Replaced all indices with indexes. #671

dblock · 2024-11-13T19:43:38Z

Description

Replaces all "indices" with "indexes".

There's a debate whether this is right in opensearch-project/documentation-website#8696, but in the meantime this standardizes the language to match what we have in the documentation and runs a Vale pass on many descriptions and avoids tripping lots of future contributions.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

github-actions · 2024-11-13T19:45:48Z

Changes Analysis

Commit SHA: 535d92e
Comparing To SHA: 1c46b69

API Changes

Summary

├─┬Paths
│ ├─┬/{index}/_count
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (17339:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (17328:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (17395:20)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17395:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17339:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (17328:20)
│ ├─┬/{index}
│ │ ├─┬GET
│ │ │ ├──[🔀] description (9544:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20166:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (20176:20)
│ │ ├─┬DELETE
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (19353:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19365:20)
│ │ └─┬HEAD
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19557:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (19565:20)
│ ├─┬/_mapping
│ │ └─┬GET
│ │   ├──[🔀] description (2982:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19966:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (19932:20)
│ ├─┬/{index}/_rank_eval
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23375:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23382:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23358:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (23368:20)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23368:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23375:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23382:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (23358:20)
│ ├─┬/_plugins/_ism/change_policy/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21547:20)
│ ├─┬/_cluster/state/{metric}/{index}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17196:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17214:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17243:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (17228:20)
│ ├─┬/_search_shards
│ │ ├─┬GET
│ │ │ ├──[🔀] description (8155:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (23662:20)
│ │ └─┬POST
│ │   ├──[🔀] description (8177:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (23662:20)
│ ├─┬/{index}/_segments
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20782:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20793:20)
│ ├─┬/_plugins/_ism/retry
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21664:20)
│ ├─┬/_opendistro/_security/api/allowlist
│ │ └─┬PUT
│ │   └──[🔀] description (14092:20)
│ ├─┬/{index}/_shard_stores
│ │ └─┬GET
│ │   ├──[🔀] description (11554:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20828:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20855:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20836:20)
│ ├─┬/_cat/segments/{index}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (16146:20)
│ ├─┬/{index}/_upgrade
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ ├──[🔀] description (20136:20)
│ │ │ │ └─┬Schema
│ │ │ │   └──[🔀] description (20139:22)
│ │ │ ├─┬Parameters
│ │ │ │ ├──[🔀] description (20146:20)
│ │ │ │ └─┬Schema
│ │ │ │   └──[🔀] description (20149:22)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20153:20)
│ │ │ └─┬Parameters
│ │ │   ├──[🔀] description (20159:20)
│ │ │   └─┬Schema
│ │ │     └──[🔀] description (20162:22)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (21247:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (21250:22)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (21260:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (21263:22)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (21237:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (21240:22)
│ │   └─┬Parameters
│ │     └──[🔀] description (21254:20)
│ ├─┬/{index}/_recovery
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (20632:20)
│ ├─┬/{index}/_flush
│ │ ├─┬GET
│ │ │ ├──[🔀] description (10648:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (19625:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19636:20)
│ │ └─┬POST
│ │   ├──[🔀] description (10670:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19636:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (19625:20)
│ ├─┬/_cat/recovery/{index}
│ │ └──GET
│ ├─┬/{index}/_alias
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (19774:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19752:20)
│ │ └─┬PUT
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20338:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬is_write_index
│ │           └──[🔀] description (26157:30)
│ ├─┬/_field_caps
│ │ ├─┬GET
│ │ │ ├──[🔀] description (2322:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18391:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (18415:20)
│ │ └─┬POST
│ │   ├──[🔀] description (2345:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18415:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18391:20)
│ ├─┬/_settings/{name}
│ │ └─┬GET
│ │   ├──[🔀] description (8598:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20015:20)
│ ├─┬/{index}/_cache/clear
│ │ └─┬POST
│ │   ├──[🔀] description (10060:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18940:20)
│ │   └─┬Parameters
│ │     ├──[🔀] description (18992:20)
│ │     └─┬Schema
│ │       └──[🔀] description (18998:22)
│ ├─┬/{index}/_alias/{name}
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (19752:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19774:20)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20338:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬is_write_index
│ │ │         └──[🔀] description (26157:30)
│ │ ├─┬POST
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20338:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬is_write_index
│ │ │         └──[🔀] description (26157:30)
│ │ ├─┬DELETE
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19227:20)
│ │ └─┬HEAD
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19422:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19440:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (19460:20)
│ ├─┬/_nodes/stats/{metric}/{index_metric}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (22833:20)
│ ├─┬/{index}/_open
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20246:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20259:20)
│ ├─┬/_plugins/_knn/warmup/{index}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     ├──[🔀] description (22092:20)
│ │     └─┬Schema
│ │       └──[🔀] description (22095:22)
│ ├─┬/_opendistro/_knn/warmup/{index}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     ├──[🔀] description (22092:20)
│ │     └─┬Schema
│ │       └──[🔀] description (22095:22)
│ ├─┬/_segments
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (20793:20)
│ ├─┬/{index}/_aliases/{name}
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20338:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬is_write_index
│ │ │         └──[🔀] description (26157:30)
│ │ ├─┬POST
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20338:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬is_write_index
│ │ │         └──[🔀] description (26157:30)
│ │ └─┬DELETE
│ │   └─┬Parameters
│ │     └──[🔀] description (19227:20)
│ ├─┬/_search/scroll/{scroll_id}
│ │ └─┬DELETE
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] description (25886:26)
│ ├─┬/_cat/segment_replication/{index}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (16047:20)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (16086:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (16089:22)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (16079:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (16082:22)
│ │   └─┬Parameters
│ │     ├──[🔀] description (16018:20)
│ │     └─┬Schema
│ │       └──[🔀] description (16021:22)
│ ├─┬/_opendistro/_ism/remove
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21645:20)
│ ├─┬/_dangling
│ │ └─┬GET
│ │   └──[🔀] description (2137:20)
│ ├─┬/_opendistro/_ism/explain/{index}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (21568:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21568:20)
│ ├─┬/{index}/_block/{block}
│ │ └─┬PUT
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18858:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18866:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18887:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18880:20)
│ ├─┬/_snapshot/{repository}/{snapshot}
│ │ ├─┬PUT
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       ├─┬ignore_unavailable
│ │ │       │ └──[🔀] description (27262:30)
│ │ │       ├─┬include_global_state
│ │ │       │ └──[🔀] description (27265:30)
│ │ │       ├─┬feature_states
│ │ │       │ └──[🔀] description (27270:30)
│ │ │       └─┬partial
│ │ │         └──[🔀] description (27277:30)
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         ├─┬feature_states
│ │         │ └──[🔀] description (27270:30)
│ │         ├─┬include_global_state
│ │         │ └──[🔀] description (27265:30)
│ │         ├─┬partial
│ │         │ └──[🔀] description (27277:30)
│ │         └─┬ignore_unavailable
│ │           └──[🔀] description (27262:30)
│ ├─┬/_upgrade
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20153:20)
│ │ │ ├─┬Parameters
│ │ │ │ ├──[🔀] description (20159:20)
│ │ │ │ └─┬Schema
│ │ │ │   └──[🔀] description (20162:22)
│ │ │ └─┬Parameters
│ │ │   ├──[🔀] description (20146:20)
│ │ │   └─┬Schema
│ │ │     └──[🔀] description (20149:22)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (21260:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (21263:22)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (21247:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (21250:22)
│ │   └─┬Parameters
│ │     └──[🔀] description (21254:20)
│ ├─┬/_settings
│ │ ├─┬GET
│ │ │ ├──[🔀] description (8547:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (20015:20)
│ │ └─┬PUT
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20548:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20510:20)
│ ├─┬/_cat/count/{index}
│ │ └─┬GET
│ │   ├──[🔀] description (601:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (15101:20)
│ ├─┬/{index}/_search/template
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23725:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23715:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (23761:20)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23715:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23725:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (23761:20)
│ ├─┬/_cat/indices
│ │ └─┬GET
│ │   ├──[🔀] description (697:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (15334:20)
│ ├─┬/{index}/_update_by_query
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (25653:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (25398:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (25442:20)
│ ├─┬/_plugins/_ism/add
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21528:20)
│ ├─┬/{index}/_delete_by_query
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17722:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17678:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (17928:20)
│ ├─┬/{index}/_close
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (19093:20)
│ ├─┬/_opendistro/_refresh_search_analyzers/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21625:20)
│ ├─┬/_plugins/_ism/remove/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21645:20)
│ ├─┬/_cat/count
│ │ └─┬GET
│ │   └──[🔀] description (579:20)
│ ├─┬/_opendistro/_ism/add/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21528:20)
│ ├─┬/{index}/_search_shards
│ │ ├─┬GET
│ │ │ ├──[🔀] description (11314:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23654:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (23662:20)
│ │ └─┬POST
│ │   ├──[🔀] description (11337:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23654:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (23662:20)
│ ├─┬/_plugins/_security/api/allowlist
│ │ └─┬PUT
│ │   └──[🔀] description (5760:20)
│ ├─┬/_validate/query
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (21301:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21301:20)
│ ├─┬/_search
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23995:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (24217:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23875:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       ├─┬stats
│ │ │       │ └──[🔀] description (27000:30)
│ │ │       ├─┬terminate_after
│ │ │       │ └──[🔀] description (26969:30)
│ │ │       └─┬indices_boost
│ │ │         └──[🔀] description (26901:30)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23875:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (24217:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23995:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         ├─┬stats
│ │         │ └──[🔀] description (27000:30)
│ │         ├─┬terminate_after
│ │         │ └──[🔀] description (26969:30)
│ │         └─┬indices_boost
│ │           └──[🔀] description (26901:30)
│ ├─┬/_search/scroll
│ │ └─┬DELETE
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[🔀] description (25886:26)
│ ├─┬/_cat/aliases
│ │ └─┬GET
│ │   ├──[🔀] description (452:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (14837:20)
│ ├─┬/{index}/_field_caps
│ │ ├─┬GET
│ │ │ ├──[🔀] description (10599:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18391:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (18415:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (18383:20)
│ │ └─┬POST
│ │   ├──[🔀] description (10623:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18383:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (18415:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (18391:20)
│ ├─┬/_cluster/health/{index}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (16904:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (16875:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (16897:20)
│ ├─┬/_search/template
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23725:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (23761:20)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23725:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (23761:20)
│ ├─┬/{index}/_source/{id}
│ │ └─┬HEAD
│ │   └─┬Parameters
│ │     └──[🔀] description (18100:20)
│ ├─┬/_plugins/_ism/add/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21528:20)
│ ├─┬/{index}/_search
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23995:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23875:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23830:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (24217:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       ├─┬indices_boost
│ │ │       │ └──[🔀] description (26901:30)
│ │ │       ├─┬stats
│ │ │       │ └──[🔀] description (27000:30)
│ │ │       └─┬terminate_after
│ │ │         └──[🔀] description (26969:30)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (24217:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23830:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23995:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23875:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         ├─┬indices_boost
│ │         │ └──[🔀] description (26901:30)
│ │         ├─┬stats
│ │         │ └──[🔀] description (27000:30)
│ │         └─┬terminate_after
│ │           └──[🔀] description (26969:30)
│ ├─┬/{index}/_mapping
│ │ ├─┬GET
│ │ │ ├──[🔀] description (10719:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (19966:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19932:20)
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20428:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (20436:20)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20428:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20436:20)
│ ├─┬/_opendistro/_ism/change_policy
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21547:20)
│ ├─┬/_opendistro/_ism/change_policy/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21547:20)
│ ├─┬/_plugins/_ism/retry/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21664:20)
│ ├─┬/{index}/_settings
│ │ ├─┬GET
│ │ │ ├──[🔀] description (11474:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20015:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19996:20)
│ │ └─┬PUT
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20499:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20548:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20510:20)
│ ├─┬/_opendistro/_ism/retry/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21664:20)
│ ├─┬/{index}/_forcemerge
│ │ └─┬POST
│ │   ├──[🔀] description (10693:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19688:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19695:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19680:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (19710:20)
│ ├─┬/_cluster/health
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (16904:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (16897:20)
│ ├─┬/{index}/_settings/{name}
│ │ └─┬GET
│ │   ├──[🔀] description (11527:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19996:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20015:20)
│ ├─┬/_plugins/_ism/explain/{index}
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (21568:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21568:20)
│ ├─┬/{index}/_validate/query
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (21283:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (21301:20)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (21283:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (21301:20)
│ ├─┬/_flush
│ │ ├─┬GET
│ │ │ ├──[🔀] description (2369:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19636:20)
│ │ └─┬POST
│ │   ├──[🔀] description (2390:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (19636:20)
│ ├─┬/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}
│ │ └─┬PUT
│ │   └──[🔀] description (8924:20)
│ ├─┬/_cat/indices/{index}
│ │ └─┬GET
│ │   ├──[🔀] description (728:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (15285:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (15334:20)
│ ├─┬/{index}/_msearch/template
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (22492:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (22492:20)
│ ├─┬/_cluster/state
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17228:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17214:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (17243:20)
│ ├─┬/_opendistro/_ism/remove/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21645:20)
│ ├─┬/_component_template/{name}
│ │ ├─┬PUT
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (17038:20)
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬allow_auto_create
│ │ │         └──[🔀] description (25917:30)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17038:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬allow_auto_create
│ │           └──[🔀] description (25917:30)
│ ├─┬/{index}/_mapping/field/{fields}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19827:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (19838:20)
│ ├─┬/_mapping/field/{fields}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (19838:20)
│ ├─┬/_plugins/_ism/change_policy
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21547:20)
│ ├─┬/_index_template/_simulate_index/{name}
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬allow_auto_create
│ │           └──[🔀] description (26354:30)
│ ├─┬/_cluster/state/{metric}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17214:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17243:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (17228:20)
│ ├─┬/{index}/_aliases
│ │ └─┬PUT
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20338:20)
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬is_write_index
│ │           └──[🔀] description (26157:30)
│ ├─┬/_stats
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (21167:20)
│ ├─┬/_shard_stores
│ │ └─┬GET
│ │   ├──[🔀] description (8624:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20836:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20855:20)
│ ├─┬/_data_stream/_stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └─┬backing_indices
│ │             └──[🔀] description (28673:30)
│ ├─┬/_cat/aliases/{name}
│ │ └─┬GET
│ │   ├──[🔀] description (476:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (14837:20)
│ ├─┬/_data_stream/{name}/_stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └─┬backing_indices
│ │             └──[🔀] description (28673:30)
│ ├─┬/{index}/_stats
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (21116:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (21167:20)
│ ├─┬/{index}/_msearch
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (22545:20)
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (22545:20)
│ ├─┬/_rank_eval
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23368:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (23375:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (23382:20)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23368:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (23382:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (23375:20)
│ ├─┬/{index}/_refresh
│ │ ├─┬GET
│ │ │ ├──[🔀] description (11134:20)
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (20670:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (20659:20)
│ │ └─┬POST
│ │   ├──[🔀] description (11154:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (20659:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20670:20)
│ ├─┬/{index}/_doc/{id}
│ │ └─┬HEAD
│ │   └─┬Parameters
│ │     └──[🔀] description (18186:20)
│ ├─┬/_cat/shards/{index}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (16225:20)
│ ├─┬/_plugins/_ism/remove
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21645:20)
│ ├─┬/{index}/_search/point_in_time
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (17459:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (17462:22)
│ │   └─┬Parameters
│ │     └──[🔀] description (17476:20)
│ ├─┬/_plugins/_refresh_search_analyzers/{index}
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21625:20)
│ ├─┬/_cache/clear
│ │ └─┬POST
│ │   ├──[🔀] description (409:20)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (18992:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (18998:22)
│ │   └─┬Parameters
│ │     └──[🔀] description (18940:20)
│ ├─┬/_resolve/index/{name}
│ │ └─┬GET
│ │   ├──[🔀] description (7793:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20697:20)
│ ├─┬/_refresh
│ │ ├─┬GET
│ │ │ ├──[🔀] description (7591:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (20670:20)
│ │ └─┬POST
│ │   ├──[🔀] description (7610:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (20670:20)
│ ├─┬/_plugins/_knn/models/_search
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (21793:20)
│ │ │ ├─┬Parameters
│ │ │ │ ├──[🔀] description (21822:20)
│ │ │ │ └─┬Schema
│ │ │ │   └──[🔀] description (21825:22)
│ │ │ ├─┬Parameters
│ │ │ │ ├──[🔀] description (21722:20)
│ │ │ │ └─┬Schema
│ │ │ │   └──[🔀] description (21725:22)
│ │ │ └─┬Parameters
│ │ │   ├──[🔀] description (21815:20)
│ │ │   └─┬Schema
│ │ │     └──[🔀] description (21818:22)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (21722:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (21725:22)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (21815:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (21818:22)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (21793:20)
│ │   └─┬Parameters
│ │     ├──[🔀] description (21822:20)
│ │     └─┬Schema
│ │       └──[🔀] description (21825:22)
│ ├─┬/_forcemerge
│ │ └─┬POST
│ │   ├──[🔀] description (2415:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19688:20)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (19695:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (19710:20)
│ ├─┬/_nodes/{node_id}/stats/{metric}/{index_metric}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (22833:20)
│ ├─┬/_stats/{metric}
│ │ └─┬GET
│ │   └─┬Parameters
│ │     └──[🔀] description (21167:20)
│ ├─┬/_aliases/{name}
│ │ ├─┬PUT
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬is_write_index
│ │ │         └──[🔀] description (26157:30)
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬is_write_index
│ │           └──[🔀] description (26157:30)
│ ├─┬/_opendistro/_ism/retry
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21664:20)
│ ├─┬/_count
│ │ ├─┬GET
│ │ │ ├─┬Parameters
│ │ │ │ └──[🔀] description (17339:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (17395:20)
│ │ └─┬POST
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (17395:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (17339:20)
│ ├─┬/{index}/_stats/{metric}
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (21116:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (21167:20)
│ ├─┬/_cat/segment_replication
│ │ └─┬GET
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (16018:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (16021:22)
│ │   ├─┬Parameters
│ │   │ └──[🔀] description (16047:20)
│ │   ├─┬Parameters
│ │   │ ├──[🔀] description (16086:20)
│ │   │ └─┬Schema
│ │   │   └──[🔀] description (16089:22)
│ │   └─┬Parameters
│ │     ├──[🔀] description (16079:20)
│ │     └─┬Schema
│ │       └──[🔀] description (16082:22)
│ ├─┬/_alias
│ │ ├─┬GET
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (19774:20)
│ │ └─┬PUT
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬is_write_index
│ │           └──[🔀] description (26157:30)
│ ├─┬/_opendistro/_ism/add
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └──[🔀] description (21528:20)
│ ├─┬/_template/{name}
│ │ ├─┬PUT
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬index_patterns
│ │ │         └──[🔀] description (26276:30)
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬index_patterns
│ │           └──[🔀] description (26276:30)
│ └─┬/_alias/{name}
│   ├─┬GET
│   │ └─┬Parameters
│   │   └──[🔀] description (19774:20)
│   ├─┬PUT
│   │ └─┬Requestbody
│   │   └─┬application/json
│   │     └─┬Schema
│   │       └─┬is_write_index
│   │         └──[🔀] description (26157:30)
│   ├─┬POST
│   │ └─┬Requestbody
│   │   └─┬application/json
│   │     └─┬Schema
│   │       └─┬is_write_index
│   │         └──[🔀] description (26157:30)
│   └─┬HEAD
│     ├─┬Parameters
│     │ └──[🔀] description (19440:20)
│     └─┬Parameters
│       └──[🔀] description (19460:20)
└─┬Components
  ├─┬cluster.stats___FieldTypesMappings
  │ └─┬total_deduplicated_field_count
  │   └──[🔀] description (47636:24)
  ├─┬insights._common___Source
  │ ├─┬terminate_after
  │ │ └──[🔀] description (51427:24)
  │ ├─┬indices_boost
  │ │ └──[🔀] description (51371:24)
  │ └─┬stats
  │   └──[🔀] description (51458:24)
  ├─┬indices._common___AliasDefinition
  │ └─┬is_hidden
  │   └──[🔀] description (48420:24)
  ├─┬indices._common___IndexSettingsLifecycle
  │ └─┬rollover_alias
  │   └──[🔀] description (48895:24)
  ├─┬indices._common___DataStream
  │ └─┬indices
  │   └──[🔀] description (48446:24)
  ├─┬asynchronous_search._common___Search
  │ ├─┬indices_boost
  │ │ └──[🔀] description (44260:24)
  │ ├─┬stats
  │ │ └──[🔀] description (44349:24)
  │ └─┬terminate_after
  │   └──[🔀] description (44318:24)
  ├─┬insights._common___TopQuery
  │ └─┬indices
  │   └──[🔀] description (51535:24)
  ├─┬indices._common___Alias
  │ └─┬is_hidden
  │   └──[🔀] description (48387:24)
  ├─┬_common___ExpandWildcard
  │ ├─┬ONEOF
  │ │ └──[🔀] description (31620:24)
  │ ├─┬ONEOF
  │ │ ├──[🔀] description (31626:24)
  │ │ └──[🔀] const (31625:18)❌ 
  │ └─┬ONEOF
  │   ├──[🔀] description (31617:24)
  │   └──[🔀] const (31616:18)❌ 
  ├─┬indices.data_streams_stats___DataStreamsStatsItem
  │ └─┬backing_indices
  │   └──[🔀] description (49530:24)
  ├─┬cluster.stats___ClusterIndices
  │ └─┬count
  │   └──[🔀] description (47228:24)
  ├─┬cat.snapshots___SnapshotsRecord
  │ └─┬indices
  │   └──[🔀] description (46307:24)
  ├─┬cluster.stats___FieldTypes
  │ └─┬index_count
  │   └──[🔀] description (47606:24)
  └─┬indices._common___IndexSettingsStore
    └─┬allow_mmap
      └──[🔀] description (49148:24)

Document Element	Total Changes	Breaking Changes
paths	365	0
components	22	2

❌ BREAKING Changes: 2 out of 387
Modifications: 387
Breaking Modifications: 2

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11841565344/artifacts/2188745144

API Coverage

	Before	After	Δ
Covered (%)	588 (57.59 %)	588 (57.59 %)	0 (0 %)
Uncovered (%)	433 (42.41 %)	433 (42.41 %)	0 (0 %)
Unknown	42	42	0

github-actions · 2024-11-13T19:47:03Z

Spec Test Coverage Analysis

Total	Tested
517	349 (67.5 %)

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

dblock · 2024-11-14T20:13:02Z

@nhtruong care to take a look pls?

dblock added the skip-changelog No need to update CHANGELOG. label Nov 13, 2024

dblock force-pushed the indices-indexes branch 6 times, most recently from 8e8ff53 to 7ee9ff3 Compare November 13, 2024 20:08

dblock marked this pull request as ready for review November 13, 2024 20:10

dblock requested review from harshavamsi, sachetalva, nhtruong, Xtansia, VachaShah, Tokesh and aabeshov as code owners November 13, 2024 20:10

dblock added 2 commits November 14, 2024 11:38

Replaced all indices with indexes.

da62093

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

Fixed CHANGELOG entries under the 0.1.0 release.

535d92e

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

dblock force-pushed the indices-indexes branch from 7ee9ff3 to 535d92e Compare November 14, 2024 16:38

dblock removed the skip-changelog No need to update CHANGELOG. label Nov 14, 2024

dblock mentioned this pull request Nov 14, 2024

add phone number analysis plugin #609

Merged

nhtruong approved these changes Nov 14, 2024

View reviewed changes

nhtruong merged commit 398481e into opensearch-project:main Nov 14, 2024
28 checks passed

dblock deleted the indices-indexes branch November 14, 2024 23:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replaced all indices with indexes. #671

Replaced all indices with indexes. #671

dblock commented Nov 13, 2024 •

edited

Loading

github-actions bot commented Nov 13, 2024 •

edited

Loading

github-actions bot commented Nov 13, 2024 •

edited

Loading

dblock commented Nov 14, 2024

Replaced all indices with indexes. #671

Replaced all indices with indexes. #671

Conversation

dblock commented Nov 13, 2024 • edited Loading

Description

github-actions bot commented Nov 13, 2024 • edited Loading

Changes Analysis

API Changes

Summary

Report

API Coverage

github-actions bot commented Nov 13, 2024 • edited Loading

Spec Test Coverage Analysis

dblock commented Nov 14, 2024

dblock commented Nov 13, 2024 •

edited

Loading

github-actions bot commented Nov 13, 2024 •

edited

Loading

github-actions bot commented Nov 13, 2024 •

edited

Loading