Commit 914bfd7
feat: multi-pass type name resolution
I've been meaning to use this approach for a long time, because
the attempts at avoiding type collisions via structure suffixes or
prefixes work sporadically, at best.
Conflict resolution is fundamentally a global problem, not a local
problem when doing recursive traversal, so this PR splits the code
generation into two parts. First, the OAPI document structure is
traversed, and all the schemas that we generate are gathered up
into a list of candidates, then we do global conflict resolution
across the space of all schemas. This allows us to preserve the
functionality of things affected by schema name - `$ref`, `required`
properties, and so forth.
This fixes issue #1474 (client response wrapper type colliding with
a component schema of the same name and improves issue #200 handling
(same name across schemas, parameters, responses, requestBodies,
headers).
The new system is gated behind the existing `resolve-type-name-collisions`
output option. When disabled, behavior is unchanged, oapi-codegen exits
with an error. This flag is default false, so there is no behavior change
to oapi-codegen unless it's specified. All current test files regenerate
without any differences.
Added a comprehensive test which reproduces the scenarios in all the
PR's and Issues below, and adds a few more, to make sure that references
to renamed targets are also correct..
Key changes:
- gather.go: walks entire spec collecting schemas with location metadata
- resolve_names.go: assigns unique names via context suffix, per-schema
disambiguation, and numeric fallback strategies
- Component schemas are privileged and keep bare names on collision
- Client response wrapper types now participate in collision detection
- Removed ComponentType/DefinedComp from Schema struct
- Removed FixDuplicateTypeNames and related functions from utils.go
Obsoletes issues:
- #1474 Schema name vs client wrapper (CreateChatCompletionResponse)
- #1713 Schema name vs client wrapper (CreateBlueprintResponse)
- #1450 Schema name vs client wrapper (DeleteBusinessResponse)
- #2097 Path response type vs schema definition (Status)
- #255 Endpoint path vs response type (QueryResponse)
- #899 Duplicate types from response wrapper vs schema (AccessListResponse)
- #1357 Schema vs operationId response (ListAssistantsResponse, OpenAI spec)
- #254 Cross-section: requestBodies vs schemas (Pet)
- #407 Cross-section: requestBodies vs schemas (myThing)
- #1881 Cross-section: requestBodies with multiple content types
Obsoletes PRs:
- #292 Parameter structures params postfix (superseded by context suffix)
- #1005 Fix generate equals structs (superseded by multi-pass resolution)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
EOF
)1 parent efb2df3 commit 914bfd7
File tree
20 files changed
+3195
-582
lines changed- internal/test
- issues/issue-200
- name_conflict_resolution
- pkg/codegen
20 files changed
+3195
-582
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
255 | 255 | | |
256 | 256 | | |
257 | 257 | | |
258 | | - | |
| 258 | + | |
259 | 259 | | |
260 | 260 | | |
261 | 261 | | |
| |||
This file was deleted.
This file was deleted.
This file was deleted.
0 commit comments