Skip to content

Commit

Permalink
Merge pull request #257 from ParadigmFoundation/docs/go-kosu/update-r…
Browse files Browse the repository at this point in the history
…pc-references

go-kosu: update RPC doc references
  • Loading branch information
Henry Harder committed Sep 4, 2019
2 parents d8d8d5d + 30f3b38 commit 63766e7
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 32 deletions.
32 changes: 16 additions & 16 deletions packages/go-kosu/docs/kosu_rpc.md
Expand Up @@ -53,11 +53,11 @@ _Method:_

_Parameters:_

- Order Transactions - `Array([order]())`
- `Order Transactions` - `Array`([TransactionOrder](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#TransactionOrder))

_Returns:_

- Orders Result - `[object](AddOrdersResult)`
- `Orders Result` - [`AddOrdersResult`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/rpc#AddOrdersResult)

#### cURL example

Expand Down Expand Up @@ -121,7 +121,7 @@ _Method:_

- `kosu_latestHeight`

_Parameters:_
_Parameters:_ None

_Returns:_

Expand All @@ -145,7 +145,7 @@ _Method:_

- `kosu_numberPosters`

_Parameters:_
_Parameters:_ None

_Returns:_

Expand All @@ -165,7 +165,7 @@ _Parameters:_

_Returns:_

- `Poster` - _[object]()_
- `Poster` - _[`Poster`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#Poster)_

#### cURL Example

Expand Down Expand Up @@ -201,7 +201,7 @@ _Parameters:_

_Returns:_

- `Validator` - _[object]()_
- `Validator` - _[`Validator`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#Validator)_

#### cURL Example

Expand Down Expand Up @@ -237,7 +237,7 @@ _Method:_

- `kosu_remainingLimit`

_Parameters:_
_Parameters:_ None

_Returns:_

Expand All @@ -254,11 +254,11 @@ _Method:_

- `kosu_roundInfo`

_Parameters:_
_Parameters:_ None

_Returns:_

- `RoundInfo` - _[object]()_
- `RoundInfo` - _[`RoundInfo`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#RoundInfo)_

#### cURL example

Expand All @@ -281,7 +281,7 @@ _Method:_

- `kosu_totalOrders`

_Parameters:_
_Parameters:_ None

_Returns:_

Expand All @@ -295,11 +295,11 @@ _Method:_

- `kosu_validators`

_Parameters:_
_Parameters:_ None

_Returns:_

- `Validator Set` - _Array([object]())_
- `Validator Set` - _`Array`([Validator](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#Validator))_

#### cURL example

Expand Down Expand Up @@ -371,7 +371,7 @@ _Parameters:_

_Returns:_

- `block` - _[object](https://godoc.org/github.com/tendermint/tendermint/types#Block)_
- `block` - _[`Block`](https://godoc.org/github.com/tendermint/tendermint/types#Block)_

#### Go example

Expand Down Expand Up @@ -491,11 +491,11 @@ _Method:_

- `kosu_subscribe`

_Parameters:_
_Parameters:_ None

_Returns:_

- `Order Transaction` - _[object]()_
- `Order Transaction` - _[`TransactionOrder`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#TransactionOrder)_

#### Go Example

Expand Down Expand Up @@ -611,7 +611,7 @@ _Parameters:_

_Returns:_

- `Rebalance Transaction` - _[object]()_
- `Rebalance Transaction` - _[`TransactionRebalance`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#TransactionRebalance)_

#### Go Example

Expand Down
32 changes: 16 additions & 16 deletions packages/go-kosu/rpc/service.go
Expand Up @@ -93,7 +93,7 @@ _Parameters:_
_Returns:_
- `block` - _[object](https://godoc.org/github.com/tendermint/tendermint/types#Block)_
- `block` - _[`Block`](https://godoc.org/github.com/tendermint/tendermint/types#Block)_
#### Go example
Expand Down Expand Up @@ -217,11 +217,11 @@ _Method:_
- `kosu_subscribe`
_Parameters:_
_Parameters:_ None
_Returns:_
- `Order Transaction` - _[object]()_
- `Order Transaction` - _[`TransactionOrder`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#TransactionOrder)_
#### Go Example
Expand Down Expand Up @@ -391,7 +391,7 @@ _Parameters:_
_Returns:_
- `Rebalance Transaction` - _[object]()_
- `Rebalance Transaction` - _[`TransactionRebalance`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#TransactionRebalance)_
#### Go Example
Expand Down Expand Up @@ -472,7 +472,7 @@ _Method:_
- `kosu_latestHeight`
_Parameters:_
_Parameters:_ None
_Returns:_
Expand Down Expand Up @@ -509,11 +509,11 @@ _Method:_
_Parameters:_
- Order Transactions - `Array([order]())`
- `Order Transactions` - `Array`([TransactionOrder](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#TransactionOrder))
_Returns:_
- Orders Result - `[object](AddOrdersResult)`
- `Orders Result` - [`AddOrdersResult`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/rpc#AddOrdersResult)
#### cURL example
Expand Down Expand Up @@ -611,11 +611,11 @@ _Method:_
- `kosu_roundInfo`
_Parameters:_
_Parameters:_ None
_Returns:_
- `RoundInfo` - _[object]()_
- `RoundInfo` - _[`RoundInfo`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#RoundInfo)_
#### cURL example
Expand Down Expand Up @@ -648,7 +648,7 @@ _Parameters:_
_Returns:_
- `Validator` - _[object]()_
- `Validator` - _[`Validator`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#Validator)_
#### cURL Example
Expand Down Expand Up @@ -688,11 +688,11 @@ _Method:_
- `kosu_validators`
_Parameters:_
_Parameters:_ None
_Returns:_
- `Validator Set` - _Array([object]())_
- `Validator Set` - _`Array`([Validator](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#Validator))_
#### cURL example
Expand Down Expand Up @@ -751,7 +751,7 @@ _Parameters:_
_Returns:_
- `Poster` - _[object]()_
- `Poster` - _[`Poster`](https://godoc.org/github.com/ParadigmFoundation/kosu-monorepo/packages/go-kosu/abci/types#Poster)_
#### cURL Example
Expand Down Expand Up @@ -784,7 +784,7 @@ _Method:_
- `kosu_totalOrders`
_Parameters:_
_Parameters:_ None
_Returns:_
Expand All @@ -802,7 +802,7 @@ _Method:_
- `kosu_numberPosters`
_Parameters:_
_Parameters:_ None
_Returns:_
Expand All @@ -826,7 +826,7 @@ _Method:_
- `kosu_remainingLimit`
_Parameters:_
_Parameters:_ None
_Returns:_
Expand Down

0 comments on commit 63766e7

Please sign in to comment.