REST API 리소스 문서화

GitLab REST API 리소스를 Markdown으로 문서화하는 방법과 스타일 가이드를 설명합니다.

REST API 리소스는 /doc/api 아래에 Markdown으로 문서화됩니다. 각 리소스는 자체 Markdown 파일을 가지며, 이 파일은 api_resources.md 에서 링크됩니다. Markdown 또는 API 코드를 수정할 때는 bin/rake gitlab:openapi:v2:generate 및 bin/rake gitlab:openapi:v3:generate 를 실행하여 해당 OpenAPI 정의 도 업데이트하세요. OpenAPI 정의의 업데이트 필요 여부를 확인하려면 bin/rake gitlab:openapi:v2:check_docs 및 bin/rake gitlab:openapi:v3:check_docs 를 실행할 수 있습니다. 이는 API 코드 또는 문서를 수정하는 커밋에 대해 실행되는 openapi-doc-check CI/CD job에서도 확인됩니다. API 리소스에 대한 Markdown 토픽에는 다음 내용이 포함되어야 합니다: HTTP 메서드(GET, PUT, DELETE 등)와 요청 경로를 포함하는 블록. 항상 경로는 / 로 시작합니다. 예: GET /api/v4/projects/:id/repository/branches 속성 요청 에 대한 자세한 설명. 응답 본문 에 대한 자세한 설명. cURL 예시. 응답 본문 예시(JSON 형식). 새 API 문서 페이지를 추가한 후에는 전역 내비게이션에 항목을 추가 하세요. 페이지 메타데이터 # 새 페이지를 생성할 때 일관성을 위해 다음 지침을 따르는 description 메타데이터 필드를 프론트매터에 포함하세요: "REST API to"로 시작 사용자가 API로 할 수 있는 작업을 설명하는 동사 사용 -ing로 끝나는 단어 사용 금지 한 문장으로 유지, 가능하면 100자 이하 마침표로 끝내기 예를 들면: --- stage: Example Stage group: Example Group info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments> description: REST API to create, update, and delete issues. title: Example page title --- 추가 예시: description: REST API to retrieve CI/CD job details, retry and cancel jobs, run manual jobs, and access job logs. description: REST API to create, manage, and monitor CI/CD pipelines. API 토픽 템플릿 # 다음 템플릿을 시작점으로 사용하세요. 테이블에서 필수 속성을 먼저 나열하세요. ## API name <details class="history-t