GitLab API

GitlabTool

Actions905

Overview

This node interacts with the GitLab API, specifically supporting the operation to POST to the /api/v4/features/{name} endpoint. It allows users to update or create features in GitLab by specifying the feature name as a path parameter and providing the request body according to the API schema. This node is useful for automating feature management in GitLab projects, such as enabling or disabling specific features programmatically.

Use Case Examples

  1. Automate enabling a feature in a GitLab project by specifying the feature name and sending the appropriate request body.
  2. Integrate GitLab feature toggling into a CI/CD pipeline to dynamically control project features based on deployment conditions.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication to use, defaulting to GitLab API key authentication. Hidden if Skip Authentication is true.
baseUrl Base URL of the GitLab instance to which the API requests are sent, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Defines the expected parameters for the operation, including the path parameter 'name' (integer) and the request body schema for the POST operation. This is hidden and used internally for validation.
Request Body Schema Schema defining the structure of the request body for the POST operation. Hidden and used internally.
Request Path The API endpoint path for the operation, set to /api/v4/features/{name}. Hidden and used internally.
Path Parameters Collection of path parameters for the request, specifically the 'name' parameter representing the feature name to be posted.

Output

JSON

  • response - The JSON response returned from the GitLab API after posting to the feature endpoint.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the 'name' path parameter is correctly set and matches the expected feature identifier format.
  • Verify that the request body adheres to the GitLab API schema for the feature update to avoid validation errors.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab server.
  • Authentication errors may occur if the GitLab API key credential is missing or invalid; ensure proper credentials are configured.

Links

Discussion