From ace8b852cb1a1e7cd3d4dd71f49e1d33440a0f5f Mon Sep 17 00:00:00 2001 From: Henry Heng Date: Tue, 27 Aug 2024 16:35:29 +0100 Subject: [PATCH] Chore/update swagger spec (#3096) update swagger spec --- .../api-documentation/src/yml/swagger.yml | 267 ------------------ 1 file changed, 267 deletions(-) diff --git a/packages/api-documentation/src/yml/swagger.yml b/packages/api-documentation/src/yml/swagger.yml index 9e347ad5c..66531111d 100644 --- a/packages/api-documentation/src/yml/swagger.yml +++ b/packages/api-documentation/src/yml/swagger.yml @@ -1,9 +1,7 @@ tags: - - name: apikey - name: assistants - name: chatmessage - name: chatflows - - name: credentials - name: document-store - name: feedback - name: leads @@ -15,131 +13,6 @@ tags: - name: vector paths: - /apikey: - post: - tags: - - apikey - security: - - bearerAuth: [] - operationId: createApiKey - summary: Add new api key - description: Add new api key - requestBody: - content: - application/json: - schema: - type: object - properties: - keyName: - type: string - example: 'someKeyName' - required: true - responses: - '200': - description: Api key created successfully - content: - application/json: - schema: - $ref: '#/components/schemas/ApiKey' - application/xml: - schema: - $ref: '#/components/schemas/ApiKey' - '400': - description: Invalid keyName provided - '404': - description: Api Key not found - '422': - description: Validation exception - get: - tags: - - apikey - security: - - bearerAuth: [] - summary: List all API keys - description: List all API keys - operationId: listApiKey - responses: - '200': - description: A list of API keys - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ApiKey' - application/xml: - schema: - type: array - items: - $ref: '#/components/schemas/ApiKey' - '500': - description: Internal error - /apikey/{id}: - put: - tags: - - apikey - security: - - bearerAuth: [] - summary: Update API key name - description: Update API key name - operationId: updateApiKey - parameters: - - in: path - name: id - required: true - schema: - type: string - description: Api Key ID - requestBody: - content: - application/json: - schema: - type: object - properties: - keyName: - type: string - example: 'someKeyName' - responses: - '200': - description: Api key updated successfully - content: - application/json: - schema: - $ref: '#/components/schemas/ApiKey' - application/xml: - schema: - $ref: '#/components/schemas/ApiKey' - '400': - description: The specified ID is invalid - '404': - description: Api Key with the specified ID was not found - '500': - description: Internal error - delete: - tags: - - apikey - security: - - bearerAuth: [] - summary: Delete API key - description: Delete API key - operationId: deleteApiKey - parameters: - - in: path - name: id - required: true - schema: - type: string - description: Api Key ID - responses: - '200': - description: Api key deleted successfully - '400': - description: The specified ID is invalid - '404': - description: Api Key with the specified ID was not found - '500': - description: Internal error - /chatmessage/{id}: get: tags: @@ -557,146 +430,6 @@ paths: description: Chatflow not found '500': description: Internal error - /credentials: - post: - tags: - - credentials - security: - - bearerAuth: [] - operationId: createCredential - summary: Add new credential - description: Add new credential - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Credential' - required: true - responses: - '200': - description: Successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/Credential' - '400': - description: Invalid request body - '422': - description: Validation exception - get: - tags: - - credentials - security: - - bearerAuth: [] - summary: List all credentials - description: List all credentials - operationId: listCredentials - parameters: - - in: query - name: credentialName - required: false - schema: - type: string - description: Filter credentials by name - responses: - '200': - description: Successful operation - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Credential' - '500': - description: Internal error - - /credentials/{id}: - get: - tags: - - credentials - security: - - bearerAuth: [] - summary: Get a credential by ID - description: Retrieve a specific credential by ID - operationId: getCredentialById - parameters: - - in: path - name: id - required: true - schema: - type: string - description: Credential ID - responses: - '200': - description: Successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/Credential' - '400': - description: The specified ID is invalid - '404': - description: Credential with the specified ID was not found - '500': - description: Internal error - put: - tags: - - credentials - security: - - bearerAuth: [] - summary: Update a credential by ID - description: Update a specific credential by ID - operationId: updateCredential - parameters: - - in: path - name: id - required: true - schema: - type: string - description: Credential ID - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Credential' - required: true - responses: - '200': - description: Successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/Credential' - '400': - description: The specified ID is invalid or request body is invalid - '404': - description: Credential with the specified ID was not found - '500': - description: Internal error - delete: - tags: - - credentials - security: - - bearerAuth: [] - summary: Delete a credential by ID - description: Delete a specific credential by ID - operationId: deleteCredential - parameters: - - in: path - name: id - required: true - schema: - type: string - description: Credential ID - responses: - '200': - description: Successful operation - '400': - description: The specified ID is invalid - '404': - description: Credential with the specified ID was not found - '500': - description: Internal error /document-store/store: post: