[Detection Engine][API Docs] Update request/response examples for value lists APIs#205957
Conversation
…ssing in docs sheet
|
Pinging @elastic/security-detection-engine (Team:Detection Engine) |
yctercero
added
release_note:skip
There was a problem hiding this comment.
Thanks for adding these examples, @yctercero! There are still some parameter descriptions missing (see column B in this spreadsheet) – will that be addressed separately?
.../security/packages/kbn-securitysolution-lists-common/api/create_list/create_list.schema.yaml
Outdated
Show resolved
Hide resolved
.../security/packages/kbn-securitysolution-lists-common/api/delete_list/delete_list.schema.yaml
Outdated
Show resolved
Hide resolved
...ity/packages/kbn-securitysolution-lists-common/api/read_list_item/read_list_item.schema.yaml
Outdated
Show resolved
Hide resolved
...y/packages/kbn-securitysolution-lists-common/api/patch_list_item/patch_list_item.schema.yaml
Outdated
Show resolved
Hide resolved
...y/packages/kbn-securitysolution-lists-common/api/find_list_items/find_list_items.schema.yaml
Outdated
Show resolved
Hide resolved
…o/kibana into update_value_list_openapi_descx
…o/kibana into update_value_list_openapi_descx
…o/kibana into update_value_list_openapi_descx
…ue lists APIs (elastic#205957) # Summary As part of the effort to add missing content for Security APIs, this PR introduces a few missing request, response, and parameter examples for Detection Engine Value Lists APIs.
kibanamachine
added
the
backport missing
|
Friendly reminder: Looks like this PR hasn’t been backported yet. |
4 similar comments
|
Friendly reminder: Looks like this PR hasn’t been backported yet. |
|
Friendly reminder: Looks like this PR hasn’t been backported yet. |
|
Friendly reminder: Looks like this PR hasn’t been backported yet. |
|
Friendly reminder: Looks like this PR hasn’t been backported yet. |
|
Friendly reminder: Looks like this PR hasn’t been backported yet. |
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
|
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
|
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
1 similar comment
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…for value lists APIs (#205957) (#209691) # Backport This will backport the following commits from `main` to `8.17`: - [[Detection Engine][API Docs] Update request/response examples for value lists APIs (#205957)](#205957) <!--- Backport version: 9.6.4 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Yara Tercero","email":"yctercero@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-01-23T15:19:45Z","message":"[Detection Engine][API Docs] Update request/response examples for value lists APIs (#205957)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nDetection Engine Value Lists APIs.","sha":"e396ac9a1438fcb16c2e4f1b61c3633de098d9bf","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport missing","v9.0.0","Team:Detection Engine","v8.16.0","backport:version","v8.17.0","v8.18.0"],"title":"[Detection Engine][API Docs] Update request/response examples for value lists APIs","number":205957,"url":"https://github.com/elastic/kibana/pull/205957","mergeCommit":{"message":"[Detection Engine][API Docs] Update request/response examples for value lists APIs (#205957)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nDetection Engine Value Lists APIs.","sha":"e396ac9a1438fcb16c2e4f1b61c3633de098d9bf"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205957","number":205957,"mergeCommit":{"message":"[Detection Engine][API Docs] Update request/response examples for value lists APIs (#205957)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nDetection Engine Value Lists APIs.","sha":"e396ac9a1438fcb16c2e4f1b61c3633de098d9bf"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/209597","number":209597,"state":"OPEN"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/209586","number":209586,"state":"OPEN"},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"url":"https://github.com/elastic/kibana/pull/209462","number":209462,"branch":"8.18","state":"OPEN"}]}] BACKPORT-->
…for value lists APIs (#205957) (#209597) # Backport This will backport the following commits from `main` to `8.16`: - [[Detection Engine][API Docs] Update request/response examples for value lists APIs (#205957)](#205957) <!--- Backport version: 9.6.4 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Yara Tercero","email":"yctercero@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-01-23T15:19:45Z","message":"[Detection Engine][API Docs] Update request/response examples for value lists APIs (#205957)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nDetection Engine Value Lists APIs.","sha":"e396ac9a1438fcb16c2e4f1b61c3633de098d9bf","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport missing","v9.0.0","Team:Detection Engine","v8.16.0","backport:version","v8.17.0","v8.18.0"],"title":"[Detection Engine][API Docs] Update request/response examples for value lists APIs","number":205957,"url":"https://github.com/elastic/kibana/pull/205957","mergeCommit":{"message":"[Detection Engine][API Docs] Update request/response examples for value lists APIs (#205957)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nDetection Engine Value Lists APIs.","sha":"e396ac9a1438fcb16c2e4f1b61c3633de098d9bf"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.17","8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205957","number":205957,"mergeCommit":{"message":"[Detection Engine][API Docs] Update request/response examples for value lists APIs (#205957)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nDetection Engine Value Lists APIs.","sha":"e396ac9a1438fcb16c2e4f1b61c3633de098d9bf"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
kibanamachine
added
v8.16.4
and removed
backport missing
5 participants
Summary
As part of the effort to add missing content for Security APIs, this PR introduces a few missing request, response, and parameter examples for Detection Engine Value Lists APIs.
How to Test
Run a local preview in bump, which shows what the output will look like in our production.
cd x-pack/solutions/security/packages/kbn-securitysolution-exceptions-commonand then runnpm run openapi:generatefollowed bynpm run openapi:bundle. That last command gives you the path to the bundled file at the end that is used in the next step.bump preview x-pack/solutions/security/packages/kbn-securitysolution-lists-common/docs/openapi/ess/security_solution_lists_api_2023_10_31.bundled.schema.yaml