@ignore and @deprecated field detection implemented. @deprecated is unused presently.

Author: jackman0

intermediate_map.go

@@ -15,6 +15,7 @@ type MapIntermediate struct {
 	ValueType     *MemberIntermediate
 	Description   string
 	Validations   Validator
+	Deprecated    bool
 }
 
 func (this *MapIntermediate) IsRequired() bool {

intermediate_member.go

@@ -18,6 +18,7 @@ type MemberIntermediate struct {
 	JsonOmitEmpty bool   // If the omitempty flag was given in the JSON.
 	Description   string
 	Validations   Validator
+	Deprecated    bool
 }
 
 func (this *MemberIntermediate) IsRequired() bool {

intermediate_slice.go

@@ -14,6 +14,7 @@ type SliceIntermediate struct {
 	ValueType     *MemberIntermediate
 	Description   string
 	Validations   Validator
+	Deprecated    bool
 }
 
 func (this *SliceIntermediate) IsRequired() bool {

walker_definitions.go

@@ -119,6 +119,18 @@ func (this *DefinitionVisitor) Visit(node ast.Node) (w ast.Visitor) {
 		}
 	case *ast.Field:
 
+		controlsDoc := parseOpenApiControls(t.Doc.Text())
+		controlsComment := parseOpenApiControls(t.Comment.Text())
+
+		controls := OpenApiControls{
+			Ignore:     controlsDoc.Ignore || controlsComment.Ignore,
+			Deprecated: controlsDoc.Deprecated || controlsComment.Deprecated,
+		}
+
+		if controls.Ignore {
+			return nil
+		}
+
 		if this.Definition == nil {
 			// Ignore fields that don't belong to our definition.
 			return nil
@@ -197,6 +209,7 @@ func (this *DefinitionVisitor) Visit(node ast.Node) (w ast.Visitor) {
 				KeyType:       keyType,
 				Description:   desc,
 				Validations:   validations,
+				Deprecated:    controls.Deprecated,
 			}
 
 		} else if isSlice, v := IsSlice(goType); isSlice {
@@ -214,6 +227,7 @@ func (this *DefinitionVisitor) Visit(node ast.Node) (w ast.Visitor) {
 				ValueType:     valueType,
 				Description:   desc,
 				Validations:   validations,
+				Deprecated:    controls.Deprecated,
 			}
 		} else {
 			member = &MemberIntermediate{
@@ -223,6 +237,7 @@ func (this *DefinitionVisitor) Visit(node ast.Node) (w ast.Visitor) {
 				JsonOmitEmpty: jsonOmitEmpty,
 				Description:   desc,
 				Validations:   validations,
+				Deprecated:    controls.Deprecated,
 			}
 		}
 
@@ -419,3 +434,26 @@ func parseValidateTag(s string) map[string]string {
 	return validations
 
 }
+
+type OpenApiControls struct {
+	Ignore     bool
+	Deprecated bool
+}
+
+func parseOpenApiControls(s string) OpenApiControls {
+
+	var controls OpenApiControls
+
+	rxIgnore := regexp.MustCompile(`@(?i:ignore)`)
+	rxDeprecated := regexp.MustCompile(`@(?i:deprecated)`)
+
+	if rxIgnore.MatchString(s) {
+		controls.Ignore = true
+	}
+
+	if rxDeprecated.MatchString(s) {
+		controls.Deprecated = true
+	}
+
+	return controls
+}