Skip to content

Commit fb8ad72

Browse files
shreyasbhat0shreyasbhat0
authored
Merge pull request #51 from sudoblockio/fix/doc-string-openapi
fix: transactions and address doc string
2 parents c37f048 + bbae026 commit fb8ad72

File tree

5 files changed

+37
-35
lines changed

5 files changed

+37
-35
lines changed

‎src/api/docs/docs.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ const docTemplate = `{
110110
"tags": [
111111
"Addresses"
112112
],
113-
"summary": "Get contracts",
113+
"summary": "Get Contracts",
114114
"parameters": [
115115
{
116116
"type": "string",
@@ -1024,7 +1024,7 @@ const docTemplate = `{
10241024
"tags": [
10251025
"Transactions"
10261026
],
1027-
"summary": "Get internal transactions by address",
1027+
"summary": "Get Internal Transactions By Address",
10281028
"parameters": [
10291029
{
10301030
"type": "integer",
@@ -1078,7 +1078,7 @@ const docTemplate = `{
10781078
"tags": [
10791079
"Transactions"
10801080
],
1081-
"summary": "Get internal transactions by block number",
1081+
"summary": "Get Internal Transactions By Block Number",
10821082
"parameters": [
10831083
{
10841084
"type": "integer",
@@ -1132,7 +1132,7 @@ const docTemplate = `{
11321132
"tags": [
11331133
"Transactions"
11341134
],
1135-
"summary": "Get internal transactions by hash",
1135+
"summary": "Get Internal Transactions By Hash",
11361136
"parameters": [
11371137
{
11381138
"type": "integer",
@@ -1186,7 +1186,7 @@ const docTemplate = `{
11861186
"tags": [
11871187
"Transactions"
11881188
],
1189-
"summary": "Get token holders by token contract",
1189+
"summary": "Get Token Holders By Token Contract",
11901190
"parameters": [
11911191
{
11921192
"type": "integer",
@@ -1240,7 +1240,7 @@ const docTemplate = `{
12401240
"tags": [
12411241
"Transactions"
12421242
],
1243-
"summary": "Get token transfers",
1243+
"summary": "Get Token Transfers",
12441244
"parameters": [
12451245
{
12461246
"type": "integer",
@@ -1329,7 +1329,7 @@ const docTemplate = `{
13291329
"tags": [
13301330
"Transactions"
13311331
],
1332-
"summary": "Get token transfer by address",
1332+
"summary": "Get Token Transfer By Address",
13331333
"parameters": [
13341334
{
13351335
"type": "integer",
@@ -1383,7 +1383,7 @@ const docTemplate = `{
13831383
"tags": [
13841384
"Transactions"
13851385
],
1386-
"summary": "Get token transfers by token contract",
1386+
"summary": "Get Token Transfers By Token Contract",
13871387
"parameters": [
13881388
{
13891389
"type": "integer",

‎src/api/docs/swagger.json

+8-8
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
"tags": [
103103
"Addresses"
104104
],
105-
"summary": "Get contracts",
105+
"summary": "Get Contracts",
106106
"parameters": [
107107
{
108108
"type": "string",
@@ -1016,7 +1016,7 @@
10161016
"tags": [
10171017
"Transactions"
10181018
],
1019-
"summary": "Get internal transactions by address",
1019+
"summary": "Get Internal Transactions By Address",
10201020
"parameters": [
10211021
{
10221022
"type": "integer",
@@ -1070,7 +1070,7 @@
10701070
"tags": [
10711071
"Transactions"
10721072
],
1073-
"summary": "Get internal transactions by block number",
1073+
"summary": "Get Internal Transactions By Block Number",
10741074
"parameters": [
10751075
{
10761076
"type": "integer",
@@ -1124,7 +1124,7 @@
11241124
"tags": [
11251125
"Transactions"
11261126
],
1127-
"summary": "Get internal transactions by hash",
1127+
"summary": "Get Internal Transactions By Hash",
11281128
"parameters": [
11291129
{
11301130
"type": "integer",
@@ -1178,7 +1178,7 @@
11781178
"tags": [
11791179
"Transactions"
11801180
],
1181-
"summary": "Get token holders by token contract",
1181+
"summary": "Get Token Holders By Token Contract",
11821182
"parameters": [
11831183
{
11841184
"type": "integer",
@@ -1232,7 +1232,7 @@
12321232
"tags": [
12331233
"Transactions"
12341234
],
1235-
"summary": "Get token transfers",
1235+
"summary": "Get Token Transfers",
12361236
"parameters": [
12371237
{
12381238
"type": "integer",
@@ -1321,7 +1321,7 @@
13211321
"tags": [
13221322
"Transactions"
13231323
],
1324-
"summary": "Get token transfer by address",
1324+
"summary": "Get Token Transfer By Address",
13251325
"parameters": [
13261326
{
13271327
"type": "integer",
@@ -1375,7 +1375,7 @@
13751375
"tags": [
13761376
"Transactions"
13771377
],
1378-
"summary": "Get token transfers by token contract",
1378+
"summary": "Get Token Transfers By Token Contract",
13791379
"parameters": [
13801380
{
13811381
"type": "integer",

‎src/api/docs/swagger.yaml

+8-8
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ paths:
440440
schema:
441441
additionalProperties: true
442442
type: object
443-
summary: Get contracts
443+
summary: Get Contracts
444444
tags:
445445
- Addresses
446446
/api/v1/addresses/details/{address}:
@@ -1031,7 +1031,7 @@ paths:
10311031
schema:
10321032
additionalProperties: true
10331033
type: object
1034-
summary: Get internal transactions by hash
1034+
summary: Get Internal Transactions By Hash
10351035
tags:
10361036
- Transactions
10371037
/api/v1/transactions/internal/address/{address}:
@@ -1067,7 +1067,7 @@ paths:
10671067
schema:
10681068
additionalProperties: true
10691069
type: object
1070-
summary: Get internal transactions by address
1070+
summary: Get Internal Transactions By Address
10711071
tags:
10721072
- Transactions
10731073
/api/v1/transactions/internal/block-number/{block_number}:
@@ -1103,7 +1103,7 @@ paths:
11031103
schema:
11041104
additionalProperties: true
11051105
type: object
1106-
summary: Get internal transactions by block number
1106+
summary: Get Internal Transactions By Block Number
11071107
tags:
11081108
- Transactions
11091109
/api/v1/transactions/token-holders/token-contract/{token_contract_address}:
@@ -1139,7 +1139,7 @@ paths:
11391139
schema:
11401140
additionalProperties: true
11411141
type: object
1142-
summary: Get token holders by token contract
1142+
summary: Get Token Holders By Token Contract
11431143
tags:
11441144
- Transactions
11451145
/api/v1/transactions/token-transfers:
@@ -1198,7 +1198,7 @@ paths:
11981198
schema:
11991199
additionalProperties: true
12001200
type: object
1201-
summary: Get token transfers
1201+
summary: Get Token Transfers
12021202
tags:
12031203
- Transactions
12041204
/api/v1/transactions/token-transfers/address/{address}:
@@ -1234,7 +1234,7 @@ paths:
12341234
schema:
12351235
additionalProperties: true
12361236
type: object
1237-
summary: Get token transfer by address
1237+
summary: Get Token Transfer By Address
12381238
tags:
12391239
- Transactions
12401240
/api/v1/transactions/token-transfers/token-contract/{token_contract_address}:
@@ -1270,7 +1270,7 @@ paths:
12701270
schema:
12711271
additionalProperties: true
12721272
type: object
1273-
summary: Get token transfers by token contract
1273+
summary: Get Token Transfers By Token Contract
12741274
tags:
12751275
- Transactions
12761276
/metadata:

‎src/api/rest/addresses.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ package rest
33
import (
44
"encoding/json"
55
"errors"
6-
"gorm.io/gorm"
76
"strconv"
87

8+
"gorm.io/gorm"
9+
910
fiber "github.com/gofiber/fiber/v2"
1011
"go.uber.org/zap"
1112

@@ -197,7 +198,7 @@ type ContractsQuery struct {
197198
}
198199

199200
// Contract
200-
// @Summary Get contracts
201+
// @Summary Get Contracts
201202
// @Description get list of contracts
202203
// @Tags Addresses
203204
// @BasePath /api/v1

‎src/api/rest/transactions.go

+10-9
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ import (
44
"encoding/json"
55
"errors"
66
"fmt"
7+
"strconv"
8+
"sync"
9+
710
fiber "github.com/gofiber/fiber/v2"
811
"github.com/sudoblockio/icon-go-api/models"
912
"go.uber.org/zap"
1013
"gorm.io/gorm"
11-
"strconv"
12-
"sync"
1314

1415
"github.com/sudoblockio/icon-go-api/config"
1516
"github.com/sudoblockio/icon-go-api/crud"
@@ -479,7 +480,7 @@ func handlerGetTransactionAddress(c *fiber.Ctx) error {
479480
}
480481

481482
// Internal transactions by hash
482-
// @Summary Get internal transactions by hash
483+
// @Summary Get Internal Transactions By Hash
483484
// @Description Get internal transactions by hash
484485
// @Tags Transactions
485486
// @BasePath /api/v1
@@ -551,7 +552,7 @@ func handlerGetInternalTransactionsByHash(c *fiber.Ctx) error {
551552
}
552553

553554
// Internal transactions by address
554-
// @Summary Get internal transactions by address
555+
// @Summary Get Internal Transactions By Address
555556
// @Description Get internal transactions by address
556557
// @Tags Transactions
557558
// @BasePath /api/v1
@@ -625,7 +626,7 @@ func handlerGetInternalTransactionsAddress(c *fiber.Ctx) error {
625626
}
626627

627628
// Internal transactions by block number
628-
// @Summary Get internal transactions by block number
629+
// @Summary Get Internal Transactions By Block Number
629630
// @Description Get internal transactions by block number
630631
// @Tags Transactions
631632
// @BasePath /api/v1
@@ -704,7 +705,7 @@ func handlerGetInternalTransactionsBlockNumber(c *fiber.Ctx) error {
704705
}
705706

706707
// TokenTransfers
707-
// @Summary Get token transfers
708+
// @Summary Get Token Transfers
708709
// @Description get historical token transfers
709710
// @Tags Transactions
710711
// @BasePath /api/v1
@@ -794,7 +795,7 @@ func handlerGetTokenTransfers(c *fiber.Ctx) error {
794795
}
795796

796797
// TokenTransfersAddress
797-
// @Summary Get token transfer by address
798+
// @Summary Get Token Transfer By Address
798799
// @Description get historical token transfers by address
799800
// @Tags Transactions
800801
// @BasePath /api/v1
@@ -869,7 +870,7 @@ func handlerGetTokenTransfersAddress(c *fiber.Ctx) error {
869870
}
870871

871872
// TokenTransfersTokenContract
872-
// @Summary Get token transfers by token contract
873+
// @Summary Get Token Transfers By Token Contract
873874
// @Description get historical token transfers by token contract
874875
// @Tags Transactions
875876
// @BasePath /api/v1
@@ -944,7 +945,7 @@ func handlerGetTokenTransfersTokenContract(c *fiber.Ctx) error {
944945
}
945946

946947
// TokenAddressesTokenContract
947-
// @Summary Get token holders by token contract
948+
// @Summary Get Token Holders By Token Contract
948949
// @Description get token holders
949950
// @Tags Transactions
950951
// @BasePath /api/v1

0 commit comments

Comments
 (0)