Issue with enum query parameter with a default value
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 45/100
Piste de recherche
Commencez par suivre la génération des paramètres Swagger pour le paramètre de requête enum montré dans l’issue. Vérifiez comment sont dérivés la valeur par défaut et l’indicateur required, puis vérifiez que le JSON généré inclut la valeur par défaut "published_at" et required true, sans option nil dans l’UI.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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!
- Langage dominant
- Clojure
- Étoiles
- 1.1k
- Forks
- 144
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de metosin/compojure-api
-
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
metosin/compojure-api#489 ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 30/100
metosin/compojure-api#468 ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
metosin/compojure-api#467 ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
metosin/compojure-api#464 ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 30/100
metosin/compojure-api#463 · 3 commentaires ·
Toutes les issues de metosin/compojure-api
Issues similaires
-
to-calcit-data 查询合同漏列保留字符串选项 / Missing existing string-preserving argument in public contractOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
calcit-lang/calcit#2151 ·
Les mainteneurs répondent en général sous 1 jour
-
worker/start rejects middleware supplied as a VarPeut-être pris @rajp152k l’a pris il y a 1 jour. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
Profiler (Remotery) leaks a socket for every connection that fails the WebSocket handshakePeut-être pris @rthery l’a pris il y a 1 jour. Ouvertetriage
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
IOP nitrate needs triage
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
Les mainteneurs répondent en général sous 1 jour
-
category:tooling
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
Les mainteneurs répondent en général sous 1 jour