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.
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.
- Navigate to any model page in your project via the
Explorertab. - Hover over the field or section you want to comment on.
- Click on the comment icon that appears.
Commenting areas
You can add comments to the following areas:
Explorer Tab
Supergraph Page
Subgraph Page
Models --> General
- Description
- Signature
- GraphQL root fields
Models --> Fields & Relationships
- Output fields
- Arguments
- Relationships
Models --> Permissions
- Role
- Read
- Create
- Update
- Delete
GraphiQL Tab
Insights Tab
Builds Tab
Notifications
To ensure effective collaboration, you can tag subgraph collaborators in your comments:
- Type
@in your comment. - Select the collaborator you want to notify.
Tagged collaborators will receive an email with your comments and a notification on the notification hub on the console, keeping them informed of any discussions or questions.
The notification hub can be found in the top right corner of the console. On clicking the comments button, you will see all the comments where you are tagged in one place. The messages will be grouped based on the underlying commenting thread. You can click on a particular comment (deep linking) and go to the original thread on the console. You can also delete notifications from that menu.
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.
- Notification Email on Resolving comments.
- Ability to auto notify subgraph admin and developers.
- History Tab for comments.
- Figma Style (Canvas) Commenting.
