Use ordered maps

go.mod

@@ -27,4 +27,7 @@ require (
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/bahlo/generic-list-go v0.2.0 // indirect
+	github.com/buger/jsonparser v1.1.1 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
 )

go.sum

@@ -3,6 +3,10 @@ github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xW
 github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=
 github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
+github.com/bahlo/generic-list-go v0.2.0 h1:5sz/EEAK+ls5wF+NeqDpk5+iNdMDXrh3z3nPnH1Wvgk=
+github.com/bahlo/generic-list-go v0.2.0/go.mod h1:2KvAjgMlE5NNynlg/5iLrrCCZ2+5xWbdbCW3pNTGyYg=
+github.com/buger/jsonparser v1.1.1 h1:2PnMjfWD7wBILjqQbt530v576A/cAbQvEW9gGIpYMUs=
+github.com/buger/jsonparser v1.1.1/go.mod h1:6RYKKt7H4d4+iWqouImQ9R2FZql3VbhNgx27UK13J/0=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

openapi2conv/issue847_test.go

@@ -35,9 +35,9 @@ paths:
 	err = v3.Validate(context.Background())
 	require.NoError(t, err)
 
-	schemaRequired := v3.Paths["/ping"].Post.RequestBody.Value.Content["multipart/form-data"].Schema.Value.Required
+	schemaRequired := v3.Paths.Value("/ping").Post.RequestBody.Value.Content["multipart/form-data"].Schema.Value.Required
 	require.Equal(t, schemaRequired, []string{"file"})
 
-	fieldRequired := v3.Paths["/ping"].Post.RequestBody.Value.Content["multipart/form-data"].Schema.Value.Properties["file"].Value.Required
+	fieldRequired := v3.Paths.Value("/ping").Post.RequestBody.Value.Content["multipart/form-data"].Schema.Value.Properties["file"].Value.Required
 	require.Nil(t, fieldRequired)
 }

openapi3/callback.go

@@ -57,6 +57,11 @@ func (pair *callbacksKV) Next() *callbacksKV {
 	return (*callbacksKV)(ompair.Next())
 }
 
+// NewCallbacksWithCapacity builds a callbacks object of the given capacity.
+func NewCallbacksWithCapacity(cap int) *Callbacks {
+	return &Callbacks{om: orderedmap.New[string, *CallbackRef](cap)}
+}
+
 var _ jsonpointer.JSONPointable = (*Callbacks)(nil)
 
 // JSONLookup implements https://pkg.go.dev/github.com/go-openapi/jsonpointer#JSONPointable

openapi3/internalize_refs.go

@@ -241,13 +241,6 @@ func (doc *T) addCallbackToSpec(c *CallbackRef, refNameResolver RefNameResolver,
 		return false
 	}
 	name := refNameResolver(c.Ref)
-
-	if doc.Components == nil {
-		doc.Components = &Components{}
-	}
-	if doc.Components.Callbacks == nil {
-		doc.Components.Callbacks = &Callbacks{}
-	}
 	c.Ref = "#/components/callbacks/" + name
 	doc.Components.Callbacks.Set(name, &CallbackRef{Value: c.Value})
 	return true
@@ -354,6 +347,13 @@ func (doc *T) derefPaths(paths *orderedmap.OrderedMap[string, *PathItem], refNam
 			if op.RequestBody != nil && op.RequestBody.Value != nil {
 				doc.derefRequestBody(*op.RequestBody.Value, refNameResolver, pathIsExternal || isExternal)
 			}
+
+			if doc.Components == nil {
+				doc.Components = &Components{}
+			}
+			if doc.Components.Callbacks == nil {
+				doc.Components.Callbacks = NewCallbacksWithCapacity(op.Callbacks.Len())
+			}
 			for pair := op.Callbacks.Iter(); pair != nil; pair = pair.Next() {
 				cb := pair.Value
 				isExternal := doc.addCallbackToSpec(cb, refNameResolver, pathIsExternal)
@@ -362,6 +362,7 @@ func (doc *T) derefPaths(paths *orderedmap.OrderedMap[string, *PathItem], refNam
 					doc.derefPaths(cbValue, refNameResolver, pathIsExternal || isExternal)
 				}
 			}
+
 			doc.derefResponses(op.Responses, refNameResolver, pathIsExternal)
 			for _, param := range op.Parameters {
 				isExternal := doc.addParameterToSpec(param, refNameResolver, pathIsExternal)
@@ -425,6 +426,12 @@ func (doc *T) InternalizeRefs(ctx context.Context, refNameResolver func(ref stri
 		doc.derefExamples(components.Examples, refNameResolver, false)
 		doc.derefLinks(components.Links, refNameResolver, false)
 
+		if doc.Components == nil {
+			doc.Components = &Components{}
+		}
+		if doc.Components.Callbacks == nil {
+			doc.Components.Callbacks = NewCallbacksWithCapacity(components.Callbacks.Len())
+		}
 		for pair := components.Callbacks.Iter(); pair != nil; pair = pair.Next() {
 			cb := pair.Value
 			isExternal := doc.addCallbackToSpec(cb, refNameResolver, false)

openapi3/issue819_test.go

@@ -33,7 +33,7 @@ paths:
 	err = doc.Validate(sl.Context)
 	require.NoError(t, err)
 
-	require.NotNil(t, doc.Paths["/v1/operation"].Get.Responses.Get(201))
-	require.Nil(t, doc.Paths["/v1/operation"].Get.Responses.Get(404))
-	require.Nil(t, doc.Paths["/v1/operation"].Get.Responses.Get(999))
+	require.NotNil(t, doc.Paths.Value("/v1/operation").Get.Responses.Get(201))
+	require.Nil(t, doc.Paths.Value("/v1/operation").Get.Responses.Get(404))
+	require.Nil(t, doc.Paths.Value("/v1/operation").Get.Responses.Get(999))
 }

openapi3/loader_test.go

@@ -62,6 +62,7 @@ paths:
 	require.Equal(t, 2, len(doc.Components.Schemas))
 	require.Equal(t, 1, doc.Paths.Len())
 	require.Equal(t, "unexpected error", *doc.Paths.Value("/items").Put.Responses.Default().Value.Description)
+
 	err = doc.Validate(loader.Context)
 	require.NoError(t, err)
 }

openapi3/refs_test.go

@@ -230,8 +230,8 @@ components:
 	require.NoError(t, err)
 	v, kind, err = ptr.Get(doc)
 	require.NoError(t, err)
-	require.IsType(t, Paths{}, v)
-	require.Equal(t, reflect.TypeOf(Paths{}).Kind(), kind)
+	require.IsType(t, &Paths{}, v)
+	require.Equal(t, reflect.TypeOf(&Paths{}).Kind(), kind)
 
 	ptr, err = jsonpointer.New("/paths/~1pet")
 	require.NoError(t, err)

openapi3/security_scheme.go

@@ -364,8 +364,8 @@ func (flow *OAuthFlow) Validate(ctx context.Context, opts ...ValidationOption) e
 		}
 	}
 
-	if flow.Scopes == nil {
-		return errors.New("field 'scopes' is missing")
+	if v := flow.Scopes; v == nil || v.Len() == 0 {
+		return errors.New("field 'scopes' is empty or missing")
 	}
 
 	return validateExtensions(ctx, flow.Extensions)

openapi3filter/req_resp_decoder_test.go

@@ -1042,7 +1042,7 @@ func TestDecodeParameter(t *testing.T) {
 						Title:   "MyAPI",
 						Version: "0.1",
 					}
-					doc := &openapi3.T{OpenAPI: "3.0.0", Info: info, Paths: openapi3.Paths{}}
+					doc := &openapi3.T{OpenAPI: "3.0.0", Info: info, Paths: openapi3.NewPaths()}
 					op := &openapi3.Operation{
 						OperationID: "test",
 						Parameters:  []*openapi3.ParameterRef{{Value: tc.param}},