Set DdiActionFeedback ID deprecated (#1091)

* Deprecate DdiActionFeedback ID

Signed-off-by: Florian Ruschbaschan <Florian.Ruschbaschan@bosch.io>

* Add deprecation to FEEDBACK_ACTION_ID in docu

Signed-off-by: Florian Ruschbaschan <Florian.Ruschbaschan@bosch.io>
This commit is contained in:
Florian Ruschbaschan
2021-06-11 13:56:23 +02:00
committed by GitHub
parent f19c3e5ff6
commit bacd72f40c
5 changed files with 13 additions and 31 deletions

View File

@@ -26,7 +26,7 @@ final class DdiApiModelProperties {
static final String TARGET_RESULT_FINISHED = "defined status of the result";
static final String TARGET_RESULT_PROGRESS = "progress assumption of the device";
static final String TARGET_RESULT_PROGRESS = "progress assumption of the device (currently not supported).";
static final String TARGET_PROGRESS_CNT = "current progress level";
@@ -34,6 +34,8 @@ final class DdiApiModelProperties {
static final String ACTION_ID = "id of the action";
static final String FEEDBACK_ACTION_ID = "(@deprecated) id of the action";
static final String CANCEL_ACTION = "action that needs to be canceled";
static final String ACTION_ID_CANCELED = "id of the action that needs to be canceled (typically identical to id field on the cancel action itself)";

View File

@@ -183,7 +183,7 @@ public class RootControllerDocumentationTest extends AbstractApiRestDocumentatio
pathParameters(parameterWithName("tenant").description(ApiModelPropertiesGeneric.TENANT),
parameterWithName("controllerId").description(DdiApiModelProperties.CONTROLLER_ID),
parameterWithName("actionId").description(DdiApiModelProperties.ACTION_ID_CANCELED)),
requestFields(optionalRequestFieldWithPath("id").description(DdiApiModelProperties.ACTION_ID),
requestFields(optionalRequestFieldWithPath("id").description(DdiApiModelProperties.FEEDBACK_ACTION_ID),
requestFieldWithPath("status").description(DdiApiModelProperties.TARGET_STATUS),
requestFieldWithPath("status.execution")
.description(DdiApiModelProperties.TARGET_EXEC_STATUS).type("enum")
@@ -386,7 +386,7 @@ public class RootControllerDocumentationTest extends AbstractApiRestDocumentatio
parameterWithName("controllerId").description(DdiApiModelProperties.CONTROLLER_ID),
parameterWithName("actionId").description(DdiApiModelProperties.ACTION_ID)),
requestFields(optionalRequestFieldWithPath("id").description(DdiApiModelProperties.ACTION_ID),
requestFields(optionalRequestFieldWithPath("id").description(DdiApiModelProperties.FEEDBACK_ACTION_ID),
requestFieldWithPath("status").description(DdiApiModelProperties.TARGET_STATUS),
requestFieldWithPath("status.execution")
.description(DdiApiModelProperties.TARGET_EXEC_STATUS).type("enum")