From b5c891ebbc0eaf2f73ec33ba4f9d34daf6df8e57 Mon Sep 17 00:00:00 2001 From: Niyazbek Torekeldi <78027392+Tokesh@users.noreply.github.com> Date: Tue, 27 Jun 2023 20:40:25 +0200 Subject: [PATCH] adding documentation URL to APIs (#126) Signed-off-by: Tokesh Signed-off-by: Thomas Farr Co-authored-by: Thomas Farr --- model/_global/bulk/operations.smithy | 3 +-- model/_global/clear_scroll/operations.smithy | 3 +-- model/_global/count/operations.smithy | 3 +-- model/_global/create/operations.smithy | 3 +-- model/_global/delete/operations.smithy | 3 +-- model/_global/delete_by_query/operations.smithy | 3 +-- model/_global/delete_pit/operations.smithy | 3 +-- model/_global/delete_script/operations.smithy | 3 +-- model/_global/exists/operations.smithy | 3 +-- model/_global/exists_source/operations.smithy | 3 +-- model/_global/explain/operations.smithy | 3 +-- model/_global/field_caps/operations.smithy | 3 +-- model/_global/get_all_pits/operations.smithy | 3 +-- model/_global/get_script/operations.smithy | 3 +-- model/_global/get_script_context/operations.smithy | 3 +-- model/_global/get_script_languages/operations.smithy | 3 +-- model/_global/index/operations.smithy | 3 +-- model/_global/mget/operations.smithy | 3 +-- model/_global/msearch/operations.smithy | 3 +-- model/_global/msearch_template/operations.smithy | 3 +-- model/_global/put_script/operations.smithy | 3 +-- model/_global/rank_eval/operations.smithy | 3 +-- model/_global/reindex/operations.smithy | 4 ++-- model/_global/render_search_template/operations.smithy | 3 +-- model/_global/scripts_painless_execute/operations.smithy | 3 +-- model/_global/scroll/operations.smithy | 3 +-- model/_global/search_template/operations.smithy | 3 +-- model/_global/update/operations.smithy | 3 +-- model/_global/update_by_query/operations.smithy | 3 +-- model/cat/aliases/operations.smithy | 3 +-- model/cat/allocation/operations.smithy | 3 +-- model/cat/cluster_manager/operations.smithy | 3 +-- model/cat/count/operations.smithy | 3 +-- model/cat/fielddata/operations.smithy | 3 +-- model/cat/health/operations.smithy | 3 +-- model/cat/help/operations.smithy | 3 +-- model/cat/master/operations.smithy | 3 +-- model/cat/nodeattrs/operations.smithy | 3 +-- model/cat/pending_tasks/operations.smithy | 3 +-- model/cat/plugins/operations.smithy | 3 +-- model/cat/recovery/operations.smithy | 3 +-- model/cat/repositories/operations.smithy | 3 +-- model/cat/segment_replication/operations.smithy | 3 +-- model/cat/segments/operations.smithy | 3 +-- model/cat/shards/operations.smithy | 3 +-- model/cat/snapshots/operations.smithy | 3 +-- model/cat/tasks/operations.smithy | 3 +-- model/cat/templates/operations.smithy | 3 +-- model/cat/thread_pool/operations.smithy | 3 +-- model/nodes/hot_threads/operations.smithy | 3 +-- model/nodes/info/operations.smithy | 3 +-- model/nodes/reload_secure_settings/operations.smithy | 3 +-- model/nodes/stats/operations.smithy | 3 +-- model/snapshot/create/operations.smithy | 3 +-- model/snapshot/create_repository/operations.smithy | 3 +-- model/snapshot/delete/operations.smithy | 3 +-- model/snapshot/delete_repository/operations.smithy | 3 +-- model/snapshot/get_repository/operations.smithy | 3 +-- model/snapshot/restore/operations.smithy | 3 +-- model/snapshot/status/operations.smithy | 3 +-- model/snapshot/verify_repository/operations.smithy | 3 +-- model/tasks/cancel/operations.smithy | 3 +-- model/tasks/get/operations.smithy | 3 +-- model/tasks/list/operations.smithy | 3 +-- 64 files changed, 65 insertions(+), 128 deletions(-) diff --git a/model/_global/bulk/operations.smithy b/model/_global/bulk/operations.smithy index 55ac834c..3041865f 100644 --- a/model/_global/bulk/operations.smithy +++ b/model/_global/bulk/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/bulk/" ) @vendorExtensions( diff --git a/model/_global/clear_scroll/operations.smithy b/model/_global/clear_scroll/operations.smithy index 0cf7f89e..2c56c3a0 100644 --- a/model/_global/clear_scroll/operations.smithy +++ b/model/_global/clear_scroll/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/scroll/" ) @vendorExtensions( diff --git a/model/_global/count/operations.smithy b/model/_global/count/operations.smithy index 0e85bd9d..a78fed72 100644 --- a/model/_global/count/operations.smithy +++ b/model/_global/count/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/count/" ) @vendorExtensions( diff --git a/model/_global/create/operations.smithy b/model/_global/create/operations.smithy index 024a68b0..6a1743db 100644 --- a/model/_global/create/operations.smithy +++ b/model/_global/create/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/index-document/" ) @vendorExtensions( diff --git a/model/_global/delete/operations.smithy b/model/_global/delete/operations.smithy index 69bac69a..d88b726d 100644 --- a/model/_global/delete/operations.smithy +++ b/model/_global/delete/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/" ) @vendorExtensions( diff --git a/model/_global/delete_by_query/operations.smithy b/model/_global/delete_by_query/operations.smithy index d052ffe3..5bf94c56 100644 --- a/model/_global/delete_by_query/operations.smithy +++ b/model/_global/delete_by_query/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/" ) @vendorExtensions( diff --git a/model/_global/delete_pit/operations.smithy b/model/_global/delete_pit/operations.smithy index 10769440..da6f951c 100644 --- a/model/_global/delete_pit/operations.smithy +++ b/model/_global/delete_pit/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits" ) @vendorExtensions( diff --git a/model/_global/delete_script/operations.smithy b/model/_global/delete_script/operations.smithy index 544410fc..6fe81657 100644 --- a/model/_global/delete_script/operations.smithy +++ b/model/_global/delete_script/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/" ) @vendorExtensions( diff --git a/model/_global/exists/operations.smithy b/model/_global/exists/operations.smithy index f13d4922..f8a60a46 100644 --- a/model/_global/exists/operations.smithy +++ b/model/_global/exists/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" ) @vendorExtensions( diff --git a/model/_global/exists_source/operations.smithy b/model/_global/exists_source/operations.smithy index 45025c7c..b68bf201 100644 --- a/model/_global/exists_source/operations.smithy +++ b/model/_global/exists_source/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" ) @vendorExtensions( diff --git a/model/_global/explain/operations.smithy b/model/_global/explain/operations.smithy index 5d2401e1..58bfe79b 100644 --- a/model/_global/explain/operations.smithy +++ b/model/_global/explain/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/explain/" ) @vendorExtensions( diff --git a/model/_global/field_caps/operations.smithy b/model/_global/field_caps/operations.smithy index 73f8cc25..807b25b0 100644 --- a/model/_global/field_caps/operations.smithy +++ b/model/_global/field_caps/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations" ) @vendorExtensions( diff --git a/model/_global/get_all_pits/operations.smithy b/model/_global/get_all_pits/operations.smithy index 3d127574..3ec013e7 100644 --- a/model/_global/get_all_pits/operations.smithy +++ b/model/_global/get_all_pits/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits" ) @vendorExtensions( diff --git a/model/_global/get_script/operations.smithy b/model/_global/get_script/operations.smithy index 91f72592..48f9bb96 100644 --- a/model/_global/get_script/operations.smithy +++ b/model/_global/get_script/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/" ) @vendorExtensions( diff --git a/model/_global/get_script_context/operations.smithy b/model/_global/get_script_context/operations.smithy index 5df4946b..3fde1430 100644 --- a/model/_global/get_script_context/operations.smithy +++ b/model/_global/get_script_context/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/" ) @vendorExtensions( diff --git a/model/_global/get_script_languages/operations.smithy b/model/_global/get_script_languages/operations.smithy index c48fde51..97dbecea 100644 --- a/model/_global/get_script_languages/operations.smithy +++ b/model/_global/get_script_languages/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/" ) @vendorExtensions( diff --git a/model/_global/index/operations.smithy b/model/_global/index/operations.smithy index 10aae047..6fea22b6 100644 --- a/model/_global/index/operations.smithy +++ b/model/_global/index/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/index-document/" ) @vendorExtensions( diff --git a/model/_global/mget/operations.smithy b/model/_global/mget/operations.smithy index 45404ae9..3f73b90a 100644 --- a/model/_global/mget/operations.smithy +++ b/model/_global/mget/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/" ) @vendorExtensions( diff --git a/model/_global/msearch/operations.smithy b/model/_global/msearch/operations.smithy index 3fb6ab21..2247ae14 100644 --- a/model/_global/msearch/operations.smithy +++ b/model/_global/msearch/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/multi-search/" ) @vendorExtensions( diff --git a/model/_global/msearch_template/operations.smithy b/model/_global/msearch_template/operations.smithy index 1e5b4c93..a03f4d4e 100644 --- a/model/_global/msearch_template/operations.smithy +++ b/model/_global/msearch_template/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/search-plugins/search-template/" ) @vendorExtensions( diff --git a/model/_global/put_script/operations.smithy b/model/_global/put_script/operations.smithy index 17daf6fd..d379699f 100644 --- a/model/_global/put_script/operations.smithy +++ b/model/_global/put_script/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/" ) @vendorExtensions( diff --git a/model/_global/rank_eval/operations.smithy b/model/_global/rank_eval/operations.smithy index 73f3a6a8..a922cb4b 100644 --- a/model/_global/rank_eval/operations.smithy +++ b/model/_global/rank_eval/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/rank-eval/" ) @vendorExtensions( diff --git a/model/_global/reindex/operations.smithy b/model/_global/reindex/operations.smithy index b0365fe1..891e8d6c 100644 --- a/model/_global/reindex/operations.smithy +++ b/model/_global/reindex/operations.smithy @@ -8,9 +8,9 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL + @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/im-plugin/reindex-data/" ) @vendorExtensions( diff --git a/model/_global/render_search_template/operations.smithy b/model/_global/render_search_template/operations.smithy index 9968a149..cdab0af2 100644 --- a/model/_global/render_search_template/operations.smithy +++ b/model/_global/render_search_template/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/search-plugins/search-template/" ) @vendorExtensions( diff --git a/model/_global/scripts_painless_execute/operations.smithy b/model/_global/scripts_painless_execute/operations.smithy index bd1c487d..f0ebc0ab 100644 --- a/model/_global/scripts_painless_execute/operations.smithy +++ b/model/_global/scripts_painless_execute/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/" ) @vendorExtensions( diff --git a/model/_global/scroll/operations.smithy b/model/_global/scroll/operations.smithy index f5e56d66..5abb09b2 100644 --- a/model/_global/scroll/operations.smithy +++ b/model/_global/scroll/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods" ) @vendorExtensions( diff --git a/model/_global/search_template/operations.smithy b/model/_global/search_template/operations.smithy index 9b43e22f..e3f08c56 100644 --- a/model/_global/search_template/operations.smithy +++ b/model/_global/search_template/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/search-plugins/search-template/" ) @vendorExtensions( diff --git a/model/_global/update/operations.smithy b/model/_global/update/operations.smithy index 9e363ef9..7e187769 100644 --- a/model/_global/update/operations.smithy +++ b/model/_global/update/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/update-document/" ) @vendorExtensions( diff --git a/model/_global/update_by_query/operations.smithy b/model/_global/update_by_query/operations.smithy index 7a95ceb1..f25e6d72 100644 --- a/model/_global/update_by_query/operations.smithy +++ b/model/_global/update_by_query/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/" ) @vendorExtensions( diff --git a/model/cat/aliases/operations.smithy b/model/cat/aliases/operations.smithy index 8e39ba59..e19ba911 100644 --- a/model/cat/aliases/operations.smithy +++ b/model/cat/aliases/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/" ) @vendorExtensions( diff --git a/model/cat/allocation/operations.smithy b/model/cat/allocation/operations.smithy index 528acdad..c76f05c0 100644 --- a/model/cat/allocation/operations.smithy +++ b/model/cat/allocation/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/" ) @vendorExtensions( diff --git a/model/cat/cluster_manager/operations.smithy b/model/cat/cluster_manager/operations.smithy index c120cdee..0c0810d1 100644 --- a/model/cat/cluster_manager/operations.smithy +++ b/model/cat/cluster_manager/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/" ) @vendorExtensions( diff --git a/model/cat/count/operations.smithy b/model/cat/count/operations.smithy index 3814dac2..59c6d091 100644 --- a/model/cat/count/operations.smithy +++ b/model/cat/count/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-count/" ) @vendorExtensions( diff --git a/model/cat/fielddata/operations.smithy b/model/cat/fielddata/operations.smithy index c895b549..990602fd 100644 --- a/model/cat/fielddata/operations.smithy +++ b/model/cat/fielddata/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/" ) @vendorExtensions( diff --git a/model/cat/health/operations.smithy b/model/cat/health/operations.smithy index d4879afe..de4d9158 100644 --- a/model/cat/health/operations.smithy +++ b/model/cat/health/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-health/" ) @vendorExtensions( diff --git a/model/cat/help/operations.smithy b/model/cat/help/operations.smithy index 6357421e..d0ee5875 100644 --- a/model/cat/help/operations.smithy +++ b/model/cat/help/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/index/" ) @vendorExtensions( diff --git a/model/cat/master/operations.smithy b/model/cat/master/operations.smithy index 92914b73..b81272c7 100644 --- a/model/cat/master/operations.smithy +++ b/model/cat/master/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/" ) @deprecated diff --git a/model/cat/nodeattrs/operations.smithy b/model/cat/nodeattrs/operations.smithy index 28216385..96cdd979 100644 --- a/model/cat/nodeattrs/operations.smithy +++ b/model/cat/nodeattrs/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/" ) @vendorExtensions( diff --git a/model/cat/pending_tasks/operations.smithy b/model/cat/pending_tasks/operations.smithy index cd646848..c43b44cc 100644 --- a/model/cat/pending_tasks/operations.smithy +++ b/model/cat/pending_tasks/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/" ) @vendorExtensions( diff --git a/model/cat/plugins/operations.smithy b/model/cat/plugins/operations.smithy index cffdf668..6b47967d 100644 --- a/model/cat/plugins/operations.smithy +++ b/model/cat/plugins/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/" ) @vendorExtensions( diff --git a/model/cat/recovery/operations.smithy b/model/cat/recovery/operations.smithy index 237c2221..84d2ed61 100644 --- a/model/cat/recovery/operations.smithy +++ b/model/cat/recovery/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/" ) @vendorExtensions( diff --git a/model/cat/repositories/operations.smithy b/model/cat/repositories/operations.smithy index c9d9a27f..d66efad0 100644 --- a/model/cat/repositories/operations.smithy +++ b/model/cat/repositories/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/" ) @vendorExtensions( diff --git a/model/cat/segment_replication/operations.smithy b/model/cat/segment_replication/operations.smithy index f88e9fa6..0795c98e 100644 --- a/model/cat/segment_replication/operations.smithy +++ b/model/cat/segment_replication/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/" ) @vendorExtensions( diff --git a/model/cat/segments/operations.smithy b/model/cat/segments/operations.smithy index fa4f540b..f72f89bd 100644 --- a/model/cat/segments/operations.smithy +++ b/model/cat/segments/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-segments/" ) @vendorExtensions( diff --git a/model/cat/shards/operations.smithy b/model/cat/shards/operations.smithy index b745dfcd..ea62c32b 100644 --- a/model/cat/shards/operations.smithy +++ b/model/cat/shards/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-shards/" ) @vendorExtensions( diff --git a/model/cat/snapshots/operations.smithy b/model/cat/snapshots/operations.smithy index 0c5a8764..1493a254 100644 --- a/model/cat/snapshots/operations.smithy +++ b/model/cat/snapshots/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/" ) @vendorExtensions( diff --git a/model/cat/tasks/operations.smithy b/model/cat/tasks/operations.smithy index d32cf7f3..6121e2e3 100644 --- a/model/cat/tasks/operations.smithy +++ b/model/cat/tasks/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/" ) @vendorExtensions( diff --git a/model/cat/templates/operations.smithy b/model/cat/templates/operations.smithy index 8fafe7ad..48f9e804 100644 --- a/model/cat/templates/operations.smithy +++ b/model/cat/templates/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-templates/" ) @vendorExtensions( diff --git a/model/cat/thread_pool/operations.smithy b/model/cat/thread_pool/operations.smithy index f16959bb..bd3a5a9a 100644 --- a/model/cat/thread_pool/operations.smithy +++ b/model/cat/thread_pool/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/" ) @vendorExtensions( diff --git a/model/nodes/hot_threads/operations.smithy b/model/nodes/hot_threads/operations.smithy index 665d9aaf..865f6d1b 100644 --- a/model/nodes/hot_threads/operations.smithy +++ b/model/nodes/hot_threads/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/" ) @deprecated diff --git a/model/nodes/info/operations.smithy b/model/nodes/info/operations.smithy index 44b50722..ca7d7810 100644 --- a/model/nodes/info/operations.smithy +++ b/model/nodes/info/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/" ) @vendorExtensions( diff --git a/model/nodes/reload_secure_settings/operations.smithy b/model/nodes/reload_secure_settings/operations.smithy index f735caae..7ac10412 100644 --- a/model/nodes/reload_secure_settings/operations.smithy +++ b/model/nodes/reload_secure_settings/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/" ) @vendorExtensions( diff --git a/model/nodes/stats/operations.smithy b/model/nodes/stats/operations.smithy index 698784cf..1ecc4b9a 100644 --- a/model/nodes/stats/operations.smithy +++ b/model/nodes/stats/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/" ) @vendorExtensions( diff --git a/model/snapshot/create/operations.smithy b/model/snapshot/create/operations.smithy index 98a3e3e8..bb502bcf 100644 --- a/model/snapshot/create/operations.smithy +++ b/model/snapshot/create/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/" ) @vendorExtensions( diff --git a/model/snapshot/create_repository/operations.smithy b/model/snapshot/create_repository/operations.smithy index 3c4c3649..a0768092 100644 --- a/model/snapshot/create_repository/operations.smithy +++ b/model/snapshot/create_repository/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/" ) @vendorExtensions( diff --git a/model/snapshot/delete/operations.smithy b/model/snapshot/delete/operations.smithy index eec07396..1d2c801d 100644 --- a/model/snapshot/delete/operations.smithy +++ b/model/snapshot/delete/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/" ) @vendorExtensions( diff --git a/model/snapshot/delete_repository/operations.smithy b/model/snapshot/delete_repository/operations.smithy index c6bc54aa..77e1b120 100644 --- a/model/snapshot/delete_repository/operations.smithy +++ b/model/snapshot/delete_repository/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/" ) @vendorExtensions( diff --git a/model/snapshot/get_repository/operations.smithy b/model/snapshot/get_repository/operations.smithy index c7f0ac00..194c00cd 100644 --- a/model/snapshot/get_repository/operations.smithy +++ b/model/snapshot/get_repository/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/" ) @vendorExtensions( diff --git a/model/snapshot/restore/operations.smithy b/model/snapshot/restore/operations.smithy index a6d61067..910b1fcf 100644 --- a/model/snapshot/restore/operations.smithy +++ b/model/snapshot/restore/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/" ) @vendorExtensions( diff --git a/model/snapshot/status/operations.smithy b/model/snapshot/status/operations.smithy index 87bd9518..eb7031f4 100644 --- a/model/snapshot/status/operations.smithy +++ b/model/snapshot/status/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/" ) @vendorExtensions( diff --git a/model/snapshot/verify_repository/operations.smithy b/model/snapshot/verify_repository/operations.smithy index 6e6c3e1f..aa40b978 100644 --- a/model/snapshot/verify_repository/operations.smithy +++ b/model/snapshot/verify_repository/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/" ) @vendorExtensions( diff --git a/model/tasks/cancel/operations.smithy b/model/tasks/cancel/operations.smithy index d7d66739..8f295ca0 100644 --- a/model/tasks/cancel/operations.smithy +++ b/model/tasks/cancel/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling" ) @vendorExtensions( diff --git a/model/tasks/get/operations.smithy b/model/tasks/get/operations.smithy index 41b859d0..5367ddf2 100644 --- a/model/tasks/get/operations.smithy +++ b/model/tasks/get/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/tasks/" ) @vendorExtensions( diff --git a/model/tasks/list/operations.smithy b/model/tasks/list/operations.smithy index 713863e8..8b9d828a 100644 --- a/model/tasks/list/operations.smithy +++ b/model/tasks/list/operations.smithy @@ -8,9 +8,8 @@ $version: "2" namespace OpenSearch use opensearch.openapi#vendorExtensions -// TODO: Fill in API Reference URL @externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" + "API Reference": "https://opensearch.org/docs/latest/api-reference/tasks/" ) @vendorExtensions(