Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Add overlays for transform examples #3658

Merged
merged 2 commits into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/overlays/elasticsearch-openapi-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -676,6 +676,17 @@ actions:
examples:
getTasksResponseExample1:
$ref: "../../specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml"
## Examples for transforms
- target: "$.paths['/_transform/_upgrade']['post']"
description: "Add examples for transform upgrade"
update:
responses:
200:
content:
application/json:
examples:
transformUpgradeResponseExample1:
$ref: "../../specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml"
## Examples for watcher
- target: "$.paths['/_watcher/settings']['put']"
description: "Add request example for update watcher settings"
Expand Down
68 changes: 68 additions & 0 deletions docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2381,6 +2381,74 @@ actions:
examples:
updateTransformResponseExample1:
$ref: "../../specification/transform/update_transform/examples/response/UpdateTransformResponseExample1.yaml"
- target: "$.paths['/_transform/{transform_id}/_stop']['post']"
description: "Add examples for transform stop"
update:
responses:
200:
content:
application/json:
examples:
transformStopResponseExample1:
$ref: "../../specification/transform/stop_transform/examples/response/StopTransformResponseExample1.yaml"
- target: "$.paths['/_transform/{transform_id}/_start']['post']"
description: "Add examples for transform start"
update:
responses:
200:
content:
application/json:
examples:
transformStartResponseExample1:
$ref: "../../specification/transform/start_transform/examples/response/StartTransformResponseExample1.yaml"
- target: "$.paths['/_transform/{transform_id}/_schedule_now']['post']"
description: "Add examples for transform schedule now"
update:
responses:
200:
content:
application/json:
examples:
transformScheduleNowResponseExample1:
$ref: "../../specification/transform/schedule_now_transform/examples/response/ScheduleNowTransformResponseExample1.yaml"
- target: "$.paths['/_transform/{transform_id}/_reset']['post']"
description: "Add examples for transform reset"
update:
responses:
200:
content:
application/json:
examples:
transformResetResponseExample1:
$ref: "../../specification/transform/reset_transform/examples/response/ResetTransformResponseExample1.yaml"
- target: "$.paths['/_transform/{transform_id}/_stats']['get']"
description: "Add examples for transform get stats"
update:
responses:
200:
content:
application/json:
examples:
transformGetStatsResponseExample1:
$ref: "../../specification/transform/get_transform_stats/examples/response/GetTransformStatsResponseExample1.yaml"
- target: "$.paths['/_transform/{transform_id}']['delete']"
description: "Add examples for transform delete"
update:
responses:
200:
content:
application/json:
examples:
transformDeleteResponseExample1:
$ref: "../../specification/transform/delete_transform/examples/response/DeleteTransformResponseExample1.yaml"
- target: "$.components['transform.get_transform#200']"
description: "Add examples for transform get"
update:
content:
application/json:
examples:
transformGetResponseExample1:
$ref: "../../specification/transform/get_transform/examples/response/GetTransformResponseExample1.yaml"
## xCodeSamples
- target: "$.paths['/{index}/_doc/{id}']['head']"
description: "Add xCodeSamples for check document operation"
Expand Down
6 changes: 3 additions & 3 deletions output/openapi/elasticsearch-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions output/openapi/elasticsearch-serverless-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading