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

[Security][OpenAPI] Improve exceptions intro #201716

Closed
wants to merge 3 commits into from

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Nov 26, 2024

Summary

This PR copies information from https://www.elastic.co/guide/en/security/current/exceptions-api-overview.html into https://www.elastic.co/docs/api/doc/kibana/group/endpoint-security-exceptions-api

Based on https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/code_generation/security_solution_codegen.sh, I generated the output for this change by running:

cd kibana/packages/kbn-securitysolution-exceptions-common
yarn openapi:bundle
cd kibana/oas_docs
make api-docs

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

N/A

Preview

bump preview output/kibana.yaml:

image

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes docs Feature:Rule Exceptions Security Solution Detection Rule Exceptions area backport:version Backport to applied version labels v8.17.0 v8.16.2 labels Nov 26, 2024
@elasticmachine
Copy link
Contributor

🤖 Jobs for this PR can be triggered through checkboxes. 🚧

ℹ️ To trigger the CI, please tick the checkbox below 👇

  • Click to trigger kibana-pull-request for this PR!
  • Click to trigger kibana-deploy-project-from-pr for this PR!

@lcawl
Copy link
Contributor Author

lcawl commented Nov 29, 2024

Replaced by #202305

@lcawl lcawl closed this Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels docs Feature:Rule Exceptions Security Solution Detection Rule Exceptions area release_note:skip Skip the PR/issue when compiling release notes v8.16.2 v8.17.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants