LukeParke/plex-api-spec
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-api-spec.git synced 2025-12-08 20:47:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added new endpoints

Browse Source
This commit is contained in:
Luke Hagar
2023-04-18 21:28:09 -05:00
parent 022b26a47e
commit 544780d7bc
6 changed files with 193 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
referenced/paths/pms/identity.yaml Normal file
View File

@@ -0,0 +1,30 @@
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":
$ref: "../../responses/401.yaml"

45
referenced/paths/pms/servers.yaml Normal file
View File

@@ -0,0 +1,45 @@
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":
$ref: "../../responses/401.yaml"

19
referenced/paths/pms/transcode-sessions-key.yaml Normal file
View File

@@ -0,0 +1,19 @@
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":
$ref: "../../responses/401.yaml"

90
referenced/paths/pms/transcode-sessions.yaml Normal file
View File

@@ -0,0 +1,90 @@
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":
$ref: "../../responses/401.yaml"

2
referenced/paths/pms/updater-status.yaml
View File

@@ -3,7 +3,7 @@ get:
- 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

8
referenced/plex-api-spec.yaml
View File

@@ -113,6 +113,8 @@ paths:
$ref: "./paths/pms/butler.yaml" $ref: "./paths/pms/butler.yaml"
/butler/{taskName}: /butler/{taskName}:
$ref: "./paths/pms/butler-task.yaml" $ref: "./paths/pms/butler-task.yaml"
/identity:
$ref: "./paths/pms/identity.yaml"
/log: /log:
$ref: "./paths/pms/log.yaml" $ref: "./paths/pms/log.yaml"
/log/networked: /log/networked:
@@ -159,6 +161,12 @@ paths:
$ref: "./paths/pms/sessions.yaml" $ref: "./paths/pms/sessions.yaml"
/status/sessions/history/all: /status/sessions/history/all:
$ref: "./paths/pms/session-history.yaml" $ref: "./paths/pms/session-history.yaml"
/servers:
$ref: "./paths/pms/servers.yaml"
/transcode/sessions:
$ref: "./paths/pms/transcode-sessions.yaml"
/transcode/sessions/{sessionKey}:
$ref: "./paths/pms/transcode-sessions-key.yaml"
/:/prefs: /:/prefs:
$ref: "./paths/pms/server-preferences.yaml" $ref: "./paths/pms/server-preferences.yaml"