Documentation of API error codes
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
- Área
- api, documentation
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
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de desec-io/desec-stack
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
desec-io/desec-stack#1312 ·
Los mantenedores suelen responder en 14 días
-
UI bug and inconsistency: Adding IPv6 address/netmask to token IP restriction silently errors outAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
desec-io/desec-stack#1310 ·
Los mantenedores suelen responder en 14 días
-
Here-strings in request examplesPosiblemente ocupada @jadhavgaurav la tomó hace 28 días. Abiertodocs help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
desec-io/desec-stack#1286 · 1 comentario ·
Los mantenedores suelen responder en 14 días
-
api enhancement prio: low
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
desec-io/desec-stack#1246 · 1 comentario ·
Los mantenedores suelen responder en 14 días
-
enhancement gui help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
desec-io/desec-stack#1181 · 1 comentario ·
Los mantenedores suelen responder en 14 días
Todos los issues de desec-io/desec-stack
Issues similares
-
[dbt] exported dataset keys reference physical columnsPosiblemente ocupada @WilliamKelley la tomó hoy. Abiertoneeds-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
apache/ossie-converters#251 ·
Los mantenedores suelen responder en 2 días
-
cli difficulty: easy enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 2 días
-
needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
aws/aws-durable-execution-sdk-python#977 ·
Los mantenedores suelen responder en 1 día
-
needs-triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
flashinfer-ai/flashinfer#9803 ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
iamprivacy/Waves#66 · 2 comentarios ·