talksik/genqlient
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix documentation for optional: value (#229)

Browse Source 
A couple people noticed the documentation didn't match
the actual option syntax we settled on. Now it does.

Fixes #226, replaces #222 (closed due to CLA issues).
This commit is contained in:
Ben Kraft
2022-10-23 21:20:10 -07:00
committed by GitHub
parent 85e2e8dffd
commit 1d71fffcb6
1 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/genqlient.yaml
+13 -15
View File
@@ -97,21 +97,19 @@ use_struct_references: boolean
# Defaults to false.
use_extensions: boolean
# Customize how optional fields are handled.
optional:
# Customize how models are generated for optional fields. This can currently
# be set to one of the following values:
# - value (default): optional fields are generated as values, the same as
# non-optional fields. E.g. fields with GraphQL types `String` or `String!`
# will both map to the Go type `string`. When values are absent in
# responses the zero value will be used.
# - pointer: optional fields are generated as pointers. E.g. fields with
# GraphQL type `String` will map to the Go type `*string`. When values are
# absent in responses `nil` will be used. Optional list fields do not use
# pointers-to-slices, so the GraphQL type `[String]` will map to the Go
# type `[]*string`, not `*[]*string`; GraphQL null and empty list simply
# map to Go nil- and empty-slice.
output: value
# Customize how models are generated for optional fields. This can currently
# be set to one of the following values:
# - value (default): optional fields are generated as values, the same as
# non-optional fields. E.g. fields with GraphQL types `String` or `String!`
# will both map to the Go type `string`. When values are absent in
# responses the zero value will be used.
# - pointer: optional fields are generated as pointers. E.g. fields with
# GraphQL type `String` will map to the Go type `*string`. When values are
# absent in responses `nil` will be used. Optional list fields do not use
# pointers-to-slices, so the GraphQL type `[String]` will map to the Go
# type `[]*string`, not `*[]*string`; GraphQL null and empty list simply
# map to Go nil- and empty-slice.
optional: value
# A map from GraphQL type name to Go fully-qualified type name to override
# the Go type genqlient will use for this GraphQL type.