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

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

@@ -40,77 +40,77 @@ paths:
description: Get Available Clients description: Get Available Clients
operationId: getAvailableClients operationId: getAvailableClients
parameters: parameters:
- in: header - - in: header
name: X-Plex-Platform name: X-Plex-Client-Identifier
description: 'Platform name, eg iOS, MacOSX, Android, LG, etc' description: 'UUID, serial number, or other number unique per device'
schema: schema:
type: string type: string
example: required: true
- iOS - - in: header
- MacOSX name: X-Plex-Device-Name
- Android description: Primary name for the device eg. `Plex Web (Chrome)`
- LG schema:
required: false type: string
- in: header example: Plex Web (Chrome)
name: X-Plex-Platform-Version required: false
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2' - - in: header
schema: name: X-Plex-Device
type: string description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
example: schema:
- 4.3.1 type: string
- 10.6.7 example:
- 3.2 - 'iPhone3,2'
required: false - Motorola XOOM™
- in: header - LG5200TV
name: X-Plex-Provides required: false
description: 'One or more of [player, controller, server]' - - in: header
schema: name: X-Plex-Platform-Version
type: string description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2'
example: schema:
- iOS type: string
- MacOSX example:
- Android - 4.3.1
- LG - 10.6.7
required: false - 3.2
- in: header required: false
name: X-Plex-Client-Identifier - - in: header
description: 'UUID, serial number, or other number unique per device' name: X-Plex-Platform
schema: description: 'Platform name, eg iOS, MacOSX, Android, LG, etc'
type: string schema:
required: true type: string
- in: header example:
name: X-Plex-Product - iOS
description: 'Plex application name, eg Laika, Plex Media Server, Media Link' - MacOSX
schema: - Android
type: string - LG
example: required: false
- Laika - - in: header
- Plex Media Server name: X-Plex-Product
- Media Link description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
required: false schema:
- in: header type: string
name: X-Plex-Version example:
description: Plex application version number - Laika
schema: - Plex Media Server
type: string - Media Link
required: false required: false
- in: header - - in: header
name: X-Plex-Device name: X-Plex-Provides
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV' description: 'One or more of [player, controller, server]'
schema: schema:
type: string type: string
example: example:
- 'iPhone3,2' - iOS
- Motorola XOOM™ - MacOSX
- LG5200TV - Android
required: false - LG
- in: header required: false
name: X-Plex-Device-Name - - in: header
description: Primary name for the device eg. `Plex Web (Chrome)` name: X-Plex-Version
schema: description: Plex application version number
type: string schema:
example: Plex Web (Chrome) type: string
required: false required: false
responses: responses:
'200': '200':
description: Available Clients description: Available Clients
@@ -2017,77 +2017,77 @@ paths:
description: Get Logged in User description: Get Logged in User
operationId: getCurrentUserDetails operationId: getCurrentUserDetails
parameters: parameters:
- in: header - - in: header
name: X-Plex-Platform name: X-Plex-Client-Identifier
description: 'Platform name, eg iOS, MacOSX, Android, LG, etc' description: 'UUID, serial number, or other number unique per device'
schema: schema:
type: string type: string
example: required: true
- iOS - - in: header
- MacOSX name: X-Plex-Device-Name
- Android description: Primary name for the device eg. `Plex Web (Chrome)`
- LG schema:
required: false type: string
- in: header example: Plex Web (Chrome)
name: X-Plex-Platform-Version required: false
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2' - - in: header
schema: name: X-Plex-Device
type: string description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
example: schema:
- 4.3.1 type: string
- 10.6.7 example:
- 3.2 - 'iPhone3,2'
required: false - Motorola XOOM™
- in: header - LG5200TV
name: X-Plex-Provides required: false
description: 'One or more of [player, controller, server]' - - in: header
schema: name: X-Plex-Platform-Version
type: string description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2'
example: schema:
- iOS type: string
- MacOSX example:
- Android - 4.3.1
- LG - 10.6.7
required: false - 3.2
- in: header required: false
name: X-Plex-Client-Identifier - - in: header
description: 'UUID, serial number, or other number unique per device' name: X-Plex-Platform
schema: description: 'Platform name, eg iOS, MacOSX, Android, LG, etc'
type: string schema:
required: true type: string
- in: header example:
name: X-Plex-Product - iOS
description: 'Plex application name, eg Laika, Plex Media Server, Media Link' - MacOSX
schema: - Android
type: string - LG
example: required: false
- Laika - - in: header
- Plex Media Server name: X-Plex-Product
- Media Link description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
required: false schema:
- in: header type: string
name: X-Plex-Version example:
description: Plex application version number - Laika
schema: - Plex Media Server
type: string - Media Link
required: false required: false
- in: header - - in: header
name: X-Plex-Device name: X-Plex-Provides
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV' description: 'One or more of [player, controller, server]'
schema: schema:
type: string type: string
example: example:
- 'iPhone3,2' - iOS
- Motorola XOOM™ - MacOSX
- LG5200TV - Android
required: false - LG
- in: header required: false
name: X-Plex-Device-Name - - in: header
description: Primary name for the device eg. `Plex Web (Chrome)` name: X-Plex-Version
schema: description: Plex application version number
type: string schema:
example: Plex Web (Chrome) type: string
required: false required: false
responses: responses:
'200': '200':
description: Logged in user details description: Logged in user details
@@ -2122,77 +2122,77 @@ paths:
description: Get Devices description: Get Devices
operationId: getDevices operationId: getDevices
parameters: parameters:
- in: header - - in: header
name: X-Plex-Platform name: X-Plex-Client-Identifier
description: 'Platform name, eg iOS, MacOSX, Android, LG, etc' description: 'UUID, serial number, or other number unique per device'
schema: schema:
type: string type: string
example: required: true
- iOS - - in: header
- MacOSX name: X-Plex-Device-Name
- Android description: Primary name for the device eg. `Plex Web (Chrome)`
- LG schema:
required: false type: string
- in: header example: Plex Web (Chrome)
name: X-Plex-Platform-Version required: false
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2' - - in: header
schema: name: X-Plex-Device
type: string description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
example: schema:
- 4.3.1 type: string
- 10.6.7 example:
- 3.2 - 'iPhone3,2'
required: false - Motorola XOOM™
- in: header - LG5200TV
name: X-Plex-Provides required: false
description: 'One or more of [player, controller, server]' - - in: header
schema: name: X-Plex-Platform-Version
type: string description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2'
example: schema:
- iOS type: string
- MacOSX example:
- Android - 4.3.1
- LG - 10.6.7
required: false - 3.2
- in: header required: false
name: X-Plex-Client-Identifier - - in: header
description: 'UUID, serial number, or other number unique per device' name: X-Plex-Platform
schema: description: 'Platform name, eg iOS, MacOSX, Android, LG, etc'
type: string schema:
required: true type: string
- in: header example:
name: X-Plex-Product - iOS
description: 'Plex application name, eg Laika, Plex Media Server, Media Link' - MacOSX
schema: - Android
type: string - LG
example: required: false
- Laika - - in: header
- Plex Media Server name: X-Plex-Product
- Media Link description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
required: false schema:
- in: header type: string
name: X-Plex-Version example:
description: Plex application version number - Laika
schema: - Plex Media Server
type: string - Media Link
required: false required: false
- in: header - - in: header
name: X-Plex-Device name: X-Plex-Provides
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV' description: 'One or more of [player, controller, server]'
schema: schema:
type: string type: string
example: example:
- 'iPhone3,2' - iOS
- Motorola XOOM™ - MacOSX
- LG5200TV - Android
required: false - LG
- in: header required: false
name: X-Plex-Device-Name - - in: header
description: Primary name for the device eg. `Plex Web (Chrome)` name: X-Plex-Version
schema: description: Plex application version number
type: string schema:
example: Plex Web (Chrome) type: string
required: false required: false
responses: responses:
'200': '200':
description: List of Plex Devices description: List of Plex Devices