Skip to content

docs(drivers): say what the read path withholds from a plugin driver's config #21953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
objectstack-fleet merged 1 commit into from
Oct 6, 2026
Merged

docs(drivers): say what the read path withholds from a plugin driver's config #21953

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions content/docs/data-modeling/drivers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,18 @@ Two things live **outside** `config`, because they are not driver-specific:

A plugin-contributed driver (`com.vendor.snowflake`) has no contract in this
repo, so its `config` is left unvalidated rather than judged against a shape the
platform does not have. The platform also does not guess which of its keys hold
credentials: `config` is stored and served to administrators as written. Keeping
secrets out of it is the plugin author's responsibility; put the credential in
the bound secret (`external.credentialsRef`) instead.
platform does not have, and is stored as written. The platform also does not
guess which of its keys hold credentials. On read it withholds only what it
withholds for every driver: a key named exactly `password` or `authToken`, or
one of their former aliases (`FORMER_CREDENTIAL_ALIASES`), and, in a URL-shaped
string value, the password in its userinfo and its credential query parameters
(`CREDENTIAL_URL_QUERY_PARAM_NAMES`, such as `?password=`). Both apply at every
depth of nested objects, but not inside arrays. Everything else in `config` is
served to administrators as written (`redactDatasourceConfig` in
`datasource-credential-redaction.ts`), and a withheld value still sits in the
stored row. Keeping secrets out of `config` is the plugin author's
responsibility; put the credential in the bound secret
(`external.credentialsRef`) instead.

<Callout type="info">
The same schemas are projected to JSON Schema for
Expand Down
Loading