API Connect

Expand all | Collapse all

XML in yaml description just shows entities in Dev Portal

  • 1.  XML in yaml description just shows entities in Dev Portal

    IBM Select
    Posted Wed September 22, 2021 11:46 AM
    Edited by Irfan Khairi Thu September 23, 2021 09:36 AM
    Hello together,

    I am struggling with the github markdown in API Developer Portal Description (being placed in the yaml file itself).

    This is my markdown text being placed in the yaml:

    #### Release Notes
    | Version | Release | Description |
    | ----------- | ----------- | --------------- |
    | 1.0.0| MA202111 | Initial version |

    #### Example request

    ```xml
    <soapenv:Envelope xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Header>
    <wsa:To>blabla</wsa:To>
    <wsa:Action>blabla</wsa:Action>
    <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">${= "urn:uuid:" + UUID.randomUUID()}</wsa:MessageID>
    </soapenv:Header>
    <soapenv:Body>
    [...]
    ```

    This is what is shown in DevPortal:

    Release Notes

    Version Release Description
    1.0.0 MA202111 Initial version

    Example request

    &lt;soapenv:Envelope xmlns:wsa=&quot;http://www.w3.org/2005/08/addressing&quot; xmlns:soapenv=&quot;http://schemas.xmlsoap.org/soap/envelope/&quot; &lt;soapenv:Header&gt; &lt;wsa:To&gt;blabla&lt;/wsa:To&gt; &lt;wsa:Action&gt;blabla&lt;/wsa:Action&gt; &lt;wsa:MessageID xmlns:wsa=&quot;http://www.w3.org/2005/08/addressing&quot;&gt;${= &quot;urn:uuid:&quot; + UUID.randomUUID()}&lt;/wsa:MessageID&gt;
    






    I would like to get rid of the entities being shown and have a correct xml as example in DevPortal in the description.

    I used backticks and <pre><code>, but nothing worked. Also I tried to convert to entities in html als well so that they get converted back when deployed, but this also showed the entities.

    Does someone know how to make DevPortal recognize xml correctly in the description of a yaml?

    Thanks and best regards
    Silja



    ------------------------------
    Silja Woelk
    ------------------------------


  • 2.  RE: XML in yaml description just shows entities in Dev Portal

    Posted 8 days ago
    What you show looks like an escaped XML string which is why the < characters are changed to &lt; etc.  I'd suggest opening a PMR to determine if this is a product defect.

    Regards,
    Steve

    ------------------------------
    Steve Linn
    Senior Consulting I/T Specialist
    IBM
    ------------------------------