Fixed some minor bugs and added to root

This commit is contained in:
Vito0912 2024-07-30 17:34:04 +02:00
parent 7ef2eed2ad
commit 9b3cb4ed33
5 changed files with 72 additions and 60 deletions

View file

@ -40,7 +40,7 @@ paths:
description: TODO description: TODO
oneOf: oneOf:
- $ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItem' - $ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItem'
/api/items/{id}/play: /api/items/{id}/play/{episodeId}:
parameters: parameters:
- name: id - name: id
in: path in: path
@ -48,6 +48,12 @@ paths:
required: true required: true
schema: schema:
$ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItemId' $ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItemId'
- name: episodeId
in: path
description: The ID of the episode to play.
required: false
schema:
$ref: '../objects/mediaTypes/Podcast.yaml#/components/schemas/podcastId'
post: post:
operationId: playLibraryItem operationId: playLibraryItem
summary: Play a library item. summary: Play a library item.

View file

@ -0,0 +1,2 @@
paths:

View file

@ -5,6 +5,9 @@ components:
type: string type: string
format: uuid format: uuid
playbackSession: playbackSession:
type: object
description: A playback session object.
properties:
id: id:
$ref: '#/components/schemas/playbackSessionId' $ref: '#/components/schemas/playbackSessionId'
userId: userId:
@ -14,15 +17,14 @@ components:
libraryItemId: libraryItemId:
$ref: '../LibraryItem.yaml#/components/schemas/libraryItemId' $ref: '../LibraryItem.yaml#/components/schemas/libraryItemId'
episodeId: episodeId:
$ref: '../mediaTypes/Podcast.yaml#/components/schemas/episodeId' $ref: '../mediaTypes/Podcast.yaml#/components/schemas/podcastId'
nullable: true
mediaType: mediaType:
$ref: '../../controllers/LibraryItemController.yaml#/components/schemas/libraryMediaType' $ref: '../mediaTypes/media.yaml#/components/schemas/mediaType'
mediaMetadata: mediaMetadata:
description: The metadata of the media. description: The metadata of the media.
oneOf: oneOf:
- $ref: '../mediaTypes/Book.yaml#/components/schemas/bookMinified' - $ref: '../mediaTypes/Book.yaml#/components/schemas/bookMinified'
- $ref: '../mediaTypes/Podcast.yaml#/components/schemas/podcastMinified' - $ref: '../mediaTypes/Podcast.yaml#/components/schemas/Podcast'
chapters: chapters:
description: The chapters of the media. description: The chapters of the media.
type: array type: array
@ -35,9 +37,9 @@ components:
description: The display author of the media. description: The display author of the media.
type: string type: string
coverPath: coverPath:
$ref: '../Book.yaml#/components/schemas/bookCoverPath' $ref: '../mediaTypes/Book.yaml#/components/schemas/bookCoverPath'
duration: duration:
$ref: '../schemas.yaml#/components/schemas/durationSec' $ref: '../../schemas.yaml#/components/schemas/durationSec'
playMethod: playMethod:
type: integer type: integer
description: The method used to play the media. 0 = Direct play, 1 = Direct Stream, 2 = Transcode, 3 = Local description: The method used to play the media. 0 = Direct play, 1 = Direct Stream, 2 = Transcode, 3 = Local
@ -47,23 +49,23 @@ components:
deviceInfo: deviceInfo:
$ref: './Device.yaml#/components/schemas/deviceInfo' $ref: './Device.yaml#/components/schemas/deviceInfo'
serverVersion: serverVersion:
$ref: '../schemas.yaml#/components/schemas/serverVersion' $ref: '../../schemas.yaml#/components/schemas/serverVersion'
date: date:
description: TODO description: TODO
type: String type: string
dayOfWeek: dayOfWeek:
description: TODO description: TODO
type: String type: string
timeListening: timeListening:
$ref: '../schemas.yaml#/components/schemas/durationSec' $ref: '../../schemas.yaml#/components/schemas/durationSec'
startTime: startTime:
$ref: '../schemas.yaml#/components/schemas/durationSec' $ref: '../../schemas.yaml#/components/schemas/durationSec'
currentTime: currentTime:
$ref: '../schemas.yaml#/components/schemas/durationSec' $ref: '../../schemas.yaml#/components/schemas/durationSec'
createdAt: createdAt:
$ref: '../schemas.yaml#/components/schemas/createdAt' $ref: '../../schemas.yaml#/components/schemas/createdAt'
updatedAt: updatedAt:
$ref: '../schemas.yaml#/components/schemas/updatedAt' $ref: '../../schemas.yaml#/components/schemas/updatedAt'
playbackSessionExpanded: playbackSessionExpanded:
description: Expanded playback session schema. description: Expanded playback session schema.
allOf: allOf:

Binary file not shown.

View file

@ -83,6 +83,8 @@ paths:
$ref: './controllers/AuthController.yaml#/paths/~1logout' $ref: './controllers/AuthController.yaml#/paths/~1logout'
/api/items/{id}: /api/items/{id}:
$ref: './controllers/LibraryItemController.yaml#/paths/~1api~1items~1{id}' $ref: './controllers/LibraryItemController.yaml#/paths/~1api~1items~1{id}'
/api/items/{id}/play/{episodeId}:
$ref: './controllers/LibraryItemController.yaml#/paths/~1api~1items~1{id}~1play~1{episodeId}'
tags: tags:
- name: Authors - name: Authors
description: Author endpoints description: Author endpoints