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.

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

Improves Lists API docs content #192504

Merged
merged 6 commits into from
Sep 17, 2024
Merged

Improves Lists API docs content #192504

merged 6 commits into from
Sep 17, 2024

Conversation

natasha-moore-elastic
Copy link
Contributor

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.

@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 Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. APIDocs Team:Detection Rule Management Security Detection Rule Management Team Team:Detection Engine Security Solution Detection Engine Area labels Sep 10, 2024
@natasha-moore-elastic natasha-moore-elastic self-assigned this Sep 10, 2024
@natasha-moore-elastic natasha-moore-elastic marked this pull request as ready for review September 11, 2024 08:40
@natasha-moore-elastic natasha-moore-elastic requested a review from a team as a code owner September 11, 2024 08:40
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@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)

dhurley14
dhurley14 approved these changes Sep 17, 2024
View reviewed changes
Copy link
Contributor

@dhurley14 dhurley14 left a comment

Choose a reason for hiding this comment

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

Thank you for these updates!

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

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 5c58979 into elastic:main Sep 17, 2024
41 checks passed
@natasha-moore-elastic natasha-moore-elastic deleted the api-docs-review-lists-32 branch September 17, 2024 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dhurley14 dhurley14 dhurley14 approved these changes

Assignees

@natasha-moore-elastic natasha-moore-elastic

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 Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@natasha-moore-elastic @elasticmachine @kibana-ci @dhurley14 @kibanamachine