wip

Author: bahkauv70

templates/go/model_simple.mustache

@@ -2,10 +2,30 @@
 var _ MappedNullable = &{{classname}}{}
 
 {{#vars}}
-// {{baseName}} 
+
 /*
-{{{.}}}
+	types and functions for {{baseName}} 
+	{{!.}}
 */
+
+{{! The basic approach is as follows: To avoid checking the various datatypes, }}
+{{! exceptions and non-orthogonal model states we introduce go type-alias }}
+{{! These are compatible with their basic types (this maintains backwards)}}
+{{! compatibility with existing code). This allows to concentrate the  decision what }}
+{{! actual type the openapi represents in a single place. Reusing the generated}}
+{{! type in all other places avoids repetion of the non-trivial decision matrix}}
+{{! which type is to be used.}}
+{{! We define three basic types:}}
+{{! - FooAttributeType: The type used for the model-struct definitions, i.e. the struct attribute type}}
+{{! - FooArgType: The type used for parameter passing, i.e. in function calls}}
+{{! - FooRetType: The type used for function returns.}}
+{{! To simplify reading and writing values even further, type-safe}}
+{{! helper methods for getting and setting valuesare generated as well}}
+{{! (these are not rendered as methods, as the structs themselves may be nil)}}
+{{! (a pure function avoids possible nil-pointer exceptions)}}
+
+
+{{! address primitives types, excluding enums (they are handled explicitly below) }}
 {{^isEnum}}
 {{#isNumber}}
 // isNumber
@@ -71,6 +91,7 @@ func set{{classname}}{{getter}}AttributeType(arg *{{classname}}{{getter}}Attribu
 }
 {{/isDouble}}
 {{#isShort}}
+{{! isShort and isInteger may be true at the same time, so select one}}
 {{^isInteger}}
 // isShort
 type {{classname}}{{getter}}AttributeType = *int64
@@ -136,8 +157,11 @@ func set{{classname}}{{getter}}AttributeType(arg *{{classname}}{{getter}}Attribu
 }
 {{/isLong}}
 {{#isString}}
+{{! string-types are definitely used non-orthogonally, so we have to exclude some possibilities}}
 {{^isArray}}
+{{! skip arrays, they are addressed explicitly below}}
 {{#isNullable}}
+{{! nullable strings have a special type}}
 // isNullableString
 type {{classname}}{{getter}}AttributeType = *NullableString
 func get{{classname}}{{getter}}AttributeTypeOk(arg {{classname}}{{getter}}AttributeType) (ret {{classname}}{{getter}}RetType, ok bool) {
@@ -161,6 +185,7 @@ func set{{classname}}{{getter}}AttributeType(arg *{{classname}}{{getter}}Attribu
 }
 {{/isNullable}}
 {{^isNullable}}
+{{! non nullable strings are plain string pointers}}
 // isNotNullableString
 type {{classname}}{{getter}}AttributeType = *string
 func get{{classname}}{{getter}}AttributeTypeOk(arg {{classname}}{{getter}}AttributeType) (ret {{classname}}{{getter}}RetType, ok bool) {
@@ -207,6 +232,7 @@ func set{{classname}}{{getter}}AttributeType(arg *{{classname}}{{getter}}Attribu
 {{/isEnum}}
 
 {{#isDateTime}}
+{{! special handling for date-time}}
 // isDateTime
 type {{classname}}{{getter}}AttributeType = *time.Time
 type {{classname}}{{getter}}ArgType = {{#isNullable}}*{{/isNullable}}time.Time
@@ -228,6 +254,7 @@ func set{{classname}}{{getter}}AttributeType(arg *{{classname}}{{getter}}Attribu
 }
 {{/isDateTime}}
 {{#isDate}}
+{{! special handling for date}}
 // isDate
 type {{classname}}{{getter}}AttributeType = *time.Time
 type {{classname}}{{getter}}ArgType = {{#isNullable}}*{{/isNullable}}time.Time
@@ -249,6 +276,7 @@ func set{{classname}}{{getter}}AttributeType(arg *{{classname}}{{getter}}Attribu
 }
 {{/isDate}}
 {{#isEnumRef}}
+{{! special handling for enums}}
 // isEnumRef
 type {{classname}}{{getter}}AttributeType = *{{^isNumeric}}{{dataType}}{{/isNumeric}}{{#isNumeric}}int64{{/isNumeric}}
 type {{classname}}{{getter}}ArgType = {{#isNullable}}*{{/isNullable}}{{^isNumeric}}{{dataType}}{{/isNumeric}}{{#isNumeric}}int64{{/isNumeric}}
@@ -270,6 +298,7 @@ func set{{classname}}{{getter}}AttributeType(arg *{{classname}}{{getter}}Attribu
 }
 {{/isEnumRef}}
 {{#isModel}}
+{{! special handling for recursive datatypes}}
 // isModel
 type {{classname}}{{getter}}AttributeType = *{{dataType}}
 type {{classname}}{{getter}}ArgType = {{#isNullable}}*{{/isNullable}}{{dataType}}
@@ -297,6 +326,7 @@ func set{{classname}}{{getter}}AttributeType(arg *{{classname}}{{getter}}Attribu
 {{^isDateTime}}
 {{^isEnumRef}}
 // fallback
+{{! everything else will end up here}}
 type {{classname}}{{getter}}AttributeType = *{{dataType}}
 type {{classname}}{{getter}}ArgType = {{#isNullable}}*{{/isNullable}}{{dataType}}
 type {{classname}}{{getter}}RetType = {{#isNullable}}*{{/isNullable}}{{dataType}}