GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves Composer package information for a specific group in GitLab using the GitLab API v4. It is useful for automating the process of fetching package details from a GitLab group, which can help in managing dependencies or integrating package data into workflows. For example, it can be used to get metadata about a Composer package hosted in a GitLab group to verify versions or dependencies programmatically.

Use Case Examples

  1. Fetch details of a Composer package named 'my-composer-package' from a GitLab group identified by its ID or URL-encoded path.
  2. Automate monitoring of package updates in a GitLab group by periodically retrieving package information.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication The authentication method used 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.
Parameter Schema Defines the required parameters for the API call: 'id' (the group ID or URL-encoded path) and 'package_name' (the Composer package name).
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path template used to fetch the Composer package information for the specified group and package name.
Query Parameters Collection of query parameters, specifically 'package_name' which is the Composer package name to fetch.
Path Parameters Collection of path parameters, specifically 'id' which is the group ID or URL-encoded path.

Output

JSON

  • id - The ID of the GitLab group.
  • package_name - The name of the Composer package.
  • package_version - The version of the Composer package.
  • package_metadata - Metadata details about the Composer package retrieved from the GitLab API.

Dependencies

  • GitLab API key credential for authentication unless 'Skip Authentication' is enabled.

Troubleshooting

  • Ensure the 'id' path parameter is correctly URL-encoded if it contains special characters to avoid request failures.
  • Verify that the 'package_name' query parameter matches the exact Composer package name in GitLab to get accurate results.
  • If authentication is enabled, confirm that the GitLab API key credential is valid and has sufficient permissions to access the group and package data.
  • Common error messages may include 401 Unauthorized if authentication fails, 404 Not Found if the group ID or package name is incorrect, and 400 Bad Request if required parameters are missing or malformed.

Links

Discussion