Confusing service IDs for z/OSMF

[ATorrise]

Is your feature or enhancement request related to a problem or limitation? Please describe
Customers have indicated confusion around choosing a service ID for z/OSMF:

• When the service ID is registered as zosmf, the CLI automatically prepends /zosmf/ to the base path of API requests
• When the service ID is registered as ibmzosmf, APIML manages the base path, and the CLI does not add /zosmf/

The current doc suggests replacing ibmzosmf with the correct service ID but doesn't explain that ibmzosmf allows APIML to handle the base path, stopping the CLI from prepending /zosmf/. The doc makes it seem like ibmzosmf is a placeholder to be replaced, and isn't a valid service ID meant for APIML use.

Describe your enhancement idea

Update documentation to clarify the behavior when using zosmf vs. ibmzosmf as the service ID in the CLI documentation.
Be explicit that ibmzosmf allows APIML to control the base path, taking control from the CLI’s automatic base path handling.

or..

possible code change where the CLI detects whether it is using APIML. If APIML is detected, the CLI could skip automatically prepending /zosmf/, regardless of the service ID, to offload work from users.

Helpful links:

Understanding zosmfServiceId configuration
API Gateway configuration parameters and zosmfServiceId
Accessing services through API ML

[github-actions]

Thank you for raising this enhancement request.
The community has 90 days to vote on it.
If the enhancement receives at least 5 upvotes, it is added to our development backlog.
If it receives fewer votes, the issue is closed.

[balhar-jakub]

The topic of zosmf vs. ibmzosmf is relevant only for V2. Starting with V3 the only available service id is the ibmzosmf. It's possible to change the behavior of the /ibmzosmf

If the default behavior without API ML doesn't handle basePath, one of the options in V3 release stream is to change the static definition for ibmzosmf to not provide the basePath as well.