Breaking change introduced by “Handle leading underscores in property names”
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Bug
- Clareza
- Claramente especificada
- Status de atividade
- Estagnada
- Stack de tecnologia
- go
- Domínio
- backend-api-design
Direção de pesquisa
Review the PR #1822 that introduced the change. Examine the code generation logic, likely in the package handling property name transformation. Understand the breaking change's impact on existing generated structs. Determine if a flag, conditional logic, or versioning strategy is needed to restore backward compatibility.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
I believe the recent change to handle leading underscores in property names has introduced a breaking change in how the oapi-codegen generates structs. https://github.com/oapi-codegen/oapi-codegen/pull/1822
This renaming alters the generated code and breaks existing code that relies on the previous field names. While I understand the goal of avoiding duplicate names, this change modifies the generated code and therefore should be considered a breaking change.
Additionally, it exposes implementation details of the OpenAPI spec (like the underscore prefix) into the generated Go code, which can be undesirable when consumers expect normalized field names.
What I expected
The generated field names to stay consistent with previous behavior, or at least a clear note that this change breaks compatibility (e.g. via a major version bump or release note).
What happened
The generated code now prefixes fields with Underscore, breaking compatibility with previously generated code.
Suggestions
Maybe this behavior could be:
- Behind a flag, or
- Only enforced when duplicate fields are present, or
- Called out clearly in the changelog or release notes if it’s meant to be permanent
- Linguagem predominante
- Go
- Estrelas
- 8.6k
- Forks
- 1.1k
- Merge médio
- 14h 45min
- PRs com merge (30d)
- 29
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de oapi-codegen/oapi-codegen
-
area:*of bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
oapi-codegen/oapi-codegen#2593 ·
Mantenedores costumam responder em até 1 dia
-
client
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
oapi-codegen/oapi-codegen#2483 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
oapi-codegen/oapi-codegen#2408 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
oapi-codegen/oapi-codegen#2397 · 3 comentários ·
Mantenedores costumam responder em até 1 dia
-
documentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
oapi-codegen/oapi-codegen#2168 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
Todas as issues de oapi-codegen/oapi-codegen
Issues semelhantes
-
bug
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
open-telemetry/opentelemetry-go-compile-instrumentation#1417 ·
Mantenedores costumam responder em até 2 dias
-
agent-research-finding agent-research-recommend chore ready-for-agent
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
jordansmall/spindrift#4068 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Type/Task
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
OpenNSW/nsw-srilanka#537 ·
Mantenedores costumam responder em até 1 dia
-
security
Dificuldade 2/5 1-2 dias Facilidade para iniciantes 62/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 90/100
Mantenedores costumam responder em até 1 dia