GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves RubyGems package dependencies for a specific project from the GitLab API. It is useful for developers or DevOps engineers who want to programmatically access dependency information of RubyGems packages associated with a GitLab project. For example, it can be used to automate dependency checks or integrate dependency data into CI/CD pipelines.

Use Case Examples

  1. Fetch dependencies of RubyGems packages for a project with ID 12345 to analyze or audit dependencies.
  2. Retrieve specific gem dependencies by providing gem names as query parameters to monitor or update dependencies automatically.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication Selects the authentication method to use for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters for the API request, including 'gems' which is a comma-delimited list of gem names to filter dependencies.
Path Parameters Path parameters for the API request, including 'id' which is the ID or URL-encoded path of the GitLab project.

Output

JSON

  • dependencies - List of RubyGems package dependencies returned by the GitLab API for the specified project.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the provided authentication.
  • If authentication is skipped, the API request may fail due to lack of permissions.
  • Verify that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.
  • Check that the 'gems' query parameter is formatted correctly as a comma-delimited string if filtering by gem names.

Links

Discussion