OpenAPI specs - Summary attribute

bcgov / DBC-APIM

DataBC OPEN API Services

Apache License 2.0

1 stars 0 forks source link

OpenAPI specs - Summary attribute #31

Closed BK01 closed 7 years ago

BK01 commented 7 years ago

Skills / SW:

OpenAPI spec (swagger 2.0)

Description:

Fork OpenAPI specs located at the following repo. https://github.com/bcgov/api-specs
Add a 'summary' attribute for each resource
Initially only complete for the BCGNWS OpenAPI spec to be followed by DataBC review and feedback

Deliverables:

Pull request submitted for a new version of the BCGNWS OpenAPI spec (include summary attribute)

banders commented 7 years ago

I have added the summary attributes to each resource of the BCGNWS API spec. The pull request has been merged into the bcgov repo, and the updated spec file is here.

Let me know if you'd like me to add "summary" attributes to the other API spec files.

BK01 commented 7 years ago

@banders @ll911 Thank you. We will merge the new BCGNWS API spec, review/QA and let you know about additional API specs.

BK01 commented 7 years ago

@banders Tests were successful.

Currently the BCGNWS, Geomark, Open511 and BC Laws API specs have included the summary attribute.

Please proceed to add the summary attribute to the API specs of the geocoder, gated-geocoder, BCDC API and BC Route Planner.

banders commented 7 years ago

I added 'summary' to geocoder, gated-geocoder, BCDC and router. Pull request is here.

banders commented 7 years ago

The above-noted pull request has been merged into the api-specs master branch. Let me know if any problems arise when the API specs are viewed in swagger-ui.