[Security Solution] Improving documentations for bulk_actions#216852
[Security Solution] Improving documentations for bulk_actions#216852banderror merged 9 commits intoelastic:mainfrom
Conversation
8362e20 to
f33b1b9
Compare
|
Pinging @elastic/security-detections-response (Team:Detections and Resp) |
|
Pinging @elastic/security-solution (Team: SecuritySolution) |
|
Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management) |
e3921a0 to
ed890f3
Compare
...tion/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.schema.yaml
Outdated
Show resolved
Hide resolved
c902c00 to
657ad28
Compare
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
cc @jkelas |
|
One test job failed and I had to restart it. Other than that no more issues, and I'm gonna merge it and make sure the PR is backported. cc @jkelas |
|
Starting backport for target branches: 8.18, 8.x, 9.0 https://github.com/elastic/kibana/actions/runs/14361784508 |
…c#216852) **Resolves: elastic/security-docs#3019 ## Summary In this PR I am improving documentation for the bulk_actions endpoint. The focus is on improving descriptions of parameters and providing examples for all important situations, especially setting / adding actions. # Testing 1. cd x-pack/solutions/security/plugins/security_solution 2. yarn openapi:bundle:detections 3. Take the bundled file (docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml) and load it into bump.sh console to see the changes. 4. Compare the changes with the [Legacy documentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html) You can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/) where I deployed the generated bundled doc. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> (cherry picked from commit 9d659b7)
…c#216852) **Resolves: elastic/security-docs#3019 ## Summary In this PR I am improving documentation for the bulk_actions endpoint. The focus is on improving descriptions of parameters and providing examples for all important situations, especially setting / adding actions. # Testing 1. cd x-pack/solutions/security/plugins/security_solution 2. yarn openapi:bundle:detections 3. Take the bundled file (docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml) and load it into bump.sh console to see the changes. 4. Compare the changes with the [Legacy documentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html) You can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/) where I deployed the generated bundled doc. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> (cherry picked from commit 9d659b7)
💔 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 |
…216852) (#217717) # Backport This will backport the following commits from `main` to `9.0`: - [[Security Solution] Improving documentations for bulk_actions (#216852)](#216852) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Jacek Kolezynski","email":"jacek.kolezynski@elastic.co"},"sourceCommit":{"committedDate":"2025-04-09T16:03:19Z","message":"[Security Solution] Improving documentations for bulk_actions (#216852)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3019**\n\n## Summary\nIn this PR I am improving documentation for the bulk_actions endpoint.\nThe focus is on improving descriptions of parameters and providing\nexamples for all important situations, especially setting / adding\nactions.\n\n# Testing\n1. cd x-pack/solutions/security/plugins/security_solution\n2. yarn openapi:bundle:detections \n3. Take the bundled file\n(docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml)\nand load it into bump.sh console to see the changes.\n4. Compare the changes with the [Legacy\ndocumentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html)\n\nYou can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/)\nwhere I deployed the generated bundled doc.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"9d659b76dd31364ef5a4d4b5292f5988de1dca77","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Detections and Resp","Team: SecuritySolution","Feature:Rule Management","APIDocs","Team:Detection Rule Management","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[Security Solution] Improving documentations for bulk_actions","number":216852,"url":"https://github.com/elastic/kibana/pull/216852","mergeCommit":{"message":"[Security Solution] Improving documentations for bulk_actions (#216852)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3019**\n\n## Summary\nIn this PR I am improving documentation for the bulk_actions endpoint.\nThe focus is on improving descriptions of parameters and providing\nexamples for all important situations, especially setting / adding\nactions.\n\n# Testing\n1. cd x-pack/solutions/security/plugins/security_solution\n2. yarn openapi:bundle:detections \n3. Take the bundled file\n(docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml)\nand load it into bump.sh console to see the changes.\n4. Compare the changes with the [Legacy\ndocumentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html)\n\nYou can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/)\nwhere I deployed the generated bundled doc.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"9d659b76dd31364ef5a4d4b5292f5988de1dca77"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/216852","number":216852,"mergeCommit":{"message":"[Security Solution] Improving documentations for bulk_actions (#216852)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3019**\n\n## Summary\nIn this PR I am improving documentation for the bulk_actions endpoint.\nThe focus is on improving descriptions of parameters and providing\nexamples for all important situations, especially setting / adding\nactions.\n\n# Testing\n1. cd x-pack/solutions/security/plugins/security_solution\n2. yarn openapi:bundle:detections \n3. Take the bundled file\n(docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml)\nand load it into bump.sh console to see the changes.\n4. Compare the changes with the [Legacy\ndocumentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html)\n\nYou can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/)\nwhere I deployed the generated bundled doc.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"9d659b76dd31364ef5a4d4b5292f5988de1dca77"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Jacek Kolezynski <jacek.kolezynski@elastic.co>
…216852) (#217716) # Backport This will backport the following commits from `main` to `8.x`: - [[Security Solution] Improving documentations for bulk_actions (#216852)](#216852) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Jacek Kolezynski","email":"jacek.kolezynski@elastic.co"},"sourceCommit":{"committedDate":"2025-04-09T16:03:19Z","message":"[Security Solution] Improving documentations for bulk_actions (#216852)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3019**\n\n## Summary\nIn this PR I am improving documentation for the bulk_actions endpoint.\nThe focus is on improving descriptions of parameters and providing\nexamples for all important situations, especially setting / adding\nactions.\n\n# Testing\n1. cd x-pack/solutions/security/plugins/security_solution\n2. yarn openapi:bundle:detections \n3. Take the bundled file\n(docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml)\nand load it into bump.sh console to see the changes.\n4. Compare the changes with the [Legacy\ndocumentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html)\n\nYou can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/)\nwhere I deployed the generated bundled doc.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"9d659b76dd31364ef5a4d4b5292f5988de1dca77","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Detections and Resp","Team: SecuritySolution","Feature:Rule Management","APIDocs","Team:Detection Rule Management","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[Security Solution] Improving documentations for bulk_actions","number":216852,"url":"https://github.com/elastic/kibana/pull/216852","mergeCommit":{"message":"[Security Solution] Improving documentations for bulk_actions (#216852)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3019**\n\n## Summary\nIn this PR I am improving documentation for the bulk_actions endpoint.\nThe focus is on improving descriptions of parameters and providing\nexamples for all important situations, especially setting / adding\nactions.\n\n# Testing\n1. cd x-pack/solutions/security/plugins/security_solution\n2. yarn openapi:bundle:detections \n3. Take the bundled file\n(docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml)\nand load it into bump.sh console to see the changes.\n4. Compare the changes with the [Legacy\ndocumentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html)\n\nYou can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/)\nwhere I deployed the generated bundled doc.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"9d659b76dd31364ef5a4d4b5292f5988de1dca77"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/216852","number":216852,"mergeCommit":{"message":"[Security Solution] Improving documentations for bulk_actions (#216852)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3019**\n\n## Summary\nIn this PR I am improving documentation for the bulk_actions endpoint.\nThe focus is on improving descriptions of parameters and providing\nexamples for all important situations, especially setting / adding\nactions.\n\n# Testing\n1. cd x-pack/solutions/security/plugins/security_solution\n2. yarn openapi:bundle:detections \n3. Take the bundled file\n(docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml)\nand load it into bump.sh console to see the changes.\n4. Compare the changes with the [Legacy\ndocumentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html)\n\nYou can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/)\nwhere I deployed the generated bundled doc.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"9d659b76dd31364ef5a4d4b5292f5988de1dca77"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: Jacek Kolezynski <jacek.kolezynski@elastic.co>
…c#216852) **Resolves: elastic/security-docs#3019 ## Summary In this PR I am improving documentation for the bulk_actions endpoint. The focus is on improving descriptions of parameters and providing examples for all important situations, especially setting / adding actions. # Testing 1. cd x-pack/solutions/security/plugins/security_solution 2. yarn openapi:bundle:detections 3. Take the bundled file (docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml) and load it into bump.sh console to see the changes. 4. Compare the changes with the [Legacy documentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html) You can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/) where I deployed the generated bundled doc. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> (cherry picked from commit 9d659b7) # Conflicts: # oas_docs/output/kibana.serverless.yaml
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…216852) (#217824) # Backport This will backport the following commits from `main` to `8.18`: - [[Security Solution] Improving documentations for bulk_actions (#216852)](#216852) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Jacek Kolezynski","email":"jacek.kolezynski@elastic.co"},"sourceCommit":{"committedDate":"2025-04-09T16:03:19Z","message":"[Security Solution] Improving documentations for bulk_actions (#216852)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3019**\n\n## Summary\nIn this PR I am improving documentation for the bulk_actions endpoint.\nThe focus is on improving descriptions of parameters and providing\nexamples for all important situations, especially setting / adding\nactions.\n\n# Testing\n1. cd x-pack/solutions/security/plugins/security_solution\n2. yarn openapi:bundle:detections \n3. Take the bundled file\n(docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml)\nand load it into bump.sh console to see the changes.\n4. Compare the changes with the [Legacy\ndocumentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html)\n\nYou can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/)\nwhere I deployed the generated bundled doc.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"9d659b76dd31364ef5a4d4b5292f5988de1dca77","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Detections and Resp","Team: SecuritySolution","Feature:Rule Management","APIDocs","Team:Detection Rule Management","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[Security Solution] Improving documentations for bulk_actions","number":216852,"url":"https://github.com/elastic/kibana/pull/216852","mergeCommit":{"message":"[Security Solution] Improving documentations for bulk_actions (#216852)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3019**\n\n## Summary\nIn this PR I am improving documentation for the bulk_actions endpoint.\nThe focus is on improving descriptions of parameters and providing\nexamples for all important situations, especially setting / adding\nactions.\n\n# Testing\n1. cd x-pack/solutions/security/plugins/security_solution\n2. yarn openapi:bundle:detections \n3. Take the bundled file\n(docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml)\nand load it into bump.sh console to see the changes.\n4. Compare the changes with the [Legacy\ndocumentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html)\n\nYou can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/)\nwhere I deployed the generated bundled doc.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"9d659b76dd31364ef5a4d4b5292f5988de1dca77"}},"sourceBranch":"main","suggestedTargetBranches":["8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/217717","number":217717,"state":"MERGED","mergeCommit":{"sha":"91cdba78ba8586974f5cb317fb33e8c0cbf32e60","message":"[9.0] [Security Solution] Improving documentations for bulk_actions (#216852) (#217717)\n\n# Backport\n\nThis will backport the following commits from `main` to `9.0`:\n- [[Security Solution] Improving documentations for bulk_actions\n(#216852)](https://github.com/elastic/kibana/pull/216852)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\nCo-authored-by: Jacek Kolezynski <jacek.kolezynski@elastic.co>"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/216852","number":216852,"mergeCommit":{"message":"[Security Solution] Improving documentations for bulk_actions (#216852)\n\n**Resolves: https://github.com/elastic/security-docs/issues/3019**\n\n## Summary\nIn this PR I am improving documentation for the bulk_actions endpoint.\nThe focus is on improving descriptions of parameters and providing\nexamples for all important situations, especially setting / adding\nactions.\n\n# Testing\n1. cd x-pack/solutions/security/plugins/security_solution\n2. yarn openapi:bundle:detections \n3. Take the bundled file\n(docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml)\nand load it into bump.sh console to see the changes.\n4. Compare the changes with the [Legacy\ndocumentation](https://www.elastic.co/guide/en/security/current/rule-api-overview.html)\n\nYou can also use this [link](https://bump.sh/jkelas/doc/kibana_wip/)\nwhere I deployed the generated bundled doc.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"9d659b76dd31364ef5a4d4b5292f5988de1dca77"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/217716","number":217716,"state":"MERGED","mergeCommit":{"sha":"3fa939ea4d4b7e3ec59009782c638ccb3dda95ac","message":"[8.x] [Security Solution] Improving documentations for bulk_actions (#216852) (#217716)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.x`:\n- [[Security Solution] Improving documentations for bulk_actions\n(#216852)](https://github.com/elastic/kibana/pull/216852)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\n---------\n\nCo-authored-by: Jacek Kolezynski <jacek.kolezynski@elastic.co>"}},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Jacek Kolezynski <jacek.kolezynski@elastic.co>
|
This PR didn't make it into the latest BC. Updating the labels. |
Resolves: elastic/security-docs#3019
Summary
In this PR I am improving documentation for the bulk_actions endpoint. The focus is on improving descriptions of parameters and providing examples for all important situations, especially setting / adding actions.
Testing
You can also use this link where I deployed the generated bundled doc.