feat:Add new schemas and update OpenAPI specification for Instill AI API

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced Citation and CitationsType schemas to enhance citation handling.
  • Added a citations property to agent messages for improved context in conversations.
• Improvements
  • Updated TriggerData schema to clarify the secret property and added connectionReferences for better connection management.

[coderabbitai]

Walkthrough

The changes in this pull request introduce new schemas and updates to the OpenAPI specification for the Instill AI API. Two new schemas, Citation and CitationsType, are added, enhancing the API's functionality related to citations. The TriggerData schema is modified to clarify the secret property and to include a new connectionReferences property. Additionally, the app.v1alpha.Message schema is updated to incorporate a citations property, allowing for the inclusion of citation information in agent messages.

Changes

File	Change Summary
src/libs/Instill/openapi.yaml	- Added new schema: Citation - Added new schema: CitationsType - Updated TriggerData: added connectionReferences, updated secret description - Updated app.v1alpha.Message: added citations property

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Database

    Client->>API: Request to send message with citations
    API->>Database: Validate citations
    Database-->>API: Return validation results
    API->>Client: Send response with message status

Loading

🐇 "In the meadow, citations grow,
With secrets shared and connections flow.
Messages now with wisdom bright,
In every chat, they take their flight.
Hooray for changes, let’s all cheer,
For a brighter API, we hold dear!" 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bfc1e74 and e6bc0a9.

⛔ Files ignored due to path filters (15)

• src/libs/Instill/Generated/Instill.Models.AppV1alphaMessage.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.Citation.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.Citation.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.CitationsType.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.LookUpConnectionAdminResponse.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.LookUpConnectionAdminResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.TriggerData.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.TriggerDataConnectionReferences.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.TriggerDataConnectionReferences.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.TriggerDataSecret.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.TriggerDataVariable.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/JsonConverters.CitationsType.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/JsonConverters.CitationsTypeNullable.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/JsonSerializerContext.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 (4 hunks)

🔇 Additional comments (4)

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

6699-6723: LGTM! Well-structured Citation schema

The Citation schema is well-defined with clear field descriptions and appropriate use of readOnly flags for immutable fields.

---

6724-6729: LGTM! Well-defined CitationsType enum

The CitationsType enum is well-defined with clear values and descriptions for each type.

---

10302-10313: LGTM! Enhanced TriggerData schema with improved flexibility

The updates to TriggerData schema improve cross-namespace functionality and clarify secret override behavior. The new connectionReferences field enables better connection management across namespaces.

---

10932-10944: LGTM! Well-structured Message schema enhancements

The additions to the Message schema are well-designed with clear field purposes and appropriate readOnly flags. The schema properly integrates with the new Citation type for agent messages.

---

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.