Skip to content

Adds description of new key_def functions #5131

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

Merged
merged 4 commits into from
May 27, 2025

Conversation

AArdeev
Copy link
Contributor

@AArdeev AArdeev commented May 26, 2025

  • Since 3.1.0, new functions are added to key_def module.
  • Functions compare data against the key_def object
  • validate_key(key) - validates input key against the rules
  • validate_full_key(key) - validates input key's all fields against the rules
  • compare_keys(key_a, key_b) - Compares two keys against each other and the rules
  • validate_tuple(tuple) - validates the tuple against the rules
  • Fixes Document key validation and comparison key_def module functions #4111

…t the ```key_def``` object rules

Since 3.1.0, new functions are added to ```key_def``` module.
```validate_key(key)``` - validates input key against the rules
```validate_full_key(key)``` - validates input key's all fields against the rules
```compare_keys(key_a, key_b)``` - Compares two keys against each other and the rules
```validate_tuple(tuple)``` - validates the tuple against the rules
Fixes #4111
@AArdeev AArdeev requested a review from locker May 26, 2025 13:42
@AArdeev AArdeev self-assigned this May 26, 2025
@AArdeev AArdeev requested a review from locker May 27, 2025 11:05
@AArdeev AArdeev merged commit 5616c49 into latest May 27, 2025
1 check passed
@AArdeev AArdeev deleted the AArdeev/gh-4111-add-key-def-functions branch May 27, 2025 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document key validation and comparison key_def module functions
2 participants