Dátové schémy: Spoločné modely

codeReťazecPovinné

Stabilný strojovo čitateľný kód.

Obmedzenia

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"]

Príklad: "authentication.invalid_credentials"

fieldsPole <FieldError > | nullVoliteľné

Chyby validácie jednotlivých polí.

Príklad: null

messageReťazecPovinné

Vysvetlenie pre človeka; v programovej logike používajte kód chyby.

Príklad: "The credentials are invalid."

Ďalšie polia: Nie

dataMutationData Povinné

Príklad odpovede · MutationData.

Príklad: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Povinné

Metaúdaje odpovede.

Príklad: {"request_id":"example"}

Ďalšie polia: Nie

localeReťazecPovinné

Jazyk vybraný pre túto požiadavku.

Príklad: "en"

market_codeReťazecPovinné

Kód trhu vrátený koncovým bodom kontextu.

Príklad: "PL"

market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

Príklad: "example"

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100

Príklad: "example"

Ďalšie polia: Nie

localeReťazecPovinné

Jazyk vybraný pre túto požiadavku.

Príklad: "en"

market_codeReťazecPovinné

Kód trhu vrátený koncovým bodom kontextu.

Príklad: "PL"

market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

Príklad: "example"

paginationPagination Povinné

Metaúdaje stránkovania pomocou kurzora.

Príklad: {"has_more":false,"limit":20,"next_cursor":null}

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100

Príklad: "example"

Ďalšie polia: Nie

errorApiError Povinné

Štruktúrované informácie o chybe.

Príklad: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}

metaRequestMeta Povinné

Metaúdaje odpovede.

Príklad: {"request_id":"example-request"}

Ďalšie polia: Nie

codeReťazecPovinné

Stabilný strojovo čitateľný kód.

Obmedzenia

enum

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

fieldReťazecPovinné

Pole súvisiace s chybou validácie.

minLength: 1maxLength: 128

locationReťazecPovinné

Informácie o umiestnení.

Obmedzenia

enum

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

Ďalšie polia: Nie

amountReťazecPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Príklad: "0.00"

currencyReťazecPovinné

Kód meny sumy.

Obmedzenia

pattern

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

Príklad: "PLN"

minor_unitsCelé čísloPovinné

Počet desatinných miest používaných menou.

minimum: 0maximum: 4

Príklad: 2

Ďalšie polia: Nie

deletedLogická hodnotaPovinné

Či bolo zmazanie vykonané.

Príklad: false

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (MutationData).

Príklad: "example"

versionCelé číslo | nullPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

paginationPagination Povinné

Metaúdaje stránkovania pomocou kurzora.

Príklad: {"has_more":false,"limit":20,"next_cursor":null}

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100

Príklad: "example"

Ďalšie polia: Nie

has_moreLogická hodnotaPovinné

Či je dostupná ďalšia stránka.

Príklad: false

limitCelé čísloPovinné

Maximálny počet záznamov na tejto stránke.

minimum: 1maximum: 100

Príklad: 20

next_cursorReťazec | nullPovinné

Hodnota na pokračovanie na ďalšiu stránku alebo null.

Príklad: null

Ďalšie polia: Nie

request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100

Príklad: "example"

Ďalšie polia: Nie