API Services Portal Issue

This ticket is like #1005 but more straightforward in that we'd be working with the existing structure of the BCDC and there is little ambiguity.

User Story

As an API provider sharing an API on the API Directory, I want to be able to provide an obvious link to my OpenAPI spec, so that potential consumers can find existing resources for my API.

///

As an API Consumer, I want to be able to consistently find the OpenAPI spec, so that I have a logical next step to follow to access an API after finding an API listing in the Directory.

More details

Most APIs in the catalogue already have their API spec as a resource, e.g. https://catalogue.data.gov.bc.ca/dataset/bc-gov-news-api-service

The link on the Directory listing can go to our Swagger UI console with the API spec loaded (spec URL to https://openapi.apps.gov.bc.ca/?url=, e.g. https://openapi.apps.gov.bc.ca/?url=https://raw.githubusercontent.com/bcgov/api-specs/master/news/news-oas3.yaml#/).

There is no UX design for this feature, but the link to the API console should probably be a standalone button next to the name of the API (dataset), which is in the same location for both catalogue-linked and unlinked datasets.

Along with the UI changes to the Directory, we need to:

modify the schema for DraftDataset to include a new field (e.g. openapispec) which contains the url
modify the CKAN feeder (which pulls data from the BCDC) to add this URL to datasets in our db
modify the CKAN feeder to loosen the search requirements to routinely update more datasets (currently fetches only datasets in bc-government-api-registry group, daily)

Test Case

TESTCASE

View an API Directory listing for a dataset which has a resource with bcdc_type: webservice and format: openapi-json

EXPECTED

Link to Swagger console

bcgov / api-services-portal

Directory: Link to OpenAPI Spec #1044