Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaced all indices with indexes. #671

Merged
merged 2 commits into from
Nov 14, 2024
Merged

Replaced all indices with indexes. #671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da62093
Replaced all indices with indexes.
dblock Nov 13, 2024
535d92e
Fixed CHANGELOG entries under the 0.1.0 release.
dblock Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Added `_common.mapping:FlatObjectProperty` ([#661](https://github.com/opensearch-project/opensearch-api-specification/pull/661))
- Added `HEAD /{index}/_doc/{id}` returning `404` ([#670](https://github.com/opensearch-project/opensearch-api-specification/pull/670))
- Added `_common.mapping:IcuCollationKeywordProperty` ([#666](https://github.com/opensearch-project/opensearch-api-specification/pull/666))
- Added `/_cluster/stats/{metric}/nodes/{node_id}` and `/_cluster/stats/{metric}/{index_metric}/nodes/{node_id}` ([#639](https://github.com/opensearch-project/opensearch-api-specification/pull/639))
- Added `PhoneAnalyzer` from `analysis-phonenumber` plugin ([#609](https://github.com/opensearch-project/opensearch-api-specification/pull/609))
- Added `/_list/indices` & `/_list/shards` api specs ([#613](https://github.com/opensearch-project/opensearch-api-specification/pull/613))

### Removed
- Removed unsupported `_common.mapping:SourceField`'s `mode` field and associated `_common.mapping:SourceFieldMode` enum ([#652](https://github.com/opensearch-project/opensearch-api-specification/pull/652))
Expand Down Expand Up @@ -135,8 +138,6 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Added API spec for `adjust_pure_negative` for bool queries ([#641](https://github.com/opensearch-project/opensearch-api-specification/pull/641))
- Added a spec style checker [#620](https://github.com/opensearch-project/opensearch-api-specification/pull/620).
- Added `remote_store` to node `Stats` ([#643](https://github.com/opensearch-project/opensearch-api-specification/pull/643))
- Added `/_cluster/stats/{metric}/nodes/{node_id}` and `/_cluster/stats/{metric}/{index_metric}/nodes/{node_id}` ([#639](https://github.com/opensearch-project/opensearch-api-specification/pull/639))
- Added `PhoneAnalyzer` from `analysis-phonenumber` plugin ([#609](https://github.com/opensearch-project/opensearch-api-specification/pull/609))

### Changed

Expand All @@ -161,7 +162,6 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Changed `cluster.reroute`'s `metric` path param to use an enum of metrics ([#586](https://github.com/opensearch-project/opensearch-api-specification/pull/586))
- Changed `indices.stats`'s `metric` path param to use an enum of metrics ([#586](https://github.com/opensearch-project/opensearch-api-specification/pull/586))
- Changed `CleanupRepositoryResults`' properties to be `int64`s ([#587](https://github.com/opensearch-project/opensearch-api-specification/pull/587))
- Added `/_list/indices` & `/_list/shards` api specs ([#613](https://github.com/opensearch-project/opensearch-api-specification/pull/613))

### Deprecated

Expand Down
2 changes: 1 addition & 1 deletion TESTING_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
112 changes: 56 additions & 56 deletions spec/namespaces/_core.yaml
View file
Open in desktop

Large diffs are not rendered by default.

50 changes: 25 additions & 25 deletions spec/namespaces/cat.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 info.
externalDocs:
url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/
parameters:
Expand All @@ -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 info.
externalDocs:
url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/
parameters:
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand Down
20 changes: 10 additions & 10 deletions spec/namespaces/cluster.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,8 +539,8 @@
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 using `actions.auto_create_index`.

Check failure on line 543 in spec/namespaces/cluster.yaml

View workflow job for this annotation

GitHub Actions / check 

[vale] reported by reviewdog 🐶
[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'actions.auto'.

Raw Output:
{"message": "[OpenSearch.SpacingPunctuation] There should be no space before and one space after the punctuation mark in 'actions.auto'.", "location": {"path": "spec/namespaces/cluster.yaml", "range": {"start": {"line": 543, "column": 80}}}, "severity": "ERROR"}
If set to `false` then data streams matching the template must always be explicitly created.
type: boolean
template:
Expand Down Expand Up @@ -1009,7 +1009,7 @@
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'
Expand All @@ -1031,14 +1031,14 @@
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
Expand Down Expand Up @@ -1175,7 +1175,7 @@
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
Expand Down Expand Up @@ -1330,7 +1330,7 @@
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'
Expand All @@ -1348,7 +1348,7 @@
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
Expand All @@ -1362,7 +1362,7 @@
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
Expand All @@ -1377,7 +1377,7 @@
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
Expand Down
2 changes: 1 addition & 1 deletion spec/namespaces/dangling_indices.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: []
Expand Down
Loading
Loading