GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves comments on a specific commit in a GitLab project repository. It is useful for developers and project managers who want to review or analyze feedback and discussions related to particular commits in their GitLab projects. For example, it can be used to fetch all comments on a commit to understand code review feedback or track discussions on changes made in that commit.

Use Case Examples

  1. Fetching comments on a commit to review code feedback before merging.
  2. Listing all comments on a commit to analyze discussion history for auditing purposes.

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.
Parameter Schema Defines required and optional parameters for the API call, including project ID, commit SHA, page number, and items per page.
Query Parameters Optional query parameters for pagination such as page number and items per page.
Path Parameters Required path parameters including project ID and commit SHA to identify the specific commit.

Output

JSON

  • comments
    • ``
      * id - Unique identifier of the comment.
      * note - Text content of the comment.
      * author - Author information of the comment.
      * created_at - Timestamp when the comment was created.

Dependencies

  • Requires GitLab API key credential for authentication unless skipping authentication is enabled.

Troubleshooting

  • Common issues include authentication failures if the API key is missing or invalid. Ensure the GitLab API key credential is correctly configured.
  • Errors may occur if the project ID or commit SHA is incorrect or missing; verify these parameters are accurate and URL-encoded if necessary.
  • Pagination parameters (page, per_page) must be valid integers; invalid values may cause request failures.

Links

Discussion