Managing Live Documentation

In order to share your API documentation with people who are not in your team, you need to enable the Live Documentation feature.

Until it is enabled, it is only viewable as a preview for users who have access to the API definition, as indicated on the Live Documentation button in the header.

1. Go to the Settings page.
   You can access this page by going to Edit > Settings or by clicking Settings in the left panel.
2. Toggle the Enabled button from Off to On and enter a URL.

   

3. Choose the visibility. If you select Password protected, enter a password in the corresponding field.
4. Click Save to enable your Live Documentation.

Results

Your Live Documentation is now available. You can click Open to open it in a new tab.

Disable your documentation and select whether you want to retain its subdomain.

1. Open your API and go to Settings.
2. Toggle the Enabled button from On to Off.
3. If you want to release the documentation subdomain, clear the Retain Live API documentation subdomain check box.
   By default, Talend Cloud API Designer saves the subdomain you defined when you enabled the Live Documentation. This allows you to keep the same URL if you enable it again later. If you want to use this subdomain for a different API, you first need to release it.

   

4. Click Save.