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

[DOCS] Documentation for rule version is outdated and for rule revision is missing #3545

Open
Tracked by #200310
banderror opened this issue Jul 8, 2023 · 0 comments
Assignees

Comments

@banderror
Copy link
Contributor

banderror commented Jul 8, 2023

Epic: elastic/kibana#200310
Related to: #3116

Summary

The Update rule documentation page:

  • Lists the version field among the optional request fields. This shouldn't be the case - we shouldn't allow users to set/change the version field via CRUD and other API endpoints. The version field is managed by the server internally and can only be changed by prebuilt rule authors in a rule's source file. Here, either the doc is outdated, or we need to fix this in the app and update the docs accordingly.
  • States that If this is not provided, the rule’s version number is incremented by 1.. This is not the case anymore, because we changed the semantics of the version field, so now it tracks the version of the rule's source (content). We introduced a new field for the If this is not provided, the rule’s version number is incremented by 1. semantics, and it's called revision.

Any fixes in the app should not introduce breaking changes at the schema level (user sending a version in a request shouldn't get a 400 response).

All pages under https://www.elastic.co/guide/en/security/8.8/rule-api-overview.html that mention the version field should be updated.

Finally, the new rule revision field should be documented. Looks like it wasn't (fully?) done in #3116

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants