Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Missing field image_id in API Call /api/books #3474

Closed
bytepoets-ssi opened this issue Jun 2, 2022 · 2 comments
Closed

Missing field image_id in API Call /api/books #3474

bytepoets-ssi opened this issue Jun 2, 2022 · 2 comments
Labels
🐛 Bug
Milestone
v22.06

Comments

@bytepoets-ssi
Copy link

Describe the Bug

The documentation mentions a field image_id but the API does not deliver it in API Call /api/books

Steps to Reproduce

  1. Log in to Bookstack
  2. Create a book
  3. Add a title image to the book
  4. Open /api/books
  5. Field image_id is missing for every book

Expected Behaviour

The field image_id is returned for every book

Screenshots or Additional Context

The field is mentioned in the source code, but isn't returned anyway

BookStack/app/Http/Controllers/Api/BookApiController.php

Line 40 in 7c597a0

'id', 'name', 'slug', 'description', 'created_at', 'updated_at', 'created_by', 'updated_by', 'owned_by', 'image_id',

Browser Details

No response

Exact BookStack Version

v22.04.2

PHP Version

No response

Hosting Environment

https://demo.bookstackapp.com
@ssddanbrown ssddanbrown added this to the Next Feature Release milestone Jun 2, 2022
@ssddanbrown
Copy link
Member

Thanks for reporting @bytepoets-ssi. Looks like this property has been hidden for a couple of years, since about v0.30.0.
I'd suggest we simply remove it from the listing call and the API docs since I can't see it providing much value as-is.

@ssddanbrown
Copy link
Member

As per my last comment, this property has now been removed for documentation.
Change will be included in the next feature release.

yangmx5 pushed a commit to yangmx5/BookStack that referenced this issue Jun 19, 2022
@ssddanbrown
Removed image_id property from books & shelves api docs
9aafbbf 
This was either not provided or not provided for the last 18 months.
Likely not providing much value as-is so removing.

Closes BookStackApp#3474
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🐛 Bug
Milestone
v22.06
Development

No branches or pull requests
2 participants
@ssddanbrown @bytepoets-ssi