Logging, validations and REST API documentation

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.NotEmpty;
 import lombok.Data;
 
 /**
@@ -28,7 +30,12 @@
 @Data
 public class CommitUpgradeRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotEmpty(message = "Activation ID must not be empty when commiting upgrade")
     private String activationId;
+
+    @Schema(description = "Application key")
+    @NotEmpty(message = "Application key must not be empty when commiting upgrade")
     private String applicationKey;
 
 }

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

@@ -31,7 +31,7 @@
 public class CreateIntegrationRequest {
 
     @Schema(description = "Integration name")
-    @NotBlank(message = "Integration name must not be empty when creating integration")
+    @NotBlank(message = "Integration name must not be empty when creating an integration")
     private String name;
 
 }

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

@@ -19,6 +19,9 @@
 package com.wultra.security.powerauth.client.model.request;
 
 import com.wultra.security.powerauth.client.model.enumeration.SignatureType;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
 import lombok.Data;
 import lombok.ToString;
 
@@ -30,16 +33,42 @@
 @Data
 public class CreateTokenRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when creating token")
     private String activationId;
+
+    @Schema(description = "Application key")
+    @NotBlank(message = "Application key must not be empty when creating token")
     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 token")
     private String ephemeralPublicKey;
+
+    @Schema(description = "Encrypted data used in encryption")
+    @NotBlank(message = "Encrypted data must not be empty when creating token")
     private String encryptedData;
+
+    @Schema(description = "Value of MAC used in encryption")
+    @NotBlank(message = "Value of MAC must not be empty when creating token")
     private String mac;
+
+    @Schema(description = "Activation nonce value")
     @ToString.Exclude
     private String nonce;
+
+    @Schema(description = "Signature type")
+    @NotNull(message = "Signature type must not be null when creating token")
     private SignatureType signatureType;
+
+    @Schema(description = "Cryptography protocol version")
+    @NotBlank(message = "Protocol must not be empty when creating token")
     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/GetCallbackUrlListRequest.java

@@ -31,7 +31,7 @@
 public class GetCallbackUrlListRequest {
 
     @Schema(description = "The identifier of the application")
-    @NotBlank(message = "Application ID must not be empty when creating a callback")
+    @NotBlank(message = "Application ID must not be empty when fetching callback list")
     private String applicationId;
 
 }

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

@@ -18,6 +18,7 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
 
 /**
@@ -28,6 +29,7 @@
 @Data
 public class GetErrorCodeListRequest {
 
+    @Schema(description = "ISO 639 language code")
     private String language;
 
 }

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

@@ -53,7 +53,7 @@ public class OperationApproveRequest {
     @NotBlank(message = "Data must not be empty when approving operation")
     private String data;
 
-    @Schema(description = "PowerAuth signature type")
+    @Schema(description = "Signature type")
     @NotNull(message = "Signature type must not be null when approving operation")
     private SignatureType signatureType;
 

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

@@ -77,7 +77,7 @@ public class RecoveryCodeActivationRequest {
     private String activationOtp;
 
     @Schema(description = "Cryptography protocol version")
-    @NotBlank(message = "Protocol version must not be empty when preparing activation")
+    @NotBlank(message = "Protocol version must not be empty when creating activation using recovery code")
     private String protocolVersion;
 
     @Schema(description = "Timestamp value used in encryption")

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

@@ -31,7 +31,7 @@
 public class RemoveIntegrationRequest {
 
     @Schema(description = "Integration identifier")
-    @NotBlank(message = "Integration identifier must not be empty when removing integration")
+    @NotBlank(message = "Integration identifier must not be empty when removing an integration")
     private String id;
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/RemoveTemporaryPublicKeyRequest.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 RemoveTemporaryPublicKeyRequest {
 
+    @Schema(description = "Temporary public key identifier")
+    @NotBlank(message = "Temporary public key identifier must not be empty when removing a temporary public key")
     private String id;
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/RemoveTokenRequest.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 RemoveTokenRequest {
 
+    @Schema(description = "Token identifier")
+    @NotBlank(message = "Token ID must not be empty when removing token")
     private String tokenId;
+
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when removing token")
     private String activationId;
 
 }

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

@@ -18,6 +18,10 @@
 
 package com.wultra.security.powerauth.client.model.request;
 
+import com.wultra.security.powerauth.client.model.enumeration.SignatureType;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
 import lombok.Data;
 import lombok.ToString;
 
@@ -29,15 +33,42 @@
 @Data
 public class StartUpgradeRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when starting upgrade")
     private String activationId;
+
+    @Schema(description = "Application key")
+    @NotBlank(message = "Application key must not be empty when starting upgrade")
     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 starting upgrade")
     private String ephemeralPublicKey;
+
+    @Schema(description = "Encrypted data used in encryption")
+    @NotBlank(message = "Encrypted data must not be empty when starting upgrade")
     private String encryptedData;
+
+    @Schema(description = "Value of MAC used in encryption")
+    @NotBlank(message = "Value of MAC must not be empty when starting upgrade")
     private String mac;
+
+    @Schema(description = "Activation nonce value")
     @ToString.Exclude
     private String nonce;
+
+    @Schema(description = "Signature type")
+    @NotNull(message = "Signature type must not be null when starting upgrade")
+    private SignatureType signatureType;
+
+    @Schema(description = "Cryptography protocol version")
+    @NotBlank(message = "Protocol must not be empty when starting upgrade")
     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/TelemetryReportRequest.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.Data;
 
@@ -32,8 +33,11 @@
 @Data
 public class TelemetryReportRequest {
 
-    @NotBlank
+    @Schema(description = "Telemetry report name")
+    @NotBlank(message = "Telemetry report name must not be empty when requesting telemetry report")
     private String name;
+
+    @Schema(description = "Telemetry report parameters")
     private Map<String, Object> parameters = new HashMap<>();
 
 }

powerauth-client-model/src/main/java/com/wultra/security/powerauth/client/model/request/TemporaryPublicKeyRequest.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 TemporaryPublicKeyRequest {
 
+    @Schema(description = "JWT claims for the temporary public key request")
+    @NotBlank(message = "Parameter jwt must not be empty when requesting temporary public key")
     private String jwt;
 
 }

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

@@ -56,7 +56,7 @@ public class UpdateCallbackUrlRequest {
     private CallbackUrlType type;
 
     @Schema(description = "Callback URL")
-    @NotBlank(message = "Callback URL must not be empty when creating a callback")
+    @NotBlank(message = "Callback URL must not be empty when updating a callback")
     private String callbackUrl;
 
     @Schema(description = "Callback attributes")

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

@@ -18,7 +18,10 @@
 
 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.NotNull;
+import jakarta.validation.constraints.Positive;
 import lombok.Data;
 import lombok.ToString;
 
@@ -30,21 +33,27 @@
 @Data
 public class ValidateTokenRequest {
 
-    @NotNull
+    @Schema(description = "Token identifier")
+    @NotBlank(message = "Token ID must not be empty when validating token")
     private String tokenId;
 
     @ToString.Exclude
-    @NotNull
+    @Schema(description = "Token digest")
+    @NotBlank(message = "Token digest must not be empty when validating token")
     private String tokenDigest;
 
-    @NotNull
+    @Schema(description = "Nonce")
+    @NotBlank(message = "Parameter nonce must not be empty when validating token")
     @ToString.Exclude
     private String nonce;
 
-    @NotNull
+    @Schema(description = "Cryptography protocol version")
+    @NotBlank(message = "Protocol version must not be empty when validating token")
     private String protocolVersion;
 
-    @NotNull
+    @Schema(description = "Timestamp")
+    @NotNull(message = "Timestamp must not be null when validating token")
+    @Positive(message = "Invalid timestamp value when validating token")
     private long timestamp;
 
 }

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

@@ -19,6 +19,9 @@
 package com.wultra.security.powerauth.client.model.request;
 
 import com.wultra.security.powerauth.client.model.enumeration.SignatureType;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
 import lombok.Data;
 import lombok.ToString;
 
@@ -30,19 +33,59 @@
 @Data
 public class VaultUnlockRequest {
 
+    @Schema(description = "Activation identifier")
+    @NotBlank(message = "Activation ID must not be empty when unlocking vault")
     private String activationId;
+
+    @Schema(description = "Application key")
+    @NotBlank(message = "Application key must not be empty when unlocking vault")
     private String applicationKey;
+
+    @Schema(description = "Signed data")
+    @NotBlank(message = "Signed data must not be empty when unlocking vault")
     private String signedData;
+
+    @Schema(description = "Signature")
+    @NotBlank(message = "Signature must not be empty when unlocking vault")
     @ToString.Exclude
     private String signature;
+
+    @Schema(description = "Signature type")
+    @NotNull(message = "Signature type must not be empty when unlocking vault")
     private SignatureType signatureType;
+
+    @Schema(description = "Signature version")
+    @NotNull(message = "Signature version must not be empty when unlocking vault")
     private String signatureVersion;
+
+    @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 unlocking vault")
     private String ephemeralPublicKey;
+
+    @Schema(description = "Encrypted data used in encryption")
+    @NotBlank(message = "Encrypted data must not be empty when unlocking vault")
     private String encryptedData;
+
+    @Schema(description = "Value of MAC used in encryption")
+    @NotBlank(message = "Value of MAC must not be empty when unlocking vault")
     private String mac;
+
+    @Schema(description = "Activation 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 unlocking vault")
+    private String protocolVersion;
+
+    @Schema(description = "Timestamp value used in encryption")
     private Long timestamp;
 
 }