diff --git a/docs/controllers/MeController.yaml b/docs/controllers/MeController.yaml index 166312f78..e8165b322 100644 --- a/docs/controllers/MeController.yaml +++ b/docs/controllers/MeController.yaml @@ -13,3 +13,65 @@ paths: application/json: schema: $ref: '../objects/entities/User.yaml#/components/schemas/user' + /api/me/progress/{libraryItemId}/{episodeId}: + parameters: + - name: libraryItemId + in: path + description: The ID of the library item. + required: true + schema: + $ref: '../objects/LibraryItem.yaml#/components/schemas/libraryItemId' + - name: episodeId + in: path + description: The ID of the episode to get progress for. + required: false + schema: + $ref: '../objects/mediaTypes/Podcast.yaml#/components/schemas/podcastId' + get: + operationId: getProgress + summary: Get the user's progress for a library item. + description: Get the user's progress for a library item. + tags: + - Me + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '../objects/Media.yaml#/components/schemas/mediaProgress' + '404': + description: Not Found + content: + html/text: + schema: + type: string + example: Not Found + /api/me/progress/{mediaId}: + parameters: + - name: mediaId + in: path + description: The ID of the media progress. + required: true + schema: + $ref: '../objects/Media.yaml#/components/schemas/mediaProgressId' + get: + operationId: getProgressById + summary: Get the user's progress for a media item. + description: Get the user's progress for a media item. + tags: + - Me + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '../objects/Media.yaml#/components/schemas/mediaProgress' + '404': + description: Not Found + content: + html/text: + schema: + type: string + example: Not Found diff --git a/docs/openapi.json b/docs/openapi.json index 25cdf1964..d72acb3e6 100644 Binary files a/docs/openapi.json and b/docs/openapi.json differ diff --git a/docs/root.yaml b/docs/root.yaml index a706e4041..ff2c6f21f 100644 --- a/docs/root.yaml +++ b/docs/root.yaml @@ -87,6 +87,10 @@ paths: $ref: './controllers/LibraryItemController.yaml#/paths/~1api~1items~1{id}~1play~1{episodeId}' /api/me: $ref: './controllers/MeController.yaml#/paths/~1api~1me' + /api/me/progress/{libraryItemId}/{episodeId}: + $ref: './controllers/MeController.yaml#/paths/~1api~1me~1progress~1{libraryItemId}~1{episodeId}' + /api/me/progress/{mediaId}: + $ref: './controllers/MeController.yaml#/paths/~1api~1me~1progress~1{mediaId}' tags: - name: Authors description: Author endpoints