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:14:19 +00:00
parent 1a90982035
commit 4b28482d57
1 changed files with 213 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -40,7 +40,40 @@ paths:
description: Get Available Clients description: Get Available Clients
operationId: getAvailableClients operationId: getAvailableClients
parameters: parameters:
- in: header - - in: header
name: X-Plex-Client-Identifier
description: 'UUID, serial number, or other number unique per device'
schema:
type: string
required: true
- - in: header
name: X-Plex-Device-Name
description: Primary name for the device eg. `Plex Web (Chrome)`
schema:
type: string
example: Plex Web (Chrome)
required: false
- - in: header
name: X-Plex-Device
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
schema:
type: string
example:
- 'iPhone3,2'
- Motorola XOOM™
- LG5200TV
required: false
- - in: header
name: X-Plex-Platform-Version
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2'
schema:
type: string
example:
- 4.3.1
- 10.6.7
- 3.2
required: false
- - 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, etc'
schema: schema:
@@ -51,17 +84,17 @@ paths:
- Android - Android
- LG - LG
required: false required: false
- in: header - - in: header
name: X-Plex-Platform-Version name: X-Plex-Product
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2' description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
schema: schema:
type: string type: string
example: example:
- 4.3.1 - Laika
- 10.6.7 - Plex Media Server
- 3.2 - Media Link
required: false required: false
- in: header - - in: header
name: X-Plex-Provides name: X-Plex-Provides
description: 'One or more of [player, controller, server]' description: 'One or more of [player, controller, server]'
schema: schema:
@@ -72,45 +105,12 @@ paths:
- Android - Android
- LG - LG
required: false required: false
- in: header - - in: header
name: X-Plex-Client-Identifier
description: 'UUID, serial number, or other number unique per device'
schema:
type: string
required: true
- in: header
name: X-Plex-Product
description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
schema:
type: string
example:
- Laika
- Plex Media Server
- Media Link
required: false
- in: header
name: X-Plex-Version name: X-Plex-Version
description: Plex application version number description: Plex application version number
schema: schema:
type: string type: string
required: false required: false
- in: header
name: X-Plex-Device
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
schema:
type: string
example:
- 'iPhone3,2'
- Motorola XOOM™
- LG5200TV
required: false
- in: header
name: X-Plex-Device-Name
description: Primary name for the device eg. `Plex Web (Chrome)`
schema:
type: string
example: Plex Web (Chrome)
required: false
responses: responses:
'200': '200':
description: Available Clients description: Available Clients
@@ -2017,7 +2017,40 @@ paths:
description: Get Logged in User description: Get Logged in User
operationId: getCurrentUserDetails operationId: getCurrentUserDetails
parameters: parameters:
- in: header - - in: header
name: X-Plex-Client-Identifier
description: 'UUID, serial number, or other number unique per device'
schema:
type: string
required: true
- - in: header
name: X-Plex-Device-Name
description: Primary name for the device eg. `Plex Web (Chrome)`
schema:
type: string
example: Plex Web (Chrome)
required: false
- - in: header
name: X-Plex-Device
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
schema:
type: string
example:
- 'iPhone3,2'
- Motorola XOOM™
- LG5200TV
required: false
- - in: header
name: X-Plex-Platform-Version
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2'
schema:
type: string
example:
- 4.3.1
- 10.6.7
- 3.2
required: false
- - 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, etc'
schema: schema:
@@ -2028,17 +2061,17 @@ paths:
- Android - Android
- LG - LG
required: false required: false
- in: header - - in: header
name: X-Plex-Platform-Version name: X-Plex-Product
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2' description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
schema: schema:
type: string type: string
example: example:
- 4.3.1 - Laika
- 10.6.7 - Plex Media Server
- 3.2 - Media Link
required: false required: false
- in: header - - in: header
name: X-Plex-Provides name: X-Plex-Provides
description: 'One or more of [player, controller, server]' description: 'One or more of [player, controller, server]'
schema: schema:
@@ -2049,45 +2082,12 @@ paths:
- Android - Android
- LG - LG
required: false required: false
- in: header - - in: header
name: X-Plex-Client-Identifier
description: 'UUID, serial number, or other number unique per device'
schema:
type: string
required: true
- in: header
name: X-Plex-Product
description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
schema:
type: string
example:
- Laika
- Plex Media Server
- Media Link
required: false
- in: header
name: X-Plex-Version name: X-Plex-Version
description: Plex application version number description: Plex application version number
schema: schema:
type: string type: string
required: false required: false
- in: header
name: X-Plex-Device
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
schema:
type: string
example:
- 'iPhone3,2'
- Motorola XOOM™
- LG5200TV
required: false
- in: header
name: X-Plex-Device-Name
description: Primary name for the device eg. `Plex Web (Chrome)`
schema:
type: string
example: Plex Web (Chrome)
required: false
responses: responses:
'200': '200':
description: Logged in user details description: Logged in user details
@@ -2122,7 +2122,40 @@ paths:
description: Get Devices description: Get Devices
operationId: getDevices operationId: getDevices
parameters: parameters:
- in: header - - in: header
name: X-Plex-Client-Identifier
description: 'UUID, serial number, or other number unique per device'
schema:
type: string
required: true
- - in: header
name: X-Plex-Device-Name
description: Primary name for the device eg. `Plex Web (Chrome)`
schema:
type: string
example: Plex Web (Chrome)
required: false
- - in: header
name: X-Plex-Device
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
schema:
type: string
example:
- 'iPhone3,2'
- Motorola XOOM™
- LG5200TV
required: false
- - in: header
name: X-Plex-Platform-Version
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2'
schema:
type: string
example:
- 4.3.1
- 10.6.7
- 3.2
required: false
- - 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, etc'
schema: schema:
@@ -2133,17 +2166,17 @@ paths:
- Android - Android
- LG - LG
required: false required: false
- in: header - - in: header
name: X-Plex-Platform-Version name: X-Plex-Product
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2' description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
schema: schema:
type: string type: string
example: example:
- 4.3.1 - Laika
- 10.6.7 - Plex Media Server
- 3.2 - Media Link
required: false required: false
- in: header - - in: header
name: X-Plex-Provides name: X-Plex-Provides
description: 'One or more of [player, controller, server]' description: 'One or more of [player, controller, server]'
schema: schema:
@@ -2154,45 +2187,12 @@ paths:
- Android - Android
- LG - LG
required: false required: false
- in: header - - in: header
name: X-Plex-Client-Identifier
description: 'UUID, serial number, or other number unique per device'
schema:
type: string
required: true
- in: header
name: X-Plex-Product
description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
schema:
type: string
example:
- Laika
- Plex Media Server
- Media Link
required: false
- in: header
name: X-Plex-Version name: X-Plex-Version
description: Plex application version number description: Plex application version number
schema: schema:
type: string type: string
required: false required: false
- in: header
name: X-Plex-Device
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
schema:
type: string
example:
- 'iPhone3,2'
- Motorola XOOM™
- LG5200TV
required: false
- in: header
name: X-Plex-Device-Name
description: Primary name for the device eg. `Plex Web (Chrome)`
schema:
type: string
example: Plex Web (Chrome)
required: false
responses: responses:
'200': '200':
description: List of Plex Devices description: List of Plex Devices