Modify the API template - add endpoints (#8959)

Signed-off-by: Fanit Kolchina <[email protected]>
opensearch-project · Dec 16, 2024 · 13af62a · 13af62a
1 parent fadfee3
commit 13af62a
Show file tree

Hide file tree

Showing 157 changed files with 176 additions and 176 deletions.
diff --git a/API_STYLE_GUIDE.md b/API_STYLE_GUIDE.md
@@ -31,13 +31,13 @@ The following sections describe the basic API documentation structure. Each sect
 Depending on where the documentation appears within a section or subsection, heading levels may be adjusted to fit with other content.
 
 1. Name of API (heading level 2)
-1. (Optional) Path and HTTP methods (heading level 3)
-1. Path parameters (heading level 3)
-1. Query parameters (heading level 3)
-1. Request fields (heading level 3)
+1. Endpoints (heading level 3)
+1. (Optional) Path parameters (heading level 3)
+1. (Optional) Query parameters (heading level 3)
+1. (Optional) Request fields (heading level 3)
 1. Example request (heading level 4)
-1. Example response (heading level 4)
-1. Response fields (heading level 3)
+1. (Optional) Example response (heading level 4)
+1. (Optional) Response fields (heading level 3)
 
 ## API name
 
@@ -55,7 +55,7 @@ If applicable, provide any caveats to its usage with a note or tip, as in the fo
 "If you use the Security plugin, make sure you have the appropriate permissions."
 (To set this point in note-style format, follow the text on the next line with {: .note})
 
-### Path and HTTP methods
+### Endpoints
 
 For relatively complex API calls that include path parameters, it's sometimes a good idea to provide an example so that users can visualize how the request is properly formed. This section is optional and includes examples that illustrate how the endpoint and path parameters fit together in the request. The following is an example of this section for the nodes stats API:
 

diff --git a/_api-reference/analyze-apis.md b/_api-reference/analyze-apis.md
@@ -20,7 +20,7 @@ The Analyze API analyzes a text string and returns the resulting tokens.
 If you use the Security plugin, you must have the `manage index` privilege. If you only want to analyze text, you must have the `manage cluster` privilege.
 {: .note}
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET /_analyze

diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md
@@ -16,7 +16,7 @@ has_children: false
 The CAT aliases operation lists the mapping of aliases to indexes, plus routing and filtering information.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/aliases/<alias>

diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md
@@ -15,7 +15,7 @@ has_children: false
 The CAT allocation operation lists the allocation of disk space for indexes and the number of shards on each node.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/allocation?v

diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md
@@ -15,7 +15,7 @@ has_children: false
 The CAT cluster manager operation lists information that helps identify the elected cluster manager node.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/cluster_manager

diff --git a/_api-reference/cat/cat-count.md b/_api-reference/cat/cat-count.md
@@ -16,7 +16,7 @@ redirect_from:
 The CAT count operation lists the number of documents in your cluster.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/count?v

diff --git a/_api-reference/cat/cat-field-data.md b/_api-reference/cat/cat-field-data.md
@@ -15,7 +15,7 @@ redirect_from:
 The CAT Field Data operation lists the memory size used by each field per node.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/fielddata?v

diff --git a/_api-reference/cat/cat-health.md b/_api-reference/cat/cat-health.md
@@ -16,7 +16,7 @@ redirect_from:
 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.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/health?v

diff --git a/_api-reference/cat/cat-indices.md b/_api-reference/cat/cat-indices.md
@@ -15,7 +15,7 @@ redirect_from:
 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.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/indices/<index>

diff --git a/_api-reference/cat/cat-nodeattrs.md b/_api-reference/cat/cat-nodeattrs.md
@@ -15,7 +15,7 @@ redirect_from:
 The CAT nodeattrs operation lists the attributes of custom nodes.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/nodeattrs

diff --git a/_api-reference/cat/cat-nodes.md b/_api-reference/cat/cat-nodes.md
@@ -17,7 +17,7 @@ The CAT nodes operation lists node-level information, including node roles and l
 A few important node metrics are `pid`, `name`, `cluster_manager`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/nodes

diff --git a/_api-reference/cat/cat-pending-tasks.md b/_api-reference/cat/cat-pending-tasks.md
@@ -16,7 +16,7 @@ redirect_from:
 The CAT pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/pending_tasks

diff --git a/_api-reference/cat/cat-plugins.md b/_api-reference/cat/cat-plugins.md
@@ -16,7 +16,7 @@ redirect_from:
 The CAT plugins operation lists the names, components, and versions of the installed plugins.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/plugins

diff --git a/_api-reference/cat/cat-recovery.md b/_api-reference/cat/cat-recovery.md
@@ -16,7 +16,7 @@ redirect_from:
 The CAT recovery operation lists all completed and ongoing index and shard recoveries.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/recovery

diff --git a/_api-reference/cat/cat-repositories.md b/_api-reference/cat/cat-repositories.md
@@ -15,7 +15,7 @@ redirect_from:
 
 The CAT repositories operation lists all snapshot repositories for a cluster.
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/repositories

diff --git a/_api-reference/cat/cat-segment-replication.md b/_api-reference/cat/cat-segment-replication.md
@@ -15,7 +15,7 @@ The CAT segment replication operation returns information about active and last
 Call the CAT Segment Replication API only on indexes with segment replication enabled.
 {: .note}
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET /_cat/segment_replication

diff --git a/_api-reference/cat/cat-segments.md b/_api-reference/cat/cat-segments.md
@@ -16,7 +16,7 @@ redirect_from:
 The cat segments operation lists Lucene segment-level information for each index.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/segments

diff --git a/_api-reference/cat/cat-shards.md b/_api-reference/cat/cat-shards.md
@@ -16,7 +16,7 @@ redirect_from:
 The CAT shards operation lists the state of all primary and replica shards and how they are distributed.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/shards

diff --git a/_api-reference/cat/cat-snapshots.md b/_api-reference/cat/cat-snapshots.md
@@ -16,7 +16,7 @@ redirect_from:
 The CAT snapshots operation lists all snapshots for a repository.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/snapshots

diff --git a/_api-reference/cat/cat-tasks.md b/_api-reference/cat/cat-tasks.md
@@ -15,7 +15,7 @@ redirect_from:
 
 The CAT tasks operation lists the progress of all tasks currently running on your cluster.
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/tasks

diff --git a/_api-reference/cat/cat-templates.md b/_api-reference/cat/cat-templates.md
@@ -16,7 +16,7 @@ redirect_from:
 The CAT templates operation lists the names, patterns, order numbers, and version numbers of index templates.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/templates

diff --git a/_api-reference/cat/cat-thread-pool.md b/_api-reference/cat/cat-thread-pool.md
@@ -15,7 +15,7 @@ redirect_from:
 The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cat/thread_pool

diff --git a/_api-reference/cluster-api/cluster-allocation.md b/_api-reference/cluster-api/cluster-allocation.md
@@ -17,7 +17,7 @@ The most basic cluster allocation explain request finds an unassigned shard and
 If you add some options, you can instead get information on a specific shard, including why OpenSearch assigned it to its current node.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cluster/allocation/explain

diff --git a/_api-reference/cluster-api/cluster-awareness.md b/_api-reference/cluster-api/cluster-awareness.md
@@ -15,7 +15,7 @@ redirect_from:
 
 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.
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 PUT /_cluster/routing/awareness/<attribute>/weights

diff --git a/_api-reference/cluster-api/cluster-decommission.md b/_api-reference/cluster-api/cluster-decommission.md
@@ -18,7 +18,7 @@ The cluster decommission operation adds support decommissioning based on awarene
 For more information about allocation awareness, see [Shard allocation awareness]({{site.url}}{{site.baseurl}}//opensearch/cluster/#shard-allocation-awareness).
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 PUT  /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}

diff --git a/_api-reference/cluster-api/cluster-health.md b/_api-reference/cluster-api/cluster-health.md
@@ -18,7 +18,7 @@ The most basic cluster health request returns a simple status of the health of y
 To get the status of a specific index, provide the index name.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cluster/health

diff --git a/_api-reference/cluster-api/cluster-settings.md b/_api-reference/cluster-api/cluster-settings.md
@@ -14,7 +14,7 @@ redirect_from:
 
 The cluster settings operation lets you check the current settings for your cluster, review default settings, and change settings. When you update a setting using the API, OpenSearch applies it to all nodes in the cluster.
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cluster/settings

diff --git a/_api-reference/cluster-api/cluster-stats.md b/_api-reference/cluster-api/cluster-stats.md
@@ -16,7 +16,7 @@ redirect_from:
 The cluster stats API operation returns statistics about your cluster.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _cluster/stats

diff --git a/_api-reference/count.md b/_api-reference/count.md
@@ -14,7 +14,7 @@ The count API gives you quick access to the number of documents that match a que
 You can also use it to check the document count of an index, data stream, or cluster.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET <target>/_count/<id>

diff --git a/_api-reference/document-apis/bulk-streaming.md b/_api-reference/document-apis/bulk-streaming.md
@@ -19,7 +19,7 @@ The streaming bulk operation lets you add, update, or delete multiple documents
 The default HTTP transport method does not support streaming. You must install the [`transport-reactor-netty4`]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/network-settings/#selecting-the-transport) HTTP transport plugin and use it as the default HTTP transport layer. Both the `transport-reactor-netty4` plugin and the Streaming Bulk API are experimental.
 {: .note}
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 POST _bulk/stream

diff --git a/_api-reference/document-apis/bulk.md b/_api-reference/document-apis/bulk.md
@@ -19,7 +19,7 @@ Beginning in OpenSearch 2.9, when indexing documents using the bulk operation, t
 
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 POST _bulk

diff --git a/_api-reference/document-apis/delete-by-query.md b/_api-reference/document-apis/delete-by-query.md
@@ -13,7 +13,7 @@ redirect_from:
 
 You can include a query as part of your delete request so OpenSearch deletes all documents that match that query.
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 POST <index>/_delete_by_query

diff --git a/_api-reference/document-apis/delete-document.md b/_api-reference/document-apis/delete-document.md
@@ -13,7 +13,7 @@ redirect_from:
 
 If you no longer need a document in your index, you can use the delete document API operation to delete it.
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 DELETE /<index>/_doc/<_id>

diff --git a/_api-reference/document-apis/get-documents.md b/_api-reference/document-apis/get-documents.md
@@ -14,7 +14,7 @@ redirect_from:
 After adding a JSON document to your index, you can use the Get Document API operation to retrieve the document's information and data.
 
 
-## Path and HTTP methods
+## Endpoints
 
 Use the GET method to retrieve a document and its source or stored fields from a particular index. Use the HEAD method to verify that a document exists:
 

diff --git a/_api-reference/document-apis/index-document.md b/_api-reference/document-apis/index-document.md
@@ -14,7 +14,7 @@ redirect_from:
 You can use the `Index document` operation to add a single document to your index.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 PUT <index>/_doc/<_id>

diff --git a/_api-reference/document-apis/multi-get.md b/_api-reference/document-apis/multi-get.md
@@ -13,7 +13,7 @@ redirect_from:
 
 The multi-get operation allows you to run multiple GET operations in one request, so you can get back all documents that match your criteria.
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET _mget

diff --git a/_api-reference/document-apis/reindex.md b/_api-reference/document-apis/reindex.md
@@ -15,7 +15,7 @@ redirect_from:
 The reindex document API operation lets you copy all or a subset of your data from a source index into a destination index.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 POST /_reindex

diff --git a/_api-reference/document-apis/update-by-query.md b/_api-reference/document-apis/update-by-query.md
@@ -14,7 +14,7 @@ redirect_from:
 You can include a query and a script as part of your update request so OpenSearch can run the script to update all of the documents that match the query.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 POST <index1>, <index2>/_update_by_query

diff --git a/_api-reference/document-apis/update-document.md b/_api-reference/document-apis/update-document.md
@@ -22,7 +22,7 @@ You cannot explicitly specify an ingest pipeline when calling the Update Documen
 the index [sample-index1] has a default ingest pipeline or a final ingest pipeline, the support of the ingest pipelines for update operation causes unexpected result and will be removed in 3.0.0
 ```
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 POST /<index>/_update/<_id>

diff --git a/_api-reference/explain.md b/_api-reference/explain.md
@@ -18,7 +18,7 @@ The explain API is an expensive operation in terms of both resources and time. O
 {: .warning }
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 GET <index>/_explain/<id>

diff --git a/_api-reference/index-apis/alias.md b/_api-reference/index-apis/alias.md
@@ -15,7 +15,7 @@ redirect_from:
 An alias is a virtual pointer that you can use to reference one or more indexes. Creating and updating aliases are atomic operations, so you can reindex your data and point an alias at it without any downtime.
 
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 POST _aliases

diff --git a/_api-reference/index-apis/blocks.md b/_api-reference/index-apis/blocks.md
@@ -12,7 +12,7 @@ nav_order: 6
 Use the Blocks API to limit certain operations on a specified index. Different types of blocks allow you to restrict index write, read, or metadata operations. 
 For example, adding a `write` block through the API ensures that all index shards have properly accounted for the block before returning a successful response. Any in-flight write operations to the index must be complete before the `write` block takes effect.
 
-## Path and HTTP methods
+## Endpoints
 
 ```json
 PUT /<index>/_block/<block>
-Original file line number
+Diff line change
@@ Expand Up @@
-    ## Path and HTTP methods
+    ## Endpoints
     ```json
     POST _bulk
@@ Expand Down @@