Skip to content

docs(component-developer): document options.encryption_hint for JSON editor fields - #96

Merged
natocTo merged 2 commits into
mainfrom
natocTo-UT-4836-encryption-hint-docs
Aug 5, 2026
Merged

docs(component-developer): document options.encryption_hint for JSON editor fields#96
natocTo merged 2 commits into
mainfrom
natocTo-UT-4836-encryption-hint-docs

Conversation

@natocTo

@natocTo natocTo commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents options.encryption_hint, the new component-schema option shipped in keboola/ui#7627 (Linear UT-4836), in the build-component-ui UI-elements reference so Component Factory authors find the opt-out instead of reporting the hint as a component bug.

A format: editor field in application/json mode 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.
  • Patch version bump of component-developer in 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

@natocTo natocTo self-assigned this Aug 4, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@linear-code

linear-code Bot commented Aug 4, 2026

Copy link
Copy Markdown

UT-4836

@natocTo
natocTo requested review from Mystypix, jordanrburger and matyas-jirat-keboola and removed request for jordanrburger August 4, 2026 07:15
@natocTo
natocTo merged commit 8570fd4 into main Aug 5, 2026
2 checks passed
@natocTo
natocTo deleted the natocTo-UT-4836-encryption-hint-docs branch August 5, 2026 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants