Replaced all indices with indexes.

Signed-off-by: dblock <[email protected]>

CHANGELOG.md

@@ -143,7 +143,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Replaced nullable with `null` type ([#436](https://github.com/opensearch-project/opensearch-api-specification/pull/436))
 - Split test suite ([#472](https://github.com/opensearch-project/opensearch-api-specification/pull/472))
 - Changed `WriteResponseBase`'s `_primary_term`, `_seq_no` & `_version` to have `int64` format ([#530](https://github.com/opensearch-project/opensearch-api-specification/pull/530))
-- Adjusted indices, shards cat API to test against unassigned indices ([#551](https://github.com/opensearch-project/opensearch-api-specification/pull/551))
+- Adjusted indexes, shards cat API to test against unassigned indexes ([#551](https://github.com/opensearch-project/opensearch-api-specification/pull/551))
 - Corrected Sort schema for `/_search`'s request body ([#529](https://github.com/opensearch-project/opensearch-api-specification/issues/529))
 - Rename `Bytes` component to `StorageType` ([#552](https://github.com/opensearch-project/opensearch-api-specification/pull/552))
 - Rename `ByteSize` to `StorageSize` ([#552](https://github.com/opensearch-project/opensearch-api-specification/pull/552))

TESTING_GUIDE.md

@@ -97,7 +97,7 @@ Remember to set the `OPENSEARCH_PASSWORD` or `AWS_ACCESS_KEY_ID` and `AWS_SECRET
 
 #### FORBIDDEN/10/cluster create-index blocked (api)
 
-The cluster is most likely hitting a disk watermark threshold. This example sets the disk watermark thresholds to 1500MB low, 100MB high, and 500MB flood stage, allowing the cluster to create indices even if the disk is almost full.
+The cluster is most likely hitting a disk watermark threshold. This example sets the disk watermark thresholds to 1500MB low, 100MB high, and 500MB flood stage, allowing the cluster to create indexes even if the disk is almost full.
 
 ```bash
 curl -k -X PUT --user "admin:${OPENSEARCH_PASSWORD}" https://localhost:9200/_cluster/settings -H 'Content-Type: application/json' -d'

spec/namespaces/cat.yaml

@@ -20,7 +20,7 @@ paths:
       operationId: cat.aliases.0
       x-operation-group: cat.aliases
       x-version-added: '1.0'
-      description: Shows information about currently configured aliases to indices including filter and routing infos.
+      description: Shows information about currently configured aliases to indexes including filter and routing infos.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/
       parameters:
@@ -39,7 +39,7 @@ paths:
       operationId: cat.aliases.1
       x-operation-group: cat.aliases
       x-version-added: '1.0'
-      description: Shows information about currently configured aliases to indices including filter and routing infos.
+      description: Shows information about currently configured aliases to indexes including filter and routing infos.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/
       parameters:
@@ -122,7 +122,7 @@ paths:
       operationId: cat.count.0
       x-operation-group: cat.count
       x-version-added: '1.0'
-      description: Provides quick access to the document count of the entire cluster, or individual indices.
+      description: Provides quick access to the document count of the entire cluster, or individual indexes.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/
       parameters:
@@ -139,7 +139,7 @@ paths:
       operationId: cat.count.1
       x-operation-group: cat.count
       x-version-added: '1.0'
-      description: Provides quick access to the document count of the entire cluster, or individual indices.
+      description: Provides quick access to the document count of the entire cluster, or individual indexes.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/
       parameters:
@@ -215,7 +215,7 @@ paths:
       operationId: cat.indices.0
       x-operation-group: cat.indices
       x-version-added: '1.0'
-      description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...'
+      description: 'Returns information about indexes: number of primaries and replicas, document counts, disk size, ...'
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/
       parameters:
@@ -241,7 +241,7 @@ paths:
       operationId: cat.indices.1
       x-operation-group: cat.indices
       x-version-added: '1.0'
-      description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...'
+      description: 'Returns information about indexes: number of primaries and replicas, document counts, disk size, ...'
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/
       parameters:
@@ -1066,7 +1066,7 @@ components:
     cat.aliases::query.expand_wildcards:
       in: query
       name: expand_wildcards
-      description: Whether to expand wildcard expression to concrete indices that are open, closed or both.
+      description: Whether to expand wildcard expression to concrete indexes that are open, closed or both.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
       style: form
@@ -1331,8 +1331,8 @@ components:
       in: path
       name: index
       description: |-
-        Comma-separated list of data streams, indices, and aliases used to limit the request.
-        Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
+        Comma-separated list of data streams, indexes, and aliases used to limit the request.
+        Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Indices'
@@ -1515,8 +1515,8 @@ components:
       in: path
       name: index
       description: |-
-        Comma-separated list of data streams, indices, and aliases used to limit the request.
-        Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
+        Comma-separated list of data streams, indexes, and aliases used to limit the request.
+        Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Indices'
@@ -1563,7 +1563,7 @@ components:
     cat.indices::query.health:
       in: query
       name: health
-      description: The health status used to limit returned indices. By default, the response includes indices of any health status.
+      description: The health status used to limit returned indexes. By default, the response includes indexes of any health status.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/HealthStatus'
       style: form
@@ -2066,8 +2066,8 @@ components:
       in: path
       name: index
       description: |-
-        A comma-separated list of data streams, indices, and aliases used to limit the request.
-        Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
+        A comma-separated list of data streams, indexes, and aliases used to limit the request.
+        Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Indices'
@@ -2247,10 +2247,10 @@ components:
     cat.segment_replication::query.allow_no_indices:
       name: allow_no_indices
       in: query
-      description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).
+      description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified).
       schema:
         type: boolean
-        description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).
+        description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified).
     cat.segment_replication::query.bytes:
       name: bytes
       in: query
@@ -2276,7 +2276,7 @@ components:
     cat.segment_replication::query.expand_wildcards:
       name: expand_wildcards
       in: query
-      description: Whether to expand wildcard expression to concrete indices that are open, closed or both.
+      description: Whether to expand wildcard expression to concrete indexes that are open, closed or both.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
     cat.segment_replication::query.format:
@@ -2308,17 +2308,17 @@ components:
     cat.segment_replication::query.ignore_throttled:
       name: ignore_throttled
       in: query
-      description: Whether specified concrete, expanded or aliased indices should be ignored when throttled.
+      description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled.
       schema:
         type: boolean
-        description: Whether specified concrete, expanded or aliased indices should be ignored when throttled.
+        description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled.
     cat.segment_replication::query.ignore_unavailable:
       name: ignore_unavailable
       in: query
-      description: Whether specified concrete indices should be ignored when unavailable (missing or closed).
+      description: Whether specified concrete indexes should be ignored when unavailable (missing or closed).
       schema:
         type: boolean
-        description: Whether specified concrete indices should be ignored when unavailable (missing or closed).
+        description: Whether specified concrete indexes should be ignored when unavailable (missing or closed).
     cat.segment_replication::query.index:
       name: index
       in: query
@@ -2376,9 +2376,9 @@ components:
       in: path
       name: index
       description: |-
-        A comma-separated list of data streams, indices, and aliases used to limit the request.
+        A comma-separated list of data streams, indexes, and aliases used to limit the request.
         Supports wildcards (`*`).
-        To target all data streams and indices, omit this parameter or use `*` or `_all`.
+        To target all data streams and indexes, omit this parameter or use `*` or `_all`.
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Indices'
@@ -2455,9 +2455,9 @@ components:
       in: path
       name: index
       description: |-
-        A comma-separated list of data streams, indices, and aliases used to limit the request.
+        A comma-separated list of data streams, indexes, and aliases used to limit the request.
         Supports wildcards (`*`).
-        To target all data streams and indices, omit this parameter or use `*` or `_all`.
+        To target all data streams and indexes, omit this parameter or use `*` or `_all`.
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Indices'

spec/namespaces/cluster.yaml

@@ -506,8 +506,8 @@ components:
               allow_auto_create:
                 description: |-
                   This setting overrides the value of the `action.auto_create_index` cluster setting.
-                  If set to `true` in a template, then indices can be automatically created using that
-                  template even if auto-creation of indices is disabled via `actions.auto_create_index`.
+                  If set to `true` in a template, then indexes can be automatically created using that
+                  template even if auto-creation of indexes is disabled via `actions.auto_create_index`.
                   If set to `false` then data streams matching the template must always be explicitly created.
                 type: boolean
               template:
@@ -976,7 +976,7 @@ components:
     cluster.health::path.index:
       in: path
       name: index
-      description: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.
+      description: Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`.
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Indices'
@@ -998,14 +998,14 @@ components:
     cluster.health::query.expand_wildcards:
       in: query
       name: expand_wildcards
-      description: Whether to expand wildcard expression to concrete indices that are open, closed or both.
+      description: Whether to expand wildcard expression to concrete indexes that are open, closed or both.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
       style: form
     cluster.health::query.level:
       in: query
       name: level
-      description: Can be one of cluster, indices or shards. Controls the details level of the health information returned.
+      description: Can be one of cluster, indexes or shards. Controls the details level of the health information returned.
       schema:
         $ref: '../schemas/cluster.health.yaml#/components/schemas/Level'
       style: form
@@ -1142,7 +1142,7 @@ components:
       description: |-
         Name of the component template to create.
         OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.
-        OpenSearch Agent uses these templates to configure backing indices for its data streams.
+        OpenSearch Agent uses these templates to configure backing indexes for its data streams.
         If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.
         If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.
       required: true
@@ -1297,7 +1297,7 @@ components:
     cluster.state::path.index:
       in: path
       name: index
-      description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
+      description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes
       required: true
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/Indices'
@@ -1315,7 +1315,7 @@ components:
     cluster.state::query.allow_no_indices:
       in: query
       name: allow_no_indices
-      description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
+      description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified)
       schema:
         type: boolean
       style: form
@@ -1329,7 +1329,7 @@ components:
     cluster.state::query.expand_wildcards:
       in: query
       name: expand_wildcards
-      description: Whether to expand wildcard expression to concrete indices that are open, closed or both.
+      description: Whether to expand wildcard expression to concrete indexes that are open, closed or both.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
       style: form
@@ -1344,7 +1344,7 @@ components:
     cluster.state::query.ignore_unavailable:
       in: query
       name: ignore_unavailable
-      description: Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      description: Whether specified concrete indexes should be ignored when unavailable (missing or closed)
       schema:
         type: boolean
       style: form

spec/namespaces/dangling_indices.yaml

@@ -9,7 +9,7 @@ paths:
       operationId: dangling_indices.list_dangling_indices.0
       x-operation-group: dangling_indices.list_dangling_indices
       x-version-added: '1.0'
-      description: Returns all dangling indices.
+      description: Returns all dangling indexes.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/
       parameters: []