0

是否可以为使用 graphql 的查询中接受的参数添加描述或注释？

我有一个查询如下：

    field :users, types[Types::UserType] do
  description 'List of Users. Date parameters accepted in yyyy/mm/dd format.'

  # Required for date range search, accepts string (yyyy/mm/dd)
  argument :from_date, types.String, default_value: nil

如您所见，目前我正在将参数的描述添加到字段的描述中。在它描述我看到的类型的 graphiql 模式中：

users(from_date: Stringto_date: Stringemail: Stringname: Stringoffset: Intlimit: Int): [UserType]

当我点击 from_date 它描述了一个字符串。反正有没有描述字符串的格式？例如。“yyyy/mm/dd 格式的字符串。”

谢谢！

4

1 回答 1

2

查看文档，您应该能够执行以下操作：

argument :favoriteFood, types.String, "A string in yyyy/mm/dd format", default_value: nil
于 2018-02-28T03:06:40.933 回答