GitLab API

GitlabTool
Join our community

Actions1000

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. For example, it can be used to find packages matching a search query within a project by specifying the project ID and search term.

Use Case Examples

  1. Search for Conan packages in a project with ID '123' using the query 'Hello*' to find all packages starting with 'Hello'.
  2. Use the node to automate package discovery in CI/CD pipelines by dynamically searching for package versions.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method to use for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance to send the API request to.
Method The HTTP method to use for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters The query parameters for the API request, including the search query 'q' to filter Conan packages.
Path Parameters The path parameters for the API request, including the 'id' which is the ID or URL-encoded path of the GitLab project.

Output

JSON

  • id - The ID or URL-encoded path of the GitLab project used in the request.
  • q - The search query string used to filter Conan packages.
  • results - The list of Conan packages matching the search query returned by the GitLab API.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID ('id') is correct and accessible with the provided authentication.
  • Verify the search query ('q') is properly formatted and not empty.
  • Check that the base URL is correct and points to a valid GitLab instance.
  • Authentication errors may occur if the API key credential is missing or invalid; ensure proper credentials are configured.

Links

Discussion