Errori
Come l'API segnala gli errori e cosa significa ogni codice.
L'API restituisce gli errori nell'array GraphQL standard errors; lo stato HTTP resta 200 e data può essere null o parziale. Ogni errore indica il suo tipo in extensions.code, e una richiesta rifiutata ne indica il motivo in 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
}Errori in qualsiasi richiesta
Possono essere restituiti da qualsiasi operazione dell'intera API.
UNAUTHENTICATEDLa tua chiave API manca, non è valida o è scaduta.RATE_LIMITHai inviato troppe richieste; attendi prima di riprovare.INTERNALSi è verificato un errore imprevisto del server; riprova più tardi.Errori specifici
A seconda dell'operazione e dei dati che invii, una richiesta può restituire anche:
NOT_FOUNDLa risorsa non esiste o la tua organizzazione non può accedervi.VALIDATIONLa richiesta è stata rifiutata per ciò che chiedeva. extensions.reasonCode ne indica il motivo: vedi «Rifiuti» più in basso.INPUTUn ID o un token illeggibile: un bug del client o un link non valido, mai qualcosa digitato da una persona. Trattalo come NOT_FOUND.CONSTRAINTDue richieste si sono contese la stessa scrittura e questa ha perso. Di solito basta riprovare.Rifiuti
Una richiesta rifiutata è sempre VALIDATION, con queste estensioni. Basati su reasonCode, mai su message, che è la stessa frase per tutti i rifiuti.
reasonCodeIl motivo del rifiuto, come parola stabile. Usala come chiave di traduzione.fieldDove si trova il problema nella richiesta: il nome dell'operazione, poi il percorso in ciò che hai inviato, senza l'involucro input e con le posizioni delle liste a partire da zero (domainUpdate.nameServers[1]). Assente quando il rifiuto riguarda l'intera richiesta.paramsI valori che servono alla spiegazione, come kind o un nome host. Assente quando non ce ne sono.reasonLa stessa spiegazione in inglese, per gli sviluppatori. Non è pensata per essere mostrata agli utenti.Motivi che qualsiasi operazione può dare
Oltre ai motivi elencati per ogni operazione, qualsiasi operazione può rispondere con questi. Per gli ultimi quattro, params.kind indica il tipo di elemento a cui si riferisce il rifiuto (PROJECT, DNS_ZONE, DNS_RECORD…).
MALFORMEDUn valore non ha la forma prevista. reason indica il problema.REQUIREDManca un valore, oppure è stato inviato null per un campo che non si può svuotare.TOO_LARGEUn testo o un file supera la dimensione consentita. params.maxBytes è il limite.NOT_FOUNDQualcosa a cui si riferisce la richiesta non esiste o appartiene a un'altra organizzazione.TAKENIl nome è già usato da qualcos'altro.IN_USENon si può eliminare finché è ancora in uso.DELETEDÈ stato eliminato, e non si può modificare nulla finché non viene ripristinato.