From 8ed9a9505b24e4a712ec663f893b206d08d72084 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Thu, 4 May 2023 10:44:02 -0700 Subject: [PATCH] More redirect fixes - index and ingestion APIs (#3975) * more redirect fixes to index and ingest apis Signed-off-by: Heather Halter * one more Signed-off-by: Heather Halter --------- Signed-off-by: Heather Halter Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _api-reference/index-apis/clone.md | 2 ++ _api-reference/index-apis/close-index.md | 2 ++ _api-reference/index-apis/create-index.md | 6 +++--- _api-reference/index-apis/dangling-index.md | 2 +- _api-reference/index-apis/delete-index.md | 2 ++ _api-reference/index-apis/exists.md | 10 +++++----- _api-reference/index-apis/get-index.md | 8 +++++--- _api-reference/index-apis/get-settings.md | 4 +++- _api-reference/index-apis/index.md | 2 +- _api-reference/index-apis/open-index.md | 10 ++++++---- _api-reference/index-apis/put-mapping.md | 2 ++ _api-reference/index-apis/shrink-index.md | 4 +++- _api-reference/index-apis/split.md | 2 ++ _api-reference/index-apis/update-settings.md | 2 ++ _api-reference/index.md | 2 +- _api-reference/ingest-apis/create-update-ingest.md | 2 ++ _api-reference/ingest-apis/delete-ingest.md | 2 ++ _api-reference/ingest-apis/get-ingest.md | 2 ++ _api-reference/ingest-apis/index.md | 2 +- _api-reference/ingest-apis/simulate-ingest.md | 2 ++ _api-reference/search.md | 6 ++++-- _api-reference/tasks.md | 4 +++- 22 files changed, 56 insertions(+), 24 deletions(-) diff --git a/_api-reference/index-apis/clone.md b/_api-reference/index-apis/clone.md index bc956edd..788e7e81 100644 --- a/_api-reference/index-apis/clone.md +++ b/_api-reference/index-apis/clone.md @@ -3,6 +3,8 @@ layout: default title: Clone index parent: Index APIs nav_order: 70 +redirect_from: + - /opensearch/rest-api/index-apis/clone/ --- # Clone index diff --git a/_api-reference/index-apis/close-index.md b/_api-reference/index-apis/close-index.md index a914a7ea..5a1d3c25 100644 --- a/_api-reference/index-apis/close-index.md +++ b/_api-reference/index-apis/close-index.md @@ -3,6 +3,8 @@ layout: default title: Close index parent: Index APIs nav_order: 30 +redirect_from: + - /opensearch/rest-api/index-apis/close-index/ --- # Close index diff --git a/_api-reference/index-apis/create-index.md b/_api-reference/index-apis/create-index.md index af97d389..57ebf330 100644 --- a/_api-reference/index-apis/create-index.md +++ b/_api-reference/index-apis/create-index.md @@ -4,14 +4,14 @@ title: Create index parent: Index APIs nav_order: 1 redirect_from: - - /opensearch/rest-api/index-apis/create-index/ + - /opensearch/rest-api/index-apis/create-index/ --- # Create index Introduced 1.0 {: .label .label-purple } -While you can create an index by using a document as a base, you can also just create an empty index for use later. +While you can create an index by using a document as a base, you can also create an empty index for use later. ## Example @@ -92,7 +92,7 @@ index.hidden | Whether the index should be hidden. Hidden indices are not return Setting | Description :--- | :--- index.number_of_replicas | The number of replica shards each primary shard should have. For example, if you have 4 primary shards and set `index.number_of_replicas` to 3, the index has 12 replica shards. Default is 1. -index.auto_expand_replicas | Whether the cluster should automatically add replica shards based on the number of data nodes. Specify a lower and upper bound (for example, `0-9`). You can use `all` for the upper bound. For example, if you have 5 data nodes and set `index.auto_expand_replicas` to `0-3`, then the cluster does not automatically add another replica shard. However, if you set this value to `0-all` and add 2 more nodes for a total of 7, the cluster will expand to now have 6 replica shards. Default is `false` (disabled). +index.auto_expand_replicas | Whether the cluster should automatically add replica shards based on the number of data nodes. Specify a lower bound and upper limit (for example, 0-9), or `all` for the upper limit. For example, if you have 5 data nodes and set `index.auto_expand_replicas` to 0-3, then the cluster does not automatically add another replica shard. However, if you set this value to `0-all` and add 2 more nodes for a total of 7, the cluster will expand to now have 6 replica shards. Default is disabled. index.search.idle.after | Amount of time a shard should wait for a search or get request until it goes idle. Default is `30s`. index.refresh_interval | How often the index should refresh, which publishes its most recent changes and makes them available for searching. Can be set to `-1` to disable refreshing. Default is `1s`. index.max_result_window | The maximum value of `from` + `size` for searches to the index. `from` is the starting index to search from, and `size` is the amount of results to return. Default: 10000. diff --git a/_api-reference/index-apis/dangling-index.md b/_api-reference/index-apis/dangling-index.md index 653e8189..1513a723 100644 --- a/_api-reference/index-apis/dangling-index.md +++ b/_api-reference/index-apis/dangling-index.md @@ -43,7 +43,7 @@ Query parameters are optional. Query parameter | Data type | Description :--- | :--- | :--- -accept_data_loss | Boolean | Must be set to `true` for an `import` or `delete` because Opensearch is unaware of where the dangling index data came from. +accept_data_loss | Boolean | Must be set to `true` for an `import` or `delete` because OpenSearch is unaware of where the dangling index data came from. timeout | Time units | The amount of time to wait for a response. If no response is received in the defined time period, an error is returned. Default is `30` seconds. master_timeout | Time units | The amount of time to wait for the connection to the cluster manager. If no response is received in the defined time period, an error is returned. Default is `30` seconds. diff --git a/_api-reference/index-apis/delete-index.md b/_api-reference/index-apis/delete-index.md index e938b5ea..e3d5d911 100644 --- a/_api-reference/index-apis/delete-index.md +++ b/_api-reference/index-apis/delete-index.md @@ -3,6 +3,8 @@ layout: default title: Delete index parent: Index APIs nav_order: 10 +redirect_from: + - /opensearch/rest-api/index-apis/delete-index/ --- # Delete index diff --git a/_api-reference/index-apis/exists.md b/_api-reference/index-apis/exists.md index fa60b79a..88acd1da 100644 --- a/_api-reference/index-apis/exists.md +++ b/_api-reference/index-apis/exists.md @@ -3,8 +3,8 @@ layout: default title: Index exists parent: Index APIs nav_order: 5 -redirect_from: - - /opensearch/rest-api/index-apis/exists/ +redirect_from: + - /opensearch/rest-api/index-apis/exists/ --- # Index exists @@ -32,11 +32,11 @@ All parameters are optional. Parameter | Type | Description :--- | :--- | :--- -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. +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. flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "index": { "creation_date": "123456789" } is "index.creation_date": "123456789". include_defaults | Boolean | Whether to include default settings as part of the response. This parameter is useful for identifying the names and current values of settings you want to update. -ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indices. Default is false. +ignore_unavailable | Boolean | If true, OpenSearch does not search for missing or closed indexes. Default is false. local | Boolean | Whether to return information from only the local node instead of from the master node. Default is false. diff --git a/_api-reference/index-apis/get-index.md b/_api-reference/index-apis/get-index.md index 60b5976d..2c759587 100644 --- a/_api-reference/index-apis/get-index.md +++ b/_api-reference/index-apis/get-index.md @@ -3,6 +3,8 @@ layout: default title: Get index parent: Index APIs nav_order: 20 +redirect_from: + - /opensearch/rest-api/index-apis/get-index/ --- # Get index @@ -30,11 +32,11 @@ All parameters are optional. Parameter | Type | Description :--- | :--- | :--- -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), which must be used with open, closed, or both. Default is open. +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), which must be used with open, closed, or both. Default is open. flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "index": { "creation_date": "123456789" } is "index.creation_date": "123456789". include_defaults | Boolean | Whether to include default settings as part of the response. This parameter is useful for identifying the names and current values of settings you want to update. -ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indices in the response. +ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response. local | Boolean | Whether to return information from only the local node instead of from the master node. Default is false. master_timeout | Time | How long to wait for a connection to the master node. Default is `30s`. diff --git a/_api-reference/index-apis/get-settings.md b/_api-reference/index-apis/get-settings.md index 6fa558a7..f695ddb2 100644 --- a/_api-reference/index-apis/get-settings.md +++ b/_api-reference/index-apis/get-settings.md @@ -3,6 +3,8 @@ layout: default title: Get settings parent: Index APIs nav_order: 100 +redirect_from: + - /opensearch/rest-api/index-apis/get-index/ --- # Get settings @@ -37,7 +39,7 @@ Parameter | Data type | Description 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), which must be used with `open`, `closed`, or both. Default is `open`. flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of “index”: { “creation_date”: “123456789” } is “index.creation_date”: “123456789”. -include_defaults | String | Whether to include default settings, including settings used within OpenSearch's plugins, in the response. Default is false. +include_defaults | String | Whether to include default settings, including settings used within OpenSearch plugins, in the response. Default is false. ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response. local | Boolean | Whether to return information from the local node only instead of the master node. Default is false. master_timeout | Time | How long to wait for a connection to the master node. Default is `30s`. diff --git a/_api-reference/index-apis/index.md b/_api-reference/index-apis/index.md index adb164c8..2428bcb3 100644 --- a/_api-reference/index-apis/index.md +++ b/_api-reference/index-apis/index.md @@ -9,7 +9,7 @@ redirect_from: # Index APIs -The index API operations let you interact with indices in your cluster. Using these operations, you can create, delete, close, and complete other index-related operations. +The index API operations let you interact with indexes in your cluster. Using these operations, you can create, delete, close, and complete other index-related operations. If you use the Security plugin, make sure you have the appropriate permissions. {: .note } diff --git a/_api-reference/index-apis/open-index.md b/_api-reference/index-apis/open-index.md index 4097620a..98d020ea 100644 --- a/_api-reference/index-apis/open-index.md +++ b/_api-reference/index-apis/open-index.md @@ -3,6 +3,8 @@ layout: default title: Open index parent: Index APIs nav_order: 40 +redirect_from: + - /opensearch/rest-api/index-apis/open-index/ --- # Open index @@ -30,10 +32,10 @@ All parameters are optional. Parameter | Type | Description :--- | :--- | :--- -<index-name> | String | The index to open. Can be a comma-separated list of multiple index names. Use `_all` or * to open 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 open. Can be a comma-separated list of multiple index names. Use `_all` or * to open 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/put-mapping.md b/_api-reference/index-apis/put-mapping.md index ec6e0b1b..8f474b48 100644 --- a/_api-reference/index-apis/put-mapping.md +++ b/_api-reference/index-apis/put-mapping.md @@ -3,6 +3,8 @@ layout: default title: Create or update mappings parent: Index APIs nav_order: 220 +redirect_from: + - /opensearch/rest-api/index-apis/put-mapping/ --- # Create or update mappings diff --git a/_api-reference/index-apis/shrink-index.md b/_api-reference/index-apis/shrink-index.md index 851e6040..402f8943 100644 --- a/_api-reference/index-apis/shrink-index.md +++ b/_api-reference/index-apis/shrink-index.md @@ -3,6 +3,8 @@ layout: default title: Shrink index parent: Index APIs nav_order: 50 +redirect_from: + - /opensearch/rest-api/index-apis/shrink-index/ --- # Shrink index @@ -32,7 +34,7 @@ POST //_shrink/ PUT //_shrink/ ``` -When creating new indices with this operation, remember that OpenSearch indices have the following naming restrictions: +When creating new indexes with this operation, remember that OpenSearch indexes have the following naming restrictions: - All letters must be lowercase. - Index names can't begin with underscores (`_`) or hyphens (`-`). diff --git a/_api-reference/index-apis/split.md b/_api-reference/index-apis/split.md index 80a0f9ca..d35030ce 100644 --- a/_api-reference/index-apis/split.md +++ b/_api-reference/index-apis/split.md @@ -3,6 +3,8 @@ layout: default title: Split index parent: Index APIs nav_order: 80 +redirect_from: + - /opensearch/rest-api/index-apis/split/ --- # Split index diff --git a/_api-reference/index-apis/update-settings.md b/_api-reference/index-apis/update-settings.md index fd507fd1..16a4a9d3 100644 --- a/_api-reference/index-apis/update-settings.md +++ b/_api-reference/index-apis/update-settings.md @@ -3,6 +3,8 @@ layout: default title: Update settings parent: Index APIs nav_order: 120 +redirect_from: + - /opensearch/rest-api/index-apis/update-settings/ --- # Update settings diff --git a/_api-reference/index.md b/_api-reference/index.md index cd5a5ea8..cbd516ae 100644 --- a/_api-reference/index.md +++ b/_api-reference/index.md @@ -4,7 +4,7 @@ title: REST API reference nav_order: 1 has_toc: true redirect_from: - - /opensearch/rest-api/ + - /opensearch/rest-api/index/ --- # REST API reference diff --git a/_api-reference/ingest-apis/create-update-ingest.md b/_api-reference/ingest-apis/create-update-ingest.md index 03e5d1f3..de2ea4ac 100644 --- a/_api-reference/ingest-apis/create-update-ingest.md +++ b/_api-reference/ingest-apis/create-update-ingest.md @@ -3,6 +3,8 @@ layout: default title: Create or update ingest pipeline parent: Ingest APIs nav_order: 11 +redirect_from: + - /opensearch/rest-api/ingest-apis/create-update-ingest/ --- # Create and update a pipeline diff --git a/_api-reference/ingest-apis/delete-ingest.md b/_api-reference/ingest-apis/delete-ingest.md index 0f2b6e95..c5065d1e 100644 --- a/_api-reference/ingest-apis/delete-ingest.md +++ b/_api-reference/ingest-apis/delete-ingest.md @@ -3,6 +3,8 @@ layout: default title: Delete a pipeline parent: Ingest APIs nav_order: 14 +redirect_from: + - /opensearch/rest-api/ingest-apis/delete-ingest/ --- # Delete a pipeline diff --git a/_api-reference/ingest-apis/get-ingest.md b/_api-reference/ingest-apis/get-ingest.md index c92d8e51..f8e18f8a 100644 --- a/_api-reference/ingest-apis/get-ingest.md +++ b/_api-reference/ingest-apis/get-ingest.md @@ -3,6 +3,8 @@ layout: default title: Get ingest pipeline parent: Ingest APIs nav_order: 10 +redirect_from: + - /opensearch/rest-api/ingest-apis/get-ingest/ --- ## Get ingest pipeline diff --git a/_api-reference/ingest-apis/index.md b/_api-reference/ingest-apis/index.md index 7e12387a..1df68b70 100644 --- a/_api-reference/ingest-apis/index.md +++ b/_api-reference/ingest-apis/index.md @@ -4,7 +4,7 @@ title: Ingest APIs has_children: true nav_order: 40 redirect_from: - - /opensearch/rest-api/ingest-apis/ + - /opensearch/rest-api/ingest-apis/index/ --- # Ingest APIs diff --git a/_api-reference/ingest-apis/simulate-ingest.md b/_api-reference/ingest-apis/simulate-ingest.md index db22336a..e8d85813 100644 --- a/_api-reference/ingest-apis/simulate-ingest.md +++ b/_api-reference/ingest-apis/simulate-ingest.md @@ -3,6 +3,8 @@ layout: default title: Simulate an ingest pipeline parent: Ingest APIs nav_order: 13 +redirect_from: + - /opensearch/rest-api/ingest-apis/simulate-ingest/ --- # Simulate a pipeline diff --git a/_api-reference/search.md b/_api-reference/search.md index 4422afa5..a449ee42 100644 --- a/_api-reference/search.md +++ b/_api-reference/search.md @@ -2,6 +2,8 @@ layout: default title: Search nav_order: 75 +redirect_from: + - /opensearch/rest-api/search/ --- # Search @@ -64,7 +66,7 @@ request_cache | Boolean | Specifies whether OpenSearch should use the request ca rest_total_hits_as_int | Boolean | Whether to return `hits.total` as an integer. Returns an object otherwise. Default is false. routing | String | Value used to route the update by query operation to a specific shard. scroll | Time | How long to keep the search context open. -search_type | String | Whether OpenSearch should use global term and document frequencies when calculating revelance scores. Valid choices are `query_then_fetch` and `dfs_query_then_fetch`. `query_then_fetch` scores documents using local term and document frequencies for the shard. It’s usually faster but less accurate. `dfs_query_then_fetch` scores documents using global term and document frequencies across all shards. It’s usually slower but more accurate. Default is `query_then_fetch`. +search_type | String | Whether OpenSearch should use global term and document frequencies when calculating relevance scores. Valid choices are `query_then_fetch` and `dfs_query_then_fetch`. `query_then_fetch` scores documents using local term and document frequencies for the shard. It’s usually faster but less accurate. `dfs_query_then_fetch` scores documents using global term and document frequencies across all shards. It’s usually slower but more accurate. Default is `query_then_fetch`. seq_no_primary_term | Boolean | Whether to return sequence number and primary term of the last operation of each document hit. size | Integer | How many results to include in the response. sort | List | A comma-separated list of <field> : <direction> pairs to sort by. @@ -94,7 +96,7 @@ docvalue_fields | Array of objects | The fields that OpenSearch should return us fields | Array | The fields to search for in the request. Specify a format to return results in a certain format, such as date and time. explain | String | Whether to return details about how OpenSearch computed the document's score. Default is false. from | Integer | The starting index to search from. Default is 0. -indices_boost | Array of objects | Scores used to boost specified indices' scores. Specify in the format of <index> : <boost-multiplier> +indices_boost | Array of objects | Values used to boost the score of specified indexes. Specify in the format of <index> : <boost-multiplier> min_score | Integer | Specify a score threshold to return only documents above the threshold. query | Object | The [DSL query]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index) to use in the request. seq_no_primary_term | Boolean | Whether to return sequence number and primary term of the last operation of each document hit. diff --git a/_api-reference/tasks.md b/_api-reference/tasks.md index 54dbe62a..fd8099bc 100644 --- a/_api-reference/tasks.md +++ b/_api-reference/tasks.md @@ -2,6 +2,8 @@ layout: default title: Tasks nav_order: 85 +redirect_from: + - /opensearch/rest-api/tasks/ --- # Tasks @@ -146,7 +148,7 @@ GET /_tasks?nodes=opensearch-node1 } ``` -The following request will return detailed information about active search tasks: +The following request returns detailed information about active search tasks: **Sample Request**