-
Notifications
You must be signed in to change notification settings - Fork 9k
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
Swagger UI - can it display Minimum value, Maximum value, Pattern, Default Values ?? #1217
Comments
It displays those when you hover over the property in the Model. |
OK. I see it. (for Range and Pattern, but not for default values) I don't want my clients to guess on what property to hover. |
If you can come up with a way to display all the information in a way that's visually appealing and won't make the UI bloated, feel free to create a PR with the implementation. |
Or even a mock up of how it could be more effective would be great. |
In RAML 0.8 display looks appealing. see example here: https://anypoint.mulesoft.com/apiplatform/popular/#/portals/apis/6308/versions/6302/pages/31760 It looks like there is enough space for everything in that display. doesn't it? |
What about pattern for a parameter value? |
To clarify my question - I do have pattern configured for url parameter and wonder if there is any code to support validation for those. |
@webron the feature of displaying information about the range doesn't seem to be working. If you look at http://petstore.swagger.io/, the |
@tanob right now, these are displayed for model properties only, and not primitive parameters. |
@webron do you guys now support having maximum and minimum with query parameters such as limit and offset? |
@michaelbaqadi support in what sense? |
For example, we can specify the maximum integer number for the limit parameter in url.
|
@michaelbaqadi - sorry for the late reply, somehow missed the notification on it. I'm honestly not sure if we support those right now. The best way to find out is to simply test it. |
Closing in favor of #993. |
I would expect API documentation to include those "Validation rules"
The text was updated successfully, but these errors were encountered: