From d2fa430725b00886dfd96e2ad7ff22373a613935 Mon Sep 17 00:00:00 2001 From: Henry Heng Date: Mon, 13 Jan 2025 15:17:15 +0000 Subject: [PATCH] Chore/swagger update (#3860) * update swagger spec * update api docs to include doc store file chunks * update swagger api * update swagger api --- .../api-documentation/src/yml/swagger.yml | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/packages/api-documentation/src/yml/swagger.yml b/packages/api-documentation/src/yml/swagger.yml index 36662d02..3b37cc52 100644 --- a/packages/api-documentation/src/yml/swagger.yml +++ b/packages/api-documentation/src/yml/swagger.yml @@ -62,12 +62,14 @@ paths: name: startDate schema: type: string + example: 2025-01-01T11:28:36.000Z format: date-time description: Filter by start date - in: query name: endDate schema: type: string + example: 2025-01-13T11:28:36.000Z format: date-time description: Filter by end date - in: query @@ -80,7 +82,7 @@ paths: schema: type: string enum: [THUMBS_UP, THUMBS_DOWN] - description: Filter by feedback type + description: Filter by feedback type. Only applicable if feedback is true responses: '200': description: A list of chat messages @@ -130,6 +132,29 @@ paths: type: string enum: [INTERNAL, EXTERNAL] description: Filter by chat type + - in: query + name: startDate + schema: + type: string + example: 2025-01-01T11:28:36.000Z + description: Filter by start date + - in: query + name: endDate + schema: + type: string + example: 2025-01-13T11:28:36.000Z + description: Filter by end date + - in: query + name: feedbackType + schema: + type: string + enum: [THUMBS_UP, THUMBS_DOWN] + description: Filter by feedback type + - in: query + name: hardDelete + schema: + type: boolean + description: If hardDelete is true, messages will be deleted from the third party service as well responses: '200': description: Chat messages deleted successfully