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

build: dereferenced Plex Media Server API Spec updated

Browse Source
This commit is contained in:
JasonLandbridge
2024-09-19 06:40:11 +00:00
committed by github-actions[bot]
parent 82ce462641
commit c424a63c5f
1 changed files with 407 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

525
output/plex-media-server-spec-dereferenced.yaml
View File

@@ -74,7 +74,7 @@ components:
accessToken: accessToken:
description: Plex Authentication Token description: Plex Authentication Token
type: apiKey type: apiKey
in: query in: header
name: X-Plex-Token name: X-Plex-Token
paths: paths:
/: /:
@@ -3048,6 +3048,8 @@ paths:
application/json: application/json:
schema: schema:
type: object type: object
required:
- MediaContainer
properties: properties:
MediaContainer: MediaContainer:
type: object type: object
@@ -3055,6 +3057,7 @@ paths:
- size - size
- allowSync - allowSync
- title1 - title1
- Directory
properties: properties:
size: size:
type: integer type: integer
@@ -3070,6 +3073,28 @@ paths:
type: array type: array
items: items:
type: object type: object
required:
- allowSync
- art
- composite
- filters
- refreshing
- thumb
- key
- type
- title
- agent
- scanner
- language
- uuid
- updatedAt
- createdAt
- scannedAt
- content
- directory
- contentChangedAt
- hidden
- Location
properties: properties:
allowSync: allowSync:
type: boolean type: boolean
@@ -3114,19 +3139,19 @@ paths:
type: type:
- integer - integer
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime in seconds
format: int64 format: int64
createdAt: createdAt:
type: type:
- integer - integer
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime in seconds
format: int64 format: int64
scannedAt: scannedAt:
type: type:
- integer - integer
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime in seconds
format: int64 format: int64
content: content:
type: boolean type: boolean
@@ -3146,6 +3171,9 @@ paths:
type: array type: array
items: items:
type: object type: object
required:
- id
- path
properties: properties:
id: id:
type: integer type: integer
@@ -3888,22 +3916,30 @@ paths:
Adds the Guids object to the response Adds the Guids object to the response
schema: schema:
type: integer type: integer
format: int32
enum: enum:
- 0 - 0
- 1 - 1
example: 1 example: 1
required: false default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- name: includeMeta - name: includeMeta
in: query in: query
description: | description: |
Adds the Meta object to the response Adds the Meta object to the response
schema: schema:
type: integer type: integer
format: int32
enum: enum:
- 0 - 0
- 1 - 1
example: 1 example: 1
required: false default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- name: type - name: type
in: query in: query
description: | description: |
@@ -3921,6 +3957,11 @@ paths:
- 3 - 3
- 4 - 4
example: 2 example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true
- name: X-Plex-Container-Start - name: X-Plex-Container-Start
in: query in: query
@@ -3965,6 +4006,23 @@ paths:
properties: properties:
MediaContainer: MediaContainer:
type: object type: object
required:
- size
- totalSize
- offset
- allowSync
- art
- content
- identifier
- librarySectionID
- librarySectionTitle
- librarySectionUUID
- mediaTagPrefix
- mediaTagVersion
- thumb
- title1
- title2
- viewGroup
properties: properties:
size: size:
type: integer type: integer
@@ -4022,6 +4080,15 @@ paths:
type: array type: array
items: items:
type: object type: object
required:
- ratingKey
- key
- guid
- title
- type
- year
- duration
- Media
properties: properties:
ratingKey: ratingKey:
type: string type: string
@@ -4234,6 +4301,22 @@ paths:
tag: tag:
type: string type: string
example: Sigourney Weaver example: Sigourney Weaver
Guid:
x-speakeasy-name-override: MediaGuid
description: |
The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.
type: array
items:
type: object
required:
- id
properties:
id:
type: string
description: |
Can be one of the following formats:
imdb://tt13015952, tmdb://2434012, tvdb://7945991
example: 'imdb://tt13015952'
titleSort: titleSort:
type: string type: string
example: Whale example: Whale
@@ -4310,6 +4393,132 @@ paths:
parentTheme: parentTheme:
type: string type: string
example: /library/metadata/66/theme/1705716261 example: /library/metadata/66/theme/1705716261
Meta:
description: |
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
type: object
properties:
Type:
type: array
items:
type: object
required:
- key
- type
- title
- active
properties:
key:
type: string
example: /library/sections/2/all?type=2
type:
type: string
example: show
title:
type: string
example: TV Shows
active:
type: boolean
example: false
Filter:
type: array
items:
type: object
required:
- filter
- filterType
- key
- title
- type
properties:
filter:
type: string
example: genre
filterType:
type: string
example: string
key:
type: string
example: /library/sections/2/genre?type=2
title:
type: string
example: Genre
type:
type: string
example: filter
Sort:
type: array
items:
type: object
required:
- key
- title
- defaultDirection
properties:
default:
type: string
example: asc
defaultDirection:
type: string
example: asc
descKey:
type: string
example: 'titleSort:desc'
firstCharacterKey:
type: string
example: /library/sections/2/firstCharacter
key:
type: string
example: titleSort
title:
type: string
example: Title
Field:
type: array
items:
type: object
required:
- key
- title
- type
properties:
key:
type: string
example: show.title
title:
type: string
example: Show Title
type:
type: string
example: string
subType:
type: string
example: rating
FieldType:
type: array
items:
type: object
required:
- type
- Operator
properties:
type:
type: string
example: tag
Operator:
type: array
items:
type: object
required:
- key
- title
properties:
key:
type: string
example: '='
title:
type: string
example: is
'400': '400':
description: 'Bad Request - A parameter was not specified, or was specified incorrectly.' description: 'Bad Request - A parameter was not specified, or was specified incorrectly.'
content: content:
@@ -4496,6 +4705,11 @@ paths:
- 3 - 3
- 4 - 4
example: 2 example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true
responses: responses:
'200': '200':
@@ -5817,6 +6031,11 @@ paths:
- 3 - 3
- 4 - 4
example: 2 example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true
- name: includeGuids - name: includeGuids
in: query in: query
@@ -6420,17 +6639,6 @@ paths:
description: Get Plex server access tokens and server connections description: Get Plex server access tokens and server connections
operationId: get-server-resources operationId: get-server-resources
parameters: parameters:
- name: X-Plex-Client-Identifier
x-speakeasy-name-override: ClientID
description: |
The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
in: query
schema:
type: string
example: gcgzw5rz2xovp84b4vha3a40
required: true
- name: includeHttps - name: includeHttps
in: query in: query
description: Include Https entries in the results description: Include Https entries in the results
@@ -6442,6 +6650,9 @@ paths:
- 1 - 1
example: 1 example: 1
default: 0 default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- name: includeRelay - name: includeRelay
in: query in: query
description: | description: |
@@ -6455,6 +6666,9 @@ paths:
- 1 - 1
example: 1 example: 1
default: 0 default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- name: includeIPv6 - name: includeIPv6
in: query in: query
description: Include IPv6 entries in the results description: Include IPv6 entries in the results
@@ -6466,6 +6680,9 @@ paths:
- 1 - 1
example: 1 example: 1
default: 0 default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
responses: responses:
'200': '200':
description: List of Plex Devices. This includes Plex hosted servers and clients description: List of Plex Devices. This includes Plex hosted servers and clients
@@ -6523,11 +6740,17 @@ paths:
clientIdentifier: clientIdentifier:
type: string type: string
createdAt: createdAt:
type: string allOf:
format: date-time - type: string
format: date-time
example: '2019-06-24T11:38:02Z'
- description: The time the device was created/registered
lastSeenAt: lastSeenAt:
type: string allOf:
format: date-time - type: string
format: date-time
example: '2019-06-24T11:38:02Z'
- description: The last time the device was seen
provides: provides:
type: string type: string
ownerId: ownerId:
@@ -6575,18 +6798,29 @@ paths:
- IPv6 - IPv6
properties: properties:
protocol: protocol:
description: 'The protocol used for the connection (http, https, etc)'
type: string type: string
enum:
- http
- https
address: address:
description: The (ip) address or domain name used for the connection
type: string type: string
port: port:
type: number description: The port used for the connection
type: integer
format: int32
uri: uri:
description: The full URI of the connection
type: string type: string
local: local:
description: If the connection is local address
type: boolean type: boolean
relay: relay:
description: If the connection is relayed through plex.direct
type: boolean type: boolean
IPv6: IPv6:
description: If the connection is using IPv6
type: boolean type: boolean
'400': '400':
description: 'Bad Request - A parameter was not specified, or was specified incorrectly.' description: 'Bad Request - A parameter was not specified, or was specified incorrectly.'
@@ -7104,17 +7338,6 @@ paths:
type: boolean type: boolean
default: false default: false
required: false required: false
- name: X-Plex-Client-Identifier
x-speakeasy-name-override: ClientID
description: |
The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
in: query
schema:
type: string
example: gcgzw5rz2xovp84b4vha3a40
required: true
- name: X-Plex-Product - name: X-Plex-Product
x-speakeasy-name-override: ClientName x-speakeasy-name-override: ClientName
in: query in: query
@@ -7361,17 +7584,6 @@ paths:
description: Retrieve an Access Token from Plex.tv after the Pin has been authenticated description: Retrieve an Access Token from Plex.tv after the Pin has been authenticated
operationId: getTokenByPinId operationId: getTokenByPinId
parameters: parameters:
- name: X-Plex-Client-Identifier
x-speakeasy-name-override: ClientID
description: |
The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
in: query
schema:
type: string
example: gcgzw5rz2xovp84b4vha3a40
required: true
- name: pinID - name: pinID
description: The PinID to retrieve an access token for description: The PinID to retrieve an access token for
in: path in: path
@@ -8225,6 +8437,11 @@ paths:
- 3 - 3
- 4 - 4
example: 2 example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true
responses: responses:
'200': '200':
@@ -11551,7 +11768,7 @@ paths:
type: type:
- integer - integer
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime in seconds
format: int64 format: int64
locale: locale:
type: type:
@@ -11580,55 +11797,97 @@ paths:
title: UserProfile title: UserProfile
type: object type: object
required: required:
- autoSelectAudio
- defaultAudioLanguage - defaultAudioLanguage
- defaultSubtitleLanguage - defaultSubtitleLanguage
- autoSelectSubtitle
- defaultSubtitleAccessibility
- defaultSubtitleForced
- watchedIndicator
- mediaReviewsVisibility
properties: properties:
autoSelectAudio: autoSelectAudio:
description: If the account has automatically select audio and subtitle tracks enabled
type: boolean type: boolean
example: true example: true
default: true default: true
description: If the account has automatically select audio and subtitle tracks enabled
defaultAudioLanguage: defaultAudioLanguage:
description: The preferred audio language for the account
type: type:
- string - string
- 'null' - 'null'
example: ja example: ja
description: The preferred audio language for the account
defaultSubtitleLanguage: defaultSubtitleLanguage:
description: The preferred subtitle language for the account
type: type:
- string - string
- 'null' - 'null'
example: en example: en
description: The preferred subtitle language for the account
autoSelectSubtitle: autoSelectSubtitle:
example: 1 allOf:
description: 'The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)' - type: integer
enum: format: int32
- 0 enum:
- 1 - 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: 'The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)'
defaultSubtitleAccessibility: defaultSubtitleAccessibility:
enum: allOf:
- 0 - type: integer
- 1 format: int32
example: 1 enum:
description: 'The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)' - 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: 'The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)'
defaultSubtitleForced: defaultSubtitleForced:
enum: allOf:
- 0 - type: integer
- 1 format: int32
example: 0 enum:
description: 'The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)' - 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: 'The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)'
watchedIndicator: watchedIndicator:
enum: allOf:
- 0 - type: integer
- 1 format: int32
example: 1 enum:
- 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: Whether or not media watched indicators are enabled (little orange dot on media)
mediaReviewsVisibility: mediaReviewsVisibility:
enum: allOf:
- 0 - type: integer
- 1 format: int32
type: integer enum:
example: 0 - 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: Whether or not the account has media reviews visibility enabled
protected: protected:
type: boolean type: boolean
description: If the account has a Plex Home PIN enabled description: If the account has a Plex Home PIN enabled
@@ -11637,7 +11896,7 @@ paths:
type: type:
- integer - integer
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime in seconds
format: int64 format: int64
restricted: restricted:
type: boolean type: boolean
@@ -11956,18 +12215,6 @@ paths:
summary: Get User Sign In Data summary: Get User Sign In Data
description: Sign in user with username and password and return user data with Plex authentication token description: Sign in user with username and password and return user data with Plex authentication token
operationId: post-users-sign-in-data operationId: post-users-sign-in-data
parameters:
- name: X-Plex-Client-Identifier
x-speakeasy-name-override: ClientID
description: |
The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
in: query
schema:
type: string
example: gcgzw5rz2xovp84b4vha3a40
required: true
requestBody: requestBody:
content: content:
application/x-www-form-urlencoded: application/x-www-form-urlencoded:
@@ -12224,7 +12471,7 @@ paths:
type: type:
- integer - integer
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime in seconds
format: int64 format: int64
locale: locale:
type: type:
@@ -12253,55 +12500,97 @@ paths:
title: UserProfile title: UserProfile
type: object type: object
required: required:
- autoSelectAudio
- defaultAudioLanguage - defaultAudioLanguage
- defaultSubtitleLanguage - defaultSubtitleLanguage
- autoSelectSubtitle
- defaultSubtitleAccessibility
- defaultSubtitleForced
- watchedIndicator
- mediaReviewsVisibility
properties: properties:
autoSelectAudio: autoSelectAudio:
description: If the account has automatically select audio and subtitle tracks enabled
type: boolean type: boolean
example: true example: true
default: true default: true
description: If the account has automatically select audio and subtitle tracks enabled
defaultAudioLanguage: defaultAudioLanguage:
description: The preferred audio language for the account
type: type:
- string - string
- 'null' - 'null'
example: ja example: ja
description: The preferred audio language for the account
defaultSubtitleLanguage: defaultSubtitleLanguage:
description: The preferred subtitle language for the account
type: type:
- string - string
- 'null' - 'null'
example: en example: en
description: The preferred subtitle language for the account
autoSelectSubtitle: autoSelectSubtitle:
example: 1 allOf:
description: 'The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)' - type: integer
enum: format: int32
- 0 enum:
- 1 - 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: 'The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)'
defaultSubtitleAccessibility: defaultSubtitleAccessibility:
enum: allOf:
- 0 - type: integer
- 1 format: int32
example: 1 enum:
description: 'The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)' - 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: 'The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)'
defaultSubtitleForced: defaultSubtitleForced:
enum: allOf:
- 0 - type: integer
- 1 format: int32
example: 0 enum:
description: 'The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)' - 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: 'The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)'
watchedIndicator: watchedIndicator:
enum: allOf:
- 0 - type: integer
- 1 format: int32
example: 1 enum:
- 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: Whether or not media watched indicators are enabled (little orange dot on media)
mediaReviewsVisibility: mediaReviewsVisibility:
enum: allOf:
- 0 - type: integer
- 1 format: int32
type: integer enum:
example: 0 - 0
- 1
example: 1
default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- description: Whether or not the account has media reviews visibility enabled
protected: protected:
type: boolean type: boolean
description: If the account has a Plex Home PIN enabled description: If the account has a Plex Home PIN enabled
@@ -12310,7 +12599,7 @@ paths:
type: type:
- integer - integer
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime in seconds
format: int64 format: int64
restricted: restricted:
type: boolean type: boolean
@@ -12613,7 +12902,7 @@ paths:
- type: - type:
- integer - integer
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime in seconds
format: int64 format: int64
- type: 'null' - type: 'null'
endsAt: endsAt:
@@ -12621,7 +12910,7 @@ paths:
- type: - type:
- integer - integer
example: 1556281940 example: 1556281940
description: Unix epoch datetime description: Unix epoch datetime in seconds
format: int64 format: int64
- type: 'null' - type: 'null'
canceled: canceled: