openreferral / api-specification

This is the working repository for Open Referral's Human Services Data API protocols.
https://openreferral.readthedocs.io/en/latest/hsda/
Other
29 stars 13 forks source link

Wrong definitions for /locations/{location_id}/physical-address/ requests #75

Closed vtimonov closed 3 years ago

vtimonov commented 6 years ago

The requests below should be specified for the physical addresses of a specific location, but in openapi-hsda.yaml they are defined as postal-address:

/locations/{location_id}/physical-address/ /locations/{location_id}/physical-address/{postal_address_id}/

/locations/{location_id}/physical-address/:
    get:
      summary: Get physical addresses for location
      description: Returns a list of physical addresses for a specific location
      operationId: listLocationPhysicalAddresses
      parameters:
        - in: path
          required: true
          type: string
          name: location_id
          description: 'The unique location id.'
      responses:
        '200':
          description: Postal Address Response
          schema:
            type: array
            items:
              $ref: "#/definitions/postal_address"
kinlane commented 3 years ago

This has been cleaned up in the latest copy of the OpenAPI definition.