supergraph.graphql

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
}