From 834a0ce2fa1830824c8943c9e4c8cefba520b3f6 Mon Sep 17 00:00:00 2001 From: MDeLuise <66636702+MDeLuise@users.noreply.github.com> Date: Fri, 20 Dec 2024 14:04:34 +0100 Subject: [PATCH] improve(docs): improve descriptions for keystore management job steps --- .../DeviceKeystoreCertificateCreateJobStepDefinition.java | 4 ++-- .../DeviceKeystoreItemDeleteJobStepDefinition.java | 6 +++--- .../DeviceKeystoreKeypairCreateJobStepDefinition.java | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreCertificateCreateJobStepDefinition.java b/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreCertificateCreateJobStepDefinition.java index 59168816da8..7c03066228d 100644 --- a/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreCertificateCreateJobStepDefinition.java +++ b/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreCertificateCreateJobStepDefinition.java @@ -12,7 +12,6 @@ *******************************************************************************/ package org.eclipse.kapua.service.device.management.keystore.job.definition; -import com.beust.jcommander.internal.Lists; import org.eclipse.kapua.model.id.KapuaId; import org.eclipse.kapua.service.device.management.keystore.DeviceKeystoreManagementService; import org.eclipse.kapua.service.device.management.keystore.job.DeviceKeystoreCertificateCreateTargetProcessor; @@ -22,6 +21,7 @@ import org.eclipse.kapua.service.job.step.definition.JobStepPropertyRecord; import org.eclipse.kapua.service.job.step.definition.JobStepType; import org.eclipse.kapua.service.job.step.definition.device.management.TimeoutJobStepPropertyRecord; +import com.beust.jcommander.internal.Lists; /** * {@link JobStepDefinition} to perform {@link DeviceKeystoreManagementService#createKeystoreCertificate(KapuaId, KapuaId, DeviceKeystoreCertificate, Long)}. @@ -43,7 +43,7 @@ public DeviceKeystoreCertificateCreateJobStepDefinition() { Lists.newArrayList( new JobStepPropertyRecord( DeviceKeystoreCertificateCreatePropertyKeys.KEYSTORE_ID, - "Identifier of the device keystore where the certificate will be added", + "Identifier of the device keystore where the certificate will be added. The identifier can be found in the Key Stores view within the Device Overview page or can be retrieved via the REST API", String.class.getName(), null, "SSLKeystore", diff --git a/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreItemDeleteJobStepDefinition.java b/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreItemDeleteJobStepDefinition.java index c8c409d90aa..27c66b8be79 100644 --- a/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreItemDeleteJobStepDefinition.java +++ b/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreItemDeleteJobStepDefinition.java @@ -12,7 +12,6 @@ *******************************************************************************/ package org.eclipse.kapua.service.device.management.keystore.job.definition; -import com.beust.jcommander.internal.Lists; import org.eclipse.kapua.model.id.KapuaId; import org.eclipse.kapua.service.device.management.keystore.DeviceKeystoreManagementService; import org.eclipse.kapua.service.device.management.keystore.job.DeviceKeystoreItemDeleteTargetProcessor; @@ -21,6 +20,7 @@ import org.eclipse.kapua.service.job.step.definition.JobStepPropertyRecord; import org.eclipse.kapua.service.job.step.definition.JobStepType; import org.eclipse.kapua.service.job.step.definition.device.management.TimeoutJobStepPropertyRecord; +import com.beust.jcommander.internal.Lists; /** * {@link JobStepDefinition} to perform {@link DeviceKeystoreManagementService#deleteKeystoreItem(KapuaId, KapuaId, String, String, Long)} @@ -42,7 +42,7 @@ public DeviceKeystoreItemDeleteJobStepDefinition() { Lists.newArrayList( new JobStepPropertyRecord( DeviceKeystoreItemDeletePropertyKeys.KEYSTORE_ID, - "Identifier of the device keystore where the certificate will be removed", + "Identifier of the device keystore where the certificate will be removed. The identifier can be found in the Key Stores view within the Device Overview page or can be retrieved via the REST API", String.class.getName(), null, "SSLKeystore", @@ -55,7 +55,7 @@ public DeviceKeystoreItemDeleteJobStepDefinition() { null), new JobStepPropertyRecord( DeviceKeystoreItemDeletePropertyKeys.ALIAS, - "Alias of the certificate in the destination keystore", + "Alias of the certificate. The Alias can be found in the Key Stores view within the Device Overview page or can be retrieved via the REST API", String.class.getName(), null, "ssl-eclipse", diff --git a/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreKeypairCreateJobStepDefinition.java b/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreKeypairCreateJobStepDefinition.java index ddad9be0749..d4a6aae54f5 100644 --- a/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreKeypairCreateJobStepDefinition.java +++ b/service/device/management/keystore/job/src/main/java/org/eclipse/kapua/service/device/management/keystore/job/definition/DeviceKeystoreKeypairCreateJobStepDefinition.java @@ -12,7 +12,6 @@ *******************************************************************************/ package org.eclipse.kapua.service.device.management.keystore.job.definition; -import com.beust.jcommander.internal.Lists; import org.eclipse.kapua.model.id.KapuaId; import org.eclipse.kapua.service.device.management.keystore.DeviceKeystoreManagementService; import org.eclipse.kapua.service.device.management.keystore.job.DeviceKeystoreKeypairCreateTargetProcessor; @@ -22,6 +21,7 @@ import org.eclipse.kapua.service.job.step.definition.JobStepPropertyRecord; import org.eclipse.kapua.service.job.step.definition.JobStepType; import org.eclipse.kapua.service.job.step.definition.device.management.TimeoutJobStepPropertyRecord; +import com.beust.jcommander.internal.Lists; /** * {@link JobStepDefinition} to perform {@link DeviceKeystoreManagementService#createKeystoreKeypair(KapuaId, KapuaId, DeviceKeystoreKeypair, Long)} @@ -43,7 +43,7 @@ public DeviceKeystoreKeypairCreateJobStepDefinition() { Lists.newArrayList( new JobStepPropertyRecord( DeviceKeystoreKeypairCreatePropertyKeys.KEYSTORE_ID, - "Identifier of the device keystore where the certificate will be added", + "Identifier of the device keystore where the certificate will be added. The identifier can be found in the Key Stores view within the Device Overview page or can be retrieved via the REST API", String.class.getName(), null, "SSLKeystore",