Commenting on Metadata

Introduction

Hasura DDN provides a commenting feature that allows your API producers and consumers to start conversations directly on the API metadata. This feature enhances collaboration by closing the feedback loop and helps teams communicate more effectively about their API design and implementation.

Getting Access

This feature is currently in limited access and only available for Hasura Cloud projects. To get access, please fill out this form.

How to comment

You can add comments on various objects from your metadata.

1. Navigate to any model page in your project via the Explorer tab.
2. Hover over the field or section you want to comment on.
3. Click on the comment icon that appears.

Commenting areas

You can add comments to the following areas:

General

• Description
• Signature
• GraphQL root fields

Fields & Relationships

• Output fields
• Arguments
• Relationships

Permissions

• Role
• Read
• Create
• Update
• Delete

Notifications

To ensure effective collaboration, you can tag subgraph collaborators in your comments:

1. Type @ in your comment.
2. Select the collaborator you want to notify.

Tagged collaborators will receive an email with your comments, keeping them informed of any discussions or questions.

Invite collaborators

You can learn how to invite collaborators here.

Limitations

The feature is in early access and has known limitations, which are in our backlog. Let us know if you would like to prioritize any specific functionality.

1. Deep Linking of comments - directly go to comment thread using its link.
2. Notification Email on Resolving comments.
3. Ability to auto notify subgraph admin and developers.
4. Commenting on other pages of console such as GraphiQL and Insights.
5. History Tab for comments.
6. Insights/Analytics on comments.