mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-07-11 03:41:42 +00:00
77 lines
2.3 KiB
YAML
77 lines
2.3 KiB
YAML
paths:
|
|
/api/me:
|
|
get:
|
|
operationId: getMe
|
|
summary: Get the current user.
|
|
description: Get the current user.
|
|
tags:
|
|
- Me
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
content:
|
|
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
|