Hide the ZOSMF endpoint from API Catalog

[GilPen]

Hello

We would like to give ZLUX to our development team because we developped some APIs which could be useful for them.

Our APIs could be start from the ZLUX API CATALOG entry but we wouldn't like to expose the zosmf endpoints. Of course SAF roles stop some ZOSMF operations but we would like to hide this tile.

We want they use our own APIs which make some additional controls and not the natives zosmf REST API.

I can disable our own endpoints in the zowe yaml but I didn't find the good syntax to disable zosmf endpoints.

Example: £ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
£ Each extension can have dedicated definition similar to core components.
api-zaas-utilities: <- disable our own endpoint which calls api-zaas-utilities
enabled: false

Environment ZOS 2.4 ZOWE 2.8 node-v16.17.1-os390-s390x-202210212032 Java(TM) SE Runtime Environment (build 8.0.7.20 - pmz6480sr7fp20-20221020_01(SR7 FP20))

Thank you for your help

Regards Gilles

[1000TurquoisePogs]

Can an API Layer dev weigh in? I may misunderstand but it looks like although you can disable zOSMF, it looks like the static definition file exists unconditionally such that you might still get the zOSMF tile but set to undefined:undefined URL? I'm just observing this https://github.com/zowe/api-layer/blob/v2.x.x/discovery-package/src/main/resources/zosmf-static-definition.yaml.template

[GilPen]

Hello, Thank you for your answer

In fact I don't want to disable zosmf APIs from the ZLUX because our API use zosmf too.

I'd like the tile disappears in the ZLUX browser because I would like developers use our own API and don't use the zosmf APIs which are given with ZLUX.

[pablocarle]

@GilPen I will validate this with the team but I think there's currently no mechanism to hide the z/OSMF tile in API Catalog. If this is the case we need to handle this as an enhancement.

[pablocarle]

@GilPen We will handle this request as an enhancement. Could you confirm if the intention is to have the possibility of hiding the API Catalog tile? Please be aware -if this is the case- that hiding of the tile will not make the API not callable (or discoverable). For example, the z/OSMF API will still be registered to the API ML and visible for example in the Discovery Service registry. z/OSMF is in many cases required for API ML to function.

[balhar-jakub]

I believe we had a request like this before and that it actually was implemented.

[balhar-jakub]

It wasn't implemented, but the is linked to the following issues in the repository: #1977 #706 and #2952

[balhar-jakub]

@GilPen Looking again at your request, it's possible to remove the tile from the documentation for all the users. We don't have a way to keep it for some and disable for others at the moment.

If you want to disable it for some, you need to find the zosmf.yml or zosmf_template.yml file within Zowe workspace and remove the SwaggerUrl from the file.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

[github-actions[bot]]

This issue has been automatically closed due to lack of activity. If you disagree, please comment on reason why and reopen the issue