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

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced new API endpoints for managing agents, apps, conversations, and pipelines, including CRUD operations.
  • Added endpoints for listing and managing catalog files and connections.
  • Enhanced API documentation with clearer descriptions and examples for each endpoint.

• Bug Fixes

  • Updated schema definitions to include new properties and metadata fields for agents, apps, and pipelines.

[coderabbitai]

Walkthrough

The changes encompass a substantial update to the OpenAPI specification for the Instill AI API, introducing numerous new endpoints and modifying existing ones. This includes the addition of CRUD operations for agents, apps, conversations, and pipelines, as well as endpoints for managing connections and pipeline releases. The schema definitions have been updated to reflect these changes, with new properties added and documentation enhanced for clarity on request and response formats.

Changes

File Path	Change Summary
src/libs/Instill/openapi.yaml	Added multiple new endpoints for managing agents, apps, conversations, pipelines, and connections, including CRUD operations and additional metadata fields in schema definitions. Enhanced documentation for clarity on endpoint usage.

Poem

In the land of code where rabbits play,
New paths are added, hip-hip-hooray!
Agents and apps, they hop and thrive,
With pipelines and connections, we come alive!
So let’s celebrate this API delight,
With joyful bounces, we take flight! 🐇✨

---

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 generate docstrings to generate docstrings for this PR. (Experiment)
• @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 (2)

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

Line range hint 15-17: Consider adding environment-specific servers

While the current server definitions are good, consider adding environment-specific servers (e.g., staging, development) to facilitate testing and development.

servers:
  - url: https://api.instill.tech
    description: Production
  - url: https://staging-api.instill.tech 
    description: Staging
  - url: http://api.instill.tech
    description: Development

---

Line range hint 18-3163: Consider adding rate limiting headers

While the API specification is comprehensive, consider documenting rate limiting headers and quotas to help API consumers better understand usage limits.

Add standard rate limit headers to responses:

headers:
  X-RateLimit-Limit:
    description: Request limit per hour
    schema:
      type: integer
  X-RateLimit-Remaining:
    description: Remaining requests for the hour
    schema:
      type: integer
  X-RateLimit-Reset:
    description: Time at which the rate limit resets
    schema:
      type: string
      format: date-time

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 378f7bc and 452417b.

📒 Files selected for processing (1)

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

🔇 Additional comments (3)

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

Line range hint 1-14: LGTM! Well-structured API information section

The API information section follows OpenAPI best practices with proper versioning, licensing, and contact information.

---

Line range hint 3164-3171: LGTM! Proper security scheme implementation

The security scheme is well-defined using Bearer token authentication with clear documentation and examples.

---

Line range hint 3172-3179: LGTM! Well-organized API documentation

The API is well-organized with:

• Clear tag groupings
• Comprehensive external documentation links
• Consistent naming conventions