Merge branch 'main' into mw-stored-example-link

Author: marciw

docs/add-new-api.md

@@ -173,12 +173,13 @@ Add an `examples` folder and `request` and `xxx_response` subfolders (where `xxx
 
 These examples are for use in the API documentation and must adhere to the [OpenAPI 3.0 Example object specification](https://spec.openapis.org/oas/v3.0.3#example-object). They must have a `value` field that contains the request or response body.
 If there are multiple examples for the endpoint, they must each have a brief `summary` field, which is used as the label for the example. You can also optionaly provide an explanation in a `description` field.
+In order to generate curl and console examples automatically, the request examples must also contain a `method_request`.
 
 For example:
 
 ```yaml
 summary: Sequence query
-# method_request: GET /my-data-stream/_eql/search
+method_request: GET /my-data-stream/_eql/search
 # type: request
 description: >
   Run `GET /my-data-stream/_eql/search` to search for a sequence of events.

output/openapi/elasticsearch-openapi.json

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { FieldValue, Id, IndexName, NodeId } from '@_types/common'
+import { FieldValue, IndexName, NodeId } from '@_types/common'
 import { ErrorCause } from '@_types/Errors'
 import { integer } from '@_types/Numeric'
 import { DurationValue, UnitMillis } from '@_types/Time'
@@ -67,6 +67,7 @@ export class EsqlClusterDetails {
   indices: string
   took?: DurationValue<UnitMillis>
   _shards?: EsqlShardInfo
+  failures?: EsqlShardFailure[]
 }
 
 export enum EsqlClusterStatus {
@@ -82,12 +83,11 @@ export class EsqlShardInfo {
   successful?: integer
   skipped?: integer
   failed?: integer
-  failures?: EsqlShardFailure[]
 }
 
 export class EsqlShardFailure {
-  shard: Id
-  index: IndexName
+  shard: integer
+  index: IndexName | null
   node?: NodeId
   reason: ErrorCause
 }