Improves Lists API docs content #192504
Merged
Improves Lists API docs content #192504
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
natasha-moore-elastic
added
release_note:skip
|
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) |
|
Pinging @elastic/security-detection-engine (Team:Detection Engine) |
dhurley14
approved these changes
Sep 17, 2024
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
To update your PR or re-run it, just comment with: |
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#32 by improving the Lists 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). Note: Couldn’t add description for the GET /api/lists/privileges operation, since it's not documented in [ESS API docs](https://www.elastic.co/guide/en/security/8.15/security-apis.html). --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 5c58979) # Conflicts: # x-pack/test/api_integration/services/security_solution_lists_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#32 by improving the Lists 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). Note: Couldn’t add description for the GET /api/lists/privileges operation, since it's not documented in [ESS API docs](https://www.elastic.co/guide/en/security/8.15/security-apis.html). --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 5c58979) # Conflicts: # x-pack/test/api_integration/services/security_solution_lists_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#32 by improving the Lists 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). Note: Couldn’t add description for the GET /api/lists/privileges operation, since it's not documented in [ESS API docs](https://www.elastic.co/guide/en/security/8.15/security-apis.html). --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 5c58979) # Conflicts: # x-pack/test/api_integration/services/security_solution_lists_api.gen.ts
💚 All backports created successfully
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.x`: - [Improves Lists API docs content (#192504)](#192504) <!--- 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-17T11:24:07Z","message":"Improves Lists API docs content (#192504)\n\n## Summary\r\n\r\nResolves elastic/security-docs-internal#32 by\r\nimproving the Lists API docs content. Adds missing and improves existing\r\noperation summaries and operation descriptions to adhere to our [OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\nNote: Couldn’t add description for the GET /api/lists/privileges\r\noperation, since it's not documented in [ESS API\r\ndocs](https://www.elastic.co/guide/en/security/8.15/security-apis.html).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"5c5897966ab0d6caaba64d943d91d0485dde16f2","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","Team: SecuritySolution","APIDocs","Team:Detection Rule Management","Team:Detection Engine"],"number":192504,"url":"https://github.com/elastic/kibana/pull/192504","mergeCommit":{"message":"Improves Lists API docs content (#192504)\n\n## Summary\r\n\r\nResolves elastic/security-docs-internal#32 by\r\nimproving the Lists API docs content. Adds missing and improves existing\r\noperation summaries and operation descriptions to adhere to our [OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\nNote: Couldn’t add description for the GET /api/lists/privileges\r\noperation, since it's not documented in [ESS API\r\ndocs](https://www.elastic.co/guide/en/security/8.15/security-apis.html).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"5c5897966ab0d6caaba64d943d91d0485dde16f2"}},"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/192504","number":192504,"mergeCommit":{"message":"Improves Lists API docs content (#192504)\n\n## Summary\r\n\r\nResolves elastic/security-docs-internal#32 by\r\nimproving the Lists API docs content. Adds missing and improves existing\r\noperation summaries and operation descriptions to adhere to our [OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\nNote: Couldn’t add description for the GET /api/lists/privileges\r\noperation, since it's not documented in [ESS API\r\ndocs](https://www.elastic.co/guide/en/security/8.15/security-apis.html).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"5c5897966ab0d6caaba64d943d91d0485dde16f2"}}]}] 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.16`: - [Improves Lists API docs content (#192504)](#192504) <!--- 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-17T11:24:07Z","message":"Improves Lists API docs content (#192504)\n\n## Summary\r\n\r\nResolves elastic/security-docs-internal#32 by\r\nimproving the Lists API docs content. Adds missing and improves existing\r\noperation summaries and operation descriptions to adhere to our [OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\nNote: Couldn’t add description for the GET /api/lists/privileges\r\noperation, since it's not documented in [ESS API\r\ndocs](https://www.elastic.co/guide/en/security/8.15/security-apis.html).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"5c5897966ab0d6caaba64d943d91d0485dde16f2","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","Team: SecuritySolution","APIDocs","Team:Detection Rule Management","Team:Detection Engine"],"number":192504,"url":"https://github.com/elastic/kibana/pull/192504","mergeCommit":{"message":"Improves Lists API docs content (#192504)\n\n## Summary\r\n\r\nResolves elastic/security-docs-internal#32 by\r\nimproving the Lists API docs content. Adds missing and improves existing\r\noperation summaries and operation descriptions to adhere to our [OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\nNote: Couldn’t add description for the GET /api/lists/privileges\r\noperation, since it's not documented in [ESS API\r\ndocs](https://www.elastic.co/guide/en/security/8.15/security-apis.html).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"5c5897966ab0d6caaba64d943d91d0485dde16f2"}},"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/192504","number":192504,"mergeCommit":{"message":"Improves Lists API docs content (#192504)\n\n## Summary\r\n\r\nResolves elastic/security-docs-internal#32 by\r\nimproving the Lists API docs content. Adds missing and improves existing\r\noperation summaries and operation descriptions to adhere to our [OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\nNote: Couldn’t add description for the GET /api/lists/privileges\r\noperation, since it's not documented in [ESS API\r\ndocs](https://www.elastic.co/guide/en/security/8.15/security-apis.html).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"5c5897966ab0d6caaba64d943d91d0485dde16f2"}}]}] 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 Lists API docs content (#192504)](#192504) <!--- 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-17T11:24:07Z","message":"Improves Lists API docs content (#192504)\n\n## Summary\r\n\r\nResolves elastic/security-docs-internal#32 by\r\nimproving the Lists API docs content. Adds missing and improves existing\r\noperation summaries and operation descriptions to adhere to our [OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\nNote: Couldn’t add description for the GET /api/lists/privileges\r\noperation, since it's not documented in [ESS API\r\ndocs](https://www.elastic.co/guide/en/security/8.15/security-apis.html).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"5c5897966ab0d6caaba64d943d91d0485dde16f2","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","Team: SecuritySolution","APIDocs","Team:Detection Rule Management","Team:Detection Engine"],"number":192504,"url":"https://github.com/elastic/kibana/pull/192504","mergeCommit":{"message":"Improves Lists API docs content (#192504)\n\n## Summary\r\n\r\nResolves elastic/security-docs-internal#32 by\r\nimproving the Lists API docs content. Adds missing and improves existing\r\noperation summaries and operation descriptions to adhere to our [OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\nNote: Couldn’t add description for the GET /api/lists/privileges\r\noperation, since it's not documented in [ESS API\r\ndocs](https://www.elastic.co/guide/en/security/8.15/security-apis.html).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"5c5897966ab0d6caaba64d943d91d0485dde16f2"}},"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/192504","number":192504,"mergeCommit":{"message":"Improves Lists API docs content (#192504)\n\n## Summary\r\n\r\nResolves elastic/security-docs-internal#32 by\r\nimproving the Lists API docs content. Adds missing and improves existing\r\noperation summaries and operation descriptions to adhere to our [OAS\r\nstandards](https://elasticco.atlassian.net/wiki/spaces/DOC/pages/450494532/API+reference+docs).\r\n\r\nNote: Couldn’t add description for the GET /api/lists/privileges\r\noperation, since it's not documented in [ESS API\r\ndocs](https://www.elastic.co/guide/en/security/8.15/security-apis.html).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>","sha":"5c5897966ab0d6caaba64d943d91d0485dde16f2"}}]}] 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Resolves https://github.com/elastic/security-docs-internal/issues/32 by improving the Lists API docs content. Adds missing and improves existing operation summaries and operation descriptions to adhere to our OAS standards.
Note: Couldn’t add description for the GET /api/lists/privileges operation, since it's not documented in ESS API docs.