feat:Update OpenAPI Specification for Instill AI API with New Endpoints and Enhancements

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced new endpoints for managing agents and tools, including the ability to list, create, update, and delete agents and tools.
• Bug Fixes
  • Updated existing endpoint descriptions for clarity and improved usability.

[coderabbitai]

Walkthrough

The changes involve significant updates to the OpenAPI specification for the Instill AI API, introducing new endpoints for agent and tool management, along with enhancements to existing endpoints. New paths allow for listing, creating, updating, and deleting agents and tools. Additionally, schema definitions have been expanded to include new components for agents, along with updates to existing schemas for improved clarity and functionality.

Changes

File Path	Change Summary
src/libs/Instill/openapi.yaml	Added new endpoints for managing agents (GET, POST, PUT, DELETE) and tools (GET, POST). Updated existing app endpoints' summaries and descriptions. Introduced new schemas for Agent, CreateAgentBody, UpdateAgentBody, CreateAgentResponse, UpdateAgentResponse, ListAgentsResponse, and ListToolsResponse. Updated App and UpdateChatBody schemas to reflect changes.

Poem

In the land of code, where rabbits play,
New agents and tools hop into the fray.
With paths that lead to manage and create,
Our API grows, oh, isn’t it great?
So let’s celebrate with a joyful cheer,
For every new feature brings us near! 🐇✨

---

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 (5)

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

387-419: Consider adding pagination parameters to ListAgents endpoint

The GET /agents endpoint should include pagination parameters (pageSize, pageToken) for better scalability when dealing with large datasets.

      parameters:
        - name: namespaceId
          in: path
          description: The app's owner(namespaces).
          required: true
          schema:
            type: string
+       - name: pageSize
+         in: query
+         description: "The maximum number of agents to return. Default is 10, maximum is 100."
+         schema:
+           type: integer
+           format: int32
+       - name: pageToken
+         in: query
+         description: "Token for pagination"
+         schema:
+           type: string

---

Line range hint 101-146: Consider adding rate limiting headers to responses

For better client integration, consider adding standard rate limiting response headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset).

---

995-1027: Consider adding filtering capabilities to ListTools endpoint

To improve usability, consider adding filter parameters to allow clients to filter tools by type, status, or other relevant criteria.

      parameters:
+       - name: filter
+         in: query
+         description: "Filter expression following AIP-160 syntax"
+         schema:
+           type: string

---

6196-6239: Consider adding validation constraints to Agent schema

The Agent schema could benefit from additional validation constraints for fields like displayName (e.g., max length, pattern).

        displayName:
          type: string
          description: The agent display name.
+         maxLength: 100
+         pattern: "^[a-zA-Z0-9-_ ]+$"

---

10122-10132: Consider adding validation for Tool configuration values

The Tool schema's config property could benefit from additional validation for the string values.

        config:
          type: object
          additionalProperties:
-           type: string
+           type: string
+           maxLength: 1000
+           minLength: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 034499e and 824ba7a.

⛔ Files ignored due to path filters (56)

• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceCreateAgent.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceDeleteAgent.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceDeleteApp.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceGetPlaygroundConversation.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceListAgents.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceListChats.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceListTools.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceRestartPlaygroundConversation.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.AppPublicServiceUpdateApp.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateChat.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.AppClient.AppPublicServiceUpdateConversation.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.AppPublicServiceDeleteAgent.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceDeleteApp.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceGetPlaygroundConversation.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceListAgents.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceListChats.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceListTools.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceRestartPlaygroundConversation.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.AppPublicServiceUpdateApp.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateChat.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAppClient.AppPublicServiceUpdateConversation.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.Agent.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.Agent.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceCreateAgentResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceCreateAgentResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceDeleteAgentResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceDeleteAgentResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceListAgentsResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceListAgentsResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceListToolsResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceListToolsResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceUpdateAgentResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AppPublicServiceUpdateAgentResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.Chat.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.CreateAgentBody.Json.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.CreateAgentResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.CreateAgentResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.DeleteAgentResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.DeleteAgentResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.ListAgentsResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.ListAgentsResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.ListToolsResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.ListToolsResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.Tool.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.ToolConfig.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.UpdateAgentBody.Json.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.UpdateAgentResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.UpdateAgentResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.UpdateChatBody.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.UpdateConversationBody.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 (15 hunks)