6.2 Editing Documentation for the APIs

Secure API Manager allows you to edit each documentation entry added to the API. This is how you edit the inline documentation, change the URLs, or upload an updated file that contains the documentation.

To edit the documentation for an API:

  1. Log in to the Publisher using an administrator account.

    https://lifecycle-manager-dns-name:9444/publisher

  2. Click the name of the appropriate API, then click the Docs tab.

  3. In the documentation table, click Edit Content on the appropriate documentation item.

  4. Change the appropriate information for the documentation source.

    Inline

    The Publisher launches the embedded text editor. Make the appropriate changes to the inline documentation, then click Save and Close.

    URL

    Change the URL to the new URL.

    File

    Upload a new documentation file by clicking Browse and selecting the new file.

  5. Click Save and Close to save the changes.