-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add examples to both OpenAPI documents via overlays (#2882)
- Loading branch information
Showing
5 changed files
with
114 additions
and
71 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # overlays.yaml | ||
| overlay: 1.0.0 | ||
| info: | ||
| title: Overlays for the Elasticsearch OpenAPI document | ||
| version: 0.0.1 | ||
| actions: | ||
| - target: '$.info' | ||
| description: Add a document description and feedback link | ||
| update: | ||
| title: Elasticsearch API | ||
| description: > | ||
| ## Documentation source and versions | ||
| This documentation is derived from the `main` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository. | ||
| It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/). | ||
| x-doc-license: | ||
| name: Attribution-NonCommercial-NoDerivatives 4.0 International | ||
| url: 'https://creativecommons.org/licenses/by-nc-nd/4.0/' | ||
| x-feedbackLink: | ||
| label: Feedback | ||
| url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+ |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| # overlays.yaml | ||
| overlay: 1.0.0 | ||
| info: | ||
| title: Overlays for examples that apply to both Elasticsearcb and Elasticsearch Serverless OpenAPI documents | ||
| version: 0.0.1 | ||
| actions: | ||
| - target: "$.components['requestBodies']['async_search.submit']" | ||
| description: "Add example for asynch search submit request" | ||
| update: | ||
| content: | ||
| application/json: | ||
| examples: | ||
| asyncSearchSubmitResponseExample1: | ||
| $ref: "../../specification/async_search/submit/AsyncSearchSubmitRequestExample1.json" | ||
| - target: "$.components['responses']['async_search.submit#200']" | ||
| description: "Add example for asynch search submit response" | ||
| update: | ||
| content: | ||
| application/json: | ||
| examples: | ||
| asyncSearchSubmitResponseExample1: | ||
| $ref: "../../specification/async_search/submit/AsyncSearchSubmitResponseExample1.json" | ||
| - target: "$.paths['/_transform/{transform_id}']['put']" | ||
| description: "Add examples for create transform operation" | ||
| update: | ||
| requestBody: | ||
| content: | ||
| application/json: | ||
| examples: | ||
| createTransformRequestExample1: | ||
| $ref: "../../specification/transform/put_transform/PutTransformRequestExample1.json" | ||
| createTransformRequestExample2: | ||
| $ref: "../../specification/transform/put_transform/PutTransformRequestExample2.json" | ||
| responses: | ||
| 200: | ||
| content: | ||
| application/json: | ||
| examples: | ||
| createTransformResponseExample1: | ||
| $ref: "../../specification/transform/put_transform/PutTransformResponseExample1.json" | ||
| - target: "$.components['requestBodies']['transform.preview_transform']" | ||
| description: "Add examples for preview transform operation" | ||
| update: | ||
| content: | ||
| application/json: | ||
| examples: | ||
| previewTransformRequestExample1: | ||
| $ref: "../../specification/transform/preview_transform/PreviewTransformRequestExample1.json" | ||
| - target: "$.components['reponses']['transform.preview_transform#200']" | ||
| description: "Add examples for preview transform operation" | ||
| update: | ||
| content: | ||
| application/json: | ||
| examples: | ||
| previewTransformResponseExample1: | ||
| $ref: "../../specification/transform/preview_transform/PreviewTransformResponseExample1.json" | ||
| - target: "$.paths['/_transform/{transform_id}/_update']['post']" | ||
| description: "Add examples for update transform operation" | ||
| update: | ||
| requestBody: | ||
| content: | ||
| application/json: | ||
| examples: | ||
| updateTransformRequestExample1: | ||
| $ref: "../../specification/transform/update_transform/UpdateTransformRequestExample1.json" | ||
| responses: | ||
| 200: | ||
| content: | ||
| application/json: | ||
| examples: | ||
| updateTransformResponseExample1: | ||
| $ref: "../../specification/transform/update_transform/UpdateTransformResponseExample1.json" |