feat: added deprecation parsing (#410)

swaggo · Jun 12, 2019 · b534de4 · b534de4
1 parent f7df9bf
commit b534de4
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/operation.go b/operation.go
@@ -109,6 +109,8 @@ func (operation *Operation) ParseComment(comment string, astFile *ast.File) erro
 		if err := operation.ParseSecurityComment(lineRemainder); err != nil {
 			return err
 		}
+	case "@deprecated":
+		operation.Deprecate()
 	}
 	return nil
 }

diff --git a/operation_test.go b/operation_test.go
@@ -711,7 +711,8 @@ func TestParseMultiDescription(t *testing.T) {
 	assert.NoError(t, err)
 
 	comment = `@Tags multi`
-	operation.ParseComment(comment, nil)
+	err = operation.ParseComment(comment, nil)
+	assert.NoError(t, err)
 
 	comment = `@Description line two x`
 	err = operation.ParseComment(comment, nil)
@@ -722,3 +723,16 @@ func TestParseMultiDescription(t *testing.T) {
 	expected := `"description": "line one\nline two x"`
 	assert.Contains(t, string(b), expected)
 }
+
+func TestParseDeprecationDescription(t *testing.T) {
+	comment := `@Deprecated`
+	operation := NewOperation()
+	operation.parser = New()
+
+	err := operation.ParseComment(comment, nil)
+	assert.NoError(t, err)
+
+	if !operation.Deprecated {
+		t.Error("Failed to parse @deprecated comment")
+	}
+}