mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-07-12 12:21:34 +00:00
Add: library items endpoint
This commit is contained in:
parent
2ff0cb2c0a
commit
955f6ffcff
2 changed files with 101 additions and 0 deletions
|
|
@ -269,3 +269,100 @@ paths:
|
||||||
example: 'Issues deleted.'
|
example: 'Issues deleted.'
|
||||||
'404':
|
'404':
|
||||||
$ref: '#/components/responses/library404'
|
$ref: '#/components/responses/library404'
|
||||||
|
/api/libraries/{id}/items:
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
description: The ID of the library.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
$ref: '../objects/Library.yaml#/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: '../schemas.yaml#/components/schemas/limit'
|
||||||
|
page:
|
||||||
|
$ref: '../schemas.yaml#/components/schemas/page'
|
||||||
|
sort:
|
||||||
|
$ref: '#/components/schemas/librarySort'
|
||||||
|
desc:
|
||||||
|
$ref: '../schemas.yaml#/components/schemas/sortDesc'
|
||||||
|
filter:
|
||||||
|
$ref: '#/components/schemas/libraryFilter'
|
||||||
|
minified:
|
||||||
|
$ref: '../schemas.yaml#/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: '../objects/LibraryItem.yaml#/components/schemas/libraryItem'
|
||||||
|
total:
|
||||||
|
$ref: '../schemas.yaml#/components/schemas/total'
|
||||||
|
limit:
|
||||||
|
$ref: '../schemas.yaml#/components/schemas/limit'
|
||||||
|
page:
|
||||||
|
$ref: '../schemas.yaml#/components/schemas/page'
|
||||||
|
sortBy:
|
||||||
|
$ref: '#/components/schemas/sortBy'
|
||||||
|
sortDesc:
|
||||||
|
$ref: '#/components/schemas/sortDesc'
|
||||||
|
filterBy:
|
||||||
|
$ref: '#/components/schemas/filterBy'
|
||||||
|
mediaType:
|
||||||
|
$ref: '../objects/mediaTypes/media.yaml#/components/schemas/mediaType'
|
||||||
|
minified:
|
||||||
|
$ref: '../schemas.yaml#/components/schemas/minified'
|
||||||
|
collapseSeries:
|
||||||
|
$ref: '#/components/schemas/collapseSeries'
|
||||||
|
include:
|
||||||
|
$ref: '#/components/schemas/libraryInclude'
|
||||||
|
'404':
|
||||||
|
$ref: '#/components/responses/library404'
|
||||||
|
/api/libraries/{id}/authors:
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
description: The ID of the library.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
$ref: '../objects/Library.yaml#/components/schemas/libraryId'
|
||||||
|
get:
|
||||||
|
operationId: getLibraryAuthors
|
||||||
|
summary: Get all authors in a library
|
||||||
|
description: Get all authors in a library by ID on server.
|
||||||
|
tags:
|
||||||
|
- Libraries
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: getLibraryAuthors OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '../objects/entities/Author.yaml#/components/schemas/authorExpanded'
|
||||||
|
'404':
|
||||||
|
$ref: '#/components/responses/library404'
|
||||||
|
|
|
||||||
|
|
@ -25,6 +25,10 @@ paths:
|
||||||
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries'
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries'
|
||||||
/api/libraries/{id}:
|
/api/libraries/{id}:
|
||||||
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}'
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}'
|
||||||
|
/api/libraries/{id}/authors:
|
||||||
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}~1authors'
|
||||||
|
/api/libraries/{id}/items:
|
||||||
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}~1items'
|
||||||
/api/libraries/{id}/issues:
|
/api/libraries/{id}/issues:
|
||||||
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}~1issues'
|
$ref: './controllers/LibraryController.yaml#/paths/~1api~1libraries~1{id}~1issues'
|
||||||
tags:
|
tags:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue