Fix: series issues

docs/controllers/SeriesController.yaml

@@ -17,6 +17,7 @@ paths:
         schema:
           $ref: '../objects/entities/Series.yaml#/components/schemas/seriesId'
     get:
+      operationId: getSeries
       tags:
         - Series
       summary: Get series
@@ -33,7 +34,7 @@ paths:
                   type: string
                   description: A comma separated list of what to include with the series.
                   example: 'progress,rssfeed'
-                  enum: ['progress', 'rssfeed']
+                  enum: ['progress', 'rssfeed', 'progress,rssfeed', 'rssfeed,progress']
       responses:
         '200':
           description: OK
@@ -44,6 +45,7 @@ paths:
         '404':
           $ref: '#/components/responses/series404'
     patch:
+      operationId: updateSeries
       tags:
         - Series
       summary: Update series

docs/objects/entities/Series.yaml

@@ -105,14 +105,13 @@ components:
     seriesWithProgressAndRSS:
       type: object
       description: A series object which includes the name and progress of the series.
-      properties:
+      oneOf:
-        oneOf:
+        - $ref: '#/components/schemas/series'
-          - $ref: '#/components/schemas/series'
+        - type: object
-          - type: object
+          properties:
-            properties:
+            progress:
-              progress:
+              $ref: '#/components/schemas/seriesProgress'
-                $ref: '#/components/schemas/seriesProgress'
+            rssFeed:
-              rssFeed:
+              description: The RSS feed for the series.
-                description: The RSS feed for the series.
+              type: string
-                type: string
+              example: 'TBD'
-                example: 'TBD'

docs/openapi.json

@@ -24,6 +24,10 @@
     {
       "name": "Libraries",
       "description": "Library endpoints"
+    },
+    {
+      "name": "Series",
+      "description": "Series endpoints"
     }
   ],
   "paths": {
@@ -885,6 +889,7 @@
         }
       ],
       "get": {
+        "operationId": "getSeries",
         "tags": [
           "Series"
         ],
@@ -904,7 +909,9 @@
                     "example": "progress,rssfeed",
                     "enum": [
                       "progress",
-                      "rssfeed"
+                      "rssfeed",
+                      "progress,rssfeed",
+                      "rssfeed,progress"
                     ]
                   }
                 }
@@ -929,6 +936,7 @@
         }
       },
       "patch": {
+        "operationId": "updateSeries",
         "tags": [
           "Series"
         ],
@@ -1772,30 +1780,6 @@
           }
         }
       },
-      "seriesWithProgressAndRSS": {
-        "type": "object",
-        "description": "A series object which includes the name and progress of the series.",
-        "properties": {
-          "oneOf": [
-            {
-              "$ref": "#/components/schemas/series"
-            },
-            {
-              "type": "object",
-              "properties": {
-                "progress": {
-                  "$ref": "#/components/schemas/seriesProgress"
-                },
-                "rssFeed": {
-                  "description": "The RSS feed for the series.",
-                  "type": "string",
-                  "example": "TBD"
-                }
-              }
-            }
-          ]
-        }
-      },
       "seriesDescription": {
         "description": "A description for the series. Will be null if there is none.",
         "type": "string",
@@ -1822,6 +1806,52 @@
             "$ref": "#/components/schemas/updatedAt"
           }
         }
+      },
+      "seriesProgress": {
+        "type": "object",
+        "description": "The user's progress of a series.",
+        "properties": {
+          "libraryItemIds": {
+            "description": "The IDs of the library items in the series.",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/libraryItemId"
+            }
+          },
+          "libraryItemIdsFinished": {
+            "description": "The IDs of the library items in the series that are finished.",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/libraryItemId"
+            }
+          },
+          "isFinished": {
+            "description": "Whether the series is finished.",
+            "type": "boolean"
+          }
+        }
+      },
+      "seriesWithProgressAndRSS": {
+        "type": "object",
+        "description": "A series object which includes the name and progress of the series.",
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/series"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "progress": {
+                "$ref": "#/components/schemas/seriesProgress"
+              },
+              "rssFeed": {
+                "description": "The RSS feed for the series.",
+                "type": "string",
+                "example": "TBD"
+              }
+            }
+          }
+        ]
       }
     },
     "responses": {

docs/root.yaml

@@ -40,3 +40,5 @@ tags:
     description: Author endpoints
   - name: Libraries
     description: Library endpoints
+  - name: Series
+    description: Series endpoints