Adatsémák: Közös modellek

codeKarakterláncKötelező

Stabil, géppel feldolgozható kód.

Korlátozások

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

Példa: "authentication.invalid_credentials"

fieldsTömb <FieldError > | nullNem kötelező

Az egyes mezők érvényesítési hibái.

Példa: null

messageKarakterláncKötelező

Embernek szánt magyarázat; a program logikájában a hibakódot használja.

Példa: "The credentials are invalid."

További mezők: Nem

dataMutationData Kötelező

Példaválasz · MutationData.

Példa: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Kötelező

A válasz metaadatai.

Példa: {"request_id":"example"}

További mezők: Nem

localeKarakterláncKötelező

A kéréshez kiválasztott nyelv.

Példa: "en"

market_codeKarakterláncKötelező

A környezetvégpont által visszaadott piackód.

Példa: "PL"

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

Példa: "example"

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

Példa: "example"

További mezők: Nem

localeKarakterláncKötelező

A kéréshez kiválasztott nyelv.

Példa: "en"

market_codeKarakterláncKötelező

A környezetvégpont által visszaadott piackód.

Példa: "PL"

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

Példa: "example"

paginationPagination Kötelező

A kurzoros lapozás metaadatai.

Példa: {"has_more":false,"limit":20,"next_cursor":null}

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

Példa: "example"

További mezők: Nem

errorApiError Kötelező

Strukturált hibainformáció.

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

metaRequestMeta Kötelező

A válasz metaadatai.

Példa: {"request_id":"example-request"}

További mezők: Nem

codeKarakterláncKötelező

Stabil, géppel feldolgozható kód.

Korlátozások

enum

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

fieldKarakterláncKötelező

Az érvényesítési hibához tartozó mező.

minLength: 1maxLength: 128

locationKarakterláncKötelező

Helyadatok.

Korlátozások

enum

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

További mezők: Nem

amountKarakterláncKötelező

JSON-karakterláncként kódolt tizedes összeg; null csak ott, ahol engedélyezett.

Példa: "0.00"

currencyKarakterláncKötelező

Az összeg pénznemkódja.

Korlátozások

pattern

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

Példa: "PLN"

minor_unitsEgész számKötelező

A pénznem által használt tizedesjegyek száma.

minimum: 0maximum: 4

Példa: 2

További mezők: Nem

deletedLogikai értékKötelező

Jelzi, hogy a törlés megtörtént-e.

Példa: false

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (MutationData).

Példa: "example"

versionEgész szám | nullKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

paginationPagination Kötelező

A kurzoros lapozás metaadatai.

Példa: {"has_more":false,"limit":20,"next_cursor":null}

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

Példa: "example"

További mezők: Nem

has_moreLogikai értékKötelező

Jelzi, hogy elérhető-e további oldal.

Példa: false

limitEgész számKötelező

Az oldalon szereplő rekordok maximális száma.

minimum: 1maximum: 100

Példa: 20

next_cursorKarakterlánc | nullKötelező

A következő oldal folytatási értéke, vagy null.

Példa: null

További mezők: Nem

request_idKarakterláncKötelező

Kérésazonosító; a válasz metaadataiban a HTTP-kérést azonosítja.

minLength: 1maxLength: 100

Példa: "example"

További mezők: Nem