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

revert

Browse Source
This commit is contained in:
JasonLandbridge
2024-08-25 12:03:42 +02:00
parent 5ad02de237
commit 33cc477a24
1 changed files with 30 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
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: get-all-libraries operationId: getLibraries
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,10 +2426,6 @@ paths:
properties: properties:
MediaContainer: MediaContainer:
type: object type: object
required:
- size
- allowSync
- title1
properties: properties:
size: size:
type: integer type: integer
@@ -2486,23 +2482,17 @@ paths:
type: string type: string
example: 322a231a-b7f7-49f5-920f-14c61199cd30 example: 322a231a-b7f7-49f5-920f-14c61199cd30
updatedAt: updatedAt:
type: type: integer
- integer
example: 1556281940
description: Unix epoch datetime
format: int32 format: int32
example: 1705615634
createdAt: createdAt:
type: type: integer
- integer
example: 1556281940
description: Unix epoch datetime
format: int32 format: int32
example: 1654131312
scannedAt: scannedAt:
type: type: integer
- integer
example: 1556281940
description: Unix epoch datetime
format: int32 format: int32
example: 1705615584
content: content:
type: boolean type: boolean
example: true example: true
@@ -2597,14 +2587,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: get-library-details operationId: getLibrary
parameters: parameters:
- name: sectionId - name: sectionId
description: The id of the library description: the Id of the library to query
in: path in: path
schema: schema:
type: number type: number
example: 15 example: 1000
required: true required: true
- name: includeDetails - name: includeDetails
description: | description: |
@@ -2812,15 +2802,15 @@ paths:
tags: tags:
- Library - Library
summary: Delete Library Section summary: Delete Library Section
description: Delete a library using a specific section id description: Delate a library using a specific section
operationId: deleteLibrary operationId: deleteLibrary
parameters: parameters:
- name: sectionId - name: sectionId
description: The id of the library description: the Id of the library to query
in: path in: path
schema: schema:
type: number type: number
example: 15 example: 1000
required: true required: true
responses: responses:
'200': '200':
@@ -3306,28 +3296,17 @@ paths:
get: get:
tags: tags:
- Library - Library
summary: Refresh Metadata Of The Library summary: Refresh Library
description: | description: |
This endpoint Refreshes all the Metadata of the library. This endpoint Refreshes the library.
operationId: get-refresh-library-metadata operationId: refreshLibrary
parameters: parameters:
- name: sectionId - name: sectionId
description: The id of the library description: the Id of the library to refresh
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
@@ -9356,10 +9335,10 @@ paths:
- url: 'https://plex.tv/api/v2' - url: 'https://plex.tv/api/v2'
security: [] security: []
tags: tags:
- Authentication - User
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-users-sign-in-data operationId: post-sign-in
parameters: parameters:
- name: X-Plex-Client-Identifier - name: X-Plex-Client-Identifier
description: | description: |
@@ -10007,21 +9986,18 @@ paths:
- string - string
- 'null' - 'null'
renewsAt: renewsAt:
oneOf: type:
- type: - integer
- integer - 'null'
example: 1556281940 description: Unix epoch datetime
description: Unix epoch datetime format: int32
format: int32
- type: 'null'
endsAt: endsAt:
oneOf: type:
- type: - integer
- integer - 'null'
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime
format: int32 format: int32
- type: 'null'
canceled: canceled:
type: boolean type: boolean
example: false example: false