Skip to content

Commit 9426781

Browse files
authored
[DOCS] Add overlays for transform examples (#3658) (#3683)
(cherry picked from commit 0d77821)
1 parent 1b5ce8d commit 9426781

26 files changed

+227
-197
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -795,6 +795,17 @@ actions:
795795
examples:
796796
getTasksResponseExample1:
797797
$ref: "../../specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml"
798+
## Examples for transforms
799+
- target: "$.paths['/_transform/_upgrade']['post']"
800+
description: "Add examples for transform upgrade"
801+
update:
802+
responses:
803+
200:
804+
content:
805+
application/json:
806+
examples:
807+
transformUpgradeResponseExample1:
808+
$ref: "../../specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml"
798809
## Examples for watcher
799810
- target: "$.paths['/_watcher/settings']['put']"
800811
description: "Add request example for update watcher settings"

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2560,6 +2560,74 @@ actions:
25602560
examples:
25612561
updateTransformResponseExample1:
25622562
$ref: "../../specification/transform/update_transform/examples/response/UpdateTransformResponseExample1.yaml"
2563+
- target: "$.paths['/_transform/{transform_id}/_stop']['post']"
2564+
description: "Add examples for transform stop"
2565+
update:
2566+
responses:
2567+
200:
2568+
content:
2569+
application/json:
2570+
examples:
2571+
transformStopResponseExample1:
2572+
$ref: "../../specification/transform/stop_transform/examples/response/StopTransformResponseExample1.yaml"
2573+
- target: "$.paths['/_transform/{transform_id}/_start']['post']"
2574+
description: "Add examples for transform start"
2575+
update:
2576+
responses:
2577+
200:
2578+
content:
2579+
application/json:
2580+
examples:
2581+
transformStartResponseExample1:
2582+
$ref: "../../specification/transform/start_transform/examples/response/StartTransformResponseExample1.yaml"
2583+
- target: "$.paths['/_transform/{transform_id}/_schedule_now']['post']"
2584+
description: "Add examples for transform schedule now"
2585+
update:
2586+
responses:
2587+
200:
2588+
content:
2589+
application/json:
2590+
examples:
2591+
transformScheduleNowResponseExample1:
2592+
$ref: "../../specification/transform/schedule_now_transform/examples/response/ScheduleNowTransformResponseExample1.yaml"
2593+
- target: "$.paths['/_transform/{transform_id}/_reset']['post']"
2594+
description: "Add examples for transform reset"
2595+
update:
2596+
responses:
2597+
200:
2598+
content:
2599+
application/json:
2600+
examples:
2601+
transformResetResponseExample1:
2602+
$ref: "../../specification/transform/reset_transform/examples/response/ResetTransformResponseExample1.yaml"
2603+
- target: "$.paths['/_transform/{transform_id}/_stats']['get']"
2604+
description: "Add examples for transform get stats"
2605+
update:
2606+
responses:
2607+
200:
2608+
content:
2609+
application/json:
2610+
examples:
2611+
transformGetStatsResponseExample1:
2612+
$ref: "../../specification/transform/get_transform_stats/examples/response/GetTransformStatsResponseExample1.yaml"
2613+
- target: "$.paths['/_transform/{transform_id}']['delete']"
2614+
description: "Add examples for transform delete"
2615+
update:
2616+
responses:
2617+
200:
2618+
content:
2619+
application/json:
2620+
examples:
2621+
transformDeleteResponseExample1:
2622+
$ref: "../../specification/transform/delete_transform/examples/response/DeleteTransformResponseExample1.yaml"
2623+
- target: "$.components['transform.get_transform#200']"
2624+
description: "Add examples for transform get"
2625+
update:
2626+
content:
2627+
application/json:
2628+
examples:
2629+
transformGetResponseExample1:
2630+
$ref: "../../specification/transform/get_transform/examples/response/GetTransformResponseExample1.yaml"
25632631
## xCodeSamples
25642632
- target: "$.paths['/{index}/_doc/{id}']['head']"
25652633
description: "Add xCodeSamples for check document operation"

output/openapi/elasticsearch-openapi.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)