mirror of
https://github.com/LukeHagar/plex-api-spec.git
synced 2025-12-09 12:37:45 +00:00
cleaning and formatting, adding error names
This commit is contained in:
@@ -16,7 +16,6 @@ get:
|
|||||||
- 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
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- Authentication
|
- Authentication
|
||||||
summary: Get a Transient Token.
|
summary: Get a Transient Token
|
||||||
description: |
|
description: |
|
||||||
This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
|
This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
|
||||||
operationId: getTransientToken
|
operationId: getTransientToken
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ get:
|
|||||||
This endpoint will return the recently added content.
|
This endpoint will return the recently added content.
|
||||||
operationId: getRecentlyAdded
|
operationId: getRecentlyAdded
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "../../parameters/accept-application-json.yaml"
|
|
||||||
- $ref: "../../parameters/container-start.yaml"
|
- $ref: "../../parameters/container-start.yaml"
|
||||||
- $ref: "../../parameters/container-size.yaml"
|
- $ref: "../../parameters/container-size.yaml"
|
||||||
responses:
|
responses:
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ get:
|
|||||||
schema:
|
schema:
|
||||||
$ref: ../../models/AuthPinContainer.yaml
|
$ref: ../../models/AuthPinContainer.yaml
|
||||||
"400":
|
"400":
|
||||||
$ref: ../../responses/400-MissingIdentifier.yaml
|
$ref: ../../responses/400.yaml
|
||||||
"404":
|
"404":
|
||||||
description: Not Found or Expired
|
description: Not Found or Expired
|
||||||
content:
|
content:
|
||||||
|
|||||||
@@ -28,4 +28,4 @@ post:
|
|||||||
schema:
|
schema:
|
||||||
$ref: ../../models/AuthPinContainer.yaml
|
$ref: ../../models/AuthPinContainer.yaml
|
||||||
"400":
|
"400":
|
||||||
$ref: ../../responses/400-MissingIdentifier.yaml
|
$ref: ../../responses/400.yaml
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ get:
|
|||||||
operationId: get-server-resources
|
operationId: get-server-resources
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
|
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
|
||||||
- $ref: "../../parameters/plex/x-plex-token.yaml"
|
|
||||||
- name: includeHttps
|
- name: includeHttps
|
||||||
in: query
|
in: query
|
||||||
description: Include Https entries in the results
|
description: Include Https entries in the results
|
||||||
@@ -26,7 +25,6 @@ get:
|
|||||||
description: Include IPv6 entries in the results
|
description: Include IPv6 entries in the results
|
||||||
schema:
|
schema:
|
||||||
$ref: "../../models/common/PlexBoolean.yaml"
|
$ref: "../../models/common/PlexBoolean.yaml"
|
||||||
- $ref: "../../parameters/accept-application-json.yaml"
|
|
||||||
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
|
||||||
|
|||||||
@@ -3,12 +3,9 @@ get:
|
|||||||
- url: https://plex.tv/api/v2/
|
- url: https://plex.tv/api/v2/
|
||||||
tags:
|
tags:
|
||||||
- Authentication
|
- Authentication
|
||||||
summary: Get User Data By Token
|
summary: Get Token Details
|
||||||
description: Get the User data from the provided X-Plex-Token
|
description: Get the User data from the provided X-Plex-Token
|
||||||
operationId: getUserDetails
|
operationId: getTokenDetails
|
||||||
parameters:
|
|
||||||
- $ref: "../../parameters/plex/x-plex-token.yaml"
|
|
||||||
- $ref: "../../parameters/accept-application-json.yaml"
|
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: Logged in user details
|
description: Logged in user details
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ post:
|
|||||||
operationId: post-users-sign-in-data
|
operationId: post-users-sign-in-data
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
|
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
|
||||||
- $ref: "../../parameters/accept-application-json.yaml"
|
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
application/x-www-form-urlencoded:
|
application/x-www-form-urlencoded:
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
description: Bad Request response when the X-Plex-Client-Identifier is missing
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
errors:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
code:
|
|
||||||
type: integer
|
|
||||||
example: 1000
|
|
||||||
message:
|
|
||||||
type: string
|
|
||||||
x-speakeasy-error-message: true
|
|
||||||
example: X-Plex-Client-Identifier is missing
|
|
||||||
status:
|
|
||||||
type: integer
|
|
||||||
example: 400
|
|
||||||
@@ -2,6 +2,7 @@ description: Bad Request - A parameter was not specified, or was specified incor
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
x-speakeasy-name-override: BadRequest
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
errors:
|
errors:
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ description: Unauthorized - Returned if the X-Plex-Token is missing from the hea
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
x-speakeasy-name-override: Unauthorized
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
errors:
|
errors:
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ description: Request Timeout
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
x-speakeasy-name-override: RequestTimeout
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
code:
|
code:
|
||||||
|
|||||||
Reference in New Issue
Block a user