From 9b3cb4ed33e05062e2aef445a9a28a77cba67522 Mon Sep 17 00:00:00 2001
From: Vito0912 <86927734+Vito0912@users.noreply.github.com>
Date: Tue, 30 Jul 2024 17:34:04 +0200
Subject: [PATCH] Fixed some minor bugs and added to root

---
 docs/controllers/LibraryItemController.yaml |   8 +-
 docs/controllers/MeController.yaml          |   2 +
 docs/objects/entities/PlaybackSession.yaml  | 120 ++++++++++----------
 docs/openapi.json                           | Bin 298894 -> 316108 bytes
 docs/root.yaml                              |   2 +
 5 files changed, 72 insertions(+), 60 deletions(-)
 create mode 100644 docs/controllers/MeController.yaml

diff --git a/docs/controllers/LibraryItemController.yaml b/docs/controllers/LibraryItemController.yaml
index 60a7699a1..6a3a34670 100644
--- a/docs/controllers/LibraryItemController.yaml
+++ b/docs/controllers/LibraryItemController.yaml
@@ -40,7 +40,7 @@ paths:
                       description: TODO
                       oneOf:
                         - $ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItem'
-  /api/items/{id}/play:
+  /api/items/{id}/play/{episodeId}:
     parameters:
       - name: id
         in: path
@@ -48,6 +48,12 @@ paths:
         required: true
         schema:
           $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:
       operationId: playLibraryItem
       summary: Play a library item.
diff --git a/docs/controllers/MeController.yaml b/docs/controllers/MeController.yaml
new file mode 100644
index 000000000..cf62b8460
--- /dev/null
+++ b/docs/controllers/MeController.yaml
@@ -0,0 +1,2 @@
+paths:
+
diff --git a/docs/objects/entities/PlaybackSession.yaml b/docs/objects/entities/PlaybackSession.yaml
index 0867e6d4e..17004fb9f 100644
--- a/docs/objects/entities/PlaybackSession.yaml
+++ b/docs/objects/entities/PlaybackSession.yaml
@@ -5,65 +5,67 @@ components:
       type: string
       format: uuid
     playbackSession:
-      id:
-        $ref: '#/components/schemas/playbackSessionId'
-      userId:
-        $ref: './User.yaml#/components/schemas/userId'
-      libraryId:
-        $ref: '../Library.yaml#/components/schemas/libraryId'
-      libraryItemId:
-        $ref: '../LibraryItem.yaml#/components/schemas/libraryItemId'
-      episodeId:
-        $ref: '../mediaTypes/Podcast.yaml#/components/schemas/episodeId'
-        nullable: true
-      mediaType:
-        $ref: '../../controllers/LibraryItemController.yaml#/components/schemas/libraryMediaType'
-      mediaMetadata:
-        description: The metadata of the media.
-        oneOf:
-          - $ref: '../mediaTypes/Book.yaml#/components/schemas/bookMinified'
-          - $ref: '../mediaTypes/Podcast.yaml#/components/schemas/podcastMinified'
-      chapters:
-        description: The chapters of the media.
-        type: array
-        items:
-          $ref: '../metadata/BookMetadata.yaml#/components/schemas/bookChapter'
-      displayTitle:
-        description: The display title of the media.
-        type: string
-      displayAuthor:
-        description: The display author of the media.
-        type: string
-      coverPath:
-        $ref: '../Book.yaml#/components/schemas/bookCoverPath'
-      duration:
-        $ref: '../schemas.yaml#/components/schemas/durationSec'
-      playMethod:
-        type: integer
-        description: The method used to play the media. 0 = Direct play, 1 = Direct Stream, 2 = Transcode, 3 = Local
-      mediaPlayer:
-        type: string
-        description: The media player used to play the media.
-      deviceInfo:
-        $ref: './Device.yaml#/components/schemas/deviceInfo'
-      serverVersion:
-        $ref: '../schemas.yaml#/components/schemas/serverVersion'
-      date:
-        description: TODO
-        type: String
-      dayOfWeek:
-        description: TODO
-        type: String
-      timeListening:
-        $ref: '../schemas.yaml#/components/schemas/durationSec'
-      startTime:
-        $ref: '../schemas.yaml#/components/schemas/durationSec'
-      currentTime:
-        $ref: '../schemas.yaml#/components/schemas/durationSec'
-      createdAt:
-        $ref: '../schemas.yaml#/components/schemas/createdAt'
-      updatedAt:
-        $ref: '../schemas.yaml#/components/schemas/updatedAt'
+      type: object
+      description: A playback session object.
+      properties:
+        id:
+          $ref: '#/components/schemas/playbackSessionId'
+        userId:
+          $ref: './User.yaml#/components/schemas/userId'
+        libraryId:
+          $ref: '../Library.yaml#/components/schemas/libraryId'
+        libraryItemId:
+          $ref: '../LibraryItem.yaml#/components/schemas/libraryItemId'
+        episodeId:
+          $ref: '../mediaTypes/Podcast.yaml#/components/schemas/podcastId'
+        mediaType:
+          $ref: '../mediaTypes/media.yaml#/components/schemas/mediaType'
+        mediaMetadata:
+          description: The metadata of the media.
+          oneOf:
+            - $ref: '../mediaTypes/Book.yaml#/components/schemas/bookMinified'
+            - $ref: '../mediaTypes/Podcast.yaml#/components/schemas/Podcast'
+        chapters:
+          description: The chapters of the media.
+          type: array
+          items:
+            $ref: '../metadata/BookMetadata.yaml#/components/schemas/bookChapter'
+        displayTitle:
+          description: The display title of the media.
+          type: string
+        displayAuthor:
+          description: The display author of the media.
+          type: string
+        coverPath:
+          $ref: '../mediaTypes/Book.yaml#/components/schemas/bookCoverPath'
+        duration:
+          $ref: '../../schemas.yaml#/components/schemas/durationSec'
+        playMethod:
+          type: integer
+          description: The method used to play the media. 0 = Direct play, 1 = Direct Stream, 2 = Transcode, 3 = Local
+        mediaPlayer:
+          type: string
+          description: The media player used to play the media.
+        deviceInfo:
+          $ref: './Device.yaml#/components/schemas/deviceInfo'
+        serverVersion:
+          $ref: '../../schemas.yaml#/components/schemas/serverVersion'
+        date:
+          description: TODO
+          type: string
+        dayOfWeek:
+          description: TODO
+          type: string
+        timeListening:
+          $ref: '../../schemas.yaml#/components/schemas/durationSec'
+        startTime:
+          $ref: '../../schemas.yaml#/components/schemas/durationSec'
+        currentTime:
+          $ref: '../../schemas.yaml#/components/schemas/durationSec'
+        createdAt:
+          $ref: '../../schemas.yaml#/components/schemas/createdAt'
+        updatedAt:
+          $ref: '../../schemas.yaml#/components/schemas/updatedAt'
     playbackSessionExpanded:
       description: Expanded playback session schema.
       allOf:
diff --git a/docs/openapi.json b/docs/openapi.json
index 9e2e04872117b71a0216be6e3a46df4111b1e161..9c2d854dd463ed36109bfdceab048129adb66f7d 100644
GIT binary patch
delta 3045
zcmb7Ge@xtG8GnC#3)h48;P_df@TEmcDdX;FSNr3jhcav{rC@1m>yJ`7y28qVaNR)3
zcElNtiI;=7^2uD<vPEZ|MA@<wH47d|mvpW_F#h417)NV1&E_1$#F*-g&-*>@c2G1f
z<Qwk$eLwH>KF{ZQKF{-pFFSAiFe~&le?{ynR4u^*6s3vmwJz4j&au;MX!=jDan8rC
zR*tQ=PdB9tCm(a<V(Rz23XRu!XzXec!aw1;Yb?0>>f~+&qPz^DEBsB>{*8vzB{S-|
z={($P;O^9xm|ewxo<k-<CJU7Nin;3djLlWb{BgSa=`;Zy;zpLAb+X4<7we$^2Uvie
zVZB(qC=aA1EvWkAh3kT>mzivUU;*aG<-hTbi2PQRDf8M+wEtarGat0$c}5%^PvzZt
zy{z9lpn(qRCkq`c$jECfJ}e)>RK3hCrDK;cCi5qu%s6ZK;DX$$V=IPxi0@GoO-_W~
zmeu3?WdYm`auZq%QLHB3@xn~y2eabl+Q{r_a(RGtVD{I%1W}Kyc<{{NM=<h4dk|oc
ze!MgHmkhA;<Zho8N|3_zvqNO4hkmuOA=Zb{F}?*Yc3zIT%fcvK4mAlF1DnJS!C5En
z*2x@P+9ch?a^u*`)tH~=yC`%MQ5!GP5pP1qvtlQad{zzr*&a_h7E6r7rP_fm3O>Oh
zInqyWu}q$41MuwQJ!<N`MzjQEE+$6#IR20)-bLScxwp_NR`wM#(7_&KM`-f^{dG}v
z0d@1`Pr|f`VdWlfPHm)5=UD)Ed-#_y{~^DQsgS6^!4onA?Uf=$h2G3|oFzMtlMU0#
z#t`b?mm3@d32)-XUaF=}I+f|jUE54ngS6g=kr()8Ec}C4S^=xMaE)>YP4%j<ealxU
z=#kUDLc{iX6?JB-1#YOxK^ugNxLFv{esGb#Hc`#EXfrk-R3bh%-YLDA9i*Kuaw|Y*
z9n<{4(<ncI=ol5relFIp(LVQM@oQo;@lKWAD)Li3teUx5waR=kXM9lROEQ7OhxxXo
zZ2=0i2c^Bzh51LNcl4YM?Wbfud@ds&(I-So+8K-3ATigEyB+dCR*%KZc~YQeJhrgU
zPX%zlOqM4OUsJD345v@YJj>V`U9Fw!rG*kqydf*sS+5k7N%Wn;2W8Te*qYfzqC2be
zXXU}eYA`z^wh=dvCB?2=2Yj#bltZypnXH~R_^EPwi77uBPUfu2%HUbc;7Z&P*1$eX
z>oE!)d&LG#X*w?aP8Pw}E1TpFwi|anVoN-0{J>~!A*P(t{eQF{6?wK8=26)l-;I0w
z41e-QoUWC%tEbqdd|%j;l^ltceXWV#$WqKhnDMl3R||vQv?M5I!?GSTPYBzxB(|Ou
z+tl1GZ>DZH%hT9;N7SbF5P_5`jNFzT@fS7n`bLCKNppD;TxkC*_fjZJiCJ<>Wt{Ql
ztSU?VY*KC=|B<NJxO_R*uoJq)Wt)*_6+ae+g%iFRN=JK@Q4ZfMm86xZ<WkTTZ%HA#
zPNt}^HwD9$A_If9+^Hga@*T?$JA#KAsYgd{h@DmuMLr{plBH>t=p!pUQg2+@hK$?d
z`*|yYOAQCVx+y=6TNQ>4?|hS2=v-jtgwcTZX1-H}{@IQ8G+Bel1#uPTcH>n<KNNNq
zzEx!*FTEw&@O;2<Vy;J&#d@!~iy|NHHrAuM*05vpi$<A>o~lv4;&N+G(>-CwrTf%5
zB3pP>;`4kjcdLbhVobfw3v_|B#oEiBgT&$U+GgC`EfhT?&Z(k_^}G$E$At^Neo+Ot
zU)u4?A4Nd|xPy9c`S?X%Y+>tBct?7Yu-6P~pwT-refb8fI1%0_ZD{$P_$At(6f>D|
z_70H}gIeTxu0rlcXrplq6mZH@TK8JK)b<IYf5pZ?e4~Dk$ym>;*x;xpl$)MfdKyUl
z@zMR!K+*E|tco~7_B5W_AR|;2t67324dj?0^fKGNwAw`9I@D9Im%taM2JU`Kq$GwK
z39KuTLZg25;r21&L+LfSH{Lv~)-%4tXnyb>qe@@cy{bSgnflfx$!1BYI;Y%^krUz}
z?J)IIB^ve2&etmrKd~~z4pXN;P7HNo_Ndsp0*6Qobs)MA;N~u4ufAY?CoM?Z`ia&y
z8aJ(B*@?L)MKj)g*zoH0Z)4)RoKWr;ix9QT3Ai`&y8ku9k=HF<6n$~+BW#dnitbu^
zO6t;x7e##duMjOE=sIPUOAlHP8YO7@mw5WWDp+?^>tZ%{L)5`^7}@y2IeARcEW}^F
zE~t#(CuJ;?&?e<Bu&afaKBaFwb-GvMg2Sk`ZUJiHJyS2Q)z?<-aW8&xlte}sJ9kdv
z8~GT!)6wMxi!P&3QZ>W1L3nh7s)O&#!e<E_EmwtsjQcVhX0K7C?;q&9En4*TI9DHd
X67wFBjj4Xp>12Q9bY#Hzcj12ksvuY<

delta 46
zcmX@JRJd=xP(usj7A6bn$$OYM+PRFFfS7qZmk|p`#PkhCjB=CL6lrZgw~ghWGyrW{
B5EuXe

diff --git a/docs/root.yaml b/docs/root.yaml
index cc6cf7e11..b920e09a1 100644
--- a/docs/root.yaml
+++ b/docs/root.yaml
@@ -83,6 +83,8 @@ paths:
     $ref: './controllers/AuthController.yaml#/paths/~1logout'
   /api/items/{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:
   - name: Authors
     description: Author endpoints