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

[TRIVIAL] Fix API error message #3246

Merged
merged 2 commits into from
Jan 21, 2025
Merged

[TRIVIAL] Fix API error message #3246

merged 2 commits into from
Jan 21, 2025

Conversation

MartinquaXD
Copy link
Contributor

@MartinquaXD MartinquaXD commented Jan 21, 2025

Description

The API expects camelCase query parameters and parses them into snake_case Rust identifiers. Therefor the API actually expects the query parameter orderUid and not order_uid which should be reflected in the error message.

Changes

Updated error message to be correct from the perspective of the API consumer not the backend internals.

The error message also now uses or instead of and to more strongly indicate that only 1 parameter is expected. This was not obvious when a user provided the arguments order_uid and owner and was surprised that the request returned results for different orders.

@MartinquaXD MartinquaXD requested a review from a team as a code owner January 21, 2025 07:31
@MartinquaXD MartinquaXD enabled auto-merge (squash) January 21, 2025 07:31
@MartinquaXD MartinquaXD merged commit 9cf2e35 into main Jan 21, 2025
11 checks passed
@MartinquaXD MartinquaXD deleted the fix-api-error-message branch January 21, 2025 08:15
@github-actions github-actions bot locked and limited conversation to collaborators Jan 21, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants