-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcodegen.go
More file actions
1109 lines (949 loc) · 33.9 KB
/
codegen.go
File metadata and controls
1109 lines (949 loc) · 33.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Package codegen generates Go code from parsed OpenAPI specs.
package codegen
import (
"fmt"
"sort"
"strings"
"github.com/pb33f/libopenapi"
"github.com/pb33f/libopenapi/datamodel/high/base"
"golang.org/x/tools/imports"
"github.com/oapi-codegen/oapi-codegen-exp/codegen/internal/dce"
"github.com/oapi-codegen/oapi-codegen-exp/codegen/internal/runtimeextract"
"github.com/oapi-codegen/oapi-codegen-exp/codegen/internal/templates"
runtime "github.com/oapi-codegen/oapi-codegen-exp/codegen/internal/runtime"
)
// Generate produces Go code from the parsed OpenAPI document.
// specData is the raw spec bytes used to embed the spec in the generated code.
func Generate(doc libopenapi.Document, specData []byte, cfg Configuration) (string, error) {
cfg.ApplyDefaults()
// Build the V3 model once — all gather functions share this single build.
model, err := doc.BuildV3Model()
if err != nil {
return "", fmt.Errorf("building v3 model: %w", err)
}
if model == nil {
return "", fmt.Errorf("failed to build v3 model")
}
v3Doc := &model.Model
// Create a single CodegenContext that all generators share.
ctx := NewCodegenContext()
// Configure runtime package prefixes if an external runtime is specified.
var runtimePrefixes RuntimePrefixes
if cfg.Generation.RuntimePackage != nil {
runtimePrefixes = RuntimePrefixes{
Params: "oapiCodegenParamsPkg.",
Types: "oapiCodegenTypesPkg.",
Helpers: "oapiCodegenHelpersPkg.",
}
ctx.SetRuntimePrefixes(runtimePrefixes.Params, runtimePrefixes.Types, runtimePrefixes.Helpers)
}
// Create content type matcher for filtering request/response bodies
contentTypeMatcher := NewContentTypeMatcher(cfg.ContentTypes)
// Create content type short namer for friendly type names
contentTypeNamer := NewContentTypeShortNamer(cfg.ContentTypeShortNames)
// Pass 1: Gather all schemas that need types.
// Operation filters (include/exclude tags, operation IDs) are applied during
// gathering so that schemas from excluded operations are never collected.
schemas, err := GatherSchemas(v3Doc, contentTypeMatcher, cfg.OutputOptions)
if err != nil {
return "", fmt.Errorf("gathering schemas: %w", err)
}
// Filter explicitly excluded schemas
schemas = FilterSchemasByName(schemas, cfg.OutputOptions.ExcludeSchemas)
// Optionally prune component schemas that aren't referenced by any other schema
if cfg.OutputOptions.PruneUnreferencedSchemas {
schemas = PruneUnreferencedSchemas(schemas)
}
// Pass 2: Compute names for all schemas
converter := NewNameConverter(cfg.NameMangling, cfg.NameSubstitutions)
ComputeSchemaNames(schemas, converter, contentTypeNamer)
// Build schema index for type resolution
schemaIndex := make(map[string]*SchemaDescriptor)
for _, s := range schemas {
schemaIndex[s.Path.String()] = s
}
// Pass 3: Generate Go code
importResolver, err := NewImportResolver(cfg.ImportMapping)
if err != nil {
return "", fmt.Errorf("parsing import-mapping: %w", err)
}
tagGenerator := NewStructTagGenerator(cfg.StructTags)
gen := NewTypeGenerator(cfg.TypeMapping, converter, importResolver, tagGenerator, ctx)
gen.IndexSchemas(schemas)
// Enum pre-pass: collect EnumInfo for all enum schemas, run collision detection
gen.resolveEnumNames(schemas, cfg.OutputOptions.AlwaysPrefixEnumValues)
output := NewOutput(cfg.PackageName)
// ── Phase 1: Generate all code sections ──
// Generate models (types for schemas) unless using external models package
if cfg.Generation.ModelsPackage == nil {
for _, desc := range schemas {
code := generateType(gen, desc)
if code != "" {
output.AddType(code)
}
}
// Embed the raw OpenAPI spec if specData was provided
if len(specData) > 0 {
embeddedCode, err := generateEmbeddedSpec(specData)
if err != nil {
return "", fmt.Errorf("generating embedded spec: %w", err)
}
output.AddType(embeddedCode)
ctx.AddImport("bytes")
ctx.AddImport("compress/gzip")
ctx.AddImport("encoding/base64")
ctx.AddImport("fmt")
ctx.AddImport("strings")
ctx.AddImport("sync")
}
}
// Gather operations once — reused by client and server.
var ops []*OperationDescriptor
if cfg.Generation.Client || cfg.Generation.Server != "" {
ops, err = GatherOperations(v3Doc, ctx, contentTypeMatcher, cfg.TypeMapping)
if err != nil {
return "", fmt.Errorf("gathering operations: %w", err)
}
ops = FilterOperations(ops, cfg.OutputOptions)
}
// Generate client code if requested
if cfg.Generation.Client {
clientGen, err := NewClientGenerator(schemaIndex, cfg.Generation.SimpleClient, cfg.Generation.ModelsPackage, runtimePrefixes, cfg.TypeMapping)
if err != nil {
return "", fmt.Errorf("creating client generator: %w", err)
}
clientCode, err := clientGen.GenerateClient(ops)
if err != nil {
return "", fmt.Errorf("generating client code: %w", err)
}
output.AddType(clientCode)
// Add client template imports (base + shared sender templates)
for _, ct := range templates.ClientTemplates {
ctx.AddTemplateImports(ct.Imports)
}
for _, st := range templates.SenderTemplates {
ctx.AddTemplateImports(st.Imports)
}
// Add models package import if using external models
if cfg.Generation.ModelsPackage != nil && cfg.Generation.ModelsPackage.Path != "" {
ctx.AddImportAlias(cfg.Generation.ModelsPackage.Path, cfg.Generation.ModelsPackage.Alias)
}
}
// Track whether shared error types have been generated to avoid duplication.
generatedErrors := false
// Generate server code for path operations if a server framework is set.
if cfg.Generation.Server != "" {
if len(ops) > 0 {
serverGen, err := NewServerGenerator(cfg.Generation.Server, runtimePrefixes)
if err != nil {
return "", fmt.Errorf("creating server generator: %w", err)
}
serverCode, err := serverGen.GenerateServer(ops)
if err != nil {
return "", fmt.Errorf("generating server code: %w", err)
}
output.AddType(serverCode)
generatedErrors = true
// Add server template imports
serverTemplates, err := getServerTemplates(cfg.Generation.Server)
if err != nil {
return "", fmt.Errorf("getting server templates: %w", err)
}
for _, st := range serverTemplates {
ctx.AddTemplateImports(st.Imports)
}
}
}
// Gather webhook operations once — reused by initiator and receiver.
var webhookOps []*OperationDescriptor
if cfg.Generation.WebhookInitiator || cfg.Generation.WebhookReceiver {
webhookOps, err = GatherWebhookOperations(v3Doc, ctx, contentTypeMatcher, cfg.TypeMapping)
if err != nil {
return "", fmt.Errorf("gathering webhook operations: %w", err)
}
}
// Gather callback operations once — reused by initiator and receiver.
var callbackOps []*OperationDescriptor
if cfg.Generation.CallbackInitiator || cfg.Generation.CallbackReceiver {
callbackOps, err = GatherCallbackOperations(v3Doc, ctx, contentTypeMatcher, cfg.TypeMapping)
if err != nil {
return "", fmt.Errorf("gathering callback operations: %w", err)
}
}
// Generate webhook initiator code if requested
if cfg.Generation.WebhookInitiator {
if len(webhookOps) > 0 {
initiatorGen, err := NewInitiatorGenerator("Webhook", schemaIndex, true, cfg.Generation.ModelsPackage, runtimePrefixes, cfg.TypeMapping)
if err != nil {
return "", fmt.Errorf("creating webhook initiator generator: %w", err)
}
initiatorCode, err := initiatorGen.GenerateInitiator(webhookOps)
if err != nil {
return "", fmt.Errorf("generating webhook initiator code: %w", err)
}
output.AddType(initiatorCode)
// Add initiator template imports (base + shared sender templates)
for _, pt := range templates.InitiatorTemplates {
ctx.AddTemplateImports(pt.Imports)
}
for _, st := range templates.SenderTemplates {
ctx.AddTemplateImports(st.Imports)
}
if cfg.Generation.ModelsPackage != nil && cfg.Generation.ModelsPackage.Path != "" {
ctx.AddImportAlias(cfg.Generation.ModelsPackage.Path, cfg.Generation.ModelsPackage.Alias)
}
}
}
// Generate callback initiator code if requested
if cfg.Generation.CallbackInitiator {
if len(callbackOps) > 0 {
initiatorGen, err := NewInitiatorGenerator("Callback", schemaIndex, true, cfg.Generation.ModelsPackage, runtimePrefixes, cfg.TypeMapping)
if err != nil {
return "", fmt.Errorf("creating callback initiator generator: %w", err)
}
initiatorCode, err := initiatorGen.GenerateInitiator(callbackOps)
if err != nil {
return "", fmt.Errorf("generating callback initiator code: %w", err)
}
output.AddType(initiatorCode)
// Add initiator template imports (base + shared sender templates)
for _, pt := range templates.InitiatorTemplates {
ctx.AddTemplateImports(pt.Imports)
}
for _, st := range templates.SenderTemplates {
ctx.AddTemplateImports(st.Imports)
}
if cfg.Generation.ModelsPackage != nil && cfg.Generation.ModelsPackage.Path != "" {
ctx.AddImportAlias(cfg.Generation.ModelsPackage.Path, cfg.Generation.ModelsPackage.Alias)
}
}
}
// Generate webhook receiver code if requested
if cfg.Generation.WebhookReceiver {
if cfg.Generation.Server == "" {
return "", fmt.Errorf("webhook-receiver requires server to be set")
}
if len(webhookOps) > 0 {
receiverGen, err := NewReceiverGenerator("Webhook", cfg.Generation.Server, runtimePrefixes)
if err != nil {
return "", fmt.Errorf("creating webhook receiver generator: %w", err)
}
receiverCode, err := receiverGen.GenerateReceiver(webhookOps)
if err != nil {
return "", fmt.Errorf("generating webhook receiver code: %w", err)
}
output.AddType(receiverCode)
paramTypes, err := receiverGen.GenerateParamTypes(webhookOps)
if err != nil {
return "", fmt.Errorf("generating webhook receiver param types: %w", err)
}
output.AddType(paramTypes)
if !generatedErrors {
errors, err := receiverGen.GenerateErrors()
if err != nil {
return "", fmt.Errorf("generating webhook receiver errors: %w", err)
}
output.AddType(errors)
generatedErrors = true
}
receiverTemplates, err := getReceiverTemplates(cfg.Generation.Server)
if err != nil {
return "", fmt.Errorf("getting receiver templates: %w", err)
}
for _, ct := range receiverTemplates {
ctx.AddTemplateImports(ct.Imports)
}
for _, st := range templates.SharedServerTemplates {
ctx.AddTemplateImports(st.Imports)
}
}
}
// Generate callback receiver code if requested
if cfg.Generation.CallbackReceiver {
if cfg.Generation.Server == "" {
return "", fmt.Errorf("callback-receiver requires server to be set")
}
if len(callbackOps) > 0 {
receiverGen, err := NewReceiverGenerator("Callback", cfg.Generation.Server, runtimePrefixes)
if err != nil {
return "", fmt.Errorf("creating callback receiver generator: %w", err)
}
receiverCode, err := receiverGen.GenerateReceiver(callbackOps)
if err != nil {
return "", fmt.Errorf("generating callback receiver code: %w", err)
}
output.AddType(receiverCode)
paramTypes, err := receiverGen.GenerateParamTypes(callbackOps)
if err != nil {
return "", fmt.Errorf("generating callback receiver param types: %w", err)
}
output.AddType(paramTypes)
if !generatedErrors {
errors, err := receiverGen.GenerateErrors()
if err != nil {
return "", fmt.Errorf("generating callback receiver errors: %w", err)
}
output.AddType(errors)
generatedErrors = true //nolint:ineffassign // kept for symmetry with webhook loop
}
receiverTemplates, err := getReceiverTemplates(cfg.Generation.Server)
if err != nil {
return "", fmt.Errorf("getting receiver templates: %w", err)
}
for _, ct := range receiverTemplates {
ctx.AddTemplateImports(ct.Imports)
}
for _, st := range templates.SharedServerTemplates {
ctx.AddTemplateImports(st.Imports)
}
}
}
// ── Phase 2: Render helpers ──
if cfg.Generation.RuntimePackage != nil {
// Runtime package is configured — don't embed helpers, import them.
// Always add all three sub-package imports; the Go compiler and goimports
// will strip any that end up unused.
ctx.AddImportAlias(cfg.Generation.RuntimePackage.TypesImport(), "oapiCodegenTypesPkg")
ctx.AddImportAlias(cfg.Generation.RuntimePackage.ParamsImport(), "oapiCodegenParamsPkg")
ctx.AddImportAlias(cfg.Generation.RuntimePackage.HelpersImport(), "oapiCodegenHelpersPkg")
} else {
// Inline mode: emit all runtime code, DCE will remove unused declarations.
runtimeCode, runtimeImports, err := runtimeextract.ExtractAllInline(runtime.SourceFS)
if err != nil {
return "", fmt.Errorf("extracting runtime code: %w", err)
}
output.AddType(runtimeCode)
for _, imp := range runtimeImports {
if imp.Alias != "" {
ctx.AddImportAlias(imp.Path, imp.Alias)
} else {
ctx.AddImport(imp.Path)
}
}
}
// ── Phase 3: Assemble output ──
// Transfer all imports from ctx to output
output.AddImports(ctx.Imports())
formatted, err := output.Format()
if err != nil {
return "", err
}
// Run DCE to remove unused runtime declarations (only relevant in inline mode).
if cfg.Generation.RuntimePackage == nil {
formatted, err = dce.EliminateDeadCode(formatted)
if err != nil {
return "", fmt.Errorf("dead code elimination: %w", err)
}
// DCE re-prints via go/printer which changes formatting; normalize with goimports.
reformatted, err := imports.Process("", []byte(formatted), nil)
if err != nil {
return "", fmt.Errorf("formatting after DCE: %w", err)
}
formatted = string(reformatted)
}
return formatted, nil
}
// generateType generates Go code for a single schema descriptor.
func generateType(gen *TypeGenerator, desc *SchemaDescriptor) string {
kind := GetSchemaKind(desc)
// If schema has TypeOverride extension, generate a type alias to the external type
// instead of generating the full type definition
if desc.Extensions != nil && desc.Extensions.TypeOverride != nil {
return generateTypeOverrideAlias(gen, desc)
}
var code string
switch kind {
case KindReference:
// Internal references don't generate new types; they use the referenced type's name.
// However, component schemas that are $ref to external types need a type alias
// so that local types can reference them by their local name.
if desc.IsExternalReference() && desc.IsTopLevelComponentSchema() && desc.ShortName != "" {
code = generateExternalRefAlias(gen, desc)
break
}
return ""
case KindStruct:
code = generateStructType(gen, desc)
case KindMap:
code = generateMapAlias(gen, desc)
case KindEnum:
code = generateEnumType(gen, desc)
case KindAllOf:
code = generateAllOfType(gen, desc)
case KindAnyOf:
code = generateAnyOfType(gen, desc)
case KindOneOf:
code = generateOneOfType(gen, desc)
case KindAlias:
code = generateTypeAlias(gen, desc)
default:
return ""
}
if code == "" {
return ""
}
// Prepend schema path comment
return schemaPathComment(desc.Path) + code
}
// schemaPathComment returns a comment line showing the schema path.
func schemaPathComment(path SchemaPath) string {
return fmt.Sprintf("// %s\n", path.String())
}
// generateStructType generates a struct type for an object schema.
func generateStructType(gen *TypeGenerator, desc *SchemaDescriptor) string {
fields := gen.GenerateStructFields(desc)
doc := extractDescription(desc.Schema)
// Check if we need additionalProperties handling
if gen.HasAdditionalProperties(desc) {
gen.AddJSONImport()
gen.AddImport("fmt")
addPropsType := gen.AdditionalPropertiesType(desc)
structCode := GenerateStructWithAdditionalProps(desc.ShortName, fields, addPropsType, doc, gen.TagGenerator())
addPropsCode, err := GenerateAdditionalPropertiesCode(desc.ShortName, fields, addPropsType)
if err != nil {
return fmt.Sprintf("// ERROR generating additional properties for %s: %v\n", desc.ShortName, err)
}
code := structCode + "\n" + addPropsCode
applyDefaults, needsReflect, err := GenerateApplyDefaultsCode(desc.ShortName, fields)
if err != nil {
return fmt.Sprintf("// ERROR generating ApplyDefaults for %s: %v\n", desc.ShortName, err)
}
code += "\n" + applyDefaults
if needsReflect {
gen.AddImport("reflect")
}
return code
}
code := GenerateStruct(desc.ShortName, fields, doc, gen.TagGenerator())
applyDefaults, needsReflect, err := GenerateApplyDefaultsCode(desc.ShortName, fields)
if err != nil {
return fmt.Sprintf("// ERROR generating ApplyDefaults for %s: %v\n", desc.ShortName, err)
}
code += "\n" + applyDefaults
if needsReflect {
gen.AddImport("reflect")
}
return code
}
// generateMapAlias generates a type alias for a pure map schema.
func generateMapAlias(gen *TypeGenerator, desc *SchemaDescriptor) string {
mapType := gen.GoTypeExpr(desc)
doc := extractDescription(desc.Schema)
return GenerateTypeAlias(desc.ShortName, mapType, doc)
}
// generateEnumType generates an enum type with const values.
// It uses pre-computed EnumInfo from the enum pre-pass for collision-aware naming.
func generateEnumType(gen *TypeGenerator, desc *SchemaDescriptor) string {
info, ok := gen.enumInfoMap[desc.Path.String()]
if !ok {
// Fallback: shouldn't happen, but build info on the fly
info = gen.buildEnumInfo(desc)
if info == nil {
return ""
}
computeEnumConstantNames([]*EnumInfo{info}, gen.converter)
}
return GenerateEnumFromInfo(info)
}
// generateExternalRefAlias generates a type alias for a component schema that is
// a $ref to an external type. This ensures the local name exists so other local
// types can reference it.
func generateExternalRefAlias(gen *TypeGenerator, desc *SchemaDescriptor) string {
goType := gen.externalRefType(desc)
if goType == "any" {
return ""
}
return GenerateTypeAlias(desc.ShortName, goType, "")
}
// generateTypeAlias generates a simple type alias.
func generateTypeAlias(gen *TypeGenerator, desc *SchemaDescriptor) string {
goType := gen.GoTypeExpr(desc)
doc := extractDescription(desc.Schema)
return GenerateTypeAlias(desc.ShortName, goType, doc)
}
// generateTypeOverrideAlias generates a type alias to an external type specified via x-oapi-codegen-type-override.
func generateTypeOverrideAlias(gen *TypeGenerator, desc *SchemaDescriptor) string {
override := desc.Extensions.TypeOverride
// Register the import
if override.ImportPath != "" {
if override.ImportAlias != "" {
gen.AddImportAlias(override.ImportPath, override.ImportAlias)
} else {
gen.AddImport(override.ImportPath)
}
}
doc := extractDescription(desc.Schema)
return GenerateTypeAlias(desc.ShortName, override.TypeName, doc)
}
// AllOfMergeError represents a conflict when merging allOf schemas.
type AllOfMergeError struct {
SchemaName string
PropertyName string
Type1 string
Type2 string
}
func (e AllOfMergeError) Error() string {
return fmt.Sprintf("allOf merge conflict in %s: property %q has conflicting types %s and %s",
e.SchemaName, e.PropertyName, e.Type1, e.Type2)
}
// allOfMemberInfo holds information about an allOf member for merging.
type allOfMemberInfo struct {
fields []StructField // flattened fields from object schemas
unionType string // non-empty if this member is a oneOf/anyOf union
unionDesc *SchemaDescriptor
required []string // required fields from this allOf member
refType string // non-empty if this member is a $ref (the JSON pointer)
}
// generateAllOfType generates a struct with flattened properties from all allOf members.
// Object schema properties are merged into flat fields.
// oneOf/anyOf members become union fields with json:"-" tag.
func generateAllOfType(gen *TypeGenerator, desc *SchemaDescriptor) string {
schema := desc.Schema
if schema == nil {
return ""
}
// Merge extensions from all allOf members into a composite.
// This mirrors V2's MergeSchemas which merges extensions before type generation.
mergedExt := mergeAllOfExtensions(desc, gen.schemaIndex)
// Merge all fields, checking for conflicts
mergedFields := make(map[string]StructField) // keyed by JSONName
var fieldOrder []string // preserve order
var unionFields []StructField
// First, collect fields from properties defined directly on the schema
// (Issue 2102: properties at same level as allOf were being ignored)
if schema.Properties != nil && schema.Properties.Len() > 0 {
directFields := gen.GenerateStructFields(desc)
for _, field := range directFields {
mergedFields[field.JSONName] = field
fieldOrder = append(fieldOrder, field.JSONName)
}
}
// Collect info about each allOf member
var members []allOfMemberInfo
for i, proxy := range schema.AllOf {
info := allOfMemberInfo{}
memberSchema := proxy.Schema()
if memberSchema == nil {
continue
}
// Check if this member is a oneOf/anyOf (union type)
if len(memberSchema.OneOf) > 0 || len(memberSchema.AnyOf) > 0 {
// This is a union - keep as a union field
if desc.AllOf != nil && i < len(desc.AllOf) {
info.unionType = desc.AllOf[i].ShortName
info.unionDesc = desc.AllOf[i]
}
} else if proxy.IsReference() {
// Reference to another schema - get its fields
ref := proxy.GetReference()
info.refType = ref
if target, ok := gen.schemaIndex[ref]; ok {
info.fields = gen.collectFieldsRecursive(target)
}
} else if memberSchema.Properties != nil && memberSchema.Properties.Len() > 0 {
// Inline object schema - get its fields
if desc.AllOf != nil && i < len(desc.AllOf) {
info.fields = gen.GenerateStructFields(desc.AllOf[i])
}
}
// Also check for required array in allOf members (may mark fields as required)
info.required = memberSchema.Required
members = append(members, info)
}
// After field collection: if no fields were found, check if the composite
// should be a type alias (TypeOverride from a $ref target, no struct properties).
if len(mergedFields) == 0 && !hasAnyFields(members) {
if mergedExt != nil && mergedExt.TypeOverride != nil {
desc.Extensions = mergedExt
return generateTypeOverrideAlias(gen, desc)
}
}
// Merge fields from allOf members
for _, member := range members {
if member.unionType != "" {
// Add union as a special field
unionFields = append(unionFields, StructField{
Name: member.unionType,
Type: "*" + member.unionType,
JSONName: "-", // will use json:"-"
})
continue
}
for _, field := range member.fields {
if existing, ok := mergedFields[field.JSONName]; ok {
// Check for type conflict
if existing.Type != field.Type {
// Type conflict - generate error comment in output
// In a real implementation, this should be a proper error
// For now, we'll include a comment and use the first type
field.Doc = fmt.Sprintf("CONFLICT: type %s vs %s", existing.Type, field.Type)
}
// If same type, keep existing (first wins for required/nullable)
continue
}
mergedFields[field.JSONName] = field
fieldOrder = append(fieldOrder, field.JSONName)
}
// Apply required array from this allOf member to update pointer/omitempty
for _, reqName := range member.required {
if field, ok := mergedFields[reqName]; ok {
applyRequiredOverride(&field)
mergedFields[reqName] = field
}
}
}
// Build final field list in order
var finalFields []StructField
for _, jsonName := range fieldOrder {
finalFields = append(finalFields, mergedFields[jsonName])
}
doc := extractDescription(schema)
// Generate struct
var code string
if len(unionFields) > 0 {
// Has union members - need custom marshal/unmarshal
gen.AddJSONImport()
code = generateAllOfStructWithUnions(desc.ShortName, finalFields, unionFields, doc, gen.TagGenerator())
} else {
// Simple case - just flattened fields
code = GenerateStruct(desc.ShortName, finalFields, doc, gen.TagGenerator())
}
// Generate ApplyDefaults method
applyDefaults, needsReflect, err := GenerateApplyDefaultsCode(desc.ShortName, finalFields)
if err != nil {
return fmt.Sprintf("// ERROR generating ApplyDefaults for %s: %v\n", desc.ShortName, err)
}
code += "\n" + applyDefaults
if needsReflect {
gen.AddImport("reflect")
}
return code
}
// mergeAllOfExtensions merges extensions from all allOf member descriptors into a
// single composite. For $ref members, the target schema's extensions are merged first,
// then the allOf member descriptor's own extensions (so inline overrides win).
func mergeAllOfExtensions(desc *SchemaDescriptor, schemaIndex map[string]*SchemaDescriptor) *Extensions {
if desc == nil || len(desc.AllOf) == 0 {
return nil
}
merged := &Extensions{}
hasAny := false
for i, memberDesc := range desc.AllOf {
if memberDesc == nil {
continue
}
// For $ref members, merge the target schema's extensions
if memberDesc.IsReference() {
if target, ok := schemaIndex[memberDesc.Ref]; ok && target.Extensions != nil {
mergeExtensions(merged, target.Extensions)
hasAny = true
}
}
// Merge the member descriptor's own extensions (inline extensions override $ref target)
if memberDesc.Extensions != nil {
mergeExtensions(merged, memberDesc.Extensions)
hasAny = true
}
// Also check if the allOf proxy in the schema has extensions that were parsed
// on the descriptor at this index
if desc.Schema != nil && i < len(desc.Schema.AllOf) {
proxy := desc.Schema.AllOf[i]
memberSchema := proxy.Schema()
if memberSchema != nil && memberSchema.Extensions != nil {
ext, err := ParseExtensions(memberSchema.Extensions, desc.Path.Append("allOf", fmt.Sprintf("%d", i)).String())
if err == nil && ext != nil {
mergeExtensions(merged, ext)
hasAny = true
}
}
}
}
if !hasAny {
return nil
}
return merged
}
// hasAnyFields returns true if any allOf member contributed struct fields or union types.
func hasAnyFields(members []allOfMemberInfo) bool {
for _, m := range members {
if len(m.fields) > 0 || m.unionType != "" {
return true
}
}
return false
}
// generateAllOfStructWithUnions generates an allOf struct that contains union fields.
func generateAllOfStructWithUnions(name string, fields []StructField, unionFields []StructField, doc string, tagGen *StructTagGenerator) string {
b := NewCodeBuilder()
if doc != "" {
for _, line := range strings.Split(doc, "\n") {
b.Line("// %s", line)
}
}
b.Line("type %s struct {", name)
b.Indent()
// Regular fields
for _, f := range fields {
tag := generateFieldTag(f, tagGen)
b.Line("%s %s %s", f.Name, f.Type, tag)
}
// Union fields with json:"-"
for _, f := range unionFields {
b.Line("%s %s `json:\"-\"`", f.Name, f.Type)
}
b.Dedent()
b.Line("}")
// Generate MarshalJSON
b.BlankLine()
b.Line("func (s %s) MarshalJSON() ([]byte, error) {", name)
b.Indent()
b.Line("result := make(map[string]any)")
b.BlankLine()
// Marshal regular fields
for _, f := range fields {
if f.Pointer {
b.Line("if s.%s != nil {", f.Name)
b.Indent()
b.Line("result[%q] = s.%s", f.JSONName, f.Name)
b.Dedent()
b.Line("}")
} else if strings.HasPrefix(f.Type, "[]") || strings.HasPrefix(f.Type, "map[") {
// Slices and maps - only include if not nil
b.Line("if s.%s != nil {", f.Name)
b.Indent()
b.Line("result[%q] = s.%s", f.JSONName, f.Name)
b.Dedent()
b.Line("}")
} else {
b.Line("result[%q] = s.%s", f.JSONName, f.Name)
}
}
// Marshal and merge union fields
for _, f := range unionFields {
b.BlankLine()
b.Line("if s.%s != nil {", f.Name)
b.Indent()
b.Line("unionData, err := json.Marshal(s.%s)", f.Name)
b.Line("if err != nil {")
b.Indent()
b.Line("return nil, err")
b.Dedent()
b.Line("}")
b.Line("var unionMap map[string]any")
b.Line("if err := json.Unmarshal(unionData, &unionMap); err == nil {")
b.Indent()
b.Line("for k, v := range unionMap {")
b.Indent()
b.Line("result[k] = v")
b.Dedent()
b.Line("}")
b.Dedent()
b.Line("}")
b.Dedent()
b.Line("}")
}
b.BlankLine()
b.Line("return json.Marshal(result)")
b.Dedent()
b.Line("}")
// Generate UnmarshalJSON
b.BlankLine()
b.Line("func (s *%s) UnmarshalJSON(data []byte) error {", name)
b.Indent()
// Unmarshal into raw map for field extraction
b.Line("var raw map[string]json.RawMessage")
b.Line("if err := json.Unmarshal(data, &raw); err != nil {")
b.Indent()
b.Line("return err")
b.Dedent()
b.Line("}")
b.BlankLine()
// Unmarshal known fields
for _, f := range fields {
b.Line("if v, ok := raw[%q]; ok {", f.JSONName)
b.Indent()
if f.Pointer {
baseType := strings.TrimPrefix(f.Type, "*")
b.Line("var val %s", baseType)
b.Line("if err := json.Unmarshal(v, &val); err != nil {")
b.Indent()
b.Line("return err")
b.Dedent()
b.Line("}")
b.Line("s.%s = &val", f.Name)
} else {
b.Line("if err := json.Unmarshal(v, &s.%s); err != nil {", f.Name)
b.Indent()
b.Line("return err")
b.Dedent()
b.Line("}")
}
b.Dedent()
b.Line("}")
}
// Unmarshal union fields from the full data
for _, f := range unionFields {
b.BlankLine()
baseType := strings.TrimPrefix(f.Type, "*")
b.Line("var %sVal %s", f.Name, baseType)
b.Line("if err := json.Unmarshal(data, &%sVal); err != nil {", f.Name)
b.Indent()
b.Line("return err")
b.Dedent()
b.Line("}")
b.Line("s.%s = &%sVal", f.Name, f.Name)
}
b.BlankLine()
b.Line("return nil")
b.Dedent()
b.Line("}")
return b.String()
}
// generateUnionTypeCommon is the shared implementation for anyOf and oneOf type generation.
func generateUnionTypeCommon(gen *TypeGenerator, desc *SchemaDescriptor, isOneOf bool) string {
var members []UnionMember
if isOneOf {
members = collectUnionMembers(gen, desc, desc.OneOf, desc.Schema.OneOf, "oneOf")
} else {
members = collectUnionMembers(gen, desc, desc.AnyOf, desc.Schema.AnyOf, "anyOf")
}
if len(members) == 0 {
return ""
}
gen.AddJSONImports()
// Extract fixed properties (wrapper fields alongside oneOf/anyOf)
var fixedFields []StructField
if desc.Schema.Properties != nil && desc.Schema.Properties.Len() > 0 {
fixedFields = gen.GenerateStructFields(desc)
}
cfg := UnionTypeConfig{
TypeName: desc.ShortName,
Members: members,
IsOneOf: isOneOf,
Doc: extractDescription(desc.Schema),
FixedFields: fixedFields,
Discriminator: desc.Discriminator,
HelperPrefix: gen.helperPrefix(),
TagGen: gen.tagGenerator,
Converter: gen.converter,
}
if desc.Discriminator != nil {
gen.AddImport("errors")
}
if len(fixedFields) > 0 {
gen.AddImport("fmt")
}
code, err := GenerateUnionCode(cfg)
if err != nil {
// Fall back to empty string on template error — the build will fail
// with a clear error from go generate rather than a panic here.
return fmt.Sprintf("// ERROR generating union type %s: %v\n", desc.ShortName, err)
}
return code
}
// generateAnyOfType generates a union type for anyOf schemas.
func generateAnyOfType(gen *TypeGenerator, desc *SchemaDescriptor) string {
return generateUnionTypeCommon(gen, desc, false)
}
// generateOneOfType generates a union type for oneOf schemas.
func generateOneOfType(gen *TypeGenerator, desc *SchemaDescriptor) string {
return generateUnionTypeCommon(gen, desc, true)
}
// schemaHasApplyDefaults returns true if the schema will have an ApplyDefaults method generated.
// This is true for: