mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2024-11-07 08:34:10 +01:00
c5e60d30e1
* Add: `AudioTrack.yaml` * Fix: audiotrack example * Initial: podcast schemas and endpoints * Update schemas * Add: podcasts tag * Update bundled spec
76 lines
2.1 KiB
YAML
76 lines
2.1 KiB
YAML
components:
|
|
schemas:
|
|
addedAt:
|
|
type: integer
|
|
description: The time (in ms since POSIX epoch) when added to the server.
|
|
example: 1633522963509
|
|
createdAt:
|
|
type: integer
|
|
description: The time (in ms since POSIX epoch) when was created.
|
|
example: 1633522963509
|
|
updatedAt:
|
|
type: integer
|
|
description: The time (in ms since POSIX epoch) when last updated.
|
|
example: 1633522963509
|
|
size:
|
|
description: The total size (in bytes) of the item or file.
|
|
type: integer
|
|
example: 268824228
|
|
durationSec:
|
|
description: The total length (in seconds) of the item or file.
|
|
type: number
|
|
example: 33854.905
|
|
duration:
|
|
description: The total length of the item or file.
|
|
type: string
|
|
example: '01:23:45'
|
|
tags:
|
|
description: Tags applied to items.
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: ['To Be Read', 'Genre: Nonfiction']
|
|
inode:
|
|
description: The inode of the item in the file system.
|
|
type: string
|
|
format: '[0-9]*'
|
|
example: '649644248522215260'
|
|
total:
|
|
description: The total number of items in the response.
|
|
type: integer
|
|
example: 100
|
|
limit:
|
|
description: The number of items to return. If 0, no items are returned.
|
|
type: integer
|
|
example: 10
|
|
default: 0
|
|
page:
|
|
description: The page number (zero indexed) to return. If no limit is specified, then page will have no effect.
|
|
type: integer
|
|
example: 1
|
|
default: 0
|
|
sortDesc:
|
|
description: Return items in reversed order if true.
|
|
type: boolean
|
|
example: true
|
|
default: false
|
|
minified:
|
|
description: Return minified items if true.
|
|
type: boolean
|
|
example: true
|
|
default: false
|
|
region:
|
|
description: The region used to search.
|
|
type: string
|
|
example: 'us'
|
|
default: 'us'
|
|
parameters:
|
|
minified:
|
|
in: query
|
|
name: minified
|
|
description: Return minified items if true
|
|
schema:
|
|
type: integer
|
|
minimum: 0
|
|
example: 1
|