Skip to content

Commit f966e72

Browse files
shreyasbhat0shreyasbhat0
authored
Merge pull request #49 from sudoblockio/fix/doc-string-for-stats
fix: update doc string for stats
2 parents 1c96e0d + 8d0d7fb commit f966e72

File tree

11 files changed

+113
-75
lines changed

11 files changed

+113
-75
lines changed

‎.github/workflows/push-main.yml

+3-6
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,13 @@ jobs:
7171
max-parallel: 1
7272
matrix:
7373
include:
74-
- cluster: prod-sng
74+
- cluster: prod-ams
7575
network_name: mainnet
7676
network_version: v2
77-
- cluster: prod-sng
78-
network_name: sejong
79-
network_version: v2
80-
- cluster: prod-sng
77+
- cluster: prod-ams
8178
network_name: lisbon
8279
network_version: v2
83-
- cluster: prod-sng
80+
- cluster: prod-ams
8481
network_name: berlin
8582
network_version: v2
8683

‎.github/workflows/release.yml

+3-6
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,13 @@ jobs:
7474
max-parallel: 1
7575
matrix:
7676
include:
77-
- cluster: prod-ams
77+
- cluster: prod-sng
7878
network_name: mainnet
7979
network_version: v2
80-
- cluster: prod-ams
81-
network_name: sejong
82-
network_version: v2
83-
- cluster: prod-ams
80+
- cluster: prod-sng
8481
network_name: lisbon
8582
network_version: v2
86-
- cluster: prod-ams
83+
- cluster: prod-sng
8784
network_name: berlin
8885
network_version: v2
8986

‎Makefile

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
test: up-dbs test-unit test-integration
44

55
up-dbs: ## Bring up the DBs
6-
docker-compose -f docker-compose.db.yml up -d
6+
docker compose -f docker-compose.db.yml up -d
77
echo "Waiting for backend to populate some records..."
88
sleep 10
99

1010
down-dbs: ## Take down the DBs
11-
docker-compose -f docker-compose.db.yml down
11+
docker compose -f docker-compose.db.yml down
1212

1313
test-unit: ## Run unit tests - Need DB compose up
1414
cd src && go test ./... -v --tags=unit
@@ -22,13 +22,13 @@ test-coverage: up-dbs ## Run unit tests - Need DB compose up
2222
cd src && go test ./... -v -race -covermode=atomic -coverprofile=../coverage.out
2323

2424
pull:
25-
docker-compose -f docker-compose.db.yml -f docker-compose.yml pull
25+
docker compose -f docker-compose.db.yml -f docker-compose.yml pull
2626

2727
up: ## Bring everything up as containers
28-
docker-compose -f docker-compose.db.yml -f docker-compose.yml up -d
28+
docker compose -f docker-compose.db.yml -f docker-compose.yml up -d
2929

3030
down: ## Take down all the containers
31-
docker-compose -f docker-compose.db.yml -f docker-compose.yml down -v
31+
docker compose -f docker-compose.db.yml -f docker-compose.yml down -v
3232

3333
clean:
3434
docker volume rm $(docker volume ls -q)
@@ -37,16 +37,16 @@ build-swagger: ## Build the swagger docs
3737
cd src/api && bash generateSwagDocs.sh
3838

3939
build: ## Build everything
40-
docker-compose build
40+
docker compose build
4141

4242
ps: ## List all containers and running status
43-
docker-compose -f docker-compose.db.yml -f docker-compose.yml ps
43+
docker compose -f docker-compose.db.yml -f docker-compose.yml ps
4444

4545
postgres-console: ## Start postgres terminal
46-
docker-compose -f docker-compose.db.yml -f docker-compose.yml exec postgres psql -U postgres
46+
docker compose -f docker-compose.db.yml -f docker-compose.yml exec postgres psql -U postgres
4747

4848
redis-console: ## Start redis terminal
49-
docker-compose -f docker-compose.db.yml -f docker-compose.yml exec redis redis-cli
49+
docker compose -f docker-compose.db.yml -f docker-compose.yml exec redis redis-cli
5050

5151
help:
5252
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-16s\033[0m %s\n", $$1, $$2}'

‎src/api/api.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ func Start() *fiber.App {
7777
}
7878

7979
// Version
80-
// @Summary Show the status of server.
81-
// @Description get the status of server.
80+
// @Summary Show the version of server.
81+
// @Description get the version of server.
8282
// @Tags Version
8383
// @Accept */*
8484
// @Produce json
@@ -95,8 +95,8 @@ func handlerVersion(c *fiber.Ctx) error {
9595
}
9696

9797
// Metadata
98-
// @Summary Show the status of server.
99-
// @Description get the status of server.
98+
// @Summary Show the metadata of server.
99+
// @Description get the metadata of server.
100100
// @Tags Version
101101
// @Accept */*
102102
// @Produce json

‎src/api/docs/docs.go

+18-17
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
// Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
2-
// This file was generated by swaggo/swag
1+
// Package docs Code generated by swaggo/swag. DO NOT EDIT
32
package docs
43

54
import "github.com/swaggo/swag"
65

7-
const docTemplate_swagger = `{
6+
const docTemplate = `{
87
"schemes": {{ marshal .Schemes }},
98
"swagger": "2.0",
109
"info": {
@@ -544,7 +543,7 @@ const docTemplate_swagger = `{
544543
"tags": [
545544
"Stats"
546545
],
547-
"summary": "Get Stats",
546+
"summary": "Get Circulating Supply",
548547
"responses": {
549548
"200": {
550549
"description": "OK",
@@ -571,7 +570,7 @@ const docTemplate_swagger = `{
571570
"tags": [
572571
"Stats"
573572
],
574-
"summary": "Get Stats",
573+
"summary": "Get Market Cap",
575574
"responses": {
576575
"200": {
577576
"description": "OK",
@@ -598,7 +597,7 @@ const docTemplate_swagger = `{
598597
"tags": [
599598
"Stats"
600599
],
601-
"summary": "Get Stats",
600+
"summary": "Get Total Supply",
602601
"responses": {
603602
"200": {
604603
"description": "OK",
@@ -653,7 +652,7 @@ const docTemplate_swagger = `{
653652
"tags": [
654653
"Supplies"
655654
],
656-
"summary": "Get Supplies",
655+
"summary": "Get Circulating Supply",
657656
"responses": {
658657
"200": {
659658
"description": "OK",
@@ -680,7 +679,7 @@ const docTemplate_swagger = `{
680679
"tags": [
681680
"Supplies"
682681
],
683-
"summary": "Get Supplies",
682+
"summary": "Get Market Cap",
684683
"responses": {
685684
"200": {
686685
"description": "OK",
@@ -707,7 +706,7 @@ const docTemplate_swagger = `{
707706
"tags": [
708707
"Supplies"
709708
],
710-
"summary": "Get Supplies",
709+
"summary": "Get Total Supply",
711710
"responses": {
712711
"200": {
713712
"description": "OK",
@@ -1428,7 +1427,7 @@ const docTemplate_swagger = `{
14281427
},
14291428
"/metadata": {
14301429
"get": {
1431-
"description": "get the status of server.",
1430+
"description": "get the metadata of server.",
14321431
"consumes": [
14331432
"*/*"
14341433
],
@@ -1438,7 +1437,7 @@ const docTemplate_swagger = `{
14381437
"tags": [
14391438
"Version"
14401439
],
1441-
"summary": "Show the status of server.",
1440+
"summary": "Show the metadata of server.",
14421441
"responses": {
14431442
"200": {
14441443
"description": "OK",
@@ -1452,7 +1451,7 @@ const docTemplate_swagger = `{
14521451
},
14531452
"/version": {
14541453
"get": {
1455-
"description": "get the status of server.",
1454+
"description": "get the version of server.",
14561455
"consumes": [
14571456
"*/*"
14581457
],
@@ -1462,7 +1461,7 @@ const docTemplate_swagger = `{
14621461
"tags": [
14631462
"Version"
14641463
],
1465-
"summary": "Show the status of server.",
1464+
"summary": "Show the version of server.",
14661465
"responses": {
14671466
"200": {
14681467
"description": "OK",
@@ -1970,18 +1969,20 @@ const docTemplate_swagger = `{
19701969
}
19711970
}`
19721971

1973-
// SwaggerInfo_swagger holds exported Swagger Info so clients can modify it
1974-
var SwaggerInfo_swagger = &swag.Spec{
1972+
// SwaggerInfo holds exported Swagger Info so clients can modify it
1973+
var SwaggerInfo = &swag.Spec{
19751974
Version: "2.0",
19761975
Host: "",
19771976
BasePath: "",
19781977
Schemes: []string{},
19791978
Title: "Icon Go API",
19801979
Description: "The icon tracker API",
19811980
InfoInstanceName: "swagger",
1982-
SwaggerTemplate: docTemplate_swagger,
1981+
SwaggerTemplate: docTemplate,
1982+
LeftDelim: "{{",
1983+
RightDelim: "}}",
19831984
}
19841985

19851986
func init() {
1986-
swag.Register(SwaggerInfo_swagger.InstanceName(), SwaggerInfo_swagger)
1987+
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
19871988
}

‎src/api/docs/swagger.json

+10-10
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@
535535
"tags": [
536536
"Stats"
537537
],
538-
"summary": "Get Stats",
538+
"summary": "Get Circulating Supply",
539539
"responses": {
540540
"200": {
541541
"description": "OK",
@@ -562,7 +562,7 @@
562562
"tags": [
563563
"Stats"
564564
],
565-
"summary": "Get Stats",
565+
"summary": "Get Market Cap",
566566
"responses": {
567567
"200": {
568568
"description": "OK",
@@ -589,7 +589,7 @@
589589
"tags": [
590590
"Stats"
591591
],
592-
"summary": "Get Stats",
592+
"summary": "Get Total Supply",
593593
"responses": {
594594
"200": {
595595
"description": "OK",
@@ -644,7 +644,7 @@
644644
"tags": [
645645
"Supplies"
646646
],
647-
"summary": "Get Supplies",
647+
"summary": "Get Circulating Supply",
648648
"responses": {
649649
"200": {
650650
"description": "OK",
@@ -671,7 +671,7 @@
671671
"tags": [
672672
"Supplies"
673673
],
674-
"summary": "Get Supplies",
674+
"summary": "Get Market Cap",
675675
"responses": {
676676
"200": {
677677
"description": "OK",
@@ -698,7 +698,7 @@
698698
"tags": [
699699
"Supplies"
700700
],
701-
"summary": "Get Supplies",
701+
"summary": "Get Total Supply",
702702
"responses": {
703703
"200": {
704704
"description": "OK",
@@ -1419,7 +1419,7 @@
14191419
},
14201420
"/metadata": {
14211421
"get": {
1422-
"description": "get the status of server.",
1422+
"description": "get the metadata of server.",
14231423
"consumes": [
14241424
"*/*"
14251425
],
@@ -1429,7 +1429,7 @@
14291429
"tags": [
14301430
"Version"
14311431
],
1432-
"summary": "Show the status of server.",
1432+
"summary": "Show the metadata of server.",
14331433
"responses": {
14341434
"200": {
14351435
"description": "OK",
@@ -1443,7 +1443,7 @@
14431443
},
14441444
"/version": {
14451445
"get": {
1446-
"description": "get the status of server.",
1446+
"description": "get the version of server.",
14471447
"consumes": [
14481448
"*/*"
14491449
],
@@ -1453,7 +1453,7 @@
14531453
"tags": [
14541454
"Version"
14551455
],
1456-
"summary": "Show the status of server.",
1456+
"summary": "Show the version of server.",
14571457
"responses": {
14581458
"200": {
14591459
"description": "OK",

0 commit comments

Comments
 (0)