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 PMS Spec

Browse Source
This commit is contained in:
lukehagar
2023-06-02 20:55:42 +00:00
parent 0097be2fc0
commit cf53e3ffd8
1 changed files with 91 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
static/plex-media-server-spec-dereferenced.yaml
View File

@@ -10,7 +10,6 @@ info:
email: Lukeslakemail@gmail.com email: Lukeslakemail@gmail.com
license: license:
name: MIT name: MIT
identifier: MIT
url: 'https://opensource.org/licenses/MIT' url: 'https://opensource.org/licenses/MIT'
servers: servers:
- url: 'http://{Local IP}:{Port}' - url: 'http://{Local IP}:{Port}'
@@ -29,6 +28,20 @@ servers:
Port: Port:
default: '32400' default: '32400'
description: The port to access your plex server description: The port to access your plex server
- url: '{Protocol}://{Local IP}:{Port}'
variables:
Protocol:
default: http
description: The protocl to use when connecting to your plex server
enum:
- http
- https
Local IP:
default: 10.10.10.47
description: The Local IP Address of your plex server
Port:
default: '32400'
description: The port to access your plex server
security: security:
- Token: [] - Token: []
ClientIdentifier: [] ClientIdentifier: []
@@ -286,7 +299,7 @@ paths:
description: The media key to mark as played description: The media key to mark as played
in: query in: query
schema: schema:
type: string type: number
example: 59398 example: 59398
required: true required: true
responses: responses:
@@ -325,12 +338,14 @@ paths:
description: The media key to mark as Unplayed description: The media key to mark as Unplayed
in: query in: query
schema: schema:
type: string type: number
example: 59398 example: 59398
required: true required: true
responses: responses:
'200': '200':
description: Media is marked Unplayed description: Media is marked Unplayed
'400':
description: 'Bad Request - A parameter was not specified, or was specified incorrectly.'
'401': '401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query. description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
content: content:
@@ -769,7 +784,7 @@ paths:
/clients: /clients:
get: get:
tags: tags:
- Devices - Server
summary: Get Available Clients summary: Get Available Clients
description: Get Available Clients description: Get Available Clients
operationId: getAvailableClients operationId: getAvailableClients
@@ -811,7 +826,7 @@ paths:
example: A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05 example: A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05
version: version:
type: string type: string
example: 8.17 example: '8.17'
protocol: protocol:
type: string type: string
example: plex example: plex
@@ -822,7 +837,7 @@ paths:
type: string type: string
example: tablet example: tablet
protocolVersion: protocolVersion:
type: string type: number
example: 2 example: 2
protocolCapabilities: protocolCapabilities:
type: string type: string
@@ -853,7 +868,7 @@ paths:
/devices: /devices:
get: get:
tags: tags:
- Devices - Server
summary: Get Devices summary: Get Devices
description: Get Devices description: Get Devices
operationId: getDevices operationId: getDevices
@@ -890,7 +905,6 @@ paths:
example: iOS example: iOS
clientIdentifier: clientIdentifier:
type: string type: string
example: null
createdAt: createdAt:
type: number type: number
example: 1654131230 example: 1654131230
@@ -922,7 +936,7 @@ paths:
tags: tags:
- Hubs - Hubs
summary: Get Global Hubs summary: Get Global Hubs
description: '' description: Get Global Hubs filtered by the parameters provided.
operationId: getGlobalHubs operationId: getGlobalHubs
parameters: parameters:
- name: count - name: count
@@ -991,7 +1005,7 @@ paths:
in: query in: query
schema: schema:
type: string type: string
example: examples:
- arnold - arnold
- dylan - dylan
required: true required: true
@@ -1051,7 +1065,7 @@ paths:
in: query in: query
schema: schema:
type: string type: string
example: examples:
- dead+poop - dead+poop
required: true required: true
- name: sectionId - name: sectionId
@@ -1205,7 +1219,7 @@ paths:
/library/hashes: /library/hashes:
get: get:
tags: tags:
- Hashes - Library
summary: Get Hash Value summary: Get Hash Value
description: This resource returns hash values for local files description: This resource returns hash values for local files
operationId: getFileHash operationId: getFileHash
@@ -1301,7 +1315,7 @@ paths:
type: string type: string
example: 322a231a-b7f7-49f5-920f-14c61199cd30 example: 322a231a-b7f7-49f5-920f-14c61199cd30
ratingKey: ratingKey:
type: string type: number
example: 59398 example: 59398
key: key:
type: string type: string
@@ -1400,7 +1414,7 @@ paths:
type: string type: string
example: h264 example: h264
videoResolution: videoResolution:
type: string type: number
example: 1080 example: 1080
container: container:
type: string type: string
@@ -1442,7 +1456,7 @@ paths:
has64bitOffsets: has64bitOffsets:
type: boolean type: boolean
hasThumbnail: hasThumbnail:
type: string type: number
example: 1 example: 1
optimizedForStreaming: optimizedForStreaming:
type: boolean type: boolean
@@ -1582,7 +1596,7 @@ paths:
description: the Id of the library to query description: the Id of the library to query
in: path in: path
schema: schema:
type: string type: number
example: 1000 example: 1000
required: true required: true
- name: includeDetails - name: includeDetails
@@ -1627,13 +1641,14 @@ paths:
tags: tags:
- Library - Library
summary: Delete Library Section summary: Delete Library Section
description: Delate a library using a specific section
operationId: deleteLibrary operationId: deleteLibrary
parameters: parameters:
- name: sectionId - name: sectionId
description: the Id of the library to query description: the Id of the library to query
in: path in: path
schema: schema:
type: string type: number
example: 1000 example: 1000
required: true required: true
responses: responses:
@@ -1864,6 +1879,47 @@ paths:
example: 401 example: 401
'404': '404':
description: In response to a non-existant sectionId. description: In response to a non-existant sectionId.
'/library/metadata/{ratingKey}':
get:
tags:
- Library
summary: Get Items Metadata
description: |
This endpoint will return the metadata of a library item specified with the ratingKey.
operationId: getMetadata
parameters:
- name: ratingKey
description: the id of the library item to return the children of.
in: path
schema:
type: number
required: true
responses:
'200':
description: The children of the library item.
'400':
description: 'Bad Request - A parameter was not specified, or was specified incorrectly.'
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
type: number
example: 1001
message:
type: string
example: User could not be authenticated
status:
type: number
example: 401
'/library/metadata/{ratingKey}/children': '/library/metadata/{ratingKey}/children':
get: get:
tags: tags:
@@ -1957,16 +2013,16 @@ paths:
type: string type: string
example: 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd example: 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd
ratingKey: ratingKey:
type: string type: number
example: 49564 example: 49564
key: key:
type: string type: string
example: /library/metadata/49564 example: /library/metadata/49564
parentRatingKey: parentRatingKey:
type: string type: number
example: 49557 example: 49557
grandparentRatingKey: grandparentRatingKey:
type: string type: number
example: 49556 example: 49556
guid: guid:
type: string type: string
@@ -2081,7 +2137,7 @@ paths:
example: hevc example: hevc
videoResolution: videoResolution:
type: string type: string
example: 1080 example: '1080'
container: container:
type: string type: string
example: mkv example: mkv
@@ -2366,7 +2422,7 @@ paths:
/myplex/account: /myplex/account:
get: get:
tags: tags:
- MyPlex - Server
summary: Get MyPlex Account summary: Get MyPlex Account
description: Returns MyPlex Account Information description: Returns MyPlex Account Information
operationId: getMyPlexAccount operationId: getMyPlexAccount
@@ -2392,7 +2448,6 @@ paths:
example: mapped example: mapped
mappingError: mappingError:
type: string type: string
example: null
signInState: signInState:
type: string type: string
example: ok example: ok
@@ -2442,7 +2497,7 @@ paths:
'/photo/:/transcode': '/photo/:/transcode':
get: get:
tags: tags:
- Photos - Server
summary: Get a Resized Photo summary: Get a Resized Photo
description: | description: |
Plex's Photo transcoder is used throughout the service to serve images at specified sizes. Plex's Photo transcoder is used throughout the service to serve images at specified sizes.
@@ -2476,7 +2531,7 @@ paths:
in: query in: query
schema: schema:
type: number type: number
example: examples:
- 0 - 0
- 20 - 20
- 4000 - 4000
@@ -2611,7 +2666,7 @@ paths:
tags: tags:
- Playlists - Playlists
summary: Get All Playlists summary: Get All Playlists
description: '' description: Get All Playlists given the specified filters.
operationId: getPlaylists operationId: getPlaylists
parameters: parameters:
- name: playlistType - name: playlistType
@@ -2998,7 +3053,7 @@ paths:
in: query in: query
schema: schema:
type: string type: string
example: 110 example: '110'
required: true required: true
responses: responses:
'200': '200':
@@ -3045,7 +3100,7 @@ paths:
type: string type: string
example: Hera example: Hera
ratingKey: ratingKey:
type: string type: number
example: 10398 example: 10398
key: key:
type: string type: string
@@ -3144,7 +3199,7 @@ paths:
type: string type: string
example: hevc example: hevc
videoResolution: videoResolution:
type: string type: number
example: 1080 example: 1080
container: container:
type: string type: string
@@ -3330,7 +3385,7 @@ paths:
in: query in: query
schema: schema:
type: string type: string
example: examples:
- 'server://client-identifier' - 'server://client-identifier'
- 'provider://provider-identifier' - 'provider://provider-identifier'
required: true required: true
@@ -3808,6 +3863,9 @@ tags:
- name: Library - name: Library
description: | description: |
API Calls interacting with Plex Media Server Libraries API Calls interacting with Plex Media Server Libraries
- name: Media
description: |
API Calls interacting with Plex Media Server Media
- name: Hubs - name: Hubs
description: | description: |
Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows. Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
@@ -3820,6 +3878,9 @@ tags:
- name: Search - name: Search
description: | description: |
API Calls that perform search operations with Plex Media Server API Calls that perform search operations with Plex Media Server
- name: Sessions
description: |
API Calls that perform search operations with Plex Media Server Sessions
- name: User - name: User
description: | description: |
API Calls that perform operations with Plex Media Server Users API Calls that perform operations with Plex Media Server Users