IBM Support

PI68850: DESCRIPTION OF SOME REST APIS MAY BE MISSING FROM SWAGGER DOCUME NT.

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as program error.

Error description

  • When the API Discovery feature has been enabled, the
    description of REST APIs from some applications may not be
    included in the Swagger document returned from the
    ibm/api/docs endpoint.
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED:  All users of IBM WebSphere Application      *
    *                  Server that use the API Discovery feature.  *
    ****************************************************************
    * PROBLEM DESCRIPTION: The description of some REST APIs may   *
    *                      be missing from the Swagger document    *
    *                      returned by the ibm/api/docs endpoint.  *
    ****************************************************************
    * RECOMMENDATION:  Install a fix pack that contains this       *
    *                  APAR.                                       *
    ****************************************************************
    When the API Discovery feature has been enabled, the
    description of REST APIs from some applications may not be
    included in the Swagger document returned from the
    ibm/api/docs endpoint. This may occur when the application has
    packaged a META-INF/swagger.json or META-INF/swagger.yaml file
    that describes the REST APIs contained within the application.
    

Problem conclusion

  • The API Discovery feature was attempting to read the
    META-INF/swagger.json file using the application's
    ClassLoader. The file may exist but may not be accessible
    because the ClassLoader was restricting its visibility. In such
    a case, the Swagger document returned from the ibm/api/docs
    endpoint would be missing the description of the REST APIs that
    were contained in the application.
    
    This issue was resolved by querying the web module archive
    directly for the META-INF/swagger.json file if the attempt to
    read it from the ClassLoader failed.
    
    The fix for this APAR is currently targeted for inclusion in
    fix pack 9.0.0.2. Please refer to the Recommended Updates
    page for delivery information:
    http://www.ibm.com/support/docview.wss?rs=180&uid=swg27004980
    

Temporary fix

Comments

APAR Information

  • APAR number

    PI68850

  • Reported component name

    WEBSPHERE APP S

  • Reported component ID

    5724J0800

  • Reported release

    900

  • Status

    CLOSED PER

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2016-09-08

  • Closed date

    2016-09-13

  • Last modified date

    2016-09-13

  • 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

    WEBSPHERE APP S

  • Fixed component ID

    5724J0800

Applicable component levels

  • R900 PSY

       UP

[{"Business Unit":{"code":"BU053","label":"Cloud \u0026 Data Platform"},"Product":{"code":"SSEQTP","label":"WebSphere Application Server"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"900","Line of Business":{"code":"LOB36","label":"IBM Automation"}}]

Document Information

Modified date:
18 October 2021