Add examples to both OpenAPI documents via overlays #2882
Merged
Conversation
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
szabosteve
approved these changes
Sep 11, 2024
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.
Relates to #2144, #2482
Until we can automatically include examples in the OpenAPI documents, they are being applied by using https://github.com/elastic/elasticsearch-specification/tree/main/docs/overlays
In preparation for publishing https://github.com/elastic/elasticsearch-specification/blob/main/output/openapi/elasticsearch-openapi.json, this PR splits the existing overlay into (1) an overlay that is specific to the serverless openAPI document, (2) an overlay that is specific to the non-serverless openAPI document, and (3) an overlay that contains any common updates such as examples that are applicable to both.
The make overlay-docs command is updated to apply all those overlays. I've also created a make lint-docs-errs command to only return linting errors rather than all the warnings and information messages.