Actions40
- Book Actions
- Page Actions
- Chapter Actions
- Shelf Actions
- User Actions
- Role Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API to manage "Shelf" resources, specifically supporting the update operation. It allows users to update the details of an existing Shelf in a BookStack instance. This is useful for maintaining and organizing collections of books by modifying shelf names or descriptions.
Practical examples include:
- Renaming a shelf to better reflect its contents.
- Updating the description of a shelf to provide more context or information about the collection it holds.
The node supports two modes for specifying the update:
- Automatic mode: Describe your request in natural language, and the system attempts to infer the resource and operation.
- Manual mode: Explicitly specify the resource ("Shelf"), operation ("Update"), and required parameters.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: "Set Automatically" or "Set Manually". |
| Request Description | (Shown if "Set Automatically") A text description of what you want to do; the system uses this to select resource and operation automatically. Example: "Update shelf named 'Fiction'". |
| ID | The unique identifier of the Shelf resource to update. Required for update operations. |
| Name | The new name for the Shelf. Required when updating a Shelf. |
| Description | The new description for the Shelf. Optional when updating a Shelf. |
Output
The node outputs JSON data representing the updated Shelf resource as returned by the BookStack API. This typically includes fields such as the shelf's ID, name, description, creation and update timestamps, and other metadata provided by the API.
No binary data output is produced by this node.
Example output structure (simplified):
{
"id": 123,
"name": "New Shelf Name",
"description": "Updated description of the shelf",
"created_at": "2023-01-01T12:00:00Z",
"updated_at": "2023-01-02T15:30:00Z"
}
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.
- HTTP requests are made to the BookStack REST API endpoints under
/api/shelfs/{id}for updates.
Troubleshooting
- Missing or invalid ID: The update operation requires a valid Shelf ID. If omitted or incorrect, the API will return an error indicating the resource was not found.
- Authentication errors: Ensure that the API token and base URL are correctly set in the credentials. Authentication failures will result in 401 or 403 HTTP errors.
- Invalid property values: The "Name" field is required and must be non-empty. Omitting it or providing invalid data may cause the API to reject the request.
- API endpoint issues: Confirm that the BookStack instance is accessible and the API endpoint
/api/shelfs/{id}is correct and enabled. - Automatic mode parsing errors: When using automatic mode, ambiguous or unclear request descriptions might lead to incorrect resource or operation inference. In such cases, switch to manual mode for precise control.