GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation performs a search query on Conan packages using the GitLab API. It is useful for users who want to find specific Conan packages hosted on GitLab by specifying search criteria. For example, a developer looking for a particular version or type of Conan package can use this node to query the GitLab package registry and retrieve matching results.

Use Case Examples

  1. Searching for Conan packages with names starting with 'Hello' using the query parameter 'q=Hello*'.
  2. Using the node to integrate package search functionality into an automated CI/CD pipeline to fetch package metadata.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication. Hidden if Skip Authentication is true.
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.
Query Parameters Collection of query parameters for the API request, specifically including the 'q' parameter which is the search query string for Conan packages.

Output

JSON

  • response - The JSON response from the GitLab API containing the search results for Conan packages.

Dependencies

  • GitLab API authentication credentials

Troubleshooting

  • Ensure the 'q' query parameter is provided and correctly formatted, as it is required for the search operation.
  • If authentication is enabled, verify that the GitLab API credentials are valid and have the necessary permissions to access the package registry.
  • Check the baseUrl to ensure it points to a valid GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages may include authentication failures, invalid query parameters, or network connectivity issues. Verify credentials, parameter values, and network access to resolve these.

Links

Discussion