Display Shelley migrations in Api doc #1687
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
piotr-iohk
added
the
RESOLVING ISSUE
piotr-iohk
commented
May 26, 2020
| @@ -1660,6 +1660,7 @@ x-tagGroups: | |||
| - Addresses | |||
| - Coin Selections | |||
| - Transactions | |||
| - Migrations | |||
There was a problem hiding this comment.
Shelley migrations were not displayed in api doc because of this 👆
piotr-iohk
force-pushed
the
piotr/fix_migration_shelley_spec
branch
from
2488641 to
1867266
Compare
specifications/api/swagger.yaml
Outdated
|
|
||
| Migrate all funds from a Shelley wallet to a specified set of addresses. | ||
| Create one or several transactions sending all funds from a Shelley wallet to set of addresses. | ||
| This operation tries to preserve as much as possible the current UTxO shape of a wallet (hence | ||
| why several transactions may be needed). |
There was a problem hiding this comment.
I wonder whether word why is needed here 🤔 @rvl / @jonathanknowles could you voice your opinion?
There was a problem hiding this comment.
How about this
Submit one or more transactions which transfers all funds from a Shelley wallet to a set of addresses.
This operation attempts to preserve the UTxO "shape" of a wallet as far as possible. That is, coins will not be agglomerated.
Therefore, if the wallet has a large UTxO set, several transactions may be needed.
There was a problem hiding this comment.
Reworded in 508e41b.
paweljakubas
approved these changes
May 26, 2020
|
bors r+ |
Build succeeded |
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.
Issue Number
#1675
Overview
1867266
Display Shelley migrations in swagger spec.
508e41b
Reword migration description according to review suggestions
Comments
Shelley migrations, although included in
swagger.yaml, were not being displayed in the API doc. This pr fixes this. Also includes minor rewording of the migration endpoints descriptions.