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

[PR #3012] [MERGED] Initial library endpoints #3840

New Issue
Closed
opened 2026-04-25 00:17:16 +02:00 by adam · 0 comments
adam commented 2026-04-25 00:17:16 +02:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/advplyr/audiobookshelf/pull/3012
Author: @nichwall
Created: 5/25/2024
Status: ✅ Merged
Merged: 6/14/2024
Merged by: @advplyr

Base: master ← Head: initial_library_endpoints

📝 Commits (10+)

📊 Changes

15 files changed (+1135 additions, -325 deletions)

View changed files

➕ .github/workflows/lint-openapi.yml (+30 -0)
📝 docs/README.md (+20 -17)
📝 docs/controllers/AuthorController.yaml (+266 -111)
➕ docs/controllers/LibraryController.yaml (+435 -0)
➕ docs/controllers/SeriesController.yaml (+72 -0)
📝 docs/objects/Library.yaml (+89 -3)
📝 docs/objects/LibraryItem.yaml (+8 -2)
📝 docs/objects/entities/Author.yaml (+26 -44)
📝 docs/objects/entities/Series.yaml (+107 -1)
📝 docs/objects/files/AudioFile.yaml (+1 -1)
➕ docs/objects/files/EBookFile.yaml (+17 -0)
📝 docs/objects/mediaTypes/Book.yaml (+3 -3)
📝 docs/openapi.json (+0 -0)
📝 docs/root.yaml (+29 -140)
📝 docs/schemas.yaml (+32 -3)

📄 Description

This PR includes:

  • Some initial library endpoints
  • Updates to the Author endpoints
  • Fixes to existing schemas for exploded spec
  • Adds series endpoints
  • Adds workflow to lint the spec

Next steps are likely (in this general order):

  1. Notification routes
  2. Email routes
  3. Podcast routes and schemas (used in lots of responses with the library)
  4. Item routes and schemas
  5. Collections routes and schemas
  6. Playlists routes and schemas
  7. RSS feeds
  8. The rest of the Library routes

Preview of redocly generated docs:
image

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/advplyr/audiobookshelf/pull/3012 **Author:** [@nichwall](https://github.com/nichwall) **Created:** 5/25/2024 **Status:** ✅ Merged **Merged:** 6/14/2024 **Merged by:** [@advplyr](https://github.com/advplyr) **Base:** `master` ← **Head:** `initial_library_endpoints` --- ### 📝 Commits (10+) - [`7da2d0a`](https://github.com/advplyr/audiobookshelf/commit/7da2d0ae8c9316c453e79f48205d68b0968519c4) Fix: extra type in `Author.yaml` - [`76100b6`](https://github.com/advplyr/audiobookshelf/commit/76100b680ea3249d7ae21e6e987ebd9738818b9d) Fix: formatting - [`5fdfc9e`](https://github.com/advplyr/audiobookshelf/commit/5fdfc9e454dff8650aba11fc5034c447a5896762) Initial library schema - [`5295088`](https://github.com/advplyr/audiobookshelf/commit/52950884623a7a5cfa95c04296e59604a0836667) Additional debugging - [`242afb3`](https://github.com/advplyr/audiobookshelf/commit/242afb3d1accfafd18fca110d210d966f817128f) Fix: spec relative paths - [`f92f5c3`](https://github.com/advplyr/audiobookshelf/commit/f92f5c31bc4b3c177d6ce3b893de266bf5b7204a) Add: ebook file spec - [`a0a2fef`](https://github.com/advplyr/audiobookshelf/commit/a0a2fef54d0ac9d94b835356481a25eef2363599) Fix: response type should be string - [`d6407cf`](https://github.com/advplyr/audiobookshelf/commit/d6407cf64560b870fef7acd2a05032e62c7a6102) Linting updates - [`1b3882b`](https://github.com/advplyr/audiobookshelf/commit/1b3882b7799a27695ded12d0a4284ba8abe8e035) Add: missing librarySettings - [`39f2d7d`](https://github.com/advplyr/audiobookshelf/commit/39f2d7dbbb0353f27049710e0513db0dd8f6f090) Temporary fix: Library cron can be null or false ### 📊 Changes **15 files changed** (+1135 additions, -325 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/lint-openapi.yml` (+30 -0) 📝 `docs/README.md` (+20 -17) 📝 `docs/controllers/AuthorController.yaml` (+266 -111) ➕ `docs/controllers/LibraryController.yaml` (+435 -0) ➕ `docs/controllers/SeriesController.yaml` (+72 -0) 📝 `docs/objects/Library.yaml` (+89 -3) 📝 `docs/objects/LibraryItem.yaml` (+8 -2) 📝 `docs/objects/entities/Author.yaml` (+26 -44) 📝 `docs/objects/entities/Series.yaml` (+107 -1) 📝 `docs/objects/files/AudioFile.yaml` (+1 -1) ➕ `docs/objects/files/EBookFile.yaml` (+17 -0) 📝 `docs/objects/mediaTypes/Book.yaml` (+3 -3) 📝 `docs/openapi.json` (+0 -0) 📝 `docs/root.yaml` (+29 -140) 📝 `docs/schemas.yaml` (+32 -3) </details> ### 📄 Description This PR includes: - Some initial library endpoints - Updates to the Author endpoints - Fixes to existing schemas for exploded spec - Adds series endpoints - Adds workflow to lint the spec Next steps are likely (in this general order): 1. Notification routes 2. Email routes 3. Podcast routes and schemas (used in lots of responses with the library) 4. Item routes and schemas 5. Collections routes and schemas 6. Playlists routes and schemas 7. RSS feeds 8. The rest of the Library routes Preview of redocly generated docs: ![image](https://github.com/advplyr/audiobookshelf/assets/5686638/5d3c628d-b43a-49f4-a4ae-0c3c214b3b00) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2026-04-25 00:17:16 +02:00
adam closed this issue 2026-04-25 00:17:16 +02:00
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 pull-request
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#3840
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?