-
Notifications
You must be signed in to change notification settings - Fork 136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve description for not documented parameters #9
Comments
Hi @2fd, I am trying to describe arguments for a given query. This scheme:
So now I try:
but it does not work. I may not be that familiar with the shorthand notation. How can I add a description to an argument? |
Hello @mlapeyre3 In your case it would remain like this: # The root query object
type Query {
# Fetch an Order given its id.
order(
# Description of the id argument
id: ID
): Order
} |
Hi @2fd, Thanks, it works great! |
Could have nice to have this in the doc, I've been looking for it as well ;) |
@2fd , I was playing around following you examples without success for my use case. http://facebook.github.io/graphql/June2018/#sec-Descriptions So I changed from: # Base user type
type User {
# User unique id
id: ID!
# The full user name
name: String!
# The user email address
email: Email!
} To: "Base user type"
type User {
"Its unique id, which have to be an Int"
id: ID!
"The full user name"
name: String!
"The user email address"
email: Email!
} And that works ! |
Change
[NULL]
for[NOT DOCUMENTED]
The text was updated successfully, but these errors were encountered: