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

Added tags and other cleanup

Browse source 
Beginning cleanup of examples for linter warnings
This commit is contained in:
Nicholas Wallace 2024-02-20 00:21:26 +00:00
parent 0aba5e62c8
commit f5e1e5f21b
1 changed files with 53 additions and 100 deletions
Download patch file Download diff file Expand all files Collapse all files

149
server/models/components.js
View file

@ -6,36 +6,40 @@
* type: string * type: string
* description: The ID of the libraries created on server version 2.2.23 and before. * description: The ID of the libraries created on server version 2.2.23 and before.
* format: "lib_[a-z0-9]{18}" * format: "lib_[a-z0-9]{18}"
* examples: * example: lib_o78uaoeuh78h6aoeif
* - lib_o78uaoeuh78h6aoeif * newLibraryId:
* - lib_74obqytfms9o8oeumg
* libraryId:
* type: string * type: string
* description: The library ID for any libraries after 2.3.0. * description: The library ID for any libraries after 2.3.0.
* format: uuid * format: uuid
* example: * example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
* - e4bb1afb-4a4f-4dd6-8be0-e615d233185b
* mediaType: * mediaType:
* type: string * type: string
* description: What kind of media the library item contains. Will be book or podcast. * description: The type of media, will be book or podcast.
* enum: [book, podcast] * enum: [book, podcast]
* createdAt: * createdAt:
* type: integer * type: integer
* description: The time (in ms since POSIX epoch) when the item was created. * description: The time (in ms since POSIX epoch) when the item was created.
* example: * example: 1633522963509
* - 1633522963509 * tags:
* description: Tags applied items.
* type: array
* items:
* type: string
* examples:
* - Favorite
* - Nonfiction/History
* - Content: Violence
* library: * library:
* type: object * type: object
* properties: * properties:
* id: * id:
* oneOf: * oneOf:
* - $ref: '#/components/schemas/oldLibraryId' * - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/libraryId' * - $ref: '#/components/schemas/newLibraryId'
* name: * name:
* type: string * type: string
* description: The name of the library. * description: The name of the library.
* example: * example: Main
* - Main
* folders: * folders:
* type: array * type: array
* description: The folders that the library is composed of on the server. * description: The folders that the library is composed of on the server.
@ -44,20 +48,17 @@
* displayOrder: * displayOrder:
* type: integer * type: integer
* description: Display position of the library in the list of libraries. Must be >= 1. * description: Display position of the library in the list of libraries. Must be >= 1.
* example: * example: 1
* - 1
* icon: * icon:
* type: string * type: string
* description: The selected icon for the library. See [Library Icons](https://api.audiobookshelf.org/#library-icons) for a list of possible icons. * description: The selected icon for the library. See [Library Icons](https://api.audiobookshelf.org/#library-icons) for a list of possible icons.
* example: * example: audiobookshelf
* - audiobookshelf
* mediaType: * mediaType:
* - $ref: '#/components/schemas/mediaType' * - $ref: '#/components/schemas/mediaType'
* provider: * provider:
* type: string * type: string
* description: Preferred metadata provider for the library. See [Metadata Providers](https://api.audiobookshelf.org/#metadata-providers) for a list of possible providers. * description: Preferred metadata provider for the library. See [Metadata Providers](https://api.audiobookshelf.org/#metadata-providers) for a list of possible providers.
* example: * example: audible
* - audible
* settings: * settings:
* $ref: '#/components/schemas/librarySettings' * $ref: '#/components/schemas/librarySettings'
* createdAt: * createdAt:
@ -65,8 +66,7 @@
* lastUpdate: * lastUpdate:
* type: integer * type: integer
* description: The time (in ms since POSIX epoch) when the library was last updated. (Read Only) * description: The time (in ms since POSIX epoch) when the library was last updated. (Read Only)
* example: * example: 1646520916818
* - 1646520916818
* librarySettings: * librarySettings:
* type: object * type: object
* properties: * properties:
@ -83,8 +83,7 @@
* skipMatchingMediaWithAsin: * skipMatchingMediaWithAsin:
* type: boolean * type: boolean
* description: Whether to skip matching books that already have an ASIN. * description: Whether to skip matching books that already have an ASIN.
* example: * example: false
* - false
* skipMatchingMediaWithIsbn: * skipMatchingMediaWithIsbn:
* type: boolean * type: boolean
* description: Whether to skip matching books that already have an ISBN. * description: Whether to skip matching books that already have an ISBN.
@ -109,10 +108,7 @@
* example: * example:
* - Fantasy * - Fantasy
* tags: * tags:
* description: The tags in the library. * $ref: '#/components/schemas/tags'
* type: array
* items:
* type: string
* series: * series:
* description: The series in the library. The series will only have their id and name. * description: The series in the library. The series will only have their id and name.
* type: array * type: array
@ -155,7 +151,7 @@
* libraryId: * libraryId:
* oneOf: * oneOf:
* - $ref: '#/components/schemas/oldLibraryId' * - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/libraryId' * - $ref: '#/components/schemas/newLibraryId'
* addedAt: * addedAt:
* description: The time (in ms since POSIX epoch) when the folder was added. (Read Only) * description: The time (in ms since POSIX epoch) when the folder was added. (Read Only)
* type: integer * type: integer
@ -167,13 +163,14 @@
* id: * id:
* description: The ID of the library item. * description: The ID of the library item.
* type: string * type: string
* format: uuid
* ino: * ino:
* description: The inode of the library item. * description: The inode of the library item.
* type: string * type: string
* libraryId: * libraryId:
* oneOf: * oneOf:
* - $ref: '#/components/schemas/oldLibraryId' * - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/libraryId' * - $ref: '#/components/schemas/newLibraryId'
* folderId: * folderId:
* description: The ID of the folder the library item is in. * description: The ID of the folder the library item is in.
* type: string * type: string
@ -332,7 +329,7 @@
* libraryId: * libraryId:
* oneOf: * oneOf:
* - $ref: '#/components/schemas/oldLibraryId' * - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/libraryId' * - $ref: '#/components/schemas/newLibraryId'
* folderId: * folderId:
* description: The ID of the folder the library item is in. * description: The ID of the folder the library item is in.
* type: string * type: string
@ -433,12 +430,7 @@
* example: * example:
* - /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/cover.jpg * - /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/cover.jpg
* tags: * tags:
* description: The book's tags. * $ref: '#/components/schemas/tags'
* type: array
* items:
* type: string
* example:
* - Favorite
* audioFiles: * audioFiles:
* type: array * type: array
* items: * items:
@ -465,12 +457,7 @@
* example: * example:
* - /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/cover.jpg * - /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/cover.jpg
* tags: * tags:
* description: The book's tags. * $ref: '#/components/schemas/tags'
* type: array
* items:
* type: string
* example:
* - Favorite
* numTracks: * numTracks:
* description: The number of tracks the book's audio files have. * description: The number of tracks the book's audio files have.
* type: integer * type: integer
@ -525,12 +512,7 @@
* example: * example:
* - /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/cover.jpg * - /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/cover.jpg
* tags: * tags:
* description: The book's tags. * $ref: '#/components/schemas/tags'
* type: array
* items:
* type: string
* example:
* - Favorite
* audioFiles: * audioFiles:
* type: array * type: array
* items: * items:
@ -886,12 +868,7 @@
* example: * example:
* - /podcasts/Welcome to Night Vale/cover.jpg * - /podcasts/Welcome to Night Vale/cover.jpg
* tags: * tags:
* description: The podcast's tags. * $ref: '#/components/schemas/tags'
* type: array
* items:
* type: string
* example:
* - Favorite
* episodes: * episodes:
* description: The downloaded episodes of the podcast. * description: The downloaded episodes of the podcast.
* type: array * type: array
@ -938,12 +915,7 @@
* example: * example:
* - /podcasts/Welcome to Night Vale/cover.jpg * - /podcasts/Welcome to Night Vale/cover.jpg
* tags: * tags:
* description: The podcast's tags. * $ref: '#/components/schemas/tags'
* type: array
* items:
* type: string
* example:
* - Favorite
* numEpisodes: * numEpisodes:
* description: The number of downloaded episodes for the podcast. * description: The number of downloaded episodes for the podcast.
* type: integer * type: integer
@ -995,12 +967,7 @@
* example: * example:
* - /podcasts/Welcome to Night Vale/cover.jpg * - /podcasts/Welcome to Night Vale/cover.jpg
* tags: * tags:
* description: The podcast's tags. * $ref: '#/components/schemas/tags'
* type: array
* items:
* type: string
* example:
* - Favorite
* episodes: * episodes:
* description: The downloaded episodes of the podcast. * description: The downloaded episodes of the podcast.
* type: array * type: array
@ -1518,7 +1485,7 @@
* libraryId: * libraryId:
* oneOf: * oneOf:
* - $ref: '#/components/schemas/oldLibraryId' * - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/libraryId' * - $ref: '#/components/schemas/newLibraryId'
* isFinished: * isFinished:
* description: Whether the episode has finished downloading. * description: Whether the episode has finished downloading.
* type: boolean * type: boolean
@ -2289,7 +2256,7 @@
* libraryId: * libraryId:
* oneOf: * oneOf:
* - $ref: '#/components/schemas/oldLibraryId' * - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/libraryId' * - $ref: '#/components/schemas/newLibraryId'
* userId: * userId:
* description: The ID of the user the playlist belongs to. * description: The ID of the user the playlist belongs to.
* type: string * type: string
@ -2329,7 +2296,7 @@
* libraryId: * libraryId:
* oneOf: * oneOf:
* - $ref: '#/components/schemas/oldLibraryId' * - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/libraryId' * - $ref: '#/components/schemas/newLibraryId'
* userId: * userId:
* description: The ID of the user the playlist belongs to. * description: The ID of the user the playlist belongs to.
* type: string * type: string
@ -2526,7 +2493,7 @@
* libraryId: * libraryId:
* oneOf: * oneOf:
* - $ref: '#/components/schemas/oldLibraryId' * - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/libraryId' * - $ref: '#/components/schemas/newLibraryId'
* libraryItemId: * libraryItemId:
* description: The ID of the library item. * description: The ID of the library item.
* type: string * type: string
@ -2640,7 +2607,7 @@
* libraryId: * libraryId:
* oneOf: * oneOf:
* - $ref: '#/components/schemas/oldLibraryId' * - $ref: '#/components/schemas/oldLibraryId'
* - $ref: '#/components/schemas/libraryId' * - $ref: '#/components/schemas/newLibraryId'
* libraryItemId: * libraryItemId:
* description: The ID of the library item. * description: The ID of the library item.
* type: string * type: string
@ -3718,26 +3685,22 @@
* trackIndex: * trackIndex:
* description: The RSS feed episode's track index. * description: The RSS feed episode's track index.
* type: integer * type: integer
* example: * example: 0
* - 0
* fullPath: * fullPath:
* description: The path on the server of the audio file the RSS feed episode is for. * description: The path on the server of the audio file the RSS feed episode is for.
* type: string * type: string
* example: * example: /podcasts/Welcome to Night Vale/1 - Pilot.mp3
* - /podcasts/Welcome to Night Vale/1 - Pilot.mp3
* stream: * stream:
* type: object * type: object
* properties: * properties:
* id: * id:
* description: The ID of the stream. It will be the same as the ID of the playback session that the stream is for. * description: The ID of the stream. It will be the same as the ID of the playback session that the stream is for.
* type: string * type: string
* example: * example: play_c786zm3qtjz6bd5q3n
* - play_c786zm3qtjz6bd5q3n
* userId: * userId:
* description: The ID of the user that started the stream. * description: The ID of the user that started the stream.
* type: string * type: string
* example: * example: root
* - root
* libraryItem: * libraryItem:
* $ref: '#/components/schemas/libraryItemExpanded' * $ref: '#/components/schemas/libraryItemExpanded'
* episode: * episode:
@ -3745,56 +3708,46 @@
* segmentLength: * segmentLength:
* description: The length (in seconds) of each segment of the stream. * description: The length (in seconds) of each segment of the stream.
* type: integer * type: integer
* example: * example: 6
* - 6
* playlistPath: * playlistPath:
* description: The path on the server of the stream output. * description: The path on the server of the stream output.
* type: string * type: string
* example: * example: /metadata/streams/play_c786zm3qtjz6bd5q3n/output.m3u8
* - /metadata/streams/play_c786zm3qtjz6bd5q3n/output.m3u8
* clientPlaylistUri: * clientPlaylistUri:
* description: The URI path for the client to access the stream. * description: The URI path for the client to access the stream.
* type: string * type: string
* example: * example: /hls/play_c786zm3qtjz6bd5q3n/output.m3u8
* - /hls/play_c786zm3qtjz6bd5q3n/output.m3u8
* startTime: * startTime:
* description: The time (in seconds) where the playback session started. * description: The time (in seconds) where the playback session started.
* type: integer * type: integer
* example: * example: 0
* - 0
* segmentStartNumber: * segmentStartNumber:
* description: The segment where the transcoding began. * description: The segment where the transcoding began.
* type: integer * type: integer
* example: * example: 0
* - 0
* isTranscodeComplete: * isTranscodeComplete:
* description: Whether transcoding is complete. * description: Whether transcoding is complete.
* type: boolean * type: boolean
* example: * example: false
* - false
* streamProgress: * streamProgress:
* type: object * type: object
* properties: * properties:
* stream: * stream:
* description: The ID of the stream the progress is for. * description: The ID of the stream the progress is for.
* type: string * type: string
* example: * example: play_c786zm3qtjz6bd5q3n
* - play_c786zm3qtjz6bd5q3n
* percent: * percent:
* description: A human-readable percentage of transcode completion. * description: A human-readable percentage of transcode completion.
* type: string * type: string
* example: * example: 8.66%
* - 8.66%
* chunks: * chunks:
* description: The segment ranges that have been transcoded. * description: The segment ranges that have been transcoded.
* type: array * type: array
* items: * items:
* type: string * type: string
* example: * example: 0-536
* - 0-536
* numSegments: * numSegments:
* description: The total number of segments of the stream. * description: The total number of segments of the stream.
* type: integer * type: integer
* example: * example: 6200
* - 6200
*/ */