-
Notifications
You must be signed in to change notification settings - Fork 0
docs: OpenAPI spec version upgraded from 1.2.0 to 1.6.5 #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
|
🔒 Entelligence AI Vulnerability Scanner ✅ No security vulnerabilities found! Your code passed our comprehensive security analysis. |
WalkthroughThis PR upgrades the OpenAPI specification from version 1.2.0 to 1.6.5, introducing major API enhancements centered around Model Context Protocol (MCP) integration, knowledge base management, and voice capabilities. The update adds multiple new endpoint categories including public flow execution, knowledge bases, ElevenLabs voice integration, and OpenAI-compatible responses. A significant architectural change renames folder-related endpoints to projects. New configuration options support event delivery modes (polling/streaming/direct), MCP enablement, and authentication settings at the project level. The specification also introduces comprehensive schemas for content blocks (text, code, media, JSON, tool, error) and expands configuration responses with serialization limits, webhook settings, and voice mode availability. Changes
Sequence DiagramThis diagram shows the interactions between components: sequenceDiagram
participant Client
participant API Gateway
participant Auth Service
participant Flow Service
participant Queue Service
participant MCP Service
participant Database
Note over Client,Database: Build Flow (Authenticated)
Client->>API Gateway: POST /api/v1/build/{flow_id}/flow
API Gateway->>Auth Service: Validate API Key/OAuth Token
Auth Service-->>API Gateway: User Authenticated
API Gateway->>Flow Service: Build Flow Request
Flow Service->>Database: Load Flow Data
Database-->>Flow Service: Flow Configuration
Flow Service->>Queue Service: Create Job (event_delivery: polling/streaming)
Queue Service-->>Flow Service: Job ID
Flow Service-->>Client: Return Job ID
Note over Client,Queue Service: Poll or Stream Events
alt event_delivery is streaming
Client->>Queue Service: GET /api/v1/build/{job_id}/events?event_delivery=streaming
Queue Service-->>Client: SSE Stream (events)
else event_delivery is polling
Client->>Queue Service: GET /api/v1/build/{job_id}/events?event_delivery=polling
Queue Service-->>Client: JSON Response (batch events)
end
Note over Client,Database: Build Public Flow (No Auth)
Client->>API Gateway: POST /api/v1/build_public_tmp/{flow_id}/flow
Note right of API Gateway: Uses client_id cookie<br/>No authentication required
API Gateway->>Flow Service: Build Public Flow Request
Flow Service->>Database: Verify Flow is PUBLIC
Database-->>Flow Service: Flow Access Type
alt access_type is PUBLIC
Flow Service->>Database: Load Flow with Owner Permissions
Database-->>Flow Service: Flow Configuration
Flow Service->>Queue Service: Create Job (deterministic UUID)
Queue Service-->>Flow Service: Job ID
Flow Service-->>Client: Return Job ID
else access_type is PRIVATE
Flow Service-->>Client: 403 Forbidden
end
Note over Client,Database: MCP Project Configuration
Client->>API Gateway: PATCH /api/v1/mcp/project/{project_id}
API Gateway->>Auth Service: Validate User
Auth Service-->>API Gateway: Authenticated
API Gateway->>MCP Service: Update MCP Settings
MCP Service->>Database: Load Project Flows
Database-->>MCP Service: Flow List
loop For each flow in project
MCP Service->>Database: Update Flow (mcp_enabled, action_name, action_description)
end
MCP Service->>Database: Update Project Auth Settings
Database-->>MCP Service: Settings Saved
MCP Service-->>Client: Success Response
Note over Client,MCP Service: MCP Tool Execution
Client->>API Gateway: POST /api/v1/mcp/project/{project_id}
Note right of Client: MCP client (Cursor, Claude, etc)
API Gateway->>MCP Service: Handle MCP Message
MCP Service->>Database: Get MCP-Enabled Flows
Database-->>MCP Service: Tool List
alt MCP tool call
MCP Service->>Flow Service: Execute Flow as Tool
Flow Service->>Queue Service: Create Job
Queue Service-->>Flow Service: Results
Flow Service-->>MCP Service: Tool Output
MCP Service-->>Client: MCP Response
else MCP list tools
MCP Service-->>Client: Available Tools List
end
Note over Client,Database: Knowledge Base Operations
Client->>API Gateway: GET /api/v1/knowledge_bases/
API Gateway->>Auth Service: Validate User
Auth Service-->>API Gateway: Authenticated
API Gateway->>Database: List Knowledge Bases
Database-->>API Gateway: KB List with Metadata
API Gateway-->>Client: Knowledge Base Info
🔗 Cross-Repository Impact AnalysisEnable automatic detection of breaking changes across your dependent repositories. → Set up now Learn more about Cross-Repository AnalysisWhat It Does
How to Enable
Benefits
Note for WindsurfPlease change the default marketplace provider to the following in the windsurf settings:Marketplace Extension Gallery Service URL: https://marketplace.visualstudio.com/_apis/public/gallery Marketplace Gallery Item URL: https://marketplace.visualstudio.com/items Entelligence.ai can learn from your feedback. Simply add 👍 / 👎 emojis to teach it your preferences. More shortcuts belowEmoji Descriptions:
Interact with the Bot:
Also you can trigger various commands with the bot by doing The current supported commands are
More commands to be added soon. |
This PR updates the OpenAPI spec.
Update reason: version upgraded from 1.2.0 to 1.6.5
Version: 1.6.5
EntelligenceAI PR Summary
OpenAPI specification upgraded from v1.2.0 to v1.6.5 with extensive API enhancements for MCP integration, knowledge bases, and voice capabilities.