mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-07-12 12:21:34 +00:00
Fix: allow comma in Author query
This commit is contained in:
Nicholas Wallace
parent
0a4d24f1b3
commit
f5d7a71f62
2 changed files with 88 additions and 749 deletions
|
|
@ -74,17 +74,14 @@ paths:
|
||||||
description: Get an author by ID. The author's books and series can be included in the response.
|
description: Get an author by ID. The author's books and series can be included in the response.
|
||||||
tags:
|
tags:
|
||||||
- Authors
|
- Authors
|
||||||
requestBody:
|
parameters:
|
||||||
required: false
|
- in: query
|
||||||
description: The author object to create.
|
name: include
|
||||||
content:
|
description: A comma separated list of what to include with the author. The options are `items` and `series`. `series` will only have an effect if `items` is included. For example, the value `items,series` will include both library items and series.
|
||||||
application/json:
|
allowReserved: true
|
||||||
schema:
|
schema:
|
||||||
properties:
|
type: string
|
||||||
include:
|
example: 'items,series'
|
||||||
$ref: '#/components/schemas/authorInclude'
|
|
||||||
library:
|
|
||||||
$ref: '#/components/schemas/authorLibraryId'
|
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: getAuthorById OK
|
description: getAuthorById OK
|
||||||
|
|
|
||||||
|
|
@ -47,25 +47,21 @@
|
||||||
"operationId": "getAuthorById",
|
"operationId": "getAuthorById",
|
||||||
"summary": "Get an author by ID",
|
"summary": "Get an author by ID",
|
||||||
"description": "Get an author by ID. The author's books and series can be included in the response.",
|
"description": "Get an author by ID. The author's books and series can be included in the response.",
|
||||||
"tags": ["Authors"],
|
"tags": [
|
||||||
"requestBody": {
|
"Authors"
|
||||||
"required": false,
|
],
|
||||||
"description": "The author object to create.",
|
"parameters": [
|
||||||
"content": {
|
{
|
||||||
"application/json": {
|
"in": "query",
|
||||||
"schema": {
|
"name": "include",
|
||||||
"properties": {
|
"description": "A comma separated list of what to include with the author. The options are `items` and `series`. `series` will only have an effect if `items` is included. For example, the value `items,series` will include both library items and series.",
|
||||||
"include": {
|
"allowReserved": true,
|
||||||
"$ref": "#/components/schemas/authorInclude"
|
"schema": {
|
||||||
},
|
"type": "string"
|
||||||
"library": {
|
},
|
||||||
"$ref": "#/components/schemas/libraryId"
|
"example": "items,series"
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
"description": "getAuthorById OK",
|
"description": "getAuthorById OK",
|
||||||
|
|
@ -86,7 +82,9 @@
|
||||||
"operationId": "updateAuthorById",
|
"operationId": "updateAuthorById",
|
||||||
"summary": "Update an author by ID",
|
"summary": "Update an author by ID",
|
||||||
"description": "Update an author by ID. The author's name and description can be updated. This endpoint will merge two authors if the new author name matches another author name in the database.",
|
"description": "Update an author by ID. The author's name and description can be updated. This endpoint will merge two authors if the new author name matches another author name in the database.",
|
||||||
"tags": ["Authors"],
|
"tags": [
|
||||||
|
"Authors"
|
||||||
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"description": "The author object to update.",
|
"description": "The author object to update.",
|
||||||
"content": {
|
"content": {
|
||||||
|
|
@ -140,7 +138,9 @@
|
||||||
"operationId": "deleteAuthorById",
|
"operationId": "deleteAuthorById",
|
||||||
"summary": "Delete an author by ID",
|
"summary": "Delete an author by ID",
|
||||||
"description": "Delete an author by ID. This will remove the author from all books.",
|
"description": "Delete an author by ID. This will remove the author from all books.",
|
||||||
"tags": ["Authors"],
|
"tags": [
|
||||||
|
"Authors"
|
||||||
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
"description": "deleteAuthorById OK",
|
"description": "deleteAuthorById OK",
|
||||||
|
|
@ -175,7 +175,9 @@
|
||||||
"operationId": "getAuthorImageById",
|
"operationId": "getAuthorImageById",
|
||||||
"summary": "Get an author image by author ID",
|
"summary": "Get an author image by author ID",
|
||||||
"description": "Get an author image by author ID. The image will be returned in the requested format and size.",
|
"description": "Get an author image by author ID. The image will be returned in the requested format and size.",
|
||||||
"tags": ["Authors"],
|
"tags": [
|
||||||
|
"Authors"
|
||||||
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "The author image to get.",
|
"description": "The author image to get.",
|
||||||
|
|
@ -233,7 +235,9 @@
|
||||||
"operationId": "addAuthorImageById",
|
"operationId": "addAuthorImageById",
|
||||||
"summary": "Add an author image to the server",
|
"summary": "Add an author image to the server",
|
||||||
"description": "Add an author image to the server. The image will be downloaded from the provided URL and stored on the server.",
|
"description": "Add an author image to the server. The image will be downloaded from the provided URL and stored on the server.",
|
||||||
"tags": ["Authors"],
|
"tags": [
|
||||||
|
"Authors"
|
||||||
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "The author image to add by URL.",
|
"description": "The author image to add by URL.",
|
||||||
|
|
@ -266,7 +270,9 @@
|
||||||
"operationId": "updateAuthorImageById",
|
"operationId": "updateAuthorImageById",
|
||||||
"summary": "Update an author image by author ID",
|
"summary": "Update an author image by author ID",
|
||||||
"description": "Update an author image by author ID. The image will be resized if the width, height, or format is provided.",
|
"description": "Update an author image by author ID. The image will be resized if the width, height, or format is provided.",
|
||||||
"tags": ["Authors"],
|
"tags": [
|
||||||
|
"Authors"
|
||||||
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"description": "The author image to update.",
|
"description": "The author image to update.",
|
||||||
"content": {
|
"content": {
|
||||||
|
|
@ -311,7 +317,9 @@
|
||||||
"operationId": "deleteAuthorImageById",
|
"operationId": "deleteAuthorImageById",
|
||||||
"summary": "Delete an author image by author ID",
|
"summary": "Delete an author image by author ID",
|
||||||
"description": "Delete an author image by author ID. This will remove the image from the server and the database.",
|
"description": "Delete an author image by author ID. This will remove the image from the server and the database.",
|
||||||
"tags": ["Authors"],
|
"tags": [
|
||||||
|
"Authors"
|
||||||
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
"description": "deleteAuthorImageById OK"
|
"description": "deleteAuthorImageById OK"
|
||||||
|
|
@ -338,7 +346,9 @@
|
||||||
"operationId": "matchAuthorById",
|
"operationId": "matchAuthorById",
|
||||||
"summary": "Match the author against Audible using quick match",
|
"summary": "Match the author against Audible using quick match",
|
||||||
"description": "Match the author against Audible using quick match. Quick match updates the author's description and image (if no image already existed) with information from audible. Either `asin` or `q` must be provided, with `asin` taking priority if both are provided.",
|
"description": "Match the author against Audible using quick match. Quick match updates the author's description and image (if no image already existed) with information from audible. Either `asin` or `q` must be provided, with `asin` taking priority if both are provided.",
|
||||||
"tags": ["Authors"],
|
"tags": [
|
||||||
|
"Authors"
|
||||||
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "The author object to match against an online provider.",
|
"description": "The author object to match against an online provider.",
|
||||||
|
|
@ -385,166 +395,6 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/api/libraries": {
|
|
||||||
"get": {
|
|
||||||
"operationId": "getLibraries",
|
|
||||||
"summary": "Get all libraries on server",
|
|
||||||
"description": "Get all libraries on server.",
|
|
||||||
"tags": ["Libraries"],
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "getLibraries OK",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/library"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"post": {
|
|
||||||
"operationId": "createLibrary",
|
|
||||||
"summary": "Create a new library on server",
|
|
||||||
"description": "Create a new library on server.",
|
|
||||||
"tags": ["Libraries"],
|
|
||||||
"requestBody": {
|
|
||||||
"description": "The library object to create.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"required": ["name", "folders"],
|
|
||||||
"properties": {
|
|
||||||
"name": {
|
|
||||||
"$ref": "#/components/schemas/libraryName"
|
|
||||||
},
|
|
||||||
"folders": {
|
|
||||||
"$ref": "#/components/schemas/libraryFolders"
|
|
||||||
},
|
|
||||||
"displayOrder": {
|
|
||||||
"$ref": "#/components/schemas/libraryDisplayOrder"
|
|
||||||
},
|
|
||||||
"icon": {
|
|
||||||
"$ref": "#/components/schemas/libraryIcon"
|
|
||||||
},
|
|
||||||
"mediaType": {
|
|
||||||
"$ref": "#/components/schemas/libraryMediaType"
|
|
||||||
},
|
|
||||||
"provider": {
|
|
||||||
"$ref": "#/components/schemas/libraryProvider"
|
|
||||||
},
|
|
||||||
"settings": {
|
|
||||||
"$ref": "#/components/schemas/librarySettings"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"$ref": "#/components/responses/library200"
|
|
||||||
},
|
|
||||||
"404": {
|
|
||||||
"$ref": "#/components/responses/library404"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/api/libraries/{id}": {
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"name": "id",
|
|
||||||
"in": "path",
|
|
||||||
"description": "The ID of the library.",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/libraryId"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"get": {
|
|
||||||
"operationId": "getLibraryById",
|
|
||||||
"summary": "Get a single library by ID on server",
|
|
||||||
"description": "Get a single library by ID on server.",
|
|
||||||
"tags": ["Libraries"],
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"$ref": "#/components/responses/library200"
|
|
||||||
},
|
|
||||||
"404": {
|
|
||||||
"$ref": "#/components/responses/library404"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"patch": {
|
|
||||||
"operationId": "updateLibraryById",
|
|
||||||
"summary": "Update a single library by ID on server",
|
|
||||||
"description": "Update a single library by ID on server.",
|
|
||||||
"tags": ["Libraries"],
|
|
||||||
"requestBody": {
|
|
||||||
"required": true,
|
|
||||||
"description": "The library object to update.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"name": {
|
|
||||||
"$ref": "#/components/schemas/libraryName"
|
|
||||||
},
|
|
||||||
"folders": {
|
|
||||||
"$ref": "#/components/schemas/libraryFolders"
|
|
||||||
},
|
|
||||||
"displayOrder": {
|
|
||||||
"$ref": "#/components/schemas/libraryDisplayOrder"
|
|
||||||
},
|
|
||||||
"icon": {
|
|
||||||
"$ref": "#/components/schemas/libraryIcon"
|
|
||||||
},
|
|
||||||
"mediaType": {
|
|
||||||
"$ref": "#/components/schemas/libraryMediaType"
|
|
||||||
},
|
|
||||||
"provider": {
|
|
||||||
"$ref": "#/components/schemas/libraryProvider"
|
|
||||||
},
|
|
||||||
"settings": {
|
|
||||||
"$ref": "#/components/schemas/librarySettings"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"$ref": "#/components/responses/library200"
|
|
||||||
},
|
|
||||||
"404": {
|
|
||||||
"$ref": "#/components/responses/library404"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"delete": {
|
|
||||||
"operationId": "deleteLibraryById",
|
|
||||||
"summary": "Delete a single library by ID on server",
|
|
||||||
"description": "Delete a single library by ID on server and return the deleted object.",
|
|
||||||
"tags": ["Libraries"],
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"$ref": "#/components/responses/library200"
|
|
||||||
},
|
|
||||||
"404": {
|
|
||||||
"$ref": "#/components/responses/library404"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/api/libraries/{id}/authors": {
|
"/api/libraries/{id}/authors": {
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
|
|
@ -561,7 +411,9 @@
|
||||||
"operationId": "getLibraryAuthors",
|
"operationId": "getLibraryAuthors",
|
||||||
"summary": "Get all authors in a library",
|
"summary": "Get all authors in a library",
|
||||||
"description": "Get all authors in a library by ID on server.",
|
"description": "Get all authors in a library by ID on server.",
|
||||||
"tags": ["Libraries"],
|
"tags": [
|
||||||
|
"Libraries"
|
||||||
|
],
|
||||||
"responses": {
|
"responses": {
|
||||||
"200": {
|
"200": {
|
||||||
"description": "getLibraryAuthors OK",
|
"description": "getLibraryAuthors OK",
|
||||||
|
|
@ -587,277 +439,6 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/api/libraries/{id}/items": {
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"name": "id",
|
|
||||||
"in": "path",
|
|
||||||
"description": "The ID of the library.",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/libraryId"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"get": {
|
|
||||||
"operationId": "getLibraryItems",
|
|
||||||
"summary": "Get items in a library",
|
|
||||||
"description": "Get items in a library by ID on server.",
|
|
||||||
"tags": ["Libraries"],
|
|
||||||
"requestBody": {
|
|
||||||
"required": false,
|
|
||||||
"description": "The filters to apply to the requested library items.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"limit": {
|
|
||||||
"$ref": "#/components/schemas/limit"
|
|
||||||
},
|
|
||||||
"page": {
|
|
||||||
"$ref": "#/components/schemas/page"
|
|
||||||
},
|
|
||||||
"sort": {
|
|
||||||
"$ref": "#/components/schemas/librarySort"
|
|
||||||
},
|
|
||||||
"desc": {
|
|
||||||
"$ref": "#/components/schemas/sortDesc"
|
|
||||||
},
|
|
||||||
"filter": {
|
|
||||||
"$ref": "#/components/schemas/libraryFilter"
|
|
||||||
},
|
|
||||||
"minified": {
|
|
||||||
"$ref": "#/components/schemas/minified"
|
|
||||||
},
|
|
||||||
"collapseSeries": {
|
|
||||||
"$ref": "#/components/schemas/libraryCollapseSeries"
|
|
||||||
},
|
|
||||||
"include": {
|
|
||||||
"$ref": "#/components/schemas/libraryInclude"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "getLibraryItems OK",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"results": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/libraryItemBase"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"total": {
|
|
||||||
"$ref": "#/components/schemas/total"
|
|
||||||
},
|
|
||||||
"limit": {
|
|
||||||
"$ref": "#/components/schemas/limit"
|
|
||||||
},
|
|
||||||
"page": {
|
|
||||||
"$ref": "#/components/schemas/page"
|
|
||||||
},
|
|
||||||
"sortBy": {
|
|
||||||
"$ref": "#/components/schemas/sortBy"
|
|
||||||
},
|
|
||||||
"sortDesc": {
|
|
||||||
"$ref": "#/components/schemas/sortDesc"
|
|
||||||
},
|
|
||||||
"filterBy": {
|
|
||||||
"$ref": "#/components/schemas/filterBy"
|
|
||||||
},
|
|
||||||
"mediaType": {
|
|
||||||
"$ref": "#/components/schemas/mediaType"
|
|
||||||
},
|
|
||||||
"minified": {
|
|
||||||
"$ref": "#/components/schemas/minified"
|
|
||||||
},
|
|
||||||
"collapseSeries": {
|
|
||||||
"$ref": "#/components/schemas/collapseSeries"
|
|
||||||
},
|
|
||||||
"include": {
|
|
||||||
"$ref": "#/components/schemas/libraryInclude"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"404": {
|
|
||||||
"$ref": "#/components/responses/library404"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/api/libraries/{id}/issues": {
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"name": "id",
|
|
||||||
"in": "path",
|
|
||||||
"description": "The ID of the library.",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/libraryId"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"delete": {
|
|
||||||
"operationId": "deleteLibraryIssues",
|
|
||||||
"summary": "Delete items with issues in a library.",
|
|
||||||
"description": "Delete all items with issues in a library by library ID on the server. This only removes the items from the ABS database and does not delete media files.",
|
|
||||||
"tags": ["Libraries"],
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "deleteLibraryIssues OK",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "string",
|
|
||||||
"example": "Issues deleted."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"404": {
|
|
||||||
"$ref": "#/components/responses/library404"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/api/libraries/{id}/series": {
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"name": "id",
|
|
||||||
"in": "path",
|
|
||||||
"description": "The ID of the library.",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/libraryId"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"get": {
|
|
||||||
"operationId": "getLibrarySeries",
|
|
||||||
"summary": "Get library series",
|
|
||||||
"description": "Get series in a library. Filtering and sorting can be applied.",
|
|
||||||
"tags": ["Libraries"],
|
|
||||||
"parameters": [
|
|
||||||
{
|
|
||||||
"in": "query",
|
|
||||||
"name": "limit",
|
|
||||||
"description": "The number of series to return. If 0, all series are returned.",
|
|
||||||
"example": 10,
|
|
||||||
"schema": {
|
|
||||||
"type": "integer",
|
|
||||||
"default": 0
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"in": "query",
|
|
||||||
"name": "page",
|
|
||||||
"description": "The page number (zero indexed) to return. If no limit is specified, then page will have no effect.",
|
|
||||||
"example": 0,
|
|
||||||
"schema": {
|
|
||||||
"type": "integer",
|
|
||||||
"default": 0
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"in": "query",
|
|
||||||
"name": "sort",
|
|
||||||
"description": "The field to sort by from the request.",
|
|
||||||
"example": "numBooks",
|
|
||||||
"schema": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["name", "numBooks", "totalDuration", "addedAt", "lastBookAdded", "lastBookUpdated"],
|
|
||||||
"default": "name"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"in": "query",
|
|
||||||
"name": "desc",
|
|
||||||
"description": "Return items in reversed order if true.",
|
|
||||||
"example": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"in": "query",
|
|
||||||
"name": "filter",
|
|
||||||
"description": "The filter for the library.",
|
|
||||||
"example": "media.metadata.title",
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"in": "query",
|
|
||||||
"name": "include",
|
|
||||||
"description": "The fields to include in the response. The only current option is `rssfeed`.",
|
|
||||||
"example": "rssfeed",
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "getLibrarySeries OK",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"results": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/seriesBooks"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"total": {
|
|
||||||
"$ref": "#/components/schemas/total"
|
|
||||||
},
|
|
||||||
"limit": {
|
|
||||||
"$ref": "#/components/schemas/limit"
|
|
||||||
},
|
|
||||||
"page": {
|
|
||||||
"$ref": "#/components/schemas/page"
|
|
||||||
},
|
|
||||||
"sortBy": {
|
|
||||||
"$ref": "#/components/schemas/sortBy"
|
|
||||||
},
|
|
||||||
"sortDesc": {
|
|
||||||
"$ref": "#/components/schemas/sortDesc"
|
|
||||||
},
|
|
||||||
"filterBy": {
|
|
||||||
"$ref": "#/components/schemas/filterBy"
|
|
||||||
},
|
|
||||||
"minified": {
|
|
||||||
"$ref": "#/components/schemas/minified"
|
|
||||||
},
|
|
||||||
"include": {
|
|
||||||
"$ref": "#/components/schemas/libraryInclude"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"404": {
|
|
||||||
"$ref": "#/components/responses/library404"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/api/libraries/{id}/series/{seriesId}": {
|
"/api/libraries/{id}/series/{seriesId}": {
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
|
|
@ -884,7 +465,9 @@
|
||||||
"summary": "Get single series in library",
|
"summary": "Get single series in library",
|
||||||
"description": "Get a single series in a library by ID on server. This endpoint is deprecated and `/api/series/{id}` should be used instead.",
|
"description": "Get a single series in a library by ID on server. This endpoint is deprecated and `/api/series/{id}` should be used instead.",
|
||||||
"deprecated": true,
|
"deprecated": true,
|
||||||
"tags": ["Libraries"],
|
"tags": [
|
||||||
|
"Libraries"
|
||||||
|
],
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "The filters to apply to the requested library series.",
|
"description": "The filters to apply to the requested library series.",
|
||||||
|
|
@ -902,7 +485,14 @@
|
||||||
"sort": {
|
"sort": {
|
||||||
"description": "The field to sort by from the request.",
|
"description": "The field to sort by from the request.",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"enum": ["name", "numBooks", "totalDuration", "addedAt", "lastBookAdded", "lastBookUpdated"],
|
"enum": [
|
||||||
|
"name",
|
||||||
|
"numBooks",
|
||||||
|
"totalDuration",
|
||||||
|
"addedAt",
|
||||||
|
"lastBookAdded",
|
||||||
|
"lastBookUpdated"
|
||||||
|
],
|
||||||
"example": "numBooks",
|
"example": "numBooks",
|
||||||
"default": "name"
|
"default": "name"
|
||||||
},
|
},
|
||||||
|
|
@ -954,7 +544,9 @@
|
||||||
],
|
],
|
||||||
"get": {
|
"get": {
|
||||||
"operationId": "getSeries",
|
"operationId": "getSeries",
|
||||||
"tags": ["Series"],
|
"tags": [
|
||||||
|
"Series"
|
||||||
|
],
|
||||||
"summary": "Get series",
|
"summary": "Get series",
|
||||||
"description": "Get a series by ID.",
|
"description": "Get a series by ID.",
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
|
|
@ -969,7 +561,12 @@
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "A comma separated list of what to include with the series.",
|
"description": "A comma separated list of what to include with the series.",
|
||||||
"example": "progress,rssfeed",
|
"example": "progress,rssfeed",
|
||||||
"enum": ["progress", "rssfeed", "progress,rssfeed", "rssfeed,progress"]
|
"enum": [
|
||||||
|
"progress",
|
||||||
|
"rssfeed",
|
||||||
|
"progress,rssfeed",
|
||||||
|
"rssfeed,progress"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -994,7 +591,9 @@
|
||||||
},
|
},
|
||||||
"patch": {
|
"patch": {
|
||||||
"operationId": "updateSeries",
|
"operationId": "updateSeries",
|
||||||
"tags": ["Series"],
|
"tags": [
|
||||||
|
"Series"
|
||||||
|
],
|
||||||
"summary": "Update series",
|
"summary": "Update series",
|
||||||
"description": "Update a series by ID.",
|
"description": "Update a series by ID.",
|
||||||
"requestBody": {
|
"requestBody": {
|
||||||
|
|
@ -1048,17 +647,6 @@
|
||||||
"format": "uuid",
|
"format": "uuid",
|
||||||
"example": "e4bb1afb-4a4f-4dd6-8be0-e615d233185b"
|
"example": "e4bb1afb-4a4f-4dd6-8be0-e615d233185b"
|
||||||
},
|
},
|
||||||
"authorInclude": {
|
|
||||||
"description": "A comma separated list of what to include with the author. The options are `items` and `series`. `series` will only have an effect if `items` is included. For example, the value `items,series` will include both library items and series.",
|
|
||||||
"type": "string",
|
|
||||||
"example": "items"
|
|
||||||
},
|
|
||||||
"libraryId": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The ID of the library.",
|
|
||||||
"format": "uuid",
|
|
||||||
"example": "e4bb1afb-4a4f-4dd6-8be0-e615d233185b"
|
|
||||||
},
|
|
||||||
"authorAsin": {
|
"authorAsin": {
|
||||||
"description": "The Audible identifier (ASIN) of the author. Will be null if unknown. Not the Amazon identifier.",
|
"description": "The Audible identifier (ASIN) of the author. Will be null if unknown. Not the Amazon identifier.",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
|
@ -1111,6 +699,12 @@
|
||||||
"format": "[0-9]*",
|
"format": "[0-9]*",
|
||||||
"example": "649644248522215260"
|
"example": "649644248522215260"
|
||||||
},
|
},
|
||||||
|
"libraryId": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The ID of the library.",
|
||||||
|
"format": "uuid",
|
||||||
|
"example": "e4bb1afb-4a4f-4dd6-8be0-e615d233185b"
|
||||||
|
},
|
||||||
"folderId": {
|
"folderId": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The ID of the folder.",
|
"description": "The ID of the folder.",
|
||||||
|
|
@ -1120,7 +714,10 @@
|
||||||
"mediaType": {
|
"mediaType": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The type of media, will be book or podcast.",
|
"description": "The type of media, will be book or podcast.",
|
||||||
"enum": ["book", "podcast"]
|
"enum": [
|
||||||
|
"book",
|
||||||
|
"podcast"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"libraryItemBase": {
|
"libraryItemBase": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
|
|
@ -1205,7 +802,11 @@
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"example": ["Fantasy", "Sci-Fi", "Nonfiction: History"]
|
"example": [
|
||||||
|
"Fantasy",
|
||||||
|
"Sci-Fi",
|
||||||
|
"Nonfiction: History"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"publishedYear": {
|
"publishedYear": {
|
||||||
"description": "The year the book was published. Will be null if unknown.",
|
"description": "The year the book was published. Will be null if unknown.",
|
||||||
|
|
@ -1303,7 +904,10 @@
|
||||||
"items": {
|
"items": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
},
|
},
|
||||||
"example": ["To Be Read", "Genre: Nonfiction"]
|
"example": [
|
||||||
|
"To Be Read",
|
||||||
|
"Genre: Nonfiction"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"durationSec": {
|
"durationSec": {
|
||||||
"description": "The total length (in seconds) of the item or file.",
|
"description": "The total length (in seconds) of the item or file.",
|
||||||
|
|
@ -1513,172 +1117,6 @@
|
||||||
"example": "us",
|
"example": "us",
|
||||||
"default": "us"
|
"default": "us"
|
||||||
},
|
},
|
||||||
"libraryName": {
|
|
||||||
"description": "The name of the library.",
|
|
||||||
"type": "string",
|
|
||||||
"example": "My Audiobooks"
|
|
||||||
},
|
|
||||||
"folder": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "Folder used in library",
|
|
||||||
"properties": {
|
|
||||||
"id": {
|
|
||||||
"$ref": "#/components/schemas/folderId"
|
|
||||||
},
|
|
||||||
"fullPath": {
|
|
||||||
"description": "The path on the server for the folder. (Read Only)",
|
|
||||||
"type": "string",
|
|
||||||
"example": "/podcasts"
|
|
||||||
},
|
|
||||||
"libraryId": {
|
|
||||||
"$ref": "#/components/schemas/libraryId"
|
|
||||||
},
|
|
||||||
"addedAt": {
|
|
||||||
"$ref": "#/components/schemas/addedAt"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"librarySettings": {
|
|
||||||
"description": "The settings for the library.",
|
|
||||||
"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 * * *"
|
|
||||||
},
|
|
||||||
"audiobooksOnly": {
|
|
||||||
"description": "Whether the library should ignore ebook files and only allow ebook files to be supplementary.",
|
|
||||||
"type": "boolean",
|
|
||||||
"example": false
|
|
||||||
},
|
|
||||||
"hideSingleBookSeries": {
|
|
||||||
"description": "Whether to hide series with only one book.",
|
|
||||||
"type": "boolean",
|
|
||||||
"example": false
|
|
||||||
},
|
|
||||||
"onlyShowLaterBooksInContinueSeries": {
|
|
||||||
"description": "Whether to only show books in a series after the highest series sequence.",
|
|
||||||
"type": "boolean",
|
|
||||||
"example": false
|
|
||||||
},
|
|
||||||
"metadataPrecedence": {
|
|
||||||
"description": "The precedence of metadata sources. See Metadata Providers for a list of possible providers.",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"example": ["folderStructure", "audioMetatags", "nfoFile", "txtFiles", "opfFile", "absMetadata"]
|
|
||||||
},
|
|
||||||
"podcastSearchRegion": {
|
|
||||||
"description": "The region to use when searching for podcasts.",
|
|
||||||
"type": "string",
|
|
||||||
"example": "us"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"createdAt": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "The time (in ms since POSIX epoch) when was created.",
|
|
||||||
"example": 1633522963509
|
|
||||||
},
|
|
||||||
"library": {
|
|
||||||
"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": "#/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": "#/components/schemas/createdAt"
|
|
||||||
},
|
|
||||||
"lastUpdate": {
|
|
||||||
"$ref": "#/components/schemas/updatedAt"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"libraryFolders": {
|
|
||||||
"description": "The folders of the library. Only specify the fullPath.",
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/components/schemas/folder"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"libraryDisplayOrder": {
|
|
||||||
"description": "The display order of the library. Must be >= 1.",
|
|
||||||
"type": "integer",
|
|
||||||
"minimum": 1,
|
|
||||||
"example": 1
|
|
||||||
},
|
|
||||||
"libraryIcon": {
|
|
||||||
"description": "The icon of the library. See Library Icons for a list of possible icons.",
|
|
||||||
"type": "string",
|
|
||||||
"example": "audiobookshelf"
|
|
||||||
},
|
|
||||||
"libraryMediaType": {
|
|
||||||
"description": "The type of media that the library contains. Must be `book` or `podcast`.",
|
|
||||||
"type": "string",
|
|
||||||
"example": "book"
|
|
||||||
},
|
|
||||||
"libraryProvider": {
|
|
||||||
"description": "Preferred metadata provider for the library. See Metadata Providers for a list of possible providers.",
|
|
||||||
"type": "string",
|
|
||||||
"example": "audible"
|
|
||||||
},
|
|
||||||
"authorExpanded": {
|
"authorExpanded": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "The author schema with the total number of books in the library.",
|
"description": "The author schema with the total number of books in the library.",
|
||||||
|
|
@ -1710,11 +1148,6 @@
|
||||||
"example": 1,
|
"example": 1,
|
||||||
"default": 0
|
"default": 0
|
||||||
},
|
},
|
||||||
"librarySort": {
|
|
||||||
"description": "The sort order of the library. For example, to sort by title use 'sort=media.metadata.title'.",
|
|
||||||
"type": "string",
|
|
||||||
"example": "media.metadata.title"
|
|
||||||
},
|
|
||||||
"sortDesc": {
|
"sortDesc": {
|
||||||
"description": "Return items in reversed order if true.",
|
"description": "Return items in reversed order if true.",
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
|
|
@ -1732,92 +1165,11 @@
|
||||||
"example": true,
|
"example": true,
|
||||||
"default": false
|
"default": false
|
||||||
},
|
},
|
||||||
"libraryCollapseSeries": {
|
|
||||||
"description": "Whether to collapse series.",
|
|
||||||
"type": "boolean",
|
|
||||||
"example": true,
|
|
||||||
"default": false
|
|
||||||
},
|
|
||||||
"libraryInclude": {
|
"libraryInclude": {
|
||||||
"description": "The fields to include in the response. The only current option is `rssfeed`.",
|
"description": "The fields to include in the response. The only current option is `rssfeed`.",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"example": "rssfeed"
|
"example": "rssfeed"
|
||||||
},
|
},
|
||||||
"total": {
|
|
||||||
"description": "The total number of items in the response.",
|
|
||||||
"type": "integer",
|
|
||||||
"example": 100
|
|
||||||
},
|
|
||||||
"sortBy": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The field to sort by from the request.",
|
|
||||||
"example": "media.metadata.title"
|
|
||||||
},
|
|
||||||
"filterBy": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The field to filter by from the request. TODO",
|
|
||||||
"example": "media.metadata.title"
|
|
||||||
},
|
|
||||||
"collapseSeries": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Whether collapse series was set in the request.",
|
|
||||||
"example": true
|
|
||||||
},
|
|
||||||
"sequence": {
|
|
||||||
"description": "The position in the series the book is.",
|
|
||||||
"type": "string",
|
|
||||||
"nullable": true
|
|
||||||
},
|
|
||||||
"libraryItemSequence": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "A single item on the server, like a book or podcast. Includes series sequence information.",
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/libraryItemBase"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/sequence"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"seriesBooks": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "A series object which includes the name and books in the series.",
|
|
||||||
"properties": {
|
|
||||||
"id": {
|
|
||||||
"$ref": "#/components/schemas/seriesId"
|
|
||||||
},
|
|
||||||
"name": {
|
|
||||||
"$ref": "#/components/schemas/seriesName"
|
|
||||||
},
|
|
||||||
"addedAt": {
|
|
||||||
"$ref": "#/components/schemas/addedAt"
|
|
||||||
},
|
|
||||||
"nameIgnorePrefix": {
|
|
||||||
"description": "The name of the series with any prefix moved to the end.",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"nameIgnorePrefixSort": {
|
|
||||||
"description": "The name of the series with any prefix removed.",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"type": {
|
|
||||||
"description": "Will always be `series`.",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"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/libraryItemSequence"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"totalDuration": {
|
|
||||||
"description": "The combined duration (in seconds) of all books in the series.",
|
|
||||||
"type": "number"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"seriesDescription": {
|
"seriesDescription": {
|
||||||
"description": "A description for the series. Will be null if there is none.",
|
"description": "A description for the series. Will be null if there is none.",
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
|
@ -1904,16 +1256,6 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"library200": {
|
|
||||||
"description": "Library found.",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/library"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"library404": {
|
"library404": {
|
||||||
"description": "Library not found.",
|
"description": "Library not found.",
|
||||||
"content": {
|
"content": {
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue