From 39d1590acee262ab1cb8126a3ccecb1354027390 Mon Sep 17 00:00:00 2001 From: CalDescent Date: Sat, 22 May 2021 14:16:14 +0100 Subject: [PATCH] Improved descriptions of the new API endpoints. --- .../org/qortal/api/resource/CrossChainHtlcResource.java | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/qortal/api/resource/CrossChainHtlcResource.java b/src/main/java/org/qortal/api/resource/CrossChainHtlcResource.java index a2dcd470..bbac65a4 100644 --- a/src/main/java/org/qortal/api/resource/CrossChainHtlcResource.java +++ b/src/main/java/org/qortal/api/resource/CrossChainHtlcResource.java @@ -224,7 +224,9 @@ public class CrossChainHtlcResource { @Path("/redeem/LITECOIN/{ataddress}") @Operation( summary = "Redeems HTLC associated with supplied AT", - description = "To be used by a seller (Bob) who needs to redeem LTC proceeds that are stuck in a P2SH.", + description = "To be used by a QORT seller (Bob) who needs to redeem LTC proceeds that are stuck in a P2SH.
" + + "This requires Bob's trade bot data to be present in the database for this AT.
" + + "It will fail if the buyer has yet to redeem the QORT held in the AT.", responses = { @ApiResponse( content = @Content(mediaType = MediaType.TEXT_PLAIN, schema = @Schema(type = "boolean")) @@ -359,6 +361,9 @@ public class CrossChainHtlcResource { @Path("/refund/LITECOIN/{ataddress}") @Operation( summary = "Refunds HTLC associated with supplied AT", + description = "To be used by a QORT buyer (Alice) who needs to refund their LTC that is stuck in a P2SH.
" + + "This requires Alice's trade bot data to be present in the database for this AT.
" + + "It will fail if it's already redeemed by the seller, or if the lockTime (60 minutes) hasn't passed yet.", responses = { @ApiResponse( content = @Content(mediaType = MediaType.TEXT_PLAIN, schema = @Schema(type = "boolean"))