Clarify meaning of API/Offer related % fields [#6] #6065
Merged
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
This commit adds comments to grpc.proto to be pulled into a new API reference doc. Some of the comments highlight issues to be resolved in following PRs. The main focus is on documenting gRPC Offers service definitions in grpc.proto: - Comment each field in the Offers service's messages. - Add TODO comments about fixing field defs with usability & consistency problems. Other API reference doc related changes to grpc.proto: - Comment each gRPC service's rpc method definitions, however briefly. - Improve some existing rpc method comments.
We will consider each problematic number field one at a time. Note: changing field types in following commits will break the API's backward compatibility, but devs agree it's OK since it is still in beta.
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.
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 change fixes some inconsistencies in offer related API fields representing percentages:
marketPriceMargin->marketPriceMarginPct.buyerSecurityDeposit->buyerSecurityDepositPct.In both cases, these fields' values represent "literal" percent values, e.g., 2.55 means 2.55%.
It also fixes inconsistencies between input-pct values and output-pct values. For example, when
createofferwas passed amarketPriceMargin=1.0 (%) param, thegetofferresponse contained an unexpected decimal representation of the pct literal:marketPriceMargin=0.01. Nowcreateofferinput equalsgetofferoutput: 1.0 (%).Summary of commits:
grpc.protooffer pct literal field names.GrpcOffersServiceto new .proto *Pct field names.coreapi pkg classes to new .proto *Pct field names.climodule to new .proto *Pct field names.apitestcases to new .proto *Pct field names.Based on branch
5-change-tradeinfo-proto-prc-n-vol-to-string, PR #6062