metosin/malli

Feature request: enum value descriptions

Open

#613 ouverte le 10 janv. 2022

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Clojure (237 forks)batch import
enhancementhelp wanted

Métriques du dépôt

Stars
 (1 724 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Sometimes, the enumerated values are not clear enough by themselves. It would be nice to have a standard way to provide a description for each enumerated value.

Following our discussion on Slack, a nice solution would be to have :enumn (similar to :catn) that support description of enumerated values, like this:

[:enumn 
   ["foo" {:description "foo means that you don't know how to name things"}] 
   ["bar"] 
   "baz"]

Where some enumerated values have description and some don't.

Open question

Is there a way to pass the description of enumerated values to Swagger? JSON Schema doesn't seem to support description for enumerated values.

Guide contributeur