mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-07-11 11:51:36 +00:00
First draft for user / login and logout
This commit is contained in:
parent
ee53086444
commit
15136e2562
5 changed files with 274 additions and 0 deletions
42
docs/objects/Media.yaml
Normal file
42
docs/objects/Media.yaml
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
components:
|
||||
schemas:
|
||||
mediaProgressId:
|
||||
type: string
|
||||
description: The ID of the media progress.
|
||||
example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
|
||||
format: uuid
|
||||
mediaProgress:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
$ref: '#/components/schemas/mediaProgressId'
|
||||
libraryItemId:
|
||||
$ref: 'LibraryItem.yaml#/components/schemas/libraryItemId'
|
||||
episodeId:
|
||||
$ref: 'mediaTypes/Podcast.yaml#/components/schemas/podcastId'
|
||||
duration:
|
||||
$ref: '../schemas.yaml#/components/schemas/durationSec'
|
||||
progress:
|
||||
type: number
|
||||
description: The user's progress in the media item.
|
||||
example: 0.5
|
||||
currentTime:
|
||||
type: number
|
||||
description: The user's current time in the media item.
|
||||
example: 0.5
|
||||
isFinished:
|
||||
type: boolean
|
||||
description: Whether the user has finished the media item.
|
||||
example: false
|
||||
hideFromContinueListening:
|
||||
type: boolean
|
||||
description: Whether the media item should be hidden from the continue listening section.
|
||||
example: false
|
||||
lastUpdate:
|
||||
$ref: '../schemas.yaml#/components/schemas/updatedAt'
|
||||
startedAt:
|
||||
$ref: '../schemas.yaml#/components/schemas/createdAt'
|
||||
finishedAt:
|
||||
type: integer
|
||||
description: The time (in ms since POSIX epoch) when the media was finished. Will be null if the media has is not finished.
|
||||
example: 1616239000
|
||||
Loading…
Add table
Add a link
Reference in a new issue