Skip to content
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.

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

fixed introspection field "specifiedBy" to "specifiedByURL" #848

Merged
merged 4 commits into from Apr 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions spec/Section 3 -- Type System.md
Expand Up @@ -391,11 +391,11 @@ useful custom scalar is `URL`, which serializes as a string, but is guaranteed
by the server to be a valid URL.

When defining a custom scalar, GraphQL services should provide a specification
URL via the `@specifiedBy` directive or the `specifiedBy` introspection field.
URL via the `@specifiedBy` directive or the `specifiedByURL` introspection field.
This URL must link to a human-readable specification of the data format,
serialization, and coercion rules for the scalar. For example, a GraphQL service
providing a `UUID` scalar may link to RFC 4122, or some custom document defining
a reasonable subset of that RFC. If a scalar `specifiedBy` URL is present,
a reasonable subset of that RFC. If a scalar specification URL is present,
systems and tools that are aware of it should conform to its described rules.

```graphql example
Expand All @@ -411,7 +411,7 @@ Custom scalar specification URLs should not be changed once defined. Doing so
would likely disrupt tooling or could introduce breaking changes within the
linked specification's contents.

Built-in scalar types must not provide a `specifiedBy` URL as they are specified
Built-in scalar types must not provide a specification URL as they are specified
by this document.

Note: Custom scalars should also summarize the specified format and provide
Expand Down
6 changes: 3 additions & 3 deletions spec/Section 4 -- Introspection.md
Expand Up @@ -152,7 +152,7 @@ type __Type {
ofType: __Type

# should be non-null for custom SCALAR only, must be null for the others
specifiedBy: String
specifiedByURL: String
}

type __Field {
Expand Down Expand Up @@ -242,13 +242,13 @@ actually valid. These kinds are listed in the `__TypeKind` enumeration.
Represents scalar types such as Int, String, and Boolean. Scalars cannot have fields.

Also represents [Custom scalars](#sec-Scalars.Custom-Scalars) which may provide
`specifiedBy` as a scalar specification URL.
`specifiedByURL` as a scalar specification URL.

Fields

* `kind` must return `__TypeKind.SCALAR`.
* `name` must return a String.
* `specifiedBy` may return a String (in the form of a URL) for custom scalars,
* `specifiedByURL` may return a String (in the form of a URL) for custom scalars,
otherwise must be {null}.
* `description` may return a String or {null}.
* All other fields must return {null}.
Expand Down