GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation updates a specific wiki page in a GitLab project using the GitLab API. It is useful for automating the modification of wiki content within projects hosted on GitLab, such as updating documentation or project notes programmatically.

Use Case Examples

  1. Updating a wiki page in a GitLab project by specifying the project ID and the wiki page slug, along with the new content to be saved.
  2. Automating wiki content updates as part of a CI/CD pipeline or project management workflow.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated API access.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, defaulting to GET but set to PUT for this operation.
Path Parameters Parameters used in the API request path to identify the specific project and wiki page to update.

Output

JSON

  • id - The unique identifier of the updated wiki page.
  • slug - The slug of the updated wiki page.
  • title - The title of the updated wiki page.
  • content - The content of the updated wiki page.
  • format - The format of the wiki content (e.g., markdown).
  • message - Commit message associated with the update.
  • author - Information about the author who made the update.
  • created_at - Timestamp when the wiki page was created.
  • updated_at - Timestamp when the wiki page was last updated.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and wiki slug are correctly specified; incorrect values will cause the API request to fail.
  • Authentication errors may occur if the GitLab API key is missing or invalid; verify the API key credentials.
  • The API endpoint requires the PUT method; using a different HTTP method will result in an error.
  • Check the request body schema to ensure all required fields for updating the wiki are included and correctly formatted.

Links

Discussion