mirror of
https://github.com/LukeHagar/plex-docs.git
synced 2025-12-08 04:20:46 +00:00
Updating OpenAPI Spec
This commit is contained in:
@@ -8,7 +8,7 @@ info:
|
|||||||
email: Lukeslakemail@gmail.com
|
email: Lukeslakemail@gmail.com
|
||||||
url: https://www.LukeHagar.com
|
url: https://www.LukeHagar.com
|
||||||
servers:
|
servers:
|
||||||
- url: "{Protocol}://{Local IP}:{Port}"
|
- url: '{Protocol}://{Local IP}:{Port}'
|
||||||
variables:
|
variables:
|
||||||
Protocol:
|
Protocol:
|
||||||
enum:
|
enum:
|
||||||
@@ -20,7 +20,7 @@ servers:
|
|||||||
default: 10.10.10.47
|
default: 10.10.10.47
|
||||||
description: The Local IP Address of your plex server
|
description: The Local IP Address of your plex server
|
||||||
Port:
|
Port:
|
||||||
default: "32400"
|
default: '32400'
|
||||||
description: The port to access your plex server
|
description: The port to access your plex server
|
||||||
- url: https://plex.tv/api/v2
|
- url: https://plex.tv/api/v2
|
||||||
security:
|
security:
|
||||||
@@ -182,7 +182,7 @@ components:
|
|||||||
librarySectionID:
|
librarySectionID:
|
||||||
type: string
|
type: string
|
||||||
responses:
|
responses:
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
paths:
|
paths:
|
||||||
/:
|
/:
|
||||||
@@ -193,14 +193,14 @@ paths:
|
|||||||
description: Server Capabilities
|
description: Server Capabilities
|
||||||
operationId: serverCapabilities
|
operationId: serverCapabilities
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: The Server Capabilities
|
description: The Server Capabilities
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties: *ref_0
|
properties: *ref_0
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
/activities:
|
/activities:
|
||||||
get:
|
get:
|
||||||
@@ -210,14 +210,14 @@ paths:
|
|||||||
description: Server Activities
|
description: Server Activities
|
||||||
operationId: serverActivities
|
operationId: serverActivities
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: The Server Activities
|
description: The Server Activities
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties: *ref_1
|
properties: *ref_1
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
/activities/{activityUUID}:
|
/activities/{activityUUID}:
|
||||||
delete:
|
delete:
|
||||||
@@ -235,14 +235,14 @@ paths:
|
|||||||
example: 25b71ed5-0f9d-461c-baa7-d404e9e10d3e
|
example: 25b71ed5-0f9d-461c-baa7-d404e9e10d3e
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: The Server Activity was canceled
|
description: The Server Activity was canceled
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties: *ref_1
|
properties: *ref_1
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
/updater/status:
|
/updater/status:
|
||||||
get:
|
get:
|
||||||
@@ -252,9 +252,9 @@ paths:
|
|||||||
description: Querying status of updates
|
description: Querying status of updates
|
||||||
operationId: queryingUpdateStatus
|
operationId: queryingUpdateStatus
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: The Server Updates
|
description: The Server Updates
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
/updater/check:
|
/updater/check:
|
||||||
put:
|
put:
|
||||||
@@ -274,9 +274,9 @@ paths:
|
|||||||
- 1
|
- 1
|
||||||
example: 1
|
example: 1
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: ""
|
description: ''
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
/updater/apply:
|
/updater/apply:
|
||||||
put:
|
put:
|
||||||
@@ -306,11 +306,11 @@ paths:
|
|||||||
- 1
|
- 1
|
||||||
example: 1
|
example: 1
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: If the update process started correctly
|
description: If the update process started correctly
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
"500":
|
'500':
|
||||||
description: If the update process failed to start
|
description: If the update process failed to start
|
||||||
/butler:
|
/butler:
|
||||||
post:
|
post:
|
||||||
@@ -325,9 +325,9 @@ paths:
|
|||||||
4. If we are outside the configured window, the task will start immediately.
|
4. If we are outside the configured window, the task will start immediately.
|
||||||
operationId: startAllButlerTasks
|
operationId: startAllButlerTasks
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: All tasks were started
|
description: All tasks were started
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
delete:
|
delete:
|
||||||
tags:
|
tags:
|
||||||
@@ -337,9 +337,9 @@ paths:
|
|||||||
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
|
||||||
operationId: stopAllButlerTasks
|
operationId: stopAllButlerTasks
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: All tasks were stopped
|
description: All tasks were stopped
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
/butler/{taskName}:
|
/butler/{taskName}:
|
||||||
post:
|
post:
|
||||||
@@ -376,11 +376,11 @@ paths:
|
|||||||
- UpgradeMediaAnalysis
|
- UpgradeMediaAnalysis
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: The task was started successfully
|
description: The task was started successfully
|
||||||
"202":
|
'202':
|
||||||
description: The task was already running.
|
description: The task was already running.
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
delete:
|
delete:
|
||||||
tags:
|
tags:
|
||||||
@@ -412,11 +412,11 @@ paths:
|
|||||||
- UpgradeMediaAnalysis
|
- UpgradeMediaAnalysis
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
"200":
|
'200':
|
||||||
description: The task was stopped
|
description: The task was stopped
|
||||||
"401":
|
'401':
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
"404":
|
'404':
|
||||||
description: The task was not running
|
description: The task was not running
|
||||||
tags:
|
tags:
|
||||||
- name: Activities
|
- name: Activities
|
||||||
|
|||||||
Reference in New Issue
Block a user