GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves related issues for a specific merge request in a GitLab project using the GitLab API. It is useful for developers and project managers who want to track issues linked to a particular merge request, helping in project management and issue tracking workflows. For example, it can be used to automatically fetch and display related issues when reviewing a merge request.

Use Case Examples

  1. Fetch related issues for merge request IID 42 in project with ID 'my-group/my-project'.
  2. Paginate through related issues by specifying page and per_page query parameters.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, defaulting to GET.
Parameter Schema Defines the required and optional parameters for the API request, including project ID, merge request IID, page number, and items per page.
Query Parameters Optional query parameters for pagination, including page number and items per page.
Path Parameters Path parameters specifying the project ID and merge request IID for the API request.

Output

JSON

  • id - The ID of the related issue.
  • title - The title of the related issue.
  • description - The description of the related issue.
  • state - The current state of the related issue (e.g., open, closed).
  • created_at - The creation timestamp of the related issue.
  • updated_at - The last update timestamp of the related issue.
  • web_url - The URL to view the related issue in GitLab.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and merge request IID are correctly specified; incorrect values will result in API errors.
  • Check that the GitLab API key credential is valid and has sufficient permissions to access the project and merge request data.
  • If pagination parameters (page, per_page) are used, verify they are within valid ranges to avoid empty or partial results.

Links

Discussion