feat:Update OpenAPI Specification for Instill API User and Organization Endpoints

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced new endpoints for managing object upload/download URLs and catalog operations.
  • Added UpdateObjectResponse schema for enhanced response structure.

• Improvements

  • Updated parameter requirements for better clarity and usability.
  • Enhanced response schemas with additional properties for detailed information.
  • Standardized error response descriptions for consistency.

• Documentation

  • Improved overall API documentation for better understanding and usage guidance.

[coderabbitai]

Walkthrough

The pull request introduces significant changes to the OpenAPI specification for the Instill API, focusing on user and organization endpoints. Key modifications include the addition of new endpoints for object management, updates to existing endpoint descriptions, and changes to parameter requirements. Notably, the objectUid parameter has been made required for a specific endpoint, and response schemas have been enhanced with new properties and clearer descriptions. Additionally, error handling descriptions have been standardized, and overall documentation has been improved for better clarity.

Changes

File	Change Summary
src/libs/Instill/openapi.yaml	- Added new endpoints for object upload/download and catalog operations.
	- Introduced UpdateObjectResponse schema in components/schemas.
	- Updated objectUid parameter to required in /v1alpha/namespaces/{namespaceId}/object-download-url.
	- Enhanced GetObjectDownloadURLResponse with downloadUrl and urlExpireAt properties.
	- Standardized error response descriptions across multiple endpoints.
	- Improved overall documentation for clarity and structure.

Poem

🐇 In the meadow where APIs play,
New paths have opened, hip-hip-hooray!
With clearer docs and endpoints bright,
We hop along, our future's light.
So gather 'round, dear friends and cheer,
For Instill's changes bring us near! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 196f9f8 and be47f3f.

⛔ Files ignored due to path filters (4)

• src/libs/Instill/Generated/Instill.IObjectClient.GetObjectDownloadURL.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.UpdateObjectResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.ObjectClient.GetObjectDownloadURL.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 (2 hunks)

🔇 Additional comments (2)

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

1815-1816: LGTM! Parameter documentation improvements

The changes enhance the API specification by:

• Making the objectUid parameter explicitly required
• Adding clear parameter descriptions
• Using consistent lowercase formatting in descriptions

Also applies to: 1821-1821

---

3721-3728: LGTM! Well-structured response schema

The new UpdateObjectResponse schema follows OpenAPI best practices and maintains consistency with other response schemas in the API.

---

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.