diff --git a/docs/controllers/LibraryController.yaml b/docs/controllers/LibraryController.yaml index df044f2ce..2924ab75a 100644 --- a/docs/controllers/LibraryController.yaml +++ b/docs/controllers/LibraryController.yaml @@ -395,7 +395,8 @@ paths: get: operationId: getLibrarySeriesById summary: Get single series in library - description: Get a single series in a library by ID on server. + description: Get a single series in a library by ID on server. This endpoint is deprecated and `/api/series/{id}` should be used instead. + deprecated: true tags: - Libraries requestBody: diff --git a/docs/controllers/SeriesController.yaml b/docs/controllers/SeriesController.yaml index 233528a89..1fd999ed4 100644 --- a/docs/controllers/SeriesController.yaml +++ b/docs/controllers/SeriesController.yaml @@ -18,11 +18,10 @@ paths: $ref: '../objects/entities/Series.yaml#/components/schemas/seriesId' get: operationId: getSeries - deprecated: true tags: - Series summary: Get series - description: Get a series by ID. This endpoint is deprecated and will be removed in the future. Use `/api/libraries/{id}/series/{seriesId}` instead. + description: Get a series by ID. requestBody: required: false description: A comma separated list of what to include with the series. diff --git a/docs/openapi.json b/docs/openapi.json index 6930f90df..57ba2fd3c 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -900,7 +900,8 @@ "get": { "operationId": "getLibrarySeriesById", "summary": "Get single series in library", - "description": "Get a single series in a library by ID on server.", + "description": "Get a single series in a library by ID on server. This endpoint is deprecated and `/api/series/{id}` should be used instead.", + "deprecated": true, "tags": [ "Libraries" ], @@ -980,12 +981,11 @@ ], "get": { "operationId": "getSeries", - "deprecated": true, "tags": [ "Series" ], "summary": "Get series", - "description": "Get a series by ID. This endpoint is deprecated and will be removed in the future. Use `/api/libraries/{id}/series/{seriesId}` instead.", + "description": "Get a series by ID.", "requestBody": { "required": false, "description": "A comma separated list of what to include with the series.",