mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00

Files

T

Thomas Kosiewski acc0890dce feat: add lint check for API key scope enum completeness (#19862 )

Added a script/linter to ensure all `policy.RBACPermissions` entries are part of the `api_key_scope` enumerated in the `coderd/database/dump.sql` file.

Fixes #19846

2025-09-24 18:06:16 +02:00

main.go

feat: add lint check for API key scope enum completeness (#19862 )

2025-09-24 18:06:16 +02:00

README.md

feat: add lint check for API key scope enum completeness (#19862 )

2025-09-24 18:06:16 +02:00

README.md

check-scopes

Validates that the DB enum api_key_scope contains every <resource>:<action> derived from coderd/rbac/policy/RBACPermissions.

Exits 0 when all scopes are present in coderd/database/dump.sql.
Exits 1 and prints missing values with suggested ALTER TYPE statements otherwise.

Usage

Ensure the schema dump is up-to-date, then run the check:

make -B gen/db   # forces DB dump regeneration
make lint/check-scopes

Or directly:

go run ./tools/check-scopes

Optional flags:

-dump path — override path to dump.sql (default coderd/database/dump.sql).

Remediation

When the tool reports missing values:

Create a DB migration extending the enum, e.g.:

ALTER TYPE api_key_scope ADD VALUE IF NOT EXISTS 'template:view_insights';

Regenerate and re-run:

make -B gen/db && make lint/check-scopes

Decide whether each new scope is public (exposed in the catalog) or internal-only (handled by the catalog task).