diff --git a/.changeset/afraid-rules-yell.md b/.changeset/afraid-rules-yell.md new file mode 100644 index 0000000000..258a07dc89 --- /dev/null +++ b/.changeset/afraid-rules-yell.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-common': patch +--- + +Updated the backend database connection configuration schema to set the password visibility to secret diff --git a/packages/backend-common/config.d.ts b/packages/backend-common/config.d.ts index dc2e2fa133..3fd886874e 100644 --- a/packages/backend-common/config.d.ts +++ b/packages/backend-common/config.d.ts @@ -72,10 +72,22 @@ export interface Config { /** Default database client to use */ client: 'better-sqlite3' | 'sqlite3' | 'pg'; /** - * Base database connection string or Knex object + * Base database connection string, or object with individual connection properties * @visibility secret */ - connection: string | object; + connection: + | string + | Partial<{ + /** + * Password that belongs to the client User + * @visibility secret + */ + password: string; + /** + * Other connection settings + */ + [key: string]: unknown; + }>; /** Database name prefix override */ prefix?: string; /**