Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

GraphQL type descriptions with AppSync

Tags:

aws-appsync

Is there a way to add GraphQL type descriptions to a GraphQL Schema used by AppSync?

ApolloServer and graphql-js support this with comments in the schema file (see here ). Is there something similar for AppSync so I can use GraphQL type introspection to see field descriptions?

like image 549
Tom Q. Avatar asked Dec 14 '25 18:12

Tom Q.


1 Answers

You should be able to do this with a comment just over the type (note that it must be the line immediately before). It might look like this:


# A comment on a post.
type Comment {
    id: ID!
    content: String
}

like image 85
Jeff Bailey Avatar answered Dec 16 '25 07:12

Jeff Bailey