Collaborate on an API

You can collaborate on an API specification in Tanzu Service Mesh with other developers and operators by providing comments on the API, the API specification, and the API scores and by replying to comments from other developers and operators.

Using Tanzu Service Mesh, you can share an API specification with a community of developers and operators so that the community can view the API specification and its scores and provide feedback. You can collaborate on the specification with the developer and operator community by exchanging comments. For example, you can add comments to ask other developers for advice on how to improve an API score, ask for their feedback on the design of the API, or ask them for ideas on how to resolve a specific problem in the API specification.

You can also reply to comments from other developers and operators.

Prerequisites

• Access the Tanzu Service Mesh Console.

• You can collaborate only on a configured API. Verify that you are familiar with the concept of a configured API. For information about configured APIs, see Configured APIs.

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 on whose API specification you want to collaborate with other developers.
3. In the upper-right corner of the API details page, click Show Activity Feed.

   The Activity Feed panel appears on the right side. In the Activity Feed panel, you can view all existing comments on the specification, add comments, and reply to other users' comments.

4. To add a comment, perform the following steps:
   1. Enter your comment into the box at the top of the Activity Feed panel.
      Tip:

      • This box has the prompt text Add new comment.

      • You can reference another configured API in Tanzu Service Mesh. For example, you want to point out to other developers how a specific security problem was resolved in the referenced API specification, which improved its Security score, and suggest reusing the same solution for this specification. To reference another API in your comment, enter # and then in the drop-down menu that appears, select the API that you want to reference in your comment. The reference will take the users to the API details page of that API.

      Note:

      Currently, once a comment is added, it cannot be deleted. The ability to delete comments will be available in a future release.

   2. Click Save.

   Your comment is visible to other users who have access to the API, and they can reply to it.

5. To reply to another user's comment, enter your reply into the box under that comment and click Reply.
   Tip:

   The box has the prompt text Reply here.

6. To close the Activity Feed panel, click Hide Activity Feed.