[Question] How to define the "description" for fields?

[yaquawa]

Is there an easy way to define "description" for each fields?

Maybe we can do it like #description ... or define them in separate config file will be a good solution?

[chrissm79]

If you're using v2.1 or v2.0 you can add a description to each field by prepending it w/ # like so:

type User {
    # First name of user
    first_name: String

    # Last name of user
    last_name: String
}

In v2.2 (currently in beta), you need to use the new triple quotes (the # will not throw any errors, it's just considered a comment instead of a description)

type User {
    """First name of user"""
    first_name: String

    """Last name of user"""
    last_name: String
}

The change in syntax was introduced here.

[yaquawa]

@chrissm79 Cool! Thanks!!

[chrissm79]

@yaquawa no problem!