Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Update documentation for 0.5.0 #721

Merged
merged 1 commit into from
Jul 16, 2024
+6,635 −1,609
Merged

📖 Update documentation for 0.5.0 #721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion api/analysis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
2 changes: 1 addition & 1 deletion api/file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading
Loading