GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to update a project topic by its ID using the PUT HTTP method. It is useful for automating the management of project topics in GitLab, such as modifying topic details programmatically within workflows.

Use Case Examples

  1. Updating the name or description of a specific project topic in GitLab by providing its ID and new data.
  2. Automating bulk updates to project topics based on external triggers or data sources.

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, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, defaulting to GET but set to PUT for this operation.
Parameter Schema Defines the parameters for the API call, including the path parameter 'id' which is the ID of the project topic to update.
Request Body Schema Defines the schema for the request body containing the data to update the project topic.
Request Path The API endpoint path template for updating a topic, including the placeholder for the topic ID.
Path Parameters Collection of path parameters, specifically the 'id' of the project topic to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the project topic, typically containing the updated topic details.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the 'id' path parameter is correctly set to a valid project topic ID; otherwise, the API will return an error.
  • Verify that the authentication credentials are valid and have sufficient permissions to update project topics.
  • Check the request body schema to ensure it matches the expected format for updating a topic in GitLab.
  • If the baseUrl is changed from the default, ensure it points to a valid GitLab instance with API access.

Links

Discussion