results_schema.yml

components:
  schemas:
    WorkflowResult:
      type: object
      description: Definition for results that will be returned by this workflow. This structure will be passed through by Gizmo speaking clients as WorkflowInstance.results.
      required:
        - workflow_pass
        - workflow_checks
        - samples
      properties:
        workflow_pass: 
          type: boolean
          description: True if this workflow instance passes all checks
        workflow_checks:
          type: array
          description: An array of checks performed on the workflow instance
          items:
            $ref: '#/components/schemas/CheckResult'
        samples:
          type: array
          description: Samples in this workflow instance
          items:
            $ref: '#/components/schemas/Sample'


    Sample:
      type: object
      description: A sample sheet entry and its corresponding checks and related results
      required:
        - alias
        - barcode
        - sample_type
        - sample_pass
        - sample_checks
        - results
      properties:
        alias:
          type: string
          description: The alias for the sample given by the user
        barcode:
          type: string
          description: The physical barcode assigned to the sample
        sample_type:
          type: string
          description: The type of the sample
          enum:
            - no_template_control
            - positive_control
            - negative_control
            - test_sample
        sample_pass:
          type: boolean
          description: If true the sample has passed workflow checks
        sample_checks:
          type: array
          description: An array of checks performed on the sample
          items:
            $ref: '#/components/schemas/CheckResult'
        results:
          type: object
          description: Further specific workflow results for this sample
          additionalProperties: true


    CheckResult:
      type: object
      description: A result of some check the workflow has performed on a sample, or itself
      required:
        - check_name
        - check_pass
      properties:
        check_name:
          type: string
          description: The name of the check
        check_pass:
          type: boolean
          description: If true the check has passed