添加描述/注释到graphql参数?

时间:2018-02-27 22:25:26

标签: ruby graphql graphql-ruby

是否可以向使用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格式的字符串。"

谢谢!

1 个答案:

答案 0 :(得分:2)

Looking at the docs,您应该可以执行以下操作:

<optgroup>