Skip to content

docs: feature/4321 환경별 API 가이드 동기화 (백업 복제 리전 노출 정합화)#353

Open
haung921209 wants to merge 4 commits into
alphafrom
feature/4321
Open

docs: feature/4321 환경별 API 가이드 동기화 (백업 복제 리전 노출 정합화)#353
haung921209 wants to merge 4 commits into
alphafrom
feature/4321

Conversation

@haung921209
Copy link
Copy Markdown
Contributor

개요

nc-rds feature/4321 의 API 가이드 생성기 출력으로 ko/api-guide-v3.0*, ko/api-guide-v4.0* 전 환경(public/gov/ncgn/ngovc/ngoic/ngsc/ninc) 가이드를 동기화합니다.

핵심 변경

  • 백업 복제 리전(replicationRegion) / 리전 코드 노출을 (engine × realm) 가용 리전으로 정합화
    • public: KR1/KR2/JP1
    • gov, ncgn: KR1
    • ngovc, ngoic, ngsc, ninc: KR4
  • 기존 gov/ncgn 가이드에서 잘못 노출되던 KR2/JP1 제거
  • 가용 리전 근거: 배포 환경 config 의 region.master-regionregion.slave-regions (런타임 RegionProperties.getAllRegions() 와 동일)

참고

  • 생성기 기준 전체 재생성이라, 리전 외에도 표 정렬/문구/섹션 순서 등 포맷 차이가 diff 에 포함됩니다(생성기를 source of truth 로 통일).
  • 대상: ko 한국어 가이드만. (en 영문은 별도)
  • v2.0 가이드는 생성기 비대상이라 미변경.

- nc-rds feature/4321 의 API 가이드 생성기 출력으로 ko/api-guide-v3.0*, v4.0* 갱신
- 백업 복제 리전(replicationRegion)/리전 코드 노출을 (engine × realm) 가용 리전으로 정합화
  - public: KR1/KR2/JP1, gov·ncgn: KR1, ngovc·ngoic·ngsc·ninc: KR4
  - 기존 gov/ncgn 가이드의 잘못된 KR2/JP1 노출 제거
- 생성기 기준으로 전체 재생성하여 포맷/문구 차이 포함
- 섹션 순서: 프로젝트 정보(리전 목록) 등 의미순으로 재정렬, 가용성 영역은 끝으로
- v3.0 인증 헤더를 User Access Key ID/Secret(X-TC-AUTHENTICATION-*)로 분리(v4.0은 Bearer 유지)
- v3.0 데이터 스토리지 섹션 병합(storages)
- build.js: mysql api-guide-v3.0/v4.0 을 exclusionDocs에 추가(생성기 산출물 보존, 템플릿 재생성 방지)
- RDS/mariadb/ko/api-guide-v4.0(.gov) 섹션 순서·백업 복제 리전(KR1) 정합화
- build.js mariadb config exclusionDocs에 api-guide-v4.0 추가(생성기 산출물 보존)
- nhn-api-codex 1.0.1 적용으로 배열 응답 예시에 모든 필드 표기(이전엔 마지막 필드만)
- 서브넷 식별자(subnetId) 형식을 UUID로 표기
- mysql ko/ 전 환경(v3.0/v4.0) 및 mariadb/ko/ v4.0 재생성 반영
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