Skip to content

Parameters Object does not list examples field #766

Closed
@DavidBiesack

Description

@DavidBiesack

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.

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