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

Update API docs for required_fields #5190

Merged
merged 3 commits into from
May 17, 2024
Merged

Update API docs for required_fields #5190

merged 3 commits into from
May 17, 2024

Conversation

nikitaindik
Copy link
Contributor

Epic: https://github.com/elastic/security-team/issues/1974
Related to: elastic/kibana#173594

Summary

API updates for elastic/kibana#180682.

Updates related API docs with required_field changes made in elastic/kibana#180682.

@nikitaindik nikitaindik added Team: Detections/Response Detections and Response API Feature: Rules Docset: ESS Issues that apply to docs in the Stack release v8.15.0 labels May 9, 2024
@nikitaindik nikitaindik self-assigned this May 9, 2024
@nikitaindik nikitaindik requested a review from a team as a code owner May 9, 2024 15:13
@github-actions GitHub Actions
Copy link

github-actions bot commented May 9, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@nikitaindik nikitaindik changed the title Update docs for required_fields Update API docs for required_fields May 9, 2024
@nikitaindik nikitaindik mentioned this pull request May 9, 2024
Closed
14 tasks
@joepeeples joepeeples mentioned this pull request May 9, 2024
Closed
joepeeples
joepeeples reviewed May 9, 2024
View reviewed changes
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

Thanks for preparing this PR! I added a few possible edits for consideration.

docs/detections/api/rules/rules-api-create.asciidoc Outdated Show resolved Hide resolved
docs/detections/api/rules/rules-api-update.asciidoc Outdated Show resolved Hide resolved
nikitaindik and others added 2 commits May 10, 2024 00:44
@nikitaindik @joepeeples
Update docs/detections/api/rules/rules-api-create.asciidoc
da6bc49 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@nikitaindik @joepeeples
Update docs/detections/api/rules/rules-api-update.asciidoc
41c7478 
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
@nikitaindik
Copy link
Contributor Author

Thanks @joepeeples! I have committed your suggestions.

@banderror banderror requested review from a team and dplumlee May 10, 2024 11:15
dplumlee
dplumlee approved these changes May 10, 2024
View reviewed changes
Copy link
Contributor

@dplumlee dplumlee left a comment

Choose a reason for hiding this comment

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

LGTM!

@nikitaindik nikitaindik merged commit f9012b2 into elastic:main May 17, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joepeeples joepeeples joepeeples approved these changes

@dplumlee dplumlee dplumlee approved these changes

Assignees

@nikitaindik nikitaindik

Labels
API Docset: ESS Issues that apply to docs in the Stack release Feature: Rules Team: Detections/Response Detections and Response v8.15.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nikitaindik @dplumlee @joepeeples