metosin/malli

Feature request: enum value descriptions

Open

#613 opened on Jan 10, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Clojure (1,724 stars) (237 forks)batch import
enhancementhelp wanted

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.

Contributor guide

Feature request: enum value descriptions · metosin/malli#613 | Good First Issue