feat:Refactor OpenAPI Spec: Add Endpoints and Enhance Tool Modeling#202
Open
feat:Refactor OpenAPI Spec: Add Endpoints and Enhance Tool Modeling#202
Conversation
WalkthroughThe OpenAPI spec for Studio was extensively refactored. New assistant, MCP discovery, generation, maestro run, and vector-store endpoints were added. Tool modeling shifted to a union-based ToolDefinition and ToolResource system with new HTTP/MCP/file/web search types. Schemas, enums, and namespaces were reorganized; several payloads gained vector_store_id. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Client
participant API as Studio API
participant Assist as Assistant Service
participant Exec as Execution Engine
participant Tools as Tools (HTTP/MCP/File/Web)
rect rgba(230,246,255,0.6)
note over Client,API: Create/Modify Assistant
Client->>API: POST /studio/v1/assistants (CreateAssistantRequest)
API->>Assist: Create Assistant (models, tools, tool_resources)
Assist-->>API: Assistant
Client->>API: PATCH /studio/v1/assistants/{id} (ModifyAssistantRequest)
API->>Assist: Update Assistant
Assist-->>API: Assistant
end
rect rgba(240,255,240,0.6)
note over Client,API: Run Assistant
Client->>API: POST /studio/v1/assistants/{id}/run (RunAssistantRequest)
API->>Exec: Start run (requirements, optimization)
Exec->>Tools: Invoke tool via ToolDefinition (http|mcp|file_search|web_search)
Tools-->>Exec: Results / Errors
Exec-->>API: MaestroRunResult (may include error)
API-->>Client: MaestroRunResult
end
sequenceDiagram
autonumber
actor Client
participant API as Studio API
participant MCP as MCP Discovery
note over Client,API: MCP Tool Discovery
Client->>API: POST /studio/v1/mcp/discover (MCPDefinition)
API->>MCP: Discover tools
MCP-->>API: MCPDiscoveryResponse (tools, resources)
API-->>Client: MCPDiscoveryResponse
sequenceDiagram
autonumber
actor Client
participant API as Studio API
participant Gen as Generation Service
note over Client,API: Generation utilities
Client->>API: POST /studio/v1/generation/requirements
API->>Gen: Generate requirements
Gen-->>API: RequirementsGenerationResponse
API-->>Client: RequirementsGenerationResponse
Client->>API: POST /studio/v1/generation/thread-name
API->>Gen: Generate thread name
Gen-->>API: ThreadNameGenerationResponse
API-->>Client: ThreadNameGenerationResponse
sequenceDiagram
autonumber
actor Client
participant API as Studio API
participant Demo as Regulations Demo
note over Client,API: Vector Store retrieval
Client->>API: GET /studio/v1/demos/regulations/vector-store/{vector_store_id}
API->>Demo: Fetch vector store
Demo-->>API: Vector store details
API-->>Client: Response
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60–90 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro ⛔ Files ignored due to path filters (136)
📒 Files selected for processing (1)
🔇 Additional comments (15)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Enhancements
Refactor