-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Add CodeTF failure state to Result #31
Conversation
codetf.schema.json
Outdated
"failureState": { | ||
"type": "object", | ||
"properties": { | ||
"failed": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This required failed
boolean introduces complexity (more opportunities for the data to be invalid) and it makes this a breaking instead of an additive change.
Instead of the boolean, can we let the existence of the failure object indicate a failure? That would make this an additive change and reduce the number of invalid states.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I see how this is a breaking change since failureState
itself remains optional but I do think the boolean is redundant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh I didn't catch that. I thought failureState and this boolean were required
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In either case, the presence/absence of failure
seems cleaner.
codetf.schema.json
Outdated
@@ -87,6 +87,34 @@ | |||
"description": "Vendor-specific properties to help storytelling", | |||
"additionalProperties": true | |||
}, | |||
"failureState": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider simply "failure" instead of "failureState". I feel like almost everything here is "state".
baa28ca
to
9f7843f
Compare
No description provided.