Skip to content

[ResponseOps][Rules] Allow users to create a snooze schedule for rule via API #210584

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
js-jankisalvi merged 39 commits into from
Mar 13, 2025
Merged

[ResponseOps][Rules] Allow users to create a snooze schedule for rule via API #210584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
ecfda99
schedule schema
js-jankisalvi Feb 7, 2025
9e92ec0
Add validations and transform
js-jankisalvi Feb 11, 2025
b0fecec
updated validations with regex and added transform for timezone
js-jankisalvi Feb 13, 2025
78c3a7d
added public snooze route
js-jankisalvi Feb 14, 2025
398e829
api description and unit test
js-jankisalvi Feb 18, 2025
c97f688
[CI] Auto-commit changed files from 'node scripts/notice'
kibanamachine Feb 18, 2025
13f7f1b
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Feb 18, 2025
78be27e
added timezone and schedule validation
js-jankisalvi Feb 19, 2025
7ad29b0
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Feb 20, 2025
d7cee14
add response schema
js-jankisalvi Feb 21, 2025
ca8e3fa
updated request and response schema with custom object
js-jankisalvi Feb 21, 2025
1b1fc53
integration tests
js-jankisalvi Feb 24, 2025
bbd5eed
cleanup
js-jankisalvi Feb 25, 2025
1242f0a
Merge branch 'main' into recuuring-schema
js-jankisalvi Feb 28, 2025
ea7d604
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Feb 28, 2025
02bdcd5
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Feb 28, 2025
d13eaef
Merge branch 'main' into recuuring-schema
js-jankisalvi Feb 28, 2025
04b2cf9
lint fix
js-jankisalvi Feb 28, 2025
1423080
Merge branch 'recuuring-schema' of https://github.com/js-jankisalvi/k…
js-jankisalvi Feb 28, 2025
f57b075
Merge branch 'main' into recuuring-schema
js-jankisalvi Mar 3, 2025
ee44c6d
Feedback 1
js-jankisalvi Mar 3, 2025
4e95eff
fix typo
js-jankisalvi Mar 3, 2025
abb2f4e
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Mar 3, 2025
31c1058
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Mar 3, 2025
23a1b2c
add check for end and occurrences
js-jankisalvi Mar 4, 2025
190edbb
remove clear snooze integration test, add days in duration regex
js-jankisalvi Mar 6, 2025
054f4a5
remove indefinite duration, use common snooze rule method
js-jankisalvi Mar 10, 2025
88cd8cd
Merge branch 'main' into recuuring-schema
js-jankisalvi Mar 10, 2025
16ee5a5
Edit descriptions
lcawl Mar 10, 2025
3cec82b
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Mar 10, 2025
0b5320f
Merge remote-tracking branch 'upstream' into recuuring-schema
js-jankisalvi Mar 12, 2025
7ada495
resolve snooze rule route internal conflict
js-jankisalvi Mar 12, 2025
af5ca48
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Mar 12, 2025
461050d
feedback 2
js-jankisalvi Mar 12, 2025
6ae2c29
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Mar 12, 2025
17f8115
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Mar 12, 2025
5563855
Merge branch 'main' into recuuring-schema
js-jankisalvi Mar 12, 2025
df69e33
update response duration to same as request format
js-jankisalvi Mar 13, 2025
e059749
add transform duration logic back
js-jankisalvi Mar 13, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
239 changes: 239 additions & 0 deletions oas_docs/bundle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4365,6 +4365,245 @@
]
}
},
"/api/alerting/rule/{id}/snooze_schedule": {
"post": {
"description": "When you snooze a rule, the rule checks continue to run but alerts will not generate actions. You can snooze for a specified period of time and schedule single or recurring downtimes.",
"operationId": "post-alerting-rule-id-snooze-schedule",
"parameters": [
{
"description": "A required header to protect against CSRF attacks",
"in": "header",
"name": "kbn-xsrf",
"required": true,
"schema": {
"example": "true",
"type": "string"
}
},
{
"description": "Identifier of the rule.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"schedule": {
"additionalProperties": false,
"properties": {
"custom": {
"additionalProperties": false,
"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,
"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"
}
},
"type": "object"
},
"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"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"schedule"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": false,
"properties": {
"body": {
"additionalProperties": false,
"properties": {
"schedule": {
"additionalProperties": false,
"properties": {
"custom": {
"additionalProperties": false,
"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,
"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"
}
},
"type": "object"
},
"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"
],
"type": "object"
},
"id": {
"description": "Identifier of the snooze schedule.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"schedule"
],
"type": "object"
}
},
"required": [
"body"
],
"type": "object"
}
}
},
"description": "Indicates a successful call."
},
"400": {
"description": "Indicates an invalid schema."
},
"403": {
"description": "Indicates that this call is forbidden."
},
"404": {
"description": "Indicates a rule with the given id does not exist."
}
},
"summary": "Schedule a snooze for the rule",
"tags": [
"alerting"
]
}
},
"/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute": {
"post": {
"operationId": "post-alerting-rule-rule-id-alert-alert-id-mute",
Expand Down
Loading