JSON schemas #42
JSON schemas #42
Conversation
jslane-h
commented
May 30, 2024
jslane-h
commented
- Added schemas for library items, verification cases, and workflows. Done manually and no descriptions yet
- Added tests for these schemas
schema/library.schema.json
Outdated
| "library_item_id": { | ||
| "type": "integer", | ||
| "minimum": 1, | ||
| "maximum": 67 |
There was a problem hiding this comment.
I think that we might not want a maximum for now. @leijerry888, what do you think about it?
There was a problem hiding this comment.
I think that we might not want a maximum for now. @leijerry888, what do you think about it?
That's correct. We do not want a maximum.
| "description_verification_type": { | ||
| "enum": [ | ||
| "rule-based", | ||
| "procedure-based" |
There was a problem hiding this comment.
I'm fine with just these for now since that we don't have any ml-based one yet. But we might want to add it eventually.
| @@ -0,0 +1,47 @@ | |||
| { | |||
There was a problem hiding this comment.
Aren't we missing description_assertions?
There was a problem hiding this comment.
That's right. Just added that
| @@ -0,0 +1,1062 @@ | |||
| { | |||
There was a problem hiding this comment.
I think that we might want to change the name of that file to something more generic such as verification_cases.schema.json, I always though that the new_library_ prefix was a bit confusing since it's not the same thing at all as the library.json file.
| "expected_result": { | ||
| "enum": [ | ||
| "pass", | ||
| "fail" | ||
| ] |
There was a problem hiding this comment.
@leijerry888 - Could we get rid of these here and in general in all verification case files since they're already in the library?
| "cases" | ||
| ], | ||
| "additionalProperties": false, | ||
| "$defs": { |
There was a problem hiding this comment.
Would it make sense to move these to individual files for easier maintenance/expansion?
There was a problem hiding this comment.
I could see that being helpful. I think the one downside is that it makes validation a little more complex since you have to introduce a registry and (iirc) $id's. Similarly, splitting "States", "Meta", and "Imports" could be beneficial for the GUI
