Issue with enum query parameter with a default value
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
Línea de trabajo
Empieza siguiendo la generación de parámetros de Swagger para el parámetro de consulta enum mostrado en el issue. Comprueba cómo se derivan el valor predeterminado y el indicador required, y verifica después que el JSON generado incluya el valor predeterminado "published_at" y required true, sin ninguna opción nil en la UI.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
If a query parameter is of type enum and has a default value, the swagger parameter for default should be appropriately set and required should be set to true.
Here is an example below.
what's happening
(GET "/all/" request
:description "Return a list of articles."
:return [(dissoc t/Article :is_html :text)]
:responses default-responses
:query-params [{sort :- (describe (s/enum :published_at :last_processed_at) "The sort type. Defaults to published_at.") "published_at"}]
(return (domain/get-all-articles db (org request) :days 1)))
The sort parameter above can be either published_at or last_processed_at where it defaults to the former.
The JSON output for the route above is:
"parameters": [
{
"in": "query",
"name": "sort",
"description": "The sort type. Defaults to published_at.",
"required": false,
"type": "string",
"enum": [
"last_processed_at",
"published_at"
]
}
]
And the UI renders like this:
expectation
I would expect the select box in the UI to start off with the published_at pre-selected and not allow a nil option.
I would expect the json output to have required set to true and a default value set to published_at.
Thanks for your time!
- Lenguaje dominante
- Clojure
- Estrellas
- 1.1k
- Forks
- 145
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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 metosin/compojure-api
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
metosin/compojure-api#489 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
metosin/compojure-api#468 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
metosin/compojure-api#467 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
metosin/compojure-api#464 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
metosin/compojure-api#463 · 3 comentarios ·
Todos los issues de metosin/compojure-api
Issues similares
-
Dificultad 2/5 Medio día Aptitud para principiantes 84/100
clojure-lsp/clojure-lsp#2502 ·
Los mantenedores suelen responder en 1 día
-
Sessions are never closedAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
category:tooling
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día