Skip to content

Commit 55356e6

Browse files
miguelgrinbergmiguelgrinberg
committed
restructure existing examples w/o bodies as request examples
1 parent 384a89b commit 55356e6

File tree

360 files changed

+128
-233
lines changed

Some content is hidden

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

360 files changed

+128
-233
lines changed

‎specification/_global/bulk/examples/response/BulkResponseExample2.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
summary: Failed actions
2-
method_request: POST /_bulk
32
description: >
43
If you run `POST /_bulk` with operations that update non-existent documents, the operations cannot complete successfully.
54
The API returns a response with an `errors` property value `true`.

‎specification/_global/bulk/examples/response/BulkResponseExample3.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
summary: Filter for failed operations
2-
method_request: POST /_bulk?filter_path=items.*.error
32
description: >
43
An example response from `POST /_bulk?filter_path=items.*.error`, which returns only information about failed operations.
54
# type: response

‎specification/_global/close_point_in_time/examples/200_response/ClosePointInTimeResponseExample1.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# summary:
2-
method_request: DELETE /_pit
32
description: A successful response from `DELETE /_pit`.
43
# type: response
54
# response_code: 200

‎specification/_global/count/examples/200_response/CountResponseExample1.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# summary:
2-
method_request: GET /my-index-000001/_count?q=user:kimchy
32
description: A successful response from `GET /my-index-000001/_count?q=user:kimchy`.
43
# type: response
54
# response_code: 200

‎specification/_global/delete/examples/request/DeleteRequestExample1.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
method_request: DELETE /my-index-000001/_doc/1

‎specification/_global/delete/examples/response/DeleteResponseExample1.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# summary:
2-
method_request: DELETE /my-index-000001/_doc/1
32
description: A successful response from `DELETE /my-index-000001/_doc/1`, which deletes the JSON document 1 from the `my-index-000001` index.
43
# type: response
54
# response_code: ''

‎specification/_global/delete_by_query/examples/response/DeleteByQueryResponseExample1.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# summary:
2-
method_request: POST /my-index-000001/_delete_by_query
32
description: A successful response from `POST /my-index-000001/_delete_by_query`.
43
# type: response
54
# response_code:

‎specification/_global/explain/examples/response/ExplainResponseExample1.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# summary:
2-
method_request: GET /my-index-000001/_explain/0
32
description: A successful response from `GET /my-index-000001/_explain/0`.
43
# type: response
54
# response_code: 200

‎specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample1.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
summary: Get two fields
22
# type: "response"
3-
method_request: GET _field_caps?fields=rating,title
43
description: >
54
A successful response from `GET _field_caps?fields=rating,title`.
65
The field `rating` is defined as a long in `index1` and `index2` and as a `keyword` in `index3` and `index4`.

‎specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample2.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
summary: Get unmapped fields
22
# type: "response"
3-
method_request: GET _field_caps?fields=rating,title&include_unmapped
43
description: >
54
A successful response from `GET _field_caps?fields=rating,title&include_unmapped`.
65
The response contains an entry for each field that is present in some indices but not all.

0 commit comments

Comments
 (0)