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

added test and fixes for get-library-all

Browse Source 
corrected get-media-meta-data response
This commit is contained in:
JasonLandbridge
2025-02-06 22:48:23 +01:00
parent 70e85b90e2
commit 457d3aa023
98 changed files with 80138 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

164
src/paths/library/[sectionKey]/get-library-all.yaml Normal file
View File

@@ -0,0 +1,164 @@
get:
tags:
- Library
summary: Get all media of library
operationId: get-all-media-library
description: |
Retrieves a list of all general media data for this library.
parameters:
- $ref: "../../../parameters/library/section-key.yaml"
- $ref: "../../../parameters/type.yaml"
- $ref: "../../../parameters/include-meta.yaml"
- $ref: "../../../parameters/include-guids.yaml"
- $ref: "../../../parameters/include-advanced.yaml"
- $ref: "../../../parameters/include-collections.yaml"
- $ref: "../../../parameters/include-external-media.yaml"
- $ref: "../../../parameters/container-start.yaml"
- $ref: "../../../parameters/container-size.yaml"
- $ref: "../../../parameters/accept-application-json.yaml"
responses:
"200":
description: Successful response containing media container data.
content:
application/json:
schema:
type: object
properties:
MediaContainer:
allOf:
- $ref: "../../../models/media-container/size.yaml"
- $ref: "../../../models/media-container/total-size.yaml"
- $ref: "../../../models/media-container/offset.yaml"
- $ref: "../../../models/media-container/allow-sync.yaml"
- $ref: "../../../models/media-container/art.yaml"
- $ref: "../../../models/media-container/content.yaml"
- $ref: "../../../models/media-container/identifier.yaml"
- $ref: "../../../models/media-container/library-section-id.yaml"
- $ref: "../../../models/media-container/library-section-title.yaml"
- $ref: "../../../models/media-container/library-section-uuid.yaml"
- $ref: "../../../models/media-container/media-tag-prefix.yaml"
- $ref: "../../../models/media-container/media-tag-version.yaml"
- $ref: "../../../models/media-container/thumb.yaml"
- $ref: "../../../models/media-container/nocache.yaml"
- $ref: "../../../models/media-container/title1.yaml"
- $ref: "../../../models/media-container/title2.yaml"
- $ref: "../../../models/media-container/view-group.yaml"
- type: object
properties:
Meta:
$ref: "../../../models/Meta.yaml"
Metadata:
type: array
description: "An array of metadata items."
items:
required:
- type
allOf:
- $ref: "../../../models/meta-data/rating-key.yaml"
- $ref: "../../../models/meta-data/key.yaml"
- $ref: "../../../models/meta-data/guid.yaml"
- $ref: "../../../models/meta-data/slug.yaml"
- $ref: "../../../models/meta-data/studio.yaml"
- $ref: "../../../models/meta-data/type.yaml"
- $ref: "../../../models/meta-data/title.yaml"
- $ref: "../../../models/meta-data/title-sort.yaml"
- $ref: "../../../models/meta-data/content-rating.yaml"
- $ref: "../../../models/meta-data/summary.yaml"
- $ref: "../../../models/meta-data/rating.yaml"
- $ref: "../../../models/meta-data/audience-rating.yaml"
- $ref: "../../../models/meta-data/year.yaml"
- $ref: "../../../models/meta-data/tagline.yaml"
- $ref: "../../../models/meta-data/thumb.yaml"
- $ref: "../../../models/meta-data/art.yaml"
- $ref: "../../../models/meta-data/theme.yaml"
- $ref: "../../../models/meta-data/index.yaml"
- $ref: "../../../models/meta-data/leaf-count.yaml"
- $ref: "../../../models/meta-data/viewed-leaf-count.yaml"
- $ref: "../../../models/meta-data/child-count.yaml"
- $ref: "../../../models/meta-data/season-count.yaml"
- $ref: "../../../models/meta-data/duration.yaml"
- $ref: "../../../models/meta-data/originally-available-at.yaml"
- $ref: "../../../models/meta-data/added-at.yaml"
- $ref: "../../../models/meta-data/updated-at.yaml"
- $ref: "../../../models/meta-data/audience-rating-image.yaml"
- $ref: "../../../models/meta-data/chapter-source.yaml"
- $ref: "../../../models/meta-data/primary-extra-key.yaml"
- $ref: "../../../models/meta-data/original-title.yaml"
- $ref: "../../../models/meta-data/parent-rating-key.yaml"
- $ref: "../../../models/meta-data/grandparent-rating-key.yaml"
- $ref: "../../../models/meta-data/parent-guid.yaml"
- $ref: "../../../models/meta-data/grandparent-guid.yaml"
- $ref: "../../../models/meta-data/grandparent-slug.yaml"
- $ref: "../../../models/meta-data/grandparent-key.yaml"
- $ref: "../../../models/meta-data/parent-key.yaml"
- $ref: "../../../models/meta-data/grandparent-title.yaml"
- $ref: "../../../models/meta-data/grandparent-thumb.yaml"
- $ref: "../../../models/meta-data/grandparent-theme.yaml"
- $ref: "../../../models/meta-data/grandparent-art.yaml"
- $ref: "../../../models/meta-data/parent-title.yaml"
- $ref: "../../../models/meta-data/parent-index.yaml"
- $ref: "../../../models/meta-data/parent-thumb.yaml"
- $ref: "../../../models/meta-data/rating-image.yaml"
- $ref: "../../../models/meta-data/view-count.yaml"
- $ref: "../../../models/meta-data/view-offset.yaml"
- $ref: "../../../models/meta-data/skip-count.yaml"
- $ref: "../../../models/meta-data/subtype.yaml"
- $ref: "../../../models/meta-data/last-rated-at.yaml"
- $ref: "../../../models/meta-data/created-at-accuracy.yaml"
- $ref: "../../../models/meta-data/created-at-tz-offset.yaml"
- $ref: "../../../models/meta-data/last-viewed-at.yaml"
- $ref: "../../../models/meta-data/user-rating.yaml"
- $ref: "../../../models/meta-data/objects/image.yaml"
- $ref: "../../../models/meta-data/objects/ultra-blur-colors.yaml"
- type: object
properties:
Media:
allOf:
- $ref: "../../../models/Media-data.yaml"
Genre:
type: array
items:
allOf:
- $ref: "../../../models/country/tag.yaml"
Country:
type: array
items:
allOf:
- $ref: "../../../models/country/tag.yaml"
Director:
type: array
items:
allOf:
- $ref: "../../../models/director/tag.yaml"
Writer:
type: array
items:
allOf:
- $ref: "../../../models/writer/tag.yaml"
Role:
type: array
items:
allOf:
- $ref: "../../../models/role/tag.yaml"
Guid:
x-speakeasy-name-override: guids
type: array
items:
type: object
properties:
id:
type: string
description: |
The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337
example: tvdb://2337
Collection:
type: array
items:
allOf:
- $ref: "../../../models/collection/tag.yaml"
"400":
$ref: "../../../responses/400.yaml"
"401":
$ref: "../../../responses/401.yaml"
"404":
$ref: "../../../responses/404-html.yaml"

53
src/paths/library/[sectionKey]/get-library-countries.yaml
View File

@@ -19,49 +19,20 @@ get:
properties:
MediaContainer:
allOf:
- $ref: "../../../models/MediaContainer.yaml"
- $ref: "../../../models/media-container/size.yaml"
- $ref: "../../../models/media-container/allow-sync.yaml"
- $ref: "../../../models/media-container/art.yaml"
- $ref: "../../../models/media-container/content.yaml"
- $ref: "../../../models/media-container/identifier.yaml"
- $ref: "../../../models/media-container/media-tag-prefix.yaml"
- $ref: "../../../models/media-container/media-tag-version.yaml"
- $ref: "../../../models/media-container/nocache.yaml"
- $ref: "../../../models/media-container/thumb.yaml"
- $ref: "../../../models/media-container/title1.yaml"
- $ref: "../../../models/media-container/title2.yaml"
- $ref: "../../../models/media-container/view-group.yaml"
- type: object
required:
- size
- allowSync
- art
- content
- identifier
- mediaTagPrefix
- mediaTagVersion
- nocache
- thumb
- title1
- title2
- viewGroup
properties:
art:
type: string
example: "/:/resources/show-fanart.jpg"
content:
type: string
example: "secondary"
mediaTagPrefix:
type: string
example: "/system/bundle/media/flags/"
mediaTagVersion:
type: integer
example: 1734362201
nocache:
type: boolean
example: true
thumb:
type: string
example: "/:/resources/show.png"
title1:
type: string
example: "TV Series"
title2:
type: string
example: "By Country"
viewGroup:
type: string
example: "secondary"
Directory:
type: array
items:

53
src/paths/library/[sectionKey]/get-library-genres.yaml
View File

@@ -19,49 +19,20 @@ get:
properties:
MediaContainer:
allOf:
- $ref: "../../../models/MediaContainer.yaml"
- $ref: "../../../models/media-container/size.yaml"
- $ref: "../../../models/media-container/allow-sync.yaml"
- $ref: "../../../models/media-container/art.yaml"
- $ref: "../../../models/media-container/content.yaml"
- $ref: "../../../models/media-container/identifier.yaml"
- $ref: "../../../models/media-container/media-tag-prefix.yaml"
- $ref: "../../../models/media-container/media-tag-version.yaml"
- $ref: "../../../models/media-container/nocache.yaml"
- $ref: "../../../models/media-container/thumb.yaml"
- $ref: "../../../models/media-container/title1.yaml"
- $ref: "../../../models/media-container/title2.yaml"
- $ref: "../../../models/media-container/view-group.yaml"
- type: object
required:
- size
- allowSync
- art
- content
- identifier
- mediaTagPrefix
- mediaTagVersion
- nocache
- thumb
- title1
- title2
- viewGroup
properties:
art:
type: string
example: "/:/resources/show-fanart.jpg"
content:
type: string
example: "secondary"
mediaTagPrefix:
type: string
example: "/system/bundle/media/flags/"
mediaTagVersion:
type: integer
example: 1734362201
nocache:
type: boolean
example: true
thumb:
type: string
example: "/:/resources/show.png"
title1:
type: string
example: "TV Shows (Reality)"
title2:
type: string
example: "By Genre"
viewGroup:
type: string
example: "secondary"
Directory:
type: array
items:

4
src/paths/library/[sectionKey]/get-library-items.yaml
View File

@@ -33,7 +33,6 @@ get:
schema:
type: string
enum:
- all
- unwatched
- newest
- recentlyAdded
@@ -41,12 +40,9 @@ get:
- onDeck
- collection
- edition
- genre
- year
- decade
- director
- actor
- country
- contentRating
- rating
- resolution

32
src/paths/library/metadata/[ratingKey]/get-media-meta-data.yaml
View File

@@ -140,21 +140,15 @@ get:
- librarySectionTitle
- librarySectionID
- librarySectionKey
- contentRating
- summary
- audienceRating
- year
- thumb
- art
- duration
- originallyAvailableAt
- addedAt
- updatedAt
- audienceRatingImage
- Image
- UltraBlurColors
- Guid
- Rating
properties:
ratingKey:
type: string
@@ -268,7 +262,17 @@ get:
year:
type: integer
description: "The release year."
format: int32
example: 2015
rating:
type: number
format: float
description: "The general rating"
example: 6.0
ratingImage:
type: string
description: "The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image)."
example: "rottentomatoes://image.rating.ripe"
tagline:
type: string
description: "The tagline of the content."
@@ -295,6 +299,7 @@ get:
type: integer
description: "Duration of the content in milliseconds."
example: 2700000
format: int32
originallyAvailableAt:
type: string
format: date
@@ -311,15 +316,16 @@ get:
childCount:
type: integer
description: "The number of child items."
format: int32
example: 6
addedAt:
type: integer
description: "Unix timestamp when the item was added."
example: 1625505101
allOf:
- description: "Unix timestamp when the item was added."
- $ref: "../../../../models/common/PlexDateTime.yaml"
updatedAt:
type: integer
description: "Unix timestamp when the item was last updated."
example: 1736487993
allOf:
- description: "Unix timestamp when the item was last updated."
- $ref: "../../../../models/common/PlexDateTime.yaml"
audienceRatingImage:
type: string
description: "The URL for the audience rating image."
@@ -424,6 +430,7 @@ get:
id:
type: integer
description: "The unique country identifier."
format: int32
example: 58591
filter:
type: string
@@ -447,6 +454,7 @@ get:
description: "The GUID value."
example: "imdb://tt3032476"
Rating:
x-speakeasy-name-override: Ratings
type: array
description: "An array of rating objects."
items: