Skip to content
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

openapi2conv: fix that removes an extra required array from formDataBody #848

Merged
merged 2 commits into from
Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 60 additions & 0 deletions openapi2conv/issue847_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
package openapi2conv

import (
"context"
"encoding/json"
"testing"

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

func TestIssue847(t *testing.T) {
spec := []byte(`
{
"swagger": "2.0",
"info": {
"description": "Hello Java Sec API",
"version": "1.10",
"title": "Swagger2 RESTful API"
},
"host": "localhost:8888",
"basePath": "/",
"paths": {
"/UPLOAD/uploadSafe": {
"post": {
"operationId": "singleFileUploadSafeUsingPOST",
"consumes": [
"multipart/form-data"
],
"parameters": [
{
"name": "file",
"in": "formData",
"description": "file",
"required": true,
"type": "file"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
}
}
}
}
}
`)
doc3, err := v2v3JSON(spec)
require.NoError(t, err)

reqStr, err := json.MarshalIndent(doc3, "", " ")
require.NotNil(t, reqStr)
require.NoError(t, err)
fenollp marked this conversation as resolved.
Show resolved Hide resolved

fenollp marked this conversation as resolved.
Show resolved Hide resolved
err = doc3.Validate(context.Background())
require.NoError(t, err)
}
8 changes: 7 additions & 1 deletion openapi2conv/openapi2_conv.go
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,12 @@ func formDataBody(bodies map[string]*openapi3.SchemaRef, reqs map[string]bool, c
requireds = append(requireds, propName)
}
}
for s, ref := range bodies {
if ref.Value != nil && len(ref.Value.Required) > 0 {
ref.Value.Required = nil
bodies[s] = ref
}
}
schema := &openapi3.Schema{
Type: "object",
Properties: ToV3Schemas(bodies),
Expand Down Expand Up @@ -701,7 +707,7 @@ func fromV3RequestBodies(name string, requestBodyRef *openapi3.RequestBodyRef, c
return
}

//Only select one formData or request body for an individual requestBody as OpenAPI 2 does not support multiples
// Only select one formData or request body for an individual requestBody as OpenAPI 2 does not support multiples
if requestBodyRef.Value != nil {
for contentType, mediaType := range requestBodyRef.Value.Content {
if consumes == nil {
Expand Down