Release v5.0.0
RoZod v5.0.0 Release Notes
Breaking Changes
-
Request methods must now be uppercase: All API request methods (GET, POST, PUT, DELETE, PATCH) must now be uppercase. If you have defined custom endpoints, you'll need to update the
methodproperty. -
Path parameter handling fixed: Path parameters are no longer incorrectly added as query parameters. This fixes a bug but may change behavior if you were relying on the old behavior.
Major Enhancements
OpenCloud API Support
We have added comprehensive OpenCloud API endpoints support, by generating them directly from the Roblox Docs.
If anything seems wrong, please do a PR to this repo, and make an issue here after.
New Endpoints
- Added many missing endpoints across various Roblox API services: a7d7321#diff-4efe52146d177e544cc121d98f2ff48e3ab37fdcc03e2b1d00133170172f4f85
Other Changes
- Updated codegen to use legacy documentation sources
- Updated README with new functionality and examples
- Fixed various tests to use correct methods for API calls
Migration Guide
Updating Request Methods
If you've defined custom endpoints, update the method to be uppercase:
// Before
const myEndpoint = endpoint({
method: 'get',
path: '/v1/resource',
// ...
});
// After
const myEndpoint = endpoint({
method: 'GET',
path: '/v1/resource',
// ...
});Path Parameter Changes
If you were relying on path parameters being added as query parameters, you'll need to adjust your code. Path parameters are now correctly only used in the URL path and not added as query parameters.
Feedback
If you encounter any issues with this release, please open an issue on GitHub.