GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the dependencies of RubyGems packages for a specific project in GitLab using the GitLab API. 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 a project with ID 12345 to analyze or display them in a dashboard.
  2. Automate the retrieval of gem dependencies to ensure compatibility before deployment.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication to use for the API request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, defaulting to 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 project.

Output

JSON

  • dependencies - List of RubyGems package dependencies returned by the API.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the provided authentication.
  • If skipping authentication, verify that the GitLab instance allows unauthenticated access to the dependencies endpoint.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.
  • Verify that the 'gems' query parameter, if used, is correctly formatted as a comma-delimited string of gem names.

Links

Discussion