mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-07-14 21:31:43 +00:00
Additional debugging
This commit is contained in:
Nicholas Wallace
parent
5fdfc9e454
commit
5295088462
5 changed files with 257 additions and 3 deletions
50
docs/controllers/LibraryController.yaml
Normal file
50
docs/controllers/LibraryController.yaml
Normal file
|
|
@ -0,0 +1,50 @@
|
||||||
|
components:
|
||||||
|
parameters:
|
||||||
|
libraryName:
|
||||||
|
name: name
|
||||||
|
in: query
|
||||||
|
description: The name of the library.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: My Audiobooks
|
||||||
|
libraryFolders:
|
||||||
|
name: folders
|
||||||
|
in: query
|
||||||
|
description: The folders of the library. Only specify the fullPath.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '../objects/Folder.yaml#/components/schemas/folder'
|
||||||
|
libraryIcon:
|
||||||
|
name: icon
|
||||||
|
in: query
|
||||||
|
description: The icon of the library. See Library Icons for a list of possible icons.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: 'audiobookshelf'
|
||||||
|
libraryMediaType:
|
||||||
|
name: mediaType
|
||||||
|
in: query
|
||||||
|
description: The type of media that the library contains. Must be `book` or `podcast`.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: 'book'
|
||||||
|
libraryProvider:
|
||||||
|
name: provider
|
||||||
|
in: query
|
||||||
|
description: Preferred metadata provider for the library. See Metadata Providers for a list of possible providers.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
example: 'audible'
|
||||||
|
librarySettings:
|
||||||
|
name: settings
|
||||||
|
in: query
|
||||||
|
description: The settings for the library.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
$ref: '../objects/Library.yaml#/components/schemas/librarySettings'
|
||||||
|
|
@ -72,6 +72,6 @@ components:
|
||||||
settings:
|
settings:
|
||||||
$ref: '#/components/schemas/librarySettings'
|
$ref: '#/components/schemas/librarySettings'
|
||||||
createdAt:
|
createdAt:
|
||||||
$ref: './../schemas.yaml#/components/schemas/createdAt'
|
$ref: '../schemas.yaml#/components/schemas/createdAt'
|
||||||
lastUpdate:
|
lastUpdate:
|
||||||
$ref: './../schemas.yaml#/components/schemas/updatedAt'
|
$ref: '../schemas.yaml#/components/schemas/updatedAt'
|
||||||
|
|
|
||||||
|
|
@ -18,7 +18,7 @@ components:
|
||||||
audioFiles:
|
audioFiles:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/audioFile'
|
$ref: '../files/AudioFile.yaml#/components/schemas/audioFile'
|
||||||
chapters:
|
chapters:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
|
|
||||||
|
|
@ -877,6 +877,191 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"post": {
|
||||||
|
"operationId": "createLibrary",
|
||||||
|
"summary": "Create a new library on server",
|
||||||
|
"tags": [
|
||||||
|
"Libraries"
|
||||||
|
],
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "name",
|
||||||
|
"in": "query",
|
||||||
|
"description": "The name of the library.",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"example": "My Audiobooks"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "folders",
|
||||||
|
"in": "query",
|
||||||
|
"description": "The folders of the library. Only specify the fullPath.",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "Folder used in library",
|
||||||
|
"properties": {
|
||||||
|
"id": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The ID of the folder.",
|
||||||
|
"format": "uuid",
|
||||||
|
"example": "e4bb1afb-4a4f-4dd6-8be0-e615d233185b"
|
||||||
|
},
|
||||||
|
"fullPath": {
|
||||||
|
"description": "The path on the server for the folder. (Read Only)",
|
||||||
|
"type": "string",
|
||||||
|
"example": "/podcasts"
|
||||||
|
},
|
||||||
|
"libraryId": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The ID of the library.",
|
||||||
|
"format": "uuid",
|
||||||
|
"example": "e4bb1afb-4a4f-4dd6-8be0-e615d233185b"
|
||||||
|
},
|
||||||
|
"addedAt": {
|
||||||
|
"type": "integer",
|
||||||
|
"description": "The time (in ms since POSIX epoch) when added to the server.",
|
||||||
|
"example": 1633522963509
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "icon",
|
||||||
|
"in": "query",
|
||||||
|
"description": "The icon of the library. See Library Icons for a list of possible icons.",
|
||||||
|
"required": false,
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"example": "audiobookshelf"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "mediaType",
|
||||||
|
"in": "query",
|
||||||
|
"description": "The type of media that the library contains. Must be `book` or `podcast`.",
|
||||||
|
"required": false,
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"example": "book"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "provider",
|
||||||
|
"in": "query",
|
||||||
|
"description": "Preferred metadata provider for the library. See Metadata Providers for a list of possible providers.",
|
||||||
|
"required": false,
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"example": "audible"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "settings",
|
||||||
|
"in": "query",
|
||||||
|
"description": "The settings for the library.",
|
||||||
|
"required": false,
|
||||||
|
"schema": {
|
||||||
|
"description": "The settings for the library.",
|
||||||
|
"allOf": [
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"coverAspectRatio": {
|
||||||
|
"description": "Whether the library should use square book covers. Must be 0 (for false) or 1 (for true).",
|
||||||
|
"type": "integer",
|
||||||
|
"example": 1
|
||||||
|
},
|
||||||
|
"disableWatcher": {
|
||||||
|
"description": "Whether to disable the folder watcher for the library.",
|
||||||
|
"type": "boolean",
|
||||||
|
"example": false
|
||||||
|
},
|
||||||
|
"skipMatchingMediaWithAsin": {
|
||||||
|
"description": "Whether to skip matching books that already have an ASIN.",
|
||||||
|
"type": "boolean",
|
||||||
|
"example": false
|
||||||
|
},
|
||||||
|
"skipMatchingMediaWithIsbn": {
|
||||||
|
"description": "Whether to skip matching books that already have an ISBN.",
|
||||||
|
"type": "boolean",
|
||||||
|
"example": false
|
||||||
|
},
|
||||||
|
"autoScanCronExpression": {
|
||||||
|
"description": "The cron expression for when to automatically scan the library folders. If null, automatic scanning will be disabled.",
|
||||||
|
"type": "string",
|
||||||
|
"nullable": true,
|
||||||
|
"example": "0 0 0 * * *"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "createLibrary OK",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"description": "A library object which includes either books or podcasts.",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"id": {
|
||||||
|
"$ref": "#/components/schemas/libraryId"
|
||||||
|
},
|
||||||
|
"name": {
|
||||||
|
"$ref": "#/components/schemas/libraryName"
|
||||||
|
},
|
||||||
|
"folders": {
|
||||||
|
"description": "The folders that belong to the library.",
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "./Folder.yaml#/components/schemas/folder"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"displayOrder": {
|
||||||
|
"description": "Display position of the library in the list of libraries. Must be >= 1.",
|
||||||
|
"type": "integer",
|
||||||
|
"example": 1
|
||||||
|
},
|
||||||
|
"icon": {
|
||||||
|
"description": "The selected icon for the library. See Library Icons for a list of possible icons.",
|
||||||
|
"type": "string",
|
||||||
|
"example": "audiobookshelf"
|
||||||
|
},
|
||||||
|
"mediaType": {
|
||||||
|
"description": "The type of media that the library contains. Will be `book` or `podcast`. (Read Only)",
|
||||||
|
"type": "string",
|
||||||
|
"example": "book"
|
||||||
|
},
|
||||||
|
"provider": {
|
||||||
|
"description": "Preferred metadata provider for the library. See Metadata Providers for a list of possible providers.",
|
||||||
|
"type": "string",
|
||||||
|
"example": "audible"
|
||||||
|
},
|
||||||
|
"settings": {
|
||||||
|
"$ref": "#/components/schemas/librarySettings"
|
||||||
|
},
|
||||||
|
"createdAt": {
|
||||||
|
"$ref": "../schemas.yaml#/components/schemas/createdAt"
|
||||||
|
},
|
||||||
|
"lastUpdate": {
|
||||||
|
"$ref": "../schemas.yaml#/components/schemas/updatedAt"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -168,6 +168,25 @@ paths:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: './objects/Library.yaml#/components/schemas/library'
|
$ref: './objects/Library.yaml#/components/schemas/library'
|
||||||
|
post:
|
||||||
|
operationId: createLibrary
|
||||||
|
summary: Create a new library on server
|
||||||
|
tags:
|
||||||
|
- Libraries
|
||||||
|
parameters:
|
||||||
|
- $ref: './controllers/LibraryController.yaml#/components/parameters/libraryName'
|
||||||
|
- $ref: './controllers/LibraryController.yaml#/components/parameters/libraryFolders'
|
||||||
|
- $ref: './controllers/LibraryController.yaml#/components/parameters/libraryIcon'
|
||||||
|
- $ref: './controllers/LibraryController.yaml#/components/parameters/libraryMediaType'
|
||||||
|
- $ref: './controllers/LibraryController.yaml#/components/parameters/libraryProvider'
|
||||||
|
- $ref: './controllers/LibraryController.yaml#/components/parameters/librarySettings'
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: createLibrary OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: './objects/Library.yaml#/components/schemas/library'
|
||||||
tags:
|
tags:
|
||||||
- name: Authors
|
- name: Authors
|
||||||
description: Author endpoints
|
description: Author endpoints
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue