GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation updates the External Wiki integration settings for a specific project in GitLab using the PUT HTTP method. It is useful for automating the configuration of project integrations, particularly the external wiki feature, within GitLab projects. For example, it can be used to programmatically enable or modify the external wiki integration for a project identified by its ID.

Use Case Examples

  1. Updating the external wiki integration settings for a GitLab project by specifying the project ID and the desired configuration in the request body.
  2. Automating project setup workflows that require configuring external wiki integration as part of the project initialization process.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, defaulting to GitLab API authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to PUT. Options include GET, POST, PUT, DELETE, HEAD, PATCH.
Parameter Schema Defines the path and body parameters for the operation, including the project ID and the request body schema for the external wiki integration update.
Request Body Schema The schema defining the structure of the request body for the external wiki integration update.
Request Path The API endpoint path for the operation, with a placeholder for the project ID.
Path Parameters Collection of path parameters, specifically the project ID to identify which project to update the external wiki integration for.

Output

JSON

  • response - The JSON response from the GitLab API after updating the external wiki integration.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the authentication credentials are correctly configured and have sufficient permissions to update project integrations.
  • Check the request body schema to ensure it matches the expected format for the external wiki integration update.
  • Common error messages may include authentication failures, invalid project ID, or malformed request body. Resolving these typically involves correcting credentials, verifying project existence, and validating request payload structure.

Links

Discussion