Commit ef4ac87b authored by Christopher Schinnerl's avatar Christopher Schinnerl

update docs

parent 27b6c87e
......@@ -5,4 +5,4 @@ The Sia API documentation can be found here:
[Sia API](https://sia.tech/docs/ "Sia API")
Updates to the API documentation can be made here:
[Sia API markdown](./api/index.html.md "Sia API markdown")
\ No newline at end of file
[Sia API markdown](./api/index.html.md "Sia API markdown")
......@@ -5,4 +5,4 @@ The Sia API documentation can be found here:
[Sia API](https://sia.tech/docs/ "Sia API")
Updates to the API documentation can be made here:
[Sia API markdown](./index.html.md "Sia API markdown")
\ No newline at end of file
[Sia API markdown](./index.html.md "Sia API markdown")
......@@ -1500,7 +1500,7 @@ standard success or error response. See [standard responses](#standard-responses
## /renter/contracts [GET]
Returns the renter's contracts. Active contracts are contracts that the Renter is currently using to store, upload, and download data, and are returned by default. Inactive contracts are contracts that are in the current period but are marked as not good for renew, these contracts have the potential to become active again but currently are not storing data. Expired contracts are contracts not in the current period, where not more data is being stored and excess funds have been released to the renter.
Returns the renter's contracts. Active contracts are contracts that the Renter is currently using to store, upload, and download data, and are returned by default. Inactive contracts are contracts that are in the current period but are marked as not good for renew, these contracts have the potential to become active again but currently are not storing data. Expired contracts are contracts not in the current period, where not more data is being stored and excess funds have been released to the renter. Recoverable contracts are contracts which the contractor is currently trying to recover and which haven't expired yet.
### Query String Parameters
#### OPTIONAL
......@@ -1510,6 +1510,9 @@ flag indicating if inactive contracts should be returned.
**expired** | boolean
flag indicating if expired contracts should be returned.
**recoverable** | boolean
flag indicating if recoverable contracts should be returned.
### JSON Response
> JSON Response Example
......@@ -1540,6 +1543,7 @@ flag indicating if expired contracts should be returned.
],
"inactivecontracts": [],
"expiredcontracts": [],
"recoverablecontracts": [],
}
```
**downloadspending** | hastings
......@@ -2798,4 +2802,4 @@ The addresses currently watched by the wallet.
### Response
standard success or error response. See [standard responses](#standard-responses).
\ No newline at end of file
standard success or error response. See [standard responses](#standard-responses).
......@@ -624,7 +624,7 @@ func (r *Renter) OldContracts() []modules.RenterContract {
// PeriodSpending returns the host contractor's period spending
func (r *Renter) PeriodSpending() modules.ContractorSpending { return r.hostContractor.PeriodSpending() }
// recoverableContracts returns the host contractor's recoverable contracts.
// RecoverableContracts returns the host contractor's recoverable contracts.
func (r *Renter) RecoverableContracts() []modules.RecoverableContract {
return r.hostContractor.RecoverableContracts()
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment