docs: minor API doc fix

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

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/api/server/routes/syms/syms.go b/api/server/routes/syms/syms.go
@@ -58,7 +58,7 @@ func AddRoutes(rg *gin.RouterGroup, db db.Database) {
 	//
 	// Symbol
 	//
-	// Get symbols for a given uuid.
+	// Get symbol for a given uuid and address.
 	//
 	//     Produces:
 	//     - application/json

diff --git a/api/swagger.json b/api/swagger.json
@@ -1425,7 +1425,7 @@
     },
     "/syms/{uuid}/{addr}": {
       "get": {
-        "description": "Get symbols for a given uuid.",
+        "description": "Get symbol for a given uuid and address.",
         "produces": [
           "application/json"
         ],

diff --git a/internal/db/db.go b/internal/db/db.go
@@ -18,12 +18,14 @@ type Database interface {
 	// It returns ErrNotFound if the key does not exist.
 	Get(key string) (*model.Ipsw, error)
 
-	// Get returns the value for the given key.
-	// It returns ErrNotFound if the key does not exist.
+	// GetByName returns the value for the given name.
+	// It returns ErrNotFound if the name does not exist.
 	GetByName(name string) (*model.Ipsw, error)
 
+	// GetSymbol returns the symbol for the given UUID and address.
 	GetSymbol(uuid string, addr uint64) (*model.Symbol, error)
 
+	// GetSymbols returns all symbols for the given UUID.
 	GetSymbols(uuid string) ([]*model.Symbol, error)
 
 	// Save updates the IPSW.

diff --git a/www/static/api/swagger.json b/www/static/api/swagger.json
@@ -1425,7 +1425,7 @@
     },
     "/syms/{uuid}/{addr}": {
       "get": {
-        "description": "Get symbols for a given uuid.",
+        "description": "Get symbol for a given uuid and address.",
         "produces": [
           "application/json"
         ],