mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2025-11-04 03:17:00 -05:00
baf5f7fbc3
* Fix: extra type in `Author.yaml`
* Fix: formatting
* Initial library schema
* Additional debugging
* Fix: spec relative paths
* Add: ebook file spec
* Fix: response type should be string
* Linting updates
* Add: missing librarySettings
* Temporary fix: Library cron can be null or false
* Author controller updates
* Add: `/api/libraries/{id}` endpoint
* Update library responses
* Add: descriptions
* Fix: queries should be in body
* Fix: `body` should be `requestBody`
* Move: `libraryController` paths, clean up `requestBody`
* Clean up libraryController parameters
* Move: author endpoints to controller
* Add `get` for author images
* Simplify author schema with items
* Remove: unused response type
* Update: formatting
* Update json
* Update requestBody on LibraryController
* LibrarySettings update
* Replace: generic parameter with path specific parameter
* Fix: requestBody descriptions
* Fix: match post operation
* Temporary: nullable Author schemas
* LibraryController items endpoint
* Add: delete library items with issues
* Massive cleanup and violation fixing
* Update bundled spec
* Add: remove library items with issues
* Add: library items endpoint
* Fix: errors
* Fix: base schemas
* Add: series schemas
* Add: library series endpoint
* Fix: oneOf and array issues
* Add: author search region for matching
* Add: series endpoints
* Fix: series issues
* Add library series endpoint and update deprecation
* Fix: series endpoint deprecation
* Fix: `name` in `sortDesc` schema
* Add: workflow for linting spec
* Update OpenAPI readme
73 lines
2.2 KiB
YAML
73 lines
2.2 KiB
YAML
components:
|
|
responses:
|
|
series404:
|
|
description: Series not found.
|
|
content:
|
|
text/html:
|
|
schema:
|
|
type: string
|
|
example: Series not found.
|
|
paths:
|
|
/api/series/{id}:
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
description: The ID of the series.
|
|
required: true
|
|
schema:
|
|
$ref: '../objects/entities/Series.yaml#/components/schemas/seriesId'
|
|
get:
|
|
operationId: getSeries
|
|
tags:
|
|
- Series
|
|
summary: Get series
|
|
description: Get a series by ID.
|
|
requestBody:
|
|
required: false
|
|
description: A comma separated list of what to include with the series.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
include:
|
|
type: string
|
|
description: A comma separated list of what to include with the series.
|
|
example: 'progress,rssfeed'
|
|
enum: ['progress', 'rssfeed', 'progress,rssfeed', 'rssfeed,progress']
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../objects/entities/Series.yaml#/components/schemas/seriesWithProgressAndRSS'
|
|
'404':
|
|
$ref: '#/components/responses/series404'
|
|
patch:
|
|
operationId: updateSeries
|
|
tags:
|
|
- Series
|
|
summary: Update series
|
|
description: Update a series by ID.
|
|
requestBody:
|
|
required: true
|
|
description: The series to update.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
name:
|
|
$ref: '../objects/entities/Series.yaml#/components/schemas/seriesName'
|
|
description:
|
|
$ref: '../objects/entities/Series.yaml#/components/schemas/seriesDescription'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../objects/entities/Series.yaml#/components/schemas/series'
|
|
'404':
|
|
$ref: '#/components/responses/series404'
|