GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves a specific wiki page from a GitLab project using the GitLab API. It is useful for accessing detailed documentation or notes stored in project wikis, especially when you need to fetch a particular version or render the content as HTML. For example, it can be used to automate fetching project documentation for display in dashboards or integration with other tools.

Use Case Examples

  1. Fetch the latest version of a wiki page by its slug from a GitLab project.
  2. Retrieve a specific version of a wiki page by providing the version hash.
  3. Render the wiki page content as HTML for display purposes.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Parameter Schema Defines the parameters required for the operation, including path and query parameters such as project ID, wiki slug, version hash, and render_html flag.
Request Body Schema Schema for the request body, if applicable (null for this operation).
Request Path The API endpoint path template for the operation.
Query Parameters Optional query parameters for the request, including version hash and render_html flag to control content rendering.
Path Parameters Path parameters required for the request, including the project ID and the slug of the wiki page.

Output

JSON

  • id - The unique identifier of the wiki page.
  • slug - The slug of the wiki page.
  • title - The title of the wiki page.
  • content - The content of the wiki page, either raw or rendered as HTML depending on the render_html parameter.
  • format - The format of the wiki page content.
  • version - The version hash 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 authentication credential

Troubleshooting

  • Ensure the project ID and wiki slug are correctly specified; incorrect values will result in a 404 Not Found error.
  • If authentication is required and skipped, the request will fail with an authentication error; ensure proper API credentials are provided unless skipping authentication is intentional.
  • Check the baseUrl if using a self-hosted GitLab instance; incorrect baseUrl will cause connection failures.
  • If the version hash is provided but invalid, the API may return an error or the latest version instead.

Links

Discussion