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

Make accessing Your Products (API Directory) easier #1160

Open rustyjux opened 2 months ago

rustyjux commented 2 months ago

API Services Portal Issue

User Story

As a API provider,
I want to be able to access 'Your Products' from the API Directory tab
so that I can easily and intuitively navigate the Portal.

When no Gateway is active (i.e. following login), the API Directory page does not show the 'Your Products' link or Gateway dropdown selector, requiring a roundabout navigation (via Gateways) to view Your Products. This problem comes out of the relocation of the Namespace/Gateway selector (and thus is only in dev/test as of 2024-08-29).

Solution: I don't have a proposed solution yet!

See also #1143 - first any page renames should be completed, then the links to 'Your Products' / 'Preview in Directory' / 'View Dataset' should be updated/unified as appropriate, so that it is also easy to nav to 'Your Products' from Gateway detail and Products pages.

More details

API directory page looks like (NS to GW) - cannot select Gateway: image

vs prior to NS to GW - Namespace selector is always visible: image

Users now no longer have the Namespace dropdown up top, so the only way to get to Your Products is to first activate a Gateway from a Gateways page.

On the other hand, hiding Your Products without a Gateway active is good, because API consumers (ie users without any Gateways) won't see a page that's not relevant to them. Your Products should stay hidden for users without Gateways in any solution.

timng-bcgov commented 2 months ago

I don't necessarily see this as a bad thing, since we direct users to preview their Products using the Gateways manager in our revised tutorials. But we haven't heard much from users about how they access their Products and the API Directory. So I see a few options that are likely out-of-scope of the ns-to-gw release and would defer making a decision without further research:

rustyjux commented 2 months ago

Re: option 2 - this is very doable. We already show the same 'Gateway selected: ' bar on Your Products, once you get there. image

Re: option 1 - I have felt (and still feel) like a better place for the Gateways dropdown is in the nav bar next to Gateways. With Gateways selected: image

Not totally sure how this implementation could look if the user is in the Directory.

Anyway looks like this issue really needs to wait until we have a more clear stance on the location for the dropdown.