All notable changes to the RTK Query - Code Generator for Open API project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
This version adds a new mergeReadWriteOnly configuration option (default to false) that, when set to true will not generate separate types for read-only and write-only properties.
- Adds a temporary workaround for 4.9.0 and 4.10.0 generate circular types oazapfts/oazapfts#491
- Support for Read Only Properties in the Open API spec. Previously, this property was ignored.
- Now if the readOnly property is present and set to
truein a schema, it will split the type into two types: one with the read only property suffixed as 'Read' and the other without the read only properties, using the same type name as before. - This may cause issues if you had your OpenAPI spec properly typed/configured, as it will remove the read onyl types from your existing type. You will need to switch to the new type suffixed as 'Read' to avoid missing property names.
- Now if the readOnly property is present and set to
- Codegen: better handling of duplicate param names (Codegen: better handling of duplicate param names #3780)
- If a parameter name is both used in a query and a parameter, it will be prefixed with
query/paramnow to avoid conflicts
- If a parameter name is both used in a query and a parameter, it will be prefixed with
- Option of generating real TS enums instead of string unions Adds the option of generating real TS enums instead of string unions #2854
- Compatibility with TypeScript 5.x versions as the codegen relies on the TypeScript AST for code generation
- As a result also needs a higher TypeScript version to work with (old version range was 4.1-4.5)
- Changes depenendcy from a temporarily patched old version of
oazapftsback to the current upstream version