Merge pull request #195 from jhernand/honor_json_annotation_in_openap…

…i_generator Honor `@json` annotation in OpenAPI generator
openshift-online · May 18, 2023 · 4bf3654 · 4bf3654
2 parents 01e4c03 + 8b562cb
commit 4bf3654
Show file tree

Hide file tree

Showing 10 changed files with 89 additions and 95 deletions.
diff --git a/pkg/http/annotations.go → pkg/annotations/annotations.go b/pkg/http/annotations.go → pkg/annotations/annotations.go
@@ -14,17 +14,17 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package http
+package annotations
 
 import (
 	"fmt"
 
 	"github.com/openshift-online/ocm-api-metamodel/pkg/concepts"
 )
 
-// httpName checks if the given concept has a `http` annotation. If it does then it returns the
+// HTTPName checks if the given concept has a `http` annotation. If it does then it returns the
 // value of the `name` parameter. If it doesn't, it returns an empty string.
-func httpName(concept concepts.Annotated) string {
+func HTTPName(concept concepts.Annotated) string {
 	annotation := concept.GetAnnotation("http")
 	if annotation == nil {
 		return ""
@@ -36,9 +36,9 @@ func httpName(concept concepts.Annotated) string {
 	return fmt.Sprintf("%s", name)
 }
 
-// jsonName checks if the given concept has a `json` annotation. If it does then it returns the
+// JSONName checks if the given concept has a `json` annotation. If it does then it returns the
 // value of the `name` parameter. If it doesn't, it returns an empty string.
-func jsonName(concept concepts.Annotated) string {
+func JSONName(concept concepts.Annotated) string {
 	annotation := concept.GetAnnotation("json")
 	if annotation == nil {
 		return ""
@@ -49,3 +49,17 @@ func jsonName(concept concepts.Annotated) string {
 	}
 	return fmt.Sprintf("%s", name)
 }
+
+// GoName checks if the given concept as a `go` annotation. If it has it then it returns the value
+// of the `name` parameter. It returns an empty string if there is no such annotation or parameter.
+func GoName(concept concepts.Annotated) string {
+	annotation := concept.GetAnnotation("go")
+	if annotation == nil {
+		return ""
+	}
+	name := annotation.FindParameter("name")
+	if name == nil {
+		return ""
+	}
+	return fmt.Sprintf("%s", name)
+}
diff --git a/pkg/generators/golang/annotations.go b/pkg/generators/golang/annotations.go
diff --git a/pkg/generators/golang/builders_generator.go b/pkg/generators/golang/builders_generator.go
@@ -19,6 +19,7 @@ package golang
 import (
 	"fmt"
 
+	"github.com/openshift-online/ocm-api-metamodel/pkg/annotations"
 	"github.com/openshift-online/ocm-api-metamodel/pkg/concepts"
 	"github.com/openshift-online/ocm-api-metamodel/pkg/names"
 	"github.com/openshift-online/ocm-api-metamodel/pkg/nomenclator"
@@ -558,13 +559,13 @@ func (g *BuildersGenerator) objectName(typ *concepts.Type) string {
 	var name string
 	switch {
 	case typ.IsStruct():
-		name = goName(typ)
+		name = annotations.GoName(typ)
 		if name == "" {
 			name = g.names.Public(typ.Name())
 		}
 	case typ.IsList():
 		element := typ.Element()
-		name = goName(element)
+		name = annotations.GoName(element)
 		if name == "" {
 			name = g.names.Public(element.Name())
 		}
@@ -582,14 +583,14 @@ func (g *BuildersGenerator) builderName(typ *concepts.Type) string {
 	var name string
 	switch {
 	case typ.IsStruct():
-		name = goName(typ)
+		name = annotations.GoName(typ)
 		if name == "" {
 			name = g.names.Public(typ.Name())
 		}
 		name += "Builder"
 	case typ.IsList():
 		element := typ.Element()
-		name = goName(element)
+		name = annotations.GoName(element)
 		if name == "" {
 			name = g.names.Public(element.Name())
 		}
@@ -610,13 +611,13 @@ func (g *BuildersGenerator) builderCtor(typ *concepts.Type) string {
 	switch {
 	case typ.IsList():
 		element := typ.Element()
-		name = goName(element)
+		name = annotations.GoName(element)
 		if name == "" {
 			name = g.names.Public(element.Name())
 		}
 		name += "List"
 	case typ.IsStruct():
-		name = goName(typ)
+		name = annotations.GoName(typ)
 		if name == "" {
 			name = g.names.Public(typ.Name())
 		}
@@ -685,7 +686,7 @@ func (g *BuildersGenerator) fieldType(attribute *concepts.Attribute) *TypeRefere
 }
 
 func (g *BuildersGenerator) setterName(attribute *concepts.Attribute) string {
-	name := goName(attribute)
+	name := annotations.GoName(attribute)
 	if name == "" {
 		name = g.names.Public(attribute.Name())
 	}

diff --git a/pkg/generators/golang/clients_generator.go b/pkg/generators/golang/clients_generator.go
@@ -19,6 +19,7 @@ package golang
 import (
 	"fmt"
 
+	"github.com/openshift-online/ocm-api-metamodel/pkg/annotations"
 	"github.com/openshift-online/ocm-api-metamodel/pkg/concepts"
 	"github.com/openshift-online/ocm-api-metamodel/pkg/http"
 	"github.com/openshift-online/ocm-api-metamodel/pkg/names"
@@ -1008,7 +1009,7 @@ func (g *ClientsGenerator) generateResponseSource(method *concepts.Method) {
 }
 
 func (g *ClientsGenerator) versionName(version *concepts.Version) string {
-	name := goName(version)
+	name := annotations.GoName(version)
 	if name == "" {
 		name = g.names.Public(version.Name())
 	}
@@ -1024,7 +1025,7 @@ func (g *ClientsGenerator) resourceFile(resource *concepts.Resource) string {
 }
 
 func (g *ClientsGenerator) enumName(typ *concepts.Type) string {
-	name := goName(typ)
+	name := annotations.GoName(typ)
 	if name == "" {
 		name = g.names.Public(typ.Name())
 	}
@@ -1056,7 +1057,7 @@ func (g *ClientsGenerator) fieldType(parameter *concepts.Parameter) *TypeReferen
 }
 
 func (g *ClientsGenerator) getterName(parameter *concepts.Parameter) string {
-	name := goName(parameter)
+	name := annotations.GoName(parameter)
 	if name == "" {
 		name = g.names.Public(parameter.Name())
 	}
@@ -1069,7 +1070,7 @@ func (g *ClientsGenerator) getterType(parameter *concepts.Parameter) *TypeRefere
 }
 
 func (g *ClientsGenerator) setterName(parameter *concepts.Parameter) string {
-	name := goName(parameter)
+	name := annotations.GoName(parameter)
 	if name == "" {
 		name = g.names.Public(parameter.Name())
 	}
@@ -1102,15 +1103,15 @@ func (g *ClientsGenerator) accessorType(parameter *concepts.Parameter) *TypeRefe
 }
 
 func (g *ClientsGenerator) locatorName(locator *concepts.Locator) string {
-	name := goName(locator)
+	name := annotations.GoName(locator)
 	if name == "" {
 		name = g.names.Public(locator.Name())
 	}
 	return name
 }
 
 func (g *ClientsGenerator) methodName(method *concepts.Method) string {
-	name := goName(method)
+	name := annotations.GoName(method)
 	if name == "" {
 		name = g.names.Public(method.Name())
 	}
@@ -1120,7 +1121,7 @@ func (g *ClientsGenerator) methodName(method *concepts.Method) string {
 func (g *ClientsGenerator) clientName(resource *concepts.Resource) string {
 	var name string
 	if !resource.IsRoot() {
-		name = goName(resource)
+		name = annotations.GoName(resource)
 		if name == "" {
 			name = g.names.Public(resource.Name())
 		}
@@ -1133,16 +1134,16 @@ func (g *ClientsGenerator) requestName(method *concepts.Method) string {
 	resource := method.Owner()
 	var name string
 	if resource.IsRoot() {
-		name = goName(method)
+		name = annotations.GoName(method)
 		if name == "" {
 			name = g.names.Public(method.Name())
 		}
 	} else {
-		resourceName := goName(resource)
+		resourceName := annotations.GoName(resource)
 		if resourceName == "" {
 			resourceName = g.names.Public(resource.Name())
 		}
-		methodName := goName(method)
+		methodName := annotations.GoName(method)
 		if methodName == "" {
 			methodName = g.names.Public(method.Name())
 		}
@@ -1156,16 +1157,16 @@ func (g *ClientsGenerator) responseName(method *concepts.Method) string {
 	resource := method.Owner()
 	var name string
 	if resource.IsRoot() {
-		name = goName(method)
+		name = annotations.GoName(method)
 		if name == "" {
 			name = g.names.Public(method.Name())
 		}
 	} else {
-		resourceName := goName(resource)
+		resourceName := annotations.GoName(resource)
 		if resourceName == "" {
 			resourceName = g.names.Public(resource.Name())
 		}
-		methodName := goName(method)
+		methodName := annotations.GoName(method)
 		if methodName == "" {
 			methodName = g.names.Public(method.Name())
 		}
@@ -1176,7 +1177,7 @@ func (g *ClientsGenerator) responseName(method *concepts.Method) string {
 }
 
 func (g *ClientsGenerator) pollRequestName(resource *concepts.Resource) string {
-	name := goName(resource)
+	name := annotations.GoName(resource)
 	if name == "" {
 		name = g.names.Public(resource.Name())
 	}
@@ -1185,7 +1186,7 @@ func (g *ClientsGenerator) pollRequestName(resource *concepts.Resource) string {
 }
 
 func (g *ClientsGenerator) pollResponseName(resource *concepts.Resource) string {
-	name := goName(resource)
+	name := annotations.GoName(resource)
 	if name == "" {
 		name = g.names.Public(resource.Name())
 	}

diff --git a/pkg/generators/golang/json_generator.go b/pkg/generators/golang/json_generator.go
@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"strconv"
 
+	"github.com/openshift-online/ocm-api-metamodel/pkg/annotations"
 	"github.com/openshift-online/ocm-api-metamodel/pkg/concepts"
 	"github.com/openshift-online/ocm-api-metamodel/pkg/http"
 	"github.com/openshift-online/ocm-api-metamodel/pkg/names"
@@ -1446,7 +1447,7 @@ func (g *JSONSupportGenerator) resourceFile(resource *concepts.Resource) string
 }
 
 func (g *JSONSupportGenerator) marshalTypeFunc(typ *concepts.Type) string {
-	name := goName(typ)
+	name := annotations.GoName(typ)
 	if name == "" {
 		name = g.names.Public(typ.Name())
 	}
@@ -1460,7 +1461,7 @@ func (g *JSONSupportGenerator) writeTypeFunc(typ *concepts.Type) string {
 }
 
 func (g *JSONSupportGenerator) unmarshalTypeFunc(typ *concepts.Type) string {
-	name := goName(typ)
+	name := annotations.GoName(typ)
 	if name == "" {
 		name = g.names.Public(typ.Name())
 	}
@@ -1485,16 +1486,16 @@ func (g *JSONSupportGenerator) clientRequestName(method *concepts.Method) string
 	resource := method.Owner()
 	var name string
 	if resource.IsRoot() {
-		name = goName(method)
+		name = annotations.GoName(method)
 		if name == "" {
 			name = g.names.Public(method.Name())
 		}
 	} else {
-		resourceName := goName(resource)
+		resourceName := annotations.GoName(resource)
 		if resourceName == "" {
 			resourceName = g.names.Public(resource.Name())
 		}
-		methodName := goName(method)
+		methodName := annotations.GoName(method)
 		if methodName == "" {
 			methodName = g.names.Public(method.Name())
 		}
@@ -1508,16 +1509,16 @@ func (g *JSONSupportGenerator) clientResponseName(method *concepts.Method) strin
 	resource := method.Owner()
 	var name string
 	if resource.IsRoot() {
-		name = goName(method)
+		name = annotations.GoName(method)
 		if name == "" {
 			name = g.names.Public(method.Name())
 		}
 	} else {
-		resourceName := goName(resource)
+		resourceName := annotations.GoName(resource)
 		if resourceName == "" {
 			resourceName = g.names.Public(resource.Name())
 		}
-		methodName := goName(method)
+		methodName := annotations.GoName(method)
 		if methodName == "" {
 			methodName = g.names.Public(method.Name())
 		}