mirror of
https://github.com/LukeHagar/plex-api-spec.git
synced 2025-12-09 20:47:46 +00:00
corrections
This commit is contained in:
JasonLandbridge
19
src/models/MediaContainer.yaml
Normal file
19
src/models/MediaContainer.yaml
Normal file
@@ -0,0 +1,19 @@
|
||||
title: MediaContainer
|
||||
type: object
|
||||
required:
|
||||
- size
|
||||
properties:
|
||||
size:
|
||||
type: number
|
||||
example: 50
|
||||
offset:
|
||||
type: integer
|
||||
format: int32
|
||||
totalSize:
|
||||
type: integer
|
||||
format: int32
|
||||
identifier:
|
||||
type: string
|
||||
example: "com.plexapp.plugins.library"
|
||||
allowSync:
|
||||
type: boolean
|
||||
129
src/models/Meta.yaml
Normal file
129
src/models/Meta.yaml
Normal file
@@ -0,0 +1,129 @@
|
||||
description: |
|
||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||
type: object
|
||||
properties:
|
||||
Type:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- key
|
||||
- type
|
||||
- title
|
||||
- active
|
||||
properties:
|
||||
key:
|
||||
type: string
|
||||
example: "/library/sections/2/all?type=2"
|
||||
type:
|
||||
type: string
|
||||
example: "show"
|
||||
title:
|
||||
type: string
|
||||
example: "TV Shows"
|
||||
active:
|
||||
type: boolean
|
||||
example: false
|
||||
Filter:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- filter
|
||||
- filterType
|
||||
- key
|
||||
- title
|
||||
- type
|
||||
properties:
|
||||
filter:
|
||||
type: string
|
||||
example: "genre"
|
||||
filterType:
|
||||
type: string
|
||||
example: "string"
|
||||
key:
|
||||
type: string
|
||||
example: "/library/sections/2/genre?type=2"
|
||||
title:
|
||||
type: string
|
||||
example: "Genre"
|
||||
type:
|
||||
type: string
|
||||
example: "filter"
|
||||
Sort:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- key
|
||||
- title
|
||||
- defaultDirection
|
||||
properties:
|
||||
default:
|
||||
type: string
|
||||
example: "asc"
|
||||
active:
|
||||
type: boolean
|
||||
example: false
|
||||
activeDirection:
|
||||
$ref: "../models/common/PlexSortDirection.yaml"
|
||||
defaultDirection:
|
||||
$ref: "../models/common/PlexSortDirection.yaml"
|
||||
descKey:
|
||||
type: string
|
||||
example: "titleSort:desc"
|
||||
firstCharacterKey:
|
||||
type: string
|
||||
example: "/library/sections/2/firstCharacter"
|
||||
key:
|
||||
type: string
|
||||
example: "titleSort"
|
||||
title:
|
||||
type: string
|
||||
example: "Title"
|
||||
Field:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- key
|
||||
- title
|
||||
- type
|
||||
properties:
|
||||
key:
|
||||
type: string
|
||||
example: "show.title"
|
||||
title:
|
||||
type: string
|
||||
example: "Show Title"
|
||||
type:
|
||||
type: string
|
||||
example: "string"
|
||||
subType:
|
||||
type: string
|
||||
example: "rating"
|
||||
FieldType:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
- Operator
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
example: "tag"
|
||||
Operator:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- key
|
||||
- title
|
||||
properties:
|
||||
key:
|
||||
type: string
|
||||
example: "="
|
||||
title:
|
||||
type: string
|
||||
example: "is"
|
||||
6
src/parameters/include-meta.yaml
Normal file
6
src/parameters/include-meta.yaml
Normal file
@@ -0,0 +1,6 @@
|
||||
name: includeMeta
|
||||
in: query
|
||||
description: |
|
||||
Adds the Meta object to the response
|
||||
schema:
|
||||
$ref: "../models/common/PlexBoolean.yaml"
|
||||
7
src/parameters/section-id.yaml
Normal file
7
src/parameters/section-id.yaml
Normal file
@@ -0,0 +1,7 @@
|
||||
name: sectionID
|
||||
in: query
|
||||
required: false
|
||||
description: The library section ID for filtering content.
|
||||
schema:
|
||||
type: integer
|
||||
example: 2
|
||||
42
src/paths/hubs/home/get-recently-added.yaml
Normal file
42
src/paths/hubs/home/get-recently-added.yaml
Normal file
@@ -0,0 +1,42 @@
|
||||
get:
|
||||
tags:
|
||||
- Hubs
|
||||
summary: Get Recently Added
|
||||
description: |
|
||||
This endpoint will return the recently added content.
|
||||
operationId: get-recently-added
|
||||
parameters:
|
||||
- name: contentDirectoryID
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
description: The content directory ID.
|
||||
- name: pinnedContentDirectoryID
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: Comma-separated list of pinned content directory IDs.
|
||||
- $ref: "../../../parameters/section-id.yaml"
|
||||
- $ref: "../../../parameters/type.yaml"
|
||||
- $ref: "../../../parameters/include-meta.yaml"
|
||||
- $ref: "../../../parameters/container-start.yaml"
|
||||
- $ref: "../../../parameters/container-size.yaml"
|
||||
responses:
|
||||
"200":
|
||||
description: A successful response with recently added content.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
MediaContainer:
|
||||
allOf:
|
||||
- $ref: "../../../models/MediaContainer.yaml"
|
||||
- $ref: "../../../models/Meta.yaml"
|
||||
|
||||
"401":
|
||||
description: Unauthorized, invalid Plex token.
|
||||
"400":
|
||||
description: Bad request, invalid parameters.
|
||||
File diff suppressed because it is too large
Load Diff
@@ -117,9 +117,7 @@ get:
|
||||
type: boolean
|
||||
example: true
|
||||
contentChangedAt:
|
||||
type: integer
|
||||
format: int32
|
||||
example: 3192854
|
||||
$ref: "../../models/common/PlexDateTime.yaml"
|
||||
hidden:
|
||||
type: integer
|
||||
format: int32
|
||||
|
||||
@@ -6,6 +6,23 @@ get:
|
||||
This endpoint will return the recently added content.
|
||||
operationId: getRecentlyAdded
|
||||
parameters:
|
||||
- name: contentDirectoryID
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
example: 2
|
||||
- name: pinnedContentDirectoryID
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: integer
|
||||
example: [3, 5, 7, 13, 12, 1, 6, 14, 2, 10, 16, 17]
|
||||
- $ref: "../../parameters/section-id.yaml"
|
||||
- $ref: "../../parameters/type.yaml"
|
||||
- $ref: "../../parameters/include-meta.yaml"
|
||||
- $ref: "../../parameters/container-start.yaml"
|
||||
- $ref: "../../parameters/container-size.yaml"
|
||||
responses:
|
||||
@@ -17,229 +34,231 @@ get:
|
||||
type: object
|
||||
properties:
|
||||
MediaContainer:
|
||||
type: object
|
||||
properties:
|
||||
size:
|
||||
type: number
|
||||
example: 50
|
||||
allowSync:
|
||||
type: boolean
|
||||
identifier:
|
||||
type: string
|
||||
example: com.plexapp.plugins.library
|
||||
mediaTagPrefix:
|
||||
type: string
|
||||
example: /system/bundle/media/flags/
|
||||
mediaTagVersion:
|
||||
type: number
|
||||
example: 1680021154
|
||||
mixedParents:
|
||||
type: boolean
|
||||
Metadata:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
allowSync:
|
||||
type: boolean
|
||||
librarySectionID:
|
||||
type: number
|
||||
example: 1
|
||||
librarySectionTitle:
|
||||
type: string
|
||||
example: Movies
|
||||
librarySectionUUID:
|
||||
type: string
|
||||
example: 322a231a-b7f7-49f5-920f-14c61199cd30
|
||||
ratingKey:
|
||||
type: number
|
||||
example: 59398
|
||||
key:
|
||||
type: string
|
||||
example: /library/metadata/59398
|
||||
guid:
|
||||
type: string
|
||||
example: plex://movie/5e161a83bea6ac004126e148
|
||||
studio:
|
||||
type: string
|
||||
example: Marvel Studios
|
||||
type:
|
||||
type: string
|
||||
example: movie
|
||||
title:
|
||||
type: string
|
||||
example: "Ant-Man and the Wasp: Quantumania"
|
||||
contentRating:
|
||||
type: string
|
||||
example: PG-13
|
||||
summary:
|
||||
type: string
|
||||
example: Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible.
|
||||
rating:
|
||||
type: number
|
||||
example: 4.7
|
||||
audienceRating:
|
||||
type: number
|
||||
example: 8.3
|
||||
year:
|
||||
type: number
|
||||
example: 2023
|
||||
tagline:
|
||||
type: string
|
||||
example: Witness the beginning of a new dynasty.
|
||||
thumb:
|
||||
type: string
|
||||
example: /library/metadata/59398/thumb/1681888010
|
||||
art:
|
||||
type: string
|
||||
example: /library/metadata/59398/art/1681888010
|
||||
duration:
|
||||
type: number
|
||||
example: 7474422
|
||||
originallyAvailableAt:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2023-02-15
|
||||
addedAt:
|
||||
type: number
|
||||
example: 1681803215
|
||||
updatedAt:
|
||||
type: number
|
||||
example: 1681888010
|
||||
audienceRatingImage:
|
||||
type: string
|
||||
example: rottentomatoes://image.rating.upright
|
||||
chapterSource:
|
||||
type: string
|
||||
example: media
|
||||
primaryExtraKey:
|
||||
type: string
|
||||
example: /library/metadata/59399
|
||||
ratingImage:
|
||||
type: string
|
||||
example: rottentomatoes://image.rating.rotten
|
||||
Media:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
example: 120345
|
||||
duration:
|
||||
type: number
|
||||
example: 7474422
|
||||
bitrate:
|
||||
type: number
|
||||
example: 3623
|
||||
width:
|
||||
type: number
|
||||
example: 1920
|
||||
height:
|
||||
type: number
|
||||
example: 804
|
||||
aspectRatio:
|
||||
type: number
|
||||
example: 2.35
|
||||
audioChannels:
|
||||
type: number
|
||||
example: 6
|
||||
audioCodec:
|
||||
type: string
|
||||
example: ac3
|
||||
videoCodec:
|
||||
type: string
|
||||
example: h264
|
||||
videoResolution:
|
||||
type: number
|
||||
example: 1080
|
||||
container:
|
||||
type: string
|
||||
example: mp4
|
||||
videoFrameRate:
|
||||
type: string
|
||||
example: 24p
|
||||
optimizedForStreaming:
|
||||
type: number
|
||||
example: 0
|
||||
has64bitOffsets:
|
||||
type: boolean
|
||||
videoProfile:
|
||||
type: string
|
||||
example: high
|
||||
Part:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
example: 120353
|
||||
key:
|
||||
type: string
|
||||
example: /library/parts/120353/1681803203/file.mp4
|
||||
duration:
|
||||
type: number
|
||||
example: 7474422
|
||||
file:
|
||||
type: string
|
||||
example: /movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4
|
||||
size:
|
||||
type: number
|
||||
example: 3395307162
|
||||
container:
|
||||
type: string
|
||||
example: mp4
|
||||
has64bitOffsets:
|
||||
type: boolean
|
||||
hasThumbnail:
|
||||
type: number
|
||||
example: 1
|
||||
optimizedForStreaming:
|
||||
type: boolean
|
||||
videoProfile:
|
||||
type: string
|
||||
example: high
|
||||
Genre:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Comedy
|
||||
Director:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Peyton Reed
|
||||
Writer:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Jeff Loveness
|
||||
Country:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: United States of America
|
||||
Role:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Paul Rudd
|
||||
allOf:
|
||||
- $ref: "../../models/Meta.yaml"
|
||||
- type: object
|
||||
properties:
|
||||
size:
|
||||
type: number
|
||||
example: 50
|
||||
allowSync:
|
||||
type: boolean
|
||||
identifier:
|
||||
type: string
|
||||
example: com.plexapp.plugins.library
|
||||
mediaTagPrefix:
|
||||
type: string
|
||||
example: /system/bundle/media/flags/
|
||||
mediaTagVersion:
|
||||
type: number
|
||||
example: 1680021154
|
||||
mixedParents:
|
||||
type: boolean
|
||||
Metadata:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
allowSync:
|
||||
type: boolean
|
||||
librarySectionID:
|
||||
type: number
|
||||
example: 1
|
||||
librarySectionTitle:
|
||||
type: string
|
||||
example: Movies
|
||||
librarySectionUUID:
|
||||
type: string
|
||||
example: 322a231a-b7f7-49f5-920f-14c61199cd30
|
||||
ratingKey:
|
||||
type: number
|
||||
example: 59398
|
||||
key:
|
||||
type: string
|
||||
example: /library/metadata/59398
|
||||
guid:
|
||||
type: string
|
||||
example: plex://movie/5e161a83bea6ac004126e148
|
||||
studio:
|
||||
type: string
|
||||
example: Marvel Studios
|
||||
type:
|
||||
type: string
|
||||
example: movie
|
||||
title:
|
||||
type: string
|
||||
example: "Ant-Man and the Wasp: Quantumania"
|
||||
contentRating:
|
||||
type: string
|
||||
example: PG-13
|
||||
summary:
|
||||
type: string
|
||||
example: Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible.
|
||||
rating:
|
||||
type: number
|
||||
example: 4.7
|
||||
audienceRating:
|
||||
type: number
|
||||
example: 8.3
|
||||
year:
|
||||
type: number
|
||||
example: 2023
|
||||
tagline:
|
||||
type: string
|
||||
example: Witness the beginning of a new dynasty.
|
||||
thumb:
|
||||
type: string
|
||||
example: /library/metadata/59398/thumb/1681888010
|
||||
art:
|
||||
type: string
|
||||
example: /library/metadata/59398/art/1681888010
|
||||
duration:
|
||||
type: number
|
||||
example: 7474422
|
||||
originallyAvailableAt:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2023-02-15
|
||||
addedAt:
|
||||
type: number
|
||||
example: 1681803215
|
||||
updatedAt:
|
||||
type: number
|
||||
example: 1681888010
|
||||
audienceRatingImage:
|
||||
type: string
|
||||
example: rottentomatoes://image.rating.upright
|
||||
chapterSource:
|
||||
type: string
|
||||
example: media
|
||||
primaryExtraKey:
|
||||
type: string
|
||||
example: /library/metadata/59399
|
||||
ratingImage:
|
||||
type: string
|
||||
example: rottentomatoes://image.rating.rotten
|
||||
Media:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
example: 120345
|
||||
duration:
|
||||
type: number
|
||||
example: 7474422
|
||||
bitrate:
|
||||
type: number
|
||||
example: 3623
|
||||
width:
|
||||
type: number
|
||||
example: 1920
|
||||
height:
|
||||
type: number
|
||||
example: 804
|
||||
aspectRatio:
|
||||
type: number
|
||||
example: 2.35
|
||||
audioChannels:
|
||||
type: number
|
||||
example: 6
|
||||
audioCodec:
|
||||
type: string
|
||||
example: ac3
|
||||
videoCodec:
|
||||
type: string
|
||||
example: h264
|
||||
videoResolution:
|
||||
type: number
|
||||
example: 1080
|
||||
container:
|
||||
type: string
|
||||
example: mp4
|
||||
videoFrameRate:
|
||||
type: string
|
||||
example: 24p
|
||||
optimizedForStreaming:
|
||||
type: number
|
||||
example: 0
|
||||
has64bitOffsets:
|
||||
type: boolean
|
||||
videoProfile:
|
||||
type: string
|
||||
example: high
|
||||
Part:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
example: 120353
|
||||
key:
|
||||
type: string
|
||||
example: /library/parts/120353/1681803203/file.mp4
|
||||
duration:
|
||||
type: number
|
||||
example: 7474422
|
||||
file:
|
||||
type: string
|
||||
example: /movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4
|
||||
size:
|
||||
type: number
|
||||
example: 3395307162
|
||||
container:
|
||||
type: string
|
||||
example: mp4
|
||||
has64bitOffsets:
|
||||
type: boolean
|
||||
hasThumbnail:
|
||||
type: number
|
||||
example: 1
|
||||
optimizedForStreaming:
|
||||
type: boolean
|
||||
videoProfile:
|
||||
type: string
|
||||
example: high
|
||||
Genre:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Comedy
|
||||
Director:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Peyton Reed
|
||||
Writer:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Jeff Loveness
|
||||
Country:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: United States of America
|
||||
Role:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Paul Rudd
|
||||
"400":
|
||||
$ref: "../../responses/400.yaml"
|
||||
"401":
|
||||
|
||||
@@ -108,6 +108,8 @@ paths:
|
||||
# Folder: pms/paths/hubs
|
||||
/hubs:
|
||||
$ref: "./paths/hubs/hubs.yaml"
|
||||
/hubs/home/recentlyAdded:
|
||||
$ref: "./paths/hubs/home/get-recently-added.yaml"
|
||||
/hubs/search:
|
||||
$ref: "./paths/hubs/search.yaml"
|
||||
/hubs/search/voice:
|
||||
|
||||
Reference in New Issue
Block a user