Uh oh!
There was an error while loading. Please reload this page.
Update transactions object - #157
Conversation
waldyrious
left a comment
There was a problem hiding this comment.
As with #155, this would have been easier to review (and more clearly recorded in the git history) as separate commits for the additions, the rearrangements, and the formatting.
Other than the comments I've left inline, this looks good to me.
| denomination | The funds to be transferred, as originally requested. See "Denomination" below. | ||
| fees | The fees that were applied to the transaction. | ||
| denomination | The funds to be transferred, as originally requested. See [Denomination](#denomination). | ||
| fees | The fees that were applied to the transaction. See [Fees](#fees). |
| currency | The currency in which the amount and commission are expressed. The value is always `USD`. | ||
| fee | The normalized fee amount. | ||
| rate | The exchange rate for this pair. | ||
| target | Can be `origin` or `destination` and determines where the fee was applied. |
There was a problem hiding this comment.
Looks like all other entries start with "The foo". This should probably adopt the same format, for consistency.
There was a problem hiding this comment.
This was extracted from the ### Fees section, which was already using this description. Maybe we can improve some of these descriptions in the future.
There was a problem hiding this comment.
Got it. Should I open an issue in this repo to track that?
There was a problem hiding this comment.
Sure. It would be nice to have a list of low-hanging fruit like this to improve in the near future.
There was a problem hiding this comment.
Great. I've created #160 to track this particular issue, and added a "bite-size" label for similar issues. Let me know if you prefer a different name for the label, and please tag any relevant existing issues with it.
| description | The name of the sender. | ||
| fee | The Bitcoin network Fee, if origin is in BTC but destination is not, or is a non-Uphold Bitcoin Address. | ||
| isMember | A boolean signaling if the origin user has completed the membership process. | ||
| node | Details about the transaction origin node. |
There was a problem hiding this comment.
Same as above: these two would fit better if they started with "The foo".
| description | The name of the recipient. In the case where money is sent via email, the description will contain the email address of the recipient. | ||
| fee | The Bitcoin network Fee, if destination is a BTC address but origin is not. | ||
| isMember | A boolean signaling if the destination user has completed the membership process. | ||
| node | Details about the transaction destination node. |
There was a problem hiding this comment.
Same as above: these two would fit better if they started with "The foo".
5175c72 to
2359cf1Comparewaldyrious
commented
Sep 25, 2018
@rplopes sorry, I can't figure out what changed in your new commit :/ Can you clarify? |
@waldyrious only the ❯ git diff 5175c72 2359cf1
diff --git a/_entities.md b/_entities.md
index 3f83096..8e69ded 100644
--- a/_entities.md+++ b/_entities.md@@ -297,7 +297,7 @@ currency | The currency of the funds at the origin.
description | The name of the sender.
fee | The Bitcoin network Fee, if origin is in BTC but destination is not, or is a non-Uphold Bitcoin Address.
isMember | A boolean signaling if the origin user has completed the membership process.
-node | Details about the transaction origin node.+node | The details about the transaction origin node.
rate | The rate for conversion between origin and destination, as expressed in the currency at origin (the inverse of `destination.rate`).
sources | The transactions where the value was originated from (id and amount).
type | The type of endpoint. Possible values are 'card' and 'external'.
@@ -320,7 +320,7 @@ currency | The denomination of the funds at the time they were sent/received.
description | The name of the recipient. In the case where money is sent via email, the description will contain the email address of the recipient.
fee | The Bitcoin network Fee, if destination is a BTC address but origin is not.
isMember | A boolean signaling if the destination user has completed the membership process.
-node | Details about the transaction destination node.+node | The details about the transaction destination node.
rate | The rate for conversion between origin and destination, as expressed in the currency at destination (the inverse of `origin.rate`).
type | The type of endpoint. Possible values are 'email', 'card' and 'external'. |
application,network,priority,reference,fees.target,params.rate,params.type,normalized.fee,normalized.target,destination.isMember,destination.node,origin.isMemberandorigin.node