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: formatting

Browse source
This commit is contained in:
Nicholas Wallace 2024-05-14 04:51:59 +00:00
parent 44a98a0061
commit a60f7463a7
3 changed files with 7 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/controllers/LibraryController.yaml
View file

@ -66,9 +66,7 @@ components:
description: The ID of the library. description: The ID of the library.
required: true required: true
schema: schema:
type: string $ref: '../objects/Library.yaml#/components/schemas/libraryId'
format: uuid
example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b
responses: responses:
library200: library200:
description: Library found. description: Library found.
@ -104,6 +102,7 @@ paths:
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. description: Create a new library on server.
required: [name, folders]
tags: tags:
- Libraries - Libraries
requestBody: requestBody:
@ -114,7 +113,6 @@ paths:
$ref: '#/components/requestBody/libraryMediaType' $ref: '#/components/requestBody/libraryMediaType'
$ref: '#/components/requestBody/libraryProvider' $ref: '#/components/requestBody/libraryProvider'
$ref: '#/components/requestBody/librarySettings' $ref: '#/components/requestBody/librarySettings'
required: [name, folders]
responses: responses:
'200': '200':
$ref: '#/components/responses/library200' $ref: '#/components/responses/library200'

6
docs/objects/Library.yaml
View file

@ -4,12 +4,12 @@ components:
type: string type: string
description: The ID of the libraries created on server version 2.2.23 and before. description: The ID of the libraries created on server version 2.2.23 and before.
format: 'lib_[a-z0-9]{18}' format: 'lib_[a-z0-9]{18}'
example: lib_o78uaoeuh78h6aoeif example: 'lib_o78uaoeuh78h6aoeif'
libraryId: libraryId:
type: string type: string
description: The ID of the library. description: The ID of the library.
format: uuid format: uuid
example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b example: 'e4bb1afb-4a4f-4dd6-8be0-e615d233185b'
libraryName: libraryName:
description: The name of the library. description: The name of the library.
type: string type: string
@ -76,7 +76,7 @@ components:
description: The folders that belong to the library. description: The folders that belong to the library.
type: array type: array
items: items:
$ref: 'Folder.yaml#/components/schemas/folder' $ref: './Folder.yaml#/components/schemas/folder'
displayOrder: displayOrder:
description: Display position of the library in the list of libraries. Must be >= 1. description: Display position of the library in the list of libraries. Must be >= 1.
type: integer type: integer

4
docs/objects/LibraryItem.yaml
View file

@ -22,9 +22,9 @@ components:
ino: ino:
$ref: '../schemas.yaml#/components/schemas/inode' $ref: '../schemas.yaml#/components/schemas/inode'
libraryId: libraryId:
$ref: 'Library.yaml#/components/schemas/libraryId' $ref: './Library.yaml#/components/schemas/libraryId'
folderId: folderId:
$ref: 'Folder.yaml#/components/schemas/folderId' $ref: './Folder.yaml#/components/schemas/folderId'
path: path:
description: The path of the library item on the server. description: The path of the library item on the server.
type: string type: string