Skip to content

[OAS] Add description and response examples to /api/status #267355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TinaHeiligers merged 5 commits into from
May 5, 2026
Merged

[OAS] Add description and response examples to /api/status #267355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1daeeb1
[OAS] Add description and response examples to /api/status
TinaHeiligers May 3, 2026
c4c474a
Changes from make api-docs
kibanamachine May 3, 2026
7304b48
trigger CI
TinaHeiligers May 3, 2026
5effce9
Changes from capture_oas_snapshot.sh
kibanamachine May 3, 2026
da5af31
Merge branch 'main' into oas/api-status-description-examples
TinaHeiligers May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 68 additions & 1 deletion oas_docs/output/kibana.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75605,6 +75605,7 @@ paths:
name: product_name
/api/status:
get:
description: Returns Kibana's overall operational status and a per-service breakdown for Elasticsearch, Saved Objects, and registered plugins. The endpoint is intended for liveness and readiness checks (for example, by Kubernetes probes) and for operators monitoring a Kibana deployment. Unauthenticated callers receive a redacted response that exposes only the overall status level.
operationId: get-status
parameters:
- description: Set to "true" to get the response in v7 format.
Expand All @@ -75623,6 +75624,39 @@ paths:
'200':
content:
application/json:
examples:
statusAvailableResponse:
description: A successful response when Kibana and its core services are operating normally.
summary: Kibana is available
value:
metrics:
collection_interval_in_millis: 5000
elasticsearch_client:
totalActiveSockets: 4
totalIdleSockets: 2
totalQueuedRequests: 0
last_updated: '2026-04-30T12:00:05.000Z'
name: kibana
status:
core:
elasticsearch:
level: available
summary: Elasticsearch is available
savedObjects:
level: available
summary: SavedObjects service has completed migrations and is available
overall:
level: available
summary: All services are available
plugins: {}
uuid: 5b2de169-2785-441b-ae8c-186a1936b17d
version:
build_date: '2026-04-30T12:00:00.000Z'
build_flavor: traditional
build_hash: ad8f0fa4d5022f56bbe2c4d51e9d0fcfa1ee67fc
build_number: 100200
build_snapshot: false
number: 9.3.0
schema:
anyOf:
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_response'
Expand All @@ -75632,12 +75666,45 @@ paths:
'503':
content:
application/json:
examples:
statusUnavailableResponse:
description: A response when one or more core services are unavailable.
summary: Kibana is unavailable
value:
metrics:
collection_interval_in_millis: 5000
elasticsearch_client:
totalActiveSockets: 0
totalIdleSockets: 0
totalQueuedRequests: 0
last_updated: '2026-04-30T12:00:05.000Z'
name: kibana
status:
core:
elasticsearch:
level: unavailable
summary: Unable to connect to Elasticsearch
savedObjects:
level: unavailable
summary: SavedObjects service depends on Elasticsearch
overall:
level: unavailable
summary: Some services are unavailable
plugins: {}
uuid: 5b2de169-2785-441b-ae8c-186a1936b17d
version:
build_date: '2026-04-30T12:00:00.000Z'
build_flavor: traditional
build_hash: ad8f0fa4d5022f56bbe2c4d51e9d0fcfa1ee67fc
build_number: 100200
build_snapshot: false
number: 9.3.0
schema:
anyOf:
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_response'
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse'
description: Kibana's operational status. A minimal response is sent for unauthorized users.
description: Kibana or some of it's essential services are unavailable. Kibana may be degraded or unavailable.
description: Kibana or some of its essential services are unavailable. Kibana may be degraded or unavailable.
summary: Get Kibana's current status
tags:
- system
Expand Down
69 changes: 68 additions & 1 deletion oas_docs/output/kibana.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81462,6 +81462,7 @@ paths:
name: product_name
/api/status:
get:
description: Returns Kibana's overall operational status and a per-service breakdown for Elasticsearch, Saved Objects, and registered plugins. The endpoint is intended for liveness and readiness checks (for example, by Kubernetes probes) and for operators monitoring a Kibana deployment. Unauthenticated callers receive a redacted response that exposes only the overall status level.
operationId: get-status
parameters:
- description: Set to "true" to get the response in v7 format.
Expand All @@ -81480,6 +81481,39 @@ paths:
'200':
content:
application/json:
examples:
statusAvailableResponse:
description: A successful response when Kibana and its core services are operating normally.
summary: Kibana is available
value:
metrics:
collection_interval_in_millis: 5000
elasticsearch_client:
totalActiveSockets: 4
totalIdleSockets: 2
totalQueuedRequests: 0
last_updated: '2026-04-30T12:00:05.000Z'
name: kibana
status:
core:
elasticsearch:
level: available
summary: Elasticsearch is available
savedObjects:
level: available
summary: SavedObjects service has completed migrations and is available
overall:
level: available
summary: All services are available
plugins: {}
uuid: 5b2de169-2785-441b-ae8c-186a1936b17d
version:
build_date: '2026-04-30T12:00:00.000Z'
build_flavor: traditional
build_hash: ad8f0fa4d5022f56bbe2c4d51e9d0fcfa1ee67fc
build_number: 100200
build_snapshot: false
number: 9.3.0
schema:
anyOf:
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_response'
Expand All @@ -81489,12 +81523,45 @@ paths:
'503':
content:
application/json:
examples:
statusUnavailableResponse:
description: A response when one or more core services are unavailable.
summary: Kibana is unavailable
value:
metrics:
collection_interval_in_millis: 5000
elasticsearch_client:
totalActiveSockets: 0
totalIdleSockets: 0
totalQueuedRequests: 0
last_updated: '2026-04-30T12:00:05.000Z'
name: kibana
status:
core:
elasticsearch:
level: unavailable
summary: Unable to connect to Elasticsearch
savedObjects:
level: unavailable
summary: SavedObjects service depends on Elasticsearch
overall:
level: unavailable
summary: Some services are unavailable
plugins: {}
uuid: 5b2de169-2785-441b-ae8c-186a1936b17d
version:
build_date: '2026-04-30T12:00:00.000Z'
build_flavor: traditional
build_hash: ad8f0fa4d5022f56bbe2c4d51e9d0fcfa1ee67fc
build_number: 100200
build_snapshot: false
number: 9.3.0
schema:
anyOf:
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_response'
- $ref: '#/components/schemas/Kibana_HTTP_APIs_core_status_redactedResponse'
description: Kibana's operational status. A minimal response is sent for unauthorized users.
description: Kibana or some of it's essential services are unavailable. Kibana may be degraded or unavailable.
description: Kibana or some of its essential services are unavailable. Kibana may be degraded or unavailable.
summary: Get Kibana's current status
tags:
- system
Expand Down
75 changes: 75 additions & 0 deletions src/core/packages/status/server-internal/src/routes/status.examples.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
responses:
'200':
description: Overall status is OK and Kibana should be functioning normally.
content:
application/json:
examples:
statusAvailableResponse:
summary: Kibana is available
description: A successful response when Kibana and its core services are operating normally.
value:
name: kibana
uuid: 5b2de169-2785-441b-ae8c-186a1936b17d
version:
number: 9.3.0
build_hash: ad8f0fa4d5022f56bbe2c4d51e9d0fcfa1ee67fc
build_number: 100200
build_snapshot: false
build_flavor: traditional
build_date: '2026-04-30T12:00:00.000Z'
status:
overall:
level: available
summary: All services are available
core:
elasticsearch:
level: available
summary: Elasticsearch is available
savedObjects:
level: available
summary: SavedObjects service has completed migrations and is available
plugins: {}
metrics:
last_updated: '2026-04-30T12:00:05.000Z'
collection_interval_in_millis: 5000
elasticsearch_client:
totalActiveSockets: 4
totalIdleSockets: 2
totalQueuedRequests: 0
'503':
description: Kibana or some of its essential services are unavailable. Kibana may be degraded or unavailable.
content:
application/json:
examples:
statusUnavailableResponse:
summary: Kibana is unavailable
description: A response when one or more core services are unavailable.
value:
name: kibana
uuid: 5b2de169-2785-441b-ae8c-186a1936b17d
version:
number: 9.3.0
build_hash: ad8f0fa4d5022f56bbe2c4d51e9d0fcfa1ee67fc
build_number: 100200
build_snapshot: false
build_flavor: traditional
build_date: '2026-04-30T12:00:00.000Z'
status:
overall:
level: unavailable
summary: Some services are unavailable
core:
elasticsearch:
level: unavailable
summary: Unable to connect to Elasticsearch
savedObjects:
level: unavailable
summary: SavedObjects service depends on Elasticsearch
plugins: {}
metrics:
last_updated: '2026-04-30T12:00:05.000Z'
collection_interval_in_millis: 5000
elasticsearch_client:
totalActiveSockets: 0
totalIdleSockets: 0
totalQueuedRequests: 0
3 changes: 3 additions & 0 deletions src/core/packages/status/server-internal/src/routes/status.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/

import path from 'node:path';
import { type Observable, combineLatest, ReplaySubject, firstValueFrom, startWith } from 'rxjs';
import { schema } from '@kbn/config-schema';
import type { PackageInfo } from '@kbn/config';
Expand Down Expand Up @@ -100,7 +101,9 @@ export const registerStatusRoute = ({
tags: ['api', 'security:acceptJWT', 'oas-tag:system'],
access: 'public', // needs to be public to allow access from "system" users like k8s readiness probes.
summary: `Get Kibana's current status`,
description: `Returns Kibana's overall operational status and a per-service breakdown for Elasticsearch, Saved Objects, and registered plugins. The endpoint is intended for liveness and readiness checks (for example, by Kubernetes probes) and for operators monitoring a Kibana deployment. Unauthenticated callers receive a redacted response that exposes only the overall status level.`,
excludeFromRateLimiter: true,
oasOperationObject: () => path.resolve(__dirname, './status.examples.yaml'),
},
validate: {
request: {
Expand Down
4 changes: 2 additions & 2 deletions src/platform/packages/private/kbn-validate-oas/src/oas_error_baseline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"./oas_docs/output/kibana.yaml": 200,
"./oas_docs/output/kibana.serverless.yaml": 183
"./oas_docs/output/kibana.yaml": 197,
"./oas_docs/output/kibana.serverless.yaml": 180
}
Loading