starred/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-05-30 23:40:40 +02:00
Code Issues 1.0k Packages Projects Releases 10 Wiki Activity

[Bug]: Library Settings Schema in API Documentation does not match JSON reponse for podcast libraries #2805

New Issue
Closed
opened 2026-04-25 00:10:47 +02:00 by adam · 4 comments
adam commented 2026-04-25 00:10:47 +02:00
Owner
Copy Link
Copy Source

Originally created by @thejevans on GitHub (May 27, 2025).

What happened?

According to the documentation, I expect something like the following for a "Library Settings" object:

{
  "coverAspectRatio": 1,
  "disableWatcher": false,
  "skipMatchingMediaWithAsin": false,
  "skipMatchingMediaWithIsbn": false,
  "autoScanCronExpression": null
}

However, a podcast library returns the following fields:

  • coverAspectRatio
  • disableWatcher
  • autoScanCronExpression
  • podcastSearchRegion
  • markAsFinishedPercentComplete
  • markAsFinishedTimeRemaining

What did you expect to happen?

I would expect the API documentation to match the actual behavior as defined here:

https://github.com/advplyr/audiobookshelf/blob/3d0219a8663609ea9c31e72fff522c8103fdcc6b/server/models/Library.js#L56-L82

Steps to reproduce the issue

  1. make a request to the API that includes a "Library Settings" object for a podcast library, such as Get All Libraries

Audiobookshelf version

v2.23.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

No response

Originally created by @thejevans on GitHub (May 27, 2025). ### What happened? According to the documentation, I expect something like the following for a "Library Settings" object: ```json { "coverAspectRatio": 1, "disableWatcher": false, "skipMatchingMediaWithAsin": false, "skipMatchingMediaWithIsbn": false, "autoScanCronExpression": null } ``` However, a podcast library returns the following fields: - `coverAspectRatio` - `disableWatcher` - `autoScanCronExpression` - `podcastSearchRegion` - `markAsFinishedPercentComplete` - `markAsFinishedTimeRemaining` ### What did you expect to happen? I would expect the API documentation to match the actual behavior as defined here: https://github.com/advplyr/audiobookshelf/blob/3d0219a8663609ea9c31e72fff522c8103fdcc6b/server/models/Library.js#L56-L82 ### Steps to reproduce the issue 1. make a request to the API that includes a "Library Settings" object for a podcast library, such as [Get All Libraries](https://api.audiobookshelf.org/#get-all-libraries) ### Audiobookshelf version v2.23.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 _No response_
adam added the bug label 2026-04-25 00:10:47 +02:00
adam closed this issue 2026-04-25 00:10:47 +02:00
adam commented 2026-04-25 00:10:47 +02:00
Author
Owner
Copy Link
Copy Source

@thejevans commented on GitHub (May 28, 2025):

I've noticed a few more discrepancies while I'm building a library in Python to interface with the ABS API as part of a project. I don't plan to make a comprehensive library (at least for now) as my current focus is on podcasts, but I'm happy to compile the list of issues I find all at once when I'm done, and if y'all would like, I can probably figure out how the docs are generated and send in a PR with fixes. Let me know how best to help. Thanks!

@thejevans commented on GitHub (May 28, 2025): I've noticed a few more discrepancies while I'm building a library in Python to interface with the ABS API as part of a project. I don't plan to make a comprehensive library (at least for now) as my current focus is on podcasts, but I'm happy to compile the list of issues I find all at once when I'm done, and if y'all would like, I can probably figure out how the docs are generated and send in a PR with fixes. Let me know how best to help. Thanks!
adam commented 2026-04-25 00:10:47 +02:00
Author
Owner
Copy Link
Copy Source

@nichwall commented on GitHub (May 28, 2025):

The API docs are not up to date. The slate docs will likely not be updated because they need to be manually updated and tested. Several attempts have been made to create an OpenAPI spec of the API so docs and tests can be run automatically, but none of the attempts have worked out yet.

@nichwall commented on GitHub (May 28, 2025): The API docs are not up to date. The slate docs will likely not be updated because they need to be manually updated and tested. Several attempts have been made to create an OpenAPI spec of the API so docs and tests can be run automatically, but none of the attempts have worked out yet.
adam commented 2026-04-25 00:10:47 +02:00
Author
Owner
Copy Link
Copy Source

@thejevans commented on GitHub (May 28, 2025):

Ah okay. Thanks. I appreciate the insight!

@thejevans commented on GitHub (May 28, 2025): Ah okay. Thanks. I appreciate the insight!
adam commented 2026-04-25 00:10:47 +02:00
Author
Owner
Copy Link
Copy Source

@advplyr commented on GitHub (May 29, 2025):

I added a notice in the API docs. https://api.audiobookshelf.org/#introduction
Thanks!

@advplyr commented on GitHub (May 29, 2025): I added a notice in the API docs. https://api.audiobookshelf.org/#introduction Thanks!
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
authentication
backlog
bug
chapter editor
config-issue
ebooks
encoding/embedding
enhancement
help wanted
listening sessions & progress
planned
possible plugin
progress sync
pull-request
Mirrored from GitHub Pull Request
 sorting/filtering/searching
unable to reproduce
upload
users & permissions
waiting
No Label bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#2805
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?