GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves milestone event data related to a specific issue within a GitLab project using the GitLab API v4. It is useful for tracking milestone changes or events associated with issues in a project, such as when a milestone is added, changed, or removed from an issue. Practical examples include monitoring project progress, automating notifications based on milestone updates, or integrating milestone event data into project management workflows.

Use Case Examples

  1. Fetch milestone events for issue #123 in project 'my-group/my-project' to track milestone changes.
  2. Automate alerts when a milestone is assigned or removed from an issue in a GitLab project.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request, useful for public or unauthenticated API access.
Authentication Selects the authentication method, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Parameter Schema Defines the required and optional parameters for the API call, including project ID, eventable ID, pagination page, 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 the eventable ID (issue ID) to identify the resource milestone events.

Output

JSON

  • response - The JSON response from the GitLab API containing the list of resource milestone events for the specified issue.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and eventable ID are correctly specified and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access the project and issue data.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • Pagination parameters (page and per_page) should be valid integers; otherwise, the API may return errors or unexpected results.

Links

Discussion