Skip to content

Add support for leading vertical bar in union types #320

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.

Sign up for GitHub

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
robzhu merged 3 commits into from
Jun 14, 2017
Merged

Add support for leading vertical bar in union types #320

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0057589
Add support for leading vertical bar in union types
alexandrebodin Jun 13, 2017
5e4970a
Add precisions to vertical bar usage
alexandrebodin Jun 13, 2017
e7a94e2
Change wording, Add example for unsupported trailing vertical bar
alexandrebodin Jun 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions spec/Section 3 -- Type System.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -755,6 +755,24 @@ Union types have the potential to be invalid if incorrectly defined.
Similarly, wrapping types may not be member types of a Union.
2. A Union type must define one or more unique member types.

#### Union type syntax

Union types are defined by delimiting one or more types with a single vertical bar character `|`:

```graphql
union SearchResult = Photo | Person
```

You may also use a leading vertical bar.
Copy link
Contributor

@robzhu robzhu Jun 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change this to You may also use a leading vertical bar: to be consistent with the opening clause.


```graphql
union SearchResult =
| Photo
| Person
```

Note Trailing vertical bars are not supported.
Copy link
Contributor

@robzhu robzhu Jun 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would update this to say "Trailing delimiters are not supported:" followed by an (invalid) example. You can "```!graphql" to designate an invalid example.


### Enums

GraphQL Enums are a variant on the Scalar type, which represents one of a
Expand Down