docs: fix API docs

blacktop · Jul 3, 2024 · 5a9da7d · 5a9da7d
1 parent 9f56962
commit 5a9da7d
Show file tree

Hide file tree

Showing 5 changed files with 2,467 additions and 811 deletions.
diff --git a/api/api.go b/api/api.go
@@ -1,7 +1,7 @@
 // Package api contains common constants for daemon and client.
 package api
 
-//go:generate go run github.com/go-swagger/go-swagger/cmd/swagger generate spec -o swagger.json --scan-models
+//go:generate go run github.com/go-swagger/go-swagger/cmd/swagger generate spec -o swagger.json
 
 // Common constants for daemon and client.
 const (

diff --git a/api/server/routes/syms/syms.go b/api/server/routes/syms/syms.go
@@ -54,9 +54,9 @@ func AddRoutes(rg *gin.RouterGroup, db db.Database) {
 		}
 		c.JSON(http.StatusOK, successResponse{Success: true})
 	})
-	// swagger:route GET /syms/{uuid} Syms getSymbols
+	// swagger:route GET /syms/{uuid}/{addr} Syms getSymbol
 	//
-	// Symbols
+	// Symbol
 	//
 	// Get symbols for a given uuid.
 	//
@@ -69,13 +69,19 @@ func AddRoutes(rg *gin.RouterGroup, db db.Database) {
 	//         description: file UUID
 	//         required: true
 	//         type: string
+	//       + name: addr
+	//         in: path
+	//         description: symbol address
+	//         required: true
+	//         type: integer
 	//
 	//     Responses:
-	//       200: symsResponse
+	//       200: symResponse
 	//       500: genericError
-	rg.GET("/syms/:uuid", func(c *gin.Context) {
+	rg.GET("/syms/:uuid/:addr", func(c *gin.Context) {
 		uuid := c.Param("uuid")
-		syms, err := syms.Get(uuid, db)
+		addr := c.Param("addr")
+		sym, err := syms.GetForAddr(uuid, cast.ToUint64(addr), db)
 		if err != nil {
 			if errors.Is(err, model.ErrNotFound) {
 				c.AbortWithStatusJSON(http.StatusNotFound, types.GenericError{Error: err.Error()})
@@ -84,11 +90,11 @@ func AddRoutes(rg *gin.RouterGroup, db db.Database) {
 			c.AbortWithStatusJSON(http.StatusInternalServerError, types.GenericError{Error: err.Error()})
 			return
 		}
-		c.JSON(http.StatusOK, symsResponse(syms))
+		c.JSON(http.StatusOK, symResponse(sym))
 	})
-	// swagger:route GET /syms/{uuid}/{addr} Syms getSymbol
+	// swagger:route GET /syms/{uuid} Syms getSymbols
 	//
-	// Symbol
+	// Symbols
 	//
 	// Get symbols for a given uuid.
 	//
@@ -101,19 +107,13 @@ func AddRoutes(rg *gin.RouterGroup, db db.Database) {
 	//         description: file UUID
 	//         required: true
 	//         type: string
-	//       + name: addr
-	//         in: path
-	//         description: symbol address
-	//         required: true
-	//         type: integer
 	//
 	//     Responses:
-	//       200: symResponse
+	//       200: symsResponse
 	//       500: genericError
-	rg.GET("/syms/:uuid/:addr", func(c *gin.Context) {
+	rg.GET("/syms/:uuid", func(c *gin.Context) {
 		uuid := c.Param("uuid")
-		addr := c.Param("addr")
-		sym, err := syms.GetForAddr(uuid, cast.ToUint64(addr), db)
+		syms, err := syms.Get(uuid, db)
 		if err != nil {
 			if errors.Is(err, model.ErrNotFound) {
 				c.AbortWithStatusJSON(http.StatusNotFound, types.GenericError{Error: err.Error()})
@@ -122,6 +122,6 @@ func AddRoutes(rg *gin.RouterGroup, db db.Database) {
 			c.AbortWithStatusJSON(http.StatusInternalServerError, types.GenericError{Error: err.Error()})
 			return
 		}
-		c.JSON(http.StatusOK, symResponse(sym))
+		c.JSON(http.StatusOK, symsResponse(syms))
 	})
 }