Схеми даних: Спільні моделі

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"

Додаткові поля: Ні