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

recaph commented 1 month ago

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://:7554/apicatalog/ ..

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

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.

balhar-jakub commented 1 month ago

@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 commented 1 month ago

@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.

zowe / docs-site