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

feat(websoc): enhance WebSoc quarter parameter validation message #76

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

rsahyoun
Copy link
Contributor

@rsahyoun rsahyoun commented Jan 13, 2025

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):

image

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code involves a change to the database schema.
  • My code requires a change to the documentation.

@rsahyoun rsahyoun changed the title Added specific error message when quarter parameter is missing in websoc query fix(schema): enhance WebSoc quarter parameter validation message Jan 13, 2025
@rsahyoun rsahyoun changed the title fix(schema): enhance WebSoc quarter parameter validation message feat(schema): enhance WebSoc quarter parameter validation message Jan 13, 2025
@rsahyoun rsahyoun changed the title feat(schema): enhance WebSoc quarter parameter validation message feat(websoc): enhance WebSoc quarter parameter validation message Jan 13, 2025
@andrew-wang0 andrew-wang0 self-requested a review January 13, 2025 21:46
Copy link
Member

@andrew-wang0 andrew-wang0 left a comment

Choose a reason for hiding this comment

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

Looks good to me. Great work!

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.

2 participants