openapi{2,3}: simplify unmarshal errors (#870)

getkin · Nov 26, 2023 · 377bb40 · 377bb40
1 parent fe1c5f5
commit 377bb40
Show file tree

Hide file tree

Showing 32 changed files with 222 additions and 42 deletions.
diff --git a/openapi2/marsh.go b/openapi2/marsh.go
@@ -0,0 +1,26 @@
+package openapi2
+
+import (
+	"encoding/json"
+	"fmt"
+	"strings"
+
+	"github.com/invopop/yaml"
+)
+
+func unmarshalError(jsonUnmarshalErr error) error {
+	if before, after, found := strings.Cut(jsonUnmarshalErr.Error(), "Bis."); found && before != "" && after != "" {
+		before = strings.ReplaceAll(before, " Go struct ", " ")
+		return fmt.Errorf("%s.%s", before, after)
+	}
+	return jsonUnmarshalErr
+}
+
+func unmarshal(data []byte, v interface{}) error {
+	// See https://github.com/getkin/kin-openapi/issues/680
+	if err := json.Unmarshal(data, v); err != nil {
+		// UnmarshalStrict(data, v) TODO: investigate how ymlv3 handles duplicate map keys
+		return yaml.Unmarshal(data, v)
+	}
+	return nil
+}
diff --git a/openapi2/marsh_test.go b/openapi2/marsh_test.go
@@ -0,0 +1,61 @@
+package openapi2
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestUnmarshalError(t *testing.T) {
+	{
+		v2 := []byte(`
+openapi: '2.0'
+info:
+  version: '1.10'
+  title: title
+paths:
+  "/ping":
+    post:
+      consumes:
+      - multipart/form-data
+      parameters:
+        name: file  # <-- Missing dash
+        in: formData
+        description: file
+        required: true
+        type: file
+      responses:
+        '200':
+          description: OK
+`[1:])
+
+		var doc T
+		err := unmarshal(v2, &doc)
+		require.ErrorContains(t, err, `json: cannot unmarshal object into field Operation.parameters of type openapi2.Parameters`)
+	}
+
+	v2 := []byte(`
+openapi: '2.0'
+info:
+  version: '1.10'
+  title: title
+paths:
+  "/ping":
+    post:
+      consumes:
+      - multipart/form-data
+      parameters:
+      - name: file  # <--
+        in: formData
+        description: file
+        required: true
+        type: file
+      responses:
+        '200':
+          description: OK
+`[1:])
+
+	var doc T
+	err := unmarshal(v2, &doc)
+	require.NoError(t, err)
+}
diff --git a/openapi2/openapi2.go b/openapi2/openapi2.go
@@ -82,7 +82,7 @@ func (doc *T) UnmarshalJSON(data []byte) error {
 	type TBis T
 	var x TBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "swagger")

diff --git a/openapi2/operation.go b/openapi2/operation.go
@@ -71,7 +71,7 @@ func (operation *Operation) UnmarshalJSON(data []byte) error {
 	type OperationBis Operation
 	var x OperationBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "summary")

diff --git a/openapi2/parameter.go b/openapi2/parameter.go
@@ -142,7 +142,7 @@ func (parameter *Parameter) UnmarshalJSON(data []byte) error {
 	type ParameterBis Parameter
 	var x ParameterBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "$ref")

diff --git a/openapi2/path_item.go b/openapi2/path_item.go
@@ -65,7 +65,7 @@ func (pathItem *PathItem) UnmarshalJSON(data []byte) error {
 	type PathItemBis PathItem
 	var x PathItemBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "$ref")

diff --git a/openapi2/response.go b/openapi2/response.go
@@ -47,7 +47,7 @@ func (response *Response) UnmarshalJSON(data []byte) error {
 	type ResponseBis Response
 	var x ResponseBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "$ref")

diff --git a/openapi2/security_scheme.go b/openapi2/security_scheme.go
@@ -69,7 +69,7 @@ func (securityScheme *SecurityScheme) UnmarshalJSON(data []byte) error {
 	type SecuritySchemeBis SecurityScheme
 	var x SecuritySchemeBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "$ref")

diff --git a/openapi3/components.go b/openapi3/components.go
@@ -68,7 +68,7 @@ func (components *Components) UnmarshalJSON(data []byte) error {
 	type ComponentsBis Components
 	var x ComponentsBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "schemas")

diff --git a/openapi3/contact.go b/openapi3/contact.go
@@ -38,7 +38,7 @@ func (contact *Contact) UnmarshalJSON(data []byte) error {
 	type ContactBis Contact
 	var x ContactBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "name")

diff --git a/openapi3/discriminator.go b/openapi3/discriminator.go
@@ -32,7 +32,7 @@ func (discriminator *Discriminator) UnmarshalJSON(data []byte) error {
 	type DiscriminatorBis Discriminator
 	var x DiscriminatorBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "propertyName")

diff --git a/openapi3/encoding.go b/openapi3/encoding.go
@@ -68,7 +68,7 @@ func (encoding *Encoding) UnmarshalJSON(data []byte) error {
 	type EncodingBis Encoding
 	var x EncodingBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "contentType")

diff --git a/openapi3/example.go b/openapi3/example.go
@@ -67,7 +67,7 @@ func (example *Example) UnmarshalJSON(data []byte) error {
 	type ExampleBis Example
 	var x ExampleBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "summary")

diff --git a/openapi3/external_docs.go b/openapi3/external_docs.go
@@ -37,7 +37,7 @@ func (e *ExternalDocs) UnmarshalJSON(data []byte) error {
 	type ExternalDocsBis ExternalDocs
 	var x ExternalDocsBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "description")

diff --git a/openapi3/info.go b/openapi3/info.go
@@ -47,7 +47,7 @@ func (info *Info) UnmarshalJSON(data []byte) error {
 	type InfoBis Info
 	var x InfoBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "title")

diff --git a/openapi3/license.go b/openapi3/license.go
@@ -33,7 +33,7 @@ func (license *License) UnmarshalJSON(data []byte) error {
 	type LicenseBis License
 	var x LicenseBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "name")

diff --git a/openapi3/link.go b/openapi3/link.go
@@ -73,7 +73,7 @@ func (link *Link) UnmarshalJSON(data []byte) error {
 	type LinkBis Link
 	var x LinkBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "operationRef")

diff --git a/openapi3/loader.go b/openapi3/loader.go
@@ -14,8 +14,6 @@ import (
 	"sort"
 	"strconv"
 	"strings"
-
-	"github.com/invopop/yaml"
 )
 
 var CircularReferenceError = "kin-openapi bug found: circular schema reference not handled"
@@ -178,15 +176,6 @@ func (loader *Loader) loadFromDataWithPathInternal(data []byte, location *url.UR
 	return doc, nil
 }
 
-func unmarshal(data []byte, v interface{}) error {
-	// See https://github.com/getkin/kin-openapi/issues/680
-	if err := json.Unmarshal(data, v); err != nil {
-		// UnmarshalStrict(data, v) TODO: investigate how ymlv3 handles duplicate map keys
-		return yaml.Unmarshal(data, v)
-	}
-	return nil
-}
-
 // ResolveRefsIn expands references if for instance spec was just unmarshaled
 func (loader *Loader) ResolveRefsIn(doc *T, location *url.URL) (err error) {
 	if loader.Context == nil {

diff --git a/openapi3/marsh.go b/openapi3/marsh.go
@@ -0,0 +1,26 @@
+package openapi3
+
+import (
+	"encoding/json"
+	"fmt"
+	"strings"
+
+	"github.com/invopop/yaml"
+)
+
+func unmarshalError(jsonUnmarshalErr error) error {
+	if before, after, found := strings.Cut(jsonUnmarshalErr.Error(), "Bis."); found && before != "" && after != "" {
+		before = strings.ReplaceAll(before, " Go struct ", " ")
+		return fmt.Errorf("%s.%s", before, after)
+	}
+	return jsonUnmarshalErr
+}
+
+func unmarshal(data []byte, v interface{}) error {
+	// See https://github.com/getkin/kin-openapi/issues/680
+	if err := json.Unmarshal(data, v); err != nil {
+		// UnmarshalStrict(data, v) TODO: investigate how ymlv3 handles duplicate map keys
+		return yaml.Unmarshal(data, v)
+	}
+	return nil
+}
diff --git a/openapi3/marsh_test.go b/openapi3/marsh_test.go
@@ -0,0 +1,78 @@
+package openapi3
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestUnmarshalError(t *testing.T) {
+	{
+		spec := []byte(`
+openapi: 3.0.1
+info:
+  version: v1
+  title: Products api
+components:
+  schemas:
+    someSchema:
+      type: object
+    schemaArray:
+      type: array
+      minItems: 1
+      items:
+        $ref: '#/components/schemas/someSchema'
+paths:
+  /categories:
+    get:
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                allOf:
+                  $ref: '#/components/schemas/schemaArray'  # <- Should have been a list
+`[1:])
+
+		sl := NewLoader()
+
+		_, err := sl.LoadFromData(spec)
+		require.ErrorContains(t, err, `json: cannot unmarshal object into field Schema.allOf of type openapi3.SchemaRefs`)
+	}
+
+	spec := []byte(`
+openapi: 3.0.1
+info:
+  version: v1
+  title: Products api
+components:
+  schemas:
+    someSchema:
+      type: object
+    schemaArray:
+      type: array
+      minItems: 1
+      items:
+        $ref: '#/components/schemas/someSchema'
+paths:
+  /categories:
+    get:
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                allOf:
+                - $ref: '#/components/schemas/schemaArray'  # <-
+`[1:])
+
+	sl := NewLoader()
+
+	doc, err := sl.LoadFromData(spec)
+	require.NoError(t, err)
+
+	err = doc.Validate(sl.Context)
+	require.NoError(t, err)
+}
diff --git a/openapi3/media_type.go b/openapi3/media_type.go
@@ -89,7 +89,7 @@ func (mediaType *MediaType) UnmarshalJSON(data []byte) error {
 	type MediaTypeBis MediaType
 	var x MediaTypeBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "schema")

diff --git a/openapi3/openapi3.go b/openapi3/openapi3.go
@@ -56,7 +56,7 @@ func (doc *T) UnmarshalJSON(data []byte) error {
 	type TBis T
 	var x TBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "openapi")

diff --git a/openapi3/operation.go b/openapi3/operation.go
@@ -104,7 +104,7 @@ func (operation *Operation) UnmarshalJSON(data []byte) error {
 	type OperationBis Operation
 	var x OperationBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "tags")

diff --git a/openapi3/parameter.go b/openapi3/parameter.go
@@ -222,7 +222,7 @@ func (parameter *Parameter) UnmarshalJSON(data []byte) error {
 	type ParameterBis Parameter
 	var x ParameterBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 

diff --git a/openapi3/path_item.go b/openapi3/path_item.go
@@ -86,7 +86,7 @@ func (pathItem *PathItem) UnmarshalJSON(data []byte) error {
 	type PathItemBis PathItem
 	var x PathItemBis
 	if err := json.Unmarshal(data, &x); err != nil {
-		return err
+		return unmarshalError(err)
 	}
 	_ = json.Unmarshal(data, &x.Extensions)
 	delete(x.Extensions, "$ref")