Update OpenAPI UUID parameter types - #915
Merged
chinweobtagaz merged 1 commit intoJul 31, 2026
Merged
Conversation
Contributor
Author
|
Hey @chinweobtagaz kindly review this pr |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR updates the OpenAPI parameter definitions for UUID path and query parameters to match the existing
actix_web::web::Path<Uuid>implementation.Changes
Uuidinstead ofString.Uuidinstead ofString.player_idquery parameter documentation to useOption<Uuid>.Why
The API handlers already use
Path<Uuid>, which automatically validates incoming UUIDs and returns a 400 Bad Request for malformed values. These changes keep the generated OpenAPI documentation consistent with the runtime behavior and clearly communicate that these parameters are UUIDs.Testing
cargo fmtcargo test -p api(all API tests passed)Closes #894