This page of the documentation describes sharing in SaaS installations. For working with others in On-Premise installations, click here.
The AsyncAPI editor does not support comments.
OpenAPI Code Editor supports comments, so you can share your thoughts and discuss ideas with other users. Comments are used as tickets that bring issues and ideas to the attention of other users.
Any user with commenting permissions can add, reply to, resolve, and reopen comments.
Comments are linked to a specific version of an API or domain and are not copied between other versions.
Designers and consumers can add comments on any line of the OpenAPI definition, and can also reply to, resolve, and re-open comments.
To add a comment, click the plus sign to the left of the line number in the editor. This opens the comment panel where you can type your comment.
Comments support the Markdown syntax for text formatting:
All the comments appear to the right of the editor, sorted by the line number. To show or hide the comments, click on the editor toolbar. Comments are real-time, so other users who have the API page open will see the comments immediately without refreshing the page.
Open and resolved comments
All the comments are grouped into two categories: Open Comments and Resolved Comments. Open comments are unresolved questions and things on the backlog.
Once an issue has been taken care of, you can mark the comment as resolved. This moves the comment to the Resolved Comments section at the bottom.
Resolved comments may be deleted or kept for historical purposes. Resolved comments can also be re-opened, if needed.
Who can comment?
The following users have commenting permissions:
Organization owners and designers.
Consumers if the Allow Consumers to Comment on all the APIs & Domains they can access option is enabled for the organization.