feat:Add new endpoints and enhance existing ones in Instill AI API OpenAPI spec

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced multiple new endpoints for managing pipelines and connections, including creating, updating, and deleting pipeline releases.
  • Added functionality for triggering pipelines both synchronously and asynchronously.
  • Enhanced API responses with richer metadata for operations related to pipelines, models, and user memberships.

• Documentation

  • Improved documentation with clearer descriptions and examples, especially for complex operations.

[coderabbitai]

Walkthrough

The changes to the OpenAPI specification for the Instill AI API include the addition of multiple new endpoints for managing pipelines, models, and user interactions. Enhancements have been made to existing endpoints, improving functionality and clarity. New operations for managing pipeline releases, such as creating, updating, and deleting releases, have been introduced. The request and response schemas have been updated with additional properties, and error handling has been standardized across endpoints. Documentation improvements provide clearer descriptions and examples, particularly for complex operations.

Changes

File Path

Change Summary

src/libs/Instill/openapi.yaml

- Added new endpoints for managing pipeline releases, including listing, creating, retrieving, updating, and deleting releases. - Introduced endpoints for triggering pipeline releases synchronously and asynchronously. - Added endpoints for managing connections, including listing, creating, retrieving, updating, and deleting connections, along with testing connections. - Introduced endpoints for listing and retrieving integrations. - Updated request and response schemas with new properties and standardized error handling across endpoints.

Poem

In the garden of code where the pipelines flow,
New paths are sprouting, watch them grow! 🌱
With releases and triggers, all set to play,
Connections and integrations brighten the day.
Hops of joy for the changes we see,
In the world of Instill, how grand it will be! 🐇✨

---

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

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

Line range hint 14-16: Consider removing HTTP server in production

Having an HTTP endpoint in production could expose sensitive data in transit. Consider enforcing HTTPS-only in production environments.

Apply this diff to remove the HTTP server:

servers:
  - url: https://api.instill.tech
-  - url: http://api.instill.tech

---

Line range hint 1-3: Consider adding rate limiting headers

While the API is well-structured, consider adding rate limiting headers (X-RateLimit-*) to help clients properly handle API quotas and throttling.

Some recommended headers to add:

• X-RateLimit-Limit: Maximum requests per time window
• X-RateLimit-Remaining: Remaining requests in current window
• X-RateLimit-Reset: Time when the rate limit resets

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f4ca74e and 9be678c.

⛔ Files ignored due to path filters (3)

• src/libs/Instill/Generated/Instill.Models.EventSpecification.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.EventSpecificationConfigSchema.Json.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.EventSpecificationConfigSchema.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

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

6859-6869: LGTM: Security scheme implementation follows best practices

The Bearer token authentication is well-documented with clear examples and follows standard practices.

---

6859-6869: LGTM: Well-structured event specification schema

The EventSpecification schema provides a clear separation between configuration and message formats, with proper documentation support through examples.