Skip to content

/employees example in "Media Types" summary inaccurately describes response schema #398

@chris-martin

Description

@chris-martin

On https://swagger.io/docs/specification/v3_0/media-types/ the example path is /employees and its summary says "Returns a list of employees." However, the response schema is

type: object # Data type
properties:
  id:
    type: integer
  name:
    type: string
  fullTime:
    type: boolean
example: # Sample data
  id: 1
  name: Jessica Right
  fullTime: true

Given that the path name is plural and the summary specifies "a list," I think that schema was meant to have been an array?

I don't think this technically impacts what this page of the documentation conveys, but it is confusing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docstriagedIssue has been reviewd

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions