GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation interacts with the GitLab API to retrieve information about a specific PyPi package within a GitLab group. It is useful for scenarios where you need to fetch package details from a group's PyPi repository, such as automating package management or integrating package data into workflows.

Use Case Examples

  1. Fetching metadata for a PyPi package named 'my.pypi.package' in a GitLab group identified by its ID or full path.
  2. Automating the retrieval of package information for CI/CD pipelines that depend on specific PyPi packages hosted in GitLab groups.

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 (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters Parameters sent in the query string of the API request, specifically the PyPi package name to retrieve.
Path Parameters Parameters sent in the URL path of the API request, specifically the group ID or full path.

Output

JSON

  • id - The ID or full path of the GitLab group.
  • package_name - The name of the PyPi package being queried.
  • package_details - The details of the PyPi package returned by the API.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID or full path is correct and accessible with the provided authentication.
  • Verify the PyPi package name is accurate and exists in the specified group.
  • Check network connectivity and the base URL configuration to the GitLab instance.
  • Authentication errors may occur if the API key is invalid or lacks necessary permissions.

Links

  • GitLab Simple PyPi API - Official GitLab documentation for the Simple PyPi API used to retrieve package information.

Discussion