Actions31
Overview
This node integrates with the BookStack API to manage various resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Chapter - Update operation, it allows updating an existing chapter's details by specifying its ID and new properties like name.
Common scenarios include:
- Renaming a chapter within a book.
- Updating chapter metadata in an automated documentation or knowledge base workflow.
- Synchronizing chapter information from another system into BookStack.
For example, you might use this node to update the title of a chapter after content revisions or to correct typos in chapter names programmatically.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the chapter to update. This is required to specify which chapter will be modified. |
| Name | The new name/title for the chapter. This is required when updating the chapter to set its updated name. |
Output
The node outputs JSON data representing the updated chapter resource as returned by the BookStack API. This typically includes fields such as the chapter's ID, name, and other metadata reflecting the current state after the update.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The node expects the base URL of the BookStack instance and authentication tokens to be configured in the credentials.
- Network access to the BookStack API endpoint is necessary.
Troubleshooting
- Missing or invalid ID: If the ID property is not provided or incorrect, the API will fail to locate the chapter, resulting in an error. Ensure the correct chapter ID is supplied.
- Authentication errors: If the API token or base URL is misconfigured, requests will fail with authorization errors. Verify credentials are correctly set up.
- Validation errors: Providing an empty or invalid name may cause the API to reject the update. Make sure the "Name" field is non-empty and valid.
- API connectivity issues: Network problems or incorrect base URLs can cause request failures. Confirm that the BookStack server is reachable.