groove/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-07-12 12:21:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

LibrarySettings update

Browse source
This commit is contained in:
Nicholas Wallace 2024-05-15 03:58:10 +00:00
parent 0e9cf0df68
commit 1430946e0e
1 changed files with 47 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

95
docs/objects/Library.yaml
View file

@ -16,54 +16,53 @@ components:
example: My Audiobooks example: My Audiobooks
librarySettings: librarySettings:
description: The settings for the library. description: The settings for the library.
allOf: type: object
- type: object properties:
properties: coverAspectRatio:
coverAspectRatio: description: Whether the library should use square book covers. Must be 0 (for false) or 1 (for true).
description: Whether the library should use square book covers. Must be 0 (for false) or 1 (for true). type: integer
type: integer example: 1
example: 1 disableWatcher:
disableWatcher: description: Whether to disable the folder watcher for the library.
description: Whether to disable the folder watcher for the library. type: boolean
type: boolean example: false
example: false skipMatchingMediaWithAsin:
skipMatchingMediaWithAsin: description: Whether to skip matching books that already have an ASIN.
description: Whether to skip matching books that already have an ASIN. type: boolean
type: boolean example: false
example: false skipMatchingMediaWithIsbn:
skipMatchingMediaWithIsbn: description: Whether to skip matching books that already have an ISBN.
description: Whether to skip matching books that already have an ISBN. type: boolean
type: boolean example: false
example: false autoScanCronExpression:
autoScanCronExpression: description: The cron expression for when to automatically scan the library folders. If null, automatic scanning will be disabled.
description: The cron expression for when to automatically scan the library folders. If null, automatic scanning will be disabled. oneOf:
oneOf: - type: string
- type: string - type: boolean
- type: boolean - type: null
- type: null example: '0 0 0 * * *'
example: '0 0 0 * * *' audiobooksOnly:
audiobooksOnly: description: Whether the library should ignore ebook files and only allow ebook files to be supplementary.
description: Whether the library should ignore ebook files and only allow ebook files to be supplementary. type: boolean
type: boolean example: false
example: false hideSingleBookSeries:
hideSingleBookSeries: description: Whether to hide series with only one book.
description: Whether to hide series with only one book. type: boolean
type: boolean example: false
example: false onlyShowLaterBooksInContinueSeries:
onlyShowLaterBooksInContinueSeries: description: Whether to only show books in a series after the highest series sequence.
description: Whether to only show books in a series after the highest series sequence. type: boolean
type: boolean example: false
example: false metadataPrecedence:
metadataPrecedence: description: The precedence of metadata sources. See Metadata Providers for a list of possible providers.
description: The precedence of metadata sources. See Metadata Providers for a list of possible providers. type: array
type: array items:
items: type: string
type: string example: ['folderStructure', 'audioMetatags', 'nfoFile', 'txtFiles', 'opfFile', 'absMetadata']
example: ['folderStructure', 'audioMetatags', 'nfoFile', 'txtFiles', 'opfFile', 'absMetadata'] podcastSearchRegion:
podcastSearchRegion: description: The region to use when searching for podcasts.
description: The region to use when searching for podcasts. type: string
type: string example: 'us'
example: 'us'
library: library:
description: A library object which includes either books or podcasts. description: A library object which includes either books or podcasts.
type: object type: object