GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves the wikis of a specific project from the GitLab API (version 4). It is useful for users who want to access project wiki pages, optionally including the content of those pages. For example, it can be used to fetch documentation or notes stored in a project's wiki for further processing or display.

Use Case Examples

  1. Fetch all wiki pages of a project by providing the project ID.
  2. Fetch wiki pages including their content by setting the 'with_content' query parameter to true.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send requests to.
Method The HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters for the request, including 'with_content' to include wiki page content.
Path Parameters Path parameters for the request, specifically the project 'id' to identify which project's wikis to retrieve.

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 for authentication

Troubleshooting

  • Ensure the project ID path parameter is correctly set and corresponds to an existing project in GitLab.
  • If authentication is enabled, verify that the GitLab API key credential is valid and has sufficient permissions to access project wikis.
  • Check the baseUrl property to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If the 'with_content' query parameter is set to true but no content is returned, verify that the wiki pages actually contain content and that the API version supports this parameter.

Links

Discussion