[Nim] Fix compilation in case of schema with enum constraint with an enum value being not a valid nim identifier#20780
Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom May 20, 2025
Conversation
Contributor
Author
|
Note : I have identified others cases where generated Nim code will not compile due to invalid identifiers, I prefer to have atomic PRs instead of a huge 'fix them all'. I also need guidance of how to add unit tests for these edge cases so that the behaviour changes on generated code becomes more readeable when reviewing.. |
Member
|
thanks for the PR please pm me via slack to quickly walk through adding a test |
If enum constraint contains one value which is not a valid nim identifier, we must surround this identifier with backtick.
bb4b91f to
c2d3e6b
Compare
Member
|
i just merged #20819 into master can you please pull the latest master into your branch? and then update the test spec (modules/openapi-generator/src/test/resources/3_0/nim/petstore.yaml) with test schemas/endpoints. |
Member
|
let's give it a try and see if anyone from the community have time to contribute a fix |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a fix for bug #20779
In case of a schema with an enum constraint, nim code generation creates a nim objtect type enum with the enum values of this schema enum.
It must be valid identifier otherwise the code can not compile.
The fix is to
1/ detect if it is a valid nim identifier, job done with the isValidIdentifier private function, using a pattern based on the definition of a nim valid identifier (see https://nim-lang.org/docs/manual.html#lexical-analysis-identifiers-amp-keywords)
2/ If it is not a valid identifier, we surround the identifier with backticks.
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)@hokamoto