From b4025f9c27946d16bc417ae885439f379750fa22 Mon Sep 17 00:00:00 2001 From: Robert Sing <50371841+singrob@users.noreply.github.com> Date: Fri, 18 Oct 2019 09:32:08 +0200 Subject: [PATCH] improved documentation of ddi-rootcontroller resource's links list (#887) * improved documentation of ddi-rootcontroller resource's links list * fixed review comments * improved formatting Signed-off-by: Robert Sing --- .../src/main/asciidoc/rootcontroller-api-guide.adoc | 2 +- .../hawkbit/rest/ddi/documentation/DdiApiModelProperties.java | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/rootcontroller-api-guide.adoc b/hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/rootcontroller-api-guide.adoc index 7204599e4..238a89fe6 100644 --- a/hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/rootcontroller-api-guide.adoc +++ b/hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/rootcontroller-api-guide.adoc @@ -15,7 +15,7 @@ toc::[] === Implementation notes -This base resource can be regularly polled by the controller on the provisioning target or device in order to retrieve actions that need to be executed. Those are provided as a list of links to more detailed information about the action. The resource supports Etag based modification checks in order to save traffic. Note: deployments have to be confirmed in order to move on to the next action. Cancellations have to be confirmed or rejected. +This base resource can be regularly polled by the controller on the provisioning target or device in order to retrieve actions that need to be executed. Those are provided as a list of links to give more detailed information about the action. Links are only available for initial configuration or open actions, respectively. The resource supports Etag based modification checks in order to save traffic. Note: deployments have to be confirmed in order to move on to the next action. Cancellations have to be confirmed or rejected. === Controller base poll resource diff --git a/hawkbit-rest/hawkbit-rest-docs/src/test/java/org/eclipse/hawkbit/rest/ddi/documentation/DdiApiModelProperties.java b/hawkbit-rest/hawkbit-rest-docs/src/test/java/org/eclipse/hawkbit/rest/ddi/documentation/DdiApiModelProperties.java index b6c22b782..adc842c90 100644 --- a/hawkbit-rest/hawkbit-rest-docs/src/test/java/org/eclipse/hawkbit/rest/ddi/documentation/DdiApiModelProperties.java +++ b/hawkbit-rest/hawkbit-rest-docs/src/test/java/org/eclipse/hawkbit/rest/ddi/documentation/DdiApiModelProperties.java @@ -108,7 +108,9 @@ final class DdiApiModelProperties { static final String FILENAME = "file name of artifact"; - static final String TARGET_CONFIG_DATA = "configuration data as key/value list"; + static final String TARGET_CONFIG_DATA = "Link which is provided whenever the provisioning target or device is supposed " + + "to push its configuration data (aka. \"controller attributes\") to the server. Only shown for the initial " + + "configuration, after a successful update action, or if requested explicitly (e.g. via the management UI)."; static final String ARTIFACT_HASHES_SHA1 = "SHA1 hash of the artifact in Base 16 format"; static final String ARTIFACT_HASHES_MD5 = "MD5 hash of the artifact";