feat:Update OpenAPI specification to introduce AIAgentSettings schema

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced a new schema, AIAgentSettings, for enhanced configuration of AI agents.
• Improvements
  • Updated request bodies for CreateAgentBody, UpdateAgentBody, CreateChatBody, and UpdateChatBody to utilize the new aiAgentSettings schema, improving clarity in agent-related metadata management.

[coderabbitai]

Walkthrough

The changes in the OpenAPI specification for the Instill AI API include the introduction of a new schema called AIAgentSettings, which defines various properties for AI agent configurations. Existing request bodies, specifically CreateAgentBody, UpdateAgentBody, CreateChatBody, and UpdateChatBody, have been updated to reference this new schema instead of the previous AIAgentAppMetadata. These modifications enhance the API's structure for managing AI agents and their settings while maintaining the overall integrity of the OpenAPI document.

Changes

File Path	Change Summary
src/libs/Instill/openapi.yaml	- Added new schema: AIAgentSettings - Updated CreateAgentBody to reference aiAgentSettings - Updated UpdateAgentBody to reference aiAgentSettings - Updated CreateChatBody to reference aiAgentSettings - Updated UpdateChatBody to reference aiAgentSettings

Poem

🐇 In the land of code where rabbits play,
New settings for agents have come to stay.
With AIAgentSettings, they hop with glee,
Configuring their tools, as smart as can be!
So let’s celebrate, with a joyful cheer,
For the changes made, we hold so dear! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/libs/Instill/openapi.yaml (1)

Line range hint 1-11033: Clean transition from AIAgentAppMetadata to AIAgentSettings

The API maintains backward compatibility while transitioning from AIAgentAppMetadata to AIAgentSettings. The v1alpha versioning is appropriately used to handle this schema evolution.

Consider adding deprecation notices in the AIAgentAppMetadata schema to guide users toward using the new AIAgentSettings schema in future versions.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9bf660d and febbc0e.

⛔ Files ignored due to path filters (17)

• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateAgent.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateChat.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateAgent.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateChat.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceCreateAgent.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceCreateChat.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateAgent.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateChat.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AIAgentSettings.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AIAgentSettings.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AIAgentSettingsConnections.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AIAgentSettingsConnections.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.CreateAgentBody.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.CreateChatBody.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.UpdateAgentBody.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.UpdateChatBody.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/Instill/openapi.yaml (6 hunks)

🔇 Additional comments (2)

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

6269-6290: Well-structured schema definition for AIAgentSettings

The new AIAgentSettings schema is cleanly implemented with proper typing and documentation for all fields. The schema effectively encapsulates the settings needed for AI agent configuration.

---

7205-7208: Consistent integration of AIAgentSettings across request bodies

The AIAgentSettings schema has been consistently integrated into all relevant request bodies (CreateAgentBody, UpdateAgentBody, CreateChatBody, UpdateChatBody), maintaining a uniform approach to agent configuration.

Also applies to: 10647-10650, 7294-7297, 10727-10730