Discoverability of YAML config files in the manager Activity log

[timng-bcgov]

API Services Portal Issue

User Story

As an API provider,

I want to reference Gateway configuration files in the API Services Portal

so that I know which files were applied to any given Gateway.

Test Case

ENV

• DEV
• TEST
• PROD

TESTCASE

Navigate to the Activity log for a specific gateway https://api.gov.bc.ca/manager/activity

It's possible to reference the YAML file that was used for Gateway config by selecting the More details action on a " published gateway configuration" item:

A modal dialog will open upon interaction to show the contents of the config file:

EXPECTED

I'm concerned about the usability of the modal, specifically the call to action for the interaction (More details) and the modal title (Activity Details). I'm wondering if the modal component is used for any other purpose on the Activity page. If not, then we should consider renaming both items. It may also be helpful to include a modal description. I will also note that no reference is made in the DevHub documentation that the config file can be surfaced in this manner.

ACTUAL

As described above.

ERROR

Notes

This is an observation I made after discussion with a client in which we were trying to locate a Gateway configuration file and the Activity log was brought up as a possible source.

[rustyjux]

I have been thinking about this user story as well. One could approach this on an slightly more fundamental level which is to say there should be an API endpoint for retrieving gateway configuration (most recent, or potentially also historical). Then we could also integrate this function into the gwa-cli.

One unfortunate aspect of the current way gw config is provided from the /activity endpoint is that it is in Kong format, rather than the resource-based format we recommend and use in our tutorials (see docs for more on formats), regardless of the format the config was sent in. It isn't overly difficult for a user to do the conversion, but it would be nice to save them the effort.

So IMO, the acceptance criteria for work on providing access to current config would be to give an option to get gw config in Kong or resource-based format (if plan to continue supporting both).

We might also consider supporting the export of other resources (Products, Datasets, etc) in the Gateway, alongside the gw config.