Skip to content

[Security Solution] Improving documentations for bulk_actions#216852

Merged
banderror merged 9 commits intoelastic:mainfrom
jkelas:3019_bulk_actions
Apr 9, 2025
Merged

[Security Solution] Improving documentations for bulk_actions#216852
banderror merged 9 commits intoelastic:mainfrom
jkelas:3019_bulk_actions

Conversation

@jkelas
Copy link
Copy Markdown
Contributor

@jkelas jkelas commented Apr 2, 2025

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

You can also use this link where I deployed the generated bundled doc.

@jkelas jkelas self-assigned this Apr 2, 2025
@jkelas jkelas added Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Rule Management Security Detection Rule Management Team release_note:skip Skip the PR/issue when compiling release notes APIDocs backport:version Backport to applied version labels 8.18 candidate v9.1.0 v8.19.0 labels Apr 2, 2025
@jkelas jkelas force-pushed the 3019_bulk_actions branch 3 times, most recently from 8362e20 to f33b1b9 Compare April 3, 2025 08:05
@jkelas jkelas marked this pull request as ready for review April 3, 2025 08:17
@jkelas jkelas requested review from a team as code owners April 3, 2025 08:17
@jkelas jkelas requested review from dhurley14 and nikitaindik April 3, 2025 08:17
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)

@jkelas jkelas requested review from banderror and removed request for nikitaindik April 3, 2025 08:24
@jkelas jkelas force-pushed the 3019_bulk_actions branch from e3921a0 to ed890f3 Compare April 3, 2025 13:51
@jkelas jkelas force-pushed the 3019_bulk_actions branch from c902c00 to 657ad28 Compare April 9, 2025 09:54
Copy link
Copy Markdown
Contributor

@banderror banderror left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jkelas Perfect, thanks for fixing the remaining issues! Looks really great - night and day compared to what we had just a few weeks ago. 💪 🙌

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Apr 9, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

cc @jkelas

@banderror
Copy link
Copy Markdown
Contributor

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

@banderror banderror merged commit 9d659b7 into elastic:main Apr 9, 2025
9 checks passed
@kibanamachine
Copy link
Copy Markdown
Contributor

Starting backport for target branches: 8.18, 8.x, 9.0

https://github.com/elastic/kibana/actions/runs/14361784508

kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Apr 9, 2025
…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)
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Apr 9, 2025
…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)
@kibanamachine
Copy link
Copy Markdown
Contributor

💔 Some backports could not be created

Status Branch Result
8.18 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.18:
- [Fleet] Fix fleet server policy creation with non es default output (#214590)
8.x
9.0

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 216852

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Apr 9, 2025
…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>
kibanamachine added a commit that referenced this pull request Apr 9, 2025
…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>
banderror pushed a commit to banderror/kibana that referenced this pull request Apr 10, 2025
…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
@banderror
Copy link
Copy Markdown
Contributor

💚 All backports created successfully

Status Branch Result
8.18

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

banderror added a commit that referenced this pull request Apr 11, 2025
…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>
@mistic mistic removed the v8.18.0 label Apr 15, 2025
@mistic
Copy link
Copy Markdown
Contributor

mistic commented Apr 15, 2025

This PR didn't make it into the latest BC. Updating the labels.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

APIDocs backport:version Backport to applied version labels Feature:Rule Management Security Solution Detection Rule Management area release_note:skip Skip the PR/issue when compiling release notes Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.18.1 v8.19.0 v9.0.0 v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Improve documentation for the bulk actions API

5 participants