GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves information about a specific Composer package within a GitLab group using the GitLab API v4. It is useful for users who want to programmatically access package details such as metadata or version information for Composer packages hosted in a GitLab group repository. For example, a developer or DevOps engineer might use this node to automate package management or integrate package data into CI/CD pipelines.

Use Case Examples

  1. Retrieve details of a Composer package named 'my-composer-package' in a GitLab group identified by its ID or URL-encoded path.
  2. Automate monitoring of package versions in a GitLab group by fetching package information regularly.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, defaulting to GET.
Parameter Schema Defines the required parameters for the API call, including the group ID or URL-encoded path and the Composer package name. This is hidden and used internally.
Request Body Schema Schema for the request body if applicable, hidden and null for this operation.
Request Path The API endpoint path template for accessing the Composer package in the group.
Query Parameters Collection of query parameters, specifically the Composer package name to query.
Path Parameters Collection of path parameters, specifically the group ID or URL-encoded path.

Output

JSON

  • id - The ID of the GitLab group.
  • package_name - The name of the Composer package.
  • version - The version of the Composer package.
  • description - Description of the Composer package.
  • created_at - Timestamp when the package was created.
  • updated_at - Timestamp when the package was last updated.
  • metadata - Additional metadata related to the Composer package.

Dependencies

  • GitLab API key credential for authentication unless Skip Authentication is enabled.

Troubleshooting

  • Ensure the group ID or URL-encoded path is correct and accessible with the provided credentials.
  • Verify that the Composer package name is correctly specified and exists in the group.
  • Check network connectivity to the GitLab instance specified by the baseUrl.
  • If authentication is skipped, ensure the API endpoint allows unauthenticated access, otherwise requests will fail with authorization errors.

Links

Discussion