OpenAPI Console - DWDS OFI

BK01 commented 7 years ago

When available, meeting to be held with DataBC and DWDS vendor to review existing documentation and API details.

Skills / SW:

yaml, json, OpenAPI, Swagger Editor

Description:

Create an OpenAPI spec for DWDS OFI API
api spec to have tag sections expanded by default shown as 'list operations' (same as Geocoder)
Include a brief description (1-2 sentences) below the API title
Include a link for further details (example below): More Information: https://catalogue.data.gov.bc.ca/dataset/530503ce-6c81-4e27-ab1a-776b48b41b4d Contact the developer (hyperlink to: https://forms.gov.bc.ca/databc-contact-us/) OR : data@gov.bc.ca

Deliverables:

yaml api spec file for DWDS OFI
json api spec file for DWDS OFI

BK01 commented 7 years ago

The inclusion of total downloads (all time & per time period) per data object are not currently available in OFI’s API but are included as an idea for the future. That said, the information is already in tables, but in its current state you would need to write SQL to access the numbers.

Are there any options to create analytics to show views or download requests exclusive to BCDC API?

BK01 commented 7 years ago

DWDS OFI API console in development under another project

BK01 commented 6 years ago

DataBC has a draft spec ready for testing and refinement.

BK01 commented 6 years ago

DWDS OFI Swagger 2.0 spec received and uploaded into BCDC-TEST. GitHub can be used in the future once API owner approves. Next steps, fix errors and convert to OpenAPI 3 spec.

BK01 commented 6 years ago

DataBC to move spec to Gogs repo for DWDS-OFI. To speak to TL about using conversion script to bring to OAS 3.

BK01 commented 6 years ago

Complete - in cat.data.

bcgov / DBC-APIM

OpenAPI Console - DWDS OFI #16