feat(materia): document and changelog JSON functions #561
Conversation
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
✅ Review app deployedCheck how your changes look like!
|
Co-Authored-By: Pierre Zemb <contact@pierrezemb.fr> Co-Authored-By: RaspY <161023878+raspy737@users.noreply.github.com>
Co-Authored-By: Pierre Zemb <contact@pierrezemb.fr> Co-Authored-By: RaspY <161023878+raspy737@users.noreply.github.com>
RaspY737
approved these changes
Mar 13, 2025
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.
Describe your PR
Summarize your changes here : explain what, how, and why. Be as explicict as you can on why your changes are needed and avoid implicit reasoning.
This pull request includes updates to the Materia KV documentation to introduce and explain new JSON functions. The changes include a new changelog entry, updates to the list of supported commands, and detailed examples and limitations of the JSON functions.
Documentation updates:
content/changelog/2025/03-12-materia-kv-json.md: Added a new changelog entry for JSON functions in Materia KV, including new commands and a link to the documentation.content/doc/addons/materia-kv.md: AddedJSON.SET,JSON.GET, andJSON.DELcommands to the list of supported commands.Examples and usage:
content/doc/addons/materia-kv.md: Added a section with detailed examples of using JSON functions withredis-cli, including setting, getting, and deleting JSON values, as well as handling multiple paths and recursive searches.Limitations:
content/doc/addons/materia-kv.md: Documented the current limitations of the JSON functions, such as restrictions on creating new fields in existing documents and nested path creation.Checklist
Reviewers
Who should review these changes? @CleverCloud/reviewers