IBM Support

LI81125: API WITH MARKDOWN IN THE DESCRIPTION IS NOT DISPLAYING CORRECTLY

Subscribe

You can track all active APARs for this component.

 

APAR status

  • Closed as program error.

Error description

  • If you create an API with markdown table (eg. in the
    description), the table in the markdown does not render
    properly.
    
    Example of the API with markdown
    description:
    
    description: >-
     | Error, Error_description |
    Description | Example |
     |-----------|--------------------------
    -|-----------------------------------|
     | | The user has no
    access. | ``
    
    {"request_id":"0dddeff2-4229-0de6-9ui0-1498331e9922"} `` |
     |
    #XXX restapi.ScopeFault | The solution has
     transmitted an
    incorrect request. The required scope is missing. It
     is up to
    the software provider to ensure that the request is
     correct. |
    ``
     {"error_uri":"http://www.example-error.com", "request_id":"0
    dddeff2-4229-0de6-9ui0-1498331e9922","error":"#XXX","error_descr
    iption":"restapi.ScopeFault"}
     `` |
     examples:
    
    application/json: |
     [
     {
    
    "error_uri":"http://www.example-error.com", "request_id":"0dddef
    f2-4229-0de6-9ui0-1498331e9922","error":"#XXX","error_descriptio
    n":"restapi.ScopeFault" }
     ]
    

Local fix

Problem summary

  • Markdown in response descriptions was not being honored.
    

Problem conclusion

  • Fix will be included in API Connect v2018.4.1.8
    

Temporary fix

Comments

APAR Information

  • APAR number

    LI81125

  • Reported component name

    API CONNECT ENT

  • Reported component ID

    5725Z2201

  • Reported release

    18X

  • Status

    CLOSED PER

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2019-10-04

  • Closed date

    2019-10-17

  • Last modified date

    2019-10-17

  • 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

    API CONNECT ENT

  • Fixed component ID

    5725Z2201

Applicable component levels

  • R18X PSY

       UP

[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSMNED","label":"IBM API Connect"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"18X","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
29 September 2021