Redoing the docs for playlist delete

ystv · Jan 2, 2025 · 56d2b81 · 56d2b81
1 parent 5d3ba53
commit 56d2b81
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 7 deletions.
diff --git a/controllers/v1/creator/playlist.go b/controllers/v1/creator/playlist.go
@@ -128,14 +128,14 @@ func (r *Repos) UpdatePlaylist(c echo.Context) error {
 	return c.NoContent(http.StatusOK)
 }
 
-// DeletePlaylist handles deleting series
-// @Summary Delete a series
-// @Description Delete a series
-// @ID delete-creator-series
-// @Tags creator-series
-// @Param seriesid path int true "Series ID"
+// DeletePlaylist handles deleting playlist
+// @Summary Delete a playlist
+// @Description Delete a playlist
+// @ID delete-creator-playlist
+// @Tags creator-playlist
+// @Param playlistid path int true "Series ID"
 // @Success 200
-// @Router /v1/internal/creator/series/{seriesid} [delete]
+// @Router /v1/internal/creator/playlist/{playlistid} [delete]
 func (r *Repos) DeletePlaylist(c echo.Context) error {
 	playlistID, err := strconv.Atoi(c.Param("playlistid"))
 	if err != nil {

diff --git a/swagger/docs.go b/swagger/docs.go
@@ -903,6 +903,28 @@ const docTemplate = `{
                         }
                     }
                 }
+            },
+            "delete": {
+                "description": "Delete a playlist",
+                "tags": [
+                    "creator-playlist"
+                ],
+                "summary": "Delete a playlist",
+                "operationId": "delete-creator-playlist",
+                "parameters": [
+                    {
+                        "type": "integer",
+                        "description": "Series ID",
+                        "name": "playlistid",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK"
+                    }
+                }
             }
         },
         "/v1/internal/creator/playout/channels": {