feat:Rename stateless-run endpoints to maestro/runs and update schemas #105
Conversation
WalkthroughThe pull request updates API endpoint paths by renaming the "stateless-run" endpoints to "maestro/runs". This includes changes to operation IDs, method signatures, and the request/response schemas. The old payload and result schemas are removed and replaced with new ones that align with the "maestro" context. Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant API as API Server
Note over C,API: Create Maestro Run Flow
C->>API: POST /studio/v1/maestro/runs\n(CreateMaestroRunsPayload)
API-->>C: MaestroRunResult
Note over C,API: Retrieve Maestro Run Flow
C->>API: GET /studio/v1/maestro/runs/{execution_id}
API-->>C: MaestroRunResult
Suggested reviewers
Poem
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/libs/AI21/openapi.yaml (1)
1529-1571: Review: CreateMaestroRunsPayload Schema Definition
The newCreateMaestroRunsPayloadschema includes the requiredmessagesfield along with additional options such asoutput_type,models,tools,tool_resources,verbose,context, andconstraints. The structure is generally clear; however, consider expanding the definition of theoutput_typeproperty (or adding a description) if its exact structure is known. This could help clarify its expected format to API consumers.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (34)
src/libs/AI21/Generated/AI21.Ai21Api.CreateMaestroRunStudioV1MaestroRunsPost.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Ai21Api.GetMaestroRunStudioV1MaestroRunsExecutionIdGet.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.IAi21Api.CreateMaestroRunStudioV1MaestroRunsPost.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.IAi21Api.GetMaestroRunStudioV1MaestroRunsExecutionIdGet.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.Assistant.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.Constraint.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayload.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayload.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayloadContext.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayloadContext.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayloadOutputType.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayloadOutputType.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayloadTool.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayloadTool.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayloadTool2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.CreateStatelessRunsPayloadOutputType.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.MaestroRunResult.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.MaestroRunResult.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.MaestroRunResultResult.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.MaestroRunResultResult.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.MaestroRunResultStatus.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ModelName.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ToolResources.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ToolResources.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ToolResourcesFileSearch.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ToolResourcesFileSearch.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ToolResourcesWebSearch.Json.g.csis excluded by!**/generated/**src/libs/AI21/Generated/AI21.Models.ToolResourcesWebSearch.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.CreateMaestroRunsPayloadTool2.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.CreateMaestroRunsPayloadTool2Nullable.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.MaestroRunResultStatus.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonConverters.MaestroRunResultStatusNullable.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/AI21/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/AI21/openapi.yaml(6 hunks)
🔇 Additional comments (2)
src/libs/AI21/openapi.yaml (2)
475-497: Review: New POST Endpoint for Maestro Run
The new POST endpoint at/studio/v1/maestro/runsis defined with an updated summary, operationId, and schema references. The request body now points toCreateMaestroRunsPayloadand the successful response referencesMaestroRunResult. Please ensure that any legacy endpoints have been deprecated and that the updated documentation clearly reflects the changes.
498-516: Review: New GET Endpoint for Maestro Run
The GET endpoint at/studio/v1/maestro/runs/{execution_id}is correctly updated with a new summary and operationId, and it references theMaestroRunResultschema in its response. Verify that the structure of the returned payload now meets the new Maestro run context expectations.
| MaestroRunResult: | ||
| title: MaestroRunResult | ||
| required: | ||
| - id | ||
| - status | ||
| type: object | ||
| properties: | ||
| id: | ||
| title: Id | ||
| type: string | ||
| description: "A unique ID for the request (not the message). Repeated identical requests\nget different IDs. However, for a streaming response, the ID will be the same\nfor all responses in the stream.\n" | ||
| format: uuid | ||
| status: | ||
| title: Status | ||
| enum: | ||
| - completed | ||
| - failed | ||
| - in_progress | ||
| - requires_action | ||
| type: string | ||
| result: | ||
| title: Result |
There was a problem hiding this comment.
💡 Verification agent
❓ Verification inconclusive
Critical: Incomplete Definition in MaestroRunResult Schema
The MaestroRunResult schema correctly defines the required id and status properties, but the result property is missing an explicit type declaration and further specification. This incomplete definition could lead to ambiguity for API consumers. Please specify the type (for example, object or string) and add a description. For example, you might consider the following diff:
@@ MaestroRunResult schema
- result:
- title: Result
+ result:
+ title: Result
+ type: object
+ description: Optional detailed result of the Maestro run operation.Action Required: Complete MaestroRunResult Definition in openapi.yaml
In the MaestroRunResult schema (located in src/libs/AI21/openapi.yaml between lines 1919–1940), the result property is missing a type declaration and description. To eliminate ambiguity for API consumers, please update the result property to explicitly specify its type (for example, object) and add an appropriate description. For instance, consider applying the following diff:
@@ MaestroRunResult schema
- result:
- title: Result
+ result:
+ title: Result
+ type: object
+ description: Optional detailed result of the Maestro run operation.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| MaestroRunResult: | |
| title: MaestroRunResult | |
| required: | |
| - id | |
| - status | |
| type: object | |
| properties: | |
| id: | |
| title: Id | |
| type: string | |
| description: "A unique ID for the request (not the message). Repeated identical requests\nget different IDs. However, for a streaming response, the ID will be the same\nfor all responses in the stream.\n" | |
| format: uuid | |
| status: | |
| title: Status | |
| enum: | |
| - completed | |
| - failed | |
| - in_progress | |
| - requires_action | |
| type: string | |
| result: | |
| title: Result | |
| MaestroRunResult: | |
| title: MaestroRunResult | |
| required: | |
| - id | |
| - status | |
| type: object | |
| properties: | |
| id: | |
| title: Id | |
| type: string | |
| description: "A unique ID for the request (not the message). Repeated identical requests\nget different IDs. However, for a streaming response, the ID will be the same\nfor all responses in the stream.\n" | |
| format: uuid | |
| status: | |
| title: Status | |
| enum: | |
| - completed | |
| - failed | |
| - in_progress | |
| - requires_action | |
| type: string | |
| result: | |
| title: Result | |
| type: object | |
| description: Optional detailed result of the Maestro run operation. |
Summary by CodeRabbit