search

bcgov / DBC-APIM

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

Design New API registration #88

Open BK01 opened 6 years ago

BK01 commented 6 years ago

Investigate and propose design for a service to enable new BC Gov't API owners (IDIR) to register their API's with Kong. The service should be able to be called from a button in BCDC (add dataset for example when logged in), the API console or GWA.

API owners will still be responsible for using BCDC in a self-serve manner to describe their APIs (metadata, API console etc).

The scope of this issue is limited to technically registering an API with DataBC's implementation of Kong.

BK01 commented 6 years ago

2 components - service + UI

Log into BCDC, click 'add dataset'.. Form or modal window for API owner (IDIR) to fill out (backend, default rate limit, name of API, shortname.api.gov.bc.ca, metadata URL (draft or pub) - DataBC to confirm fields and default values etc To result in email to LL, SD and BK. LL or SD setup in GWA

banders commented 6 years ago

@BK01 I send you an email with a proposed system design. If you're happy with the proposed design, I can send a quote.

banders commented 6 years ago

The proposal was discussed during a conference call today. It was suggested that we extend the capabilities of the REST API. It will now perform two tasks (item 1 below is the new requirement):

  1. Create a new draft metadata record in BCDC for the API (if no such record currently exists)
  2. Send an email to DataBC with details of the proposed new API.
BK01 commented 6 years ago

To review new design doc