Skip to content

Commit f9c2658

Browse files
add request heading line to request examples
1 parent d06f13e commit f9c2658

File tree

298 files changed

+298
-298
lines changed

Some content is hidden

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

298 files changed

+298
-298
lines changed

specification/_global/bulk/examples/request/BulkRequestExample1.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
summary: Multiple operations
2-
# method_request: POST _bulk
2+
method_request: POST _bulk
33
description: Run `POST _bulk` to perform multiple operations.
44
# type: request
55
value: '{ "index" : { "_index" : "test", "_id" : "1" } }

specification/_global/bulk/examples/request/BulkRequestExample2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
summary: Bulk updates
2-
# method_request: POST _bulk
2+
method_request: POST _bulk
33
description: >
44
When you run `POST _bulk` and use the `update` action, you can use `retry_on_conflict` as a field in the action itself (not in the extra payload line) to specify how many times an update should be retried in the case of a version conflict.
55
# type: request

specification/_global/bulk/examples/request/BulkRequestExample3.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
summary: Filter for failed operations
2-
# method_request: POST /_bulk
2+
method_request: POST /_bulk
33
description: >
44
To return only information about failed operations, run `POST /_bulk?filter_path=items.*.error`.
55
# type: request

specification/_global/bulk/examples/request/BulkRequestExample4.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
summary: Dynamic templates
2-
# method_request: POST /_bulk
2+
method_request: POST /_bulk
33
description: >
44
Run `POST /_bulk` to perform a bulk request that consists of index and create actions with the `dynamic_templates` parameter.
55
The bulk request creates two new fields `work_location` and `home_location` with type `geo_point` according to the `dynamic_templates` parameter.

specification/_global/clear_scroll/examples/request/ClearScrollRequestExample1.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# summary:
2-
# method_request: DELETE /_search/scroll
2+
method_request: DELETE /_search/scroll
33
description: Run `DELETE /_search/scroll` to clear the search context and results for a scrolling search.
44
# type: request
55
value: |-

specification/_global/close_point_in_time/examples/request/ClosePointInTimeRequestExample1.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# summary:
2-
# method_request: DELETE /_pit
2+
method_request: DELETE /_pit
33
description: Run `DELETE /_pit` to close a point-in-time.
44
# type: request
55
value: |-

specification/_global/count/examples/request/CountRequestExample1.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# summary:
2-
# method_request: GET /my-index-000001/_count
2+
method_request: GET /my-index-000001/_count
33
description: >
44
Run `GET /my-index-000001/_count?q=user:kimchy`.
55
Alternatively, run `GET /my-index-000001/_count` with the same query in the request body.

specification/_global/create/examples/request/CreateRequestExample1.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# summary:
2-
# method_request: PUT my-index-000001/_create/1
2+
method_request: PUT my-index-000001/_create/1
33
description: >
44
Run `PUT my-index-000001/_create/1` to index a document into the `my-index-000001` index if no document with that ID exists.
55
# type: request

specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample1.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
summary: Delete all documents
2-
# method_request: POST /my-index-000001,my-index-000002/_delete_by_query
2+
method_request: POST /my-index-000001,my-index-000002/_delete_by_query
33
description: Run `POST /my-index-000001,my-index-000002/_delete_by_query` to delete all documents from multiple data streams or indices.
44
# type: request
55
value: |-

specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
summary: Delete a single document
2-
# method_request: POST my-index-000001/_delete_by_query
2+
method_request: POST my-index-000001/_delete_by_query
33
description: Run `POST my-index-000001/_delete_by_query` to delete a document by using a unique attribute.
44
# type: request
55
value: |-

0 commit comments

Comments
 (0)