docs(component-developer): document options.encryption_hint for JSON editor fields - #96
Merged
Merged
Conversation
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
natocTo
requested review from
Mystypix,
jordanrburger and
matyas-jirat-keboola
and removed request for
jordanrburger
August 4, 2026 07:15
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
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.
Summary
Documents
options.encryption_hint, the new component-schema option shipped in keboola/ui#7627 (Linear UT-4836), in thebuild-component-uiUI-elements reference so Component Factory authors find the opt-out instead of reporting the hint as a component bug.A
format: editorfield inapplication/jsonmode stores the parsed JSON, so a#-prefixed key inside it really is encrypted on save — regardless of the declared type. Where the JSON is not Keboola configuration (a vendor filter tree, a payload template), the note advertises an action the component cannot use."options": { "encryption_hint": false }hides the note; encryption behaviour is unchanged.references/ui-elements.md— one row in Editor Options, one bullet under Code Editor Modes.component-developerin the plugin manifest and marketplace.Platform-side docs (Supported Options table): keboola/developers-docs#409
Link to Devin session: https://app.devin.ai/sessions/bad65a351c774d9d9d23e7684c7c68ac
Requested by: @natocTo