fix: Doc generate - Escape pipe symbols in output enums in md

mihaigalos · mihaigalos · commit 9b433b9056e4 · 2025-07-08T18:42:00.000+02:00
This then guarantees the generated markdown cells align properly.

Signed-off-by: Mihai Galos &lt;mihai@galos.one&gt;
diff --git a/pkg/tools/gen/gendoc.go b/pkg/tools/gen/gendoc.go
@@ -293,8 +293,9 @@ func (g *GenContext) renderPackage(spec *SwaggerV2Spec, parentDir string) error
 		if err != nil {
 			return fmt.Errorf("failed to render package %s with template, err: %s", pkg.Name, err)
 		}
+		escape_pipes := bytes.ReplaceAll(buf.Bytes(), []byte(" | "), []byte(" \\| "))
 		// write content to file
-		err = os.WriteFile(filepath.Join(parentDir, docFileName), buf.Bytes(), 0644)
+		err = os.WriteFile(filepath.Join(parentDir, docFileName), escape_pipes, 0644)
 		if err != nil {
 			return fmt.Errorf("failed to write file %s in %s: %v", docFileName, parentDir, err)
 		}

Original file line number	Diff line number	Diff line change
`@@ -293,8 +293,9 @@ func (g GenContext) renderPackage(spec SwaggerV2Spec, parentDir string) error`
`293`	`293`	`if err != nil {`
`294`	`294`	`return fmt.Errorf("failed to render package %s with template, err: %s", pkg.Name, err)`
`295`	`295`	`}`
	`296`	`+ escape_pipes := bytes.ReplaceAll(buf.Bytes(), []byte(" \| "), []byte(" \\\| "))`
`296`	`297`	`// write content to file`
`297`		`- err = os.WriteFile(filepath.Join(parentDir, docFileName), buf.Bytes(), 0644)`
	`298`	`+ err = os.WriteFile(filepath.Join(parentDir, docFileName), escape_pipes, 0644)`
`298`	`299`	`if err != nil {`
`299`	`300`	`return fmt.Errorf("failed to write file %s in %s: %v", docFileName, parentDir, err)`
`300`	`301`	`}`