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

refactor: update includeGuids parameter and restructure MediaContainer properties in YAML files

Browse Source
This commit is contained in:
JasonLandbridge
2025-06-03 13:54:07 +02:00
parent 315ef8fd2f
commit 687a36687b
1 changed files with 178 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

374
src/paths/library/content-top.yaml
View File

@@ -6,15 +6,8 @@ get:
This endpoint will return the top watched content from libraries of a certain type This endpoint will return the top watched content from libraries of a certain type
operationId: getTopWatchedContent operationId: getTopWatchedContent
parameters: parameters:
- name: includeGuids
in: query
description: |
Adds the Guids object to the response
schema:
type: integer
required: false
example: 1
- $ref: "../../parameters/type.yaml" - $ref: "../../parameters/type.yaml"
- $ref: "../../parameters/include-guids.yaml"
responses: responses:
"200": "200":
description: The metadata of the library item. description: The metadata of the library item.
@@ -24,194 +17,183 @@ get:
type: object type: object
properties: properties:
MediaContainer: MediaContainer:
type: object allOf:
properties: - $ref: "../../models/media-container/size.yaml"
size: - $ref: "../../models/media-container/allow-sync.yaml"
type: integer - $ref: "../../models/media-container/identifier.yaml"
format: int32 - $ref: "../../models/media-container/media-tag-prefix.yaml"
example: 1 - $ref: "../../models/media-container/media-tag-version.yaml"
allowSync: - type: object
type: boolean properties:
example: true Metadata:
identifier: type: array
type: string items:
example: com.plexapp.plugins.library type: object
mediaTagPrefix: properties:
type: string ratingKey:
example: /system/bundle/media/flags/ type: string
mediaTagVersion: example: "17"
type: integer key:
format: int32 type: string
example: 1698860922 example: /library/metadata/17
Metadata: guid:
type: array type: string
items: example: plex://movie/5d77683f6f4521001ea9dc53
type: object slug:
properties: type: string
ratingKey: example: waterloo-road
type: string studio:
example: "17" type: string
key: example: Universal Pictures
type: string type:
example: /library/metadata/17 type: string
guid: example: movie
type: string title:
example: plex://movie/5d77683f6f4521001ea9dc53 type: string
slug: example: Serenity
type: string librarySectionTitle:
example: waterloo-road type: string
studio: example: Movies
type: string librarySectionID:
example: Universal Pictures type: integer
type: format: int32
type: string example: 1
example: movie librarySectionKey:
title: type: string
type: string example: /library/sections/1
example: Serenity contentRating:
librarySectionTitle: type: string
type: string example: PG-13
example: Movies summary:
librarySectionID: type: string
type: integer example:
format: int32 Serenity continues the story of the TV series it was based upon
example: 1 ("Firefly"). River Tam had a secret - one in which she's not
librarySectionKey: even aware - so dangerous, no one's safe, as an Alliance
type: string operative's sent to capture her, and all others are considered
example: /library/sections/1 irrelevant to his job.
contentRating: index:
type: string type: integer
example: PG-13 example: 1
summary: audienceRating:
type: string type: number
example: example: 9.1
Serenity continues the story of the TV series it was based upon year:
("Firefly"). River Tam had a secret - one in which she's not type: integer
even aware - so dangerous, no one's safe, as an Alliance format: int32
operative's sent to capture her, and all others are considered example: 2005
irrelevant to his job. tagline:
index: type: string
type: integer example: They aim to misbehave.
example: 1 thumb:
audienceRating: type: string
type: number example: /library/metadata/17/thumb/1705637165
example: 9.1 art:
year: type: string
type: integer example: /library/metadata/17/art/1705637165
format: int32 duration:
example: 2005 type: integer
tagline: format: int32
type: string example: 141417
example: They aim to misbehave. originallyAvailableAt:
thumb: type: string
type: string format: date
example: /library/metadata/17/thumb/1705637165 example: 2005-09-29
art: leafCount:
type: string type: integer
example: /library/metadata/17/art/1705637165 example: 222
duration: viewedLeafCount:
type: integer type: integer
format: int32 example: 100
example: 141417 childCount:
originallyAvailableAt: type: integer
type: string example: 13
format: date addedAt:
example: 2005-09-29 type: integer
leafCount: format: int32
type: integer example: 1705637164
example: 222 updatedAt:
viewedLeafCount: type: integer
type: integer format: int32
example: 100 example: 1705637165
childCount: globalViewCount:
type: integer type: integer
example: 13 example: 80
addedAt: audienceRatingImage:
type: integer type: string
format: int32 example: rottentomatoes://image.rating.upright
example: 1705637164 Genre:
updatedAt: type: array
type: integer items:
format: int32 type: object
example: 1705637165 properties:
globalViewCount: id:
type: integer type: integer
example: 80 format: int32
audienceRatingImage: example: 184
type: string filter:
example: rottentomatoes://image.rating.upright type: string
Genre: example: genre=184
type: array tag:
items: type: string
type: object example: Thriller
properties: Country:
id: type: array
type: integer items:
format: int32 type: object
example: 184 properties:
filter: id:
type: string type: integer
example: genre=184 format: int32
tag: example: 116
type: string filter:
example: Thriller type: string
Country: example: country=116
type: array tag:
items: type: string
type: object example: United States of America
properties: Guid:
id: x-speakeasy-name-override: guids
type: integer type: array
format: int32 items:
example: 116 type: object
filter: properties:
type: string id:
example: country=116 type: string
tag: example: tvdb://2337
type: string Role:
example: United States of America type: array
Guid: items:
x-speakeasy-name-override: guids type: object
type: array properties:
items: id:
type: object type: integer
properties: format: int32
id: example: 220
type: string filter:
example: tvdb://2337 type: string
Role: example: actor=220
type: array tag:
items: type: string
type: object example: Dennis Keiffer
properties: tagKey:
id: type: string
type: integer example: 5d77683554f42c001f8c4708
format: int32 role:
example: 220 type: string
filter: example: Bar Guy (uncredited)
type: string thumb:
example: actor=220 type: string
tag: example: https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg
type: string User:
example: Dennis Keiffer type: array
tagKey: items:
type: string type: object
example: 5d77683554f42c001f8c4708 properties:
role: id:
type: string type: integer
example: Bar Guy (uncredited) format: int32
thumb: example: 220
type: string
example: https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg
User:
type: array
items:
type: object
properties:
id:
type: integer
format: int32
example: 220
"400": "400":
$ref: "../../responses/400.yaml" $ref: "../../responses/400.yaml"
"401": "401":