GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation performs a search for Conan packages within a specific GitLab project using the GitLab API. It is useful for developers or DevOps engineers who want to query Conan packages stored in a GitLab project's package registry, enabling them to find packages by name or pattern matching.

Use Case Examples

  1. Searching for Conan packages in a project by specifying the project ID and a search query string, e.g., searching for packages starting with 'Hello*'.
  2. Using the node to automate retrieval of package information for CI/CD pipelines or dependency management workflows.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
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 operation, including the project ID (path parameter) and the search query (query parameter).
Request Path The API endpoint path for searching Conan packages in a project, with a placeholder for the project ID.
Query Parameters Collection of query parameters for the request, specifically the search query 'q' used to filter Conan packages.
Path Parameters Collection of path parameters for the request, specifically the 'id' representing the project ID or URL-encoded path.

Output

JSON

  • result - The JSON response containing the search results of Conan packages matching the query in the specified project.

Dependencies

  • GitLab API authentication (API key or token)

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user or token.
  • Verify that the search query parameter 'q' is properly formatted and not empty, as it is required.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.
  • Authentication errors may occur if the API token is missing, expired, or lacks sufficient permissions to access the project's package registry.

Links

Discussion