GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves wiki pages for a specific project from the GitLab API (version 4). It is useful for scenarios where users want to access or display the wiki content associated with a GitLab project, such as for documentation or project management purposes. For example, a user can fetch all wiki pages of a project, optionally including the content of each page.

Use Case Examples

  1. Fetch all wiki pages for a project with ID 123, including the content of each page.
  2. Retrieve wiki pages without content for a project to display a list of page titles.

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 send the API request to.
Method The HTTP method to use for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Query Parameters Optional query parameters for the API request, such as 'with_content' to include the content of wiki pages.
Path Parameters Path parameters required for the API request, specifically the project ID ('id').

Output

JSON

  • id - The unique identifier of the wiki page.
  • title - The title of the wiki page.
  • content - The content of the wiki page, included if 'with_content' is true.
  • format - The format of the wiki page content.
  • slug - The URL-friendly identifier of the wiki page.
  • created_at - The creation timestamp of the wiki page.
  • updated_at - The last update timestamp of the wiki page.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID ('id') path parameter is correctly set and corresponds to an existing project in GitLab.
  • Verify that the base URL is correct and accessible, especially if using a self-hosted GitLab instance.
  • If authentication is not skipped, ensure the GitLab API key credential is valid and has sufficient permissions to access the project's wikis.
  • Check the 'with_content' query parameter value; it should be a boolean or string representing a boolean to include page content.
  • Common error messages may include 401 Unauthorized (invalid or missing API key), 404 Not Found (invalid project ID), or 400 Bad Request (incorrect parameters).

Links

Discussion