search

bcgov / DBC-APIM

DataBC OPEN API Services
Apache License 2.0
1 stars 0 forks source link

2) Upgrade: OpenAPI specs #49

Open BK01 opened 7 years ago

BK01 commented 7 years ago

Upgrade OpenAPI specifications to version 3.x

BK01 commented 7 years ago

Waiting for support from Swaggerui 3 for OpenAPI 3

BK01 commented 7 years ago

OpenAPI 3.0 has now been released -> https://swagger.io/announcing-openapi-3-0/ To discuss Aug 15th

BK01 commented 7 years ago

Waiting for swagger-ui to be upgraded to support OpenAPI specs 3.x (expected soon)

BK01 commented 7 years ago

swagger-ui now supports OAS 3.0. However, we need to wait for the 'Try It Out' functionality to be implemented for OAS 3.0

BK01 commented 7 years ago

Try it Out functionality now available. Initiating work.

banders commented 7 years ago

@ll911 @BK01 I have updated the version of swagger-ui used by the API Console. The new swagger-ui now supports OpenAPI 3. Leo has deployed it to BCDC in delivery.

I have also converted most of the specification files to OpenAPI 3 (all except the two geocoder files). Currently the changes are in this branch within my fork of the api-specs repo.

We can test these files with the API Console in delivery by creating new BCDC "resources" pointing my repo at the branch noted above. We shouldn't replace the spec files in the bcgov api-specs master repo until the latest API Console has been migrated to BCDC Prod (because the API Console currently in Prod doesn't support OpenAPI 3).

I have done some preliminary testing on all the converted spec files in the new API Console, but it would help to have more eyes on this. It would be excellent if you have a chance to look as well.

I'll work on the geocoder specification files next.

BK01 commented 7 years ago

Thank you Brock. DataBC will begin testing the API console with new specs in delivery.

BK01 commented 6 years ago

On hold until new version of swagger-ui available with full openAPI 3.x support for our specs.

BK01 commented 6 years ago

DataBC to begin UAT in cad.data

BK01 commented 6 years ago

DataBC completed UAT in cad.data. Issue with Route Planner has been resolved. Open511 and BCLaws will continue to reference the old API console (http://apps.gov.bc.ca/pub/api-explorer/?url=) until issue with HTTPS support and CORS are resolved. Therefore, OAS3 spec and new console / editor migration can continue as planned.

BK01 commented 6 years ago

@banders All API consoles successful except for one.

The BCDC console TEST and DLV environment URLs need to be adjusted. The current request URL is listed as:

banders commented 6 years ago

@BK01 I have fixed the 'delivery' and 'test' server URLs. New spec here:

https://github.com/banders/api-specs/blob/upgrade-to-openapi3/bcdc/bcdc.json

BK01 commented 6 years ago

@banders Confirmed. Successful UAT in cad.data for BCDC api spec