Merge pull request #503 from snyk/feat/use-openapi-tags

tinygrasshopper · web-flow · commit f68ffa5d2be4 · 2025-04-25T13:16:07.000+01:00
feat: use openapi tags while generating docs
diff --git a/tools/api-docs-generator/generator/reference_docs.go b/tools/api-docs-generator/generator/reference_docs.go
@@ -230,9 +230,9 @@ func renderReferenceDocsPage(filePath, label, docsPath string, operation []opera
 		}
 		_, err = fmt.Fprintf(docsFile,
 			`
-{%% swagger src="%s" path="%s" method="%s" %%}
+{%% openapi src="%s" path="%s" method="%s" %%}
 [%s](%s)
-{%% endswagger %%}
+{%% endopenapi %%}
 `,
 			relativePathToSpec,
 			op.pathURL,

Original file line number	Diff line number	Diff line change
`@@ -230,9 +230,9 @@ func renderReferenceDocsPage(filePath, label, docsPath string, operation []opera`
`230`	`230`	`}`
`231`	`231`	`_, err = fmt.Fprintf(docsFile,`
`232`	`232`	`
`233`		`-{%% swagger src="%s" path="%s" method="%s" %%}`
	`233`	`+{%% openapi src="%s" path="%s" method="%s" %%}`
`234`	`234`	`[%s](%s)`
`235`		`-{%% endswagger %%}`
	`235`	`+{%% endopenapi %%}`
`236`	`236`	`,
`237`	`237`	`relativePathToSpec,`
`238`	`238`	`op.pathURL,`