Skip to content
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

Descriptions as strings in GraphQL SDL #95

Merged
merged 7 commits into from
Feb 12, 2018
Merged

Conversation

cjoudrey
Copy link
Owner

@cjoudrey cjoudrey commented Feb 12, 2018

Fixes #77

As per graphql/graphql-js#927, descriptions are now strings instead of comments in the SDL.

For example:

Before

# Query
type Query {
  # A
  a: String
}

Now

"Query"
type Query {
  "A"
  a: String
}

Moving forward schemas will need to use this syntax. In order to provide a graceful upgrade path, users can use the --comment-descriptions CLI option to use the old way of defining descriptions for types.

@cjoudrey cjoudrey force-pushed the descriptions-as-strings branch from 8124e0d to 0ba9070 Compare February 12, 2018 04:45
@cjoudrey cjoudrey merged commit af836db into master Feb 12, 2018
@cjoudrey cjoudrey deleted the descriptions-as-strings branch February 12, 2018 23:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant