fix: add customMetadata support to Folder interface in listFiles response #131
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull request overview
This PR adds support for customMetadata in the Folder interface to fix an inconsistency where the ImageKit API returns custom metadata for folders, but the TypeScript interface didn't reflect this capability.
Changes:
- Added optional
customMetadatafield to theFolderinterface with the same type signature as theFileinterface
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes the issue where
listFilesAPI was not returningcustomMetadatafor folders, even though the ImageKit web UI allows users to set custom metadata on folders.Changes
customMetadata?: { [key: string]: unknown }field to theFolderinterfaceFileinterface which already had this fieldlistFilesresponsesIssue
The
listFilesoperation correctly returnedcustomMetadatafor files but not for folders. This was an oversight in the interface definition.Testing
The change is a type definition update that allows folders to properly expose their custom metadata in API responses. No breaking changes.
Fixes : #115