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

[DOCS] Document the new revision rule field #3116

Closed
4 tasks
Tracked by #174167
banderror opened this issue Mar 31, 2023 · 0 comments · Fixed by #3313
Closed
4 tasks
Tracked by #174167

[DOCS] Document the new revision rule field #3116

banderror opened this issue Mar 31, 2023 · 0 comments · Fixed by #3313
Assignees
@benironside
Labels
Feature: Prebuilt rules Feature: Rules Team: Detections/Response Detections and Response Team: Docs v8.8.0

Comments

@banderror
Copy link
Contributor

banderror commented Mar 31, 2023 •
edited by benironside
Loading

Related issues: elastic/kibana#137164, elastic/kibana#137168, elastic/kibana#136213
Related PRs: elastic/kibana#147398, elastic/kibana#151388, elastic/kibana#153716

Summary

Document the new rule field called revision (added in elastic/kibana#147398) and its difference from the version field.

  • Update the docs for the Detections API endpoints. Include the revision field in the response specs and examples
  • Add new revision field to alert schema #3237
  • If the version field is mentioned on any page besides the REST API pages, make sure to explain the difference between version and revision
  • Consider creating a dedicated page for explaining what these two fields are and referencing it from other pages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@benironside benironside

Labels
Feature: Prebuilt rules Feature: Rules Team: Detections/Response Detections and Response Team: Docs v8.8.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documents revision field and adds a description of version field elastic/security-docs
2 participants
@banderror @benironside