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:17:51 +00:00
parent 4b28482d57
commit 4b03d7674d
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-Client-Identifier name: X-Plex-Client-Identifier
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
required: true required: true
- - in: header - in: header
name: X-Plex-Device-Name name: X-Plex-Device-Name
description: Primary name for the device eg. `Plex Web (Chrome)` description: Primary name for the device eg. `Plex Web (Chrome)`
schema: schema:
type: string type: string
example: Plex Web (Chrome) example: Plex Web (Chrome)
required: false required: false
- - in: header - in: header
name: X-Plex-Device name: X-Plex-Device
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV' description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
schema: schema:
type: string type: string
example: example:
- 'iPhone3,2' - 'iPhone3,2'
- Motorola XOOM™ - Motorola XOOM™
- LG5200TV - LG5200TV
required: false required: false
- - in: header - in: header
name: X-Plex-Platform-Version name: X-Plex-Platform-Version
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2' description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2'
schema: schema:
type: string type: string
example: example:
- 4.3.1 - 4.3.1
- 10.6.7 - 10.6.7
- 3.2 - 3.2
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, etc'
schema: schema:
type: string type: string
example: example:
- iOS - iOS
- MacOSX - MacOSX
- Android - Android
- LG - LG
required: false required: false
- - in: header - in: header
name: X-Plex-Product name: X-Plex-Product
description: 'Plex application name, eg Laika, Plex Media Server, Media Link' description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
schema: schema:
type: string type: string
example: example:
- Laika - Laika
- Plex Media Server - Plex Media Server
- Media Link - 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:
type: string type: string
example: example:
- iOS - iOS
- MacOSX - MacOSX
- Android - Android
- LG - LG
required: false required: false
- - in: header - 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
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-Client-Identifier name: X-Plex-Client-Identifier
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
required: true required: true
- - in: header - in: header
name: X-Plex-Device-Name name: X-Plex-Device-Name
description: Primary name for the device eg. `Plex Web (Chrome)` description: Primary name for the device eg. `Plex Web (Chrome)`
schema: schema:
type: string type: string
example: Plex Web (Chrome) example: Plex Web (Chrome)
required: false required: false
- - in: header - in: header
name: X-Plex-Device name: X-Plex-Device
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV' description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
schema: schema:
type: string type: string
example: example:
- 'iPhone3,2' - 'iPhone3,2'
- Motorola XOOM™ - Motorola XOOM™
- LG5200TV - LG5200TV
required: false required: false
- - in: header - in: header
name: X-Plex-Platform-Version name: X-Plex-Platform-Version
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2' description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2'
schema: schema:
type: string type: string
example: example:
- 4.3.1 - 4.3.1
- 10.6.7 - 10.6.7
- 3.2 - 3.2
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, etc'
schema: schema:
type: string type: string
example: example:
- iOS - iOS
- MacOSX - MacOSX
- Android - Android
- LG - LG
required: false required: false
- - in: header - in: header
name: X-Plex-Product name: X-Plex-Product
description: 'Plex application name, eg Laika, Plex Media Server, Media Link' description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
schema: schema:
type: string type: string
example: example:
- Laika - Laika
- Plex Media Server - Plex Media Server
- Media Link - 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:
type: string type: string
example: example:
- iOS - iOS
- MacOSX - MacOSX
- Android - Android
- LG - LG
required: false required: false
- - in: header - 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
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-Client-Identifier name: X-Plex-Client-Identifier
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
required: true required: true
- - in: header - in: header
name: X-Plex-Device-Name name: X-Plex-Device-Name
description: Primary name for the device eg. `Plex Web (Chrome)` description: Primary name for the device eg. `Plex Web (Chrome)`
schema: schema:
type: string type: string
example: Plex Web (Chrome) example: Plex Web (Chrome)
required: false required: false
- - in: header - in: header
name: X-Plex-Device name: X-Plex-Device
description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV' description: 'Device name and model number, eg iPhone3,2, Motorola XOOM™, LG5200TV'
schema: schema:
type: string type: string
example: example:
- 'iPhone3,2' - 'iPhone3,2'
- Motorola XOOM™ - Motorola XOOM™
- LG5200TV - LG5200TV
required: false required: false
- - in: header - in: header
name: X-Plex-Platform-Version name: X-Plex-Platform-Version
description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2' description: 'Operating system version, eg 4.3.1, 10.6.7, 3.2'
schema: schema:
type: string type: string
example: example:
- 4.3.1 - 4.3.1
- 10.6.7 - 10.6.7
- 3.2 - 3.2
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, etc'
schema: schema:
type: string type: string
example: example:
- iOS - iOS
- MacOSX - MacOSX
- Android - Android
- LG - LG
required: false required: false
- - in: header - in: header
name: X-Plex-Product name: X-Plex-Product
description: 'Plex application name, eg Laika, Plex Media Server, Media Link' description: 'Plex application name, eg Laika, Plex Media Server, Media Link'
schema: schema:
type: string type: string
example: example:
- Laika - Laika
- Plex Media Server - Plex Media Server
- Media Link - 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:
type: string type: string
example: example:
- iOS - iOS
- MacOSX - MacOSX
- Android - Android
- LG - LG
required: false required: false
- - in: header - 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
responses: responses:
'200': '200':
description: List of Plex Devices description: List of Plex Devices