From 9cf4cd203eaaefe822353ce8a0a68fc4aafd6a53 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Tue, 23 May 2023 08:52:25 -0700 Subject: [PATCH] fixindexapiorder (#4146) Signed-off-by: Heather Halter --- _api-reference/{ => index-apis}/alias.md | 2 ++ .../index-apis/clear-index-cache.md | 22 +++++++++---------- _api-reference/index-apis/clone.md | 2 +- _api-reference/index-apis/close-index.md | 10 ++++----- _api-reference/index-apis/create-index.md | 4 ++-- _api-reference/index-apis/dangling-index.md | 2 +- _api-reference/index-apis/delete-index.md | 2 +- _api-reference/index-apis/exists.md | 2 +- _api-reference/index-apis/get-index.md | 2 +- _api-reference/index-apis/get-settings.md | 2 +- _api-reference/index-apis/open-index.md | 2 +- _api-reference/index-apis/put-mapping.md | 2 +- _api-reference/index-apis/shrink-index.md | 2 +- _api-reference/index-apis/split.md | 2 +- _api-reference/index-apis/update-settings.md | 2 +- 15 files changed, 31 insertions(+), 29 deletions(-) rename _api-reference/{ => index-apis}/alias.md (98%) diff --git a/_api-reference/alias.md b/_api-reference/index-apis/alias.md similarity index 98% rename from _api-reference/alias.md rename to _api-reference/index-apis/alias.md index 2a19f152..e5f6d789 100644 --- a/_api-reference/alias.md +++ b/_api-reference/index-apis/alias.md @@ -1,9 +1,11 @@ --- layout: default title: Alias +parent: Index APIs nav_order: 5 redirect_from: - /opensearch/rest-api/alias/ + - /api-reference/alias/ --- # Alias diff --git a/_api-reference/index-apis/clear-index-cache.md b/_api-reference/index-apis/clear-index-cache.md index fef459f0..11216e76 100644 --- a/_api-reference/index-apis/clear-index-cache.md +++ b/_api-reference/index-apis/clear-index-cache.md @@ -2,10 +2,10 @@ layout: default title: Clear Index or Data Stream Cache parent: Index APIs -nav_order: 320 +nav_order: 10 --- -## Clear index or data stream cache +# Clear index or data stream cache The clear cache API operation clears the caches of one or more indexes. For data streams, the API clears the caches of the stream’s backing indexes. @@ -13,14 +13,14 @@ The clear cache API operation clears the caches of one or more indexes. For data If you use the Security plugin, you must have the `manage index` privileges. {: .note} -### Path parameters +## Path parameters | Parameter | Data type | Description | :--- | :--- | :--- | target | String | Comma-delimited list of data streams, indexes, and index aliases to which cache clearing will be applied. Wildcard expressions (`*`) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. Optional. | -### Query parameters +## Query parameters All query parameters are optional. @@ -35,11 +35,11 @@ All query parameters are optional. | query | Boolean | If `true`, clears the query cache. Defaults to `true`. | | request | Boolean | If `true`, clears the request cache. Defaults to `true`. | -#### Example requests +## Example requests The following example requests show multiple clear cache API uses. -##### Clear a specific cache +### Clear a specific cache The following request clears the fields cache only: @@ -66,7 +66,7 @@ POST /my-index/_cache/clear?request=true ```` {% include copy-curl.html %} -##### Clear the cache for specific fields +### Clear the cache for specific fields The following request clears the fields caches of `fielda` and `fieldb`: @@ -75,7 +75,7 @@ POST /my-index/_cache/clear?fields=fielda,fieldb ```` {% include copy-curl.html %} -##### Clear caches for specific data streams and indexes +### Clear caches for specific data streams and indexes The following request clears the cache for two specific indexes: @@ -84,7 +84,7 @@ POST /my-index,my-index2/_cache/clear ```` {% include copy-curl.html %} -##### Clear caches for all data streams and indexes +### Clear caches for all data streams and indexes The following request clears the cache for all data streams and indexes: @@ -93,7 +93,7 @@ POST /_cache/clear ```` {% include copy-curl.html %} -#### Example response +## Example response The `POST /books,hockey/_cache/clear` request returns the following fields: @@ -107,7 +107,7 @@ The `POST /books,hockey/_cache/clear` request returns the following fields: } ```` -### Response fields +## Response fields The `POST /books,hockey/_cache/clear` request returns the following response fields: diff --git a/_api-reference/index-apis/clone.md b/_api-reference/index-apis/clone.md index 788e7e81..32316122 100644 --- a/_api-reference/index-apis/clone.md +++ b/_api-reference/index-apis/clone.md @@ -2,7 +2,7 @@ layout: default title: Clone index parent: Index APIs -nav_order: 70 +nav_order: 15 redirect_from: - /opensearch/rest-api/index-apis/clone/ --- diff --git a/_api-reference/index-apis/close-index.md b/_api-reference/index-apis/close-index.md index 5a1d3c25..9cebeeb7 100644 --- a/_api-reference/index-apis/close-index.md +++ b/_api-reference/index-apis/close-index.md @@ -2,7 +2,7 @@ layout: default title: Close index parent: Index APIs -nav_order: 30 +nav_order: 20 redirect_from: - /opensearch/rest-api/index-apis/close-index/ --- @@ -32,10 +32,10 @@ All parameters are optional. Parameter | Type | Description :--- | :--- | :--- -<index-name> | String | The index to close. Can be a comma-separated list of multiple index names. Use `_all` or * to close all indices. -allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indices. Default is true. -expand_wildcards | String | Expands wildcard expressions to different indices. Combine multiple values with commas. Available values are all (match all indices), open (match open indices), closed (match closed indices), hidden (match hidden indices), and none (do not accept wildcard expressions). Default is open. -ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indices. Default is false. +<index-name> | String | The index to close. Can be a comma-separated list of multiple index names. Use `_all` or * to close all indexes. +allow_no_indices | Boolean | Whether to ignore wildcards that don't match any indexes. Default is true. +expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are all (match all indexes), open (match open indexes), closed (match closed indexes), hidden (match hidden indexes), and none (do not accept wildcard expressions). Default is open. +ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indexes. Default is false. wait_for_active_shards | String | Specifies the number of active shards that must be available before OpenSearch processes the request. Default is 1 (only the primary shard). Set to all or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the request to succeed. master_timeout | Time | How long to wait for a connection to the master node. Default is `30s`. timeout | Time | How long to wait for a response from the cluster. Default is `30s`. diff --git a/_api-reference/index-apis/create-index.md b/_api-reference/index-apis/create-index.md index 635e7484..e2efa0b4 100644 --- a/_api-reference/index-apis/create-index.md +++ b/_api-reference/index-apis/create-index.md @@ -2,10 +2,10 @@ layout: default title: Create index parent: Index APIs -nav_order: 1 +nav_order: 25 redirect_from: - /opensearch/rest-api/index-apis/create-index/ - - opensearch/rest-api/create-index/ + - /opensearch/rest-api/create-index/ --- # Create index diff --git a/_api-reference/index-apis/dangling-index.md b/_api-reference/index-apis/dangling-index.md index 1513a723..2a8bbce7 100644 --- a/_api-reference/index-apis/dangling-index.md +++ b/_api-reference/index-apis/dangling-index.md @@ -2,7 +2,7 @@ layout: default title: Dangling indexes parent: index-apis -nav_order: 84 +nav_order: 30 --- # Dangling indexes API diff --git a/_api-reference/index-apis/delete-index.md b/_api-reference/index-apis/delete-index.md index 29984b7a..fa6a4eb9 100644 --- a/_api-reference/index-apis/delete-index.md +++ b/_api-reference/index-apis/delete-index.md @@ -2,7 +2,7 @@ layout: default title: Delete index parent: Index APIs -nav_order: 10 +nav_order: 35 redirect_from: - /opensearch/rest-api/index-apis/delete-index/ --- diff --git a/_api-reference/index-apis/exists.md b/_api-reference/index-apis/exists.md index 88acd1da..a5bba5f3 100644 --- a/_api-reference/index-apis/exists.md +++ b/_api-reference/index-apis/exists.md @@ -2,7 +2,7 @@ layout: default title: Index exists parent: Index APIs -nav_order: 5 +nav_order: 50 redirect_from: - /opensearch/rest-api/index-apis/exists/ --- diff --git a/_api-reference/index-apis/get-index.md b/_api-reference/index-apis/get-index.md index 2c759587..c51ac181 100644 --- a/_api-reference/index-apis/get-index.md +++ b/_api-reference/index-apis/get-index.md @@ -2,7 +2,7 @@ layout: default title: Get index parent: Index APIs -nav_order: 20 +nav_order: 40 redirect_from: - /opensearch/rest-api/index-apis/get-index/ --- diff --git a/_api-reference/index-apis/get-settings.md b/_api-reference/index-apis/get-settings.md index f695ddb2..60b59a1b 100644 --- a/_api-reference/index-apis/get-settings.md +++ b/_api-reference/index-apis/get-settings.md @@ -2,7 +2,7 @@ layout: default title: Get settings parent: Index APIs -nav_order: 100 +nav_order: 45 redirect_from: - /opensearch/rest-api/index-apis/get-index/ --- diff --git a/_api-reference/index-apis/open-index.md b/_api-reference/index-apis/open-index.md index 98d020ea..40dc8be0 100644 --- a/_api-reference/index-apis/open-index.md +++ b/_api-reference/index-apis/open-index.md @@ -2,7 +2,7 @@ layout: default title: Open index parent: Index APIs -nav_order: 40 +nav_order: 55 redirect_from: - /opensearch/rest-api/index-apis/open-index/ --- diff --git a/_api-reference/index-apis/put-mapping.md b/_api-reference/index-apis/put-mapping.md index 528dc9db..55ba0f80 100644 --- a/_api-reference/index-apis/put-mapping.md +++ b/_api-reference/index-apis/put-mapping.md @@ -2,7 +2,7 @@ layout: default title: Create or update mappings parent: Index APIs -nav_order: 220 +nav_order: 27 redirect_from: - /opensearch/rest-api/index-apis/update-mapping/ --- diff --git a/_api-reference/index-apis/shrink-index.md b/_api-reference/index-apis/shrink-index.md index 402f8943..0a1ee5c4 100644 --- a/_api-reference/index-apis/shrink-index.md +++ b/_api-reference/index-apis/shrink-index.md @@ -2,7 +2,7 @@ layout: default title: Shrink index parent: Index APIs -nav_order: 50 +nav_order: 65 redirect_from: - /opensearch/rest-api/index-apis/shrink-index/ --- diff --git a/_api-reference/index-apis/split.md b/_api-reference/index-apis/split.md index d35030ce..e33d8155 100644 --- a/_api-reference/index-apis/split.md +++ b/_api-reference/index-apis/split.md @@ -2,7 +2,7 @@ layout: default title: Split index parent: Index APIs -nav_order: 80 +nav_order: 70 redirect_from: - /opensearch/rest-api/index-apis/split/ --- diff --git a/_api-reference/index-apis/update-settings.md b/_api-reference/index-apis/update-settings.md index 16a4a9d3..5e8abcde 100644 --- a/_api-reference/index-apis/update-settings.md +++ b/_api-reference/index-apis/update-settings.md @@ -2,7 +2,7 @@ layout: default title: Update settings parent: Index APIs -nav_order: 120 +nav_order: 75 redirect_from: - /opensearch/rest-api/index-apis/update-settings/ ---