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

Updating OpenAPI Spec

Browse Source
This commit is contained in:
lukehagar
2023-04-10 13:38:45 +00:00
parent d71bff781e
commit b262a56dda
1 changed files with 84 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -752,6 +752,89 @@ paths:
description: The playlist description: The playlist
'401': '401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query. description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
delete:
tags:
- Playlists
summary: Delete a Playlist
description: |
This endpoint will delete a playlist
operationId: deletePlaylist
parameters:
- name: playlistID
description: the ID of the playlist
in: path
schema:
type: number
required: true
responses:
'200':
description: The playlist is deleted
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
put:
tags:
- Playlists
summary: Update a Playlist
description: |
This endpoint will delete a playlist
operationId: updatePlaylist
parameters:
- name: playlistID
description: the ID of the playlist
in: path
schema:
type: number
required: true
responses:
'200':
description: The playlist is deleted
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
'/playlists/{playlistID}/items':
get:
tags:
- Playlists
summary: Retrieve Playlist Contents
description: |
This endpoint will return the contents of a playlist
operationId: getPlaylistContent
parameters:
- name: playlistID
description: the ID of the playlist
in: path
schema:
type: number
required: true
- name: type
description: the metadata type of the item to return
in: query
schema:
type: number
required: true
responses:
'200':
description: The playlist contents
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
delete:
tags:
- Playlists
summary: Delete Playlist Contents
description: |
This endpoint will clear the contents of a playlist
operationId: clearPlaylistContent
parameters:
- name: playlistID
description: the ID of the playlist
in: path
schema:
type: number
required: true
responses:
'200':
description: The playlist contents are cleared
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
tags: tags:
- name: Activities - name: Activities
description: | description: |
@@ -784,7 +867,7 @@ tags:
- name: Hubs - name: Hubs
description: | description: |
Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows. Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.
- name: Playlist - name: Playlists
description: | description: |
Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017"). They can be organized in (optionally nesting) folders. Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017"). They can be organized in (optionally nesting) folders.
Retrieving a playlist, or its items, will trigger a refresh of its metadata. This may cause the duration and number of items to change. Retrieving a playlist, or its items, will trigger a refresh of its metadata. This may cause the duration and number of items to change.