mirror of
https://github.com/LukeHagar/plex-docs.git
synced 2025-12-06 04:20:40 +00:00
Updating OpenAPI Spec
This commit is contained in:
lukehagar
@@ -2031,6 +2031,171 @@ paths:
|
||||
example: 401
|
||||
'403':
|
||||
description: the user was not signed in
|
||||
/myplex/account:
|
||||
get:
|
||||
tags:
|
||||
- MyPlex
|
||||
summary: Get MyPlex Account
|
||||
description: Returns MyPlex Account Information
|
||||
operationId: getMyPlexAccount
|
||||
responses:
|
||||
'200':
|
||||
description: MyPlex Account
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
MyPlex:
|
||||
type: object
|
||||
properties:
|
||||
authToken:
|
||||
type: string
|
||||
example: Z5v-PrNASDFpsaCi3CPK7
|
||||
username:
|
||||
type: string
|
||||
example: example.email@mail.com
|
||||
mappingState:
|
||||
type: string
|
||||
example: mapped
|
||||
mappingError:
|
||||
type: string
|
||||
example: null
|
||||
signInState:
|
||||
type: string
|
||||
example: ok
|
||||
publicAddress:
|
||||
type: string
|
||||
example: 140.20.68.140
|
||||
publicPort:
|
||||
type: number
|
||||
example: 32400
|
||||
privateAddress:
|
||||
type: string
|
||||
example: 10.10.10.47
|
||||
privatePort:
|
||||
type: number
|
||||
example: 32400
|
||||
subscriptionFeatures:
|
||||
type: string
|
||||
example: 'federated-auth,hardware_transcoding,home,hwtranscode,item_clusters,kevin-bacon,livetv,loudness,lyrics,music-analysis,music_videos,pass,photo_autotags,photos-v5,photosV6-edit,photosV6-tv-albums,premium_music_metadata,radio,server-manager,session_bandwidth_restrictions,session_kick,shared-radio,sync,trailers,tuner-sharing,type-first,unsupportedtuners,webhooks'
|
||||
subscriptionActive:
|
||||
type: boolean
|
||||
subscriptionState:
|
||||
type: string
|
||||
example: Active
|
||||
'401':
|
||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
errors:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: number
|
||||
example: 1001
|
||||
message:
|
||||
type: string
|
||||
example: User could not be authenticated
|
||||
status:
|
||||
type: number
|
||||
example: 401
|
||||
'/photo/:/transcode':
|
||||
get:
|
||||
tags:
|
||||
- Photos
|
||||
summary: Get a Resized Photo
|
||||
description: |
|
||||
Plex's Photo transcoder is used throughout the service to serve images at specified sizes.
|
||||
operationId: getResizedPhoto
|
||||
parameters:
|
||||
- name: width
|
||||
description: The width for the resized photo
|
||||
in: query
|
||||
schema:
|
||||
type: number
|
||||
example: 110
|
||||
required: true
|
||||
- name: height
|
||||
description: The height for the resized photo
|
||||
in: query
|
||||
schema:
|
||||
type: number
|
||||
example: 165
|
||||
required: true
|
||||
- name: opacity
|
||||
description: The opacity for the resized photo
|
||||
in: query
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 1
|
||||
maximum: 100
|
||||
default: 100
|
||||
required: true
|
||||
- name: blur
|
||||
description: The width for the resized photo
|
||||
in: query
|
||||
schema:
|
||||
type: number
|
||||
example:
|
||||
- 0
|
||||
- 20
|
||||
- 4000
|
||||
required: true
|
||||
- name: minSize
|
||||
description: images are always scaled proportionally. A value of '1' in minSize will make the smaller native dimension the dimension resized against.
|
||||
in: query
|
||||
schema:
|
||||
type: number
|
||||
enum:
|
||||
- 0
|
||||
- 1
|
||||
required: true
|
||||
- name: upscale
|
||||
description: allow images to be resized beyond native dimensions.
|
||||
in: query
|
||||
schema:
|
||||
type: number
|
||||
enum:
|
||||
- 0
|
||||
- 1
|
||||
required: true
|
||||
- name: url
|
||||
description: path to image within Plex
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
example: /library/metadata/49564/thumb/1654258204
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Resized Image
|
||||
'401':
|
||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
errors:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: number
|
||||
example: 1001
|
||||
message:
|
||||
type: string
|
||||
example: User could not be authenticated
|
||||
status:
|
||||
type: number
|
||||
example: 401
|
||||
/playlists:
|
||||
post:
|
||||
tags:
|
||||
@@ -2466,6 +2631,283 @@ paths:
|
||||
status:
|
||||
type: number
|
||||
example: 401
|
||||
/search:
|
||||
get:
|
||||
tags:
|
||||
- Search
|
||||
summary: Get Search Results
|
||||
description: This will search the database for the string provided.
|
||||
operationId: getSearchResults
|
||||
parameters:
|
||||
- name: query
|
||||
description: The search query string to use
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
example: 110
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Search Results
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
MediaContainer:
|
||||
type: object
|
||||
properties:
|
||||
size:
|
||||
type: number
|
||||
example: 26
|
||||
identifier:
|
||||
type: string
|
||||
example: com.plexapp.plugins.library
|
||||
mediaTagPrefix:
|
||||
type: string
|
||||
example: /system/bundle/media/flags/
|
||||
mediaTagVersion:
|
||||
type: number
|
||||
example: 1680021154
|
||||
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
|
||||
personal:
|
||||
type: boolean
|
||||
sourceTitle:
|
||||
type: string
|
||||
example: Hera
|
||||
ratingKey:
|
||||
type: string
|
||||
example: 10398
|
||||
key:
|
||||
type: string
|
||||
example: /library/metadata/10398
|
||||
guid:
|
||||
type: string
|
||||
example: 'plex://movie/5d7768284de0ee001fcc8f52'
|
||||
studio:
|
||||
type: string
|
||||
example: Paramount
|
||||
type:
|
||||
type: string
|
||||
example: movie
|
||||
title:
|
||||
type: string
|
||||
example: 'Mission: Impossible'
|
||||
contentRating:
|
||||
type: string
|
||||
example: PG-13
|
||||
summary:
|
||||
type: string
|
||||
example: When Ethan Hunt the leader of a crack espionage team whose perilous operation has gone awry with no explanation discovers that a mole has penetrated the CIA he's surprised to learn that he's the No. 1 suspect. To clear his name Hunt now must ferret out the real double agent and in the process even the score.
|
||||
rating:
|
||||
type: number
|
||||
example: 6.6
|
||||
audienceRating:
|
||||
type: number
|
||||
example: 7.1
|
||||
year:
|
||||
type: number
|
||||
example: 1996
|
||||
tagline:
|
||||
type: string
|
||||
example: Expect the impossible.
|
||||
thumb:
|
||||
type: string
|
||||
example: /library/metadata/10398/thumb/1679505055
|
||||
art:
|
||||
type: string
|
||||
example: /library/metadata/10398/art/1679505055
|
||||
duration:
|
||||
type: number
|
||||
example: 6612628
|
||||
originallyAvailableAt:
|
||||
type: string
|
||||
format: date
|
||||
example: 1996-05-22T00:00:00.000Z
|
||||
addedAt:
|
||||
type: number
|
||||
example: 1589234571
|
||||
updatedAt:
|
||||
type: number
|
||||
example: 1679505055
|
||||
audienceRatingImage:
|
||||
type: string
|
||||
example: 'rottentomatoes://image.rating.upright'
|
||||
chapterSource:
|
||||
type: string
|
||||
example: media
|
||||
primaryExtraKey:
|
||||
type: string
|
||||
example: /library/metadata/10501
|
||||
ratingImage:
|
||||
type: string
|
||||
example: 'rottentomatoes://image.rating.ripe'
|
||||
Media:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
example: 26610
|
||||
duration:
|
||||
type: number
|
||||
example: 6612628
|
||||
bitrate:
|
||||
type: number
|
||||
example: 4751
|
||||
width:
|
||||
type: number
|
||||
example: 1916
|
||||
height:
|
||||
type: number
|
||||
example: 796
|
||||
aspectRatio:
|
||||
type: number
|
||||
example: 2.35
|
||||
audioChannels:
|
||||
type: number
|
||||
example: 6
|
||||
audioCodec:
|
||||
type: string
|
||||
example: aac
|
||||
videoCodec:
|
||||
type: string
|
||||
example: hevc
|
||||
videoResolution:
|
||||
type: string
|
||||
example: 1080
|
||||
container:
|
||||
type: string
|
||||
example: mkv
|
||||
videoFrameRate:
|
||||
type: string
|
||||
example: 24p
|
||||
audioProfile:
|
||||
type: string
|
||||
example: lc
|
||||
videoProfile:
|
||||
type: string
|
||||
example: main 10
|
||||
Part:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
example: 26610
|
||||
key:
|
||||
type: string
|
||||
example: /library/parts/26610/1589234571/file.mkv
|
||||
duration:
|
||||
type: number
|
||||
example: 6612628
|
||||
file:
|
||||
type: string
|
||||
example: /movies/Mission Impossible (1996)/Mission Impossible (1996) Bluray-1080p.mkv
|
||||
size:
|
||||
type: number
|
||||
example: 3926903851
|
||||
audioProfile:
|
||||
type: string
|
||||
example: lc
|
||||
container:
|
||||
type: string
|
||||
example: mkv
|
||||
videoProfile:
|
||||
type: string
|
||||
example: main 10
|
||||
Genre:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Action
|
||||
Director:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: Brian De Palma
|
||||
Writer:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: David Koepp
|
||||
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: Tom Cruise
|
||||
Provider:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
key:
|
||||
type: string
|
||||
example: /system/search
|
||||
title:
|
||||
type: string
|
||||
example: Local Network
|
||||
type:
|
||||
type: string
|
||||
example: mixed
|
||||
'401':
|
||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
errors:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: number
|
||||
example: 1001
|
||||
message:
|
||||
type: string
|
||||
example: User could not be authenticated
|
||||
status:
|
||||
type: number
|
||||
example: 401
|
||||
/security/token:
|
||||
get:
|
||||
tags:
|
||||
|
||||
Reference in New Issue
Block a user