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:01:00 +00:00
parent a9cf4f193e
commit 1a90982035
1 changed files with 151 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -50,7 +50,7 @@ paths:
- MacOSX - MacOSX
- Android - Android
- LG - LG
required: true 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'
@@ -60,7 +60,7 @@ paths:
- 4.3.1 - 4.3.1
- 10.6.7 - 10.6.7
- 3.2 - 3.2
required: true 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]'
@@ -71,7 +71,7 @@ paths:
- MacOSX - MacOSX
- Android - Android
- LG - LG
required: true required: false
- 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'
@@ -87,13 +87,13 @@ paths:
- Laika - Laika
- Plex Media Server - Plex Media Server
- Media Link - Media Link
required: true 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: true 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'
@@ -103,14 +103,14 @@ paths:
- 'iPhone3,2' - 'iPhone3,2'
- Motorola XOOM™ - Motorola XOOM™
- LG5200TV - LG5200TV
required: true required: false
- 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: true required: false
responses: responses:
'200': '200':
description: Available Clients description: Available Clients
@@ -2016,6 +2016,78 @@ paths:
summary: Get Logged in User summary: Get Logged in User
description: Get Logged in User description: Get Logged in User
operationId: getCurrentUserDetails operationId: getCurrentUserDetails
parameters:
- in: header
name: X-Plex-Platform
description: 'Platform name, eg iOS, MacOSX, Android, LG, etc'
schema:
type: string
example:
- iOS
- MacOSX
- Android
- LG
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-Provides
description: 'One or more of [player, controller, server]'
schema:
type: string
example:
- iOS
- MacOSX
- Android
- LG
required: false
- 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
description: Plex application version number
schema:
type: string
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
@@ -2049,6 +2121,78 @@ paths:
summary: Get Devices summary: Get Devices
description: Get Devices description: Get Devices
operationId: getDevices operationId: getDevices
parameters:
- in: header
name: X-Plex-Platform
description: 'Platform name, eg iOS, MacOSX, Android, LG, etc'
schema:
type: string
example:
- iOS
- MacOSX
- Android
- LG
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-Provides
description: 'One or more of [player, controller, server]'
schema:
type: string
example:
- iOS
- MacOSX
- Android
- LG
required: false
- 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
description: Plex application version number
schema:
type: string
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