bcgov / DBC-APIM

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

Server Parameter #69

Open BK01 opened 6 years ago

BK01 commented 6 years ago

Use the server parameter to specify the api environment for additional specs. Full list of candidate specs are still to be determined. Initial list below.

For the following APIs use the server parameter to list environments delivery, test and prod (default).

Geomark Route Planner BCDC BCGNWS Geocoder / pub+gated

BK01 commented 6 years ago

DataBC to provide URL's and descriptions

BK01 commented 6 years ago

URLs provided via email

banders commented 6 years ago

@BK01 @ll911 @Darv72 Some of the API Specs currently have two "Servers" listed: one for HTTP, one for HTTPS. Recall, APIs using HTTP cause mixed content errors in the API console (which itself is loaded over HTTPS). Should I remove the HTTP option to avoid this problem? A secondary benefit is that listing HTTPS only will reduce our server options list from 6 items to 3 items.

BK01 commented 6 years ago

@banders Sounds reasonable to me. Lets try that proposed approach and test in cad using OAS3 specs from your repo.

banders commented 6 years ago

@BK01 I have updated the following API specs (OAS3) with "server" URLs for delivery, test and prod:

https://github.com/banders/api-specs/tree/upgrade-to-openapi3

BK01 commented 6 years ago

@BK01 DataBC to use with new viewer, as well as UAT for CORS issues in TEST. Add comment or disclaimer that DLV/TEST will work in gov't domain through BCDC viewer. In external viewer may have issue. Also confirm usage of BCDC permalinks and ideal bbox params

BK01 commented 6 years ago

DataBC will fork and update once latest OAS3 specs are merged into master (PROD viewer migration)

BK01 commented 6 years ago

api-spec update complete in BK01 repo. Next UAT, followed by PR to banders repo.

BK01 commented 6 years ago

@banders changes to api-specs available for your review in this pull request

BK01 commented 6 years ago

@BK01 to repeat UAT

BK01 commented 6 years ago

UAT successful