GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to retrieve details about a specific project topic by its ID. It is useful for workflows that need to fetch information about project topics in GitLab, such as automation scripts for project management or reporting tools that integrate GitLab data.

Use Case Examples

  1. Retrieve details of a project topic by providing its ID to automate project documentation.
  2. Fetch topic information to display in a custom dashboard or report.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance to which the API request is sent.
Method HTTP method used for the API request, default is GET.
Parameter Schema Schema defining the path parameter 'id' which is the ID of the project topic to retrieve.
Request Body Schema Schema for the request body, null for this operation as it is a GET request.
Request Path API endpoint path with placeholder for the topic ID.
Path Parameters Collection of path parameters including 'id' which specifies the project topic ID to fetch.

Output

JSON

  • id - The unique identifier of the project topic.
  • name - The name of the project topic.
  • description - Description of the project topic.
  • created_at - Timestamp when the topic was created.
  • updated_at - Timestamp when the topic was last updated.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'id' path parameter is provided and is a valid integer representing an existing project topic ID in GitLab.
  • If authentication is enabled, verify that the GitLab API key credential is correctly configured and has sufficient permissions to access project topics.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 404 Not Found if the topic ID does not exist, and 401 Unauthorized if authentication fails. Verify the ID and credentials accordingly.

Links

Discussion