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. Automating package discovery in CI/CD pipelines by integrating this node to fetch package information dynamically.

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.
Method The HTTP method used for the API request.
Parameter Schema Defines the required parameters for the operation, including the project ID (path parameter) and the search query (query parameter).
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path with placeholders for path parameters.
Query Parameters Collection of query parameters, specifically the search query 'q' used to filter Conan packages.
Path Parameters Collection of path parameters, specifically the project ID 'id' to identify the GitLab project.

Output

JSON

  • packages - List of Conan packages matching the search query within the specified project.
  • statusCode - HTTP status code returned by the API request.
  • headers - HTTP response headers from the API request.

Dependencies

  • GitLab API authentication credential

Troubleshooting

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

Links

Discussion