Skip to content

Commit

Permalink
Documenation b (#136)
Browse files Browse the repository at this point in the history 
* Added documentation to some folders

Signed-off-by: Alen Abeshov <[email protected]>

* Added documentation to some folders

Signed-off-by: Alen Abeshov <[email protected]>

* Added documentation to some folders

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

* Fixed urls and rewrited wrong urls.

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

---------

Signed-off-by: Alen Abeshov <[email protected]>
Signed-off-by: Alen Abeshov <[email protected]>
Signed-off-by: alen_abeshov <[email protected]>
Co-authored-by: Alen Abeshov <[email protected]>
  • Loading branch information
@aabeshov
aabeshov and Alen Abeshov authored Jul 31, 2023
1 parent 3b9cb87 commit df7f025
Show file tree
Hide file tree
Showing 42 changed files with 42 additions and 79 deletions.
3 changes: 1 addition & 2 deletions model/cluster/allocation_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/cluster-api/cluster-allocation/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/cluster/delete_decommission_awareness/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/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/cluster/delete_weighted_routing/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/cluster-api/cluster-awareness/#example-deleting-weights"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/cluster/get_decommission_awareness/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/cluster-api/cluster-decommission/#example-getting-zone-decommission-status"
)

@vendorExtensions(
Expand Down
2 changes: 1 addition & 1 deletion model/cluster/get_settings/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace OpenSearch
use opensearch.openapi#vendorExtensions

@externalDocumentation(
"API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-settings/"
"API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/"
)

@vendorExtensions(
Expand Down
2 changes: 1 addition & 1 deletion model/cluster/get_weighted_routing/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ 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/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones"
)

@vendorExtensions(
Expand Down
2 changes: 1 addition & 1 deletion model/cluster/health/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ 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/cluster-api/cluster-health/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/cluster/put_component_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/im-plugin/index-templates/#use-component-templates-to-create-an-index-template"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/cluster/put_decommission_awareness/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/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/cluster/put_weighted_routing/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/cluster-api/cluster-awareness/#example-weighted-round-robin-search"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/cluster/remote_info/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/remote-info/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/cluster/stats/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/cluster-api/cluster-stats/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/dangling_indices/delete_dangling_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/index-apis/dangling-index/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/dangling_indices/import_dangling_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/index-apis/dangling-index/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/dangling_indices/list_dangling_indices/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/index-apis/dangling-index/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/analyze/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/analyze-apis/perform-text-analysis/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/clear_cache/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/index-apis/clear-index-cache/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/clone/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/index-apis/clone/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/close/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/index-apis/close-index/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/data_streams_stats/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/im-plugin/data-streams/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/delete_alias/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/im-plugin/index-alias/#delete-aliases"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/delete_index_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/im-plugin/index-templates/#delete-a-template"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/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/index-apis/exists/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/exists_index_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/im-plugin/index-templates/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/get/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/index-apis/get-index/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/get_alias/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/im-plugin/index-alias/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/get_field_mapping/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/index/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/get_index_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/im-plugin/index-templates/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/get_mapping/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/index/#get-a-mapping"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/open/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/index-apis/open-index/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/put_alias/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/im-plugin/index-alias/#create-aliases"
)

@vendorExtensions(
Expand Down
2 changes: 1 addition & 1 deletion model/indices/put_index_template/operations.smithy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ 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/index-templates/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/put_settings/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/index-apis/update-settings/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/put_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/im-plugin/index-templates/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/refresh/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/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/rollover/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/dashboards/im-dashboards/rollover/"
)

@vendorExtensions(
Expand Down
3 changes: 1 addition & 2 deletions model/indices/shrink/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/index-apis/shrink-index/"
)

@vendorExtensions(
Expand Down
Loading

0 comments on commit df7f025

Please sign in to comment.