IBM Support

LI81616: DOUBLE QUOTES IN EXAMPLE DEFINITION ARE SHOWN WITH BACKSLASHES IN THE DEVELOPER PORTAL EXPLORER

Subscribe to this APAR

By subscribing, you receive periodic emails alerting you to the status of the APAR, along with a link to the fix after it becomes available. You can track this item individually or track all items by product.

Notify me when this APAR changes.

Notify me when an APAR for this component changes.

 

APAR status

  • Closed as program error.

Error description

  • When you define in your swagger definition examples containing
    double quotes, when the information is rendeed in the developer
    portal explorer it is escaped with backslashes.
    For example an operation parameters defined like this:
    ===
    name: extf-file
    in: body
    required: true
    schema:
    type: string
    format: binary
    example: |
    "EXTF";700;16;"Debitoren/Kreditoren";5;20200108134956610;;"RE";"
    TestUser";"";29098;55003;20200101;4;;;"";"";;0;;"";;"";;;"03";;;
    "";""
    ...
    description: |
    Content of the extf-file.
    Max allowed file size: 50 MB
    x-mimetype: application/extf
    ===
    Which gets build in the swagger Editor like this, which we also
    want to achieve in our Developer Portal:
    "EXTF";700;16;"Debitoren/Kreditoren";5;20200108134956610;;"RE";"
    TestUser";"";29098;55003;20200101;4;;;"";"";;0;;"";;"";;;"03";;;
    "";""
    ...
    But the actual result in the DeveloperPortal is this:
    "\"EXTF\";700;16;\"Debitoren/Kreditoren\";5;20200108134956610;;\
    "RE\";\"TestUser\";\"\";29098;55003;20200101;4;;;\"\";\";;0;;\"\
    ";;\"\";;;\"03\";;;\"\";\"\""
    

Local fix

Problem summary

  • When you define in your swagger definition examples containing
    double quotes, the information rendered in the developer
    portal explorer incorrectly with displays backslashes.
    

Problem conclusion

  • Product is updated in 2018.4.1.16 and 10.0.2 to address the
    issue.
    

Temporary fix

Comments

APAR Information

  • APAR number

    LI81616

  • 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

    2020-07-16

  • Closed date

    2021-04-01

  • Last modified date

    2021-04-01

  • 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