[bisq-network/projects] Prepare roll out of API for January or February release (#46)

[Stan]

> Do you have any further input?

@chimp1984 I think api method level help would be useful, implemented in a server side `CoreHelpService` with one method:  `getHelp(String methodName)`.

It would return a String the CLI would print on stdout. 

I was thinking the help would work as is on the CLI:  `./bisq-cli  --help` shows the CLI level help as it does now (the list of supported api methods.)  `./bisq-cli --password=blah --port=N method-name help` would get the method specific help string from the server.

Here is what the `takeoffer help` output might look like to a CLI user:

```
takeoffer
Takes an existing offer using a payment account.  The Bisq trade fee can be paid in BSQ or BTC.

Usage: takeoffer offer-id payment-acct-id [taker-fee-currency-code = bsq|btc]

Parameters:
1.  offer-id              (required)                 The ID of the offer being taken.
2.  payment-acct-id       (required)                 The ID of the payment account used for the trade.
3.  fee-currency-code     (optional, default = BTC)  The Bisq trade fee currency (BSQ or BTC).

```

It would be easy to do in the CLI using `jsimpleopt`, but if we ever serve RESTful clients (HTTP 1.1), we don't want to be maintaining duplicate help strings on the client and server -- that's why I suggest a new `CoreHelpService`.

For dev users, this is documentation.


-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/projects/issues/46#issuecomment-754016275
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20210104/f169baa3/attachment-0001.htm>