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 #3198] [CLOSED] WIP: feat: add more OpenAPI specs #3900

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

📋 Pull Request Information

Original PR: https://github.com/advplyr/audiobookshelf/pull/3198
Author: @Vito0912
Created: 7/27/2024
Status: ❌ Closed

Base: master ← Head: feat/openapi-1

📝 Commits (10+)

  • 15136e2 First draft for user / login and logout
  • 9efd353 Fixed wrong formation and added endpoints to root
  • 1811e0a Added media to items endpoint
  • 3e94497 fix: some typos
  • 7ae904c Added some smaller fixes and the getaitem endpoint
  • 11826c3 Reverted change that has contradictory outputs
  • e6d4e89 Updated LibraryItemController Paths (See description)
  • 7ef2eed Added /api/items/{id}/play endpoint
  • 9b3cb4e Fixed some minor bugs and added to root
  • b0d85a8 Added /api/me endpoint

📊 Changes

20 files changed (+1239 additions, -20 deletions)

View changed files

➕ docs/bundled.yaml (+0 -0)
➕ docs/controllers/AuthController.yaml (+70 -0)
📝 docs/controllers/LibraryController.yaml (+1 -0)
➕ docs/controllers/LibraryItemController.yaml (+163 -0)
➕ docs/controllers/MeController.yaml (+205 -0)
➕ docs/controllers/SessionController.yaml (+278 -0)
➕ docs/objects/Bookmarks.yaml (+18 -0)
📝 docs/objects/LibraryItem.yaml (+13 -0)
➕ docs/objects/Media.yaml (+76 -0)
➕ docs/objects/Permissions.yaml (+55 -0)
➕ docs/objects/entities/Device.yaml (+42 -0)
➕ docs/objects/entities/PlaybackSession.yaml (+131 -0)
➕ docs/objects/entities/User.yaml (+85 -0)
📝 docs/objects/files/AudioFile.yaml (+16 -0)
📝 docs/objects/mediaTypes/Book.yaml (+14 -0)
📝 docs/objects/metadata/BookMetadata.yaml (+29 -20)
📝 docs/openapi.json (+0 -0)
📝 docs/root.yaml (+40 -0)
📝 docs/schemas.yaml (+3 -0)
➕ unicode.dll (+0 -0)

📄 Description

This PR is a work in progress and may never be "finished."

I will be updating it with commits periodically. This PR should not be merged until the last commit is ready for merging. If the last commit is not ready for merging, I am still adding new specifications. So at that time I did not tested it or generated the OpenApi.json.
I try to test everything somewhat. Please review before merging.

Contributions and suggestions for better practices are appreciated, including naming conventions, references, etc. This is my first time writing OpenAPI specs, and I am doing my best to ensure each component is unique and references existing schemas when possible.

Currently, I am testing a bit, but I wanted to open this PR to show what I am working on so others can help or contribute.

🔄 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/3198 **Author:** [@Vito0912](https://github.com/Vito0912) **Created:** 7/27/2024 **Status:** ❌ Closed **Base:** `master` ← **Head:** `feat/openapi-1` --- ### 📝 Commits (10+) - [`15136e2`](https://github.com/advplyr/audiobookshelf/commit/15136e25625f725fb9e33f71cef765088cfac216) First draft for user / login and logout - [`9efd353`](https://github.com/advplyr/audiobookshelf/commit/9efd3537a4fa93e83590c0a077d8216a57264431) Fixed wrong formation and added endpoints to root - [`1811e0a`](https://github.com/advplyr/audiobookshelf/commit/1811e0a06c2c299c54fe8f3b1f8f72f8f7a0f7d8) Added media to items endpoint - [`3e94497`](https://github.com/advplyr/audiobookshelf/commit/3e944974e20eb17674d56940f2ef9562a1b91c9a) fix: some typos - [`7ae904c`](https://github.com/advplyr/audiobookshelf/commit/7ae904ccbba7c8a667368bf2f9385170861b003e) Added some smaller fixes and the getaitem endpoint - [`11826c3`](https://github.com/advplyr/audiobookshelf/commit/11826c37a3f7309b1a1a2d1c2e10957a3be8daac) Reverted change that has contradictory outputs - [`e6d4e89`](https://github.com/advplyr/audiobookshelf/commit/e6d4e89bd1d290c691674367f69f6e11f1cc7dd9) Updated LibraryItemController Paths (See description) - [`7ef2eed`](https://github.com/advplyr/audiobookshelf/commit/7ef2eed2ad324c06ec249689a784836ada968c07) Added /api/items/{id}/play endpoint - [`9b3cb4e`](https://github.com/advplyr/audiobookshelf/commit/9b3cb4ed33e05062e2aef445a9a28a77cba67522) Fixed some minor bugs and added to root - [`b0d85a8`](https://github.com/advplyr/audiobookshelf/commit/b0d85a8dd92173dadae2f1d818c466711c356e82) Added /api/me endpoint ### 📊 Changes **20 files changed** (+1239 additions, -20 deletions) <details> <summary>View changed files</summary> ➕ `docs/bundled.yaml` (+0 -0) ➕ `docs/controllers/AuthController.yaml` (+70 -0) 📝 `docs/controllers/LibraryController.yaml` (+1 -0) ➕ `docs/controllers/LibraryItemController.yaml` (+163 -0) ➕ `docs/controllers/MeController.yaml` (+205 -0) ➕ `docs/controllers/SessionController.yaml` (+278 -0) ➕ `docs/objects/Bookmarks.yaml` (+18 -0) 📝 `docs/objects/LibraryItem.yaml` (+13 -0) ➕ `docs/objects/Media.yaml` (+76 -0) ➕ `docs/objects/Permissions.yaml` (+55 -0) ➕ `docs/objects/entities/Device.yaml` (+42 -0) ➕ `docs/objects/entities/PlaybackSession.yaml` (+131 -0) ➕ `docs/objects/entities/User.yaml` (+85 -0) 📝 `docs/objects/files/AudioFile.yaml` (+16 -0) 📝 `docs/objects/mediaTypes/Book.yaml` (+14 -0) 📝 `docs/objects/metadata/BookMetadata.yaml` (+29 -20) 📝 `docs/openapi.json` (+0 -0) 📝 `docs/root.yaml` (+40 -0) 📝 `docs/schemas.yaml` (+3 -0) ➕ `unicode.dll` (+0 -0) </details> ### 📄 Description This PR is a work in progress and may never be "finished." I will be updating it with commits periodically. This PR should not be merged until the last commit is ready for merging. If the last commit is not ready for merging, I am still adding new specifications. So at that time I did not tested it or generated the `OpenApi.json`. I try to test everything somewhat. Please review before merging. Contributions and suggestions for better practices are appreciated, including naming conventions, references, etc. This is my first time writing OpenAPI specs, and I am doing my best to ensure each component is unique and references existing schemas when possible. Currently, I am testing a bit, but I wanted to open this PR to show what I am working on so others can help or contribute. --- <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:29 +02:00
adam closed this issue 2026-04-25 00:17:29 +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#3900
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?