From 5f678cd814bea6741284cbaed2a2c42b7ceaf004 Mon Sep 17 00:00:00 2001 From: aetter Date: Mon, 26 Jul 2021 16:14:22 -0700 Subject: [PATCH] Add "introduced" labels for APIs --- _im-plugin/index-rollups/rollup-api.md | 10 +++ .../index-transforms/transforms-apis.md | 16 ++++ _im-plugin/ism/api.md | 18 +++++ _monitoring-plugins/ad/api.md | 24 ++++++ _monitoring-plugins/alerting/api.md | 48 +++++++++++ _monitoring-plugins/pa/api.md | 2 + _opensearch/rest-api/alias.md | 2 + _opensearch/rest-api/cat/cat-aliases.md | 2 + _opensearch/rest-api/cat/cat-allocation.md | 2 + _opensearch/rest-api/cat/cat-count.md | 2 + _opensearch/rest-api/cat/cat-field-data.md | 2 + _opensearch/rest-api/cat/cat-health.md | 2 + _opensearch/rest-api/cat/cat-indices.md | 2 + _opensearch/rest-api/cat/cat-master.md | 2 + _opensearch/rest-api/cat/cat-nodeattrs.md | 2 + _opensearch/rest-api/cat/cat-nodes.md | 2 + _opensearch/rest-api/cat/cat-pending-tasks.md | 2 + _opensearch/rest-api/cat/cat-plugins.md | 2 + _opensearch/rest-api/cat/cat-recovery.md | 2 + _opensearch/rest-api/cat/cat-repositories.md | 2 + _opensearch/rest-api/cat/cat-segments.md | 2 + _opensearch/rest-api/cat/cat-shards.md | 2 + _opensearch/rest-api/cat/cat-snapshots.md | 2 + _opensearch/rest-api/cat/cat-tasks.md | 2 + _opensearch/rest-api/cat/cat-templates.md | 2 + _opensearch/rest-api/cat/cat-thread-pool.md | 4 +- _opensearch/rest-api/cluster-allocation.md | 2 + _opensearch/rest-api/cluster-health.md | 2 + _opensearch/rest-api/cluster-settings.md | 2 + _opensearch/rest-api/create-index.md | 2 + _opensearch/rest-api/document-apis/bulk.md | 2 + .../rest-api/document-apis/delete-document.md | 4 +- .../rest-api/document-apis/get-documents.md | 2 + _opensearch/rest-api/scroll.md | 2 + _opensearch/rest-api/tasks.md | 2 + _sass/custom/custom.scss | 22 ++--- _search-plugins/async/index.md | 8 ++ _search-plugins/knn/api.md | 4 + _search-plugins/ppl/endpoint.md | 2 + _search-plugins/sql/endpoints.md | 4 +- _security-plugin/access-control/api.md | 80 +++++++++++++++++++ 41 files changed, 283 insertions(+), 17 deletions(-) diff --git a/_im-plugin/index-rollups/rollup-api.md b/_im-plugin/index-rollups/rollup-api.md index 9e17b4f5..ad8bebd5 100644 --- a/_im-plugin/index-rollups/rollup-api.md +++ b/_im-plugin/index-rollups/rollup-api.md @@ -20,6 +20,8 @@ Use the index rollup operations to programmatically work with index rollup jobs. --- ## Create or update an index rollup job +Introduced 1.0 +{: .label .label-purple } Creates or updates an index rollup job. You must provide the `seq_no` and `primary_term` parameters. @@ -134,6 +136,8 @@ Options | Description | Type | Required ## Get an index rollup job +Introduced 1.0 +{: .label .label-purple } Returns all information about an index rollup job based on the `rollup_id`. @@ -159,6 +163,8 @@ GET _plugins/_rollup/jobs/ --- ## Delete an index rollup job +Introduced 1.0 +{: .label .label-purple } Deletes an index rollup job based on the `rollup_id`. @@ -178,6 +184,8 @@ DELETE _plugins/_rollup/jobs/ ## Start or stop an index rollup job +Introduced 1.0 +{: .label .label-purple } Start or stop an index rollup job. @@ -199,6 +207,8 @@ POST _plugins/_rollup/jobs//_stop --- ## Explain an index rollup job +Introduced 1.0 +{: .label .label-purple } Returns detailed metadata information about the index rollup job and its current progress. diff --git a/_im-plugin/index-transforms/transforms-apis.md b/_im-plugin/index-transforms/transforms-apis.md index 5edd7766..67acd298 100644 --- a/_im-plugin/index-transforms/transforms-apis.md +++ b/_im-plugin/index-transforms/transforms-apis.md @@ -15,6 +15,8 @@ Aside from using OpenSearch Dashboards, you can also use the REST API to create, {:toc} ## Create a transform job +Introduced 1.0 +{: .label .label-purple } Creates a transform job. @@ -139,6 +141,8 @@ source_field | String | The field(s) to transform | Yes aggregations | JSON | The aggregations to use in the transform job. Supported aggregations are: `sum`, `max`, `min`, `value_count`, `avg`, `scripted_metric`, and `percentiles`. For more information, see [Metric Aggregations]({{site.url}}{{site.baseurl}}/opensearch/metric-agg). | Yes if not using groups ## Update a transform job +Introduced 1.0 +{: .label .label-purple } Updates a transform job if `transform_id` already exists. @@ -254,6 +258,8 @@ Parameter | Description | Required `if_primary_term` | Only perform the transform operation if the last operation that changed the transform job has the specified sequence term. | No ## Get a transform job's details +Introduced 1.0 +{: .label .label-purple } Returns a transform job's details. @@ -520,6 +526,8 @@ GET _plugins/_transform?size=2&from=8 ``` ## Start a transform job +Introduced 1.0 +{: .label .label-purple } Transform jobs created using the API are automatically enabled, but if you ever need to enable a job, you can use the `start` API operation. @@ -538,6 +546,8 @@ POST _plugins/_transform//_start ``` ## Stop a transform job +Introduced 1.0 +{: .label .label-purple } Stops/disables a transform job. @@ -556,6 +566,8 @@ POST _plugins/_transform//_stop ``` ## Get the status of a transform job +Introduced 1.0 +{: .label .label-purple } Returns the status and metadata of a transform job. @@ -589,6 +601,8 @@ GET _plugins/_transform//_explain ``` ## Preview a transform job's results +Introduced 1.0 +{: .label .label-purple } Returns a preview of what a transformed index would look like. @@ -674,6 +688,8 @@ POST _plugins/_transform/_preview ``` ## Delete a transform job +Introduced 1.0 +{: .label .label-purple } Deletes a transform job. This operation does not delete the source or target indices. diff --git a/_im-plugin/ism/api.md b/_im-plugin/ism/api.md index 4b568ad6..5209c435 100644 --- a/_im-plugin/ism/api.md +++ b/_im-plugin/ism/api.md @@ -21,6 +21,8 @@ Use the index state management operations to programmatically work with policies ## Create policy +Introduced 1.0 +{: .label .label-purple } Creates a policy. @@ -138,6 +140,8 @@ PUT _plugins/_ism/policies/policy_1 --- ## Add policy +Introduced 1.0 +{: .label .label-purple } Adds a policy to an index. This operation does not change the policy if the index already has one. @@ -168,6 +172,8 @@ Don't use the broad `*` wildcard, and instead add a prefix, such as `my-logs*`, ## Update policy +Introduced 1.0 +{: .label .label-purple } Updates a policy. Use the `seq_no` and `primary_term` parameters to update an existing policy. If these numbers don't match the existing policy or the policy doesn't exist, ISM throws an error. @@ -285,6 +291,8 @@ PUT _plugins/_ism/policies/policy_1?if_seq_no=7&if_primary_term=1 --- ## Get policy +Introduced 1.0 +{: .label .label-purple } Gets the policy by `policy_id`. @@ -355,6 +363,8 @@ GET _plugins/_ism/policies/policy_1 --- ## Remove policy from index +Introduced 1.0 +{: .label .label-purple } Removes any ISM policy from the index. @@ -378,6 +388,8 @@ POST _plugins/_ism/remove/index_1 --- ## Update managed index policy +Introduced 1.0 +{: .label .label-purple } Updates the managed index policy to a new policy (or to a new version of the policy). You can use an index pattern to update multiple indices at once. When updating multiple indices, you might want to include a state filter to only affect certain managed indices. The change policy filters out all the existing managed indices and only applies the change to the ones in the state that you specify. You can also explicitly specify the state that the managed index transitions to after the change policy takes effect. @@ -414,6 +426,8 @@ POST _plugins/_ism/change_policy/index_1 --- ## Retry failed index +Introduced 1.0 +{: .label .label-purple } Retries the failed action for an index. For the retry call to succeed, ISM must manage the index, and the index must be in a failed state. You can use index patterns (`*`) to retry multiple failed indices. @@ -440,6 +454,8 @@ POST _plugins/_ism/retry/index_1 --- ## Explain index +Introduced 1.0 +{: .label .label-purple } Gets the current state of the index. You can use index patterns to get the status of multiple indices. @@ -465,6 +481,8 @@ The `plugins.index_state_management.policy_id` setting is deprecated starting fr --- ## Delete policy +Introduced 1.0 +{: .label .label-purple } Deletes the policy by `policy_id`. diff --git a/_monitoring-plugins/ad/api.md b/_monitoring-plugins/ad/api.md index ac52c534..a46420a9 100644 --- a/_monitoring-plugins/ad/api.md +++ b/_monitoring-plugins/ad/api.md @@ -19,6 +19,8 @@ Use these anomaly detection operations to programmatically create and manage det --- ## Create anomaly detector +Introduced 1.0 +{: .label .label-purple } Creates an anomaly detector. @@ -306,6 +308,8 @@ Options | Description | Type | Required --- ## Preview detector +Introduced 1.0 +{: .label .label-purple } Passes a date range to the anomaly detector to return any anomalies within that date range. @@ -445,6 +449,8 @@ If you specify a category field, each result is associated with an entity: --- ## Start detector job +Introduced 1.0 +{: .label .label-purple } Starts a real-time or historical anomaly detector job. @@ -470,6 +476,8 @@ POST _plugins/_anomaly_detection/detectors//_start --- ## Stop detector job +Introduced 1.0 +{: .label .label-purple } Stops a real-time or historical anomaly detector job. @@ -488,6 +496,8 @@ Stopped detector: m4ccEnIBTXsGi3mvMt9p --- ## Search detector result +Introduced 1.0 +{: .label .label-purple } Returns all results for a search query. @@ -933,6 +943,8 @@ GET _plugins/_anomaly_detection/detectors/results/_search --- ## Delete detector +Introduced 1.0 +{: .label .label-purple } Deletes a detector based on the `detector_id`. To delete a detector, you need to first stop the detector. @@ -968,6 +980,8 @@ DELETE _plugins/_anomaly_detection/detectors/ --- ## Update detector +Introduced 1.0 +{: .label .label-purple } Updates a detector with any changes, including the description or adding or removing of features. To update a detector, you need to first stop the detector. @@ -1139,6 +1153,8 @@ PUT _plugins/_anomaly_detection/detectors/ --- ## Get detector +Introduced 1.0 +{: .label .label-purple } Returns all information about a detector based on the `detector_id`. @@ -1485,6 +1501,8 @@ GET _plugins/_anomaly_detection/detectors/?task=true --- ## Search detector +Introduced 1.0 +{: .label .label-purple } Returns all anomaly detectors for a search query. @@ -1591,6 +1609,8 @@ Sample Input: --- ## Get detector stats +Introduced 1.0 +{: .label .label-purple } Provides information about how the plugin is performing. @@ -1691,6 +1711,8 @@ Historical detectors contain additional fields: --- ## Create monitor +Introduced 1.0 +{: .label .label-purple } Create a monitor to set up alerts for the detector. @@ -1909,6 +1931,8 @@ POST _plugins/_alerting/monitors --- ## Profile detector +Introduced 1.0 +{: .label .label-purple } Returns information related to the current state of the detector and memory usage, including current errors and shingle size, to help troubleshoot the detector. diff --git a/_monitoring-plugins/alerting/api.md b/_monitoring-plugins/alerting/api.md index e24a6236..5a6f87dc 100644 --- a/_monitoring-plugins/alerting/api.md +++ b/_monitoring-plugins/alerting/api.md @@ -20,6 +20,8 @@ Use the alerting API to programmatically manage monitors and alerts. --- ## Create monitor +Introduced 1.0 +{: .label .label-purple } #### Request @@ -246,6 +248,8 @@ For a full list of timezone names, refer to [Wikipedia](https://en.wikipedia.org --- ## Update monitor +Introduced 1.0 +{: .label .label-purple } When you update a monitor, include the current version number as a parameter. OpenSearch increments the version number automatically (see the sample response). @@ -368,6 +372,8 @@ PUT _plugins/_alerting/monitors/ --- ## Get monitor +Introduced 1.0 +{: .label .label-purple } #### Request @@ -438,6 +444,8 @@ GET _plugins/_alerting/monitors/ --- ## Monitor stats +Introduced 1.0 +{: .label .label-purple } Returns statistics about the alerting feature. Use `_plugins/_alerting/stats` to find node IDs and metrics. Then you can drill down using those values. @@ -627,6 +635,8 @@ GET _plugins/_alerting//stats/ --- ## Delete monitor +Introduced 1.0 +{: .label .label-purple } #### Request @@ -658,6 +668,8 @@ DELETE _plugins/_alerting/monitors/ --- ## Search monitors +Introduced 1.0 +{: .label .label-purple } #### Request @@ -755,6 +767,8 @@ GET _plugins/_alerting/monitors/_search --- ## Run monitor +Introduced 1.0 +{: .label .label-purple } You can add the optional `?dryrun=true` parameter to the URL to show the results of a run without actions sending any message. @@ -787,6 +801,8 @@ POST _plugins/_alerting/monitors//_execute --- ## Get alerts +Introduced 1.0 +{: .label .label-purple } Returns an array of all alerts. @@ -855,6 +871,8 @@ GET _plugins/_alerting/monitors/alerts --- ## Acknowledge alert +Introduced 1.0 +{: .label .label-purple } [After getting your alerts](#get-alerts/), you can acknowledge any number of active alerts in one call. If the alert is already in an ERROR, COMPLETED, or ACKNOWLEDGED state, it appears in the `failed` array. @@ -882,6 +900,8 @@ POST _plugins/_alerting/monitors//_acknowledge/alerts --- ## Create destination +Introduced 1.0 +{: .label .label-purple } #### Requests @@ -956,6 +976,8 @@ POST _plugins/_alerting/destinations --- ## Update destination +Introduced 1.0 +{: .label .label-purple } #### Request @@ -991,6 +1013,8 @@ PUT _plugins/_alerting/destinations/ --- ## Get destination +Introduced 1.0 +{: .label .label-purple } Retrieve one destination. @@ -1036,6 +1060,8 @@ GET _plugins/_alerting/destinations/ --- ## Get destinations +Introduced 1.0 +{: .label .label-purple } Retrieve all destinations. @@ -1081,6 +1107,8 @@ GET _plugins/_alerting/destinations --- ## Delete destination +Introduced 1.0 +{: .label .label-purple } #### Request @@ -1110,6 +1138,8 @@ DELETE _plugins/_alerting/destinations/ --- ## Create email account +Introduced 1.0 +{: .label .label-purple } #### Request ```json @@ -1142,6 +1172,8 @@ POST _plugins/_alerting/destinations/email_accounts ``` ## Update email account +Introduced 1.0 +{: .label .label-purple } #### Request ```json @@ -1173,6 +1205,8 @@ PUT _plugins/_alerting/destinations/email_accounts/ ``` ## Get email account +Introduced 1.0 +{: .label .label-purple } #### Request ```json @@ -1204,6 +1238,8 @@ GET _plugins/_alerting/destinations/email_accounts/ ``` ## Delete email account +Introduced 1.0 +{: .label .label-purple } #### Request ``` @@ -1230,6 +1266,8 @@ DELETE _plugins/_alerting/destinations/email_accounts/ ``` ## Search email account +Introduced 1.0 +{: .label .label-purple } #### Request @@ -1296,6 +1334,8 @@ POST _plugins/_alerting/destinations/email_accounts/_search --- ## Create email group +Introduced 1.0 +{: .label .label-purple } #### Request @@ -1330,6 +1370,8 @@ POST _plugins/_alerting/destinations/email_groups ``` ## Update email group +Introduced 1.0 +{: .label .label-purple } #### Request @@ -1363,6 +1405,8 @@ PUT _plugins/_alerting/destinations/email_groups/ ``` ## Get email group +Introduced 1.0 +{: .label .label-purple } #### Request ```json @@ -1395,6 +1439,8 @@ GET _plugins/_alerting/destinations/email_groups/ ``` ## Delete email group +Introduced 1.0 +{: .label .label-purple } #### Request ``` @@ -1421,6 +1467,8 @@ DELETE _plugins/_alerting/destinations/email_groups/ ``` ## Search email group +Introduced 1.0 +{: .label .label-purple } #### Request diff --git a/_monitoring-plugins/pa/api.md b/_monitoring-plugins/pa/api.md index 291105f1..f1517d45 100644 --- a/_monitoring-plugins/pa/api.md +++ b/_monitoring-plugins/pa/api.md @@ -6,6 +6,8 @@ nav_order: 1 --- # Performance Analyzer API +Introduced 1.0 +{: .label .label-purple } Performance Analyzer uses a single HTTP method and URI for most requests: diff --git a/_opensearch/rest-api/alias.md b/_opensearch/rest-api/alias.md index f703d63f..3376c6a0 100644 --- a/_opensearch/rest-api/alias.md +++ b/_opensearch/rest-api/alias.md @@ -7,6 +7,8 @@ nav_order: 8 --- # Alias +Introduced 1.0 +{: .label .label-purple } An alias is a virtual pointer that you can use to reference one or more indices. Creating and updating aliases are atomic operations, so you can reindex your data and point an alias at it without any downtime. diff --git a/_opensearch/rest-api/cat/cat-aliases.md b/_opensearch/rest-api/cat/cat-aliases.md index 833ad9a6..500a0ce0 100644 --- a/_opensearch/rest-api/cat/cat-aliases.md +++ b/_opensearch/rest-api/cat/cat-aliases.md @@ -8,6 +8,8 @@ has_children: false --- # cat aliases +Introduced 1.0 +{: .label .label-purple } The cat aliases operation lists the mapping of aliases to indices, plus routing and filtering information. diff --git a/_opensearch/rest-api/cat/cat-allocation.md b/_opensearch/rest-api/cat/cat-allocation.md index c7b14edc..6c5c0aa7 100644 --- a/_opensearch/rest-api/cat/cat-allocation.md +++ b/_opensearch/rest-api/cat/cat-allocation.md @@ -8,6 +8,8 @@ has_children: false --- # cat allocation +Introduced 1.0 +{: .label .label-purple } The cat allocation operation lists the allocation of disk space for indices and the number of shards on each node. diff --git a/_opensearch/rest-api/cat/cat-count.md b/_opensearch/rest-api/cat/cat-count.md index 44cc9d1b..69ddf279 100644 --- a/_opensearch/rest-api/cat/cat-count.md +++ b/_opensearch/rest-api/cat/cat-count.md @@ -8,6 +8,8 @@ has_children: false --- # cat count +Introduced 1.0 +{: .label .label-purple } The cat count operation lists the number of documents in your cluster. diff --git a/_opensearch/rest-api/cat/cat-field-data.md b/_opensearch/rest-api/cat/cat-field-data.md index 54c5a5bf..d86d17a1 100644 --- a/_opensearch/rest-api/cat/cat-field-data.md +++ b/_opensearch/rest-api/cat/cat-field-data.md @@ -8,6 +8,8 @@ has_children: false --- # cat fielddata +Introduced 1.0 +{: .label .label-purple } The cat fielddata operation lists the memory size used by each field per node. diff --git a/_opensearch/rest-api/cat/cat-health.md b/_opensearch/rest-api/cat/cat-health.md index 9e16abe7..476681f8 100644 --- a/_opensearch/rest-api/cat/cat-health.md +++ b/_opensearch/rest-api/cat/cat-health.md @@ -8,6 +8,8 @@ has_children: false --- # cat health +Introduced 1.0 +{: .label .label-purple } The cat health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster. diff --git a/_opensearch/rest-api/cat/cat-indices.md b/_opensearch/rest-api/cat/cat-indices.md index 64affeee..0bd4a2e9 100644 --- a/_opensearch/rest-api/cat/cat-indices.md +++ b/_opensearch/rest-api/cat/cat-indices.md @@ -8,6 +8,8 @@ has_children: false --- # cat indices +Introduced 1.0 +{: .label .label-purple } The cat indices operation lists information related to indices⁠—how much disk space they are using, how many shards they have, their health status, and so on. diff --git a/_opensearch/rest-api/cat/cat-master.md b/_opensearch/rest-api/cat/cat-master.md index 266340d4..73ca13d1 100644 --- a/_opensearch/rest-api/cat/cat-master.md +++ b/_opensearch/rest-api/cat/cat-master.md @@ -8,6 +8,8 @@ has_children: false --- # cat master +Introduced 1.0 +{: .label .label-purple } The cat master operation lists information that helps identify the elected master node. diff --git a/_opensearch/rest-api/cat/cat-nodeattrs.md b/_opensearch/rest-api/cat/cat-nodeattrs.md index 0ed56e53..c06ac527 100644 --- a/_opensearch/rest-api/cat/cat-nodeattrs.md +++ b/_opensearch/rest-api/cat/cat-nodeattrs.md @@ -8,6 +8,8 @@ has_children: false --- # cat nodeattrs +Introduced 1.0 +{: .label .label-purple } The cat nodeattrs operation lists the attributes of custom nodes. diff --git a/_opensearch/rest-api/cat/cat-nodes.md b/_opensearch/rest-api/cat/cat-nodes.md index 8f3cdc84..d2587bc6 100644 --- a/_opensearch/rest-api/cat/cat-nodes.md +++ b/_opensearch/rest-api/cat/cat-nodes.md @@ -8,6 +8,8 @@ has_children: false --- # cat nodes +Introduced 1.0 +{: .label .label-purple } The cat nodes operation lists node-level information, including node roles and load metrics. diff --git a/_opensearch/rest-api/cat/cat-pending-tasks.md b/_opensearch/rest-api/cat/cat-pending-tasks.md index eb6f6a35..37cf82ac 100644 --- a/_opensearch/rest-api/cat/cat-pending-tasks.md +++ b/_opensearch/rest-api/cat/cat-pending-tasks.md @@ -8,6 +8,8 @@ has_children: false --- # cat pending tasks +Introduced 1.0 +{: .label .label-purple } The cat pending tasks operation lists the progress of all pending tasks, including task priority and time in queue. diff --git a/_opensearch/rest-api/cat/cat-plugins.md b/_opensearch/rest-api/cat/cat-plugins.md index 6f7f7c3e..c4982914 100644 --- a/_opensearch/rest-api/cat/cat-plugins.md +++ b/_opensearch/rest-api/cat/cat-plugins.md @@ -8,6 +8,8 @@ has_children: false --- # cat plugins +Introduced 1.0 +{: .label .label-purple } The cat plugins operation lists the names, components, and versions of the installed plugins. diff --git a/_opensearch/rest-api/cat/cat-recovery.md b/_opensearch/rest-api/cat/cat-recovery.md index b5aec967..548456c0 100644 --- a/_opensearch/rest-api/cat/cat-recovery.md +++ b/_opensearch/rest-api/cat/cat-recovery.md @@ -8,6 +8,8 @@ has_children: false --- # cat recovery +Introduced 1.0 +{: .label .label-purple } The cat recovery operation lists all completed and ongoing index and shard recoveries. diff --git a/_opensearch/rest-api/cat/cat-repositories.md b/_opensearch/rest-api/cat/cat-repositories.md index 2b6129bd..e505f11a 100644 --- a/_opensearch/rest-api/cat/cat-repositories.md +++ b/_opensearch/rest-api/cat/cat-repositories.md @@ -8,6 +8,8 @@ has_children: false --- # cat repositories +Introduced 1.0 +{: .label .label-purple } The cat repositories operation lists all completed and ongoing index and shard recoveries. diff --git a/_opensearch/rest-api/cat/cat-segments.md b/_opensearch/rest-api/cat/cat-segments.md index de4f0c7c..a5fce2e5 100644 --- a/_opensearch/rest-api/cat/cat-segments.md +++ b/_opensearch/rest-api/cat/cat-segments.md @@ -8,6 +8,8 @@ has_children: false --- # cat segments +Introduced 1.0 +{: .label .label-purple } The cat segments operation lists Lucene segment-level information for each index. diff --git a/_opensearch/rest-api/cat/cat-shards.md b/_opensearch/rest-api/cat/cat-shards.md index b040ab6a..00d4b554 100644 --- a/_opensearch/rest-api/cat/cat-shards.md +++ b/_opensearch/rest-api/cat/cat-shards.md @@ -8,6 +8,8 @@ has_children: false --- # cat shards +Introduced 1.0 +{: .label .label-purple } The cat shards operation lists the state of all primary and replica shards and how they are distributed. diff --git a/_opensearch/rest-api/cat/cat-snapshots.md b/_opensearch/rest-api/cat/cat-snapshots.md index aafe9caa..71aa30cf 100644 --- a/_opensearch/rest-api/cat/cat-snapshots.md +++ b/_opensearch/rest-api/cat/cat-snapshots.md @@ -8,6 +8,8 @@ has_children: false --- # cat snapshots +Introduced 1.0 +{: .label .label-purple } The cat snapshots operation lists all snapshots for a repository. diff --git a/_opensearch/rest-api/cat/cat-tasks.md b/_opensearch/rest-api/cat/cat-tasks.md index 7dbccb73..2d30836b 100644 --- a/_opensearch/rest-api/cat/cat-tasks.md +++ b/_opensearch/rest-api/cat/cat-tasks.md @@ -8,6 +8,8 @@ has_children: false --- # cat tasks +Introduced 1.0 +{: .label .label-purple } The cat tasks operation lists the progress of all tasks currently running on your cluster. diff --git a/_opensearch/rest-api/cat/cat-templates.md b/_opensearch/rest-api/cat/cat-templates.md index ff4035fb..637c158a 100644 --- a/_opensearch/rest-api/cat/cat-templates.md +++ b/_opensearch/rest-api/cat/cat-templates.md @@ -8,6 +8,8 @@ has_children: false --- # cat templates +Introduced 1.0 +{: .label .label-purple } The cat templates operation lists the names, patterns, order numbers, and version numbers of index templates. diff --git a/_opensearch/rest-api/cat/cat-thread-pool.md b/_opensearch/rest-api/cat/cat-thread-pool.md index 0f55d715..e15b8e27 100644 --- a/_opensearch/rest-api/cat/cat-thread-pool.md +++ b/_opensearch/rest-api/cat/cat-thread-pool.md @@ -8,6 +8,8 @@ has_children: false --- # cat thread pool +Introduced 1.0 +{: .label .label-purple } The cat thread pool operation lists the active, queued, and rejected threads of different thread pools on each node. @@ -47,5 +49,5 @@ master_timeout | Time | The amount of time to wait for a connection to the maste node_name name active queue rejected odfe-node2 ad-batch-task-threadpool 0 0 0 odfe-node2 ad-threadpool 0 0 0 -odfe-node2 analyze 0 0 0s +odfe-node2 analyze 0 0 0s ``` diff --git a/_opensearch/rest-api/cluster-allocation.md b/_opensearch/rest-api/cluster-allocation.md index de384c6b..07caee47 100644 --- a/_opensearch/rest-api/cluster-allocation.md +++ b/_opensearch/rest-api/cluster-allocation.md @@ -6,6 +6,8 @@ nav_order: 10 --- # Cluster allocation explain +Introduced 1.0 +{: .label .label-purple } The most basic cluster allocation explain request finds an unassigned shard and explains why it can't be allocated to a node. diff --git a/_opensearch/rest-api/cluster-health.md b/_opensearch/rest-api/cluster-health.md index 4d83ff5f..339c4398 100644 --- a/_opensearch/rest-api/cluster-health.md +++ b/_opensearch/rest-api/cluster-health.md @@ -6,6 +6,8 @@ nav_order: 15 --- # Cluster health +Introduced 1.0 +{: .label .label-purple } The most basic cluster health request returns a simple status of the health of your cluster. OpenSearch expresses cluster health in three colors: green, yellow, and red. A green status means all primary shards and their replicas are allocated to nodes. A yellow status means all primary shards are allocated to nodes, but some replicas aren't. A red status means at least one primary shard is not allocated to any node. diff --git a/_opensearch/rest-api/cluster-settings.md b/_opensearch/rest-api/cluster-settings.md index d477060b..cc0f3a99 100644 --- a/_opensearch/rest-api/cluster-settings.md +++ b/_opensearch/rest-api/cluster-settings.md @@ -6,6 +6,8 @@ nav_order: 20 --- # Cluster settings +Introduced 1.0 +{: .label .label-purple } The cluster settings operation lets you check the current settings for your cluster, review default settings, and change settings. When you update a setting using the API, OpenSearch applies it to all nodes in the cluster. diff --git a/_opensearch/rest-api/create-index.md b/_opensearch/rest-api/create-index.md index 348cb839..8f4775a3 100644 --- a/_opensearch/rest-api/create-index.md +++ b/_opensearch/rest-api/create-index.md @@ -7,6 +7,8 @@ nav_order: 7 --- # 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. diff --git a/_opensearch/rest-api/document-apis/bulk.md b/_opensearch/rest-api/document-apis/bulk.md index 7ae76357..4139471e 100644 --- a/_opensearch/rest-api/document-apis/bulk.md +++ b/_opensearch/rest-api/document-apis/bulk.md @@ -7,6 +7,8 @@ nav_order: 20 --- # Bulk +Introduced 1.0 +{: .label .label-purple } The bulk operation lets you add, update, or delete many documents in a single request. Compared to individual OpenSearch indexing requests, the bulk operation has significant performance benefits. Whenever practical, we recommend batching indexing operations into bulk requests. diff --git a/_opensearch/rest-api/document-apis/delete-document.md b/_opensearch/rest-api/document-apis/delete-document.md index 7f167ac4..ed8148bc 100644 --- a/_opensearch/rest-api/document-apis/delete-document.md +++ b/_opensearch/rest-api/document-apis/delete-document.md @@ -5,7 +5,9 @@ parent: Document APIs nav_order: 10 --- -# Get document +# Delete document +Introduced 1.0 +{: .label .label-purple } If you no longer need a document in your index, you can use the delete document API operation to delete it. diff --git a/_opensearch/rest-api/document-apis/get-documents.md b/_opensearch/rest-api/document-apis/get-documents.md index a7231b39..a9d223e0 100644 --- a/_opensearch/rest-api/document-apis/get-documents.md +++ b/_opensearch/rest-api/document-apis/get-documents.md @@ -6,6 +6,8 @@ nav_order: 5 --- # Get document +Introduced 1.0 +{: .label .label-purple } After adding a JSON document to your index, you can use the get document API operation to retrieve the document's information and data. diff --git a/_opensearch/rest-api/scroll.md b/_opensearch/rest-api/scroll.md index 4d782bab..beffb655 100644 --- a/_opensearch/rest-api/scroll.md +++ b/_opensearch/rest-api/scroll.md @@ -6,6 +6,8 @@ nav_order: 120 --- # Scroll +Introduced 1.0 +{: .label .label-purple } You can use the `scroll` operation to retrieve a large number of results. For example, for machine learning jobs, you can request an unlimited number of results in batches. diff --git a/_opensearch/rest-api/tasks.md b/_opensearch/rest-api/tasks.md index 5e4236ad..0e4afe4a 100644 --- a/_opensearch/rest-api/tasks.md +++ b/_opensearch/rest-api/tasks.md @@ -8,6 +8,8 @@ redirect_from: --- # Tasks +Introduced 1.0 +{: .label .label-purple } A task is any operation you run in a cluster. For example, searching your data collection of books for a title or author name is a task. When you run OpenSearch, a task is automatically created to monitor your cluster's health and performance. For more information about all of the tasks currently executing in your cluster, you can use the `tasks` API operation. diff --git a/_sass/custom/custom.scss b/_sass/custom/custom.scss index c1035b19..05423e37 100755 --- a/_sass/custom/custom.scss +++ b/_sass/custom/custom.scss @@ -205,19 +205,13 @@ td { } // Keeps labels high and tight next to headers -h1 + p.label { - margin: -23px 0 0 0; -} -h2 + p.label { - margin: -15px 0 0 0; -} -h3 + p.label { - margin: -10px 0 0 0; -} -h4 + p.label, -h5 + p.label, -h6 + p.label { - margin: -7px 0 0 0; +h1 + p.label, h1 + p.label + p.label, +h2 + p.label, h2 + p.label + p.label, +h3 + p.label, h3 + p.label + p.label, +h4 + p.label, h4 + p.label + p.label, +h5 + p.label, h5 + p.label + p.label, +h6 + p.label, h6 + p.label + p.label { + margin: -20px 0 0 0; } // Modifies margins in xl layout to support TOC @@ -1098,4 +1092,4 @@ main { background: none; } } -} \ No newline at end of file +} diff --git a/_search-plugins/async/index.md b/_search-plugins/async/index.md index 3d79b539..873acdc0 100644 --- a/_search-plugins/async/index.md +++ b/_search-plugins/async/index.md @@ -15,6 +15,8 @@ Searching large volumes of data can take a long time, especially if you're searc Asynchronous search in OpenSearch lets you send search requests that run in the background. You can monitor the progress of these searches and get back partial results as they become available. After the search finishes, you can save the results to examine at a later time. ## REST API +Introduced 1.0 +{: .label .label-purple } To perform an asynchronous search, send requests to `_plugins/_asynchronous_search`, with your query in the request body: @@ -112,6 +114,8 @@ Options | Description `aggregations` | The partial aggregation results that have been completed by the shards so far. ## Get partial results +Introduced 1.0 +{: .label .label-purple } After you submit an asynchronous search request, you can request partial responses with the ID that you see in the asynchronous search response. @@ -188,6 +192,8 @@ You can poll the ID with the `wait_for_completion_timeout` parameter to wait for For asynchronous searches with `keep_on_completion` as `true` and a sufficiently long `keep_alive` time, you can keep polling the IDs until the search finishes. If you don’t want to periodically poll each ID, you can retain the results in your cluster with the `keep_alive` parameter and come back to it at a later time. ## Delete searches and results +Introduced 1.0 +{: .label .label-purple } You can use the DELETE API operation to delete any ongoing asynchronous search by its ID. If the search is still running, it’s canceled. If the search is complete, the saved search results are deleted. @@ -204,6 +210,8 @@ DELETE _plugins/_asynchronous_search/?pretty ``` ## Monitor stats +Introduced 1.0 +{: .label .label-purple } You can use the stats API operation to monitor asynchronous searches that are running, completed, and/or persisted. diff --git a/_search-plugins/knn/api.md b/_search-plugins/knn/api.md index 1c3ffec2..72f633e4 100644 --- a/_search-plugins/knn/api.md +++ b/_search-plugins/knn/api.md @@ -13,6 +13,8 @@ The k-NN plugin adds two API operations to help you better manage the plugin's f ## Stats +Introduced 1.0 +{: .label .label-purple } The k-NN `stats` API provides information about the current status of the k-NN plugin. The plugin keeps track of both cluster-level and node-level statistics. Cluster-level statistics have a single value for the entire cluster. Node-level statistics have a single value for each node in the cluster. You can filter the query by `nodeId` and `statName`: ``` @@ -107,6 +109,8 @@ GET /_plugins/_knn/HYMrXXsBSamUkcAjhjeN0w/stats/circuit_breaker_triggered,graph_ ## Warmup operation +Introduced 1.0 +{: .label .label-purple } The Hierarchical Navigable Small World (HNSW) graphs used to perform an approximate k-Nearest Neighbor (k-NN) search are stored as `.hnsw` files with other Apache Lucene segment files. In order for you to perform a search on these graphs using the k-NN plugin, the plugin needs to load these files into native memory. diff --git a/_search-plugins/ppl/endpoint.md b/_search-plugins/ppl/endpoint.md index be29bbd6..b4c98ed9 100644 --- a/_search-plugins/ppl/endpoint.md +++ b/_search-plugins/ppl/endpoint.md @@ -7,6 +7,8 @@ redirect_from: /docs/ppl/endpoint/ --- # Endpoint +Introduced 1.0 +{: .label .label-purple } To send a query request to PPL plugin, use the HTTP POST request. We recommend a POST request because it doesn't have any length limit and it allows you to pass other parameters to the plugin for other functionality. diff --git a/_search-plugins/sql/endpoints.md b/_search-plugins/sql/endpoints.md index 0f0b22ee..3369d4fe 100644 --- a/_search-plugins/sql/endpoints.md +++ b/_search-plugins/sql/endpoints.md @@ -8,6 +8,8 @@ redirect_from: /docs/sql/endpoints/ # Endpoint +Introduced 1.0 +{: .label .label-purple } To send query request to SQL plugin, you can either use a request parameter in HTTP GET or request body by HTTP POST request. POST request @@ -183,7 +185,7 @@ The `datarows` can have more than the `fetch_size` number of records in case the ```json { - "cursor": "d:eyJhIjp7fSwicyI6IkRYRjFaWEo1UVc1a1JtVjBZMmdCQUFBQUFBQUFBQU1XZWpkdFRFRkZUMlpTZEZkeFdsWnJkRlZoYnpaeVVRPT0iLCJjIjpbeyJuYW1lIjoiZmlyc3RuYW1lIiwidHlwZSI6InRleHQifSx7Im5hbWUiOiJsYXN0bmFtZSIsInR5cGUiOiJ0ZXh0In1dLCJmIjo1LCJpIjoiYWNjb3VudHMabcde12345", + "cursor": "d:eyJhIjp7fSwicyI6IkRYRjFaWEo1UVc1a1JtVjBZMmdCQUFBQUFBQUFBQU1XZWpkdFRFRkZUMlpTZEZkeFdsWnJkRlZoYnpaeVVRPT0iLCJjIjpbeyJuYW1lIjoiZmlyc3RuYW1lIiwidHlwZSI6InRleHQifSx7Im5hbWUiOiJsYXN0bmFtZSIsInR5cGUiOiJ0ZXh0In1dLCJmIjo1LCJpIjoiYWNjb3VudHMabcde12345", "datarows": [ [ "Abbey", diff --git a/_security-plugin/access-control/api.md b/_security-plugin/access-control/api.md index fbfe2be7..61c1be0b 100644 --- a/_security-plugin/access-control/api.md +++ b/_security-plugin/access-control/api.md @@ -95,6 +95,8 @@ To add or remove these flags, you need to modify `plugins/opensearch-security/se ## Account ### Get account details +Introduced 1.0 +{: .label .label-purple } Returns account details for the current user. For example, if you sign the request as the `admin` user, the response includes details for that user. @@ -132,6 +134,8 @@ GET _plugins/_security/api/account ### Change password +Introduced 1.0 +{: .label .label-purple } Changes the password for the current user. @@ -162,6 +166,8 @@ PUT _plugins/_security/api/account ## Action groups ### Get action group +Introduced 1.0 +{: .label .label-purple } Retrieves one action group. @@ -192,6 +198,8 @@ GET _plugins/_security/api/actiongroups/ ### Get action groups +Introduced 1.0 +{: .label .label-purple } Retrieves all action groups. @@ -224,6 +232,8 @@ GET _plugins/_security/api/actiongroups/ ### Delete action group +Introduced 1.0 +{: .label .label-purple } #### Request @@ -242,6 +252,8 @@ DELETE _plugins/_security/api/actiongroups/ ### Create action group +Introduced 1.0 +{: .label .label-purple } Creates or replaces the specified action group. @@ -272,6 +284,8 @@ PUT _plugins/_security/api/actiongroups/ ### Patch action group +Introduced 1.0 +{: .label .label-purple } Updates individual attributes of an action group. @@ -297,6 +311,8 @@ PATCH _plugins/_security/api/actiongroups/ ### Patch action groups +Introduced 1.0 +{: .label .label-purple } Creates, updates, or deletes multiple action groups in a single call. @@ -332,6 +348,8 @@ These calls let you create, update, and delete internal users. If you use an ext ### Get user +Introduced 1.0 +{: .label .label-purple } #### Request @@ -357,6 +375,8 @@ GET _plugins/_security/api/internalusers/ ### Get users +Introduced 1.0 +{: .label .label-purple } #### Request @@ -381,6 +401,8 @@ GET _plugins/_security/api/internalusers/ ### Delete user +Introduced 1.0 +{: .label .label-purple } #### Request @@ -399,6 +421,8 @@ DELETE _plugins/_security/api/internalusers/ ### Create user +Introduced 1.0 +{: .label .label-purple } Creates or replaces the specified user. You must specify either `password` (plain text) or `hash` (the hashed user password). If you specify `password`, the security plugin automatically hashes the password before storing it. @@ -430,6 +454,8 @@ PUT _plugins/_security/api/internalusers/ ### Patch user +Introduced 1.0 +{: .label .label-purple } Updates individual attributes of an internal user. @@ -460,6 +486,8 @@ PATCH _plugins/_security/api/internalusers/ ``` ### Patch users +Introduced 1.0 +{: .label .label-purple } Creates, updates, or deletes multiple internal users in a single call. @@ -496,6 +524,8 @@ PATCH _plugins/_security/api/internalusers ### Get role +Introduced 1.0 +{: .label .label-purple } Retrieves one role. @@ -542,6 +572,8 @@ GET _plugins/_security/api/roles/ ### Get roles +Introduced 1.0 +{: .label .label-purple } Retrieves all roles. @@ -582,6 +614,8 @@ GET _plugins/_security/api/roles/ ### Delete role +Introduced 1.0 +{: .label .label-purple } #### Request @@ -600,6 +634,8 @@ DELETE _plugins/_security/api/roles/ ### Create role +Introduced 1.0 +{: .label .label-purple } Creates or replaces the specified role. @@ -645,6 +681,8 @@ PUT _plugins/_security/api/roles/ ### Patch role +Introduced 1.0 +{: .label .label-purple } Updates individual attributes of a role. @@ -673,6 +711,8 @@ PATCH _plugins/_security/api/roles/ ### Patch roles +Introduced 1.0 +{: .label .label-purple } Creates, updates, or deletes multiple roles in a single call. @@ -708,6 +748,8 @@ PATCH _plugins/_security/api/roles ## Role mappings ### Get role mapping +Introduced 1.0 +{: .label .label-purple } Retrieves one role mapping. @@ -731,6 +773,8 @@ GET _plugins/_security/api/rolesmapping/ ### Get role mappings +Introduced 1.0 +{: .label .label-purple } Retrieves all role mappings. @@ -754,6 +798,8 @@ GET _plugins/_security/api/rolesmapping ### Delete role mapping +Introduced 1.0 +{: .label .label-purple } Deletes the specified role mapping. @@ -774,6 +820,8 @@ DELETE _plugins/_security/api/rolesmapping/ ### Create role mapping +Introduced 1.0 +{: .label .label-purple } Creates or replaces the specified role mapping. @@ -799,6 +847,8 @@ PUT _plugins/_security/api/rolesmapping/ ### Patch role mapping +Introduced 1.0 +{: .label .label-purple } Updates individual attributes of a role mapping. @@ -827,6 +877,8 @@ PATCH _plugins/_security/api/rolesmapping/ ### Patch role mappings +Introduced 1.0 +{: .label .label-purple } Creates or updates multiple role mappings in a single call. @@ -859,6 +911,8 @@ PATCH _plugins/_security/api/rolesmapping ## Tenants ### Get tenant +Introduced 1.0 +{: .label .label-purple } Retrieves one tenant. @@ -883,6 +937,8 @@ GET _plugins/_security/api/tenants/ ### Get tenants +Introduced 1.0 +{: .label .label-purple } Retrieves all tenants. @@ -913,6 +969,8 @@ GET _plugins/_security/api/tenants/ ### Delete tenant +Introduced 1.0 +{: .label .label-purple } Deletes the specified tenant. @@ -933,6 +991,8 @@ DELETE _plugins/_security/api/tenants/ ### Create tenant +Introduced 1.0 +{: .label .label-purple } Creates or replaces the specified tenant. @@ -956,6 +1016,8 @@ PUT _plugins/_security/api/tenants/ ### Patch tenant +Introduced 1.0 +{: .label .label-purple } Add, delete, or modify a single tenant. @@ -981,6 +1043,8 @@ PATCH _plugins/_security/api/tenants/ ### Patch tenants +Introduced 1.0 +{: .label .label-purple } Add, delete, or modify multiple tenants in a single call. @@ -1018,6 +1082,8 @@ PATCH _plugins/_security/api/tenants/ ## Configuration ### Get configuration +Introduced 1.0 +{: .label .label-purple } Retrieves the current security plugin configuration in JSON format. @@ -1029,6 +1095,8 @@ GET _plugins/_security/api/securityconfig ### Update configuration +Introduced 1.0 +{: .label .label-purple } Creates or updates the existing configuration using the REST API. This operation can easily break your existing configuration, so we recommend using `securityadmin.sh` instead, which is far safer. See [Access control for the API](#access-control-for-the-api) for how to enable this operation. @@ -1087,6 +1155,8 @@ PUT _plugins/_security/api/securityconfig/config ### Patch configuration +Introduced 1.0 +{: .label .label-purple } Updates the existing configuration using the REST API. This operation can easily break your existing configuration, so we recommend using `securityadmin.sh` instead, which is far safer. See [Access control for the API](#access-control-for-the-api) for how to enable this operation. @@ -1116,6 +1186,8 @@ PATCH _plugins/_security/api/securityconfig ## Certificates ### Get certificates +Introduced 1.0 +{: .label .label-purple } Retrieves the current security plugin configuration in JSON format. @@ -1127,6 +1199,8 @@ GET _plugins/_security/api/securityconfig ### Update configuration +Introduced 1.0 +{: .label .label-purple } Creates or updates the existing configuration using the REST API rather than `securityadmin.sh`. This operation can easily break your existing configuration, so we recommend using `securityadmin.sh` instead. See [Access control for the API](#access-control-for-the-api) for how to enable this operation. @@ -1185,6 +1259,8 @@ PUT _plugins/_security/api/securityconfig/config ### Patch configuration +Introduced 1.0 +{: .label .label-purple } Updates the existing configuration using the REST API rather than `securityadmin.sh`. This operation can easily break your existing configuration, so we recommend using `securityadmin.sh` instead. See [Access control for the API](#access-control-for-the-api) for how to enable this operation. @@ -1213,6 +1289,8 @@ PATCH _plugins/_security/api/securityconfig ## Cache ### Flush cache +Introduced 1.0 +{: .label .label-purple } Flushes the security plugin user, authentication, and authorization cache. @@ -1239,6 +1317,8 @@ DELETE _plugins/_security/api/cache ## Health ### Health check +Introduced 1.0 +{: .label .label-purple } Checks to see if the security plugin is up and running. If you operate your cluster behind a load balancer, this operation is useful for determining node health and doesn't require a signed request.