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

Update requestBody on LibraryController

Browse source
This commit is contained in:
Nicholas Wallace 2024-05-15 03:03:48 +00:00
parent 9af5b8d96d
commit 0e9cf0df68
1 changed files with 50 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

74
docs/controllers/LibraryController.yaml
View file

@ -1,4 +1,12 @@
components:
parameters:
libraryId:
name: id
in: path
description: The ID of the library.
required: true
schema:
$ref: '../objects/Library.yaml#/components/schemas/libraryId'
requestBody:
libraryName:
name: name
@ -59,14 +67,6 @@ components:
description: The settings for the library.
schema:
$ref: '../objects/Library.yaml#/components/schemas/librarySettings'
parameters:
libraryId:
name: id
in: path
description: The ID of the library.
required: true
schema:
$ref: '../objects/Library.yaml#/components/schemas/libraryId'
responses:
library200:
description: Library found.
@ -106,27 +106,40 @@ paths:
tags:
- Libraries
requestBody:
$ref: '#/components/requestBody/libraryName'
$ref: '#/components/requestBody/libraryFolders'
$ref: '#/components/requestBody/libraryDisplayOrder'
$ref: '#/components/requestBody/libraryIcon'
$ref: '#/components/requestBody/libraryMediaType'
$ref: '#/components/requestBody/libraryProvider'
$ref: '#/components/requestBody/librarySettings'
required: true
content:
application/json:
schema:
type: object
properties:
name:
$ref: '#/components/requestBody/libraryName'
folders:
$ref: '#/components/requestBody/libraryFolders'
displayOrder:
$ref: '#/components/requestBody/libraryDisplayOrder'
icon:
$ref: '#/components/requestBody/libraryIcon'
mediaType:
$ref: '#/components/requestBody/libraryMediaType'
provider:
$ref: '#/components/requestBody/libraryProvider'
settings:
$ref: '#/components/requestBody/librarySettings'
responses:
'200':
$ref: '#/components/responses/library200'
'404':
$ref: '#/components/responses/library404'
/api/libraries/{id}:
parameters:
$ref: '#/components/parameters/libraryId'
get:
operationId: getLibraryById
summary: Get a single library by ID on server
description: Get a single library by ID on server.
tags:
- Libraries
parameters:
$ref: '#/components/parameters/libraryId'
responses:
'200':
$ref: '#/components/responses/library200'
@ -139,13 +152,26 @@ paths:
tags:
- Libraries
requestBody:
$ref: '#/components/requestBody/libraryName'
$ref: '#/components/requestBody/libraryFolders'
$ref: '#/components/requestBody/libraryDisplayOrder'
$ref: '#/components/requestBody/libraryIcon'
$ref: '#/components/requestBody/libraryMediaType'
$ref: '#/components/requestBody/libraryProvider'
$ref: '#/components/requestBody/librarySettings'
required: true
content:
application/json:
schema:
type: object
properties:
name:
$ref: '#/components/requestBody/libraryName'
folders:
$ref: '#/components/requestBody/libraryFolders'
displayOrder:
$ref: '#/components/requestBody/libraryDisplayOrder'
icon:
$ref: '#/components/requestBody/libraryIcon'
mediaType:
$ref: '#/components/requestBody/libraryMediaType'
provider:
$ref: '#/components/requestBody/libraryProvider'
settings:
$ref: '#/components/requestBody/librarySettings'
responses:
'200':
$ref: '#/components/responses/library200'