GraphQL架构顶层的文档

Question

我正在记录我的架构（SDL）中的所有类型，字段和参数，包括顶部的Query和Mutation-但我不知道如何添加单个部分整个架构顶层的文档。

我不确定这是规范还是工具-例如，阿波罗允许我编写schema { }，但不能在其中放入任何内容或文件。

并且在文档中没有任何示例，特别是在https://graphql.github.io/graphql-spec/June2018/#sec-Descriptions中，该示例显示了“描述良好的”模式，没有顶级文档字符串。

这是规范未涵盖的内容，还是仅仅是工具？

Answer 1

与类型不同，SchemaDefinition spec不包含Description。 __Schema introspection type也没有description字段。因此，无法为整个架构设置或获取描述。

但是，它是upcoming feature。