Handle leading underscores in property names#1822
Merged
jamietanna merged 2 commits intooapi-codegen:mainfrom Nov 4, 2024
Merged
Handle leading underscores in property names#1822jamietanna merged 2 commits intooapi-codegen:mainfrom
jamietanna merged 2 commits intooapi-codegen:mainfrom
Conversation
Member
|
Thanks for the fix, @tobio! Mind running |
Contributor
Author
|
I should read the docs better :) Done. I'll take a look at adding a BWC option for this tomorrow if that makes sense? |
Member
|
NP! For these ones, we generally don't try and make them backwards-compatible, so I'm happy merging as-is 😀 |
jamietanna
approved these changes
Nov 4, 2024
mdjarv
pushed a commit
to mdjarv/oapi-codegen
that referenced
this pull request
Nov 12, 2024
…gen#1822) Similar to other changes we've made to make our generated field names more predictable - and in many cases, valid Go names - we should tweak how a leading underscore is used in a field name. This avoids cases with a spec such as: ```yaml properties: _version: type: string version: type: int ``` Which would previously generate duplicate field names, `Version` and `Version`. Instead, we now produce `_Version` and `Version`. Co-authored-by: Jamie Tanna <jamie.tanna@elastic.co>
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
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.
I'm working with a spec that has something like:
Now surely there's some better naming they could have used whilst designing the response, but that's not in my control. As it is, oapi-codegen generates a duplicate
Versionfield for both of these properties.This PR updates the name prefix to add an
Underscoreprefix in this case, de-duplicating the field names.