github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 03:01:21 -04:00
Code Issues Projects Releases Packages Wiki Activity

[ResponseOps][MW] Fix MW oas docs capture. (#221727)

Browse source 
Closes #210326

## Summary

The public Maintenance Window API specification was missing from
`oas_docs/output/kibana.yaml`.

The `capture_oas_snapshot.sh` script had an outdated path.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
This commit is contained in:
Antonio 2025-06-03 13:05:18 +02:00 • committed by GitHub
parent 597b82b9e8
commit 7cad18fc68
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
17 changed files with 4611 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.buildkite/scripts/steps/checks/capture_oas_snapshot.sh
View file

@ -20,7 +20,7 @@ cmd="node scripts/capture_oas_snapshot \
--include-path /api/dashboards \ --include-path /api/dashboards \
--include-path /api/saved_objects/_import \ --include-path /api/saved_objects/_import \
--include-path /api/saved_objects/_export \ --include-path /api/saved_objects/_export \
--include-path /api/alerting/maintenance_window" --include-path /api/maintenance_window"
if is_pr && ! is_auto_commit_disabled; then if is_pr && ! is_auto_commit_disabled; then
cmd="$cmd --update" cmd="$cmd --update"
fi fi

1327
oas_docs/bundle.json
View file

File diff suppressed because it is too large Load diff

1327
oas_docs/bundle.serverless.json
View file

File diff suppressed because it is too large Load diff

954
oas_docs/output/kibana.serverless.yaml
View file

@ -92,6 +92,13 @@ tags:
- name: Fleet Server hosts - name: Fleet Server hosts
- name: Fleet service tokens - name: Fleet service tokens
- name: Fleet uninstall tokens - name: Fleet uninstall tokens
- name: maintenance-window
description: |
You can schedule single or recurring maintenance windows to temporarily reduce rule notifications. For example, a maintenance window prevents false alarms during planned outages.
externalDocs:
description: Maintenance window documentation
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts/maintenance-windows
x-displayName: Maintenance windows
- name: Message Signing Service - name: Message Signing Service
- description: Machine learning - description: Machine learning
name: ml name: ml
@ -42315,6 +42322,953 @@ paths:
summary: Get value list privileges summary: Get value list privileges
tags: tags:
- Security Lists API - Security Lists API
/api/maintenance_window:
post:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: post-maintenance-window
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
requestBody:
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
minimum: 1
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
maximum: 12
minimum: 1
type: number
minItems: 1
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
maximum: 31
minimum: 1
type: number
minItems: 1
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
minItems: 1
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL). Only alerts matching this query will be supressed by the maintenance window.
type: string
required:
- kql
required:
- query
required:
- alerting
title:
description: The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window.
type: string
required:
- title
- schedule
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
summary: Create a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
/api/maintenance_window/{id}:
delete:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: delete-maintenance-window-id
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: The identifier for the maintenance window to be deleted.
in: path
name: id
required: true
schema:
type: string
responses:
'204':
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
summary: Delete a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
get:
description: '[Required authorization] Route required privileges: read-maintenance-window.'
operationId: get-maintenance-window-id
parameters:
- description: The identifier for the maintenance window.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
summary: Get maintenance window details.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
patch:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: patch-maintenance-window-id
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
minimum: 1
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
maximum: 12
minimum: 1
type: number
minItems: 1
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
maximum: 31
minimum: 1
type: number
minItems: 1
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
minItems: 1
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL). Only alerts matching this query will be supressed by the maintenance window.
type: string
required:
- kql
required:
- query
required:
- alerting
title:
description: The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window.
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
'409':
description: Indicates that the maintenance window has already been updated by another user.
summary: Update a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
/api/maintenance_window/{id}/_archive:
post:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: post-maintenance-window-id-archive
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: The identifier for the maintenance window to be archived.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
summary: Archive a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
/api/maintenance_window/{id}/_unarchive:
post:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: post-maintenance-window-id-unarchive
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: The identifier for the maintenance window to be unarchived.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
summary: Unarchive a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
/api/ml/saved_objects/sync: /api/ml/saved_objects/sync:
get: get:
description: | description: |

954
oas_docs/output/kibana.yaml
View file

@ -115,6 +115,13 @@ tags:
url: https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management url: https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management
name: logstash name: logstash
x-displayName: Logstash configuration management x-displayName: Logstash configuration management
- name: maintenance-window
description: |
You can schedule single or recurring maintenance windows to temporarily reduce rule notifications. For example, a maintenance window prevents false alarms during planned outages.
externalDocs:
description: Maintenance window documentation
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/alerts/maintenance-windows
x-displayName: Maintenance windows
- name: Message Signing Service - name: Message Signing Service
- description: Machine learning - description: Machine learning
name: ml name: ml
@ -44720,6 +44727,953 @@ paths:
tags: tags:
- logstash - logstash
x-state: Technical Preview x-state: Technical Preview
/api/maintenance_window:
post:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: post-maintenance-window
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
requestBody:
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
minimum: 1
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
maximum: 12
minimum: 1
type: number
minItems: 1
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
maximum: 31
minimum: 1
type: number
minItems: 1
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
minItems: 1
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL). Only alerts matching this query will be supressed by the maintenance window.
type: string
required:
- kql
required:
- query
required:
- alerting
title:
description: The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window.
type: string
required:
- title
- schedule
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
summary: Create a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
/api/maintenance_window/{id}:
delete:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: delete-maintenance-window-id
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: The identifier for the maintenance window to be deleted.
in: path
name: id
required: true
schema:
type: string
responses:
'204':
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
summary: Delete a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
get:
description: '[Required authorization] Route required privileges: read-maintenance-window.'
operationId: get-maintenance-window-id
parameters:
- description: The identifier for the maintenance window.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
summary: Get maintenance window details.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
patch:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: patch-maintenance-window-id
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
minimum: 1
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
maximum: 12
minimum: 1
type: number
minItems: 1
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
maximum: 31
minimum: 1
type: number
minItems: 1
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
minItems: 1
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL). Only alerts matching this query will be supressed by the maintenance window.
type: string
required:
- kql
required:
- query
required:
- alerting
title:
description: The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window.
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
'409':
description: Indicates that the maintenance window has already been updated by another user.
summary: Update a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
/api/maintenance_window/{id}/_archive:
post:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: post-maintenance-window-id-archive
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: The identifier for the maintenance window to be archived.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
summary: Archive a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
/api/maintenance_window/{id}/_unarchive:
post:
description: '[Required authorization] Route required privileges: write-maintenance-window.'
operationId: post-maintenance-window-id-unarchive
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- description: The identifier for the maintenance window to be unarchived.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
created_at:
description: The date and time when the maintenance window was created.
type: string
created_by:
description: The identifier for the user that created the maintenance window.
nullable: true
type: string
enabled:
description: Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
type: boolean
id:
description: The identifier for the maintenance window.
type: string
schedule:
additionalProperties: false
type: object
properties:
custom:
additionalProperties: false
type: object
properties:
duration:
description: 'The duration of the schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `h`, `m`, or `s` for hours, minutes, seconds. For example: `1d`, `5h`, `30m`, `5000s`.'
type: string
recurring:
additionalProperties: false
type: object
properties:
end:
description: 'The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-04-01T00:00:00.000Z`.'
type: string
every:
description: 'The interval and frequency of a recurring schedule. It allows values in `<integer><unit>` format. `<unit>` is one of `d`, `w`, `M`, or `y` for days, weeks, months, years. For example: `15d`, `2w`, `3m`, `1y`.'
type: string
occurrences:
description: The total number of recurrences of the schedule.
type: number
onMonth:
description: The specific months for a recurring schedule. Valid values are 1-12.
items:
type: number
type: array
onMonthDay:
description: The specific days of the month for a recurring schedule. Valid values are 1-31.
items:
type: number
type: array
onWeekDay:
description: The specific days of the week (`[MO,TU,WE,TH,FR,SA,SU]`) or nth day of month (`[+1MO, -3FR, +2WE, -4SA, -5SU]`) for a recurring schedule.
items:
type: string
type: array
start:
description: 'The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: `2025-03-12T12:00:00.000Z`.'
type: string
timezone:
description: The timezone of the schedule. The default timezone is UTC.
type: string
required:
- start
- duration
required:
- custom
scope:
additionalProperties: false
type: object
properties:
alerting:
additionalProperties: false
type: object
properties:
query:
additionalProperties: false
type: object
properties:
kql:
description: A filter written in Kibana Query Language (KQL).
type: string
required:
- kql
required:
- query
required:
- alerting
status:
description: The current status of the maintenance window.
enum:
- running
- upcoming
- finished
- archived
type: string
title:
description: The name of the maintenance window.
type: string
updated_at:
description: The date and time when the maintenance window was last updated.
type: string
updated_by:
description: The identifier for the user that last updated this maintenance window.
nullable: true
type: string
required:
- id
- title
- enabled
- created_by
- updated_by
- created_at
- updated_at
- status
- schedule
description: Indicates a successful call.
'400':
description: Indicates an invalid schema or parameters.
'403':
description: Indicates that this call is forbidden.
'404':
description: Indicates a maintenance window with the given ID does not exist.
summary: Unarchive a maintenance window.
tags:
- maintenance-window
x-state: Generally available; added in 9.1.0
/api/ml/saved_objects/sync: /api/ml/saved_objects/sync:
get: get:
description: | description: |

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/archive/archive_maintenance_window_route.test.ts vendored
View file

@ -54,6 +54,10 @@ describe('archiveMaintenanceWindowRoute', () => {
expect(config.options).toMatchInlineSnapshot(` expect(config.options).toMatchInlineSnapshot(`
Object { Object {
"access": "public", "access": "public",
"availability": Object {
"since": "9.1.0",
"stability": "stable",
},
"summary": "Archive a maintenance window.", "summary": "Archive a maintenance window.",
"tags": Array [ "tags": Array [
"oas-tag:maintenance-window", "oas-tag:maintenance-window",

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/archive/archive_maintenance_window_route.ts vendored
View file

@ -56,6 +56,10 @@ export const archiveMaintenanceWindowRoute = (
access: 'public', access: 'public',
summary: 'Archive a maintenance window.', summary: 'Archive a maintenance window.',
tags: ['oas-tag:maintenance-window'], tags: ['oas-tag:maintenance-window'],
availability: {
since: '9.1.0',
stability: 'stable',
},
}, },
}, },
router.handleLegacyErrors( router.handleLegacyErrors(

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/create/create_maintenance_window_route.test.ts vendored
View file

@ -71,6 +71,10 @@ describe('createMaintenanceWindowRoute', () => {
expect(config.options).toMatchInlineSnapshot(` expect(config.options).toMatchInlineSnapshot(`
Object { Object {
"access": "public", "access": "public",
"availability": Object {
"since": "9.1.0",
"stability": "stable",
},
"summary": "Create a maintenance window.", "summary": "Create a maintenance window.",
"tags": Array [ "tags": Array [
"oas-tag:maintenance-window", "oas-tag:maintenance-window",

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/create/create_maintenance_window_route.ts vendored
View file

@ -54,6 +54,10 @@ export const createMaintenanceWindowRoute = (
access: 'public', access: 'public',
summary: 'Create a maintenance window.', summary: 'Create a maintenance window.',
tags: ['oas-tag:maintenance-window'], tags: ['oas-tag:maintenance-window'],
availability: {
since: '9.1.0',
stability: 'stable',
},
}, },
}, },
router.handleLegacyErrors( router.handleLegacyErrors(

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/delete/delete_maintenance_window_route.test.ts vendored
View file

@ -50,6 +50,10 @@ describe('deleteMaintenanceWindowRoute', () => {
expect(config.options).toMatchInlineSnapshot(` expect(config.options).toMatchInlineSnapshot(`
Object { Object {
"access": "public", "access": "public",
"availability": Object {
"since": "9.1.0",
"stability": "stable",
},
"summary": "Delete a maintenance window.", "summary": "Delete a maintenance window.",
"tags": Array [ "tags": Array [
"oas-tag:maintenance-window", "oas-tag:maintenance-window",

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/delete/delete_maintenance_window_route.ts vendored
View file

@ -50,6 +50,10 @@ export const deleteMaintenanceWindowRoute = (
access: 'public', access: 'public',
summary: 'Delete a maintenance window.', summary: 'Delete a maintenance window.',
tags: ['oas-tag:maintenance-window'], tags: ['oas-tag:maintenance-window'],
availability: {
since: '9.1.0',
stability: 'stable',
},
}, },
}, },
router.handleLegacyErrors( router.handleLegacyErrors(

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/get/get_maintenance_window_route.test.ts vendored
View file

@ -50,6 +50,10 @@ describe('getMaintenanceWindowRoute', () => {
expect(config.options).toMatchInlineSnapshot(` expect(config.options).toMatchInlineSnapshot(`
Object { Object {
"access": "public", "access": "public",
"availability": Object {
"since": "9.1.0",
"stability": "stable",
},
"summary": "Get maintenance window details.", "summary": "Get maintenance window details.",
"tags": Array [ "tags": Array [
"oas-tag:maintenance-window", "oas-tag:maintenance-window",

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/get/get_maintenance_window_route.ts vendored
View file

@ -56,6 +56,10 @@ export const getMaintenanceWindowRoute = (
access: 'public', access: 'public',
summary: 'Get maintenance window details.', summary: 'Get maintenance window details.',
tags: ['oas-tag:maintenance-window'], tags: ['oas-tag:maintenance-window'],
availability: {
since: '9.1.0',
stability: 'stable',
},
}, },
}, },
router.handleLegacyErrors( router.handleLegacyErrors(

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/unarchive/unarchive_maintenance_window_route.test.ts vendored
View file

@ -54,6 +54,10 @@ describe('unarchiveMaintenanceWindowRoute', () => {
expect(config.options).toMatchInlineSnapshot(` expect(config.options).toMatchInlineSnapshot(`
Object { Object {
"access": "public", "access": "public",
"availability": Object {
"since": "9.1.0",
"stability": "stable",
},
"summary": "Unarchive a maintenance window.", "summary": "Unarchive a maintenance window.",
"tags": Array [ "tags": Array [
"oas-tag:maintenance-window", "oas-tag:maintenance-window",

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/unarchive/unarchive_maintenance_window_route.ts vendored
View file

@ -56,6 +56,10 @@ export const unarchiveMaintenanceWindowRoute = (
access: 'public', access: 'public',
summary: 'Unarchive a maintenance window.', summary: 'Unarchive a maintenance window.',
tags: ['oas-tag:maintenance-window'], tags: ['oas-tag:maintenance-window'],
availability: {
since: '9.1.0',
stability: 'stable',
},
}, },
}, },
router.handleLegacyErrors( router.handleLegacyErrors(

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/update/update_maintenance_window_route.test.ts vendored
View file

@ -78,6 +78,10 @@ describe('updateMaintenanceWindowRoute', () => {
expect(config.options).toMatchInlineSnapshot(` expect(config.options).toMatchInlineSnapshot(`
Object { Object {
"access": "public", "access": "public",
"availability": Object {
"since": "9.1.0",
"stability": "stable",
},
"summary": "Update a maintenance window.", "summary": "Update a maintenance window.",
"tags": Array [ "tags": Array [
"oas-tag:maintenance-window", "oas-tag:maintenance-window",

4
x-pack/platform/plugins/shared/alerting/server/routes/maintenance_window/apis/external/update/update_maintenance_window_route.ts vendored
View file

@ -67,6 +67,10 @@ export const updateMaintenanceWindowRoute = (
access: 'public', access: 'public',
summary: 'Update a maintenance window.', summary: 'Update a maintenance window.',
tags: ['oas-tag:maintenance-window'], tags: ['oas-tag:maintenance-window'],
availability: {
since: '9.1.0',
stability: 'stable',
},
}, },
}, },
router.handleLegacyErrors( router.handleLegacyErrors(