refactor: openapi3edit: combine OperationMore and OperationEditor

Author: grokify

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/getkin/kin-openapi v0.60.0
 	github.com/ghodss/yaml v1.0.0
 	github.com/grokify/gocharts v1.3.0
-	github.com/grokify/simplego v0.25.4
+	github.com/grokify/simplego v0.26.1
 	github.com/jessevdk/go-flags v1.5.0
 	github.com/pkg/errors v0.9.1
 	github.com/rs/zerolog v1.21.0

go.sum

@@ -93,8 +93,8 @@ github.com/grokify/gocharts v1.3.0 h1:/M9cUup80jQtXBPb6RoPQJrGpb/90PFI5IZ58t5cJk
 github.com/grokify/gocharts v1.3.0/go.mod h1:uhe0lH04KtJuYRuzreaujjYZ/8x53Numw8JN/sa2/fw=
 github.com/grokify/simplego v0.0.3/go.mod h1:mOeVoV0XRtBVrkTxFdN4e9u7yeiRurhCtxsk+CA7gO4=
 github.com/grokify/simplego v0.0.21/go.mod h1:8BYycDukEZvM7jyu8mfG9On4/pG6fEhPYlE3TBsB/Xw=
-github.com/grokify/simplego v0.25.4 h1:Gq6aOcs+uiYTwT6ubkK/WzMZQ0wH9B/MA0CTZMTuRL4=
-github.com/grokify/simplego v0.25.4/go.mod h1:B24I7pmy89MLOQ2ySaigcsrNEe+DXK7opD2LMK2LJeg=
+github.com/grokify/simplego v0.26.1 h1:T/mjgK4PXYFgj0IsAFGRwtN6+Ts8poM5zR80jTA0fak=
+github.com/grokify/simplego v0.26.1/go.mod h1:B24I7pmy89MLOQ2ySaigcsrNEe+DXK7opD2LMK2LJeg=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
 github.com/huandu/xstrings v1.3.2 h1:L18LIDzqlW6xN2rEkpdV8+oL/IXWJ1APd+vsdYy4Wdw=
 github.com/huandu/xstrings v1.3.2/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE=

openapi3edit/operations.go

@@ -9,20 +9,38 @@ import (
 	"github.com/grokify/swaggman/openapi3"
 )
 
-type OperationEditor struct {
+type OperationMore struct {
+	UrlPath   string
+	Method    string
 	Operation *oas3.Operation
 }
 
-func (oedit *OperationEditor) AddExternalDocs(docURL, docDescription string, preserveIfReqEmpty bool) {
-	operationAddExternalDocs(oedit.Operation, docURL, docDescription, preserveIfReqEmpty)
+func (opm *OperationMore) AddExternalDocs(docURL, docDescription string, preserveIfReqEmpty bool) {
+	operationAddExternalDocs(opm.Operation, docURL, docDescription, preserveIfReqEmpty)
 }
 
-func (oedit *OperationEditor) AddRequestBodySchemaRef(description string, required bool, contentType string, schemaRef *oas3.SchemaRef) error {
-	return operationAddRequestBodySchemaRef(oedit.Operation, description, required, contentType, schemaRef)
+func (opm *OperationMore) AddRequestBodySchemaRef(description string, required bool, contentType string, schemaRef *oas3.SchemaRef) error {
+	return operationAddRequestBodySchemaRef(opm.Operation, description, required, contentType, schemaRef)
 }
 
-func (oedit *OperationEditor) AddResponseBodySchemaRef(statusCode, description, contentType string, schemaRef *oas3.SchemaRef) error {
-	return operationAddResponseBodySchemaRef(oedit.Operation, statusCode, description, contentType, schemaRef)
+func (opm *OperationMore) AddResponseBodySchemaRef(statusCode, description, contentType string, schemaRef *oas3.SchemaRef) error {
+	return operationAddResponseBodySchemaRef(opm.Operation, statusCode, description, contentType, schemaRef)
+}
+
+func (opm *OperationMore) HasParameter(paramNameWant string) bool {
+	paramNameWantLc := strings.TrimSpace(paramNameWant)
+	for _, paramRef := range opm.Operation.Parameters {
+		if paramRef.Value == nil {
+			continue
+		}
+		param := paramRef.Value
+		param.Name = strings.TrimSpace(param.Name)
+		paramNameTryLc := strings.ToLower(param.Name)
+		if paramNameWantLc == paramNameTryLc {
+			return true
+		}
+	}
+	return false
 }
 
 func operationAddRequestBodySchemaRef(op *oas3.Operation, description string, required bool, contentType string, schemaRef *oas3.SchemaRef) error {
@@ -234,12 +252,6 @@ type OperationMoreSet struct {
 	OperationMores []OperationMore
 }
 
-type OperationMore struct {
-	UrlPath   string
-	Method    string
-	Operation *oas3.Operation
-}
-
 func QueryOperationsByTags(spec *oas3.Swagger, tags []string) *OperationMoreSet {
 	tagsWantMatch := map[string]int{}
 	for _, tag := range tags {

openapi3edit/security.go

@@ -6,7 +6,7 @@ import (
 	"strings"
 
 	oas3 "github.com/getkin/kin-openapi/openapi3"
-	"github.com/grokify/simplego/type/stringsutil"
+	"github.com/grokify/simplego/type/maputil"
 	"github.com/grokify/swaggman/openapi3"
 )
 
@@ -132,13 +132,14 @@ func SecuritySchemeApikeyAddOperations(spec *oas3.Swagger, tags []string, keyNam
 		tagsMap[tagName] = 1
 	}
 	openapi3.VisitOperations(spec, func(skipPath, skipMethod string, op *oas3.Operation) {
-		if !MapSliceIntersectionExists(tagsMap, op.Tags) {
+		if !maputil.MapSliceIntersectionExists(tagsMap, op.Tags) {
 			return
 		}
 		SecuritySchemeAddOperation(op, keyName, []string{})
 	})
 }
 
+/*
 func MapSliceIntersection(haystack map[string]int, needles []string, unique bool) []string {
 	if unique {
 		needles = stringsutil.SliceCondenseSpace(needles, true, false)
@@ -151,6 +152,7 @@ func MapSliceIntersection(haystack map[string]int, needles []string, unique bool
 	}
 	return matches
 }
+*/
 
 func MapSliceIntersectionExists(haystack map[string]int, needles []string) bool {
 	for _, needle := range needles {

openapi3edit/validate_and_fix.go

@@ -32,6 +32,7 @@ func ParsePathParametersParens(urlPath string) []string {
 	return paramNames
 }
 
+/*
 func OperationHasParameter(paramNameWant string, op *oas3.Operation) bool {
 	paramNameWantLc := strings.ToLower(strings.TrimSpace(paramNameWant))
 	for _, paramRef := range op.Parameters {
@@ -47,7 +48,7 @@ func OperationHasParameter(paramNameWant string, op *oas3.Operation) bool {
 	}
 	return false
 }
-
+*/
 // SortParameters sorts parameters according to an input name list.
 // This used to resort parameters inline with path path parameters
 // so they line up properly when rendered.
@@ -96,8 +97,9 @@ func ValidateFixOperationPathParameters(spec *oas3.Swagger, fix bool) ([]*openap
 			}
 			varNamesMissing := []string{}
 			fixed := false
+			opm := OperationMore{Operation: op}
 			for _, varName := range varNamesPath {
-				if !OperationHasParameter(varName, op) {
+				if !opm.HasParameter(varName) {
 					if fix {
 						newParamRef := &oas3.ParameterRef{
 							Value: &oas3.Parameter{