Skip to content

docs(config): separate data-plane API keys from management credentials - #5134

Merged
lidge-jun merged 1 commit into
devfrom
codex/5120-apikeys-data-plane-docs
Sep 19, 2026
Merged

lidge-jun merged 1 commit into
devfrom
codex/5120-apikeys-data-plane-docs

Conversation

@lidge-jun

Copy link
Copy Markdown
Owner

Summary

  • Correct the apiKeys server-configuration row in English and all seven translated copies.
  • Describe generated keys as data-plane admission credentials only and link the separate management credential reference.
  • Record the locale-alignment contract in the existing docs/release structure owner.
  • Preserve the existing runtime behavior and listener exceptions.

Closes #5120

Verification

  • rg -n "apiKeys\\?" docs-site/src/content/docs/reference/configuration/server.md docs-site/src/content/docs/{fr,ja,ko,ru,tr,zh-cn,zh-tw}/reference/configuration/server.md — exactly one row per file (8 total).
  • rg -n "management-api" ... on the same file set — every edited row links its locale management reference (8 hits on the edited rows).
  • Contradiction scan for the old claim: no hits.
  • git diff --check — clean.
  • Local tests, typecheck, install, and documentation build: NOT RUN (campaign restriction).
  • Exact-head hosted CI is required as execution evidence, including the documentation build.

Checklist

  • Scope stays focused and avoids unrelated cleanup.
  • Docs or release notes were updated when needed.
  • Security-sensitive changes were reviewed for secrets, auth, and unsafe defaults. This documentation-only change preserves the existing credential separation and introduces no secret material.

The server-configuration table in English and all seven locale copies
claimed generated apiKeys are accepted by management and data-plane
auth. Runtime rejects data-plane credentials as management tokens
(src/server/management-auth.ts). Correct each row to describe
data-plane admission only, link the locale management reference, and
record the row contract in the docs structure owner.

Closes #5120
@lidge-jun
lidge-jun requested a review from Ingwannu as a code owner September 19, 2026 08:34
@coderabbitai

coderabbitai Bot commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

Next included review available in 5 seconds.

Check out review usage here.

View limit details

Limit details: You’ve used all 10 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: lidge-jun/opencodex/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 59c8e94a-e9b1-4bac-8208-9606896bc6bd

📥 Commits

Reviewing files that changed from the base of the PR and between 52c427a and 44f8fa1.

📒 Files selected for processing (9)
  • docs-site/src/content/docs/fr/reference/configuration/server.md
  • docs-site/src/content/docs/ja/reference/configuration/server.md
  • docs-site/src/content/docs/ko/reference/configuration/server.md
  • docs-site/src/content/docs/reference/configuration/server.md
  • docs-site/src/content/docs/ru/reference/configuration/server.md
  • docs-site/src/content/docs/tr/reference/configuration/server.md
  • docs-site/src/content/docs/zh-cn/reference/configuration/server.md
  • docs-site/src/content/docs/zh-tw/reference/configuration/server.md
  • structure/ops/docs-and-release.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-19T08:36:58.549497Z 44f8fa1 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

Copy link
Copy Markdown
Contributor

✅ Deterministic PR hygiene checks passed.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 19, 2026
@lidge-jun

Copy link
Copy Markdown
Owner Author

리뷰 · 우선순위 72 / 80

이 PR은 서버 설정 표의 apiKeys 한 줄을 런타임과 같게 고칩니다. 예전 문서는 생성된 ocx_… 키가 관리 API와 데이터 플레인 둘 다에 통한다고 적었습니다. 실제로는 통하지 않습니다. src/server/management-auth.ts의 ready()는 관리 토큰이 데이터 플레인 비밀과 같으면 “management credential conflicts with a data-plane credential”로 초기화를 실패시킵니다. tests/server/server-management-auth.test.ts는 데이터 키로 /api/config를 치면 401, 관리 키로 /v1/models를 쳐도 401이 나는 걸 이미 고정해 두었습니다. 이슈 #5120이 그 틀린 설명을 고치라고 열었고, 이 PR이 영문과 번역본 일곱 개, 그리고 문서 구조 주인 structure/ops/docs-and-release.md까지 같이 맞춥니다.

고친 뜻은 어디서나 같습니다. 생성된 키는 루프백이 아닌 바인드에서 데이터 플레인 입장용입니다. 관리 API는 허가하지 않고, 관리 자격 증명은 각 로케일의 관리 API 레퍼런스로 보냅니다. 링크 여덟 개가 전부 실제 management-api.md와 짝이 맞습니다. 루프백 예외를 넓히지 않았고, 인증 코드와 테스트는 그대로입니다. types.ts/config.ts 분리와는 무관하고, 같은 주제로 열린 다른 PR은 없습니다. 이 head에서 문서 사이트 빌드는 초록입니다. 테스트 샤드 skip은 문서만 바뀌어서 맞습니다.

라인 docs-site/src/content/docs/ja/reference/configuration/server.md apiKeys 행 - 일본어 문장 안에 중국어 准入이 들어 있습니다. 같은 파일 아래쪽은 アドミッション을 씁니다. 뜻은 통하지만 일본어 독자에게는 깨진 글자로 보입니다. 머지를 막을 정도는 아닙니다.

메인테이너의 판단이 필요한 지점

  • 일본어 准入을 머지 전에 アドミッション이나 受け入れ로 고칠지, 후속으로 둘지
  • 문서 사이트 빌드가 이미 초록이니 이대로 넣을지

너의 추천
문서 사이트 빌드가 초록이면 머지하세요. 관리 API에도 통한다고 적혀 있던 설명을 런타임과 같게 고친 좁은 문서 수정입니다. 일본어 한 글자는 있으면 고치는 게 낫고, 없어도 #5120을 닫는 데 지장은 없습니다. Closes #5120이 본문에 있으니 머지하면 이슈도 같이 닫힙니다. 로컬 스위트는 돌리지 마세요.

이 댓글은 grok-bot이 작성했습니다

@lidge-jun

Copy link
Copy Markdown
Owner Author

Maintainer integration into dev under MAINTAINERS.md, bound to reviewed head 44f8fa1fdc2e0b0a1047feac21acba6dd691fa77.

All nine changed files were reviewed: eight apiKeys rows now correctly state data-plane-only admission, each locale management-reference link resolves at this tree, and the docs owner records the alignment. Runtime credentials/authentication are unchanged. No unresolved reviews or maintainer change requests were present. This is maintainer integration, not self-approval.

Exact-head run https://github.com/lidge-jun/opencodex/actions/runs/35432368404 succeeded, including docs site build, structure gate and aggregate ci. The separate enforce-target gate also succeeded. Runtime jobs were not applicable to this documentation-only diff and are not claimed as executed. Local tests/typecheck/build/install were NOT RUN.

Current base is dev; native-stack membership lookup returned empty. The unrelated runtime integration queue remains separately gated. Close #5120 only after confirmed dev landing.

@lidge-jun
lidge-jun merged commit 1b54f29 into dev Sep 19, 2026
21 checks passed
@lidge-jun
lidge-jun deleted the codex/5120-apikeys-data-plane-docs branch September 19, 2026 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant