OpenProjectInstall

Overview

This node allows you to preview a Markdown document as rendered by the OpenProject system. It is particularly useful when you want to see how Markdown content will appear within the context of OpenProject, including any custom markdown extensions that depend on specific contexts such as work packages.

A common scenario for this node is when you have Markdown text that references project-specific elements (like images attached to a work package) and you want to render it exactly as it would appear in OpenProject before saving or sharing it. For example, previewing a work package description with embedded images or links that rely on the work package context.

Properties

Output

The node outputs JSON data representing the rendered Markdown document as processed by OpenProject. This typically includes the HTML or other markup generated from the Markdown input, reflecting any context-specific enhancements (e.g., embedded images or links resolved based on the provided context).

No binary data output is indicated.

Dependencies

• Requires an API key credential to authenticate with the OpenProject API.
• The node depends on the OpenProject API being accessible at the URL specified in the credentials.
• The node uses OpenProject’s Markdown rendering service, which supports GitHub Flavored Markdown plus additional OpenProject-specific extensions.

Troubleshooting

• Invalid Context URL: If the context property is set incorrectly (e.g., wrong path or non-existent work package ID), the rendering may fail or produce incomplete results. Ensure the context URL matches supported formats and points to existing resources.
• Authentication Errors: Missing or invalid API credentials will prevent the node from accessing the OpenProject API. Verify that the API key and base URL are correctly configured.
• Unsupported Contexts: Providing a context not supported by OpenProject’s markdown renderer may result in fallback to basic rendering without extensions.
• Network Issues: Connectivity problems to the OpenProject server will cause request failures. Check network access and server availability.

Links and References

• OpenProject API Documentation
• GitHub Flavored Markdown Spec
• OpenProject Markdown Extensions