You can view and edit the configuration that was used to create a configured API. For example, you can edit the name of the configured API, select a different branch in the GitHub repository that contains the API documents, or upload new API documents for the API to Tanzu Service Mesh.

The ability to edit the configuration of a configured API is useful in certain scenarios. For example, when you were creating a configured API, you selected the No API Documents option because your team was just setting up a GitHub repository so they did not have any API documents stored there then. After the repository has been set up, and the appropriate API documents have been added, you edit the API configuration to upload the documents to Tanzu Service Mesh. As a result, Tanzu Service Mesh will read the documents and create an API specification based on them.

Prerequisites

Procedure

  1. In the navigation pane on the left, click API Management.
  2. In the table on the API Management page, click the name of the configured API whose configuration you want to view or edit.
    Tip:

    A configured API has Configured in the Configuration column.

  3. On the API details page, click the Configuration tab.

    The Configuration tab displays the API configuration details.

  4. To edit the API configuration, do one or more of the following:
    • To edit the name or the description of the API, click Edit in the Basic Details section and make the changes you want on the Basic Details page of the Configure API wizard.

    • To change the GitHub repository or the branch where the API documents for the API specification are stored, click Edit in the Git Repository section and make the selections that you want on the Basic Details page of the wizard.

    • To upload API documents for the API, click Edit in the API Documents section and select the API documents on the API Documents page of the wizard.

  5. To save the changes in the configuration, on the Summary page of the wizard, click Save.

Results

The Configuration tab reflects the changes made to the configuration.