-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
fix(go-server): allow zero values for required request body fields #24262
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| generatorName: go-server | ||
| outputDir: samples/server/others/go-server/required-zero-value | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/go-server/required-zero-value.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/go-server | ||
| additionalProperties: | ||
| hideGenerationTimestamp: "true" | ||
| packageName: petstoreserver | ||
| addResponseHeaders: true |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,48 +57,46 @@ func New{{{classname}}}FromValue(v {{{format}}}{{^format}}{{dataType}}{{/format} | |
| {{/isEnum}}{{^isEnum}}{{#description}} | ||
| // {{classname}} - {{{description}}}{{/description}} | ||
| type {{classname}} struct { | ||
| {{#parent}} | ||
| {{^isMap}} | ||
| {{^isArray}} | ||
| {{{parent}}} | ||
| {{/isArray}} | ||
| {{/isMap}} | ||
| {{#isArray}} | ||
| Items {{{parent}}} | ||
| {{/isArray}} | ||
| {{/parent}} | ||
| {{#vendorExtensions.x-go-embed-parent-classname}} | ||
| {{{.}}} | ||
| {{/vendorExtensions.x-go-embed-parent-classname}} | ||
| {{#vars}}{{#description}} | ||
| // {{{.}}}{{/description}} | ||
| {{#deprecated}} | ||
| // Deprecated | ||
| {{/deprecated}} | ||
| {{name}} {{#isNullable}}*{{/isNullable}}{{{dataType}}} `json:"{{baseName}}{{^required}},omitempty{{/required}}"{{#vendorExtensions.x-go-custom-tag}} {{{.}}}{{/vendorExtensions.x-go-custom-tag}}` | ||
| {{/vars}} | ||
| }{{/isEnum}} | ||
| } | ||
| {{#vendorExtensions.hasPresenceCheckRequiredVars}} | ||
| {{>model_unmarshal_json_presence}} | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P2: Unknown JSON properties remain silently accepted despite the strict decoder. The generated presence unmarshaller filters them out before Prompt for AI agents |
||
| {{/vendorExtensions.hasPresenceCheckRequiredVars}} | ||
| {{/isEnum}} | ||
|
|
||
| // Assert{{classname}}Required checks if the required fields are not zero-ed | ||
| // Assert{{classname}}Required checks complex required fields (models, arrays, maps) and embedded parents. | ||
| // Primitive required fields are validated for JSON request bodies in UnmarshalJSON so zero values remain valid. | ||
| func Assert{{classname}}Required(obj {{classname}}) error { | ||
| {{#hasRequired}} | ||
| {{#vendorExtensions.hasRequiredAssertVars}} | ||
| elements := map[string]interface{}{ | ||
| {{#requiredVars}}{{^isReadOnly}} "{{baseName}}": obj.{{name}}, | ||
| {{/isReadOnly}}{{/requiredVars}} } | ||
| {{#vendorExtensions.assertRequiredVars}} | ||
| "{{baseName}}": obj.{{name}}, | ||
| {{/vendorExtensions.assertRequiredVars}} | ||
| } | ||
| for name, el := range elements { | ||
| if isZero := IsZeroValue(el); isZero { | ||
| return &RequiredError{Field: name} | ||
| } | ||
| } | ||
|
|
||
| {{/vendorExtensions.hasRequiredAssertVars}} | ||
| {{/hasRequired}} | ||
| {{#parent}} | ||
| {{^isMap}} | ||
| {{^isArray}} | ||
| if err := Assert{{{parent}}}Required(obj.{{{parent}}}); err != nil { | ||
| {{#vendorExtensions.x-go-embed-parent-classname}} | ||
| if err := Assert{{vendorExtensions.x-go-embed-parent-classname}}Required(obj.{{vendorExtensions.x-go-embed-parent-classname}}); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| {{/isArray}} | ||
| {{/isMap}} | ||
| {{/parent}} | ||
| {{/vendorExtensions.x-go-embed-parent-classname}} | ||
| {{#Vars}} | ||
| {{^isReadOnly}} | ||
| {{#isNullable}} | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // UnmarshalJSON validates required property keys then unmarshals into {{classname}} | ||
| func (o *{{classname}}) UnmarshalJSON(data []byte) (err error) { | ||
| // Presence is checked against required fields that exist on this struct, | ||
| // including fields promoted from embedded allOf parents. | ||
| requiredProperties := []string{ | ||
| {{#vendorExtensions.presenceCheckRequiredVars}} | ||
| "{{baseName}}", | ||
| {{/vendorExtensions.presenceCheckRequiredVars}} | ||
| } | ||
|
|
||
| requiredNullableProperties := map[string]bool{ | ||
| {{#vendorExtensions.presenceCheckRequiredVars}} | ||
| "{{baseName}}": {{#isNullable}}true{{/isNullable}}{{^isNullable}}false{{/isNullable}}, | ||
| {{/vendorExtensions.presenceCheckRequiredVars}} | ||
| } | ||
|
|
||
| {{^isAdditionalPropertiesTrue}} | ||
| allowedJsonKeys := map[string]struct{}{ | ||
| {{#vendorExtensions.allowedJsonKeys}} | ||
| "{{.}}": {}, | ||
| {{/vendorExtensions.allowedJsonKeys}} | ||
| } | ||
|
|
||
| {{/isAdditionalPropertiesTrue}} | ||
| allProperties := make(map[string]json.RawMessage) | ||
|
|
||
| err = json.Unmarshal(data, &allProperties) | ||
|
cubic-dev-ai[bot] marked this conversation as resolved.
|
||
|
|
||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| for _, requiredProperty := range requiredProperties { | ||
| value, exists := allProperties[requiredProperty] | ||
| if !exists { | ||
| return &RequiredError{Field: requiredProperty} | ||
| } | ||
| if string(value) == "null" && !requiredNullableProperties[requiredProperty] { | ||
| return &RequiredError{Field: requiredProperty} | ||
| } | ||
| } | ||
|
|
||
| {{^isAdditionalPropertiesTrue}} | ||
| for key := range allProperties { | ||
| if _, exists := allowedJsonKeys[key]; !exists { | ||
| return fmt.Errorf("json: unknown field %q", key) | ||
| } | ||
| } | ||
|
|
||
| {{/isAdditionalPropertiesTrue}} | ||
| var decoded {{classname}} | ||
|
|
||
| {{#vendorExtensions.decodeVars}} | ||
| if value, exists := allProperties["{{baseName}}"]; exists { | ||
| if err = json.Unmarshal(value, &decoded.{{name}}); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| {{/vendorExtensions.decodeVars}} | ||
|
|
||
| *o = decoded | ||
|
|
||
| return nil | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.