Add more index API examples (#3430) (#3444)

(cherry picked from commit 0664ce5)

Author: lcawl

output/openapi/elasticsearch-openapi.json

@@ -119,6 +119,9 @@ connector-update-status,https://www.elastic.co/guide/en/elasticsearch/reference/
 convert-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/convert-processor.html
 cron-expressions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/api-conventions.html#api-cron-expressions
 csv-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/csv-processor.html
+dangling-index-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-index-delete.html
+dangling-index-import,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-index-import.html
+dangling-indices-list,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/dangling-indices-list.html
 data-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-processor.html
 data-stream-path-param,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html#indices-create-data-stream-api-path-params
 data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html
@@ -226,6 +229,7 @@ index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index.htm
 indexing-buffer,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indexing-buffer.html
 index-modules-merge,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-modules-merge.html
 index-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/index-templates.html
+index-templates-v1,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-templates-v1.html
 indices-aliases,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-aliases.html
 indices-analyze,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html
 indices-clearcache,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-clearcache.html
@@ -234,28 +238,39 @@ indices-close,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/i
 indices-component-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html
 indices-create-data-stream,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html
 indices-create-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-index.html
+indices-delete-alias,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-alias.html
 indices-delete-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-index.html
+indices-delete-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-template.html
+indices-delete-template-v1,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-template-v1.html
 indices-disk-usage,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-disk-usage.html
 indices-downsample-data-stream,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-downsample-data-stream.html
 indices-exists,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-exists.html
 indices-flush,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-flush.html
 indices-forcemerge,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-forcemerge.html
+indices-get-alias,
+https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-alias.html
 indices-get-field-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-field-mapping.html
 indices-get-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-index.html
 indices-get-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-mapping.html
 indices-get-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-settings.html
+indices-get-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-template.html
+indices-get-template-v1,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-template-v1.html
 indices-open-close,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-open-close.html
 indices-put-mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-put-mapping.html
 indices-recovery,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-recovery.html
 indices-refresh,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-refresh.html
 indices-reload-analyzers,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-reload-analyzers.html
+indices-resolve-cluster-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-resolve-cluster-api.html
 indices-resolve-index-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-resolve-index-api.html
 indices-rollover-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-rollover-index.html
 indices-segments,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-segments.html
 indices-shards-stores,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-shards-stores.html
 indices-shrink-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-shrink-index.html
+indices-simulate,https://www.elastic.co/guide/en/elasticsearch/reference/{master}/indices-simulate-index.html
+indices-simulate-template,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-simulate-template.html
 indices-split-index,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-split-index.html
 indices-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-stats.html
+indices-template-exists-v1,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-template-exists-v1.html
 indices-templates,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-templates.html
 indices-update-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-update-settings.html
 infer-trained-model-deployment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/infer-trained-model-deployment.html
@@ -281,6 +296,7 @@ logstash-logstash-settings-file,https://www.elastic.co/guide/en/logstash/{branch
 lowercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/lowercase-processor.html
 mapping-date-format,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-date-format.html
 mapping-meta-field,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html
+mapping-params,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-params.html
 mapping-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-fields.html
 mapping-roles,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html
 mapping-settings-limit,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-settings-limit.html

output/openapi/elasticsearch-serverless-openapi.json

@@ -33,7 +33,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
  * @rest_spec_name field_caps
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=public
- * @index_privileges view_index_metadata,read,manage
+ * @index_privileges view_index_metadata,read
  * @doc_tag search
  */
 export interface Request extends RequestBase {

output/schema/schema.json

@@ -23,7 +23,6 @@ import { Duration } from '@_types/Time'
 
 /**
  * Delete component templates.
- * Deletes component templates.
  * Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
  * @rest_spec_name cluster.delete_component_template
  * @availability stack since=7.8.0 stability=stable

specification/_doc_ids/table.csv

@@ -23,7 +23,7 @@ import { Duration } from '@_types/Time'
 
 /**
  * Get component templates.
- * Retrieves information about component templates.
+ * Get information about component templates.
  * @rest_spec_name cluster.get_component_template
  * @availability stack since=7.8.0 stability=stable
  * @availability serverless stability=stable visibility=public

specification/_global/field_caps/FieldCapabilitiesRequest.ts

@@ -24,7 +24,6 @@ import { Duration } from '@_types/Time'
 
 /**
  * Create or update a component template.
- * Creates or updates a component template.
  * Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
  *
  * An index template can be composed of multiple component templates.
@@ -39,6 +38,11 @@ import { Duration } from '@_types/Time'
  *
  * You can use C-style `/* *\/` block comments in component templates.
  * You can include comments anywhere in the request body except before the opening curly bracket.
+ *
+ * **Applying component templates**
+ *
+ * You cannot directly apply a component template to a data stream or index.
+ * To be applied, a component template must be included in an index template's `composed_of` list.
  * @rest_spec_name cluster.put_component_template
  * @availability stack since=7.8.0 stability=stable
  * @availability serverless stability=stable visibility=public
@@ -81,7 +85,7 @@ export interface Request extends RequestBase {
     version?: VersionNumber
     /**
      * Optional user metadata about the component template.
-     * May have any contents. This map is not automatically generated by Elasticsearch.
+     * It may have any contents. This map is not automatically generated by Elasticsearch.
      * This information is stored in the cluster state, so keeping it short is preferable.
      * To unset `_meta`, replace the template without specifying this information.
      */

specification/cluster/delete_component_template/ClusterDeleteComponentTemplateRequest.ts

@@ -0,0 +1,17 @@
+summary: Create a template
+# method_request: PUT _component_template/template_1
+# description:
+# type: request
+value:
+  template:
+  settings:
+    number_of_shards: 1
+  mappings:
+    _source:
+      enabled: false
+    properties:
+      host_name:
+        type: keyword
+      created_at:
+        type: date
+        format: 'EEE MMM dd HH:mm:ss Z yyyy'

specification/cluster/get_component_template/ClusterGetComponentTemplateRequest.ts

@@ -0,0 +1,18 @@
+summary: Create a template with aliases
+# method_request: PUT _component_template/template_1
+description: >
+  You can include index aliases in a component template.
+  During index creation, the `{index}` placeholder in the alias name will be replaced with the actual index name that the template gets applied to.
+# type: request
+value:
+  template:
+  settings:
+    number_of_shards: 1
+  aliases:
+    alias1: {}
+    alias2:
+      filter:
+        term:
+          user.id: kimchy
+      routing: shard-1
+    '{index}-alias': {}