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.

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

Parameters Object does not list examples field #766

Closed
DavidBiesack opened this issue Aug 22, 2016 · 3 comments
Closed

Parameters Object does not list examples field #766

DavidBiesack opened this issue Aug 22, 2016 · 3 comments

Comments

@DavidBiesack
Copy link

I looked at #636 again after @darrelmiller posted "Extending representations to parameters and headers" #762 . I think the Parameter Object section should include the (singular) example field under Fixed Fields. examples are used in parameters in the samples under Examples Object :

# in a parameter

  parameters:
    - name: 'zip'
      in: 'query'
      type: 'string'
      format: 'zip'
      example: 
        $ref: 'http://foo.bar#/examples/zip-example'

Also, given the ongoing discussions about multiple representations/content in #762 the example or examples field should be added to content (was representations) content object, as examples and content objects should apply to parameters as well.

@darrelmiller
Copy link
Member

darrelmiller commented Aug 22, 2016

@DavidBiesack It's there https://github.com/OAI/OpenAPI-Specification/pull/761/files#diff-4a97aef5bba9ddb7fd8609f48f4bdc30R906 in the docs for the 'representation/content' object. I haven't updated the spec PR regarding parameters/headers yet because that is still being debated.

@DavidBiesack
Copy link
Author

Thanks @darrelmiller -- is it worth splitting that off into a separate PR, since the examples #636 is already merged but the representations/content PR #761 is still a proposal?

@fehguy
Copy link
Contributor

fehguy commented Feb 1, 2017

Both merged now

@fehguy fehguy closed this as completed Feb 1, 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