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-12 14:51:22 +00:00
parent 0d087a9bad
commit 7e5c82ee49
1 changed files with 140 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -45,7 +45,6 @@ paths:
description: 'UUID, serial number, or other number unique per device' description: 'UUID, serial number, or other number unique per device'
schema: schema:
type: string type: string
default: PlexJS
required: true required: true
- in: header - in: header
name: X-Plex-Device-Name name: X-Plex-Device-Name
@@ -76,7 +75,7 @@ paths:
required: false required: false
- in: header - in: header
name: X-Plex-Platform name: X-Plex-Platform
description: 'Platform name, eg `iOS`, `MacOSX`, `Android`, `LG`, etc' description: 'Platform name, eg `iOS`, `MacOSX`, `Android`, `LG`'
schema: schema:
type: string type: string
example: example:
@@ -118,52 +117,54 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: object type: array
properties: items:
MediaContainer: type: object
type: object properties:
properties: MediaContainer:
size: type: object
type: number properties:
example: 1 size:
Server: type: number
type: array example: 1
items: Server:
type: object type: array
properties: items:
name: type: object
type: string properties:
example: iPad name:
host: type: string
type: string example: iPad
example: 10.10.10.102 host:
address: type: string
type: string example: 10.10.10.102
example: 10.10.10.102 address:
port: type: string
type: number example: 10.10.10.102
example: 32500 port:
machineIdentifier: type: number
type: string example: 32500
example: A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05 machineIdentifier:
version: type: string
type: string example: A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05
example: 8.17 version:
protocol: type: string
type: string example: 8.17
example: plex protocol:
product: type: string
type: string example: plex
example: Plex for iOS product:
deviceClass: type: string
type: string example: Plex for iOS
example: tablet deviceClass:
protocolVersion: type: string
type: string example: tablet
example: 2 protocolVersion:
protocolCapabilities: type: string
type: string example: 2
example: 'playback,playqueues,timeline,provider-playback' protocolCapabilities:
type: string
example: 'playback,playqueues,timeline,provider-playback'
'401': '401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query. description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
content: content:
@@ -2023,7 +2024,6 @@ paths:
description: 'UUID, serial number, or other number unique per device' description: 'UUID, serial number, or other number unique per device'
schema: schema:
type: string type: string
default: PlexJS
required: true required: true
- in: header - in: header
name: X-Plex-Device-Name name: X-Plex-Device-Name
@@ -2054,7 +2054,7 @@ paths:
required: false required: false
- in: header - in: header
name: X-Plex-Platform name: X-Plex-Platform
description: 'Platform name, eg `iOS`, `MacOSX`, `Android`, `LG`, etc' description: 'Platform name, eg `iOS`, `MacOSX`, `Android`, `LG`'
schema: schema:
type: string type: string
example: example:
@@ -2129,7 +2129,6 @@ paths:
description: 'UUID, serial number, or other number unique per device' description: 'UUID, serial number, or other number unique per device'
schema: schema:
type: string type: string
default: PlexJS
required: true required: true
- in: header - in: header
name: X-Plex-Device-Name name: X-Plex-Device-Name
@@ -2160,7 +2159,7 @@ paths:
required: false required: false
- in: header - in: header
name: X-Plex-Platform name: X-Plex-Platform
description: 'Platform name, eg `iOS`, `MacOSX`, `Android`, `LG`, etc' description: 'Platform name, eg `iOS`, `MacOSX`, `Android`, `LG`'
schema: schema:
type: string type: string
example: example:
@@ -2202,93 +2201,95 @@ paths:
content: content:
application/json: application/json:
schema: schema:
type: object type: array
properties: items:
name: type: object
type: string properties:
example: Hera name:
product: type: string
type: string example: Hera
example: Plex Media Server product:
productVersion: type: string
type: string example: Plex Media Server
example: 1.31.3.6868-28fc46b27 productVersion:
platform: type: string
type: string example: 1.31.3.6868-28fc46b27
example: Linux platform:
platformVersion: type: string
type: string example: Linux
example: '5.19.17-Unraid (#2 SMP PREEMPT_DYNAMIC Wed Nov 2 11:54:15 PDT 2022)' platformVersion:
device: type: string
type: string example: '5.19.17-Unraid (#2 SMP PREEMPT_DYNAMIC Wed Nov 2 11:54:15 PDT 2022)'
example: PC device:
clientIdentifier: type: string
type: string example: PC
example: 96f2fe7a78c9dc1f16a16bedbe90f98149be16b4 clientIdentifier:
createdAt: type: string
type: string example: 96f2fe7a78c9dc1f16a16bedbe90f98149be16b4
format: date-time createdAt:
example: 2022-06-02T00:54:26.000Z type: string
lastSeenAt: format: date-time
type: string example: 2022-06-02T00:54:26.000Z
format: date-time lastSeenAt:
example: 2023-04-11T05:53:59.000Z type: string
provides: format: date-time
type: string example: 2023-04-11T05:53:59.000Z
example: server provides:
ownerId: type: string
type: string example: server
format: nullable ownerId:
sourceTitle: type: string
type: string format: nullable
format: nullable sourceTitle:
publicAddress: type: string
type: string format: nullable
example: 68.248.140.20 publicAddress:
accessToken: type: string
type: string example: 68.248.140.20
example: CR3nxzsaSHdWx_WwZsJL accessToken:
owned: type: string
type: boolean example: CR3nxzsaSHdWx_WwZsJL
home: owned:
type: boolean type: boolean
synced: home:
type: boolean type: boolean
relay: synced:
type: boolean type: boolean
presence: relay:
type: boolean type: boolean
httpsRequired: presence:
type: boolean type: boolean
publicAddressMatches: httpsRequired:
type: boolean type: boolean
dnsRebindingProtection: publicAddressMatches:
type: boolean type: boolean
natLoopbackSupported: dnsRebindingProtection:
type: boolean type: boolean
connections: natLoopbackSupported:
type: array type: boolean
items: connections:
type: object type: array
properties: items:
protocol: type: object
type: string properties:
example: http protocol:
address: type: string
type: string example: http
example: 172.18.0.1 address:
port: type: string
type: number example: 172.18.0.1
example: 32400 port:
uri: type: number
type: string example: 32400
example: 'http://172.18.0.1:32400' uri:
local: type: string
type: boolean example: 'http://172.18.0.1:32400'
relay: local:
type: boolean type: boolean
IPv6: relay:
type: boolean type: boolean
IPv6:
type: boolean
'401': '401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query. description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
content: content: