feat:Add fileUids property to ChatBody schema in OpenAPI spec

[HavenDV]

Summary by CodeRabbit

• New Features
  • Enhanced chat functionality allowing users to include multiple file references alongside their messages.

[coderabbitai]

Walkthrough

The pull request updates the OpenAPI specification by adding a new property, fileUids, to the ChatBody schema. This property is defined as an array of strings and is introduced alongside the existing message property. The change allows multiple file identifiers to be associated with a chat message, enhancing the chat request structure without affecting previous functionality. This update is isolated to the OpenAPI YAML file within the project.

Changes

File	Change Summary
src/libs/.../openapi.yaml	Added fileUids (array of string) to the ChatBody schema to support multiple file identifiers.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant S as Chat Server
    C->>S: Send Chat Request (message, fileUids)
    S->>S: Process message and file identifiers
    S-->>C: Return Chat Response

Loading

Suggested reviewers

• github-actions

Poem

I'm a coding rabbit with a skip and a hop,
New fileUids in a chat make our API pop.
Strings in an array, neat and fine,
Hop along the code line by line.
With whiskers twitching at each new byte,
I celebrate these changes in pure delight!
🐇✨

---

📜 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 f3ae247 and 3966395.

⛔ Files ignored due to path filters (4)

• src/libs/Instill/Generated/Instill.AgentClient.AgentPublicServiceChat.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IAgentClient.AgentPublicServiceChat.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.AgentPublicServiceChatBody.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 (1 hunks)

🔇 Additional comments (1)

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

6492-6496: Well-defined enhancement to ChatBody schema

The addition of the fileUids property to the AgentPublicService.ChatBody schema is well-structured and adds useful functionality. This array property allows clients to associate multiple file identifiers with a chat message, enhancing the chat request capabilities.

The change is backward compatible since fileUids is not marked as required, which means existing clients that don't include this property will continue to function as before.

---

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.