Ben KraftandGitHub
5211442843
## Summary: The basic idea here is if you only request interface fields (no fragments) you may not care about the concrete type, and so we could just generate a struct as if it were an object. I don't think it's a good idea to do that by default, because then if you later add a fragment all your code totally changes, but it's quite reasonable as an option! Most of the code involved is just wiring and validation; the core implementation is literally just: treat it like an object. Issue: https://github.com/Khan/genqlient/issues/85 ## Test plan: make check Author: benjaminjkraft Reviewers: csilvers, StevenACoffman, benjaminjkraft, aberkan, dnerdy, jvoll, mahtabsabet, MiguelCastillo Required Reviewers: Approved By: StevenACoffman Checks: ⌛ Test (1.17), ⌛ Test (1.16), ⌛ Test (1.15), ⌛ Test (1.14), ⌛ Lint, ⌛ Test (1.17), ⌛ Test (1.16), ⌛ Test (1.15), ⌛ Test (1.14), ⌛ Lint Pull Request URL: https://github.com/Khan/genqlient/pull/97
103 lines
3.9 KiB
GraphQL
103 lines
3.9 KiB
GraphQL
# The quasi-directive @genqlient is used to configure genqlient on a
|
|
# query-by-query basis.
|
|
#
|
|
# The syntax of the directive is just like a GraphQL directive (as defined
|
|
# below), except it goes in a comment on the line immediately preceding the
|
|
# field. (This is because GraphQL expects directives in queries to be defined
|
|
# by the server, not by the client, so it would reject a real @genqlient
|
|
# directive as nonexistent.)
|
|
#
|
|
# Directives may be applied to fields, arguments, or the entire query.
|
|
# Directives on the line preceding the query apply to all relevant nodes in
|
|
# the query; other directives apply to all nodes on the following line. (In
|
|
# all cases it's fine for there to be other comments in between the directive
|
|
# and the node(s) to which it applies.) For example, in the following query:
|
|
# # @genqlient(n: "a")
|
|
#
|
|
# # @genqlient(n: "b")
|
|
# #
|
|
# # Comment describing the query
|
|
# #
|
|
# # @genqlient(n: "c")
|
|
# query MyQuery(arg1: String,
|
|
# # @genqlient(n: "d")
|
|
# arg2: String, arg3: String,
|
|
# arg4: String,
|
|
# ) {
|
|
# # @genqlient(n: "e")
|
|
# field1, field2
|
|
# field3
|
|
# }
|
|
# the directive "a" is ignored, "b" and "c" apply to all relevant nodes in the
|
|
# query, "d" applies to arg2 and arg3, and "e" applies to field1 and field2.
|
|
directive genqlient(
|
|
|
|
# If set, this argument will be omitted if it's equal to its Go zero
|
|
# value, or is an empty slice.
|
|
#
|
|
# For example, given the following query:
|
|
# # @genqlient(omitempty: true)
|
|
# query MyQuery(arg: String) { ... }
|
|
# genqlient will generate a function
|
|
# MyQuery(ctx context.Context, client graphql.Client, arg string) ...
|
|
# which will pass {"arg": null} to GraphQL if arg is "", and the actual
|
|
# value otherwise.
|
|
#
|
|
# Only applicable to arguments of nullable types.
|
|
omitempty: Boolean
|
|
|
|
# If set, this argument or field will use a pointer type in Go. Response
|
|
# types always use pointers, but otherwise we typically do not.
|
|
#
|
|
# This can be useful if it's a type you'll need to pass around (and want a
|
|
# pointer to save copies) or if you wish to distinguish between the Go
|
|
# zero value and null (for nullable fields).
|
|
pointer: Boolean
|
|
|
|
# If set, this field will use a struct type in Go, even if it's an interface.
|
|
#
|
|
# This is useful when you have a query like
|
|
# query MyQuery {
|
|
# myInterface { myField }
|
|
# }
|
|
# where you are requesting only shared fields of an interface. By default,
|
|
# genqlient still generates an interface type, for consistency. But this
|
|
# isn't necessary: a struct would do just fine since there are no
|
|
# type-specific fields. Setting `struct: true` tells genqlient to do that.
|
|
#
|
|
# Note that this is only allowed when there are no fragments in play, such
|
|
# that all fields are on the interface type. Note that if you later add a
|
|
# fragment, you'll have to remove this option, and the types will change.
|
|
struct: Boolean
|
|
|
|
# If set, this argument or field will use the given Go type instead of a
|
|
# genqlient-generated type.
|
|
#
|
|
# The value should be the fully-qualified type name to use for the field,
|
|
# for example:
|
|
# time.Time
|
|
# map[string]interface{}
|
|
# []github.com/you/yourpkg/subpkg.MyType
|
|
# Note that the type is the type of the whole field, e.g. if your field in
|
|
# GraphQL has type `[DateTime]`, you'd do
|
|
# # @genqlient(bind: "[]time.Time")
|
|
# (But you're not required to; if you want to map to some type DateList,
|
|
# you can do that, as long as its UnmarshalJSON method can accept a list
|
|
# of datetimes.)
|
|
#
|
|
# See bindings in genqlient.yaml for more details; this is effectively to a
|
|
# local version of that global setting and should be used with similar care.
|
|
# If set to "-", overrides any such global setting and uses a
|
|
# genqlient-generated type.
|
|
bind: String
|
|
|
|
) on
|
|
# genqlient directives can go almost anywhere, although some options are only
|
|
# applicable in certain locations as described above.
|
|
| QUERY
|
|
| MUTATION
|
|
| SUBSCRIPTION
|
|
| FIELD
|
|
| FRAGMENT_DEFINITION
|
|
| VARIABLE_DEFINITION
|