Merge pull request #1 from samipak458/patch01

[DOC] Format all API pages according to the API template
samipak458 · Oct 6, 2023 · 185c4a5 · 185c4a5
2 parents 7fd7cfa + 1ce4df0
commit 185c4a5
Show file tree

Hide file tree

Showing 107 changed files with 323 additions and 209 deletions.
diff --git a/_api-reference/analyze-apis.md b/_api-reference/analyze-apis.md
@@ -9,6 +9,8 @@ redirect_from:
 ---
 
 # Analyze API
+**Introduced 1.0**
+{: .label .label-purple }
 
 The Analyze API allows you to perform [text analysis]({{site.url}}{{site.baseurl}}/api-reference/analyze-apis/), which is the process of converting unstructured text into individual tokens (usually words) that are optimized for search.
 

diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md
@@ -10,12 +10,12 @@ has_children: false
 ---
 
 # CAT aliases
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT aliases operation lists the mapping of aliases to indexes, plus routing and filtering information.
 
-## Example
+**Example**
 
 ```json
 GET _cat/aliases?v

diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md
@@ -9,12 +9,12 @@ has_children: false
 ---
 
 # CAT allocation
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT allocation operation lists the allocation of disk space for indexes and the number of shards on each node.
 
-## Example
+**Example**
 
 ```json
 GET _cat/allocation?v

diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md
@@ -9,12 +9,12 @@ has_children: false
 ---
 
 # CAT cluster_manager
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT cluster manager operation lists information that helps identify the elected cluster manager node.
 
-## Example
+**Example**
 
 ```
 GET _cat/cluster_manager?v
@@ -36,6 +36,7 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-refe
 Parameter | Type | Description
 :--- | :--- | :---
 cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
+
 ## Response
 
 ```json

diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT count
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT count operation lists the number of documents in your cluster.
 
-## Example
+**Example**
 
 ```json
 GET _cat/count?v

diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md
@@ -9,12 +9,12 @@ redirect_from:
 ---
 
 # CAT fielddata
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT fielddata operation lists the memory size used by each field per node.
 
-## Example
+**Example**
 
 ```json
 GET _cat/fielddata?v

diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT health
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.
 
-## Example
+**Example**
 
 ```json
 GET _cat/health?v

diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md
@@ -9,12 +9,12 @@ redirect_from:
 ---
 
 # CAT indices
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT indices operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
 
-## Example
+**Example**
 
 ```
 GET _cat/indices?v

diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md
@@ -9,12 +9,12 @@ redirect_from:
 ---
 
 # CAT nodeattrs
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT nodeattrs operation lists the attributes of custom nodes.
 
-## Example
+**Example**
 
 ```
 GET _cat/nodeattrs?v

diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md
@@ -10,14 +10,14 @@ redirect_from:
 ---
 
 # CAT nodes
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT nodes operation lists node-level information, including node roles and load metrics.
 
 A few important node metrics are `pid`, `name`, `cluster_manager`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`.
 
-## Example
+**Example**
 
 ```
 GET _cat/nodes?v

diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT pending tasks
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.
 
-## Example
+**Example**
 
 ```
 GET _cat/pending_tasks?v

diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT plugins
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT plugins operation lists the names, components, and versions of the installed plugins.
 
-## Example
+**Example**
 
 ```
 GET _cat/plugins?v

diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT recovery
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT recovery operation lists all completed and ongoing index and shard recoveries.
 
-## Example
+**Example**
 
 ```
 GET _cat/recovery?v

diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT repositories
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT repositories operation lists all completed and ongoing index and shard recoveries.
 
-## Example
+**Example**
 
 ```
 GET _cat/repositories?v

diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md
@@ -7,7 +7,7 @@ has_children: false
 ---
 
 # CAT segment replication
-Introduced 2.7
+**Introduced 2.7**
 {: .label .label-purple }
 
 The CAT segment replication operation returns information about active and last completed [segment replication]({{site.url}}{{site.baseurl}}/opensearch/segment-replication/index) events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging.
@@ -47,7 +47,7 @@ Parameter | Data type  | Description
 `v` | Boolean    | If `true`, the response includes column headings. Defaults to `false`.
 `s` | String     | Specifies to sort the results. For example, `s=shardId:desc` sorts by shardId in descending order.
 
-## Examples 
+### Examples 
 
 The following examples illustrate various segment replication responses.
 

diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT segments
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The cat segments operation lists Lucene segment-level information for each index.
 
-## Example
+**Example**
 
 ```
 GET _cat/segments?v

diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT shards
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT shards operation lists the state of all primary and replica shards and how they are distributed.
 
-## Example
+**Example**
 
 ```
 GET _cat/shards?v

diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT snapshots
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT snapshots operation lists all snapshots for a repository.
 
-## Example
+**Example**
 
 ```
 GET _cat/snapshots?v

diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md
@@ -10,12 +10,12 @@ redirect_from:
 ---
 
 # CAT tasks
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The CAT tasks operation lists the progress of all tasks currently running on your cluster.
 
-## Example
+**Example**
 
 ```
 GET _cat/tasks?v

diff --git a/_api-reference/cluster-api/cluster-allocation.md b/_api-reference/cluster-api/cluster-allocation.md
@@ -9,15 +9,15 @@ redirect_from:
 ---
 
 # Cluster allocation explain
-Introduced 1.0
+**Introduced 1.0**
 {: .label .label-purple }
 
 The most basic cluster allocation explain request finds an unassigned shard and explains why it can't be allocated to a node.
 
 If you add some options, you can instead get information on a specific shard, including why OpenSearch assigned it to its current node.
 
 
-## Example
+**Example**
 
 ```json
 GET _cluster/allocation/explain?include_yes_decisions=true

diff --git a/_api-reference/cluster-api/cluster-awareness.md b/_api-reference/cluster-api/cluster-awareness.md
@@ -10,6 +10,8 @@ redirect_from:
 ---
 
 # Cluster routing and awareness
+**Introduced 1.0**
+{: .label .label-purple }
 
 To control the distribution of search or HTTP traffic, you can use the weights per awareness attribute to control the distribution of search or HTTP traffic across zones. This is commonly used for zonal deployments, heterogeneous instances, and routing traffic away from zones during zonal failure.
 
@@ -49,11 +51,11 @@ In the following example request body, `zone_1` and `zone_2` receive 50 requests
 }
 ```
 
-## Example: Weighted round robin search
+#### Example: Weighted round robin search
 
 The following example request creates a round robin shard allocation for search traffic by using an undefined ratio:
 
-### Request
+#### Request
 
 ```json
 PUT /_cluster/routing/awareness/zone/weights
@@ -69,7 +71,7 @@ PUT /_cluster/routing/awareness/zone/weights
 ```
 {% include copy-curl.html %}
 
-### Response
+#### Response
 
 ```
 {
@@ -78,18 +80,18 @@ PUT /_cluster/routing/awareness/zone/weights
 ```
 
 
-## Example: Getting weights for all zones
+#### Example: Getting weights for all zones
 
 The following example request gets weights for all zones.
 
-### Request
+#### Request
 
 ```json
 GET /_cluster/routing/awareness/zone/weights
 ```
 {% include copy-curl.html %}
 
-### Response
+#### Response
 
 OpenSearch responds with the weight of each zone:
 
@@ -106,18 +108,18 @@ OpenSearch responds with the weight of each zone:
 }
 ```
 
-## Example: Deleting weights
+#### Example: Deleting weights
 
 You can remove your weight ratio for each zone using the `DELETE` method.
 
-### Request
+#### Request
 
 ```json
 DELETE /_cluster/routing/awareness/zone/weights
 ```
 {% include copy-curl.html %}
 
-### Response
+#### Response
 
 ```json
 {