diff --git a/docs/controllers/SeriesController.yaml b/docs/controllers/SeriesController.yaml index 2788ac1b1..1fd999ed4 100644 --- a/docs/controllers/SeriesController.yaml +++ b/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 diff --git a/docs/objects/entities/Series.yaml b/docs/objects/entities/Series.yaml index 90c8e04aa..ef35a5b35 100644 --- a/docs/objects/entities/Series.yaml +++ b/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: - - $ref: '#/components/schemas/series' - - type: object - properties: - progress: - $ref: '#/components/schemas/seriesProgress' - rssFeed: - description: The RSS feed for the series. - type: string - example: 'TBD' + 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' diff --git a/docs/openapi.json b/docs/openapi.json index baf4259da..8d993d7a6 100644 --- a/docs/openapi.json +++ b/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": { diff --git a/docs/root.yaml b/docs/root.yaml index ca42751c3..c8bc23ea0 100644 --- a/docs/root.yaml +++ b/docs/root.yaml @@ -40,3 +40,5 @@ tags: description: Author endpoints - name: Libraries description: Library endpoints + - name: Series + description: Series endpoints