Skip to content

Releases: hubverse-org/schemas

v4.0.0 - New output type ID spec

25 Nov 07:39
v4.0.0
0163a89
Compare
Choose a tag to compare

What's Changed

  • BREAKING CHANGE: Introduction of is_required boolean property at the output_type level to configure whether the output type is required for submissions to be considered valid (#99).
  • BREAKING CHANGE: Disallowed optional property in output_type_id objects. As such, when a given output type is submitted, values for all output type IDs much be submitted (#100,#101, #102).
  • BREAKING CHANGE: To improve cross-platform interoperability, expectation of missing values in point estimate output_type_id required properties now encoded with null instead of ["NA"] (#109).
  • Introduction of optional derived_task_ids properties to enable hub administrators to define derived task IDs (i.e. task IDs whose values depend on the values of other task IDs). The higher level derived_task_ids property sets the property globally at the hub level but can be overriden by the round level derived_task_ids property. The property allows for primarily validation functionality to ignore such task IDs when appropriate which can significantly improve validation efficency (#96). For more information see hubValidations documentation on ignoring derived task IDs.
  • Added more specific schema for target_keys to ensure only string properties are allowed (#97)
  • Removed the requirement for a minimum value of zero in cdf numeric output_type_ids (#113).
  • Ensured that additional properties are not allowed in lower level properties (e.g. individual task IDs, output_type objects etc). Custom additional properties are only allowed at the round level, while additional task ID objects that match the expected task ID schema are allowed in the task_ids object (#114).

Full Changelog: v3.0.1...v4.0.0

v3.0.1 - Introduce output_type_id_datatype property

24 Jul 14:30
ce9efd4
Compare
Choose a tag to compare
  • Introduction of optional output_type_id_datatype property to enable hub administrators to configure and communicate the output_type_id column data type at a hub level. This will allow hubs to override default behaviour of automatically determinining the simplest data type that can accomodate output type IDs across all output types when creating hub schema. The setting is also useful for administrators to future proof the output_type_id column from potential issues arising by changes in data type, introduced by new output types after submissions have begun, by setting output_type_id_datatype to the simplest data type from the start, i.e. character (#87).
  • Removed restrictive epidemic week formatting requirements for CDF output_type_id values. Character output type IDs no longer need to conform to the regex pattern ^EW[0-9]{6} (e.g. "EW202240") (#80).

v3.0.0 - Support samples & Organisation name channge

19 Jun 05:56
0f35d3b
Compare
Choose a tag to compare

v3.0.0

  • Breaking change: introduction of new sample output type id schema specification in tasks.json. The main breaking change is the removal of the output_type_id property in sample. Instead, the collection of samples is defined through a new output_type_id_params object (#70).
  • Breaking change: The repository_url and repository_host properties in admin.json have been deprecated in favour of a sigle repository object with separate host, owner and name properties (#67).
  • Breaking change: The optional hub_models property in admin.json has been removed as it's schema could create conflicts with the model_abbr and team_abbr schema specification in the hub administered `model-metadata-schema.json (#77).
  • Additional properties are now allowed at the round item property level (#74).
  • Host organisation name changed in schema id properties to hubverse-org throughout all schema versions.

v2.0.1

12 Mar 18:46
5585912
Compare
Choose a tag to compare

What's Changed

See NEWS.md for updates.

v2.0.0

14 Jul 14:18
de580d5
Compare
Choose a tag to compare

What's Changed

See NEWS.md for updates

v1.0.0

15 May 09:37
e41978f
Compare
Choose a tag to compare

What's Changed

See NEWS.md for updates

v0.0.1 - First stable schema release

22 Feb 15:22
Compare
Choose a tag to compare
add note about ensuring concurrent updates to schema and hubDocs vers…

v0.0.0.9 - Development release

16 Feb 14:31
1361c3a
Compare
Choose a tag to compare

First development release of Modeling Hub Schema