feat(websoc): enhance WebSoc quarter parameter validation message #76
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated the error message for the required quarter parameter in the WebSoc query schema. Previously, when the quarter parameter was omitted, the error message stated: "Required". The new message is more specific, telling the user that the quarter parameter is required.
Related Issue
Link to issue #72
Motivation and Context
When programmers were making websoc queries without the quarter parameter, the previous message was not helpful and unclear on what was missing. This change makes the API more clear in showing what is required when the quarter parameter is absent from the query.
How Has This Been Tested?
By running and hosting the API locally with Docker and pnpm, I was able to test my changes and confirm the results I was striving for while also confirming that there were no errors and that nothing broke in the process. The tests I ran included accessing the API locally through local host 8787 and testing parameters being present and absent along with values being present and absent for those parameters.
Screenshots (if appropriate):
Types of changes
Checklist: