From cef0c8138eab2f335c4975d9f499a2fbaedc51c3 Mon Sep 17 00:00:00 2001 From: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com> Date: Mon, 24 Jun 2024 09:24:04 +1200 Subject: [PATCH] feat: update documentation --- src/docs/openapi.v2.yml | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/src/docs/openapi.v2.yml b/src/docs/openapi.v2.yml index 9148178..a599ab7 100644 --- a/src/docs/openapi.v2.yml +++ b/src/docs/openapi.v2.yml @@ -142,7 +142,7 @@ paths: - AppServiceID: [] responses: "200": - description: List of logs for the service + description: List of logs for the service. content: application/json: schema: @@ -204,7 +204,7 @@ paths: - AppServiceID: [] responses: "201": - description: Log created + description: Log created. content: application/json: schema: @@ -277,11 +277,26 @@ paths: description: |- Get the details for all the services. Only available to admins + parameters: + - schema: + type: number + minimum: 1 + default: 1 + in: query + name: page + required: false + - schema: + type: number + minimum: 1 + default: 50 + in: query + name: page_size + required: false security: - AppServiceID: [] responses: "200": - description: All services + description: All services. content: application/json: schema: @@ -330,7 +345,7 @@ paths: - AppServiceID: [] responses: "201": - description: Created service details + description: Created service details. content: application/json: schema: @@ -372,7 +387,7 @@ paths: - AppServiceID: [] responses: "200": - description: Service details + description: Service details. content: application/json: schema: