Erreurs
Comment l'API signale les erreurs et ce que signifie chaque code.
L'API renvoie les erreurs dans le tableau GraphQL standard errors. Le statut HTTP reste 200 et data peut être null ou partiel. Chaque erreur indique son type dans extensions.code, et une demande refusée en indique la raison dans extensions.reasonCode.
{
"errors": [
{
"message": "Input does not meet data validation rules.",
"path": ["issueCreate"],
"extensions": {
"code": "VALIDATION",
"reasonCode": "REQUIRED",
"field": "issueCreate.title",
"reason": "title is required"
}
}
],
"data": null
}Erreurs sur n'importe quelle requête
Elles peuvent être renvoyées par n'importe quelle opération de toute l'API.
UNAUTHENTICATEDVotre clé API est absente, non valide ou expirée.RATE_LIMITVous avez envoyé trop de requêtes ; attendez avant de réessayer.INTERNALUne erreur inattendue du serveur s'est produite ; réessayez plus tard.Erreurs spécifiques
Selon l'opération et les données que vous envoyez, une requête peut aussi renvoyer :
NOT_FOUNDLa ressource n'existe pas ou votre organisation ne peut pas y accéder.VALIDATIONLa demande a été refusée à cause de ce qu'elle demandait. extensions.reasonCode en indique la raison, voir « Refus » plus bas.INPUTUn identifiant ou un jeton illisible, c'est-à-dire un bug du client ou un lien cassé, jamais une saisie d'une personne. Traitez-le comme NOT_FOUND.CONSTRAINTDeux demandes se sont disputé la même écriture et celle-ci a perdu. Une nouvelle tentative suffit en général.Refus
Une demande refusée est toujours VALIDATION, avec ces extensions. Basez-vous sur reasonCode, jamais sur message, qui est la même phrase pour tous les refus.
reasonCodeLa raison du refus, sous forme de mot stable. Utilisez-la comme clé de traduction.fieldL'endroit de la demande où se trouve le problème, à savoir le nom de l'opération puis le chemin dans ce que vous avez envoyé, sans l'enveloppe input et avec les positions des listes à partir de zéro (domainUpdate.nameServers[1]). Absent quand le refus porte sur toute la demande.paramsLes valeurs dont l'explication a besoin, comme kind ou un nom d'hôte. Absent quand il n'y en a pas.reasonLa même explication en anglais, pour les développeurs. Elle n'est pas destinée aux utilisateurs.Raisons que toute opération peut donner
En plus des raisons indiquées pour chaque opération, toutes peuvent répondre avec celles-ci. Pour les quatre dernières, params.kind indique le type d'élément concerné (PROJECT, DNS_ZONE, DNS_RECORD…).
MALFORMEDUne valeur n'a pas la forme attendue. reason indique le problème.REQUIREDUne valeur manque, ou null a été envoyé pour un champ qui ne peut pas être vidé.TOO_LARGEUn texte ou un fichier dépasse la taille autorisée. params.maxBytes en est la limite.NOT_FOUNDUn élément auquel la demande fait référence n'existe pas ou appartient à une autre organisation.TAKENLe nom est déjà utilisé par autre chose.IN_USEImpossible de le supprimer tant qu'il est encore utilisé.DELETEDIl a été supprimé, et rien ne peut y être modifié avant sa restauration.