groove/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-07-13 04:41:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
audiobookshelf/server/models/components.js

3240 lines
134 KiB
JavaScript
Raw Normal View History

Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
/**
* @openapi
* components:
* schemas:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oldLibraryId:
* type: string
* description: The ID of the libraries created on server version 2.2.23 and before.
* format: "lib_[a-z0-9]{18}"
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: lib_o78uaoeuh78h6aoeif
* newLibraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* type: string
* description: The library ID for any libraries after 2.3.0.
* format: uuid
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
Cleaned up `mediaType` schema
2024-02-19 21:52:00 +00:00
* mediaType:
* type: string
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* description: The type of media, will be book or podcast.
Cleaned up `mediaType` schema
2024-02-19 21:52:00 +00:00
* enum: [book, podcast]
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* createdAt:
* type: integer
* description: The time (in ms since POSIX epoch) when the item was created.
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 1633522963509
* tags:
* description: Tags applied items.
* type: array
* items:
* type: string
* examples:
* - Favorite
* - Nonfiction/History
* - Content: Violence
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* library:
* type: object
* properties:
* id:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* type: string
* description: The name of the library.
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: Main
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* folders:
* type: array
* description: The folders that the library is composed of on the server.
* items:
* $ref: '#/components/schemas/folder'
* displayOrder:
* type: integer
* description: Display position of the library in the list of libraries. Must be >= 1.
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* icon:
* type: string
* description: The selected icon for the library. See [Library Icons](https://api.audiobookshelf.org/#library-icons) for a list of possible icons.
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: audiobookshelf
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaType:
Cleaned up `mediaType` schema
2024-02-19 21:52:00 +00:00
* - $ref: '#/components/schemas/mediaType'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* provider:
* type: string
* description: Preferred metadata provider for the library. See [Metadata Providers](https://api.audiobookshelf.org/#metadata-providers) for a list of possible providers.
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: audible
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* settings:
* $ref: '#/components/schemas/librarySettings'
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastUpdate:
* type: integer
* description: The time (in ms since POSIX epoch) when the library was last updated. (Read Only)
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 1646520916818
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* librarySettings:
* type: object
* properties:
* coverAspectRatio:
* type: integer
* description: Whether the library should use square book covers. Must be 0 (for false) or 1 (for true).
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* disableWatcher:
* type: boolean
* description: Whether to disable the folder watcher for the library.
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* skipMatchingMediaWithAsin:
* type: boolean
* description: Whether to skip matching books that already have an ASIN.
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* skipMatchingMediaWithIsbn:
* type: boolean
* description: Whether to skip matching books that already have an ISBN.
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* autoScanCronExpression:
* description: The cron expression for when to automatically scan the library folders. If null, automatic scanning will be disabled.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryFilterData:
* type: object
* properties:
* authors:
* description: The authors of books in the library.
* type: array
* items:
* $ref: '#/components/schemas/authorMinified'
* genres:
* description: The genres of books in the library.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Fantasy
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tags:
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* $ref: '#/components/schemas/tags'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* series:
* description: The series in the library. The series will only have their id and name.
* type: array
* items:
* type: object
* properties:
* id:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ser_cabkj4jeu8be3rap4g
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* narrators:
* description: The narrators of books in the library.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sam Tsoutsouvas
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* languages:
* description: The languages of books in the library.
* type: array
* items:
* type: string
* folder:
* type: object
* properties:
* id:
* description: The ID of the folder. (Read Only)
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: fol_bev1zuxhb0j0s1wehr
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* fullPath:
* description: The path on the server for the folder. (Read Only)
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /podcasts
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* addedAt:
* description: The time (in ms since POSIX epoch) when the folder was added. (Read Only)
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650462940610
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItem:
* type: object
* properties:
* id:
* description: The ID of the library item.
* type: string
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* format: uuid
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ino:
* description: The inode of the library item.
* type: string
* libraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* folderId:
* description: The ID of the folder the library item is in.
* type: string
* path:
* description: The path of the library item on the server.
* type: string
* relPath:
* description: The path, relative to the library folder, of the library item.
* type: string
* isFile:
* description: Whether the library item is a single file in the root of the library folder.
* type: boolean
* mtimeMs:
* description: The time (in ms since POSIX epoch) when the library item was last modified on disk.
* type: integer
* ctimeMs:
* description: The time (in ms since POSIX epoch) when the library item status was changed on disk.
* type: integer
* birthtimeMs:
* description: The time (in ms since POSIX epoch) when the library item was created on disk. Will be 0 if unknown.
* type: integer
* addedAt:
* description: The time (in ms since POSIX epoch) when the library item was added to the library.
* type: integer
* updatedAt:
* description: The time (in ms since POSIX epoch) when the library item was last updated. (Read Only)
* type: integer
* lastScan:
* description: The time (in ms since POSIX epoch) when the library item was last scanned. Will be null if the server has not yet scanned the library item.
* type: integer
* scanVersion:
* description: The version of the scanner when last scanned. Will be null if it has not been scanned.
* type: string
* isMissing:
* description: Whether the library item was scanned and no longer exists.
* type: boolean
* isInvalid:
* description: Whether the library item was scanned and no longer has media files.
* type: boolean
* mediaType:
Cleaned up `mediaType` schema
2024-02-19 21:52:00 +00:00
* - $ref: '#/components/schemas/mediaType'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* media:
* description: The media of the library item.
* oneOf:
* - $ref: '#/components/schemas/book'
* - $ref: '#/components/schemas/podcast'
* libraryFiles:
* description: The files of the library item.
* type: array
* items:
* $ref: '#/components/schemas/libraryFile'
* libraryItemMinified:
* type: object
* properties:
* id:
* description: The ID of the library item.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_8gch9ve09orgn4fdz8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ino:
* description: The inode of the library item.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '649641337522215266'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* folderId:
* description: The ID of the folder the library item is in.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: fol_bev1zuxhb0j0s1wehr
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* path:
* description: The path of the library item on the server.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* relPath:
* description: The path, relative to the library folder, of the library item.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind/Sword of Truth/Wizards First Rule
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isFile:
* description: Whether the library item is a single file in the root of the library folder.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mtimeMs:
* description: The time (in ms since POSIX epoch) when the library item was last modified on disk.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621074299
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ctimeMs:
* description: The time (in ms since POSIX epoch) when the library item status was changed on disk.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621074299
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* birthtimeMs:
* description: The time (in ms since POSIX epoch) when the library item was created on disk. Will be 0 if unknown.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* addedAt:
* description: The time (in ms since POSIX epoch) when the library item was added to the library.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the library item was last updated. (Read Only)
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621110769
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isMissing:
* description: Whether the library item was scanned and no longer exists.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isInvalid:
* description: Whether the library item was scanned and no longer has media files.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaType:
Cleaned up `mediaType` schema
2024-02-19 21:52:00 +00:00
* - $ref: '#/components/schemas/mediaType'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* media:
* description: The media of the library item.
* type: object
* additionalProperties:
* oneOf:
* - $ref: '#/components/schemas/bookMinified'
* - $ref: '#/components/schemas/podcastMinified'
* numFiles:
* description: The number of library files for the library item.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* size:
* description: The total size (in bytes) of the library item.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 268990279
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItemExpanded:
* type: object
* properties:
* id:
* description: The ID of the library item.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_8gch9ve09orgn4fdz8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ino:
* description: The inode of the library item.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '649641337522215266'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* folderId:
* description: The ID of the folder the library item is in.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: fol_bev1zuxhb0j0s1wehr
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* path:
* description: The path of the library item on the server.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* relPath:
* description: The path, relative to the library folder, of the library item.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind/Sword of Truth/Wizards First Rule
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isFile:
* description: Whether the library item is a single file in the root of the library folder.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mtimeMs:
* description: The time (in ms since POSIX epoch) when the library item was last modified on disk.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621074299
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ctimeMs:
* description: The time (in ms since POSIX epoch) when the library item status was changed on disk.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621074299
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* birthtimeMs:
* description: The time (in ms since POSIX epoch) when the library item was created on disk. Will be 0 if unknown.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* addedAt:
* description: The time (in ms since POSIX epoch) when the library item was added to the library.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the library item was last updated. (Read Only)
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621110769
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastScan:
* description: The time (in ms since POSIX epoch) when the library item was last scanned. Will be null if the server has not yet scanned the library item.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1651830827825
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scanVersion:
* description: The version of the scanner when last scanned. Will be null if it has not been scanned.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2.0.21
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isMissing:
* description: Whether the library item was scanned and no longer exists.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isInvalid:
* description: Whether the library item was scanned and no longer has media files.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaType:
Cleaned up `mediaType` schema
2024-02-19 21:52:00 +00:00
* - $ref: '#/components/schemas/mediaType'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* media:
* description: The media of the library item.
* type: object
* additionalProperties:
* oneOf:
* - $ref: '#/components/schemas/bookExpanded'
* - $ref: '#/components/schemas/podcastExpanded'
* libraryFiles:
* description: The files of the library item.
* type: array
* items:
* $ref: '#/components/schemas/libraryFile'
* size:
* description: The total size (in bytes) of the library item.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 268990279
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* book:
* type: object
* properties:
* libraryItemId:
* description: The ID of the library item that contains the book.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_8gch9ve09orgn4fdz8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadata:
* $ref: '#/components/schemas/bookMetadata'
* coverPath:
* description: The absolute path on the server of the cover file. Will be null if there is no cover.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/cover.jpg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tags:
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* $ref: '#/components/schemas/tags'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* audioFiles:
* type: array
* items:
* $ref: '#/components/schemas/audioFile'
* chapters:
* type: array
* items:
* $ref: '#/components/schemas/bookChapter'
* missingParts:
* description: Any parts missing from the book by track index.
* type: array
* items:
* type: integer
* ebookFile:
* $ref: '#/components/schemas/ebookFile'
* bookMinified:
* type: object
* properties:
* metadata:
* $ref: '#/components/schemas/bookMetadataMinified'
* coverPath:
* description: The absolute path on the server of the cover file. Will be null if there is no cover.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/cover.jpg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tags:
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* $ref: '#/components/schemas/tags'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numTracks:
* description: The number of tracks the book's audio files have.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numAudioFiles:
* description: The number of audio files the book has.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numChapters:
* description: The number of chapters the book has.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numMissingParts:
* description: The total number of missing parts the book has.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numInvalidAudioFiles:
* description: The number of invalid audio files the book has.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The total length (in seconds) of the book.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 33854.905
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* size:
* description: The total size (in bytes) of the book.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 268824228
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ebookFormat:
* description: The format of ebook of the book. Will be null if the book is an audiobook.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* bookExpanded:
* type: object
* properties:
* libraryItemId:
* description: The ID of the library item that contains the book.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_8gch9ve09orgn4fdz8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadata:
* $ref: '#/components/schemas/bookMetadataExpanded'
* coverPath:
* description: The absolute path on the server of the cover file. Will be null if there is no cover.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/cover.jpg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tags:
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* $ref: '#/components/schemas/tags'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* audioFiles:
* type: array
* items:
* $ref: '#/components/schemas/audioFile'
* chapters:
* type: array
* items:
* $ref: '#/components/schemas/bookChapter'
* missingParts:
* description: Any parts missing from the book by track index.
* type: array
* items:
* type: integer
* ebookFile:
* $ref: '#/components/schemas/ebookFile'
* duration:
* description: The total length (in seconds) of the book.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 33854.905
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* size:
* description: The total size (in bytes) of the book.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 268824228
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tracks:
* type: array
* items:
* $ref: '#/components/schemas/audioTrack'
* bookMetadata:
* type: object
* properties:
* title:
* description: The title of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Wizards First Rule
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* subtitle:
* description: The subtitle of the book. Will be null if there is no subtitle.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* authors:
* description: The authors of the book.
* type: array
* items:
* $ref: '#/components/schemas/authorMinified'
* narrators:
* description: The narrators of the audiobook.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sam Tsoutsouvas
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* series:
* description: The series the book belongs to.
* type: array
* items:
* $ref: '#/components/schemas/seriesSequence'
* genres:
* description: The genres of the book.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Fantasy
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publishedYear:
* description: The year the book was published. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '2008'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publishedDate:
* description: The date the book was published. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publisher:
* description: The publisher of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Brilliance Audio
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: A description for the book. Will be null if empty.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* The masterpiece that started Terry Goodkind's New York Times bestselling
* epic Sword of Truth In the aftermath of the brutal murder of his father,
* a mysterious woman, Kahlan Amnell, appears in Richard Cypher's forest
* sanctuary seeking help...and more. His world, his very beliefs, are
* shattered when ancient debts come due with thundering violence. In a
* dark age it takes courage to live, and more than mere courage to
* challenge those who hold dominion, Richard and Kahlan must take up that
* challenge or become the next victims. Beyond awaits a bewitching land
* where even the best of their hearts could betray them. Yet, Richard
* fears nothing so much as what secrets his sword might reveal about his
* own soul. Falling in love would destroy them - for reasons Richard can't
* imagine and Kahlan dare not say. In their darkest hour, hunted
* relentlessly, tormented by treachery and loss, Kahlan calls upon Richard
* to reach beyond his sword - to invoke within himself something more
* noble. Neither knows that the rules of battle have just changed...or
* that their time has run out. Wizard's First Rule is the beginning. One
* book. One Rule. Witness the birth of a legend.
* isbn:
* description: The ISBN of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* asin:
* description: The ASIN of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: B002V0QK4C
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The language of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* explicit:
* description: Whether the book has been marked as explicit.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* bookMetadataMinified:
* type: object
* properties:
* title:
* description: The title of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Wizards First Rule
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* titleIgnorePrefix:
* description: The title of the book with any prefix moved to the end.
* type: string
* subtitle:
* description: The subtitle of the book. Will be null if there is no subtitle.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* authorName:
* description: The name of the book's author(s).
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* authorNameLF:
* description: The name of the book's author(s) with last names first.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Goodkind, Terry
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* narratorName:
* description: The name of the audiobook's narrator(s).
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sam Tsoutsouvas
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* seriesName:
* description: The name of the book's series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* genres:
* description: The genres of the book.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Fantasy
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publishedYear:
* description: The year the book was published. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '2008'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publishedDate:
* description: The date the book was published. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publisher:
* description: The publisher of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Brilliance Audio
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: A description for the book. Will be null if empty.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* The masterpiece that started Terry Goodkind's New York Times bestselling
* epic Sword of Truth In the aftermath of the brutal murder of his father,
* a mysterious woman, Kahlan Amnell, appears in Richard Cypher's forest
* sanctuary seeking help...and more. His world, his very beliefs, are
* shattered when ancient debts come due with thundering violence. In a
* dark age it takes courage to live, and more than mere courage to
* challenge those who hold dominion, Richard and Kahlan must take up that
* challenge or become the next victims. Beyond awaits a bewitching land
* where even the best of their hearts could betray them. Yet, Richard
* fears nothing so much as what secrets his sword might reveal about his
* own soul. Falling in love would destroy them - for reasons Richard can't
* imagine and Kahlan dare not say. In their darkest hour, hunted
* relentlessly, tormented by treachery and loss, Kahlan calls upon Richard
* to reach beyond his sword - to invoke within himself something more
* noble. Neither knows that the rules of battle have just changed...or
* that their time has run out. Wizard's First Rule is the beginning. One
* book. One Rule. Witness the birth of a legend.
* isbn:
* description: The ISBN of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* asin:
* description: The ASIN of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: B002V0QK4C
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The language of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* explicit:
* description: Whether the book has been marked as explicit.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* bookMetadataExpanded:
* type: object
* properties:
* title:
* description: The title of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Wizards First Rule
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* titleIgnorePrefix:
* description: The title of the book with any prefix moved to the end.
* type: string
* subtitle:
* description: The subtitle of the book. Will be null if there is no subtitle.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* authorName:
* description: The name of the book's author(s).
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* authorNameLF:
* description: The name of the book's author(s) with last names first.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Goodkind, Terry
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* narratorName:
* description: The name of the audiobook's narrator(s).
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sam Tsoutsouvas
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* seriesName:
* description: The name of the book's series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* authors:
* description: The authors of the book.
* type: array
* items:
* $ref: '#/components/schemas/authorMinified'
* narrators:
* description: The narrators of the audiobook.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sam Tsoutsouvas
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* series:
* description: The series the book belongs to.
* type: array
* items:
* $ref: '#/components/schemas/seriesSequence'
* genres:
* description: The genres of the book.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Fantasy
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publishedYear:
* description: The year the book was published. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '2008'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publishedDate:
* description: The date the book was published. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publisher:
* description: The publisher of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Brilliance Audio
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: A description for the book. Will be null if empty.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* The masterpiece that started Terry Goodkind's New York Times bestselling
* epic Sword of Truth In the aftermath of the brutal murder of his father,
* a mysterious woman, Kahlan Amnell, appears in Richard Cypher's forest
* sanctuary seeking help...and more. His world, his very beliefs, are
* shattered when ancient debts come due with thundering violence. In a
* dark age it takes courage to live, and more than mere courage to
* challenge those who hold dominion, Richard and Kahlan must take up that
* challenge or become the next victims. Beyond awaits a bewitching land
* where even the best of their hearts could betray them. Yet, Richard
* fears nothing so much as what secrets his sword might reveal about his
* own soul. Falling in love would destroy them - for reasons Richard can't
* imagine and Kahlan dare not say. In their darkest hour, hunted
* relentlessly, tormented by treachery and loss, Kahlan calls upon Richard
* to reach beyond his sword - to invoke within himself something more
* noble. Neither knows that the rules of battle have just changed...or
* that their time has run out. Wizard's First Rule is the beginning. One
* book. One Rule. Witness the birth of a legend.
* isbn:
* description: The ISBN of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* asin:
* description: The ASIN of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: B002V0QK4C
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The language of the book. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* explicit:
* description: Whether the book has been marked as explicit.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* bookChapter:
* type: object
* properties:
* id:
* description: The ID of the book chapter.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* start:
* description: When in the book (in seconds) the chapter starts.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* end:
* description: When in the book (in seconds) the chapter ends.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 6004.6675
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* title:
* description: The title of the chapter.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Wizards First Rule 01
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcast:
* type: object
* properties:
* libraryItemId:
* description: The ID of the library item that contains the podcast.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadata:
* $ref: '#/components/schemas/podcastMetadata'
* coverPath:
* description: The absolute path on the server of the cover file. Will be null if there is no cover.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /podcasts/Welcome to Night Vale/cover.jpg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tags:
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* $ref: '#/components/schemas/tags'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodes:
* description: The downloaded episodes of the podcast.
* type: array
* items:
* $ref: '#/components/schemas/podcastEpisode'
* autoDownloadEpisodes:
* description: Whether the server will automatically download podcast episodes according to the schedule.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* autoDownloadSchedule:
* description: The cron expression for when to automatically download podcast episodes. Will not exist if autoDownloadEpisodes is false.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0 0 * * 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastEpisodeCheck:
* description: The time (in ms since POSIX epoch) when the podcast was checked for new episodes.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1667326662087
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* maxEpisodesToKeep:
* description: The maximum number of podcast episodes to keep when automatically downloading new episodes. Episodes beyond this limit will be deleted. If 0, all episodes will be kept.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* maxNewEpisodesToDownload:
* description: The maximum number of podcast episodes to download when automatically downloading new episodes. If 0, all episodes will be downloaded.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastMinified:
* type: object
* properties:
* libraryItemId:
* description: The ID of the library item that contains the podcast.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadata:
* $ref: '#/components/schemas/podcastMetadata'
* coverPath:
* description: The absolute path on the server of the cover file. Will be null if there is no cover.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /podcasts/Welcome to Night Vale/cover.jpg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tags:
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* $ref: '#/components/schemas/tags'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numEpisodes:
* description: The number of downloaded episodes for the podcast.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* autoDownloadEpisodes:
* description: Whether the server will automatically download podcast episodes according to the schedule.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* autoDownloadSchedule:
* description: The cron expression for when to automatically download podcast episodes. Will not exist if autoDownloadEpisodes is false.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0 0 * * 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastEpisodeCheck:
* description: The time (in ms since POSIX epoch) when the podcast was checked for new episodes.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1667326662087
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* maxEpisodesToKeep:
* description: The maximum number of podcast episodes to keep when automatically downloading new episodes. Episodes beyond this limit will be deleted. If 0, all episodes will be kept.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* maxNewEpisodesToDownload:
* description: The maximum number of podcast episodes to download when automatically downloading new episodes. If 0, all episodes will be downloaded.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* size:
* description: The total size (in bytes) of the podcast.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 23706728
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastExpanded:
* type: object
* properties:
* libraryItemId:
* description: The ID of the library item that contains the podcast.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadata:
* $ref: '#/components/schemas/podcastMetadataExpanded'
* coverPath:
* description: The absolute path on the server of the cover file. Will be null if there is no cover.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /podcasts/Welcome to Night Vale/cover.jpg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tags:
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* $ref: '#/components/schemas/tags'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodes:
* description: The downloaded episodes of the podcast.
* type: array
* items:
* $ref: '#/components/schemas/podcastEpisodeExpanded'
* autoDownloadEpisodes:
* description: Whether the server will automatically download podcast episodes according to the schedule.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* autoDownloadSchedule:
* description: The cron expression for when to automatically download podcast episodes. Will not exist if autoDownloadEpisodes is false.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0 0 * * 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastEpisodeCheck:
* description: The time (in ms since POSIX epoch) when the podcast was checked for new episodes.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1667326662087
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* maxEpisodesToKeep:
* description: The maximum number of podcast episodes to keep when automatically downloading new episodes. Episodes beyond this limit will be deleted. If 0, all episodes will be kept.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* maxNewEpisodesToDownload:
* description: The maximum number of podcast episodes to download when automatically downloading new episodes. If 0, all episodes will be downloaded.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* size:
* description: The total size (in bytes) of the podcast.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 23706728
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastMetadata:
* type: object
* properties:
* title:
* description: The title of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Welcome to Night Vale
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* author:
* description: The author of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Night Vale Presents
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: The description for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: |2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* Twice-monthly community updates for the small desert town of Night Vale, where every conspiracy theory is true. Turn on your radio and hide. Never listened before? It's an ongoing radio show. Start with the current episode, and you'll catch on in no time. Or, go right to Episode 1 if you wanna binge-listen.
* releaseDate:
* description: The release date of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '2022-10-20T19:00:00Z'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: date-time
* genres:
* description: The podcast's genres.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Science Fiction
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* - Podcasts
* - Fiction
* feedUrl:
* description: A URL of an RSS feed for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: http://feeds.nightvalepresents.com/welcometonightvalepodcast
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* imageUrl:
* description: A URL of a cover image for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://is4-ssl.mzstatic.com/image/thumb/Podcasts125/v4/4a/31/35/4a3135d0-1fe7-a2d7-fb43-d182ec175402/mza_8232698753950666850.jpg/600x600bb.jpg
* format: url
* itunesPageUrl:
* description: A URL of an iTunes page for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://podcasts.apple.com/us/podcast/welcome-to-night-vale/id536258179?uo=4
* format: url
* itunesId:
* description: The iTunes ID for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 536258179
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* itunesArtistId:
* description: The iTunes Artist ID for the author of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 718704794
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* explicit:
* description: Whether the podcast has been marked as explicit.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The language of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* type:
* description: The type of the podcast.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: episodic
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastMetadataMinified:
* type: object
* properties:
* title:
* description: The title of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Welcome to Night Vale
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* titleIgnorePrefix:
* description: The title of the podcast with any prefix moved to the end.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Welcome to Night Vale
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* author:
* description: The author of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Night Vale Presents
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: The description for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: |2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* Twice-monthly community updates for the small desert town of Night Vale, where every conspiracy theory is true. Turn on your radio and hide. Never listened before? It's an ongoing radio show. Start with the current episode, and you'll catch on in no time. Or, go right to Episode 1 if you wanna binge-listen.
* releaseDate:
* description: The release date of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '2022-10-20T19:00:00Z'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: date-time
* genres:
* description: The podcast's genres.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Science Fiction
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* - Podcasts
* - Fiction
* feedUrl:
* description: A URL of an RSS feed for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: http://feeds.nightvalepresents.com/welcometonightvalepodcast
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* imageUrl:
* description: A URL of a cover image for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://is4-ssl.mzstatic.com/image/thumb/Podcasts125/v4/4a/31/35/4a3135d0-1fe7-a2d7-fb43-d182ec175402/mza_8232698753950666850.jpg/600x600bb.jpg
* format: url
* itunesPageUrl:
* description: A URL of an iTunes page for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://podcasts.apple.com/us/podcast/welcome-to-night-vale/id536258179?uo=4
* format: url
* itunesId:
* description: The iTunes ID for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 536258179
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* itunesArtistId:
* description: The iTunes Artist ID for the author of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 718704794
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* explicit:
* description: Whether the podcast has been marked as explicit.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The language of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* type:
* description: The type of the podcast.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: episodic
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastMetadataExpanded:
* type: object
* properties:
* title:
* description: The title of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Welcome to Night Vale
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* titleIgnorePrefix:
* description: The title of the podcast with any prefix moved to the end.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Welcome to Night Vale
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* author:
* description: The author of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Night Vale Presents
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: The description for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: |2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* Twice-monthly community updates for the small desert town of Night Vale, where every conspiracy theory is true. Turn on your radio and hide. Never listened before? It's an ongoing radio show. Start with the current episode, and you'll catch on in no time. Or, go right to Episode 1 if you wanna binge-listen.
* releaseDate:
* description: The release date of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '2022-10-20T19:00:00Z'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: date-time
* genres:
* description: The podcast's genres.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Science Fiction
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* - Podcasts
* - Fiction
* feedUrl:
* description: A URL of an RSS feed for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: http://feeds.nightvalepresents.com/welcometonightvalepodcast
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* imageUrl:
* description: A URL of a cover image for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://is4-ssl.mzstatic.com/image/thumb/Podcasts125/v4/4a/31/35/4a3135d0-1fe7-a2d7-fb43-d182ec175402/mza_8232698753950666850.jpg/600x600bb.jpg
* format: url
* itunesPageUrl:
* description: A URL of an iTunes page for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://podcasts.apple.com/us/podcast/welcome-to-night-vale/id536258179?uo=4
* format: url
* itunesId:
* description: The iTunes ID for the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 536258179
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* itunesArtistId:
* description: The iTunes Artist ID for the author of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 718704794
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* explicit:
* description: Whether the podcast has been marked as explicit.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The language of the podcast. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* type:
* description: The type of the podcast.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: episodic
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastEpisode:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [object, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* properties:
* libraryItemId:
* description: The ID of the library item that contains the podcast.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* id:
* description: The ID of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* index:
* description: The index of the podcast episode.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* season:
* description: The season of the podcast episode, if known.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episode:
* description: The episode of the season of the podcast, if known.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeType:
* description: The type of episode that the podcast episode is.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: full
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* title:
* description: The title of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Pilot
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* subtitle:
* description: The subtitle of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* Pilot Episode. A new dog park opens in Night Vale. Carlos, a scientist,
* visits and discovers some interesting things. Seismic things. Plus, a
* helpful guide to surveillance helicopter-spotting. Weather: "These and
* More Than These" by Joseph Fink Music:...
* description:
* description: A HTML encoded, description of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* <p>Pilot Episode. A new dog park opens in Night Vale. Carlos, a scientist, visits and discovers some interesting things. Seismic things. Plus, a helpful guide to surveillance helicopter-spotting.</p>
* <p>Weather: "These and More Than These" by Joseph Fink</p>
* <p>Music: Disparition, <a target="_blank">disparition.info</a></p>
* <p>Logo: Rob Wilson, <a target="_blank">silastom.com</a></p>
* <p>Produced by Night Vale Presents. Written by Joseph Fink and Jeffrey
* Cranor. Narrated by Cecil Baldwin. More Info: <a
* target="_blank">welcometonightvale.com</a>, and follow <a
* target="_blank">@NightValeRadio</a> on Twitter or <a
* target="_blank">Facebook</a>.</p>
* enclosure:
* $ref: '#/components/schemas/podcastEpisodeEnclousure'
* pubDate:
* description: When the podcast episode was published.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Fri, 15 Jun 2012 12:00:00 -0000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* audioFile:
* $ref: '#/components/schemas/audioFile'
* publishedAt:
* description: The time (in ms since POSIX epoch) when the podcast episode was published.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1339761600000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* addedAt:
* description: The time (in ms since POSIX epoch) when the podcast episode was added to the library.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1667326679503
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the podcast episode was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1667326679503
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastEpisodeExpanded:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [object, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* properties:
* libraryItemId:
* description: The ID of the library item that contains the podcast.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* id:
* description: The ID of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* index:
* description: The index of the podcast episode.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* season:
* description: The season of the podcast episode, if known.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episode:
* description: The episode of the season of the podcast, if known.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeType:
* description: The type of episode that the podcast episode is.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: full
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* title:
* description: The title of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Pilot
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* subtitle:
* description: The subtitle of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* Pilot Episode. A new dog park opens in Night Vale. Carlos, a scientist,
* visits and discovers some interesting things. Seismic things. Plus, a
* helpful guide to surveillance helicopter-spotting. Weather: "These and
* More Than These" by Joseph Fink Music:...
* description:
* description: A HTML encoded, description of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* <p>Pilot Episode. A new dog park opens in Night Vale. Carlos, a scientist, visits and discovers some interesting things. Seismic things. Plus, a helpful guide to surveillance helicopter-spotting.</p>
*
* <p>Weather: "These and More Than These" by Joseph Fink</p>
*
*
* <p>Music: Disparition, <a target="_blank">disparition.info</a></p>
*
*
* <p>Logo: Rob Wilson, <a target="_blank">silastom.com</a></p>
*
*
* <p>Produced by Night Vale Presents. Written by Joseph Fink and Jeffrey
* Cranor. Narrated by Cecil Baldwin. More Info: <a
* target="_blank">welcometonightvale.com</a>, and follow <a
* target="_blank">@NightValeRadio</a> on Twitter or <a
* target="_blank">Facebook</a>.</p>
* enclosure:
* $ref: '#/components/schemas/podcastEpisodeEnclousure'
* pubDate:
* description: When the podcast episode was published.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Fri, 15 Jun 2012 12:00:00 -0000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* audioFile:
* $ref: '#/components/schemas/audioFile'
* audioTrack:
* $ref: '#/components/schemas/audioTrack'
* publishedAt:
* description: The time (in ms since POSIX epoch) when the podcast episode was published.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1339761600000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* addedAt:
* description: The time (in ms since POSIX epoch) when the podcast episode was added to the library.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1667326679503
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the podcast episode was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1667326679503
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The total length (in seconds) of the podcast episode.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1454.18449
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* size:
* description: The total size (in bytes) of the podcast episode.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 23653735
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastEpisodeEnclousure:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [object, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* properties:
* url:
* description: The URL where the podcast episode's audio file was downloaded from.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://www.podtrac.com/pts/redirect.mp3/dovetail.prxu.org/_/126/1fadf1ad-aad8-449f-843b-6e8bb6949622/1_Pilot.mp3
* format: url
* type:
* description: The MIME type of the podcast episode's audio file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: audio/mpeg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* length:
* description: The size (in bytes) that was reported when downloading the podcast episode's audio file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '20588611'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastEpisodeDownload:
* type: object
* properties:
* id:
* description: The ID of the podcast episode download.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: epdl_pgv4d47j6dtqpk4r0v
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeDisplayTitle:
* description: The display title of the episode to be downloaded.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Glow Cloud
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* url:
* description: The URL from which to download the episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://www.podtrac.com/pts/redirect.mp3/dovetail.prxu.org/_/126/cb1dd91f-5d8d-42e9-ba22-14ff335d2cbb/2_Glow_Cloud.mp3
* format: url
* libraryItemId:
* description: The ID of the library item the episode belongs to.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isFinished:
* description: Whether the episode has finished downloading.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* failed:
* description: Whether the episode failed to download.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* startedAt:
* description: The time (in ms since POSIX epoch) when the episode started downloading. Will be null if it has not started downloading yet.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* finishedAt:
* description: The time (in ms since POSIX epoch) when the episode finished downloading. Will be null if it has not finished.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastTitle:
* description: The title of the episode's podcast.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Welcome to Night Vale
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastExplicit:
* description: Whether the episode's podcast is explicit.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* season:
* description: The season of the podcast episode.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episode:
* description: The episode number of the podcast episode.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeType:
* description: The type of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: full
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publishedAt:
* description: The time (in ms since POSIX epoch) when the episode was published.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1341144000000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastFeed:
* type: object
* properties:
* metadata:
* $ref: '#/components/schemas/podcastMetadata'
* episodes:
* type: array
* items:
* $ref: '#/components/schemas/podcastEpisode'
* podcastFeedMinified:
* type: object
* properties:
* metadata:
* $ref: '#/components/schemas/podcastMetadata'
* numEpisodes:
* description: The number of episodes the podcast has.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 280
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastFeedMetadata:
* type: object
* properties:
* image:
* description: A URL for the podcast's cover image.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://f.prxu.org/126/images/1f749c5d-c83a-4db9-8112-a3245da49c54/nightvalelogo-web4.jpg
* format: url
* categories:
* description: The podcast's categories. Can be similar to genres.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Fiction:Science Fiction
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* feedUrl:
* description: A URL of an RSS feed for the podcast.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: http://feeds.nightvalepresents.com/welcometonightvalepodcast
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* description:
* description: A HTML encoded description of the podcast.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: |2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* <p>Twice-monthly community updates for the small desert town of Night Vale, where every conspiracy theory is true. Turn on your radio and hide. Never listened before? It's an ongoing radio show. Start with the current episode, and you'll catch on in no time. Or, go right to Episode 1 if you wanna binge-listen.</p>
*
* descriptionPlain:
* description: A plain text description of the podcast.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: |2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* Twice-monthly community updates for the small desert town of Night Vale, where every conspiracy theory is true. Turn on your radio and hide. Never listened before? It's an ongoing radio show. Start with the current episode, and you'll catch on in no time. Or, go right to Episode 1 if you wanna binge-listen.
* title:
* description: The podcast's title.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Welcome to Night Vale
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The podcast's language.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: en
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* explicit:
* description: Whether the podcast is explicit. Will probably be "true" or "false".
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 'false'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* author:
* description: The podcast's author.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Night Vale Presents
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* pubDate:
* description: The podcast's publication date.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Thu, 17 Nov 2022 16:04:42 -0000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* link:
* description: A URL the RSS feed provided for possible display to the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: http://welcometonightvale.com
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* podcastFeedEpisode:
* type: object
* properties:
* title:
* description: The podcast episode's title.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Pilot
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* subtitle:
* description: The podcast episode's subtitle.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* Pilot Episode. A new dog park opens in Night Vale. Carlos, a scientist,
* visits and discovers some interesting things. Seismic things. Plus, a
* helpful guide to surveillance helicopter-spotting. Weather: "These and
* More Than These" by Joseph Fink Music:...
* description:
* description: A HTML encoded description of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* <p>Pilot Episode. A new dog park opens in Night Vale. Carlos, a scientist, visits and discovers some interesting things. Seismic things. Plus, a helpful guide to surveillance helicopter-spotting.</p>
*
* <p>Weather: "These and More Than These" by Joseph Fink</p>
*
*
* <p>Music: Disparition, <a target="_blank">disparition.info</a></p>
*
*
* <p>Logo: Rob Wilson, <a target="_blank">silastom.com</a></p>
*
*
* <p>Produced by Night Vale Presents. Written by Joseph Fink and Jeffrey
* Cranor. Narrated by Cecil Baldwin. More Info: <a
* target="_blank">welcometonightvale.com</a>, and follow <a
* target="_blank">@NightValeRadio</a> on Twitter or <a
* target="_blank">Facebook</a>.</p>
*
* descriptionPlain:
* description: A plain text description of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* Pilot Episode. A new dog park opens in Night Vale. Carlos, a scientist, visits and discovers some interesting things. Seismic things. Plus, a helpful guide to surveillance helicopter-spotting.
*
* Weather: "These and More Than These" by Joseph Fink
*
*
* Music: Disparition, disparition.info
*
*
* Logo: Rob Wilson, silastom.com
*
*
* Produced by Night Vale Presents. Written by Joseph Fink and Jeffrey
* Cranor. Narrated by Cecil Baldwin. More Info: welcometonightvale.com,
* and follow @NightValeRadio on Twitter or Facebook.
* pubDate:
* description: The podcast episode's publication date.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Fri, 15 Jun 2012 12:00:00 -0000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeType:
* description: The type of episode that the podcast episode is.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: full
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* season:
* description: The season of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episode:
* description: The episode of the season of the podcast.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* author:
* description: The author of the podcast episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The duration of the podcast episode as reported by the RSS feed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '21:02'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* explicit:
* description: Whether the podcast episode is explicit.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ''
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* publishedAt:
* description: The time (in ms since POSIX epoch) when the podcast episode was published.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1339761600000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* enclosure:
* $ref: '#/components/schemas/podcastEpisodeEnclousure'
* audioFile:
* type: object
* properties:
* index:
* description: The index of the audio file.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ino:
* description: The inode of the audio file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '649644248522215260'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadata:
* $ref: '#/components/schemas/fileMetadata'
* addedAt:
* description: The time (in ms since POSIX epoch) when the audio file was added to the library.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621074131
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the audio file last updated. (Read Only)
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1651830828023
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* trackNumFromMeta:
* description: The track number of the audio file as pulled from the file's metadata. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* discNumFromMeta:
* description: The disc number of the audio file as pulled from the file's metadata. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* trackNumFromFilename:
* description: The track number of the audio file as determined from the file's name. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* discNumFromFilename:
* description: The track number of the audio file as determined from the file's name. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* manuallyVerified:
* description: Whether the audio file has been manually verified by a user.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* invalid:
* description: Whether the audio file is missing from the server.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* exclude:
* description: Whether the audio file has been marked for exclusion.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* error:
* description: Any error with the audio file. Will be null if there is none.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format:
* description: The format of the audio file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: MP2/3 (MPEG audio layer 2/3)
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The total length (in seconds) of the audio file.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 6004.6675
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* bitRate:
* description: The bit rate (in bit/s) of the audio file.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 64000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The language of the audio file.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* codec:
* description: The codec of the audio file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: mp3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* timeBase:
* description: The time base of the audio file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1/14112000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* channels:
* description: The number of channels the audio file has.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* channelLayout:
* description: The layout of the audio file's channels.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: stereo
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* chapters:
* description: If the audio file is part of an audiobook, the chapters the file contains.
* type: array
* items:
* $ref: '#/components/schemas/bookChapter'
* embeddedCoverArt:
* description: The type of embedded cover art in the audio file. Will be null if none exists.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metaTags:
* $ref: '#/components/schemas/audioMetaTags'
* mimeType:
* description: The MIME type of the audio file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: audio/mpeg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* audioMetaTags:
* description: ID3 metadata tags pulled from the audio file on import. Only non-null tags will be returned in requests.
* type: object
* properties:
* tagAlbum:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: SOT Bk01
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagArtist:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagGenre:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Audiobook Fantasy
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagTitle:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Wizards First Rule 01
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagSeries:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagSeriesPart:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagTrack:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 01/20
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagDisc:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagSubtitle:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagAlbumArtist:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagDate:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagComposer:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagPublisher:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagComment:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagDescription:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagEncoder:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagEncodedBy:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagIsbn:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagLanguage:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagASIN:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagOverdriveMediaMarker:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagOriginalYear:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagReleaseCountry:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagReleaseType:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagReleaseStatus:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagISRC:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagMusicBrainzTrackId:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagMusicBrainzAlbumId:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagMusicBrainzAlbumArtistId:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* tagMusicBrainzArtistId:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* audioTrack:
* type: object
* properties:
* index:
* description: The index of the audio track.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* startOffset:
* description: When in the audio file (in seconds) the track starts.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The length (in seconds) of the audio track.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 33854.905
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* title:
* description: The filename of the audio file the audio track belongs to.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Wizards First Rule 01.mp3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* contentUrl:
* description: The URL path of the audio file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* /s/item/li_8gch9ve09orgn4fdz8/Terry Goodkind - SOT Bk01 - Wizards First
* Rule 01.mp3
* mimeType:
* description: The MIME type of the audio file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: audio/mpeg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadata:
* $ref: '#/components/schemas/fileMetadata'
* ebookFile:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [object, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* properties:
* ino:
* description: The inode of the ebook file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '9463162'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadata:
* $ref: '#/components/schemas/fileMetadata'
* ebookFormat:
* description: The ebook format of the ebook file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: epub
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* addedAt:
* description: The time (in ms since POSIX epoch) when the library file was added.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the library file was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621110769
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryFile:
* type: object
* properties:
* ino:
* description: The inode of the library file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '649644248522215260'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadata:
* $ref: '#/components/schemas/fileMetadata'
* addedAt:
* description: The time (in ms since POSIX epoch) when the library file was added.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621052494
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the library file was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621052494
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* fileType:
* description: The type of file that the library file is (audio, image, etc.).
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: audio
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* fileMetadata:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [object, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* properties:
* filename:
* description: The filename of the file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Wizards First Rule 01.mp3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ext:
* description: The file extension of the file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: .mp3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* path:
* description: The absolute path on the server of the file.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* /audiobooks/Terry Goodkind/Sword of Truth/Wizards First Rule/Terry
* Goodkind - SOT Bk01 - Wizards First Rule 01.mp3
* relPath:
* description: The path of the file, relative to the book's or podcast's folder.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Wizards First Rule 01.mp3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* size:
* description: The size (in bytes) of the file.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 48037888
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mtimeMs:
* description: The time (in ms since POSIX epoch) when the file was last modified on disk.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1632223180278
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ctimeMs:
* description: The time (in ms since POSIX epoch) when the file status was changed on disk.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1645978261001
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* birthtimeMs:
* description: The time (in ms since POSIX epoch) when the file was created on disk. Will be 0 if unknown.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* author:
* type: object
* properties:
* id:
* description: The ID of the author.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: aut_z3leimgybl7uf3y4ab
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* asin:
* description: The ASIN of the author. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* description: The name of the author.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: A description of the author. Will be null if there is none.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* imagePath:
* description: The absolute path for the author image. Will be null if there is no image.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* addedAt:
* description: The time (in ms since POSIX epoch) when the author was added.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the author was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* authorMinified:
* type: object
* properties:
* id:
* description: The ID of the author.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: aut_z3leimgybl7uf3y4ab
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* description: The name of the author.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* authorExpanded:
* type: object
* properties:
* id:
* description: The ID of the author.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: aut_z3leimgybl7uf3y4ab
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* asin:
* description: The ASIN of the author. Will be null if unknown.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* description: The name of the author.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Terry Goodkind
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: A description of the author. Will be null if there is none.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* imagePath:
* description: The absolute path for the author image. Will be null if there is no image.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* addedAt:
* description: The time (in ms since POSIX epoch) when the author was added.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the author was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numBooks:
* description: The number of books associated with the author in the library.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* series:
* type: object
* properties:
* id:
* description: The ID of the series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ser_cabkj4jeu8be3rap4g
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* description: The name of the series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: A description for the series. Will be null if there is none.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* addedAt:
* description: The time (in ms since POSIX epoch) when the series was added.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the series was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* seriesNumBooks:
* type: object
* properties:
* id:
* description: The ID of the series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ser_cabkj4jeu8be3rap4g
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* description: The name of the series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* nameIgnorePrefix:
* description: The name of the series with any prefix moved to the end.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItemIds:
* description: The IDs of the library items in the series.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_8gch9ve09orgn4fdz8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numBooks:
* description: The number of books in the series.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* seriesBooks:
* type: object
* properties:
* id:
* description: The ID of the series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ser_cabkj4jeu8be3rap4g
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* description: The name of the series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* nameIgnorePrefix:
* description: The name of the series with any prefix moved to the end.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* nameIgnorePrefixSort:
* description: The name of the series with any prefix removed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* type:
* description: Will always be series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: series
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* books:
* description: The library items that contain the books in the series. A sequence attribute that denotes the position in the series the book is in, is tacked on.
* type: array
* items:
* $ref: '#/components/schemas/libraryItem'
* addedAt:
* description: The time (in ms since POSIX epoch) when the series was added.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1650621073750
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* totalDuration:
* description: The combined duration (in seconds) of all books in the series.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 12000.946
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* seriesSequence:
* type: object
* properties:
* id:
* description: The ID of the series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ser_cabkj4jeu8be3rap4g
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* description: The name of the series.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Sword of Truth
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* sequence:
* description: The position in the series the book is.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '1'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* playlist:
* type: object
* properties:
* id:
* description: The ID of the playlist.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: pl_qbwet64998s5ra6dcu
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* userId:
* description: The ID of the user the playlist belongs to.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* description: The playlist's name.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Favorites
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: The playlist's description.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* coverPath:
* description: The path of the playlist's cover.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* items:
* description: The items in the playlist.
* type: array
* items:
* $ref: '#/components/schemas/playlistItem'
* lastUpdate:
* description: The time (in ms since POSIX epoch) when the playlist was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1669623431313
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* playlistExpanded:
* type: object
* properties:
* id:
* description: The ID of the playlist.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: pl_qbwet64998s5ra6dcu
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* userId:
* description: The ID of the user the playlist belongs to.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* name:
* description: The playlist's name.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Favorites
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: The playlist's description.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* coverPath:
* description: The path of the playlist's cover.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* items:
* description: The items in the playlist.
* type: array
* items:
* $ref: '#/components/schemas/playlistItemExpanded'
* lastUpdate:
* description: The time (in ms since POSIX epoch) when the playlist was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1669623431313
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* playlistItem:
* type: object
* properties:
* libraryItemId:
* description: The ID of the library item the playlist item is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_8gch9ve09orgn4fdz8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeId:
* description: The ID of the podcast episode the playlist item is for.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* playlistItemExpanded:
* type: object
* properties:
* libraryItemId:
* description: The ID of the library item the playlist item is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_8gch9ve09orgn4fdz8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeId:
* description: The ID of the podcast episode the playlist item is for.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episode:
* $ref: '#/components/schemas/podcastEpisodeExpanded'
* libraryItem:
* description: The library item the playlist item is for. Will be Library Item Minified if episodeId is not null.
* type: object
* additionalProperties:
* oneOf:
* - $ref: '#/components/schemas/libraryItemMinified'
* - $ref: '#/components/schemas/libraryItemExpanded'
* mediaProgress:
* type: object
* properties:
* id:
* description: The ID of the media progress. If the media progress is for a book, this will just be the libraryItemId. If for a podcast episode, it will be a hyphenated combination of the libraryItemId and episodeId.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm-ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItemId:
* description: The ID of the library item the media progress is of.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeId:
* description: The ID of the podcast episode the media progress is of. Will be null if the progress is for a book.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The total duration (in seconds) of the media. Will be 0 if the media was marked as finished without the user listening to it.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1454.18449
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* progress:
* description: The percentage completion progress of the media. Will be 1 if the media is finished.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0.011193983371394644
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* currentTime:
* description: The current time (in seconds) of the user's progress. If the media has been marked as finished, this will be the time the user was at beforehand.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 16.278117
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isFinished:
* description: Whether the media is finished.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* hideFromContinueListening:
* description: Whether the media will be hidden from the "Continue Listening" shelf.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastUpdate:
* description: The time (in ms since POSIX epoch) when the media progress was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668120246620
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* startedAt:
* description: The time (in ms since POSIX epoch) when the media progress was created.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668120083771
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* finishedAt:
* description: The time (in ms since POSIX epoch) when the media was finished. Will be null if the media has is not finished.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaProgressWithMedia:
* type: object
* properties:
* id:
* description: The ID of the media progress. If the media progress is for a book, this will just be the libraryItemId. If for a podcast episode, it will be a hyphenated combination of the libraryItemId and episodeId.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm-ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItemId:
* description: The ID of the library item the media progress is of.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeId:
* description: The ID of the podcast episode the media progress is of. Will be null if the progress is for a book.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The total duration (in seconds) of the media. Will be 0 if the media was marked as finished without the user listening to it.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1454.18449
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* progress:
* description: The percentage completion progress of the media. Will be 1 if the media is finished.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0.011193983371394644
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* currentTime:
* description: The current time (in seconds) of the user's progress. If the media has been marked as finished, this will be the time the user was at beforehand.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 16.278117
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isFinished:
* description: Whether the media is finished.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* hideFromContinueListening:
* description: Whether the media will be hidden from the "Continue Listening" shelf.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastUpdate:
* description: The time (in ms since POSIX epoch) when the media progress was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668120246620
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* startedAt:
* description: The time (in ms since POSIX epoch) when the media progress was created.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668120083771
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* finishedAt:
* description: The time (in ms since POSIX epoch) when the media was finished. Will be null if the media has is not finished.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* media:
* description: The media of the library item the media progress is for.
* type: object
* additionalProperties:
* oneOf:
* - $ref: '#/components/schemas/bookExpanded'
* - $ref: '#/components/schemas/podcastExpanded'
* episode:
* $ref: '#/components/schemas/podcastEpisode'
* playbackSession:
* type: object
* properties:
* id:
* description: The ID of the playback session.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: play_c786zm3qtjz6bd5q3n
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* userId:
* description: The ID of the user the playback session is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItemId:
* description: The ID of the library item.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeId:
* description: The ID of the podcast episode. Will be null if this playback session was started without an episode ID.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaType:
Cleaned up `mediaType` schema
2024-02-19 21:52:00 +00:00
* - $ref: '#/components/schemas/mediaType'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaMetadata:
* description: The metadata of the library item's media.
* type: object
* additionalProperties:
* oneOf:
* - $ref: '#/components/schemas/bookMetadata'
* - $ref: '#/components/schemas/podcastMetadata'
* chapters:
* description: If the library item is a book, the chapters it contains.
* type: array
* items:
* $ref: '#/components/schemas/bookChapter'
* displayTitle:
* description: The title of the playing item to show to the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Pilot
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* displayAuthor:
* description: The author of the playing item to show to the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Night Vale Presents
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* coverPath:
* description: The cover path of the library item's media.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /metadata/items/li_bufnnmp4y5o2gbbxfm/cover.jpg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The total duration (in seconds) of the playing item.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1454.18449
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* playMethod:
* description: What play method the playback session is using. See below for values.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaPlayer:
* description: The given media player when the playback session was requested.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: unknown
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* deviceInfo:
* $ref: '#/components/schemas/deviceInfo'
* serverVersion:
* description: The server version the playback session was started with.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2.4.4
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* date:
* description: The day (in the format YYYY-MM-DD) the playback session was started.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '2022-11-11'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: date
* dayOfWeek:
* description: The day of the week the playback session was started.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Friday
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* timeListening:
* description: The amount of time (in seconds) the user has spent listening using this playback session.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* startTime:
* description: The time (in seconds) where the playback session started.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* currentTime:
* description: The current time (in seconds) of the playback position.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* startedAt:
* description: The time (in ms since POSIX epoch) when the playback session was started.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668206493239
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the playback session was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668206493239
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* playbackSessionExpanded:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [object, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* properties:
* id:
* description: The ID of the playback session.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: play_c786zm3qtjz6bd5q3n
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* userId:
* description: The ID of the user the playback session is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
Cleaned up libraryId schema definition
2024-02-19 21:39:26 +00:00
* oneOf:
* - $ref: '#/components/schemas/oldLibraryId'
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* - $ref: '#/components/schemas/newLibraryId'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItemId:
* description: The ID of the library item.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeId:
* description: The ID of the podcast episode. Will be null if this playback session was started without an episode ID.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaType:
Cleaned up `mediaType` schema
2024-02-19 21:52:00 +00:00
* - $ref: '#/components/schemas/mediaType'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaMetadata:
* description: The metadata of the library item's media.
* type: object
* additionalProperties:
* oneOf:
* - $ref: '#/components/schemas/bookMetadata'
* - $ref: '#/components/schemas/podcastMetadata'
* chapters:
* description: If the library item is a book, the chapters it contains.
* type: array
* items:
* $ref: '#/components/schemas/bookChapter'
* displayTitle:
* description: The title of the playing item to show to the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Pilot
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* displayAuthor:
* description: The author of the playing item to show to the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Night Vale Presents
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* coverPath:
* description: The cover path of the library item's media.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /metadata/items/li_bufnnmp4y5o2gbbxfm/cover.jpg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The total duration (in seconds) of the playing item.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1454.18449
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* playMethod:
* description: What play method the playback session is using. See below for values.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaPlayer:
* description: The given media player when the playback session was requested.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: unknown
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* deviceInfo:
* $ref: '#/components/schemas/deviceInfo'
* serverVersion:
* description: The server version the playback session was started with.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2.4.4
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* date:
* description: The day (in the format YYYY-MM-DD) the playback session was started.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '2022-11-11'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: date
* dayOfWeek:
* description: The day of the week the playback session was started.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Friday
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* timeListening:
* description: The amount of time (in seconds) the user has spent listening using this playback session.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* startTime:
* description: The time (in seconds) where the playback session started.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* currentTime:
* description: The current time (in seconds) of the playback position.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* startedAt:
* description: The time (in ms since POSIX epoch) when the playback session was started.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668206493239
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the playback session was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668206493239
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* audioTracks:
* description: The audio tracks that are being played with the playback session.
* type: array
* items:
* $ref: '#/components/schemas/audioFile'
* videoTrack:
* description: The video track that is being played with the playback session. Will be null if the playback session is for a book or podcast. (Video Track Object does not exist)
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItem:
* $ref: '#/components/schemas/libraryItemExpanded'
* deviceInfo:
* type: object
* properties:
* id:
* description: Unique identifier.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 69b7e852-23a6-4587-bed3-6a5966062e38
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: uuid
* userId:
* description: User identifier.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 3c479fe6-6bf8-44e4-a4a6-680c768b501c
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: uuid
* deviceId:
* description: Device identifier, as provided in the request.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 4dd05e7fadca538b
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ipAddress:
* description: The IP address that the request came from.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 192.168.1.118
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: ipv4
* browserName:
* description: The browser name, taken from the user agent.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Firefox
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* browserVersion:
* description: The browser version, taken from the user agent.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '106.0'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* osName:
* description: The name of OS, taken from the user agent.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Linux
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* osVersion:
* description: The version of the OS, taken from the user agent.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: x86_64
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* deviceName:
* description: The device name, constructed automatically from other attributes.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* deviceType:
* description: The device name, constructed automatically from other attributes.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* manufacturer:
* description: The client device's manufacturer, as provided in the request.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* model:
* description: The client device's model, as provided in the request.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* sdkVersion:
* description: For an Android device, the Android SDK version of the client, as provided in the request.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* clientName:
* description: Name of the client, as provided in the request.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Abs Web
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* clientVersion:
* description: Version of the client, as provided in the request.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2.3.3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* user:
* type: object
* properties:
* id:
* description: The ID of the user. Only the root user has the root ID.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* username:
* description: The username of the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* type:
* description: The type of the user. Will be root, guest, user, or admin. There will be only one root user which is created when the server first starts.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* token:
* description: The authentication token of the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: exJhbGciOiJI6IkpXVCJ9.eyJ1c2Vyi5NDEyODc4fQ.ZraBFohS4Tg39NszY
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaProgress:
* description: The user's media progress.
* type: array
* items:
* $ref: '#/components/schemas/mediaProgress'
* seriesHideFromContinueListening:
* description: The IDs of series to hide from the user's "Continue Series" shelf.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ...
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* bookmarks:
* description: The user's bookmarks.
* type: array
* items:
* $ref: '#/components/schemas/audioBookmark'
* isActive:
* description: Whether the user's account is active.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isLocked:
* description: Whether the user is locked.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastSeen:
* description: The time (in ms since POSIX epoch) when the user was last seen by the server. Will be null if the user has never logged in.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668296147437
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* permissions:
* $ref: '#/components/schemas/userPermissions'
* librariesAccessible:
* description: The IDs of libraries accessible to the user. An empty array means all libraries are accessible.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ...
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* itemTagsAccessible:
* description: The tags accessible to the user. An empty array means all tags are accessible.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ...
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* userWithProgressDetails:
* type: object
* properties:
* id:
* description: The ID of the user. Only the root user has the root ID.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* username:
* description: The username of the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* type:
* description: The type of the user. Will be root, guest, user, or admin. There will be only one root user which is created when the server first starts.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* token:
* description: The authentication token of the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: exJhbGciOiJI6IkpXVCJ9.eyJ1c2Vyi5NDEyODc4fQ.ZraBFohS4Tg39NszY
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* mediaProgress:
* description: The user's media progress.
* type: array
* items:
* $ref: '#/components/schemas/mediaProgressWithMedia'
* seriesHideFromContinueListening:
* description: The IDs of series to hide from the user's "Continue Series" shelf.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ...
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* bookmarks:
* description: The user's bookmarks.
* type: array
* items:
* $ref: '#/components/schemas/audioBookmark'
* isActive:
* description: Whether the user's account is active.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isLocked:
* description: Whether the user is locked.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastSeen:
* description: The time (in ms since POSIX epoch) when the user was last seen by the server. Will be null if the user has never logged in.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668296147437
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* permissions:
* $ref: '#/components/schemas/userPermissions'
* librariesAccessible:
* description: The IDs of libraries accessible to the user. An empty array means all libraries are accessible.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ...
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* itemTagsAccessible:
* description: The tags accessible to the user. An empty array means all tags are accessible.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ...
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* userWithSession:
* type: object
* properties:
* id:
* description: The ID of the user. Only the root user has the root ID.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* username:
* description: The username of the user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* type:
* description: The type of the user. Will be root, guest, user, or admin. There will be only one root user which is created when the server first starts.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* session:
* $ref: '#/components/schemas/playbackSessionExpanded'
* lastSeen:
* description: The time (in ms since POSIX epoch) when the user was last seen by the server. Will be null if the user has never logged in.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668296147437
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* userPermissions:
* type: object
* properties:
* download:
* description: Whether the user can download items to the server.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* update:
* description: Whether the user can update library items.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* delete:
* description: Whether the user can delete library items.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* upload:
* description: Whether the user can upload items to the server.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* accessAllLibraries:
* description: Whether the user can access all libraries.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* accessAllTags:
* description: Whether the user can access all tags.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* accessExplicitContent:
* description: Whether the user can access explicit content.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* audioBookmark:
* type: object
* properties:
* libraryItemId:
* description: The ID of the library item the bookmark is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_8gch9ve09orgn4fdz8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* title:
* description: The title of the bookmark.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: the good part
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* time:
* description: The time (in seconds) the bookmark is at in the book.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 16
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* backup:
* type: object
* properties:
* id:
* description: The ID of the backup. Will be the date and time when the backup was created.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2022-11-14T0130
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* backupMetadataCovers:
* description: Whether the backup includes library item covers and author images located in metadata.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* backupDirPath:
* description: The backup directory path.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /metadata/backups
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* datePretty:
* description: The date and time when the backup was created in a human-readable format.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Mon, Nov 14 2022 01:30
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* fullPath:
* description: The full path of the backup on the server.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /metadata/backups/2022-11-14T0130.audiobookshelf
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* path:
* description: The path of the backup relative to the metadata directory.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: backups/2022-11-14T0130.audiobookshelf
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* filename:
* description: The filename of the backup.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2022-11-14T0130.audiobookshelf
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* fileSize:
* description: The size (in bytes) of the backup file.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 7776983
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* serverVersion:
* description: The version of the server when the backup was created.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2.2.4
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* notificationSettings:
* type: object
* properties:
* id:
* description: The ID of the notification settings.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: notification-settings
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* appriseType:
* description: The type of Apprise that will be used. At the moment, only api is available.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: api
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* appriseApiUrl:
* description: The full URL where the Apprise API to use is located.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: https://apprise.example.com/notify
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* notifications:
* description: The set notifications.
* type: array
* items:
* $ref: '#/components/schemas/notification'
* maxFailedAttempts:
* description: The maximum number of times a notification fails before being disabled.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 5
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* maxNotificationQueue:
* description: The maximum number of notifications in the notification queue before events are ignored.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 20
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* notificationDelay:
* description: The time (in ms) between notification pushes.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* notification:
* type: object
* properties:
* id:
* description: The ID of the notification.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: noti_nod281qwkj5ow7h7fi
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
* description: The ID of the library the notification is associated with.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* eventName:
* description: The name of the event the notification will fire on.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: onPodcastEpisodeDownloaded
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* urls:
* description: The Apprise URLs to use for the notification.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: apprises://apprise.example.com/email
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* titleTemplate:
* description: The template for the notification title.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: New {{podcastTitle}} Episode!
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* bodyTemplate:
* description: The template for the notification body.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '{{episodeTitle}} has been added to {{libraryName}} library.'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* enabled:
* description: Whether the notification is enabled.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* type:
* description: The notification's type.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: info
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastFiredAt:
* description: The time (in ms since POSIX epoch) when the notification was last fired. Will be null if the notification has not fired.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [integer, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1668776410792
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* lastAttemptFailed:
* description: Whether the last notification attempt failed.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numConsecutiveFailedAttempts:
* description: The number of consecutive times the notification has failed.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numTimesFired:
* description: The number of times the notification has fired.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 5
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* notificationEvents:
* type: object
* properties:
* name:
* description: The name of the notification event.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: onPodcastEpisodeDownloaded
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* requiresLibrary:
* description: Whether the notification event depends on a library existing.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryMediaType:
* description: The type of media of the library the notification depends on existing. Will not exist if requiresLibrary is false.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: podcast
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: The description of the notification event.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Triggered when a podcast episode is auto-downloaded
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* variables:
* description: The variables of the notification event that can be used in the notification templates.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: libraryItemId
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* - libraryId
* - libraryName
* - mediaTags
* - podcastTitle
* - podcastAuthor
* - podcastDescription
* - podcastGenres
* - episodeId
* - episodeTitle
* - episodeSubtitle
* - episodeDescription
* defaults:
* type: object
* properties:
* title:
* description: The default title template for notifications using the notification event.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: New {{podcastTitle}} Episode!
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* body:
* description: The default body template for notifications using the notification event.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: '{{episodeTitle}} has been added to {{libraryName}} library.'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* testData:
* description: The keys of the testData object will match the list of variables. The values will be the data used when sending a test notification.
* type: object
* properties:
* libraryItemId:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_notification_test
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryId:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: lib_test
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryName:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Podcasts
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* podcastTitle:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Abs Test Podcast
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeId:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ep_notification_test
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeTitle:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Successful Test
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* serverSettings:
* type: object
* properties:
* id:
* description: The ID of the server settings.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: server-settings
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scannerFindCovers:
* description: Whether the scanner will attempt to find a cover if your audiobook does not have an embedded cover or a cover image inside the folder. Note that This will extend scan time.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scannerCoverProvider:
* description: If scannerFindCovers is true, which metadata provider to use. See Metadata Providers for options.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: google
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scannerParseSubtitle:
* description: Whether to extract subtitles from audiobook folder names. Subtitles must be separated by -, i.e. /audiobooks/Book Title - A Subtitle Here/ has the subtitle A Subtitle Here.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scannerPreferAudioMetadata:
* description: Whether to use audio file ID3 meta tags instead of folder names for book details.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scannerPreferOpfMetadata:
* description: Whether to use OPF file metadata instead of folder names for book details.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scannerPreferMatchedMetadata:
* description: Whether matched data will override item details when using Quick Match. By default, Quick Match will only fill in missing details.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scannerDisableWatcher:
* description: Whether to disable the automatic adding/updating of items when file changes are detected. Requires server restart for changes to take effect.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scannerPreferOverdriveMediaMarker:
* description: Whether to use the custom metadata in MP3 files from Overdrive for chapter timings automatically.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* scannerUseTone:
* description: Should use tone to extract metadata
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* storeCoverWithItem:
* description: Whether to store covers in the library item's folder. By default, covers are stored in /metadata/items. Only one file named cover will be kept.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* storeMetadataWithItem:
* description: Whether to store metadata files in the library item's folder. By default, metadata files are stored in /metadata/items. Uses the .abs file extension.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* metadataFileFormat:
* description: Must be either json or abs
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: json
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* rateLimitLoginRequests:
* description: The maximum number of login requests per rateLimitLoginWindow.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 10
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* rateLimitLoginWindow:
* description: The length (in ms) of each login rate limit window.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 600000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* backupSchedule:
* description: The cron expression for when to do automatic backups.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 30 1 * * *
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* backupsToKeep:
* description: The number of backups to keep.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* maxBackupSize:
* description: The maximum backup size (in GB) before they fail, a safeguard against misconfiguration.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* backupMetadataCovers:
* description: Whether backups should include library item covers and author images located in metadata.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* loggerDailyLogsToKeep:
* description: The number of daily logs to keep.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 7
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* loggerScannerLogsToKeep:
* description: The number of scanner logs to keep.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* homeBookshelfView:
* description: Whether the home page should use a skeuomorphic design with wooden shelves.
Fixed linting warnings for paths
2024-02-20 05:44:23 +00:00
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* bookshelfView:
* description: Whether other bookshelf pages should use a skeuomorphic design with wooden shelves.
Fixed linting warnings for paths
2024-02-20 05:44:23 +00:00
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* sortingIgnorePrefix:
* description: Whether to ignore prefixes when sorting. For example, for the prefix the, the book title The Book Title would sort as Book Title, The.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* sortingPrefixes:
* description: If sortingIgnorePrefix is true, what prefixes to ignore.
* type: array
* items:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: the
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* - a
* chromecastEnabled:
* description: Whether to enable streaming to Chromecast devices.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* dateFormat:
* description: What date format to use. Options are MM/dd/yyyy, dd/MM/yyyy, dd.MM.yyyy, yyyy-MM-dd, MMM do, yyyy, MMMM do, yyyy, dd MMM yyyy, or dd MMMM yyyy.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: MM/dd/yyyy
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* timeFormat:
* description: What time format to use. Options are HH:mm (24-hour) and h:mma (am/pm).
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: HH:mm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The default server language.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: en-us
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* logLevel:
* description: What log level the server should use when logging. 1 for debug, 2 for info, or 3 for warnings.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* version:
* description: The server's version.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 2.2.5
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* rssFeed:
* type: object
* properties:
* id:
* description: The ID of the RSS feed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* slug:
* description: The slug (the last part of the URL) for the RSS feed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* userId:
* description: The ID of the user that created the RSS feed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* entityType:
* description: The type of entity the RSS feed is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: item
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* entityId:
* description: The ID of the entity the RSS feed is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* coverPath:
* description: The path of the cover to use for the RSS feed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: /metadata/items/li_bufnnmp4y5o2gbbxfm/cover.jpg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* serverAddress:
* description: The server's address.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: https://abs.example.com
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* feedUrl:
* description: The full URL of the RSS feed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: https://abs.example.com/feed/li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* meta:
* $ref: '#/components/schemas/rssFeedMetadata'
* episodes:
* description: The RSS feed's episodes.
* type: array
* items:
* $ref: '#/components/schemas/rssFeedEpisode'
* createdAt:
Cleaned up `createdAt` schema
2024-02-19 21:54:35 +00:00
* $ref: '#/components/schemas/createdAt'
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* updatedAt:
* description: The time (in ms since POSIX epoch) when the RSS feed was last updated.
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1669031843179
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* rssFeedMinified:
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [object, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* properties:
* id:
* description: The ID of the RSS feed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* entityType:
* description: The type of entity the RSS feed is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: item
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* entityId:
* description: The ID of the entity the RSS feed is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* feedUrl:
* description: The full URL of the RSS feed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: https://abs.example.com/feed/li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* meta:
* $ref: '#/components/schemas/rssFeedMetadataMinified'
* rssFeedMetadata:
* type: object
* properties:
* title:
* description: The title of the entity the RSS feed is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Welcome to Night Vale
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: The description of the entity the RSS feed is for.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: |2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* Twice-monthly community updates for the small desert town of Night Vale, where every conspiracy theory is true. Turn on your radio and hide. Never listened before? It's an ongoing radio show. Start with the current episode, and you'll catch on in no time. Or, go right to Episode 1 if you wanna binge-listen.
* author:
* description: The author of the entity the RSS feed is for.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Night Vale Presents
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* imageUrl:
* description: The URL of the RSS feed's image.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: https://abs.example.com/feed/li_bufnnmp4y5o2gbbxfm/cover
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* feedUrl:
* description: The URL of the RSS feed.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: https://abs.example.com/feed/li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* link:
* description: The URL of the entity the RSS feed is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: https://abs.example.com/item/li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* explicit:
* description: Whether the RSS feed's contents are explicit.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* type:
* description: The type of the RSS feed.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: episodic
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* language:
* description: The language of the RSS feed.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: en
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* preventIndexing:
* description: Whether the RSS feed is marked to prevent indexing of the feed.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ownerName:
* description: The owner name of the RSS feed.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ownerEmail:
* description: The owner email of the RSS feed.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* rssFeedMetadataMinified:
* type: object
* properties:
* title:
* description: The title of the entity the RSS feed is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Welcome to Night Vale
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: The description of the entity the RSS feed is for.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: |2-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
*
* Twice-monthly community updates for the small desert town of Night Vale, where every conspiracy theory is true. Turn on your radio and hide. Never listened before? It's an ongoing radio show. Start with the current episode, and you'll catch on in no time. Or, go right to Episode 1 if you wanna binge-listen.
* preventIndexing:
* description: Whether the RSS feed is marked to prevent indexing of the feed.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: true
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ownerName:
* description: The owner name of the RSS feed.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* ownerEmail:
* description: The owner email of the RSS feed.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* rssFeedEpisode:
* type: object
* properties:
* id:
* description: The ID of the RSS feed episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* title:
* description: The title of the RSS feed episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Pilot
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* description:
* description: An HTML encoded description of the RSS feed episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* <div><br>Pilot Episode. A new dog park opens in Night Vale. Carlos, a
* scientist, visits and discovers some interesting things. Seismic things.
* Plus, a helpful guide to surveillance
* helicopter-spotting.<br><br></div><div><br>Weather: "These and More Than
* These" by Joseph Fink<br><br></div><div><br>Music: Disparition,
* disparition.info<br><br></div><div><br>Logo: Rob Wilson,
* silastom.com<br><br></div><div><br>Produced by Night Vale Presents.
* Written by Joseph Fink and Jeffrey Cranor. Narrated by Cecil Baldwin.
* More Info: welcometonightvale.com, and follow @NightValeRadio on Twitter
* or Facebook.<br><br></div>
* enclosure:
* description: Download information for the RSS feed episode. (Similar to Podcast Episode Enclosure)
* type: object
* properties:
* url:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: >-
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* https://abs.example.com/feed/li_bufnnmp4y5o2gbbxfm/item/ep_lh6ko39pumnrma3dhv/1
* - Pilot.mp3
* type:
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: audio/mpeg
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* size:
* type: integer
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 23653735
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* pubDate:
* description: The RSS feed episode's publication date.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Fri, 15 Jun 2012 12:00:00 -0000
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* link:
* description: A URL to display to the RSS feed user.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: https://abs.example.com/item/li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* format: url
* author:
* description: The author of the RSS feed episode.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: Night Vale Presents
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* explicit:
* description: Whether the RSS feed episode is explicit.
* type: boolean
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* duration:
* description: The duration (in seconds) of the RSS feed episode.
* type: number
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: 1454.18449
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* season:
* description: The season of the RSS feed episode.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episode:
* description: The episode number of the RSS feed episode.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeType:
* description: The type of the RSS feed episode.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItemId:
* description: The ID of the library item the RSS feed is for.
* type: string
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: li_bufnnmp4y5o2gbbxfm
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* episodeId:
* description: The ID of the podcast episode the RSS feed episode is for. Will be null if the RSS feed is for a book.
Updated null types in initial OpenAPI spec
2024-02-19 19:18:43 +00:00
* type: [string, 'null']
Cleaned up component examples
2024-02-20 00:28:22 +00:00
* example: ep_lh6ko39pumnrma3dhv
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* trackIndex:
* description: The RSS feed episode's track index.
* type: integer
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* fullPath:
* description: The path on the server of the audio file the RSS feed episode is for.
* type: string
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: /podcasts/Welcome to Night Vale/1 - Pilot.mp3
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* stream:
* type: object
* properties:
* id:
* 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
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: play_c786zm3qtjz6bd5q3n
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* userId:
* description: The ID of the user that started the stream.
* type: string
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: root
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* libraryItem:
* $ref: '#/components/schemas/libraryItemExpanded'
* episode:
* $ref: '#/components/schemas/podcastEpisodeExpanded'
* segmentLength:
* description: The length (in seconds) of each segment of the stream.
* type: integer
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 6
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* playlistPath:
* description: The path on the server of the stream output.
* type: string
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: /metadata/streams/play_c786zm3qtjz6bd5q3n/output.m3u8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* clientPlaylistUri:
* description: The URI path for the client to access the stream.
* type: string
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: /hls/play_c786zm3qtjz6bd5q3n/output.m3u8
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* startTime:
* description: The time (in seconds) where the playback session started.
* type: integer
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* segmentStartNumber:
* description: The segment where the transcoding began.
* type: integer
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 0
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* isTranscodeComplete:
* description: Whether transcoding is complete.
* type: boolean
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: false
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* streamProgress:
* type: object
* properties:
* stream:
* description: The ID of the stream the progress is for.
* type: string
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: play_c786zm3qtjz6bd5q3n
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* percent:
* description: A human-readable percentage of transcode completion.
* type: string
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 8.66%
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* chunks:
* description: The segment ranges that have been transcoded.
* type: array
* items:
* type: string
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 0-536
Initial CollectionController OpenAPI spec This includes a large `components.js` taken from initial efforts of benonymity. This file still needs to be cleaned up but is provided as a starting point.
2024-02-17 03:50:37 +00:00
* numSegments:
* description: The total number of segments of the stream.
* type: integer
Added tags and other cleanup Beginning cleanup of examples for linter warnings
2024-02-20 00:21:26 +00:00
* example: 6200
Fixed linting warnings for paths
2024-02-20 05:44:23 +00:00
*/
Reference in a new issue Copy permalink