Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Encode point estimate output type IDs with null. #111

Merged
merged 3 commits into from
Oct 25, 2024
Merged

Encode point estimate output type IDs with null. #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bfabc6d
Encode point estimate output type IDs with null. Resolves #109
annakrystalli Oct 25, 2024
de81fd1
Update v4.0.0/tasks-schema.json
annakrystalli Oct 25, 2024
7543aa7
Update v4.0.0/tasks-schema.json
annakrystalli Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# v4.0.0

* 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: 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](https://hubverse-org.github.io/hubValidations/articles/validate-pr.html#ignoring-derived-task-ids-to-improve-performance).
* Added more specific schema for `target_keys` to ensure only `string` properties are allowed (#97)

Expand Down
28 changes: 8 additions & 20 deletions v4.0.0/tasks-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -652,23 +652,17 @@
"description": "Object defining the mean of the predictive distribution output type.",
"properties": {
"output_type_id": {
"description": "output_type_id is not meaningful for a point estimate output_type.",
"description": "output_type_id is not meaningful for a point estimate output_type. Must have a single property named 'required' with the value null.",
"examples": [
{
"required": [
"NA"
]
"required": null
}
],
"type": "object",
"properties": {
"required": {
"description": "Not relevant for point estimate output types. Must be single element 'NA' array.",
"type": "array",
"items": {
"const": "NA",
"maxItems": 1
}
"description": "Not relevant for point estimate output types. Must be null.",
"type": "null"
}
},
"required": [
Expand Down Expand Up @@ -736,23 +730,17 @@
"description": "Object defining the median of the predictive distribution output type",
"properties": {
"output_type_id": {
"description": "output_type_id is not meaningful for a point estimate output_type.",
"description": "output_type_id is not meaningful for a point estimate output_type. Must have a single property named 'required' with the value null.",
"examples": [
{
"required": [
"NA"
]
"required": null
}
],
"type": "object",
"properties": {
"required": {
"description": "Not relevant for point estimate output types. Must be single element 'NA' array.",
"type": "array",
"items": {
"const": "NA",
"maxItems": 1
}
"description": "Not relevant for point estimate output types. Must be null.",
"type": "null"
}
},
"required": [
Expand Down
Loading