Skip to content

Adding enum values for Enum Type in Swagger ReadOnly documentation #3977

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

Merged
merged 6 commits into from
Jan 6, 2018

Conversation

dedece35
Copy link
Contributor

@dedece35 dedece35 commented Dec 2, 2017

Description

SwaggerUI documentation in ReadOnly mode doesn't give :

  • the available values of an "Enum" type
  • default value
  • example value

These values are given when "Try it out" button is clicked.

Now, these available values are also displayed on readonly mode of swaggerUI.

Motivation and Context

I want know available values for an Enum type, default value and example value without clicking on "Try it out" button.

How Has This Been Tested?

To develop this feature, I followed CONTRIBUTING.md file such as :

  • I launched "npm run dev" to have the test page ("Pets" API)
  • I developed and verified results in page http://localhost:3200 and see the rendered result
  • I launched "npm test" and verified that all is OK

Screenshots (if appropriate):

the red square zone is the result of my feature.
addenumvalues

Types of changes

  • No code changes (changes to documentation, CI, metadata, etc)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@shockey shockey added this to the December 8, 2017 milestone Dec 4, 2017
@shockey shockey removed this from the December 8, 2017 milestone Dec 13, 2017
@shockey
Copy link
Contributor

shockey commented Dec 13, 2017

Setting this aside pending @webron's feedback about the larger UX changes we want to make 👍

@dedece35
Copy link
Contributor Author

ok thank you a lot @shockey

@dedece35
Copy link
Contributor Author

dedece35 commented Dec 30, 2017

hello @shockey , have you some news about feedback ?

Copy link
Contributor

@webron webron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shockey tested, and I'm OK with the functionality as its been imple,ented.

Thanks for the work, @dedece35 - sorry for the delay.

@shockey shockey removed the On hold label Jan 5, 2018
@shockey shockey added this to the January 5, 2018 milestone Jan 5, 2018
@shockey shockey merged commit a47da98 into swagger-api:master Jan 6, 2018
@dedece35
Copy link
Contributor Author

dedece35 commented Jan 6, 2018

thanks a lot to you @shockey

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

Successfully merging this pull request may close these issues.

3 participants