From 1c6120efedacec0960e288ecd1087df9175982a9 Mon Sep 17 00:00:00 2001 From: meni Date: Sun, 20 Sep 2026 04:13:51 +0300 Subject: [PATCH] fix(docs): align runtime Swagger with established format --- docs/runtime-routes.json | 8918 ++++++++++++++++++++++- scripts/audit-runtime-openapi.mjs | 34 +- scripts/generate-runtime-openapi.mjs | 7 +- scripts/runtime-openapi-conventions.mjs | 207 + src/api/routes/index.router.ts | 7 +- 5 files changed, 8959 insertions(+), 214 deletions(-) create mode 100644 scripts/runtime-openapi-conventions.mjs diff --git a/docs/runtime-routes.json b/docs/runtime-routes.json index 600b00629c..dc02dd3c57 100644 --- a/docs/runtime-routes.json +++ b/docs/runtime-routes.json @@ -2,1011 +2,9525 @@ { "method": "post", "path": "/archive/backfill/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Run backfill", + "description": "Run backfill for Archive.", + "operationId": "post_archive_backfill", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/calls/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get calls", + "description": "Get calls for Archive.", + "operationId": "get_archive_calls", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/chats/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get chats", + "description": "Get chats for Archive.", + "operationId": "get_archive_chats", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/contacts/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get contacts", + "description": "Get contacts for Archive.", + "operationId": "get_archive_contacts", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/events/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get events", + "description": "Get events for Archive.", + "operationId": "get_archive_events", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/groups/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get groups", + "description": "Get groups for Archive.", + "operationId": "get_archive_groups", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/media/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get media", + "description": "Get media for Archive.", + "operationId": "get_archive_media", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/memberships/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get memberships", + "description": "Get memberships for Archive.", + "operationId": "get_archive_memberships", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/messages/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get messages", + "description": "Get messages for Archive.", + "operationId": "get_archive_messages", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/messages/{instanceName}/{messageId}/revisions", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get messages", + "description": "Get messages for Archive.", + "operationId": "get_archive_messages_revisions", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + }, + { + "name": "messageId", + "in": "path", + "required": true, + "description": "Message Id path parameter.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/policies", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get policies", + "description": "Get policies for Archive.", + "operationId": "get_archive_policies", + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "put", "path": "/archive/policies", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Update policies", + "description": "Update policies for Archive.", + "operationId": "put_archive_policies", + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "post", "path": "/archive/purges/confirm", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Run purges", + "description": "Run purges for Archive.", + "operationId": "post_archive_purges_confirm", + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "post", "path": "/archive/purges/preview/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Run purges", + "description": "Run purges for Archive.", + "operationId": "post_archive_purges_preview", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/purges/tombstones/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get purges", + "description": "Get purges for Archive.", + "operationId": "get_archive_purges_tombstones", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/reactions/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get reactions", + "description": "Get reactions for Archive.", + "operationId": "get_archive_reactions", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/receipts/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get receipts", + "description": "Get receipts for Archive.", + "operationId": "get_archive_receipts", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/status", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get status", + "description": "Get status for Archive.", + "operationId": "get_archive_status", + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "get", "path": "/archive/sync-gaps/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Get sync gaps", + "description": "Get sync gaps for Archive.", + "operationId": "get_archive_sync_gaps", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "post", "path": "/archive/verify/{instanceName}", - "source": "src/api/routes/archive.router.ts" + "source": "src/api/routes/archive.router.ts", + "operation": { + "tags": [ + "Archive" + ], + "summary": "Run verify", + "description": "Run verify for Archive.", + "operationId": "post_archive_verify", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/archive.router.ts" + } }, { "method": "post", "path": "/business/getCatalog/{instanceName}", - "source": "src/api/routes/business.router.ts" + "source": "src/api/routes/business.router.ts", + "operation": { + "tags": [ + "Business & catalog" + ], + "summary": "Get get Catalog", + "description": "Get get Catalog for Business & catalog.", + "operationId": "post_business_getCatalog", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/business.router.ts" + } }, { "method": "post", "path": "/business/getCollections/{instanceName}", - "source": "src/api/routes/business.router.ts" + "source": "src/api/routes/business.router.ts", + "operation": { + "tags": [ + "Business & catalog" + ], + "summary": "Get get Collections", + "description": "Get get Collections for Business & catalog.", + "operationId": "post_business_getCollections", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/business.router.ts" + } }, { "method": "post", "path": "/call/offer/{instanceName}", - "source": "src/api/routes/call.router.ts" + "source": "src/api/routes/call.router.ts", + "operation": { + "tags": [ + "Calls" + ], + "summary": "Create offer", + "description": "Create offer for Calls.", + "operationId": "post_call_offer", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/call.router.ts" + } }, { "method": "post", "path": "/chat/archiveChat/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Update archive Chat", + "description": "Update archive Chat for Chats.", + "operationId": "post_chat_archiveChat", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "delete", "path": "/chat/deleteMessageForEveryone/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Delete delete Message For Everyone", + "description": "Delete delete Message For Everyone for Chats.", + "operationId": "delete_chat_deleteMessageForEveryone", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/fetchBusinessProfile/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get fetch Business Profile", + "description": "Get fetch Business Profile for Chats.", + "operationId": "post_chat_fetchBusinessProfile", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "get", "path": "/chat/fetchPrivacySettings/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get fetch Privacy Settings", + "description": "Get fetch Privacy Settings for Chats.", + "operationId": "get_chat_fetchPrivacySettings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/fetchProfile/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get fetch Profile", + "description": "Get fetch Profile for Chats.", + "operationId": "post_chat_fetchProfile", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/fetchProfilePictureUrl/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get fetch Profile Picture Url", + "description": "Get fetch Profile Picture Url for Chats.", + "operationId": "post_chat_fetchProfilePictureUrl", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "get", "path": "/chat/findChatByRemoteJid/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get find Chat By Remote Jid", + "description": "Get find Chat By Remote Jid for Chats.", + "operationId": "get_chat_findChatByRemoteJid", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/findChats/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get find Chats", + "description": "Get find Chats for Chats.", + "operationId": "post_chat_findChats", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/findContacts/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get find Contacts", + "description": "Get find Contacts for Chats.", + "operationId": "post_chat_findContacts", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/findMessages/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get find Messages", + "description": "Get find Messages for Chats.", + "operationId": "post_chat_findMessages", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/findStatusMessage/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get find Status Message", + "description": "Get find Status Message for Chats.", + "operationId": "post_chat_findStatusMessage", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/getBase64FromMediaMessage/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Get get Base64 From Media Message", + "description": "Get get Base64 From Media Message for Chats.", + "operationId": "post_chat_getBase64FromMediaMessage", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/markChatUnread/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Update mark Chat Unread", + "description": "Update mark Chat Unread for Chats.", + "operationId": "post_chat_markChatUnread", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/markMessageAsRead/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Update mark Message As Read", + "description": "Update mark Message As Read for Chats.", + "operationId": "post_chat_markMessageAsRead", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "delete", "path": "/chat/removeProfilePicture/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Delete remove Profile Picture", + "description": "Delete remove Profile Picture for Chats.", + "operationId": "delete_chat_removeProfilePicture", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/sendPresence/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Create send Presence", + "description": "Create send Presence for Chats.", + "operationId": "post_chat_sendPresence", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/updateBlockStatus/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Update update Block Status", + "description": "Update update Block Status for Chats.", + "operationId": "post_chat_updateBlockStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/updateMessage/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Update update Message", + "description": "Update update Message for Chats.", + "operationId": "post_chat_updateMessage", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/updatePrivacySettings/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Update update Privacy Settings", + "description": "Update update Privacy Settings for Chats.", + "operationId": "post_chat_updatePrivacySettings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/updateProfileName/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Update update Profile Name", + "description": "Update update Profile Name for Chats.", + "operationId": "post_chat_updateProfileName", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/updateProfilePicture/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Update update Profile Picture", + "description": "Update update Profile Picture for Chats.", + "operationId": "post_chat_updateProfilePicture", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/updateProfileStatus/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Update update Profile Status", + "description": "Update update Profile Status for Chats.", + "operationId": "post_chat_updateProfileStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "post", "path": "/chat/whatsappNumbers/{instanceName}", - "source": "src/api/routes/chat.router.ts" + "source": "src/api/routes/chat.router.ts", + "operation": { + "tags": [ + "Chats" + ], + "summary": "Run whatsapp Numbers", + "description": "Run whatsapp Numbers for Chats.", + "operationId": "post_chat_whatsappNumbers", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/chat.router.ts" + } }, { "method": "get", "path": "/chatwoot/find/{instanceName}", - "source": "src/api/integrations/chatbot/chatwoot/routes/chatwoot.router.ts" + "source": "src/api/integrations/chatbot/chatwoot/routes/chatwoot.router.ts", + "operation": { + "tags": [ + "Chatwoot" + ], + "summary": "Get find", + "description": "Get find for Chatwoot.", + "operationId": "get_chatwoot_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/chatwoot/routes/chatwoot.router.ts" + } }, { "method": "post", "path": "/chatwoot/set/{instanceName}", - "source": "src/api/integrations/chatbot/chatwoot/routes/chatwoot.router.ts" + "source": "src/api/integrations/chatbot/chatwoot/routes/chatwoot.router.ts", + "operation": { + "tags": [ + "Chatwoot" + ], + "summary": "Update set", + "description": "Update set for Chatwoot.", + "operationId": "post_chatwoot_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/chatwoot/routes/chatwoot.router.ts" + } }, { "method": "post", "path": "/chatwoot/webhook/{instanceName}", - "source": "src/api/integrations/chatbot/chatwoot/routes/chatwoot.router.ts" + "source": "src/api/integrations/chatbot/chatwoot/routes/chatwoot.router.ts", + "operation": { + "tags": [ + "Chatwoot" + ], + "summary": "Run webhook", + "description": "Run webhook for Chatwoot.", + "operationId": "post_chatwoot_webhook", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/chatwoot/routes/chatwoot.router.ts" + } }, { "method": "post", "path": "/dify/changeStatus/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Update change Status", + "description": "Update change Status for Dify.", + "operationId": "post_dify_changeStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "post", "path": "/dify/create/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Create create", + "description": "Create create for Dify.", + "operationId": "post_dify_create", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "delete", "path": "/dify/delete/{difyId}/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Delete delete", + "description": "Delete delete for Dify.", + "operationId": "delete_dify_delete", + "parameters": [ + { + "name": "difyId", + "in": "path", + "required": true, + "description": "Dify Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "get", "path": "/dify/fetch/{difyId}/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Get fetch", + "description": "Get fetch for Dify.", + "operationId": "get_dify_fetch", + "parameters": [ + { + "name": "difyId", + "in": "path", + "required": true, + "description": "Dify Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "get", "path": "/dify/fetchSessions/{difyId}/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Get fetch Sessions", + "description": "Get fetch Sessions for Dify.", + "operationId": "get_dify_fetchSessions", + "parameters": [ + { + "name": "difyId", + "in": "path", + "required": true, + "description": "Dify Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "get", "path": "/dify/fetchSettings/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Get fetch Settings", + "description": "Get fetch Settings for Dify.", + "operationId": "get_dify_fetchSettings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "get", "path": "/dify/find/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Get find", + "description": "Get find for Dify.", + "operationId": "get_dify_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "post", "path": "/dify/ignoreJid/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Update ignore Jid", + "description": "Update ignore Jid for Dify.", + "operationId": "post_dify_ignoreJid", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "post", "path": "/dify/settings/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Update settings", + "description": "Update settings for Dify.", + "operationId": "post_dify_settings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "put", "path": "/dify/update/{difyId}/{instanceName}", - "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + "source": "src/api/integrations/chatbot/dify/routes/dify.router.ts", + "operation": { + "tags": [ + "Dify" + ], + "summary": "Update update", + "description": "Update update for Dify.", + "operationId": "put_dify_update", + "parameters": [ + { + "name": "difyId", + "in": "path", + "required": true, + "description": "Dify Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/dify/routes/dify.router.ts" + } }, { "method": "post", "path": "/evoai/changeStatus/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Update change Status", + "description": "Update change Status for EvoAI.", + "operationId": "post_evoai_changeStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "post", "path": "/evoai/create/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Create create", + "description": "Create create for EvoAI.", + "operationId": "post_evoai_create", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "delete", "path": "/evoai/delete/{evoaiId}/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Delete delete", + "description": "Delete delete for EvoAI.", + "operationId": "delete_evoai_delete", + "parameters": [ + { + "name": "evoaiId", + "in": "path", + "required": true, + "description": "Evoai Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "get", "path": "/evoai/fetch/{evoaiId}/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Get fetch", + "description": "Get fetch for EvoAI.", + "operationId": "get_evoai_fetch", + "parameters": [ + { + "name": "evoaiId", + "in": "path", + "required": true, + "description": "Evoai Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "get", "path": "/evoai/fetchSessions/{evoaiId}/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Get fetch Sessions", + "description": "Get fetch Sessions for EvoAI.", + "operationId": "get_evoai_fetchSessions", + "parameters": [ + { + "name": "evoaiId", + "in": "path", + "required": true, + "description": "Evoai Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "get", "path": "/evoai/fetchSettings/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Get fetch Settings", + "description": "Get fetch Settings for EvoAI.", + "operationId": "get_evoai_fetchSettings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "get", "path": "/evoai/find/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Get find", + "description": "Get find for EvoAI.", + "operationId": "get_evoai_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "post", "path": "/evoai/ignoreJid/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Update ignore Jid", + "description": "Update ignore Jid for EvoAI.", + "operationId": "post_evoai_ignoreJid", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "post", "path": "/evoai/settings/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Update settings", + "description": "Update settings for EvoAI.", + "operationId": "post_evoai_settings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "put", "path": "/evoai/update/{evoaiId}/{instanceName}", - "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + "source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts", + "operation": { + "tags": [ + "EvoAI" + ], + "summary": "Update update", + "description": "Update update for EvoAI.", + "operationId": "put_evoai_update", + "parameters": [ + { + "name": "evoaiId", + "in": "path", + "required": true, + "description": "Evoai Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evoai/routes/evoai.router.ts" + } }, { "method": "post", "path": "/evolutionBot/changeStatus/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Update change Status", + "description": "Update change Status for Evolution Bot.", + "operationId": "post_evolutionBot_changeStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "post", "path": "/evolutionBot/create/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Create create", + "description": "Create create for Evolution Bot.", + "operationId": "post_evolutionBot_create", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "delete", "path": "/evolutionBot/delete/{evolutionBotId}/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Delete delete", + "description": "Delete delete for Evolution Bot.", + "operationId": "delete_evolutionBot_delete", + "parameters": [ + { + "name": "evolutionBotId", + "in": "path", + "required": true, + "description": "Evolution Bot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "get", "path": "/evolutionBot/fetch/{evolutionBotId}/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Get fetch", + "description": "Get fetch for Evolution Bot.", + "operationId": "get_evolutionBot_fetch", + "parameters": [ + { + "name": "evolutionBotId", + "in": "path", + "required": true, + "description": "Evolution Bot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "get", "path": "/evolutionBot/fetchSessions/{evolutionBotId}/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Get fetch Sessions", + "description": "Get fetch Sessions for Evolution Bot.", + "operationId": "get_evolutionBot_fetchSessions", + "parameters": [ + { + "name": "evolutionBotId", + "in": "path", + "required": true, + "description": "Evolution Bot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "get", "path": "/evolutionBot/fetchSettings/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Get fetch Settings", + "description": "Get fetch Settings for Evolution Bot.", + "operationId": "get_evolutionBot_fetchSettings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "get", "path": "/evolutionBot/find/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Get find", + "description": "Get find for Evolution Bot.", + "operationId": "get_evolutionBot_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "post", "path": "/evolutionBot/ignoreJid/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Update ignore Jid", + "description": "Update ignore Jid for Evolution Bot.", + "operationId": "post_evolutionBot_ignoreJid", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "post", "path": "/evolutionBot/settings/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Update settings", + "description": "Update settings for Evolution Bot.", + "operationId": "post_evolutionBot_settings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "put", "path": "/evolutionBot/update/{evolutionBotId}/{instanceName}", - "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + "source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts", + "operation": { + "tags": [ + "Evolution Bot" + ], + "summary": "Update update", + "description": "Update update for Evolution Bot.", + "operationId": "put_evolutionBot_update", + "parameters": [ + { + "name": "evolutionBotId", + "in": "path", + "required": true, + "description": "Evolution Bot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/evolutionBot/routes/evolutionBot.router.ts" + } }, { "method": "post", "path": "/flowise/changeStatus/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Update change Status", + "description": "Update change Status for Flowise.", + "operationId": "post_flowise_changeStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "post", "path": "/flowise/create/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Create create", + "description": "Create create for Flowise.", + "operationId": "post_flowise_create", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "delete", "path": "/flowise/delete/{flowiseId}/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Delete delete", + "description": "Delete delete for Flowise.", + "operationId": "delete_flowise_delete", + "parameters": [ + { + "name": "flowiseId", + "in": "path", + "required": true, + "description": "Flowise Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "get", "path": "/flowise/fetch/{flowiseId}/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Get fetch", + "description": "Get fetch for Flowise.", + "operationId": "get_flowise_fetch", + "parameters": [ + { + "name": "flowiseId", + "in": "path", + "required": true, + "description": "Flowise Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "get", "path": "/flowise/fetchSessions/{flowiseId}/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Get fetch Sessions", + "description": "Get fetch Sessions for Flowise.", + "operationId": "get_flowise_fetchSessions", + "parameters": [ + { + "name": "flowiseId", + "in": "path", + "required": true, + "description": "Flowise Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "get", "path": "/flowise/fetchSettings/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Get fetch Settings", + "description": "Get fetch Settings for Flowise.", + "operationId": "get_flowise_fetchSettings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "get", "path": "/flowise/find/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Get find", + "description": "Get find for Flowise.", + "operationId": "get_flowise_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "post", "path": "/flowise/ignoreJid/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Update ignore Jid", + "description": "Update ignore Jid for Flowise.", + "operationId": "post_flowise_ignoreJid", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "post", "path": "/flowise/settings/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Update settings", + "description": "Update settings for Flowise.", + "operationId": "post_flowise_settings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "put", "path": "/flowise/update/{flowiseId}/{instanceName}", - "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + "source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts", + "operation": { + "tags": [ + "Flowise" + ], + "summary": "Update update", + "description": "Update update for Flowise.", + "operationId": "put_flowise_update", + "parameters": [ + { + "name": "flowiseId", + "in": "path", + "required": true, + "description": "Flowise Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/flowise/routes/flowise.router.ts" + } }, { "method": "get", "path": "/group/acceptInviteCode/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Update accept Invite Code", + "description": "Update accept Invite Code for Groups.", + "operationId": "get_group_acceptInviteCode", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "post", "path": "/group/create/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Create create", + "description": "Create create for Groups.", + "operationId": "post_group_create", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "get", "path": "/group/fetchAllGroups/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Get fetch All Groups", + "description": "Get fetch All Groups for Groups.", + "operationId": "get_group_fetchAllGroups", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "get", "path": "/group/findGroupInfos/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Get find Group Infos", + "description": "Get find Group Infos for Groups.", + "operationId": "get_group_findGroupInfos", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "get", "path": "/group/inviteCode/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Get invite Code", + "description": "Get invite Code for Groups.", + "operationId": "get_group_inviteCode", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "get", "path": "/group/inviteInfo/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Get invite Info", + "description": "Get invite Info for Groups.", + "operationId": "get_group_inviteInfo", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "delete", "path": "/group/leaveGroup/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Delete leave Group", + "description": "Delete leave Group for Groups.", + "operationId": "delete_group_leaveGroup", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "get", "path": "/group/participants/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Get participants", + "description": "Get participants for Groups.", + "operationId": "get_group_participants", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "post", "path": "/group/revokeInviteCode/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Delete revoke Invite Code", + "description": "Delete revoke Invite Code for Groups.", + "operationId": "post_group_revokeInviteCode", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "post", "path": "/group/sendInvite/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Create send Invite", + "description": "Create send Invite for Groups.", + "operationId": "post_group_sendInvite", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "post", "path": "/group/toggleEphemeral/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Update toggle Ephemeral", + "description": "Update toggle Ephemeral for Groups.", + "operationId": "post_group_toggleEphemeral", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "post", "path": "/group/updateGroupDescription/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Update update Group Description", + "description": "Update update Group Description for Groups.", + "operationId": "post_group_updateGroupDescription", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "post", "path": "/group/updateGroupPicture/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Update update Group Picture", + "description": "Update update Group Picture for Groups.", + "operationId": "post_group_updateGroupPicture", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "post", "path": "/group/updateGroupSubject/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Update update Group Subject", + "description": "Update update Group Subject for Groups.", + "operationId": "post_group_updateGroupSubject", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "post", "path": "/group/updateParticipant/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Update update Participant", + "description": "Update update Participant for Groups.", + "operationId": "post_group_updateParticipant", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "post", "path": "/group/updateSetting/{instanceName}", - "source": "src/api/routes/group.router.ts" + "source": "src/api/routes/group.router.ts", + "operation": { + "tags": [ + "Groups" + ], + "summary": "Update update Setting", + "description": "Update update Setting for Groups.", + "operationId": "post_group_updateSetting", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/group.router.ts" + } }, { "method": "get", "path": "/instance/connect/{instanceName}", - "source": "src/api/routes/instance.router.ts" + "source": "src/api/routes/instance.router.ts", + "operation": { + "tags": [ + "Instances" + ], + "summary": "Update connect", + "description": "Update connect for Instances.", + "operationId": "get_instance_connect", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/instance.router.ts" + } }, { "method": "get", "path": "/instance/connectionState/{instanceName}", - "source": "src/api/routes/instance.router.ts" + "source": "src/api/routes/instance.router.ts", + "operation": { + "tags": [ + "Instances" + ], + "summary": "Get connection State", + "description": "Get connection State for Instances.", + "operationId": "get_instance_connectionState", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/instance.router.ts" + } }, { "method": "post", "path": "/instance/create", - "source": "src/api/routes/instance.router.ts" + "source": "src/api/routes/instance.router.ts", + "operation": { + "tags": [ + "Instances" + ], + "summary": "Create create", + "description": "Create create for Instances.", + "operationId": "post_instance_create", + "parameters": [], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/instance.router.ts" + } }, { "method": "delete", "path": "/instance/delete/{instanceName}", - "source": "src/api/routes/instance.router.ts" + "source": "src/api/routes/instance.router.ts", + "operation": { + "tags": [ + "Instances" + ], + "summary": "Delete delete", + "description": "Delete delete for Instances.", + "operationId": "delete_instance_delete", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/instance.router.ts" + } }, { "method": "get", "path": "/instance/fetchInstances", - "source": "src/api/routes/instance.router.ts" + "source": "src/api/routes/instance.router.ts", + "operation": { + "tags": [ + "Instances" + ], + "summary": "Get fetch Instances", + "description": "Get fetch Instances for Instances.", + "operationId": "get_instance_fetchInstances", + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/instance.router.ts" + } }, { "method": "delete", "path": "/instance/logout/{instanceName}", - "source": "src/api/routes/instance.router.ts" + "source": "src/api/routes/instance.router.ts", + "operation": { + "tags": [ + "Instances" + ], + "summary": "Delete logout", + "description": "Delete logout for Instances.", + "operationId": "delete_instance_logout", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/instance.router.ts" + } }, { "method": "post", "path": "/instance/restart/{instanceName}", - "source": "src/api/routes/instance.router.ts" + "source": "src/api/routes/instance.router.ts", + "operation": { + "tags": [ + "Instances" + ], + "summary": "Update restart", + "description": "Update restart for Instances.", + "operationId": "post_instance_restart", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/instance.router.ts" + } }, { "method": "post", "path": "/instance/setPresence/{instanceName}", - "source": "src/api/routes/instance.router.ts" + "source": "src/api/routes/instance.router.ts", + "operation": { + "tags": [ + "Instances" + ], + "summary": "Update set Presence", + "description": "Update set Presence for Instances.", + "operationId": "post_instance_setPresence", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/instance.router.ts" + } }, { "method": "get", "path": "/instanceapikey", - "source": "src/api/routes/instance.router.ts" + "source": "src/api/routes/instance.router.ts", + "operation": { + "tags": [ + "Instance API key" + ], + "summary": "Get instanceapikey", + "description": "Get instanceapikey for Instance API key.", + "operationId": "get_instanceapikey", + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/instance.router.ts" + } }, { "method": "get", "path": "/kafka/find/{instanceName}", - "source": "src/api/integrations/event/kafka/kafka.router.ts" + "source": "src/api/integrations/event/kafka/kafka.router.ts", + "operation": { + "tags": [ + "Kafka" + ], + "summary": "Get find", + "description": "Get find for Kafka.", + "operationId": "get_kafka_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/event/kafka/kafka.router.ts" + } }, { "method": "post", "path": "/kafka/set/{instanceName}", - "source": "src/api/integrations/event/kafka/kafka.router.ts" + "source": "src/api/integrations/event/kafka/kafka.router.ts", + "operation": { + "tags": [ + "Kafka" + ], + "summary": "Update set", + "description": "Update set for Kafka.", + "operationId": "post_kafka_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/event/kafka/kafka.router.ts" + } }, { "method": "get", "path": "/label/findLabels/{instanceName}", - "source": "src/api/routes/label.router.ts" + "source": "src/api/routes/label.router.ts", + "operation": { + "tags": [ + "Labels" + ], + "summary": "Get find Labels", + "description": "Get find Labels for Labels.", + "operationId": "get_label_findLabels", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/label.router.ts" + } }, { "method": "post", "path": "/label/handleLabel/{instanceName}", - "source": "src/api/routes/label.router.ts" + "source": "src/api/routes/label.router.ts", + "operation": { + "tags": [ + "Labels" + ], + "summary": "Update handle Label", + "description": "Update handle Label for Labels.", + "operationId": "post_label_handleLabel", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/label.router.ts" + } }, { "method": "post", "path": "/message/sendButtons/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Buttons", + "description": "Create send Buttons for Messages.", + "operationId": "post_message_sendButtons", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendContact/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Contact", + "description": "Create send Contact for Messages.", + "operationId": "post_message_sendContact", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendList/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send List", + "description": "Create send List for Messages.", + "operationId": "post_message_sendList", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendLocation/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Location", + "description": "Create send Location for Messages.", + "operationId": "post_message_sendLocation", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendMedia/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Media", + "description": "Create send Media for Messages.", + "operationId": "post_message_sendMedia", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendPoll/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Poll", + "description": "Create send Poll for Messages.", + "operationId": "post_message_sendPoll", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendPtv/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Ptv", + "description": "Create send Ptv for Messages.", + "operationId": "post_message_sendPtv", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendReaction/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Reaction", + "description": "Create send Reaction for Messages.", + "operationId": "post_message_sendReaction", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendStatus/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Status", + "description": "Create send Status for Messages.", + "operationId": "post_message_sendStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendSticker/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Sticker", + "description": "Create send Sticker for Messages.", + "operationId": "post_message_sendSticker", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendTemplate/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Template", + "description": "Create send Template for Messages.", + "operationId": "post_message_sendTemplate", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendText/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Text", + "description": "Create send Text for Messages.", + "operationId": "post_message_sendText", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/message/sendWhatsAppAudio/{instanceName}", - "source": "src/api/routes/sendMessage.router.ts" + "source": "src/api/routes/sendMessage.router.ts", + "operation": { + "tags": [ + "Messages" + ], + "summary": "Create send Whats App Audio", + "description": "Create send Whats App Audio for Messages.", + "operationId": "post_message_sendWhatsAppAudio", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/sendMessage.router.ts" + } }, { "method": "post", "path": "/n8n/changeStatus/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Update change Status", + "description": "Update change Status for n8n.", + "operationId": "post_n8n_changeStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "post", "path": "/n8n/create/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Create create", + "description": "Create create for n8n.", + "operationId": "post_n8n_create", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "delete", "path": "/n8n/delete/{n8nId}/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Delete delete", + "description": "Delete delete for n8n.", + "operationId": "delete_n8n_delete", + "parameters": [ + { + "name": "n8nId", + "in": "path", + "required": true, + "description": "N8n Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "get", "path": "/n8n/fetch/{n8nId}/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Get fetch", + "description": "Get fetch for n8n.", + "operationId": "get_n8n_fetch", + "parameters": [ + { + "name": "n8nId", + "in": "path", + "required": true, + "description": "N8n Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "get", "path": "/n8n/fetchSessions/{n8nId}/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Get fetch Sessions", + "description": "Get fetch Sessions for n8n.", + "operationId": "get_n8n_fetchSessions", + "parameters": [ + { + "name": "n8nId", + "in": "path", + "required": true, + "description": "N8n Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "get", "path": "/n8n/fetchSettings/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Get fetch Settings", + "description": "Get fetch Settings for n8n.", + "operationId": "get_n8n_fetchSettings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "get", "path": "/n8n/find/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Get find", + "description": "Get find for n8n.", + "operationId": "get_n8n_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "post", "path": "/n8n/ignoreJid/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Update ignore Jid", + "description": "Update ignore Jid for n8n.", + "operationId": "post_n8n_ignoreJid", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "post", "path": "/n8n/settings/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Update settings", + "description": "Update settings for n8n.", + "operationId": "post_n8n_settings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "put", "path": "/n8n/update/{n8nId}/{instanceName}", - "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + "source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts", + "operation": { + "tags": [ + "n8n" + ], + "summary": "Update update", + "description": "Update update for n8n.", + "operationId": "put_n8n_update", + "parameters": [ + { + "name": "n8nId", + "in": "path", + "required": true, + "description": "N8n Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/n8n/routes/n8n.router.ts" + } }, { "method": "get", "path": "/nats/find/{instanceName}", - "source": "src/api/integrations/event/nats/nats.router.ts" + "source": "src/api/integrations/event/nats/nats.router.ts", + "operation": { + "tags": [ + "NATS" + ], + "summary": "Get find", + "description": "Get find for NATS.", + "operationId": "get_nats_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/event/nats/nats.router.ts" + } }, { "method": "post", "path": "/nats/set/{instanceName}", - "source": "src/api/integrations/event/nats/nats.router.ts" + "source": "src/api/integrations/event/nats/nats.router.ts", + "operation": { + "tags": [ + "NATS" + ], + "summary": "Update set", + "description": "Update set for NATS.", + "operationId": "post_nats_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/event/nats/nats.router.ts" + } }, { "method": "post", "path": "/openai/changeStatus/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Update change Status", + "description": "Update change Status for OpenAI.", + "operationId": "post_openai_changeStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "post", "path": "/openai/create/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Create create", + "description": "Create create for OpenAI.", + "operationId": "post_openai_create", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "get", "path": "/openai/creds/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Get creds", + "description": "Get creds for OpenAI.", + "operationId": "get_openai_creds", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "post", "path": "/openai/creds/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Run creds", + "description": "Run creds for OpenAI.", + "operationId": "post_openai_creds", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "delete", "path": "/openai/creds/{openaiCredsId}/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Delete creds", + "description": "Delete creds for OpenAI.", + "operationId": "delete_openai_creds", + "parameters": [ + { + "name": "openaiCredsId", + "in": "path", + "required": true, + "description": "Openai Creds Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "delete", "path": "/openai/delete/{openaiBotId}/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Delete delete", + "description": "Delete delete for OpenAI.", + "operationId": "delete_openai_delete", + "parameters": [ + { + "name": "openaiBotId", + "in": "path", + "required": true, + "description": "Openai Bot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "get", "path": "/openai/fetch/{openaiBotId}/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Get fetch", + "description": "Get fetch for OpenAI.", + "operationId": "get_openai_fetch", + "parameters": [ + { + "name": "openaiBotId", + "in": "path", + "required": true, + "description": "Openai Bot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "get", "path": "/openai/fetchSessions/{openaiBotId}/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Get fetch Sessions", + "description": "Get fetch Sessions for OpenAI.", + "operationId": "get_openai_fetchSessions", + "parameters": [ + { + "name": "openaiBotId", + "in": "path", + "required": true, + "description": "Openai Bot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "get", "path": "/openai/fetchSettings/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Get fetch Settings", + "description": "Get fetch Settings for OpenAI.", + "operationId": "get_openai_fetchSettings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "get", "path": "/openai/find/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Get find", + "description": "Get find for OpenAI.", + "operationId": "get_openai_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "get", "path": "/openai/getModels/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Get get Models", + "description": "Get get Models for OpenAI.", + "operationId": "get_openai_getModels", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "post", "path": "/openai/ignoreJid/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Update ignore Jid", + "description": "Update ignore Jid for OpenAI.", + "operationId": "post_openai_ignoreJid", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "post", "path": "/openai/settings/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Update settings", + "description": "Update settings for OpenAI.", + "operationId": "post_openai_settings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "put", "path": "/openai/update/{openaiBotId}/{instanceName}", - "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + "source": "src/api/integrations/chatbot/openai/routes/openai.router.ts", + "operation": { + "tags": [ + "OpenAI" + ], + "summary": "Update update", + "description": "Update update for OpenAI.", + "operationId": "put_openai_update", + "parameters": [ + { + "name": "openaiBotId", + "in": "path", + "required": true, + "description": "Openai Bot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/openai/routes/openai.router.ts" + } }, { "method": "get", "path": "/proxy/find/{instanceName}", - "source": "src/api/routes/proxy.router.ts" + "source": "src/api/routes/proxy.router.ts", + "operation": { + "tags": [ + "Proxy" + ], + "summary": "Get find", + "description": "Get find for Proxy.", + "operationId": "get_proxy_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/proxy.router.ts" + } }, { "method": "post", "path": "/proxy/set/{instanceName}", - "source": "src/api/routes/proxy.router.ts" + "source": "src/api/routes/proxy.router.ts", + "operation": { + "tags": [ + "Proxy" + ], + "summary": "Update set", + "description": "Update set for Proxy.", + "operationId": "post_proxy_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/proxy.router.ts" + } }, { "method": "get", "path": "/pusher/find/{instanceName}", - "source": "src/api/integrations/event/pusher/pusher.router.ts" + "source": "src/api/integrations/event/pusher/pusher.router.ts", + "operation": { + "tags": [ + "Pusher" + ], + "summary": "Get find", + "description": "Get find for Pusher.", + "operationId": "get_pusher_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/event/pusher/pusher.router.ts" + } }, { "method": "post", "path": "/pusher/set/{instanceName}", - "source": "src/api/integrations/event/pusher/pusher.router.ts" + "source": "src/api/integrations/event/pusher/pusher.router.ts", + "operation": { + "tags": [ + "Pusher" + ], + "summary": "Update set", + "description": "Update set for Pusher.", + "operationId": "post_pusher_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/event/pusher/pusher.router.ts" + } }, { "method": "get", "path": "/rabbitmq/find/{instanceName}", - "source": "src/api/integrations/event/rabbitmq/rabbitmq.router.ts" + "source": "src/api/integrations/event/rabbitmq/rabbitmq.router.ts", + "operation": { + "tags": [ + "RabbitMQ" + ], + "summary": "Get find", + "description": "Get find for RabbitMQ.", + "operationId": "get_rabbitmq_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/event/rabbitmq/rabbitmq.router.ts" + } }, { "method": "post", "path": "/rabbitmq/set/{instanceName}", - "source": "src/api/integrations/event/rabbitmq/rabbitmq.router.ts" + "source": "src/api/integrations/event/rabbitmq/rabbitmq.router.ts", + "operation": { + "tags": [ + "RabbitMQ" + ], + "summary": "Update set", + "description": "Update set for RabbitMQ.", + "operationId": "post_rabbitmq_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/event/rabbitmq/rabbitmq.router.ts" + } }, { "method": "post", "path": "/s3/getMedia/{instanceName}", - "source": "src/api/integrations/storage/s3/routes/s3.router.ts" + "source": "src/api/integrations/storage/s3/routes/s3.router.ts", + "operation": { + "tags": [ + "S3" + ], + "summary": "Get get Media", + "description": "Get get Media for S3.", + "operationId": "post_s3_getMedia", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/storage/s3/routes/s3.router.ts" + } }, { "method": "post", "path": "/s3/getMediaUrl/{instanceName}", - "source": "src/api/integrations/storage/s3/routes/s3.router.ts" + "source": "src/api/integrations/storage/s3/routes/s3.router.ts", + "operation": { + "tags": [ + "S3" + ], + "summary": "Get get Media Url", + "description": "Get get Media Url for S3.", + "operationId": "post_s3_getMediaUrl", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/storage/s3/routes/s3.router.ts" + } }, { "method": "post", "path": "/settings-template/assign/{instanceName}", - "source": "src/api/routes/settingsTemplate.router.ts" + "source": "src/api/routes/settingsTemplate.router.ts", + "operation": { + "tags": [ + "Settings templates" + ], + "summary": "Assign a settings template", + "description": "Run assign. Template edits propagate to every binding without copying settings.", + "operationId": "post_settings_template_assign", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Settings template operation completed." + }, + "400": { + "description": "Invalid template, scope, or target." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or settings template not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "required": [ + "templateId", + "scope" + ], + "properties": { + "templateId": { + "type": "string", + "minLength": 1 + }, + "scope": { + "type": "string", + "enum": [ + "instance", + "group", + "contact" + ] + }, + "target": { + "type": "string", + "minLength": 3, + "maxLength": 255, + "description": "Omit for instance scope. Group targets end in @g.us; contact targets are full non-group WhatsApp identifiers." + } + } + } + } + } + }, + "x-source": "src/api/routes/settingsTemplate.router.ts" + } }, { "method": "get", "path": "/settings-template/bindings/{instanceName}", - "source": "src/api/routes/settingsTemplate.router.ts" + "source": "src/api/routes/settingsTemplate.router.ts", + "operation": { + "tags": [ + "Settings templates" + ], + "summary": "List template bindings", + "description": "List the instance default and exact group/contact bindings.", + "operationId": "get_settings_template_bindings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Template binding list." + }, + "400": { + "description": "Invalid template, scope, or target." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or settings template not found." + } + }, + "x-source": "src/api/routes/settingsTemplate.router.ts" + } }, { "method": "post", "path": "/settings-template/create", - "source": "src/api/routes/settingsTemplate.router.ts" + "source": "src/api/routes/settingsTemplate.router.ts", + "operation": { + "tags": [ + "Settings templates" + ], + "summary": "Create a settings template", + "description": "Create create. Template edits propagate to every binding without copying settings.", + "operationId": "post_settings_template_create", + "parameters": [], + "responses": { + "201": { + "description": "Settings template created." + }, + "400": { + "description": "Invalid template, scope, or target." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or settings template not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "required": [ + "name", + "settings" + ], + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "settings": { + "type": "object", + "additionalProperties": false, + "properties": { + "localReadTtlSeconds": { + "type": [ + "integer", + "null" + ], + "minimum": 0, + "maximum": 2592000 + }, + "localReadTtlOverrides": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "integer", + "minimum": 0, + "maximum": 2592000 + } + }, + "automationSafety": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + } + } + } + } + }, + "example": { + "name": "Careful outreach", + "settings": { + "localReadTtlSeconds": 120, + "automationSafety": { + "enabled": true + } + } + } + } + } + }, + "x-source": "src/api/routes/settingsTemplate.router.ts" + } }, { "method": "delete", "path": "/settings-template/delete", - "source": "src/api/routes/settingsTemplate.router.ts" + "source": "src/api/routes/settingsTemplate.router.ts", + "operation": { + "tags": [ + "Settings templates" + ], + "summary": "Delete a settings template", + "description": "Delete delete. Template edits propagate to every binding without copying settings.", + "operationId": "delete_settings_template_delete", + "parameters": [], + "responses": { + "200": { + "description": "Settings template operation completed." + }, + "400": { + "description": "Invalid template, scope, or target." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or settings template not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "required": [ + "templateId" + ], + "properties": { + "templateId": { + "type": "string", + "minLength": 1 + } + } + } + } + } + }, + "x-source": "src/api/routes/settingsTemplate.router.ts" + } }, { "method": "post", "path": "/settings-template/duplicate", - "source": "src/api/routes/settingsTemplate.router.ts" + "source": "src/api/routes/settingsTemplate.router.ts", + "operation": { + "tags": [ + "Settings templates" + ], + "summary": "Duplicate a settings template", + "description": "Run duplicate. Template edits propagate to every binding without copying settings.", + "operationId": "post_settings_template_duplicate", + "parameters": [], + "responses": { + "201": { + "description": "Settings template created." + }, + "400": { + "description": "Invalid template, scope, or target." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or settings template not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "required": [ + "templateId", + "name" + ], + "properties": { + "templateId": { + "type": "string", + "minLength": 1 + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + } + } + } + } + }, + "x-source": "src/api/routes/settingsTemplate.router.ts" + } }, { "method": "post", "path": "/settings-template/edit", - "source": "src/api/routes/settingsTemplate.router.ts" + "source": "src/api/routes/settingsTemplate.router.ts", + "operation": { + "tags": [ + "Settings templates" + ], + "summary": "Edit a settings template", + "description": "Run edit. Template edits propagate to every binding without copying settings.", + "operationId": "post_settings_template_edit", + "parameters": [], + "responses": { + "200": { + "description": "Settings template operation completed." + }, + "400": { + "description": "Invalid template, scope, or target." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or settings template not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "required": [ + "templateId" + ], + "properties": { + "templateId": { + "type": "string", + "minLength": 1 + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "settings": { + "type": "object", + "additionalProperties": false, + "properties": { + "localReadTtlSeconds": { + "type": [ + "integer", + "null" + ], + "minimum": 0, + "maximum": 2592000 + }, + "localReadTtlOverrides": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "integer", + "minimum": 0, + "maximum": 2592000 + } + }, + "automationSafety": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + } + } + } + } + } + } + } + }, + "x-source": "src/api/routes/settingsTemplate.router.ts" + } }, { "method": "get", "path": "/settings-template/list", - "source": "src/api/routes/settingsTemplate.router.ts" + "source": "src/api/routes/settingsTemplate.router.ts", + "operation": { + "tags": [ + "Settings templates" + ], + "summary": "List settings templates", + "description": "List live shared settings templates.", + "operationId": "get_settings_template_list", + "parameters": [], + "responses": { + "200": { + "description": "Settings template list." + }, + "400": { + "description": "Invalid template, scope, or target." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or settings template not found." + } + }, + "x-source": "src/api/routes/settingsTemplate.router.ts" + } }, { "method": "delete", "path": "/settings-template/unassign/{instanceName}", - "source": "src/api/routes/settingsTemplate.router.ts" + "source": "src/api/routes/settingsTemplate.router.ts", + "operation": { + "tags": [ + "Settings templates" + ], + "summary": "Unassign a settings template", + "description": "Delete unassign. Template edits propagate to every binding without copying settings.", + "operationId": "delete_settings_template_unassign", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Settings template operation completed." + }, + "400": { + "description": "Invalid template, scope, or target." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or settings template not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "required": [ + "scope" + ], + "properties": { + "scope": { + "type": "string", + "enum": [ + "instance", + "group", + "contact" + ] + }, + "target": { + "type": "string", + "minLength": 3, + "maxLength": 255 + } + } + } + } + } + }, + "x-source": "src/api/routes/settingsTemplate.router.ts" + } }, { "method": "get", "path": "/settings/find/{instanceName}", - "source": "src/api/routes/settings.router.ts" + "source": "src/api/routes/settings.router.ts", + "operation": { + "tags": [ + "Instance settings" + ], + "summary": "Get find", + "description": "Get find for Instance settings.", + "operationId": "get_settings_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/settings.router.ts" + } }, { "method": "get", "path": "/settings/outbound-audit/{instanceName}", - "source": "src/api/routes/settings.router.ts" + "source": "src/api/routes/settings.router.ts", + "operation": { + "tags": [ + "Instance settings" + ], + "summary": "Get outbound audit", + "description": "Get outbound audit for Instance settings.", + "operationId": "get_settings_outbound_audit", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/settings.router.ts" + } }, { "method": "post", "path": "/settings/set/{instanceName}", - "source": "src/api/routes/settings.router.ts" + "source": "src/api/routes/settings.router.ts", + "operation": { + "tags": [ + "Instance settings" + ], + "summary": "Update set", + "description": "Update set for Instance settings.", + "operationId": "post_settings_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/settings.router.ts" + } }, { "method": "get", "path": "/sqs/find/{instanceName}", - "source": "src/api/integrations/event/sqs/sqs.router.ts" + "source": "src/api/integrations/event/sqs/sqs.router.ts", + "operation": { + "tags": [ + "SQS" + ], + "summary": "Get find", + "description": "Get find for SQS.", + "operationId": "get_sqs_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/event/sqs/sqs.router.ts" + } }, { "method": "post", "path": "/sqs/set/{instanceName}", - "source": "src/api/integrations/event/sqs/sqs.router.ts" + "source": "src/api/integrations/event/sqs/sqs.router.ts", + "operation": { + "tags": [ + "SQS" + ], + "summary": "Update set", + "description": "Update set for SQS.", + "operationId": "post_sqs_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/event/sqs/sqs.router.ts" + } }, { "method": "post", "path": "/template/create/{instanceName}", - "source": "src/api/routes/template.router.ts" + "source": "src/api/routes/template.router.ts", + "operation": { + "tags": [ + "WhatsApp templates" + ], + "summary": "Create create", + "description": "Create create for WhatsApp templates.", + "operationId": "post_template_create", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/template.router.ts" + } }, { "method": "delete", "path": "/template/delete/{instanceName}", - "source": "src/api/routes/template.router.ts" + "source": "src/api/routes/template.router.ts", + "operation": { + "tags": [ + "WhatsApp templates" + ], + "summary": "Delete delete", + "description": "Delete delete for WhatsApp templates.", + "operationId": "delete_template_delete", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/template.router.ts" + } }, { "method": "post", "path": "/template/edit/{instanceName}", - "source": "src/api/routes/template.router.ts" + "source": "src/api/routes/template.router.ts", + "operation": { + "tags": [ + "WhatsApp templates" + ], + "summary": "Run edit", + "description": "Run edit for WhatsApp templates.", + "operationId": "post_template_edit", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/routes/template.router.ts" + } }, { "method": "get", "path": "/template/find/{instanceName}", - "source": "src/api/routes/template.router.ts" + "source": "src/api/routes/template.router.ts", + "operation": { + "tags": [ + "WhatsApp templates" + ], + "summary": "Get find", + "description": "Get find for WhatsApp templates.", + "operationId": "get_template_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/routes/template.router.ts" + } }, { "method": "post", "path": "/typebot/changeStatus/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Update change Status", + "description": "Update change Status for Typebot.", + "operationId": "post_typebot_changeStatus", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "post", "path": "/typebot/create/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Create create", + "description": "Create create for Typebot.", + "operationId": "post_typebot_create", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "delete", "path": "/typebot/delete/{typebotId}/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Delete delete", + "description": "Delete delete for Typebot.", + "operationId": "delete_typebot_delete", + "parameters": [ + { + "name": "typebotId", + "in": "path", + "required": true, + "description": "Typebot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "get", "path": "/typebot/fetch/{typebotId}/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Get fetch", + "description": "Get fetch for Typebot.", + "operationId": "get_typebot_fetch", + "parameters": [ + { + "name": "typebotId", + "in": "path", + "required": true, + "description": "Typebot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "get", "path": "/typebot/fetchSessions/{typebotId}/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Get fetch Sessions", + "description": "Get fetch Sessions for Typebot.", + "operationId": "get_typebot_fetchSessions", + "parameters": [ + { + "name": "typebotId", + "in": "path", + "required": true, + "description": "Typebot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "get", "path": "/typebot/fetchSettings/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Get fetch Settings", + "description": "Get fetch Settings for Typebot.", + "operationId": "get_typebot_fetchSettings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "get", "path": "/typebot/find/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Get find", + "description": "Get find for Typebot.", + "operationId": "get_typebot_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "post", "path": "/typebot/ignoreJid/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Update ignore Jid", + "description": "Update ignore Jid for Typebot.", + "operationId": "post_typebot_ignoreJid", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "post", "path": "/typebot/settings/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Update settings", + "description": "Update settings for Typebot.", + "operationId": "post_typebot_settings", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "post", "path": "/typebot/start/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Run start", + "description": "Run start for Typebot.", + "operationId": "post_typebot_start", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "put", "path": "/typebot/update/{typebotId}/{instanceName}", - "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + "source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts", + "operation": { + "tags": [ + "Typebot" + ], + "summary": "Update update", + "description": "Update update for Typebot.", + "operationId": "put_typebot_update", + "parameters": [ + { + "name": "typebotId", + "in": "path", + "required": true, + "description": "Typebot Id path parameter.", + "schema": { + "type": "string" + } + }, + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/chatbot/typebot/routes/typebot.router.ts" + } }, { "method": "post", "path": "/webhook/evolution", - "source": "src/api/integrations/channel/evolution/evolution.router.ts" + "source": "src/api/integrations/channel/evolution/evolution.router.ts", + "operation": { + "tags": [ + "Webhooks" + ], + "summary": "Run evolution", + "description": "Run evolution for Webhooks.", + "operationId": "post_webhook_evolution", + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/channel/evolution/evolution.router.ts" + } }, { "method": "get", "path": "/webhook/find-all/{instanceName}", - "source": "src/api/integrations/event/webhook/webhook.router.ts" + "source": "src/api/integrations/event/webhook/webhook.router.ts", + "operation": { + "tags": [ + "Webhooks" + ], + "summary": "Get find all", + "description": "Get find all for Webhooks.", + "operationId": "get_webhook_find_all", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/event/webhook/webhook.router.ts" + } }, { "method": "get", "path": "/webhook/find/{instanceName}", - "source": "src/api/integrations/event/webhook/webhook.router.ts" + "source": "src/api/integrations/event/webhook/webhook.router.ts", + "operation": { + "tags": [ + "Webhooks" + ], + "summary": "Get find", + "description": "Get find for Webhooks.", + "operationId": "get_webhook_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/event/webhook/webhook.router.ts" + } }, { "method": "get", "path": "/webhook/meta", - "source": "src/api/integrations/channel/meta/meta.router.ts" + "source": "src/api/integrations/channel/meta/meta.router.ts", + "operation": { + "tags": [ + "Webhooks" + ], + "summary": "Get meta", + "description": "Get meta for Webhooks.", + "operationId": "get_webhook_meta", + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/channel/meta/meta.router.ts" + } }, { "method": "post", "path": "/webhook/meta", - "source": "src/api/integrations/channel/meta/meta.router.ts" + "source": "src/api/integrations/channel/meta/meta.router.ts", + "operation": { + "tags": [ + "Webhooks" + ], + "summary": "Run meta", + "description": "Run meta for Webhooks.", + "operationId": "post_webhook_meta", + "parameters": [], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/channel/meta/meta.router.ts" + } }, { "method": "post", "path": "/webhook/set-many/{instanceName}", - "source": "src/api/integrations/event/webhook/webhook.router.ts" + "source": "src/api/integrations/event/webhook/webhook.router.ts", + "operation": { + "tags": [ + "Webhooks" + ], + "summary": "Update set many", + "description": "Update set many for Webhooks.", + "operationId": "post_webhook_set_many", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/event/webhook/webhook.router.ts" + } }, { "method": "post", "path": "/webhook/set/{instanceName}", - "source": "src/api/integrations/event/webhook/webhook.router.ts" + "source": "src/api/integrations/event/webhook/webhook.router.ts", + "operation": { + "tags": [ + "Webhooks" + ], + "summary": "Update set", + "description": "Update set for Webhooks.", + "operationId": "post_webhook_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/event/webhook/webhook.router.ts" + } }, { "method": "get", "path": "/websocket/find/{instanceName}", - "source": "src/api/integrations/event/websocket/websocket.router.ts" + "source": "src/api/integrations/event/websocket/websocket.router.ts", + "operation": { + "tags": [ + "WebSocket" + ], + "summary": "Get find", + "description": "Get find for WebSocket.", + "operationId": "get_websocket_find", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "x-source": "src/api/integrations/event/websocket/websocket.router.ts" + } }, { "method": "post", "path": "/websocket/set/{instanceName}", - "source": "src/api/integrations/event/websocket/websocket.router.ts" + "source": "src/api/integrations/event/websocket/websocket.router.ts", + "operation": { + "tags": [ + "WebSocket" + ], + "summary": "Update set", + "description": "Update set for WebSocket.", + "operationId": "post_websocket_set", + "parameters": [ + { + "name": "instanceName", + "in": "path", + "required": true, + "description": "Evolution API instance name.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Invalid request." + }, + "401": { + "description": "Missing or invalid API key." + }, + "404": { + "description": "Instance or resource not found." + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "example": {} + } + } + }, + "x-source": "src/api/integrations/event/websocket/websocket.router.ts" + } } ] diff --git a/scripts/audit-runtime-openapi.mjs b/scripts/audit-runtime-openapi.mjs index 9fe289c3cb..12ac50e572 100644 --- a/scripts/audit-runtime-openapi.mjs +++ b/scripts/audit-runtime-openapi.mjs @@ -1,14 +1,38 @@ import fs from 'node:fs'; - import YAML from 'yaml'; - const routes = JSON.parse(fs.readFileSync('docs/runtime-routes.json', 'utf8')); const base = YAML.parse(fs.readFileSync('docs/openapi.yaml', 'utf8'), { maxAliasCount: -1 }); const paths = structuredClone(base.paths ?? {}); for (const route of routes) { paths[route.path] ??= {}; - paths[route.path][route.method] ??= { responses: { default: { description: 'Evolution API response.' } } }; + paths[route.path][route.method] ??= route.operation; } const missing = routes.filter(({ method, path }) => !paths[path]?.[method]); -if (missing.length > 0) throw new Error(`Merged OpenAPI is missing ${missing.length} runtime operations.`); -console.log(`Audited ${routes.length} runtime operations successfully.`); +if (missing.length) throw new Error(`Merged OpenAPI is missing ${missing.length} runtime operations.`); +const bad = []; +for (const route of routes) { + const operation = paths[route.path][route.method]; + const generated = !base.paths?.[route.path]?.[route.method]; + for (const field of ['tags', 'summary', 'responses']) + if (!operation[field] || (Array.isArray(operation[field]) && !operation[field].length)) + bad.push(`${route.method} ${route.path}: ${field}`); + if (!generated) continue; + for (const field of ['description', 'operationId']) + if (!operation[field]) bad.push(`${route.method} ${route.path}: ${field}`); + for (const name of [...route.path.matchAll(/\{([^}]+)\}/g)].map((match) => match[1])) + if ( + !(operation.parameters ?? []).some( + (parameter) => parameter.name === name && parameter.in === 'path' && parameter.required === true, + ) + ) + bad.push(`${route.method} ${route.path}: path parameter ${name}`); + if (['post', 'put', 'patch'].includes(route.method) && !operation.requestBody) + bad.push(`${route.method} ${route.path}: requestBody`); +} +const generatedIds = routes + .filter((route) => !base.paths?.[route.path]?.[route.method]) + .map((route) => paths[route.path][route.method].operationId); +const duplicateIds = generatedIds.filter((id, index) => generatedIds.indexOf(id) !== index); +if (duplicateIds.length) bad.push(`duplicate operationIds: ${[...new Set(duplicateIds)].join(', ')}`); +if (bad.length) throw new Error(`Runtime OpenAPI convention failures (${bad.length}):\n${bad.join('\n')}`); +console.log(`Audited ${routes.length} runtime operations and presentation conventions successfully.`); diff --git a/scripts/generate-runtime-openapi.mjs b/scripts/generate-runtime-openapi.mjs index 7dd2314b2e..25c09df8d8 100644 --- a/scripts/generate-runtime-openapi.mjs +++ b/scripts/generate-runtime-openapi.mjs @@ -1,4 +1,5 @@ import fs from 'node:fs'; +import { runtimeOperation } from './runtime-openapi-conventions.mjs'; const routerPrefixes = { 'src/api/routes/instance.router.ts': '/instance', @@ -51,7 +52,11 @@ for (const [file, prefix] of Object.entries(routerPrefixes)) { const unique = [...new Map(operations.map((item) => [`${item.method} ${item.path}`, item])).values()].sort( (left, right) => left.path.localeCompare(right.path) || left.method.localeCompare(right.method), ); -const output = `${JSON.stringify(unique, null, 2)}\n`; +const output = `${JSON.stringify( + unique.map((route) => ({ ...route, operation: runtimeOperation(route) })), + null, + 2, +)}\n`; const target = 'docs/runtime-routes.json'; if (process.argv.includes('--check')) { if (!fs.existsSync(target) || fs.readFileSync(target, 'utf8') !== output) { diff --git a/scripts/runtime-openapi-conventions.mjs b/scripts/runtime-openapi-conventions.mjs new file mode 100644 index 0000000000..a325e4f52d --- /dev/null +++ b/scripts/runtime-openapi-conventions.mjs @@ -0,0 +1,207 @@ +const domainNames = { + instance: 'Instances', + settings: 'Instance settings', + 'settings-template': 'Settings templates', + message: 'Messages', + call: 'Calls', + chat: 'Chats', + group: 'Groups', + business: 'Business & catalog', + template: 'WhatsApp templates', + proxy: 'Proxy', + label: 'Labels', + webhook: 'Webhooks', + websocket: 'WebSocket', + rabbitmq: 'RabbitMQ', + nats: 'NATS', + pusher: 'Pusher', + sqs: 'SQS', + kafka: 'Kafka', + s3: 'S3', + chatwoot: 'Chatwoot', + typebot: 'Typebot', + openai: 'OpenAI', + dify: 'Dify', + flowise: 'Flowise', + n8n: 'n8n', + evoai: 'EvoAI', + evolutionBot: 'Evolution Bot', + instanceapikey: 'Instance API key', + root: 'Evolution API', +}; +const words = (value) => + value + .replace(/([a-z0-9])([A-Z])/g, '$1 $2') + .replace(/[-_]/g, ' ') + .trim(); +const title = (value) => words(value).replace(/\b\w/g, (letter) => letter.toUpperCase()); + +const templateSettingsSchema = { + type: 'object', + additionalProperties: false, + properties: { + localReadTtlSeconds: { type: ['integer', 'null'], minimum: 0, maximum: 2592000 }, + localReadTtlOverrides: { + type: ['object', 'null'], + additionalProperties: { type: 'integer', minimum: 0, maximum: 2592000 }, + }, + automationSafety: { type: ['object', 'null'], additionalProperties: true }, + }, +}; +const templateBody = (action) => { + const schemas = { + create: { + required: ['name', 'settings'], + properties: { name: { type: 'string', minLength: 1, maxLength: 255 }, settings: templateSettingsSchema }, + }, + edit: { + required: ['templateId'], + properties: { + templateId: { type: 'string', minLength: 1 }, + name: { type: 'string', minLength: 1, maxLength: 255 }, + settings: templateSettingsSchema, + }, + }, + duplicate: { + required: ['templateId', 'name'], + properties: { + templateId: { type: 'string', minLength: 1 }, + name: { type: 'string', minLength: 1, maxLength: 255 }, + }, + }, + delete: { required: ['templateId'], properties: { templateId: { type: 'string', minLength: 1 } } }, + assign: { + required: ['templateId', 'scope'], + properties: { + templateId: { type: 'string', minLength: 1 }, + scope: { type: 'string', enum: ['instance', 'group', 'contact'] }, + target: { + type: 'string', + minLength: 3, + maxLength: 255, + description: + 'Omit for instance scope. Group targets end in @g.us; contact targets are full non-group WhatsApp identifiers.', + }, + }, + }, + unassign: { + required: ['scope'], + properties: { + scope: { type: 'string', enum: ['instance', 'group', 'contact'] }, + target: { type: 'string', minLength: 3, maxLength: 255 }, + }, + }, + }; + return schemas[action] ? { type: 'object', additionalProperties: false, ...schemas[action] } : null; +}; + +const actionVerb = (method, action) => { + if (/^(find|fetch|get|list|connection)/i.test(action)) return 'Get'; + if (/^(delete|remove|logout|leave|revoke)/i.test(action)) return 'Delete'; + if (/^(create|send|offer)/i.test(action)) return 'Create'; + if (/^(set|update|handle|change|toggle|restart|archive|mark|accept|connect|ignore)/i.test(action)) return 'Update'; + return method === 'get' + ? 'Get' + : method === 'delete' + ? 'Delete' + : method === 'put' || method === 'patch' + ? 'Update' + : 'Run'; +}; +export const runtimeOperation = ({ method, path, source }) => { + const segments = path.split('/').filter(Boolean); + const domain = segments[0] || 'root'; + const action = segments.find((s, i) => i > 0 && !s.startsWith('{')) || domain; + const params = [...path.matchAll(/\{([^}]+)\}/g)].map(([, name]) => ({ + name, + in: 'path', + required: true, + description: name === 'instanceName' ? 'Evolution API instance name.' : `${title(name)} path parameter.`, + schema: { type: 'string' }, + })); + const bodyMethods = new Set(['post', 'put', 'patch']); + const summary = `${actionVerb(method, action)} ${words(action)}`; + const operation = { + tags: [domainNames[domain] || title(domain)], + summary, + description: `${summary} for ${domainNames[domain] || title(domain)}.`, + operationId: `${method}_${[domain, ...segments.slice(1).filter((x) => !x.startsWith('{'))].join('_').replace(/[^A-Za-z0-9_]/g, '_')}`, + parameters: params, + responses: { + '200': { description: 'Successful response.' }, + '400': { description: 'Invalid request.' }, + '401': { description: 'Missing or invalid API key.' }, + '404': { description: 'Instance or resource not found.' }, + }, + }; + if (method === 'post' && /create|duplicate/i.test(action)) { + operation.responses = { + '201': operation.responses['200'], + ...Object.fromEntries(Object.entries(operation.responses).filter(([k]) => k !== '200')), + }; + } + if (bodyMethods.has(method)) + operation.requestBody = { + required: true, + content: { 'application/json': { schema: { type: 'object', additionalProperties: true }, example: {} } }, + }; + if (domain === 'settings-template') { + const templateSummaries = { + assign: 'Assign a settings template', + bindings: 'List template bindings', + create: 'Create a settings template', + delete: 'Delete a settings template', + duplicate: 'Duplicate a settings template', + edit: 'Edit a settings template', + list: 'List settings templates', + unassign: 'Unassign a settings template', + }; + operation.summary = templateSummaries[action]; + operation.description = + action === 'list' + ? 'List live shared settings templates.' + : action === 'bindings' + ? 'List the instance default and exact group/contact bindings.' + : `${summary}. Template edits propagate to every binding without copying settings.`; + const schema = templateBody(action); + if (schema) + operation.requestBody = { + required: true, + content: { + 'application/json': { + schema, + example: + action === 'create' + ? { + name: 'Careful outreach', + settings: { localReadTtlSeconds: 120, automationSafety: { enabled: true } }, + } + : undefined, + }, + }, + }; + operation.responses = { + ...(operation.responses['201'] + ? { '201': { description: 'Settings template created.' } } + : { + '200': { + description: + action === 'list' + ? 'Settings template list.' + : action === 'bindings' + ? 'Template binding list.' + : 'Settings template operation completed.', + }, + }), + '400': { description: 'Invalid template, scope, or target.' }, + '401': { description: 'Missing or invalid API key.' }, + '404': { description: 'Instance or settings template not found.' }, + }; + } + operation['x-source'] = source; + return operation; +}; +export const runtimeTags = [...new Set(Object.values(domainNames))].map((name) => ({ + name, + description: `${name} operations.`, +})); diff --git a/src/api/routes/index.router.ts b/src/api/routes/index.router.ts index 6b56f91695..d6daf806ec 100644 --- a/src/api/routes/index.router.ts +++ b/src/api/routes/index.router.ts @@ -56,12 +56,7 @@ if (!serverConfig.DISABLE_DOCS) { const runtimeRoutes = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'docs', 'runtime-routes.json'), 'utf8')); for (const route of runtimeRoutes) { base.paths[route.path] ??= {}; - base.paths[route.path][route.method] ??= { - tags: [`Evolution API: ${route.path.split('/')[1] || 'root'}`], - summary: `${route.method.toUpperCase()} ${route.path}`, - description: `Runtime route declared in ${route.source}.`, - responses: { default: { description: 'Evolution API response.' } }, - }; + base.paths[route.path][route.method] ??= route.operation; } const openApiDocument = YAML.stringify(base);