Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feature request: enum description #201

Closed
ConorSheehan1 opened this issue Feb 25, 2019 · 3 comments · May be fixed by #429
Closed

feature request: enum description #201

ConorSheehan1 opened this issue Feb 25, 2019 · 3 comments · May be fixed by #429
Labels
enhancement wontfix
Milestone
Gem 2.X.0

Comments

@ConorSheehan1
Copy link

It'd be great if we could add a description to each enum value by passing a hash instead of an array to the enum param.

Something like this: OAI/OpenAPI-Specification#348 (comment)

# requested support
parameter name: :foo, in: :query, enum: {'bar': 'lists bars', 'baz': 'lists people named baz'}

# current support
parameter name: :foo, in: :query, enum: ['bar', 'baz']
@TheHussein
Copy link

any updates on this?

@masamichhhhi masamichhhhi mentioned this issue May 30, 2021
Open
@stale
Copy link

stale bot commented Feb 10, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If the issue is still relevant to you, please leave a comment stating so to keep the issue from being closed. Thank you for your contributions.

@stale stale bot added the wontfix label Feb 10, 2022
@stale stale bot closed this as completed Feb 24, 2022
masamichhhhi added a commit to masamichhhhi/rswag that referenced this issue Dec 10, 2022
@masamichhhhi
Merge branch 'rswag:master' into add-enum-description-for-rswag#201
ee5f73e
@romanblanco romanblanco reopened this Apr 2, 2023
@romanblanco romanblanco linked a pull request Apr 2, 2023 that will close this issue
Allow enum parameter description. (#201) #429
Open
@romanblanco romanblanco added this to the Gem 2.X.0 milestone May 8, 2023
masamichhhhi added a commit to masamichhhhi/rswag that referenced this issue Jun 17, 2023
@masamichhhhi
Merge remote-tracking branch 'upstream/master' into add-enum-descript…
d5ea1fb 
…ion-for-rswag#201
romanblanco added a commit to masamichhhhi/rswag that referenced this issue Dec 16, 2023
@romanblanco
Merge branch 'master' into add-enum-description-for-rswag#201
7edb856
@stale Stale
Copy link

stale bot commented May 8, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If the issue is still relevant to you, please leave a comment stating so to keep the issue from being closed. Thank you for your contributions.

@stale stale bot added the wontfix label May 8, 2024
@stale stale bot closed this as completed May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement wontfix
Projects
None yet
Milestone
Gem 2.X.0
Development

Successfully merging a pull request may close this issue.

Allow enum parameter description. (#201) masamichhhhi/rswag
3 participants
@romanblanco @ConorSheehan1 @TheHussein