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

Add: descriptions

Browse source
This commit is contained in:
Nicholas Wallace 2024-05-12 07:18:48 +00:00
parent 9f6ef2dea3
commit eaad5c82c8
1 changed files with 15 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/root.yaml
View file

@ -22,6 +22,7 @@ paths:
get: get:
operationId: getAuthorById operationId: getAuthorById
summary: Get a single author by ID on server summary: Get a single author by ID on server
description: Get a single author by ID on server. The author's books and series can be included in the response.
tags: tags:
- Authors - Authors
parameters: parameters:
@ -42,7 +43,8 @@ paths:
$ref: './controllers/AuthorController.yaml#/components/responses/author404' $ref: './controllers/AuthorController.yaml#/components/responses/author404'
patch: patch:
operationId: updateAuthorById operationId: updateAuthorById
summary: Update a single author by ID on server. This endpoint will merge two authors if the new author name matches another author in the database. summary: Update a single author by ID on server.
description: Update a single author by ID on server. This endpoint will merge two authors if the new author name matches another author in the database.
tags: tags:
- Authors - Authors
parameters: parameters:
@ -70,7 +72,8 @@ paths:
$ref: './controllers/AuthorController.yaml#/components/responses/author404' $ref: './controllers/AuthorController.yaml#/components/responses/author404'
delete: delete:
operationId: deleteAuthorById operationId: deleteAuthorById
summary: Delete a single author by ID on server and remove author from all books. summary: Delete a single author by ID.
description: Delete a single author by ID on server and remove author from all books.
tags: tags:
- Authors - Authors
parameters: parameters:
@ -84,6 +87,7 @@ paths:
post: post:
operationId: setAuthorImageById operationId: setAuthorImageById
summary: Set an author image using a provided URL. summary: Set an author image using a provided URL.
description: Set an author image using a provided URL. The image will be downloaded and stored on the server.
tags: tags:
- Authors - Authors
parameters: parameters:
@ -102,6 +106,7 @@ paths:
delete: delete:
operationId: deleteAuthorImageById operationId: deleteAuthorImageById
summary: Delete an author image from the server and remove the image from the database. summary: Delete an author image from the server and remove the image from the database.
description: Delete an author image from the server.
tags: tags:
- Authors - Authors
parameters: parameters:
@ -114,6 +119,7 @@ paths:
patch: patch:
operationId: getAuthorImageById operationId: getAuthorImageById
summary: Return the author image by author ID. summary: Return the author image by author ID.
description: Return the author image by author ID. The image will be resized if the width, height, or format is provided.
tags: tags:
- Authors - Authors
parameters: parameters:
@ -135,7 +141,8 @@ paths:
/api/authors/{id}/match: /api/authors/{id}/match:
post: post:
operationId: matchAuthorById operationId: matchAuthorById
summary: Match the author against Audible using quick match. Quick match updates the author's description and image (if no image already existed) with information from audible. Either `asin` or `q` must be provided, with `asin` taking priority if both are provided. summary: Match the author against Audible using quick match.
description: Match the author against Audible using quick match. Quick match updates the author's description and image (if no image already existed) with information from audible. Either `asin` or `q` must be provided, with `asin` taking priority if both are provided.
tags: tags:
- Authors - Authors
parameters: parameters:
@ -157,6 +164,7 @@ paths:
get: get:
operationId: getLibraries operationId: getLibraries
summary: Get all libraries on server summary: Get all libraries on server
description: Get all libraries on server.
tags: tags:
- Libraries - Libraries
responses: responses:
@ -171,6 +179,7 @@ paths:
post: post:
operationId: createLibrary operationId: createLibrary
summary: Create a new library on server summary: Create a new library on server
description: Create a new library on server.
tags: tags:
- Libraries - Libraries
parameters: parameters:
@ -189,6 +198,7 @@ paths:
get: get:
operationId: getLibraryById operationId: getLibraryById
summary: Get a single library by ID on server summary: Get a single library by ID on server
description: Get a single library by ID on server.
tags: tags:
- Libraries - Libraries
parameters: parameters:
@ -201,6 +211,7 @@ paths:
patch: patch:
operationId: updateLibraryById operationId: updateLibraryById
summary: Update a single library by ID on server summary: Update a single library by ID on server
description: Update a single library by ID on server.
tags: tags:
- Libraries - Libraries
parameters: parameters:
@ -219,6 +230,7 @@ paths:
delete: delete:
operationId: deleteLibraryById operationId: deleteLibraryById
summary: Delete a single library by ID on server summary: Delete a single library by ID on server
description: Delete a single library by ID on server and return the deleted object.
tags: tags:
- Libraries - Libraries
parameters: parameters: