Skip to content

Expand 'example' support #418

Closed
Closed

Description

@webron

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.

Activity

  1. changed the title [-]Exapand 'example' support[/-] [+]Expand 'example' support[/+] on Jul 30, 2015
  2. Fival85 commented on Aug 14, 2015

    @Fival85

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

    That would be nice and easy to use :)

  3. jharmn commented on Feb 12, 2016

    @jharmn
    Contributor

    Link to parent #565

  4. webron commented on Mar 3, 2017

    @webron
    MemberAuthor

    Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions