BUG/MINOR: specification: fix open api v3 specification generation

haproxytech · Dec 19, 2024 · d30eda3 · d30eda3
1 parent 0fb4941
commit d30eda3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/configure_data_plane.go b/configure_data_plane.go
@@ -20,6 +20,7 @@ package dataplaneapi
 import (
 	"context"
 	"crypto/tls"
+	"encoding/json"
 	"io"
 	"net/http"
 	"os"
@@ -751,7 +752,11 @@ func configureAPI(api *operations.DataPlaneAPI) http.Handler { //nolint:cyclop,m
 	// setup OpenAPI v3 specification handler
 	api.Version3GetOpenapiv3SpecificationHandler = version3.GetOpenapiv3SpecificationHandlerFunc(func(params version3.GetOpenapiv3SpecificationParams, principal interface{}) middleware.Responder {
 		v2 := openapi2.T{}
-		err = v2.UnmarshalJSON(SwaggerJSON)
+		v2JSONString := string(SwaggerJSON)
+		v2JSONString = strings.ReplaceAll(v2JSONString, "#/definitions", "#/components/schemas")
+		curatedV2 := json.RawMessage([]byte(v2JSONString))
+
+		err = v2.UnmarshalJSON(curatedV2)
 		if err != nil {
 			e := misc.HandleError(err)
 			return version3.NewGetOpenapiv3SpecificationDefault(int(*e.Code)).WithPayload(e)

diff --git a/configure_data_plane_test.go b/configure_data_plane_test.go
@@ -18,19 +18,26 @@
 package dataplaneapi
 
 import (
+	"encoding/json"
+	"strings"
 	"testing"
 
 	"github.com/getkin/kin-openapi/openapi2"
 	"github.com/getkin/kin-openapi/openapi2conv"
 )
 
 func TestConvOpenAPIV2ToV3(t *testing.T) {
+	v2JSONString := string(SwaggerJSON)
+	v2JSONString = strings.ReplaceAll(v2JSONString, "#/definitions", "#/components/schemas")
+	curatedV2 := json.RawMessage([]byte(v2JSONString))
+
 	var v2 openapi2.T
-	err := v2.UnmarshalJSON(SwaggerJSON)
+	err := v2.UnmarshalJSON(curatedV2)
 	if err != nil {
 		t.Error(err)
 		return
 	}
+
 	_, err = openapi2conv.ToV3(&v2)
 	if err != nil {
 		t.Error(err)