Skip to content

Expand 'example' support #418

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
webron opened this issue Jul 20, 2015 · 3 comments
Closed

Expand 'example' support #418

webron opened this issue Jul 20, 2015 · 3 comments

Comments

@webron
Copy link
Member

webron commented Jul 20, 2015

Later on I'll try to add the history behind the issue, but for now, here's an explanation of what's needed:

  • Allow providing examples at the parameter level. Right now it's limited to definitions which affect only body parameters. This also means that the same example would be used for all operations referencing it.
  • Allow providing examples based on mime-type. This will become even more critical with the added support for versions and other mime-type based features in the future.
@Fival85
Copy link

Fival85 commented Aug 14, 2015

@ApiParam(value = "The Ordernumber", example = {"1234", "5678"}) @PathParam("orderNumber")

That would be nice and easy to use :)

@jharmn
Copy link
Contributor

jharmn commented Feb 12, 2016

Link to parent #565

@webron
Copy link
Member Author

webron commented Mar 3, 2017

Done.

@webron webron closed this as completed Mar 3, 2017
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

3 participants