Skip to content

Commit

Permalink
adding documentation URL to APIs (#126)
Browse files Browse the repository at this point in the history 
Signed-off-by: Tokesh <[email protected]>
Signed-off-by: Thomas Farr <[email protected]>
Co-authored-by: Thomas Farr <[email protected]>
  • Loading branch information
@Tokesh @Xtansia
Tokesh and Xtansia committed Jun 27, 2023
1 parent 5e64539 commit b5c891e
Show file tree
Hide file tree
Showing 64 changed files with 65 additions and 128 deletions.
3 changes: 1 addition & 2 deletions model/_global/bulk/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/clear_scroll/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/count/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/create/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/delete/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/delete_by_query/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/delete_pit/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/delete_script/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/exists/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/exists_source/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/explain/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/field_caps/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/get_all_pits/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/get_script/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/get_script_context/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/get_script_languages/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/index/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/mget/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/msearch/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/msearch_template/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/put_script/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/rank_eval/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
4 changes: 2 additions & 2 deletions model/_global/reindex/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/render_search_template/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/scripts_painless_execute/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/scroll/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/search_template/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/update/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/_global/update_by_query/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/cat/aliases/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/cat/allocation/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/cat/cluster_manager/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/cat/count/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/cat/fielddata/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/cat/health/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 1 addition & 2 deletions model/cat/help/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
Loading

0 comments on commit b5c891e

Please sign in to comment.