Document the commands JSON files#403
Merged
zuiderkwast merged 5 commits intoMay 2, 2024
Merged
Conversation
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## unstable #403 +/- ##
============================================
- Coverage 68.43% 68.36% -0.08%
============================================
Files 109 108 -1
Lines 61671 61563 -108
============================================
- Hits 42207 42085 -122
- Misses 19464 19478 +14 |
enjoy-binbin
approved these changes
Apr 30, 2024
Thanks Binbin! Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech> Co-authored-by: Binbin <binloveplay1314@qq.com>
stockholmux
suggested changes
Apr 30, 2024
stockholmux
left a comment
Member
There was a problem hiding this comment.
Great to see this. A couple of small issues.
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
PingXie
pushed a commit
to PingXie/valkey
that referenced
this pull request
May 2, 2024
These JSON files were originally not intended to be used directly, since they contain internals and some fiels like "acl_categories" that are not the final ACL categories. (Valkey will apply some implicit rules to compute the final ACL categories.) However, people see JSON files and use them directly anyway. So it's better to document them. In a later PR, we can get rid of all implicit ACL categories and instead populate them explicitly in the JSON files. Then, we'll add a validation (e.g. in generate-command-code.py) that the implied categories are set. --------- Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech> Co-authored-by: Binbin <binloveplay1314@qq.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
These JSON files were originally not intended to be used directly, since they
contain internals and some fiels like "acl_categories" that are not the final
ACL categories. (Valkey will apply some implicit rules to compute the final ACL
categories.) However, people see JSON files and use them directly anyway.
So it's better to document them.
In a later PR, we can get rid of all implicit ACL categories and instead populate them explicitly in the JSON files. Then, we'll add a validation (e.g. in generate-command-code.py) that the implied categories are set.