Skip to content

Commit c786309

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

File tree

289 files changed

+289
-57
lines changed

Some content is hidden

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

289 files changed

+289
-57
lines changed

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

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

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

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

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# summary:
2+
method_request: DELETE /_pit
23
description: A successful response from `DELETE /_pit`.
34
# type: response
45
# response_code: 200

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

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

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

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

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# summary:
2+
method_request: POST /my-index-000001/_delete_by_query
23
description: A successful response from `POST /my-index-000001/_delete_by_query`.
34
# type: response
45
# response_code:

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# summary:
2+
method_request: GET /my-index-000001/_explain/0
23
description: A successful response from `GET /my-index-000001/_explain/0`.
34
# type: response
45
# response_code: 200

specification/_global/field_caps/examples/request/FieldCapabilitiesRequestExample1.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# summary:
2-
method_request: "POST my-index-*/_field_caps?fields=rating"
2+
method_request: 'POST my-index-*/_field_caps?fields=rating'
33
description: >
44
Run `POST my-index-*/_field_caps?fields=rating` to get field capabilities and filter indices with a query.
55
Indices that rewrite the provided filter to `match_none` on every shard will be filtered from the response.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
summary: Get two fields
22
# type: "response"
3+
method_request: GET _field_caps?fields=rating,title
34
description: >
45
A successful response from `GET _field_caps?fields=rating,title`.
56
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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
summary: Get unmapped fields
22
# type: "response"
3+
method_request: GET _field_caps?fields=rating,title&include_unmapped
34
description: >
45
A successful response from `GET _field_caps?fields=rating,title&include_unmapped`.
56
The response contains an entry for each field that is present in some indices but not all.

0 commit comments

Comments
 (0)