From 333fae41743d81de85422840112ddfa443a59a1a Mon Sep 17 00:00:00 2001 From: m-tabaza Date: Tue, 27 Aug 2024 19:09:36 +0300 Subject: [PATCH] Fix import actions doc --- .../endpoint/import-actions-from-swagger.mdx | 67 +------------------ 1 file changed, 1 insertion(+), 66 deletions(-) diff --git a/docs/api-reference/endpoint/import-actions-from-swagger.mdx b/docs/api-reference/endpoint/import-actions-from-swagger.mdx index 64eda6807..146264d64 100644 --- a/docs/api-reference/endpoint/import-actions-from-swagger.mdx +++ b/docs/api-reference/endpoint/import-actions-from-swagger.mdx @@ -1,68 +1,3 @@ --- -title: "Import actions" -api: "PUT https://api-v2.opencopilot.so/backend/actions/bot/:id/import-from-swagger" -description: "Import actions from a Swagger file to a copilot by ID" +openapi: put /actions --- - - -This endpoint points to the (v2) version of the API. The (v2) version of the API is the latest version and is recommended for all new development. Please update your code to use the (v2) version of the API. - - - -### OpenAPI Specification (Swagger) - -This endpoint supports the [OpenAPI V3 Specification (Swagger)](https://swagger.io/specification/). We have introduced some new fields to the OpenAPI specification that are custom to Open. These fields are: - -- **`x-open-execute-after`: `string[]`** - This field is useful when you want to execute other operation(s) before the current operation/action. it takes an array of operation IDs. The AI will execute the operations in the order they are listed in the array. - -**Example:** - -Suppose you have an action with the operation ID `deleteUserCourses`. Before performing this action, you want to force the AI to list all the courses the user has and then delete them. - -You can achieve this by adding `['listUserCourses']` to the `x-open-execute-after` field. The AI will first execute the `listUserCourses` operation and then proceed to execute the `deleteUserCourses` operation. - - -### Body - - - The uuid of the copilot - - -### Headers - - - application/json - - - - Bearer YOUR_TOKEN - - - -### Response - - - Indicates whether the call was successful. - - - - -```bash Example Request -curl --location --request PUT 'https://api-v2.opencopilot.so/backend/actions/bot/:id/import-from-swagger' \ ---header 'Accept: application/json' \ ---header 'Authorization : Bearer YOUR_TOKEN' \ ---form 'file=@"/Users/gharbat/Desktop/swagger.json"' -``` - - - - - -```json Response -{ - "message": "Successfully imported actions from swagger.json" -} -``` - -