[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions#223053
Conversation
...olution-endpoint-exceptions-common/api/create_endpoint_list/create_endpoint_list.schema.yaml
Outdated
Show resolved
Hide resolved
…nt-exceptions-common/api/create_endpoint_list/create_endpoint_list.schema.yaml Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
.../packages/kbn-securitysolution-exceptions-common/api/model/exception_list_common.schema.yaml
Outdated
Show resolved
Hide resolved
rylnd
left a comment
There was a problem hiding this comment.
@nastasha-solomon this looks great, I just had two high-level nits:
- "e.g.
list_id" should become just "list_id", as it's the only possible value - The phrase "by using" should be replaced with something like "identified by" or "specified via" or something more clear/specific.
...dpoint-exceptions-common/api/delete_endpoint_list_item/delete_endpoint_list_item.schema.yaml
Outdated
Show resolved
Hide resolved
|
Starting backport for target branches: 8.18, 8.19, 9.0, 9.1 https://github.com/elastic/kibana/actions/runs/15983086520 |
|
Starting backport for target branches: 8.18, 8.19, 9.0, 9.1 https://github.com/elastic/kibana/actions/runs/15983093147 |
…astic#223053) ## Summary Contributes to elastic/docs-content#1636 by updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint exceptions endpoint. ## Doc updates Made the following changes to the docs for the Elastic Endpoint exceptions endpoint: - Updated descriptions and titles for the Elastic Endpoint operations to show that they should only be used for exceptions to the Elastic Endpoint rule. **Before** <img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM" src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf" /> **After** <img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM" src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042" /> - Modified the example included in the `list_id` param description. When you create a new Endpoint exception list, the `list_id` will be `endpoint_list`. **Before** <img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM" src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16" /> **After** <img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM" src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f" /> --------- Co-authored-by: Ryland Herrick <ryalnd@gmail.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 938ead0)
…astic#223053) ## Summary Contributes to elastic/docs-content#1636 by updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint exceptions endpoint. ## Doc updates Made the following changes to the docs for the Elastic Endpoint exceptions endpoint: - Updated descriptions and titles for the Elastic Endpoint operations to show that they should only be used for exceptions to the Elastic Endpoint rule. **Before** <img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM" src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf" /> **After** <img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM" src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042" /> - Modified the example included in the `list_id` param description. When you create a new Endpoint exception list, the `list_id` will be `endpoint_list`. **Before** <img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM" src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16" /> **After** <img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM" src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f" /> --------- Co-authored-by: Ryland Herrick <ryalnd@gmail.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 938ead0)
…astic#223053) ## Summary Contributes to elastic/docs-content#1636 by updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint exceptions endpoint. ## Doc updates Made the following changes to the docs for the Elastic Endpoint exceptions endpoint: - Updated descriptions and titles for the Elastic Endpoint operations to show that they should only be used for exceptions to the Elastic Endpoint rule. **Before** <img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM" src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf" /> **After** <img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM" src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042" /> - Modified the example included in the `list_id` param description. When you create a new Endpoint exception list, the `list_id` will be `endpoint_list`. **Before** <img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM" src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16" /> **After** <img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM" src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f" /> --------- Co-authored-by: Ryland Herrick <ryalnd@gmail.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 938ead0)
…astic#223053) ## Summary Contributes to elastic/docs-content#1636 by updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint exceptions endpoint. ## Doc updates Made the following changes to the docs for the Elastic Endpoint exceptions endpoint: - Updated descriptions and titles for the Elastic Endpoint operations to show that they should only be used for exceptions to the Elastic Endpoint rule. **Before** <img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM" src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf" /> **After** <img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM" src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042" /> - Modified the example included in the `list_id` param description. When you create a new Endpoint exception list, the `list_id` will be `endpoint_list`. **Before** <img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM" src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16" /> **After** <img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM" src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f" /> --------- Co-authored-by: Ryland Herrick <ryalnd@gmail.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 938ead0)
💔 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 |
…astic#223053) ## Summary Contributes to elastic/docs-content#1636 by updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint exceptions endpoint. ## Doc updates Made the following changes to the docs for the Elastic Endpoint exceptions endpoint: - Updated descriptions and titles for the Elastic Endpoint operations to show that they should only be used for exceptions to the Elastic Endpoint rule. **Before** <img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM" src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf" /> **After** <img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM" src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042" /> - Modified the example included in the `list_id` param description. When you create a new Endpoint exception list, the `list_id` will be `endpoint_list`. **Before** <img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM" src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16" /> **After** <img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM" src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f" /> --------- Co-authored-by: Ryland Herrick <ryalnd@gmail.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 938ead0)
💔 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 |
…ns (#223053) (#225923) # Backport This will backport the following commits from `main` to `9.1`: - [[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)](#223053) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Nastasha Solomon","email":"79124755+nastasha-solomon@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-06-30T20:33:23Z","message":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)\n\n## Summary\n\nContributes to elastic/docs-content#1636 by\nupdating ESS (8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions endpoint.\n\n## Doc updates\nMade the following changes to the docs for the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and titles for the Elastic Endpoint operations to\nshow that they should only be used for exceptions to the Elastic\nEndpoint rule.\n\n **Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36 20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n **After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21 50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n- Modified the example included in the `list_id` param description. When\nyou create a new Endpoint exception list, the `list_id` will be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 31 58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n **After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32 39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by: Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:version","v8.18.0","v9.1.0","v8.19.0","v9.2.0"],"title":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions","number":223053,"url":"https://github.com/elastic/kibana/pull/223053","mergeCommit":{"message":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)\n\n## Summary\n\nContributes to elastic/docs-content#1636 by\nupdating ESS (8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions endpoint.\n\n## Doc updates\nMade the following changes to the docs for the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and titles for the Elastic Endpoint operations to\nshow that they should only be used for exceptions to the Elastic\nEndpoint rule.\n\n **Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36 20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n **After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21 50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n- Modified the example included in the `list_id` param description. When\nyou create a new Endpoint exception list, the `list_id` will be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 31 58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n **After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32 39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by: Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","9.1","8.19"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.1","label":"v9.1.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/223053","number":223053,"mergeCommit":{"message":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)\n\n## Summary\n\nContributes to elastic/docs-content#1636 by\nupdating ESS (8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions endpoint.\n\n## Doc updates\nMade the following changes to the docs for the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and titles for the Elastic Endpoint operations to\nshow that they should only be used for exceptions to the Elastic\nEndpoint rule.\n\n **Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36 20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n **After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21 50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n- Modified the example included in the `list_id` param description. When\nyou create a new Endpoint exception list, the `list_id` will be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 31 58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n **After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32 39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by: Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}}]}] BACKPORT--> Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
…ns (#223053) (#225922) # Backport This will backport the following commits from `main` to `9.0`: - [[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)](#223053) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Nastasha Solomon","email":"79124755+nastasha-solomon@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-06-30T20:33:23Z","message":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)\n\n## Summary\n\nContributes to elastic/docs-content#1636 by\nupdating ESS (8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions endpoint.\n\n## Doc updates\nMade the following changes to the docs for the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and titles for the Elastic Endpoint operations to\nshow that they should only be used for exceptions to the Elastic\nEndpoint rule.\n\n **Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36 20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n **After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21 50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n- Modified the example included in the `list_id` param description. When\nyou create a new Endpoint exception list, the `list_id` will be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 31 58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n **After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32 39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by: Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:version","v8.18.0","v9.1.0","v8.19.0","v9.2.0"],"title":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions","number":223053,"url":"https://github.com/elastic/kibana/pull/223053","mergeCommit":{"message":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)\n\n## Summary\n\nContributes to elastic/docs-content#1636 by\nupdating ESS (8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions endpoint.\n\n## Doc updates\nMade the following changes to the docs for the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and titles for the Elastic Endpoint operations to\nshow that they should only be used for exceptions to the Elastic\nEndpoint rule.\n\n **Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36 20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n **After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21 50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n- Modified the example included in the `list_id` param description. When\nyou create a new Endpoint exception list, the `list_id` will be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 31 58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n **After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32 39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by: Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","9.1","8.19"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.1","label":"v9.1.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/223053","number":223053,"mergeCommit":{"message":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)\n\n## Summary\n\nContributes to elastic/docs-content#1636 by\nupdating ESS (8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions endpoint.\n\n## Doc updates\nMade the following changes to the docs for the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and titles for the Elastic Endpoint operations to\nshow that they should only be used for exceptions to the Elastic\nEndpoint rule.\n\n **Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36 20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n **After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21 50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n- Modified the example included in the `list_id` param description. When\nyou create a new Endpoint exception list, the `list_id` will be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 31 58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n **After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32 39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by: Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}}]}] BACKPORT--> Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
|
Starting backport for target branches: 8.18, 8.19, 9.0, 9.1 https://github.com/elastic/kibana/actions/runs/15985379765 |
…astic#223053) ## Summary Contributes to elastic/docs-content#1636 by updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint exceptions endpoint. ## Doc updates Made the following changes to the docs for the Elastic Endpoint exceptions endpoint: - Updated descriptions and titles for the Elastic Endpoint operations to show that they should only be used for exceptions to the Elastic Endpoint rule. **Before** <img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM" src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf" /> **After** <img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM" src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042" /> - Modified the example included in the `list_id` param description. When you create a new Endpoint exception list, the `list_id` will be `endpoint_list`. **Before** <img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM" src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16" /> **After** <img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM" src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f" /> --------- Co-authored-by: Ryland Herrick <ryalnd@gmail.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 938ead0)
💔 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 |
…ons (#223053) (#225921) # Backport This will backport the following commits from `main` to `8.18`: - [[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)](#223053) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Nastasha Solomon","email":"79124755+nastasha-solomon@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-06-30T20:33:23Z","message":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)\n\n## Summary\n\nContributes to elastic/docs-content#1636 by\nupdating ESS (8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions endpoint.\n\n## Doc updates\nMade the following changes to the docs for the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and titles for the Elastic Endpoint operations to\nshow that they should only be used for exceptions to the Elastic\nEndpoint rule.\n\n **Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36 20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n **After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21 50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n- Modified the example included in the `list_id` param description. When\nyou create a new Endpoint exception list, the `list_id` will be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 31 58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n **After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32 39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by: Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:version","v8.18.0","v9.1.0","v8.19.0","v9.2.0"],"title":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions","number":223053,"url":"https://github.com/elastic/kibana/pull/223053","mergeCommit":{"message":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)\n\n## Summary\n\nContributes to elastic/docs-content#1636 by\nupdating ESS (8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions endpoint.\n\n## Doc updates\nMade the following changes to the docs for the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and titles for the Elastic Endpoint operations to\nshow that they should only be used for exceptions to the Elastic\nEndpoint rule.\n\n **Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36 20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n **After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21 50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n- Modified the example included in the `list_id` param description. When\nyou create a new Endpoint exception list, the `list_id` will be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 31 58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n **After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32 39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by: Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","9.1","8.19"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.1","label":"v9.1.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/223053","number":223053,"mergeCommit":{"message":"[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions (#223053)\n\n## Summary\n\nContributes to elastic/docs-content#1636 by\nupdating ESS (8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions endpoint.\n\n## Doc updates\nMade the following changes to the docs for the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and titles for the Elastic Endpoint operations to\nshow that they should only be used for exceptions to the Elastic\nEndpoint rule.\n\n **Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36 20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n **After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21 50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n- Modified the example included in the `list_id` param description. When\nyou create a new Endpoint exception list, the `list_id` will be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 31 58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n **After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32 39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by: Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}}]}] BACKPORT--> --------- Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
|
Starting backport for target branches: 8.18, 8.19, 9.0, 9.1 https://github.com/elastic/kibana/actions/runs/15987331065 |
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
…point exceptions (#226316) Manually creates an 8.19 backport for #223053. Related: - elastic/docs-content#1636 - #223053 --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Summary
Contributes to elastic/docs-content#1636 by updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint exceptions endpoint.
Doc updates
Made the following changes to the docs for the Elastic Endpoint exceptions endpoint:
Updated descriptions and titles for the Elastic Endpoint operations to show that they should only be used for exceptions to the Elastic Endpoint rule.
Before

After

Modified the example included in the
list_idparam description. When you create a new Endpoint exception list, thelist_idwill beendpoint_list.Before

After
