Skip to content

Commit 67a391f

Browse files
committed
Format remaining examples
1 parent 50f5ace commit 67a391f

File tree

49 files changed

+575
-630
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+575
-630
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ actions:
7171
application/json:
7272
examples:
7373
getFeaturesResponseExample1:
74-
$ref: "../../specification/features/get_features/FeaturesApiResponseExample1.json"
74+
$ref: "../../specification/features/get_features/examples/response/GetFeaturesResponseExample1.yaml"
7575
- target: "$.paths['/_features/_reset']['post']"
7676
description: "Add examples for reset features operation"
7777
update:
@@ -81,7 +81,7 @@ actions:
8181
application/json:
8282
examples:
8383
resetFeaturesResponseExample1:
84-
$ref: "../../specification/features/reset_features/ResetFeaturesResponseExample1.json"
84+
$ref: "../../specification/features/reset_features/examples/response/ResetFeaturesResponseExample1.yaml"
8585
- target: "$.components['requestBodies']['cluster.allocation_explain']"
8686
description: "Add examples for cluster allocation explain operation"
8787
update:
@@ -97,7 +97,7 @@ actions:
9797
application/json:
9898
examples:
9999
clusterHealthResponseExample1:
100-
$ref: "../../specification/cluster/health/clusterHealthResponseExample1.json"
100+
$ref: "../../specification/cluster/health/examples/response/clusterHealthResponseExample1.yaml"
101101
- target: "$.paths['/_cluster/settings']['put']"
102102
description: "Add examples for cluster update settings operation"
103103
update:
@@ -123,15 +123,15 @@ actions:
123123
application/json:
124124
examples:
125125
clusterNodesReloadSecureSettingsRequestExample1:
126-
$ref: "../../specification/nodes/reload_secure_settings/clusterNodesReloadSecureSettingsRequestExample1.json"
126+
$ref: "../../specification/nodes/reload_secure_settings/examples/request/ReloadSecureSettingsRequestExample1.yaml"
127127
- target: "$.components['responses']['nodes.reload_secure_settings#200']"
128128
description: "Add response examples for nodes reload secure settings operation"
129129
update:
130130
content:
131131
application/json:
132132
examples:
133133
clusterNodesReloadSecureSettingsResponseExample1:
134-
$ref: "../../specification/nodes/reload_secure_settings/clusterNodesReloadSecureSettingsResponseExample1.json"
134+
$ref: "../../specification/nodes/reload_secure_settings/examples/response/ReloadSecureSettingsResponseExample1.yaml"
135135
- target: "$.paths['/_tasks']['get']"
136136
description: "Add examples for task management operation"
137137
update:
@@ -141,7 +141,7 @@ actions:
141141
application/json:
142142
examples:
143143
getTasksResponseExample1:
144-
$ref: "../../specification/tasks/get/getTasksResponseExample1.json"
144+
$ref: "../../specification/tasks/get/examples/response/GetTaskResponseExample1.yaml"
145145
- target: "$.components['responses']['nodes.info#200']"
146146
description: "Add response examples for nodes info"
147147
update:
@@ -159,7 +159,7 @@ actions:
159159
application/json:
160160
examples:
161161
deleteLifecycleResponseExample1:
162-
$ref: "../../specification/ilm/delete_lifecycle/DeleteLifecycleResponseExample1.json"
162+
$ref: "../../specification/ilm/delete_lifecycle/examples/response/DeleteLifecycleResponseExample1.yaml"
163163
- target: "$.paths['/_ilm/policy/{policy}']['put']"
164164
description: "Add examples for create a lifecycle operation"
165165
update:
@@ -183,7 +183,7 @@ actions:
183183
application/json:
184184
examples:
185185
getLifecycleResponseExample1:
186-
$ref: "../../specification/ilm/get_lifecycle/GetLifecycleResponseExample1.json"
186+
$ref: "../../specification/ilm/get_lifecycle/examples/response/GetLifecycleResponseExample1.yaml"
187187
- target: "$.paths['/_ilm/migrate_to_data_tiers']['post']"
188188
description: "Add examples for migrate to data tiers routing operation"
189189
update:
@@ -227,7 +227,7 @@ actions:
227227
application/json:
228228
examples:
229229
startILMResponseExample1:
230-
$ref: "../../specification/ilm/start/StartILMResponseExample1.json"
230+
$ref: "../../specification/ilm/start/examples/response/StartILMResponseExample1.yaml"
231231
- target: "$.paths['/_ilm/stop']['post']"
232232
description: "Add examples for stop index lifecycle management operation"
233233
update:
@@ -237,7 +237,7 @@ actions:
237237
application/json:
238238
examples:
239239
stopILMResponseExample1:
240-
$ref: "../../specification/ilm/stop/stopILMResponseExample1.json"
240+
$ref: "../../specification/ilm/stop/examples/response/StopILMResponseExample1.yaml"
241241
- target: "$.paths['/_ilm/status']['get']"
242242
description: "Add examples for get index lifecycle management status operation"
243243
update:
@@ -247,7 +247,7 @@ actions:
247247
application/json:
248248
examples:
249249
getILMStatusResponseExample1:
250-
$ref: "../../specification/ilm/get_status/GetILMStatusResponseExample1.json"
250+
$ref: "../../specification/ilm/get_status/examples/response/GetILMStatusResponseExample1.yaml"
251251
- target: "$.paths['/{index}/_ilm/explain']['get']"
252252
description: "Add examples for explain lifecycle operation"
253253
update:
@@ -257,7 +257,7 @@ actions:
257257
application/json:
258258
examples:
259259
explainLifecycleResponseExample1:
260-
$ref: "../../specification/ilm/explain_lifecycle/ExplainLifecycleResponseExample1.json"
260+
$ref: "../../specification/ilm/explain_lifecycle/examples/response/ExplainLifecycleResponseExample1.yaml"
261261
- target: "$.paths['/{index}/_ilm/remove']['post']"
262262
description: "Add examples for remove policy from index operation"
263263
update:
@@ -267,7 +267,7 @@ actions:
267267
application/json:
268268
examples:
269269
removePolicyResponseExample1:
270-
$ref: "../../specification/ilm/remove_policy/RemovePolicyResponseExample1.json"
270+
$ref: "../../specification/ilm/remove_policy/examples/response/RemovePolicyResponseExample1.yaml"
271271
- target: "$.components['requestBodies']['indices.clone']"
272272
description: "Add examples for clone index request"
273273
update:

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1094,32 +1094,32 @@ actions:
10941094
application/json:
10951095
examples:
10961096
createTransformRequestExample1:
1097-
$ref: "../../specification/transform/put_transform/PutTransformRequestExample1.json"
1097+
$ref: "../../specification/transform/put_transform/examples/request/PutTransformRequestExample1.yaml"
10981098
createTransformRequestExample2:
1099-
$ref: "../../specification/transform/put_transform/PutTransformRequestExample2.json"
1099+
$ref: "../../specification/transform/put_transform/examples/request/PutTransformRequestExample2.yaml"
11001100
responses:
11011101
200:
11021102
content:
11031103
application/json:
11041104
examples:
11051105
createTransformResponseExample1:
1106-
$ref: "../../specification/transform/put_transform/PutTransformResponseExample1.json"
1106+
$ref: "../../specification/transform/put_transform/examples/response/PutTransformResponseExample1.yaml"
11071107
- target: "$.components['requestBodies']['transform.preview_transform']"
11081108
description: "Add examples for preview transform operation"
11091109
update:
11101110
content:
11111111
application/json:
11121112
examples:
11131113
previewTransformRequestExample1:
1114-
$ref: "../../specification/transform/preview_transform/PreviewTransformRequestExample1.json"
1114+
$ref: "../../specification/transform/preview_transform/examples/request/PreviewTransformRequestExample1.yaml"
11151115
- target: "$.components['responses']['transform.preview_transform#200']"
11161116
description: "Add examples for preview transform operation"
11171117
update:
11181118
content:
11191119
application/json:
11201120
examples:
11211121
previewTransformResponseExample1:
1122-
$ref: "../../specification/transform/preview_transform/PreviewTransformResponseExample1.json"
1122+
$ref: "../../specification/transform/preview_transform/examples/response/PreviewTransformResponseExample1.yaml"
11231123
- target: "$.paths['/_transform/{transform_id}/_update']['post']"
11241124
description: "Add examples for update transform operation"
11251125
update:
@@ -1128,14 +1128,14 @@ actions:
11281128
application/json:
11291129
examples:
11301130
updateTransformRequestExample1:
1131-
$ref: "../../specification/transform/update_transform/UpdateTransformRequestExample1.json"
1131+
$ref: "../../specification/transform/update_transform/examples/request/UpdateTransformRequestExample1.yaml"
11321132
responses:
11331133
200:
11341134
content:
11351135
application/json:
11361136
examples:
11371137
updateTransformResponseExample1:
1138-
$ref: "../../specification/transform/update_transform/UpdateTransformResponseExample1.json"
1138+
$ref: "../../specification/transform/update_transform/examples/response/UpdateTransformResponseExample1.yaml"
11391139
- target: "$.paths['/_eql/search/status/{id}']['get']"
11401140
description: "Add examples for get async EQL status operation"
11411141
update:
@@ -1145,7 +1145,7 @@ actions:
11451145
application/json:
11461146
examples:
11471147
eqlGetStatusResponseExample1:
1148-
$ref: "../../specification/eql/get_status/EqlGetStatusResponseExample1.json"
1148+
$ref: "../../specification/eql/get_status/examples/response/EqlGetStatusResponseExample1.yaml"
11491149
- target: "$.components['requestBodies']['eql.search']"
11501150
description: "Add examples for EQL search operation"
11511151
update:

output/schema/schema.json

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

specification/cluster/health/clusterHealthResponseExample1.json

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# summary:
2+
description: >
3+
A successful response from `GET _cluster/health`.
4+
It is the health status of a quiet single node cluster with a single index with one shard and one replica.
5+
type: response
6+
response_code: 200
7+
value: |-
8+
{
9+
"cluster_name" : "testcluster",
10+
"status" : "yellow",
11+
"timed_out" : false,
12+
"number_of_nodes" : 1,
13+
"number_of_data_nodes" : 1,
14+
"active_primary_shards" : 1,
15+
"active_shards" : 1,
16+
"relocating_shards" : 0,
17+
"initializing_shards" : 0,
18+
"unassigned_shards" : 1,
19+
"delayed_unassigned_shards": 0,
20+
"number_of_pending_tasks" : 0,
21+
"number_of_in_flight_fetch": 0,
22+
"task_max_waiting_in_queue_millis": 0,
23+
"active_shards_percent_as_number": 50.0
24+
}

specification/eql/get_status/EqlGetStatusResponseExample1.json

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# summary:
2+
description: A successful response for getting status information for an async EQL search.
3+
# type: response
4+
# response_code: 200
5+
value: >-
6+
{
7+
"id": "FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
8+
"is_running" : true,
9+
"is_partial" : true,
10+
"start_time_in_millis" : 1611690235000,
11+
"expiration_time_in_millis" : 1611690295000
12+
}

specification/features/get_features/FeaturesApiResponseExample1.json

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# summary:
2+
description: A successful response for retrieving a list of feature states that can be included when taking a snapshot.
3+
# type: response
4+
# response_code: 200
5+
value: |-
6+
{
7+
"features": [
8+
{
9+
"name": "tasks",
10+
"description": "Manages task results"
11+
},
12+
{
13+
"name": "kibana",
14+
"description": "Manages Kibana configuration and reports"
15+
}
16+
]
17+
}

specification/features/reset_features/ResetFeaturesResponseExample1.json

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)