Add Library ItemController

This commit is contained in:
unl0ck 2024-11-12 20:43:02 +00:00
parent d7e810fc2f
commit 1593a045b6
2 changed files with 55 additions and 0 deletions

View File

@ -0,0 +1,53 @@
components:
schemas:
expanded:
type: binary
description: Whether to return Library Item Expanded instead. 0 for false, 1 for true.
format: binary
example: 0
include:
type: string
description: "A comma separated list of what to include with the library item. The options are: progress, rssfeed, authors (for books), and downloads (for podcasts). expanded must be 1 for include to have an effect."
example: progress,rssfeed,authors
episode:
type: string
description: If requesting progress for a podcast, the episode ID to get progress for.
paths:
/api/items/{id}:
parameters:
- name: id
in: path
description: The ID of the libraryItem.
required: true
schema:
$ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItemId'
get:
summary: Get a library item by ID
description: Get a library item by ID
operationId: getLibraryItemById
tags:
- LibraryItem
parameters:
- name: expanded
in: query
description: Whether to return Library Item Expanded instead. 0 for false, 1 for true.
schema:
$ref: '/components/schemas/expanded'
- name: include
in: query
description: "A comma separated list of what to include with the library item. The options are: progress, rssfeed, authors (for books), and downloads (for podcasts). expanded must be 1 for include to have an effect."
schema:
$ref: '/components/schemas/include'
- name: episode
in: query
description: If requesting progress for a podcast, the episode ID to get progress for.
schema:
$ref: '/components/schemas/episode'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItemBase'

View File

@ -90,3 +90,5 @@ tags:
description: Notifications endpoints
- name: Podcasts
description: Podcast endpoints
- name: LibraryItem
description: LibraryItem endpoints