BookStack

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. It supports common CRUD operations: create, get (retrieve), get many (list), update, and delete.

A key feature is the ability to operate in two modes:

• Automatic mode: Users provide a natural language description of their request, and the node attempts to infer the appropriate resource and operation.
• Manual mode: Users explicitly select the resource and operation.

This node is beneficial for automating content management workflows within BookStack, such as creating new documentation pages, updating book descriptions, listing all shelves, or deleting outdated chapters.

Practical examples:

• Automatically create a new page about "API documentation" by describing the request in natural language.
• Manually update the description of a specific book by selecting the book resource and update operation.
• List all users or roles in the BookStack instance.
• Delete an attachment by specifying its ID.

Properties

Output

The node outputs JSON data representing the response from the BookStack API for each input item processed. The structure depends on the resource and operation performed but generally includes the requested resource's details or confirmation of the action taken.

If an error occurs and "Continue On Fail" is enabled, the output JSON will contain an error field with the error message.

No binary data output is produced by this node.

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The base URL and tokens for the BookStack API must be configured in the node credentials.
• The node uses HTTP requests to communicate with the BookStack REST API endpoints.

Troubleshooting

• Common issues:

  • Incorrect or missing API credentials will cause authentication failures.
  • Providing an invalid resource ID for get, update, or delete operations will result in errors.
  • In automatic mode, ambiguous or unclear request descriptions may lead to incorrect resource or operation inference.
  • Missing required fields (e.g., name when creating a resource) will cause validation errors.

• Error messages:

  • Authentication errors typically indicate invalid or missing API tokens; verify credentials configuration.
  • "Resource not found" errors suggest the specified ID does not exist; check the ID value.
  • Validation errors indicate missing or malformed input parameters; ensure all required properties are set correctly.

• To resolve issues, verify credentials, confirm input parameters, and if using automatic mode, try rephrasing the request description for clarity.

Links and References

• BookStack Official API Documentation
• BookStack GitHub Repository