gitlab-org / gitlab-discussions-

Note

The Note model is a crucial component of the GitLab Discussions system. It represents a single comment or note within a discussion. It’s the foundation for all interactions and feedback in GitLab Discussions.

Note Attributes

  • id: A unique identifier for the note.
  • noteable_type: The type of object the note is associated with (e.g., ‘Issue’, ‘MergeRequest’, ‘Snippet’).
  • noteable_id: The ID of the object the note is associated with.
  • project_id: The ID of the project the note belongs to.
  • author_id: The ID of the user who created the note.
  • created_at: The timestamp when the note was created.
  • updated_at: The timestamp when the note was last updated.
  • body: The actual text content of the note.
  • attachment: A URL to an attachment associated with the note.
  • system: Boolean indicating whether the note was created by the system (e.g., for issue status updates).
  • discussion_id: The ID of the discussion the note belongs to.
  • note_type: The type of note (e.g., ‘DiscussionNote’, ‘DiffNote’).

Creating Notes

Notes are typically created through the GitLab API. You can create notes via:

  • POST /projects/:id/issues/:issue_id/notes: To create a note on an issue.
  • POST /projects/:id/merge_requests/:merge_request_id/notes: To create a note on a merge request.
  • POST /projects/:id/snippets/:snippet_id/notes: To create a note on a snippet.

For example:

{
            "body": "This is a test note"
          }

Updating Notes

You can update an existing note by using the PUT request to the note’s endpoint. For example:

{
            "body": "This is an updated note"
          }

Deleting Notes

You can delete a note using the DELETE request to the note’s endpoint. For example:

DELETE /projects/:id/issues/:issue_id/notes/:note_id

Example Use Cases

  • Commenting on an issue: When a user leaves a comment on an issue, a note is created.
  • Replying to a note: When a user replies to an existing note, a new note is created.
  • System-generated notes: When an issue is closed or reopened, a system-generated note is created to record the status change.

Note Security

It’s crucial to consider security implications when working with notes. Notes can contain sensitive information, and unauthorized access could lead to data breaches. It’s important to enforce proper authorization mechanisms and restrict access to notes based on user roles and permissions.