feat:Update OpenAPI Specification for Instill API to v0.42.0-beta

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced new endpoints for user and organization subscription management.
  • Added functionality to retrieve detailed user membership and subscription information.

• Improvements

  • Enhanced existing endpoints to provide more detailed responses and clarify request requirements.
  • Updated response schemas to include additional fields and pagination details for better data handling.

[coderabbitai]

Walkthrough

The changes involve an update to the OpenAPI specification for the Instill API, transitioning from version v0.41.0-beta to v0.42.0-beta. This update introduces new endpoints for user and organization management, modifies existing endpoints to enhance functionality, and updates response schemas to include additional fields and refine definitions. Notable additions include endpoints for retrieving subscription details, while modifications improve the clarity of request and response structures.

Changes

Files	Change Summary
src/libs/Instill/openapi.yaml	Version updated to v0.42.0-beta, added endpoints for user and organization subscriptions, modified existing endpoints for memberships and user updates, and updated response schemas for GetAuthenticatedUserResponse and ListUsersResponse.

Poem

In the meadow, changes bloom,
New paths for users, dispelling gloom.
With subscriptions clear and bright,
Our API shines, a guiding light.
Hop along, let’s celebrate,
Version updates, oh, how great! 🐇✨

---

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

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

Line range hint 1020-1048: New subscription endpoints added

Two new endpoints have been added for retrieving subscription details:

1. GET /v1beta/user/subscription
2. GET /v1beta/organizations/{organizationId}/subscription

These endpoints are well-structured and consistent with the existing API design. They both return appropriate response schemas and include proper authentication checks.

Suggestion for improvement:
Consider adding a description field to the OrganizationSubscription and UserSubscription schemas to provide more context about the subscription details.

---

Line range hint 217-258: Improved PATCH user endpoint

The PATCH /v1beta/users/{userId} endpoint has been updated to clarify the request body requirements. The changes include a more detailed description of the update process and the fields that can be modified.

Suggestion for improvement:
Consider adding an example request body to further clarify the expected input for this endpoint.

---

Line range hint 1-3700: Overall API specification review

The changes to the OpenAPI specification are well-implemented and consistent with the existing structure. The new endpoints and schema updates enhance the API's functionality and clarity. However, there are a few suggestions for further improvement:

1. Add example request and response bodies for new endpoints, especially for the subscription-related endpoints.
2. Ensure all schemas and endpoints have consistent and detailed descriptions.
3. Consider adding a deprecated field to mark any endpoints or schemas that may be phased out in future versions.
4. Review the use of required fields across all schemas to ensure they accurately reflect the API's expectations.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 590e3e2 and aaad1ce.

📒 Files selected for processing (1)

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

🧰 Additional context used

🔇 Additional comments (4)

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

12-12: Version update confirmed

The API version has been correctly updated from v0.41.0-beta to v0.42.0-beta. This change is consistent with the summary provided.

---

Line range hint 291-316: Enhanced user memberships endpoint

The GET /v1beta/users/{userId}/memberships endpoint has been updated to provide a more detailed response structure for user memberships. The changes improve the clarity and usefulness of the endpoint.

---

Line range hint 2037-2043: Enhanced GetAuthenticatedUserResponse schema

The GetAuthenticatedUserResponse schema has been updated to include more detailed user information. This change improves the API's ability to provide comprehensive user data.

---

Line range hint 2188-2203: Improved ListUsersResponse schema

The ListUsersResponse schema has been enhanced to provide pagination details. This improvement allows for better handling of large result sets and is consistent with best practices for API design.