chore: Marking Storage's key-based API as deprecated in the Category implementation. #3863
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3863 +/- ##
==========================================
- Coverage 68.50% 68.43% -0.08%
==========================================
Files 1082 1082
Lines 37699 37699
==========================================
- Hits 25827 25799 -28
- Misses 11872 11900 +28
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
5d
approved these changes
Sep 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue #
Description
When we introduced the new
path: StoragePathparameters for the Storage APIs, we deprecated the old ones usingkey: String. However, we only did so in the category protocol and not in the category implementation itself, which results in the warning not being propagated to the users becauseAmplify.Storageis not typed to the protocol, but rather to the actual implementation.So in order to discourage the usage of these APIs and raise awareness of the new ones, I'm adding the deprecation annotations to the category as well.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.