From 819ae4c4044c4242b89501b60bc79f14a669d10d Mon Sep 17 00:00:00 2001 From: Luke Hagar Date: Thu, 13 Apr 2023 20:03:56 -0500 Subject: [PATCH] Adjusted Required Parameters, Populated Global Parameters on all endpointss --- referenced/paths/plex.tv/pins-id.yaml | 1 - referenced/paths/plex.tv/pins.yaml | 1 - referenced/paths/plex.tv/resources.yaml | 1 - referenced/paths/plex.tv/user.yaml | 1 - referenced/paths/pms/activities-cancel.yaml | 7 +++++++ referenced/paths/pms/activities.yaml | 12 +++++++++-- referenced/paths/pms/all-libraries.yaml | 8 +++++++ referenced/paths/pms/all-playlists.yaml | 7 +++++++ referenced/paths/pms/butler-task.yaml | 14 +++++++++++++ referenced/paths/pms/butler.yaml | 8 +++++++ referenced/paths/pms/clients.yaml | 8 +++++++ referenced/paths/pms/hubs-search-voice.yaml | 7 +++++++ referenced/paths/pms/hubs-search.yaml | 7 +++++++ referenced/paths/pms/hubs-section.yaml | 7 +++++++ referenced/paths/pms/hubs.yaml | 7 +++++++ referenced/paths/pms/library-content-all.yaml | 7 +++++++ .../paths/pms/library-content-common.yaml | 7 +++++++ .../paths/pms/library-content-latest.yaml | 7 +++++++ referenced/paths/pms/library-details.yaml | 7 +++++++ referenced/paths/pms/library-hashes.yaml | 7 +++++++ referenced/paths/pms/library-ondeck.yaml | 8 +++++++ referenced/paths/pms/library-refresh.yaml | 7 +++++++ referenced/paths/pms/log-networked.yaml | 8 +++++++ referenced/paths/pms/log.yaml | 15 +++++++++++++ referenced/paths/pms/playlist-contents.yaml | 21 +++++++++++++++++++ referenced/paths/pms/playlist-id.yaml | 14 +++++++++++++ referenced/paths/pms/playlist-upload.yaml | 7 +++++++ referenced/paths/pms/playlists.yaml | 9 +++++++- referenced/paths/pms/root.yaml | 8 +++++++ referenced/paths/pms/security-resources.yaml | 7 +++++++ referenced/paths/pms/security-token.yaml | 7 +++++++ referenced/paths/pms/server-preferences.yaml | 8 +++++++ referenced/paths/pms/session-history.yaml | 8 +++++++ referenced/paths/pms/sessions.yaml | 8 +++++++ referenced/paths/pms/updater-apply.yaml | 7 +++++++ referenced/paths/pms/updater-check.yaml | 7 +++++++ referenced/paths/pms/updater-status.yaml | 8 +++++++ referenced/plex-api-spec.yaml | 5 +++++ 38 files changed, 286 insertions(+), 7 deletions(-) diff --git a/referenced/paths/plex.tv/pins-id.yaml b/referenced/paths/plex.tv/pins-id.yaml index bba90e3b..c9c2ea3a 100644 --- a/referenced/paths/plex.tv/pins-id.yaml +++ b/referenced/paths/plex.tv/pins-id.yaml @@ -11,7 +11,6 @@ get: schema: type: string required: true - - $ref: "../../parameters/X-Plex-Client-Identifier.yaml" - $ref: "../../parameters/X-Plex-Device-Name.yaml" - $ref: "../../parameters/X-Plex-Device.yaml" - $ref: "../../parameters/X-Plex-Platform-Version.yaml" diff --git a/referenced/paths/plex.tv/pins.yaml b/referenced/paths/plex.tv/pins.yaml index 55977a5f..6a35b097 100644 --- a/referenced/paths/plex.tv/pins.yaml +++ b/referenced/paths/plex.tv/pins.yaml @@ -16,7 +16,6 @@ post: type: boolean default: false required: false - - $ref: "../../parameters/X-Plex-Client-Identifier.yaml" - $ref: "../../parameters/X-Plex-Device-Name.yaml" - $ref: "../../parameters/X-Plex-Device.yaml" - $ref: "../../parameters/X-Plex-Platform-Version.yaml" diff --git a/referenced/paths/plex.tv/resources.yaml b/referenced/paths/plex.tv/resources.yaml index 6e3d1edd..c268db7a 100644 --- a/referenced/paths/plex.tv/resources.yaml +++ b/referenced/paths/plex.tv/resources.yaml @@ -5,7 +5,6 @@ get: description: Get Devices operationId: getDevices parameters: - - $ref: "../../parameters/X-Plex-Client-Identifier.yaml" - $ref: "../../parameters/X-Plex-Device-Name.yaml" - $ref: "../../parameters/X-Plex-Device.yaml" - $ref: "../../parameters/X-Plex-Platform-Version.yaml" diff --git a/referenced/paths/plex.tv/user.yaml b/referenced/paths/plex.tv/user.yaml index 997f7c8d..205d5b96 100644 --- a/referenced/paths/plex.tv/user.yaml +++ b/referenced/paths/plex.tv/user.yaml @@ -5,7 +5,6 @@ get: description: Get Logged in User operationId: getCurrentUserDetails parameters: - - $ref: "../../parameters/X-Plex-Client-Identifier.yaml" - $ref: "../../parameters/X-Plex-Device-Name.yaml" - $ref: "../../parameters/X-Plex-Device.yaml" - $ref: "../../parameters/X-Plex-Platform-Version.yaml" diff --git a/referenced/paths/pms/activities-cancel.yaml b/referenced/paths/pms/activities-cancel.yaml index aaa573ba..bb49110d 100644 --- a/referenced/paths/pms/activities-cancel.yaml +++ b/referenced/paths/pms/activities-cancel.yaml @@ -12,6 +12,13 @@ delete: type: string example: 25b71ed5-0f9d-461c-baa7-d404e9e10d3e required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The Server Activity was canceled diff --git a/referenced/paths/pms/activities.yaml b/referenced/paths/pms/activities.yaml index ffcd8275..ce39e947 100644 --- a/referenced/paths/pms/activities.yaml +++ b/referenced/paths/pms/activities.yaml @@ -1,9 +1,17 @@ get: tags: - Activities - summary: Server Activities - description: Server Activities + summary: Get Server Activities + description: Get Server Activities operationId: getServerActivities + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The Server Activities diff --git a/referenced/paths/pms/all-libraries.yaml b/referenced/paths/pms/all-libraries.yaml index b42c71f1..fb36d757 100644 --- a/referenced/paths/pms/all-libraries.yaml +++ b/referenced/paths/pms/all-libraries.yaml @@ -3,6 +3,14 @@ get: - Library summary: Get All Libraries operationId: getLibraries + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" description: | A library section (commonly referred to as just a library) is a collection of media. Libraries are typed, and depending on their type provide either a flat or a hierarchical view of the media. diff --git a/referenced/paths/pms/all-playlists.yaml b/referenced/paths/pms/all-playlists.yaml index 578e6f09..bd36096d 100644 --- a/referenced/paths/pms/all-playlists.yaml +++ b/referenced/paths/pms/all-playlists.yaml @@ -24,6 +24,13 @@ get: - 0 - 1 required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: returns all playlists diff --git a/referenced/paths/pms/butler-task.yaml b/referenced/paths/pms/butler-task.yaml index 4360927a..e43450c5 100644 --- a/referenced/paths/pms/butler-task.yaml +++ b/referenced/paths/pms/butler-task.yaml @@ -31,6 +31,13 @@ post: - RefreshPeriodicMetadata - UpgradeMediaAnalysis required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The task was started successfully @@ -68,6 +75,13 @@ delete: - RefreshPeriodicMetadata - UpgradeMediaAnalysis required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The task was stopped diff --git a/referenced/paths/pms/butler.yaml b/referenced/paths/pms/butler.yaml index 46d13f0c..e06c3b12 100644 --- a/referenced/paths/pms/butler.yaml +++ b/referenced/paths/pms/butler.yaml @@ -9,6 +9,14 @@ post: 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window. 4. If we are outside the configured window, the task will start immediately. operationId: startAllTasks + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: All tasks were started diff --git a/referenced/paths/pms/clients.yaml b/referenced/paths/pms/clients.yaml index a4d87b40..9590326a 100644 --- a/referenced/paths/pms/clients.yaml +++ b/referenced/paths/pms/clients.yaml @@ -4,6 +4,14 @@ get: summary: Get Available Clients description: Get Available Clients operationId: getAvailableClients + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: Available Clients diff --git a/referenced/paths/pms/hubs-search-voice.yaml b/referenced/paths/pms/hubs-search-voice.yaml index f308d431..836616ad 100644 --- a/referenced/paths/pms/hubs-search-voice.yaml +++ b/referenced/paths/pms/hubs-search-voice.yaml @@ -31,6 +31,13 @@ get: example: 5 default: 3 required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The search results diff --git a/referenced/paths/pms/hubs-search.yaml b/referenced/paths/pms/hubs-search.yaml index 0aacb053..dc55048a 100644 --- a/referenced/paths/pms/hubs-search.yaml +++ b/referenced/paths/pms/hubs-search.yaml @@ -39,6 +39,13 @@ get: type: number example: 5 default: 3 + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The search results diff --git a/referenced/paths/pms/hubs-section.yaml b/referenced/paths/pms/hubs-section.yaml index 89696680..78d737f5 100644 --- a/referenced/paths/pms/hubs-section.yaml +++ b/referenced/paths/pms/hubs-section.yaml @@ -27,6 +27,13 @@ get: - 0 - 1 required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The hubs specific to the library diff --git a/referenced/paths/pms/hubs.yaml b/referenced/paths/pms/hubs.yaml index b382c6db..e554210d 100644 --- a/referenced/paths/pms/hubs.yaml +++ b/referenced/paths/pms/hubs.yaml @@ -20,6 +20,13 @@ get: - 0 - 1 required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: returns global hubs diff --git a/referenced/paths/pms/library-content-all.yaml b/referenced/paths/pms/library-content-all.yaml index c425b16b..6c4842ba 100644 --- a/referenced/paths/pms/library-content-all.yaml +++ b/referenced/paths/pms/library-content-all.yaml @@ -24,6 +24,13 @@ get: schema: type: string required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The details of the library diff --git a/referenced/paths/pms/library-content-common.yaml b/referenced/paths/pms/library-content-common.yaml index adfaf103..4eef3720 100644 --- a/referenced/paths/pms/library-content-common.yaml +++ b/referenced/paths/pms/library-content-common.yaml @@ -24,6 +24,13 @@ get: schema: type: string required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The details of the library diff --git a/referenced/paths/pms/library-content-latest.yaml b/referenced/paths/pms/library-content-latest.yaml index febc9dcf..a3ef525e 100644 --- a/referenced/paths/pms/library-content-latest.yaml +++ b/referenced/paths/pms/library-content-latest.yaml @@ -24,6 +24,13 @@ get: schema: type: string required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The details of the library diff --git a/referenced/paths/pms/library-details.yaml b/referenced/paths/pms/library-details.yaml index 997b5b60..8026f1bc 100644 --- a/referenced/paths/pms/library-details.yaml +++ b/referenced/paths/pms/library-details.yaml @@ -43,6 +43,13 @@ get: - 1 default: 0 required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The details of the library diff --git a/referenced/paths/pms/library-hashes.yaml b/referenced/paths/pms/library-hashes.yaml index f86f2f52..69069214 100644 --- a/referenced/paths/pms/library-hashes.yaml +++ b/referenced/paths/pms/library-hashes.yaml @@ -18,6 +18,13 @@ get: schema: type: number required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The hash of the file diff --git a/referenced/paths/pms/library-ondeck.yaml b/referenced/paths/pms/library-ondeck.yaml index 470f0b78..b76ce826 100644 --- a/referenced/paths/pms/library-ondeck.yaml +++ b/referenced/paths/pms/library-ondeck.yaml @@ -5,6 +5,14 @@ get: description: | This endpoint will return the on deck content. operationId: getOnDeck + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The on deck content diff --git a/referenced/paths/pms/library-refresh.yaml b/referenced/paths/pms/library-refresh.yaml index c7a3b270..abda36fb 100644 --- a/referenced/paths/pms/library-refresh.yaml +++ b/referenced/paths/pms/library-refresh.yaml @@ -12,6 +12,13 @@ get: schema: type: number required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The library is refreshing diff --git a/referenced/paths/pms/log-networked.yaml b/referenced/paths/pms/log-networked.yaml index 278dbfed..f8d9cec8 100644 --- a/referenced/paths/pms/log-networked.yaml +++ b/referenced/paths/pms/log-networked.yaml @@ -5,6 +5,14 @@ get: description: | This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time. operationId: enablePaperTrail + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: Papertrail enabled successfully diff --git a/referenced/paths/pms/log.yaml b/referenced/paths/pms/log.yaml index 8d27cf09..530a7572 100644 --- a/referenced/paths/pms/log.yaml +++ b/referenced/paths/pms/log.yaml @@ -38,6 +38,13 @@ get: type: string example: "" required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: Log Line submitted successfully @@ -51,6 +58,14 @@ post: description: | This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. operationId: logMultiLine + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: Multi-Line Log Message Posted successfully diff --git a/referenced/paths/pms/playlist-contents.yaml b/referenced/paths/pms/playlist-contents.yaml index fb96fa97..4fd3947e 100644 --- a/referenced/paths/pms/playlist-contents.yaml +++ b/referenced/paths/pms/playlist-contents.yaml @@ -21,6 +21,13 @@ get: schema: type: number required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The playlist contents @@ -41,6 +48,13 @@ delete: schema: type: number required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The playlist contents are cleared @@ -76,6 +90,13 @@ put: type: number example: 123 required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: Playlist Updated diff --git a/referenced/paths/pms/playlist-id.yaml b/referenced/paths/pms/playlist-id.yaml index 202e1b3e..d1aa975d 100644 --- a/referenced/paths/pms/playlist-id.yaml +++ b/referenced/paths/pms/playlist-id.yaml @@ -13,6 +13,13 @@ get: schema: type: number required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The playlist @@ -33,6 +40,13 @@ delete: schema: type: number required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The playlist is deleted diff --git a/referenced/paths/pms/playlist-upload.yaml b/referenced/paths/pms/playlist-upload.yaml index 78480b27..45d350a0 100644 --- a/referenced/paths/pms/playlist-upload.yaml +++ b/referenced/paths/pms/playlist-upload.yaml @@ -30,6 +30,13 @@ post: - 0 - 1 required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The playlist is uploaded diff --git a/referenced/paths/pms/playlists.yaml b/referenced/paths/pms/playlists.yaml index bf7efa08..c5c1f77a 100644 --- a/referenced/paths/pms/playlists.yaml +++ b/referenced/paths/pms/playlists.yaml @@ -44,7 +44,14 @@ post: in: query schema: type: number - required: false + required: false + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: returns all playlists diff --git a/referenced/paths/pms/root.yaml b/referenced/paths/pms/root.yaml index ebab520b..0bf4f5d8 100644 --- a/referenced/paths/pms/root.yaml +++ b/referenced/paths/pms/root.yaml @@ -4,6 +4,14 @@ get: summary: Server Capabilities description: Server Capabilities operationId: getServerCapabilities + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The Server Capabilities diff --git a/referenced/paths/pms/security-resources.yaml b/referenced/paths/pms/security-resources.yaml index c6de1a9e..b9104ca3 100644 --- a/referenced/paths/pms/security-resources.yaml +++ b/referenced/paths/pms/security-resources.yaml @@ -16,6 +16,13 @@ get: - server://client-identifier - provider://provider-identifier required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: Source Connection Information diff --git a/referenced/paths/pms/security-token.yaml b/referenced/paths/pms/security-token.yaml index e616684d..35e58df9 100644 --- a/referenced/paths/pms/security-token.yaml +++ b/referenced/paths/pms/security-token.yaml @@ -22,6 +22,13 @@ get: enum: - all required: true + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: A Transient Token diff --git a/referenced/paths/pms/server-preferences.yaml b/referenced/paths/pms/server-preferences.yaml index f2ea9a7b..ef617c63 100644 --- a/referenced/paths/pms/server-preferences.yaml +++ b/referenced/paths/pms/server-preferences.yaml @@ -4,6 +4,14 @@ get: summary: Get Server Preferences description: Get Server Preferences operationId: getServerPreferences + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: Server Preferences diff --git a/referenced/paths/pms/session-history.yaml b/referenced/paths/pms/session-history.yaml index 81673e30..4bb36774 100644 --- a/referenced/paths/pms/session-history.yaml +++ b/referenced/paths/pms/session-history.yaml @@ -4,6 +4,14 @@ get: summary: Get Session History description: This will Retrieve a listing of all history views. operationId: getSessionHistory + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: List of Plex Sessions diff --git a/referenced/paths/pms/sessions.yaml b/referenced/paths/pms/sessions.yaml index e4755c01..da73c65d 100644 --- a/referenced/paths/pms/sessions.yaml +++ b/referenced/paths/pms/sessions.yaml @@ -4,6 +4,14 @@ get: summary: Get Active Sessions description: This will retrieve the "Now Playing" Information of the PMS. operationId: getSessions + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: List of Active Plex Sessions diff --git a/referenced/paths/pms/updater-apply.yaml b/referenced/paths/pms/updater-apply.yaml index dcdf3801..a240b11e 100644 --- a/referenced/paths/pms/updater-apply.yaml +++ b/referenced/paths/pms/updater-apply.yaml @@ -24,6 +24,13 @@ put: - 0 - 1 example: 1 + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: If the update process started correctly diff --git a/referenced/paths/pms/updater-check.yaml b/referenced/paths/pms/updater-check.yaml index 80ae4231..3c4092ea 100644 --- a/referenced/paths/pms/updater-check.yaml +++ b/referenced/paths/pms/updater-check.yaml @@ -14,6 +14,13 @@ put: - 0 - 1 example: 1 + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: "" diff --git a/referenced/paths/pms/updater-status.yaml b/referenced/paths/pms/updater-status.yaml index 7035ce51..907ab7df 100644 --- a/referenced/paths/pms/updater-status.yaml +++ b/referenced/paths/pms/updater-status.yaml @@ -4,6 +4,14 @@ get: summary: Querying status of updates description: Querying status of updates operationId: queryUpdateStatus + parameters: + - $ref: "../../parameters/X-Plex-Device-Name.yaml" + - $ref: "../../parameters/X-Plex-Device.yaml" + - $ref: "../../parameters/X-Plex-Platform-Version.yaml" + - $ref: "../../parameters/X-Plex-Platform.yaml" + - $ref: "../../parameters/X-Plex-Product.yaml" + - $ref: "../../parameters/X-Plex-Provides.yaml" + - $ref: "../../parameters/X-Plex-Version.yaml" responses: "200": description: The Server Updates diff --git a/referenced/plex-api-spec.yaml b/referenced/plex-api-spec.yaml index f3e59538..1bbc8b9a 100644 --- a/referenced/plex-api-spec.yaml +++ b/referenced/plex-api-spec.yaml @@ -31,6 +31,7 @@ servers: security: - PlexToken: [] + PlexClientIdentifier: [] components: securitySchemes: @@ -38,6 +39,10 @@ components: type: apiKey in: header # can be "header", "query" or "cookie" name: X-Plex-Token # name of the header, query parameter or cookie + PlexClientIdentifier: # arbitrary name for the security scheme + type: apiKey + in: header # can be "header", "query" or "cookie" + name: X-Plex-Client-Identifier # name of the header, query parameter or cookie paths: