BookStackInstall

Overview

This node integrates with the BookStack API, allowing users to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Attachment resource with the Move operation, it enables moving an attachment from one location to another within the BookStack system.

Common scenarios where this node is beneficial include reorganizing documentation assets by relocating attachments between different books or chapters, maintaining a clean and structured knowledge base, or automating content management workflows.

For example, you might use this node to move an attachment file from one chapter to another after restructuring your documentation, ensuring that all related files are correctly associated with their new locations.

Properties

Name	Meaning
Tool Description	Choose how to determine the resource and operation: - Set Automatically - Set Manually
Request Description	(Shown only if "Set Automatically" is selected) Describe your request in natural language; the system will attempt to automatically select the appropriate resource and operation based on this description.

Since the user provided only these properties, and the node supports manual selection of resource and operation when "Set Manually" is chosen, the relevant parameters for the Attachment - Move operation would typically include:

• Resource: Attachment
• Operation: Move
• ID: The ID of the attachment to move (required)
• Target Location Parameters: When moving, the node sets target identifiers such as target_shelf_id or target_book_id depending on the resource type. For attachments, this would be handled internally based on the move logic.

Note: The exact input fields for specifying the target location are not explicitly listed in the provided snippet but are implied by the move operation's payload construction.

Output

The node outputs JSON data representing the response from the BookStack API after performing the move operation. This typically includes details about the moved attachment resource, such as its updated location or metadata.

If the operation fails, the output JSON will contain an error message describing the issue.

The node does not output binary data.

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The node expects the BookStack API base URL and authentication tokens to be configured in the credentials.
• HTTP requests are made to the BookStack API endpoints corresponding to the resource and operation.

Troubleshooting

• Common Issues:

  • Incorrect or missing attachment ID: Ensure the ID parameter is correctly set to identify the attachment to move.
  • Insufficient permissions: The API token used must have rights to move attachments within BookStack.
  • Invalid target location: The target shelf or book ID must exist and be accessible.
  • Network or authentication errors: Verify API credentials and network connectivity.

• Error Messages:

  • Errors returned from the BookStack API will be included in the output JSON under an error field if the node is set to continue on failure.
  • Common HTTP errors like 401 Unauthorized indicate credential issues.
  • 404 Not Found may indicate invalid resource IDs.

To resolve errors, verify all input parameters, ensure valid credentials, and confirm the target locations exist in BookStack.

Links and References

• BookStack Official Documentation
• BookStack API Reference

---

This summary is based solely on static analysis of the provided source code and property definitions.