Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

schema-first approach does not support single line and mutliline documentation

See original GitHub issue

Currently, the schema-first approach does not support single line and mutliline documentation (see GraphQL Specifications from June 2018).

The following one will not work when we try to use the schema-first approach:

"""
A simple GraphQL schema which is well described.
"""
type Query {
  """
  Translates a string from a given language into a different language.
  """
  translate(
    "The original language that `text` is provided in."
    fromLanguage: Language

    "The translated language to be returned."
    toLanguage: Language

    "The text to be translated."
    text: String
  ): String
}

"""
The set of languages supported by `translate`.
"""
enum Language {
  "English"
  EN

  "French"
  FR

  "Chinese"
  CH
}

I made a little research and I didn’t manage to find any .net GraphQL implementation that supports this. Is this one related to this issue? Thx you 🙄

Issue Analytics

State:
Created 4 years ago
Comments:9 (7 by maintainers)

Top GitHub Comments

2reactions

michaelstaibcommented, Mar 23, 2019

No prob. With version 9 we will bring lots of improvements for Schema-first

1reaction

michaelstaibcommented, Mar 23, 2019

OK, it is public https://www.nuget.org/packages/HotChocolate/0.8.1-rc.2

Top Results From Across the Web

GraphQL schema basics

GraphQL's schema definition language (SDL) supports Markdown-enabled documentation strings, called descriptions. These help consumers of your graph discover ...

GraphQL playground type detail multiline comment?

1 Answer 1 · Both don't seem to work for me... prints everything in one line in graphql playground. – J.S.C · Are...

Schema-First API Design

A schema-first approach creates a single source of truth that can be used to generate all kinds of development artifacts. Well-defined API specs ......

Schema Registry API Reference

Schema Registry API Reference¶. This section provides a detailed reference for the Schema Registry API. The best way to test these is to...

PHP Documentation Standards | Coding Standards Handbook

WordPress uses a customized documentation schema that draws inspiration from PHPDoc, an evolving standard for providing documentation to PHP code, which is ......