Veri şemaları: Ortak modeller

codeDizeZorunlu

Makine tarafından okunabilir, sabit kod.

Kısıtlamalar

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

Örnek: "authentication.invalid_credentials"

fieldsDizi <FieldError > | nullİsteğe bağlı

Tek tek alanlara ilişkin doğrulama hataları.

Örnek: null

messageDizeZorunlu

İnsanlar için açıklama; program mantığında hata kodunu kullanın.

Örnek: "The credentials are invalid."

Ek alanlar: Hayır

dataMutationData Zorunlu

Yanıt örneği · MutationData.

Örnek: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"request_id":"example"}

Ek alanlar: Hayır

localeDizeZorunlu

Bu istek için seçilen dil.

Örnek: "en"

market_codeDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar kodu.

Örnek: "PL"

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

Örnek: "example"

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

Örnek: "example"

Ek alanlar: Hayır

localeDizeZorunlu

Bu istek için seçilen dil.

Örnek: "en"

market_codeDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar kodu.

Örnek: "PL"

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

Örnek: "example"

paginationPagination Zorunlu

İmleç tabanlı sayfalamanın üst verileri.

Örnek: {"has_more":false,"limit":20,"next_cursor":null}

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

Örnek: "example"

Ek alanlar: Hayır

errorApiError Zorunlu

Yapılandırılmış hata bilgileri.

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

metaRequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"request_id":"example-request"}

Ek alanlar: Hayır

codeDizeZorunlu

Makine tarafından okunabilir, sabit kod.

Kısıtlamalar

enum

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

fieldDizeZorunlu

Doğrulama hatasıyla ilişkili alan.

minLength: 1maxLength: 128

locationDizeZorunlu

Konum bilgileri.

Kısıtlamalar

enum

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

Ek alanlar: Hayır

amountDizeZorunlu

JSON dizesi olarak kodlanan ondalık tutar; yalnızca izin verilen yerlerde null olabilir.

Örnek: "0.00"

currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar

pattern

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

Örnek: "PLN"

minor_unitsTam sayıZorunlu

Para biriminin kullandığı ondalık basamak sayısı.

minimum: 0maximum: 4

Örnek: 2

Ek alanlar: Hayır

deletedMantıksal değerZorunlu

Silme işleminin uygulanıp uygulanmadığı.

Örnek: false

idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (MutationData).

Örnek: "example"

versionTam sayı | nullZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

paginationPagination Zorunlu

İmleç tabanlı sayfalamanın üst verileri.

Örnek: {"has_more":false,"limit":20,"next_cursor":null}

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

Örnek: "example"

Ek alanlar: Hayır

has_moreMantıksal değerZorunlu

Başka bir sayfanın mevcut olup olmadığı.

Örnek: false

limitTam sayıZorunlu

Bu sayfadaki en yüksek kayıt sayısı.

minimum: 1maximum: 100

Örnek: 20

next_cursorDize | nullZorunlu

Sonraki sayfanın devam değeri veya null.

Örnek: null

Ek alanlar: Hayır

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

Örnek: "example"

Ek alanlar: Hayır