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

chore: add deprecation notice to DataStore exported Schemaa type #13321

Merged
merged 4 commits into from
May 1, 2024

Conversation

svidgen
Copy link
Member

@svidgen svidgen commented Apr 30, 2024

Description of changes

Adds deprecation flag and docstring to the Schema type exported from DataStore. Customers should not be using this type directly. And, it shows up in autocompletion when customers are looking for the Schema type exported from gen2 API's, which can lead to some confusion.

Issue #, if available

Description of how you validated changes

The primary concern is whether any lint rules might prohibit an app from using a deprecated type. To alleviate that concern:

  1. Ran e2e's in a tagged release to confirm no failed builds.
  2. Manually created a nextjs app with default eslint rules and built. (No errors or warnings emitted.)

Checklist

  • PR description included
  • yarn test passes
  • Tests are changed or added
  • Relevant documentation is changed or added (and PR referenced)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@svidgen svidgen requested a review from a team as a code owner April 30, 2024 22:02
@svidgen svidgen merged commit d218d81 into aws-amplify:main May 1, 2024
30 checks passed
@svidgen svidgen deleted the deprecate-public-schema-type branch May 1, 2024 14:25
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.

3 participants