apigen: use directives for tags

filecoin-project · Mar 22, 2021 · 08405ca · 08405ca
1 parent 7bc3b18
commit 08405ca
Show file tree

Hide file tree

Showing 5 changed files with 318 additions and 321 deletions.
diff --git a/api/api_common.go b/api/api_common.go
@@ -19,60 +19,60 @@ type Common interface {
 
 	// MethodGroup: Auth
 
-	AuthVerify(ctx context.Context, token string) ([]auth.Permission, error) // perm:read
-	AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)    // perm:admin
+	AuthVerify(ctx context.Context, token string) ([]auth.Permission, error) //perm:read
+	AuthNew(ctx context.Context, perms []auth.Permission) ([]byte, error)    //perm:admin
 
 	// MethodGroup: Net
 
-	NetConnectedness(context.Context, peer.ID) (network.Connectedness, error) // perm:read
-	NetPeers(context.Context) ([]peer.AddrInfo, error)                        // perm:read
-	NetConnect(context.Context, peer.AddrInfo) error                          // perm:write
-	NetAddrsListen(context.Context) (peer.AddrInfo, error)                    // perm:read
-	NetDisconnect(context.Context, peer.ID) error                             // perm:write
-	NetFindPeer(context.Context, peer.ID) (peer.AddrInfo, error)              // perm:read
-	NetPubsubScores(context.Context) ([]PubsubScore, error)                   // perm:read
-	NetAutoNatStatus(context.Context) (NatInfo, error)                        // perm:read
-	NetAgentVersion(ctx context.Context, p peer.ID) (string, error)           // perm:read
-	NetPeerInfo(context.Context, peer.ID) (*ExtendedPeerInfo, error)          // perm:read
+	NetConnectedness(context.Context, peer.ID) (network.Connectedness, error) //perm:read
+	NetPeers(context.Context) ([]peer.AddrInfo, error)                        //perm:read
+	NetConnect(context.Context, peer.AddrInfo) error                          //perm:write
+	NetAddrsListen(context.Context) (peer.AddrInfo, error)                    //perm:read
+	NetDisconnect(context.Context, peer.ID) error                             //perm:write
+	NetFindPeer(context.Context, peer.ID) (peer.AddrInfo, error)              //perm:read
+	NetPubsubScores(context.Context) ([]PubsubScore, error)                   //perm:read
+	NetAutoNatStatus(context.Context) (NatInfo, error)                        //perm:read
+	NetAgentVersion(ctx context.Context, p peer.ID) (string, error)           //perm:read
+	NetPeerInfo(context.Context, peer.ID) (*ExtendedPeerInfo, error)          //perm:read
 
 	// NetBandwidthStats returns statistics about the nodes total bandwidth
 	// usage and current rate across all peers and protocols.
-	NetBandwidthStats(ctx context.Context) (metrics.Stats, error) // perm:read
+	NetBandwidthStats(ctx context.Context) (metrics.Stats, error) //perm:read
 
 	// NetBandwidthStatsByPeer returns statistics about the nodes bandwidth
 	// usage and current rate per peer
-	NetBandwidthStatsByPeer(ctx context.Context) (map[string]metrics.Stats, error) // perm:read
+	NetBandwidthStatsByPeer(ctx context.Context) (map[string]metrics.Stats, error) //perm:read
 
 	// NetBandwidthStatsByProtocol returns statistics about the nodes bandwidth
 	// usage and current rate per protocol
-	NetBandwidthStatsByProtocol(ctx context.Context) (map[protocol.ID]metrics.Stats, error) // perm:read
+	NetBandwidthStatsByProtocol(ctx context.Context) (map[protocol.ID]metrics.Stats, error) //perm:read
 
 	// ConnectionGater API
-	NetBlockAdd(ctx context.Context, acl NetBlockList) error    // perm:admin
-	NetBlockRemove(ctx context.Context, acl NetBlockList) error // perm:admin
-	NetBlockList(ctx context.Context) (NetBlockList, error)     // perm:read
+	NetBlockAdd(ctx context.Context, acl NetBlockList) error    //perm:admin
+	NetBlockRemove(ctx context.Context, acl NetBlockList) error //perm:admin
+	NetBlockList(ctx context.Context) (NetBlockList, error)     //perm:read
 
 	// MethodGroup: Common
 
 	// Discover returns an OpenRPC document describing an RPC API.
-	Discover(ctx context.Context) (apitypes.OpenRPCDocument, error) // perm:read
+	Discover(ctx context.Context) (apitypes.OpenRPCDocument, error) //perm:read
 
 	// ID returns peerID of libp2p node backing this API
-	ID(context.Context) (peer.ID, error) // perm:read
+	ID(context.Context) (peer.ID, error) //perm:read
 
 	// Version provides information about API provider
-	Version(context.Context) (APIVersion, error) // perm:read
+	Version(context.Context) (APIVersion, error) //perm:read
 
-	LogList(context.Context) ([]string, error)         // perm:write
-	LogSetLevel(context.Context, string, string) error // perm:write
+	LogList(context.Context) ([]string, error)         //perm:write
+	LogSetLevel(context.Context, string, string) error //perm:write
 
 	// trigger graceful shutdown
-	Shutdown(context.Context) error // perm:admin
+	Shutdown(context.Context) error //perm:admin
 
 	// Session returns a random UUID of api provider session
-	Session(context.Context) (uuid.UUID, error) // perm:read
+	Session(context.Context) (uuid.UUID, error) //perm:read
 
-	Closing(context.Context) (<-chan struct{}, error) // perm:read
+	Closing(context.Context) (<-chan struct{}, error) //perm:read
 }
 
 // APIVersion provides various build-time information