Skip to content

Commit 40d025c

Browse files
Code-Hexleebyron
andauthored
fixed introspection field "specifiedBy" to "specifiedByURL" (#848)
* fixed introspection field "specifiedBy" to "specifiedByURL" * fixed specifiedBy to specifiedByURL in Section 3 * Remove redundant URL * use term Co-authored-by: Lee Byron <lee@leebyron.com>
1 parent 61c50f2 commit 40d025c

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

spec/Section 3 -- Type System.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -391,11 +391,11 @@ useful custom scalar is `URL`, which serializes as a string, but is guaranteed
391391
by the server to be a valid URL.
392392

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

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

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

417417
Note: Custom scalars should also summarize the specified format and provide

spec/Section 4 -- Introspection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ type __Type {
154154
ofType: __Type
155155

156156
# should be non-null for custom SCALAR only, must be null for the others
157-
specifiedBy: String
157+
specifiedByURL: String
158158
}
159159

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

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

249249
Fields
250250

251251
* `kind` must return `__TypeKind.SCALAR`.
252252
* `name` must return a String.
253-
* `specifiedBy` may return a String (in the form of a URL) for custom scalars,
253+
* `specifiedByURL` may return a String (in the form of a URL) for custom scalars,
254254
otherwise must be {null}.
255255
* `description` may return a String or {null}.
256256
* All other fields must return {null}.

0 commit comments

Comments
 (0)