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] [DOCS] Adds conceptual content to API docs (#202305) #204119

Merged
merged 1 commit into from
Dec 13, 2024
Merged

[8.17] [DOCS] Adds conceptual content to API docs (#202305) #204119

merged 1 commit into from
Dec 13, 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
[DOCS] Adds conceptual content to API docs (elastic#202305)
1c34a0f 
## Summary

Resolves elastic/security-docs-internal#49.

In order to retire asciidoc API docs, we first need to move over any
relevant content from those docs to the API reference site. This PR adds
the relevant conceptual information from:

-
https://www.elastic.co/guide/en/security/master/exceptions-api-overview.html
-
https://www.elastic.co/guide/en/security/master/lists-api-overview.html
- https://www.elastic.co/guide/en/security/master/rule-api-overview.html

### Previews:
Bump previews expire after 30min, so I'm providing screenshots below:

Detections preview:

![detections_preview](https://github.com/user-attachments/assets/c47b9d85-b5d0-4a32-8668-dc1ae2215681)

Exceptions preview:

![exceptions_preview](https://github.com/user-attachments/assets/b3fe9139-2162-4c56-bba9-751dffa11cb4)

Lists preview:

![lists_preview](https://github.com/user-attachments/assets/1c714f17-825d-45c7-8112-cc3d25c51047)

---------

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

# Conflicts:
#	oas_docs/output/kibana.serverless.yaml
#	packages/kbn-securitysolution-lists-common/docs/openapi/ess/security_solution_lists_api_2023_10_31.bundled.schema.yaml
#	packages/kbn-securitysolution-lists-common/docs/openapi/serverless/security_solution_lists_api_2023_10_31.bundled.schema.yaml
@natasha-moore-elastic natasha-moore-elastic enabled auto-merge (squash) December 12, 2024 19:19
@natasha-moore-elastic natasha-moore-elastic mentioned this pull request Dec 12, 2024
Merged
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

maximpn
maximpn approved these changes Dec 13, 2024
View reviewed changes
Copy link
Contributor

@maximpn maximpn left a comment

Choose a reason for hiding this comment

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

Original PR was reviewed and approved earlier. Approve the backport.

@natasha-moore-elastic natasha-moore-elastic merged commit c085236 into elastic:8.17 Dec 13, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maximpn maximpn maximpn 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.
3 participants
@natasha-moore-elastic @elasticmachine @maximpn