Add TypeBox Enum Support for OpenAPI #267
Merged
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
runyasak
force-pushed
the
feat/type-enum
branch
from
f9d1f6c to
f372188
Compare
SaltyAom
reviewed
Sep 21, 2025
| body, | ||
| definitions | ||
| ) | ||
| const { type: _type, description, $ref, ...options } = convertedBody |
Member
There was a problem hiding this comment.
unwrapReference is missing, but I can handle that
Contributor
Author
There was a problem hiding this comment.
Oh, I apologized for implementing unwrapReference.
Thank you for handling it for me.
SaltyAom
approved these changes
Sep 21, 2025
Member
|
|
Contributor
Author
|
@SaltyAom Thank you so much for reviewing and merging my PR krub. |
Member
|
Don't worry, I added a test case to prevent it from breaking for the next time Anyway, nice PR, thank you |
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.
Overview
TypeBox enums were being converted to
anyOfformat instead of the standardOpenAPIenum format, which caused issues in API documentation generation.So, I implemented support for converting enums to proper OpenAPI format.
Scope of work
Added
convertEnumToOpenApifunction for converting TypeBox enum toOpenAPIScreenshot
Discussions
I'm not certain about the good approach for inferring
schematype.While I recognize that using
anyis not a good practice, I implemented it for ease of development.I would appreciate your suggestions on how to improve type safety in this area.
This is my first PR for this project. If you have any feedback or suggestions, please do not hesitate to let me know. I will update the PR as soon as possible.