groove/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-07-13 21:01:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Cleaning up LibraryItem schemas

Browse source
This commit is contained in:
Nicholas Wallace 2024-02-25 19:11:53 +00:00
parent c7ca8b7d65
commit 85586315f7
4 changed files with 76 additions and 174 deletions
Download patch file Download diff file Expand all files Collapse all files

23
server/objects/Folder.js
View file

@ -4,21 +4,32 @@ const uuidv4 = require("uuid").v4
* @openapi
* components:
* schemas:
* oldFolderId:
* type: string
* description: The ID of folders created on server version 2.2.23 and before.
* format: "fol_[a-z0-9]{18}"
* example: fol_o78uaoeuh78h6aoeif
* newFolderId:
* type: string
* description: The folder ID for any folders added after 2.3.0.
* format: uuid
* example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
* folderId:
* type: string
* anyOf:
* - $ref: '#/components/schemas/oldFolderId'
* - $ref: '#/components/schemas/newFolderId'
* folder:
* type: object
* properties:
* id:
* description: The ID of the folder. (Read Only)
* type: string
* example: fol_bev1zuxhb0j0s1wehr
* $ref: '#/components/schemas/folderId'
* fullPath:
* description: The path on the server for the folder. (Read Only)
* type: string
* example: /podcasts
* libraryId:
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/newLibraryId'
* - $ref: '#/components/schemas/libraryId'
* addedAt:
* description: The time (in ms since POSIX epoch) when the folder was added. (Read Only)
* type: integer