Separated Params

This commit is contained in:
Luke Hagar
2023-04-12 09:13:30 -05:00
parent b4e4965cf1
commit c4a8bb06c9
12 changed files with 95 additions and 81 deletions

View File

@@ -0,0 +1,6 @@
- in: header
name: X-Plex-Client-Identifier
description: UUID, serial number, or other number unique per device
schema:
type: string
required: true

View File

@@ -0,0 +1,7 @@
- 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

View File

@@ -0,0 +1,10 @@
- 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

View File

@@ -0,0 +1,10 @@
- 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

View File

@@ -0,0 +1,11 @@
- 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

View File

@@ -0,0 +1,10 @@
- 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

View File

@@ -0,0 +1,11 @@
- in: header
name: X-Plex-Provides
description: One or more of [player, controller, server]
schema:
type: string
example:
- iOS
- MacOSX
- Android
- LG
required: false

View File

@@ -0,0 +1,6 @@
- in: header
name: X-Plex-Version
description: Plex application version number
schema:
type: string
required: false

View File

@@ -1,78 +0,0 @@
- 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

View File

@@ -5,7 +5,14 @@ get:
description: Get Available Clients
operationId: getAvailableClients
parameters:
$ref: "../parameters/clientDetails.yaml"
- $ref: "../parameters/X-Plex-Client-Identifier.yaml"
- $ref: "../parameters/X-Plex-Device-Name.yaml"
- $ref: "../parameters/X-Plex-Device.yaml"
- $ref: "../parameters/X-Plex-Platform-Version.yaml"
- $ref: "../parameters/X-Plex-Platform.yaml"
- $ref: "../parameters/X-Plex-Product.yaml"
- $ref: "../parameters/X-Plex-Provides.yaml"
- $ref: "../parameters/X-Plex-Version.yaml"
responses:
"200":
description: Available Clients

View File

@@ -5,7 +5,14 @@ get:
description: Get Devices
operationId: getDevices
parameters:
$ref: "../parameters/clientDetails.yaml"
- $ref: "../parameters/X-Plex-Client-Identifier.yaml"
- $ref: "../parameters/X-Plex-Device-Name.yaml"
- $ref: "../parameters/X-Plex-Device.yaml"
- $ref: "../parameters/X-Plex-Platform-Version.yaml"
- $ref: "../parameters/X-Plex-Platform.yaml"
- $ref: "../parameters/X-Plex-Product.yaml"
- $ref: "../parameters/X-Plex-Provides.yaml"
- $ref: "../parameters/X-Plex-Version.yaml"
responses:
"200":
description: List of Plex Devices

View File

@@ -5,7 +5,14 @@ get:
description: Get Logged in User
operationId: getCurrentUserDetails
parameters:
$ref: "../parameters/clientDetails.yaml"
- $ref: "../parameters/X-Plex-Client-Identifier.yaml"
- $ref: "../parameters/X-Plex-Device-Name.yaml"
- $ref: "../parameters/X-Plex-Device.yaml"
- $ref: "../parameters/X-Plex-Platform-Version.yaml"
- $ref: "../parameters/X-Plex-Platform.yaml"
- $ref: "../parameters/X-Plex-Product.yaml"
- $ref: "../parameters/X-Plex-Provides.yaml"
- $ref: "../parameters/X-Plex-Version.yaml"
responses:
"200":
description: Logged in user details