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(amplify-data): enhance discussion of split schema files #8228

Merged
merged 2 commits into from
Jan 31, 2025

Conversation

palpatim
Copy link
Member

Description of changes:

Builds on #8221 and enhances the discussion of split schema files, especially with respect to directive support on fields of extended types.

image

  • Added file title to schema code snippets
  • Added field and directive examples to schema code snippets
  • Consolidated info callouts about file order and duplicate names
  • Added detail to unsupported use cases of the extend keyword
  • Removed link to issue

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.

@palpatim palpatim requested a review from josefaidt as a code owner January 30, 2025 19:57
dzhan-aws
dzhan-aws previously approved these changes Jan 30, 2025
sundersc
sundersc previously approved these changes Jan 30, 2025

For the latest updates and potential future enhancements, please track the ongoing discussion in [GitHub Issue #3036](https://github.com/aws-amplify/amplify-category-api/issues/3036).
<Callout info>
Amplify directives are not supported on extended type definitions themselves (e.g., `extend type Todo @auth...`), or on fields of types other than `Query`, `Mutation`, and `Subscription`.
Copy link
Contributor

@josefaidt josefaidt Jan 30, 2025

Choose a reason for hiding this comment

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

the latter part of the callout reads a bit odd to me but it may just be me 😅

or on fields of types other than Query, Mutation, and Subscription

is this referring to fields in non-model types?

Copy link
Member Author

Choose a reason for hiding this comment

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

Both model and non-model types are not supported. I agree the syntax is a bit convoluted -- can you suggest clearer wording?

Copy link
Contributor

Choose a reason for hiding this comment

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

is it accurate to say "or on fields of extended types other than..."?

Copy link
Member Author

@palpatim palpatim Jan 31, 2025

Choose a reason for hiding this comment

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

Yes, it is more accurate. I'm not sure it's any clearer, but would this work?

Amplify directives are not supported on extended type definitions themselves (e.g., extend type Todo @auth...), or on fields of extended types other than Query, Mutation, and Subscription.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes that works! When I read it initially I thought of model types despite the preceding context

@palpatim palpatim dismissed stale reviews from sundersc and dzhan-aws via e71c1c2 January 31, 2025 18:40
@josefaidt josefaidt enabled auto-merge (squash) January 31, 2025 19:13
@josefaidt josefaidt merged commit 23e4186 into main Jan 31, 2025
11 of 12 checks passed
@josefaidt josefaidt deleted the palpatim.feat.split-schema-files branch January 31, 2025 19:18
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