Add Swagger generator && Add Logger in Go

flemzord · flemzord · commit 2e4dca340b09 · 2021-11-25T10:50:43.000+01:00
Signed-off-by: Maxence Maireaux &lt;maxence@maireaux.fr&gt;
diff --git a/api/controllers/account_controller.go b/api/controllers/account_controller.go
@@ -75,7 +75,7 @@ func (ctl *AccountController) GetAccount(c *gin.Context) {
 }
 
 // PostAccountMetadata godoc
-// @Summary List Accounts
+// @Summary Add metadata to account
 // @Schemes
 // @Param ledger path string true "ledger"
 // @Param accountId path string true "accountId"
diff --git a/api/controllers/ledger_controller.go b/api/controllers/ledger_controller.go
@@ -18,7 +18,7 @@ func NewLedgerController() LedgerController {
 }
 
 // GetStats godoc
-// @Summary Get Stats
+// @Summary Get ledger stats (aggregate metrics on accounts and transactions)
 // @Schemes
 // @Description The stats for account
 // @Accept json
diff --git a/api/controllers/script_controller.go b/api/controllers/script_controller.go
@@ -23,7 +23,7 @@ func NewScriptController() ScriptController {
 }
 
 // PostScript godoc
-// @Summary List Accounts
+// @Summary Execute a Numscript and commit transaction if any
 // @Schemes
 // @Param ledger path string true "ledger"
 // @Accept json

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ func (ctl AccountController) GetAccount(c gin.Context) {`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`// PostAccountMetadata godoc`
`78`		`-// @Summary List Accounts`
	`78`	`+// @Summary Add metadata to account`
`79`	`79`	`// @Schemes`
`80`	`80`	`// @Param ledger path string true "ledger"`
`81`	`81`	`// @Param accountId path string true "accountId"`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ func NewLedgerController() LedgerController {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`// GetStats godoc`
`21`		`-// @Summary Get Stats`
	`21`	`+// @Summary Get ledger stats (aggregate metrics on accounts and transactions)`
`22`	`22`	`// @Schemes`
`23`	`23`	`// @Description The stats for account`
`24`	`24`	`// @Accept json`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ func NewScriptController() ScriptController {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`// PostScript godoc`
`26`		`-// @Summary List Accounts`
	`26`	`+// @Summary Execute a Numscript and commit transaction if any`
`27`	`27`	`// @Schemes`
`28`	`28`	`// @Param ledger path string true "ledger"`
`29`	`29`	`// @Accept json`