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.

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

Merged
merged 1 commit into from
May 28, 2024
Merged

Add CodeTF failure state to Result #31

merged 1 commit into from
May 28, 2024

Conversation

drdavella
Copy link
Member

No description provided.

@drdavella drdavella requested review from nahsra and gilday May 23, 2024 15:12
"failureState": {
"type": "object",
"properties": {
"failed": {
Copy link
Contributor

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.

Copy link
Member Author

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.

Copy link
Contributor

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

Copy link
Member Author

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.

@@ -87,6 +87,34 @@
"description": "Vendor-specific properties to help storytelling",
"additionalProperties": true
},
"failureState": {
Copy link
Contributor

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".

@drdavella drdavella merged commit 62434ba into main May 28, 2024
2 checks passed
@drdavella drdavella deleted the add-failure-state branch May 28, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants