External Document

The external document contains links to external documents that need to be added to the help document.

Name	Type	Description
url required	String	The URL of the external document.

Info:

Preferably, the url attribute should be given the publicly hosted URL of the external document.

Imagine that we want to add the document of OAuth2- https://oauth.net/doc/ to the help document of trips resource.

Define the external document in the operation of trips resource as follows,

    
        copy
        
            
        
    
    
         
<external-document url = "https://oauth.net/doc/" />

Last Updated 2025-05-30 16:54:59 +0530 +0530

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit