chore: refactor data auth builder examples by HuiSF · Pull Request #7251 · aws-amplify/docs

HuiSF · 2024-04-19T01:15:46Z

Description of changes:

Update Gen2 Data examples around auth rule builders to adapt the updated interface.

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.

* Updates to Vite + React quickstart * Update src/fragments/gen2/quickstart/build-a-backend.mdx Co-authored-by: Kevin Old <kevold@amazon.com> * Update build-a-backend.mdx * Update build-a-backend.mdx * Update build-a-backend.mdx --------- Co-authored-by: Kevin Old <kevold@amazon.com>

…ion guide. (#6935)

* platform typed as optional * refactor init * remove commented code * remove angry useEffect * fix typing * added layoutcontext so mobile menu closes on navigation * move import --------- Co-authored-by: katiegoines <katiegoines@gmail.com>

…atform (#6947) Co-authored-by: Tim Nguyen <54393192+timngyn@users.noreply.github.com>

…ctive pl…" (#6955) This reverts commit 5998b22.

* chore: more layout refactoring * remove unused prop, alphabetize props

* include usage for multi-page apps * improve multi-page app docs * use Hub syntax * update imports in examples

* chore: Clean up broken Amplify JS API reference links. * Cleaned up language.

* update build image settings for Gen 2 * remove callout and add fragment to vite guide

* chore: add unit test for YoutubeEmbed component * add code coverage stats --------- Co-authored-by: katiegoines <katiegoines@gmail.com>

* chore: add unit tests for Accordion component * issue with window properties * fixed tracking test * working on animation issue * accordion tests * fix testing errors * added test for closing accordion * add code coverage stats --------- Co-authored-by: katiegoines <katiegoines@gmail.com>

* Add algolia env vars to next.config * Remove extra code string

…pe (#6989)

…; add build step to docs (#6970) * fix(data): update React Native minimum iOS deployment target; add build step to docs * address PR feedback * remove deployment target guidance * add React Native version deployment target callout * fix unrecognized syntax * replace callout with accordion * move 'upgrading' callout

* Clarify behavior of forgetDevice() API regarding device tracking This commit updates the documentation to clarify that using the forgetDevice() API results in the device being neither remembered nor tracked. Previously, the documentation suggested that forgotten devices might still be tracked, leading to confusion about the API's behavior. The revised wording aligns with the detailed description under the "Forgotten" section, ensuring consistency and eliminating ambiguity about how forgotten devices are handled. * Clarify behavior of forgetDevice() API regarding device tracking

* Support for enum value listing * Update src/pages/gen2/build-a-backend/data/data-modeling/add-fields/index.mdx

Removed 'Angular' from the app description. It is not necessarily an angular app.

* fix amplify console link * fix text from AWS Console to Amplify Console * updated alt text for Amplify console * Update src/fragments/gen2/quickstart/deploy-and-host.mdx Co-authored-by: Scott Rees <6165315+reesscot@users.noreply.github.com> * Update src/pages/gen2/deploy-and-host/fullstack-branching/branch-deployments/index.mdx Co-authored-by: Scott Rees <6165315+reesscot@users.noreply.github.com> --------- Co-authored-by: Scott Rees <6165315+reesscot@users.noreply.github.com>

* add 96x96 favicons * add favicon and apple-touch to root * updated icons --------- Co-authored-by: Jacob Logan <lognjc@amazon.com>

the v5 snippet was labeled as v6 and the v6 was labeled as v5 Co-authored-by: derrik.fleming <derrik.fleming@spindance.com>

* fix: copied code no longer includes markdown comments * minor cleanup * splite prepareCopyText to it's own export for easier testing * fix MDXCode mock

* add image example for secrets manager key/value * add documentation for creating secrets in secrets manager and configuring db details on the construct * adjust order of paragraphs, moving relevant text closer to image and make alt text more descriptive

* Added documentation on updated IAM behavior * Update src/pages/[platform]/tools/cli/migration/iam-auth-updates-for-cdk-construct/index.mdx Co-authored-by: Kamil Sobol <sobol.k.r@gmail.com> * Update src/pages/[platform]/build-a-backend/graphqlapi/customize-authorization-rules/index.mdx Co-authored-by: Kamil Sobol <sobol.k.r@gmail.com> * Update src/pages/[platform]/build-a-backend/graphqlapi/customize-authorization-rules/index.mdx * Update src/pages/[platform]/tools/cli/migration/iam-auth-updates-for-cdk-construct/index.mdx * Update src/pages/[platform]/tools/cli/migration/iam-auth-updates-for-cdk-construct/index.mdx Co-authored-by: Tim Schmelter <schmelte@amazon.com> * addressed comments * Updated to reflect changes to Gen 2 content * Update src/pages/[platform]/build-a-backend/graphqlapi/customize-authorization-rules/index.mdx --------- Co-authored-by: Kamil Sobol <sobol.k.r@gmail.com> Co-authored-by: Tim Schmelter <schmelte@amazon.com>

* edits to custom business logic * update secondary index code examples

* add client side code for public access * add client side code for signed in user access * add client side code for multi user access * add client side code for per user/owner access * add client side code for custom id & group claims * add client side code for custom access * add client side code for user pool group access * add client side code for oidc access * Update src/pages/gen2/build-a-backend/data/customize-authz/signed-in-user-data-access/index.mdx Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com> * add info callout and configuration code to public/private iam examples * move callout up * remove "**note**" from callouts --------- Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com>

* Added new relationship behavior doc * fixed typos

…e aws sdk page (#7220) * fix(predictions): fix wrong reference of swfit/android predictions use aws sdk page * fix(predictions): update Use AWS SDK description

The correct DynamoDB syntax requires semicolon in both expression and expressionValues

* updated generate-client-code section * updated graphql-client-code section * updated the description * removed workflow * Update src/pages/gen2/reference/cli-commands/index.mdx Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com> * Update src/pages/gen2/reference/cli-commands/index.mdx Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com> * added Supported GraphQL client code combinations * fixed the spell * fixed the format * fixed the syntax * Update src/pages/gen2/reference/cli-commands/index.mdx Co-authored-by: josef <josef.aidt@gmail.com> * Update src/pages/gen2/reference/cli-commands/index.mdx Co-authored-by: josef <josef.aidt@gmail.com> * Update src/pages/gen2/reference/cli-commands/index.mdx Co-authored-by: josef <josef.aidt@gmail.com> * Update src/pages/gen2/reference/cli-commands/index.mdx Co-authored-by: josef <josef.aidt@gmail.com> * updated the stack name --------- Co-authored-by: Rene Brandel <4989523+renebrandel@users.noreply.github.com> Co-authored-by: josef <josef.aidt@gmail.com>

The merge-base changed after approval.

hibler13 and others added 30 commits February 19, 2024 13:21

fix: Fix incorrect auth import path in migration guide. (#6934)

c54850c

fix: Update incorrect updateMFAPreference parameter in JS v6 migrat…

d9e1afa

…ion guide. (#6935)

Amplify Android Release 2.14.11 (#6933)

abea35b

fix: Nesting of auth cli templates (#6932)

20df399

fix: change config variable name (#6923)

d29e872

Guide to support Amplify v2 with AWS Android SDK (#6927)

2aef692

Update puppeteer (#6949)

ea39d66

Update index.mdx (#6950)

cadadb0

Update CODEOWNERS with correct PM alignment (#6951)

bcfdc8e

fix(flutter, js): scope "connect existing cdk" guide to respective pl…

5998b22

…atform (#6947) Co-authored-by: Tim Nguyen <54393192+timngyn@users.noreply.github.com>

Revert "fix(flutter, js): scope "connect existing cdk" guide to respe…

c3d5432

…ctive pl…" (#6955) This reverts commit 5998b22.

chore: remove duplicated logic between Layout and LayoutHeader (#6954)

4c8a711

* chore: more layout refactoring * remove unused prop, alphabetize props

improve oauth docs (#6961)

b5cdee5

fixed gen 2 getting started guide (#6968)

71b5756

Update redirects for deleted hidden pages (#6944)

c97a89d

Update manual installation to point to @beta tag (#6972)

0b99910

include usage for multi-page apps (#6964)

74850e5

* include usage for multi-page apps * improve multi-page app docs * use Hub syntax * update imports in examples

chore: Clean up broken Amplify JS API reference links (#6976)

7661906

* chore: Clean up broken Amplify JS API reference links. * Cleaned up language.

Update build image instructions for Gen 2 (#6978)

3647359

* update build image settings for Gen 2 * remove callout and add fragment to vite guide

chore: add unit test for YoutubeEmbed component (#6983)

fb1b8ed

* chore: add unit test for YoutubeEmbed component * add code coverage stats --------- Co-authored-by: katiegoines <katiegoines@gmail.com>

Update index.mdx (#6986)

0a7e95b

Add env variables for algolia (#6957)

f9115e5

* Add algolia env vars to next.config * Remove extra code string

fix(data): update REST API docs to document correct error response ty…

7a9d346

…pe (#6989)

Support for enum value listing (#6885)

c641e6d

* Support for enum value listing * Update src/pages/gen2/build-a-backend/data/data-modeling/add-fields/index.mdx

CDK updates v2 (#6990)

e0c58b2

josefaidt and others added 25 commits March 28, 2024 10:03

remove explicit ".js" extension from gen2 resource imports (#7134)

2f2f557

remove leading slash from storage access paths (#7116)

cbfac86

remove unnecessary "Angular" mention in auth getting started (#7139)

be0ecef

Removed 'Angular' from the app description. It is not necessarily an angular app.

Add Favicon and apple-touch icons to root (#7137)

2de018c

* add 96x96 favicons * add favicon and apple-touch to root * updated icons --------- Co-authored-by: Jacob Logan <lognjc@amazon.com>

docs(migration): fixes mislabeling notification enable snippet (#7135)

730c353

the v5 snippet was labeled as v6 and the v6 was labeled as v5 Co-authored-by: derrik.fleming <derrik.fleming@spindance.com>

edits to custom business logic (#7129)

d1b93cd

remove console.log (#7147)

7d99824

fix: copied code no longer includes markdown comments (#7146)

e5013a8

* fix: copied code no longer includes markdown comments * minor cleanup * splite prepareCopyText to it's own export for easier testing * fix MDXCode mock

chore(react-native): Add callouts for dropped Expo Go support (#7160)

61c675a

Update index.mdx (#7165)

5b229ad

Update github link to maplibre repo (#7162)

f632341

Fixed typo in amplifyconfiguration.json for predictions (#7185)

56ae61d

fix swift docs to use the .update call (#7191)

93f0e10

Update index.mdx (#7164)

c2c31d5

Added Metadata section in Storage (#7152)

ec1193a

Cbonif/edits-to-secondary-indexes-page (#7179)

9324e6f

* edits to custom business logic * update secondary index code examples

Updated Gen 2 relationship behavior (#7222)

e530196

* Added new relationship behavior doc * fixed typos

fix(predictions): fix wrong reference of swfit/android predictions us…

e7d95e9

…e aws sdk page (#7220) * fix(predictions): fix wrong reference of swfit/android predictions use aws sdk page * fix(predictions): update Use AWS SDK description

Update amplify/data/increment-like.js syntax (#7229)

0315580

The correct DynamoDB syntax requires semicolon in both expression and expressionValues

chore: refactor data auth builder examples

d206342

svidgen previously approved these changes Apr 19, 2024

View reviewed changes

HuiSF mentioned this pull request Apr 19, 2024

chore: bump data-schema packages version (0.16.0) aws-amplify/amplify-backend#1339

Closed

4 tasks

timngyn force-pushed the main branch from 310db7b to dec20d3 Compare May 3, 2024 20:38

HuiSF closed this May 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: refactor data auth builder examples#7251

chore: refactor data auth builder examples#7251
HuiSF wants to merge 122 commits intomainfrom
hui/chore/data-gen2-auth

HuiSF commented Apr 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants

Conversation

HuiSF commented Apr 19, 2024

Description of changes:

Related GitHub issue #, if available:

Instructions

Checks

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

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants