Skip to content

SMILE Supported Schemas

ao508 edited this page Jul 26, 2024 · 1 revision

This page serves as a means to easily access and visualize the supported JSON schemas for outgoing SMILE Requests published to downstream clients.

Major changes from IGO Request JSON:

Request-level mappings:

- projectId --> igoProjectId
- requestId --> igoRequestId
- recipe --> genePanel

Sample metadata-level mappings:

- cmoSampleClass --> sampleType
- specimenType --> sampleClass
- oncoTreeCode --> oncotreeCode
- recipe --> genePanel
- igoId --> primaryId

Data added by SMILE:

SMILE runs a sanity check on incoming IGO requests. The result of this validation process is appended to the incoming IGO Request JSON as a new property called "status". Similarly, SMILE will validate each sample in the incoming request and append the results of the validation process as "status" at the sample-level as well. Sample-level "status" data can also be appended to or updated by the SMILE label generator, which runs as a separate process after the SMILE validation.

Validator output / appended JSON data schema:

  "status": {
    "validationReport": [{"string", "string"}],
    "validationStatus": true
  }

Notes:

  • Version(s) v2.X and greater use the adopted universal schema which was added to support sample metadata from IGO and DMP

Current schema:

Previous schemas: