Add overlays and externalDocs for knn, highlight, and fieldcollapse

Author: lcawl

docs/overlays/elasticsearch-shared-overlays.yaml

@@ -1056,12 +1056,6 @@ actions:
         externalDocs:
           url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl
           description: Query DSL
-  - target: "$.components['schemas']['_global.search._types.FieldCollapse']"
-    description: Add x-model and externalDocs
-    update:
-      x-model: true
-      externalDocs:
-        url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results
   - target: "$.components['schemas']['_global.search._types.SearchRequestBody'].properties"
     description: Add x-model to SearchRequestBody aggregations property
     update:
@@ -1077,6 +1071,36 @@ actions:
   - target: "$.components['schemas']['_types.query_dsl.QueryContainer'].properties"
     description: Remove the QueryContainer properties
     remove: true
+  - target: "$.components['schemas']['_global.search._types.FieldCollapse']"
+    description: Add x-model and externalDocs to FieldCollapse
+    update:
+      x-model: true
+      externalDocs:
+        url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results
+  - target: "$.components['schemas']['_global.search._types.FieldCollapse'].properties"
+    description: Remove properties from FieldCollapse
+    remove: true
+  - target: "$.components['schemas']['_global.search._types.FieldCollapse'].required"
+    description: Remove required from FieldCollapse
+    remove: true
+  - target: "$.components['schemas']['_global.search._types.Highlight']"
+    description: Add x-model, description, and externalDocs to Highlight
+    update:
+      x-model: true
+      description: The highlighter to use for retrieving highlighted snippets from one or more fields in your search results.
+      externalDocs:
+        url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting
+  - target: "$.components['schemas']['_global.search._types.Highlight'].allOf"
+    description: Remove allOf from Highlight
+    remove: true
+  - target: "$.components['schemas']['_global.search._types.SearchRequestBody'].properties.knn"
+    description: Add x-model to SearchRequestBody knn
+    update:
+      x-model: true
+  - target: "$.components['schemas']['_global.search._types.SearchRequestBody'].properties.knn.oneOf"
+    description: Remove oneOf from knn
+    remove: true
+# Examples
 # Examples
 ## xCodeSamples
   - target: "$.paths['/{index}/_doc/{id}']['head']"

output/schema/schema.json

@@ -706,9 +706,11 @@ search-application-get,https://www.elastic.co/docs/api/doc/elasticsearch/operati
 search-application-put,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put
 search-application-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search
 search-render-query,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-render-query
+search-retrievers,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers
 search-count,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count
 search-explain,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain
 search-field-caps,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps
+search-highlight,https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting
 search-knn,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-knn-search
 search-multi-search,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch
 search-multi-search-template,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template

specification/_doc_ids/table.csv

@@ -413,6 +413,7 @@ export interface Request extends RequestBase {
     from?: integer
     /**
      * Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.
+     * @ext_doc_id search-highlight
      */
     highlight?: Highlight
     /**
@@ -479,6 +480,7 @@ export interface Request extends RequestBase {
      * A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.
      * @availability stack since=8.14.0 stability=stable
      * @availability serverless stability=stable
+     * @ext_doc_id search-retrievers
      */
     retriever?: RetrieverContainer
     /**

specification/_global/search/SearchRequest.ts

@@ -68,6 +68,7 @@ export class SearchRequestBody {
   from?: integer
   /**
    * Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.
+   * @ext_doc_id search-highlight
    */
   highlight?: Highlight
   /**
@@ -134,6 +135,7 @@ export class SearchRequestBody {
    * A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.
    * @availability stack since=8.14.0 stability=stable
    * @availability serverless stability=stable
+   * @ext_doc_id search-retrievers
    */
   retriever?: RetrieverContainer
   /**