[Bug]: Invalid library icons passed by API. #3094

Open
opened 2026-04-25 00:13:38 +02:00 by adam · 1 comment
Owner

Originally created by @lordcheeto on GitHub (Nov 15, 2025).

What happened?

When trying to add Audiobookshelf to Music Assistant, I received an error message that an invalid value was returned by the API.

https://github.com/music-assistant/support/issues/4056 was submitted by another user, but documents the error message. The API is returning the value audiobook for the library icon instead of audiobookshelf.

What did you expect to happen?

Expected the API to return one of the values listed in the documentation.

Steps to reproduce the issue

The icons were updated in commit 6b8d71c, but the values stored in the database for existing installations were not updated. The commit includes some code to remap the icons on the fly, but that is not being done for the API response.

The workaround was to reselect the icon in the library configuration and save it, which updates the icon value in the library table to the expected audiobookshelf. This has a pretty low impact, only affecting users with ABS installations that predate this change, but this can be permanently mitigated with a database migration that remaps the values.

Audiobookshelf version

v2.3.0

How are you running audiobookshelf?

Docker

What OS is your Audiobookshelf server hosted from?

Linux

If the issue is being seen in the UI, what browsers are you seeing the problem on?

None

Logs


Additional Notes

#2993 is a request to support admin uploaded icons. If done, this should be noted as a breaking change.

Originally created by @lordcheeto on GitHub (Nov 15, 2025). ### What happened? When trying to add Audiobookshelf to Music Assistant, I received an error message that an invalid value was returned by the API. https://github.com/music-assistant/support/issues/4056 was submitted by another user, but documents the error message. The API is returning the value `audiobook` for the library icon instead of `audiobookshelf`. ### What did you expect to happen? Expected the API to return one of the values listed in [the documentation](https://api.audiobookshelf.org/#library-icons). ### Steps to reproduce the issue The icons were updated in commit 6b8d71c, but the values stored in the database for existing installations were not updated. The commit includes some code to remap the icons on the fly, but that is not being done for the API response. The workaround was to reselect the icon in the library configuration and save it, which updates the icon value in the library table to the expected `audiobookshelf`. This has a pretty low impact, only affecting users with ABS installations that predate this change, but this can be permanently mitigated with a database migration that remaps the values. ### Audiobookshelf version v2.3.0 ### How are you running audiobookshelf? Docker ### What OS is your Audiobookshelf server hosted from? Linux ### If the issue is being seen in the UI, what browsers are you seeing the problem on? None ### Logs ```shell ``` ### Additional Notes #2993 is a request to support admin uploaded icons. If done, this should be noted as a breaking change.
adam added the bug label 2026-04-25 00:13:38 +02:00
Author
Owner

@nichwall commented on GitHub (Nov 15, 2025):

FYI the documentation at https://api.audiobookshelf.org/ is about 2 years out of date. There is a notice at the top but it is easy to miss.

@nichwall commented on GitHub (Nov 15, 2025): FYI the documentation at https://api.audiobookshelf.org/ is about 2 years out of date. There is a notice at the top but it is easy to miss.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#3094