-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsupergraph.graphql
More file actions
648 lines (598 loc) · 11 KB
/
supergraph.graphql
File metadata and controls
648 lines (598 loc) · 11 KB
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
type Artifact {
"""
The file name of the artifact
"""
name: String!
"""
The download URL for the artifact
"""
url: Url!
"""
The MIME type of the artifact data
"""
mimeType: String!
}
scalar Creator
"""
Implement the DateTime<Utc> scalar
The input/output is a string in RFC3339 format.
"""
scalar DateTime
"""
A scalar that can represent any JSON value.
"""
scalar JSON
"""
A scalar that can represent any JSON Object value.
"""
scalar JSONObject
"""
A single log line streamed from a pod
"""
type LogEntry {
"""
The log line content
"""
content: String!
"""
The name of the pod producing the log
"""
podName: String!
}
"""
The root mutation of the service
"""
type Mutation {
submitWorkflowTemplate(
name: String!
visit: VisitInput!
parameters: JSON!
): Workflow!
}
"""
Information about pagination in a connection
"""
type PageInfo @shareable {
"""
When paginating backwards, are there more items?
"""
hasPreviousPage: Boolean!
"""
When paginating forwards, are there more items?
"""
hasNextPage: Boolean!
"""
When paginating backwards, the cursor to continue.
"""
startCursor: String
"""
When paginating forwards, the cursor to continue.
"""
endCursor: String
}
"""
Supported DLS science groups
"""
enum ScienceGroup {
"""
Macromolecular Crystallography
"""
MX
"""
Workflows Examples
"""
EXAMPLES
"""
Magnetic Materials
"""
MAGNETIC_MATERIALS
"""
Soft Condensed Matter
"""
CONDENSED_MATTER
"""
Imaging and Microscopy
"""
IMAGING
"""
Biological Cryo-Imaging
"""
BIO_CRYO_IMAGING
"""
Structures and Surfaces
"""
SURFACES
"""
Crystallography
"""
CRYSTALLOGRAPHY
"""
Spectroscopy
"""
SPECTROSCOPY
}
"""
The root mutation of the service
"""
type Subscription {
"""
Processing to subscribe to logs for a single pod of a workflow
"""
logs(visit: VisitInput!, workflowName: String!, taskId: String!): LogEntry!
"""
Processing to subscribe to data for all workflows in a session
"""
workflow(visit: VisitInput!, name: String!): Workflow!
}
type Task {
"""
Unique name of the task
"""
id: String!
"""
Display name of the task
"""
name: String!
"""
Current status of a task
"""
status: TaskStatus!
"""
Parent of a task
"""
depends: [String!]!
"""
Children of a task
"""
dependencies: [String!]!
"""
Artifacts produced by a task
"""
artifacts: [Artifact!]!
"""
Node type - Pod, DAG, etc
"""
stepType: String!
"""
Start time for a task on a workflow
"""
startTime: DateTime
"""
End time for a task on a workflow
"""
endTime: DateTime
"""
A human readable message indicating details about why this step is in this condition
"""
message: String
}
enum TaskStatus {
PENDING
RUNNING
SUCCEEDED
SKIPPED
FAILED
ERROR
OMITTED
}
scalar Template
"""
URL is a String implementing the [URL Standard](http://url.spec.whatwg.org/)
"""
scalar Url
"""
A visit to an instrument as part of a session
"""
type Visit {
"""
Project Proposal Code
"""
proposalCode: String!
"""
Project Proposal Number
"""
proposalNumber: Int!
"""
Session visit Number
"""
number: Int!
}
"""
A visit to an instrument as part of a session
"""
input VisitInput {
"""
Project Proposal Code
"""
proposalCode: String!
"""
Project Proposal Number
"""
proposalNumber: Int!
"""
Session visit Number
"""
number: Int!
}
type Workflow {
"""
The name given to the workflow, unique within a given visit
"""
name: String!
"""
The visit the Workflow was run against
"""
visit: Visit!
"""
The current status of the workflow
"""
status: WorkflowStatus
"""
The top-level workflow parameters
"""
parameters: JSONObject
"""
The name of the template used to run the workflow
"""
templateRef: String
"""
The workflow creator
"""
creator: WorkflowCreator!
}
type WorkflowConnection @shareable {
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
A list of edges.
"""
edges: [WorkflowEdge!]!
"""
A list of nodes.
"""
nodes: [Workflow!]!
}
"""
Information about the creator of a workflow.
"""
type WorkflowCreator {
"""
An identifier unique to the creator of the workflow.
Typically this is the creator's Fed-ID.
"""
creatorId: String!
}
"""
An edge in a connection.
"""
type WorkflowEdge @shareable {
"""
The item at the end of the edge
"""
node: Workflow!
"""
A cursor for use in pagination
"""
cursor: String!
}
"""
All tasks in the workflow have errored
"""
type WorkflowErroredStatus {
"""
Time at which this workflow started
"""
startTime: DateTime!
"""
Time at which this workflow completed
"""
endTime: DateTime!
"""
A human readable message indicating details about why the workflow is in this condition
"""
message: String
"""
Tasks created by the workflow
"""
tasks: [Task!]!
}
"""
All tasks in the workflow have failed
"""
type WorkflowFailedStatus {
"""
Time at which this workflow started
"""
startTime: DateTime!
"""
Time at which this workflow completed
"""
endTime: DateTime!
"""
A human readable message indicating details about why the workflow is in this condition
"""
message: String
"""
Tasks created by the workflow
"""
tasks: [Task!]!
}
"""
All the supported Workflows filters
"""
input WorkflowFilter {
"""
The status field for a workflow
"""
workflowStatusFilter: WorkflowStatusFilter
"""
The fedid of the user who created the workflow
"""
creator: Creator
"""
The name of the workflow template
"""
template: Template
}
type WorkflowPendingStatus {
"""
A human readable message indicating details about why the workflow is in this condition
"""
message: String
}
type WorkflowRunningStatus {
"""
Time at which this workflow started
"""
startTime: DateTime!
"""
A human readable message indicating details about why the workflow is in this condition
"""
message: String
"""
Tasks created by the workflow
"""
tasks: [Task!]!
}
"""
The status of a workflow
"""
union WorkflowStatus =
| WorkflowPendingStatus
| WorkflowRunningStatus
| WorkflowSucceededStatus
| WorkflowFailedStatus
| WorkflowErroredStatus
"""
Represents workflow status filters
"""
input WorkflowStatusFilter {
pending: Boolean! = false
running: Boolean! = false
succeeded: Boolean! = false
failed: Boolean! = false
error: Boolean! = false
}
"""
All tasks in the workflow have succeded
"""
type WorkflowSucceededStatus {
"""
Time at which this workflow started
"""
startTime: DateTime!
"""
Time at which this workflow completed
"""
endTime: DateTime!
"""
A human readable message indicating details about why the workflow is in this condition
"""
message: String
"""
Tasks created by the workflow
"""
tasks: [Task!]!
}
type WorkflowTemplate {
"""
The name given to the workflow template, globally unique
"""
name: String!
"""
The group who maintains the workflow template
"""
maintainer: String!
"""
A human readable title for the workflow template
"""
title: String
"""
A human readable description of the workflow which is created
"""
description: String
"""
The repository storing the code associated with this template.
"""
repository: String
"""
A JSON Schema describing the arguments of a Workflow Template
"""
arguments: JSON!
"""
A JSON Forms UI Schema describing how to render the arguments of the Workflow Template
"""
uiSchema: JSON
}
type WorkflowTemplateConnection @shareable {
"""
Information to aid in pagination.
"""
pageInfo: PageInfo!
"""
A list of edges.
"""
edges: [WorkflowTemplateEdge!]!
"""
A list of nodes.
"""
nodes: [WorkflowTemplate!]!
}
"""
An edge in a connection.
"""
type WorkflowTemplateEdge @shareable {
"""
The item at the end of the edge
"""
node: WorkflowTemplate!
"""
A cursor for use in pagination
"""
cursor: String!
}
"""
Supported label filters for ClusterWorkflowTemplates
"""
input WorkflowTemplatesFilter {
"""
The science group owning the template eg imaging
"""
scienceGroup: [ScienceGroup!]
}
"""
Directs the executor to include this field or fragment only when the `if` argument is true.
"""
directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
"""
Directs the executor to skip this field or fragment when the `if` argument is true.
"""
directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
"""
Provides a scalar specification URL for specifying the behavior of custom scalar types.
"""
directive @specifiedBy(url: String!) on SCALAR
type Account {
accountId: Int!
username: String!
emailAddress: String
title: String
givenName: String
familyName: String
type: AccountType!
state: AccountState!
proposalRoles: [ProposalAccount!]!
instrumentSessionRoles: [InstrumentSessionRole!]!
}
enum AccountState {
enabled
disabled
}
enum AccountType {
user
staff
functional
}
"""
Date with time (isoformat)
"""
scalar DateTime
type Instrument {
name: String!
scienceGroup: String
description: String
proposals: [Proposal!]!
instrumentSessions: [InstrumentSession!]!
}
type InstrumentSession {
instrumentSessionId: Int!
instrumentSessionNumber: Int!
startTime: DateTime
endTime: DateTime
type: String
state: String
riskRating: String
proposal: Proposal
instrument: Instrument!
roles: [InstrumentSessionRole!]!
}
type InstrumentSessionRole {
instrumentSession: InstrumentSession!
account: Account!
role: String!
onSite: Boolean!
}
type Proposal {
proposalNumber: Int!
proposalCategory: String
title: String
summary: String
state: ProposalState!
instrumentSessions: [InstrumentSession!]!
instruments: [Instrument!]!
roles: [ProposalAccount!]!
}
type ProposalAccount {
proposal: Proposal!
account: Account!
role: String!
}
enum ProposalState {
Open
Closed
Cancelled
}
type Query {
"""
Get a single [`Workflow`] by proposal, visit, and name
"""
workflow(visit: VisitInput!, name: String!): Workflow!
workflows(
visit: VisitInput!
cursor: String
limit: Int
filter: WorkflowFilter
): WorkflowConnection!
workflowTemplate(name: String!): WorkflowTemplate!
workflowTemplates(
cursor: String
limit: Int
filter: WorkflowTemplatesFilter
): WorkflowTemplateConnection!
"""
Get a proposal by its number
"""
proposal(proposalNumber: Int!): Proposal
"""
Get a list of proposals
"""
proposals(proposalCategory: String = null): [Proposal!]!
"""
Get a instrument session
"""
instrumentSession(
proposalNumber: Int!
instrumentSessionNumber: Int!
): InstrumentSession
"""
Get a instrument session
"""
instrumentSessions(
proposalNumber: Int = null
proposalCategory: String = null
): [InstrumentSession!]
"""
Get an instrument
"""
instrument(instrumentName: String!): Instrument
"""
Get a list of instruments
"""
instruments(scienceGroup: String = null): [Instrument!]!
"""
Get an account
"""
account(username: String!): Account
}