Merge branch '8.19' into backport-5096-to-8.19

Author: kosabogi

README.md

@@ -18,6 +18,8 @@ The repository has the following structure:
 This JSON representation is formally defined by [a set of TypeScript definitions (a meta-model)](./compiler/src/model/metamodel.ts)
 that also explains the various properties and their values.
 
+> [!TIP]
+> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/).
 
 ## Prepare the environment
 
@@ -78,6 +80,10 @@ $ make overlay-docs
 
 See [CONTRIBUTING.md](./CONTRIBUTING.md)
 
+Refer to the
+[Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/)
+for more details about the API documentation guidelines.
+
 ## Make Targets
 
 ```

docs/add-new-api.md

@@ -5,6 +5,9 @@ in this repository, or we do have an endpoint definition in [`/specification/_js
 but we don't have a type definition for it.
 In this document you will see how to add a new endpopint and how to add a new endpoint definition.
 
+> [!TIP]
+> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/).
+
 ## How to add a new endpoint
 
 Add a new endpoint is straightforward, you only need to copy-paste the json rest-api-spec defintion
@@ -56,7 +59,7 @@ Furthermore, every request definition **must** contain three JS Doc tags:
   - `stability`: the API stability, one of `experimental`, `beta`, `stable`
   - `visibility`: the API stability, one of `public` or `private`.
   - `since`: the version of Elasticsearch when the API has been introduced (eg: `7.7.0`).
-    This field is only available for `stack`.
+    This field is only available for `stack`. If the API is introduced in multiple major versions (eg: `8.19.0` and `9.1.0`), use the appropriate value in each branch.
   - `feature_flag`: the feature flag value, only valid if the `visibility` is set to `feature_flag`.
     This field is only available for `stack`.
 

docs/doc-comments-guide.md

@@ -5,7 +5,7 @@ A specification is not only about formalizing data structures, it's also about e
 Documentation of the TypeScript specification is made using [JSDoc](https://jsdoc.app/) comments, i.e. multiline comments starting with `/**` above a type or field declaration.
 
 The first phrase is used as the mandatory operation summary in the OpenAPI document.
-Refer to [API documentation guidelines](https://docs.elastic.dev/content-architecture/oas#summaries).
+Refer to the [Elastic API docs contribution guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/guidelines) to learn more about how to create great documentation for your API.
 
 > [!NOTE] 
 > You must add a period at the end of the phrase for it to parse correctly. The period will be properly omitted from the output OpenAPI document.
@@ -76,6 +76,8 @@ GFM also has implementations in most languages, meaning that code generators wil
 
 ## Structuring a doc-comment
 
+For guidelines of how to write great doc-comments, refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/guidelines#write-descriptions) page.
+
 ### Terseness
 
 **Doc comments are reference material**: they should be as succinct as possible while capturing all the necessary information to use the elements they're documenting. Remember that they will often show up in small IDE autocompletion popups!

docs/overlays/elasticsearch-openapi-overlays.yaml

@@ -14,7 +14,7 @@ actions:
         
         ## Documentation source and versions
         
-        This documentation is derived from the `8.x` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
+        This documentation is derived from the `8.19` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
         It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
 
         This documentation contains work-in-progress information for future Elastic Stack releases.

docs/schema-structure.md

@@ -12,6 +12,9 @@ for describing APIs that can't be represented in the specification.
 Refer to the [documentation guide](doc-comments-guide.md) to add documentation to types and fields,
 and to the [modeling guide](modeling-guide.md) to learn how to model the different types.
 
+> [!TIP]
+> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/).
+
 You can find the schema representing all APIs and types in the [output folder](output/schema/schema.json).
 The schema is structured as follows:
 

output/openapi/elasticsearch-openapi.json

@@ -31,6 +31,7 @@ import { float, long } from '@_types/Numeric'
 import { QueryContainer } from '@_types/query_dsl/abstractions'
 import { Operator } from '@_types/query_dsl/Operator'
 import { SlicedScroll } from '@_types/SlicedScroll'
+import { Sort } from '@_types/sort'
 import { Duration } from '@_types/Time'
 
 /**
@@ -310,5 +311,9 @@ export interface Request extends RequestBase {
      * Slice the request manually using the provided slice ID and total number of slices.
      */
     slice?: SlicedScroll
+    /**
+     * A sort object that specifies the order of deleted documents.
+     */
+    sort?: Sort
   }
 }