mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2025-08-02 09:14:40 +02:00
Split schema to sub files
This commit is contained in:
Nicholas Wallace
parent
afe40be957
commit
c7ac12a67a
14 changed files with 964 additions and 957 deletions
103
docs/objects/metadata/AudioMetaTags.yaml
Normal file
103
docs/objects/metadata/AudioMetaTags.yaml
Normal file
|
|
@ -0,0 +1,103 @@
|
|||
components:
|
||||
schemas:
|
||||
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:
|
||||
type: string
|
||||
nullable: true
|
||||
example: SOT Bk01
|
||||
tagArtist:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Terry Goodkind
|
||||
tagGenre:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Audiobook Fantasy
|
||||
tagTitle:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Wizards First Rule 01
|
||||
tagSeries:
|
||||
type: string
|
||||
nullable: true
|
||||
tagSeriesPart:
|
||||
type: string
|
||||
nullable: true
|
||||
tagTrack:
|
||||
type: string
|
||||
nullable: true
|
||||
example: 01/20
|
||||
tagDisc:
|
||||
type: string
|
||||
nullable: true
|
||||
tagSubtitle:
|
||||
type: string
|
||||
nullable: true
|
||||
tagAlbumArtist:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Terry Goodkind
|
||||
tagDate:
|
||||
type: string
|
||||
nullable: true
|
||||
tagComposer:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Terry Goodkind
|
||||
tagPublisher:
|
||||
type: string
|
||||
nullable: true
|
||||
tagComment:
|
||||
type: string
|
||||
nullable: true
|
||||
tagDescription:
|
||||
type: string
|
||||
nullable: true
|
||||
tagEncoder:
|
||||
type: string
|
||||
nullable: true
|
||||
tagEncodedBy:
|
||||
type: string
|
||||
nullable: true
|
||||
tagIsbn:
|
||||
type: string
|
||||
nullable: true
|
||||
tagLanguage:
|
||||
type: string
|
||||
nullable: true
|
||||
tagASIN:
|
||||
type: string
|
||||
nullable: true
|
||||
tagOverdriveMediaMarker:
|
||||
type: string
|
||||
nullable: true
|
||||
tagOriginalYear:
|
||||
type: string
|
||||
nullable: true
|
||||
tagReleaseCountry:
|
||||
type: string
|
||||
nullable: true
|
||||
tagReleaseType:
|
||||
type: string
|
||||
nullable: true
|
||||
tagReleaseStatus:
|
||||
type: string
|
||||
nullable: true
|
||||
tagISRC:
|
||||
type: string
|
||||
nullable: true
|
||||
tagMusicBrainzTrackId:
|
||||
type: string
|
||||
nullable: true
|
||||
tagMusicBrainzAlbumId:
|
||||
type: string
|
||||
nullable: true
|
||||
tagMusicBrainzAlbumArtistId:
|
||||
type: string
|
||||
nullable: true
|
||||
tagMusicBrainzArtistId:
|
||||
type: string
|
||||
nullable: true
|
||||
126
docs/objects/metadata/BookMetadata.yaml
Normal file
126
docs/objects/metadata/BookMetadata.yaml
Normal file
|
|
@ -0,0 +1,126 @@
|
|||
components:
|
||||
schemas:
|
||||
narrators:
|
||||
description: The narrators of the audiobook.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: Sam Tsoutsouvas
|
||||
bookMetadataBase:
|
||||
type: object
|
||||
description: The base book metadata object for minified, normal, and extended schemas to inherit from.
|
||||
properties:
|
||||
title:
|
||||
description: The title of the book. Will be null if unknown.
|
||||
type: string
|
||||
nullable: true
|
||||
example: Wizards First Rule
|
||||
subtitle:
|
||||
description: The subtitle of the book. Will be null if there is no subtitle.
|
||||
type: string
|
||||
nullable: true
|
||||
genres:
|
||||
description: The genres of the book.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: ["Fantasy", "Sci-Fi", "Nonfiction: History"]
|
||||
publishedYear:
|
||||
description: The year the book was published. Will be null if unknown.
|
||||
type: string
|
||||
nullable: true
|
||||
example: '2008'
|
||||
publishedDate:
|
||||
description: The date the book was published. Will be null if unknown.
|
||||
type: string
|
||||
nullable: true
|
||||
publisher:
|
||||
description: The publisher of the book. Will be null if unknown.
|
||||
type: string
|
||||
nullable: true
|
||||
example: Brilliance Audio
|
||||
description:
|
||||
description: A description for the book. Will be null if empty.
|
||||
type: string
|
||||
nullable: true
|
||||
example: >-
|
||||
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.
|
||||
type: string
|
||||
nullable: true
|
||||
asin:
|
||||
description: The ASIN of the book. Will be null if unknown.
|
||||
type: string
|
||||
nullable: true
|
||||
example: B002V0QK4C
|
||||
language:
|
||||
description: The language of the book. Will be null if unknown.
|
||||
type: string
|
||||
nullable: true
|
||||
explicit:
|
||||
description: Whether the book has been marked as explicit.
|
||||
type: boolean
|
||||
example: false
|
||||
bookMetadataMinified:
|
||||
type: object
|
||||
description: The minified metadata for a book in the database.
|
||||
allOf:
|
||||
- $ref : '#/components/schemas/bookMetadataBase'
|
||||
- type: object
|
||||
properties:
|
||||
titleIgnorePrefix:
|
||||
description: The title of the book with any prefix moved to the end.
|
||||
type: string
|
||||
authorName:
|
||||
description: The name of the book's author(s).
|
||||
type: string
|
||||
example: Terry Goodkind
|
||||
authorNameLF:
|
||||
description: The name of the book's author(s) with last names first.
|
||||
type: string
|
||||
example: Goodkind, Terry
|
||||
narratorName:
|
||||
description: The name of the audiobook's narrator(s).
|
||||
type: string
|
||||
example: Sam Tsoutsouvas
|
||||
seriesName:
|
||||
description: The name of the book's series.
|
||||
type: string
|
||||
example: Sword of Truth
|
||||
bookChapter:
|
||||
type: object
|
||||
description: A book chapter. Includes the title and timestamps.
|
||||
properties:
|
||||
id:
|
||||
description: The ID of the book chapter.
|
||||
type: integer
|
||||
example: 0
|
||||
start:
|
||||
description: When in the book (in seconds) the chapter starts.
|
||||
type: integer
|
||||
example: 0
|
||||
end:
|
||||
description: When in the book (in seconds) the chapter ends.
|
||||
type: number
|
||||
example: 6004.6675
|
||||
title:
|
||||
description: The title of the chapter.
|
||||
type: string
|
||||
example: Wizards First Rule 01 Chapter 1
|
||||
39
docs/objects/metadata/FileMetadata.yaml
Normal file
39
docs/objects/metadata/FileMetadata.yaml
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
components:
|
||||
schemas:
|
||||
fileMetadata:
|
||||
type: object
|
||||
description: The metadata for a file, including the path, size, and unix timestamps of the file.
|
||||
nullable: true
|
||||
properties:
|
||||
filename:
|
||||
description: The filename of the file.
|
||||
type: string
|
||||
example: Wizards First Rule 01.mp3
|
||||
ext:
|
||||
description: The file extension of the file.
|
||||
type: string
|
||||
example: .mp3
|
||||
path:
|
||||
description: The absolute path on the server of the file.
|
||||
type: string
|
||||
example: >-
|
||||
/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
|
||||
example: Wizards First Rule 01.mp3
|
||||
size:
|
||||
$ref: '../../schemas.yaml#/components/schemas/size'
|
||||
mtimeMs:
|
||||
description: The time (in ms since POSIX epoch) when the file was last modified on disk.
|
||||
type: integer
|
||||
example: 1632223180278
|
||||
ctimeMs:
|
||||
description: The time (in ms since POSIX epoch) when the file status was changed on disk.
|
||||
type: integer
|
||||
example: 1645978261001
|
||||
birthtimeMs:
|
||||
description: The time (in ms since POSIX epoch) when the file was created on disk. Will be 0 if unknown.
|
||||
type: integer
|
||||
example: 0
|
||||
Loading…
Add table
Add a link
Reference in a new issue