LukeParke/plex-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-docs.git synced 2025-12-06 12:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating OpenAPI Spec

Browse Source
This commit is contained in:
lukehagar
2023-04-19 02:28:42 +00:00
parent ac6f310b16
commit d10bb3b54b
1 changed files with 264 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

265
static/plex-api-spec-dereferenced.yaml
View File

@@ -431,7 +431,7 @@ paths:
- Updater - Updater
summary: Querying status of updates summary: Querying status of updates
description: Querying status of updates description: Querying status of updates
operationId: queryUpdateStatus operationId: getUpdateStatus
responses: responses:
'200': '200':
description: The Server Updates description: The Server Updates
@@ -732,6 +732,56 @@ paths:
example: 401 example: 401
'404': '404':
description: The task was not running description: The task was not running
/identity:
get:
tags:
- Server
summary: Get Server Identity
description: Get Server Identity
operationId: getServerIdentity
responses:
'200':
description: The Transcode Sessions
content:
application/json:
schema:
type: object
properties:
MediaContainer:
type: object
properties:
size:
type: number
example: 0
claimed:
type: boolean
machineIdentifier:
type: string
example: 96f2fe7a78c9dc1f16a16bedbe90f98149be16b4
version:
type: string
example: 1.31.3.6868-28fc46b27
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: number
example: 1001
message:
type: string
example: User could not be authenticated
status:
type: number
example: 401
/log: /log:
get: get:
tags: tags:
@@ -2056,6 +2106,219 @@ paths:
status: status:
type: number type: number
example: 401 example: 401
/servers:
get:
tags:
- Server
summary: Get Server List
description: Get Server List
operationId: getServerList
responses:
'200':
description: List of Servers
content:
application/json:
schema:
type: object
properties:
MediaContainer:
type: object
properties:
size:
type: number
example: 1
Server:
type: array
items:
type: object
properties:
name:
type: string
example: Hera
host:
type: string
example: 10.10.10.47
address:
type: string
example: 10.10.10.47
port:
type: number
example: 32400
machineIdentifier:
type: string
example: 96f2fe7a78c9dc1f16a16bedbe90f98149be16b4
version:
type: string
example: 1.31.3.6868-28fc46b27
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: number
example: 1001
message:
type: string
example: User could not be authenticated
status:
type: number
example: 401
/transcode/sessions:
get:
tags:
- Sessions
summary: Get Transcode Sessions
description: Get Transcode Sessions
operationId: getTranscodeSessions
responses:
'200':
description: The Transcode Sessions
content:
application/json:
schema:
type: object
properties:
MediaContainer:
type: object
properties:
size:
type: number
example: 1
TranscodeSession:
type: array
items:
type: object
properties:
key:
type: string
example: zz7llzqlx8w9vnrsbnwhbmep
throttled:
type: boolean
complete:
type: boolean
progress:
type: number
example: 0.4000000059604645
size:
type: number
example: -22
speed:
type: number
example: 22.399999618530273
error:
type: boolean
duration:
type: number
example: 2561768
context:
type: string
example: streaming
sourceVideoCodec:
type: string
example: h264
sourceAudioCodec:
type: string
example: ac3
videoDecision:
type: string
example: transcode
audioDecision:
type: string
example: transcode
protocol:
type: string
example: http
container:
type: string
example: mkv
videoCodec:
type: string
example: h264
audioCodec:
type: string
example: opus
audioChannels:
type: number
example: 2
transcodeHwRequested:
type: boolean
timeStamp:
type: number
example: 1681869535.7764285
maxOffsetAvailable:
type: number
example: 861.778
minOffsetAvailable:
type: number
example: 0
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: number
example: 1001
message:
type: string
example: User could not be authenticated
status:
type: number
example: 401
'/transcode/sessions/{sessionKey}':
delete:
tags:
- Sessions
summary: Stop a Transcode Session
description: Stop a Transcode Session
parameters:
- name: sessionKey
description: the Key of the transcode session to stop
in: path
schema:
type: string
example: zz7llzqlx8w9vnrsbnwhbmep
required: true
operationId: stopTranscodeSession
responses:
'200':
description: The Transcode Session ended
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: number
example: 1001
message:
type: string
example: User could not be authenticated
status:
type: number
example: 401
'/:/prefs': '/:/prefs':
get: get:
tags: tags: