GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves the dependencies of RubyGems packages for a specific project in GitLab. It is useful for developers or DevOps engineers who want to programmatically access the 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 RubyGems package dependencies for project ID 12345 to analyze or display in a dashboard.
  2. Automate retrieval of gem dependencies to verify compatibility before deployment.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used for the request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters for the request, including 'gems' which is a comma-delimited list of gem names to filter dependencies.
Path Parameters Path parameters for the 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 API for the specified project.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID ('id' path parameter) is correctly specified and accessible with the provided authentication.
  • Verify that the baseUrl is correct and reachable, especially if using a self-hosted GitLab instance.
  • Check that the 'gems' query parameter, if used, is properly formatted as a comma-delimited string of gem names.
  • Authentication errors may occur if the API key is missing, invalid, or lacks necessary permissions.

Links

Discussion