GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to perform operations related to topics, specifically supporting the 'postApiV4TopicsMerge' operation which merges topics via a POST request to the '/api/v4/topics/merge' endpoint. It is useful for automating topic management in GitLab projects, such as merging duplicate or related topics programmatically.

Use Case Examples

  1. Automatically merge duplicate topics in a GitLab project to maintain clean and organized topic lists.
  2. Integrate topic merging into a CI/CD pipeline to streamline project management workflows.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method The HTTP method used for the API request, defaulting to GET but supporting POST, PUT, DELETE, HEAD, and PATCH.
Parameter Schema Defines the schema for the parameters sent in the body of the POST request for merging topics.
Request Body Schema Defines the schema for the request body sent in the POST request for merging topics.
Request Path The API endpoint path for merging topics, fixed to '/api/v4/topics/merge'.

Output

JSON

  • response - The JSON response from the GitLab API after merging topics, containing details about the merged topics or operation status.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to merge topics.
  • Verify the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Check that the request body conforms to the expected schema for merging topics to avoid validation errors.
  • Common error messages may include authentication failures, permission denied, or invalid request body format. Resolving these involves verifying credentials, permissions, and request data format.

Links

Discussion