GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves a specific Conan package from the GitLab Packages Conan API (v1) using detailed path parameters. It is useful for users who want to fetch metadata or details about a particular Conan package version hosted on GitLab. For example, developers managing C++ package dependencies can use this node to programmatically access package information by specifying the package name, version, username, channel, and Conan package reference.

Use Case Examples

  1. Fetch details of a Conan package named 'my-package' version '1.0' under the user 'my-group+my-project' in the 'stable' channel with a specific Conan package ID.
  2. Automate retrieval of package metadata for CI/CD pipelines that depend on Conan packages stored in GitLab.

Properties

Name Meaning
Skip Authentication Whether to skip authentication when making the API request.
Authentication The authentication method used for the API request, typically a GitLab API key.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Path Parameters Collection of path parameters required to specify the Conan package to retrieve, including package_name, package_version, package_username, package_channel, and conan_package_reference.

Output

JSON

  • package_name - The name of the Conan package.
  • package_version - The version of the Conan package.
  • package_username - The username or group/project owning the package.
  • package_channel - The channel of the Conan package (e.g., stable).
  • conan_package_reference - The unique Conan package ID reference.
  • package_metadata - Additional metadata or details about the Conan package returned by the API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure all required path parameters (package_name, package_version, package_username, package_channel, conan_package_reference) are correctly provided and non-empty.
  • If authentication is enabled, verify that the GitLab API key credential is valid and has sufficient permissions to access the package.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages may include 404 Not Found if the package does not exist or 401 Unauthorized if authentication fails. Verify parameters and credentials accordingly.

Links

Discussion