introduce AllowExtraSiblingFields

Signed-off-by: Pierre Fenoll <[email protected]>

Author: fenollp

openapi3/components.go

@@ -224,7 +224,7 @@ func (components *Components) Validate(ctx context.Context, opts ...ValidationOp
 		}
 	}
 
-	return validateExtensions(components.Extensions)
+	return validateExtensions(ctx, components.Extensions)
 }
 
 const identifierPattern = `^[a-zA-Z0-9._-]+$`

openapi3/discriminator.go

@@ -43,7 +43,7 @@ func (discriminator *Discriminator) UnmarshalJSON(data []byte) error {
 
 // Validate returns an error if Discriminator does not comply with the OpenAPI spec.
 func (discriminator *Discriminator) Validate(ctx context.Context, opts ...ValidationOption) error {
-	// ctx = WithValidationOptions(ctx, opts...)
+	ctx = WithValidationOptions(ctx, opts...)
 
-	return validateExtensions(discriminator.Extensions)
+	return validateExtensions(ctx, discriminator.Extensions)
 }

openapi3/encoding.go

@@ -132,5 +132,5 @@ func (encoding *Encoding) Validate(ctx context.Context, opts ...ValidationOption
 		return fmt.Errorf("serialization method with style=%q and explode=%v is not supported by media type", sm.Style, sm.Explode)
 	}
 
-	return validateExtensions(encoding.Extensions)
+	return validateExtensions(ctx, encoding.Extensions)
 }

openapi3/example.go

@@ -80,7 +80,7 @@ func (example *Example) UnmarshalJSON(data []byte) error {
 
 // Validate returns an error if Example does not comply with the OpenAPI spec.
 func (example *Example) Validate(ctx context.Context, opts ...ValidationOption) error {
-	// ctx = WithValidationOptions(ctx, opts...)
+	ctx = WithValidationOptions(ctx, opts...)
 
 	if example.Value != nil && example.ExternalValue != "" {
 		return errors.New("value and externalValue are mutually exclusive")
@@ -89,5 +89,5 @@ func (example *Example) Validate(ctx context.Context, opts ...ValidationOption)
 		return errors.New("no value or externalValue field")
 	}
 
-	return validateExtensions(example.Extensions)
+	return validateExtensions(ctx, example.Extensions)
 }

openapi3/extension.go

@@ -1,21 +1,24 @@
 package openapi3
 
 import (
+	"context"
 	"fmt"
 	"sort"
 	"strings"
 )
 
-func validateExtensions(extensions map[string]interface{}) error { // FIXME: newtype + Validate(...)
+func validateExtensions(ctx context.Context, extensions map[string]interface{}) error { // FIXME: newtype + Validate(...)
 	var unknowns []string
 	for k := range extensions {
 		if !strings.HasPrefix(k, "x-") {
 			unknowns = append(unknowns, k)
 		}
 	}
+
 	if len(unknowns) != 0 {
 		sort.Strings(unknowns)
 		return fmt.Errorf("extra sibling fields: %+v", unknowns)
 	}
+
 	return nil
 }

openapi3/external_docs.go

@@ -48,7 +48,7 @@ func (e *ExternalDocs) UnmarshalJSON(data []byte) error {
 
 // Validate returns an error if ExternalDocs does not comply with the OpenAPI spec.
 func (e *ExternalDocs) Validate(ctx context.Context, opts ...ValidationOption) error {
-	// ctx = WithValidationOptions(ctx, opts...)
+	ctx = WithValidationOptions(ctx, opts...)
 
 	if e.URL == "" {
 		return errors.New("url is required")
@@ -57,5 +57,5 @@ func (e *ExternalDocs) Validate(ctx context.Context, opts ...ValidationOption) e
 		return fmt.Errorf("url is incorrect: %w", err)
 	}
 
-	return validateExtensions(e.Extensions)
+	return validateExtensions(ctx, e.Extensions)
 }

openapi3/info.go

@@ -84,7 +84,7 @@ func (info *Info) Validate(ctx context.Context, opts ...ValidationOption) error
 		return errors.New("value of title must be a non-empty string")
 	}
 
-	return validateExtensions(info.Extensions)
+	return validateExtensions(ctx, info.Extensions)
 }
 
 // Contact is specified by OpenAPI/Swagger standard version 3.
@@ -132,9 +132,9 @@ func (contact *Contact) UnmarshalJSON(data []byte) error {
 
 // Validate returns an error if Contact does not comply with the OpenAPI spec.
 func (contact *Contact) Validate(ctx context.Context, opts ...ValidationOption) error {
-	// ctx = WithValidationOptions(ctx, opts...)
+	ctx = WithValidationOptions(ctx, opts...)
 
-	return validateExtensions(contact.Extensions)
+	return validateExtensions(ctx, contact.Extensions)
 }
 
 // License is specified by OpenAPI/Swagger standard version 3.
@@ -175,11 +175,11 @@ func (license *License) UnmarshalJSON(data []byte) error {
 
 // Validate returns an error if License does not comply with the OpenAPI spec.
 func (license *License) Validate(ctx context.Context, opts ...ValidationOption) error {
-	// ctx = WithValidationOptions(ctx, opts...)
+	ctx = WithValidationOptions(ctx, opts...)
 
 	if license.Name == "" {
 		return errors.New("value of license name must be a non-empty string")
 	}
 
-	return validateExtensions(license.Extensions)
+	return validateExtensions(ctx, license.Extensions)
 }

openapi3/issue513_test.go

@@ -131,3 +131,43 @@ components:
 	err = doc.Validate(sl.Context)
 	require.ErrorContains(t, err, `extra sibling fields: [description]`)
 }
+
+func TestIssue513KOMixesRefAlongWithOtherFieldsAllowed(t *testing.T) {
+	spec := `
+openapi: "3.0.3"
+info:
+  title: 'My app'
+  version: 1.0.0
+  description: 'An API'
+
+paths:
+  /v1/operation:
+    delete:
+      summary: Delete something
+      responses:
+        200:
+          description: A sibling field that the spec says is ignored
+          $ref: '#/components/responses/SomeResponseBody'
+components:
+  responses:
+    SomeResponseBody:
+      description: Success
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+  schemas:
+    Error:
+      type: object
+      description: An error response body.
+      properties:
+        message:
+          description: A detailed message describing the error.
+          type: string
+`[1:]
+	sl := NewLoader()
+	doc, err := sl.LoadFromData([]byte(spec))
+	require.NoError(t, err)
+	err = doc.Validate(sl.Context, AllowExtraSiblingFields("description"))
+	require.NoError(t, err)
+}

openapi3/link.go

@@ -88,7 +88,7 @@ func (link *Link) UnmarshalJSON(data []byte) error {
 
 // Validate returns an error if Link does not comply with the OpenAPI spec.
 func (link *Link) Validate(ctx context.Context, opts ...ValidationOption) error {
-	// ctx = WithValidationOptions(ctx, opts...)
+	ctx = WithValidationOptions(ctx, opts...)
 
 	if link.OperationID == "" && link.OperationRef == "" {
 		return errors.New("missing operationId or operationRef on link")
@@ -97,5 +97,5 @@ func (link *Link) Validate(ctx context.Context, opts ...ValidationOption) error
 		return fmt.Errorf("operationId %q and operationRef %q are mutually exclusive", link.OperationID, link.OperationRef)
 	}
 
-	return validateExtensions(link.Extensions)
+	return validateExtensions(ctx, link.Extensions)
 }

openapi3/media_type.go

@@ -142,7 +142,7 @@ func (mediaType *MediaType) Validate(ctx context.Context, opts ...ValidationOpti
 		}
 	}
 
-	return validateExtensions(mediaType.Extensions)
+	return validateExtensions(ctx, mediaType.Extensions)
 }
 
 // JSONLookup implements github.com/go-openapi/jsonpointer#JSONPointable