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

Moved client identifier

Browse Source
This commit is contained in:
JasonLandbridge
2024-09-04 10:31:09 +02:00
parent 1d69f47436
commit 2dae95ba37
15 changed files with 296 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -30,10 +30,10 @@ x-speakeasy-globals:
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)
in: header
in: query
schema:
type: string
example: Postman
example: gcgzw5rz2xovp84b4vha3a40
required: true
security:
- accessToken: []
@@ -5536,10 +5536,10 @@ paths:
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)
in: header
in: query
schema:
type: string
example: Postman
example: gcgzw5rz2xovp84b4vha3a40
required: true
- name: includeHttps
in: query
@@ -6039,19 +6039,17 @@ paths:
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)
in: header
in: query
schema:
type: string
example: Postman
example: gcgzw5rz2xovp84b4vha3a40
required: true
- name: X-Plex-Product
description: |
Product name of the application shown in the list of devices
in: header
in: query
required: false
schema:
type: string
example: Postman
required: true
example: Plex Web
responses:
'200':
description: Requests a new pin id used in the authentication flow
@@ -6269,10 +6267,10 @@ paths:
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)
in: header
in: query
schema:
type: string
example: Postman
example: gcgzw5rz2xovp84b4vha3a40
required: true
- name: pinID
description: The PinID to retrieve an access token for
@@ -7519,6 +7517,271 @@ paths:
status:
type: number
example: 401
/media/providers:
get:
tags:
- Server
summary: Get Media Providers
description: Retrieves media providers and their features from the Plex server.
operationId: get-media-providers
parameters:
- name: Accept
in: header
required: false
schema:
type: string
enum:
- application/json
- application/xml
example: application/json
- name: X-Plex-Device
in: query
required: false
schema:
type: string
example: Linux
- name: X-Plex-Device-Name
in: query
required: false
schema:
type: string
example: Chrome
- name: X-Plex-Device-Screen-Resolution
in: query
required: false
schema:
type: string
example: '1487x1165,2560x1440'
- name: X-Plex-Features
in: query
required: false
schema:
type: string
example: 'external-media,indirect-media,hub-style-list'
- name: X-Plex-Client-Identifier
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)
in: query
schema:
type: string
example: gcgzw5rz2xovp84b4vha3a40
required: true
- name: X-Plex-Language
in: query
required: false
schema:
type: string
example: en
- name: X-Plex-Model
in: query
required: false
schema:
type: string
example: bundled
- name: X-Plex-Platform
in: query
required: false
schema:
type: string
example: Chrome
- name: X-Plex-Product
in: query
required: false
schema:
type: string
example: Plex Web
- name: X-Plex-Session-Id
in: query
required: false
schema:
type: string
example: 97e136ef-4ddd-4ff3-89a7-a5820c96c2ca
- name: X-Plex-Version
in: query
required: false
schema:
type: string
example: 4.133.0
- name: X-Plex-Token
in: query
description: Plex Authentication Token
schema:
type: string
example: CV5xoxjTpFKUzBTShsaf
required: true
responses:
'200':
description: Media providers and their features
content:
application/json:
schema:
type: object
properties:
MediaContainer:
type: object
properties:
size:
type: integer
allowCameraUpload:
type: boolean
allowChannelAccess:
type: boolean
allowSharing:
type: boolean
allowSync:
type: boolean
allowTuners:
type: boolean
backgroundProcessing:
type: boolean
certificate:
type: boolean
companionProxy:
type: boolean
countryCode:
type: string
diagnostics:
type: string
eventStream:
type: boolean
friendlyName:
type: string
livetv:
type: integer
machineIdentifier:
type: string
musicAnalysis:
type: integer
myPlex:
type: boolean
myPlexMappingState:
type: string
myPlexSigninState:
type: string
myPlexSubscription:
type: boolean
myPlexUsername:
type: string
offlineTranscode:
type: integer
ownerFeatures:
type: string
platform:
type: string
platformVersion:
type: string
pluginHost:
type: boolean
pushNotifications:
type: boolean
readOnlyLibraries:
type: boolean
streamingBrainABRVersion:
type: integer
streamingBrainVersion:
type: integer
sync:
type: boolean
transcoderActiveVideoSessions:
type: integer
transcoderAudio:
type: boolean
transcoderLyrics:
type: boolean
transcoderSubtitles:
type: boolean
transcoderVideo:
type: boolean
transcoderVideoBitrates:
type: string
transcoderVideoQualities:
type: string
transcoderVideoResolutions:
type: string
updatedAt:
type: integer
updater:
type: boolean
version:
type: string
voiceSearch:
type: boolean
MediaProvider:
type: array
items:
type: object
properties:
identifier:
type: string
title:
type: string
types:
type: string
protocols:
type: string
Feature:
type: array
items:
type: object
properties:
key:
type: string
type:
type: string
Directory:
type: array
items:
type: object
properties:
hubKey:
type: string
title:
type: string
agent:
type: string
language:
type: string
refreshing:
type: boolean
scanner:
type: string
uuid:
type: string
id:
type: string
key:
type: string
type:
type: string
subtype:
type: string
updatedAt:
type: integer
scannedAt:
type: integer
Pivot:
type: array
items:
type: object
properties:
id:
type: string
key:
type: string
type:
type: string
title:
type: string
context:
type: string
symbol:
type: string
'400':
description: Bad Request
'401':
description: Unauthorized
/search:
get:
tags:
@@ -10053,10 +10316,10 @@ paths:
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)
in: header
in: query
schema:
type: string
example: Postman
example: gcgzw5rz2xovp84b4vha3a40
required: true
requestBody:
content:

10
src/parameters/ClientIdentifier.yaml
View File

@@ -1,10 +0,0 @@
name: X-Plex-Client-Identifier
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)
in: header
schema:
type: string
example: Postman
required: true

8
src/parameters/ClientProduct.yaml
View File

@@ -1,8 +0,0 @@
name: X-Plex-Product
description: |
Product name of the application shown in the list of devices
in: header
schema:
type: string
example: Postman
required: true

8
src/parameters/plex/x-plex-identifier.yaml
View File

@@ -1,6 +1,10 @@
name: X-Plex-Client-Identifier
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)
in: query
required: false
schema:
type: string
example: "gcgzw5rz2xovp84b4vha3a40"
example: gcgzw5rz2xovp84b4vha3a40
required: true

2
src/parameters/plex-token.yaml → src/parameters/plex/x-plex-token.yaml
View File

@@ -4,4 +4,4 @@ description: Plex Authentication Token
schema:
type: string
example: CV5xoxjTpFKUzBTShsaf
required: false
required: true

2
src/paths/library/metadata/[ratingKey]/banner/get-banner-image.yaml
View File

@@ -16,7 +16,7 @@ get:
- $ref: "../../../../../parameters/image/height.yaml"
- $ref: "../../../../../parameters/image/min-size.yaml"
- $ref: "../../../../../parameters/image/upscale.yaml"
- $ref: "../../../../../parameters/plex-token.yaml"
- $ref: "../../../../../parameters/plex/x-plex-token.yaml"
responses:
'200':
description: Successful response returning an image

2
src/paths/library/metadata/[ratingKey]/thumb/get-thumb-image.yaml
View File

@@ -16,7 +16,7 @@ get:
- $ref: "../../../../../parameters/image/height.yaml"
- $ref: "../../../../../parameters/image/min-size.yaml"
- $ref: "../../../../../parameters/image/upscale.yaml"
- $ref: "../../../../../parameters/plex-token.yaml"
- $ref: "../../../../../parameters/plex/x-plex-token.yaml"
responses:
'200':
description: Successful response returning an image

2
src/paths/library/sections/watchlist/get-watch-list.yaml
View File

@@ -71,7 +71,7 @@ get:
- $ref: "../../../../parameters/accept-application-json.yaml"
- $ref: "../../../../parameters/container-start.yaml"
- $ref: "../../../../parameters/container-size.yaml"
- $ref: "../../../../parameters/plex-token.yaml"
- $ref: "../../../../parameters/plex/x-plex-token.yaml"
responses:
"200":
description: Watchlist Data

7
src/paths/media/providers/get-media-providers.yaml
View File

@@ -17,12 +17,7 @@ get:
- $ref: '../../../parameters/plex/x-plex-product.yaml'
- $ref: '../../../parameters/plex/x-plex-session-id.yaml'
- $ref: '../../../parameters/plex/x-plex-version.yaml'
- name: X-Plex-Token
in: query
required: true
schema:
type: string
example: "tW7zyenPCasLpVnaZa8y"
- $ref: '../../../parameters/plex/x-plex-token.yaml'
responses:
'200':
description: Media providers and their features

2
src/paths/pins/pins-id.yaml
View File

@@ -8,7 +8,7 @@ get:
description: Retrieve an Access Token from Plex.tv after the Pin has been authenticated
operationId: getTokenByPinId
parameters:
- $ref: "../../parameters/ClientIdentifier.yaml"
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
- name: pinID
description: The PinID to retrieve an access token for
in: path

4
src/paths/pins/pins.yaml
View File

@@ -18,8 +18,8 @@ post:
type: boolean
default: false
required: false
- $ref: ../../parameters/ClientIdentifier.yaml
- $ref: ../../parameters/ClientProduct.yaml
- $ref: ../../parameters/plex/x-plex-identifier.yaml
- $ref: ../../parameters/plex/x-plex-product.yaml
responses:
'200':
description: Requests a new pin id used in the authentication flow

2
src/paths/resources/resources.yaml
View File

@@ -8,7 +8,7 @@ get:
description: Get Resources
operationId: getResources
parameters:
- $ref: "../../parameters/ClientIdentifier.yaml"
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
- name: includeHttps
in: query
description: Include Https entries in the results

2
src/paths/user/get-user-data-by-token.yaml
View File

@@ -7,7 +7,7 @@ get:
description: Get the User data from the provided X-Plex-Token
operationId: getUserDetails
parameters:
- $ref: '../../parameters/plex-token.yaml'
- $ref: '../../parameters/plex/x-plex-token.yaml'
- $ref: "../../parameters/accept-application-json.yaml"
responses:
'200':

2
src/paths/users/post-sign-in.yaml
View File

@@ -8,7 +8,7 @@ post:
description: Sign in user with username and password and return user data with Plex authentication token
operationId: post-users-sign-in-data
parameters:
- $ref: "../../parameters/ClientIdentifier.yaml"
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
requestBody:
content:
application/x-www-form-urlencoded:

2
src/pms-spec.yaml
View File

@@ -27,7 +27,7 @@ servers:
x-speakeasy-globals:
parameters:
- $ref: "./parameters/ClientIdentifier.yaml"
- $ref: "./parameters/plex/x-plex-identifier.yaml"
security:
- accessToken: []