IBM Support

PH03360: A blank path prevents Swagger from working in the API toolkit Swagger UI.

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as unreproducible in next release.

Error description

  • If a value is not set in the Path field when creating an API
    with the z/OS Connect EE API toolkit the project can be saved
    and deployed.
    
    Testing the API using the Swagger UI in the API Toolkit, the
    field is set to the number 1 and no response is received from
    the z/OS Connect EE server.
    
    The same API can be successfully invoked via a browser or a REST
    client.
    

Local fix

  • Put a single / in the path.  This will slightly change the URIs
    for the requests, and the swagger document will be valid.
    

Problem summary

  • ****************************************************************
    * USERS AFFECTED: All users of z/OS Connect EE V3.             *
    ****************************************************************
    * PROBLEM DESCRIPTION: A blank path prevents Swagger from      *
    *                      working in the API toolkit Swagger UI.  *
    ****************************************************************
    The z/OS Connect EE  API toolkit allowed the Path field in the
    API Editor to be empty but the Swagger specification does not
    allow the corresponding property to be empty, so the generated
    Swagger document is invalid.
    

Problem conclusion

Temporary fix

Comments

  • The API toolkit has been changed to prevent Path definitions
    that do not  start with a forward slash (/) being used. An
    attempt to specify a blank value will result in the following
    message being displayed:
    API path must start with a forward slash (/).
    
    This problem has been resolved in release 3.0.6.0 of the z/OS
    Connect EE API toolkit.
    

APAR Information

  • APAR number

    PH03360

  • Reported component name

    Z/OS CONNECT EE

  • Reported component ID

    5655CE300

  • Reported release

    000

  • Status

    CLOSED UR1

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2018-09-27

  • Closed date

    2019-01-25

  • Last modified date

    2019-01-25

  • APAR is sysrouted FROM one or more of the following:

  • APAR is sysrouted TO one or more of the following:

Fix information

  • Fixed component name

    Z/OS CONNECT EE

  • Fixed component ID

    5655CE300

Applicable component levels

[{"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"SSNPJM","label":"IBM z\/OS Connect"},"Component":"","ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"3.0","Edition":"","Line of Business":{"code":"LOB35","label":"Mainframe SW"}}]

Document Information

Modified date:
14 February 2023