Invalid query parameters return two different error shapes
Los mantenedores suelen responder en 2 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
Línea de trabajo
Start by tracing query-parameter validation on the list endpoints for limit, dir, order_by, time[…], and the next/prev cursors, comparing the 400 and 422 response shapes shown in the issue. The issue leaves the choice of status and shape open, so clarify that decision before changing behavior. Done means all those invalid parameters use one consistent status and response shape, with a release note covering the client compatibility impact.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
As of #1109, on the list endpoints an invalid limit returns a 400 with a plain message. For example GET /api/v1/events?limit=0:
{"status":400,"message":"invalid limit: must be between 1 and 1000"}
An invalid dir, order_by or time[…] on the same endpoint returns a 422 with a data detail. For example GET /api/v1/events?dir=sideways:
{"status":422,"message":"validation error","data":{"query.dir":"must be 'asc' or 'desc'"}}
An invalid next or prev cursor is a 400 with a plain message, like limit. A client has to handle both shapes for one request.
Proposal: pick one status and shape for query parameter validation and apply it on every endpoint. Clients that match on the status would break, so the change needs a release note.
- Lenguaje dominante
- Go
- Estrellas
- 1.1k
- Forks
- 70
- Merge medio
- 2 d 20 h
- PR fusionados (30 d)
- 44
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 hookdeck/outpost
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 2 días
-
Dificultad 3/5 1-2 días Aptitud para principiantes 67/100
Los mantenedores suelen responder en 2 días
-
enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
hookdeck/outpost#1117 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 2 días
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
Los mantenedores suelen responder en 2 días
Todos los issues de hookdeck/outpost
Issues similares
-
area: records fast-track-debt priority: normal
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 1 día
-
processor/genainormalizer
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
open-telemetry/opentelemetry-collector-contrib#52328 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[tooling] Example acceptance runner reports ALL PASS for an unsupported program (tested patch)Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
limitlessprojects/Go-Hybrid#1595 ·
Los mantenedores suelen responder en 1 día
-
provider: hyper
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
charmbracelet/crush#4134 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
AvengeMedia/DankMaterialShell#3912 ·