feat:Update OpenAPI Specification for Instill API with Parameter Changes and Enhancements #27
Conversation
WalkthroughThe changes made to the OpenAPI specification for the Instill API involve significant updates to endpoint definitions, parameter descriptions, and schema details. Notably, the Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
src/libs/Instill/openapi.yaml (3)
1722-1736: Approve changes to GetObjectUploadURL parameters with a suggestionThe modifications to the GetObjectUploadURL operation parameters are well-considered:
- Replacing
expirationTimewithurlExpireDayssimplifies usage by specifying duration in days.- Adding
lastModifiedTimeenhances object metadata tracking.- Clarifying the
objectExpireDaysdescription improves understanding of object lifecycle management.These changes should improve API usability and provide better control over object management.
Consider adding an example value for the
urlExpireDaysparameter to further improve clarity:urlExpireDays: in: query description: "Expiration time in days for the URL. Minimum is 1 day and maximum is 7 days. If not set or set to 0, defaults to 1 day." schema: type: integer format: int32 example: 3
1781-1785: Approve change to GetObjectDownloadURL parameter with a suggestionThe replacement of
expirationTimewithurlExpireDaysin the GetObjectDownloadURL operation is consistent with the change made to the GetObjectUploadURL operation. This modification maintains API consistency and simplifies usage by specifying the expiration time in days.For consistency with the GetObjectUploadURL operation, consider adding an example value for the
urlExpireDaysparameter:urlExpireDays: in: query description: "Expiration time in days for the URL. Minimum is 1 day and maximum is 7 days. If not set or set to 0, defaults to 1 day." schema: type: integer format: int32 example: 3
Line range hint
3414-3435: Approve changes to Object schema with a suggestionThe modifications to the Object schema are beneficial:
- The updated
contentTypedescription provides clearer information on how the content type is determined.- The
objectExpireDaysdescription now explicitly states that setting it to 0 prevents automatic deletion, which improves understanding of object lifecycle management.- The addition of
lastModifiedTimeenhances object metadata tracking.These changes improve the clarity and functionality of the Object schema.
To further improve the schema, consider adding a format specifier for the
lastModifiedTimefield:lastModifiedTime: title: last modified time type: string format: date-time description: "The date and time when the object was last modified, in RFC3339 format."This change would explicitly define the expected date-time format, improving API consistency and reducing potential errors in date handling.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (5)
src/libs/Instill/Generated/Instill.IObjectClient.GetObjectDownloadURL.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.IObjectClient.GetObjectUploadURL.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.Models.Object.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.ObjectClient.GetObjectDownloadURL.g.csis excluded by!**/generated/**src/libs/Instill/Generated/Instill.ObjectClient.GetObjectUploadURL.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
- src/libs/Instill/openapi.yaml (4 hunks)
🧰 Additional context used
🔇 Additional comments (2)
src/libs/Instill/openapi.yaml (2)
1730-1736: Approve addition of lastModifiedTime to GetFileCatalogResponseMetadataThe addition of the
lastModifiedTimefield to the GetFileCatalogResponseMetadata schema is a positive change. This new field enhances the metadata information available for files in the catalog, allowing for more precise tracking of file modifications. This change is consistent with the updates made to the Object schema, maintaining consistency across the API.The inclusion of this field will improve the ability to manage and track file versions within the catalog system.
1724-1724: Approve simplification of fileUids descriptionThe simplification of the
fileUidsfield description in the ProcessCatalogFilesRequest schema is a positive change. The new description, "The file uid.", is concise and clear while still conveying the essential information. This change maintains the required nature of the field while improving the overall readability of the schema.This simplification contributes to a more streamlined and easily understandable API specification.
Summary by CodeRabbit
New Features
lastModifiedTimeparameter for enhanced tracking of object uploads.Improvements