Skip to content

chore(function): fix code snippet at set-up-function page #8046

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

Merged
merged 2 commits into from
Mar 25, 2025

Conversation

tttol
Copy link
Contributor

@tttol tttol commented Oct 19, 2024

Description of changes:

When setting up the Lambda function by referring to the “Set up a Function” page, the following error occurred while executing the npx ampx sandbox command.

[Sandbox] Detected file changes while previous deployment was in progress. Invoking 'sandbox' again
File written: amplify_outputs.json
Custom operation sayHello requires both an authorization rule and a handler reference
Caused By: Custom operation sayHello requires both an authorization rule and a handler reference

Resolution: Check your data schema definition for syntax and type errors.

[Sandbox] Watching for file changes...

Page URL: https://docs.amplify.aws/nextjs/build-a-backend/functions/set-up-function/

By adding.authorization(allow => [allow.guest()]) to data/resource.ts, the error was resolved.

  sayHello: a
    .query()
    .arguments({
      name: a.string(),
    })
    .returns(a.string())
    .authorization(allow => [allow.guest()] // Add this line
    .handler(a.handler.function(sayHello)),

I think that the code snippet in the documentation should
be modified, so I created a this PR. If there are any issues with my implementation process and it’s possible to resolve the problem without the line .authorization(allow => [allow.guest()]), could you suggest an alternative solution? I might be saying something incorrect because I’m new to AWS Amplify.

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
  • Swift
  • 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://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.

@tttol tttol requested a review from a team as a code owner October 19, 2024 23:31
@tttol tttol changed the title Fix code at set-up-function page Fix code snippet at set-up-function page Oct 19, 2024
@tttol
Copy link
Contributor Author

tttol commented Oct 31, 2024

@reesscot @swaminator @josefaidt
Could you review this PR? I saw that other users on Discord have also raised the same question, so I think this is a topic of interest for many Amplify users.

@josefaidt josefaidt self-requested a review October 31, 2024 00:58
@tttol tttol changed the title Fix code snippet at set-up-function page chore(function): fix code snippet at set-up-function page Mar 25, 2025
@tttol
Copy link
Contributor Author

tttol commented Mar 25, 2025

@ykethan @josefaidt
Thank you for approving!
I have a question — how are GitHub Actions checks triggered? Is there anything I need to do to start them?

@ykethan ykethan added the run-tests Label to run tests on PRs from a fork label Mar 25, 2025
@ykethan ykethan enabled auto-merge (squash) March 25, 2025 21:28
@ykethan ykethan merged commit 31f754f into aws-amplify:main Mar 25, 2025
12 checks passed
stocaaro pushed a commit that referenced this pull request Mar 26, 2025
* chore(function): fix code snippet at set-up-function page (#8046)

* Add `.authorization(allow => [allow.guest()])`

* chore: Update amplify-js API references

---------

Co-authored-by: Takahashi <[email protected]>
Co-authored-by: aws-amplify-bot <[email protected]>
ashika112 added a commit that referenced this pull request Apr 10, 2025
* chore: amplify-js api references update (#8299)

* chore(function): fix code snippet at set-up-function page (#8046)

* Add `.authorization(allow => [allow.guest()])`

* chore: Update amplify-js API references

---------

Co-authored-by: Takahashi <[email protected]>
Co-authored-by: aws-amplify-bot <[email protected]>

* chore: amplify-js api references update (#8316)

* chore: add decode cookie value strings note to SSR example (#8300)

* chore: fix broken maplibre links (#8301)

* chore: update secrets path ref (#8298)

* chore: add callout about committing amplify config files for expo eas build (#8274)

* chore: add callout about committing amplify config files for expo eas build

* chore: expand the callout for not push amplify_outputs to remote repo

* chore(deps): bump actions/upload-artifact from 4.6.0 to 4.6.2 (#8307)

Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 4.6.0 to 4.6.2.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@65c4c4a...ea165f8)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump actions/setup-node from 4.2.0 to 4.3.0 (#8306)

Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4.2.0 to 4.3.0.
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](actions/setup-node@1d0ff46...cdca736)

---
updated-dependencies:
- dependency-name: actions/setup-node
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: add retry strategy for api-rest category (#8295)

* fix: Remove reference to using default with enum (#8311)

* fix(storage): update instructions for adding external S3 buckets to Amplify (#8289)

* fix(storage): update instructions for adding/integrating with external S3 buckets

* rewrite examples, add user identity ID config, add examples for configuring storage without Amplify backend

* address feedback, align some wording

* reorder guest and auth'd user examples, update backend code examples to use CDK bucket construct

* address feedback

* update callout for adding existing bucket and amplify storage together, revert callout on owners example section

* adjust headings, add heading before examples for better linking

* chore: bump next version (#8313)

* chore(deps): bump aws-actions/configure-aws-credentials (#8276)

Bumps [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials) from 4.0.3 to 4.1.0.
- [Release notes](https://github.com/aws-actions/configure-aws-credentials/releases)
- [Changelog](https://github.com/aws-actions/configure-aws-credentials/blob/main/CHANGELOG.md)
- [Commits](aws-actions/configure-aws-credentials@4fc4975...ececac1)

---
updated-dependencies:
- dependency-name: aws-actions/configure-aws-credentials
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump aws-actions/aws-secretsmanager-get-secrets (#8278)

Bumps [aws-actions/aws-secretsmanager-get-secrets](https://github.com/aws-actions/aws-secretsmanager-get-secrets) from 2.0.7 to 2.0.8.
- [Release notes](https://github.com/aws-actions/aws-secretsmanager-get-secrets/releases)
- [Commits](aws-actions/aws-secretsmanager-get-secrets@1d6311a...fbd65ea)

---
updated-dependencies:
- dependency-name: aws-actions/aws-secretsmanager-get-secrets
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: update custom message with admincreateuser specifics (#8314)

* chore: Update amplify-js API references

* commit to trigger workflow

* add pre-prod/main to workflows

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Hui Zhao <[email protected]>
Co-authored-by: Tiffany Yeung <[email protected]>
Co-authored-by: Jay Raval <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: aadimch <[email protected]>
Co-authored-by: Aaron S. <[email protected]>
Co-authored-by: James Jarvis <[email protected]>
Co-authored-by: aws-amplify-bot <[email protected]>
Co-authored-by: ashika112 <[email protected]>

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: aws-amplify-ops <[email protected]>
Co-authored-by: Takahashi <[email protected]>
Co-authored-by: aws-amplify-bot <[email protected]>
Co-authored-by: Hui Zhao <[email protected]>
Co-authored-by: Tiffany Yeung <[email protected]>
Co-authored-by: Jay Raval <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: aadimch <[email protected]>
Co-authored-by: Aaron S. <[email protected]>
Co-authored-by: James Jarvis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
run-tests Label to run tests on PRs from a fork
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants