Skip to content

Question on description in enumeration #1595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
francescoingv opened this issue Mar 26, 2025 · 1 comment
Closed

Question on description in enumeration #1595

francescoingv opened this issue Mar 26, 2025 · 1 comment

Comments

@francescoingv
Copy link

Having an enumeration, i.e. enum,
it would be useful to have the possibility to associate a description for each of the allowed values,
but as far as I understand it is not possible.
As an example, I understand it is not possible to associate the commented descriptions in the following excerpt:

      "enum": [
        "Value1", # "long description for Value 1"
        "Value2"  # "long description for Value 2"
      ]

I would like to know if my understanding is wrong, and in this case have an example of how to describe the above,
or if it is correct, and in this case if it is expected to have this in place in the future.

Thank you,
Francesco

@jdesrosiers
Copy link
Member

See #57 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants