Skip to content

docs: list is a non-sensitive index; secrets require get#46

Merged
acoshift merged 1 commit into
mainfrom
list-field-scoping
Jun 23, 2026
Merged

docs: list is a non-sensitive index; secrets require get#46
acoshift merged 1 commit into
mainfrom
list-field-scoping

Conversation

@acoshift

Copy link
Copy Markdown
Member

What

Documents the SPEC-list-field-scoping.md boundary: deployment.list and envgroup.list are non-sensitive indexes. The environment, mounted files, command/args, annotations and the signed log URLs require deployment.get; env-group values require envgroup.get (the list returns only a count). A role can therefore hold .list without .get and never see secrets.

Changes

  • access/roles.md — new paragraph after the permissions table: .list and .get differ in what data they return, not just scope; a deployment.list/envgroup.list-only role can enumerate without reading secrets.
  • deployments/environment-variables.md — extend "Sensitive values": the boundary is deployment.get; deployment.list never carries env, and envGroup.list returns only envCount.
  • api/conventions.md — note in the verb table that a list item can be a reduced projection of what get returns, with the deployment + env-group examples.
  • deployments/overview.md — annotate the list vs get CLI examples.

Pairs with api#110 + apiserver#202 + console#286. hugo build passes.

Document the SPEC-list-field-scoping boundary: deployment.list and
envgroup.list are non-sensitive indexes — env, mounted files,
command/args, annotations and the signed log URLs require deployment.get,
and env-group values require envgroup.get (list returns only a count).

- access/roles.md: explain that .list and .get differ in WHAT DATA they
  return, so a role can hold .list without .get and never see secrets.
- deployments/environment-variables.md: extend "Sensitive values" — the
  boundary is deployment.get, list never carries env (same for env groups).
- api/conventions.md: note that a list item can be a reduced projection of
  what get returns (deployment + env-group examples).
- deployments/overview.md: annotate the list vs get CLI examples.

Implements SPEC-list-field-scoping.md (docs). hugo build OK.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01N9FhPEapaKr4VugQBEdisj
@deploys-app deploys-app Bot temporarily deployed to pr-46 June 23, 2026 03:30 Destroyed
@deploys-app

deploys-app Bot commented Jun 23, 2026

Copy link
Copy Markdown

Preview deleted (PR closed).

@acoshift acoshift merged commit 370d9a0 into main Jun 23, 2026
1 check passed
@acoshift acoshift deleted the list-field-scoping branch June 23, 2026 03:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant