Update documentation for 0.5.0

Signed-off-by: Sam Lucidi <[email protected]>
konveyor · Jul 12, 2024 · eff4eca · eff4eca
1 parent 36360b3
commit eff4eca
Show file tree

Hide file tree

Showing 8 changed files with 6,635 additions and 1,609 deletions.
diff --git a/Makefile b/Makefile
@@ -94,7 +94,7 @@ docs: docs-html docs-openapi3 docs-binding
 
 # Build Swagger API spec into ./docs directory
 docs-swagger:
-	$(GOBIN)/swag init -g pkg.go --dir api,assessment
+	$(GOBIN)/swag init --parseDependency --parseInternal --parseDepth 1 -g pkg.go --dir api,assessment
 
 # Build OpenAPI 3.0 docs
 docs-openapi3: docs-swagger

diff --git a/api/analysis.go b/api/analysis.go
@@ -216,7 +216,7 @@ func (h AnalysisHandler) AppLatest(ctx *gin.Context) {
 // @description Archive an analysis (report) by ID.
 // @tags analyses
 // @produce octet-stream
-// @success 204 {object}
+// @success 204
 // @router /analyses/{id}/archive [post]
 // @param id path int true "Analysis ID"
 func (h AnalysisHandler) Archive(ctx *gin.Context) {

diff --git a/api/file.go b/api/file.go
@@ -129,7 +129,7 @@ func (h FileHandler) Create(ctx *gin.Context) {
 // @produce json
 // @success 204
 // @router /files/{id} [put]
-// @param name id uint true "File ID"
+// @param id path uint true "File ID"
 func (h FileHandler) Append(ctx *gin.Context) {
 	var err error
 	input, err := ctx.FormFile(FileField)