API proxy struct codegen (#5854)
* mostly working api proxy gen * api: Consistent api names * fix docsgen * regenerate api struct * api: expand external interfaces * Add missing gen files * apigen: fix perm detection * api: Move perm tags to the interface * gofmt * worker perms * docsgen * docsgen: ignore tag comments * apigen: add codegen warning * gofmt * missing actor type * docsgen * make linter happy * fix lint * apigen: use directives for tags * docsgen * regen openrpc docs
This commit is contained in:
Łukasz Magiera
@@ -200,7 +200,7 @@ Response:
|
||||
|
||||
|
||||
### ActorAddress
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -209,7 +209,7 @@ Inputs: `null`
|
||||
Response: `"f01234"`
|
||||
|
||||
### ActorAddressConfig
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -227,7 +227,7 @@ Response:
|
||||
```
|
||||
|
||||
### ActorSectorSize
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -275,7 +275,7 @@ Response: `null`
|
||||
|
||||
|
||||
### CheckProvable
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -320,63 +320,63 @@ Response: `{}`
|
||||
|
||||
|
||||
### DealsConsiderOfflineRetrievalDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
Perms: read
|
||||
|
||||
Perms: admin
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response: `true`
|
||||
|
||||
### DealsConsiderOfflineStorageDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
Perms: read
|
||||
|
||||
Perms: admin
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response: `true`
|
||||
|
||||
### DealsConsiderOnlineRetrievalDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
Perms: read
|
||||
|
||||
Perms: admin
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response: `true`
|
||||
|
||||
### DealsConsiderOnlineStorageDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
Perms: read
|
||||
|
||||
Perms: admin
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response: `true`
|
||||
|
||||
### DealsConsiderUnverifiedStorageDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
Perms: read
|
||||
|
||||
Perms: admin
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response: `true`
|
||||
|
||||
### DealsConsiderVerifiedStorageDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
Perms: read
|
||||
|
||||
Perms: admin
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response: `true`
|
||||
|
||||
### DealsImportData
|
||||
There are not yet any comments for this method.
|
||||
|
||||
Perms: write
|
||||
|
||||
Perms: admin
|
||||
|
||||
Inputs:
|
||||
```json
|
||||
@@ -391,25 +391,25 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### DealsList
|
||||
There are not yet any comments for this method.
|
||||
|
||||
Perms: read
|
||||
|
||||
Perms: admin
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response: `null`
|
||||
|
||||
### DealsPieceCidBlocklist
|
||||
There are not yet any comments for this method.
|
||||
|
||||
Perms: read
|
||||
|
||||
Perms: admin
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
Response: `null`
|
||||
|
||||
### DealsSetConsiderOfflineRetrievalDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -423,7 +423,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### DealsSetConsiderOfflineStorageDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -437,7 +437,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### DealsSetConsiderOnlineRetrievalDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -451,7 +451,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### DealsSetConsiderOnlineStorageDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -465,7 +465,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### DealsSetConsiderUnverifiedStorageDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -479,7 +479,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### DealsSetConsiderVerifiedStorageDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -493,7 +493,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### DealsSetPieceCidBlocklist
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -566,7 +566,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### MarketDataTransferUpdates
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
@@ -590,7 +590,7 @@ Response:
|
||||
```
|
||||
|
||||
### MarketGetAsk
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -617,7 +617,7 @@ Response:
|
||||
```
|
||||
|
||||
### MarketGetDealUpdates
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -682,7 +682,7 @@ Response:
|
||||
```
|
||||
|
||||
### MarketGetRetrievalAsk
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -699,7 +699,7 @@ Response:
|
||||
```
|
||||
|
||||
### MarketImportDealData
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
@@ -716,7 +716,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### MarketListDataTransfers
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
@@ -725,7 +725,7 @@ Inputs: `null`
|
||||
Response: `null`
|
||||
|
||||
### MarketListDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -734,7 +734,7 @@ Inputs: `null`
|
||||
Response: `null`
|
||||
|
||||
### MarketListIncompleteDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -743,7 +743,7 @@ Inputs: `null`
|
||||
Response: `null`
|
||||
|
||||
### MarketListRetrievalDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -752,7 +752,7 @@ Inputs: `null`
|
||||
Response: `null`
|
||||
|
||||
### MarketPendingDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
@@ -768,7 +768,7 @@ Response:
|
||||
```
|
||||
|
||||
### MarketPublishPendingDeals
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -794,7 +794,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### MarketSetAsk
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -812,7 +812,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### MarketSetRetrievalAsk
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -834,7 +834,7 @@ Response: `{}`
|
||||
|
||||
|
||||
### MiningBase
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -1122,7 +1122,7 @@ Response: `null`
|
||||
|
||||
|
||||
### PiecesGetCIDInfo
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -1146,7 +1146,7 @@ Response:
|
||||
```
|
||||
|
||||
### PiecesGetPieceInfo
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -1170,7 +1170,7 @@ Response:
|
||||
```
|
||||
|
||||
### PiecesListCidInfos
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -1179,7 +1179,7 @@ Inputs: `null`
|
||||
Response: `null`
|
||||
|
||||
### PiecesListPieces
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -1210,6 +1210,7 @@ Response:
|
||||
|
||||
|
||||
### ReturnAddPiece
|
||||
storiface.WorkerReturn
|
||||
|
||||
|
||||
Perms: admin
|
||||
@@ -1495,7 +1496,7 @@ Response: `{}`
|
||||
|
||||
|
||||
### SealingAbort
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -1554,7 +1555,7 @@ Inputs: `null`
|
||||
Response: `60000000000`
|
||||
|
||||
### SectorMarkForUpgrade
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -1708,7 +1709,7 @@ Response:
|
||||
```
|
||||
|
||||
### SectorsRefs
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -1791,7 +1792,7 @@ Response:
|
||||
```
|
||||
|
||||
### SectorsUpdate
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -1809,7 +1810,7 @@ Response: `{}`
|
||||
|
||||
|
||||
### StorageAddLocal
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -1823,6 +1824,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### StorageAttach
|
||||
stores.SectorIndex
|
||||
|
||||
|
||||
Perms: admin
|
||||
@@ -1951,7 +1953,7 @@ Response:
|
||||
```
|
||||
|
||||
### StorageList
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -1971,7 +1973,7 @@ Response:
|
||||
```
|
||||
|
||||
### StorageLocal
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -2029,7 +2031,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### StorageStat
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -2090,7 +2092,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### WorkerJobs
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -2122,7 +2124,7 @@ Response:
|
||||
```
|
||||
|
||||
### WorkerStats
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
|
||||
@@ -40,7 +40,7 @@
|
||||
|
||||
|
||||
### Enabled
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -81,7 +81,7 @@ Response:
|
||||
```
|
||||
|
||||
### Info
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -102,7 +102,7 @@ Response:
|
||||
```
|
||||
|
||||
### Paths
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -139,7 +139,6 @@ Inputs: `null`
|
||||
Response: `"07070707-0707-0707-0707-070707070707"`
|
||||
|
||||
### Version
|
||||
TODO: Info() (name, ...) ?
|
||||
|
||||
|
||||
Perms: admin
|
||||
@@ -152,6 +151,7 @@ Response: `65792`
|
||||
|
||||
|
||||
### AddPiece
|
||||
storiface.WorkerCalls
|
||||
|
||||
|
||||
Perms: admin
|
||||
@@ -488,7 +488,7 @@ Response: `{}`
|
||||
|
||||
|
||||
### StorageAddLocal
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -505,7 +505,7 @@ Response: `{}`
|
||||
|
||||
|
||||
### TaskDisable
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
@@ -519,7 +519,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### TaskEnable
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: admin
|
||||
|
||||
|
||||
@@ -530,7 +530,7 @@ Response:
|
||||
```
|
||||
|
||||
### ChainGetNode
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -885,7 +885,7 @@ retrieval markets as a client
|
||||
ClientCalcCommP calculates the CommP for a specified file
|
||||
|
||||
|
||||
Perms: read
|
||||
Perms: write
|
||||
|
||||
Inputs:
|
||||
```json
|
||||
@@ -922,7 +922,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### ClientDataTransferUpdates
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
@@ -1113,7 +1113,7 @@ Response: `"string value"`
|
||||
ClientGetDealUpdates returns the status of updated deals
|
||||
|
||||
|
||||
Perms: read
|
||||
Perms: write
|
||||
|
||||
Inputs: `null`
|
||||
|
||||
@@ -1794,7 +1794,7 @@ Response:
|
||||
|
||||
|
||||
### MinerCreateBlock
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
@@ -2210,7 +2210,7 @@ Response: `null`
|
||||
MpoolSetConfig sets the mpool config to (a copy of) the supplied config
|
||||
|
||||
|
||||
Perms: write
|
||||
Perms: admin
|
||||
|
||||
Inputs:
|
||||
```json
|
||||
@@ -2229,7 +2229,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### MpoolSub
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -2975,7 +2975,7 @@ The Paych methods are for interacting with and managing payment channels
|
||||
|
||||
|
||||
### PaychAllocateLane
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: sign
|
||||
|
||||
@@ -2989,7 +2989,7 @@ Inputs:
|
||||
Response: `42`
|
||||
|
||||
### PaychAvailableFunds
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: sign
|
||||
|
||||
@@ -3015,7 +3015,7 @@ Response:
|
||||
```
|
||||
|
||||
### PaychAvailableFundsByFromTo
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: sign
|
||||
|
||||
@@ -3042,7 +3042,7 @@ Response:
|
||||
```
|
||||
|
||||
### PaychCollect
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: sign
|
||||
|
||||
@@ -3085,7 +3085,7 @@ Response:
|
||||
```
|
||||
|
||||
### PaychGetWaitReady
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: sign
|
||||
|
||||
@@ -3101,7 +3101,7 @@ Inputs:
|
||||
Response: `"f01234"`
|
||||
|
||||
### PaychList
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -3110,7 +3110,7 @@ Inputs: `null`
|
||||
Response: `null`
|
||||
|
||||
### PaychNewPayment
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: sign
|
||||
|
||||
@@ -3135,7 +3135,7 @@ Response:
|
||||
```
|
||||
|
||||
### PaychSettle
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: sign
|
||||
|
||||
@@ -3154,7 +3154,7 @@ Response:
|
||||
```
|
||||
|
||||
### PaychStatus
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -3174,7 +3174,7 @@ Response:
|
||||
```
|
||||
|
||||
### PaychVoucherAdd
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
@@ -3210,7 +3210,7 @@ Inputs:
|
||||
Response: `"0"`
|
||||
|
||||
### PaychVoucherCheckSpendable
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -3246,7 +3246,7 @@ Inputs:
|
||||
Response: `true`
|
||||
|
||||
### PaychVoucherCheckValid
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: read
|
||||
|
||||
@@ -3280,7 +3280,7 @@ Inputs:
|
||||
Response: `{}`
|
||||
|
||||
### PaychVoucherCreate
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: sign
|
||||
|
||||
@@ -3321,7 +3321,7 @@ Response:
|
||||
```
|
||||
|
||||
### PaychVoucherList
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: write
|
||||
|
||||
@@ -3335,7 +3335,7 @@ Inputs:
|
||||
Response: `null`
|
||||
|
||||
### PaychVoucherSubmit
|
||||
There are not yet any comments for this method.
|
||||
|
||||
|
||||
Perms: sign
|
||||
|
||||
@@ -5360,7 +5360,7 @@ Response: `"f01234"`
|
||||
WalletDelete deletes an address from the wallet.
|
||||
|
||||
|
||||
Perms: write
|
||||
Perms: admin
|
||||
|
||||
Inputs:
|
||||
```json
|
||||
@@ -5456,7 +5456,7 @@ Response: `"f01234"`
|
||||
WalletSetDefault marks the given address as as the default one.
|
||||
|
||||
|
||||
Perms: admin
|
||||
Perms: write
|
||||
|
||||
Inputs:
|
||||
```json
|
||||
|
||||
Reference in New Issue
Block a user