mirror of
https://github.com/LukeHagar/plex-docs.git
synced 2025-12-06 12:37:45 +00:00
Updating OpenAPI Spec
This commit is contained in:
@@ -1,13 +1,13 @@
|
|||||||
openapi: 3.1.1
|
openapi: 3.1.0
|
||||||
info:
|
info:
|
||||||
title: Plex-API
|
title: Plex-API
|
||||||
summary: A Plex Media Server API Map
|
summary: A Plex Media Server API Map
|
||||||
description: An Open API Spec for interacting with Plex.tv and Plex Servers
|
description: An Open API Spec for interacting with Plex.tv and Plex Servers
|
||||||
version: 0.0.2
|
version: 0.0.3
|
||||||
contact:
|
contact:
|
||||||
name: Luke Hagar
|
name: Luke Hagar
|
||||||
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:
|
||||||
@@ -16,7 +16,7 @@ servers:
|
|||||||
- http
|
- http
|
||||||
- https
|
- https
|
||||||
default: http
|
default: http
|
||||||
description: The protocl to use with your plex server
|
description: The protocol to use with your plex server
|
||||||
Local IP:
|
Local IP:
|
||||||
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
|
||||||
@@ -31,10 +31,22 @@ components:
|
|||||||
type: apiKey
|
type: apiKey
|
||||||
in: header
|
in: header
|
||||||
name: X-Plex-Token
|
name: X-Plex-Token
|
||||||
schemas:
|
paths:
|
||||||
ServerCapabilities:
|
/:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Server
|
||||||
|
summary: Server Capabilities
|
||||||
|
description: Server Capabilities
|
||||||
|
operationId: serverCapabilities
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: The Server Capabilities
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties: &ref_0
|
properties:
|
||||||
MediaContainer:
|
MediaContainer:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@@ -149,9 +161,23 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
title:
|
title:
|
||||||
type: string
|
type: string
|
||||||
ServerActivities:
|
'401':
|
||||||
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
/activities:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Activities
|
||||||
|
summary: Server Activities
|
||||||
|
description: Server Activities
|
||||||
|
operationId: serverActivities
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: The Server Activities
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
type: object
|
type: object
|
||||||
properties: &ref_1
|
properties:
|
||||||
MediaContainer:
|
MediaContainer:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@@ -181,45 +207,9 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
librarySectionID:
|
librarySectionID:
|
||||||
type: string
|
type: string
|
||||||
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:
|
'/activities/{activityUUID}':
|
||||||
/:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- Server
|
|
||||||
summary: Server Capabilities
|
|
||||||
description: Server Capabilities
|
|
||||||
operationId: serverCapabilities
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: The Server Capabilities
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties: *ref_0
|
|
||||||
'401':
|
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
/activities:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- Activities
|
|
||||||
summary: Server Activities
|
|
||||||
description: Server Activities
|
|
||||||
operationId: serverActivities
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: The Server Activities
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties: *ref_1
|
|
||||||
'401':
|
|
||||||
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
||||||
/activities/{activityUUID}:
|
|
||||||
delete:
|
delete:
|
||||||
tags:
|
tags:
|
||||||
- Activities
|
- Activities
|
||||||
@@ -237,11 +227,6 @@ paths:
|
|||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: The Server Activity was canceled
|
description: The Server Activity was canceled
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
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:
|
||||||
@@ -341,7 +326,7 @@ paths:
|
|||||||
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:
|
||||||
tags:
|
tags:
|
||||||
- Butler
|
- Butler
|
||||||
@@ -537,15 +522,15 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
example:
|
example:
|
||||||
- server://client-identifier
|
- 'server://client-identifier'
|
||||||
- provider://provider-identifier
|
- 'provider://provider-identifier'
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Source Connection Information
|
description: Source Connection Information
|
||||||
'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.
|
||||||
/library/sections/{sectionId}/{category}:
|
'/library/sections/{sectionId}/{category}':
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- Library
|
- Library
|
||||||
|
|||||||
Reference in New Issue
Block a user