Commit graph

36 commits

Author SHA1 Message Date
Kibana Machine
588d729f91
[8.12] [OAS] Adds alerts data to get rule types API (#170702) (#175339)
# Backport

This will backport the following commits from `main` to `8.12`:
- [[OAS] Adds alerts data to get rule types API
(#170702)](https://github.com/elastic/kibana/pull/170702)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-01-23T18:03:30Z","message":"[OAS]
Adds alerts data to get rule types API
(#170702)","sha":"d3c51c45ebca2c4423b7a888fa14221bfa68ef58","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","v8.12.1","v8.13.0"],"title":"[OAS]
Adds alerts data to get rule types
API","number":170702,"url":"https://github.com/elastic/kibana/pull/170702","mergeCommit":{"message":"[OAS]
Adds alerts data to get rule types API
(#170702)","sha":"d3c51c45ebca2c4423b7a888fa14221bfa68ef58"}},"sourceBranch":"main","suggestedTargetBranches":["8.12"],"targetPullRequestStates":[{"branch":"8.12","label":"v8.12.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.13.0","branchLabelMappingKey":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/170702","number":170702,"mergeCommit":{"message":"[OAS]
Adds alerts data to get rule types API
(#170702)","sha":"d3c51c45ebca2c4423b7a888fa14221bfa68ef58"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2024-01-23 12:33:38 -07:00
Lisa Cawley
9adcfd072f
[DOCS] Fix authentication types for alerting rule enable API (#171807) 2023-11-27 08:24:43 -08:00
Lisa Cawley
89dd69656c
[DOCS] Add solution selection to maintenance windows (#169441) 2023-11-03 11:36:55 -07:00
Lisa Cawley
382e3f6ec2
[DOCS] Remove OAS API previews (#168761) 2023-10-17 07:49:23 -07:00
Lisa Cawley
3a0c90d934
[DOCS] Clarify API key authorization for alerting (#161717) 2023-07-17 09:41:23 -07:00
Lisa Cawley
8afb9b086c
[DOCS] Remove deprecated action variables from rule APIs (#161216) 2023-07-06 07:49:49 -07:00
Mike Côté
5a4dd3fccd
Remove alerting_framework_heath from the alerting framework health API response (#154276)
Resolves https://github.com/elastic/kibana/issues/135035.

In this PR, I'm removing the deprecated attribute
`alerting_framework_heath` from the alerting framework health API.

## To verify

1. Start Kibana.
2. Call `/api/alerting/_health`.
3. Notice `alerting_framework_heath` is no longer part of the HTTP API
response.

---------

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
2023-04-20 07:16:27 -04:00
Tomonori Soejima
4506391efd
[DOCS] Update create_rule.asciidoc (#153734) 2023-03-27 09:20:46 -07:00
Lisa Cawley
7421a9737d
[DOCS] Create open API specification for create rule (#149565) 2023-01-26 18:07:23 -08:00
Lisa Cawley
fa68cb432b
[DOCS] Create OAS for get rule types and get alerting framework health (#148774) 2023-01-17 10:53:48 -07:00
Lisa Cawley
b254abaf08
[DOCS] Create open API specification for disable/enable rule and mute/unmute all alerts #148360 (#148494) 2023-01-10 17:01:16 -07:00
Lisa Cawley
d35296ea3b
[DOCS] Create open API specification for update rule (#147407) 2023-01-10 10:27:58 -07:00
Lisa Cawley
d862f46c2a
[DOCS] Create open API specification for find rules (#147061) 2022-12-12 11:36:44 -08:00
Lisa Cawley
8086e99478
[DOCS] Fix Rules and Connectors app labels (#145660) 2022-11-22 09:14:31 -08:00
Lisa Cawley
77742577a1
[DOCS] Edits create rule API (#142921) 2022-10-11 08:03:46 -07:00
Lisa Cawley
2d4b079f2f
[DOCS] Add prereqs to mute unmute alert APIs (#141337) 2022-09-22 13:48:12 -07:00
Lisa Cawley
ba99c7db6e
Clarify rule notification values (#140457) 2022-09-14 09:29:30 -07:00
Lee Drengenberg
031c34e947
[DOCS] Update rule name to match query my* (#139563) 2022-08-26 09:50:07 -07:00
doakalexi
0b8d2edc17
[ResponseOps][Alerting] clarify doc on mute/unmute alert instance id's (#138657)
* Updating docs

* Adding missing word

* Update docs/api/alerting/mute_alert.asciidoc

Co-authored-by: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/alerting/unmute_alert.asciidoc

Co-authored-by: Lisa Cawley <lcawley@elastic.co>

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2022-08-13 00:46:02 +09:30
Lisa Cawley
a64d9fc6ac
[DOCS] Adds prerequisites to list rule types API (#136326) 2022-07-20 10:23:04 -07:00
Lisa Cawley
3911c7e63f
[DOCS] Adds prerequisites to enable and disable rule APIs (#135369) 2022-06-29 09:56:30 -07:00
Lisa Cawley
81e8208258
[DOCS] Add prerequisites to get rule, find rule, get rule health APIs (#134865) 2022-06-22 13:25:59 -07:00
Lisa Cawley
7649b00689
[DOCS] Adds prerequisites in update rule API (#134151) 2022-06-20 08:19:38 -07:00
Lisa Cawley
9590525c57
[DOCS] Adds prerequisites to delete rule API (#134408) 2022-06-15 09:00:11 -07:00
Lisa Cawley
f1769edb19
[DOCS] Add prerequisites in create rule API (#133978) 2022-06-09 17:49:28 -07:00
Lisa Cawley
784fd55780
[DOCS] Fixes data type for fields in find rules API (#132163) 2022-05-12 12:21:16 -07:00
Lisa Cawley
d2a8ba7cf1
[DOCS] Adds info about the change in privileges when updating rules (#131993) 2022-05-11 08:05:33 -07:00
Lisa Cawley
799b257297
[DOCS] Updates deprecation text for legacy APIs (#131741) 2022-05-06 08:56:08 -07:00
Thomas P
ac7636c31b
Fix typo in alerting_framework_health field name (#120496)
* Fix type in alerting_framework_health field name

So that it's set in accordance with the documentation
https://www.elastic.co/guide/en/kibana/current/get-alerting-framework-health-api.html

* ENH: Make sure to return the older field as well to avoid breaking existing code

* DOC: Document the typo field "alerting_framework_heath"

* ENH: Add a _deprecated field in the typo field response

* fixed es lint spaces issues

* fixed more spaces issues

* fixed scope issue

* fixed scope issue

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: YulNaumenko <jo.naumenko@gmail.com>
2021-12-22 16:38:40 -08:00
ymao1
3de6de98a7
[Alerting][Docs] Review usages of Alerting vs alerting (#119314)
* Alerting vs alerting

* PR feedback

* Reverting unnecessary changes

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR feedback

* PR feedback

* Removing {kib}

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Removing {kib}

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-11-30 19:24:45 -05:00
ymao1
c05588f077
[Alerting] Enable rule import/export and allow rule types to exclude themselves from export (#102999)
* Removing feature flag changes

* Adding isExportable flag to rule type definition

* Adding isExportable flag to rule type definition

* Adding isExportable flag to rule type definition

* Filtering rule on export by rule type isExportable flag

* Fixing types

* Adding docs

* Fix condition when exportCount is 0

* Unit test for fix condition when exportCount is 0

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-28 20:35:27 -04:00
ymao1
b242765654
[Alerting][Docs] Combine rule creation and management pages (#101498)
* Combining rule management stuff into single page

* Cleaning up image widths and header sizes

* Adding in placeholder pages

* Adding in placeholder pages

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR and test fixes

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR fixes

* PR fixes

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-10 17:46:53 -04:00
ymao1
b544be6ff2
[Alerting] Return 400 Bad Request errors when creating/enabling/updating rules using API key authentication (#98088)
* Catching API key creation errors and throwing bad request errors instead

* Catching API key creation errors and throwing bad request errors instead

* Adding warning to docs

* Updating error messages

* Updating tests

* Updating warning wording in docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-27 07:46:35 -04:00
Gidi Meir Morris
1dd5e1f13d
Expands docs on List rule types API (#97608)
Corrected docs for List rule types API
2021-04-23 10:58:07 +01:00
Lisa Cawley
e285c7c214
[DOCS] Adds deprecation admonitions (#95847) 2021-03-31 14:36:48 -07:00
Mike Côté
3abb79a179
Create new alerting HTTP APIs that use the new terminology (#93977)
* Move current alert HTTP APIs to legacy folder (#93943)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Create new rule HTTP APIs (#93980)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Move current alert HTTP APIs to legacy folder (#93943)

* Move current HTTP APIs to legacy folder

* Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

* Fix failing tests and extra files

* Add necessary files

* Create rule route

* Get rule API

* Update rule API

* Delete rule route

* Aggregate rules API

* Disable rule API

* Enable rule API

* Find rules API

* Fix Update API

* Get rule alert summary API

* Get rule state API

* Health API

* Rule types API

* Mute all API

* Mute alert API

* Unmute all API

* Unmute alert route

* Update API key API

* corrected tpye by making it much more complicated

* removed unneeded cocde

* Fixes

* Add back health route

* mutedInstanceIds -> mutedAlertIds

* lastRun -> last_run

* alert_type_state -> rule_type_state & alert_instances -> alerts

Co-authored-by: Gidi Meir Morris <github@gidi.io>

* Create docs for new rule HTTP APIs, deprecate old docs (#94745)

* Create docs for new APIs, deprecate old docs

* Remove connector_type_id

* Update docs

* Add link to legacy APIs from rules API docs

* Remove connector_type_id references

* [DOCS] Add legacy APIs to index.asciidoc

* Fix camel case

Co-authored-by: lcawl <lcawley@elastic.co>

* Make alerting tests use new rules APIs (#95159)

* Make API integration tests use new HTTP APIs

* Fix end to end tests

* Fix test failures

* Fix more test failures

* Rename some files

* Add tests for legacy APIs (#95333)

* Initial commit (#95457)

* Move some new alerting APIs to /internal (#95461)

* Initial commit

* Update README.md

* Use internal API

* Merge deprecated warning w/ alternative solution

* Update API docs

Co-authored-by: Gidi Meir Morris <github@gidi.io>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: lcawl <lcawley@elastic.co>
2021-03-30 08:27:28 -04:00