api: add Version api for components

filecoin-project · Aug 2, 2022 · 79b2da1 · 79b2da1
1 parent f5a4cc0
commit 79b2da1
Show file tree

Hide file tree

Showing 20 changed files with 212 additions and 0 deletions.
diff --git a/venus-shared/api/gateway/v0/api.go b/venus-shared/api/gateway/v0/api.go
@@ -1,7 +1,15 @@
 package gateway
 
+import (
+	"context"
+
+	"github.com/filecoin-project/venus/venus-shared/types"
+)
+
 type IGateway interface {
 	IProofEvent
 	IWalletEvent
 	IMarketEvent
+
+	Version(ctx context.Context) (types.Version, error) //perm:read
 }
diff --git a/venus-shared/api/gateway/v0/method.md b/venus-shared/api/gateway/v0/method.md
@@ -1,5 +1,7 @@
 # Groups
 
+* [Gateway](#Gateway)
+  * [Version](#Version)
 * [MarketClient](#MarketClient)
   * [IsUnsealed](#IsUnsealed)
   * [ListMarketConnectionsState](#ListMarketConnectionsState)
@@ -26,6 +28,23 @@
   * [ResponseWalletEvent](#ResponseWalletEvent)
   * [SupportNewAccount](#SupportNewAccount)
 
+## Gateway
+
+### Version
+
+
+Perms: read
+
+Inputs: `[]`
+
+Response:
+```json
+{
+  "Version": "string value",
+  "APIVersion": 131584
+}
+```
+
 ## MarketClient
 
 ### IsUnsealed

diff --git a/venus-shared/api/gateway/v0/mock/mock_igateway.go b/venus-shared/api/gateway/v0/mock/mock_igateway.go
diff --git a/venus-shared/api/gateway/v0/proxy_gen.go b/venus-shared/api/gateway/v0/proxy_gen.go
diff --git a/venus-shared/api/gateway/v1/api.go b/venus-shared/api/gateway/v1/api.go
@@ -1,7 +1,15 @@
 package gateway
 
+import (
+	"context"
+
+	"github.com/filecoin-project/venus/venus-shared/types"
+)
+
 type IGateway interface {
 	IProofEvent
 	IWalletEvent
 	IMarketEvent
+
+	Version(ctx context.Context) (types.Version, error) //perm:read
 }
diff --git a/venus-shared/api/gateway/v1/method.md b/venus-shared/api/gateway/v1/method.md
@@ -1,5 +1,7 @@
 # Groups
 
+* [Gateway](#Gateway)
+  * [Version](#Version)
 * [MarketClient](#MarketClient)
   * [IsUnsealed](#IsUnsealed)
   * [ListMarketConnectionsState](#ListMarketConnectionsState)
@@ -26,6 +28,23 @@
   * [ResponseWalletEvent](#ResponseWalletEvent)
   * [SupportNewAccount](#SupportNewAccount)
 
+## Gateway
+
+### Version
+
+
+Perms: read
+
+Inputs: `[]`
+
+Response:
+```json
+{
+  "Version": "string value",
+  "APIVersion": 131584
+}
+```
+
 ## MarketClient
 
 ### IsUnsealed

diff --git a/venus-shared/api/gateway/v1/mock/mock_igateway.go b/venus-shared/api/gateway/v1/mock/mock_igateway.go
diff --git a/venus-shared/api/gateway/v1/proxy_gen.go b/venus-shared/api/gateway/v1/proxy_gen.go
diff --git a/venus-shared/api/market/api.go b/venus-shared/api/market/api.go
@@ -159,4 +159,6 @@ type IMarket interface {
 	RemovePieceStorage(ctx context.Context, name string) error //perm:admin
 
 	GetPieceStorages(ctx context.Context) market.PieceStorageInfos //perm:read
+
+	Version(ctx context.Context) (types.Version, error) //perm:read
 }
diff --git a/venus-shared/api/market/client/api.go b/venus-shared/api/market/client/api.go
@@ -87,4 +87,6 @@ type IMarketClient interface {
 	MessagerWaitMessage(ctx context.Context, mid cid.Cid) (*types.MsgLookup, error)                            //perm:read
 	MessagerPushMessage(ctx context.Context, msg *types.Message, meta *types.MessageSendSpec) (cid.Cid, error) //perm:write
 	MessagerGetMessage(ctx context.Context, mid cid.Cid) (*types.Message, error)                               //perm:read
+
+	Version(ctx context.Context) (types.Version, error) //perm:read
 }
diff --git a/venus-shared/api/market/client/method.md b/venus-shared/api/market/client/method.md
@@ -38,6 +38,7 @@
   * [MessagerGetMessage](#MessagerGetMessage)
   * [MessagerPushMessage](#MessagerPushMessage)
   * [MessagerWaitMessage](#MessagerWaitMessage)
+  * [Version](#Version)
 
 ## MarketClient
 
@@ -1246,3 +1247,18 @@ Response:
 }
 ```
 
+### Version
+
+
+Perms: read
+
+Inputs: `[]`
+
+Response:
+```json
+{
+  "Version": "string value",
+  "APIVersion": 131584
+}
+```
+
diff --git a/venus-shared/api/market/client/mock/mock_imarketclient.go b/venus-shared/api/market/client/mock/mock_imarketclient.go
diff --git a/venus-shared/api/market/client/proxy_gen.go b/venus-shared/api/market/client/proxy_gen.go
diff --git a/venus-shared/api/market/method.md b/venus-shared/api/market/method.md
@@ -77,6 +77,7 @@
   * [UpdateDealOnPacking](#UpdateDealOnPacking)
   * [UpdateDealStatus](#UpdateDealStatus)
   * [UpdateStorageDealStatus](#UpdateStorageDealStatus)
+  * [Version](#Version)
 
 ## Market
 
@@ -1945,3 +1946,18 @@ Inputs:
 
 Response: `{}`
 
+### Version
+
+
+Perms: read
+
+Inputs: `[]`
+
+Response:
+```json
+{
+  "Version": "string value",
+  "APIVersion": 131584
+}
+```
+
diff --git a/venus-shared/api/market/mock/mock_imarket.go b/venus-shared/api/market/mock/mock_imarket.go
diff --git a/venus-shared/api/market/proxy_gen.go b/venus-shared/api/market/proxy_gen.go
diff --git a/venus-shared/api/messager/api.go b/venus-shared/api/messager/api.go
@@ -60,4 +60,6 @@ type IMessager interface {
 	SetLogLevel(ctx context.Context, level string) error //perm:admin
 
 	Send(ctx context.Context, params types.QuickSendParams) (string, error) //perm:admin
+
+	Version(ctx context.Context) (shared.Version, error) //perm:read
 }
diff --git a/venus-shared/api/messager/method.md b/venus-shared/api/messager/method.md
@@ -42,6 +42,7 @@
   * [UpdateFilledMessageByID](#UpdateFilledMessageByID)
   * [UpdateMessageStateByID](#UpdateMessageStateByID)
   * [UpdateNonce](#UpdateNonce)
+  * [Version](#Version)
   * [WaitMessage](#WaitMessage)
   * [WalletHas](#WalletHas)
 
@@ -1264,6 +1265,21 @@ Inputs:
 
 Response: `{}`
 
+### Version
+
+
+Perms: read
+
+Inputs: `[]`
+
+Response:
+```json
+{
+  "Version": "string value",
+  "APIVersion": 131584
+}
+```
+
 ### WaitMessage
 
 

diff --git a/venus-shared/api/messager/mock/mock_imessager.go b/venus-shared/api/messager/mock/mock_imessager.go
diff --git a/venus-shared/api/messager/proxy_gen.go b/venus-shared/api/messager/proxy_gen.go