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

Updating PMS Spec

Browse Source
This commit is contained in:
lukehagar
2023-05-05 18:57:54 +00:00
parent 8e93d80692
commit 62e9b9255c
1 changed files with 103 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -775,6 +775,71 @@ paths:
status:
type: number
example: 401
/devices:
get:
tags:
- Devices
summary: Get Devices
description: Get Devices
operationId: getDevices
responses:
'200':
description: Devices
content:
application/json:
schema:
type: object
properties:
MediaContainer:
type: object
properties:
size:
type: number
example: 151
identifier:
type: string
example: com.plexapp.system.devices
Device:
type: array
items:
type: object
properties:
id:
type: number
example: 1
name:
type: string
example: iPhone
platform:
type: string
example: iOS
clientIdentifier:
type: string
example: null
createdAt:
type: number
example: 1654131230
'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
/hubs:
get:
tags:
@@ -1418,7 +1483,7 @@ paths:
- `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending).
- `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort.
- `title`: The title of the field.
operationId: getLibraryDetails
operationId: getLibrary
parameters:
- name: sectionId
description: the Id of the library to query
@@ -1463,6 +1528,43 @@ paths:
status:
type: number
example: 401
delete:
tags:
- Library
summary: Delete Library Section
operationId: deleteLibrary
parameters:
- name: sectionId
description: the Id of the library to query
in: path
schema:
type: string
example: 1000
required: true
responses:
'200':
description: The library is deleted
'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/sections/{sectionId}/all':
get:
tags: