Skip to content

계약 문서·proto 주석 중복 정리 - #147

Merged
m-a-king merged 1 commit into
mainfrom
docs/contract-stale-cleanup
Oct 18, 2026
Merged

m-a-king merged 1 commit into
mainfrom
docs/contract-stale-cleanup

Conversation

@m-a-king

Copy link
Copy Markdown
Contributor

한눈에

계약 문서와 계약 파일 주석이 같은 말을 두 번 하던 것 정리

  • 이전: 응답 상태 매핑·타임아웃 근거·400 판정이 계약 문서와 계약 파일 주석에 각각 있음
  • 계약 문서에만 남기고 계약 파일 주석은 문서를 가리킴
  • 렌더 계약의 URL 설명을 실제 동작(https 만 허용)에 맞게 정정
  • 머지해도 서비스 배포 없음

Situation

리뷰에서 드러난 중복·모순

  • proto 전환 뒤 계약 문서와 proto 주석에 같은 문장이 2벌 남음
  • render.proto 의 url 주석이 http 도 받는다고 적혀 있으나 renderer 는 http 를 400 으로 거부함
  • 참조: 렌더 계약 proto 추가 (5단계) #119 (렌더 계약 추가)

Task

정본 한 곳 원칙 복구

  • 동작 규칙·근거는 계약 문서, 모양은 proto

Action

정리

대상 이전 이후
render.proto url 주석 http·https 만 https 만
Disposition 주석 422·502 매핑 문장 문서 1절 참조
호출자 타임아웃 옵션 주석 stale 판정 근거 문장 문서 4절 참조
ModelProbeRequest 주석 400 판정 문장 필수 표기만
문서 엔드포인트 항목 POST 경로 rpc 이름
문서 타임아웃 표 render read 20s 리터럴 render.proto 참조

Result

남은 중복

  • 문서 타임아웃 표의 core stale 60s 와 attempt 상한 2 는 proto 밖 값이라 그대로 둠

연관 이슈

- render.proto 의 url 주석을 https 만으로 정정
  - 원인: renderer 가 http 를 400 으로 거부함
- 계약 문서의 render read 20s 숫자를 render.proto 참조로 교체
- status 매핑·400 판정·타임아웃 근거는 문서 한 곳에만 남김
  - 이전: proto 주석과 문서에 같은 문장 2벌
- 엔드포인트 항목 이름을 경로에서 rpc 이름으로 교체
  - 원인: 경로의 정본은 proto 의 http_post 옵션
@m-a-king m-a-king added the docs 문서만 만지는 작업 label Oct 18, 2026
@m-a-king m-a-king self-assigned this Oct 18, 2026
@coderabbitai

coderabbitai Bot commented Oct 18, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ca6cab70-5c7a-4ef4-a99c-79a16619b861
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@m-a-king
m-a-king merged commit 95011fd into main Oct 18, 2026
6 checks passed
@m-a-king
m-a-king deleted the docs/contract-stale-cleanup branch October 18, 2026 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 문서만 만지는 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant