[8.18] [DOCS] Remove Upgrade Assistant add default field API (#217264) (#217372)

# Backport This will backport the following commits from `8.x` to `8.18`: - [[DOCS] Remove Upgrade Assistant add default field API (#217264)](https://github.com/elastic/kibana/pull/217264)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)
2025-04-24 17:59:23 -04:00 · 2025-04-08 08:14:20 -07:00 · 2025-04-08 08:14:20 -07:00 · 12295390de
commit 12295390de
parent 4b98c0f475
5 changed files with 6 additions and 217 deletions
--- a/docs/api/upgrade-assistant.asciidoc
+++ b/docs/api/upgrade-assistant.asciidoc
@ -22,6 +22,5 @@ include::upgrade-assistant/status.asciidoc[]
 include::upgrade-assistant/reindexing.asciidoc[]
 include::upgrade-assistant/batch_reindexing.asciidoc[]
 include::upgrade-assistant/batch_queue.asciidoc[]
-include::upgrade-assistant/default-field.asciidoc[]
 include::upgrade-assistant/check_reindex_status.asciidoc[]
 include::upgrade-assistant/cancel_reindex.asciidoc[]
--- a/docs/api/upgrade-assistant/default-field.asciidoc
+++ b/docs/api/upgrade-assistant/default-field.asciidoc
@ -1,113 +0,0 @@
-[[upgrade-assistant-api-default-field]]
-=== Add default field API
-++++
-<titleabbrev>Add default field</titleabbrev>
-++++
-
-experimental[] In {es} 7.0 and later, some query types, such as Simple Query String, have a limit to the number of fields they can query against. 
-To configure the cap in {es}, set the `indices.query.bool.max_clause_count` cluster setting, which is 1024 by default.
-
-For indices with more fields than the cap, add the `index.query.default_field` index setting to inform {es} which 
-fields to use by default when no field is specified for a query. Use the add default field API to add the `index.query.default_field` setting to an {es} index.
-
-[[upgrade-assistant-api-default-field-request]]
-==== Request
-
-To add the `index.query.default_field` setting to an {es} index, submit a POST request to `/api/upgrade_assistant/add_query_default_field/<index>`:
-
-[source,js]
--------------------------------------------------
-GET /api/upgrade_assistant/add_query_default_field/myIndex
-{
-  "fieldTypes": ["text", "keyword"], <1>
-  "otherFields": ["myField.*"] <2>
-}
--------------------------------------------------
-// KIBANA
-
-<1> A required array of {es} field types that generate the list of fields.
-<2> An optional array of additional field names, dot-delimited.
-
-To add the `index.query.default_field` index setting to the specified index, {kib} generates an array of all fields from the index mapping.
-The fields contain the types specified in `fieldTypes`. {kib} appends any other fields specified in `otherFields` to the array of default fields.
-
-[[upgrade-assistant-api-default-field-response-codes]]
-==== Response codes
-
-`200`::
-  Indicates a successful call.
-
- `400`::
-  Indicates that the index already has the `index.query.default_field` setting. No changes are made to the index. 
-
-[[upgrade-assistant-api-default-field-response-body]]
-==== Response body
-
-The response body contains a JSON structure, similar to the following:
-
-[source,js]
--------------------------------------------------
-{
-  "acknowledged": true
-}
--------------------------------------------------
-
-[[upgrade-assistant-api-default-field-example]]
-==== Example
-
-Your index contains following mappings:
-
-[source,js]
--------------------------------------------------
-GET /myIndex/_mappings
-{
-  "myIndex": {
-    "mappings": {
-      "properties": {
-        "field1": { "type": "text" },
-        "field2": { "type": "float" },
-        "nestedfield": {
-          "properties": {
-            "field3": { "type": "keyword" },
-            "field4": { "type": "long" },
-          }
-        }
-      }
-    }
-  }
-}
--------------------------------------------------
-// CONSOLE
-
-Make the following request to {kib}:
-
-[source,js]
--------------------------------------------------
-GET /api/upgrade_assistant/add_query_default_field/myIndex
-{
-  "fieldTypes": ["text", "long"],
-  "otherFields": ["field2"]
-}
--------------------------------------------------
-// KIBANA
-
-The API returns the following:
-
-[source,js]
--------------------------------------------------
-GET /myIndex/_settings?flat_settings=true
-{
-  "myIndex": {
-    "settings": {
-      "index.query.default_field": [
-        "field1",
-        "nestedfield.field4",
-        "field2",
-      ]
-    }
-  }
-}
--------------------------------------------------
-// CONSOLE
-
-{kib} generates the `field1` and `nestedfield.field4` values based on the specified `fieldTypes`, then appends the `otherFields` to the array.
--- a/docs/redirects.asciidoc
+++ b/docs/redirects.asciidoc
@ -1221,3 +1221,9 @@ Refer to {api-kibana}/group/endpoint-roles[role APIs].
 == Create or update role API

 Refer to {api-kibana}/group/endpoint-roles[role APIs].
+
+[role="exclude",id="upgrade-assistant-api-default-field"]
+== Add default field API
+
+This API was removed in 7.13.0.
+Refer to {api-kibana}/group/endpoint-upgrade[upgrade assistant APIs].
--- a/oas_docs/output/kibana.yaml
+++ b/oas_docs/output/kibana.yaml
@ -24666,54 +24666,6 @@ paths:
      summary: Get Timelines or Timeline templates
      tags:
        - Security Timeline API
-  /api/upgrade_assistant/add_query_default_field/{index}:
-    get:
-      description: |
-        In Elasticsearch 7.0 and later, some query types, such as simple query string, have a limit to the number of fields they can query against. To configure the cap in Elasticsearch, set the `indices.query.bool.max_clause_count` cluster setting, which is 1024 by default.
-        For indices with more fields than the cap, add the `index.query.default_field` index setting to inform Elasticsearch which fields to use by default when no field is specified for a query. Use the add default field API to add the `index.query.default_field` setting to an Elasticsearch index.
-        To add the `index.query.default_field` index setting to the specified index, Kibana generates an array of all fields from the index mapping. The fields contain the types specified in `fieldTypes`. Kibana appends any other fields specified in `otherFields` to the array of default fields.
-      operationId: get-upgrade-default
-      requestBody:
-        content:
-          application/json:
-            examples:
-              addQueryDefaultFieldExampleRequest1:
-                description: Run `GET /api/upgrade_assistant/add_query_default_field/myIndex` to add the `index.query.default_field` setting to an Elasticsearch index.
-                value: |-
-                  {
-                    "fieldTypes": ["text", "keyword"], 
-                    "otherFields": ["myField.*"] 
-                  }
-            schema:
-              type: object
-              properties:
-                fieldTypes:
-                  description: |
-                    An array of Elasticsearch field types that generate the list of fields.
-                  type: array
-                otherFields:
-                  description: |
-                    An optional array of additional field names, dot-delimited.
-                  type: array
-              required:
-                - fieldTypes
-        required: true
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  acknowledged:
-                    type: boolean
-          description: Indicates a successful call.
-        '400':
-          description: Indicates that the index already has the `index.query.default_field` setting. No changes are made to the index.
-      summary: Add a default field
-      tags:
-        - upgrade
-      x-state: Technical Preview
  /api/upgrade_assistant/reindex/{index}:
    get:
      description: |
--- a/x-pack/platform/plugins/private/upgrade_assistant/docs/openapi/upgrade_apis.yaml
+++ b/x-pack/platform/plugins/private/upgrade_assistant/docs/openapi/upgrade_apis.yaml
@ -13,61 +13,6 @@ tags:
 servers:
  - url: /
 paths:
-  /api/upgrade_assistant/add_query_default_field/{index}:
-    get:
-      summary: Add a default field
-      description: >
-        In Elasticsearch 7.0 and later, some query types, such as simple query string, have a limit to the number of fields they can query against.
-        To configure the cap in Elasticsearch, set the `indices.query.bool.max_clause_count` cluster setting, which is 1024 by default.
-        
-        For indices with more fields than the cap, add the `index.query.default_field` index setting to inform Elasticsearch which fields to use by default when no field is specified for a query.
-        Use the add default field API to add the `index.query.default_field` setting to an Elasticsearch index.
-        
-        To add the `index.query.default_field` index setting to the specified index, Kibana generates an array of all fields from the index mapping.
-        The fields contain the types specified in `fieldTypes`.
-        Kibana appends any other fields specified in `otherFields` to the array of default fields.
-      x-state: Technical Preview
-      operationId: get-upgrade-default
-      tags:
-        - upgrade
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: object
-              required:
-                - fieldTypes
-              properties:
-                fieldTypes:
-                  type: array
-                  description: >
-                    An array of Elasticsearch field types that generate the list of fields.
-                otherFields:
-                  type: array
-                  description: >
-                    An optional array of additional field names, dot-delimited.
-            examples:
-              addQueryDefaultFieldExampleRequest1:
-                description: Run `GET /api/upgrade_assistant/add_query_default_field/myIndex` to add the `index.query.default_field` setting to an Elasticsearch index.
-                value: |-
-                  {
-                    "fieldTypes": ["text", "keyword"], 
-                    "otherFields": ["myField.*"] 
-                  }
-      responses:
-        '200':
-          description: Indicates a successful call.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  acknowledged:
-                    type: boolean
-                    # description:
-        '400':
-          description: Indicates that the index already has the `index.query.default_field` setting. No changes are made to the index.
  /api/upgrade_assistant/status:
    get:
      summary: Get the upgrade readiness status