Improve logging, validations and documentation for operations controller

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/ActivationHistoryRequest.java

@@ -18,6 +18,8 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
 import lombok.Data;
 
 import java.util.Date;
@@ -30,8 +32,14 @@
 @Data
 public class ActivationHistoryRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when requesting activation history")
     private String activationId;
+
+    @Schema(description = "Timestamp from used for timestamp filter")
     private Date timestampFrom;
+
+    @Schema(description = "Timestamp to used for timestamp filter")
     private Date timestampTo;
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/AddActivationFlagsRequest.java

@@ -18,6 +18,9 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotEmpty;
 import lombok.Data;
 
 import java.util.ArrayList;
@@ -31,7 +34,12 @@
 @Data
 public class AddActivationFlagsRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when adding activation flags")
     private String activationId;
-    private List<String> activationFlags = new ArrayList<>();
+
+    @Schema(description = "List of activation flags")
+    @NotEmpty(message = "List of activation flags must not be empty when adding activation flags")
+    private List<@NotBlank String> activationFlags = new ArrayList<>();
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/AddApplicationRolesRequest.java

@@ -18,6 +18,9 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotEmpty;
 import lombok.Data;
 
 import java.util.ArrayList;
@@ -31,7 +34,12 @@
 @Data
 public class AddApplicationRolesRequest {
 
+    @Schema(description = "The identifier of the application")
+    @NotBlank(message = "Application ID must not be empty when adding application roles")
     private String applicationId;
-    private List<String> applicationRoles = new ArrayList<>();
+
+    @Schema(description = "Application roles")
+    @NotEmpty(message = "List of application roles must not be empty when adding application roles")
+    private List<@NotBlank String> applicationRoles = new ArrayList<>();
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/BlockActivationRequest.java

@@ -18,6 +18,8 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
 import lombok.Data;
 
 /**
@@ -28,8 +30,14 @@
 @Data
 public class BlockActivationRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when blocking activation")
     private String activationId;
+
+    @Schema(description = "Reason why activation was blocked")
     private String reason;
+
+    @Schema(description = "External user identifier")
     private String externalUserId;
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/CommitActivationRequest.java

@@ -18,6 +18,8 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
 import lombok.Data;
 import lombok.ToString;
 
@@ -29,8 +31,14 @@
 @Data
 public class CommitActivationRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when commiting activation")
     private String activationId;
+
+    @Schema(description = "External user identifier")
     private String externalUserId;
+
+    @Schema(description = "Activation OTP value")
     @ToString.Exclude
     private String activationOtp;
 

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/CommitUpgradeRequest.java

@@ -18,6 +18,8 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
 import lombok.Data;
 
 /**
@@ -28,7 +30,12 @@
 @Data
 public class CommitUpgradeRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when committing upgrade")
     private String activationId;
+
+    @Schema(description = "Application key")
+    @NotBlank(message = "Application key must not be empty when committing upgrade")
     private String applicationKey;
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/ConfirmRecoveryCodeRequest.java

@@ -18,6 +18,8 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
 import lombok.Data;
 import lombok.ToString;
 
@@ -29,15 +31,38 @@
 @Data
 public class ConfirmRecoveryCodeRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when confirming recovery code")
     private String activationId;
+
+    @Schema(description = "Application key")
+    @NotBlank(message = "Application key must not be empty when confirming recovery code")
     private String applicationKey;
+
+    @Schema(description = "Identifier of the temporary key for encryption")
     private String temporaryKeyId;
+
+    @Schema(description = "Ephemeral public key used in encryption")
+    @NotBlank(message = "Ephemeral public key must not be empty when confirming recovery code")
     private String ephemeralPublicKey;
+
+    @Schema(description = "Encrypted data used in encryption")
+    @NotBlank(message = "Encrypted data must not be empty when confirming recovery code")
     private String encryptedData;
+
+    @Schema(description = "Value of MAC used in encryption")
+    @NotBlank(message = "Value of MAC must not be empty when confirming recovery code")
     private String mac;
+
+    @Schema(description = "Nonce value")
     @ToString.Exclude
     private String nonce;
-    private Long timestamp;
+
+    @Schema(description = "Cryptography protocol version")
+    @NotBlank(message = "Protocol must not be empty when confirming recovery code")
     private String protocolVersion;
 
+    @Schema(description = "Timestamp value used in encryption")
+    private Long timestamp;
+
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/CreateActivationRequest.java

@@ -18,6 +18,10 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.Future;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.Positive;
 import lombok.Data;
 import lombok.ToString;
 
@@ -31,20 +35,53 @@
 @Data
 public class CreateActivationRequest {
 
+    @Schema(description = "The identifier of the user")
+    @NotBlank(message = "User ID must not be empty when creating activation")
     private String userId;
+
+    @Schema(description = "Timestamp of activation expiration")
+    @Future(message = "The activation expiration timestamp must be in the future when creating activation")
     private Date timestampActivationExpire;
+
+    @Schema(description = "Whether recovery codes should be generated")
     private boolean generateRecoveryCodes = true;
+
+    @Schema(description = "Maximum number of failures for the activation")
+    @Positive(message = "Maximum failure count must be positive when creating activation")
     private Long maxFailureCount;
+
+    @Schema(description = "Application key")
+    @NotBlank(message = "Application key must not be empty when creating activation")
     private String applicationKey;
+
+    @Schema(description = "Identifier of the temporary key for encryption")
     private String temporaryKeyId;
+
+    @Schema(description = "Ephemeral public key used in encryption")
+    @NotBlank(message = "Ephemeral public key must not be empty when creating activation")
     private String ephemeralPublicKey;
+
+    @Schema(description = "Encrypted data used in encryption")
+    @NotBlank(message = "Encrypted data must not be empty when creating activation")
     private String encryptedData;
+
+    @Schema(description = "Value of MAC used in encryption")
+    @NotBlank(message = "Value of MAC must not be empty when creating activation")
     private String mac;
+
+    @Schema(description = "Nonce value")
     @ToString.Exclude
     private String nonce;
+
+    @Schema(description = "Activation OTP value")
     @ToString.Exclude
     private String activationOtp;
+
+    @Schema(description = "Cryptography protocol version")
+    @NotBlank(message = "Protocol must not be empty when creating activation")
     private String protocolVersion;
+
+    @Schema(description = "Timestamp value used in encryption")
     private Long timestamp;
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/CreateApplicationConfigRequest.java

@@ -18,6 +18,7 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import jakarta.validation.constraints.NotBlank;
 import lombok.AllArgsConstructor;
 import lombok.Data;
@@ -36,12 +37,15 @@
 @NoArgsConstructor
 public class CreateApplicationConfigRequest {
 
-    @NotBlank
+    @Schema(description = "The identifier of the application")
+    @NotBlank(message = "Application ID must not be empty when creating an application configuration")
     private String applicationId;
 
-    @NotBlank
+    @Schema(description = "The configuration key")
+    @NotBlank(message = "The configuration key must not be empty when creating an application configuration")
     private String key;
 
+    @Schema(description = "The configuration values")
     private List<Object> values = new ArrayList<>();
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/CreateApplicationRequest.java

@@ -18,6 +18,8 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
 import lombok.Data;
 
 /**
@@ -28,6 +30,8 @@
 @Data
 public class CreateApplicationRequest {
 
+    @Schema(description = "The identifier of the application")
+    @NotBlank(message = "Application ID must not be empty when creating an application")
     private String applicationId;
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/CreateApplicationVersionRequest.java

@@ -18,6 +18,8 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
 import lombok.Data;
 
 /**
@@ -28,7 +30,12 @@
 @Data
 public class CreateApplicationVersionRequest {
 
+    @Schema(description = "The identifier of the application")
+    @NotBlank(message = "Application ID must not be empty when creating application version")
     private String applicationId;
+
+    @Schema(description = "The identifier of the application version")
+    @NotBlank(message = "Application version ID must not be empty when creating application version")
     private String applicationVersionId;
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/CreateCallbackUrlRequest.java

@@ -39,31 +39,38 @@
 @Data
 public class CreateCallbackUrlRequest {
 
-    @NotBlank
+    @Schema(description = "The identifier of the application")
+    @NotBlank(message = "Application ID must not be empty when creating a callback")
     private String applicationId;
 
-    @NotBlank
+    @Schema(description = "Callback name")
+    @NotBlank(message = "Callback name must not be empty when creating a callback")
     private String name;
 
-    @NotNull
+    @Schema(description = "Callback type")
+    @NotNull(message = "Callback type must not be null when creating a callback")
     private CallbackUrlType type;
 
-    @NotBlank
+    @Schema(description = "Callback URL")
+    @NotBlank(message = "Callback URL must not be empty when creating a callback")
     private String callbackUrl;
 
-    private List<String> attributes = new ArrayList<>();
+    @Schema(description = "Callback attributes")
+    private List<@NotBlank String> attributes = new ArrayList<>();
+
+    @Schema(description = "Callback authentication")
     private HttpAuthenticationPrivate authentication = new HttpAuthenticationPrivate();
 
     @DurationMin(message = "Duration must be positive or zero")
-    @Schema(type = "string", format = "ISO 8601 Duration", example = "P30D")
+    @Schema(description = "Callback retention period", type = "string", format = "ISO 8601 Duration", example = "P30D")
     private Duration retentionPeriod;
 
     @DurationMin(message = "Duration must be positive or zero")
-    @Schema(type = "string", format = "ISO 8601 Duration", example = "PT2.5S")
+    @Schema(description = "Initial backoff time for the callback", type = "string", format = "ISO 8601 Duration", example = "PT2.5S")
     private Duration initialBackoff;
 
     @Min(1)
-    @Schema(type = "integer", example = "1")
+    @Schema(description = "Maximum attempts for executing the callback", type = "integer", example = "1")
     private Integer maxAttempts;
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/CreateIntegrationRequest.java

@@ -18,6 +18,8 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
 import lombok.Data;
 
 /**
@@ -28,6 +30,8 @@
 @Data
 public class CreateIntegrationRequest {
 
+    @Schema(description = "Integration name")
+    @NotBlank(message = "Integration name must not be empty when creating an integration")
     private String name;
 
 }