fix: update doc string for supplies

sudoblockio · Oct 15, 2024 · 42709a1 · 42709a1
1 parent dfb7442
commit 42709a1
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 13 deletions.
diff --git a/src/api/docs/docs.go b/src/api/docs/docs.go
@@ -652,7 +652,7 @@ const docTemplate = `{
                 "tags": [
                     "Supplies"
                 ],
-                "summary": "Get Supplies",
+                "summary": "Get Circulating Supply",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -679,7 +679,7 @@ const docTemplate = `{
                 "tags": [
                     "Supplies"
                 ],
-                "summary": "Get Supplies",
+                "summary": "Get Market Cap",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -706,7 +706,7 @@ const docTemplate = `{
                 "tags": [
                     "Supplies"
                 ],
-                "summary": "Get Supplies",
+                "summary": "Get Total Supply",
                 "responses": {
                     "200": {
                         "description": "OK",

diff --git a/src/api/docs/swagger.json b/src/api/docs/swagger.json
@@ -644,7 +644,7 @@
                 "tags": [
                     "Supplies"
                 ],
-                "summary": "Get Supplies",
+                "summary": "Get Circulating Supply",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -671,7 +671,7 @@
                 "tags": [
                     "Supplies"
                 ],
-                "summary": "Get Supplies",
+                "summary": "Get Market Cap",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -698,7 +698,7 @@
                 "tags": [
                     "Supplies"
                 ],
-                "summary": "Get Supplies",
+                "summary": "Get Total Supply",
                 "responses": {
                     "200": {
                         "description": "OK",

diff --git a/src/api/docs/swagger.yaml b/src/api/docs/swagger.yaml
@@ -767,7 +767,7 @@ paths:
           schema:
             additionalProperties: true
             type: object
-      summary: Get Supplies
+      summary: Get Circulating Supply
       tags:
       - Supplies
   /api/v1/supplies/market-cap:
@@ -785,7 +785,7 @@ paths:
           schema:
             additionalProperties: true
             type: object
-      summary: Get Supplies
+      summary: Get Market Cap
       tags:
       - Supplies
   /api/v1/supplies/total-supply:
@@ -803,7 +803,7 @@ paths:
           schema:
             additionalProperties: true
             type: object
-      summary: Get Supplies
+      summary: Get Total Supply
       tags:
       - Supplies
   /api/v1/transactions:

diff --git a/src/api/rest/supplies.go b/src/api/rest/supplies.go
@@ -2,9 +2,10 @@ package rest
 
 import (
 	"encoding/json"
+	"strconv"
+
 	"github.com/gofiber/fiber/v2"
 	"github.com/sudoblockio/icon-go-api/config"
-	"strconv"
 )
 
 func SuppliesAddHandlers(app *fiber.App) {
@@ -39,7 +40,7 @@ func handlerGetSupplies(c *fiber.Ctx) error {
 }
 
 // Circulating Supply
-// @Summary Get Supplies
+// @Summary Get Circulating Supply
 // @Description get circulating supply (total supply - burn wallet balance)
 // @Tags Supplies
 // @BasePath /api/v1
@@ -53,7 +54,7 @@ func handlerGetSuppliesCirculatingSupply(c *fiber.Ctx) error {
 }
 
 // Total Supply
-// @Summary Get Supplies
+// @Summary Get Total Supply
 // @Description get total supply
 // @Tags Supplies
 // @BasePath /api/v1
@@ -67,7 +68,7 @@ func handlerGetSuppliesTotalSupply(c *fiber.Ctx) error {
 }
 
 // Market Cap
-// @Summary Get Supplies
+// @Summary Get Market Cap
 // @Description get mkt cap (Coin Gecko Price * circulating supply)
 // @Tags Supplies
 // @BasePath /api/v1