Skip to content

Create RTK Query Code Generator for Open API Changelog #3798

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 13, 2023
Merged

Create RTK Query Code Generator for Open API Changelog #3798

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
212b386
Create ChangeLog.md
elliot-huffman Oct 13, 2023
60a90d2
Add Details as provided by @phryneas
elliot-huffman Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions packages/rtk-query-codegen-openapi/ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Changelog

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](https://keepachangelog.com/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 1.1.3 - 10-11-2023

### Added
- 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)

## 1.1.2 - 10-11-2023

### Added
- 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 `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.
- 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.

## 1.1.1 - 10-11-2023

### Changed
- Codegen: better handling of duplicate param names ([Codegen: better handling of duplicate param names #3780](https://github.com/reduxjs/redux-toolkit/pull/3780))
- If a parameter name is both used in a query and a parameter, it will be prefixed with `query`/`param` now to avoid conflicts

## 1.1.0 - 10-11-2023

### Added
- 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)
- 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 `oazapfts` back to the current upstream version