Qortal/qortal
Qortal/qortal
3
0
Fork 3
mirror of https://github.com/Qortal/qortal.git synced 2025-02-12 02:05:50 +00:00
Code Issues Projects Releases Wiki Activity

Improved descriptions of the new API endpoints.

Browse Source
This commit is contained in:
CalDescent 2021-05-22 14:16:14 +01:00
parent 0b36b650a4
commit 39d1590ace
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/main/java/org/qortal/api/resource/CrossChainHtlcResource.java
View File

@ -224,7 +224,9 @@ public class CrossChainHtlcResource {
@Path("/redeem/LITECOIN/{ataddress}") @Path("/redeem/LITECOIN/{ataddress}")
@Operation( @Operation(
summary = "Redeems HTLC associated with supplied AT", 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.<br>" +
"This requires Bob's trade bot data to be present in the database for this AT.<br>" +
"It will fail if the buyer has yet to redeem the QORT held in the AT.",
responses = { responses = {
@ApiResponse( @ApiResponse(
content = @Content(mediaType = MediaType.TEXT_PLAIN, schema = @Schema(type = "boolean")) content = @Content(mediaType = MediaType.TEXT_PLAIN, schema = @Schema(type = "boolean"))
@ -359,6 +361,9 @@ public class CrossChainHtlcResource {
@Path("/refund/LITECOIN/{ataddress}") @Path("/refund/LITECOIN/{ataddress}")
@Operation( @Operation(
summary = "Refunds HTLC associated with supplied AT", 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.<br>" +
"This requires Alice's trade bot data to be present in the database for this AT.<br>" +
"It will fail if it's already redeemed by the seller, or if the lockTime (60 minutes) hasn't passed yet.",
responses = { responses = {
@ApiResponse( @ApiResponse(
content = @Content(mediaType = MediaType.TEXT_PLAIN, schema = @Schema(type = "boolean")) content = @Content(mediaType = MediaType.TEXT_PLAIN, schema = @Schema(type = "boolean"))