GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node interacts with the GitLab API to post Markdown content via the /api/v4/markdown endpoint. It allows users to send Markdown data to GitLab for rendering or processing, which is useful for automating documentation, comments, or other Markdown-based content within GitLab projects.

Use Case Examples

  1. Automatically post formatted Markdown content to GitLab issues or merge requests.
  2. Render Markdown content dynamically by sending it to the GitLab API and retrieving the rendered output.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication when making 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 request is sent, defaulting to https://gitlab.com.
Method The 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 schema for the parameters sent in the request body, specifically for the postApiV4Markdown operation.
Request Body Schema Defines the schema for the request body, which is null by default and can be customized.
Request Path The API endpoint path for posting Markdown, fixed to /api/v4/markdown.

Output

JSON

  • response - The JSON response from the GitLab API after posting Markdown content.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the baseUrl is correctly set to the GitLab instance URL to avoid connection errors.
  • If authentication is enabled, verify that the GitLab API key is valid and has the necessary permissions.
  • Check that the request body conforms to the expected schema for the /api/v4/markdown endpoint to prevent validation errors.

Links

Discussion