mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-07-13 04:41:36 +00:00
Moved schemas into objects/ definitions
This commit is contained in:
Nicholas Wallace
parent
cc37c3d41f
commit
cc53f16185
30 changed files with 3380 additions and 3241 deletions
|
|
@ -2,6 +2,82 @@ const Logger = require('../../Logger')
|
|||
const uuidv4 = require("uuid").v4
|
||||
const { checkNamesAreEqual, nameToLastFirst } = require('../../utils/parsers/parseNameString')
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* components:
|
||||
* schemas:
|
||||
* author:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* description: The ID of the author.
|
||||
* type: string
|
||||
* example: aut_z3leimgybl7uf3y4ab
|
||||
* asin:
|
||||
* description: The ASIN of the author. Will be null if unknown.
|
||||
* type: [string, 'null']
|
||||
* name:
|
||||
* description: The name of the author.
|
||||
* type: string
|
||||
* example: Terry Goodkind
|
||||
* description:
|
||||
* description: A description of the author. Will be null if there is none.
|
||||
* type: [string, 'null']
|
||||
* imagePath:
|
||||
* description: The absolute path for the author image. Will be null if there is no image.
|
||||
* type: [string, 'null']
|
||||
* addedAt:
|
||||
* description: The time (in ms since POSIX epoch) when the author was added.
|
||||
* type: integer
|
||||
* example: 1650621073750
|
||||
* updatedAt:
|
||||
* description: The time (in ms since POSIX epoch) when the author was last updated.
|
||||
* type: integer
|
||||
* example: 1650621073750
|
||||
* authorMinified:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* description: The ID of the author.
|
||||
* type: string
|
||||
* example: aut_z3leimgybl7uf3y4ab
|
||||
* name:
|
||||
* description: The name of the author.
|
||||
* type: string
|
||||
* example: Terry Goodkind
|
||||
* authorExpanded:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* description: The ID of the author.
|
||||
* type: string
|
||||
* example: aut_z3leimgybl7uf3y4ab
|
||||
* asin:
|
||||
* description: The ASIN of the author. Will be null if unknown.
|
||||
* type: [string, 'null']
|
||||
* name:
|
||||
* description: The name of the author.
|
||||
* type: string
|
||||
* example: Terry Goodkind
|
||||
* description:
|
||||
* description: A description of the author. Will be null if there is none.
|
||||
* type: [string, 'null']
|
||||
* imagePath:
|
||||
* description: The absolute path for the author image. Will be null if there is no image.
|
||||
* type: [string, 'null']
|
||||
* addedAt:
|
||||
* description: The time (in ms since POSIX epoch) when the author was added.
|
||||
* type: integer
|
||||
* example: 1650621073750
|
||||
* updatedAt:
|
||||
* description: The time (in ms since POSIX epoch) when the author was last updated.
|
||||
* type: integer
|
||||
* example: 1650621073750
|
||||
* numBooks:
|
||||
* description: The number of books associated with the author in the library.
|
||||
* type: integer
|
||||
* example: 1
|
||||
*/
|
||||
class Author {
|
||||
constructor(author) {
|
||||
this.id = null
|
||||
|
|
|
|||
|
|
@ -1,6 +1,109 @@
|
|||
const uuidv4 = require("uuid").v4
|
||||
const { getTitleIgnorePrefix, getTitlePrefixAtEnd } = require('../../utils/index')
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* components:
|
||||
* schemas:
|
||||
* series:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* description: The ID of the series.
|
||||
* type: string
|
||||
* example: ser_cabkj4jeu8be3rap4g
|
||||
* name:
|
||||
* description: The name of the series.
|
||||
* type: string
|
||||
* example: Sword of Truth
|
||||
* description:
|
||||
* description: A description for the series. Will be null if there is none.
|
||||
* type: [string, 'null']
|
||||
* addedAt:
|
||||
* description: The time (in ms since POSIX epoch) when the series was added.
|
||||
* type: integer
|
||||
* example: 1650621073750
|
||||
* updatedAt:
|
||||
* description: The time (in ms since POSIX epoch) when the series was last updated.
|
||||
* type: integer
|
||||
* example: 1650621073750
|
||||
* seriesNumBooks:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* description: The ID of the series.
|
||||
* type: string
|
||||
* example: ser_cabkj4jeu8be3rap4g
|
||||
* name:
|
||||
* description: The name of the series.
|
||||
* type: string
|
||||
* example: Sword of Truth
|
||||
* nameIgnorePrefix:
|
||||
* description: The name of the series with any prefix moved to the end.
|
||||
* type: string
|
||||
* example: Sword of Truth
|
||||
* libraryItemIds:
|
||||
* description: The IDs of the library items in the series.
|
||||
* type: array
|
||||
* items:
|
||||
* type: string
|
||||
* example: li_8gch9ve09orgn4fdz8
|
||||
* numBooks:
|
||||
* description: The number of books in the series.
|
||||
* type: integer
|
||||
* example: 1
|
||||
* seriesBooks:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* description: The ID of the series.
|
||||
* type: string
|
||||
* example: ser_cabkj4jeu8be3rap4g
|
||||
* name:
|
||||
* description: The name of the series.
|
||||
* type: string
|
||||
* example: Sword of Truth
|
||||
* nameIgnorePrefix:
|
||||
* description: The name of the series with any prefix moved to the end.
|
||||
* type: string
|
||||
* example: Sword of Truth
|
||||
* nameIgnorePrefixSort:
|
||||
* description: The name of the series with any prefix removed.
|
||||
* type: string
|
||||
* example: Sword of Truth
|
||||
* type:
|
||||
* description: Will always be series.
|
||||
* type: string
|
||||
* example: series
|
||||
* 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
|
||||
* example: 1650621073750
|
||||
* totalDuration:
|
||||
* description: The combined duration (in seconds) of all books in the series.
|
||||
* type: number
|
||||
* example: 12000.946
|
||||
* seriesSequence:
|
||||
* type: object
|
||||
* properties:
|
||||
* id:
|
||||
* description: The ID of the series.
|
||||
* type: string
|
||||
* example: ser_cabkj4jeu8be3rap4g
|
||||
* name:
|
||||
* description: The name of the series.
|
||||
* type: string
|
||||
* example: Sword of Truth
|
||||
* sequence:
|
||||
* description: The position in the series the book is.
|
||||
* type: string
|
||||
* example: '1'
|
||||
*/
|
||||
class Series {
|
||||
constructor(series) {
|
||||
this.id = null
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue