add request heading line to response examples

Author: miguelgrinberg

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

@@ -1,4 +1,5 @@
 summary: Failed actions
+method_request: POST /_bulk
 description: >
   If you run `POST /_bulk` with operations that update non-existent documents, the operations cannot complete successfully.
   The API returns a response with an `errors` property value `true`.

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

@@ -1,4 +1,5 @@
 summary: Filter for failed operations
+method_request: POST /_bulk?filter_path=items.*.error
 description: >
   An example response from `POST /_bulk?filter_path=items.*.error`, which returns only information about failed operations.
 # type: response

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

@@ -1,4 +1,5 @@
 # summary:
+method_request: DELETE /_pit
 description: A successful response from `DELETE /_pit`.
 # type: response
 # response_code: 200

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

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /my-index-000001/_count?q=user:kimchy
 description: A successful response from `GET /my-index-000001/_count?q=user:kimchy`.
 # type: response
 # response_code: 200

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

@@ -1,4 +1,5 @@
 # summary:
+method_request: DELETE /my-index-000001/_doc/1
 description: A successful response from `DELETE /my-index-000001/_doc/1`, which deletes the JSON document 1 from the `my-index-000001` index.
 # type: response
 # response_code: ''

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

@@ -1,4 +1,5 @@
 # summary:
+method_request: POST /my-index-000001/_delete_by_query
 description: A successful response from `POST /my-index-000001/_delete_by_query`.
 # type: response
 # response_code:

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

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /my-index-000001/_explain/0
 description: A successful response from `GET /my-index-000001/_explain/0`.
 # type: response
 # response_code: 200

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

@@ -1,5 +1,6 @@
 summary: Get two fields
 # type: "response"
+method_request: GET _field_caps?fields=rating,title
 description: >
   A successful response from `GET _field_caps?fields=rating,title`.
   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

@@ -1,5 +1,6 @@
 summary: Get unmapped fields
 # type: "response"
+method_request: GET _field_caps?fields=rating,title&include_unmapped
 description: >
   A successful response from `GET _field_caps?fields=rating,title&include_unmapped`.
   The response contains an entry for each field that is present in some indices but not all.

specification/_global/get/examples/response/GetResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: Get a document
+method_request: GET my-index-000001/_doc/0
 description: >
   A successful response from `GET my-index-000001/_doc/0`.
   It retrieves the JSON document with the `_id` 0 from the `my-index-000001` index.

specification/_global/get/examples/response/GetResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: Get stored fields
+method_request: GET my-index-000001/_doc/1?stored_fields=tags,counter
 description: >
   A successful response from `GET my-index-000001/_doc/1?stored_fields=tags,counter`, which retrieves a set of stored fields.
   Field values fetched from the document itself are always returned as an array.

specification/_global/get/examples/response/GetResponseExample3.yaml

@@ -1,4 +1,5 @@
 summary: Get metadata fields
+method_request: GET my-index-000001/_doc/2?routing=user1&stored_fields=tags,counter
 description: >
   A successful response from `GET my-index-000001/_doc/2?routing=user1&stored_fields=tags,counter`, which retrieves the `_routing` metadata field.
 # type: response

specification/_global/index/examples/response/IndexResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: Automate document IDs
+method_request: POST my-index-000001/_doc/
 description: A successful response from `POST my-index-000001/_doc/`, which contains an automated document ID.
 # type: response
 # response_code: 200

specification/_global/index/examples/response/IndexResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: Define document IDs
+method_request: PUT my-index-000001/_doc/1
 description: A successful response from `PUT my-index-000001/_doc/1`.
 # type: response
 # response_code: 200

specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary: ''
+method_request: GET /
 description: A successful response from `GET /`s.
 # type: response
 # response_code: 200

specification/_global/open_point_in_time/examples/response/OpenPointInTimeResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true
 description: >
   A successful response from `POST /my-index-000001/_pit?keep_alive=1m&allow_partial_search_results=true`.
   It includes a summary of the total number of shards, as well as the number of successful shards when creating the PIT.

specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: Test context
+method_request: POST /_scripts/painless/_execute
 description: A successful response from `POST /_scripts/painless/_execute` with a `painless_test` context.
 # type: response
 # response_code: ''

specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: Filter context
+method_request: POST /_scripts/painless/_execute
 description: A successful response from `POST /_scripts/painless/_execute` with a `filter` context.
 # type: response
 # response_code: ''

specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample3.yaml

@@ -1,4 +1,5 @@
 summary: Score context
+method_request: POST /_scripts/painless/_execute
 description: A successful response from `POST /_scripts/painless/_execute` with a `score` context.
 # type: response
 # response_code: ''

specification/_global/search/examples/200_response/SearchResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /my-index-000001/_search?from=40&size=20
 description: >
   An abbreviated response from `GET /my-index-000001/_search?from=40&size=20` with a simple term query.
 # type: response

specification/_global/search_mvt/examples/response/SearchMvtResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET museums/_mvt/location/13/4207/2692
 description: >
   A successful response from `GET museums/_mvt/location/13/4207/2692`.
   It returns results as a binary vector tile.

specification/_global/search_shards/examples/response/SearchShardsResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /my-index-000001/_search_shards
 description: An abbreviated response from `GET /my-index-000001/_search_shards`.
 # type: response
 # response_code: 200

specification/_global/terms_enum/examples/response/TermsEnumResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: POST stackoverflow/_terms_enum
 description: A successful response from `POST stackoverflow/_terms_enum`.
 # type: "response",
 # response_code: 200,

specification/_global/termvectors/examples/response/TermVectorsResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: Return stored term vectors
+method_request: GET /my-index-000001/_termvectors/1
 description: A successful response from `GET /my-index-000001/_termvectors/1`.
 # type: response
 # response_code: ''

specification/_global/termvectors/examples/response/TermVectorsResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: Per-field analyzer
+method_request: GET /my-index-000001/_termvectors
 description: A successful response from `GET /my-index-000001/_termvectors` with `per_field_analyzer` in the request body.
 # type: response
 # response_code: ''

specification/_global/termvectors/examples/response/TermVectorsResponseExample3.yaml

@@ -1,4 +1,5 @@
 summary: Terms filtering
+method_request: GET /my-index-000001/_termvectors
 description: A successful response from `GET /my-index-000001/_termvectors` with a `filter` in the request body.
 # type: response
 # response_code: ''

specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=
 description: A succesful response from `GET /_async_search/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=`.
 # type: response
 # response_code: 200

specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: An active async search
+method_request: GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=
 description: A succesful response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=`, which retrieves the status of a previously submitted async search without the results.
 # type: response
 # response_code: 200

specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: A completed async search
+method_request: GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=
 description: >
   A succesful response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=` for an async search that has completed.
   The status response has an additional `completion_status` field that shows the status code of the completed async search.

specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml

@@ -1,4 +1,5 @@
 summary: A failed async search
+method_request: GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=
 description: >
   A response from `GET /_async_search/status/FmRldE8zREVEUzA2ZVpUeGs2ejJFUFEaMkZ5QTVrSTZSaVN3WlNFVmtlWHJsdzoxMDc=` for an async search that has completed with an error.
   The status response has an additional `completion_status` field that shows the status code of the completed async search.

specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: A successful response of deleting one or more autoscaling policy.
+method_request: DELETE /_autoscaling/policy/*
 description: >
   This may be a response to either `DELETE /_autoscaling/policy/my_autoscaling_policy` or `DELETE /_autoscaling/policy/*`.
 # type: "response"

specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: 'A successful response for retrieving the current autoscaling capacity.'
+method_request: GET /_autoscaling/capacity
 description: 'This may be a response to `GET /_autoscaling/capacity`.'
 # type: "response"
 # response_code: 200

specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: 'A successful response for retrieving an autoscaling policy.'
+method_request: GET /_autoscaling/policy/my_autoscaling_policy
 description: 'This may be a response to `GET /_autoscaling/policy/my_autoscaling_policy`.'
 # type: "response"
 # response_code: 200

specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET _cat/aliases?format=json&v=true
 description: >
   A successful response from `GET _cat/aliases?format=json&v=true`.
   This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.

specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_cat/allocation?v=true&format=json
 description: >
   A successful response from `GET /_cat/allocation?v=true&format=json`.
   It shows a single shard is allocated to the one node available.

specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET _cat/component_templates/my-template-*?v=true&s=name&format=json
 description: >
   A successful response from `GET _cat/component_templates/my-template-*?v=true&s=name&format=json`.
 # type: response

specification/cat/count/examples/200_response/CatCountResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: Single data stream or index count
+method_request: GET /_cat/count/my-index-000001?v=true&format=json
 description: >
   A successful response from `GET /_cat/count/my-index-000001?v=true&format=json`.
   It retrieves the document count for the `my-index-000001` data stream or index.

specification/cat/count/examples/200_response/CatCountResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: All data streams and indices count
+method_request: GET /_cat/count?v=true&format=json
 description: >
   A successful response from `GET /_cat/count?v=true&format=json`.
   It retrieves the document count for all data streams and indices in the cluster.

specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: Single field data
+method_request: GET /_cat/fielddata?v=true&fields=body&format=json
 description: >
   A successful response from `GET /_cat/fielddata?v=true&fields=body&format=json`.
   You can specify an individual field in the request body or URL path.

specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: Multiple fields data
+method_request: GET /_cat/fielddata?v=true
 description: >
   A successful response from `GET /_cat/fielddata/body,soul?v=true&format=json`.
   You can specify a comma-separated list of fields in the request body or URL path.

specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_cat/health?v=true&format=json
 description: >
   A successful response from `GET /_cat/health?v=true&format=json`.
   By default, it returns `HH:MM:SS` and Unix epoch timestamps.

specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_cat/indices/my-index-*?v=true&s=index&format=json
 description: >
   A successful response from `GET /_cat/indices/my-index-*?v=true&s=index&format=json`.
 # type: response

specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_cat/master?v=true&format=json
 description: >
   A successful response from `GET /_cat/master?v=true&format=json`.
 # type: response

specification/cat/ml_data_frame_analytics/examples/200_response/CatDataframeanalyticsResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET _cat/ml/data_frame/analytics?v=true&format=json
 description: A successful response from `GET _cat/ml/data_frame/analytics?v=true&format=json`.
 # type: response
 # response_code: 200

specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET _cat/ml/datafeeds?v=true&format=json
 description: A successful response from `GET _cat/ml/datafeeds?v=true&format=json`.
 # type: response
 # response_code:

specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json
 description: A successful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true&format=json`.
 # type: response
 # response_code: ''

specification/cat/ml_trained_models/examples/200_response/CatTrainedModelsResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET _cat/ml/trained_models?v=true&format=json
 description: A successful response from `GET _cat/ml/trained_models?v=true&format=json`.
 # type: response
 # response_code: ''

specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: Default columns
+method_request: GET /_cat/nodeattrs?v=true&format=json
 description: >
   A successful response from `GET /_cat/nodeattrs?v=true&format=json`.
   The `node`, `host`, and `ip` columns provide basic information about each node.

specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: Explicit columns
+method_request: GET /_cat/nodeattrs?v=true&h=name,pid,attr,value
 description: >
   A successful response from `GET /_cat/nodeattrs?v=true&h=name,pid,attr,value`.
   It returns the `name`, `pid`, `attr`, and `value` columns.

specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: Default columns
+method_request: GET /_cat/nodes?v=true&format=json
 description: >
   A successful response from `GET /_cat/nodes?v=true&format=json`.
   The `ip`, `heap.percent`, `ram.percent`, `cpu`, and `load_*` columns provide the IP addresses and performance information of each node.

specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: Explicit columns
+method_request: GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json
 description: >
   A successful response from `GET /_cat/nodes?v=true&h=id,ip,port,v,m&format=json`.
   It returns the `id`, `ip`, `port`, `v` (version), and `m` (master) columns.

specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json
 description: >
   A successful response from `GET /_cat/pending_tasks?v=trueh=insertOrder,timeInQueue,priority,source&format=json`.
 # type: response

specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json
 description: >
   A successful response from `GET /_cat/plugins?v=true&s=component&h=name,component,version,description&format=json`.
 # type: response

specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: No ongoing recoveries
+method_request: GET _cat/recovery?v=true&format=json
 description: >
   A successful response from `GET _cat/recovery?v=true&format=json`.
   In this example, the source and target nodes are the same because the recovery type is `store`, meaning they were read from local storage on node start.

specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: A live shard recovery
+method_request: GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json
 description: >
   A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp&format=json`.
   You can retrieve information about an ongoing recovery for example when you increase the replica count of an index and bring another node online to host the replicas.

specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml

@@ -1,4 +1,5 @@
 summary: A snapshot recovery
+method_request: GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json
 description: >
   A successful response from `GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp&format=json`.
   You can restore backups of an index using the snapshot and restore API.

specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_cat/repositories?v=true&format=json
 description: >
   A successful response from `GET /_cat/repositories?v=true&format=json`.
 # type: response

specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_cat/segments?v=true&format=json
 description: >
   A successful response from `GET /_cat/segments?v=true&format=json`.
 # type: response

specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml

@@ -1,4 +1,5 @@
 summary: A single data stream or index
+method_request: GET _cat/shards?format=json
 description: >
   A successful response from `GET _cat/shards?format=json`.
 # type: response

specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml

@@ -1,4 +1,5 @@
 summary: A wildcard pattern
+method_request: GET _cat/shards/my-index-*?format=json
 description: >
   A successful response from `GET _cat/shards/my-index-*?format=json`.
   It returns information for any data streams or indices beginning with `my-index-`.

specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml

@@ -1,4 +1,5 @@
 summary: A relocating shard
+method_request: GET _cat/shards?format=json
 description: >
   A successful response from `GET _cat/shards?format=json`.
   The `RELOCATING` value in the `state` column indicates the index shard is relocating.

specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml

@@ -1,4 +1,5 @@
 summary: Shard states
+method_request: GET _cat/shards?format=json
 description: >
   A successful response from `GET _cat/shards?format=json`.
   Before a shard is available for use, it goes through an `INITIALIZING` state.

specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml

@@ -1,4 +1,5 @@
 summary: Reasons for unassigned shards
+method_request: GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json
 description: >
   A successful response from `GET _cat/shards?h=index,shard,prirep,state,unassigned.reason&format=json`.
   It includes the `unassigned.reason` column, which indicates why a shard is unassigned.

specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET /_cat/snapshots/repo1?v=true&s=id&format=json
 description: >
   A successful response from `GET /_cat/snapshots/repo1?v=true&s=id&format=json`.
 # type: response

specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET _cat/tasks?v=true&format=json
 description: A successful response from `GET _cat/tasks?v=true&format=json`.
 # type: response
 # response_code: 200

specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml

@@ -1,4 +1,5 @@
 # summary:
+method_request: GET _cat/templates/my-template-*?v=true&s=name&format=json
 description: >
   A successful response from `GET _cat/templates/my-template-*?v=true&s=name&format=json`.
 # type: response