Documentation of API error codes

Abierto
#920 0 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 14 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
38/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python

Línea de trabajo

The issue asks for a human-readable reference of HTTP status codes and error conditions per API endpoint, plus whether JSON errors always include a detail field. Start from existing API docs and the code that raises or serializes errors for each endpoint. Confirm observed status codes and payloads against the implementation. Done when docs list those conditions per endpoint; issue #359 is noted as a possible later source of the same information.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

The docs currently do not contain a lot of information on possible error codes and conditions returned by the API. API clients therefore need to implement error handling based on observations and assumptions, and can not rely on documented behaviour.

It would be nice to have a reference of possible error conditions and HTTP status codes for each endpoint.
Furthermore, I noticed that errors seem to contain JSON data with a human-readable error message in the detail field. Is this always the case? At a quick glance, it seems to be. But I could not find any reliable information.

I believe, #359 has the potential to naturally provide this kind of information. In the mean time, a human-readable documentation would help.

Lenguaje dominante
Python
Estrellas
678
Forks
74
Merge medio
7 d 23 h
PR fusionados (30 d)
1

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de desec-io/desec-stack

Todos los issues de desec-io/desec-stack

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.