New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Detection Engine][Docs] Added response and request descriptions for API docs #205822

Merged

yctercero merged 20 commits into elastic:main from yctercero:update_exception_list_openapi_info

Jan 16, 2025

+7,190 −372

Contributor

yctercero commented Jan 7, 2025 •

edited by kibanamachine

Loading

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 Exception APIs.

How to Test

Run a local preview in bump, which shows what the output will look like in our production.

Install the bump CLI
cd x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common and then run npm run openapi:generate followed by npm run openapi:bundle. That last command gives you the path to the bundled file at the end that is used in the next step.
Run bump preview x-pack/solutions/security/packages/kbn-securitysolution-exceptions-common/docs/openapi/ess/security_solution_exceptions_api_2023_10_31.bundled.schema.yaml


          Added response and request descriptions per what was identified as mi…

3ba70e2

…ssing in docs sheet

yctercero requested review from a team as code owners

January 7, 2025 22:11

yctercero requested review from vitaliidm and a team

January 7, 2025 22:11

yctercero self-assigned this

yctercero added release_note:skip v9.0.0 Team:Detection Engine v8.17.0 v8.18.0 labels

Contributor

elasticmachine commented Jan 7, 2025

Pinging @elastic/security-detection-engine (Team:Detection Engine)

yctercero added the backport:version label

kibanamachine and others added 3 commits

January 7, 2025 22:25


          [CI] Auto-commit changed files from 'make api-docs'

917d27b


          Delete packages/kbn-repo-packages/package-map.json - unsure why that …

658f6a3

…was created


          Merge branch 'main' into update_exception_list_openapi_info

bf44ad1

vitaliidm reviewed

View reviewed changes

Contributor

vitaliidm left a comment

Thanks for working on this PR, @yctercero

I left a few comments.

Also, I noticed there are changes that enable/disable tests. Are these changes supposed to be in this PR?

...est_suites/lists_and_exception_lists/authorization/exceptions/lists/essentials_tier/index.ts Outdated Show resolved Hide resolved

x-pack/solutions/security/plugins/security_solution/jest.config.dev.js Outdated Show resolved Hide resolved

...curitysolution-exceptions-common/api/create_exception_list/create_exception_list.schema.yaml Show resolved Hide resolved

...curitysolution-exceptions-common/api/create_exception_list/create_exception_list.schema.yaml Show resolved Hide resolved

yctercero and others added 8 commits

January 8, 2025 16:41


          removing files from a separate task

f272c1e


          Merge branch 'main' of github.com:elastic/kibana into update_exceptio…

c2b347c

…n_list_openapi_info


          removing files from a separate task

2f7e5f8


          [CI] Auto-commit changed files from 'yarn openapi:generate'

9ff46ce


          addressing pr feedback and adding more examples


          addressing pr feedback and adding more examples

a89b2e9


          Merge branch 'update_exception_list_openapi_info' of github.com:ycter…

ae32d0f

…cero/kibana into update_exception_list_openapi_info


          Merge branch 'main' of github.com:elastic/kibana into update_exceptio…

a456111

…n_list_openapi_info

yctercero requested a review from a team as a code owner

January 9, 2025 17:40

yctercero requested review from ashokaditya and paul-tavares

January 9, 2025 17:40


          removing unnecessary changes

407e4b5

yctercero removed the request for review from a team

January 9, 2025 17:43

Contributor

kibanamachine commented Jan 21, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

1 similar comment

Contributor

kibanamachine commented Jan 22, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

viduni94 pushed a commit to viduni94/kibana that referenced this pull request


          [Detection Engine][Docs] Added response and request descriptions for …

95dd633

…API docs (elastic#205822)

# 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 Exception APIs.

Contributor

kibanamachine commented Jan 23, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

kibanamachine mentioned this pull request

[UII] Restrict non-local ES output types for agentless integrations and policies #207296

Merged

3 tasks

Contributor

kibanamachine commented Jan 24, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

5 similar comments

Contributor

kibanamachine commented Jan 27, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

Contributor

kibanamachine commented Jan 28, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

Contributor

kibanamachine commented Jan 29, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

Contributor

kibanamachine commented Jan 31, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

Contributor

kibanamachine commented Feb 3, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

kibanamachine mentioned this pull request

[SecuritySolution][Endpoint] Update request docs for isolate/release/processes #209097

Merged

9 tasks

Contributor

kibanamachine commented Feb 4, 2025

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 205822 locally

yctercero added the v8.16.0 label

This was referenced Feb 5, 2025

[8.18] [Detection Engine][Docs] Added response and request descriptions for API docs (#205822) #209692

Merged

[8.17] [Detection Engine][Docs] Added response and request descriptions for API docs (#205822) #209693

Merged

[8.16] [Detection Engine][Docs] Added response and request descriptions for API docs (#205822) #209694

Merged

Contributor Author

yctercero commented Feb 5, 2025

💚 All backports created successfully

Status	Branch	Result
✅	8.18
✅	8.17
✅	8.16

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

Questions ?

Please refer to the Backport tool documentation

kibanamachine mentioned this pull request

[Detection Engine][Docs] Updating examples to meet old ascii docs #207558

Merged

yctercero added a commit that referenced this pull request


          [8.18] [Detection Engine][Docs] Added response and request descriptio…

15d2a12

…ns for API docs (#205822) (#209692)

# Backport

This will backport the following commits from `main` to `8.18`:
- [[Detection Engine][Docs] Added response and request descriptions for
API docs (#205822)](#205822)

<!--- 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-16T20:14:08Z","message":"[Detection
Engine][Docs] Added response and request descriptions for API docs
(#205822)\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 Exception
APIs.","sha":"94660cf2f51047e09185f4965f94a34ec80915b2","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","backport:version","v8.17.0","v8.18.0"],"title":"[Detection
Engine][Docs] Added response and request descriptions for API
docs","number":205822,"url":"https://github.com/elastic/kibana/pull/205822","mergeCommit":{"message":"[Detection
Engine][Docs] Added response and request descriptions for API docs
(#205822)\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 Exception
APIs.","sha":"94660cf2f51047e09185f4965f94a34ec80915b2"}},"sourceBranch":"main","suggestedTargetBranches":["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/205822","number":205822,"mergeCommit":{"message":"[Detection
Engine][Docs] Added response and request descriptions for API docs
(#205822)\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 Exception
APIs.","sha":"94660cf2f51047e09185f4965f94a34ec80915b2"}},{"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-->

Contributor

kibanamachine commented Feb 6, 2025

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.

Contributor Author

yctercero commented Feb 6, 2025

💚 All backports created successfully

Status	Branch	Result
✅	8.16

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

Questions ?

Please refer to the Backport tool documentation

yctercero added a commit that referenced this pull request


          [8.17] [Detection Engine][Docs] Added response and request descriptio…

50cac19

…ns for API docs (#205822) (#209693)

# Backport

This will backport the following commits from `main` to `8.17`:
- [[Detection Engine][Docs] Added response and request descriptions for
API docs (#205822)](#205822)

<!--- 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-16T20:14:08Z","message":"[Detection
Engine][Docs] Added response and request descriptions for API docs
(#205822)\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 Exception
APIs.","sha":"94660cf2f51047e09185f4965f94a34ec80915b2","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","backport:version","v8.17.0","v8.18.0"],"title":"[Detection
Engine][Docs] Added response and request descriptions for API
docs","number":205822,"url":"https://github.com/elastic/kibana/pull/205822","mergeCommit":{"message":"[Detection
Engine][Docs] Added response and request descriptions for API docs
(#205822)\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 Exception
APIs.","sha":"94660cf2f51047e09185f4965f94a34ec80915b2"}},"sourceBranch":"main","suggestedTargetBranches":["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/205822","number":205822,"mergeCommit":{"message":"[Detection
Engine][Docs] Added response and request descriptions for API docs
(#205822)\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 Exception
APIs.","sha":"94660cf2f51047e09185f4965f94a34ec80915b2"}},{"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 the v8.17.2 label

Contributor Author

yctercero commented Feb 6, 2025

💚 All backports created successfully

Status	Branch	Result
✅	8.16

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

Questions ?

Please refer to the Backport tool documentation

yctercero added a commit that referenced this pull request


          [8.16] [Detection Engine][Docs] Added response and request descriptio…

4f2f9e8

…ns for API docs (#205822) (#209694)

# Backport

This will backport the following commits from `main` to `8.16`:
- [[Detection Engine][Docs] Added response and request descriptions for
API docs (#205822)](#205822)

<!--- 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-16T20:14:08Z","message":"[Detection
Engine][Docs] Added response and request descriptions for API docs
(#205822)\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 Exception
APIs.","sha":"94660cf2f51047e09185f4965f94a34ec80915b2","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","backport:version","v8.17.0","v8.18.0"],"title":"[Detection
Engine][Docs] Added response and request descriptions for API
docs","number":205822,"url":"https://github.com/elastic/kibana/pull/205822","mergeCommit":{"message":"[Detection
Engine][Docs] Added response and request descriptions for API docs
(#205822)\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 Exception
APIs.","sha":"94660cf2f51047e09185f4965f94a34ec80915b2"}},"sourceBranch":"main","suggestedTargetBranches":["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/205822","number":205822,"mergeCommit":{"message":"[Detection
Engine][Docs] Added response and request descriptions for API docs
(#205822)\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 Exception
APIs.","sha":"94660cf2f51047e09185f4965f94a34ec80915b2"}},{"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 labels

This was referenced Feb 19, 2025

[Security Solution] Improve OpenAPI specs for Lists API #183822

Closed

[Security Solution] Improve OpenAPI specs for Exceptions API #183838

Closed

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

Labels

backport:version release_note:skip Team:Detection Engine v8.16.0 v8.16.4 v8.17.0 v8.17.2 v8.18.0 v9.0.0