GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves Composer package information from a specific GitLab group using the GitLab API v4. It is designed to fetch package data identified by a group ID and a SHA checksum, which is useful for managing and verifying Composer packages within GitLab groups. Typical use cases include automation workflows for package management, validation of package integrity, and integration with CI/CD pipelines to ensure the correct package versions are used.

Use Case Examples

  1. Fetch Composer package details for a GitLab group by specifying the group ID and the SHA checksum of the package JSON.
  2. Automate package verification in a CI/CD pipeline by retrieving package metadata from GitLab.

Properties

Name Meaning
Skip Authentication Option to bypass authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method used for the API request, default is GET.
Parameter Schema Defines the required path parameters for the API call: group ID and SHA checksum of the package JSON.
Request Body Schema Schema for the request body, not used in this GET operation.
Request Path API endpoint path template for the request, including placeholders for group ID and SHA.
Path Parameters Collection of path parameters including 'id' (group ID or URL-encoded path) and 'sha' (SHA checksum of the package JSON).

Output

JSON

  • response - The JSON response from the GitLab API containing the Composer package information for the specified group and SHA.

Dependencies

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

Troubleshooting

  • Ensure the 'id' and 'sha' path parameters are correctly provided and URL-encoded if necessary.
  • Authentication errors may occur if the GitLab API key is missing or invalid; verify credentials.
  • Network or base URL issues can cause request failures; confirm the baseUrl is correct and accessible.
  • The API endpoint requires the group to have appropriate permissions to access package data; check user permissions.

Links

Discussion