bcgov / gwa-cli

Apache License 2.0
6 stars 1 forks source link

Namespace to Gateway - (CLI) Support users creating services and routes without name conflicts #101

Closed rustyjux closed 1 month ago

rustyjux commented 4 months ago

As a new API provider following the quick start tutorial, I need to be able to avoid/navigate service name conflicts to get up and running quickly and without issue.

The original idea here was to have a quick-start template prepended namespace to service (argument) to avoid service and route name conflicts (using the client-credientials-shared-idp template).

The new idea is to add an API call (in v3) which checks if a service name (and route?) is available (https://github.com/bcgov/api-services-portal/issues/1065). Once complete, this API call will require implementation within the CLI.

I'd suggest including this call as part of generate-config (to save the user creating a config only to find out it can't be published when they go to apply/pg). It would also be helpful to incorporate the availability API into apply and pg - both commands make use of PublishToGateway

rustyjux commented 2 months ago

At some point generate-config usage like

gwa generate-config --template quick-start

was proposed.

I'm not exactly sure what the intended use was - it could be either starting the interactive (but with template chosen), or auto-filling service and upstream.

Does it make sense to have service auto-generated and upstream filled with a default (like httpbin.org)?

@ikethecoder

rustyjux commented 2 months ago

Takeaways from this morning:

Elson9 commented 2 months ago

Check library for back-filling template flag for interactive mode

Elson9 commented 2 months ago

Discussion comments not related to service name conflicts reflected in a separate issue: #110

Elson9 commented 2 months ago

PR: #114