-
Notifications
You must be signed in to change notification settings - Fork 21
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.
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
fix: openapi spec schema.type #1023
base: master
Are you sure you want to change the base?
Conversation
e37f6fa
to
75b09a0
Compare
@youngjungithub, I've put this back into draft until the following action items are complete:
|
e8fdd05
to
6776a13
Compare
…parameter support Corrected a typo in knownImports.ts and enhanced query parameter generation logic ensuring compliance with OpenAPI 3.0.3 specifications. These changes produce a more accurate and complete OpenAPI spec, with query parameters now properly documented alongside schema types, improving API usability and clarity for downstream consumers.
a1c893c
to
a69b8e5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Outstanding work! You turned this into a readable addition, which in turn will make our OpenAPI output more readable and idiomatic.
There are two outstanding points to address:
- Please ensure all new functionality (lines of code may act as a proxy) is under test. This will prevent accidental regression in the future.
- Please rework the commit message so it is usable as a release note. Here is an example of a good commit message -- it includes a summary of the change, and the backing motivation; it helps the reader visualize which parts of an apiSpec will generate different OpenAPI output, and how that output has changed.
This data may not seem important to add in a commit message, since much of the information can be seen in the commit itself, but the release pipeline uses this commit message to create release notes, and this information will be valuable to openapi-generator users.
Once these points are addressed, this code looks ready to ship!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work in this file, @youngjungithub! Will you please adding any test cases necessary to ensure every custom mapping is under test?
Query parameters in the OpenAPI specifications are incorrectly defined as type: string, even when they represent other data types such as integers (e.g., count=100).
This misrepresentation causes confusion for API consumers, as the specs do not accurately reflect the expected data types. It also undermines proper validation and the quality of auto-generated documentation.