feat:Add GET endpoints for object upload and download to Instill API

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced new API endpoints for uploading and downloading objects.
    • Get Object Upload URL: Retrieve a URL for object uploads.
    • Get Object Download URL: Retrieve a URL for object downloads.
  • Added structured response schemas for both upload and download operations, enhancing clarity and usability.

These enhancements improve the overall functionality of the API, making it easier for users to manage object uploads and downloads.

[coderabbitai]

Walkthrough

The changes introduce two new GET endpoints to the Instill API's OpenAPI specification, allowing clients to upload and download objects. The new endpoints, /object-upload-url and /object-download-url, require specific parameters and return URLs with expiration details. Additionally, new response schemas for these endpoints are defined, along with a new schema for representing objects, which includes various properties related to the objects in the namespace.

Changes

File Path	Change Summary
src/libs/Instill/openapi.yaml	- Added new endpoint: GET /v1alpha/namespaces/{namespaceId}/object-upload-url
	- Added new endpoint: GET /v1alpha/namespaces/{namespaceId}/object-download-url
	- Introduced new response schema: GetObjectUploadURLResponse
	- Introduced new response schema: GetObjectDownloadURLResponse
	- Added new schema: Object with properties such as uid, name, size, etc.

Poem

In the fields where data flows,
New paths for uploads now arose.
With URLs to share and save,
Our objects dance, so bold and brave!
Hopping high with joy, we say,
"Welcome, changes! Hip-hip-hooray!" 🐇✨

---

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)

1703-1757: LGTM! Well-structured endpoint for object upload URL.

The new GET endpoint for obtaining an object upload URL is well-designed and properly documented. It includes all necessary parameters and follows good API design practices.

Consider adding a brief description of the endpoint's purpose in the summary, e.g., "Get a pre-signed URL for object upload".

---

1758-1804: LGTM! Well-designed endpoint for object download URL.

The new GET endpoint for obtaining an object download URL is well-structured and properly documented. It provides flexibility by allowing either objectUid or objectName for identification.

Consider adding a brief description of the endpoint's purpose in the summary, e.g., "Get a pre-signed URL for object download".

---

3399-3439: LGTM! Comprehensive Object schema definition.

The new Object schema is well-defined and includes all necessary properties for effective object management. It covers metadata, lifecycle information, and uses appropriate data types for each field.

Consider adding a brief description for the Object schema itself, explaining its purpose and usage within the API.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 47a22d8 and 9977d8b.

⛔ Files ignored due to path filters (14)

• src/libs/Instill/Generated/Instill.IInstillClient.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IObjectClient.GetObjectDownloadURL.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IObjectClient.GetObjectUploadURL.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.IObjectClient.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.InstillClient.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.GetObjectDownloadURLResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.GetObjectDownloadURLResponse2.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.GetObjectUploadURLResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.GetObjectUploadURLResponse2.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.Object.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.ObjectClient.GetObjectDownloadURL.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.ObjectClient.GetObjectUploadURL.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.ObjectClient.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 (3 hunks)

🧰 Additional context used

🔇 Additional comments (2)

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

3254-3283: LGTM! Well-defined response schemas for object upload and download URLs.

The new schemas for GetObjectUploadURLResponse and GetObjectDownloadURLResponse are well-structured and consistent. They provide all necessary information for the client, including the URL, expiration time, and object details.

The use of a separate Object schema promotes reusability and maintainability.

---

Line range hint 1703-3439: Summary: Excellent addition of object upload and download functionality.

The changes to the OpenAPI specification introduce well-designed endpoints and schemas for object upload and download URLs. These additions enhance the API's capabilities for object management while maintaining consistency with the existing design.

The new endpoints and schemas are thoroughly documented and follow best practices in API design. This update significantly improves the API's functionality for handling objects within namespaces.