Fixes for CI

Author: Jefftree

pkg/builder3/openapi.go

@@ -25,7 +25,6 @@ import (
 	"k8s.io/kube-openapi/pkg/spec3"
 	"k8s.io/kube-openapi/pkg/util"
 	"k8s.io/kube-openapi/pkg/validation/spec"
-	"k8s.io/kube-openapi/pkg/openapiconv"
 	"net/http"
 	"strings"
 )
@@ -35,11 +34,12 @@ const (
 )
 
 type openAPI struct {
-	config      *common.Config
+	config      *common.OpenAPIV3Config
 	spec        *spec3.OpenAPI
 	definitions map[string]common.OpenAPIDefinition
 }
 
+
 func groupRoutesByPath(routes []common.Route) map[string][]common.Route {
 	pathToRoutes := make(map[string][]common.Route)
 	for _, r := range routes {
@@ -106,16 +106,15 @@ func (o *openAPI) buildOperations(route common.Route, inPathCommonParamsMap map[
 
 	for code, resp := range o.config.CommonResponses {
 		if _, exists := ret.Responses.StatusCodeResponses[code]; !exists {
-			ret.Responses.StatusCodeResponses[code] = openapiconv.ConvertResponse(&resp, route.Produces())
+			ret.Responses.StatusCodeResponses[code] = resp
 		}
 	}
 
 	// If there is still no response, use default response provided.
 	if len(ret.Responses.StatusCodeResponses) == 0 {
-		ret.Responses.Default = openapiconv.ConvertResponse(o.config.DefaultResponse, route.Produces())
+		ret.Responses.Default = o.config.DefaultResponse
 	}
 
-
 	ret.Parameters = make([]*spec3.Parameter, 0)
 	params := route.Parameters()
 	for _, param := range params {
@@ -166,19 +165,23 @@ func (o *openAPI) buildRequestBody(parameters []common.Parameter, bodySample int
 
 func newOpenAPI(config *common.Config) openAPI {
 	o := openAPI{
-		config: config,
+		config: common.ConvertConfigToV3(config),
 		spec: &spec3.OpenAPI{
 			Version: "3.0.0",
 			Info:    config.Info,
 			Paths: &spec3.Paths{
 				Paths: map[string]*spec3.Path{},
 			},
 			Components: &spec3.Components{
-				Schemas: map[string]*spec.Schema{},
+				Schemas:         map[string]*spec.Schema{},
 				SecuritySchemes: make(spec3.SecuritySchemes),
+				Responses: make(map[string]*spec3.Response),
 			},
 		},
 	}
+	for k, response := range o.config.ResponseDefinitions {
+		o.spec.Components.Responses[k] = response
+	}
 
 	if o.config.GetOperationIDAndTagsFromRoute == nil {
 		// Map the deprecated handler to the common interface, if provided.

pkg/common/common.go

@@ -22,6 +22,8 @@ import (
 
 	"github.com/emicklei/go-restful"
 
+	"k8s.io/kube-openapi/pkg/openapiconv"
+	"k8s.io/kube-openapi/pkg/spec3"
 	"k8s.io/kube-openapi/pkg/validation/spec"
 )
 
@@ -117,6 +119,89 @@ type Config struct {
 	DefaultSecurity []map[string][]string
 }
 
+type OpenAPIV3Config struct {
+	// Info is general information about the API.
+	Info *spec.Info
+
+	// DefaultResponse will be used if an operation does not have any responses listed. It
+	// will show up as ... "responses" : {"default" : $DefaultResponse} in the spec.
+	DefaultResponse *spec3.Response
+
+	// ResponseDefinitions will be added to "responses" under the top-level swagger object. This is an object
+	// that holds responses definitions that can be used across operations. This property does not define
+	// global responses for all operations. For more info please refer:
+	//     https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields
+	ResponseDefinitions map[string]*spec3.Response
+
+	// CommonResponses will be added as a response to all operation specs. This is a good place to add common
+	// responses such as authorization failed.
+	CommonResponses map[int]*spec3.Response
+
+	// List of webservice's path prefixes to ignore
+	IgnorePrefixes []string
+
+	// OpenAPIDefinitions should provide definition for all models used by routes. Failure to provide this map
+	// or any of the models will result in spec generation failure.
+	GetDefinitions GetOpenAPIDefinitions
+
+	// GetOperationIDAndTags returns operation id and tags for a restful route. It is an optional function to customize operation IDs.
+	//
+	// Deprecated: GetOperationIDAndTagsFromRoute should be used instead. This cannot be specified if using the new Route
+	// interface set of funcs.
+	GetOperationIDAndTags func(r *restful.Route) (string, []string, error)
+
+	// GetOperationIDAndTagsFromRoute returns operation id and tags for a Route. It is an optional function to customize operation IDs.
+	GetOperationIDAndTagsFromRoute func(r Route) (string, []string, error)
+
+	// GetDefinitionName returns a friendly name for a definition base on the serving path. parameter `name` is the full name of the definition.
+	// It is an optional function to customize model names.
+	GetDefinitionName func(name string) (string, spec.Extensions)
+
+	// SecurityDefinitions is list of all security definitions for OpenAPI service. If this is not nil, the user of config
+	// is responsible to provide DefaultSecurity and (maybe) add unauthorized response to CommonResponses.
+	SecuritySchemes spec3.SecuritySchemes
+
+	// DefaultSecurity for all operations. This will pass as spec.SwaggerProps.Security to OpenAPI.
+	// For most cases, this will be list of acceptable definitions in SecurityDefinitions.
+	DefaultSecurity []map[string][]string
+}
+
+// ConvertConfigToV3 converts a Config object to an OpenAPIV3Config object
+func ConvertConfigToV3(config *Config) *OpenAPIV3Config {
+	if config == nil {
+		return nil
+	}
+
+	v3Config := &OpenAPIV3Config{
+		Info:                           config.Info,
+		IgnorePrefixes:                 config.IgnorePrefixes,
+		GetDefinitions:                 config.GetDefinitions,
+		GetOperationIDAndTags:          config.GetOperationIDAndTags,
+		GetOperationIDAndTagsFromRoute: config.GetOperationIDAndTagsFromRoute,
+		GetDefinitionName:              config.GetDefinitionName,
+		SecuritySchemes:                make(spec3.SecuritySchemes),
+		DefaultSecurity:                config.DefaultSecurity,
+		DefaultResponse:                openapiconv.ConvertResponse(config.DefaultResponse, []string{"application/json"}),
+
+		CommonResponses:                make(map[int]*spec3.Response),
+		ResponseDefinitions:            make(map[string]*spec3.Response),
+	}
+
+	if config.SecurityDefinitions != nil {
+		for s, securityScheme := range *config.SecurityDefinitions {
+			v3Config.SecuritySchemes[s] = openapiconv.ConvertSecurityScheme(securityScheme)
+		}
+	}
+	for k, commonResponse := range config.CommonResponses {
+		v3Config.CommonResponses[k] = openapiconv.ConvertResponse(&commonResponse, []string{"application/json"})
+	}
+
+	for k, responseDefinition := range config.ResponseDefinitions {
+		v3Config.ResponseDefinitions[k] = openapiconv.ConvertResponse(&responseDefinition, []string{"application/json"})
+	}
+	return v3Config
+}
+
 type typeInfo struct {
 	name   string
 	format string