Create RTK Query Code Generator for Open API Changelog #3798
Conversation
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
Create the initial changelog.
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
✅ Deploy Preview for redux-starter-kit-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 60a90d2:
|
phryneas
reviewed
Oct 13, 2023
Comment on lines
7
to
12
| ## [1.1.3] - 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. |
Member
There was a problem hiding this comment.
There is a bit more of a change :)
Let me try to get it together:
1.1.0
- Adds the option of generating real TS enums instead of string unions Adds the option of generating real TS enums instead of string unions #2854
- Also ensures 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)
- Also changes depenendcy from a temporarily patched old version of
oazapftsback to the current upstream version
1.1.1
- 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 withquery/paramnow to avoid conflicts
1.1.2
- Support OpenAPI readOnly/writeOnly properties (Support OpenAPI readOnly/writeOnly properties #3430)
1.1.3
- adds a temporary workaround for 4.9.0 and 4.10.0 generate circular types oazapfts/oazapfts#491
Missed these details while perusing the commits.
Contributor
Author
|
Added the details you provided, I missed the implications of those while reading the commit messages. |
Member
|
Looking good, thanks a ton! 😊 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Create the initial changelog.
Other changes are to be included in the future.