Skip to content

[Docs]: Correct apiKeys documentation to preserve management/data-plane separation #5120

Closed

Description

@lidge-jun

Documentation problem type

Incorrect documentation

Documentation location

docs-site/src/content/docs/reference/configuration/server.md:27 and translated copies

What is wrong or missing?

The apiKeys row says generated credentials authorize management and data-plane auth. Runtime rejects data credentials as management tokens: src/server/management-auth.ts:207. The canonical management reference and tests/server/server-management-auth.test.ts:780 already establish independent planes.

What should the documentation explain instead?

Describe generated apiKeys as data-plane admission credentials only and link the separate management credential instructions. This corrects prose; no authentication behavior changes.

Suggested wording or example

“Generated data-plane admission credentials. They do not authorize management APIs; management access uses its separate credential.” Preserve documented local listener exceptions rather than broadening either plane.

Additional context or attachments

Pinned source: 7864869c31c41cca9830d93540238f17df8faafb. Static documentation/source comparison only; no runtime test result is claimed.

Correct the English row and all seven translated copies carrying the same statement; link reference/management-api.md. Confirm by text scan and documentation checks. Existing runtime integration coverage is sufficient; do not alter auth code or add implementation-mirroring tests.

Checks

  • I searched existing documentation issues.
  • No secrets or personal information are included.

Activity

  1. added a commit that references this issue on Sep 19, 2026
    1b54f29
  2. lidge-jun commented on Sep 19, 2026

    @lidge-jun
    OwnerAuthor

    Resolved on dev by #5134, merge commit 1b54f2940b038e5aba0665fed2a606e30773dd35.

    English and all seven translated apiKeys rows now describe data-plane admission only and link to their existing management credential reference. The docs/release owner records this alignment; no runtime authentication behavior changed. All nine files and eight destination links were checked at exact head 44f8fa1fdc2e0b0a1047feac21acba6dd691fa77.

    Hosted documentation build, structure gate and aggregate ci passed in https://github.com/lidge-jun/opencodex/actions/runs/35432368404, and the separate enforce-target gate also passed. Event-inapplicable runtime jobs were skipped, not claimed as executions. Local suite/typecheck/build/install were NOT RUN. Actual MERGED state and dev tip were reread before closure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions