You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/**
* When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters`
* object with information about the clusters that participated in the search along with info such as shards
* count.
* @server_default false
*/
include_ccs_metadata?: boolean
{
"description": "When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.",
"name": "include_ccs_metadata",
"required": false,
"serverDefault": false,
"type": {
"kind": "instance_of",
"type": {
"name": "boolean",
"namespace": "_builtins"
}
}
}
]
However, it's missing from the OpenAPI output. For example:
"include_ccs_metadata": {
"description": "When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters`\nobject with information about the clusters that participated in the search along with info such as shards\ncount.",
"type": "boolean"
}
In Kibana API documents, those default fields are present in the OpenAPI, for example:
parameters:
- description: The number of rules to return per page.
in: query
name: per_page
required: false
schema:
default: 10
minimum: 0
type: number
I thought this already existed, but it seems not. For example, looking at https://github.com/elastic/elasticsearch-specification/blob/main/specification/esql/query/QueryRequest.ts, which has
@server_default
values set like this:I can see that same information carried into the specification files, e.g.
serverDefault
appears forinclude_ccs_metadata
in https://raw.githubusercontent.com/elastic/elasticsearch-specification/refs/heads/main/output/schema/schema-serverless.jsonHowever, it's missing from the OpenAPI output. For example:
It should appear in a
default
field, as described in https://spec.openapis.org/oas/v3.0.3#propertiesIn Kibana API documents, those default fields are present in the OpenAPI, for example:
... which then is displayed in our docs like this (https://www.elastic.co/docs/api/doc/kibana/operation/operation-get-alerting-rules-find):
The text was updated successfully, but these errors were encountered: