데이터 스키마: 공통 모델

code문자열필수

안정적인 기계 판독용 코드입니다.

제약 조건

enum

["request.malformed", "authentication.required", "authentication.invalid_credentials", "authorization.scope_denied", "authorization.ip_not_allowed", "authorization.client_ip_unverified", "entitlements.api_disabled", "entitlements.operation_disabled", "entitlements.limit_exceeded", "entitlements.resource_blocked", "resource.not_found", "request.method_not_allowed", "resource.version_conflict", "resource.state_conflict", "resource.in_use", "resource.already_exists", "idempotency.key_reused", "request.too_large", "request.unsupported_media_type", "request.validation_failed", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout"]

예제: "authentication.invalid_credentials"

fields배열 <FieldError > | null선택 사항

개별 필드의 검증 오류입니다.

예제: null

message문자열필수

사람이 읽는 설명이며 프로그램 로직에는 오류 코드를 사용해야 합니다.

예제: "The credentials are invalid."

추가 필드: 아니요

dataMutationData 필수

응답 예제 · MutationData.

예제: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

예제: {"request_id":"example"}

추가 필드: 아니요

locale문자열필수

이 요청에서 선택한 언어입니다.

예제: "en"

market_code문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

예제: "PL"

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

예제: "example"

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

예제: "example"

추가 필드: 아니요

locale문자열필수

이 요청에서 선택한 언어입니다.

예제: "en"

market_code문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

예제: "PL"

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

예제: "example"

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

예제: {"has_more":false,"limit":20,"next_cursor":null}

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

예제: "example"

추가 필드: 아니요

errorApiError 필수

구조화된 오류 정보입니다.

예제: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}

metaRequestMeta 필수

응답 메타데이터입니다.

예제: {"request_id":"example-request"}

추가 필드: 아니요

code문자열필수

안정적인 기계 판독용 코드입니다.

제약 조건

enum

["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]

field문자열필수

검증 오류와 관련된 필드입니다.

minLength: 1maxLength: 128

location문자열필수

위치 정보입니다.

제약 조건

enum

["path", "query", "header", "body"]

추가 필드: 아니요

amount문자열필수

JSON 문자열로 인코딩한 십진수 금액입니다. null 은 허용된 경우에만 사용합니다.

예제: "0.00"

currency문자열필수

금액의 통화 코드입니다.

제약 조건

pattern

"^[A-Z]{3}$"

예제: "PLN"

minor_units정수필수

통화에서 사용하는 소수 자릿수입니다.

minimum: 0maximum: 4

예제: 2

추가 필드: 아니요

deleted불리언필수

삭제가 적용되었는지 나타냅니다.

예제: false

id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (MutationData).

예제: "example"

version정수 | null필수

동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

예제: {"has_more":false,"limit":20,"next_cursor":null}

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

예제: "example"

추가 필드: 아니요

has_more불리언필수

다음 페이지가 있는지 나타냅니다.

예제: false

limit정수필수

이 페이지의 최대 레코드 수입니다.

minimum: 1maximum: 100

예제: 20

next_cursor문자열 | null필수

다음 페이지의 이어 보기 값 또는 null 입니다.

예제: null

추가 필드: 아니요

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

예제: "example"

추가 필드: 아니요