From e72452ffb3a4e2de33d2fdbe6b65272243c55392 Mon Sep 17 00:00:00 2001 From: Nicholas Kalar Date: Wed, 13 Aug 2025 15:12:25 -0400 Subject: [PATCH] Updated library doc --- src/main/resources/openapi/documentation.yaml | 22 +++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/src/main/resources/openapi/documentation.yaml b/src/main/resources/openapi/documentation.yaml index 81f04e7..0a9754f 100644 --- a/src/main/resources/openapi/documentation.yaml +++ b/src/main/resources/openapi/documentation.yaml @@ -81,17 +81,31 @@ paths: /libraries: get: - description: "" + description: "Search for libraries based on ID or get all libraries" parameters: - name: "id" in: "path" - required: true + required: false schema: type: string - example: id=27 + example: id=1 responses: "200": - description: "OK" + description: "Either a single library, or a list of all libraries." + "400": + description: "Bad Request. Likely, the ID you are looking for doesn't exist." + post: + description: "The method to add a new library." + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/NewLibrary" + responses: + "200": + description: "The ID of the newly created library will be returned." + "400": + description: "Bad Request. Unable to insert the new library." components: schemas: