Editorial: Improve Introspection section #857
Conversation
leebyron
added
✏️ Editorial
spec/Section 4 -- Introspection.md
Outdated
|
|
||
| **Schema Introspection Schema** | ||
|
|
||
| The schema introspection system is itself, of course, represented as a GraphQL |
There was a problem hiding this comment.
is itself, of course, represented as a GraphQL schema
IMO this creates a sustainable impression that the schemа, of course, can be expandable and tooling should take it into account.
spec/Section 4 -- Introspection.md
Outdated
| Fields\: | ||
|
|
||
| * `description` may return a String or {null}. | ||
| * `queryType` is the root type of a query operation, if supported. |
There was a problem hiding this comment.
if supported. Otherwise {null}.
WOW! It seemed to me that discussions of the optional queryType were about the fact that it is required for introspection, so it should always be? Did I miss something?
There was a problem hiding this comment.
Yes indeed, that one seems new :) @leebyron did you intend to make it nullable or is it a copy pasta? Until now a query type was mandatory.
There was a problem hiding this comment.
Definitely a mistake, thank you for the careful read!
leebyron
force-pushed
the
main
branch
4 times, most recently
from
e5d241d to
6c81ed8
Compare
This makes some structural changes to the introspection section and fills in some missing pieces (solved ambiguity): * Removes 4-level headers in favor of sub-section headers * Uses the same syntax and style for describing fields of all types * Defines the `__Schema` type which was previously under-defined * Defines the two enums (`__TypeKind` and `__DirectiveLocation`) which were previously under-defined. * Clarifies the `__` restriction and repeats this when defining `Name` * Moves Documentation and Description sub-sections into schema introspection section.
Co-authored-by: Ivan Maximov <[email protected]>
leebyron
force-pushed
the
editorial-introspection
branch
from
0d8a86d to
406bc4d
Compare
|
Great suggestions @benjie - incorporated |
This makes some structural changes to the introspection section and fills in some missing pieces (solved ambiguity):
__Schematype which was previously under-defined__TypeKindand__DirectiveLocation) which were previously under-defined.__restriction and repeats this when definingNameCloses #827