Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 170 additions & 0 deletions internal/test/components/components.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions internal/test/components/components.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,23 @@ components:
- oneOf:
- $ref: '#/components/schemas/OneOfVariant3'
- $ref: '#/components/schemas/OneOfVariant4'
OneOfObject13:
description: oneOf with fixed discriminator and other fields allowed
type: object
properties:
type:
type: string
oneOf:
- $ref: '#/components/schemas/OneOfVariant1'
- $ref: '#/components/schemas/OneOfVariant6'
discriminator:
propertyName: type
mapping:
v1: '#/components/schemas/OneOfVariant1'
v6: '#/components/schemas/OneOfVariant6'
required:
- type
additionalProperties: true
AnyOfObject1:
description: simple anyOf case
anyOf:
Expand Down
29 changes: 29 additions & 0 deletions internal/test/components/components_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func assertJsonEqual(t *testing.T, j1 []byte, j2 []byte) {
Expand Down Expand Up @@ -203,6 +204,34 @@ func TestAnyOf(t *testing.T) {
assert.Equal(t, OneOfVariant5{Discriminator: "all", Id: 456}, v5)
}

func TestOneOfWithAdditional(t *testing.T) {
x := OneOfObject13{
AdditionalProperties: map[string]interface{}{"x": "y"},
}
err := x.MergeOneOfVariant1(OneOfVariant1{Name: "test-name"})
require.NoError(t, err)
b, err := json.Marshal(x)
require.NoError(t, err)
assert.JSONEq(t, `{"x":"y", "name":"test-name", "type":"v1"}`, string(b))
var y OneOfObject13
err = json.Unmarshal(b, &y)
require.NoError(t, err)
assert.Equal(t, x.Type, y.Type)
xVariant, err := x.AsOneOfVariant1()
require.NoError(t, err)
yVariant, err := y.AsOneOfVariant1()
require.NoError(t, err)
assert.Equal(t, xVariant, yVariant)
xAdditional, ok := x.Get("x")
assert.True(t, ok)
yAdditional, ok := y.Get("x")
assert.True(t, ok)
assert.Equal(t, xAdditional, yAdditional)
b, err = json.Marshal(y)
require.NoError(t, err)
assert.JSONEq(t, `{"x":"y", "name":"test-name", "type":"v1"}`, string(b))
}

func TestMarshalWhenNoUnionValueSet(t *testing.T) {
const expected = `{"one":null,"three":null,"two":null}`

Expand Down
27 changes: 26 additions & 1 deletion pkg/codegen/codegen.go
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,12 @@ func GenerateTypeDefinitions(t *template.Template, swagger *openapi3.T, ops []Op
return "", fmt.Errorf("error generating union boilerplate: %w", err)
}

typeDefinitions := strings.Join([]string{enumsOut, typesOut, operationsOut, allOfBoilerplate, unionBoilerplate}, "")
unionAndAdditionalBoilerplate, err := GenerateUnionAndAdditionalProopertiesBoilerplate(t, allTypes)
if err != nil {
return "", fmt.Errorf("error generating boilerplate for union types with additionalProperties: %w", err)
}

typeDefinitions := strings.Join([]string{enumsOut, typesOut, operationsOut, allOfBoilerplate, unionBoilerplate, unionAndAdditionalBoilerplate}, "")
return typeDefinitions, nil
}

Expand Down Expand Up @@ -760,6 +765,26 @@ func GenerateUnionBoilerplate(t *template.Template, typeDefs []TypeDefinition) (
return GenerateTemplates([]string{"union.tmpl"}, t, context)
}

func GenerateUnionAndAdditionalProopertiesBoilerplate(t *template.Template, typeDefs []TypeDefinition) (string, error) {
var filteredTypes []TypeDefinition
for _, t := range typeDefs {
if len(t.Schema.UnionElements) != 0 && t.Schema.HasAdditionalProperties {
filteredTypes = append(filteredTypes, t)
}
}

if len(filteredTypes) == 0 {
return "", nil
}
context := struct {
Types []TypeDefinition
}{
Types: filteredTypes,
}

return GenerateTemplates([]string{"union-and-additional-properties.tmpl"}, t, context)
}

// SanitizeCode runs sanitizers across the generated Go code to ensure the
// generated code will be able to compile.
func SanitizeCode(goCode string) string {
Expand Down
2 changes: 2 additions & 0 deletions pkg/codegen/templates/additional-properties.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ func (a *{{.TypeName}}) Set(fieldName string, value {{$addType}}) {
a.AdditionalProperties[fieldName] = value
}

{{if eq 0 (len .Schema.UnionElements) -}}
// Override default JSON handling for {{.TypeName}} to handle AdditionalProperties
func (a *{{.TypeName}}) UnmarshalJSON(b []byte) error {
object := make(map[string]json.RawMessage)
Expand Down Expand Up @@ -68,3 +69,4 @@ func (a {{.TypeName}}) MarshalJSON() ([]byte, error) {
return json.Marshal(object)
}
{{end}}
{{end}}
72 changes: 72 additions & 0 deletions pkg/codegen/templates/union-and-additional-properties.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
{{range .Types}}

{{$addType := .Schema.AdditionalPropertiesType.TypeDecl}}
{{$typeName := .TypeName -}}
{{$discriminator := .Schema.Discriminator}}
{{$properties := .Schema.Properties -}}

// Override default JSON handling for {{.TypeName}} to handle AdditionalProperties and union
func (a *{{.TypeName}}) UnmarshalJSON(b []byte) error {
err := a.union.UnmarshalJSON(b)
if err != nil {
return err
}
object := make(map[string]json.RawMessage)
err = json.Unmarshal(b, &object)
if err != nil {
return err
}
{{range .Schema.Properties}}
if raw, found := object["{{.JsonFieldName}}"]; found {
err = json.Unmarshal(raw, &a.{{.GoFieldName}})
if err != nil {
return fmt.Errorf("error reading '{{.JsonFieldName}}': %w", err)
}
delete(object, "{{.JsonFieldName}}")
}
{{end}}
if len(object) != 0 {
a.AdditionalProperties = make(map[string]{{$addType}})
for fieldName, fieldBuf := range object {
var fieldVal {{$addType}}
err := json.Unmarshal(fieldBuf, &fieldVal)
if err != nil {
return fmt.Errorf("error unmarshaling field %s: %w", fieldName, err)
}
a.AdditionalProperties[fieldName] = fieldVal
}
}
return nil
}

// Override default JSON handling for {{.TypeName}} to handle AdditionalProperties and union
func (a {{.TypeName}}) MarshalJSON() ([]byte, error) {
var err error
b, err := a.union.MarshalJSON()
if err != nil {
return nil, err
}
object := make(map[string]json.RawMessage)
if a.union != nil {
err = json.Unmarshal(b, &object)
if err != nil {
return nil, err
}
}
{{range .Schema.Properties}}
{{if not .Required}}if a.{{.GoFieldName}} != nil { {{end}}
object["{{.JsonFieldName}}"], err = json.Marshal(a.{{.GoFieldName}})
if err != nil {
return nil, fmt.Errorf("error marshaling '{{.JsonFieldName}}': %w", err)
}
{{if not .Required}} }{{end}}
{{end}}
for fieldName, field := range a.AdditionalProperties {
object[fieldName], err = json.Marshal(field)
if err != nil {
return nil, fmt.Errorf("error marshaling '%s': %w", fieldName, err)
}
}
return json.Marshal(object)
}
{{end}}
Loading