Ben KraftandGitHub
222d6f191a
## Summary: We had this setting called "scalars", which said: bind this GraphQL type to this Go type, rather than the one you would normally use. It's called that because it's most useful for custom scalars, where "the one you would normally use" is "error: unknown scalar". But nothing ever stopped you from using it for a non-scalar type. I was planning on removing this functionality, because it's sort of a rough edge, but a discussion with Craig found some good use cases, so instead, in this commit, I document it better and add some slightly nicer ways to specify it. Specifically, here are a few potential non-scalar use cases: - bind a GraphQL enum to a nonstandard type (or even `string`) - bind an input type to some type that has exactly the fields you want; this acts as a sort of workaround for issues #14 and #44 - bind an object type to your own struct, so as to add methods to it (this is the use case Craig raised) - bind an object type to your own struct, so as to share it between multiple queries (I believe named fragments will address this case better, but it doesn't hurt to have options) - bind a GraphQL list type to a non-slice type in Go (presumably one with an UnmarshalJSON method), or any other different structure The latter three cases still have the sharp edge I was originally worried about, which is that nothing guarantees that the fields you request in the query are the ones the type expects to get. But I think it's worth having the option, with appropriate disclaimers. The main change to help support that better is that you can now specify the type inline in the query, as an alternative to specifying it in the config file; this means you might map a given object to a given struct, but only in some cases, and when you do you have a chance to look at the list of fields you're requesting. Additionally, I renamed the config field from "scalars" to "bindings" (but mentioned it in a few places where you might go looking for how to map scalars, most importantly the error message you get for an unknown (custom) scalar). While I was making a breaking change, I also changed it to be a `map[string]<struct>` instead of a `map[string]string`, because I expect to add more fields soon, e.g. to handle issue #38. Finally, since the feature is now intended/documented, I added some tests, although it's honestly quite simple on the genqlient side. ## Test plan: make tesc Author: benjaminjkraft Reviewers: csilvers, aberkan, dnerdy, MiguelCastillo Required Reviewers: Approved by: csilvers Checks: ⌛ Test (1.17), ⌛ Test (1.16), ⌛ Test (1.15), ⌛ Test (1.14), ⌛ Test (1.13), ⌛ Lint, ⌛ Test (1.17), ⌛ Test (1.16), ⌛ Test (1.15), ⌛ Test (1.14), ⌛ Test (1.13), ⌛ Lint Pull request URL: https://github.com/Khan/genqlient/pull/69
132 lines
3.1 KiB
GraphQL
132 lines
3.1 KiB
GraphQL
"""DateTime is a scalar.
|
|
|
|
We don't really have anything useful to do with this description though.
|
|
"""
|
|
scalar DateTime
|
|
scalar Junk
|
|
scalar ComplexJunk
|
|
|
|
"""Role is a type a user may have."""
|
|
enum Role {
|
|
"""What is a student?
|
|
|
|
A student is primarily a person enrolled in a school or other educational institution and who is under learning with goals of acquiring knowledge, developing professions and achieving employment at desired field. In the broader sense, a student is anyone who applies themselves to the intensive intellectual engagement with some matter necessary to master it as part of some practical affair in which such mastery is basic or decisive.
|
|
|
|
(from [Wikipedia](https://en.wikipedia.org/wiki/Student))
|
|
"""
|
|
STUDENT
|
|
|
|
"""Teacher is a teacher, who teaches the students."""
|
|
TEACHER
|
|
}
|
|
|
|
input PokemonInput {
|
|
species: String!
|
|
level: Int!
|
|
}
|
|
|
|
type Pokemon {
|
|
species: String!
|
|
level: Int!
|
|
}
|
|
|
|
"""UserQueryInput is the argument to Query.users.
|
|
|
|
Ideally this would support anything and everything!
|
|
Or maybe ideally it wouldn't.
|
|
Really I'm just talking to make this documentation longer.
|
|
"""
|
|
input UserQueryInput {
|
|
email: String
|
|
name: String
|
|
"""id looks the user up by ID. It's a great way to look up users."""
|
|
id: ID
|
|
role: Role
|
|
names: [String]
|
|
hasPokemon: PokemonInput
|
|
}
|
|
|
|
type AuthMethod {
|
|
provider: String
|
|
email: String
|
|
}
|
|
|
|
"""A User is a user!"""
|
|
type User {
|
|
"""id is the user's ID.
|
|
|
|
It is stable, unique, and opaque, like all good IDs."""
|
|
id: ID!
|
|
roles: [Role!]
|
|
name: String
|
|
emails: [String!]!
|
|
emailsOrNull: [String!]
|
|
emailsWithNulls: [String]!
|
|
emailsWithNullsOrNull: [String]
|
|
authMethods: [AuthMethod!]!
|
|
pokemon: [Pokemon!]
|
|
}
|
|
|
|
"""Content is implemented by various types like Article, Video, and Topic."""
|
|
interface Content {
|
|
"""ID is the identifier of the content."""
|
|
id: ID!
|
|
name: String!
|
|
parent: Topic
|
|
}
|
|
|
|
"""LeafContent represents content items that can't have child-nodes."""
|
|
union LeafContent = Article | Video
|
|
|
|
type Article implements Content {
|
|
"""ID is documented in the Content interface."""
|
|
id: ID!
|
|
name: String!
|
|
parent: Topic!
|
|
text: String!
|
|
}
|
|
|
|
type Video implements Content {
|
|
"""ID is documented in the Content interface."""
|
|
id: ID!
|
|
name: String!
|
|
parent: Topic!
|
|
duration: Int!
|
|
}
|
|
|
|
type Topic implements Content {
|
|
"""ID is documented in the Content interface."""
|
|
id: ID!
|
|
name: String!
|
|
parent: Topic
|
|
children: [Content!]!
|
|
}
|
|
|
|
"""Query's description is probably ignored by almost all callers."""
|
|
type Query {
|
|
"""user looks up a user by some stuff.
|
|
|
|
See UserQueryInput for what stuff is supported.
|
|
If query is null, returns the current user.
|
|
"""
|
|
user(query: UserQueryInput): User
|
|
|
|
users(query: [UserQueryInput]): User
|
|
|
|
"""usersWithRole looks a user up by role."""
|
|
usersWithRole(role: Role!): [User!]!
|
|
root: Topic!
|
|
randomItem: Content!
|
|
randomLeaf: LeafContent!
|
|
convert(dt: DateTime!, tz: String): DateTime!
|
|
maybeConvert(dt: DateTime, tz: String): DateTime
|
|
getJunk: Junk
|
|
getComplexJunk: ComplexJunk
|
|
listOfListsOfLists: [[[String!]!]!]!
|
|
listOfListsOfListsOfContent: [[[Content!]!]!]!
|
|
}
|
|
|
|
type Mutation {
|
|
createUser(name: String!, email: String): User
|
|
}
|