Skip to content

Commit 3cd6242

Browse files
magicmarkbenjie
andauthored
Apply suggestions from code review
Co-authored-by: Benjie Gillam <[email protected]>
1 parent fe62f67 commit 3cd6242

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

rfcs/SchemaCoordinates.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,21 @@
33
**Proposed by:** [Mark Larah](https://twitter.com/mark_larah) - Yelp
44

55
This RFC proposes formalizing "Schema Coordinates" - a human readable syntax to
6-
uniquely identify a type, field, or field argument defined in a GraphQL Schema.
6+
uniquely identify a type, field, field argument, enum value, directive or directive argument defined in a GraphQL Schema.
77

88
This should be listed as a non-normative note in the GraphQL specification to
99
serve as an official reference for use by third party tooling.
1010

1111
## 📜 Problem Statement
1212

13-
Third party GraphQL tooling and libraries may wish to refer to a field, or set of
14-
fields in a schema. Use cases include documentation, metrics and logging
13+
GraphQL tooling and libraries may wish to refer to the various components of a GraphQL schema. Use cases include documentation, metrics and logging
1514
libraries.
1615

1716
![](https://i.fluffy.cc/5Cz9cpwLVsH1FsSF9VPVLwXvwrGpNh7q.png)
1817

1918
_(Example shown from GraphiQL's documentation search tab)_
2019

21-
There already exists a convention used by some third party libraries for writing
20+
There already exists a convention used by some libraries and tools for writing
2221
out fields in a unique way for such purposes. However, there is no formal
2322
specification or name for this convention.
2423

@@ -173,7 +172,7 @@ From the query above, we may calculate the following list of schema coordinates:
173172
- `Business.owner`
174173
- `Person.name`
175174

176-
_`Query.searchBusinesses(name)` is also a valid member of the output set. The
175+
_`Query.searchBusinesses(name:)` is also a valid member of the output set. The
177176
serialization algorithm may optionally choose to output all permutations of field
178177
arguments used, should this be specified._
179178

@@ -301,7 +300,7 @@ This syntax consciously does not cover the following use cases:
301300
```
302301

303302
You _can_ select the definition of the `private` directive and its arguments
304-
(with `@private` and `@private(scope)` respectively), but you cannot select the
303+
(with `@private` and `@private(scope:)` respectively), but you cannot select the
305304
application of the `@private` on `User.email`.
306305

307306
For the stated use cases of this RFC, it is more likely that consumers want to

0 commit comments

Comments
 (0)