graphql-go / graphql-go/relay

FieldConfigArgument descriptions are not used in GraphiQL

Open
#40 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
423
Forks
54
PR merge metrics
No merged PRs in 30d

Description

Given the following configuration:
```go
Args: relay.NewConnectionArgs(graphql.FieldConfigArgument{
"fromDate": &graphql.ArgumentConfig{
Description: "From date value with `YY-MM-DD` format",
Type: graphql.DateTime,
},
"toDate": &graphql.ArgumentConfig{
Description: "To date value with `YY-MM-DD` format",
Type: graphql.DateTime,
},
"status": &graphql.ArgumentConfig{
Description: "Current invoice status retrieved from transactions",
Type: invoiceTransactionStatusEnum,
},
}),
```
The custom descriptions are not passed to **GraphiQL**.
For example, the type graphql.DateTime has its default description that is not overrided from my custom description. Indeed, they keep the default description:
`The DateTime scalar type represents a DateTime. The DateTime is serialized as an RFC 3339 quoted string`

Instead, the field `status` which is a custom enumeration, comes with `No Description`.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.