docs: Update API docs with codegen examples #16

yuth · 2018-10-14T19:15:47Z

Updated the GraphQL API docs to use statements generated
by the codegen. Removed the amplify codegen add command as its
no longer neeed to be added

Updated the GraphQL API docs to use statements generated by the codegen. Removed the `amplify codegen add` command as its no longer neeed to be added

undefobj · 2018-10-15T00:14:22Z

js/api.md

 ##### Type Generation using GraphQL Schemas

-When working with GraphQL data, it is useful to import your types from your schema into your code for type safety. You can easily do this with Amplify CLI's automated code generation feature. The CLI automatically downloads GraphQL Introspection Schemas from your defined GraphQL endpoint and generates TypeScript or Flow classes for you.
+When working with GraphQL data, it is useful to import your types from your schema into your code for type safety. You can easily do this with Amplify CLI's automated code generation feature. The CLI automatically downloads GraphQL Introspection Schemas from your defined GraphQL endpoint and generates TypeScript or Flow classes for you. Every time you push your GraphQL API, the cli will confirm if you want to generate the types and statements.


CLI in caps last sentence

undefobj · 2018-10-15T00:15:22Z

js/api.md


-You can declare GraphQL queries with standard GraphQL query syntax. To learn more about GraphQL queries, please visit [GraphQL Developer Documentation](http://graphql.org/learn/queries/). 
-
+Amplify cli codegen automatically generates all possible GraphQL statements (queries, mutations and subscriptions) and saves it in `src/graphql` folder.


...and for JavaScript applications saves it in src/graphql folder

undefobj

@yuth this looks good had a couple of minor comments. Also you made some changes to the connect components and used a Todo, which I like. Can you also incorporate the pending changes that I gave feedback for the Connect component on this PR: #11
@elorzafe was going to make them but perhaps you can incorporate or we can do two PRs?

yuth · 2018-10-15T21:26:59Z

@undefobj I have incorporated the feedback from #11

mlabieniec

A couple grammatical updates then LGTM

mlabieniec · 2018-10-16T15:02:41Z

js/api.md


 ```

 For mutations, a `mutation` function needs to be provided with `Connect` component. `mutation` returns a promise that resolves with the result of the GraphQL mutation.


update to:

For mutations, a mutation function needs to be provided with the Connect component. A mutation returns a promise that resolves with the result of the GraphQL mutation.

mlabieniec · 2018-10-16T15:05:19Z

js/api.md

 ##### Type Generation using GraphQL Schemas

-When working with GraphQL data, it is useful to import your types from your schema into your code for type safety. You can easily do this with Amplify CLI's automated code generation feature. The CLI automatically downloads GraphQL Introspection Schemas from your defined GraphQL endpoint and generates TypeScript or Flow classes for you.
+When working with GraphQL data, it is useful to import your types from your schema into your code for type safety. You can easily do this with Amplify CLI's automated code generation feature. The CLI automatically downloads GraphQL Introspection Schemas from your defined GraphQL endpoint and generates TypeScript or Flow classes for you. Every time you push your GraphQL API, the CLI will confirm if you want to generate the types and statements.


change to:

When working with GraphQL data it is useful to import types from your schema for type safety. You can do this with the Amplify CLI's automated code generation feature. The CLI automatically downloads GraphQL Introspection Schemas from the defined GraphQL endpoint and generates TypeScript or Flow classes for you. Every time you push your GraphQL API, the CLI will provide you the option to generate types and statements.

elorzafe

Looks good, just needs a few fixes

elorzafe · 2018-10-15T22:34:29Z

js/api.md

 // Query using a parameter
-const oneEvent = await API.graphql(graphqlOperation(GetEvent, { id: 'some id' }));
+const oneTodo = await API.graphql(graphqlOperation(queries.getTodo, { id: 'some id' }));
 console.log(oneEvent);


you need to change oneEvent to oneTodo

elorzafe · 2018-10-16T16:55:12Z

js/api.md

 };

-const newEvent = await API.graphql(graphqlOperation(CreateEvent, eventDetails));
+const newEvent = await API.graphql(graphqlOperation(mutations.createTodo, todoDetails));


Switch newEvent to newTodo also
console.log(newTodo)

elorzafe · 2018-10-16T16:58:31Z

js/api.md

+// Subscribe to creation of Todo
 const subscription = API.graphql(
-    graphqlOperation(SubscribeToEventComments, { eventId: '123' })
+    graphqlOperation(subscriptions.onCreateTodo)


Is missing the use case of sending params to the subscription I will mention that somewhere

elorzafe · 2018-10-16T17:02:44Z

js/api.md

+            <Connect query={graphqlOperation(queries.listTodos)}>
+                {({ data: { listTodos }, loading, error }) => {
+                    if (error) return (<h3>Error</h3>);
+                    if(loading || !listTodos) return (<h3>Loading...</h3>)


I would add an extra space on if (loading...

elorzafe · 2018-10-16T17:21:03Z

js/api.md

+  }
+
+  handleChange(name, ev) {
+      this.setState(name, ev.target.value);


I think that is not going to work:
I would say something like:

this.setState({ [name]: ev.target.value });

elorzafe

Cool! 👍

undefobj · 2018-10-23T21:10:05Z

Looks good to me - @elorzafe can you please confirm that we have the loading fix already deployed?

elorzafe · 2018-10-23T21:12:30Z

That is not merged yet, I was reviewing it with Manuel, we can merged and publish today

Intensify

``` E/flutter (30435): [ERROR:flutter/lib/ui/ui_dart_state.cc(177)] Unhandled Exception: type '_InternalLinkedHashMap<String, dynamic>' is not a subtype of type 'Map<String, String>' E/flutter (30435): #0 new CognitoSignUpOptions (package:amplify_auth_cognito/src/CognitoSignUp/CognitoSignUpOptions.dart:20:87) E/flutter (30435): #1 SignUpState._signUp (package:AwsAmplifySample/components/signUp.dart:29:20) E/flutter (30435): #2 SignUpState.build.<anonymous closure> (package:AwsAmplifySample/components/signUp.dart:190:35) E/flutter (30435): #3 _InkResponseState._handleTap (package:flutter/src/material/ink_well.dart:993:19) E/flutter (30435): #4 _InkResponseState.build.<anonymous closure> (package:flutter/src/material/ink_well.dart:1111:38) E/flutter (30435): #5 GestureRecognizer.invokeCallback (package:flutter/src/gestures/recognizer.dart:183:24) E/flutter (30435): #6 TapGestureRecognizer.handleTapUp (package:flutter/src/gestures/tap.dart:598:11) E/flutter (30435): #7 BaseTapGestureRecognizer._checkUp (package:flutter/src/gestures/tap.dart:287:5) E/flutter (30435): #8 BaseTapGestureRecognizer.acceptGesture (package:flutter/src/gestures/tap.dart:259:7) E/flutter (30435): #9 GestureArenaManager.sweep (package:flutter/src/gestures/arena.dart:157:27) E/flutter (30435): #10 GestureBinding.handleEvent (package:flutter/src/gestures/binding.dart:362:20) E/flutter (30435): #11 GestureBinding.dispatchEvent (package:flutter/src/gestures/binding.dart:338:22) E/flutter (30435): #12 RendererBinding.dispatchEvent (package:flutter/src/rendering/binding.dart:267:11) E/flutter (30435): #13 GestureBinding._handlePointerEvent (package:flutter/src/gestures/binding.dart:295:7) E/flutter (30435): #14 GestureBinding._flushPointerEventQueue (package:flutter/src/gestures/binding.dart:240:7) E/flutter (30435): #15 GestureBinding._handlePointerDataPacket (package:flutter/src/gestures/binding.dart:213:7) E/flutter (30435): #16 _rootRunUnary (dart:async/zone.dart:1206:13) E/flutter (30435): #17 _CustomZone.runUnary (dart:async/zone.dart:1100:19) E/flutter (30435): #18 _CustomZone.runUnaryGuarded (dart:async/zone.dart:1005:7) E/flutter (30435): #19 _invoke1 (dart:ui/hooks.dart:265:10) E/flutter (30435): #20 _dispatchPointerDataPacket (dart:ui/hooks.dart:174:5) E/flutter (30435): ``` If `dynamic` is used

docs: Update API docs with codegen examples

24e118e

Updated the GraphQL API docs to use statements generated by the codegen. Removed the `amplify codegen add` command as its no longer neeed to be added

yuth requested review from manueliglesias, mlabieniec and undefobj October 14, 2018 19:15

undefobj reviewed Oct 15, 2018

View reviewed changes

undefobj suggested changes Oct 15, 2018

View reviewed changes

docs: incorporate PR feedback

19655b2

yuth requested a review from elorzafe October 15, 2018 18:39

mlabieniec suggested changes Oct 16, 2018

View reviewed changes

docs: grammatical update

0843004

elorzafe suggested changes Oct 16, 2018

View reviewed changes

minor updates to variable names and fomratting

19d2c49

elorzafe approved these changes Oct 16, 2018

View reviewed changes

elorzafe mentioned this pull request Oct 16, 2018

fix(docs): Add loading prop usage on Connect component and mutation code snippet #11

Closed

Merge branch 'master' into api-codegen-edit

4f214c4

mlabieniec approved these changes Oct 18, 2018

View reviewed changes

mlabieniec closed this Oct 19, 2018

mlabieniec reopened this Oct 19, 2018

undefobj approved these changes Oct 23, 2018

View reviewed changes

kaustavghosh06 merged commit 74367fc into aws-amplify:master Oct 23, 2018

undefobj added a commit that referenced this pull request Dec 3, 2019

Merge pull request #16 from undefobj/intensify

3e21b1c

Intensify


		You can declare GraphQL queries with standard GraphQL query syntax. To learn more about GraphQL queries, please visit [GraphQL Developer Documentation](http://graphql.org/learn/queries/).

		Amplify cli codegen automatically generates all possible GraphQL statements (queries, mutations and subscriptions) and saves it in `src/graphql` folder.


		```

		For mutations, a `mutation` function needs to be provided with `Connect` component. `mutation` returns a promise that resolves with the result of the GraphQL mutation.

docs: Update API docs with codegen examples #16

docs: Update API docs with codegen examples #16

Uh oh!

Conversation

yuth commented Oct 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

undefobj left a comment

Choose a reason for hiding this comment

Uh oh!

yuth commented Oct 15, 2018

Uh oh!

mlabieniec left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elorzafe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elorzafe left a comment

Choose a reason for hiding this comment

Uh oh!

undefobj commented Oct 23, 2018

Uh oh!

elorzafe commented Oct 23, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants