feat(SPV-1478): migrate existing admin v2 endpoints to openapi3

actions/v2/admin/server.go

@@ -0,0 +1,19 @@
+package admin
+
+import (
+	"github.com/bitcoin-sv/spv-wallet/actions/v2/admin/users"
+	"github.com/bitcoin-sv/spv-wallet/engine"
+	"github.com/rs/zerolog"
+)
+
+// APIAdmin represents server with API endpoints
+type APIAdmin struct {
+	users.APIAdminUsers
+}
+
+// NewAPIAdmin creates a new APIAdmin
+func NewAPIAdmin(spvWalletEngine engine.ClientInterface, logger *zerolog.Logger) *APIAdmin {
+	return &APIAdmin{
+		*users.NewAPIAdminUsers(spvWalletEngine, logger),
+	}
+}

actions/v2/admin/status.go

@@ -6,10 +6,7 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-// Server represents server with API endpoints
-type Server struct{}
-
 // GetApiV2AdminStatus return the status of the server only after admin authentication
-func (s *Server) GetApiV2AdminStatus(c *gin.Context) {
+func (s *APIAdmin) GetApiV2AdminStatus(c *gin.Context) {
 	c.Status(http.StatusOK)
 }

actions/v2/admin/users/create.go

@@ -10,21 +10,19 @@ import (
 	"github.com/bitcoin-sv/spv-wallet/engine/spverrors"
 	"github.com/bitcoin-sv/spv-wallet/engine/v2/users/usersmodels"
 	"github.com/bitcoin-sv/spv-wallet/models/request/adminrequest"
-	"github.com/bitcoin-sv/spv-wallet/server/reqctx"
 	"github.com/gin-gonic/gin"
 )
 
-func create(c *gin.Context, _ *reqctx.AdminContext) {
-	logger := reqctx.Logger(c)
-
+// PostApiV2AdminUsers creates a new user
+func (s *APIAdminUsers) PostApiV2AdminUsers(c *gin.Context) {
 	var requestBody adminrequest.CreateUser
 	if err := c.Bind(&requestBody); err != nil {
-		spverrors.ErrorResponse(c, spverrors.ErrCannotBindRequest.Wrap(err), logger)
+		spverrors.ErrorResponse(c, spverrors.ErrCannotBindRequest.Wrap(err), s.logger)
 		return
 	}
 
 	if err := validatePubKey(requestBody.PublicKey); err != nil {
-		spverrors.ErrorResponse(c, err, logger)
+		spverrors.ErrorResponse(c, err, s.logger)
 		return
 	}
 
@@ -34,7 +32,7 @@ func create(c *gin.Context, _ *reqctx.AdminContext) {
 	if requestBody.PaymailDefined() {
 		alias, domain, err := parsePaymail(requestBody.Paymail)
 		if err != nil {
-			spverrors.ErrorResponse(c, err, logger)
+			spverrors.ErrorResponse(c, err, s.logger)
 			return
 		}
 
@@ -47,9 +45,9 @@ func create(c *gin.Context, _ *reqctx.AdminContext) {
 		}
 	}
 
-	createdUser, err := reqctx.Engine(c).UsersService().Create(c, newUser)
+	createdUser, err := s.engine.UsersService().Create(c, newUser)
 	if err != nil {
-		spverrors.MapResponse(c, err, logger).
+		spverrors.MapResponse(c, err, s.logger).
 			If(configerrors.ErrUnsupportedDomain).Then(adminerrors.ErrInvalidDomain).
 			Else(adminerrors.ErrCreatingUser)
 		return

actions/v2/admin/users/get.go

@@ -5,16 +5,14 @@ import (
 
 	"github.com/bitcoin-sv/spv-wallet/actions/v2/admin/internal/mapping"
 	"github.com/bitcoin-sv/spv-wallet/engine/spverrors"
-	"github.com/bitcoin-sv/spv-wallet/server/reqctx"
 	"github.com/gin-gonic/gin"
 )
 
-func get(c *gin.Context, _ *reqctx.AdminContext) {
-	userID := c.Param("id")
-
-	user, err := reqctx.Engine(c).UsersService().GetByID(c, userID)
+// GetApiV2AdminUsersId returns a user by ID
+func (s *APIAdminUsers) GetApiV2AdminUsersId(c *gin.Context, id string) {
+	user, err := s.engine.UsersService().GetByID(c, id)
 	if err != nil {
-		spverrors.ErrorResponse(c, err, reqctx.Logger(c))
+		spverrors.ErrorResponse(c, err, s.logger)
 		return
 	}
 

actions/v2/admin/users/paymail_add.go

@@ -10,24 +10,20 @@ import (
 	"github.com/bitcoin-sv/spv-wallet/engine/spverrors"
 	"github.com/bitcoin-sv/spv-wallet/engine/v2/paymails/paymailsmodels"
 	"github.com/bitcoin-sv/spv-wallet/models/request/adminrequest"
-	"github.com/bitcoin-sv/spv-wallet/server/reqctx"
 	"github.com/gin-gonic/gin"
 )
 
-func addPaymail(c *gin.Context, _ *reqctx.AdminContext) {
-	logger := reqctx.Logger(c)
-
+// PostApiV2AdminUsersIdPaymails add paymails to the user
+func (s *APIAdminUsers) PostApiV2AdminUsersIdPaymails(c *gin.Context, id string) {
 	var requestBody adminrequest.AddPaymail
 	if err := c.Bind(&requestBody); err != nil {
-		spverrors.ErrorResponse(c, spverrors.ErrCannotBindRequest.Wrap(err), logger)
+		spverrors.ErrorResponse(c, spverrors.ErrCannotBindRequest.Wrap(err), s.logger)
 		return
 	}
 
-	userID := c.Param("id")
-
 	alias, domain, err := parsePaymail(&requestBody)
 	if err != nil {
-		spverrors.ErrorResponse(c, err, logger)
+		spverrors.ErrorResponse(c, err, s.logger)
 		return
 	}
 
@@ -36,11 +32,11 @@ func addPaymail(c *gin.Context, _ *reqctx.AdminContext) {
 		Domain:     domain,
 		PublicName: requestBody.PublicName,
 		Avatar:     requestBody.Avatar,
-		UserID:     userID,
+		UserID:     id,
 	}
-	createdPaymail, err := reqctx.Engine(c).PaymailsService().Create(c, newPaymail)
+	createdPaymail, err := s.engine.PaymailsService().Create(c, newPaymail)
 	if err != nil {
-		spverrors.MapResponse(c, err, logger).
+		spverrors.MapResponse(c, err, s.logger).
 			If(configerrors.ErrUnsupportedDomain).Then(adminerrors.ErrInvalidDomain).
 			Else(adminerrors.ErrAddingPaymail)
 		return

actions/v2/admin/users/server.go

@@ -0,0 +1,20 @@
+package users
+
+import (
+	"github.com/bitcoin-sv/spv-wallet/engine"
+	"github.com/rs/zerolog"
+)
+
+// APIAdminUsers represents server with admin API endpoints
+type APIAdminUsers struct {
+	engine engine.ClientInterface
+	logger *zerolog.Logger
+}
+
+// NewAPIAdminUsers creates a new APIAdminUsers
+func NewAPIAdminUsers(engine engine.ClientInterface, logger *zerolog.Logger) *APIAdminUsers {
+	return &APIAdminUsers{
+		engine: engine,
+		logger: logger,
+	}
+}

actions/v2/register.go

@@ -1,8 +1,6 @@
 package v2
 
 import (
-	"github.com/bitcoin-sv/spv-wallet/actions/v2/admin"
-	"github.com/bitcoin-sv/spv-wallet/actions/v2/base"
 	"github.com/bitcoin-sv/spv-wallet/actions/v2/data"
 	"github.com/bitcoin-sv/spv-wallet/actions/v2/operations"
 	"github.com/bitcoin-sv/spv-wallet/actions/v2/transactions"
@@ -16,8 +14,4 @@ func Register(handlersManager *handlers.Manager) {
 	operations.RegisterRoutes(handlersManager)
 	transactions.RegisterRoutes(handlersManager)
 	data.RegisterRoutes(handlersManager)
-
-	admin.Register(handlersManager)
-
-	base.RegisterRoutes(handlersManager)
 }

actions/v2/server.go

@@ -3,17 +3,22 @@ package v2
 import (
 	"github.com/bitcoin-sv/spv-wallet/actions/v2/admin"
 	"github.com/bitcoin-sv/spv-wallet/api"
+	"github.com/bitcoin-sv/spv-wallet/config"
+	"github.com/bitcoin-sv/spv-wallet/engine"
+	"github.com/rs/zerolog"
 )
 
 // Server is the implementation of the server oapi-codegen's interface
 type Server struct {
-	admin.Server
+	admin.APIAdmin
 }
 
 // check if the Server implements the interface api.ServerInterface
 var _ api.ServerInterface = &Server{}
 
 // NewServer creates a new server
-func NewServer() *Server {
-	return &Server{}
+func NewServer(config *config.AppConfig, engine engine.ClientInterface, logger *zerolog.Logger) *Server {
+	return &Server{
+		APIAdmin: *admin.NewAPIAdmin(engine, logger),
+	}
 }

api/components/errors.yaml

@@ -4,14 +4,6 @@ info:
   version: ignored
 
 components:
-  responses:
-    NotAuthorized:
-      description: Security requirements failed
-      content:
-        application/json:
-          schema:
-            $ref: "#/components/schemas/ErrUnauthorized"
-
   schemas:
     ErrorSchema:
       type: object
@@ -73,3 +65,73 @@ components:
               example: "error-user-auth-on-non-user-endpoint"
             message:
               example: "cannot call non-user endpoints with user authorization"
+
+    ErrCannotBindRequest:
+      allOf:
+        - $ref: '#/components/schemas/ErrorSchema'
+        - type: object
+          properties:
+            code:
+              example: "error-bind-body-invalid"
+            message:
+              example: "cannot bind request body"
+
+    ErrInvalidPubKey:
+      allOf:
+        - $ref: '#/components/schemas/ErrorSchema'
+        - type: object
+          properties:
+            code:
+              example: "error-user-invalid-pubkey"
+            message:
+              example: "invalid public key"
+
+    ErrInvalidPaymail:
+      allOf:
+        - $ref: '#/components/schemas/ErrorSchema'
+        - type: object
+          properties:
+            code:
+              example: "error-user-invalid-paymail"
+            message:
+              example: "invalid paymail"
+
+    ErrPaymailInconsistent:
+      allOf:
+        - $ref: '#/components/schemas/ErrorSchema'
+        - type: object
+          properties:
+            code:
+              example: "error-user-inconsistent-paymail"
+            message:
+              example: "inconsistent paymail address and alias/domain"
+
+    ErrInvalidDomain:
+      allOf:
+        - $ref: '#/components/schemas/ErrorSchema'
+        - type: object
+          properties:
+            code:
+              example: "error-user-invalid-domain"
+            message:
+              example: "invalid domain"
+
+    ErrCreatingUser:
+      allOf:
+        - $ref: '#/components/schemas/ErrorSchema'
+        - type: object
+          properties:
+            code:
+              example: "error-user-creating"
+            message:
+              example: "error creating user"
+
+    ErrGettingUser:
+      allOf:
+        - $ref: '#/components/schemas/ErrorSchema'
+        - type: object
+          properties:
+            code:
+              example: "error-unknown"
+            message:
+              example: "Internal server error"

api/components/models.yaml

@@ -5,3 +5,59 @@ info:
 
 components:
   schemas:
+    User:
+      type: object
+      properties:
+        id:
+          type: string
+          example: "1"
+        publicKey:
+          type: string
+          example: "76a914e069bd2e2fe3ea702c40d5e65b491b734c01686788ac"
+        paymails:
+          type: array
+          items:
+            $ref: "#/components/schemas/Paymail"
+        createdAt:
+          type: string
+          format: date-time
+          example: "2021-01-01T00:00:00Z"
+        updatedAt:
+          type: string
+          format: date-time
+          example: "2021-01-01T00:00:00Z"
+      required:
+        - id
+        - publicKey
+        - paymails
+        - createdAt
+        - updatedAt
+
+    Paymail:
+      type: object
+      properties:
+        id:
+          type: string
+          example: "1"
+        alias:
+          type: string
+          example: "test"
+        domain:
+          type: string
+          example: "spv-wallet.com"
+        paymail:
+          type: string
+          example: "test@spv-wallet.com"
+        publicName:
+          type: string
+          example: "Test"
+        avatar:
+          type: string
+          example: "https://spv-wallet.com/avatar.png"
+      required:
+        - id
+        - alias
+        - domain
+        - paymail
+        - publicName
+        - avatar