This repository was archived by the owner on Aug 23, 2020. It is now read-only.
Document dto #1143
Merged
Document dto #1143
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
src/main/java/com/iota/iri/service/dto/AttachToTangleResponse.java
Outdated
Show resolved
Hide resolved
alon-e
reviewed
Nov 13, 2018
src/main/java/com/iota/iri/service/dto/FindTransactionsResponse.java
Outdated
Show resolved
Hide resolved
src/main/java/com/iota/iri/service/dto/GetBalancesResponse.java
Outdated
Show resolved
Hide resolved
| * <li>numberOfAllTransactions</li> | ||
| * <li>numberOfRandomTransactionRequests</li> | ||
| * <li>numberOfNewTransactions</li> | ||
| * <li>numberOfInvalidTransactions</li> |
There was a problem hiding this comment.
there is now also a getNumberOfStaleTransactions :)
not sure it's worth maintaining a list here
There was a problem hiding this comment.
I think it is, this information is parsed by the doclet. Would be nice to see what a Neighbor actually includes in the documentation I think!
| private String coordinatorAddress; | ||
|
|
||
| /** |
Co-Authored-By: kwek20 <[email protected]>
Co-Authored-By: kwek20 <[email protected]>
jakubcech
reviewed
Nov 16, 2018
src/main/java/com/iota/iri/service/dto/GetNeighborsResponse.java
Outdated
Show resolved
Hide resolved
src/main/java/com/iota/iri/service/dto/GetNeighborsResponse.java
Outdated
Show resolved
Hide resolved
src/main/java/com/iota/iri/service/dto/GetNodeInfoResponse.java
Outdated
Show resolved
Hide resolved
src/main/java/com/iota/iri/service/dto/RemoveNeighborsResponse.java
Outdated
Show resolved
Hide resolved
src/main/java/com/iota/iri/service/dto/RemoveNeighborsResponse.java
Outdated
Show resolved
Hide resolved
jakubcech
reviewed
Nov 16, 2018
|
|
||
| /** | ||
| * The address of the Coordinator being followed by this node. | ||
| */ | ||
| private String coordinatorAddress; |
There was a problem hiding this comment.
The address of the coordinator whose transactions the node is approving.
or whose transactions the node accepts? 🤔 💭
jakubcech
approved these changes
Nov 16, 2018
DyrellC
pushed a commit
to DyrellC/iri
that referenced
this pull request
Nov 17, 2018
* DTO documented * Added javadoc to API * Updated DTO classes for better wording/grammar * Removed final, changed HashSet to Set and merged if statement * Fully documented all DTO * Changed see to @see * Changed approve to confirm Co-Authored-By: kwek20 <[email protected]> * Changed index to specific milestone index Co-Authored-By: kwek20 <[email protected]> * More feedback processed
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Updated documentation for the DTO classes
Should be merged after #1140, since this is based on that work.
Fixes #1114
Type of change
Checklist: