search

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

Fixes to openapi.yaml so that it properly validates #18

Closed nplumley closed 7 years ago

nplumley commented 7 years ago

Hi Kin,

I started working on a Google Cloud implementation using Cloud Endpoints and found that the openapi.yaml had several problems that were causing me trouble. I used the online swagger editor [http://editor.swagger.io/#/], fix all of the issues, and have successfully pushed the new file to a Google Cloud project.

1) Paths cannot end with a slash 2) Parameters must have 'type' and 'required' fields specified 3) operationIds must be unique but many were duplicated (especially the get-xxx ones). I changed the prefix for the list operations to 'list-' 4) In the 'definitions' section, the 'required' fields must be declared in an array rather than using 'required: 1' and 'required: 0' 5) Several parameters were misnamed/missing/etc

kinlane commented 7 years ago

Thank you. Appreciate the fixes. I was working on schema validator this weekend, to help me programmatically catch these with each build / shift -- getting behind.

The paths cannot end with slash is an interesting stance by google. I go either way on this one with slash or without, but each way is definitely a different resource.

I look forward to seeing more on how you are using Google.