GitLab API

GitlabTool

Actions1000

Overview

This node 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 package with a name matching a pattern can use this node to retrieve relevant package information.

Use Case Examples

  1. Search for Conan packages with names starting with 'Hello' using the query parameter 'q=Hello*'.
  2. Perform a GET request to the GitLab API endpoint '/api/v4/packages/conan/v1/conans/search' to retrieve matching packages.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making the API request.
baseUrl The base URL of the GitLab instance to which the request is sent.
Method The HTTP method used for the request (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters Collection of query parameters for the search request, including the required 'q' parameter which is the search query string.

Output

JSON

  • results - Array of Conan packages matching the search query.

Dependencies

  • GitLab API authentication (optional if Skip Authentication is false)

Troubleshooting

  • Ensure the 'q' query parameter is provided and correctly formatted; it is required for the search to work.
  • If authentication is enabled, verify that the GitLab API credentials are valid and have the necessary permissions.
  • Check the baseUrl to ensure it points to a valid GitLab instance.
  • Common error messages may include authentication failures, missing required parameters, or network connectivity issues.

Links

Discussion