Skip to content

Commit

Permalink
docs: Merge #2644
Browse files Browse the repository at this point in the history
2644: Connect API with migration algorithm r=jonathanknowles a=jonathanknowles

# Issue Number

ADP-840

# Overview

This PR:

- [x] Implements `Api.Server.createWalletMigrationPlan`.
- [x] Implements `Api.Server.migrateWallet`.
- [x] Adjusts `migrateWallet` to require a non-empty list of addresses.
- [x] Adjusts the success response types for all migration endpoints to be `202` `ACCEPTED`.
- [x] Resurrects all previously-disabled integration tests (for ada-specific wallets).
- [x] Removes the "disabled" warnings on migration endpoints.
- [x] Adds integration test coverage for MA wallets.

# QA Due Diligence

After rewriting the integration test suite, I ran the entire integration test suite 500 times in an effort to increase confidence that there are no flaky tests. The test suite passed 500 times, with no failures or errors.

Co-authored-by: Jonathan Knowles <jonathan.knowles@iohk.io> a60199f
  • Loading branch information
William King Noel Bot committed May 15, 2021
1 parent 1bb16b2 commit 6e1f699
Showing 1 changed file with 5 additions and 12 deletions.
17 changes: 5 additions & 12 deletions api/edge/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3686,8 +3686,8 @@ x-responsesCreateWalletMigrationPlan: &responsesCreateWalletMigrationPlan
schema: *errNothingToMigrate
<<: *responsesErr404WalletNotFound
<<: *responsesErr406
200:
description: Ok
202:
description: Accepted
content:
application/json:
schema: *ApiWalletMigrationPlan
Expand All @@ -3705,13 +3705,14 @@ x-responsesMigrateWallet: &responsesMigrateWallet
<<: *responsesErr404WalletNotFound
<<: *responsesErr406
<<: *responsesErr415UnsupportedMediaType
200:
description: Ok
202:
description: Accepted
content:
application/json:
schema:
type: array
items: *ApiTransaction
minItems: 1

x-responsesDeleteWallet: &responsesDeleteWallet
<<: *responsesErr400
Expand Down Expand Up @@ -4656,10 +4657,6 @@ paths:
tags: ["Migrations"]
summary: Migrate
description: |
<p align="right">status: <strong>disabled</strong></p>
<strong>⚠️IMPORTANT⚠️</strong> This endpoint has been temporarily disabled with the introduction of multi-assets UTxO. It will be enabled again soon.
<hr/>
Migrate the UTxO balance of this wallet to the given set of addresses.
This operation will attempt to transfer as much of the wallet's balance
Expand Down Expand Up @@ -4694,10 +4691,6 @@ paths:
tags: ["Migrations"]
summary: Create a migration plan
description: |
<p align="right">status: <strong>disabled</strong></p>
<strong>⚠️IMPORTANT⚠️</strong> This endpoint has been temporarily disabled with the introduction of multi-assets UTxO. It will be enabled again soon.
<hr/>
Generate a plan for migrating the UTxO balance of this wallet to
another wallet, without executing the plan.
Expand Down

0 comments on commit 6e1f699

Please sign in to comment.