[DOCS] Adds descriptions to index APIs (G-Z) (#2230)

Co-authored-by: Abdon Pijpelink <[email protected]>

specification/_doc_ids/table.csv

@@ -1,8 +1,10 @@
+api-date-math-index-names,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-date-math-index-names
 async-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html
 autoscaling-delete-autoscaling-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-delete-autoscaling-policy.html
 autoscaling-get-autoscaling-capacity,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html
 autoscaling-get-autoscaling-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-policy.html
 autoscaling-put-autoscaling-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-put-autoscaling-policy.html
+avoid-index-pattern-collisions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html#avoid-index-pattern-collisions
 docs-bulk,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-bulk.html
 cat-alias,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-alias.html
 cat-allocation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-allocation.html

specification/indices/_types/IndexTemplate.ts

@@ -29,14 +29,43 @@ import {
 } from '@indices/_types/DataLifecycle'
 
 export class IndexTemplate {
+  /**
+   * Name of the index template.
+   */
   index_patterns: Names
+  /**
+   * An ordered list of component template names.
+   * Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.
+   */
   composed_of: Name[]
+  /**
+   * Template to be applied.
+   * It may optionally include an `aliases`, `mappings`, or `settings` configuration.
+   */
   template?: IndexTemplateSummary
+  /**
+   * Version number used to manage index templates externally.
+   * This number is not automatically generated by Elasticsearch.
+   */
   version?: VersionNumber
+  /**
+   * Priority to determine index template precedence when a new data stream or index is created.
+   * The index template with the highest priority is chosen.
+   * If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
+   * This number is not automatically generated by Elasticsearch.
+   */
   priority?: long
-  /** @doc_id mapping-meta-field */
+  /**
+   * Optional user metadata about the index template. May have any contents.
+   * This map is not automatically generated by Elasticsearch.
+   * @doc_id mapping-meta-field */
   _meta?: Metadata
   allow_auto_create?: boolean
+  /**
+   * If this object is included, the template is used to create data streams and their backing indices.
+   * Supports an empty object.
+   * Data streams require a matching index template with a `data_stream` object.
+   */
   data_stream?: IndexTemplateDataStreamConfiguration
 }
 
@@ -54,8 +83,21 @@ export class IndexTemplateDataStreamConfiguration {
 }
 
 export class IndexTemplateSummary {
+  /**
+   * Aliases to add.
+   * If the index template includes a `data_stream` object, these are data stream aliases.
+   * Otherwise, these are index aliases.
+   * Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options.
+   */
   aliases?: Dictionary<IndexName, Alias>
+  /**
+   * Mapping for fields in the index.
+   * If specified, this mapping can include field names, field data types, and mapping parameters.
+   */
   mappings?: TypeMapping
+  /**
+   * Configuration options for the index.
+   */
   settings?: IndexSettings
   /**
    * @availability stack since=8.8.0 stability=experimental

specification/indices/get_alias/IndicesGetAliasRequest.ts

@@ -21,19 +21,50 @@ import { RequestBase } from '@_types/Base'
 import { ExpandWildcards, Indices, Names } from '@_types/common'
 
 /**
+ * Retrieves information for one or more aliases.
  * @rest_spec_name indices.get_alias
  * @availability stack since=0.0.0 stability=stable
  * @availability serverless stability=stable visibility=public
  */
 export interface Request extends RequestBase {
   path_parts: {
+    /**
+     * Comma-separated list of aliases to retrieve.
+     * Supports wildcards (`*`).
+     * To retrieve all aliases, omit this parameter or use `*` or `_all`.
+     */
     name?: Names
+    /**
+     * Comma-separated list of data streams or indices used to limit the request.
+     * Supports wildcards (`*`).
+     * To target all data streams and indices, omit this parameter or use `*` or `_all`.
+     */
     index?: Indices
   }
   query_parameters: {
+    /**
+     * If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
+     * This behavior applies even if the request targets other open indices.
+     * @server_default true
+     */
     allow_no_indices?: boolean
+    /**
+     * Type of index that wildcard patterns can match.
+     * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+     * Supports comma-separated values, such as `open,hidden`.
+     * Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
+     * @server_default open
+     */
     expand_wildcards?: ExpandWildcards
+    /**
+     * If `false`, the request returns an error if it targets a missing or closed index.
+     * @server_default false
+     */
     ignore_unavailable?: boolean
+    /**
+     * If `true`, the request retrieves information from the local node only.
+     * @server_default false
+     */
     local?: boolean
   }
 }

specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts

@@ -28,10 +28,25 @@ import { ExpandWildcards, DataStreamNames } from '@_types/common'
  */
 export interface Request extends RequestBase {
   path_parts: {
+    /**
+     * Comma-separated list of data streams to limit the request.
+     * Supports wildcards (`*`).
+     * To target all data streams, omit this parameter or use `*` or `_all`.
+     */
     name: DataStreamNames
   }
   query_parameters: {
+    /**
+     * Type of data stream that wildcard patterns can match.
+     * Supports comma-separated values, such as `open,hidden`.
+     * Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
+     * @server_default open
+     */
     expand_wildcards?: ExpandWildcards
+    /**
+     * If `true`, return all default settings in the response.
+     * @server_default false
+     */
     include_defaults?: boolean
   }
 }

specification/indices/get_field_mapping/IndicesGetFieldMappingRequest.ts

@@ -21,19 +21,53 @@ import { RequestBase } from '@_types/Base'
 import { ExpandWildcards, Fields, Indices } from '@_types/common'
 
 /**
+ * Retrieves mapping definitions for one or more fields.
+ * For data streams, the API retrieves field mappings for the stream’s backing indices.
  * @rest_spec_name indices.get_field_mapping
  * @availability stack since=0.0.0 stability=stable
  */
 export interface Request extends RequestBase {
   path_parts: {
+    /**
+     * Comma-separated list or wildcard expression of fields used to limit returned information.
+     */
     fields: Fields
+    /**
+     * Comma-separated list of data streams, indices, and aliases used to limit the request.
+     * Supports wildcards (`*`).
+     * To target all data streams and indices, omit this parameter or use `*` or `_all`.
+     */
     index?: Indices
   }
   query_parameters: {
+    /**
+     * If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
+     * This behavior applies even if the request targets other open indices.
+     * @server_default true
+     */
     allow_no_indices?: boolean
+    /**
+     * Type of index that wildcard patterns can match.
+     * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+     * Supports comma-separated values, such as `open,hidden`.
+     * Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
+     * @server_default open
+     */
     expand_wildcards?: ExpandWildcards
+    /**
+     * If `false`, the request returns an error if it targets a missing or closed index.
+     * @server_default false
+     */
     ignore_unavailable?: boolean
+    /**
+     * If `true`, return all default settings in the response.
+     * @server_default false
+     */
     include_defaults?: boolean
+    /**
+     * If `true`, the request retrieves information from the local node only.
+     * @server_default false
+     */
     local?: boolean
   }
 }

specification/indices/get_mapping/IndicesGetMappingRequest.ts

@@ -22,19 +22,51 @@ import { ExpandWildcards, Indices } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
+ * Retrieves mapping definitions for one or more indices.
+ * For data streams, the API retrieves mappings for the stream’s backing indices.
  * @rest_spec_name indices.get_mapping
  * @availability stack since=0.0.0 stability=stable
  * @availability serverless stability=stable visibility=public
  */
 export interface Request extends RequestBase {
   path_parts: {
+    /**
+     * Comma-separated list of data streams, indices, and aliases used to limit the request.
+     * Supports wildcards (`*`).
+     * To target all data streams and indices, omit this parameter or use `*` or `_all`.
+     */
     index?: Indices
   }
   query_parameters: {
+    /**
+     * If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
+     * This behavior applies even if the request targets other open indices.
+     * @server_default true
+     */
     allow_no_indices?: boolean
+    /**
+     * Type of index that wildcard patterns can match.
+     * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+     * Supports comma-separated values, such as `open,hidden`.
+     * Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
+     * @server_default open
+     */
     expand_wildcards?: ExpandWildcards
+    /**
+     * If `false`, the request returns an error if it targets a missing or closed index.
+     * @server_default false
+     */
     ignore_unavailable?: boolean
+    /**
+     * If `true`, the request retrieves information from the local node only.
+     * @server_default false
+     */
     local?: boolean
+    /**
+     * Period to wait for a connection to the master node.
+     * If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
     master_timeout?: Duration
   }
 }

specification/indices/get_template/IndicesGetTemplateRequest.ts

@@ -22,17 +22,36 @@ import { Names } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
+ * Retrieves information about one or more index templates.
  * @rest_spec_name indices.get_template
  * @availability stack since=0.0.0 stability=stable
  * @availability serverless stability=stable visibility=public
  */
 export interface Request extends RequestBase {
   path_parts: {
+    /**
+     * Comma-separated list of index template names used to limit the request.
+     * Wildcard (`*`) expressions are supported.
+     * To return all index templates, omit this parameter or use a value of `_all` or `*`.
+     */
     name?: Names
   }
   query_parameters: {
+    /**
+     * If `true`, returns settings in flat format.
+     * @server_default false
+     */
     flat_settings?: boolean
+    /**
+     * If `true`, the request retrieves information from the local node only.
+     * @server_default false
+     */
     local?: boolean
+    /**
+     * Period to wait for a connection to the master node.
+     * If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
     master_timeout?: Duration
   }
 }

specification/indices/open/IndicesOpenRequest.ts

@@ -22,20 +22,61 @@ import { ExpandWildcards, Indices, WaitForActiveShards } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
+ * Opens a closed index.
+ * For data streams, the API opens any closed backing indices.
  * @rest_spec_name indices.open
  * @availability stack since=0.0.0 stability=stable
  * @availability serverless stability=stable visibility=private
  */
 export interface Request extends RequestBase {
   path_parts: {
+    /**
+     * Comma-separated list of data streams, indices, and aliases used to limit the request.
+     * Supports wildcards (`*`).
+     * By default, you must explicitly name the indices you using to limit the request.
+     * To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false.
+     * You can update this setting in the `elasticsearch.yml` file or using the cluster update settings API.
+     * @doc_id cluster-update-settings
+     */
     index: Indices
   }
   query_parameters: {
+    /**
+     * If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
+     * This behavior applies even if the request targets other open indices.
+     * @server_default true
+     */
     allow_no_indices?: boolean
+    /**
+     * Type of index that wildcard patterns can match.
+     * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
+     * Supports comma-separated values, such as `open,hidden`.
+     * Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
+     * @server_default open
+     */
     expand_wildcards?: ExpandWildcards
+    /**
+     * If `false`, the request returns an error if it targets a missing or closed index.
+     * @server_default false
+     */
     ignore_unavailable?: boolean
+    /**
+     * Period to wait for a connection to the master node.
+     * If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
     master_timeout?: Duration
+    /**
+     * Period to wait for a response.
+     * If no response is received before the timeout expires, the request fails and returns an error.
+     * @server_default 30s
+     */
     timeout?: Duration
+    /**
+     * The number of shard copies that must be active before proceeding with the operation.
+     * Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
+     * @server_default 1
+     */
     wait_for_active_shards?: WaitForActiveShards
   }
 }