Skip to content

Change in 23.0.0: Gear Output Classification Validation

Change

Starting in Flywheel 23.0.0, when a gear outputs a file with a classification value that does not match the defined classification schema, the job fails. The job log records an error in this format:

Error: Job failed because file "<file name>" has an invalid classification: The following aspect keys do not adhere to the classification schema: [<invalid keys>]

In Flywheel 21.4.0 through 22.x, Flywheel logged only a warning in the job log, and the job completed successfully.

Who Is Affected

Gear developers whose gears set classification values on output files via .metadata.json. If your gear produces output with classification values that do not conform to the Flywheel classification schema, your gear's jobs fail on Flywheel 23.0.0 and later.

  • Review the classification values your gear sets via .metadata.json against the Flywheel classification scheme.
  • Update any gears that write invalid classification values to use only schema-defined values.
  • Check the Jobs Log for jobs that failed with an invalid classification error.