Continue documenting grpc.proto for API reference site [#7] #6068
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The new console output formatting (tbl) api is working, and the deprecated classes just add maintenance work. Update affected test cases.
Much less ambiguous field value at cost of breaking backward compat in API.
…ring triggerPrice`.
Some minor refactoring included.
Quite a bit of refactoring. A lot of number-string formatting was removed.
Rename double marketPriceMargin -> marketPriceMarginPct. Rename double buyerSecurityDeposit -> buyerSecurityDepositPct.
And validate the opt value.
ghubstan
changed the title
|
I think the markdown->html transformation by the slate engine works pretty well, but there are two problems so far.
|
This was overlooked in tests, but client might use a bad offer-id param.
ghubstan
changed the title
ghubstan
added a commit
to ghubstan/bisq
that referenced
this pull request
Feb 26, 2022
This protobuf definition and service stub has been in place since the start of work on the API, but was never fully implmented, nor intended to be included in the API beta & v1 releases. Its presence added a useless section to the gRPC API Reference doc. https://ghubstan.github.io/slate Based on branch `7-more-grpcproto-comments`, PR bisq-network#6068.
The CLI and apitest cases always pass "0", but java & python clients might pass an empty string. This change avoids number formatting & scaling problems when clients pass an empty string in the price parameter.
The client may have passed an empty string for the price parameter, if only enabling or disabling the offer. If so, validate with new price = old price.
…ter" This reverts commit fcd2bcd.
…an/bisq into 7-more-grpcproto-comments
ripcurlx
approved these changes
Feb 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This completes a first pass of
grpc.protodocumentation, after some .proto field name and field type changes were made in previous PRs. Comments have not been added topb.protodefs referenced by the API site, such as all the*PaymentAccountmessages. These may be commented later, but providingCLI,JavaandPythoncode examples for the API reference doc is more important at this time.While still a work in progress, the most recent version of the slate based API Reference document could be checked for correctness, missing detail, and to see if more .proto rpc method and/or field types or names need to be changed.
Based on branch
6-disambiguate-api-pct-field-names, PR #6065.