🔥 부록
377자
4분
부록 A - OpenAPI 문서
다음은 OpenAPI (v3) 명세로, 이는 규범적이지 않으며 자체 패키지 레지스트리를 구축하는 데 관심이 있는 개발자의 편의를 위해 제공됩니다.
registry.openapi.yaml 파일을 참조하세요.
부록 B - 패키지 릴리스 메타데이터 JSON 스키마
패키지 릴리스 생성 요청의 metadata
섹션은 아래의 JSON 스키마에 정의된 PackageRelease
타입의 JSON 객체여야 합니다.
JSON 스키마 보기를 확장하세요.
PackageRelease
타입
속성 | 타입 | 설명 | 필수 여부 |
---|---|---|---|
author | Author | 패키지 릴리스의 작성자입니다. | |
description | String | 패키지 릴리스에 대한 설명입니다. | |
licenseURL | String | 패키지 릴리스의 라이선스 문서 URL입니다. | |
originalPublicationTime | String | ISO 8601 형식으로 된 패키지 릴리스의 원본 게시 시간입니다. 패키지 릴리스가 이전에 다른 곳에 게시된 경우 이 값을 설정할 수 있습니다. 레지스트리는 게시 시간을 독립적으로 기록하고 패키지 릴리스 메타데이터 응답에 publishedAt 으로 포함해야 합니다. originalPublicationTime 과 publishedAt 이 모두 설정된 경우 originalPublicationTime 을 사용해야 합니다. | |
readmeURL | String | 패키지 릴리스 또는 패키지 전반에 대한 README 파일의 URL입니다. | |
repositoryURLs | Array | 패키지의 코드 저장소 URL입니다. 동일한 저장소에 대해 모든 URL 변형(예: SSH, HTTPS)을 포함하는 것이 좋습니다. 패키지에 소스 제어 표현이 없는 경우 빈 배열일 수 있습니다. 이 속성을 설정하는 것은 레지스트리가 "URL에 등록된 패키지 식별자 조회" API에 대한 저장소 URL과 패키지 식별자 간의 매핑을 얻을 수 있는 한 가지 방법입니다. 레지스트리는 패키지 작성자가 이러한 매핑을 지정할 수 있는 다른 메커니즘을 선택할 수 있습니다. |
Author
타입
속성 | 타입 | 설명 | 필수 여부 |
---|---|---|---|
name | String | 작성자의 이름입니다. | ✓ |
email | String | 작성자의 이메일 주소입니다. | |
description | String | 작성자에 대한 설명입니다. | |
organization | Organization | 작성자가 속한 조직입니다. | |
url | String | 작성자의 URL입니다. |
Organization
타입
속성 | 타입 | 설명 | 필수 여부 |
---|---|---|---|
name | String | 조직의 이름입니다. | ✓ |
email | String | 조직의 이메일 주소입니다. | |
description | String | 조직에 대한 설명입니다. | |
url | String | 조직의 URL입니다. |