extend WithRefOrSpec and add some tests

spec/callback.go

@@ -2,6 +2,7 @@ package spec
 
 import (
 	"encoding/json"
+	"fmt"
 
 	"gopkg.in/yaml.v3"
 )
@@ -47,6 +48,26 @@ func NewCallbackRef(ref *Ref) *RefOrSpec[Extendable[Callback]] {
 	return NewRefOrSpec[Extendable[Callback]](ref, nil)
 }
 
+// WithPathItem adds the PathItem object to the Callback map.
+func (o *Callback) WithPathItem(name string, v any) *Callback {
+	var p *RefOrSpec[Extendable[PathItem]]
+	switch spec := v.(type) {
+	case *RefOrSpec[Extendable[PathItem]]:
+		p = spec
+	case *Extendable[PathItem]:
+		p = NewRefOrSpec[Extendable[PathItem]](nil, spec)
+	case *PathItem:
+		p = NewRefOrSpec[Extendable[PathItem]](nil, NewExtendable(spec))
+	default:
+		panic(fmt.Errorf("wrong Callback type: %T", spec))
+	}
+	if o.Callback == nil {
+		o.Callback = make(map[string]*RefOrSpec[Extendable[PathItem]])
+	}
+	o.Callback[name] = p
+	return o
+}
+
 // MarshalJSON implements json.Marshaler interface.
 func (o *Callback) MarshalJSON() ([]byte, error) {
 	return json.Marshal(&o.Callback)

spec/callback_test.go

@@ -0,0 +1,56 @@
+package spec_test
+
+import (
+	"github.com/stretchr/testify/require"
+	"github.com/sv-tools/openapi/spec"
+	"testing"
+)
+
+func TestCallback_WithPathItem(t *testing.T) {
+	for _, tt := range []struct {
+		name   string
+		create func() any
+	}{
+		{
+			name: "path item spec",
+			create: func() any {
+				o := spec.NewPathItemSpec()
+				o.Spec.Spec.Description = "test"
+				return o.Spec.Spec
+			},
+		},
+		{
+			name: "path item ext spec",
+			create: func() any {
+				o := spec.NewPathItemSpec()
+				o.Spec.Spec.Description = "test"
+				return o.Spec
+			},
+		},
+		{
+			name: "path item ref or spec",
+			create: func() any {
+				o := spec.NewPathItemSpec()
+				o.Spec.Spec.Description = "test"
+				return o
+			},
+		},
+	} {
+		t.Run(tt.name, func(t *testing.T) {
+			c := spec.NewCallbackSpec().Spec.Spec
+			c.WithPathItem("testPathItem", tt.create())
+			require.Len(t, c.Callback, 1)
+			require.NotNil(t, c.Callback["testPathItem"])
+			require.NotNil(t, c.Callback["testPathItem"].Spec)
+			require.NotNil(t, c.Callback["testPathItem"].Spec.Spec)
+			require.Equal(t, "test", c.Callback["testPathItem"].Spec.Spec.Description)
+		})
+	}
+
+	t.Run("panic", func(t *testing.T) {
+		c := spec.NewCallbackSpec().Spec.Spec
+		require.Panics(t, func() {
+			c.WithPathItem("panic", 42)
+		})
+	})
+}

spec/components.go

@@ -1,5 +1,7 @@
 package spec
 
+import "fmt"
+
 // Components holds a set of reusable objects for different aspects of the OAS.
 // All objects defined within the components object will have no effect on the API unless they are explicitly referenced
 // from properties outside the components object.
@@ -103,59 +105,156 @@ func NewComponents() *Extendable[Components] {
 	return NewExtendable(&Components{})
 }
 
-// WithRefOrSpec adds the given object to the appropriate list based on type and returns the current object (self|this).
+// WithRefOrSpec adds the given object to the appropriate list based on a type and returns the current object (self|this).
 func (o *Components) WithRefOrSpec(name string, v any) *Components {
 	switch spec := v.(type) {
 	case *RefOrSpec[Schema]:
 		if o.Schemas == nil {
 			o.Schemas = make(map[string]*RefOrSpec[Schema], 1)
 		}
 		o.Schemas[name] = spec
+	case *Schema:
+		if o.Schemas == nil {
+			o.Schemas = make(map[string]*RefOrSpec[Schema], 1)
+		}
+		o.Schemas[name] = NewRefOrSpec(nil, spec)
 	case *RefOrSpec[Extendable[Response]]:
 		if o.Responses == nil {
 			o.Responses = make(map[string]*RefOrSpec[Extendable[Response]], 1)
 		}
 		o.Responses[name] = spec
+	case *Extendable[Response]:
+		if o.Responses == nil {
+			o.Responses = make(map[string]*RefOrSpec[Extendable[Response]], 1)
+		}
+		o.Responses[name] = NewRefOrSpec(nil, spec)
+	case *Response:
+		if o.Responses == nil {
+			o.Responses = make(map[string]*RefOrSpec[Extendable[Response]], 1)
+		}
+		o.Responses[name] = NewRefOrSpec(nil, NewExtendable(spec))
 	case *RefOrSpec[Extendable[Parameter]]:
 		if o.Parameters == nil {
 			o.Parameters = make(map[string]*RefOrSpec[Extendable[Parameter]], 1)
 		}
 		o.Parameters[name] = spec
+	case *Extendable[Parameter]:
+		if o.Parameters == nil {
+			o.Parameters = make(map[string]*RefOrSpec[Extendable[Parameter]], 1)
+		}
+		o.Parameters[name] = NewRefOrSpec(nil, spec)
+	case *Parameter:
+		if o.Parameters == nil {
+			o.Parameters = make(map[string]*RefOrSpec[Extendable[Parameter]], 1)
+		}
+		o.Parameters[name] = NewRefOrSpec(nil, NewExtendable(spec))
 	case *RefOrSpec[Extendable[Example]]:
 		if o.Examples == nil {
 			o.Examples = make(map[string]*RefOrSpec[Extendable[Example]], 1)
 		}
 		o.Examples[name] = spec
+	case *Extendable[Example]:
+		if o.Examples == nil {
+			o.Examples = make(map[string]*RefOrSpec[Extendable[Example]], 1)
+		}
+		o.Examples[name] = NewRefOrSpec(nil, spec)
+	case *Example:
+		if o.Examples == nil {
+			o.Examples = make(map[string]*RefOrSpec[Extendable[Example]], 1)
+		}
+		o.Examples[name] = NewRefOrSpec(nil, NewExtendable(spec))
 	case *RefOrSpec[Extendable[RequestBody]]:
 		if o.RequestBodies == nil {
 			o.RequestBodies = make(map[string]*RefOrSpec[Extendable[RequestBody]], 1)
 		}
 		o.RequestBodies[name] = spec
+	case *Extendable[RequestBody]:
+		if o.RequestBodies == nil {
+			o.RequestBodies = make(map[string]*RefOrSpec[Extendable[RequestBody]], 1)
+		}
+		o.RequestBodies[name] = NewRefOrSpec(nil, spec)
+	case *RequestBody:
+		if o.RequestBodies == nil {
+			o.RequestBodies = make(map[string]*RefOrSpec[Extendable[RequestBody]], 1)
+		}
+		o.RequestBodies[name] = NewRefOrSpec(nil, NewExtendable(spec))
 	case *RefOrSpec[Extendable[Header]]:
 		if o.Headers == nil {
 			o.Headers = make(map[string]*RefOrSpec[Extendable[Header]], 1)
 		}
 		o.Headers[name] = spec
+	case *Extendable[Header]:
+		if o.Headers == nil {
+			o.Headers = make(map[string]*RefOrSpec[Extendable[Header]], 1)
+		}
+		o.Headers[name] = NewRefOrSpec(nil, spec)
+	case *Header:
+		if o.Headers == nil {
+			o.Headers = make(map[string]*RefOrSpec[Extendable[Header]], 1)
+		}
+		o.Headers[name] = NewRefOrSpec(nil, NewExtendable(spec))
 	case *RefOrSpec[Extendable[SecurityScheme]]:
 		if o.SecuritySchemes == nil {
 			o.SecuritySchemes = make(map[string]*RefOrSpec[Extendable[SecurityScheme]], 1)
 		}
 		o.SecuritySchemes[name] = spec
+	case *Extendable[SecurityScheme]:
+		if o.SecuritySchemes == nil {
+			o.SecuritySchemes = make(map[string]*RefOrSpec[Extendable[SecurityScheme]], 1)
+		}
+		o.SecuritySchemes[name] = NewRefOrSpec(nil, spec)
+	case *SecurityScheme:
+		if o.SecuritySchemes == nil {
+			o.SecuritySchemes = make(map[string]*RefOrSpec[Extendable[SecurityScheme]], 1)
+		}
+		o.SecuritySchemes[name] = NewRefOrSpec(nil, NewExtendable(spec))
 	case *RefOrSpec[Extendable[Link]]:
 		if o.Links == nil {
 			o.Links = make(map[string]*RefOrSpec[Extendable[Link]], 1)
 		}
 		o.Links[name] = spec
+	case *Extendable[Link]:
+		if o.Links == nil {
+			o.Links = make(map[string]*RefOrSpec[Extendable[Link]], 1)
+		}
+		o.Links[name] = NewRefOrSpec(nil, spec)
+	case *Link:
+		if o.Links == nil {
+			o.Links = make(map[string]*RefOrSpec[Extendable[Link]], 1)
+		}
+		o.Links[name] = NewRefOrSpec(nil, NewExtendable(spec))
 	case *RefOrSpec[Extendable[Callback]]:
 		if o.Callbacks == nil {
 			o.Callbacks = make(map[string]*RefOrSpec[Extendable[Callback]], 1)
 		}
 		o.Callbacks[name] = spec
+	case *Extendable[Callback]:
+		if o.Callbacks == nil {
+			o.Callbacks = make(map[string]*RefOrSpec[Extendable[Callback]], 1)
+		}
+		o.Callbacks[name] = NewRefOrSpec(nil, spec)
+	case *Callback:
+		if o.Callbacks == nil {
+			o.Callbacks = make(map[string]*RefOrSpec[Extendable[Callback]], 1)
+		}
+		o.Callbacks[name] = NewRefOrSpec(nil, NewExtendable(spec))
 	case *RefOrSpec[Extendable[PathItem]]:
 		if o.Paths == nil {
 			o.Paths = make(map[string]*RefOrSpec[Extendable[PathItem]], 1)
 		}
 		o.Paths[name] = spec
+	case *Extendable[PathItem]:
+		if o.Paths == nil {
+			o.Paths = make(map[string]*RefOrSpec[Extendable[PathItem]], 1)
+		}
+		o.Paths[name] = NewRefOrSpec(nil, spec)
+	case *PathItem:
+		if o.Paths == nil {
+			o.Paths = make(map[string]*RefOrSpec[Extendable[PathItem]], 1)
+		}
+		o.Paths[name] = NewRefOrSpec(nil, NewExtendable(spec))
+	default:
+		panic(fmt.Errorf("wrong component type: %T", spec))
 	}
 	return o
 }