Layer7 API Management

  • Private Community
 View Only
Back to discussions
Expand all | Collapse all

Upload a RAML into the API interactive documentation

  • 1.  Upload a RAML into the API interactive documentation

    Posted Dec 16, 2016 02:52 AM

    Hi,

     

    Following problem was brought to my attention:

    When trying to upload a RAML 0.8 or RAML 1.0 into the API interactive documentation, no documentation is generated or shown on the front-end of the portal. The two attachments are the ones we are trying to upload. These are not real API definitions but a validated test RAML/WADL file.

    It looks like the conversion from RAML to WADL doesn’t work, because when we upload a WADL file with the same contents as the RAML file all works fine.

     

    We need to be able to upload RAML files, because only then we can automatically update the interactive documentation using our build server.

     

    Thanks,

     

    Maarten van Holst Pellekaan

    Attachment(s)

    zip
    test.raml.zip   1 KB 1 version
    zip
    test.wadl.zip   683 B 1 version


  • 2.  Re: Upload a RAML into the API interactive documentation
    Best Answer

    Posted Dec 20, 2016 06:34 PM

    Hi Maartenvhp,

     

    Before I dig further into this, I want to ask what might seem like an obvious one: Is this perhaps showing properly in Staging but just not in Published areas? If so, then the interactive documentation from the RAML will be in the Staging side and just needs to be published. 

     

    You may want to review this page, as it touches a little bit on the staging / published side of things for interactive documentation too: Edit Interactive Documentation - CA API Developer Portal - 3.5 - CA Technologies Documentation 

     

    Please review that and let me know if you still require further assistance, and we'll be happy to help.

     

    Sincerely,

     

    Dustin Dauncey

    Sr Support Engineer, Global Customer Success

    Email: Dustin.Dauncey@ca.com

    Phone: +1 800 225 5224 ,48385

    Phone if outside North America - https://tinyurl.com/CAContactSupport

    CA API Management Community: https://tinyurl.com/CAAPIMCommunity



  • 3.  Re: Upload a RAML into the API interactive documentation

    Posted Jan 06, 2017 09:02 AM

    Hi Dustin,

     

    Sorry it took a while for me to answer.

    I got feedback from tech. support. It is a bug in the system. CA is working on it.

    It is not clear yet when it will be fixed.

     

    Best regards,

     

    Maarten van Holst Pellekaan

    Enable-U



  • 4.  Re: Upload a RAML into the API interactive documentation

    Posted Mar 29, 2017 12:02 PM

    Hi Maartenvhp,

     

    Were you given a bug tracking number for this by any chance so I can track that one down in our system? I'd like to keep an eye on it.

     

    Sincerely,

     

    Dustin Dauncey
    Sr Support Engineer, Global Customer Success
    Email: Dustin.Dauncey@ca.com
    Phone: +1 800 225 5224 ,48385
    Phone if outside North America - https://tinyurl.com/CAContactSupport
    CA API Management Community: https://tinyurl.com/CAAPIMCommunity



  • 5.  Re: Upload a RAML into the API interactive documentation

    Posted Mar 30, 2017 02:16 AM

    Hi Dustin,

     

    Thank you for requesting for the bug tracking number and offering to keep an eye on it.

    However the problem has been solved for now. If you are still interested in the results this is the number: 00610277.

     

    Best regards,

     

    Maarten van Holst Pellekaan

    Enable-U



  • 6.  Re: Upload a RAML into the API interactive documentation

    Posted Mar 30, 2017 05:07 PM

    Hi Maartenvhp,

     

    Thank you for the response. And my apologies for the earlier delay, by the way. I meant to include that in my last response.

     

    I have followed-up and I see that the defect was filed internally as "DE263752" and is not currently released in a CR but is being considered for a future CR to 3.5.

     

    Sincerely,

     

    Dustin Dauncey
    Sr Support Engineer, Global Customer Success
    Email: Dustin.Dauncey@ca.com
    Phone: +1 800 225 5224 ,48385
    Phone if outside North America - https://tinyurl.com/CAContactSupport
    CA API Management Community: https://tinyurl.com/CAAPIMCommunity



  • 7.  Re: Upload a RAML into the API interactive documentation

    Posted Mar 31, 2017 02:19 AM

    Hi Dustin,

     

    No problem. Thank you for looking that up internally.

    As I said it is fixed for now. We will wait for a permanent fix.

     

    Regards,

     

    Maarten van Holst Pellekaan

    Enable-U



  • 8.  Re: Upload a RAML into the API interactive documentation

    Posted Jun 14, 2018 02:09 AM

    Hello CA Team,

    Is it really fixed in Portal 3.5? Coz I am still facing issues with loading RAML into Portal for interactive documentation.



  • 9.  Re: Upload a RAML into the API interactive documentation

    Broadcom Employee
    Posted Jul 01, 2018 07:47 PM

    Dear Anem ,

    So far as I know, only RAML 0.8 is supported.

    You should be able to find some clues in /opt/Deployments/lrs/server/logs/catalina.out

     

    Regards,

    Mark



  • 10.  Re: Upload a RAML into the API interactive documentation

    Posted Jul 24, 2018 12:47 PM

    Hello,

     

    If you continue to have issues loading RAML, I'd suggest either posting the relevant log entries here for us to examine, or to open a new support case so that we can look into this as a possibly environment-specific scenario. As Mark_HE had noted earlier, the spec we appear to be supporting up to right now is 0.8, so if you're using a RAML file that's newer than that then it may not work and would be effectively a "best effort" method until a newer version is supported in Portal 3.5.

     

    Sincerely,

    Dustin Dauncey
    Sr Support Engineer, Global Customer Success
    Email: Dustin.Dauncey@ca.com
    Phone: +1 800 225 5224 ,48385
    Phone if outside North America - https://tinyurl.com/CAContactSupport
    CA API Management Community: https://tinyurl.com/CAAPIMCommunity