feat:Update OpenAPI CreateMaestroRunsPayload: Add budget and re-add verbose

[HavenDV]

Summary by CodeRabbit

• New Features
  • Added a new budget option with selectable levels (“low”, “medium”, “high”) to enhance request customization.
• Refactor
  • Improved the configuration of verbosity settings to ensure consistent behavior.

[coderabbitai]

Walkthrough

The changes update the OpenAPI specification defined in src/libs/AI21/openapi.yaml. In the CreateMaestroRunsPayload schema, the verbose property was temporarily removed and then re-added after introducing a new property named budget. The budget property is defined as a string with an enumeration of low, medium, and high. The re-added verbose property retains its original title, type, and a default value of false, indicating a restructuring of the payload schema while keeping its intended behavior.

Changes

File	Summary
src/.../openapi.yaml	Removed and later re-added the verbose property; added a new budget property (string enum: low, medium, high) in the payload schema

Possibly related PRs

• feat:Update AI21 Studio spec: Add stateless-run endpoints and schemas #98: Modifies the verbose property in a different context, indicating a shared focus on property management.
• feat:Update OpenAPI: Replace Constraint with Requirement and update payload #107: Alters properties in the CreateMaestroRunsPayload schema by replacing and renaming fields, directly aligning with the current changes.
• feat:Rename stateless-run endpoints to maestro/runs and update schemas #105: Also involves modifications to the CreateMaestroRunsPayload schema, showing a clear connection to the restructuring performed here.

Poem

I'm a little rabbit, joyful and spry,
Hoping through schemas with a twinkle in my eye.
budget steps in with values so neat,
While verbose returns to keep things complete.
In YAML and code, our paths now align—
Here's to smooth changes with a playful sign! 🐇🎉

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9db5bb and aec18ee.

⛔ Files ignored due to path filters (8)

• src/libs/AI21/Generated/AI21.Ai21Api.CreateMaestroRunStudioV1MaestroRunsPost.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.IAi21Api.CreateMaestroRunStudioV1MaestroRunsPost.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayload.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.Models.CreateMaestroRunsPayloadBudget.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonConverters.CreateMaestroRunsPayloadBudget.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonConverters.CreateMaestroRunsPayloadBudgetNullable.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/AI21/openapi.yaml (1 hunks)

🔇 Additional comments (2)

src/libs/AI21/openapi.yaml (2)

1553-1559: New 'budget' Property Addition

The new budget property has been added to the CreateMaestroRunsPayload schema with an enumeration of the values low, medium, and high. Please verify that these enum values meet the design requirements and that all consumers of this API are updated to support this new field.

---

1560-1563: Re-adding the 'verbose' Property

The verbose property has been re-introduced with its original definition (boolean type and default value of false). Ensure that re-adding it in this new position (after the budget property) remains consistent with both the API documentation and consumer expectations.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.