Ensure API category is added before pushing to Amplify#3009
Ensure API category is added before pushing to Amplify#3009Kilo-Loco wants to merge 1 commit intoaws-amplify:mainfrom
Conversation
|
|
||
| <amplify-callout> | ||
|
|
||
| **Note:** If the summary doesn't contain the API category, you will need to cancel this push process and run `$ amplify add api` before continuing. |
There was a problem hiding this comment.
I have a few concerns with this, because amplify add api is not enough. The developer needs to pick specific options in order for DataStore to work (GraphQL, enable conflict resolution).
I believe the fact that someone ignored the --quickstart means we could improve the first steps, but I'm not sure this is the right fix for that.
drochetti
left a comment
There was a problem hiding this comment.
I'd like us to take the opportunity to dive deeper on the issues our tutorial has that would require that call-out.
Unfortunately amplify add api is not enough and if we go that route we need to provide more detailed instructions, like the ones here: https://docs.amplify.aws/lib/datastore/getting-started/q/platform/ios#setup-local-development-environment
This is a good point. I don't think it makes sense to list out all these steps in the event the user skipped around since this page is part of a sequence of steps. Instead, linking to the same link you provided would address both the concern of API not being an added category as well as ensuring ALL the appropriate steps and considerations are listed thoroughly. So then maybe the callout should read more along the lines of:
|
|
Closing for now after sync with @Kilo-Loco. |
Description of changes:
This PR is focused on ensuring that the API category is included in the local Amplify app before pushing to the cloud. If the customer is missing the category for any reason, they will be blocked from syncing data to the cloud.
Before:

After:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.