Skip to content
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.

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

Improves Endpoint exceptions API content #193172

Conversation

natasha-moore-elastic
Copy link
Contributor

Summary

Resolves https://github.com/elastic/security-docs-internal/issues/34 by improving the Endpoint exceptions API docs content. Adds missing and improves existing operation summaries and operation descriptions to adhere to our OAS standards.

@natasha-moore-elastic natasha-moore-elastic added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting docs Team:Detections and Resp Security Detection Response Team APIDocs Team:Detection Rule Management Security Detection Rule Management Team Team:Detection Engine Security Solution Detection Engine Area labels Sep 17, 2024
@natasha-moore-elastic natasha-moore-elastic self-assigned this Sep 17, 2024
@natasha-moore-elastic natasha-moore-elastic marked this pull request as ready for review September 17, 2024 13:52
@natasha-moore-elastic natasha-moore-elastic requested a review from a team as a code owner September 17, 2024 13:53
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

The CI Stats report is too large to be displayed here, check out the CI build annotation for this information.

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @natasha-moore-elastic

@natasha-moore-elastic natasha-moore-elastic merged commit 59a0ca2 into elastic:main Sep 18, 2024
39 checks passed
natasha-moore-elastic added a commit to natasha-moore-elastic/kibana that referenced this pull request Dec 18, 2024
## Summary

Resolves elastic/security-docs-internal#34 by
improving the Endpoint exceptions API docs content. Adds missing and
improves existing operation summaries and operation descriptions to
adhere to our [OAS
standards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 59a0ca2)

# Conflicts:
#	packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/ess/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml
#	packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/serverless/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml
#	x-pack/test/api_integration/services/security_solution_endpoint_exceptions_api.gen.ts
natasha-moore-elastic added a commit to natasha-moore-elastic/kibana that referenced this pull request Dec 18, 2024
## Summary

Resolves elastic/security-docs-internal#34 by
improving the Endpoint exceptions API docs content. Adds missing and
improves existing operation summaries and operation descriptions to
adhere to our [OAS
standards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 59a0ca2)

# Conflicts:
#	packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/ess/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml
#	packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/serverless/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml
#	x-pack/test/api_integration/services/security_solution_endpoint_exceptions_api.gen.ts
natasha-moore-elastic added a commit to natasha-moore-elastic/kibana that referenced this pull request Dec 18, 2024
## Summary

Resolves elastic/security-docs-internal#34 by
improving the Endpoint exceptions API docs content. Adds missing and
improves existing operation summaries and operation descriptions to
adhere to our [OAS
standards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 59a0ca2)

# Conflicts:
#	packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/ess/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml
#	packages/kbn-securitysolution-endpoint-exceptions-common/docs/openapi/serverless/security_solution_endpoint_exceptions_api_2023_10_31.bundled.schema.yaml
#	x-pack/test/api_integration/services/security_solution_endpoint_exceptions_api.gen.ts
@natasha-moore-elastic
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.x
8.17
8.16

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

Questions ?

Please refer to the Backport tool documentation

natasha-moore-elastic added a commit that referenced this pull request Dec 18, 2024
# Backport

This will backport the following commits from `main` to `8.16`:
- [Improves Endpoint exceptions API content
(#193172)](#193172)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"natasha-moore-elastic","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-18T09:45:04Z","message":"Improves
Endpoint exceptions API content (#193172)\n\n## Summary\r\n\r\nResolves
elastic/security-docs-internal#34
by\r\nimproving the Endpoint exceptions API docs content. Adds missing
and\r\nimproves existing operation summaries and operation descriptions
to\r\nadhere to our
[OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"59a0ca244219c701e0c2e80877ff0b6406227c13","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:skip","v9.0.0","docs","Team:Detections
and Resp","APIDocs","Team:Detection Rule Management","Team:Detection
Engine"],"number":193172,"url":"https://github.com/elastic/kibana/pull/193172","mergeCommit":{"message":"Improves
Endpoint exceptions API content (#193172)\n\n## Summary\r\n\r\nResolves
elastic/security-docs-internal#34
by\r\nimproving the Endpoint exceptions API docs content. Adds missing
and\r\nimproves existing operation summaries and operation descriptions
to\r\nadhere to our
[OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"59a0ca244219c701e0c2e80877ff0b6406227c13"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193172","number":193172,"mergeCommit":{"message":"Improves
Endpoint exceptions API content (#193172)\n\n## Summary\r\n\r\nResolves
elastic/security-docs-internal#34
by\r\nimproving the Endpoint exceptions API docs content. Adds missing
and\r\nimproves existing operation summaries and operation descriptions
to\r\nadhere to our
[OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"59a0ca244219c701e0c2e80877ff0b6406227c13"}}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Dec 18, 2024
# Backport

This will backport the following commits from `main` to `8.17`:
- [Improves Endpoint exceptions API content
(#193172)](#193172)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"natasha-moore-elastic","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-18T09:45:04Z","message":"Improves
Endpoint exceptions API content (#193172)\n\n## Summary\r\n\r\nResolves
elastic/security-docs-internal#34
by\r\nimproving the Endpoint exceptions API docs content. Adds missing
and\r\nimproves existing operation summaries and operation descriptions
to\r\nadhere to our
[OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"59a0ca244219c701e0c2e80877ff0b6406227c13","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:skip","v9.0.0","docs","Team:Detections
and Resp","APIDocs","Team:Detection Rule Management","Team:Detection
Engine"],"number":193172,"url":"https://github.com/elastic/kibana/pull/193172","mergeCommit":{"message":"Improves
Endpoint exceptions API content (#193172)\n\n## Summary\r\n\r\nResolves
elastic/security-docs-internal#34
by\r\nimproving the Endpoint exceptions API docs content. Adds missing
and\r\nimproves existing operation summaries and operation descriptions
to\r\nadhere to our
[OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"59a0ca244219c701e0c2e80877ff0b6406227c13"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193172","number":193172,"mergeCommit":{"message":"Improves
Endpoint exceptions API content (#193172)\n\n## Summary\r\n\r\nResolves
elastic/security-docs-internal#34
by\r\nimproving the Endpoint exceptions API docs content. Adds missing
and\r\nimproves existing operation summaries and operation descriptions
to\r\nadhere to our
[OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"59a0ca244219c701e0c2e80877ff0b6406227c13"}}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <[email protected]>
natasha-moore-elastic added a commit that referenced this pull request Dec 18, 2024
# Backport

This will backport the following commits from `main` to `8.x`:
- [Improves Endpoint exceptions API content
(#193172)](#193172)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"natasha-moore-elastic","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-18T09:45:04Z","message":"Improves
Endpoint exceptions API content (#193172)\n\n## Summary\r\n\r\nResolves
elastic/security-docs-internal#34
by\r\nimproving the Endpoint exceptions API docs content. Adds missing
and\r\nimproves existing operation summaries and operation descriptions
to\r\nadhere to our
[OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"59a0ca244219c701e0c2e80877ff0b6406227c13","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:skip","v9.0.0","docs","Team:Detections
and Resp","APIDocs","Team:Detection Rule Management","Team:Detection
Engine"],"number":193172,"url":"https://github.com/elastic/kibana/pull/193172","mergeCommit":{"message":"Improves
Endpoint exceptions API content (#193172)\n\n## Summary\r\n\r\nResolves
elastic/security-docs-internal#34
by\r\nimproving the Endpoint exceptions API docs content. Adds missing
and\r\nimproves existing operation summaries and operation descriptions
to\r\nadhere to our
[OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"59a0ca244219c701e0c2e80877ff0b6406227c13"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193172","number":193172,"mergeCommit":{"message":"Improves
Endpoint exceptions API content (#193172)\n\n## Summary\r\n\r\nResolves
elastic/security-docs-internal#34
by\r\nimproving the Endpoint exceptions API docs content. Adds missing
and\r\nimproves existing operation summaries and operation descriptions
to\r\nadhere to our
[OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"59a0ca244219c701e0c2e80877ff0b6406227c13"}}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIDocs backport:skip This commit does not require backporting docs release_note:skip Skip the PR/issue when compiling release notes Team:Detection Engine Security Solution Detection Engine Area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team v8.16.3 v8.17.1 v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants