From 91145e8d30ecc9ba37479a8e92d1792bfa178dce Mon Sep 17 00:00:00 2001 From: Nikita Date: Fri, 7 Aug 2026 07:31:10 +0200 Subject: [PATCH] PRDCT-612: port options.encryption_hint from developers-docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The dev copy of these two pages was updated on 2026-08-04 (dd30fdf8, Jakub Kotek, docs half of keboola/ui#7627) — five days after the same pages merged into help. That edit exists only on developers-docs, so the delete-from-dev PR (developers-docs#406) would retire it: exactly the case Jordan flagged on the 08-05 sync, "something on a components page which we already moved, but now it exists only on developer docs — make sure that also gets handled." Ports both hunks verbatim, with two adjustments for the help side: - the `---` in the prose becomes a real em dash, per the corpus-wide sweep; - the cross-link keeps the local convention `/overview/encryption/`, matching the three existing links on neighbouring /extend/ pages. Note the audit's broken-link count goes 35 → 36 for that reason: /overview/ has not been migrated yet, so every link to it is a known forward-ref that resolves when that unit lands. The anchor #codemirror-jsonsqlpython-editor resolves today. Unblocks developers-docs#406, which is approved and only conflicts on these two files. --- .../configuration-schema/examples/index.md | 24 +++++++++++++++++++ .../ui-options/configuration-schema/index.md | 1 + 2 files changed, 25 insertions(+) diff --git a/src/content/docs/extend/component/ui-options/configuration-schema/examples/index.md b/src/content/docs/extend/component/ui-options/configuration-schema/examples/index.md index f23070a21..b56ad41a4 100644 --- a/src/content/docs/extend/component/ui-options/configuration-schema/examples/index.md +++ b/src/content/docs/extend/component/ui-options/configuration-schema/examples/index.md @@ -146,6 +146,30 @@ Allowed options: mode, placeholder, autofocus, lineNumbers lint Available modes: `text/x-sfsql`, `text/x-sql`, `text/x-plsql`, `text/x-python`, `text/x-julia`, `text/x-rsrc`, `application/json` JSON mode supports encryption. Default mode is `application/json` . You should set type base on mode (string or object). +A JSON-mode editor stores the parsed JSON, so keys prefixed with `#` inside the field are +[encrypted](/overview/encryption/) on save. The UI states this in a note below the editor. If the field does not hold +Keboola configuration (a vendor query filter, a request payload template), that note advertises something the component +cannot use — the platform would encrypt the key and the component would receive the ciphertext. Hide the note with +`options.encryption_hint: false`: + +```json +{ + "filters": { + "type": "object", + "title": "Filters", + "format": "editor", + "options": { + "editor": { + "mode": "application/json" + }, + "encryption_hint": false + } + } +} +``` + +The option only affects the note. Encryption itself is unchanged: a `#`-prefixed key is still encrypted on save. + **JsonSchema examples:** ```json diff --git a/src/content/docs/extend/component/ui-options/configuration-schema/index.md b/src/content/docs/extend/component/ui-options/configuration-schema/index.md index 34c7423be..033dd78c2 100644 --- a/src/content/docs/extend/component/ui-options/configuration-schema/index.md +++ b/src/content/docs/extend/component/ui-options/configuration-schema/index.md @@ -66,6 +66,7 @@ The following `options` keys can be used in property definitions: | `options.grid_columns` | Number of grid columns (1–12) in `grid`/`grid-strict` layouts | | `options.grid_break` | Force a new row in grid layouts | | `options.editor` | CodeMirror editor options: `mode`, `lineNumbers`, `lint`, `input_height` | +| `options.encryption_hint` | Set to `false` to hide the "properties prefixed with `#` will be encrypted" note under a JSON-mode `editor` field. See [Codemirror Editor](/extend/component/ui-options/configuration-schema/examples/#codemirror-jsonsqlpython-editor). | | `options.input_height` | Height for textarea fields (e.g., `"100px"`) | | `options.inputAttributes` | HTML input attributes (e.g., `placeholder`) | | `options.only_keys` | SSH editor variant showing only key fields |