Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec

plex-api-spec-dereferenced.yaml

@@ -2435,6 +2435,105 @@ paths:
           schema:
             type: string
           required: false
+      responses:
+        '200':
+          description: The Pin
+          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: string
+                        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:03.000Z
+                  expiresAt:
+                    type: string
+                    format: date-time
+                    example: 2023-04-12T17:30:03.000Z
+                  authToken:
+                    type: string
+                    format: nullable
+                  newRegistration:
+                    type: string
+                    format: nullable
+        '400':
+          description: X-Plex-Client-Identifier is missing
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  errors:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        code:
+                          type: number
+                          example: 1000
+                        message:
+                          type: string
+                          example: X-Plex-Client-Identifier is missing
+                        status:
+                          type: number
+                          example: 400
   '/pins/{pinID}':
     servers:
       - url: 'https://plex.tv/api/v2'
@@ -2525,6 +2624,30 @@ paths:
           schema:
             type: string
           required: false
+      responses:
+        '200':
+          description: Access Token
+        '401':
+          description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  errors:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        code:
+                          type: number
+                          example: 1001
+                        message:
+                          type: string
+                          example: User could not be authenticated
+                        status:
+                          type: number
+                          example: 401
 tags:
   - name: Activities
     description: |