lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

improved documentation of ddi-rootcontroller resource's links list (#887)

Browse Source 
* improved documentation of ddi-rootcontroller resource's links list
* fixed review comments
* improved formatting

Signed-off-by: Robert Sing <Robert.Sing@bosch-si.com>
This commit is contained in:
Robert Sing
2019-10-18 09:32:08 +02:00
committed by Stefan Behl
parent ed0f56d0a3
commit b4025f9c27
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/rootcontroller-api-guide.adoc
View File

@@ -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

4
hawkbit-rest/hawkbit-rest-docs/src/test/java/org/eclipse/hawkbit/rest/ddi/documentation/DdiApiModelProperties.java
View File

@@ -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";