Layer 7 API Management

Expand all | Collapse all

API Documentation Using WADL

Jump to Best Answer
  • 1.  API Documentation Using WADL

    Posted 08-02-2017 08:23 AM

    Hi,

    I have created an api documentation page for a service using WADL. It is working fine. However, I am unable to find the attribute in WADL which will populate the description of that particular parameter. As shown in the below snapshot, Description Column is empty. Can you please guide how to add description to it?

     

    Thanks.



  • 2.  Re: API Documentation Using WADL
    Best Answer

    Posted 08-02-2017 07:37 PM

    Hello rdas4 ,

    Any wadl element can have doc element to document that element, ie. provide a description of that element.

    for example,

    <param name="BAN" style="query" type="xsd:string" required="true" default="">
       <doc xml:lang="en" title="This is description of BAN" />
    </param>

     

    Regards,

    Mark



  • 3.  Re: API Documentation Using WADL

    Posted 08-03-2017 01:30 AM

    Thanks for quick response. I have modified the WADL and can see the description. 

     

    Thanks.