Skip to content

Commit e6d8600

Browse files
Create RTK Query Code Generator for Open API Changelog (#3798)
* Create ChangeLog.md Create the initial changelog. * Add Details as provided by @phryneas Missed these details while perusing the commits.
1 parent e657098 commit e6d8600

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Changelog
2+
3+
All notable changes to the `RTK Query - Code Generator` for `Open API` project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## 1.1.3 - 10-11-2023
8+
9+
### Added
10+
- Adds a temporary workaround for [4.9.0 and 4.10.0 generate circular types oazapfts/oazapfts#491](https://github.com/oazapfts/oazapfts/issues/491)
11+
12+
## 1.1.2 - 10-11-2023
13+
14+
### Added
15+
- Support for Read Only Properties in the Open API spec. Previously, this property was ignored.
16+
- Now if the readOnly property is present and set to `true` in 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.
17+
- 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.
18+
19+
## 1.1.1 - 10-11-2023
20+
21+
### Changed
22+
- Codegen: better handling of duplicate param names ([Codegen: better handling of duplicate param names #3780](https://github.com/reduxjs/redux-toolkit/pull/3780))
23+
- If a parameter name is both used in a query and a parameter, it will be prefixed with `query`/`param` now to avoid conflicts
24+
25+
## 1.1.0 - 10-11-2023
26+
27+
### Added
28+
- Option of generating real TS enums instead of string unions [Adds the option of generating real TS enums instead of string unions #2854](https://github.com/reduxjs/redux-toolkit/pull/2854)
29+
- Compatibility with TypeScript 5.x versions as the codegen relies on the TypeScript AST for code generation
30+
- As a result also needs a higher TypeScript version to work with (old version range was 4.1-4.5)
31+
- Changes depenendcy from a temporarily patched old version of `oazapfts` back to the current upstream version

0 commit comments

Comments
 (0)