-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
schema.graphql
683 lines (568 loc) · 18.6 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
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
"""All input for the create `Organization` mutation."""
input CreateOrganizationInput {
"""
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 `Organization` to be created by this mutation."""
organization: OrganizationInput!
}
"""The output of our create `Organization` mutation."""
type CreateOrganizationPayload {
"""
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
"""The `Organization` that was created by this mutation."""
organization: Organization
"""
Our root query field type. Allows us to run any query from our mutation payload.
"""
query: Query
"""An edge for our `Organization`. May be used by Relay 1."""
organizationEdge(
"""The method to use when ordering `Organization`."""
orderBy: [OrganizationsOrderBy!] = PRIMARY_KEY_ASC
): OrganizationsEdge
}
"""All input for the create `User` mutation."""
input CreateUserInput {
"""
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 `User` to be created by this mutation."""
user: UserInput!
}
"""The output of our create `User` mutation."""
type CreateUserPayload {
"""
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
"""The `User` that was created by this mutation."""
user: User
"""
Our root query field type. Allows us to run any query from our mutation payload.
"""
query: Query
"""Reads a single `Organization` that is related to this `User`."""
organizationByOrganizationId: Organization
"""An edge for our `User`. May be used by Relay 1."""
userEdge(
"""The method to use when ordering `User`."""
orderBy: [UsersOrderBy!] = PRIMARY_KEY_ASC
): UsersEdge
}
"""A location in a connection that can be used for resuming pagination."""
scalar Cursor
"""All input for the `deleteOrganizationById` mutation."""
input DeleteOrganizationByIdInput {
"""
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: Int!
}
"""All input for the `deleteOrganization` mutation."""
input DeleteOrganizationInput {
"""
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 globally unique `ID` which will identify a single `Organization` to be deleted.
"""
nodeId: ID!
}
"""The output of our delete `Organization` mutation."""
type DeleteOrganizationPayload {
"""
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
"""The `Organization` that was deleted by this mutation."""
organization: Organization
deletedOrganizationId: ID
"""
Our root query field type. Allows us to run any query from our mutation payload.
"""
query: Query
"""An edge for our `Organization`. May be used by Relay 1."""
organizationEdge(
"""The method to use when ordering `Organization`."""
orderBy: [OrganizationsOrderBy!] = PRIMARY_KEY_ASC
): OrganizationsEdge
}
"""All input for the `deleteUserByOrganizationIdAndUuid` mutation."""
input DeleteUserByOrganizationIdAndUuidInput {
"""
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
organizationId: Int!
uuid: UUID!
}
"""All input for the `deleteUser` mutation."""
input DeleteUserInput {
"""
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 globally unique `ID` which will identify a single `User` to be deleted.
"""
nodeId: ID!
}
"""The output of our delete `User` mutation."""
type DeleteUserPayload {
"""
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
"""The `User` that was deleted by this mutation."""
user: User
deletedUserId: ID
"""
Our root query field type. Allows us to run any query from our mutation payload.
"""
query: Query
"""Reads a single `Organization` that is related to this `User`."""
organizationByOrganizationId: Organization
"""An edge for our `User`. May be used by Relay 1."""
userEdge(
"""The method to use when ordering `User`."""
orderBy: [UsersOrderBy!] = PRIMARY_KEY_ASC
): UsersEdge
}
"""
The root mutation type which contains root level fields which mutate data.
"""
type Mutation {
"""Creates a single `Organization`."""
createOrganization(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: CreateOrganizationInput!
): CreateOrganizationPayload
"""Creates a single `User`."""
createUser(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: CreateUserInput!
): CreateUserPayload
"""
Updates a single `Organization` using its globally unique id and a patch.
"""
updateOrganization(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: UpdateOrganizationInput!
): UpdateOrganizationPayload
"""Updates a single `Organization` using a unique key and a patch."""
updateOrganizationById(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: UpdateOrganizationByIdInput!
): UpdateOrganizationPayload
"""Updates a single `User` using its globally unique id and a patch."""
updateUser(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: UpdateUserInput!
): UpdateUserPayload
"""Updates a single `User` using a unique key and a patch."""
updateUserByOrganizationIdAndUuid(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: UpdateUserByOrganizationIdAndUuidInput!
): UpdateUserPayload
"""Deletes a single `Organization` using its globally unique id."""
deleteOrganization(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: DeleteOrganizationInput!
): DeleteOrganizationPayload
"""Deletes a single `Organization` using a unique key."""
deleteOrganizationById(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: DeleteOrganizationByIdInput!
): DeleteOrganizationPayload
"""Deletes a single `User` using its globally unique id."""
deleteUser(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: DeleteUserInput!
): DeleteUserPayload
"""Deletes a single `User` using a unique key."""
deleteUserByOrganizationIdAndUuid(
"""
The exclusive input argument for this mutation. An object type, make sure to see documentation for this object’s fields.
"""
input: DeleteUserByOrganizationIdAndUuidInput!
): DeleteUserPayload
}
"""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!
}
type Organization implements Node {
"""
A globally unique identifier. Can be used in various places throughout the system to identify this single value.
"""
nodeId: ID!
id: Int!
name: String!
"""Reads and enables pagination through a set of `User`."""
usersByOrganizationId(
"""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
"""Read all values in the set before (above) this cursor."""
before: Cursor
"""Read all values in the set after (below) this cursor."""
after: Cursor
"""The method to use when ordering `User`."""
orderBy: [UsersOrderBy!] = [PRIMARY_KEY_ASC]
"""
A condition to be used in determining which values should be returned by the collection.
"""
condition: UserCondition
): UsersConnection!
}
"""
A condition to be used against `Organization` object types. All fields are
tested for equality and combined with a logical ‘and.’
"""
input OrganizationCondition {
"""Checks for equality with the object’s `id` field."""
id: Int
"""Checks for equality with the object’s `name` field."""
name: String
}
"""An input for mutations affecting `Organization`"""
input OrganizationInput {
id: Int
name: String!
}
"""
Represents an update to a `Organization`. Fields that are set will be updated.
"""
input OrganizationPatch {
id: Int
name: String
}
"""A connection to a list of `Organization` values."""
type OrganizationsConnection {
"""A list of `Organization` objects."""
nodes: [Organization]!
"""
A list of edges which contains the `Organization` and cursor to aid in pagination.
"""
edges: [OrganizationsEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""The count of *all* `Organization` you could get from the connection."""
totalCount: Int!
}
"""A `Organization` edge in the connection."""
type OrganizationsEdge {
"""A cursor for use in pagination."""
cursor: Cursor
"""The `Organization` at the end of the edge."""
node: Organization
}
"""Methods to use when ordering `Organization`."""
enum OrganizationsOrderBy {
NATURAL
ID_ASC
ID_DESC
NAME_ASC
NAME_DESC
PRIMARY_KEY_ASC
PRIMARY_KEY_DESC
}
"""Information about pagination in a connection."""
type PageInfo {
"""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
"""When paginating forwards, the cursor to continue."""
endCursor: Cursor
}
"""The root query type which gives access points into the data universe."""
type Query implements Node {
"""
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!
"""
The root query type must be a `Node` to work well with Relay 1 mutations. This just resolves to `query`.
"""
nodeId: ID!
"""Fetches an object given its globally unique `ID`."""
node(
"""The globally unique `ID`."""
nodeId: ID!
): Node
"""Reads and enables pagination through a set of `Organization`."""
allOrganizations(
"""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
"""Read all values in the set before (above) this cursor."""
before: Cursor
"""Read all values in the set after (below) this cursor."""
after: Cursor
"""The method to use when ordering `Organization`."""
orderBy: [OrganizationsOrderBy!] = [PRIMARY_KEY_ASC]
"""
A condition to be used in determining which values should be returned by the collection.
"""
condition: OrganizationCondition
): OrganizationsConnection
"""Reads and enables pagination through a set of `User`."""
allUsers(
"""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
"""Read all values in the set before (above) this cursor."""
before: Cursor
"""Read all values in the set after (below) this cursor."""
after: Cursor
"""The method to use when ordering `User`."""
orderBy: [UsersOrderBy!] = [PRIMARY_KEY_ASC]
"""
A condition to be used in determining which values should be returned by the collection.
"""
condition: UserCondition
): UsersConnection
organizationById(id: Int!): Organization
userByOrganizationIdAndUuid(organizationId: Int!, uuid: UUID!): User
"""Reads a single `Organization` using its globally unique `ID`."""
organization(
"""
The globally unique `ID` to be used in selecting a single `Organization`.
"""
nodeId: ID!
): Organization
"""Reads a single `User` using its globally unique `ID`."""
user(
"""The globally unique `ID` to be used in selecting a single `User`."""
nodeId: ID!
): User
}
"""All input for the `updateOrganizationById` mutation."""
input UpdateOrganizationByIdInput {
"""
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
"""
An object where the defined keys will be set on the `Organization` being updated.
"""
organizationPatch: OrganizationPatch!
id: Int!
}
"""All input for the `updateOrganization` mutation."""
input UpdateOrganizationInput {
"""
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 globally unique `ID` which will identify a single `Organization` to be updated.
"""
nodeId: ID!
"""
An object where the defined keys will be set on the `Organization` being updated.
"""
organizationPatch: OrganizationPatch!
}
"""The output of our update `Organization` mutation."""
type UpdateOrganizationPayload {
"""
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
"""The `Organization` that was updated by this mutation."""
organization: Organization
"""
Our root query field type. Allows us to run any query from our mutation payload.
"""
query: Query
"""An edge for our `Organization`. May be used by Relay 1."""
organizationEdge(
"""The method to use when ordering `Organization`."""
orderBy: [OrganizationsOrderBy!] = PRIMARY_KEY_ASC
): OrganizationsEdge
}
"""All input for the `updateUserByOrganizationIdAndUuid` mutation."""
input UpdateUserByOrganizationIdAndUuidInput {
"""
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
"""
An object where the defined keys will be set on the `User` being updated.
"""
userPatch: UserPatch!
organizationId: Int!
uuid: UUID!
}
"""All input for the `updateUser` mutation."""
input UpdateUserInput {
"""
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 globally unique `ID` which will identify a single `User` to be updated.
"""
nodeId: ID!
"""
An object where the defined keys will be set on the `User` being updated.
"""
userPatch: UserPatch!
}
"""The output of our update `User` mutation."""
type UpdateUserPayload {
"""
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
"""The `User` that was updated by this mutation."""
user: User
"""
Our root query field type. Allows us to run any query from our mutation payload.
"""
query: Query
"""Reads a single `Organization` that is related to this `User`."""
organizationByOrganizationId: Organization
"""An edge for our `User`. May be used by Relay 1."""
userEdge(
"""The method to use when ordering `User`."""
orderBy: [UsersOrderBy!] = PRIMARY_KEY_ASC
): UsersEdge
}
type User implements Node {
"""
A globally unique identifier. Can be used in various places throughout the system to identify this single value.
"""
nodeId: ID!
organizationId: Int!
uuid: UUID!
name: String!
"""Reads a single `Organization` that is related to this `User`."""
organizationByOrganizationId: Organization
}
"""
A condition to be used against `User` object types. All fields are tested for equality and combined with a logical ‘and.’
"""
input UserCondition {
"""Checks for equality with the object’s `organizationId` field."""
organizationId: Int
"""Checks for equality with the object’s `uuid` field."""
uuid: UUID
"""Checks for equality with the object’s `name` field."""
name: String
}
"""An input for mutations affecting `User`"""
input UserInput {
organizationId: Int!
uuid: UUID
name: String!
}
"""Represents an update to a `User`. Fields that are set will be updated."""
input UserPatch {
organizationId: Int
uuid: UUID
name: String
}
"""A connection to a list of `User` values."""
type UsersConnection {
"""A list of `User` objects."""
nodes: [User]!
"""
A list of edges which contains the `User` and cursor to aid in pagination.
"""
edges: [UsersEdge!]!
"""Information to aid in pagination."""
pageInfo: PageInfo!
"""The count of *all* `User` you could get from the connection."""
totalCount: Int!
}
"""A `User` edge in the connection."""
type UsersEdge {
"""A cursor for use in pagination."""
cursor: Cursor
"""The `User` at the end of the edge."""
node: User
}
"""Methods to use when ordering `User`."""
enum UsersOrderBy {
NATURAL
ORGANIZATION_ID_ASC
ORGANIZATION_ID_DESC
UUID_ASC
UUID_DESC
NAME_ASC
NAME_DESC
PRIMARY_KEY_ASC
PRIMARY_KEY_DESC
}
"""
A universally unique identifier as defined by [RFC 4122](https://tools.ietf.org/html/rfc4122).
"""
scalar UUID