Skip to content

Commit

Permalink
Merge branch 'master' into schemaDescription
Browse files Browse the repository at this point in the history
  • Loading branch information
leebyron authored Oct 1, 2018
2 parents 9ef2bc4 + 760753e commit 4d19603
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 21 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# GraphQL

The GraphQL specification is edited in the markdown files found in [`/spec`](./spec)
the latest release of which is published at http://facebook.github.io/graphql/.
the latest release of which is published at https://facebook.github.io/graphql/.

The latest draft specification can be found at http://facebook.github.io/graphql/draft/
The latest draft specification can be found at https://facebook.github.io/graphql/draft/
which tracks the latest commit to the master branch in this repository.

Previous releases of the GraphQL specification can be found at permalinks that
match their [release tag](https://github.com/facebook/graphql/releases). For
example, http://facebook.github.io/graphql/October2016/. If you are linking
example, https://facebook.github.io/graphql/October2016/. If you are linking
directly to the GraphQL specification, it's best to link to a tagged permalink
for the particular referenced version.

Expand All @@ -24,7 +24,7 @@ In order to be broadly adopted, GraphQL will have to target a wide
variety of backends, frameworks, and languages, which will necessitate a
collaborative effort across projects and organizations. This specification serves as a point of coordination for this effort.

Looking for help? Find resources [from the community](http://graphql.org/community/).
Looking for help? Find resources [from the community](https://graphql.org/community/).

## Getting Started

Expand Down
3 changes: 2 additions & 1 deletion spec/Appendix B -- Grammar Summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ ObjectField[Const] : Name : Value[?Const]

VariableDefinitions : ( VariableDefinition+ )

VariableDefinition : Variable : Type DefaultValue?
VariableDefinition : Variable : Type DefaultValue? Directives[Const]?

Variable : $ Name

Expand Down Expand Up @@ -296,6 +296,7 @@ ExecutableDirectiveLocation : one of
`FRAGMENT_DEFINITION`
`FRAGMENT_SPREAD`
`INLINE_FRAGMENT`
`VARIABLE_DEFINITION`

TypeSystemDirectiveLocation : one of
`SCHEMA`
Expand Down
2 changes: 1 addition & 1 deletion spec/GraphQL.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ this open standard started in 2015.
GraphQL has evolved and may continue to evolve in future editions of this
specification. Previous editions of the GraphQL specification can be found at
permalinks that match their [release tag](https://github.com/facebook/graphql/releases).
The latest working draft release can be found at [facebook.github.io/graphql/draft/](http://facebook.github.io/graphql/draft/).
The latest working draft release can be found at [facebook.github.io/graphql/draft/](https://facebook.github.io/graphql/draft/).

**Copyright notice**

Expand Down
6 changes: 3 additions & 3 deletions spec/Section 2 -- Language.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ used in this document.
SourceCharacter :: /[\u0009\u000A\u000D\u0020-\uFFFF]/

GraphQL documents are expressed as a sequence of
[Unicode](http://unicode.org/standard/standard.html) characters. However, with
[Unicode](https://unicode.org/standard/standard.html) characters. However, with
few exceptions, most of GraphQL is expressed only in the original non-control
ASCII range so as to be as widely compatible with as many existing tools,
languages, and serialization formats as possible and avoid display issues in
Expand Down Expand Up @@ -884,7 +884,7 @@ For example, these two field calls are similar, but are not identical:
}
```

The first has explictly provided {null} to the argument "arg", while the second
The first has explicitly provided {null} to the argument "arg", while the second
has implicitly not provided a value to the argument "arg". These two forms may
be interpreted differently. For example, a mutation representing deleting a
field vs not altering a field, respectively. Neither form may be used for an
Expand Down Expand Up @@ -986,7 +986,7 @@ Variable : $ Name

VariableDefinitions : ( VariableDefinition+ )

VariableDefinition : Variable : Type DefaultValue?
VariableDefinition : Variable : Type DefaultValue? Directives[Const]?

DefaultValue : = Value[Const]

Expand Down
22 changes: 11 additions & 11 deletions spec/Section 3 -- Type System.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ 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](http://commonmark.org/)). In 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.

Expand Down Expand Up @@ -445,7 +445,7 @@ encoding integer numbers larger than 32-bit.
### Float

The Float scalar type represents signed double-precision fractional values
as specified by [IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point).
as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
Response formats that support an appropriate double-precision number type
should use that type to represent this scalar.

Expand Down Expand Up @@ -524,7 +524,7 @@ often numeric, it should always serialize as a `String`.
GraphQL is agnostic to ID format, and serializes to string to ensure consistency
across many formats ID could represent, from small auto-increment numbers, to
large 128-bit random numbers, to base64 encoded values, or string values of a
format like [GUID](http://en.wikipedia.org/wiki/Globally_unique_identifier).
format like [GUID](https://en.wikipedia.org/wiki/Globally_unique_identifier).

GraphQL servers should coerce as appropriate given the ID formats they expect.
When coercion is not possible they must raise a field error.
Expand Down Expand Up @@ -1464,10 +1464,10 @@ particular, if a non-list is returned, the coercion should fail, as this
indicates a mismatch in expectations between the type system and the
implementation.

If a list's item type is nullable, then errors occuring during preparation or
If a list's item type is nullable, then errors occurring during preparation or
coercion of an individual item in the list must result in a the value {null} at
that position in the list along with an error added to the response. If a list's
item type is non-null, an error occuring at an individual item in the list must
item type is non-null, an error occurring at an individual item in the list must
result in a field error for the entire list.

Note: For more information on the error handling process, see "Errors and
Expand Down Expand Up @@ -1496,7 +1496,7 @@ Expected Type | Provided Value | Coerced Value
`[Int]` | `[1, "b", true]` | Error: Incorrect item value
`[Int]` | `1` | `[1]`
`[Int]` | `null` | `null`
`[[Int]]` | `[[1], [2, 3]]` | `[[1], [2, 3]`
`[[Int]]` | `[[1], [2, 3]]` | `[[1], [2, 3]]`
`[[Int]]` | `[1, 2, 3]` | Error: Incorrect item value
`[[Int]]` | `1` | `[[1]]`
`[[Int]]` | `null` | `null`
Expand Down Expand Up @@ -1531,7 +1531,7 @@ should be performed. If that result was not {null}, then the result of coercing
the Non-Null type is that result. If that result was {null}, then a field error
must be raised.

Note: When a field error is raised on a non-null value, the error propogates to
Note: When a field error is raised on a non-null value, the error propagates to
the parent field. For more information on this process, see
"Errors and Non-Nullability" within the Execution section.

Expand Down Expand Up @@ -1631,6 +1631,7 @@ ExecutableDirectiveLocation : one of
`FRAGMENT_DEFINITION`
`FRAGMENT_SPREAD`
`INLINE_FRAGMENT`
`VARIABLE_DEFINITION`

TypeSystemDirectiveLocation : one of
`SCHEMA`
Expand All @@ -1656,8 +1657,7 @@ provide the `@deprecated` directive if representing deprecated portions of
the schema.

Directives must only be used in the locations they are declared to belong in.
In this example, a directive is defined which can be used to annotate a
fragment definition:
In this example, a directive is defined which can be used to annotate a field:

```graphql example
directive @example on FIELD
Expand Down Expand Up @@ -1753,7 +1753,7 @@ query myQuery($someTest: Boolean) {
```

Note: Neither `@skip` nor `@include` has precedence over the other. In the case
that both the `@skip` and `@include` directives are provided in on the same the
that both the `@skip` and `@include` directives are provided on the same
field or fragment, it *must* be queried only if the `@skip` condition is false
*and* the `@include` condition is true. Stated conversely, the field or fragment
must *not* be queried if either the `@skip` condition is true *or* the
Expand All @@ -1773,7 +1773,7 @@ to indicate deprecated portions of a GraphQL service's schema, such as
deprecated fields on a type or deprecated enum values.

Deprecations include a reason for why it is deprecated, which is formatted using
Markdown syntax (as specified by [CommonMark](http://commonmark.org/)).
Markdown syntax (as specified by [CommonMark](https://commonmark.org/)).

In this example type definition, `oldField` is deprecated in favor of
using `newField`.
Expand Down
2 changes: 1 addition & 1 deletion spec/Section 4 -- Introspection.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ underscores.
All types in the introspection system provide a `description` field of type
`String` to allow type designers to publish documentation in addition to
capabilities. A GraphQL server may return the `description` field using Markdown
syntax (as specified by [CommonMark](http://commonmark.org/)). Therefore it is
syntax (as specified by [CommonMark](https://commonmark.org/)). Therefore it is
recommended that any tool that displays `description` use a CommonMark-compliant
Markdown renderer.

Expand Down

0 comments on commit 4d19603

Please sign in to comment.