reverb/swagger-spec

Parameters explicitly define names rather than enumerate them

Closed this issue · 3 comments

When defining parameters, they're given as an array rather than as keys. For example:

        - name: latitude
          in: query
          description: Latitude component of location.
          required: true
        - name: longitude
          in: query
          description: Longitude component of location.

versus:

      parameters:
        latitude:
          in: query
          description: Latitude component of location.
          required: true
        longitude:
          in: query
          description: Longitude component of location.
          required: true

This seems in contrast to the patterns set with paths, operations, and responses.

For parameters, we need the inputs to be consistently ordered. For operations (i.e. paths), they don't need to be except for display purposes.

Ok, then this must be a "won't fix." Since it is a deliberate design choice, it might be a good idea to document the reasoning, no?

sure thing. I'm going to close this