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

added some schemas

Browse Source
This commit is contained in:
Luke Hagar
2023-04-11 07:58:39 -05:00
parent 9977829038
commit 70c300a775
3 changed files with 143 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
referenced/paths/clients.yaml
View File

@@ -1,11 +1,60 @@
get: get:
tags: tags:
- Clients - Devices
summary: Get Available Clients summary: Get Available Clients
description: Get Available Clients description: Get Available Clients
operationId: getAvailableClients operationId: getAvailableClients
responses: responses:
"200": "200":
description: Available Clients description: Available Clients
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: iPad
host:
type: string
example: 10.10.10.102
address:
type: string
example: 10.10.10.102
port:
type: number
example: 32500
machineIdentifier:
type: string
example: A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05
version:
type: string
example: 8.17
protocol:
type: string
example: plex
product:
type: string
example: Plex for iOS
deviceClass:
type: string
example: tablet
protocolVersion:
type: string
example: 2
protocolCapabilities:
type: string
example: playback,playqueues,timeline,provider-playback
"401": "401":
$ref: "../responses/401.yaml" $ref: "../responses/401.yaml"

92
referenced/paths/resources.yaml
View File

@@ -1,11 +1,101 @@
get: get:
tags: tags:
- Resources - Devices
summary: Get Devices summary: Get Devices
description: Get Devices description: Get Devices
operationId: getDevices operationId: getDevices
responses: responses:
"200": "200":
description: List of Plex Devices description: List of Plex Devices
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Hera
product:
type: string
example: Plex Media Server
productVersion:
type: string
example: 1.31.3.6868-28fc46b27
platform:
type: string
example: Linux
platformVersion:
type: string
example: 5.19.17-Unraid (#2 SMP PREEMPT_DYNAMIC Wed Nov 2 11:54:15 PDT 2022)
device:
type: string
example: PC
clientIdentifier:
type: string
example: 96f2fe7a78c9dc1f16a16bedbe90f98149be16b4
createdAt:
type: string
format: date-time
example: 2022-06-02T00:54:26Z
lastSeenAt:
type: string
format: date-time
example: 2023-04-11T05:53:59Z
provides:
type: string
example: server
ownerId:
type: string
format: nullable
sourceTitle:
type: string
format: nullable
publicAddress:
type: string
example: 68.248.140.20
accessToken:
type: string
example: CR3nxzsaSHdWx_WwZsJL
owned:
type: boolean
home:
type: boolean
synced:
type: boolean
relay:
type: boolean
presence:
type: boolean
httpsRequired:
type: boolean
publicAddressMatches:
type: boolean
dnsRebindingProtection:
type: boolean
natLoopbackSupported:
type: boolean
connections:
type: array
items:
type: object
properties:
protocol:
type: string
example: http
address:
type: string
example: 172.18.0.1
port:
type: number
example: 32400
uri:
type: string
example: http://172.18.0.1:32400
local:
type: boolean
relay:
type: boolean
IPv6:
type: boolean
"401": "401":
$ref: "../responses/401.yaml" $ref: "../responses/401.yaml"

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

@@ -98,6 +98,8 @@ paths:
/hubs/search/voice: /hubs/search/voice:
$ref: "./paths/hubs-search-voice.yaml" $ref: "./paths/hubs-search-voice.yaml"
/user: /user:
servers:
- url: https://plex.tv/api/v2
$ref: "./paths/user.yaml" $ref: "./paths/user.yaml"
/resources: /resources:
servers: servers: