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

cleaned up Get Recently Added

Browse Source
This commit is contained in:
JasonLandbridge
2025-02-09 11:39:09 +01:00
parent c675101918
commit 3e91772f69
34 changed files with 11736 additions and 2713 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/models/Media-data.yaml
View File

@@ -4,8 +4,6 @@ items:
type: object
required:
- id
- hasVoiceActivity
- Part
properties:
id:
type: integer
@@ -173,9 +171,6 @@ items:
- streamType
- codec
- index
- language
- languageTag
- languageCode
- displayTitle
- extendedDisplayTitle
properties:
@@ -280,6 +275,9 @@ items:
format: int32
description: "Coded video width."
example: 3840
closedCaptions:
type: boolean
example: true
colorPrimaries:
type: string
description: "Color primaries used."
@@ -325,6 +323,9 @@ items:
scanType:
type: string
example: "progressive"
embeddedInVideo:
type: string
example: "progressive"
refFrames:
type: integer
format: int32

19
src/models/MediaContainer.yaml
View File

@@ -1,19 +0,0 @@
type: object
required:
- size
properties:
size:
type: integer
example: 50
offset:
type: integer
format: int32
totalSize:
type: integer
format: int32
identifier:
type: string
example: "com.plexapp.plugins.library"
allowSync:
type: boolean
example: false

6
src/models/country/filter.yaml Normal file
View File

@@ -0,0 +1,6 @@
type: object
description: "The filter query string for country media items."
properties:
filter:
type: string
example: "country=19"

8
src/models/country/id.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- id
description: "The identifier for the country"
properties:
id:
type: integer
example: 259

8
src/models/genre/filter.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- filter
description: "The filter query string for similar items."
properties:
filter:
type: string
example: "genre=19"

8
src/models/genre/id.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- id
description: "The identifier for the genre"
properties:
id:
type: integer
example: 259

8
src/models/meta-data/location/path.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- path
description: "The folder path for the media item."
properties:
path:
type: string
example: "/TV Shows/Clarkson's Farm"

2
src/models/meta-data/parent-slug.yaml
View File

@@ -1,6 +1,4 @@
type: object
required:
- parentSlug
properties:
parentSlug:
type: string

2
src/models/meta-data/parent-year.yaml
View File

@@ -1,6 +1,4 @@
type: object
required:
- parentYear
properties:
parentYear:
type: integer

2
src/models/meta-data/year.yaml
View File

@@ -1,6 +1,4 @@
type: object
required:
- year
properties:
year:
type: integer

8
src/models/producer/filter.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- filter
properties:
filter:
description: "The filter string used to query this producer."
type: string
example: "producer=126522"

8
src/models/producer/id.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- id
properties:
id:
description: "Unique identifier for the producer."
type: integer
example: 126522

6
src/models/producer/tag-key.yaml Normal file
View File

@@ -0,0 +1,6 @@
type: object
properties:
tagKey:
description: "A unique key associated with the producer's tag, used for internal identification."
type: string
example: "5d77683d85719b001f3a535e"

8
src/models/producer/tag.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- tag
properties:
tag:
description: "The name of the producer"
type: string
example: "Amelia Knapp"

6
src/models/producer/thumb.yaml Normal file
View File

@@ -0,0 +1,6 @@
type: object
properties:
thumb:
description: "The URL of the thumbnail image for the actor."
type: string
example: "https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg"

10
src/models/rating/image.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
required:
- image
description: "The URL for the rating image, for example from IMDb."
properties:
image:
type: string
example: "imdb://image.rating"

10
src/models/rating/type.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
required:
- type
description: "The type of rating, for example 'audience' or 'critic'."
properties:
type:
type: string
example: "audience"

10
src/models/rating/value.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
required:
- value
description: "The numerical rating value."
properties:
value:
type: number
example: 5.1

8
src/models/role/filter.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- filter
properties:
filter:
description: "The filter string used to query this actor. For example, it may indicate that this is an actor with a given key."
type: string
example: "actor=126522"

8
src/models/role/id.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- id
properties:
id:
description: "Unique identifier for the actor or role."
type: integer
example: 126522

6
src/models/role/role.yaml Normal file
View File

@@ -0,0 +1,6 @@
type: object
properties:
role:
description: "The role played by the actor in the media item."
type: string
example: "Self - Judge"

6
src/models/role/tag-key.yaml Normal file
View File

@@ -0,0 +1,6 @@
type: object
properties:
tagKey:
description: "A unique key associated with the actor's tag, used for internal identification."
type: string
example: "5d77683d85719b001f3a535e"

4
src/models/role/tag.yaml
View File

@@ -3,6 +3,6 @@ required:
- tag
properties:
tag:
description: "The display tag for the actor (typically the actor's name)."
type: string
description: The name of the actor for this role
example: Danny Boyle
example: "Teller"

6
src/models/role/thumb.yaml Normal file
View File

@@ -0,0 +1,6 @@
type: object
properties:
thumb:
description: "The URL of the thumbnail image for the actor."
type: string
example: "https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg"

10
src/models/similar/filter.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
required:
- filter
description: "The filter query string for similar items."
properties:
filter:
type: string
example: "similar=259"

10
src/models/similar/id.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
required:
- id
description: "The identifier for the similar media item."
properties:
id:
type: integer
example: 259

10
src/models/similar/tag.yaml Normal file
View File

@@ -0,0 +1,10 @@
type: object
required:
- tag
description: "The display tag for the similar item, typically the title."
properties:
tag:
type: string
example: "Criss Angel Mindfreak"

8
src/models/writer/filter.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- filter
properties:
filter:
description: "The filter string used to query this writer."
type: string
example: "writer=126522"

8
src/models/writer/id.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
required:
- id
properties:
id:
description: "Unique identifier for the writer."
type: integer
example: 126522

6
src/models/writer/tag-key.yaml Normal file
View File

@@ -0,0 +1,6 @@
type: object
properties:
tagKey:
description: "A unique key associated with the writers tag, used for internal identification."
type: string
example: "5d77683d85719b001f3a535e"

2
src/models/writer/tag.yaml
View File

@@ -5,4 +5,4 @@ properties:
tag:
type: string
description: The role of Writer
example: Danny Boyle
example: Jamie P. Hanson

160
src/paths/hubs/home/get-recently-added.yaml
View File

@@ -33,15 +33,171 @@ get:
properties:
MediaContainer:
allOf:
- $ref: "../../../models/MediaContainer.yaml"
- $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/identifier.yaml"
- type: object
properties:
Meta:
$ref: "../../../models/Meta.yaml"
Metadata:
type: array
description: "An array of metadata items."
items:
$ref: "../../../models/MetaData.yaml"
required:
- type
allOf:
- $ref: "../../../models/meta-data/added-at.yaml"
- $ref: "../../../models/meta-data/art.yaml"
- $ref: "../../../models/meta-data/audience-rating-image.yaml"
- $ref: "../../../models/meta-data/audience-rating.yaml"
- $ref: "../../../models/meta-data/chapter-source.yaml"
- $ref: "../../../models/meta-data/child-count.yaml"
- $ref: "../../../models/meta-data/content-rating.yaml"
- $ref: "../../../models/meta-data/created-at-accuracy.yaml"
- $ref: "../../../models/meta-data/created-at-tz-offset.yaml"
- $ref: "../../../models/meta-data/duration.yaml"
- $ref: "../../../models/meta-data/grandparent-art.yaml"
- $ref: "../../../models/meta-data/grandparent-guid.yaml"
- $ref: "../../../models/meta-data/grandparent-key.yaml"
- $ref: "../../../models/meta-data/grandparent-rating-key.yaml"
- $ref: "../../../models/meta-data/grandparent-slug.yaml"
- $ref: "../../../models/meta-data/grandparent-theme.yaml"
- $ref: "../../../models/meta-data/grandparent-thumb.yaml"
- $ref: "../../../models/meta-data/grandparent-title.yaml"
- $ref: "../../../models/meta-data/guid.yaml"
- $ref: "../../../models/meta-data/index.yaml"
- $ref: "../../../models/meta-data/key.yaml"
- $ref: "../../../models/meta-data/last-rated-at.yaml"
- $ref: "../../../models/meta-data/last-viewed-at.yaml"
- $ref: "../../../models/meta-data/leaf-count.yaml"
- $ref: "../../../models/meta-data/library-section-id.yaml"
- $ref: "../../../models/meta-data/library-section-key.yaml"
- $ref: "../../../models/meta-data/library-section-title.yaml"
- $ref: "../../../models/meta-data/original-title.yaml"
- $ref: "../../../models/meta-data/originally-available-at.yaml"
- $ref: "../../../models/meta-data/parent-guid.yaml"
- $ref: "../../../models/meta-data/parent-index.yaml"
- $ref: "../../../models/meta-data/parent-key.yaml"
- $ref: "../../../models/meta-data/parent-rating-key.yaml"
- $ref: "../../../models/meta-data/parent-slug.yaml"
- $ref: "../../../models/meta-data/parent-studio.yaml"
- $ref: "../../../models/meta-data/parent-theme.yaml"
- $ref: "../../../models/meta-data/parent-thumb.yaml"
- $ref: "../../../models/meta-data/parent-title.yaml"
- $ref: "../../../models/meta-data/parent-year.yaml"
- $ref: "../../../models/meta-data/primary-extra-key.yaml"
- $ref: "../../../models/meta-data/rating-image.yaml"
- $ref: "../../../models/meta-data/rating-key.yaml"
- $ref: "../../../models/meta-data/rating.yaml"
- $ref: "../../../models/meta-data/season-count.yaml"
- $ref: "../../../models/meta-data/skip-count.yaml"
- $ref: "../../../models/meta-data/slug.yaml"
- $ref: "../../../models/meta-data/studio.yaml"
- $ref: "../../../models/meta-data/subtype.yaml"
- $ref: "../../../models/meta-data/summary.yaml"
- $ref: "../../../models/meta-data/tagline.yaml"
- $ref: "../../../models/meta-data/theme.yaml"
- $ref: "../../../models/meta-data/thumb.yaml"
- $ref: "../../../models/meta-data/title-sort.yaml"
- $ref: "../../../models/meta-data/title.yaml"
- $ref: "../../../models/meta-data/type.yaml"
- $ref: "../../../models/meta-data/updated-at.yaml"
- $ref: "../../../models/meta-data/user-rating.yaml"
- $ref: "../../../models/meta-data/view-count.yaml"
- $ref: "../../../models/meta-data/view-offset.yaml"
- $ref: "../../../models/meta-data/viewed-leaf-count.yaml"
- $ref: "../../../models/meta-data/year.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/genre/id.yaml"
- $ref: "../../../models/genre/filter.yaml"
- $ref: "../../../models/genre/tag.yaml"
Country:
type: array
items:
allOf:
- $ref: "../../../models/country/id.yaml"
- $ref: "../../../models/country/tag.yaml"
- $ref: "../../../models/country/filter.yaml"
Director:
type: array
items:
allOf:
- $ref: "../../../models/director/tag.yaml"
Writer:
type: array
items:
allOf:
- $ref: "../../../models/writer/id.yaml"
- $ref: "../../../models/writer/filter.yaml"
- $ref: "../../../models/writer/tag.yaml"
- $ref: "../../../models/writer/tag-key.yaml"
Role:
type: array
items:
allOf:
- $ref: "../../../models/role/id.yaml"
- $ref: "../../../models/role/filter.yaml"
- $ref: "../../../models/role/tag.yaml"
- $ref: "../../../models/role/tag-key.yaml"
- $ref: "../../../models/role/role.yaml"
- $ref: "../../../models/role/thumb.yaml"
Producer:
type: array
items:
allOf:
- $ref: "../../../models/producer/id.yaml"
- $ref: "../../../models/producer/filter.yaml"
- $ref: "../../../models/producer/tag.yaml"
- $ref: "../../../models/producer/tag-key.yaml"
- $ref: "../../../models/producer/thumb.yaml"
Rating:
type: array
items:
allOf:
- $ref: "../../../models/rating/image.yaml"
- $ref: "../../../models/rating/value.yaml"
- $ref: "../../../models/rating/type.yaml"
Similar:
type: array
items:
allOf:
- $ref: "../../../models/similar/id.yaml"
- $ref: "../../../models/similar/filter.yaml"
- $ref: "../../../models/similar/tag.yaml"
Location:
type: array
items:
allOf:
- $ref: "../../../models/meta-data/location/path.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"
"401":
description: Unauthorized, invalid Plex token.

2
src/paths/library/[sectionKey]/get-library-all.yaml
View File

@@ -119,7 +119,7 @@ get:
type: array
items:
allOf:
- $ref: "../../../models/country/tag.yaml"
- $ref: "../../../models/genre/tag.yaml"
Country:
type: array
items:

14055
tests/paths/hubs/home/get-recently-added.spec.ts
View File

File diff suppressed because it is too large Load Diff