mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-07-16 05:33:49 +03:00
API Ability - Create gallery-image of type "cover_book" #5256
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @MaximeLibert on GitHub (Apr 15, 2025).
API Endpoint or Feature
Using the existing create method for image-gallery , people should be able to use type "cover_book" to create a book cover to then link to a book.
Use-Case
I am currently developing a small python connector that creates books in my BookStack instance, I would like to be able to add book covers using the API endpoint.
My planned method was, using API:
As you probably know, I cannot use type "gallery" cause it would interpret the uploaded_to value to be a page id not a book id.
Additional context
No response
@ssddanbrown commented on GitHub (Apr 15, 2025):
Hi @MaximeLibert,
Both the
books - POST - Createandbooks - PUT - Updateendpoints directly accept image data via theimageparameter as part of amultipart/form-dataform data request.You don't need to upload them via a separate endpoint and then "attach" them (your planned steps 2 & 3). You can just provide the image during the creation (Step 1).
@MaximeLibert commented on GitHub (Apr 15, 2025):
Hi @ssddanbrown ,
Sorry, I was lazy in my context explanation.
The python connector that I am currently building will be used to sync content from one BookStack instance to another. Both are in different networks so I cannot implement the content of multi-instance or "just" use permission to have some users see only some parts of one instance cause they wont be able to access it.
For that, I have decided to use API calls and not webhooks cause it is easier for me to trigger the rebuild of the source instance and so on.
I plan to have my technical API user to only be able to read some parts of the source instance (based on shelves rights) and just upsert the content in the other instance. Thus, I will check periodically what was "last updated" and store id mappings in a database. My script is almost finished, everything works except book covers.
For every "attachments" and "images" of source instance my logic is:
Creating the image gallery or attachment" - POST call with file (content type = multipart/form-data) OR Updating the attachment/image if already in destination
Updating the page with file- PUT call with file(content type = multipart/form-data) (even if it might be useless some of the times)
Updating the content of the page to change the hrefs.
I wanted to reuse this logic in order not to rewrite code for the book covers since they are "just" specific image galeries with type "book_cover" but the API wont allow me to do so. I could do what you proposed so thanks in advance for this.
@MaximeLibert commented on GitHub (Apr 15, 2025):
Feedback after trying your solution
Do I need to set something up for this to work ??
@ssddanbrown commented on GitHub (Apr 15, 2025):
@MaximeLibert For a PUT request you'll need to add a
_methodform item with valuePUTas an awkward workaround to a PHP limitation (hopefully to be solved soon). Is mentioned in the API docs but easy to miss.POSTrequests are fine.@MaximeLibert commented on GitHub (Apr 16, 2025):
Thanks for this, its true that it is easy to miss !
Thank you for your for your time man !
@ssddanbrown commented on GitHub (Apr 16, 2025):
No worries!
I'm going to go ahead and close this request as out of scope though.
The gallery image endpoints are specifically intended for content images, with other endpoints used for other images, and I'm not keen on duplicating actions across endpoints.