From a60f7463a7d3ec7bd9b6184944d63fa022edf7ca Mon Sep 17 00:00:00 2001 From: Nicholas Wallace Date: Tue, 14 May 2024 04:51:59 +0000 Subject: [PATCH] Update: formatting --- docs/controllers/LibraryController.yaml | 6 ++---- docs/objects/Library.yaml | 6 +++--- docs/objects/LibraryItem.yaml | 4 ++-- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/controllers/LibraryController.yaml b/docs/controllers/LibraryController.yaml index 81cf4cad3..a46edad61 100644 --- a/docs/controllers/LibraryController.yaml +++ b/docs/controllers/LibraryController.yaml @@ -66,9 +66,7 @@ components: description: The ID of the library. required: true schema: - type: string - format: uuid - example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b + $ref: '../objects/Library.yaml#/components/schemas/libraryId' responses: library200: description: Library found. @@ -104,6 +102,7 @@ paths: operationId: createLibrary summary: Create a new library on server description: Create a new library on server. + required: [name, folders] tags: - Libraries requestBody: @@ -114,7 +113,6 @@ paths: $ref: '#/components/requestBody/libraryMediaType' $ref: '#/components/requestBody/libraryProvider' $ref: '#/components/requestBody/librarySettings' - required: [name, folders] responses: '200': $ref: '#/components/responses/library200' diff --git a/docs/objects/Library.yaml b/docs/objects/Library.yaml index f6c3f9831..9f8b3429b 100644 --- a/docs/objects/Library.yaml +++ b/docs/objects/Library.yaml @@ -4,12 +4,12 @@ components: type: string description: The ID of the libraries created on server version 2.2.23 and before. format: 'lib_[a-z0-9]{18}' - example: lib_o78uaoeuh78h6aoeif + example: 'lib_o78uaoeuh78h6aoeif' libraryId: type: string description: The ID of the library. format: uuid - example: e4bb1afb-4a4f-4dd6-8be0-e615d233185b + example: 'e4bb1afb-4a4f-4dd6-8be0-e615d233185b' libraryName: description: The name of the library. type: string @@ -76,7 +76,7 @@ components: description: The folders that belong to the library. type: array items: - $ref: 'Folder.yaml#/components/schemas/folder' + $ref: './Folder.yaml#/components/schemas/folder' displayOrder: description: Display position of the library in the list of libraries. Must be >= 1. type: integer diff --git a/docs/objects/LibraryItem.yaml b/docs/objects/LibraryItem.yaml index e63fa90e5..e72f8e14b 100644 --- a/docs/objects/LibraryItem.yaml +++ b/docs/objects/LibraryItem.yaml @@ -22,9 +22,9 @@ components: ino: $ref: '../schemas.yaml#/components/schemas/inode' libraryId: - $ref: 'Library.yaml#/components/schemas/libraryId' + $ref: './Library.yaml#/components/schemas/libraryId' folderId: - $ref: 'Folder.yaml#/components/schemas/folderId' + $ref: './Folder.yaml#/components/schemas/folderId' path: description: The path of the library item on the server. type: string