groove/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-07-12 04:11:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix: series endpoint deprecation

Browse source
This commit is contained in:
Nicholas Wallace 2024-05-21 01:57:57 +00:00
parent d293edfc05
commit bc1492129c
3 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/controllers/LibraryController.yaml
View file

@ -395,7 +395,8 @@ paths:
get: get:
operationId: getLibrarySeriesById operationId: getLibrarySeriesById
summary: Get single series in library 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: tags:
- Libraries - Libraries
requestBody: requestBody:

3
docs/controllers/SeriesController.yaml
View file

@ -18,11 +18,10 @@ paths:
$ref: '../objects/entities/Series.yaml#/components/schemas/seriesId' $ref: '../objects/entities/Series.yaml#/components/schemas/seriesId'
get: get:
operationId: getSeries operationId: getSeries
deprecated: true
tags: tags:
- Series - Series
summary: Get 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: requestBody:
required: false required: false
description: A comma separated list of what to include with the series. description: A comma separated list of what to include with the series.

6
docs/openapi.json
View file

@ -900,7 +900,8 @@
"get": { "get": {
"operationId": "getLibrarySeriesById", "operationId": "getLibrarySeriesById",
"summary": "Get single series in library", "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": [ "tags": [
"Libraries" "Libraries"
], ],
@ -980,12 +981,11 @@
], ],
"get": { "get": {
"operationId": "getSeries", "operationId": "getSeries",
"deprecated": true,
"tags": [ "tags": [
"Series" "Series"
], ],
"summary": "Get 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": { "requestBody": {
"required": false, "required": false,
"description": "A comma separated list of what to include with the series.", "description": "A comma separated list of what to include with the series.",