Merge pull request #49 from sudoblockio/fix/doc-string-for-stats

fix: update doc string for stats
sudoblockio · Oct 15, 2024 · f966e72 · f966e72
2 parents 1c96e0d + 8d0d7fb
commit f966e72
Show file tree

Hide file tree

Showing 11 changed files with 113 additions and 75 deletions.
diff --git a/.github/workflows/push-main.yml b/.github/workflows/push-main.yml
@@ -71,16 +71,13 @@ jobs:
       max-parallel: 1
       matrix:
         include:
-          - cluster: prod-sng
+          - cluster: prod-ams
             network_name: mainnet
             network_version: v2
-          - cluster: prod-sng
-            network_name: sejong
-            network_version: v2
-          - cluster: prod-sng
+          - cluster: prod-ams
             network_name: lisbon
             network_version: v2
-          - cluster: prod-sng
+          - cluster: prod-ams
             network_name: berlin
             network_version: v2
 

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -74,16 +74,13 @@ jobs:
       max-parallel: 1
       matrix:
         include:
-          - cluster: prod-ams
+          - cluster: prod-sng
             network_name: mainnet
             network_version: v2
-          - cluster: prod-ams
-            network_name: sejong
-            network_version: v2
-          - cluster: prod-ams
+          - cluster: prod-sng
             network_name: lisbon
             network_version: v2
-          - cluster: prod-ams
+          - cluster: prod-sng
             network_name: berlin
             network_version: v2
 

diff --git a/Makefile b/Makefile
@@ -3,12 +3,12 @@
 test: up-dbs test-unit test-integration
 
 up-dbs:  ## Bring up the DBs
-	docker-compose -f docker-compose.db.yml up -d
+	docker compose -f docker-compose.db.yml up -d
 	echo "Waiting for backend to populate some records..."
 	sleep 10
 
 down-dbs:  ## Take down the DBs
-	docker-compose -f docker-compose.db.yml down
+	docker compose -f docker-compose.db.yml down
 
 test-unit:  ## Run unit tests - Need DB compose up
 	cd src && go test ./... -v --tags=unit
@@ -22,13 +22,13 @@ test-coverage: up-dbs ## Run unit tests - Need DB compose up
 	cd src && go test ./... -v -race -covermode=atomic -coverprofile=../coverage.out
 
 pull:
-	docker-compose -f docker-compose.db.yml -f docker-compose.yml pull
+	docker compose -f docker-compose.db.yml -f docker-compose.yml pull
 
 up:  ## Bring everything up as containers
-	docker-compose -f docker-compose.db.yml -f docker-compose.yml up -d
+	docker compose -f docker-compose.db.yml -f docker-compose.yml up -d
 
 down:  ## Take down all the containers
-	docker-compose -f docker-compose.db.yml -f docker-compose.yml down -v
+	docker compose -f docker-compose.db.yml -f docker-compose.yml down -v
 
 clean:
 	docker volume rm $(docker volume ls -q)
@@ -37,16 +37,16 @@ build-swagger:  ## Build the swagger docs
 	cd src/api && bash generateSwagDocs.sh
 
 build:  ## Build everything
-	docker-compose build
+	docker compose build
 
 ps:  ## List all containers and running status
-	docker-compose -f docker-compose.db.yml -f docker-compose.yml ps
+	docker compose -f docker-compose.db.yml -f docker-compose.yml ps
 
 postgres-console:  ## Start postgres terminal
-	docker-compose -f docker-compose.db.yml -f docker-compose.yml exec postgres psql -U postgres
+	docker compose -f docker-compose.db.yml -f docker-compose.yml exec postgres psql -U postgres
 
 redis-console:  ## Start redis terminal
-	docker-compose -f docker-compose.db.yml -f docker-compose.yml exec redis redis-cli
+	docker compose -f docker-compose.db.yml -f docker-compose.yml exec redis redis-cli
 
 help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-16s\033[0m %s\n", $$1, $$2}'
diff --git a/src/api/api.go b/src/api/api.go
@@ -77,8 +77,8 @@ func Start() *fiber.App {
 }
 
 // Version
-// @Summary Show the status of server.
-// @Description get the status of server.
+// @Summary Show the version of server.
+// @Description get the version of server.
 // @Tags Version
 // @Accept */*
 // @Produce json
@@ -95,8 +95,8 @@ func handlerVersion(c *fiber.Ctx) error {
 }
 
 // Metadata
-// @Summary Show the status of server.
-// @Description get the status of server.
+// @Summary Show the metadata of server.
+// @Description get the metadata of server.
 // @Tags Version
 // @Accept */*
 // @Produce json

diff --git a/src/api/docs/docs.go b/src/api/docs/docs.go
@@ -1,10 +1,9 @@
-// Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
-// This file was generated by swaggo/swag
+// Package docs Code generated by swaggo/swag. DO NOT EDIT
 package docs
 
 import "github.com/swaggo/swag"
 
-const docTemplate_swagger = `{
+const docTemplate = `{
     "schemes": {{ marshal .Schemes }},
     "swagger": "2.0",
     "info": {
@@ -544,7 +543,7 @@ const docTemplate_swagger = `{
                 "tags": [
                     "Stats"
                 ],
-                "summary": "Get Stats",
+                "summary": "Get Circulating Supply",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -571,7 +570,7 @@ const docTemplate_swagger = `{
                 "tags": [
                     "Stats"
                 ],
-                "summary": "Get Stats",
+                "summary": "Get Market Cap",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -598,7 +597,7 @@ const docTemplate_swagger = `{
                 "tags": [
                     "Stats"
                 ],
-                "summary": "Get Stats",
+                "summary": "Get Total Supply",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -653,7 +652,7 @@ const docTemplate_swagger = `{
                 "tags": [
                     "Supplies"
                 ],
-                "summary": "Get Supplies",
+                "summary": "Get Circulating Supply",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -680,7 +679,7 @@ const docTemplate_swagger = `{
                 "tags": [
                     "Supplies"
                 ],
-                "summary": "Get Supplies",
+                "summary": "Get Market Cap",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -707,7 +706,7 @@ const docTemplate_swagger = `{
                 "tags": [
                     "Supplies"
                 ],
-                "summary": "Get Supplies",
+                "summary": "Get Total Supply",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -1428,7 +1427,7 @@ const docTemplate_swagger = `{
         },
         "/metadata": {
             "get": {
-                "description": "get the status of server.",
+                "description": "get the metadata of server.",
                 "consumes": [
                     "*/*"
                 ],
@@ -1438,7 +1437,7 @@ const docTemplate_swagger = `{
                 "tags": [
                     "Version"
                 ],
-                "summary": "Show the status of server.",
+                "summary": "Show the metadata of server.",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -1452,7 +1451,7 @@ const docTemplate_swagger = `{
         },
         "/version": {
             "get": {
-                "description": "get the status of server.",
+                "description": "get the version of server.",
                 "consumes": [
                     "*/*"
                 ],
@@ -1462,7 +1461,7 @@ const docTemplate_swagger = `{
                 "tags": [
                     "Version"
                 ],
-                "summary": "Show the status of server.",
+                "summary": "Show the version of server.",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -1970,18 +1969,20 @@ const docTemplate_swagger = `{
     }
 }`
 
-// SwaggerInfo_swagger holds exported Swagger Info so clients can modify it
-var SwaggerInfo_swagger = &swag.Spec{
+// SwaggerInfo holds exported Swagger Info so clients can modify it
+var SwaggerInfo = &swag.Spec{
 	Version:          "2.0",
 	Host:             "",
 	BasePath:         "",
 	Schemes:          []string{},
 	Title:            "Icon Go API",
 	Description:      "The icon tracker API",
 	InfoInstanceName: "swagger",
-	SwaggerTemplate:  docTemplate_swagger,
+	SwaggerTemplate:  docTemplate,
+	LeftDelim:        "{{",
+	RightDelim:       "}}",
 }
 
 func init() {
-	swag.Register(SwaggerInfo_swagger.InstanceName(), SwaggerInfo_swagger)
+	swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
 }
diff --git a/src/api/docs/swagger.json b/src/api/docs/swagger.json
@@ -535,7 +535,7 @@
                 "tags": [
                     "Stats"
                 ],
-                "summary": "Get Stats",
+                "summary": "Get Circulating Supply",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -562,7 +562,7 @@
                 "tags": [
                     "Stats"
                 ],
-                "summary": "Get Stats",
+                "summary": "Get Market Cap",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -589,7 +589,7 @@
                 "tags": [
                     "Stats"
                 ],
-                "summary": "Get Stats",
+                "summary": "Get Total Supply",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -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",
@@ -1419,7 +1419,7 @@
         },
         "/metadata": {
             "get": {
-                "description": "get the status of server.",
+                "description": "get the metadata of server.",
                 "consumes": [
                     "*/*"
                 ],
@@ -1429,7 +1429,7 @@
                 "tags": [
                     "Version"
                 ],
-                "summary": "Show the status of server.",
+                "summary": "Show the metadata of server.",
                 "responses": {
                     "200": {
                         "description": "OK",
@@ -1443,7 +1443,7 @@
         },
         "/version": {
             "get": {
-                "description": "get the status of server.",
+                "description": "get the version of server.",
                 "consumes": [
                     "*/*"
                 ],
@@ -1453,7 +1453,7 @@
                 "tags": [
                     "Version"
                 ],
-                "summary": "Show the status of server.",
+                "summary": "Show the version of server.",
                 "responses": {
                     "200": {
                         "description": "OK",