Skip to content

Commit 2d8d3df

Browse files
committed
[DOCS] Add overlays for transform examples (#3658)
(cherry picked from commit 0d77821)
1 parent 9a94e90 commit 2d8d3df

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
@@ -674,6 +674,17 @@ actions:
674674
examples:
675675
getTasksResponseExample1:
676676
$ref: "../../specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml"
677+
## Examples for transforms
678+
- target: "$.paths['/_transform/_upgrade']['post']"
679+
description: "Add examples for transform upgrade"
680+
update:
681+
responses:
682+
200:
683+
content:
684+
application/json:
685+
examples:
686+
transformUpgradeResponseExample1:
687+
$ref: "../../specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml"
677688
## Examples for watcher
678689
- target: "$.paths['/_watcher/settings']['put']"
679690
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
@@ -2381,6 +2381,74 @@ actions:
23812381
examples:
23822382
updateTransformResponseExample1:
23832383
$ref: "../../specification/transform/update_transform/examples/response/UpdateTransformResponseExample1.yaml"
2384+
- target: "$.paths['/_transform/{transform_id}/_stop']['post']"
2385+
description: "Add examples for transform stop"
2386+
update:
2387+
responses:
2388+
200:
2389+
content:
2390+
application/json:
2391+
examples:
2392+
transformStopResponseExample1:
2393+
$ref: "../../specification/transform/stop_transform/examples/response/StopTransformResponseExample1.yaml"
2394+
- target: "$.paths['/_transform/{transform_id}/_start']['post']"
2395+
description: "Add examples for transform start"
2396+
update:
2397+
responses:
2398+
200:
2399+
content:
2400+
application/json:
2401+
examples:
2402+
transformStartResponseExample1:
2403+
$ref: "../../specification/transform/start_transform/examples/response/StartTransformResponseExample1.yaml"
2404+
- target: "$.paths['/_transform/{transform_id}/_schedule_now']['post']"
2405+
description: "Add examples for transform schedule now"
2406+
update:
2407+
responses:
2408+
200:
2409+
content:
2410+
application/json:
2411+
examples:
2412+
transformScheduleNowResponseExample1:
2413+
$ref: "../../specification/transform/schedule_now_transform/examples/response/ScheduleNowTransformResponseExample1.yaml"
2414+
- target: "$.paths['/_transform/{transform_id}/_reset']['post']"
2415+
description: "Add examples for transform reset"
2416+
update:
2417+
responses:
2418+
200:
2419+
content:
2420+
application/json:
2421+
examples:
2422+
transformResetResponseExample1:
2423+
$ref: "../../specification/transform/reset_transform/examples/response/ResetTransformResponseExample1.yaml"
2424+
- target: "$.paths['/_transform/{transform_id}/_stats']['get']"
2425+
description: "Add examples for transform get stats"
2426+
update:
2427+
responses:
2428+
200:
2429+
content:
2430+
application/json:
2431+
examples:
2432+
transformGetStatsResponseExample1:
2433+
$ref: "../../specification/transform/get_transform_stats/examples/response/GetTransformStatsResponseExample1.yaml"
2434+
- target: "$.paths['/_transform/{transform_id}']['delete']"
2435+
description: "Add examples for transform delete"
2436+
update:
2437+
responses:
2438+
200:
2439+
content:
2440+
application/json:
2441+
examples:
2442+
transformDeleteResponseExample1:
2443+
$ref: "../../specification/transform/delete_transform/examples/response/DeleteTransformResponseExample1.yaml"
2444+
- target: "$.components['transform.get_transform#200']"
2445+
description: "Add examples for transform get"
2446+
update:
2447+
content:
2448+
application/json:
2449+
examples:
2450+
transformGetResponseExample1:
2451+
$ref: "../../specification/transform/get_transform/examples/response/GetTransformResponseExample1.yaml"
23842452
## xCodeSamples
23852453
- target: "$.paths['/{index}/_doc/{id}']['head']"
23862454
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)