Generate documentation for imported external nested fields#814
Merged
jsoriano merged 3 commits intoelastic:mainfrom May 10, 2022
Merged
Generate documentation for imported external nested fields#814jsoriano merged 3 commits intoelastic:mainfrom
jsoriano merged 3 commits intoelastic:mainfrom
Conversation
Collaborator
Collaborator
🌐 Coverage report
|
mtojek
approved these changes
May 10, 2022
This was referenced May 11, 2022
jsoriano
added a commit
to jsoriano/elastic-package
that referenced
this pull request
May 12, 2022
…lastic#814)" This reverts commit 6b03219.
jsoriano
added a commit
that referenced
this pull request
May 12, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
While trying to remove duplicated fields to introduce package-spec 1.8.0 I found that sub-fields of external fields of type group were being included in the built fields files, but not in the documentation.
This PR attempts to address a couple of incoherences found with external fields, documentation and final generated field files:
An alternative could be to don't import sub-fields of external groups, but this change could be breaking as it would modify the fields actually included in the mappings. The approach in this PR solves the incoherences by modifying only the docs, what shouldn't be breaking.