bcgov / api-services-portal

API Services Portal provides a multi-tenant frontend integrating API Gateway and Authorization services from Kong CE and Keycloak.
https://api.gov.bc.ca
Apache License 2.0
22 stars 7 forks source link

Update link to existing datasets in Products/Edit Product modal #1119

Open timng-bcgov opened 3 months ago

timng-bcgov commented 3 months ago

API Services Portal Issue

User Story

As an API Provider,
I want to understand the contents of datasets available to me in the Services Portal,
so that I can successfully create a Product and share my Gateway Services.

Test Case

ENV

TESTCASE

Create a new Product in the CLI or Services Portal by navigating to Gateway details > Products > New Product. Edit the Product details by selecting the ellipsis in the top right of the card beside Add Env > Edit product. An Edit product modal dialog will open with options to change the name of the Product and link to an existing dataset.

ACTUAL

The existing copy suggests that only datasets from BCDC can be linked:

Link to BC Data Catalogue Enter an existing dataset. This value is the slug value of a corresponding BCDC entry: https://catalogue.data.gov.bc.ca/dataset/slug

However, both datasets from BCDC and custom datasets that users have created in the gwa CLI are listed.

image

EXPECTED

If we want to allow users to find custom datasets from this modal, then the input copy and interaction design needs to be updated to support this. Additionally, there is no way for users to view the contents of datasets from this menu. It may be useful to be able to view the API metadata for both BCDC and custom datasets directly from this page on the Services Portal.

Notes

Related to #1062