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

Issue with docs.zowe.org/stable/getting-started/zowe-architecture/ - Inconsistent documentation for API Catalog port #3789

Open
recaph opened this issue Jul 31, 2024 · 2 comments

Comments

@recaph
Copy link

recaph commented Jul 31, 2024

Description

Zowe Architecture mentioned port for API Catalog as 7552 but the url for link on API Mediation Layer page takes me to something like https://<ZOWE_HOST_IP>:7554/apicatalog/ ..

image

When I try to open https://<ZOWE_HOST_IP>:7552/apicatalog/ I see API Catalog loading with a lot of errors and finally show something like

image

Please clarify the usage of the ports and what port should be used for calling any rest api endpoints. What ports should an API Users, API Developer and Zowe Admin should care for.

Pages to Update

https://docs.zowe.org/stable/getting-started/zowe-architecture/ and all associated page where ports are listed

Expected behavior

Please designate any internal ports and external ports for Zowe clearly in context of API Developer and Zowe Admin separately.

@recaph recaph changed the title Issue with docs.zowe.org/stable/getting-started/zowe-architecture/ - Inconsistent with port usage for API Catalog Inconsistent documentation for ports for API Catalog Jul 31, 2024
@recaph recaph changed the title Inconsistent documentation for ports for API Catalog Inconsistent documentation for API Catalog port Jul 31, 2024
@recaph recaph changed the title Inconsistent documentation for API Catalog port Issue with docs.zowe.org/stable/getting-started/zowe-architecture/ - Inconsistent documentation for API Catalog port Jul 31, 2024
@balhar-jakub
Copy link
Member

@recaph Thanks for sharing. The architecture tries to outline the fact that right now, the API Catalog is a service that runs on it's own port 7552, but the API Catalog depends on API Gateway and as such doesn't work outside of the access through the API Gateway e.g. the port 7554.

@recaph
Copy link
Author

recaph commented Aug 1, 2024

@balhar-jakub I am not sure “ API Catalog depends on API Gateway and as such doesn't work outside of the access through the API Gateway e.g. the port 7554.” part is highlighted enough in the docs.. if it does could you point me to that…

at least current one was confusing for me..

as an API User, I am looking for information that I can use right away instead piecing things together…

like I expected opening 7552 to take me to a functional page rather than a broken page… no redirect or message to indicate 7554 is right url for it…

7552 makes sense only to Zowe Admin who has to give permission to that port.. and no a day to day user of APIs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants