Skip to content

Commit ff31205

Browse files
committed
Add required attribute to extensions in yaml file (#545)
PEtab extensions were introduced in #537. We should be able to distinguish there between optional extensions and required extensions, i.e. those that modify the parameter estimation problem as such, and those that just add additional/optional information (e.g. annotations, info for visualization, ...). If some tool does not know about a certain optional extension, it can safely be ignored during import, if it does not know about a required extension, it should fail. This PR adds a `required` attribute to extensions in the yaml file to indicate whether they are required for the mathematical interpretation of the PEtab problem. Resolves #544
1 parent 45728fd commit ff31205

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

doc/_static/petab_schema.yaml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,19 @@ properties:
9898
version:
9999
type: string
100100
pattern: ^([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?(\.post(0|[1-9][0-9]*))?(\.dev(0|[1-9][0-9]*))?$
101-
101+
required:
102+
type: bool
103+
description: |
104+
Indicates whether the extension is required for the
105+
mathematical interpretation of problem.
102106
required:
103107
- version
108+
- required
104109
additionalProperties: true
105110

106111
additionalProperties: false
107112

108113
required:
109114
- format_version
110115
- parameter_file
111-
- problems
116+
- problems

0 commit comments

Comments
 (0)