mirror of
https://github.com/LukeHagar/plex-api-spec.git
synced 2025-12-10 12:37:44 +00:00
cleanup
This commit is contained in:
@@ -1,19 +1,23 @@
|
|||||||
type: integer
|
type: integer
|
||||||
x-speakeasy-unknown-values: allow
|
x-speakeasy-unknown-values: allow
|
||||||
enum:
|
enum:
|
||||||
- 1
|
- 1 # MOVIE
|
||||||
- 2
|
- 2 # TV_SHOW
|
||||||
- 3
|
- 3 # SEASON
|
||||||
- 4
|
- 4 # EPISODE
|
||||||
- 8
|
- 5 # ARTIST
|
||||||
- 9
|
- 6 # ALBUM
|
||||||
- 10
|
- 7 # TRACK
|
||||||
|
- 8 # PHOTO_ALBUM
|
||||||
|
- 9 # PHOTO
|
||||||
example: 2
|
example: 2
|
||||||
x-speakeasy-enums:
|
x-speakeasy-enums:
|
||||||
- MOVIE
|
- MOVIE
|
||||||
- TV_SHOW
|
- TV_SHOW
|
||||||
- SEASON
|
- SEASON
|
||||||
- EPISODE
|
- EPISODE
|
||||||
- AUDIO
|
- ARTIST
|
||||||
- ALBUM
|
- ALBUM
|
||||||
- TRACK
|
- TRACK
|
||||||
|
- PHOTO_ALBUM
|
||||||
|
- PHOTO
|
||||||
|
|||||||
@@ -7,9 +7,13 @@ enum:
|
|||||||
- episode
|
- episode
|
||||||
- artist
|
- artist
|
||||||
- album
|
- album
|
||||||
|
- track
|
||||||
|
- photoalbum
|
||||||
|
- photo
|
||||||
|
- collection
|
||||||
example: "movie"
|
example: "movie"
|
||||||
description: |
|
description: |
|
||||||
The type of media content
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
x-speakeasy-enums:
|
x-speakeasy-enums:
|
||||||
- MOVIE
|
- MOVIE
|
||||||
- TV_SHOW
|
- TV_SHOW
|
||||||
@@ -17,3 +21,7 @@ x-speakeasy-enums:
|
|||||||
- EPISODE
|
- EPISODE
|
||||||
- ARTIST
|
- ARTIST
|
||||||
- ALBUM
|
- ALBUM
|
||||||
|
- TRACK
|
||||||
|
- PHOTO_ALBUM
|
||||||
|
- PHOTO
|
||||||
|
- COLLECTION
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
|
required:
|
||||||
|
- filter
|
||||||
description: "The filter query string for country media items."
|
description: "The filter query string for country media items."
|
||||||
properties:
|
properties:
|
||||||
filter:
|
filter:
|
||||||
|
|||||||
@@ -6,4 +6,5 @@ properties:
|
|||||||
id:
|
id:
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
minimum: 1
|
||||||
example: 259
|
example: 259
|
||||||
|
|||||||
@@ -6,4 +6,5 @@ properties:
|
|||||||
description: "Unique identifier for the director."
|
description: "Unique identifier for the director."
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
minimum: 1
|
||||||
example: 126522
|
example: 126522
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
type: object
|
type: object
|
||||||
|
required:
|
||||||
|
- tagKey
|
||||||
properties:
|
properties:
|
||||||
tagKey:
|
tagKey:
|
||||||
description: "A unique key associated with the director's tag, used for internal identification."
|
description: "A unique 24-character hexadecimal key associated with the director's tag, used for internal identification."
|
||||||
type: string
|
type: string
|
||||||
pattern: "^[a-fA-F0-9]{24}$"
|
pattern: "^[a-fA-F0-9]{24}$"
|
||||||
example: "5d776831151a60001f24d031"
|
example: "5d776831151a60001f24d031"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
thumb:
|
thumb:
|
||||||
description: "The URL of the thumbnail image for the director."
|
description: "The absolute URL of the thumbnail image for the director."
|
||||||
type: string
|
type: string
|
||||||
example: "https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg"
|
example: "https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg"
|
||||||
|
|||||||
@@ -5,4 +5,6 @@ description: "The identifier for the genre"
|
|||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: integer
|
type: integer
|
||||||
|
format: int32
|
||||||
|
minimum: 1
|
||||||
example: 259
|
example: 259
|
||||||
|
|||||||
@@ -6,4 +6,5 @@ properties:
|
|||||||
description: "Unique identifier for the producer."
|
description: "Unique identifier for the producer."
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
minimum: 1
|
||||||
example: 126522
|
example: 126522
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
type: object
|
type: object
|
||||||
|
required:
|
||||||
|
- tagKey
|
||||||
properties:
|
properties:
|
||||||
tagKey:
|
tagKey:
|
||||||
description: "A unique key associated with the producer's tag, used for internal identification."
|
description: "A 24-character hexadecimal unique key associated with the producer's tag, used for internal identification."
|
||||||
type: string
|
type: string
|
||||||
pattern: "^[a-fA-F0-9]{24}$"
|
pattern: "^[a-fA-F0-9]{24}$"
|
||||||
example: "5d77683d85719b001f3a535e"
|
example: "5d77683d85719b001f3a535e"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
thumb:
|
thumb:
|
||||||
description: "The URL of the thumbnail image for the actor."
|
description: "The absolute URL of the thumbnail image for the actor."
|
||||||
type: string
|
type: string
|
||||||
example: "https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg"
|
example: "https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg"
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- value
|
- value
|
||||||
@@ -6,5 +5,5 @@ description: "The numerical rating value."
|
|||||||
properties:
|
properties:
|
||||||
value:
|
value:
|
||||||
type: number
|
type: number
|
||||||
|
format: float
|
||||||
example: 5.1
|
example: 5.1
|
||||||
|
|
||||||
|
|||||||
@@ -5,4 +5,6 @@ properties:
|
|||||||
id:
|
id:
|
||||||
description: "Unique identifier for the actor or role."
|
description: "Unique identifier for the actor or role."
|
||||||
type: integer
|
type: integer
|
||||||
|
format: int32
|
||||||
|
minimum: 1
|
||||||
example: 126522
|
example: 126522
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
type: object
|
type: object
|
||||||
|
required:
|
||||||
|
- tagKey
|
||||||
properties:
|
properties:
|
||||||
tagKey:
|
tagKey:
|
||||||
description: "A unique key associated with the actor's tag, used for internal identification."
|
description: "A 24-character hexadecimal unique key associated with the actor's tag, used for internal identification."
|
||||||
type: string
|
type: string
|
||||||
|
pattern: "^[a-fA-F0-9]{24}$"
|
||||||
example: "5d77683d85719b001f3a535e"
|
example: "5d77683d85719b001f3a535e"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
thumb:
|
thumb:
|
||||||
description: "The URL of the thumbnail image for the actor."
|
description: "The absolute URL of the thumbnail image for the actor."
|
||||||
type: string
|
type: string
|
||||||
example: "https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg"
|
example: "https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg"
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- filter
|
- filter
|
||||||
@@ -7,4 +6,3 @@ properties:
|
|||||||
filter:
|
filter:
|
||||||
type: string
|
type: string
|
||||||
example: "similar=259"
|
example: "similar=259"
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- id
|
- id
|
||||||
@@ -6,5 +5,6 @@ description: "The identifier for the similar media item."
|
|||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
type: integer
|
type: integer
|
||||||
|
format: int32
|
||||||
|
minimum: 1
|
||||||
example: 259
|
example: 259
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,3 @@
|
|||||||
|
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- tag
|
- tag
|
||||||
@@ -7,4 +6,3 @@ properties:
|
|||||||
tag:
|
tag:
|
||||||
type: string
|
type: string
|
||||||
example: "Criss Angel Mindfreak"
|
example: "Criss Angel Mindfreak"
|
||||||
|
|
||||||
|
|||||||
@@ -6,4 +6,5 @@ properties:
|
|||||||
description: "Unique identifier for the writer."
|
description: "Unique identifier for the writer."
|
||||||
type: integer
|
type: integer
|
||||||
format: int32
|
format: int32
|
||||||
|
minimum: 1
|
||||||
example: 126522
|
example: 126522
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
type: object
|
type: object
|
||||||
|
required:
|
||||||
|
- tagKey
|
||||||
properties:
|
properties:
|
||||||
tagKey:
|
tagKey:
|
||||||
description: "A unique key associated with the writers tag, used for internal identification."
|
description: "A 24-character hexadecimal unique key associated with the writers tag, used for internal identification."
|
||||||
type: string
|
type: string
|
||||||
pattern: "^[a-fA-F0-9]{24}$"
|
pattern: "^[a-fA-F0-9]{24}$"
|
||||||
example: "5d77683d85719b001f3a535e"
|
example: "5d77683d85719b001f3a535e"
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
thumb:
|
thumb:
|
||||||
description: "The URL of the thumbnail image for the writer."
|
description: "The absolute URL of the thumbnail image for the writer."
|
||||||
type: string
|
type: string
|
||||||
example: "https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg"
|
example: "https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg"
|
||||||
|
|||||||
Reference in New Issue
Block a user