Skip to main content

SECRET_KEYWORD

@webda/content-mapper


Variable: SECRET_KEYWORD

const SECRET_KEYWORD: "x-webda-secret" = "x-webda-secret"

Defined in: packages/content-mapper/src/schema/annotations.ts:58

JSON Schema keyword marking a configuration value that must be encrypted

true marks the whole value (every string below it), a list of names marks only those children of an object: @secret password,connectionString.

Set by a @secret JSDoc tag on a property, or on a class (like SecretString) so every property typed with it is a secret. The x- prefix keeps it clear of a future standard keyword, as for x-webda-stream.