GitLab API

GitlabTool

Actions905

Overview

This node interacts with the GitLab API to retrieve specific PyPi package files from a project using the file's SHA256 checksum and file identifier. It is useful for automating package management tasks within GitLab projects, such as verifying or downloading PyPi package files based on their unique identifiers and checksums.

Use Case Examples

  1. A developer wants to automate the retrieval of a PyPi package file from a GitLab project by specifying the project ID, the file's SHA256 checksum, and the file identifier to ensure the correct package version is accessed.
  2. A CI/CD pipeline fetches PyPi package files from GitLab to verify integrity before deployment using the SHA256 checksum and file identifier parameters.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl The 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 parameters for the API call including project ID, file identifier, and SHA256 checksum.
Query Parameters Query parameters for the API request, specifically the file identifier of the PyPi package file.
Path Parameters Path parameters for the API request including the project ID and the SHA256 checksum of the PyPi package file.

Output

JSON

  • id - The ID or URL-encoded path of the project.
  • file_identifier - The PyPi package file identifier.
  • sha256 - The SHA256 checksum of the PyPi package file.
  • package_data - The data or metadata of the PyPi package file retrieved from the GitLab API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID, file identifier, and SHA256 checksum are correctly specified and URL-encoded if necessary.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access the project and package files.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages may include 404 Not Found if the project or file does not exist, or 401 Unauthorized if authentication fails.

Links

Discussion