Fix API template consistency. (opensearch-project#8488)

* Fix API template consistency. Signed-off-by: Archer <[email protected]> * Fix broken links Signed-off-by: Archer <[email protected]> * Rename request body headers Signed-off-by: Archer <[email protected]> * Fix broken links Signed-off-by: Archer <[email protected]> * Remove copy button from paths Signed-off-by: Archer <[email protected]> * Add path parameters Signed-off-by: Archer <[email protected]> * Additional doc feedback. Signed-off-by: Archer <[email protected]> * Change parameter text. Signed-off-by: Archer <[email protected]> * One more parameter. Signed-off-by: Archer <[email protected]> --------- Signed-off-by: Archer <[email protected]>
leanneeliatra · Oct 11, 2024 · be6e908 · be6e908
1 parent cd31d82
commit be6e908
Show file tree

Hide file tree

Showing 159 changed files with 1,134 additions and 1,078 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.
 
@@ -189,7 +189,7 @@ The `POST _reindex` request returns the following response fields:
 }
 ```
 
-### Response fields
+### Response body fields
 
 For PUT and POST APIs: Define all allowable response fields that can be returned in the body of the response.
 

diff --git a/_api-reference/analyze-apis.md b/_api-reference/analyze-apis.md
@@ -22,7 +22,7 @@ If you use the Security plugin, you must have the `manage index` privilege. If y
 
 ## Path and HTTP methods
 
-```
+```json
 GET /_analyze
 GET /{index}/_analyze
 POST /_analyze
@@ -81,7 +81,7 @@ text | String or Array of Strings | Text to analyze. If you provide an array of
 
 [Set a token limit](#set-a-token-limit)
 
-#### Analyze array of text strings
+### Analyze array of text strings
 
 When you pass an array of strings to the `text` field, it is analyzed as a multi-value field.
 
@@ -145,7 +145,7 @@ The previous request returns the following fields:
 }
 ````
 
-#### Apply a built-in analyzer
+### Apply a built-in analyzer
 
 If you omit the `index` path parameter, you can apply any of the built-in analyzers to the text string.
 
@@ -190,7 +190,7 @@ The previous request returns the following fields:
 }
 ````
 
-#### Apply a custom analyzer
+### Apply a custom analyzer
 
 You can create your own analyzer and specify it in an analyze request.
 
@@ -244,7 +244,7 @@ The previous request returns the following fields:
 }
 ````
 
-#### Apply a custom transient analyzer
+### Apply a custom transient analyzer
 
 You can build a custom transient analyzer from tokenizers, token filters, or character filters. Use the `filter` parameter to specify token filters.
 
@@ -373,7 +373,7 @@ The previous request returns the following fields:
 }
 ````
 
-#### Specify an index
+### Specify an index
 
 You can analyze text using an index's default analyzer, or you can specify a different analyzer.
 
@@ -446,7 +446,7 @@ The previous request returns the following fields:
 }
 ````
 
-#### Derive the analyzer from an index field
+### Derive the analyzer from an index field
 
 You can pass text and a field in the index. The API looks up the field's analyzer and uses it to analyze the text.
 
@@ -493,7 +493,7 @@ The previous request returns the following fields:
 }
 ````
 
-#### Specify a normalizer
+### Specify a normalizer
 
 Instead of using a keyword field, you can use the normalizer associated with the index. A normalizer causes the analysis change to produce a single token.
 
@@ -557,7 +557,7 @@ The previous request returns the following fields:
 }
 ````
 
-#### Get token details
+### Get token details
 
 You can obtain additional details for all tokens by setting the `explain` attribute to `true`.
 
@@ -640,7 +640,7 @@ The previous request returns the following fields:
 }
 ````
 
-#### Set a token limit
+### Set a token limit
 
 You can set a limit to the number of tokens generated. Setting a lower value reduces a node's memory usage. The default value is 10000.
 
@@ -659,7 +659,7 @@ PUT /books2
 The preceding request is an index API rather than an analyze API. See [Dynamic index-level index settings]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/index-settings/#dynamic-index-level-index-settings) for additional details.
 {: .note}
 
-### Response fields
+## Response body fields
 
 The text analysis endpoints return the following response fields.
 

diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md
@@ -18,17 +18,13 @@ The CAT aliases operation lists the mapping of aliases to indexes, plus routing
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/aliases/<alias>
 GET _cat/aliases
 ```
+{% include copy-curl.html %}
 
-
-## URL parameters
-
-All CAT aliases URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
+## Query parameters
 
 Parameter | Type | Description
 :--- | :--- | :---

diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md
@@ -17,16 +17,12 @@ The CAT allocation operation lists the allocation of disk space for indexes and
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/allocation?v
 GET _cat/allocation/<node_name>
 ```
 
-## URL parameters
-
-All CAT allocation URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
+## Query parameters
 
 Parameter | Type | Description
 :--- | :--- | :---

diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md
@@ -17,15 +17,11 @@ The CAT cluster manager operation lists information that helps identify the elec
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/cluster_manager
 ```
 
-## URL parameters
-
-All CAT cluster manager URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
+## Query parameters
 
 Parameter | Type | Description
 :--- | :--- | :---

diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md
@@ -18,15 +18,11 @@ The CAT count operation lists the number of documents in your cluster.
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/count?v
 GET _cat/count/<index>?v
 ```
 
-## URL parameters
-
-All CAT count URL parameters are optional. You can specify any of the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index).
-
 ## Example requests
 
 ```json

diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md
@@ -17,16 +17,12 @@ The CAT Field Data operation lists the memory size used by each field per node.
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/fielddata?v
 GET _cat/fielddata/<field_name>?v
 ```
 
-## URL parameters
-
-All CAT fielddata URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
+## Query parameters
 
 Parameter | Type | Description
 :--- | :--- | :---

diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md
@@ -18,14 +18,11 @@ The CAT health operation lists the status of the cluster, how long the cluster h
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/health?v
 ```
-{% include copy-curl.html %}
 
-## URL parameters
-
-All CAT health URL parameters are optional.
+## Query parameters
 
 Parameter | Type | Description
 :--- | :--- | :---
@@ -39,6 +36,7 @@ The following example request give cluster health information for the past 5 day
 ```json
 GET _cat/health?v&time=5d
 ```
+{% include copy-curl.html %}
 
 ## Example response
 

diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md
@@ -17,16 +17,12 @@ The CAT indices operation lists information related to indexes, that is, how muc
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/indices/<index>
 GET _cat/indices
 ```
 
-## URL parameters
-
-All URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index/), you can specify the following parameters:
+## Query parameters
 
 Parameter | Type | Description
 :--- | :--- | :---
@@ -40,14 +36,14 @@ expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Comb
 
 ## Example requests
 
-```
+```json
 GET _cat/indices?v
 ```
 {% include copy-curl.html %}
 
 To limit the information to a specific index, add the index name after your query.
 
-```
+```json
 GET _cat/indices/<index>?v
 ```
 {% include copy-curl.html %}

diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md
@@ -17,15 +17,11 @@ The CAT nodeattrs operation lists the attributes of custom nodes.
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/nodeattrs
 ```
 
-## URL parameters
-
-All CAT nodeattrs URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
+## Query parameters
 
 Parameter | Type | Description
 :--- | :--- | :---
@@ -36,7 +32,7 @@ cluster_manager_timeout | Time | The amount of time to wait for a connection to
 
 The following example request returns attributes about custom nodes:
 
-```
+```json
 GET _cat/nodeattrs?v
 ```
 {% include copy-curl.html %}

diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md
@@ -19,11 +19,11 @@ A few important node metrics are `pid`, `name`, `cluster_manager`, `ip`, `port`,
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/nodes
 ```
 
-## URL parameters
+## Query parameters
 
 All CAT nodes URL parameters are optional.
 
@@ -41,7 +41,7 @@ include_unloaded_segments | Boolean | Whether to include information from segmen
 
 The following example request lists node level information:
 
-```
+```json
 GET _cat/nodes?v
 ```
 {% include copy-curl.html %}

diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md
@@ -18,15 +18,11 @@ The CAT pending tasks operation lists the progress of all pending tasks, includi
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/pending_tasks
 ```
 
-## URL parameters
-
-All CAT nodes URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
+## Query parameters
 
 Parameter | Type | Description
 :--- | :--- | :---
@@ -38,7 +34,7 @@ time | Time | Specify the units for time. For example, `5d` or `7h`. For more in
 
 The following example request lists the progress of all pending node tasks:
 
-```
+```json
 GET _cat/pending_tasks?v
 ```
 {% include copy-curl.html %}

diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md
@@ -18,15 +18,15 @@ The CAT plugins operation lists the names, components, and versions of the insta
 
 ## Path and HTTP methods
 
-```
+```json
 GET _cat/plugins
 ```
 
-## URL parameters
+## Query parameters
 
-All CAT plugins URL parameters are optional.
+All parameters are optional.
 
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
+In addition to the [common parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
 
 Parameter | Type | Description
 :--- | :--- | :---
@@ -37,7 +37,7 @@ cluster_manager_timeout | Time | The amount of time to wait for a connection to
 
 The following example request lists all installed plugins:
 
-```
+```json
 GET _cat/plugins?v
 ```
 {% include copy-curl.html %}