[8.1] Replace hard-coded doc URLs with @doc_id (#1506)

Author: lcawl

output/schema/schema.json

@@ -375,3 +375,18 @@ run-as-privilege,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/run
 sql-rest-filtering,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/sql-rest-filtering.html
 sql-rest-format,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/sql-rest-format.html
 cron-expressions,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/api-conventions.html#api-cron-expressions
+runtime-search-request,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/runtime-search-request.html
+mapping-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/mapping-fields.html
+realtime,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/docs-get.html#realtime
+routing,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/docs-get.html#get-routing
+ccs-network-delays,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/modules-cross-cluster-search.html#ccs-network-delays
+k-precision,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-rank-eval.html#k-precision
+k-recall,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-rank-eval.html#k-recall
+mean-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-rank-eval.html#_mean_reciprocal_rank
+dcg,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-rank-eval.html#_discounted_cumulative_gain_dcg
+expected-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/search-rank-eval.html#_expected_reciprocal_rank_err
+scroll-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/paginate-search-results.html#scroll-search-results
+document-input-parameters,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/query-dsl-mlt-query.html#_document_input_parameters
+data-stream-path-param,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/indices-create-data-stream.html#indices-create-data-stream-api-path-params
+byte-units,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/api-conventions.html#byte-units
+node-roles,https://www.elastic.co/guide/en/elasticsearch/reference/8.1/modules-node.html#node-roles

specification/_doc_ids/table.csv

@@ -37,7 +37,7 @@ export interface Request extends RequestBase {
   }
   query_parameters: {
     /**
-     * If false, the request returns an error if any wildcard expression, [index alias](https://www.elastic.co/guide/en/elasticsearch/reference/current/aliases.html),
+     * 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
@@ -69,10 +69,10 @@ export interface Request extends RequestBase {
      */
     index_filter?: QueryContainer
     /**
-     * Defines ad-hoc [runtime fields](https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html) in the request similar
-     * to the way it is done in [search requests](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html#search-api-body-runtime).
+     * Defines ad-hoc runtime fields in the request similar to the way it is done in search requests.
      * These fields exist only as part of the query and take precedence over fields defined with the same name in the index mappings.
      * @since 7.12.0
+     * @doc_id runtime-search-request
      */
     runtime_mappings?: RuntimeFields
   }

specification/_global/field_caps/FieldCapabilitiesRequest.ts

@@ -47,7 +47,8 @@ export class FieldCapability {
   searchable: boolean
   type: string
   /**
-   * Whether this field is registered as a [metadata field](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html).
+   * Whether this field is registered as a metadata field.
+   * @doc_id mapping-metadata
    */
   metadata_field?: boolean
   /**

specification/_global/field_caps/types.ts

@@ -48,7 +48,7 @@ export interface Request extends RequestBase {
     /**
      *  Boolean) If true, the request is real-time as opposed to near-real-time.
      * @server_default true
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime
+     * @doc_id realtime
      */
     realtime?: boolean
     /**
@@ -58,7 +58,7 @@ export interface Request extends RequestBase {
     refresh?: boolean
     /**
      * Target the specified primary shard.
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing
+     * @doc_id routing
      */
     routing?: Routing
     /**

specification/_global/get/GetRequest.ts

@@ -48,7 +48,7 @@ export interface Request {
     /**
      *  Boolean) If true, the request is real-time as opposed to near-real-time.
      * @server_default true
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime
+     * @doc_id realtiime
      */
     realtime?: boolean
     /**
@@ -58,7 +58,7 @@ export interface Request {
     refresh?: boolean
     /**
      * Target the specified primary shard.
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#get-routing
+     * @doc_id routing
      */
     routing?: Routing
     /**

specification/_global/get_source/SourceRequest.ts

@@ -43,7 +43,7 @@ export interface Request extends RequestBase {
     /**
      * If `true`, the request is real-time as opposed to near-real-time.
      * @server_default true
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#realtime
+     * @doc_id realtime
      */
     realtime?: boolean
     /**
@@ -62,14 +62,14 @@ export interface Request extends RequestBase {
     /**
      * A comma-separated list of source fields to exclude from the response.
      * You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html
+     * @doc_id mapping-source-field
      */
     _source_excludes?: Fields
     /**
      * A comma-separated list of source fields to include in the response.
      * If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter.
      * If the `_source` parameter is `false`, this parameter is ignored.
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-source-field.html
+     * @doc_id mapping-source-field
      */
     _source_includes?: Fields
     /**

specification/_global/mget/MultiGetRequest.ts

@@ -43,7 +43,7 @@ export interface Request extends RequestBase {
     /**
      * If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.
      * @server_default true
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cross-cluster-search.html#ccs-network-delays
+     * @doc_id ccs-network-delays
      */
     ccs_minimize_roundtrips?: boolean
     /**

specification/_global/msearch/MultiSearchRequest.ts

@@ -23,7 +23,7 @@ import { long } from '@_types/Numeric'
 import { RequestItem } from './types'
 
 /**
- * Runs multiple [templated searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#run-multiple-templated-searches) with a single request.
+ * Runs multiple templated searches with a single request.
  * @rest_spec_name msearch_template
  * @since 5.0.0
  * @stability stable

specification/_global/msearch_template/MultiSearchTemplateRequest.ts

@@ -34,7 +34,7 @@ export interface Request extends RequestBase {
   query_parameters: {
     /**
      * Period to retain the search context for scrolling.
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results
+     * @doc_id scroll-search-results
      * @server_default 1d
      */
     scroll?: Time
@@ -49,7 +49,7 @@ export interface Request extends RequestBase {
   body: {
     /**
      * Period to retain the search context for scrolling.
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#scroll-search-results
+     * @doc_id scroll-search-results
      * @server_default 1d
      */
     scroll?: Time

specification/_global/scroll/ScrollRequest.ts

@@ -165,7 +165,7 @@ export interface Request extends RequestBase {
      */
     size?: integer
     slice?: SlicedScroll
-    /** @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html */
+    /** @doc_id sort-search-results */
     sort?: Sort
     /**
      * Indicates which source fields are returned for matching documents. These

specification/_global/search/SearchRequest.ts

@@ -53,7 +53,7 @@ export interface Request extends RequestBase {
     case_insensitive?: boolean
     /**
      * Allows to filter an index shard if the provided query rewrites to match_none.
-     * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
+     * @doc_id query-dsl
      */
     index_filter?: QueryContainer
     /**

specification/_global/terms_enum/TermsEnumRequest.ts

@@ -62,7 +62,7 @@ export class NodeShard {
 }
 
 /**
- * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html#node-roles
+ * @doc_id node-roles
  */
 export enum NodeRole {
   master = 0,
@@ -82,6 +82,6 @@ export enum NodeRole {
 }
 
 /**
- * * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-node.html#node-roles
+ * * @doc_id node-roles
  */
 export type NodeRoles = NodeRole[]