zowe / api-layer

The API Mediation Layer provides a single point of access for mainframe service REST APIs.
Eclipse Public License 2.0
56 stars 63 forks source link

IBM RSE API doesn't work under Zowe #3487

Open Josema-Kyndryl opened 7 months ago

Josema-Kyndryl commented 7 months ago

Under Zowe version 2.15.0+20240221, when we try to access the IBM RSE API from the Zowe API Catalog, we get the message...

API documentation could not be retrieved. There may be something wrong in your Swagger definition. Please review the values of 'schemes', 'host' and 'basePath'.

imagen

However, we found that the product swagger that we specified in /global/zowe/ZOSx/workspace/api-mediation/api-defs/application.yml swaggerUrl parameter is perfectly accessible

imagen

balhar-jakub commented 7 months ago

@Josema-Kyndryl There are two issues that would be first good to get out of way.

1) Can API Catalog access the Open API document?

You mention that you validated access, does this contain the validation of valid certificate for the RSE service and that the API Catalog doesn't reject the connection due to this and/or proxy issues?

2) Is the Open API document valid?

Did you validate with any of the online tools such as https://apitools.dev/swagger-parser/online/ or offline libraries such as https://pypi.org/project/openapi-spec-validator/?

If not, can you share the document here in the issue?

Another thing is, the same work of the API was working correctly in the previous version of the catalog?

@Joe-Winchester @AmandaDErrico Can you please make sure RSE team is aware, we may need their involvement to properly replicate and understand the issue and it may need to be handled with IBM as the community doesn't have access to the RSE API as far as I am aware.

Josema-Kyndryl commented 7 months ago

Hi @balhar-jakub

I attached a zip file with the /global/zowe/ZOSx/workspace/api-mediation/api-defs/application.yml file and also the file obtained from https://zosx.es.kyndryl.com:6800/rseapi/api-docs/swagger.json referenced in it. RSE.zip

I don't think there are any fw problems, since both the Zowe and RSEAPI STC run on the same system

Josema-Kyndryl commented 7 months ago

Hi @Joe-Winchester & @AmandaDErrico ; openAPI-spec-validator suggested by @balhar-jakub shows errors on RSE-API swagger.json: openapi-spec-validator.txt

Is it possible that a product PTF will be needed to correct them?