Sheme podataka: Zajednički modeli

codeNiz znakovaObvezno

Stabilan strojno čitljiv kod.

Ograničenja

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

Primjer: "authentication.invalid_credentials"

fieldsPolje vrijednosti <FieldError > | nullNeobavezno

Pogreške provjere pojedinih polja.

Primjer: null

messageNiz znakovaObvezno

Objašnjenje za korisnika; za programsku logiku koristite kod pogreške.

Primjer: "The credentials are invalid."

Dodatna polja: Ne

dataMutationData Obvezno

Primjer odgovora · MutationData.

Primjer: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obvezno

Metapodaci odgovora.

Primjer: {"request_id":"example"}

Dodatna polja: Ne

localeNiz znakovaObvezno

Jezik odabran za ovaj zahtjev.

Primjer: "en"

market_codeNiz znakovaObvezno

Kod tržišta vraćen s krajnje točke konteksta.

Primjer: "PL"

market_idNiz znakovaObvezno

Identifikator tržišta vraćen s krajnje točke konteksta.

Primjer: "example"

request_idNiz znakovaObvezno

Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.

minLength: 1maxLength: 100

Primjer: "example"

Dodatna polja: Ne

localeNiz znakovaObvezno

Jezik odabran za ovaj zahtjev.

Primjer: "en"

market_codeNiz znakovaObvezno

Kod tržišta vraćen s krajnje točke konteksta.

Primjer: "PL"

market_idNiz znakovaObvezno

Identifikator tržišta vraćen s krajnje točke konteksta.

Primjer: "example"

paginationPagination Obvezno

Metapodaci straničenja pomoću kursora.

Primjer: {"has_more":false,"limit":20,"next_cursor":null}

request_idNiz znakovaObvezno

Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.

minLength: 1maxLength: 100

Primjer: "example"

Dodatna polja: Ne

errorApiError Obvezno

Strukturirani podaci o pogrešci.

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

metaRequestMeta Obvezno

Metapodaci odgovora.

Primjer: {"request_id":"example-request"}

Dodatna polja: Ne

codeNiz znakovaObvezno

Stabilan strojno čitljiv kod.

Ograničenja

enum

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

fieldNiz znakovaObvezno

Polje povezano s pogreškom provjere valjanosti.

minLength: 1maxLength: 128

locationNiz znakovaObvezno

Podaci o lokaciji.

Ograničenja

enum

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

Dodatna polja: Ne

amountNiz znakovaObvezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gdje je dopušten.

Primjer: "0.00"

currencyNiz znakovaObvezno

Kod valute iznosa.

Ograničenja

pattern

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

Primjer: "PLN"

minor_unitsCijeli brojObvezno

Broj decimalnih znamenki valute.

minimum: 0maximum: 4

Primjer: 2

Dodatna polja: Ne

deletedLogička vrijednostObvezno

Je li brisanje primijenjeno.

Primjer: false

idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (MutationData).

Primjer: "example"

versionCijeli broj | nullObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 1

Dodatna polja: Ne

paginationPagination Obvezno

Metapodaci straničenja pomoću kursora.

Primjer: {"has_more":false,"limit":20,"next_cursor":null}

request_idNiz znakovaObvezno

Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.

minLength: 1maxLength: 100

Primjer: "example"

Dodatna polja: Ne

has_moreLogička vrijednostObvezno

Postoji li sljedeća stranica.

Primjer: false

limitCijeli brojObvezno

Najveći broj zapisa na ovoj stranici.

minimum: 1maximum: 100

Primjer: 20

next_cursorNiz znakova | nullObvezno

Vrijednost za nastavak na sljedeću stranicu ili null.

Primjer: null

Dodatna polja: Ne

request_idNiz znakovaObvezno

Identifikator zahtjeva; u metapodacima odgovora označava HTTP zahtjev.

minLength: 1maxLength: 100

Primjer: "example"

Dodatna polja: Ne