Updating OpenAPI Spec

static/plex-api-spec-dereferenced.yaml

@@ -124,7 +124,7 @@ paths:
         - Server
       summary: Server Capabilities
       description: Server Capabilities
-      operationId: serverCapabilities
+      operationId: getServerCapabilities
       responses:
         '200':
           description: The Server Capabilities
@@ -274,7 +274,7 @@ paths:
         - Activities
       summary: Server Activities
       description: Server Activities
-      operationId: serverActivities
+      operationId: getServerActivities
       responses:
         '200':
           description: The Server Activities
@@ -378,7 +378,7 @@ paths:
         - Updater
       summary: Querying status of updates
       description: Querying status of updates
-      operationId: queryingUpdateStatus
+      operationId: queryUpdateStatus
       responses:
         '200':
           description: The Server Updates
@@ -409,7 +409,7 @@ paths:
         - Updater
       summary: Checking for updates
       description: Checking for updates
-      operationId: checkingforUpdates
+      operationId: checkForUpdates
       parameters:
         - name: download
           description: Indicate that you want to start download any updates found.
@@ -451,7 +451,7 @@ paths:
       summary: Applying updates
       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
-      operationId: applyingUpdates
+      operationId: applyUpdates
       parameters:
         - name: tonight
           description: Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
@@ -508,7 +508,7 @@ paths:
         2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
         3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
         4. If we are outside the configured window, the task will start immediately.
-      operationId: startAllButlerTasks
+      operationId: startAllTasks
       responses:
         '200':
           description: All tasks were started
@@ -539,7 +539,7 @@ paths:
       summary: Stop all Butler tasks
       description: |
         This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.
-      operationId: stopAllButlerTasks
+      operationId: stopAllTasks
       responses:
         '200':
           description: All tasks were stopped
@@ -575,7 +575,7 @@ paths:
         2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
         3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
         4. If we are outside the configured window, the task will start immediately.
-      operationId: startAButlerTasks
+      operationId: startTask
       parameters:
         - name: taskName
           description: the name of the task to be started.
@@ -630,7 +630,7 @@ paths:
       summary: Stop a single Butler task
       description: |
         This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint.
-      operationId: stopAButlerTasks
+      operationId: stopTask
       parameters:
         - name: taskName
           description: The name of the task to be started.
@@ -686,7 +686,7 @@ paths:
       summary: Logging a single line message.
       description: |
         This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log.
-      operationId: logaLine
+      operationId: logLine
       parameters:
         - name: level
           description: |
@@ -750,7 +750,7 @@ paths:
       summary: Logging a multi-line message
       description: |
         This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above.
-      operationId: logMultipleLines
+      operationId: logMultiLine
       responses:
         '200':
           description: Multi-Line Log Message Posted successfully
@@ -905,10 +905,10 @@ paths:
     get:
       tags:
         - Library
-      summary: Get All Library Items
+      summary: Get Library Items
       description: |
-        This endpoint will return a list of all library items filtered by the filter and type provided
+        This endpoint will return a list of library items filtered by the filter and type provided
-      operationId: getAllLibraryItems
+      operationId: getLibraryItems
       parameters:
         - name: sectionId
           description: the Id of the library to query
@@ -1172,14 +1172,14 @@ paths:
       tags:
         - Library
       summary: Get All Libraries
+      operationId: getLibraries
       description: |
         A library section (commonly referred to as just a library) is a collection of media. 
         Libraries are typed, and depending on their type provide either a flat or a hierarchical view of the media. 
         For example, a music library has an artist > albums > tracks structure, whereas a movie library is flat.
 
         Libraries have features beyond just being a collection of media; for starters, they include information about supported types, filters and sorts. 
-        \This allows a client to provide a rich interface around the media (e.g. allow sorting movies by release year).
+        This allows a client to provide a rich interface around the media (e.g. allow sorting movies by release year).
-      operationId: getLibraries
       responses:
         '200':
           description: The libraries available on the Server
@@ -1388,7 +1388,7 @@ paths:
         - Playlists
       summary: Get All Playlists
       description: ''
-      operationId: getAllPlaylists
+      operationId: getPlaylists
       parameters:
         - name: playlistType
           description: limit to a type of playlist.
@@ -1442,7 +1442,7 @@ paths:
         Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:
         - `uri` - The content URI for what we're playing (e.g. `library://...`).
         - `playQueueID` - To create a playlist from an existing play queue.
-      operationId: createAPlaylist
+      operationId: createPlaylist
       parameters:
         - name: title
           description: name of the playlist
@@ -1631,7 +1631,7 @@ paths:
         By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the `type` parameter. 
         For example, you could use this to display a list of recently added albums vis a smart playlist. 
         Note that for dumb playlists, items have a `playlistItemID` attribute which is used for deleting or moving items.
-      operationId: getPlaylistContent
+      operationId: getPlaylistContents
       parameters:
         - name: playlistID
           description: the ID of the playlist
@@ -1675,7 +1675,7 @@ paths:
       summary: Delete Playlist Contents
       description: |
         Clears a playlist, only works with dumb playlists. Returns the playlist.
-      operationId: clearPlaylistContent
+      operationId: clearPlaylistContents
       parameters:
         - name: playlistID
           description: the ID of the playlist
@@ -1714,7 +1714,7 @@ paths:
       description: |
         Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. 
         With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist.
-      operationId: addPlaylistContent
+      operationId: addPlaylistContents
       parameters:
         - name: playlistID
           description: the ID of the playlist
@@ -1822,6 +1822,7 @@ paths:
       tags:
         - Search
       summary: Perform a search
+      operationId: performSearch
       description: |
         This endpoint performs a search across all library sections, or a single section, and returns matches as hubs, split up by type. It performs spell checking, looks for partial matches, and orders the hubs based on quality of results. In addition, based on matches, it will return other related matches (e.g. for a genre match, it may return movies in that genre, or for an actor match, movies with that actor).
 
@@ -1835,7 +1836,6 @@ paths:
         - `reasonID`: The ID of the item associated with the reason for the result. This might be a section ID, a tag ID, an artist ID, or a show ID.
 
         This request is intended to be very fast, and called as the user types.
-      operationId: performSearch
       parameters:
         - name: query
           description: The query term
@@ -1888,12 +1888,12 @@ paths:
       tags:
         - Search
       summary: Perform a voice search
+      operationId: performVoiceSearch
       description: |
         This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint. 
         It uses a [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) heuristic to search titles, and as such is much slower than the other search endpoint. 
         Whenever possible, clients should limit the search to the appropriate type. 
         Results, as well as their containing per-type hubs, contain a `distance` attribute which can be used to judge result quality.
-      operationId: performVoiceSearch
       parameters:
         - name: query
           description: The query term