Update pins-id.yaml 200 response

I believe this is the correct response...it returns the full pin with authToken=null until after it's verified
This commit is contained in:
Jason
2024-03-15 23:45:59 -07:00
committed by GitHub
parent f11c1cad8d
commit 0d8f198f1f

View File

@@ -16,7 +16,82 @@ get:
responses:
"200":
description: Access Token
description: The pin with a non-null authToken after verification
content:
application/json:
schema:
type: object
properties:
id:
description: PinID for use with authentication
type: number
example: 1272322473
code:
type: string
example: 3patfx1a78ukcbr7x0n9bl26t
product:
type: string
example: Plex Web
trusted:
type: boolean
qr:
description: |
a link to a QR code hosted on plex.tv
The QR code redirects to the relevant `plex.tv/link` authentication page
Which then prompts the user for the 4 Digit Link Pin
type: string
example: https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t
clientIdentifier:
type: string
example: Postman
location:
type: object
properties:
code:
type: string
example: US
european_union_member:
type: boolean
continent_code:
type: string
example: NA
country:
type: string
example: United States
city:
type: string
example: Austin
time_zone:
type: string
example: America/Chicago
postal_code:
type: number
example: 78732
in_privacy_restricted_country:
type: boolean
subdivisions:
type: string
example: Texas
coordinates:
type: string
example: 30.3768 -97.8935
expiresIn:
type: number
example: 1800
createdAt:
type: string
format: date-time
example: 2023-04-12T17:00:03Z
expiresAt:
type: string
format: date-time
example: 2023-04-12T17:30:03Z
authToken:
type: string
format: nullable
newRegistration:
type: string
format: nullable
"400":
description: X-Plex-Client-Identifier is missing
content: