From 5040894bdbb649dd187d4eda312138c3a63f4e4e Mon Sep 17 00:00:00 2001 From: KtorZ Date: Mon, 25 May 2020 14:52:48 +0200 Subject: [PATCH] clarify migrate endpoint end-user documentation The sense of 'migrate' seemed unclear to people. So this attempts to give more precisions about what it really is about. The same description should be copied over for the Shelley equivalent. --- specifications/api/swagger.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/specifications/api/swagger.yaml b/specifications/api/swagger.yaml index 273622b61b0..1211b84f0b6 100644 --- a/specifications/api/swagger.yaml +++ b/specifications/api/swagger.yaml @@ -2180,7 +2180,12 @@ paths: description: |

status: stable

- Migrate all funds from a Byron wallet to set of addresses. + Create one or several transactions sending all funds from a Byron 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). + + A typical usage would be when one wants to move all funds from an old wallet to another (Shelley + or Byron) by providing addresses coming from the new wallet. parameters: - <<: *parametersWalletId name: walletId