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

Add more details for APS Terms in the Gateway configuration documentation #1165

Open
SateeshFW opened this issue Sep 6, 2024 · 0 comments
Open
Labels
enhancement New feature or request jira

Comments

@SateeshFW
Copy link

SateeshFW commented Sep 6, 2024

API Services Portal Issue

Priority: Low

Issue Type: Feature/Enhancement

User Story

As an API Provider,
I want to understand the APS terms in the Gateway configuration documentation (Get-started),
so that I can have a clearer understanding of the gateway resources.

Current Information
The information provided under the section "Apply configuration to your Gateway" in Get-Started page.

With this command you can apply your configuration to your recently created Gateway. If you need to make updates or republish, simply run this command again.

Proposed New Message Flow:
In Get-Started page, the section "Apply configuration to your Gateway" can be expanded to add below details...

You'll see the GatewayService configuration, including:

the upstream service (url)
the route that exposes the GatewayService at the new endpoint (routes.hosts)
tags on each object with the format tags: [ ns.<GatewayId> ]
Below the GatewayService, you'll find additional resources:

_Product_ packages GatewayServices for managing consumer access
_DraftDataset_ provides metadata about the service for the API Directory
Don't worry if you don't understand all the details, you will learn more about Gateway configuration as you continue to work with the API Services Portal.

Acceptance Criteria

  • The term 'Dataset' is clearly defined
  • The term 'Product' is clearly defined
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request jira
Projects
None yet
Development

No branches or pull requests

2 participants