LukeParke/plex-api-spec
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-api-spec.git synced 2025-12-10 04:20:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

build: dereferenced Plex Media Server API Spec updated

Browse Source
This commit is contained in:
LukeHagar
2024-10-01 14:43:37 +00:00
committed by github-actions[bot]
parent 915751fec7
commit 0027d6edd9
1 changed files with 131 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

219
output/plex-media-server-spec-dereferenced.yaml
View File

@@ -55,44 +55,54 @@ x-speakeasy-globals:
parameters: parameters:
- name: X-Plex-Client-Identifier - name: X-Plex-Client-Identifier
x-speakeasy-name-override: ClientID x-speakeasy-name-override: ClientID
description: 'The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device)' description: 'An opaque identifier unique to the client (UUID, serial number, or other unique device ID)'
in: query required: true
in: header
schema: schema:
type: string type: string
example: gcgzw5rz2xovp84b4vha3a40 examples:
required: true - 3381b62b-9ab7-4e37-827b-203e9809eb58
- SMPH00123
- 4CE0460D0G
- name: X-Plex-Product - name: X-Plex-Product
x-speakeasy-name-override: ClientName x-speakeasy-name-override: ClientName
description: 'The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.)' description: 'The name of the client application. (Plex Web, Plex Media Server, etc.)'
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Plex Web examples:
- Plex Web
- Plex for Roku
- name: X-Plex-Version - name: X-Plex-Version
x-speakeasy-name-override: ClientVersion x-speakeasy-name-override: ClientVersion
description: 'The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.)' description: The version of the client application.
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: 4.133.0 examples:
- 2.4.1
- 4.133.0
- name: X-Plex-Platform - name: X-Plex-Platform
x-speakeasy-name-override: ClientPlatform x-speakeasy-name-override: Platform
description: 'The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.)' description: The platform of the client application.
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Chrome examples:
- Chrome
- Roku
- name: X-Plex-Device - name: X-Plex-Device
x-speakeasy-name-override: DeviceName x-speakeasy-name-override: DeviceNickname
description: 'The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.)' description: A relatively friendly name for the client device
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Linux examples:
- Roku 3
security: security:
- accessToken: [] - accessToken: []
components: components:
@@ -5036,12 +5046,12 @@ paths:
example: 50 example: 50
required: false required: false
- name: X-Plex-Token - name: X-Plex-Token
in: query in: header
description: Plex Authentication Token description: 'An authentication token, obtained from plex.tv'
required: true
schema: schema:
type: string type: string
example: CV5xoxjTpFKUzBTShsaf example: CV5xoxjTpFKUzBTShsaf
required: true
responses: responses:
'200': '200':
description: Watchlist Data description: Watchlist Data
@@ -7422,12 +7432,12 @@ paths:
type: integer type: integer
example: 1 example: 1
- name: X-Plex-Token - name: X-Plex-Token
in: query in: header
description: Plex Authentication Token description: 'An authentication token, obtained from plex.tv'
required: true
schema: schema:
type: string type: string
example: CV5xoxjTpFKUzBTShsaf example: CV5xoxjTpFKUzBTShsaf
required: true
responses: responses:
'200': '200':
description: Successful response returning an image description: Successful response returning an image
@@ -7581,12 +7591,12 @@ paths:
type: integer type: integer
example: 1 example: 1
- name: X-Plex-Token - name: X-Plex-Token
in: query in: header
description: Plex Authentication Token description: 'An authentication token, obtained from plex.tv'
required: true
schema: schema:
type: string type: string
example: CV5xoxjTpFKUzBTShsaf example: CV5xoxjTpFKUzBTShsaf
required: true
responses: responses:
'200': '200':
description: Successful response returning an image description: Successful response returning an image
@@ -8673,12 +8683,15 @@ paths:
- ENABLE - ENABLE
- name: X-Plex-Client-Identifier - name: X-Plex-Client-Identifier
x-speakeasy-name-override: ClientID x-speakeasy-name-override: ClientID
description: 'The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device)' description: 'An opaque identifier unique to the client (UUID, serial number, or other unique device ID)'
in: query required: true
in: header
schema: schema:
type: string type: string
example: gcgzw5rz2xovp84b4vha3a40 examples:
required: true - 3381b62b-9ab7-4e37-827b-203e9809eb58
- SMPH00123
- 4CE0460D0G
responses: responses:
'200': '200':
description: List of Plex Devices. This includes Plex hosted servers and clients description: List of Plex Devices. This includes Plex hosted servers and clients
@@ -9361,44 +9374,54 @@ paths:
required: false required: false
- name: X-Plex-Client-Identifier - name: X-Plex-Client-Identifier
x-speakeasy-name-override: ClientID x-speakeasy-name-override: ClientID
description: 'The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device)' description: 'An opaque identifier unique to the client (UUID, serial number, or other unique device ID)'
in: query required: true
in: header
schema: schema:
type: string type: string
example: gcgzw5rz2xovp84b4vha3a40 examples:
required: true - 3381b62b-9ab7-4e37-827b-203e9809eb58
- SMPH00123
- 4CE0460D0G
- name: X-Plex-Product - name: X-Plex-Product
x-speakeasy-name-override: ClientName x-speakeasy-name-override: ClientName
description: 'The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.)' description: 'The name of the client application. (Plex Web, Plex Media Server, etc.)'
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Plex Web examples:
- Plex Web
- Plex for Roku
- name: X-Plex-Device - name: X-Plex-Device
x-speakeasy-name-override: DeviceName x-speakeasy-name-override: DeviceNickname
description: 'The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.)' description: A relatively friendly name for the client device
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Linux examples:
- Roku 3
- name: X-Plex-Version - name: X-Plex-Version
x-speakeasy-name-override: ClientVersion x-speakeasy-name-override: ClientVersion
description: 'The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.)' description: The version of the client application.
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: 4.133.0 examples:
- 2.4.1
- 4.133.0
- name: X-Plex-Platform - name: X-Plex-Platform
x-speakeasy-name-override: ClientPlatform x-speakeasy-name-override: Platform
description: 'The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.)' description: The platform of the client application.
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Chrome examples:
- Chrome
- Roku
responses: responses:
'201': '201':
description: Requests a new pin id used in the authentication flow description: Requests a new pin id used in the authentication flow
@@ -9627,44 +9650,54 @@ paths:
type: integer type: integer
- name: X-Plex-Client-Identifier - name: X-Plex-Client-Identifier
x-speakeasy-name-override: ClientID x-speakeasy-name-override: ClientID
description: 'The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device)' description: 'An opaque identifier unique to the client (UUID, serial number, or other unique device ID)'
in: query required: true
in: header
schema: schema:
type: string type: string
example: gcgzw5rz2xovp84b4vha3a40 examples:
required: true - 3381b62b-9ab7-4e37-827b-203e9809eb58
- SMPH00123
- 4CE0460D0G
- name: X-Plex-Product - name: X-Plex-Product
x-speakeasy-name-override: ClientName x-speakeasy-name-override: ClientName
description: 'The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.)' description: 'The name of the client application. (Plex Web, Plex Media Server, etc.)'
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Plex Web examples:
- Plex Web
- Plex for Roku
- name: X-Plex-Device - name: X-Plex-Device
x-speakeasy-name-override: DeviceName x-speakeasy-name-override: DeviceNickname
description: 'The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.)' description: A relatively friendly name for the client device
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Linux examples:
- Roku 3
- name: X-Plex-Version - name: X-Plex-Version
x-speakeasy-name-override: ClientVersion x-speakeasy-name-override: ClientVersion
description: 'The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.)' description: The version of the client application.
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: 4.133.0 examples:
- 2.4.1
- 4.133.0
- name: X-Plex-Platform - name: X-Plex-Platform
x-speakeasy-name-override: ClientPlatform x-speakeasy-name-override: Platform
description: 'The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.)' description: The platform of the client application.
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Chrome examples:
- Chrome
- Roku
responses: responses:
'200': '200':
description: The Pin with a non-null authToken when it has been verified by the user description: The Pin with a non-null authToken when it has been verified by the user
@@ -11186,12 +11219,12 @@ paths:
- application/xml - application/xml
example: application/json example: application/json
- name: X-Plex-Token - name: X-Plex-Token
in: query in: header
description: Plex Authentication Token description: 'An authentication token, obtained from plex.tv'
required: true
schema: schema:
type: string type: string
example: CV5xoxjTpFKUzBTShsaf example: CV5xoxjTpFKUzBTShsaf
required: true
responses: responses:
'200': '200':
description: Media providers and their features description: Media providers and their features
@@ -14508,44 +14541,54 @@ paths:
parameters: parameters:
- name: X-Plex-Client-Identifier - name: X-Plex-Client-Identifier
x-speakeasy-name-override: ClientID x-speakeasy-name-override: ClientID
description: 'The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device)' description: 'An opaque identifier unique to the client (UUID, serial number, or other unique device ID)'
in: query required: true
in: header
schema: schema:
type: string type: string
example: gcgzw5rz2xovp84b4vha3a40 examples:
required: true - 3381b62b-9ab7-4e37-827b-203e9809eb58
- SMPH00123
- 4CE0460D0G
- name: X-Plex-Product - name: X-Plex-Product
x-speakeasy-name-override: ClientName x-speakeasy-name-override: ClientName
description: 'The name of the client application. This is used to track the client application and its usage. (Plex Web, Plex Media Server, etc.)' description: 'The name of the client application. (Plex Web, Plex Media Server, etc.)'
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Plex Web examples:
- Plex Web
- Plex for Roku
- name: X-Plex-Device - name: X-Plex-Device
x-speakeasy-name-override: DeviceName x-speakeasy-name-override: DeviceNickname
description: 'The name of the device the client application is running on. This is used to track the client application and its usage. (Linux, iOS, Android, etc.)' description: A relatively friendly name for the client device
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Linux examples:
- Roku 3
- name: X-Plex-Version - name: X-Plex-Version
x-speakeasy-name-override: ClientVersion x-speakeasy-name-override: ClientVersion
description: 'The version of the client application. This is used to track the client application and its usage. (4.133.0, 5.0.0, etc.)' description: The version of the client application.
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: 4.133.0 examples:
- 2.4.1
- 4.133.0
- name: X-Plex-Platform - name: X-Plex-Platform
x-speakeasy-name-override: ClientPlatform x-speakeasy-name-override: Platform
description: 'The platform of the client application. This is used to track the client application and its usage. (Chrome, Safari, etc.)' description: The platform of the client application.
in: query in: header
required: false required: false
schema: schema:
type: string type: string
example: Chrome examples:
- Chrome
- Roku
requestBody: requestBody:
content: content:
application/x-www-form-urlencoded: application/x-www-form-urlencoded: