Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(storage): Update list api documentation to add pagination examples #5397

Merged
merged 4 commits into from
Apr 26, 2023

Conversation

sdhuka
Copy link
Contributor

@sdhuka sdhuka commented Apr 18, 2023

Description of changes:

  • Remove example for deprecated list API
  • Add examples with StoragePagedListOptions

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)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

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

  • JS
  • iOS
  • Android
  • Flutter
  • React Native

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://link.com)
    HTML: <a href="https://link.com">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.

@aws-amplify-us-west-2
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-5397.d39agkzf0cwtdz.amplifyapp.com

@sdhuka sdhuka requested a review from a team April 19, 2023 15:24
@katiegoines katiegoines added product-owner-review-needed Current step in the approval process requires a PM review technical-review-needed labels Apr 19, 2023
src/fragments/lib/storage/android/list.mdx Outdated Show resolved Hide resolved
{ result ->
result.items.forEach { item ->
Log.i("MyAmplifyApp", "Item: ${item.key}")
}
Log.i("MyAmplifyApp", "Next Token: ${result.nextToken}");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Log.i("MyAmplifyApp", "Next Token: ${result.nextToken}");
Log.i("MyAmplifyApp", "Next Token: ${result.nextToken}")

src/fragments/lib/storage/android/list.mdx Outdated Show resolved Hide resolved
src/fragments/lib/storage/android/list.mdx Outdated Show resolved Hide resolved
src/fragments/lib/storage/android/list.mdx Outdated Show resolved Hide resolved
src/fragments/lib/storage/android/list.mdx Outdated Show resolved Hide resolved
src/fragments/lib/storage/android/list.mdx Outdated Show resolved Hide resolved
src/fragments/lib/storage/android/list.mdx Outdated Show resolved Hide resolved
@sdhuka sdhuka requested a review from dengdan154 April 20, 2023 13:39
@mergify mergify bot added the deleted-assets Indicate that a PR has changes with deleted assets label Apr 20, 2023
@mergify mergify bot added the redirects-needed Redirects need to be created for deleted pages label Apr 20, 2023
@mergify

This comment was marked as outdated.

@sdhuka
Copy link
Contributor Author

sdhuka commented Apr 20, 2023

@sdhuka, since a file was deleted from the src/pages and/or src/fragments directories, redirects might need to be set up so these previous pages do not 404. If redirects are needed, please answer these questions for each redirect that is needed:

  • What is the source address of the redirect? (Where are you trying to redirect from?)
  • What is the target address of the redirect? (Where are you trying to redirect to?)
  • Type of redirect? 301 - permanent redirect or 302 - temporary redirect? (More info on Amplify Hosting redirects here: https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html)

@timngyn @katiegoines No files are deleted in this PR, not sure why this bot picked it up?

@timngyn
Copy link
Member

timngyn commented Apr 20, 2023

@sdhuka, you're right. Sorry about that! There is an issue with this workflow at the moment and it's on our backlog. Feel free to ignore it and let us know if you have any questions

@katiegoines katiegoines removed technical-review-needed redirects-needed Redirects need to be created for deleted pages deleted-assets Indicate that a PR has changes with deleted assets labels Apr 20, 2023
@mergify mergify bot added redirects-needed Redirects need to be created for deleted pages deleted-assets Indicate that a PR has changes with deleted assets labels Apr 20, 2023
@mergify
Copy link

mergify bot commented Apr 20, 2023

@sdhuka, since a file was deleted from the src/pages and/or src/fragments directories, redirects might need to be set up so these previous pages do not 404. If redirects are needed, please answer these questions for each redirect that is needed:

  • What is the source address of the redirect? (Where are you trying to redirect from?)

  • What is the target address of the redirect? (Where are you trying to redirect to?)

  • Type of redirect? 301 - permanent redirect or 302 - temporary redirect? (More info on Amplify Hosting redirects here: https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html)

@katiegoines katiegoines removed redirects-needed Redirects need to be created for deleted pages deleted-assets Indicate that a PR has changes with deleted assets labels Apr 25, 2023
@katiegoines katiegoines removed the product-owner-review-needed Current step in the approval process requires a PM review label Apr 26, 2023
@katiegoines katiegoines merged commit f79b0c5 into main Apr 26, 2023
@katiegoines katiegoines deleted the sdhuka/list-api branch April 26, 2023 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants