mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-07-12 12:21:34 +00:00
89 lines
2.4 KiB
YAML
89 lines
2.4 KiB
YAML
components:
|
|
parameters:
|
|
libraryName:
|
|
name: name
|
|
in: requestBody
|
|
description: The name of the library.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
example: My Audiobooks
|
|
libraryFolders:
|
|
name: folders
|
|
in: requestBody
|
|
description: The folders of the library. Only specify the fullPath.
|
|
required: true
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../objects/Folder.yaml#/components/schemas/folder'
|
|
libraryDisplayOrder:
|
|
name: displayOrder
|
|
in: requestBody
|
|
description: The display order of the library. Must be >= 1.
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
minimum: 1
|
|
example: 1
|
|
libraryIcon:
|
|
name: icon
|
|
in: requestBody
|
|
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: requestBody
|
|
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: requestBody
|
|
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: requestBody
|
|
description: The settings for the library.
|
|
required: false
|
|
schema:
|
|
$ref: '../objects/Library.yaml#/components/schemas/librarySettings'
|
|
libraryId:
|
|
name: id
|
|
in: path
|
|
description: The ID of the library.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
|
|
librarySettings:
|
|
name: settings
|
|
in: requestBody
|
|
description: The settings for the library.
|
|
required: false
|
|
schema:
|
|
$ref: '../objects/Library.yaml#/components/schemas/librarySettings'
|
|
responses:
|
|
library200:
|
|
description: Library found.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../objects/Library.yaml#/components/schemas/library'
|
|
library404:
|
|
description: Library not found.
|
|
content:
|
|
text/html:
|
|
schema:
|
|
type: string
|
|
example: Library not found.
|