zoobc/zoobc-core#660 get multisig info api

documentation.swagger.json

@@ -492,28 +492,16 @@
         }
       }
     },
-    "/v1/multisig/GetPendingTransactionByAddress": {
+    "/v1/multisig/GetMultisignatureInfo": {
       "get": {
         "tags": [
           "MultisigService"
         ],
-        "operationId": "GetPendingTransactionByAddress",
+        "operationId": "GetMultisignatureInfo",
         "parameters": [
           {
             "type": "string",
-            "name": "SenderAddress",
-            "in": "query"
-          },
-          {
-            "enum": [
-              "PendingTransactionPending",
-              "PendingTransactionExecuted",
-              "PendingTransactionNoOp",
-              "PendingTransactionExpired"
-            ],
-            "type": "string",
-            "default": "PendingTransactionPending",
-            "name": "Status",
+            "name": "MultisigAddress",
             "in": "query"
           },
           {
@@ -548,7 +536,7 @@
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/modelGetPendingTransactionByAddressResponse"
+              "$ref": "#/definitions/modelGetMultisignatureInfoResponse"
             }
           }
         }
@@ -578,6 +566,68 @@
         }
       }
     },
+    "/v1/multisig/GetPendingTransactions": {
+      "get": {
+        "tags": [
+          "MultisigService"
+        ],
+        "operationId": "GetPendingTransactions",
+        "parameters": [
+          {
+            "type": "string",
+            "name": "SenderAddress",
+            "in": "query"
+          },
+          {
+            "enum": [
+              "PendingTransactionPending",
+              "PendingTransactionExecuted",
+              "PendingTransactionNoOp",
+              "PendingTransactionExpired"
+            ],
+            "type": "string",
+            "default": "PendingTransactionPending",
+            "name": "Status",
+            "in": "query"
+          },
+          {
+            "type": "string",
+            "name": "Pagination.OrderField",
+            "in": "query"
+          },
+          {
+            "enum": [
+              "DESC",
+              "ASC"
+            ],
+            "type": "string",
+            "default": "DESC",
+            "name": "Pagination.OrderBy",
+            "in": "query"
+          },
+          {
+            "type": "integer",
+            "format": "int64",
+            "name": "Pagination.Page",
+            "in": "query"
+          },
+          {
+            "type": "integer",
+            "format": "int64",
+            "name": "Pagination.Limit",
+            "in": "query"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/modelGetPendingTransactionsResponse"
+            }
+          }
+        }
+      }
+    },
     "/v1/nodeRegistration/GetNodeRegistration": {
       "get": {
         "tags": [
@@ -1459,6 +1509,28 @@
         }
       }
     },
+    "modelGetMultisignatureInfoResponse": {
+      "type": "object",
+      "properties": {
+        "Count": {
+          "type": "integer",
+          "format": "int64",
+          "title": "Number of item in current page"
+        },
+        "MultisignatureInfo": {
+          "type": "array",
+          "title": "content of the request",
+          "items": {
+            "$ref": "#/definitions/modelMultiSignatureInfo"
+          }
+        },
+        "Page": {
+          "type": "integer",
+          "format": "int64",
+          "title": "Starting page"
+        }
+      }
+    },
     "modelGetNextBlocksmithsResponse": {
       "type": "object",
       "properties": {
@@ -1507,7 +1579,24 @@
         }
       }
     },
-    "modelGetPendingTransactionByAddressResponse": {
+    "modelGetPendingTransactionDetailByTransactionHashResponse": {
+      "type": "object",
+      "properties": {
+        "MultiSignatureInfo": {
+          "$ref": "#/definitions/modelMultiSignatureInfo"
+        },
+        "PendingSignatures": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/modelPendingSignature"
+          }
+        },
+        "PendingTransaction": {
+          "$ref": "#/definitions/modelPendingTransaction"
+        }
+      }
+    },
+    "modelGetPendingTransactionsResponse": {
       "type": "object",
       "properties": {
         "Count": {
@@ -1529,23 +1618,6 @@
         }
       }
     },
-    "modelGetPendingTransactionDetailByTransactionHashResponse": {
-      "type": "object",
-      "properties": {
-        "MultiSignatureInfo": {
-          "$ref": "#/definitions/modelMultiSignatureInfo"
-        },
-        "PendingSignatures": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/modelPendingSignature"
-          }
-        },
-        "PendingTransaction": {
-          "$ref": "#/definitions/modelPendingTransaction"
-        }
-      }
-    },
     "modelGetTransactionMinimumFeeResponse": {
       "type": "object",
       "title": "GetTransactionMinimumFeeResponse a model response for GetTransactionMinimumFeeRequest, indicates the minimum fee for provided tx",

model/multiSignature.proto

@@ -48,13 +48,13 @@ enum PendingTransactionStatus {
 
 // API model
 
-message GetPendingTransactionByAddressRequest {
+message GetPendingTransactionsRequest {
     string SenderAddress = 1;
     PendingTransactionStatus Status = 2;
     Pagination Pagination = 3;
 }
 
-message GetPendingTransactionByAddressResponse {
+message GetPendingTransactionsResponse {
     // Number of item in current page
     uint32 Count = 1;
     // Starting page
@@ -73,3 +73,17 @@ message GetPendingTransactionDetailByTransactionHashResponse {
     repeated PendingSignature PendingSignatures = 2;
     MultiSignatureInfo MultiSignatureInfo = 3;
 }
+
+message GetMultisignatureInfoRequest {
+    string MultisigAddress = 1;
+    Pagination Pagination = 2; 
+}
+
+message GetMultisignatureInfoResponse {
+    // Number of item in current page
+    uint32 Count = 1;
+    // Starting page
+    uint32 Page = 2;
+    // content of the request
+    repeated MultiSignatureInfo MultisignatureInfo = 3;
+}

service/multiSignature.proto

@@ -9,9 +9,9 @@ import "google/api/annotations.proto";
 
 // MultisigService represent request on Blockchain's multisig component such as pending_transaction, pending_signatures, and multisig_info 
 service MultisigService {
-    rpc GetPendingTransactionByAddress(model.GetPendingTransactionByAddressRequest) returns (model.GetPendingTransactionByAddressResponse) {
+    rpc GetPendingTransactions(model.GetPendingTransactionsRequest) returns (model.GetPendingTransactionsResponse) {
         option (google.api.http) = {
-            get: "/v1/multisig/GetPendingTransactionByAddress"
+            get: "/v1/multisig/GetPendingTransactions"
         };
     }
 
@@ -20,5 +20,11 @@ service MultisigService {
             get: "/v1/multisig/GetPendingTransactionDetailByTransactionHash"
         };
     }
+    rpc GetMultisignatureInfo(model.GetMultisignatureInfoRequest) returns (model.GetMultisignatureInfoResponse) {
+        option (google.api.http) = {
+            get: "/v1/multisig/GetMultisignatureInfo"
+        };
+    } 
+
 
 }