Skip to content

Commit

Permalink
Add description to Schema (#466)
Browse files Browse the repository at this point in the history
* Move description section

* Add description to Schema
  • Loading branch information
IvanGoncharov authored Feb 6, 2020
1 parent 3b001da commit 02fd71f
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 59 deletions.
2 changes: 1 addition & 1 deletion spec/Appendix B -- Grammar Summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ TypeSystemExtension :
- SchemaExtension
- TypeExtension

SchemaDefinition : schema Directives[Const]? { RootOperationTypeDefinition+ }
SchemaDefinition : Description? schema Directives[Const]? { RootOperationTypeDefinition+ }

SchemaExtension :
- extend schema Directives[Const]? { RootOperationTypeDefinition+ }
Expand Down
123 changes: 65 additions & 58 deletions spec/Section 3 -- Type System.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,73 @@ local service to represent data a GraphQL client only accesses locally, or by a
GraphQL service which is itself an extension of another GraphQL service.


## Descriptions

Description : StringValue

Documentation is a first-class feature of GraphQL type systems. To ensure
the documentation of a GraphQL service remains consistent with its capabilities,
descriptions of GraphQL definitions are provided alongside their definitions and
made available via introspection.

To allow GraphQL service designers to easily publish documentation alongside the
capabilities of a GraphQL service, GraphQL descriptions are defined using the
Markdown syntax (as specified by [CommonMark](https://commonmark.org/)). In the
type system definition language, these description strings (often {BlockString})
occur immediately before the definition they describe.

GraphQL schema and all other definitions (e.g. types, fields, arguments, etc.)
which can be described should provide a {Description} unless they are considered
self descriptive.

As an example, this simple GraphQL schema is well described:

```graphql example
"""
A simple GraphQL schema which is well described.
"""
schema {
query: Query
}

"""
Root type for all your queries
"""
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
}
```


## Schema

SchemaDefinition : schema Directives[Const]? { RootOperationTypeDefinition+ }
SchemaDefinition : Description? schema Directives[Const]? { RootOperationTypeDefinition+ }

RootOperationTypeDefinition : OperationType : NamedType

Expand Down Expand Up @@ -169,63 +233,6 @@ Schema extensions have the potential to be invalid if incorrectly defined.
original Schema.


## Descriptions

Description : StringValue

Documentation is a first-class feature of GraphQL type systems. To ensure
the documentation of a GraphQL service remains consistent with its capabilities,
descriptions of GraphQL definitions are provided alongside their definitions and
made available via introspection.

To allow GraphQL service designers to easily publish documentation alongside the
capabilities of a GraphQL service, GraphQL descriptions are defined using the
Markdown syntax (as specified by [CommonMark](https://commonmark.org/)). In the
type system definition language, these description strings (often {BlockString})
occur immediately before the definition they describe.

All GraphQL types, fields, arguments and other definitions which can be
described should provide a {Description} unless they are considered self
descriptive.

As an example, this simple GraphQL schema is well described:

```graphql example
"""
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
}
```


## Types

TypeDefinition :
Expand Down
1 change: 1 addition & 0 deletions spec/Section 4 -- Introspection.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ The schema of the GraphQL schema introspection system:

```graphql
type __Schema {
description: String
types: [__Type!]!
queryType: __Type!
mutationType: __Type
Expand Down

0 comments on commit 02fd71f

Please sign in to comment.