Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Design New API registration #88

Open
BK01 opened this issue Jan 17, 2018 · 4 comments
Open

Design New API registration #88

BK01 opened this issue Jan 17, 2018 · 4 comments

Comments

@BK01
Copy link

BK01 commented Jan 17, 2018

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 BK01 changed the title Micro-service: New API registration Quote: Micro-service: New API registration Jan 22, 2018
@BK01
Copy link
Author

BK01 commented Jan 23, 2018

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

@BK01 BK01 changed the title Quote: Micro-service: New API registration Quote / Design: Micro-service: New API registration Jan 23, 2018
@BK01 BK01 removed the CANDIDATE label Jan 23, 2018
@BK01 BK01 changed the title Quote / Design: Micro-service: New API registration Quote / Design: New API registration Jan 23, 2018
@banders
Copy link
Collaborator

banders commented Jan 29, 2018

@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
Copy link
Collaborator

banders commented Jan 30, 2018

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 BK01 changed the title Quote / Design: New API registration New API registration Feb 9, 2018
@BK01 BK01 changed the title New API registration Design New API registration Feb 9, 2018
@BK01
Copy link
Author

BK01 commented Feb 9, 2018

To review new design doc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants