Rename request body headers

Signed-off-by: Archer <[email protected]>
opensearch-project · Oct 9, 2024 · d0dc1fa · d0dc1fa
1 parent 1726fd8
commit d0dc1fa
Show file tree

Hide file tree

Showing 46 changed files with 57 additions and 57 deletions.
diff --git a/API_STYLE_GUIDE.md b/API_STYLE_GUIDE.md
@@ -103,7 +103,7 @@ For GET and DELETE APIs: Introduce what you can do with the optional parameters.
 Parameter | Data type | Description
 :--- | :--- | :---
 
-### Request fields
+### Request body fields
 
 For PUT and POST APIs: Introduce what the request fields are allowed to provide in the body of the request.
 

diff --git a/_api-reference/nodes-apis/nodes-reload-secure.md b/_api-reference/nodes-apis/nodes-reload-secure.md
@@ -26,7 +26,7 @@ Parameter | Type | Description
 :--- | :--- | :---
 nodeId | String | A comma-separated list of nodeIds used to filter results. Supports [node filters]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/#node-filters). Defaults to `_all`.
 
-## Request fields
+## Request body fields
 
 The request may include an optional object containing the password for the OpenSearch keystore.
 

diff --git a/_api-reference/snapshots/create-snapshot.md b/_api-reference/snapshots/create-snapshot.md
@@ -35,7 +35,7 @@ Parameter | Data type | Description
 :--- | :--- | :---
 wait_for_completion | Boolean |  Whether to wait for snapshot creation to complete before continuing. If you include this parameter, the snapshot definition is returned after completion. |
 
-## Request fields
+## Request body fields
 
 The request body is optional.
 

diff --git a/_api-reference/snapshots/get-snapshot-status.md b/_api-reference/snapshots/get-snapshot-status.md
@@ -44,7 +44,7 @@ Snapshot API calls only work if the total number of shards across the requested
 Using the API to return the state of snapshots that are not currently running can be very costly in terms of both machine resources and processing time when querying data in the cloud. For each snapshot, each request causes a file read of all of the snapshot's shards. 
 {: .warning}
 
-## Request fields
+## Request body fields
 
 | Field | Data type | Description | 
 :--- | :--- | :---

diff --git a/_automating-configurations/api/create-workflow.md b/_automating-configurations/api/create-workflow.md
@@ -105,7 +105,7 @@ The following table lists the available query parameters. All query parameters a
 | `use_case` | String | The name of the [workflow template]({{site.url}}{{site.baseurl}}/automating-configurations/workflow-templates/#supported-workflow-templates) to use when creating the workflow. |
 | User-provided substitution expressions | String | Parameters matching substitution expressions in the template. Only allowed if `provision` is set to `true`. Optional. If `provision` is set to `false`, you can pass these parameters in the [Provision Workflow API query parameters]({{site.url}}{{site.baseurl}}/automating-configurations/api/provision-workflow/#query-parameters). |
 
-## Request fields
+## Request body fields
 
 The following table lists the available request fields.
 

diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md
@@ -539,7 +539,7 @@ GET _plugins/_rollup/jobs/<rollup_id>/_explain
 }
 ````
 
-#### Request fields
+#### Request body fields
 
 Request fields are required when creating an ISM policy. You can reference the [Index rollups API]({{site.url}}{{site.baseurl}}/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job) page for request field options.
 

diff --git a/_ml-commons-plugin/api/agent-apis/execute-agent.md b/_ml-commons-plugin/api/agent-apis/execute-agent.md
@@ -18,7 +18,7 @@ When an agent is executed, it runs the tools with which it is configured.
 POST /_plugins/_ml/agents/<agent_id>/_execute
 ```
 
-## Request fields
+## Request body fields
 
 The following table lists the available request fields.
 

diff --git a/_ml-commons-plugin/api/agent-apis/register-agent.md b/_ml-commons-plugin/api/agent-apis/register-agent.md
@@ -27,7 +27,7 @@ POST /_plugins/_ml/agents/_register
 ```
 {% include copy-curl.html %}
 
-## Request fields
+## Request body fields
 
 The following table lists the available request fields.
 

diff --git a/_ml-commons-plugin/api/async-batch-ingest.md b/_ml-commons-plugin/api/async-batch-ingest.md
@@ -19,7 +19,7 @@ Use the Asynchronous Batch Ingestion API to ingest data into your OpenSearch clu
 POST /_plugins/_ml/_batch_ingestion
 ```
 
-#### Request fields
+#### Request body fields
 
 The following table lists the available request fields.
 

diff --git a/_ml-commons-plugin/api/connector-apis/create-connector.md b/_ml-commons-plugin/api/connector-apis/create-connector.md
@@ -16,7 +16,7 @@ Creates a standalone connector. For more information, see [Connectors]({{site.ur
 POST /_plugins/_ml/connectors/_create
 ```
 
-## Request fields
+## Request body fields
 
 For a list of request fields, see [Blueprint configuration parameters]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/blueprints#configuration-parameters).
 

diff --git a/_ml-commons-plugin/api/connector-apis/update-connector.md b/_ml-commons-plugin/api/connector-apis/update-connector.md
@@ -25,7 +25,7 @@ For information about user access for this API, see [Model access control consid
 PUT /_plugins/_ml/connectors/<connector_id>
 ```
 
-## Request fields
+## Request body fields
 
 The following table lists the updatable fields. For more information about all connector fields, see [Blueprint configuration parameters]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/blueprints#configuration-parameters).
 

diff --git a/_ml-commons-plugin/api/controller-apis/create-controller.md b/_ml-commons-plugin/api/controller-apis/create-controller.md
@@ -35,7 +35,7 @@ Parameter | Data type | Description
 :--- | :--- | :---
 `model_id` | String | The model ID of the model for which you want to set rate limits. Required.
 
-## Request fields
+## Request body fields
 
 The following table lists the available request fields.
 

diff --git a/_ml-commons-plugin/api/memory-apis/create-memory.md b/_ml-commons-plugin/api/memory-apis/create-memory.md
@@ -34,7 +34,7 @@ Parameter | Data type | Description
 :--- | :--- | :---
 `memory_id` | String | The ID of the memory to be updated. Required for the PUT method.
 
-## Request fields
+## Request body fields
 
 The following table lists the available request fields.
 

diff --git a/_ml-commons-plugin/api/memory-apis/create-message.md b/_ml-commons-plugin/api/memory-apis/create-message.md
@@ -38,7 +38,7 @@ Parameter | Data type | Description
 `memory_id` | String | The ID of the memory to which to add the message. Required for the POST method.
 `message_id` | String | The ID of the message to be updated. Required for the PUT method.
 
-## Request fields
+## Request body fields
 
 The following table lists the available request fields.
 

diff --git a/_ml-commons-plugin/api/model-apis/register-model.md b/_ml-commons-plugin/api/model-apis/register-model.md
@@ -46,7 +46,7 @@ OpenSearch provides several pretrained models. For more information, see [OpenSe
 
 To register a pretrained text embedding model, the only required parameters are `name`, `version`, and `model_format`.
 
-#### Request fields
+#### Request body fields
 
 The following table lists the available request fields.
 
@@ -75,7 +75,7 @@ POST /_plugins/_ml/models/_register
 
 To register a pretrained sparse encoding model, you must set the function name to `SPARSE_ENCODING` or `SPARSE_TOKENIZE`.
 
-#### Request fields
+#### Request body fields
 
 The following table lists the available request fields.
 
@@ -107,7 +107,7 @@ POST /_plugins/_ml/models/_register
 
 To use a custom model locally within the OpenSearch cluster, you need to provide a URL and a config object for that model. For more information, see [Custom local models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/custom-local-models/).
 
-### Request fields
+### Request body fields
 
 The following table lists the available request fields.
 
@@ -170,7 +170,7 @@ POST /_plugins/_ml/models/_register
 
 To register a model hosted on a third-party platform, you can either first create a standalone connector and provide the ID of that connector or specify an internal connector for the model. For more information, see [Creating connectors for third-party ML platforms]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/connectors/).
 
-### Request fields
+### Request body fields
 
 The following table lists the available request fields.
 

diff --git a/_ml-commons-plugin/api/model-apis/update-model.md b/_ml-commons-plugin/api/model-apis/update-model.md
@@ -20,7 +20,7 @@ For information about user access for this API, see [Model access control consid
 PUT /_plugins/_ml/models/<model_id>
 ```
 
-## Request fields
+## Request body fields
 
 The following table lists the updatable fields. Not all request fields are applicable to all models. To determine whether the field is applicable to your model type, see [Register Model API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/model-apis/register-model/).
 

diff --git a/_ml-commons-plugin/api/model-group-apis/register-model-group.md b/_ml-commons-plugin/api/model-group-apis/register-model-group.md
@@ -21,7 +21,7 @@ For more information, see [Model access control]({{site.url}}{{site.baseurl}}/ml
 POST /_plugins/_ml/model_groups/_register
 ```
 
-## Request fields
+## Request body fields
 
 The following table lists the available request fields. 
 

diff --git a/_ml-commons-plugin/api/model-group-apis/update-model-group.md b/_ml-commons-plugin/api/model-group-apis/update-model-group.md
@@ -24,7 +24,7 @@ For more information, see [Model access control]({{site.url}}{{site.baseurl}}/ml
 PUT /_plugins/_ml/model_groups/<model_group_id>
 ```
 
-## Request fields
+## Request body fields
 
 Refer to [Request fields](#request-fields) for request field descriptions. 
 

diff --git a/_ml-commons-plugin/api/profile.md b/_ml-commons-plugin/api/profile.md
@@ -41,7 +41,7 @@ Parameter | Data type | Description
 `model_id` | String | Returns runtime data for a specific model. You can provide multiple model IDs as comma-separated values to retrieve multiple model profiles.
 `task_id`| String | Returns runtime data for a specific task. You can provide multiple task IDs as comma-separated values to retrieve multiple task profiles.
 
-### Request fields
+### Request body fields
 
 All profile body request fields are optional.
 

diff --git a/_observing-your-data/alerting/composite-monitors.md b/_observing-your-data/alerting/composite-monitors.md
@@ -74,7 +74,7 @@ POST _plugins/_alerting/workflows
 ```
 {% include copy-curl.html %}
 
-#### Request fields
+#### Request body fields
 
 | Field | Type | Description |
 | :--- | :--- | :--- |
@@ -526,7 +526,7 @@ GET /_plugins/_alerting/workflows/alerts?workflowIds=<workflow_ids>&getAssociate
 }
 ```
 
-#### Request fields
+#### Request body fields
 
 | Field | Type | Description |
 | :--- | :--- | :--- |
@@ -546,7 +546,7 @@ POST _plugins/_alerting/workflows/<workflow_id>/_acknowledge/alerts
 ```
 {% include copy-curl.html %}
 
-#### Request fields
+#### Request body fields
 
 | Field | Type | Description |
 | :--- | :--- | :--- |

diff --git a/_query-dsl/specialized/neural-sparse.md b/_query-dsl/specialized/neural-sparse.md
@@ -11,7 +11,7 @@ Introduced 2.11
 
 Use the `neural_sparse` query for vector field search in [neural sparse search]({{site.url}}{{site.baseurl}}/search-plugins/neural-sparse-search/). The query can use either raw text or sparse vector tokens.
 
-## Request fields
+## Request body fields
 
 Include the following request fields in the `neural_sparse` query:
 ### Example: Query by raw text

diff --git a/_query-dsl/specialized/neural.md b/_query-dsl/specialized/neural.md
@@ -9,7 +9,7 @@ nav_order: 50
 
 Use the `neural` query for vector field search in [neural search]({{site.url}}{{site.baseurl}}/search-plugins/neural-search/). 
 
-## Request fields
+## Request body fields
 
 Include the following request fields in the `neural` query:
 

diff --git a/_search-plugins/search-pipelines/collapse-processor.md b/_search-plugins/search-pipelines/collapse-processor.md
@@ -20,7 +20,7 @@ Using the `collapse` response processor will likely result in fewer than `size`
 from a set whose size is already less than or equal to `size`. To increase the likelihood of returning `size` hits, use the 
 `oversample` request processor and `truncate_hits` response processor, as shown in [this example]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/truncate-hits-processor/#oversample-collapse-and-truncate-hits).
 
-## Request fields
+## Request body fields
 
 The following table lists all request fields.
 

diff --git a/_search-plugins/search-pipelines/filter-query-processor.md b/_search-plugins/search-pipelines/filter-query-processor.md
@@ -13,7 +13,7 @@ Introduced 2.8
 
 The `filter_query` search request processor intercepts a search request and applies an additional query to the request, filtering the results. This is useful when you don't want to rewrite existing queries in your application but need additional filtering of the results.
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/ml-inference-search-response.md b/_search-plugins/search-pipelines/ml-inference-search-response.md
@@ -48,7 +48,7 @@ The following is the syntax for the `ml-inference` search response processor:
 ```
 {% include copy-curl.html %}
 
-## Request fields
+## Request body fields
 
 The following table lists the required and optional parameters for the `ml-inference` search response processor.
 

diff --git a/_search-plugins/search-pipelines/neural-query-enricher.md b/_search-plugins/search-pipelines/neural-query-enricher.md
@@ -13,7 +13,7 @@ Introduced 2.11
 
 The `neural_query_enricher` search request processor is designed to set a default machine learning (ML) model ID at the index or field level for [neural search]({{site.url}}{{site.baseurl}}/search-plugins/neural-search/) queries. To learn more about ML models, see [Using ML models within OpenSearch]({{site.url}}{{site.baseurl}}/ml-commons-plugin/using-ml-models/) and [Connecting to remote models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/index/).
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md b/_search-plugins/search-pipelines/neural-sparse-query-two-phase-processor.md
@@ -15,7 +15,7 @@ The `neural_sparse_two_phase_processor` search processor is designed to provide
 1. High-weight tokens score the documents and filter out the top documents.
 2. Low-weight tokens rescore the top documents.
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/normalization-processor.md b/_search-plugins/search-pipelines/normalization-processor.md
@@ -25,7 +25,7 @@ OpenSearch supports two search types: `query_then_fetch` and `dfs_query_then_fet
 
 When you send a search request to a node, the node becomes a _coordinating node_. During the first phase of search, the _query phase_, the coordinating node routes the search request to all shards in the index, including primary and replica shards. Each shard then runs the search query locally and returns metadata about the matching documents, which includes their document IDs and relevance scores. The `normalization-processor` then normalizes and combines scores from different query clauses. The coordinating node merges and sorts the local lists of results, compiling a global list of top documents that match the query. After that, search execution enters a _fetch phase_, in which the coordinating node requests the documents in the global list from the shards where they reside. Each shard returns the documents' `_source` to the coordinating node. Finally, the coordinating node sends a search response containing the results back to you.
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/oversample-processor.md b/_search-plugins/search-pipelines/oversample-processor.md
@@ -13,7 +13,7 @@ Introduced 2.12
 
 The `oversample` request processor multiplies the `size` parameter of the search request by a specified `sample_factor` (>= 1.0), saving the original value in the `original_size` pipeline variable. The `oversample` processor is designed to work with the [`truncate_hits` response processor]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/truncate-hits-processor/) but may be used on its own.
 
-## Request fields
+## Request body fields
 
 The following table lists all request fields.
 

diff --git a/_search-plugins/search-pipelines/personalize-search-ranking.md b/_search-plugins/search-pipelines/personalize-search-ranking.md
@@ -16,7 +16,7 @@ The `personalize_search_ranking` search response processor intercepts a search r
 To use the `personalize_search_ranking` processor, you must first install the Amazon Personalize Search Ranking (`opensearch-search-processor`) plugin. For detailed instructions, see [Installing and configuring the Amazon Personalize Search Ranking plugin](https://docs.aws.amazon.com/personalize/latest/dg/opensearch-install.html).
 {: .important}
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/rag-processor.md b/_search-plugins/search-pipelines/rag-processor.md
@@ -16,7 +16,7 @@ The `retrieval_augmented_generation` processor is a search results processor tha
 As of OpenSearch 2.12, the `retrieval_augmented_generation` processor supports only OpenAI and Amazon Bedrock models.
 {: .note}
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/rename-field-processor.md b/_search-plugins/search-pipelines/rename-field-processor.md
@@ -13,7 +13,7 @@ Introduced 2.8
 
 The `rename_field` search response processor intercepts a search response and renames the specified field. This is useful when your index and your application use different names for the same field. For example, if you rename a field in your index, the `rename_field` processor can change the new name to the old one before sending the response to your application.
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/rerank-processor.md b/_search-plugins/search-pipelines/rerank-processor.md
@@ -13,7 +13,7 @@ Introduced 2.12
 
 The `rerank` search request processor intercepts search results and passes them to a cross-encoder model to be reranked. The model reranks the results, taking into account the scoring context. Then the processor orders documents in the search results based on their new scores.
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/script-processor.md b/_search-plugins/search-pipelines/script-processor.md
@@ -26,7 +26,7 @@ The `script` search request processor intercepts a search request and adds an in
 
 For request field definitions, see [search request fields]({{site.url}}{{site.baseurl}}/api-reference/search#request-body).
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/sort-processor.md b/_search-plugins/search-pipelines/sort-processor.md
@@ -13,7 +13,7 @@ Introduced 2.16
 
 The `sort` processor sorts an array of items in either ascending or descending order. Numeric arrays are sorted numerically, while string or mixed arrays (strings and numbers) are sorted lexicographically. The processor throws an error if the input is not an array.
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/split-processor.md b/_search-plugins/search-pipelines/split-processor.md
@@ -13,7 +13,7 @@ Introduced 2.17
 
 The `split` processor splits a string field into an array of substrings based on a specified delimiter.
 
-## Request fields
+## Request body fields
 
 The following table lists all available request fields.
 

diff --git a/_search-plugins/search-pipelines/truncate-hits-processor.md b/_search-plugins/search-pipelines/truncate-hits-processor.md
@@ -22,7 +22,7 @@ The following is a common usage pattern:
 1. In the response pipeline, apply a reranking processor (which may promote results from beyond the originally requested top N) or the `collapse` processor (which may discard results after deduplication).
 1. Apply the `truncate` processor to return (at most) the originally requested number of hits.
 
-## Request fields
+## Request body fields
 
 The following table lists all request fields.
 

diff --git a/_search-plugins/searching-data/point-in-time-api.md b/_search-plugins/searching-data/point-in-time-api.md
@@ -176,7 +176,7 @@ DELETE /_search/point_in_time/_all
 
 If you want to delete one or several PITs, specify their PIT IDs in the request body.
 
-### Request fields
+### Request body fields
 
 Field | Data type | Description  
 :--- | :--- | :---
@@ -235,7 +235,7 @@ GET /_cat/pit_segments/_all
 
 If you want to list segments for one or several PITs, specify their PIT IDs in the request body.
 
-### Request fields
+### Request body fields
 
 Field | Data type | Description  
 :--- | :--- | :---