docs: document options.encryption_hint for JSON editor fields - #409
Merged
Conversation
A JSON-mode `format: editor` field stores the parsed JSON, so `#`-prefixed keys inside it are encrypted on save and the UI says so below the editor. For a field that does not hold Keboola configuration the note advertises something the component cannot use, so the UI now lets an author hide it with `options.encryption_hint: false`. Encryption behaviour itself is unchanged. Implements the docs half of keboola/ui#7627. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Mystypix
approved these changes
Aug 5, 2026
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
2 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.
Documents a new component configuration schema option shipped in keboola/ui#7627 (Linear UT-4836).
What the option does
A
format: editorfield inapplication/jsonmode stores the parsed JSON, so a#-prefixed key inside such a field really is encrypted on save — regardless of whether the property declarestype: "string"ortype: "object". The UI states this in a note below the editor.For a field whose JSON is not Keboola configuration (a vendor query filter tree, a request payload template) that note advertises an action the component cannot use: the platform encrypts the key and the component receives ciphertext. Component authors can now hide the note with
"options": { "encryption_hint": false }.Default is unchanged — the note keeps rendering wherever it does today, and the option does not change encryption behaviour in any way.
Changes
extend/component/ui-options/configuration-schema.md— one row in the Supported Options table, next tooptions.editor.extend/component/ui-options/ui-examples/configuration-schema-examples.md— a short note plus a minimal snippet in the existing Codemirror (json/sql/python..) Editor section.🤖 Generated with Claude Code