From 0956974353aa78195984d85c4d92a456a5e76a6e Mon Sep 17 00:00:00 2001 From: Ares <75481906+ice-ares@users.noreply.github.com> Date: Tue, 9 May 2023 17:14:34 +0300 Subject: [PATCH] updated swagger docs --- cmd/freezer-refrigerant/api/docs.go | 20 ++++++++++-------- cmd/freezer-refrigerant/api/swagger.json | 18 ++++++++-------- cmd/freezer-refrigerant/api/swagger.yaml | 18 ++++++++-------- cmd/freezer/api/docs.go | 26 ++++++++++-------------- cmd/freezer/api/swagger.json | 24 ++++++++-------------- cmd/freezer/api/swagger.yaml | 22 ++++++++------------ tokenomics/adoption.go | 2 +- tokenomics/balance.go | 2 +- tokenomics/balance_recalculation_test.go | 3 ++- tokenomics/extra_bonus.go | 2 +- tokenomics/mining.go | 2 +- tokenomics/mining_sessions.go | 2 +- tokenomics/users.go | 12 ++++++----- 13 files changed, 72 insertions(+), 81 deletions(-) diff --git a/cmd/freezer-refrigerant/api/docs.go b/cmd/freezer-refrigerant/api/docs.go index 8081438..a4224e1 100644 --- a/cmd/freezer-refrigerant/api/docs.go +++ b/cmd/freezer-refrigerant/api/docs.go @@ -370,7 +370,7 @@ const docTemplate = `{ } } }, - "tokenomics.MiningRateSummary-coin_ICE": { + "tokenomics.MiningRateSummary-string": { "type": "object", "properties": { "amount": { @@ -395,26 +395,26 @@ const docTemplate = `{ "NoneMiningRateType" ] }, - "tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE": { + "tokenomics.MiningRates-tokenomics_MiningRateSummary-string": { "type": "object", "properties": { "base": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "positiveTotalNoPreStakingBonus": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "preStaking": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "standard": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "total": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "totalNoPreStakingBonus": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "type": { "$ref": "#/definitions/tokenomics.MiningRateType" @@ -454,7 +454,7 @@ const docTemplate = `{ "example": 2 }, "miningRates": { - "$ref": "#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-string" }, "miningSession": { "$ref": "#/definitions/tokenomics.MiningSession" @@ -499,6 +499,8 @@ var SwaggerInfo = &swag.Spec{ Description: "API that handles everything related to write-only operations for user's tokenomics.", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, + LeftDelim: "{{", + RightDelim: "}}", } func init() { diff --git a/cmd/freezer-refrigerant/api/swagger.json b/cmd/freezer-refrigerant/api/swagger.json index 5e34755..c1669a0 100644 --- a/cmd/freezer-refrigerant/api/swagger.json +++ b/cmd/freezer-refrigerant/api/swagger.json @@ -365,7 +365,7 @@ } } }, - "tokenomics.MiningRateSummary-coin_ICE": { + "tokenomics.MiningRateSummary-string": { "type": "object", "properties": { "amount": { @@ -390,26 +390,26 @@ "NoneMiningRateType" ] }, - "tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE": { + "tokenomics.MiningRates-tokenomics_MiningRateSummary-string": { "type": "object", "properties": { "base": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "positiveTotalNoPreStakingBonus": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "preStaking": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "standard": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "total": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "totalNoPreStakingBonus": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "type": { "$ref": "#/definitions/tokenomics.MiningRateType" @@ -449,7 +449,7 @@ "example": 2 }, "miningRates": { - "$ref": "#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-string" }, "miningSession": { "$ref": "#/definitions/tokenomics.MiningSession" diff --git a/cmd/freezer-refrigerant/api/swagger.yaml b/cmd/freezer-refrigerant/api/swagger.yaml index 09be244..cf13adb 100644 --- a/cmd/freezer-refrigerant/api/swagger.yaml +++ b/cmd/freezer-refrigerant/api/swagger.yaml @@ -58,7 +58,7 @@ definitions: example: 300 type: integer type: object - tokenomics.MiningRateSummary-coin_ICE: + tokenomics.MiningRateSummary-string: properties: amount: example: 1,234,232.001 @@ -76,20 +76,20 @@ definitions: - PositiveMiningRateType - NegativeMiningRateType - NoneMiningRateType - tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE: + tokenomics.MiningRates-tokenomics_MiningRateSummary-string: properties: base: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' positiveTotalNoPreStakingBonus: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' preStaking: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' standard: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' total: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' totalNoPreStakingBonus: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' type: $ref: '#/definitions/tokenomics.MiningRateType' type: object @@ -117,7 +117,7 @@ definitions: example: 2 type: integer miningRates: - $ref: '#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-string' miningSession: $ref: '#/definitions/tokenomics.MiningSession' miningStreak: diff --git a/cmd/freezer/api/docs.go b/cmd/freezer/api/docs.go index b45134c..5089305 100644 --- a/cmd/freezer/api/docs.go +++ b/cmd/freezer/api/docs.go @@ -557,12 +557,6 @@ const docTemplate = `{ "$ref": "#/definitions/server.ErrorResponse" } }, - "404": { - "description": "if not found", - "schema": { - "$ref": "#/definitions/server.ErrorResponse" - } - }, "422": { "description": "if syntax fails", "schema": { @@ -750,7 +744,7 @@ const docTemplate = `{ } } }, - "tokenomics.MiningRateSummary-coin_ICE": { + "tokenomics.MiningRateSummary-string": { "type": "object", "properties": { "amount": { @@ -775,26 +769,26 @@ const docTemplate = `{ "NoneMiningRateType" ] }, - "tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE": { + "tokenomics.MiningRates-tokenomics_MiningRateSummary-string": { "type": "object", "properties": { "base": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "positiveTotalNoPreStakingBonus": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "preStaking": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "standard": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "total": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "totalNoPreStakingBonus": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "type": { "$ref": "#/definitions/tokenomics.MiningRateType" @@ -834,7 +828,7 @@ const docTemplate = `{ "example": 2 }, "miningRates": { - "$ref": "#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-string" }, "miningSession": { "$ref": "#/definitions/tokenomics.MiningSession" @@ -888,6 +882,8 @@ var SwaggerInfo = &swag.Spec{ Description: "API that handles everything related to read-only operations for user's tokenomics and statistics about it.", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, + LeftDelim: "{{", + RightDelim: "}}", } func init() { diff --git a/cmd/freezer/api/swagger.json b/cmd/freezer/api/swagger.json index 662fc82..d9b90b4 100644 --- a/cmd/freezer/api/swagger.json +++ b/cmd/freezer/api/swagger.json @@ -552,12 +552,6 @@ "$ref": "#/definitions/server.ErrorResponse" } }, - "404": { - "description": "if not found", - "schema": { - "$ref": "#/definitions/server.ErrorResponse" - } - }, "422": { "description": "if syntax fails", "schema": { @@ -745,7 +739,7 @@ } } }, - "tokenomics.MiningRateSummary-coin_ICE": { + "tokenomics.MiningRateSummary-string": { "type": "object", "properties": { "amount": { @@ -770,26 +764,26 @@ "NoneMiningRateType" ] }, - "tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE": { + "tokenomics.MiningRates-tokenomics_MiningRateSummary-string": { "type": "object", "properties": { "base": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "positiveTotalNoPreStakingBonus": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "preStaking": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "standard": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "total": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "totalNoPreStakingBonus": { - "$ref": "#/definitions/tokenomics.MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRateSummary-string" }, "type": { "$ref": "#/definitions/tokenomics.MiningRateType" @@ -829,7 +823,7 @@ "example": 2 }, "miningRates": { - "$ref": "#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE" + "$ref": "#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-string" }, "miningSession": { "$ref": "#/definitions/tokenomics.MiningSession" diff --git a/cmd/freezer/api/swagger.yaml b/cmd/freezer/api/swagger.yaml index ae2a769..01bdeae 100644 --- a/cmd/freezer/api/swagger.yaml +++ b/cmd/freezer/api/swagger.yaml @@ -118,7 +118,7 @@ definitions: example: 300 type: integer type: object - tokenomics.MiningRateSummary-coin_ICE: + tokenomics.MiningRateSummary-string: properties: amount: example: 1,234,232.001 @@ -136,20 +136,20 @@ definitions: - PositiveMiningRateType - NegativeMiningRateType - NoneMiningRateType - tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE: + tokenomics.MiningRates-tokenomics_MiningRateSummary-string: properties: base: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' positiveTotalNoPreStakingBonus: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' preStaking: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' standard: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' total: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' totalNoPreStakingBonus: - $ref: '#/definitions/tokenomics.MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRateSummary-string' type: $ref: '#/definitions/tokenomics.MiningRateType' type: object @@ -177,7 +177,7 @@ definitions: example: 2 type: integer miningRates: - $ref: '#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-coin_ICE' + $ref: '#/definitions/tokenomics.MiningRates-tokenomics_MiningRateSummary-string' miningSession: $ref: '#/definitions/tokenomics.MiningSession' miningStreak: @@ -577,10 +577,6 @@ paths: description: if hidden by the user schema: $ref: '#/definitions/server.ErrorResponse' - "404": - description: if not found - schema: - $ref: '#/definitions/server.ErrorResponse' "422": description: if syntax fails schema: diff --git a/tokenomics/adoption.go b/tokenomics/adoption.go index de0722b..8bf1ab1 100644 --- a/tokenomics/adoption.go +++ b/tokenomics/adoption.go @@ -5,7 +5,6 @@ package tokenomics import ( "context" "fmt" - "github.com/redis/go-redis/v9" "sort" "strconv" "strings" @@ -15,6 +14,7 @@ import ( "github.com/goccy/go-json" "github.com/hashicorp/go-multierror" "github.com/pkg/errors" + "github.com/redis/go-redis/v9" messagebroker "github.com/ice-blockchain/wintr/connectors/message_broker" "github.com/ice-blockchain/wintr/connectors/storage/v3" diff --git a/tokenomics/balance.go b/tokenomics/balance.go index 6b50829..faaece2 100644 --- a/tokenomics/balance.go +++ b/tokenomics/balance.go @@ -5,12 +5,12 @@ package tokenomics import ( "context" "fmt" - "github.com/hashicorp/go-multierror" "sort" "strings" stdlibtime "time" "github.com/goccy/go-json" + "github.com/hashicorp/go-multierror" "github.com/pkg/errors" messagebroker "github.com/ice-blockchain/wintr/connectors/message_broker" diff --git a/tokenomics/balance_recalculation_test.go b/tokenomics/balance_recalculation_test.go index c47286d..2eae3cb 100644 --- a/tokenomics/balance_recalculation_test.go +++ b/tokenomics/balance_recalculation_test.go @@ -6,11 +6,12 @@ package tokenomics import ( "fmt" - "github.com/ice-blockchain/wintr/time" "testing" stdlibtime "time" "github.com/stretchr/testify/assert" + + "github.com/ice-blockchain/wintr/time" ) func TestRepository_CalculateMiningRateSummaries(t *testing.T) { //nolint:funlen,maintidx // . diff --git a/tokenomics/extra_bonus.go b/tokenomics/extra_bonus.go index ae21f6f..8f2d448 100644 --- a/tokenomics/extra_bonus.go +++ b/tokenomics/extra_bonus.go @@ -5,11 +5,11 @@ package tokenomics import ( "context" "fmt" - "github.com/hashicorp/go-multierror" "strings" stdlibtime "time" "github.com/goccy/go-json" + "github.com/hashicorp/go-multierror" "github.com/pkg/errors" messagebroker "github.com/ice-blockchain/wintr/connectors/message_broker" diff --git a/tokenomics/mining.go b/tokenomics/mining.go index 3cad3b0..d622edc 100644 --- a/tokenomics/mining.go +++ b/tokenomics/mining.go @@ -5,13 +5,13 @@ package tokenomics import ( "context" "fmt" - "github.com/redis/go-redis/v9" "regexp" "sort" "strings" stdlibtime "time" "github.com/pkg/errors" + "github.com/redis/go-redis/v9" "github.com/ice-blockchain/wintr/connectors/storage/v3" "github.com/ice-blockchain/wintr/time" diff --git a/tokenomics/mining_sessions.go b/tokenomics/mining_sessions.go index a924fa4..e9dd45a 100644 --- a/tokenomics/mining_sessions.go +++ b/tokenomics/mining_sessions.go @@ -5,12 +5,12 @@ package tokenomics import ( "context" "fmt" - "github.com/redis/go-redis/v9" stdlibtime "time" "github.com/goccy/go-json" "github.com/hashicorp/go-multierror" "github.com/pkg/errors" + "github.com/redis/go-redis/v9" messagebroker "github.com/ice-blockchain/wintr/connectors/message_broker" "github.com/ice-blockchain/wintr/connectors/storage/v3" diff --git a/tokenomics/users.go b/tokenomics/users.go index 11768f3..d18faab 100644 --- a/tokenomics/users.go +++ b/tokenomics/users.go @@ -5,18 +5,20 @@ package tokenomics import ( "context" "fmt" + "strconv" + "strings" + stdlibtime "time" + "github.com/goccy/go-json" "github.com/hashicorp/go-multierror" + "github.com/pkg/errors" + "github.com/redis/go-redis/v9" + "github.com/ice-blockchain/eskimo/users" messagebroker "github.com/ice-blockchain/wintr/connectors/message_broker" "github.com/ice-blockchain/wintr/connectors/storage/v3" "github.com/ice-blockchain/wintr/log" "github.com/ice-blockchain/wintr/time" - "github.com/pkg/errors" - "github.com/redis/go-redis/v9" - "strconv" - "strings" - stdlibtime "time" ) func (s *usersTableSource) Process(ctx context.Context, msg *messagebroker.Message) error { //nolint:gocognit // .