FEATURE/MEDIUM: specification: add endpoint to serve OpenAPI v3 spec

This adds endpoint to serve OpenAPI v3 specification in addition
to existing endpoint (serving Swagger v2)

Author: amelhusic

CONTRIBUTING.md

@@ -19,6 +19,7 @@ Data Plane API is generated using [go-swagger](https://github.com/go-swagger/go-
     --tags=Discovery \
     --tags=Information \
     --tags=Specification \
+    --tags=SpecificationOpenapiv3 \
     --tags=Transactions \
     --tags=Sites \
     --tags=Stats \

configure_data_plane.go

@@ -34,9 +34,12 @@ import (
 	"syscall"
 	"time"
 
+	"github.com/getkin/kin-openapi/openapi2"
+	"github.com/getkin/kin-openapi/openapi2conv"
 	"github.com/haproxytech/config-parser/v2/types"
 	"github.com/haproxytech/dataplaneapi/adapters"
 	"github.com/haproxytech/dataplaneapi/operations/specification"
+	"github.com/haproxytech/dataplaneapi/operations/specification_openapiv3"
 	"github.com/haproxytech/models/v2"
 
 	log "github.com/sirupsen/logrus"
@@ -433,6 +436,30 @@ func configureAPI(api *operations.DataPlaneAPI) http.Handler {
 		return specification.NewGetSpecificationOK().WithPayload(&m)
 	})
 
+	// setup OpenAPI v3 specification handler
+	api.SpecificationOpenapiv3GetOpenapiv3SpecificationHandler = specification_openapiv3.GetOpenapiv3SpecificationHandlerFunc(func(params specification_openapiv3.GetOpenapiv3SpecificationParams, principal interface{}) middleware.Responder {
+		v2 := openapi2.Swagger{}
+		err := v2.UnmarshalJSON(SwaggerJSON)
+		if err != nil {
+			e := misc.HandleError(err)
+			return specification_openapiv3.NewGetOpenapiv3SpecificationDefault(int(*e.Code)).WithPayload(e)
+		}
+
+		// if host is empty(dynamic hosts), server prop is empty,
+		// so we need to set it explicitly
+		if v2.Host == "" {
+			cfg := dataplaneapi_config.Get()
+			v2.Host = cfg.Server.Host
+		}
+
+		v3, err := openapi2conv.ToV3Swagger(&v2)
+		if err != nil {
+			e := misc.HandleError(err)
+			return specification_openapiv3.NewGetOpenapiv3SpecificationDefault(int(*e.Code)).WithPayload(e)
+		}
+		return specification_openapiv3.NewGetOpenapiv3SpecificationOK().WithPayload(v3)
+	})
+
 	return setupGlobalMiddleware(api.Serve(setupMiddlewares))
 }
 

embedded_spec.go

@@ -7,6 +7,7 @@ require (
 	github.com/StackExchange/wmi v0.0.0-20190523213315-cbe66965904d // indirect
 	github.com/docker/go-units v0.4.0
 	github.com/dustinkirkland/golang-petname v0.0.0-20191129215211-8e5a1ed0cff0
+	github.com/getkin/kin-openapi v0.17.0
 	github.com/go-ole/go-ole v1.2.4 // indirect
 	github.com/go-openapi/errors v0.19.4
 	github.com/go-openapi/loads v0.19.5
@@ -25,5 +26,5 @@ require (
 	github.com/sirupsen/logrus v1.5.0
 	golang.org/x/net v0.0.0-20200425230154-ff2c4b7c35a0
 	golang.org/x/sys v0.0.0-20200420163511-1957bb5e6d1f
-	gopkg.in/yaml.v2 v2.2.8
+	gopkg.in/yaml.v2 v2.3.0
 )

go.mod

@@ -23,6 +23,10 @@ github.com/docker/go-units v0.4.0 h1:3uh0PgVws3nIA0Q+MwDC8yjEPf9zjRfZZWXZYDct3Tw
 github.com/docker/go-units v0.4.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk=
 github.com/dustinkirkland/golang-petname v0.0.0-20191129215211-8e5a1ed0cff0 h1:90Ly+6UfUypEF6vvvW5rQIv9opIL8CbmW9FT20LDQoY=
 github.com/dustinkirkland/golang-petname v0.0.0-20191129215211-8e5a1ed0cff0/go.mod h1:V+Qd57rJe8gd4eiGzZyg4h54VLHmYVVw54iMnlAMrF8=
+github.com/getkin/kin-openapi v0.17.0 h1:eAwanndaPI4Hw/vEF3Twj54j2gUzpbSf7BD3lEl6ARg=
+github.com/getkin/kin-openapi v0.17.0/go.mod h1:WGRs2ZMM1Q8LR1QBEwUxC6RJEfaBcD0s+pcEVXFuAjw=
+github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk=
+github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
 github.com/globalsign/mgo v0.0.0-20180905125535-1ca0a4f7cbcb/go.mod h1:xkRDCp4j0OGD1HRkm4kmhM+pmpv3AKq5SU7GMg4oO/Q=
 github.com/globalsign/mgo v0.0.0-20181015135952-eeefdecb41b8/go.mod h1:xkRDCp4j0OGD1HRkm4kmhM+pmpv3AKq5SU7GMg4oO/Q=
 github.com/go-ole/go-ole v1.2.4 h1:nNBDSCOigTSiarFpYE9J/KtEA1IOW4CNeqT9TQDqCxI=
@@ -282,3 +286,5 @@ gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
 gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
+gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=