generateClient Fails when Query isn't named Query about graphqlcodegen HOT 7 CLOSED

Query, Mutation and Suscription aren't Netflix DGS requirements, it's a GraphQL requirements.

Not exactly - You can map other types to query, mutation in the schema {} definition block. Perfectly valid as in @jplabadie example. The issue is - client DGS codegen only supports types named Query, Mutation and Subscription in my experience.

from graphqlcodegen.

Hi @jplabadie. Glad you find the plugin useful!

This is expected behavior. The maven plugin is a thin wrapper over the Netflix codegen library (same library their gradle plugin uses) which does have a requirement on the root type names - they need to be Query, Mutation and Subscription.

Let us know if there are any other questions.

from graphqlcodegen.

from graphqlcodegen.

@jplabadie @zorglube just wanted to follow up here to avoid some confusion.

What you had is a perfectly valid graphql schema. I work with some teams that use something similar using schema to setup query/mutation and mapping query to something like type RootQueryType that defines all of the queries for that particular schema. DGS can generate types for that and run that schema if you're using Java and the rest of the server side libraries they provide.

The problem is generating the client code - the codegen plugin will not generate client code and projections as you noticed unless the type is Query or Mutation. Even if you've specified in the schema {} block what query and mutation types are.

This schema is powered by DGS Java based server - you can see RootQueryType is defined here, not Query, and executed the shows query.

Here you can see codegen did not generate client code or shows, or any other field on RootQueryType, but did generate code for createShow.

If we rename RootQueryType to Query in this example DGS codegen will generate code for shows and bars.

If there was any confusion I hope this cleared it up.

from graphqlcodegen.

You schema seems bad. AS far as I know it might look like this :

 type Something {
  query: QueryRoot
}

type QeryRoot [
 ... 
}

type Query {
  customers(id: String, emailAlias: String, phoneNumber: String): [Customer]
  bookOfTheDead(bookId: String, bookCode: String): BookOfTheDead
}

from graphqlcodegen.

@zorglube @deweyjose

Thank you, and hearing that is the standard really helps. I consider this closed.

from graphqlcodegen.

Yes this is pretty clear. It's simply a convention, not a requirement of GraphQL, but because the schema is pretty sparse syntactically the codegen authors had to make some assumptions about where their plugin could search for Queries, Mutations, and Subscriptions.

Thanks again!

from graphqlcodegen.