Document that sendMessage can return 428

2024-10-24 10:00:07 -07:00 · 2024-10-24 10:00:07 -07:00 · ccdbec088f
parent 9822d17ab9
commit ccdbec088f
1 changed files with 3 additions and 0 deletions
--- a/service/src/main/java/org/whispersystems/textsecuregcm/controllers/MessageController.java
+++ b/service/src/main/java/org/whispersystems/textsecuregcm/controllers/MessageController.java
@ -272,6 +272,9 @@ public class MessageController {
  @ApiResponse(
      responseCode = "410", description = "Mismatched registration ids supplied for some recipient devices",
      content = @Content(schema = @Schema(implementation = AccountStaleDevices[].class)))
+  @ApiResponse(
+      responseCode="428",
+      description="The sender should complete a challenge before proceeding")
  public Response sendMessage(@ReadOnly @Auth final Optional<AuthenticatedDevice> source,
      @Parameter(description="The recipient's unidentified access key")
      @HeaderParam(HeaderUtils.UNIDENTIFIED_ACCESS_KEY) final Optional<Anonymous> accessKey,