LukeParke/plex-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-docs.git synced 2025-12-06 12:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating PMS Spec

Browse Source
This commit is contained in:
lukehagar
2024-08-24 11:39:33 +00:00
parent 4ef76fb43a
commit f9f9aa9a32
1 changed files with 136 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

234
static/plex-media-server-spec-dereferenced.yaml
View File

@@ -8883,7 +8883,9 @@ paths:
description: Unknown description: Unknown
format: date-time format: date-time
anonymous: anonymous:
type: boolean type:
- boolean
- 'null'
description: Unknown description: Unknown
default: false default: false
authToken: authToken:
@@ -8970,7 +8972,7 @@ paths:
mailingListStatus: mailingListStatus:
description: Your current mailing list status description: Your current mailing list status
enum: enum:
- subscribed - active
- unsubscribed - unsubscribed
maxHomeSize: maxHomeSize:
type: integer type: integer
@@ -8982,42 +8984,58 @@ paths:
description: '[Might be removed] The hashed Plex Home PIN ' description: '[Might be removed] The hashed Plex Home PIN '
deprecated: true deprecated: true
profile: profile:
type: array title: UserProfile
items: type: object
title: UserProfile required:
type: object - defaultAudioLanguage
properties: - defaultSubtitleLanguage
autoSelectAudio: properties:
type: boolean autoSelectAudio:
example: true type: boolean
default: true example: true
description: If the account has automatically select audio and subtitle tracks enabled default: true
defaultAudioLanguage: description: If the account has automatically select audio and subtitle tracks enabled
type: string defaultAudioLanguage:
example: ja type:
description: The preferred audio language for the account - string
defaultSubtitleLanguage: - 'null'
type: string example: ja
example: en description: The preferred audio language for the account
description: The preferred subtitle language for the account defaultSubtitleLanguage:
autoSelectSubtitle: type:
type: integer - string
example: 1 - 'null'
description: 'The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)' example: en
defaultSubtitleAccessibility: description: The preferred subtitle language for the account
type: integer autoSelectSubtitle:
example: 1 example: 1
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)' description: 'The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)'
defaultSubtitleForced: enum:
type: integer - 0
example: 0 - 1
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)' defaultSubtitleAccessibility:
watchedIndicator: enum:
type: integer - 0
example: 1 - 1
mediaReviewsVisibility: example: 1
type: integer 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)'
example: 0 defaultSubtitleForced:
enum:
- 0
- 1
example: 0
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:
enum:
- 0
- 1
example: 1
mediaReviewsVisibility:
enum:
- 0
- 1
type: integer
example: 0
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
@@ -9146,9 +9164,10 @@ paths:
example: true example: true
subscribedAt: subscribedAt:
description: Date the account subscribed to Plex Pass description: Date the account subscribed to Plex Pass
type: string type:
- string
- 'null'
example: '2021-04-12T18:21:12Z' example: '2021-04-12T18:21:12Z'
format: date-time
status: status:
description: String representation of subscriptionActive description: String representation of subscriptionActive
example: Inactive example: Inactive
@@ -9246,9 +9265,10 @@ paths:
example: true example: true
subscribedAt: subscribedAt:
description: Date the account subscribed to Plex Pass description: Date the account subscribed to Plex Pass
type: string type:
- string
- 'null'
example: '2021-04-12T18:21:12Z' example: '2021-04-12T18:21:12Z'
format: date-time
status: status:
description: String representation of subscriptionActive description: String representation of subscriptionActive
example: Inactive example: Inactive
@@ -9318,7 +9338,7 @@ paths:
- User - User
summary: Get User SignIn Data summary: Get User SignIn 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-signin-data operationId: post-sign-in
parameters: parameters:
- name: X-Plex-Client-Identifier - name: X-Plex-Client-Identifier
description: | description: |
@@ -9507,7 +9527,9 @@ paths:
description: Unknown description: Unknown
format: date-time format: date-time
anonymous: anonymous:
type: boolean type:
- boolean
- 'null'
description: Unknown description: Unknown
default: false default: false
authToken: authToken:
@@ -9594,7 +9616,7 @@ paths:
mailingListStatus: mailingListStatus:
description: Your current mailing list status description: Your current mailing list status
enum: enum:
- subscribed - active
- unsubscribed - unsubscribed
maxHomeSize: maxHomeSize:
type: integer type: integer
@@ -9606,42 +9628,58 @@ paths:
description: '[Might be removed] The hashed Plex Home PIN ' description: '[Might be removed] The hashed Plex Home PIN '
deprecated: true deprecated: true
profile: profile:
type: array title: UserProfile
items: type: object
title: UserProfile required:
type: object - defaultAudioLanguage
properties: - defaultSubtitleLanguage
autoSelectAudio: properties:
type: boolean autoSelectAudio:
example: true type: boolean
default: true example: true
description: If the account has automatically select audio and subtitle tracks enabled default: true
defaultAudioLanguage: description: If the account has automatically select audio and subtitle tracks enabled
type: string defaultAudioLanguage:
example: ja type:
description: The preferred audio language for the account - string
defaultSubtitleLanguage: - 'null'
type: string example: ja
example: en description: The preferred audio language for the account
description: The preferred subtitle language for the account defaultSubtitleLanguage:
autoSelectSubtitle: type:
type: integer - string
example: 1 - 'null'
description: 'The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)' example: en
defaultSubtitleAccessibility: description: The preferred subtitle language for the account
type: integer autoSelectSubtitle:
example: 1 example: 1
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)' description: 'The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)'
defaultSubtitleForced: enum:
type: integer - 0
example: 0 - 1
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)' defaultSubtitleAccessibility:
watchedIndicator: enum:
type: integer - 0
example: 1 - 1
mediaReviewsVisibility: example: 1
type: integer 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)'
example: 0 defaultSubtitleForced:
enum:
- 0
- 1
example: 0
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:
enum:
- 0
- 1
example: 1
mediaReviewsVisibility:
enum:
- 0
- 1
type: integer
example: 0
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
@@ -9770,9 +9808,10 @@ paths:
example: true example: true
subscribedAt: subscribedAt:
description: Date the account subscribed to Plex Pass description: Date the account subscribed to Plex Pass
type: string type:
- string
- 'null'
example: '2021-04-12T18:21:12Z' example: '2021-04-12T18:21:12Z'
format: date-time
status: status:
description: String representation of subscriptionActive description: String representation of subscriptionActive
example: Inactive example: Inactive
@@ -9870,9 +9909,10 @@ paths:
example: true example: true
subscribedAt: subscribedAt:
description: Date the account subscribed to Plex Pass description: Date the account subscribed to Plex Pass
type: string type:
- string
- 'null'
example: '2021-04-12T18:21:12Z' example: '2021-04-12T18:21:12Z'
format: date-time
status: status:
description: String representation of subscriptionActive description: String representation of subscriptionActive
example: Inactive example: Inactive
@@ -9998,19 +10038,17 @@ paths:
enum: enum:
- ended - ended
billing: billing:
type: array type: object
items: required:
type: object - internalPaymentMethod
required: - paymentMethodId
- internalPaymentMethod properties:
- paymentMethodId internalPaymentMethod:
properties: type: object
internalPaymentMethod: paymentMethodId:
type: object type:
paymentMethodId: - integer
type: - 'null'
- integer
- 'null'
trials: trials:
type: array type: array
items: items: