Skip to content

docs: API 문서 정합성 정리 + 미사용 내부 인증 헤더 제거 - #94

Open
bigmooon wants to merge 2 commits into
mainfrom
docs/api-contract-sync
Open

bigmooon wants to merge 2 commits into
mainfrom
docs/api-contract-sync

Conversation

@bigmooon

@bigmooon bigmooon commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

요약

문서-코드 drift 감사(2026-07-09) 결과 적용.

코드 (1줄):

  • apps/todos/ai_client.py: X-Internal-Service-Token 헤더 제거 — mongle-ai는
    X-API-Key만 검증(require_api_key)하며 이 헤더는 수신측이 읽지 않는 죽은 헤더.
    테스트도 부재 단언으로 갱신 (tests/test_todos_ai.py, 19/19 통과 확인).

문서:

  • docs/api-character-generation.md: 스튜디오 정본(mong-studio/docs/api/character-generation-api.md)과
    두 벌로 갈라져 있던 것을 정본에 병합 완료(이 사본 고유의 PUT headers 함정·503·appearance_payload 반영)
    → 포인터 스텁으로 교체 (-306줄)
  • docs/backend-api-flow.md: ①인증 헤더를 X-API-Key 단독 사실로 교정("primary 헤더 =
    X-Internal-Service-Token" 주장은 코드와 불일치했음), ②존재하지 않는 /todos/commit/
    라우트 기술을 제거 기록으로 교체(apps/todos/urls.py에 라우트 없음), ③RunPod 프록시
    User-Agent 요구사항 문서화
  • CLAUDE.md: 크로스레포 문서(../docs/) 포인터 1줄

Test plan

  • pytest tests/test_todos_ai.py — 19 passed
  • CI 그린 확인

bigmooon added 2 commits July 9, 2026 17:16
mongle-ai는 X-API-Key만 검증한다(require_api_key). 함께 보내던
X-Internal-Service-Token은 수신측이 읽지 않는 죽은 헤더라 제거.
- api-character-generation.md: 스튜디오 정본(docs/api/)으로 병합 완료, 포인터 스텁으로 교체
- backend-api-flow.md: 인증 헤더를 X-API-Key 단독 사실로 교정, 존재하지 않는
  /todos/commit/ 라우트 기술 제거, User-Agent 헤더 문서화
- CLAUDE.md: 크로스레포 문서(../docs) 포인터 추가
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