cleaning and formatting, adding error names

This commit is contained in:
Luke Hagar
2024-09-09 18:40:53 +00:00
parent b0cac052b4
commit cf7b58ff07
12 changed files with 8 additions and 34 deletions

View File

@@ -16,7 +16,6 @@ get:
- server://client-identifier
- provider://provider-identifier
required: true
responses:
"200":
description: Source Connection Information

View File

@@ -1,7 +1,7 @@
get:
tags:
- Authentication
summary: Get a Transient Token.
summary: Get a Transient Token
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.
operationId: getTransientToken

View File

@@ -6,7 +6,6 @@ get:
This endpoint will return the recently added content.
operationId: getRecentlyAdded
parameters:
- $ref: "../../parameters/accept-application-json.yaml"
- $ref: "../../parameters/container-start.yaml"
- $ref: "../../parameters/container-size.yaml"
responses:

View File

@@ -23,7 +23,7 @@ get:
schema:
$ref: ../../models/AuthPinContainer.yaml
"400":
$ref: ../../responses/400-MissingIdentifier.yaml
$ref: ../../responses/400.yaml
"404":
description: Not Found or Expired
content:

View File

@@ -28,4 +28,4 @@ post:
schema:
$ref: ../../models/AuthPinContainer.yaml
"400":
$ref: ../../responses/400-MissingIdentifier.yaml
$ref: ../../responses/400.yaml

View File

@@ -8,7 +8,6 @@ get:
operationId: get-server-resources
parameters:
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
- $ref: "../../parameters/plex/x-plex-token.yaml"
- name: includeHttps
in: query
description: Include Https entries in the results
@@ -26,7 +25,6 @@ get:
description: Include IPv6 entries in the results
schema:
$ref: "../../models/common/PlexBoolean.yaml"
- $ref: "../../parameters/accept-application-json.yaml"
responses:
"200":
description: List of Plex Devices. This includes Plex hosted servers and clients

View File

@@ -3,12 +3,9 @@ get:
- url: https://plex.tv/api/v2/
tags:
- Authentication
summary: Get User Data By Token
summary: Get Token Details
description: Get the User data from the provided X-Plex-Token
operationId: getUserDetails
parameters:
- $ref: "../../parameters/plex/x-plex-token.yaml"
- $ref: "../../parameters/accept-application-json.yaml"
operationId: getTokenDetails
responses:
"200":
description: Logged in user details

View File

@@ -9,7 +9,6 @@ post:
operationId: post-users-sign-in-data
parameters:
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
- $ref: "../../parameters/accept-application-json.yaml"
requestBody:
content:
application/x-www-form-urlencoded:

View File

@@ -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

View File

@@ -2,6 +2,7 @@ description: Bad Request - A parameter was not specified, or was specified incor
content:
application/json:
schema:
x-speakeasy-name-override: BadRequest
type: object
properties:
errors:

View File

@@ -2,6 +2,7 @@ description: Unauthorized - Returned if the X-Plex-Token is missing from the hea
content:
application/json:
schema:
x-speakeasy-name-override: Unauthorized
type: object
properties:
errors:

View File

@@ -2,6 +2,7 @@ description: Request Timeout
content:
application/json:
schema:
x-speakeasy-name-override: RequestTimeout
type: object
properties:
code: