Adjusted Required Parameters, Populated Global Parameters on all endpointss

This commit is contained in:
Luke Hagar
2023-04-13 20:03:56 -05:00
parent b7bf5cae2e
commit 819ae4c404
38 changed files with 286 additions and 7 deletions

View File

@@ -11,7 +11,6 @@ get:
schema: schema:
type: string type: string
required: true required: true
- $ref: "../../parameters/X-Plex-Client-Identifier.yaml"
- $ref: "../../parameters/X-Plex-Device-Name.yaml" - $ref: "../../parameters/X-Plex-Device-Name.yaml"
- $ref: "../../parameters/X-Plex-Device.yaml" - $ref: "../../parameters/X-Plex-Device.yaml"
- $ref: "../../parameters/X-Plex-Platform-Version.yaml" - $ref: "../../parameters/X-Plex-Platform-Version.yaml"

View File

@@ -16,7 +16,6 @@ post:
type: boolean type: boolean
default: false default: false
required: false required: false
- $ref: "../../parameters/X-Plex-Client-Identifier.yaml"
- $ref: "../../parameters/X-Plex-Device-Name.yaml" - $ref: "../../parameters/X-Plex-Device-Name.yaml"
- $ref: "../../parameters/X-Plex-Device.yaml" - $ref: "../../parameters/X-Plex-Device.yaml"
- $ref: "../../parameters/X-Plex-Platform-Version.yaml" - $ref: "../../parameters/X-Plex-Platform-Version.yaml"

View File

@@ -5,7 +5,6 @@ get:
description: Get Devices description: Get Devices
operationId: getDevices operationId: getDevices
parameters: parameters:
- $ref: "../../parameters/X-Plex-Client-Identifier.yaml"
- $ref: "../../parameters/X-Plex-Device-Name.yaml" - $ref: "../../parameters/X-Plex-Device-Name.yaml"
- $ref: "../../parameters/X-Plex-Device.yaml" - $ref: "../../parameters/X-Plex-Device.yaml"
- $ref: "../../parameters/X-Plex-Platform-Version.yaml" - $ref: "../../parameters/X-Plex-Platform-Version.yaml"

View File

@@ -5,7 +5,6 @@ get:
description: Get Logged in User description: Get Logged in User
operationId: getCurrentUserDetails operationId: getCurrentUserDetails
parameters: parameters:
- $ref: "../../parameters/X-Plex-Client-Identifier.yaml"
- $ref: "../../parameters/X-Plex-Device-Name.yaml" - $ref: "../../parameters/X-Plex-Device-Name.yaml"
- $ref: "../../parameters/X-Plex-Device.yaml" - $ref: "../../parameters/X-Plex-Device.yaml"
- $ref: "../../parameters/X-Plex-Platform-Version.yaml" - $ref: "../../parameters/X-Plex-Platform-Version.yaml"

View File

@@ -12,6 +12,13 @@ delete:
type: string type: string
example: 25b71ed5-0f9d-461c-baa7-d404e9e10d3e example: 25b71ed5-0f9d-461c-baa7-d404e9e10d3e
required: true required: true
- $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: responses:
"200": "200":
description: The Server Activity was canceled description: The Server Activity was canceled

View File

@@ -1,9 +1,17 @@
get: get:
tags: tags:
- Activities - Activities
summary: Server Activities summary: Get Server Activities
description: Server Activities description: Get Server Activities
operationId: getServerActivities operationId: getServerActivities
parameters:
- $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: responses:
"200": "200":
description: The Server Activities description: The Server Activities

View File

@@ -3,6 +3,14 @@ get:
- Library - Library
summary: Get All Libraries summary: Get All Libraries
operationId: getLibraries operationId: getLibraries
parameters:
- $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"
description: | description: |
A library section (commonly referred to as just a library) is a collection of media. A library section (commonly referred to as just a library) is a collection of media.
Libraries are typed, and depending on their type provide either a flat or a hierarchical view of the media. Libraries are typed, and depending on their type provide either a flat or a hierarchical view of the media.

View File

@@ -24,6 +24,13 @@ get:
- 0 - 0
- 1 - 1
required: false required: false
- $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: responses:
"200": "200":
description: returns all playlists description: returns all playlists

View File

@@ -31,6 +31,13 @@ post:
- RefreshPeriodicMetadata - RefreshPeriodicMetadata
- UpgradeMediaAnalysis - UpgradeMediaAnalysis
required: true required: true
- $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: responses:
"200": "200":
description: The task was started successfully description: The task was started successfully
@@ -68,6 +75,13 @@ delete:
- RefreshPeriodicMetadata - RefreshPeriodicMetadata
- UpgradeMediaAnalysis - UpgradeMediaAnalysis
required: true required: true
- $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: responses:
"200": "200":
description: The task was stopped description: The task was stopped

View File

@@ -9,6 +9,14 @@ post:
3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window. 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
4. If we are outside the configured window, the task will start immediately. 4. If we are outside the configured window, the task will start immediately.
operationId: startAllTasks operationId: startAllTasks
parameters:
- $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: responses:
"200": "200":
description: All tasks were started description: All tasks were started

View File

@@ -4,6 +4,14 @@ get:
summary: Get Available Clients summary: Get Available Clients
description: Get Available Clients description: Get Available Clients
operationId: getAvailableClients operationId: getAvailableClients
parameters:
- $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: responses:
"200": "200":
description: Available Clients description: Available Clients

View File

@@ -31,6 +31,13 @@ get:
example: 5 example: 5
default: 3 default: 3
required: false required: false
- $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: responses:
"200": "200":
description: The search results description: The search results

View File

@@ -39,6 +39,13 @@ get:
type: number type: number
example: 5 example: 5
default: 3 default: 3
- $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: responses:
"200": "200":
description: The search results description: The search results

View File

@@ -27,6 +27,13 @@ get:
- 0 - 0
- 1 - 1
required: false required: false
- $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: responses:
"200": "200":
description: The hubs specific to the library description: The hubs specific to the library

View File

@@ -20,6 +20,13 @@ get:
- 0 - 0
- 1 - 1
required: false required: false
- $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: responses:
"200": "200":
description: returns global hubs description: returns global hubs

View File

@@ -24,6 +24,13 @@ get:
schema: schema:
type: string type: string
required: false required: false
- $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: responses:
"200": "200":
description: The details of the library description: The details of the library

View File

@@ -24,6 +24,13 @@ get:
schema: schema:
type: string type: string
required: false required: false
- $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: responses:
"200": "200":
description: The details of the library description: The details of the library

View File

@@ -24,6 +24,13 @@ get:
schema: schema:
type: string type: string
required: false required: false
- $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: responses:
"200": "200":
description: The details of the library description: The details of the library

View File

@@ -43,6 +43,13 @@ get:
- 1 - 1
default: 0 default: 0
required: false required: false
- $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: responses:
"200": "200":
description: The details of the library description: The details of the library

View File

@@ -18,6 +18,13 @@ get:
schema: schema:
type: number type: number
required: false required: false
- $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: responses:
"200": "200":
description: The hash of the file description: The hash of the file

View File

@@ -5,6 +5,14 @@ get:
description: | description: |
This endpoint will return the on deck content. This endpoint will return the on deck content.
operationId: getOnDeck operationId: getOnDeck
parameters:
- $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: responses:
"200": "200":
description: The on deck content description: The on deck content

View File

@@ -12,6 +12,13 @@ get:
schema: schema:
type: number type: number
required: true required: true
- $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: responses:
"200": "200":
description: The library is refreshing description: The library is refreshing

View File

@@ -5,6 +5,14 @@ get:
description: | description: |
This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time. This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time.
operationId: enablePaperTrail operationId: enablePaperTrail
parameters:
- $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: responses:
"200": "200":
description: Papertrail enabled successfully description: Papertrail enabled successfully

View File

@@ -38,6 +38,13 @@ get:
type: string type: string
example: "" example: ""
required: true required: true
- $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: responses:
"200": "200":
description: Log Line submitted successfully description: Log Line submitted successfully
@@ -51,6 +58,14 @@ post:
description: | description: |
This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above.
operationId: logMultiLine operationId: logMultiLine
parameters:
- $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: responses:
"200": "200":
description: Multi-Line Log Message Posted successfully description: Multi-Line Log Message Posted successfully

View File

@@ -21,6 +21,13 @@ get:
schema: schema:
type: number type: number
required: true required: true
- $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: responses:
"200": "200":
description: The playlist contents description: The playlist contents
@@ -41,6 +48,13 @@ delete:
schema: schema:
type: number type: number
required: true required: true
- $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: responses:
"200": "200":
description: The playlist contents are cleared description: The playlist contents are cleared
@@ -76,6 +90,13 @@ put:
type: number type: number
example: 123 example: 123
required: true required: true
- $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: responses:
"200": "200":
description: Playlist Updated description: Playlist Updated

View File

@@ -13,6 +13,13 @@ get:
schema: schema:
type: number type: number
required: true required: true
- $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: responses:
"200": "200":
description: The playlist description: The playlist
@@ -33,6 +40,13 @@ delete:
schema: schema:
type: number type: number
required: true required: true
- $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: responses:
"200": "200":
description: The playlist is deleted description: The playlist is deleted

View File

@@ -30,6 +30,13 @@ post:
- 0 - 0
- 1 - 1
required: true required: true
- $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: responses:
"200": "200":
description: The playlist is uploaded description: The playlist is uploaded

View File

@@ -45,6 +45,13 @@ post:
schema: schema:
type: number type: number
required: false required: false
- $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: responses:
"200": "200":
description: returns all playlists description: returns all playlists

View File

@@ -4,6 +4,14 @@ get:
summary: Server Capabilities summary: Server Capabilities
description: Server Capabilities description: Server Capabilities
operationId: getServerCapabilities operationId: getServerCapabilities
parameters:
- $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: responses:
"200": "200":
description: The Server Capabilities description: The Server Capabilities

View File

@@ -16,6 +16,13 @@ get:
- server://client-identifier - server://client-identifier
- provider://provider-identifier - provider://provider-identifier
required: true required: true
- $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: responses:
"200": "200":
description: Source Connection Information description: Source Connection Information

View File

@@ -22,6 +22,13 @@ get:
enum: enum:
- all - all
required: true required: true
- $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: responses:
"200": "200":
description: A Transient Token description: A Transient Token

View File

@@ -4,6 +4,14 @@ get:
summary: Get Server Preferences summary: Get Server Preferences
description: Get Server Preferences description: Get Server Preferences
operationId: getServerPreferences operationId: getServerPreferences
parameters:
- $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: responses:
"200": "200":
description: Server Preferences description: Server Preferences

View File

@@ -4,6 +4,14 @@ get:
summary: Get Session History summary: Get Session History
description: This will Retrieve a listing of all history views. description: This will Retrieve a listing of all history views.
operationId: getSessionHistory operationId: getSessionHistory
parameters:
- $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: responses:
"200": "200":
description: List of Plex Sessions description: List of Plex Sessions

View File

@@ -4,6 +4,14 @@ get:
summary: Get Active Sessions summary: Get Active Sessions
description: This will retrieve the "Now Playing" Information of the PMS. description: This will retrieve the "Now Playing" Information of the PMS.
operationId: getSessions operationId: getSessions
parameters:
- $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: responses:
"200": "200":
description: List of Active Plex Sessions description: List of Active Plex Sessions

View File

@@ -24,6 +24,13 @@ put:
- 0 - 0
- 1 - 1
example: 1 example: 1
- $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: responses:
"200": "200":
description: If the update process started correctly description: If the update process started correctly

View File

@@ -14,6 +14,13 @@ put:
- 0 - 0
- 1 - 1
example: 1 example: 1
- $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: responses:
"200": "200":
description: "" description: ""

View File

@@ -4,6 +4,14 @@ get:
summary: Querying status of updates summary: Querying status of updates
description: Querying status of updates description: Querying status of updates
operationId: queryUpdateStatus operationId: queryUpdateStatus
parameters:
- $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: responses:
"200": "200":
description: The Server Updates description: The Server Updates

View File

@@ -31,6 +31,7 @@ servers:
security: security:
- PlexToken: [] - PlexToken: []
PlexClientIdentifier: []
components: components:
securitySchemes: securitySchemes:
@@ -38,6 +39,10 @@ components:
type: apiKey type: apiKey
in: header # can be "header", "query" or "cookie" in: header # can be "header", "query" or "cookie"
name: X-Plex-Token # name of the header, query parameter or cookie name: X-Plex-Token # name of the header, query parameter or cookie
PlexClientIdentifier: # arbitrary name for the security scheme
type: apiKey
in: header # can be "header", "query" or "cookie"
name: X-Plex-Client-Identifier # name of the header, query parameter or cookie
paths: paths: