storage(swift): update swift storage with storage path #7142

phantumcode · 2024-03-29T17:56:53Z

Description of changes:

Update Swift Storage category with documentation with new APIs that uses StoragePath and deprecate old APIs

Related GitHub issue #, if available:

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

Which platform(s) are affected by this PR (if applicable)?

Please add the product(s)/platform(s) affected to the PR title

Checks

Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
Are any files being deleted with this PR? If so, have the needed redirects been created?
Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

ref: MDX: [link](https://docs.amplify.aws/)
HTML: <a href="https://docs.amplify.aws/">link</a>

When this PR is ready to merge, please check the box below

Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

hdworld11 · 2024-04-09T16:53:23Z

src/fragments/lib/storage/ios/download.mdx

@@ -4,6 +4,51 @@ There are three ways of getting data that was previously uploaded:

 You can download to in-memory buffer [Data](https://developer.apple.com/documentation/foundation/data) object with `Amplify.Storage.downloadData`:

+#### With StoragePath


We should add a short blurb about how this is new in the latest version and we recommend customers to use this.

I've added a callout for each of the new API. I didn't specify a specific Amplify version, as this callout can be common and used across all native platforms.

tylerjroach · 2024-04-11T20:22:44Z

src/fragments/lib/storage/ios/remove.mdx

 Delete an object uploaded to S3 by using `Amplify.Storage.remove` and specify the key:



should stop using key terminology here.

Suggestion to do:

Delete an object uploaded to S3 by using Amplify.Storage.remove. Below then shows the "with" options.

Updated per suggestion

tylerjroach · 2024-04-11T20:22:53Z

src/fragments/lib/storage/ios/remove.mdx

+<Block name="Async/Await">
+
+```swift
+let removedKey = try await Amplify.Storage.remove(path: .fromString("example/path"))


should stop using key terminology here.

key terminology removed.

tylerjroach · 2024-04-11T20:29:11Z

src/fragments/lib/storage/ios/upload.mdx

@@ -1,7 +1,59 @@
 ## Upload data
-
 To upload to S3 from a data object, specify the `key` and the `data` object to be uploaded.


Remove "key" terminology here

key terminology removed.

tylerjroach · 2024-04-11T20:32:37Z

src/fragments/lib/storage/ios/list.mdx


+This will list all public files (This behavior is deprecated):


I would just remove this line and add #### With Key (Deprecated) like used elsewhere.

Updated per suggestion.

tylerjroach · 2024-04-11T20:32:59Z

src/fragments/lib/storage/ios/list.mdx

@@ -1,7 +1,50 @@
 You can list all of the objects uploaded under a given prefix by setting the `pageSize`. If the `pageSize` is set lower than the total file size available, A single `Storage.list` call only returns a subset of all the files. To list all the files with multiple calls, the user can use the `nextToken` from the previous call response.

-This will list all public files:
+This will list all files in the path:


I would just remove this and use #### With StoragePath as you have done elsewhere.

Updated per suggestion

tylerjroach · 2024-04-11T20:36:09Z

src/fragments/lib/storage/ios/upload.mdx

@@ -59,6 +111,88 @@ let resultSink = uploadTask

 When you have a file that you want to upload, you can specify the url to the file in the `local` parameter.
 If a file with the same `key` already exists in S3, the existing S3 file will be overwritten.


key is problematic here.

Android may just use:

To upload data to S3 from a File:

I've replaced key with path

tylerjroach

getting-started/common.mdx has: "To upload to S3 from a data object, specify the key and the data object to be uploaded." This is applied to all platforms and needs to be adjusted.

It also says: "It should contain a file called ExampleKey, whose contents is Example file contents." We should maybe adjust that file name to prevent confusion.

github-actions · 2024-04-12T13:30:29Z

Amplify Docs is moving away from the use of Fragments. Please instead use InlineFilter. See our README for more information.

github-actions · 2024-04-12T13:42:07Z

Amplify Docs is moving away from the use of Fragments. Please instead use InlineFilter. See our README for more information.

hdworld11 · 2024-04-09T16:53:57Z

src/fragments/lib/storage/ios/download.mdx

+
+</BlockSwitcher>
+
+#### With Key (Deprecated)


Let's add context that this has been deprecated from the latest version and we recommend using StoragePath above instead.

There should be a callout at the top of the download page now.

hdworld11 · 2024-04-09T16:56:53Z

src/fragments/lib/storage/native_common/configureaccess/common.mdx

@@ -1,3 +1,4 @@
+#### Note: This feature is deprecated


We should provide more context on why this is deprecated and what the customer should do instead.

Added a callout warning. This is the same/consistent with the JS Gen2 Storage doc updates.

github-actions · 2024-04-12T16:02:15Z

Amplify Docs is moving away from the use of Fragments. Please instead use InlineFilter. See our README for more information.

github-actions · 2024-04-12T16:45:12Z

Amplify Docs is moving away from the use of Fragments. Please instead use InlineFilter. See our README for more information.

…orage

storage: update swift storage with storage path

c0f4838

phantumcode changed the title ~~[DRAFT] - storage(swift): update swift storage with storage path~~ [DRAFT] storage(swift): update swift storage with storage path Mar 29, 2024

phantumcode marked this pull request as ready for review April 9, 2024 16:45

phantumcode requested review from hdworld11 and a team as code owners April 9, 2024 16:45

phantumcode changed the title ~~[DRAFT] storage(swift): update swift storage with storage path~~ storage(swift): update swift storage with storage path Apr 9, 2024

hdworld11 reviewed Apr 9, 2024

View reviewed changes

tylerjroach reviewed Apr 11, 2024

View reviewed changes

tylerjroach requested changes Apr 11, 2024

View reviewed changes

phantumcode added 2 commits April 11, 2024 20:41

Merge branch 'main' into feature/swift_gen2_storage

dc6cee8

chore: update swift storage docs with storage path

a88152a

chore: update storage getting started content

12ccdc1

hdworld11 reviewed Apr 12, 2024

View reviewed changes

chore: add callout warning to file access level

b0e2526

chore: update gen2 callout

3856ec0

chore: convert fragments to inline filter

d1598db

harsh62 previously approved these changes Apr 16, 2024

View reviewed changes

hdworld11 previously approved these changes Apr 22, 2024

View reviewed changes

update storage path example

8abfd81

phantumcode dismissed stale reviews from hdworld11 and harsh62 via 8abfd81 April 22, 2024 19:30

Merge branch 'feature/gen2_native_storage' into feature/swift_gen2_st…

2d58249

…orage

phantumcode closed this Apr 22, 2024

phantumcode deleted the feature/swift_gen2_storage branch April 22, 2024 19:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

storage(swift): update swift storage with storage path #7142

storage(swift): update swift storage with storage path #7142

phantumcode commented Mar 29, 2024

hdworld11 Apr 9, 2024

phantumcode Apr 12, 2024 •

edited

Loading

tylerjroach Apr 11, 2024

tylerjroach Apr 11, 2024

phantumcode Apr 12, 2024

tylerjroach Apr 11, 2024

phantumcode Apr 12, 2024

tylerjroach Apr 11, 2024

phantumcode Apr 12, 2024

tylerjroach Apr 11, 2024

phantumcode Apr 12, 2024

tylerjroach Apr 11, 2024

phantumcode Apr 12, 2024

tylerjroach Apr 11, 2024 •

edited

Loading

phantumcode Apr 12, 2024

tylerjroach left a comment

github-actions bot commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

hdworld11 Apr 9, 2024

phantumcode Apr 12, 2024

hdworld11 Apr 9, 2024

phantumcode Apr 12, 2024

github-actions bot commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

		@@ -4,6 +4,51 @@ There are three ways of getting data that was previously uploaded:

		You can download to in-memory buffer [Data](https://developer.apple.com/documentation/foundation/data) object with `Amplify.Storage.downloadData`:

		#### With StoragePath

		Delete an object uploaded to S3 by using `Amplify.Storage.remove` and specify the key:

		@@ -1,7 +1,59 @@
		## Upload data

		To upload to S3 from a data object, specify the `key` and the `data` object to be uploaded.


		This will list all public files (This behavior is deprecated):

		@@ -59,6 +111,88 @@ let resultSink = uploadTask

		When you have a file that you want to upload, you can specify the url to the file in the `local` parameter.
		If a file with the same `key` already exists in S3, the existing S3 file will be overwritten.

storage(swift): update swift storage with storage path #7142

storage(swift): update swift storage with storage path #7142

Conversation

phantumcode commented Mar 29, 2024

Description of changes:

Related GitHub issue #, if available:

Instructions

Checks

When this PR is ready to merge, please check the box below

Choose a reason for hiding this comment

phantumcode Apr 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tylerjroach Apr 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tylerjroach left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 12, 2024

github-actions bot commented Apr 12, 2024

phantumcode Apr 12, 2024 •

edited

Loading

tylerjroach Apr 11, 2024 •

edited

Loading