GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows users to create draft notes on a specific merge request within a GitLab project. It is useful for developers and teams who want to add comments or feedback as draft notes on merge requests before finalizing or publishing them. For example, a user can add a draft note to a merge request to suggest code changes or highlight issues that need attention.

Use Case Examples

  1. Adding a draft note to a merge request to provide feedback before merging.
  2. Creating draft comments on a merge request to collaborate with team members during code review.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters required in the request path to identify the project and merge request.

Output

JSON

  • id - The ID of the created draft note.
  • body - The content of the draft note.
  • author - Information about the author of the draft note.
  • created_at - Timestamp when the draft note was created.
  • updated_at - Timestamp when the draft note was last updated.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and merge request IID are correctly provided; otherwise, the API call will fail.
  • Authentication errors may occur if the GitLab API key is missing or invalid; verify the credentials.
  • HTTP method should be set to POST for creating draft notes; using other methods may result in errors.

Discussion