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

[DR-70429] remove timezone enums from appeals schemas #823

Merged

Conversation

anniebtran
Copy link
Contributor

@anniebtran anniebtran commented Dec 5, 2023

New schema

We're removing the enum for timezones in the Decision Reviews schemas (SC, HLR, NOD) and letting Lighthouse take care of validating the proper set of timezones so that we don't have to manage them here and on the Lighthouse side. It makes it much easier for us to maintain and reduces errors that arise from an enum being out of date (i.e. the enums defined here... see ticket below for more details about the issues we're seeing)

Pull Requests to update the schema in related repositories

After you've merged your changes to vets-json-schema you'll need to make PR's to vets-website and vets-api. Please link them here.

{ "$ref": "#/definitions/timezone" }
]
}
"timezone": { "type": "string" }
},
"required": ["homeless", "phone", "email"],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to add "timezone" to this required field?

"$ref": "#/definitions/timezone"
}
]
"type": "string"
}
},
"required": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "timezone" to required?

"$ref": "#/definitions/timezone"
}
]
"type": "string"
}
},
"required": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "timezone" to required?

"$ref": "#/definitions/timezone"
}
]
"type": "string"
}
},
"required": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "timezone" to required?

@@ -196,753 +196,7 @@
},
"timezone": {
"type": "string",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "timezone" to required? Not sure where the required field is...

@anniebtran
Copy link
Contributor Author

@Mottie I didn't feel confident enough in how the schemas are used to validate to make anything required that wasn't required before 🥴 but if you're sure of where I should be adding required values, I can go ahead and do that.

I added a note in a few of the files but to summarize what I found — I tried to see if we could implement test specs for these schemas but they're using a structural version that isn't supported by the testing tool we're using for other specs.

@anniebtran anniebtran merged commit 6b17e39 into master Dec 7, 2023
5 checks passed
@anniebtran anniebtran deleted the DR-70429-remove-timezone-enums-from-appeals-schemas branch December 7, 2023 20:11
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