-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathschema.graphql
660 lines (515 loc) · 17.2 KB
/
schema.graphql
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
"""
A filter to be used against Boolean fields. All fields are combined with a logical ‘and.’
"""
input BooleanFilter {
"""
Not equal to the specified value, treating null like an ordinary value.
"""
distinctFrom: Boolean
"""Equal to the specified value."""
equalTo: Boolean
"""Greater than the specified value."""
greaterThan: Boolean
"""Greater than or equal to the specified value."""
greaterThanOrEqualTo: Boolean
"""Included in the specified list."""
in: [Boolean!]
"""
Is null (if `true` is specified) or is not null (if `false` is specified).
"""
isNull: Boolean
"""Less than the specified value."""
lessThan: Boolean
"""Less than or equal to the specified value."""
lessThanOrEqualTo: Boolean
"""Equal to the specified value, treating null like an ordinary value."""
notDistinctFrom: Boolean
"""Not equal to the specified value."""
notEqualTo: Boolean
"""Not included in the specified list."""
notIn: [Boolean!]
}
"""All input for the `complete` mutation."""
input CompleteInput {
"""
An arbitrary string value with no semantic meaning. Will be included in the
payload verbatim. May be used to track mutations by the client.
"""
clientMutationId: String
id: UUID
}
"""The output of our `complete` mutation."""
type CompletePayload {
"""
The exact same `clientMutationId` that was provided in the mutation input,
unchanged and unused. May be used by a client to track mutations.
"""
clientMutationId: String
"""
Our root query field type. Allows us to run any query from our mutation payload.
"""
query: Query
}
"""All input for the create `Task` mutation."""
input CreateTaskInput {
"""
An arbitrary string value with no semantic meaning. Will be included in the
payload verbatim. May be used to track mutations by the client.
"""
clientMutationId: String
"""The `Task` to be created by this mutation."""
task: TaskInput!
}
"""The output of our create `Task` mutation."""
type CreateTaskPayload {
"""
The exact same `clientMutationId` that was provided in the mutation input,
unchanged and unused. May be used by a client to track mutations.
"""
clientMutationId: String
"""
Our root query field type. Allows us to run any query from our mutation payload.
"""
query: Query
"""The `Task` that was created by this mutation."""
task: Task
"""An edge for our `Task`. May be used by Relay 1."""
taskEdge(
"""The method to use when ordering `Task`."""
orderBy: [TasksOrderBy!] = [PRIMARY_KEY_ASC]
): TasksEdge
}
"""A location in a connection that can be used for resuming pagination."""
scalar Cursor
"""
A point in time as described by the [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) standard. May or may not include a timezone.
"""
scalar Datetime
"""
A filter to be used against Datetime fields. All fields are combined with a logical ‘and.’
"""
input DatetimeFilter {
"""
Not equal to the specified value, treating null like an ordinary value.
"""
distinctFrom: Datetime
"""Equal to the specified value."""
equalTo: Datetime
"""Greater than the specified value."""
greaterThan: Datetime
"""Greater than or equal to the specified value."""
greaterThanOrEqualTo: Datetime
"""Included in the specified list."""
in: [Datetime!]
"""
Is null (if `true` is specified) or is not null (if `false` is specified).
"""
isNull: Boolean
"""Less than the specified value."""
lessThan: Datetime
"""Less than or equal to the specified value."""
lessThanOrEqualTo: Datetime
"""Equal to the specified value, treating null like an ordinary value."""
notDistinctFrom: Datetime
"""Not equal to the specified value."""
notEqualTo: Datetime
"""Not included in the specified list."""
notIn: [Datetime!]
}
"""
The root mutation type which contains root level fields which mutate data.
"""
type Mutation {
complete(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: CompleteInput!
): CompletePayload
"""Creates a single `Task`."""
createTask(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: CreateTaskInput!
): CreateTaskPayload
uncomplete(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: UncompleteInput!
): UncompletePayload
}
"""An object with a globally unique `ID`."""
interface Node {
"""
A globally unique identifier. Can be used in various places throughout the system to identify this single value.
"""
nodeId: ID!
}
"""Information about pagination in a connection."""
type PageInfo {
"""When paginating forwards, the cursor to continue."""
endCursor: Cursor
"""When paginating forwards, are there more items?"""
hasNextPage: Boolean!
"""When paginating backwards, are there more items?"""
hasPreviousPage: Boolean!
"""When paginating backwards, the cursor to continue."""
startCursor: Cursor
}
"""The root query type which gives access points into the data universe."""
type Query implements Node {
"""Fetches an object given its globally unique `ID`."""
node(
"""The globally unique `ID`."""
nodeId: ID!
): Node
"""
The root query type must be a `Node` to work well with Relay 1 mutations. This just resolves to `query`.
"""
nodeId: ID!
"""
Exposes the root query type nested one level down. This is helpful for Relay 1
which can only query top level fields if they are in a particular form.
"""
query: Query!
task(id: UUID!): Task
"""Reads a single `Task` using its globally unique `ID`."""
taskByNodeId(
"""The globally unique `ID` to be used in selecting a single `Task`."""
nodeId: ID!
): Task
"""Reads and enables pagination through a set of `Task`."""
tasks(
"""Read all values in the set after (below) this cursor."""
after: Cursor
"""Read all values in the set before (above) this cursor."""
before: Cursor
"""
A condition to be used in determining which values should be returned by the collection.
"""
condition: TaskCondition
"""
A filter to be used in determining which values should be returned by the collection.
"""
filter: TaskFilter
"""Only read the first `n` values of the set."""
first: Int
"""Only read the last `n` values of the set."""
last: Int
"""
Skip the first `n` values from our `after` cursor, an alternative to cursor
based pagination. May not be used with `last`.
"""
offset: Int
"""The method to use when ordering `Task`."""
orderBy: [TasksOrderBy!] = [PRIMARY_KEY_ASC]
): TasksConnection
}
"""
A filter to be used against String fields. All fields are combined with a logical ‘and.’
"""
input StringFilter {
"""
Not equal to the specified value, treating null like an ordinary value.
"""
distinctFrom: String
"""
Not equal to the specified value, treating null like an ordinary value (case-insensitive).
"""
distinctFromInsensitive: String
"""Ends with the specified string (case-sensitive)."""
endsWith: String
"""Ends with the specified string (case-insensitive)."""
endsWithInsensitive: String
"""Equal to the specified value."""
equalTo: String
"""Equal to the specified value (case-insensitive)."""
equalToInsensitive: String
"""Greater than the specified value."""
greaterThan: String
"""Greater than the specified value (case-insensitive)."""
greaterThanInsensitive: String
"""Greater than or equal to the specified value."""
greaterThanOrEqualTo: String
"""Greater than or equal to the specified value (case-insensitive)."""
greaterThanOrEqualToInsensitive: String
"""Included in the specified list."""
in: [String!]
"""Included in the specified list (case-insensitive)."""
inInsensitive: [String!]
"""Contains the specified string (case-sensitive)."""
includes: String
"""Contains the specified string (case-insensitive)."""
includesInsensitive: String
"""
Is null (if `true` is specified) or is not null (if `false` is specified).
"""
isNull: Boolean
"""Less than the specified value."""
lessThan: String
"""Less than the specified value (case-insensitive)."""
lessThanInsensitive: String
"""Less than or equal to the specified value."""
lessThanOrEqualTo: String
"""Less than or equal to the specified value (case-insensitive)."""
lessThanOrEqualToInsensitive: String
"""
Matches the specified pattern (case-sensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters.
"""
like: String
"""
Matches the specified pattern (case-insensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters.
"""
likeInsensitive: String
"""Equal to the specified value, treating null like an ordinary value."""
notDistinctFrom: String
"""
Equal to the specified value, treating null like an ordinary value (case-insensitive).
"""
notDistinctFromInsensitive: String
"""Does not end with the specified string (case-sensitive)."""
notEndsWith: String
"""Does not end with the specified string (case-insensitive)."""
notEndsWithInsensitive: String
"""Not equal to the specified value."""
notEqualTo: String
"""Not equal to the specified value (case-insensitive)."""
notEqualToInsensitive: String
"""Not included in the specified list."""
notIn: [String!]
"""Not included in the specified list (case-insensitive)."""
notInInsensitive: [String!]
"""Does not contain the specified string (case-sensitive)."""
notIncludes: String
"""Does not contain the specified string (case-insensitive)."""
notIncludesInsensitive: String
"""
Does not match the specified pattern (case-sensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters.
"""
notLike: String
"""
Does not match the specified pattern (case-insensitive). An underscore (_) matches any single character; a percent sign (%) matches any sequence of zero or more characters.
"""
notLikeInsensitive: String
"""Does not start with the specified string (case-sensitive)."""
notStartsWith: String
"""Does not start with the specified string (case-insensitive)."""
notStartsWithInsensitive: String
"""Starts with the specified string (case-sensitive)."""
startsWith: String
"""Starts with the specified string (case-insensitive)."""
startsWithInsensitive: String
}
"""
The root subscription type: contains events and live queries you can subscribe to with the `subscription` operation.
#### Live Queries
Live query fields are differentiated by containing `(live)` at the end of their
description, they are added for each field in the `Query` type. When you
subscribe to a live query field, the selection set will be evaluated and sent to
the client, and then most things\* that would cause the output of the selection
set to change will trigger the selection set to be re-evaluated and the results
to be re-sent to the client.
_(\* Not everything: typically only changes to persisted data referenced by the query are detected, not computed fields.)_
Live queries can be very expensive, so try and keep them small and focussed.
#### Events
Event fields will run their selection set when, and only when, the specified
server-side event occurs. This makes them a lot more efficient than Live
Queries, but it is still recommended that you keep payloads fairly small.
"""
type Subscription {
"""Fetches an object given its globally unique `ID`. (live)"""
node(
"""The globally unique `ID`."""
nodeId: ID!
): Node
"""
The root query type must be a `Node` to work well with Relay 1 mutations. This just resolves to `query`. (live)
"""
nodeId: ID!
"""
Exposes the root query type nested one level down. This is helpful for Relay 1
which can only query top level fields if they are in a particular form. (live)
"""
query: Query!
""" (live)"""
task(id: UUID!): Task
"""Reads a single `Task` using its globally unique `ID`. (live)"""
taskByNodeId(
"""The globally unique `ID` to be used in selecting a single `Task`."""
nodeId: ID!
): Task
"""Reads and enables pagination through a set of `Task`. (live)"""
tasks(
"""Read all values in the set after (below) this cursor."""
after: Cursor
"""Read all values in the set before (above) this cursor."""
before: Cursor
"""
A condition to be used in determining which values should be returned by the collection.
"""
condition: TaskCondition
"""
A filter to be used in determining which values should be returned by the collection.
"""
filter: TaskFilter
"""Only read the first `n` values of the set."""
first: Int
"""Only read the last `n` values of the set."""
last: Int
"""
Skip the first `n` values from our `after` cursor, an alternative to cursor
based pagination. May not be used with `last`.
"""
offset: Int
"""The method to use when ordering `Task`."""
orderBy: [TasksOrderBy!] = [PRIMARY_KEY_ASC]
): TasksConnection
}
type Task implements Node {
complete: Boolean!
completedAt: Datetime
createdAt: Datetime!
id: UUID!
"""
A globally unique identifier. Can be used in various places throughout the system to identify this single value.
"""
nodeId: ID!
text: String!
}
"""
A condition to be used against `Task` object types. All fields are tested for equality and combined with a logical ‘and.’
"""
input TaskCondition {
"""Checks for equality with the object’s `complete` field."""
complete: Boolean
"""Checks for equality with the object’s `completedAt` field."""
completedAt: Datetime
"""Checks for equality with the object’s `createdAt` field."""
createdAt: Datetime
"""Checks for equality with the object’s `id` field."""
id: UUID
"""Checks for equality with the object’s `text` field."""
text: String
}
"""
A filter to be used against `Task` object types. All fields are combined with a logical ‘and.’
"""
input TaskFilter {
"""Checks for all expressions in this list."""
and: [TaskFilter!]
"""Filter by the object’s `complete` field."""
complete: BooleanFilter
"""Filter by the object’s `completedAt` field."""
completedAt: DatetimeFilter
"""Filter by the object’s `createdAt` field."""
createdAt: DatetimeFilter
"""Filter by the object’s `id` field."""
id: UUIDFilter
"""Negates the expression."""
not: TaskFilter
"""Checks for any expressions in this list."""
or: [TaskFilter!]
"""Filter by the object’s `text` field."""
text: StringFilter
}
"""An input for mutations affecting `Task`"""
input TaskInput {
complete: Boolean
id: UUID
text: String!
}
"""A connection to a list of `Task` values."""
type TasksConnection {
"""
A list of edges which contains the `Task` and cursor to aid in pagination.
"""
edges: [TasksEdge!]!
"""A list of `Task` objects."""
nodes: [Task!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""The count of *all* `Task` you could get from the connection."""
totalCount: Int!
}
"""A `Task` edge in the connection."""
type TasksEdge {
"""A cursor for use in pagination."""
cursor: Cursor
"""The `Task` at the end of the edge."""
node: Task!
}
"""Methods to use when ordering `Task`."""
enum TasksOrderBy {
COMPLETED_AT_ASC
COMPLETED_AT_DESC
COMPLETE_ASC
COMPLETE_DESC
CREATED_AT_ASC
CREATED_AT_DESC
ID_ASC
ID_DESC
NATURAL
PRIMARY_KEY_ASC
PRIMARY_KEY_DESC
TEXT_ASC
TEXT_DESC
}
"""
A universally unique identifier as defined by [RFC 4122](https://tools.ietf.org/html/rfc4122).
"""
scalar UUID
"""
A filter to be used against UUID fields. All fields are combined with a logical ‘and.’
"""
input UUIDFilter {
"""
Not equal to the specified value, treating null like an ordinary value.
"""
distinctFrom: UUID
"""Equal to the specified value."""
equalTo: UUID
"""Greater than the specified value."""
greaterThan: UUID
"""Greater than or equal to the specified value."""
greaterThanOrEqualTo: UUID
"""Included in the specified list."""
in: [UUID!]
"""
Is null (if `true` is specified) or is not null (if `false` is specified).
"""
isNull: Boolean
"""Less than the specified value."""
lessThan: UUID
"""Less than or equal to the specified value."""
lessThanOrEqualTo: UUID
"""Equal to the specified value, treating null like an ordinary value."""
notDistinctFrom: UUID
"""Not equal to the specified value."""
notEqualTo: UUID
"""Not included in the specified list."""
notIn: [UUID!]
}
"""All input for the `uncomplete` mutation."""
input UncompleteInput {
"""
An arbitrary string value with no semantic meaning. Will be included in the
payload verbatim. May be used to track mutations by the client.
"""
clientMutationId: String
id: UUID
}
"""The output of our `uncomplete` mutation."""
type UncompletePayload {
"""
The exact same `clientMutationId` that was provided in the mutation input,
unchanged and unused. May be used by a client to track mutations.
"""
clientMutationId: String
"""
Our root query field type. Allows us to run any query from our mutation payload.
"""
query: Query
}