Skip to content

Ensure API category is added before pushing to Amplify#3009

Closed
Kilo-Loco wants to merge 1 commit intoaws-amplify:mainfrom
Kilo-Loco:ios-getting-started/ensure-api-category
Closed

Ensure API category is added before pushing to Amplify#3009
Kilo-Loco wants to merge 1 commit intoaws-amplify:mainfrom
Kilo-Loco:ios-getting-started/ensure-api-category

Conversation

@Kilo-Loco
Copy link
Copy Markdown
Contributor

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:
Screen Shot 2021-03-03 at 9 40 27 AM

After:
Screen Shot 2021-03-03 at 9 40 09 AM

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

@Kilo-Loco Kilo-Loco requested a review from a team March 3, 2021 17:52
@Kilo-Loco Kilo-Loco added getting-started Issues with any of the Getting Started guides. amplify/ios Mostly related to iOS software. labels Mar 3, 2021

<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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor

@drochetti drochetti left a comment

Choose a reason for hiding this comment

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

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

@Kilo-Loco
Copy link
Copy Markdown
Contributor Author

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:

Note: If the summary doesn't contain the API category, you will need to cancel this push process and add the API category before continuing.

@tjleing tjleing changed the base branch from master to main April 15, 2021 14:52
@siegerts
Copy link
Copy Markdown
Contributor

siegerts commented Nov 5, 2021

Closing for now after sync with @Kilo-Loco.

@siegerts siegerts closed this Nov 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

amplify/ios Mostly related to iOS software. getting-started Issues with any of the Getting Started guides.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants