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

Update custom operations documentation with supported argument examples #8260

Merged
merged 4 commits into from
Feb 25, 2025

Conversation

vaisshnavi7
Copy link
Contributor

@vaisshnavi7 vaisshnavi7 commented Feb 18, 2025

Description of changes:

Updated the custom operations documentation to include examples of supported argument types. This update aligns with the recent feature addition in PR #497.

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.

@vaisshnavi7 vaisshnavi7 changed the title Update custom operations documentation with newly supported examples Update custom operations documentation with supported argument examples Feb 20, 2025
values: ['ACCEPTED', 'REJECTED']
}),

echo: a
Copy link
Contributor

Choose a reason for hiding this comment

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

nit -- can we use a different operation name to differentiate it from the example used in Step 1-3 on this page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure! I will use a different name

Comment on lines 522 to 523
- **Custom Types**: Define inline `customType`.
- **Reference Types**: Use `a.ref()` to reference enums and custom types.
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
- **Custom Types**: Define inline `customType`.
- **Reference Types**: Use `a.ref()` to reference enums and custom types.
- **Custom Types**: Define inline `customType`
- **Reference Types**: Use `a.ref()` to reference enums and custom types

nit, we can omit the periods in unordered lists when we are not writing complete sentences or paragraphs

@vaisshnavi7 vaisshnavi7 marked this pull request as ready for review February 24, 2025 22:56
josefaidt
josefaidt previously approved these changes Feb 24, 2025
Copy link
Member

@atierian atierian left a comment

Choose a reason for hiding this comment

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

One minor syntax issue with the enum definition. Otherwise LGTM.

@vaisshnavi7 vaisshnavi7 merged commit b751317 into main Feb 25, 2025
12 checks passed
@vaisshnavi7 vaisshnavi7 deleted the update/custom-operations-support branch February 25, 2025 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants