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.

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

Update cat namespace descriptions #751

Merged
merged 11 commits into from
Dec 31, 2024
Merged

Conversation

Naarcha-AWS
Copy link
Contributor

Updates all cat namespace descriptions to add automation.

Must be reviewed by @natebower before merging.

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.

Updates all cat namespace descriptions to add automation.

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Copy link
Contributor

github-actions bot commented Dec 20, 2024

Changes Analysis

Commit SHA: bc5bce5
Comparing To SHA: 0e0e072

API Changes

Summary

└─┬Paths
  ├─┬/_cat/snapshots
  │ └─┬GET
  │   ├──[🔀] description (1202:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16738:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16744:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16765:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16796:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16802:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16806:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16724:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16731:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16734:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16785:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16791:22)
  │   └─┬Parameters
  │     └──[🔀] description (16757:20)
  ├─┬/_cat/plugins
  │ └─┬GET
  │   ├──[🔀] description (918:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16190:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16156:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16159:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16182:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16186:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16199:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16205:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16210:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16214:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16149:20)
  │   └─┬Parameters
  │     ├──[🔀] description (16163:20)
  │     └─┬Schema
  │       └──[🔀] description (16169:22)
  ├─┬/_cat/pit_segments
  │ └─┬GET
  │   ├──[🔀] description (870:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16098:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16104:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16107:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16111:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16117:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16130:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16136:22)
  │   └─┬Parameters
  │     ├──[🔀] description (16141:20)
  │     └─┬Schema
  │       └──[🔀] description (16145:22)
  ├─┬/_cat/fielddata
  │ └─┬GET
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15588:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15594:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15548:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15562:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15565:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15569:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15575:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15555:20)
  │   └─┬Parameters
  │     ├──[🔀] description (15599:20)
  │     └─┬Schema
  │       └──[🔀] description (15603:22)
  ├─┬/_cat/repositories
  │ └─┬GET
  │   ├──[🔀] description (998:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16331:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16337:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16350:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16354:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16358:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16367:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16373:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16378:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16382:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16317:20)
  │   └─┬Parameters
  │     ├──[🔀] description (16324:20)
  │     └─┬Schema
  │       └──[🔀] description (16327:22)
  ├─┬/_cat/fielddata/{fields}
  │ └─┬GET
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15562:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15565:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15569:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15575:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15555:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15548:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15599:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15603:22)
  │   └─┬Parameters
  │     ├──[🔀] description (15588:20)
  │     └─┬Schema
  │       └──[🔀] description (15594:22)
  ├─┬/_cat/recovery
  │ └─┬GET
  │   ├──[🔀] description (943:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16277:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16285:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16243:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16258:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16264:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16292:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16298:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16309:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16313:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16236:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16251:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16254:22)
  │   └─┬Parameters
  │     └──[🔀] description (16303:20)
  ├─┬/_cat/master
  │ └─┬GET
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15851:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15855:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15797:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15800:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15804:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15810:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15823:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15827:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15831:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15840:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15846:22)
  │   └─┬Parameters
  │     └──[🔀] description (15790:20)
  ├─┬/_cat/segments
  │ └─┬GET
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16583:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16587:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16600:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16606:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16611:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16615:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16551:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16558:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16565:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16568:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16572:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16578:22)
  │   └─┬Parameters
  │     └──[🔀] description (16591:20)
  ├─┬/_cat/indices
  │ └─┬GET
  │   ├──[🔀] description (697:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15775:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15705:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15711:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15731:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15739:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15743:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15756:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15764:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15770:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15698:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15701:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15716:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15782:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15786:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15677:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15684:20)
  │   └─┬Parameters
  │     └──[🔀] description (15747:20)
  ├─┬/_cat/snapshots/{repository}
  │ └─┬GET
  │   ├──[🔀] description (1229:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16724:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16757:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16802:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16806:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16731:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16734:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16765:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16796:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16738:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16744:22)
  │   └─┬Parameters
  │     ├──[🔀] description (16785:20)
  │     └─┬Schema
  │       └──[🔀] description (16791:22)
  ├─┬/_cat/templates
  │ └─┬GET
  │   ├──[🔀] description (1284:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16959:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16965:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16909:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16950:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16942:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16946:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16970:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16974:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16916:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16919:22)
  │   └─┬Parameters
  │     ├──[🔀] description (16923:20)
  │     └─┬Schema
  │       └──[🔀] description (16929:22)
  ├─┬/_cat/tasks
  │ └─┬GET
  │   ├──[🔀] description (1257:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16885:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16874:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16880:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16891:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16895:22)
  │   ├─┬Parameters
  │   │ ├──[➖] explode (16844:16)
  │   │ ├──[🔀] description (16853:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16861:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16834:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16840:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16827:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16830:22)
  │   └─┬Parameters
  │     └──[🔀] description (16810:20)
  ├─┬/_cat/thread_pool/{thread_pool_patterns}
  │ └─┬GET
  │   ├──[🔀] description (1363:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (17021:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (17025:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (17057:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (17061:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (17038:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (17044:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (17002:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (17008:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16988:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16995:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16998:22)
  │   └─┬Parameters
  │     └──[🔀] description (17029:20)
  ├─┬/_cat/thread_pool
  │ └─┬GET
  │   ├──[🔀] description (1335:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (17021:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (17025:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16988:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (17002:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (17008:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (17038:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (17044:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (17057:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (17061:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16995:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16998:22)
  │   └─┬Parameters
  │     └──[🔀] description (17029:20)
  ├─┬/_cat/aliases
  │ └─┬GET
  │   └──[🔀] description (452:20)
  ├─┬/_cat/pit_segments/_all
  │ └─┬GET
  │   ├──[🔀] description (895:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15279:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15292:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15298:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15311:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15317:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15285:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15288:22)
  │   └─┬Parameters
  │     ├──[🔀] description (15322:20)
  │     └─┬Schema
  │       └──[🔀] description (15326:22)
  ├─┬/_cat/shards/{index}
  │ └─┬GET
  │   ├──[🔀] description (1174:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16644:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16647:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16630:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16678:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16637:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16651:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16657:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16687:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16693:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16670:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16674:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16698:20)
  │   └─┬Parameters
  │     ├──[🔀] description (16704:20)
  │     └─┬Schema
  │       └──[🔀] description (16708:22)
  ├─┬/_cat/count
  │ └─┬GET
  │   ├──[🔀] description (579:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15493:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15496:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15500:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15506:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15519:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15525:22)
  │   └─┬Parameters
  │     ├──[🔀] description (15530:20)
  │     └─┬Schema
  │       └──[🔀] description (15534:22)
  ├─┬/_cat/shards
  │ └─┬GET
  │   ├──[🔀] description (1147:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16630:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16651:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16657:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16670:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16674:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16704:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16708:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16644:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16647:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16637:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16678:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16687:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16693:22)
  │   └─┬Parameters
  │     └──[🔀] description (16698:20)
  ├─┬/_cat/count/{index}
  │ └─┬GET
  │   ├──[🔀] description (601:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15493:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15496:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15500:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15506:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15519:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15525:22)
  │   └─┬Parameters
  │     ├──[🔀] description (15530:20)
  │     └─┬Schema
  │       └──[🔀] description (15534:22)
  ├─┬/_cat/templates/{name}
  │ └─┬GET
  │   ├──[🔀] description (1309:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16923:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16929:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16909:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16959:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16965:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16970:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16974:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16942:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16946:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16950:20)
  │   └─┬Parameters
  │     ├──[🔀] description (16916:20)
  │     └─┬Schema
  │       └──[🔀] description (16919:22)
  ├─┬/_cat/nodeattrs
  │ └─┬GET
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15909:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15915:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15920:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15924:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15859:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15873:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15879:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15892:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15896:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15900:20)
  │   └─┬Parameters
  │     ├──[🔀] description (15866:20)
  │     └─┬Schema
  │       └──[🔀] description (15869:22)
  ├─┬/_cat/segment_replication
  │ └─┬GET
  │   ├──[🔀] description (1023:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16526:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16408:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16411:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16509:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16515:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16443:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16446:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16520:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16415:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16421:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16425:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16437:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16476:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16479:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16483:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16491:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16532:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16536:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16429:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16433:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16450:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16456:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16469:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16472:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16400:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16404:22)
  │   └─┬Parameters
  │     ├──[🔀] description (16498:20)
  │     └─┬Schema
  │       └──[🔀] description (16504:22)
  ├─┬/_cat/segments/{index}
  │ └─┬GET
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16583:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16587:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16591:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16551:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16558:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16565:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16568:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16572:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16578:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16600:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16606:22)
  │   └─┬Parameters
  │     ├──[🔀] description (16611:20)
  │     └─┬Schema
  │       └──[🔀] description (16615:22)
  ├─┬/_cat/cluster_manager
  │ └─┬GET
  │   └─┬Parameters
  │     ├──[🔀] description (15447:20)
  │     └─┬Schema
  │       └──[🔀] description (15451:22)
  ├─┬/_cat/health
  │ └─┬GET
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15607:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15610:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15614:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15620:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15651:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15659:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15663:22)
  │   └─┬Parameters
  │     ├──[🔀] description (15633:20)
  │     └─┬Schema
  │       └──[🔀] description (15639:22)
  ├─┬/_cat/indices/{index}
  │ └─┬GET
  │   ├──[🔀] description (728:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15677:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15705:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15711:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15731:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15739:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15743:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15764:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15770:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15667:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15684:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15716:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15698:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15701:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15747:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15756:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15775:20)
  │   └─┬Parameters
  │     ├──[🔀] description (15782:20)
  │     └─┬Schema
  │       └──[🔀] description (15786:22)
  ├─┬/_cat/aliases/{name}
  │ └─┬GET
  │   └──[🔀] description (476:20)
  ├─┬/_cat/recovery/{index}
  │ └─┬GET
  │   ├──[🔀] description (970:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16243:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16258:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16264:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16309:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16313:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16277:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16285:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16236:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16251:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16254:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16292:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16298:22)
  │   └─┬Parameters
  │     └──[🔀] description (16303:20)
  ├─┬/_cat/segment_replication/{index}
  │ └─┬GET
  │   ├──[🔀] description (1059:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16450:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16456:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16498:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16504:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16400:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16404:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16469:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16472:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16509:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16515:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16520:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16532:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16536:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16421:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16425:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16429:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16433:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16443:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16446:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16437:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16476:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16479:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16526:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16483:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16491:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (16408:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16411:22)
  │   └─┬Parameters
  │     └──[🔀] description (16415:20)
  ├─┬/_cat/nodes
  │ └─┬GET
  │   ├──[🔀] description (816:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15959:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15965:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15989:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15998:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (16004:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15949:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15935:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15928:20)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15942:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15945:22)
  │   ├─┬Parameters
  │   │ ├──[🔀] description (15978:20)
  │   │ └─┬Schema
  │   │   └──[🔀] description (15985:22)
  │   ├─┬Parameters
  │   │ └──[🔀] description (16009:20)
  │   └─┬Parameters
  │     ├──[🔀] description (16015:20)
  │     └─┬Schema
  │       └──[🔀] description (16019:22)
  └─┬/_cat/pending_tasks
    └─┬GET
      ├──[🔀] description (844:20)
      ├─┬Parameters
      │ ├──[🔀] description (16037:20)
      │ └─┬Schema
      │   └──[🔀] description (16043:22)
      ├─┬Parameters
      │ ├──[🔀] description (16090:20)
      │ └─┬Schema
      │   └──[🔀] description (16094:22)
      ├─┬Parameters
      │ └──[🔀] description (16064:20)
      ├─┬Parameters
      │ └──[🔀] description (16023:20)
      ├─┬Parameters
      │ ├──[🔀] description (16030:20)
      │ └─┬Schema
      │   └──[🔀] description (16033:22)
      ├─┬Parameters
      │ ├──[🔀] description (16073:20)
      │ └─┬Schema
      │   └──[🔀] description (16079:22)
      ├─┬Parameters
      │ ├──[🔀] description (16056:20)
      │ └─┬Schema
      │   └──[🔀] description (16060:22)
      └─┬Parameters
        └──[🔀] description (16084:20)

Document Element Total Changes Breaking Changes
paths 422 0
  • Total Changes: 422
  • Modifications: 421
  • Removals: 1

Report

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

API Coverage

Before After Δ
Covered (%) 606 (59.35 %) 606 (59.35 %) 0 (0 %)
Uncovered (%) 415 (40.65 %) 415 (40.65 %) 0 (0 %)
Unknown 43 43 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
536 541 (100.93 %)

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS
Copy link
Contributor Author

Checked the style annotations and errors. Several are for different files, and the majority of errors pertaining to this are either misidentified, for example, theopensearch it calls out appears in a hyperlink; or seem questionable, such as adding a space after the . for the hyperlink. Let me know how I should proceed with those.

@dblock
Copy link
Member

dblock commented Dec 20, 2024

Checked the style annotations and errors. Several are for different files, and the majority of errors pertaining to this are either misidentified, for example, theopensearch it calls out appears in a hyperlink; or seem questionable, such as adding a space after the . for the hyperlink. Let me know how I should proceed with those.

Looks like a bug in the linter that should be ignoring links. Can you open an issue please? We ignore that for now.

Copy link
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!

spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
schema:
type: boolean
default: false
description: Return local information, do not retrieve the state from cluster-manager node.
description: Returns local information, but does not retrieve the state from cluster-manager node.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Returns local information, but does not retrieve the state from cluster-manager node.
description: Returns local information but does not retrieve the state from the cluster manager node.

cat.thread_pool::query.master_timeout:
name: master_timeout
in: query
description: Operation timeout for connection to cluster-manager node.
description: A timeout for connection to the cluster manager node.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The" timeout? Or, even better, do we mean "The amount of time allowed to establish a connection to the cluster manager node"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Used the last option.

spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
Naarcha-AWS and others added 2 commits December 23, 2024 13:19
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
spec/namespaces/cat.yaml Outdated Show resolved Hide resolved
@Tokesh
Copy link
Collaborator

Tokesh commented Dec 28, 2024

Hello! Please rebase your PR onto the main branch. I've already prepared PR #753.

@Naarcha-AWS
Copy link
Contributor Author

@Tokesh: Done. All tests are passing, besides the Changelog test, which I believe isn't required for description updates.

@dblock dblock added the skip-changelog No need to update CHANGELOG. label Dec 30, 2024
@dblock
Copy link
Member

dblock commented Dec 30, 2024

@Tokesh You good with this? Re-review/merge pls? (I added a skip-changelog label.)

Copy link
Collaborator

@Tokesh Tokesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Thank you very much! :)
Happy upcoming New Year!

@Tokesh Tokesh merged commit 2c6502d into opensearch-project:main Dec 31, 2024
30 of 31 checks passed
nathaliellenaa pushed a commit to nathaliellenaa/opensearch-api-specification that referenced this pull request Dec 31, 2024
* Update cat namespace descriptions

Updates all cat namespace descriptions to add automation.

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix linting error

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix various errors.

Signed-off-by: Naarcha-AWS <[email protected]>

* Fix remaining linting errors

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Update spec/namespaces/cat.yaml

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No need to update CHANGELOG.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants