LukeParke/plex-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-docs.git synced 2025-12-06 12:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating OpenAPI Spec

Browse Source
This commit is contained in:
lukehagar
2023-04-14 01:36:57 +00:00
parent ff9ee450d2
commit c32a5e6c95
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
static/plex-api-spec-dereferenced.yaml
View File

@@ -865,7 +865,7 @@ paths:
put: put:
tags: tags:
- Updater - Updater
summary: Applying updates summary: Apply Updates
description: | description: |
Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
operationId: applyUpdates operationId: applyUpdates
@@ -1830,7 +1830,7 @@ paths:
description: | description: |
If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.
Note: requires Plex Media Server >= 1.15.4. Note: requires Plex Media Server >= 1.15.4.
operationId: getConnectionInformation operationId: getSourceConnectionInformation
parameters: parameters:
- name: source - name: source
description: The source identifier with an included prefix. description: The source identifier with an included prefix.
@@ -4643,7 +4643,7 @@ paths:
- User - User
summary: Get Logged in User summary: Get Logged in User
description: Get Logged in User description: Get Logged in User
operationId: getCurrentUserDetails operationId: getUserDetails
parameters: parameters:
- in: header - in: header
name: X-Plex-Device-Name name: X-Plex-Device-Name
@@ -4934,14 +4934,17 @@ paths:
/pins: /pins:
servers: servers:
- url: 'https://plex.tv/api/v2' - url: 'https://plex.tv/api/v2'
security:
- PlexClientIdentifier: []
post: post:
tags: tags:
- Authentication - Authentication
summary: Get a Pin summary: Get a Pin
operationId: getPin operationId: getPin
description: Retrieve a Pin from Plex.tv for authentication flows description: Retrieve a Pin from Plex.tv for authentication flows
security:
- PlexClientIdentifier:
type: apiKey
in: header
name: X-Plex-Client-Identifier
parameters: parameters:
- name: strong - name: strong
description: | description: |
@@ -5123,14 +5126,17 @@ paths:
'/pins/{pinID}': '/pins/{pinID}':
servers: servers:
- url: 'https://plex.tv/api/v2' - url: 'https://plex.tv/api/v2'
security:
- PlexClientIdentifier: []
get: get:
tags: tags:
- Authentication - Authentication
summary: Get Access Token summary: Get Access Token
operationId: getToken operationId: getToken
description: Retrieve an Access Token from Plex.tv after the Pin has already been authenticated description: Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
security:
- PlexClientIdentifier:
type: apiKey
in: header
name: X-Plex-Client-Identifier
parameters: parameters:
- name: pinID - name: pinID
description: The PinID to retrieve an access token for description: The PinID to retrieve an access token for