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

[8.17] Improves Lists API docs content (#192504) #204712

Merged
merged 2 commits into from
Dec 18, 2024
Merged

[8.17] Improves Lists API docs content (#192504) #204712

merged 2 commits into from
Dec 18, 2024

Conversation

natasha-moore-elastic
Copy link
Contributor

Backport

This will backport the following commits from main to 8.17:

Questions ?

Please refer to the Backport tool documentation

@natasha-moore-elastic
Improves Lists API docs content (elastic#192504)
5f2df49 
## 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 natasha-moore-elastic enabled auto-merge (squash) December 18, 2024 10:40
@natasha-moore-elastic natasha-moore-elastic mentioned this pull request Dec 18, 2024
Merged
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

@natasha-moore-elastic natasha-moore-elastic merged commit 471a3d1 into elastic:8.17 Dec 18, 2024
8 checks passed
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

@kibanamachine kibanamachine Awaiting requested review from kibanamachine kibanamachine is a code owner

Assignees
No one assigned
Labels
backport
Projects
None yet
Milestone
No milestone
Development

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