openapi: support additionalProperties: true/false boolean shorthand#310
Merged
openapi: support additionalProperties: true/false boolean shorthand#310
additionalProperties: true/false boolean shorthand#310Conversation
Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix openapi module unmarshal error for additionalProperties
openapi: support Mar 12, 2026
additionalProperties: true/false boolean shorthand
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support to the OpenAPI module’s schema parser/validator for the OpenAPI 3.0 / JSON Schema additionalProperties boolean shorthand, so specs using additionalProperties: true/false no longer fail to parse and are validated correctly at runtime.
Changes:
- Introduces an
openAPIAdditionalPropertiesunion type with YAML/JSON unmarshalling to support both boolean and schema-object forms. - Updates
openAPISchema.AdditionalPropertiesto use the new union type and extendsvalidateJSONBodyto implementtrue/false/ schema semantics. - Adds unit/integration tests covering parsing and request-validation behavior for the three forms.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
module/openapi.go |
Adds a union type for additionalProperties and updates request-body validation logic to enforce boolean/schema semantics. |
module/openapi_test.go |
Adds tests for YAML/JSON unmarshalling and request validation behavior for additionalProperties variants. |
Comment on lines
+2614
to
+2623
| // Valid: extra key is a string | ||
| body := `{"name":"test","extra":"string-value"}` | ||
| w := httptest.NewRecorder() | ||
| r := httptest.NewRequest(http.MethodPost, "/typed-extra", strings.NewReader(body)) | ||
| r.Header.Set("Content-Type", "application/json") | ||
| h.Handle(w, r) | ||
|
|
||
| if w.Code == http.StatusBadRequest { | ||
| t.Errorf("expected string extra key to pass additionalProperties:{type:string}, got 400: %s", w.Body.String()) | ||
| } |
There was a problem hiding this comment.
The additionalProperties schema case test only covers the "valid extra" path. Adding a failing case (e.g. extra key value with the wrong type) would verify that extra keys are actually being validated against the provided schema, not just accepted.
⏱ Benchmark Results✅ No significant performance regressions detected. benchstat comparison (baseline → PR)
|
Contributor
|
@copilot apply changes based on the comments in this thread And fix the failing linter |
- Add bodyLabel prefix to additionalProperties:false error messages - Strengthen AdditionalProperties_True assertion to check for 200 (not just non-400) - Add invalid-type failing case to AdditionalProperties_Schema test - Fix gocritic ifElseChain lint issue in pipeline_step_graphql.go (from main) Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
Contributor
Author
All three review items are addressed in commit
The |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
OpenAPI 3.0 allows
additionalPropertiesto be either a boolean or a schema object, but the module only handled the object form — causing a YAML parse error on any spec using the boolean shorthand.Changes
openAPIAdditionalPropertiesunion type (module/openapi.go) — wrapsbooland*openAPISchemawith customUnmarshalYAML,UnmarshalJSON, andMarshalJSONto handle both forms transparently.openAPISchema.AdditionalPropertieschanged from*openAPISchema→*openAPIAdditionalProperties.validateJSONBodyupdated to enforce all three semantics:true→ any extra keys permitted (no-op)false→ extra keys not inpropertiesare rejected with a validation error{…schema…}→ extra keys validated against the given schemaOriginal prompt
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.