add request heading line to request examples

Author: miguelgrinberg

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

@@ -1,5 +1,5 @@
 summary: Multiple operations
-# method_request: POST _bulk
+method_request: POST _bulk
 description: Run `POST _bulk` to perform multiple operations.
 # type: request
 value: '{ "index" : { "_index" : "test", "_id" : "1" } }

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

@@ -1,5 +1,5 @@
 summary: Bulk updates
-# method_request: POST _bulk
+method_request: POST _bulk
 description: >
   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.
 # type: request

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

@@ -1,5 +1,5 @@
 summary: Filter for failed operations
-# method_request: POST /_bulk
+method_request: POST /_bulk
 description: >
   To return only information about failed operations, run `POST /_bulk?filter_path=items.*.error`.
 # type: request

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

@@ -1,5 +1,5 @@
 summary: Dynamic templates
-# method_request: POST /_bulk
+method_request: POST /_bulk
 description: >
   Run `POST /_bulk` to perform a bulk request that consists of index and create actions with the `dynamic_templates` parameter.
   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

@@ -1,5 +1,5 @@
 # summary:
-# method_request: DELETE /_search/scroll
+method_request: DELETE /_search/scroll
 description: Run `DELETE /_search/scroll` to clear the search context and results for a scrolling search.
 # type: request
 value: |-

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

@@ -1,5 +1,5 @@
 # summary:
-# method_request: DELETE /_pit
+method_request: DELETE /_pit
 description: Run `DELETE /_pit` to close a point-in-time.
 # type: request
 value: |-

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

@@ -1,5 +1,5 @@
 # summary:
-# method_request: GET /my-index-000001/_count
+method_request: GET /my-index-000001/_count
 description: >
   Run `GET /my-index-000001/_count?q=user:kimchy`.
   Alternatively, run `GET /my-index-000001/_count` with the same query in the request body.

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

@@ -1,5 +1,5 @@
 # summary:
-# method_request: PUT my-index-000001/_create/1
+method_request: PUT my-index-000001/_create/1
 description: >
   Run `PUT my-index-000001/_create/1` to index a document into the `my-index-000001` index if no document with that ID exists.
 # type: request

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

@@ -1,5 +1,5 @@
 summary: Delete all documents
-# method_request: POST /my-index-000001,my-index-000002/_delete_by_query
+method_request: POST /my-index-000001,my-index-000002/_delete_by_query
 description: Run `POST /my-index-000001,my-index-000002/_delete_by_query` to delete all documents from multiple data streams or indices.
 # type: request
 value: |-

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

@@ -1,5 +1,5 @@
 summary: Delete a single document
-# method_request: POST my-index-000001/_delete_by_query
+method_request: POST my-index-000001/_delete_by_query
 description: Run `POST my-index-000001/_delete_by_query` to delete a document by using a unique attribute.
 # type: request
 value: |-

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

@@ -1,5 +1,5 @@
 summary: Slice manually
-# method_request: POST my-index-000001/_delete_by_query
+method_request: POST my-index-000001/_delete_by_query
 description: >
   Run `POST my-index-000001/_delete_by_query` to slice a delete by query manually. Provide a slice ID and total number of slices.
 # type: request

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

@@ -1,5 +1,5 @@
 summary: Automatic slicing
-# method_request: POST my-index-000001/_delete_by_query?refresh&slices=5
+method_request: POST my-index-000001/_delete_by_query?refresh&slices=5
 description: >
   Run `POST my-index-000001/_delete_by_query?refresh&slices=5` to let delete by query automatically parallelize using sliced scroll to slice on `_id`.
   The `slices` query parameter value specifies the number of slices to use.

specification/_global/explain/examples/request/ExplainRequestExample1.yaml

@@ -1,5 +1,5 @@
 # summary:
-# method_request: GET /my-index-000001/_explain/0
+method_request: GET /my-index-000001/_explain/0
 description: >
   Run `GET /my-index-000001/_explain/0` with the request body.
   Alternatively, run `GET /my-index-000001/_explain/0?q=message:elasticsearch`

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

@@ -1,5 +1,5 @@
 # summary:
-# method_request: "POST my-index-*/_field_caps?fields=rating"
+method_request: "POST my-index-*/_field_caps?fields=rating"
 description: >
   Run `POST my-index-*/_field_caps?fields=rating` to get field capabilities and filter indices with a query.
   Indices that rewrite the provided filter to `match_none` on every shard will be filtered from the response.

specification/_global/index/examples/request/IndexRequestExample1.yaml

@@ -1,5 +1,5 @@
 summary: Automate document IDs
-# method_request: POST my-index-000001/_doc/
+method_request: POST my-index-000001/_doc/
 description: >
   Run `POST my-index-000001/_doc/` to index a document.
   When you use the `POST /<target>/_doc/` request format, the `op_type` is automatically set to `create` and the index operation generates a unique ID for the document.

specification/_global/index/examples/request/IndexRequestExample2.yaml

@@ -1,5 +1,5 @@
 summary: Define document IDs
-# method_request: PUT my-index-000001/_doc/1
+method_request: PUT my-index-000001/_doc/1
 description: >
   Run `PUT my-index-000001/_doc/1` to insert a JSON document into the `my-index-000001` index with an `_id` of 1.
 # type: request

specification/_global/mget/examples/request/MultiGetRequestExample1.yaml

@@ -1,5 +1,5 @@
 summary: Get documents by ID
-# method_request: "GET /my-index-000001/_mget"
+method_request: "GET /my-index-000001/_mget"
 description: >
   Run `GET /my-index-000001/_mget`.
   When you specify an index in the request URI, only the document IDs are required in the request body.

specification/_global/mget/examples/request/MultiGetRequestExample2.yaml

@@ -1,5 +1,5 @@
 summary: Filter source fields
-# method_request: "GET /_mget"
+method_request: "GET /_mget"
 description: >
   Run `GET /_mget`.
   This request sets `_source` to `false` for document 1 to exclude the source entirely.

specification/_global/mget/examples/request/MultiGetRequestExample3.yaml

@@ -1,5 +1,5 @@
 summary: Get stored fields
-# method_request: "GET /_mget"
+method_request: "GET /_mget"
 description: >
   Run `GET /_mget`.
   This request retrieves `field1` and `field2` from document 1 and `field3` and `field4` from document 2.

specification/_global/mget/examples/request/MultiGetRequestExample4.yaml

@@ -1,5 +1,5 @@
 summary: Document routing
-# method_request: "GET /_mget?routing=key1"
+method_request: "GET /_mget?routing=key1"
 description: >
   Run `GET /_mget?routing=key1`.
   If routing is used during indexing, you need to specify the routing value to retrieve documents.

specification/_global/msearch_template/examples/request/MultiSearchTemplateRequestExample1.yaml

@@ -1,5 +1,5 @@
 # summary:
-# method_request: GET my-index/_msearch/template
+method_request: GET my-index/_msearch/template
 description: Run `GET my-index/_msearch/template` to run multiple templated searches.
 # type: "request"
 value: |-

specification/_global/mtermvectors/examples/request/MultiTermVectorsRequestExample1.yaml

@@ -1,5 +1,5 @@
 summary: Get multiple term vectors
-# method_request: "POST /my-index-000001/_mtermvectors"
+method_request: "POST /my-index-000001/_mtermvectors"
 description: >
   Run `POST /my-index-000001/_mtermvectors`.
   When you specify an index in the request URI, the index does not need to be specified for each documents in the request body.

specification/_global/mtermvectors/examples/request/MultiTermVectorsRequestExample2.yaml

@@ -1,5 +1,5 @@
 summary: Simplified syntax
-# method_request: POST /my-index-000001/_mtermvectors
+method_request: POST /my-index-000001/_mtermvectors
 description: >
   Run `POST /my-index-000001/_mtermvectors`.
   If all requested documents are in same index and the parameters are the same, you can use a simplified syntax.

specification/_global/mtermvectors/examples/request/MultiTermVectorsRequestExample3.yaml

@@ -1,5 +1,5 @@
 summary: Artificial documents
-# method_request: POST /_mtermvectors
+method_request: POST /_mtermvectors
 description: >
   Run `POST /_mtermvectors` to generate term vectors for artificial documents provided in the body of the request.
   The mapping used is determined by the specified `_index`.

specification/_global/put_script/examples/request/PutScriptRequestExample1.yaml

@@ -1,5 +1,5 @@
 summary: Create a search template
-# method_request: PUT _scripts/my-search-template
+method_request: PUT _scripts/my-search-template
 description: >
   Run `PUT _scripts/my-search-template` to create a search template.
 # type: request

specification/_global/put_script/examples/request/PutScriptRequestExample2.yaml

@@ -1,5 +1,5 @@
 summary: Create a stored script
-# method_request: PUT _scripts/my-stored-script
+method_request: PUT _scripts/my-stored-script
 description: >
   Run `PUT _scripts/my-stored-script` to create a stored script.
 # type: request

specification/_global/reindex/examples/request/ReindexRequestExample1.yaml

@@ -1,5 +1,5 @@
 summary: Reindex multiple sources
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   Run `POST _reindex` to reindex from multiple sources.
   The `index` attribute in source can be a list, which enables you to copy from lots of sources in one request.

specification/_global/reindex/examples/request/ReindexRequestExample10.yaml

@@ -1,5 +1,5 @@
 summary: Reindex with Painless
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   You can use Painless to reindex daily indices to apply a new template to the existing documents.
   The script extracts the date from the index name and creates a new index with `-1` appended.

specification/_global/reindex/examples/request/ReindexRequestExample11.yaml

@@ -1,5 +1,5 @@
 summary: Reindex a random subset
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   Run `POST _reindex` to extract a random subset of the source for testing.
   You might need to adjust the `min_score` value depending on the relative amount of data extracted from source.

specification/_global/reindex/examples/request/ReindexRequestExample12.yaml

@@ -1,5 +1,5 @@
 summary: Reindex modified documents
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   Run `POST _reindex` to modify documents during reindexing.
   This example bumps the version of the source document.

specification/_global/reindex/examples/request/ReindexRequestExample13.yaml

@@ -1,5 +1,5 @@
 summary: Reindex from remote on Elastic Cloud
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   When using Elastic Cloud, you can run `POST _reindex` and authenticate against a remote cluster with an API key.
 # type: request

specification/_global/reindex/examples/request/ReindexRequestExample2.yaml

@@ -1,5 +1,5 @@
 summary: Manual slicing
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   Run `POST _reindex` to slice a reindex request manually.
   Provide a slice ID and total number of slices to each request.

specification/_global/reindex/examples/request/ReindexRequestExample3.yaml

@@ -1,5 +1,5 @@
 summary: Automatic slicing
-# method_request: POST _reindex?slices=5&refresh
+method_request: POST _reindex?slices=5&refresh
 description: >
   Run `POST _reindex?slices=5&refresh` to automatically parallelize using sliced scroll to slice on `_id`.
   The `slices` parameter specifies the number of slices to use.

specification/_global/reindex/examples/request/ReindexRequestExample4.yaml

@@ -1,5 +1,5 @@
 summary: Routing
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   By default if reindex sees a document with routing then the routing is preserved unless it's changed by the script.
   You can set `routing` on the `dest` request to change this behavior.

specification/_global/reindex/examples/request/ReindexRequestExample5.yaml

@@ -1,5 +1,5 @@
 summary: Ingest pipelines
-# method_request: POST _reindex
+method_request: POST _reindex
 description: Run `POST _reindex` and use the ingest pipelines feature.
 # type: request
 value:

specification/_global/reindex/examples/request/ReindexRequestExample6.yaml

@@ -1,5 +1,5 @@
 summary: Reindex with a query
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   Run `POST _reindex` and add a query to the `source` to limit the documents to reindex.
   For example, this request copies documents into `my-new-index-000001` only if they have a `user.id` of `kimchy`.

specification/_global/reindex/examples/request/ReindexRequestExample7.yaml

@@ -1,5 +1,5 @@
 summary: Reindex with max_docs
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   You can limit the number of processed documents by setting `max_docs`.
   For example, run `POST _reindex` to copy a single document from `my-index-000001` to `my-new-index-000001`.

specification/_global/reindex/examples/request/ReindexRequestExample8.yaml

@@ -1,5 +1,5 @@
 summary: Reindex selected fields
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   You can use source filtering to reindex a subset of the fields in the original documents.
   For example, run `POST _reindex` the reindex only the `user.id` and `_doc` fields of each document.

specification/_global/reindex/examples/request/ReindexRequestExample9.yaml

@@ -1,5 +1,5 @@
 summary: Reindex new field names
-# method_request: POST _reindex
+method_request: POST _reindex
 description: >
   A reindex operation can build a copy of an index with renamed fields.
   If your index has documents with `text` and `flag` fields, you can change the latter field name to `tag` during the reindex.

specification/_global/render_search_template/examples/request/RenderSearchTemplateRequestExample1.yaml

@@ -1,5 +1,5 @@
 # summary:
-# method_request: POST _render/template
+method_request: POST _render/template
 description: Run `POST _render/template`
 # type: request
 value: |-

specification/_global/scripts_painless_execute/examples/request/ExecutePainlessScriptRequestExample1.yaml

@@ -1,5 +1,5 @@
 summary: Test context
-# method_request: POST /_scripts/painless/_execute
+method_request: POST /_scripts/painless/_execute
 description: >
   Run `POST /_scripts/painless/_execute`.
   The `painless_test` context is the default context.

specification/_global/scripts_painless_execute/examples/request/ExecutePainlessScriptRequestExample2.yaml

@@ -1,5 +1,5 @@
 summary: Filter context
-# method_request: POST /_scripts/painless/_execute
+method_request: POST /_scripts/painless/_execute
 description: >
   Run `POST /_scripts/painless/_execute` with a `filter` context.
   It treats scripts as if they were run inside a script query.

specification/_global/scripts_painless_execute/examples/request/ExecutePainlessScriptRequestExample3.yaml

@@ -1,5 +1,5 @@
 summary: Score context
-# method_request: POST /_scripts/painless/_execute
+method_request: POST /_scripts/painless/_execute
 description: >
   Run `POST /_scripts/painless/_execute` with a `score` context.
   It treats scripts as if they were run inside a `script_score` function in a `function_score` query.

specification/_global/scroll/examples/request/ScrollRequestExample1.yaml

@@ -1,5 +1,5 @@
 #
-# method_request: "GET /_search/scroll"
+method_request: "GET /_search/scroll"
 description: Run `GET /_search/scroll` to get the next batch of results for a scrolling search.
 # type: "request"
 value: |-

specification/_global/search/examples/request/SearchRequestExample1.yaml

@@ -1,5 +1,5 @@
 summary: A simple term search
-# method_request: GET /my-index-000001/_search?from=40&size=20
+method_request: GET /my-index-000001/_search?from=40&size=20
 description: >
   Run `GET /my-index-000001/_search?from=40&size=20` to run a search.
 # type: request

specification/_global/search/examples/request/SearchRequestExample2.yaml

@@ -1,5 +1,5 @@
 summary: A point in time search
-# method_request: POST /_search
+method_request: POST /_search
 description: >
   Run `POST /_search` to run a point in time search.
   The `id` parameter tells Elasticsearch to run the request using contexts from this open point in time.

specification/_global/search/examples/request/SearchRequestExample3.yaml

@@ -1,5 +1,5 @@
 summary: Search slicing
-# method_request: GET /_search
+method_request: GET /_search
 description: >
   When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently.
   The result from running the first `GET /_search` request returns documents belonging to the first slice (`id: 0`).

specification/_global/search_mvt/examples/request/SearchMvtRequestExample1.yaml

@@ -1,5 +1,5 @@
 # summary:
-# method_request: "GET museums/_mvt/location/13/4207/2692"
+method_request: "GET museums/_mvt/location/13/4207/2692"
 description: >
   Run `GET museums/_mvt/location/13/4207/2692` to search an index for `location` values that intersect the `13/4207/2692` vector tile.
 # type: "request"

specification/_global/search_template/examples/request/SearchTemplateRequestExample1.yaml

@@ -1,5 +1,5 @@
 # summary:
-# method_request: GET my-index/_search/template
+method_request: GET my-index/_search/template
 description: >
   Run `GET my-index/_search/template` to run a search with a search template.
 # type: request

specification/_global/terms_enum/examples/request/TermsEnumRequestExample1.yaml

@@ -1,5 +1,5 @@
 # summary:
-# method_request: "POST stackoverflow/_terms_enum"
+method_request: "POST stackoverflow/_terms_enum"
 description: Run `POST stackoverflow/_terms_enum`.
 # type: "request"
 value: |-

specification/_global/termvectors/examples/request/TermVectorsRequestExample1.yaml

@@ -1,5 +1,5 @@
 summary: Return stored term vectors
-# method_request: GET /my-index-000001/_termvectors/1
+method_request: GET /my-index-000001/_termvectors/1
 description: >
   Run `GET /my-index-000001/_termvectors/1` to return all information and statistics for field `text` in document 1.
 # type: request

specification/_global/termvectors/examples/request/TermVectorsRequestExample2.yaml

@@ -1,5 +1,5 @@
 summary: Per-field analyzer
-# method_request: GET /my-index-000001/_termvectors
+method_request: GET /my-index-000001/_termvectors
 description: >
   Run `GET /my-index-000001/_termvectors/1` to set per-field analyzers.
   A different analyzer than the one at the field may be provided by using the `per_field_analyzer` parameter.

specification/_global/termvectors/examples/request/TermVectorsRequestExample3.yaml

@@ -1,5 +1,5 @@
 summary: Terms filtering
-# method_request: GET /imdb/_termvectorss
+method_request: GET /imdb/_termvectorss
 description: >
   Run `GET /imdb/_termvectors` to filter the terms returned based on their tf-idf scores.
   It returns the three most "interesting" keywords from the artificial document having the given "plot" field value.

specification/_global/termvectors/examples/request/TermVectorsRequestExample4.yaml

@@ -1,5 +1,5 @@
 summary: Generate term vectors on the fly
-# method_request: GET /my-index-000001/_termvectors/1
+method_request: GET /my-index-000001/_termvectors/1
 description: >
   Run `GET /my-index-000001/_termvectors/1`.
   Term vectors which are not explicitly stored in the index are automatically computed on the fly.

specification/_global/termvectors/examples/request/TermVectorsRequestExample5.yaml

@@ -1,5 +1,5 @@
 summary: Artificial documents
-# method_request: GET /my-index-000001/_termvectors
+method_request: GET /my-index-000001/_termvectors
 description: >
   Run `GET /my-index-000001/_termvectors`.
   Term vectors can be generated for artificial documents, that is for documents not present in the index. If dynamic mapping is turned on (default), the document fields not in the original mapping will be dynamically created.

specification/_global/update/examples/request/UpdateRequestExample1.yaml

@@ -1,5 +1,5 @@
 summary: Update a counter with a script
-# method_request: POST test/_update/1
+method_request: POST test/_update/1
 description: Run `POST test/_update/1` to increment a counter by using a script.
 # type: request
 value:

specification/_global/update/examples/request/UpdateRequestExample10.yaml

@@ -1,5 +1,5 @@
 summary: Scripted upsert
-# method_request: POST test/_update/1
+method_request: POST test/_update/1
 description: >
   Run `POST test/_update/1` to perform a scripted upsert.
   When `scripted_upsert` is `true`, the script runs whether or not the document exists.