Commit graph

249 commits

Author SHA1 Message Date
Kibana Machine
f0334bf585
[8.7] [Docs] Fix curl examples in update data view api docs (#153292) (#154285)
# Backport

This will backport the following commits from `main` to `8.7`:
- [[Docs] Fix curl examples in update data view api docs
(#153292)](https://github.com/elastic/kibana/pull/153292)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Nick
Peihl","email":"nick.peihl@elastic.co"},"sourceCommit":{"committedDate":"2023-04-03T20:02:26Z","message":"[Docs]
Fix curl examples in update data view api docs (#153292)\n\n##
Summary\r\n\r\nFixes typos in the curl examples in the Update data views
API docs.\r\n\r\n[Reported by a
community\r\nuser](https://discuss.elastic.co/t/kibana-data-view-update-api-request-doesnt-work/327435/5).","sha":"95d48205924474153735ffa6a9a21e6d34b29ac3","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","Team:DataDiscovery","v8.0.2","v8.1.3","v8.2.3","backport:all-open","v8.3.3","v8.4.3","v8.5.3","v8.6.2","v8.8.0","v8.7.1"],"number":153292,"url":"https://github.com/elastic/kibana/pull/153292","mergeCommit":{"message":"[Docs]
Fix curl examples in update data view api docs (#153292)\n\n##
Summary\r\n\r\nFixes typos in the curl examples in the Update data views
API docs.\r\n\r\n[Reported by a
community\r\nuser](https://discuss.elastic.co/t/kibana-data-view-update-api-request-doesnt-work/327435/5).","sha":"95d48205924474153735ffa6a9a21e6d34b29ac3"}},"sourceBranch":"main","suggestedTargetBranches":["8.0","8.1","8.2","8.3","8.4","8.5","8.6","8.7"],"targetPullRequestStates":[{"branch":"8.0","label":"v8.0.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.1","label":"v8.1.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.2","label":"v8.2.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.3","label":"v8.3.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.4","label":"v8.4.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.5","label":"v8.5.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.6","label":"v8.6.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/153292","number":153292,"mergeCommit":{"message":"[Docs]
Fix curl examples in update data view api docs (#153292)\n\n##
Summary\r\n\r\nFixes typos in the curl examples in the Update data views
API docs.\r\n\r\n[Reported by a
community\r\nuser](https://discuss.elastic.co/t/kibana-data-view-update-api-request-doesnt-work/327435/5).","sha":"95d48205924474153735ffa6a9a21e6d34b29ac3"}},{"branch":"8.7","label":"v8.7.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Nick Peihl <nick.peihl@elastic.co>
2023-04-03 16:25:03 -04:00
Kibana Machine
09abc78fb1
[8.7] [DOCS] Update create_rule.asciidoc (#153734) (#153795)
# Backport

This will backport the following commits from `main` to `8.7`:
- [[DOCS] Update create_rule.asciidoc
(#153734)](https://github.com/elastic/kibana/pull/153734)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Tomonori
Soejima","email":"25199092+TomonoriSoejima@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-03-27T16:20:46Z","message":"[DOCS]
Update create_rule.asciidoc
(#153734)","sha":"4506391efdc78c7e421858fd14ac03e22dd859cd","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","v8.8.0","v8.6.3","v8.7.1"],"number":153734,"url":"https://github.com/elastic/kibana/pull/153734","mergeCommit":{"message":"[DOCS]
Update create_rule.asciidoc
(#153734)","sha":"4506391efdc78c7e421858fd14ac03e22dd859cd"}},"sourceBranch":"main","suggestedTargetBranches":["8.6","8.7"],"targetPullRequestStates":[{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/153734","number":153734,"mergeCommit":{"message":"[DOCS]
Update create_rule.asciidoc
(#153734)","sha":"4506391efdc78c7e421858fd14ac03e22dd859cd"}},{"branch":"8.6","label":"v8.6.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.7","label":"v8.7.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Tomonori Soejima <25199092+TomonoriSoejima@users.noreply.github.com>
2023-03-27 12:40:52 -04:00
Kibana Machine
106c835524
[8.7] [DOCS] Add stub for find case activity API (#152041) (#152370)
# Backport

This will backport the following commits from `main` to `8.7`:
- [[DOCS] Add stub for find case activity API
(#152041)](https://github.com/elastic/kibana/pull/152041)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-02-28T17:16:33Z","message":"[DOCS]
Add stub for find case activity API
(#152041)","sha":"1607f812eb50127b56b6a1bace86a76c91b6ee3c","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Cases","backport:prev-minor","v8.7.0","v8.8.0"],"number":152041,"url":"https://github.com/elastic/kibana/pull/152041","mergeCommit":{"message":"[DOCS]
Add stub for find case activity API
(#152041)","sha":"1607f812eb50127b56b6a1bace86a76c91b6ee3c"}},"sourceBranch":"main","suggestedTargetBranches":["8.7"],"targetPullRequestStates":[{"branch":"8.7","label":"v8.7.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/152041","number":152041,"mergeCommit":{"message":"[DOCS]
Add stub for find case activity API
(#152041)","sha":"1607f812eb50127b56b6a1bace86a76c91b6ee3c"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2023-02-28 12:41:53 -05:00
Christiane (Tina) Heiligers
b14af4b243
API docs: Add deprecation warning to all deprecated Saved Object APIs (#150267) 2023-02-07 09:28:13 -07:00
Jeramy Soucy
01a18df436
[Docs] Documents constraints of space id in create space API (#150379)
closes #150311

Adds wording to clarify that the space ID must be lowercase
alphanumeric, but can include underscores and hyphens. Previously this
restriction was not documented, but if these requirements are not met
the API will respond with a 400.
2023-02-06 16:31:35 -05:00
Christiane (Tina) Heiligers
3f4f1cb8c7
Adds deprecation notice to saved objects API docs (#150124)
Fix https://github.com/elastic/kibana/issues/149988
2023-02-02 11:13:45 -07:00
Kaarina Tungseth
be498a5c58
[DOCS] Fixes formatting in the Osquery manager APIs (#149871)
## Summary

Fixes the formatting of the rogue `Query parameters` sections.
2023-01-30 12:41:10 -06:00
Lisa Cawley
7421a9737d
[DOCS] Create open API specification for create rule (#149565) 2023-01-26 18:07:23 -08:00
Lisa Cawley
f78236a2e4
[DOCS] Create open API specification for run connector (#149274) 2023-01-26 08:53:47 -08:00
Jorge Sanz
fc17f49f27
Update DELETE request (#127537)
Update the `DELETE` request to use `<space_name>`.

Thanks @Erni for the nudge!

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2023-01-25 11:45:49 +01:00
Lisa Cawley
9ebb3994c8
[DOCS] Fix deduplication spelling (#149066) 2023-01-18 11:00:29 -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
4f6d0dff28
[DOCS] Create open API specification for create/update connector (#148691) 2023-01-17 10:31: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
a077a1d468
[DOCS] Create open API specification for delete/get connectors (#148360) 2023-01-10 10:58:58 -08: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
e1227a3fe9
[DOCS] Add assignees query parameter to find cases API (#146087) 2022-11-29 08:46:49 -08:00
Lisa Cawley
94b67781e8
Add open API specification for list connector types (#145951) 2022-11-24 11:30:51 -07:00
Lisa Cawley
876f1b9ac8
[DOCS] Alert limit for cases (#145950) 2022-11-24 17:56:45 +01:00
Lisa Cawley
8086e99478
[DOCS] Fix Rules and Connectors app labels (#145660) 2022-11-22 09:14:31 -08:00
Lisa Cawley
74198264e1
[DOCS] Clarify alertId and index in add comment API (#145189) 2022-11-18 17:56:37 +01:00
Lisa Cawley
caab55fbbf
[DOCS] Add Opsgenie to run connector API (#145311) 2022-11-17 15:52:22 -08:00
Lisa Cawley
e957314ae4
[DOCS] Add Opsgenie to create and update connector APIs (#145197) 2022-11-15 11:23:46 -08:00
Thom Heymann
2e7b789a30
Document update objects spaces API (#145109)
Resolves #133149

## Summary

Document update objects spaces API

Co-authored-by: Jeramy Soucy <jeramy.soucy@elastic.co>
2022-11-15 16:55:58 +00:00
Lisa Cawley
5348e39a36
[DOCS] Automate final case APIs (#145007) 2022-11-14 19:19:40 -07:00
Lisa Cawley
6804cffc5f
[DOCS] Automate docs for get case APIs (#144950) 2022-11-10 08:27:33 -08:00
Lisa Cawley
9bf262dd1c
[DOCS] Automate docs for push case and case case config APIs (#144657) 2022-11-08 09:34:52 -08:00
Lisa Cawley
6eb02d096f
[DOCS] Add assignees to case APIs (#143610) 2022-10-20 11:32:10 -07:00
Lisa Cawley
f92c76c86f
[DOCS] Automate docs for create/update/delete case APIs (#142929) 2022-10-18 16:09:57 -07:00
Lisa Cawley
77742577a1
[DOCS] Edits create rule API (#142921) 2022-10-11 08:03:46 -07:00
Lisa Cawley
2d8b29ed5a
[DOCS] Automate output for 4 case APIs (#142173) 2022-10-05 09:24:04 -07:00
Sébastien Loix
0e6fa006c1
[SavedObjectClient] Add support to exclude references when searching (#142479) 2022-10-04 04:19:22 -07:00
Lisa Cawley
1be987e66a
[DOCS] Link to open API specification from ML sync API (#142136) 2022-09-29 08:29:07 -07:00
Matthew Kime
3c04a1f212
[data views] Allow data view rename via rest api (#141869)
* allow rename of data view via rest api
2022-09-27 06:56:46 -05:00
Lisa Cawley
2d4b079f2f
[DOCS] Add prereqs to mute unmute alert APIs (#141337) 2022-09-22 13:48:12 -07:00
Christiane (Tina) Heiligers
8bfe338d73
Documents saved objects bulk delete API (#141164)
Co-authored-by: Rudolf Meijering <skaapgif@gmail.com>
2022-09-22 07:06:27 -07:00
Lisa Cawley
4af903daf0
[DOCS] Augment run connector API with Swimlane details (#140340) 2022-09-21 13:09:52 -07:00
Lisa Cawley
ba99c7db6e
Clarify rule notification values (#140457) 2022-09-14 09:29:30 -07:00
Lisa Cawley
efbf9e4d31
[DOCS] Augment create and run connector APIs with ServiceNow details (#140348) 2022-09-13 07:35:21 -07:00
Lisa Cawley
cfe8ec26ad
[DOCS] Augment create connector API (#139876) 2022-09-06 13:22:02 -04:00
Lisa Cawley
68e0a2aab2
[DOCS] Add Webhook - Case Management connector to case APIs (#138583) 2022-08-31 11:06:40 +03:00
Lisa Cawley
2dea72f226
Add openAPI specifications for push case API (#137549) 2022-08-26 19:56:07 -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
01f8c7c4f2
[DOCS] Add missing collapsible sections in case APIs (#138588) 2022-08-11 09:11:42 -07:00
Patryk Kopyciński
33689abc77
[Osquery] Add docs for Osquery API (#137162) 2022-08-09 18:43:31 +02:00
Tim Sullivan
f5133d449c
[Data Views] Documentation for create data view REST API (#138068)
* data view rest api request body field documentation

* document sub-fields of the api request body

* add examples of different ways to create the data view

* switch order of 2 examples

* Update docs/api/data-views/create.asciidoc

* data_view properties documentation

* update documentation

* fix broken link

* Apply suggestions from code review

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* Update docs/api/data-views/create.asciidoc

* Update docs/api/data-views/create.asciidoc

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
2022-08-09 06:44:47 -07:00
Lisa Cawley
e19714a17e
Adds openAPI spec for get alerts endpoint (#137332) 2022-07-28 08:44:30 -07:00
Lisa Cawley
0d12e2dd3c
[DOCS] More edits to the automated ml sync API docs (#137242) 2022-07-28 08:41:22 -07:00