Skip to content

New comment handling (BREAKING CHANGE) #55

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

Merged
merged 3 commits into from
Jan 24, 2022
Merged

Conversation

cbumstead
Copy link
Owner

Due to BREAKING CHANGES in the GraphQL spec about how comments are treated means using a number sign to indicate a comment in GraphQL schema files is no longer visible in the metadata that represents that schema. graphql/graphql-js#927 The new recommendation is to use three quotes to indicate a comment block.

NO LONGER SUPPORTED

  # Examples:
  # pl1: playlist(id: "{{summerPlaylist.id}}") @sla(maxResponseTime: "1s")
  # pl2: playlist(id: "{{fallPlaylist.id}}") @ensureMinimum(nItems: 2, inArrays:["pl2.tracks"])
  playlist(id: ID!): Playlist

MUST USE THIS STYLE

  """
  Examples:
  pl1: playlist(id: "{{summerPlaylist.id}}") @sla(maxResponseTime: "1s")
  pl2: playlist(id: "{{fallPlaylist.id}}") @ensureMinimum(nItems: 2, inArrays:["pl2.tracks"])
  """
  playlist(id: ID!): Playlist

@cbumstead cbumstead requested a review from dillon-shf January 21, 2022 02:58
@cbumstead cbumstead self-assigned this Jan 21, 2022
@cbumstead cbumstead linked an issue Jan 21, 2022 that may be closed by this pull request
@dillon-shf dillon-shf merged commit f6007af into master Jan 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Drop support for # comments in favor of """
2 participants