feat: Add openapi/v2 endpoint

Makefile

@@ -16,14 +16,17 @@ KUSTOMIZE ?= $(LOCALBIN)/kustomize
 KUSTOMIZE_VERSION ?= v4.5.7
 KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
 
+OPENAPI_GEN ?= $(LOCALBIN)/openapi-gen
+OPENAPI_VERSION ?= c8a335a
+
 KUBECONFIG ?= ~/.kube/config
 
 .PHONY:build
 build: fmt vet
 	go build -o bin/console main.go
 
 .PHONY: build-container
-build-container: fmt vet test
+build-container: generate fmt vet test
 	podman manifest rm ${IMG} || true && \
 	podman build --build-arg TARGET_ARCH=amd64 --manifest=${IMG} . && \
 	podman build --build-arg TARGET_ARCH=s390x --manifest=${IMG} . && \
@@ -42,6 +45,21 @@ kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
 $(KUSTOMIZE): $(LOCALBIN)
 	test -s $(LOCALBIN)/kustomize || curl -s $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN)
 
+.PHONY: openapi-gen
+openapi-gen: $(OPENAPI_GEN) ## Download openapi-gen locally if necessary.
+$(OPENAPI_GEN): $(LOCALBIN)
+	test -s $(OPENAPI_GEN) || GOBIN=$(LOCALBIN) go install k8s.io/kube-openapi/cmd/openapi-gen@$(OPENAPI_VERSION)
+
+.PHONY: generate
+generate: openapi-gen
+	cd api && $(OPENAPI_GEN) \
+	  --output-file zz_generated.openapi.go \
+	  --output-dir ../pkg/generated/api/v1 \
+	  --output-pkg kubevirt.io/vm-console-proxy/api/v1 \
+	  --report-filename /dev/null \
+	  k8s.io/apimachinery/pkg/apis/meta/v1 \
+	  kubevirt.io/vm-console-proxy/api/v1
+
 .PHONY: release-manifests
 release-manifests: kustomize manifests
 	mkdir -p ./_out

api/v1/types.go

@@ -5,6 +5,8 @@ import (
 )
 
 // TokenResponse is the response object from /token endpoint.
+//
+// +k8s:openapi-gen=true
 type TokenResponse struct {
 	Token               string      `json:"token"`
 	ExpirationTimestamp metav1.Time `json:"expirationTimestamp"`

go.mod

@@ -12,6 +12,7 @@ require (
 	k8s.io/api v0.31.0
 	k8s.io/apimachinery v0.32.3
 	k8s.io/client-go v0.31.0
+	k8s.io/kube-openapi v0.31.0
 	k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738
 	kubevirt.io/api v1.5.0
 	kubevirt.io/client-go v1.5.0
@@ -72,7 +73,6 @@ require (
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/apiextensions-apiserver v0.31.0 // indirect
 	k8s.io/klog/v2 v2.130.1 // indirect
-	k8s.io/kube-openapi v0.31.0 // indirect
 	kubevirt.io/containerized-data-importer-api v1.62.0 // indirect
 	kubevirt.io/controller-lifecycle-operator-sdk/api v0.2.4 // indirect
 	sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3 // indirect

pkg/console/console.go

@@ -7,6 +7,10 @@ import (
 
 	"github.com/emicklei/go-restful/v3"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/kube-openapi/pkg/builder"
+	"k8s.io/kube-openapi/pkg/common"
+	"k8s.io/kube-openapi/pkg/common/restfuladapter"
+	"k8s.io/kube-openapi/pkg/validation/spec"
 	"kubevirt.io/client-go/kubecli"
 	"kubevirt.io/client-go/log"
 
@@ -15,6 +19,7 @@ import (
 	"kubevirt.io/vm-console-proxy/pkg/console/service"
 	"kubevirt.io/vm-console-proxy/pkg/console/tlsconfig"
 	"kubevirt.io/vm-console-proxy/pkg/filewatch"
+	generated "kubevirt.io/vm-console-proxy/pkg/generated/api/v1"
 )
 
 const (
@@ -64,7 +69,12 @@ func Run() error {
 
 	handlers := service.NewService(cli, authConfigReader)
 
-	restful.Add(webService(handlers))
+	ws, err := webService(handlers)
+	if err != nil {
+		return fmt.Errorf("failed to create web service: %w", err)
+	}
+
+	restful.Add(ws)
 	restful.Filter(restful.OPTIONSFilter())
 
 	server := &http.Server{
@@ -85,13 +95,16 @@ func Run() error {
 	return server.ListenAndServeTLS("", "")
 }
 
-func webService(handlers service.Service) *restful.WebService {
+func webService(handlers service.Service) (*restful.WebService, error) {
 	ws := new(restful.WebService)
 
-	ws.Route(ws.GET("/apis/" + api.Group + "/" + api.Version + "/namespaces/{namespace:[a-z0-9][a-z0-9\\-]*}/virtualmachines/{name:[a-z0-9][a-z0-9\\-]*}/vnc").
+	ws.Route(ws.GET("/apis/"+api.Group+"/"+api.Version+"/namespaces/{namespace}/virtualmachines/{name}/vnc").
 		To(handlers.TokenHandler).
 		Doc("generate token").
 		Operation("token").
+		Returns(http.StatusOK, "OK", api.TokenResponse{}).
+		Returns(http.StatusBadRequest, "BadRequest", "").
+		Returns(http.StatusNotFound, "NotFound", "").
 		Param(ws.PathParameter("namespace", "namespace").Required(true)).
 		Param(ws.PathParameter("name", "name").Required(true)).
 		Param(ws.QueryParameter("duration", "duration")))
@@ -169,14 +182,63 @@ func webService(handlers service.Service) *restful.WebService {
 			response.WriteAsJson(&metav1.RootPaths{
 				Paths: []string{
 					"/apis",
-					"/apis/" + api.Group,
-					"/apis/" + api.Group + "/" + api.Version,
+					"/openapi/v2",
 				},
 			})
 		}).
 		Operation("getRootPaths").
 		Doc("Get API root paths").
 		Returns(http.StatusOK, "OK", metav1.RootPaths{}))
 
-	return ws
+	openApiSpec, err := builder.BuildOpenAPISpecFromRoutes(restfuladapter.AdaptWebServices([]*restful.WebService{ws}), openApiConfig())
+	if err != nil {
+		return nil, fmt.Errorf("failed to build OpenAPI spec from routes: %w", err)
+	}
+
+	ws.Route(ws.GET("openapi/v2").
+		Consumes(restful.MIME_JSON).
+		Produces(restful.MIME_JSON).
+		To(func(request *restful.Request, response *restful.Response) {
+			response.WriteAsJson(openApiSpec)
+		}))
+
+	return ws, nil
+}
+
+func openApiConfig() *common.Config {
+	return &common.Config{
+		CommonResponses: map[int]spec.Response{
+			401: {
+				ResponseProps: spec.ResponseProps{
+					Description: "Unauthorized",
+				},
+			},
+		},
+		Info: &spec.Info{
+			InfoProps: spec.InfoProps{
+				Title:       "KubeVirt VNC token generation API",
+				Description: "This is the VNC token generation API for Kubevirt.",
+				Contact: &spec.ContactInfo{
+					Name:  "kubevirt-dev",
+					Email: "[email protected]",
+					URL:   "https://github.com/kubevirt/kubevirt",
+				},
+				License: &spec.License{
+					Name: "Apache 2.0",
+					URL:  "https://www.apache.org/licenses/LICENSE-2.0",
+				},
+			},
+		},
+		SecurityDefinitions: &spec.SecurityDefinitions{
+			"BearerToken": &spec.SecurityScheme{
+				SecuritySchemeProps: spec.SecuritySchemeProps{
+					Type:        "apiKey",
+					Name:        "authorization",
+					In:          "header",
+					Description: "Bearer Token authentication",
+				},
+			},
+		},
+		GetDefinitions: generated.GetOpenAPIDefinitions,
+	}
 }