[DOCS] Add missing doc_id values (#3632) (#3633)

(cherry picked from commit 89a229f)

Author: lcawl

output/openapi/elasticsearch-openapi.json

@@ -29,6 +29,7 @@ import { Duration } from '@_types/Time'
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage
  * @doc_tag script
+ * @doc_id script-get
  */
 export interface Request extends RequestBase {
   urls: [

output/openapi/elasticsearch-serverless-openapi.json

@@ -43,6 +43,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name health_report
  * @availability stack since=8.7.0 stability=stable
  * @availability serverless stability=stable visibility=private
+ * @doc_id health-api
  */
 export interface Request extends RequestBase {
   urls: [

output/schema/schema.json

@@ -45,6 +45,7 @@ import { RequestItem } from './types'
  * @availability serverless stability=stable visibility=public
  * @index_privileges read
  * @doc_tag search
+ * @doc_id search-multi-search
  */
 export interface Request extends RequestBase {
   urls: [

specification/_doc_ids/table.csv

@@ -26,6 +26,7 @@ import { RequestBase } from '@_types/Base'
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=public
  * @doc_tag cluster
+ * @doc_id cluster-ping
  */
 export interface Request extends RequestBase {
   urls: [

specification/_global/get_script/GetScriptRequest.ts

@@ -30,6 +30,7 @@ import { RankEvalMetric, RankEvalRequestItem } from './types'
  * @availability serverless stability=stable visibility=public
  * @index_privileges read
  * @doc_tag search
+ * @doc_id search-rank-eval
  */
 export interface Request extends RequestBase {
   urls: [

specification/_global/health_report/Request.ts

@@ -28,7 +28,7 @@ import { Duration, TimeUnit } from '@_types/Time'
  * @rest_spec_name cat.tasks
  * @availability stack since=5.0.0 stability=experimental
  * @availability serverless stability=experimental visibility=private
- * @doc_id tasks
+ * @doc_id cat-tasks
  * @cluster_privileges monitor
  */
 export interface Request extends CatRequestBase {

specification/_global/msearch/MultiSearchRequest.ts

@@ -27,6 +27,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name enrich.delete_policy
  * @availability stack since=7.5.0 stability=stable
  * @availability serverless stability=stable visibility=public
+ * @doc_id delete-enrich-policy-api
  */
 export interface Request extends RequestBase {
   urls: [

specification/_global/ping/PingRequest.ts

@@ -27,6 +27,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name enrich.get_policy
  * @availability stack since=7.5.0 stability=stable
  * @availability serverless stability=stable visibility=public
+ * @doc_id get-enrich-policy-api
  */
 export interface Request extends RequestBase {
   urls: [

specification/_global/rank_eval/RankEvalRequest.ts

@@ -26,6 +26,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name enrich.stats
  * @availability stack since=7.5.0 stability=stable
  * @availability serverless stability=stable visibility=public
+ * @doc_id enrich-stats-api
  */
 export interface Request extends RequestBase {
   urls: [

specification/cat/tasks/CatTasksRequest.ts

@@ -27,6 +27,7 @@ import { Id } from '@_types/common'
  * @rest_spec_name eql.delete
  * @availability stack since=7.9.0 stability=stable
  * @availability serverless stability=stable visibility=public
+ * @doc_id eql-async-search-delete
  */
 export interface Request extends RequestBase {
   urls: [

specification/enrich/delete_policy/DeleteEnrichPolicyRequest.ts

@@ -32,6 +32,7 @@ import { ResultPosition } from './types'
  * @rest_spec_name eql.search
  * @availability stack since=7.9.0 stability=stable
  * @availability serverless stability=stable visibility=public
+ * @doc_id eql-search-api
  * @ext_doc_id eql
  */
 export interface Request extends RequestBase {

specification/enrich/get_policy/GetEnrichPolicyRequest.ts

@@ -33,6 +33,7 @@ import { Duration } from '@_types/Time'
  * In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.
  * @rest_spec_name features.get_features
  * @availability stack since=7.12.0 stability=stable
+ * @doc_id get-features-api
  * @ext_doc_id snapshot-create
  */
 export interface Request extends RequestBase {

specification/enrich/stats/EnrichStatsRequest.ts

@@ -41,6 +41,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name features.reset_features
  * @availability stack since=7.12.0 stability=experimental
  * @availability serverless stability=experimental visibility=private
+ * @doc_id features-reset
  */
 export interface Request extends RequestBase {
   urls: [

specification/eql/delete/EqlDeleteRequest.ts

@@ -23,9 +23,14 @@ import { Duration } from '@_types/Time'
 import { Checkpoint } from '../_types/Checkpoints'
 
 /**
+ * Get global checkpoints.
+ *
+ * Get the current global checkpoints for an index.
+ * This API is designed for internal use by the Fleet server project.
  * @rest_spec_name fleet.global_checkpoints
  * @availability stack since=7.13.0 stability=stable
  * @availability serverless stability=stable visibility=private
+ * @doc_id get-global-checkpoints
  */
 export interface Request extends RequestBase {
   urls: [

specification/eql/search/EqlSearchRequest.ts

@@ -36,6 +36,7 @@ import { Checkpoint } from '../_types/Checkpoints'
  * @availability stack since=7.16.0 stability=experimental
  * @availability serverless stability=experimental visibility=private
  * @index_privileges read
+ * @doc_id fleet-multi-search
  */
 export interface Request extends RequestBase {
   urls: [

specification/features/get_features/GetFeaturesRequest.ts

@@ -59,6 +59,7 @@ import { Checkpoint } from '../_types/Checkpoints'
  * @availability stack since=7.16.0 stability=experimental
  * @availability serverless stability=experimental visibility=private
  * @index_privileges read
+ * @doc_id fleet-search
  */
 export interface Request extends RequestBase {
   urls: [

specification/features/reset_features/ResetFeaturesRequest.ts

@@ -27,6 +27,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name ilm.delete_lifecycle
  * @availability stack since=6.6.0 stability=stable
  * @cluster_privileges manage_ilm
+ * @doc_id ilm-delete-lifecycle
  */
 export interface Request extends RequestBase {
   urls: [

specification/fleet/global_checkpoints/GlobalCheckpointsRequest.ts

@@ -30,6 +30,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name ilm.explain_lifecycle
  * @availability stack since=6.6.0 stability=stable
  * @index_privileges view_index_metadata,manage_ilm
+ * @doc_id ilm-explain-lifecycle
  */
 export interface Request extends RequestBase {
   urls: [

specification/fleet/msearch/MultiSearchRequest.ts

@@ -26,6 +26,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name ilm.get_lifecycle
  * @availability stack since=6.6.0 stability=stable
  * @cluster_privileges manage_ilm, read_ilm
+ * @doc_id ilm-get-lifecycle
  */
 export interface Request extends RequestBase {
   urls: [

specification/fleet/search/SearchRequest.ts

@@ -21,10 +21,12 @@ import { RequestBase } from '@_types/Base'
 
 /**
  * Get the ILM status.
+ *
  * Get the current index lifecycle management status.
  * @rest_spec_name ilm.get_status
  * @availability stack since=6.6.0 stability=stable
  * @cluster_privileges read_ilm
+ * @doc_id ilm-get-status
  */
 export interface Request extends RequestBase {
   urls: [

specification/ilm/delete_lifecycle/DeleteLifecycleRequest.ts

@@ -36,6 +36,7 @@ import { RequestBase } from '@_types/Base'
  * Use the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`.
  * @rest_spec_name ilm.migrate_to_data_tiers
  * @availability stack since=7.14.0 stability=stable
+ * @doc_id ilm-migrate-to-data-tiers
  * @ext_doc_id migrate-index-allocation-filters
  */
 export interface Request extends RequestBase {

specification/ilm/explain_lifecycle/ExplainLifecycleRequest.ts

@@ -39,6 +39,7 @@ import { StepKey } from './types'
  * @rest_spec_name ilm.move_to_step
  * @availability stack since=6.6.0 stability=stable
  * @index_privileges manage_ilm
+ * @doc_id ilm-move-to-step
  */
 export interface Request extends RequestBase {
   urls: [

specification/ilm/get_lifecycle/GetLifecycleRequest.ts

@@ -31,6 +31,7 @@ import { Duration } from '@_types/Time'
  * @availability stack since=6.6.0 stability=stable
  * @cluster_privileges manage_ilm
  * @index_privileges manage
+ * @doc_id ilm-put-lifecycle
  * @ext_doc_id ilm-index-lifecycle
  */
 export interface Request extends RequestBase {

specification/ilm/get_status/GetIlmStatusRequest.ts

@@ -27,6 +27,7 @@ import { IndexName } from '@_types/common'
  * @rest_spec_name ilm.remove_policy
  * @availability stack since=6.6.0 stability=stable
  * @index_privileges manage_ilm
+ * @doc_id ilm-remove-policy
  */
 export interface Request extends RequestBase {
   urls: [

specification/ilm/migrate_to_data_tiers/Request.ts

@@ -28,6 +28,7 @@ import { IndexName } from '@_types/common'
  * @rest_spec_name ilm.retry
  * @availability stack since=6.6.0 stability=stable
  * @index_privileges manage_ilm
+ * @doc_id ilm-retry-policy
  */
 export interface Request extends RequestBase {
   urls: [

specification/ilm/move_to_step/MoveToStepRequest.ts

@@ -28,6 +28,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name ilm.start
  * @availability stack since=6.6.0 stability=stable
  * @cluster_privileges manage_ilm
+ * @doc_id ilm-start
  */
 export interface Request extends RequestBase {
   urls: [

specification/ilm/put_lifecycle/PutLifecycleRequest.ts

@@ -30,6 +30,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name ilm.stop
  * @availability stack since=6.6.0 stability=stable
  * @cluster_privileges manage_ilm
+ * @doc_id ilm-stop
  */
 export interface Request extends RequestBase {
   urls: [

specification/ilm/remove_policy/RemovePolicyRequest.ts

@@ -23,10 +23,13 @@ import { Duration } from '@_types/Time'
 
 /**
  * Add an index block.
- * Limits the operations allowed on an index by blocking specific operation types.
+ *
+ * Add an index block to an index.
+ * Index blocks limit the operations allowed on an index by blocking specific operation types.
  * @rest_spec_name indices.add_block
  * @availability stack since=7.9.0 stability=stable
  * @availability serverless stability=stable visibility=public
+ * @doc_id index-block-add
  */
 export interface Request extends RequestBase {
   urls: [
@@ -36,21 +39,62 @@ export interface Request extends RequestBase {
     }
   ]
   path_parts: {
+    /**
+     * A comma-separated list or wildcard expression of index names used to limit the request.
+     * By default, you must explicitly name the indices you are adding blocks to.
+     * To allow the adding of blocks to indices with `_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 by using the cluster update settings API.
+     */
     index: IndexName
+    /**
+     * The block type to add to the index.
+     */
     block: IndicesBlockOptions
   }
   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.
+     * For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
+     * @server_default true
+     */
     allow_no_indices?: boolean // default: true
+    /**
+     * The 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.
+     * It supports comma-separated values, such as `open,hidden`.
+     * @server_default open
+     */
     expand_wildcards?: ExpandWildcards // default: open
+    /**
+     * If `false`, the request returns an error if it targets a missing or closed index.
+     * @server_default false
+     */
     ignore_unavailable?: boolean // default: false
+    /**
+     * The period to wait for the master node.
+     * If the master node is not available before the timeout expires, the request fails and returns an error.
+     * It can also be set to `-1` to indicate that the request should never timeout.
+     * @server_default 30s
+     */
     master_timeout?: Duration // default: 30s
+    /**
+     * The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
+     * If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
+     * It can also be set to `-1` to indicate that the request should never timeout.
+     * @server_default 30s
+     */
     timeout?: Duration // default: 30s
   }
 }
 
 export enum IndicesBlockOptions {
+  /** Disable metadata changes, such as closing the index. */
   metadata,
+  /** Disable read operations. */
   read,
+  /** Disable write operations and metadata changes. */
   read_only,
+  /** Disable write operations. However, metadata changes are still allowed. */
   write
 }

specification/ilm/retry/RetryIlmRequest.ts

@@ -1,7 +1,13 @@
 # summary: ''
-description: 'A successful response for adding an index block to an index.'
+description: A successful response from `PUT /my-index-000001/_block/write`, which adds an index block to an index.'
 # type: response
 # response_code: 200
-value:
-  "{\n  \"acknowledged\" : true,\n  \"shards_acknowledged\" : true,\n  \"indices\"\
-  \ : [ {\n    \"name\" : \"my-index-000001\",\n    \"blocked\" : true\n  } ]\n}"
+value: |-
+  {
+    "acknowledged" : true,
+    "shards_acknowledged" : true,
+    "indices" : [ {
+      "name" : "my-index-000001",
+      "blocked" : true
+    } ]
+  }

specification/ilm/start/StartIlmRequest.ts

@@ -32,6 +32,7 @@ import { ExpandWildcards, Fields, Indices } from '@_types/common'
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=private
  * @index_privileges manage
+ * @doc_id indices-clearcache
  */
 export interface Request extends RequestBase {
   urls: [

specification/ilm/stop/StopIlmRequest.ts

@@ -73,6 +73,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name indices.clone
  * @availability stack since=7.4.0 stability=stable
  * @index_privileges manage
+ * @doc_id indices-clone-index
  */
 export interface Request extends RequestBase {
   urls: [

specification/indices/add_block/IndicesAddBlockRequest.ts

@@ -23,13 +23,14 @@ import { Duration } from '@_types/Time'
 
 /**
  * Create a data stream.
- * Creates a data stream.
+ *
  * You must have a matching index template with data stream enabled.
  * @rest_spec_name indices.create_data_stream
  * @availability stack since=7.9.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @index_privileges create_index
  * @doc_tag data stream
+ * @doc_id indices-create-data-stream
  */
 export interface Request extends RequestBase {
   urls: [

specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml

@@ -22,12 +22,14 @@ import { ExpandWildcards, IndexName } from '@_types/common'
 
 /**
  * Get data stream stats.
- * Retrieves statistics for one or more data streams.
+ *
+ * Get statistics for one or more data streams.
  * @rest_spec_name indices.data_streams_stats
  * @availability stack since=7.9.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @index_privileges monitor
  * @doc_tag data stream
+ * @doc_id data-stream-stats-api
  */
 export interface Request extends RequestBase {
   urls: [

specification/indices/clear_cache/IndicesClearCacheRequest.ts

@@ -27,6 +27,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name indices.delete_data_lifecycle
  * @availability stack since=8.11.0 stability=stable
  * @availability serverless stability=stable visibility=public
+ * @doc_id data-stream-delete-lifecycle
  */
 export interface Request extends RequestBase {
   urls: [

specification/indices/clone/IndicesCloneRequest.ts

@@ -29,6 +29,7 @@ import { Duration } from '@_types/Time'
  * @availability serverless stability=stable visibility=public
  * @index_privileges delete_index
  * @doc_tag data stream
+ * @doc_id data-stream-delete
  */
 export interface Request extends RequestBase {
   urls: [