Schémas de données: Modèles communs

codeChaîneObligatoire

Code stable lisible par une machine.

Contraintes

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

Exemple: "authentication.invalid_credentials"

fieldsTableau <FieldError > | nullFacultatif

Erreurs de validation des champs individuels.

Exemple: null

messageChaîneObligatoire

Explication destinée aux humains ; utiliser le code d'erreur dans la logique du programme.

Exemple: "The credentials are invalid."

Champs supplémentaires: Non

dataMutationData Obligatoire

Exemple de réponse · MutationData.

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

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatoire

Métadonnées de la réponse.

Exemple: {"request_id":"example"}

Champs supplémentaires: Non

localeChaîneObligatoire

Langue sélectionnée pour cette requête.

Exemple: "en"

market_codeChaîneObligatoire

Code de marché renvoyé par le point d'accès au contexte.

Exemple: "PL"

market_idChaîneObligatoire

Identifiant de marché renvoyé par le point d'accès au contexte.

Exemple: "example"

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100

Exemple: "example"

Champs supplémentaires: Non

localeChaîneObligatoire

Langue sélectionnée pour cette requête.

Exemple: "en"

market_codeChaîneObligatoire

Code de marché renvoyé par le point d'accès au contexte.

Exemple: "PL"

market_idChaîneObligatoire

Identifiant de marché renvoyé par le point d'accès au contexte.

Exemple: "example"

paginationPagination Obligatoire

Métadonnées de pagination par curseur.

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

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100

Exemple: "example"

Champs supplémentaires: Non

errorApiError Obligatoire

Informations structurées sur l'erreur.

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

metaRequestMeta Obligatoire

Métadonnées de la réponse.

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

Champs supplémentaires: Non

codeChaîneObligatoire

Code stable lisible par une machine.

Contraintes

enum

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

fieldChaîneObligatoire

Champ associé à une erreur de validation.

minLength: 1maxLength: 128

locationChaîneObligatoire

Informations sur l'emplacement.

Contraintes

enum

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

Champs supplémentaires: Non

amountChaîneObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Exemple: "0.00"

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

pattern

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

Exemple: "PLN"

minor_unitsEntierObligatoire

Nombre de décimales utilisées par la devise.

minimum: 0maximum: 4

Exemple: 2

Champs supplémentaires: Non

deletedBooléenObligatoire

Indique si la suppression a été appliquée.

Exemple: false

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (MutationData).

Exemple: "example"

versionEntier | nullObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

Champs supplémentaires: Non

paginationPagination Obligatoire

Métadonnées de pagination par curseur.

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

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100

Exemple: "example"

Champs supplémentaires: Non

has_moreBooléenObligatoire

Indique si une page supplémentaire est disponible.

Exemple: false

limitEntierObligatoire

Nombre maximal d'enregistrements sur cette page.

minimum: 1maximum: 100

Exemple: 20

next_cursorChaîne | nullObligatoire

Valeur de continuation pour la page suivante, ou null.

Exemple: null

Champs supplémentaires: Non

request_idChaîneObligatoire

Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.

minLength: 1maxLength: 100

Exemple: "example"

Champs supplémentaires: Non