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
2024-08-25 10:04:43 +00:00
parent f9f9aa9a32
commit 4b9ce8a77e
1 changed files with 54 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2408,7 +2408,7 @@ paths:
tags: tags:
- Library - Library
summary: Get All Libraries summary: Get All Libraries
operationId: getLibraries operationId: get-all-libraries
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.
@@ -2426,6 +2426,10 @@ paths:
properties: properties:
MediaContainer: MediaContainer:
type: object type: object
required:
- size
- allowSync
- title1
properties: properties:
size: size:
type: integer type: integer
@@ -2482,17 +2486,23 @@ paths:
type: string type: string
example: 322a231a-b7f7-49f5-920f-14c61199cd30 example: 322a231a-b7f7-49f5-920f-14c61199cd30
updatedAt: updatedAt:
type: integer type:
- integer
example: 1556281940
description: Unix epoch datetime
format: int32 format: int32
example: 1705615634
createdAt: createdAt:
type: integer type:
- integer
example: 1556281940
description: Unix epoch datetime
format: int32 format: int32
example: 1654131312
scannedAt: scannedAt:
type: integer type:
- integer
example: 1556281940
description: Unix epoch datetime
format: int32 format: int32
example: 1705615584
content: content:
type: boolean type: boolean
example: true example: true
@@ -2587,14 +2597,14 @@ paths:
- Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`.
> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. > **Note**: Filters and sorts are optional; without them, no filtering controls are rendered.
operationId: getLibrary operationId: get-library-details
parameters: parameters:
- name: sectionId - name: sectionId
description: the Id of the library to query description: The id of the library
in: path in: path
schema: schema:
type: number type: number
example: 1000 example: 15
required: true required: true
- name: includeDetails - name: includeDetails
description: | description: |
@@ -2802,15 +2812,15 @@ paths:
tags: tags:
- Library - Library
summary: Delete Library Section summary: Delete Library Section
description: Delate a library using a specific section description: Delete a library using a specific section id
operationId: deleteLibrary operationId: deleteLibrary
parameters: parameters:
- name: sectionId - name: sectionId
description: the Id of the library to query description: The id of the library
in: path in: path
schema: schema:
type: number type: number
example: 1000 example: 15
required: true required: true
responses: responses:
'200': '200':
@@ -3296,17 +3306,28 @@ paths:
get: get:
tags: tags:
- Library - Library
summary: Refresh Library summary: Refresh Metadata Of The Library
description: | description: |
This endpoint Refreshes the library. This endpoint Refreshes all the Metadata of the library.
operationId: refreshLibrary operationId: get-refresh-library-metadata
parameters: parameters:
- name: sectionId - name: sectionId
description: the Id of the library to refresh description: The id of the library
in: path in: path
schema: schema:
type: number type: number
example: 15
required: true required: true
- name: force
description: Force the refresh even if the library is already being refreshed.
in: query
schema:
type: enum
example: 0
enum:
- 0
- 1
required: false
responses: responses:
'200': '200':
description: The library is refreshing description: The library is refreshing
@@ -9335,10 +9356,10 @@ paths:
- url: 'https://plex.tv/api/v2' - url: 'https://plex.tv/api/v2'
security: [] security: []
tags: tags:
- User - Authentication
summary: Get User SignIn Data summary: Get User SignIn Data
description: Sign in user with username and password and return user data with Plex authentication token description: Sign in user with username and password and return user data with Plex authentication token
operationId: post-sign-in operationId: post-users-sign-in-data
parameters: parameters:
- name: X-Plex-Client-Identifier - name: X-Plex-Client-Identifier
description: | description: |
@@ -9986,18 +10007,21 @@ paths:
- string - string
- 'null' - 'null'
renewsAt: renewsAt:
type: oneOf:
- type:
- integer - integer
- 'null'
description: Unix epoch datetime
format: int32
endsAt:
type:
- integer
- 'null'
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime
format: int32 format: int32
- type: 'null'
endsAt:
oneOf:
- type:
- integer
example: 1556281940
description: Unix epoch datetime
format: int32
- type: 'null'
canceled: canceled:
type: boolean type: boolean
example: false example: false