Actions22
Overview
This node integrates with the BookStack platform to manage its resources programmatically. Specifically, for the Chapter - Update operation, it allows users to update existing chapters within a book. This is useful in scenarios where chapter details such as the name, description, tags, or associated book need to be modified after creation.
Practical examples include:
- Renaming a chapter to better reflect updated content.
- Adding or modifying descriptive text to clarify chapter purpose.
- Updating tags to improve searchability and categorization.
- Changing the book association if the chapter was moved between books.
Properties
| Name | Meaning |
|---|---|
| Chapter ID | The unique identifier of the chapter to update (required). |
| Book ID | The ID of the book this chapter belongs to; can be changed to move the chapter. |
| Name | The new name of the chapter (up to 255 characters). |
| Description | A textual description of the chapter (up to 1900 characters). |
| Tags | Comma-separated list of tags to associate with the chapter (e.g., "tag1, tag2, tag3"). |
Output
The node outputs JSON data representing the updated chapter resource as returned by the BookStack API. This typically includes all chapter properties such as its ID, name, description, tags (as an array of objects with tag names), and book association.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a BookStack instance via an API key credential.
- The node uses HTTP requests to the BookStack REST API endpoints for chapters.
- Proper permissions on the BookStack server are necessary to update chapters.
Troubleshooting
- Missing or invalid Chapter ID: The operation requires a valid chapter ID. Ensure the ID exists and is correctly provided.
- API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
- Invalid field values: For example, exceeding character limits on name or description may cause errors.
- Network issues: Connectivity problems with the BookStack server will prevent updates.
- Error messages from API: These are surfaced as node errors with messages from the BookStack API. Review the message for clues (e.g., "Not Found" if the chapter ID does not exist).
To resolve errors:
- Double-check input parameters.
- Confirm API credentials and permissions.
- Inspect network connectivity.
- Consult BookStack API documentation for error codes.