zowe / zowe/api-layer

Fix homepage URL at API Catalog

Open
#3,299 19 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue Priority: Medium size/M
Dominant language
Java
Stars
92
Forks
81
Avg merge
1d 9h
Merged PRs (30d)
46

Description

Is your feature request related to a problem? Please describe.
The API Catalog displays the URL of the service's homepage. This value is provided by the service. It usually uses the URL with the port of the service. It could be improved by using the APIML Gateway URL, but it is still not the best solution. The APIML could be run in HA and use a DVIPA address. Any service cannot know about this address. It is not the responsibility of a service but the APIML.

Describe the solution you'd like
The API Catalog should update the homepage URL during the transformation of the service's data to use the external domain and routing through the Gateway.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the API Catalog transformation that converts service data and trace how the homepage URL and external domain or Gateway routing information are obtained. Confirm the desired behavior for Gateway routing, including HA with a DVIPA address; the work is done when the catalog displays the externally reachable homepage URL rather than the service's own URL.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.