Skip to content

Commit eaa911e

Browse files
committed
Comment out extra example fields
1 parent d46dc04 commit eaa911e

12 files changed

+42
-41
lines changed
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
summary: A successful response for adding an index block to an index.
2-
description: ''
3-
type: response
4-
response_code: 200
1+
# summary: ''
2+
description: 'A successful response for adding an index block to an index.'
3+
# type: response
4+
# response_code: 200
55
value:
66
"{\n \"acknowledged\" : true,\n \"shards_acknowledged\" : true,\n \"indices\"\
77
\ : [ {\n \"name\" : \"my-index-000001\",\n \"blocked\" : true\n } ]\n}"
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
summary: Perform analysis on a text string and returns the resulting tokens.
22
method_request: GET /_analyze
3-
description: ''
4-
type: request
3+
# description: ''
4+
# type: request
55
value: "{\n \"analyzer\" : \"standard\",\n \"text\" : \"Quick Brown Foxes!\"\n}"
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
summary: Clone an existing index.
2-
method_request: POST /my_source_index/_clone/my_target_index
3-
description: 'The API accepts `settings` and `aliases` parameters for the target index.'
4-
type: request
2+
# method_request: POST /my_source_index/_clone/my_target_index
3+
description: >
4+
Clone `my_source_index` into a new index called `my_target_index` with `POST /my_source_index/_clone/my_target_index`. The API accepts `settings` and `aliases` parameters for the target index.
5+
# type: request
56
value:
67
"{\n \"settings\": {\n \"index.number_of_shards\": 5\n },\n \"aliases\"\
78
: {\n \"my_search_indices\": {}\n }\n}"
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
summary: A successful response for closing an index.
2-
description: ''
3-
type: response
4-
response_code: 200
1+
# summary: ''
2+
description: A successful response for closing an index.
3+
# type: response
4+
# response_code: 200
55
value:
66
"{\n \"acknowledged\": true,\n \"shards_acknowledged\": true,\n \"indices\"\
77
: {\n \"my-index-000001\": {\n \"closed\": true\n }\n }\n}"
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
summary: Creates an index.
2-
method_request: PUT /my-index-000001
2+
# method_request: PUT /my-index-000001
33
description: This request specifies the `number_of_shards` and `number_of_replicas`.
4-
type: request
4+
# type: request
55
value:
66
"{\n \"settings\": {\n \"number_of_shards\": 3,\n \"number_of_replicas\"\
77
: 2\n }\n}"
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
summary: Creates an index with mapping.
2-
method_request: PUT /test
2+
# method_request: PUT /test
33
description: You can provide mapping definitions in the create index API requests.
4-
type: request
4+
# type: request
55
value:
66
"{\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n\
77
\ \"properties\": {\n \"field1\": { \"type\": \"text\" }\n }\n }\n}"

specification/indices/data_streams_stats/indicesDataStreamStatsResponseExample1.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
summary: A successful response for retrieving statistics for a data stream.
2-
description: ''
3-
type: response
4-
response_code: 200
1+
# summary: ''
2+
description: A successful response for retrieving statistics for a data stream.
3+
# type: response
4+
# response_code: 200
55
value:
66
"{\n \"_shards\": {\n \"total\": 10,\n \"successful\": 5,\n \"failed\"\
77
: 0\n },\n \"data_stream_count\": 2,\n \"backing_indices\": 5,\n \"total_store_size\"\
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
summary: A successful response for deleting a data stream lifecycle.
2-
description: ''
3-
type: response
4-
response_code: 200
1+
# summary: ''
2+
description: A successful response for deleting a data stream lifecycle.
3+
# type: response
4+
# response_code: 200
55
value: "{\n \"acknowledged\": true\n}"

specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample1.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
summary: A successful response for retrieving data stream lifecycle status for a data stream backing index.
2-
description: ''
3-
type: response
4-
response_code: 200
1+
# summary: ''
2+
description: A successful response for retrieving data stream lifecycle status for a data stream backing index.
3+
# type: response
4+
# response_code: 200
55
value:
66
"{\n \"indices\": {\n \".ds-metrics-2023.03.22-000001\": {\n \"index\"\
77
\ : \".ds-metrics-2023.03.22-000001\",\n \"managed_by_lifecycle\" : true,\n\

specification/indices/get_data_lifecycle/IndicesGetDataLifecycleResponseExample1.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
summary: A successful response of getting the lifecycle of a set of data streams.
2-
description: ''
3-
type: response
4-
response_code: 200
1+
# summary:
2+
description: A successful response of getting the lifecycle of a set of data streams.
3+
# type: response
4+
# response_code: 200
55
value:
66
"{\n \"data_streams\": [\n {\n \"name\": \"my-data-stream-1\",\n \
77
\ \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\":\

0 commit comments

Comments
 (0)