Fix API docs
Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>
diff --git a/rest-api/distributionsets-api-guide/index.html b/rest-api/distributionsets-api-guide/index.html
index 60019d0..b36c98d 100644
--- a/rest-api/distributionsets-api-guide/index.html
+++ b/rest-api/distributionsets-api-guide/index.html
@@ -455,26 +455,64 @@
<h3 id="_get_paged_list_of_distribution_sets"><a class="link" href="#_get_paged_list_of_distribution_sets">Get paged list of Distribution Sets</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-sets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url"><a class="link" href="#_request_url">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-sets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-sets-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_example"><a class="link" href="#_request_query_parameter_example">Request query parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-sets-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets?offset=1&limit=2&sort=version%3ADESC&q=name%3D%3DtestDS* HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -482,14 +520,199 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-sets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of distribution sets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True of the distribution set software module setup is complete as defined by the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-sets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 2367
+Content-Type: application/json;charset=UTF-8
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644421708,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644421711,
+ "name" : "DS",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644421701,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644421715,
+ "name" : "Firmware",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.99",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/202"
+ }
+ },
+ "id" : 202
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644421698,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644421713,
+ "name" : "app runtime",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.78",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/201"
+ }
+ },
+ "id" : 201
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644421695,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644421717,
+ "name" : "application",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.19",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/200"
+ }
+ },
+ "id" : 200
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/65"
+ }
+ },
+ "id" : 65
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -557,35 +780,416 @@
<h3 id="_create_distribution_sets"><a class="link" href="#_create_distribution_sets">Create Distribution Sets</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-distribution-sets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "requiredMigrationStep" : false,
+ "name" : "one",
+ "description" : "per maecenas sociis suspendisse sed elementum aliquet non turpis fringilla",
+ "type" : "test_default_ds_type",
+ "version" : "one",
+ "modules" : [ {
+ "id" : 199
+ }, {
+ "id" : 198
+ } ]
+}, {
+ "requiredMigrationStep" : false,
+ "name" : "two",
+ "description" : "curabitur interdum tellus nullam aptent dapibus aptent pretium natoque turpis",
+ "type" : "test_default_ds_type",
+ "version" : "two",
+ "modules" : [ {
+ "id" : 199
+ }, {
+ "id" : 198
+ } ]
+}, {
+ "requiredMigrationStep" : true,
+ "name" : "three",
+ "description" : "lobortis penatibus dui nisl fusce risus molestie elit blandit dapibus",
+ "type" : "test_default_ds_type",
+ "version" : "three",
+ "modules" : [ {
+ "id" : 199
+ }, {
+ "id" : 198
+ } ]
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-distribution-sets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsets/ HTTP/1.1
+Content-Length: 816
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "requiredMigrationStep" : false,
+ "name" : "one",
+ "description" : "per maecenas sociis suspendisse sed elementum aliquet non turpis fringilla",
+ "type" : "test_default_ds_type",
+ "version" : "one",
+ "modules" : [ {
+ "id" : 199
+ }, {
+ "id" : 198
+ } ]
+}, {
+ "requiredMigrationStep" : false,
+ "name" : "two",
+ "description" : "curabitur interdum tellus nullam aptent dapibus aptent pretium natoque turpis",
+ "type" : "test_default_ds_type",
+ "version" : "two",
+ "modules" : [ {
+ "id" : 199
+ }, {
+ "id" : 198
+ } ]
+}, {
+ "requiredMigrationStep" : true,
+ "name" : "three",
+ "description" : "lobortis penatibus dui nisl fusce risus molestie elit blandit dapibus",
+ "type" : "test_default_ds_type",
+ "version" : "three",
+ "modules" : [ {
+ "id" : 199
+ }, {
+ "id" : 198
+ } ]
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-distribution-sets/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-distribution-sets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True of the distribution set software module setup is complete as defined by the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-distribution-sets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Length: 4626
+Content-Type: application/hal+json;charset=UTF-8
+
+[ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644416622,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644416622,
+ "name" : "one",
+ "description" : "per maecenas sociis suspendisse sed elementum aliquet non turpis fringilla",
+ "version" : "one",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644416599,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644416599,
+ "name" : "os",
+ "description" : "dictumst eu ligula cursus nisi eleifend tortor vestibulum quam odio",
+ "version" : "1.0",
+ "type" : "os",
+ "vendor" : "Vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/199"
+ }
+ },
+ "id" : 199
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644416596,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644416596,
+ "name" : "application",
+ "description" : "in porta sagittis augue congue lobortis ut orci tortor integer",
+ "version" : "1.0",
+ "type" : "application",
+ "vendor" : "Vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/198"
+ }
+ },
+ "id" : 198
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/64"
+ }
+ },
+ "id" : 64
+}, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644416624,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644416624,
+ "name" : "two",
+ "description" : "curabitur interdum tellus nullam aptent dapibus aptent pretium natoque turpis",
+ "version" : "two",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644416599,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644416599,
+ "name" : "os",
+ "description" : "dictumst eu ligula cursus nisi eleifend tortor vestibulum quam odio",
+ "version" : "1.0",
+ "type" : "os",
+ "vendor" : "Vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/199"
+ }
+ },
+ "id" : 199
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644416596,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644416596,
+ "name" : "application",
+ "description" : "in porta sagittis augue congue lobortis ut orci tortor integer",
+ "version" : "1.0",
+ "type" : "application",
+ "vendor" : "Vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/198"
+ }
+ },
+ "id" : 198
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/62"
+ }
+ },
+ "id" : 62
+}, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644416626,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644416626,
+ "name" : "three",
+ "description" : "lobortis penatibus dui nisl fusce risus molestie elit blandit dapibus",
+ "version" : "three",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644416599,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644416599,
+ "name" : "os",
+ "description" : "dictumst eu ligula cursus nisi eleifend tortor vestibulum quam odio",
+ "version" : "1.0",
+ "type" : "os",
+ "vendor" : "Vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/199"
+ }
+ },
+ "id" : 199
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644416596,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644416596,
+ "name" : "application",
+ "description" : "in porta sagittis augue congue lobortis ut orci tortor integer",
+ "version" : "1.0",
+ "type" : "application",
+ "vendor" : "Vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/198"
+ }
+ },
+ "id" : 198
+ } ],
+ "requiredMigrationStep" : true,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/63"
+ }
+ },
+ "id" : 63
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -663,29 +1267,51 @@
<h3 id="_delete_distribution_set"><a class="link" href="#_delete_distribution_set">Delete Distribution Set</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-distribution-set/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/47' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-distribution-set/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/distributionsets/47 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-distribution-set/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-distribution-set/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -758,35 +1384,249 @@
<h3 id="_get_distribution_set"><a class="link" href="#_get_distribution_set">Get Distribution Set</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-set/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/43' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-set/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/43 HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-set/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-set/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True of the distribution set software module setup is complete as defined by the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.modules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of software modules.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-distribution-set/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 2609
+Content-Type: application/json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644329620,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644329625,
+ "name" : "DS",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644329600,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644329632,
+ "name" : "application",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.72",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/142"
+ }
+ },
+ "id" : 142
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644329608,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644329629,
+ "name" : "Firmware",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.94",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/144"
+ }
+ },
+ "id" : 144
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644329604,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644329635,
+ "name" : "app runtime",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.75",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/143"
+ }
+ },
+ "id" : 143
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/43"
+ },
+ "modules" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/43/assignedSM?offset=0&limit=50{&sort}",
+ "templated" : true
+ },
+ "type" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/232"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/43/metadata?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ },
+ "id" : 43
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -859,41 +1699,316 @@
<h3 id="_updating_a_distribution_set"><a class="link" href="#_updating_a_distribution_set">Updating a Distribution Set</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-distribution-set/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/49' -i -X PUT \
+ -H 'Accept: application/json' \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "requiredMigrationStep" : true,
+ "name" : "another Name",
+ "description" : "a new description",
+ "version" : "another Version"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-distribution-set/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/distributionsets/49 HTTP/1.1
+Accept: application/json
+Content-Type: application/json;charset=UTF-8
+Content-Length: 135
+Host: management-api.host.com
+
+{
+ "requiredMigrationStep" : true,
+ "name" : "another Name",
+ "description" : "a new description",
+ "version" : "another Version"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-distribution-set/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-distribution-set/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_5"><a class="link" href="#_response_status_200_5">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-distribution-set/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True of the distribution set software module setup is complete as defined by the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.modules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of software modules.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-distribution-set/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 2555
+Content-Type: application/json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644350155,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644350178,
+ "name" : "another Name",
+ "description" : "a new description",
+ "version" : "another Version",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644350144,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644350167,
+ "name" : "app runtime",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.55",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/161"
+ }
+ },
+ "id" : 161
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644350140,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644350165,
+ "name" : "application",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.95",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/160"
+ }
+ },
+ "id" : 160
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644350147,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644350162,
+ "name" : "Firmware",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.34",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/162"
+ }
+ },
+ "id" : 162
+ } ],
+ "requiredMigrationStep" : true,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/49"
+ },
+ "modules" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/49/assignedSM?offset=0&limit=50{&sort}",
+ "templated" : true
+ },
+ "type" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/248"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/49/metadata?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ },
+ "id" : 49
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -976,32 +2091,85 @@
<h3 id="_get_assigned_software_modules"><a class="link" href="#_get_assigned_software_modules">Get assigned Software Modules</a></h3>
<div class="sect3">
<h4 id="_curl_6"><a class="link" href="#_curl_6">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-software-modules/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/55/assignedSM' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-software-modules/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/55/assignedSM HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-software-modules/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_2"><a class="link" href="#_request_query_parameter_2">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-software-modules-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example"><a class="link" href="#_request_parameter_example">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-software-modules-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/50/assignedSM?offset=1&limit=2&sort=version%3ADESC&q=name%3D%3Done* HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1009,14 +2177,168 @@
<h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-software-modules/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of software modules.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].vendor</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-software-modules/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 1686
+Content-Type: application/json;charset=UTF-8
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644380901,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644380930,
+ "name" : "application",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.64",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/178"
+ }
+ },
+ "id" : 178
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644380905,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644380925,
+ "name" : "app runtime",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.56",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/179"
+ }
+ },
+ "id" : 179
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644380909,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644380928,
+ "name" : "Firmware",
+ "description" : "Updated Desc: feugiat placerat vitae venenatis venenatis a mollis aptent elementum convallis",
+ "version" : "1.0.76",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/180"
+ }
+ },
+ "id" : 180
+ } ],
+ "total" : 3,
+ "size" : 3
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1084,35 +2406,95 @@
<h3 id="_assign_software_modules_to_distribution_set"><a class="link" href="#_assign_software_modules_to_distribution_set">Assign Software Modules to Distribution Set</a></h3>
<div class="sect3">
<h4 id="_curl_7"><a class="link" href="#_curl_7">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/assign-software-modules/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/57/assignedSM' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "id" : 184
+}, {
+ "id" : 185
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/assign-software-modules/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsets/57/assignedSM HTTP/1.1
+Content-Length: 38
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "id" : 184
+}, {
+ "id" : 185
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/assign-software-modules/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_3"><a class="link" href="#_request_fields_3">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/assign-software-modules/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_7"><a class="link" href="#_response_status_200_7">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_7"><a class="link" href="#_response_example_7">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/assign-software-modules/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1195,29 +2577,57 @@
<h3 id="_delete_assignment_of_software_module"><a class="link" href="#_delete_assignment_of_software_module">Delete assignment of Software Module</a></h3>
<div class="sect3">
<h4 id="_curl_8"><a class="link" href="#_curl_8">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-assign-software-modules/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/42/assignedSM/141' -i -X DELETE \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_8"><a class="link" href="#_request_url_8">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-assign-software-modules/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/distributionsets/42/assignedSM/141 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_6"><a class="link" href="#_request_path_parameter_6">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-assign-software-modules/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_8"><a class="link" href="#_response_status_200_8">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_8"><a class="link" href="#_response_example_8">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-assign-software-modules/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1290,32 +2700,85 @@
<h3 id="_get_assigned_targets"><a class="link" href="#_get_assigned_targets">Get assigned targets</a></h3>
<div class="sect3">
<h4 id="_curl_9"><a class="link" href="#_curl_9">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-targets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/41/assignedTargets' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_9"><a class="link" href="#_request_url_9">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-targets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/41/assignedTargets HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_7"><a class="link" href="#_request_path_parameter_7">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-targets/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_3"><a class="link" href="#_request_query_parameter_3">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-targets-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_2"><a class="link" href="#_request_parameter_example_2">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-targets-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/48/assignedTargets?offset=1&limit=2&sort=name%3ADESC&q=controllerId%3D%3Dtarget* HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1323,14 +2786,72 @@
<h3 id="_response_status_200_9"><a class="link" href="#_response_status_200_9">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_6"><a class="link" href="#_response_fields_6">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-targets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array[Object]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_9"><a class="link" href="#_response_example_9">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-assigned-targets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 501
+Content-Type: application/json;charset=UTF-8
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644319289,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644319410,
+ "name" : "targetExist",
+ "controllerId" : "targetExist",
+ "updateStatus" : "pending",
+ "securityToken" : "223eced034f3390b70232136e8666b7a",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/targetExist"
+ }
+ }
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1398,47 +2919,287 @@
<h3 id="_assign_targets_to_a_distribution_set"><a class="link" href="#_assign_targets_to_a_distribution_set">Assign targets to a distribution set</a></h3>
<div class="sect3">
<h4 id="_curl_10"><a class="link" href="#_curl_10">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-assigned-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/54/assignedTargets' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target1",
+ "type" : "timeforced"
+}, {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target2",
+ "type" : "timeforced"
+}, {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target3",
+ "type" : "timeforced"
+}, {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target4",
+ "type" : "timeforced"
+}, {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target5",
+ "type" : "timeforced"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_10"><a class="link" href="#_request_url_10">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-assigned-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsets/54/assignedTargets HTTP/1.1
+Content-Length: 1027
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target1",
+ "type" : "timeforced"
+}, {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target2",
+ "type" : "timeforced"
+}, {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target3",
+ "type" : "timeforced"
+}, {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target4",
+ "type" : "timeforced"
+}, {
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "15 6 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644375697,
+ "id" : "target5",
+ "type" : "timeforced"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_8"><a class="link" href="#_request_path_parameter_8">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-assigned-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_4"><a class="link" href="#_request_query_parameter_4">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-assigned-target/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offline</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Offline update (set param to true) that is only reported but not managed by the service, e.g. defaults set in factory, manual updates or migrations from other update systems. A completed action is added to the history of the target(s). Target is set to IN_SYNC state as both assigend and installed DS are set. Note: only executed if the target has currently no running update.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_4"><a class="link" href="#_request_fields_4">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-assigned-target/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]forcetime</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Forcetime in milliseconds.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]maintenanceWindow</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Separation of download and install by defining a maintenance window for the installation.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]maintenanceWindow.schedule</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Schedule for the maintenance window start in quartz cron notation, such as '0 15 10 * * ? 2018' for 10:15am every day during the year 2018.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]maintenanceWindow.duration</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Duration of the window, such as '02:00:00' for 2 hours.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]maintenanceWindow.timezone</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">A time-zone offset from Greenwich/UTC, such as '+02:00'.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the forcetime.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['soft', 'forced','timeforced', 'downloadonly']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_10"><a class="link" href="#_response_status_200_10">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_7"><a class="link" href="#_response_fields_7">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-assigned-target/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">assigned</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Targets that now have this distribution set assigned.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">alreadyAssigned</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Targets that had this distribution set already assigned (in "offline" case this includes targets that have arbitrary updates running)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Overall assigned as part of this request.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_10"><a class="link" href="#_response_example_10">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-assigned-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 60
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "assigned" : 4,
+ "alreadyAssigned" : 1,
+ "total" : 5
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1521,32 +3282,85 @@
<h3 id="_get_installed_targets"><a class="link" href="#_get_installed_targets">Get installed targets</a></h3>
<div class="sect3">
<h4 id="_curl_11"><a class="link" href="#_curl_11">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-installed-targets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/56/installedTargets' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_11"><a class="link" href="#_request_url_11">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-installed-targets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/56/installedTargets HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_9"><a class="link" href="#_request_path_parameter_9">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-installed-targets/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_5"><a class="link" href="#_request_query_parameter_5">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-installed-targets-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_3"><a class="link" href="#_request_parameter_example_3">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-installed-targets-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/40/installedTargets?offset=1&limit=2&sort=name%3ADESC&q=controllerId%3D%3Dtarget* HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1554,14 +3368,73 @@
<h3 id="_response_status_200_11"><a class="link" href="#_response_status_200_11">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_8"><a class="link" href="#_response_fields_8">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-installed-targets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array[Object]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_11"><a class="link" href="#_response_example_11">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-installed-targets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 536
+Content-Type: application/json;charset=UTF-8
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644386034,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644386052,
+ "name" : "targetExist",
+ "controllerId" : "targetExist",
+ "updateStatus" : "in_sync",
+ "installedAt" : 1564644386050,
+ "securityToken" : "00a1a8481e70457ce6a73d144c88d6fd",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/targetExist"
+ }
+ }
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1629,32 +3502,85 @@
<h3 id="_get_installed_targets_2"><a class="link" href="#_get_installed_targets_2">Get installed targets</a></h3>
<div class="sect3">
<h4 id="_curl_12"><a class="link" href="#_curl_12">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-auto-assign-target-filter-queries/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/53/autoAssignTargetFilters' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_12"><a class="link" href="#_request_url_12">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-auto-assign-target-filter-queries/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/53/autoAssignTargetFilters HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_10"><a class="link" href="#_request_path_parameter_10">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-auto-assign-target-filter-queries/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_6"><a class="link" href="#_request_query_parameter_6">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-auto-assign-target-filter-queries-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_4"><a class="link" href="#_request_parameter_example_4">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-auto-assign-target-filter-queries-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/39/autoAssignTargetFilters?offset=1&limit=2&sort=name%3ADESC&q=name%3D%3D*1 HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1662,14 +3588,87 @@
<h3 id="_response_status_200_12"><a class="link" href="#_response_status_200_12">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_9"><a class="link" href="#_response_fields_9">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-auto-assign-target-filter-queries/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array[Object]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of target filter queries.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_12"><a class="link" href="#_response_example_12">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-auto-assign-target-filter-queries/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 849
+Content-Type: application/json;charset=UTF-8
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644370604,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644370604,
+ "name" : "filter1",
+ "query" : "name==a",
+ "autoAssignDistributionSet" : 53,
+ "autoAssignActionType" : null,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/10"
+ }
+ },
+ "id" : 10
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644370607,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644370607,
+ "name" : "filter2",
+ "query" : "name==b",
+ "autoAssignDistributionSet" : 53,
+ "autoAssignActionType" : null,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/11"
+ }
+ },
+ "id" : 11
+ } ],
+ "total" : 2,
+ "size" : 2
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1737,32 +3736,82 @@
<h3 id="_get_a_paged_list_of_meta_data"><a class="link" href="#_get_a_paged_list_of_meta_data">Get a paged list of meta data</a></h3>
<div class="sect3">
<h4 id="_curl_13"><a class="link" href="#_curl_13">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/60/metadata' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_13"><a class="link" href="#_request_url_13">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/60/metadata HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_11"><a class="link" href="#_request_path_parameter_11">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_7"><a class="link" href="#_request_query_parameter_7">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_5"><a class="link" href="#_request_parameter_example_5">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/59/metadata?offset=1&limit=2&sort=key%3ADESC&q=key%3D%3Dknown* HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1770,14 +3819,81 @@
<h3 id="_response_status_200_13"><a class="link" href="#_response_status_200_13">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_10"><a class="link" href="#_response_fields_10">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_13"><a class="link" href="#_response_example_13">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 289
+
+{
+ "content" : [ {
+ "key" : "knownKey0",
+ "value" : "knownValue0"
+ }, {
+ "key" : "knownKey1",
+ "value" : "knownValue1"
+ }, {
+ "key" : "knownKey2",
+ "value" : "knownValue2"
+ }, {
+ "key" : "knownKey3",
+ "value" : "knownValue3"
+ } ],
+ "total" : 4,
+ "size" : 4
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1845,35 +3961,116 @@
<h3 id="_create_a_list_of_meta_data_entries"><a class="link" href="#_create_a_list_of_meta_data_entries">Create a list of meta data entries</a></h3>
<div class="sect3">
<h4 id="_curl_14"><a class="link" href="#_curl_14">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/52/metadata' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "value" : "knownValue1",
+ "key" : "knownKey1"
+}, {
+ "value" : "knownValue2",
+ "key" : "knownKey2"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_14"><a class="link" href="#_request_url_14">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsets/52/metadata HTTP/1.1
+Content-Length: 110
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "value" : "knownValue1",
+ "key" : "knownKey1"
+}, {
+ "value" : "knownValue2",
+ "key" : "knownKey2"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_12"><a class="link" href="#_request_path_parameter_12">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_5"><a class="link" href="#_request_fields_5">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-metadata/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_14"><a class="link" href="#_response_status_200_14">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_14"><a class="link" href="#_response_example_14">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/create-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Length: 110
+Content-Type: application/hal+json;charset=UTF-8
+
+[ {
+ "key" : "knownKey1",
+ "value" : "knownValue1"
+}, {
+ "key" : "knownKey2",
+ "value" : "knownValue2"
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -1956,29 +4153,55 @@
<h3 id="_delete_a_single_meta_data"><a class="link" href="#_delete_a_single_meta_data">Delete a single meta data</a></h3>
<div class="sect3">
<h4 id="_curl_15"><a class="link" href="#_curl_15">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/61/metadata/knownKey' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_15"><a class="link" href="#_request_url_15">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/distributionsets/61/metadata/knownKey HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_13"><a class="link" href="#_request_path_parameter_13">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_15"><a class="link" href="#_response_status_200_15">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_15"><a class="link" href="#_response_example_15">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/delete-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -2051,35 +4274,95 @@
<h3 id="_get_a_single_meta_data_value"><a class="link" href="#_get_a_single_meta_data_value">Get a single meta data value</a></h3>
<div class="sect3">
<h4 id="_curl_16"><a class="link" href="#_curl_16">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata-value/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/58/metadata/knownKey' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_16"><a class="link" href="#_request_url_16">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata-value/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsets/58/metadata/knownKey HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_14"><a class="link" href="#_request_path_parameter_14">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata-value/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">metadatakey</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_16"><a class="link" href="#_response_status_200_16">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_11"><a class="link" href="#_response_fields_11">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata-value/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_16"><a class="link" href="#_response_example_16">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/get-metadata-value/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 50
+Content-Type: application/json;charset=UTF-8
+
+{
+ "key" : "knownKey",
+ "value" : "knownValue"
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -2147,41 +4430,144 @@
<h3 id="_update_a_single_meta_data_value"><a class="link" href="#_update_a_single_meta_data_value">Update a single meta data value</a></h3>
<div class="sect3">
<h4 id="_curl_17"><a class="link" href="#_curl_17">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsets/51/metadata/knownKey' -i -X PUT \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "value" : "valueForUpdate",
+ "key" : "knownKey"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_17"><a class="link" href="#_request_url_17">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/distributionsets/51/metadata/knownKey HTTP/1.1
+Content-Length: 54
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "value" : "valueForUpdate",
+ "key" : "knownKey"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_15"><a class="link" href="#_request_path_parameter_15">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">metadatakey</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_6"><a class="link" href="#_request_fields_6">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-metadata/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_17"><a class="link" href="#_response_status_200_17">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_12"><a class="link" href="#_response_fields_12">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-metadata/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_17"><a class="link" href="#_response_example_17">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsets/update-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 54
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "key" : "knownKey",
+ "value" : "valueForUpdate"
+}</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/distributionsettag-api-guide/index.html b/rest-api/distributionsettag-api-guide/index.html
index c593a61..aa4af7c 100644
--- a/rest-api/distributionsettag-api-guide/index.html
+++ b/rest-api/distributionsettag-api-guide/index.html
@@ -447,8 +447,10 @@
<h3 id="_get_paged_list_of_distribution_set_tags"><a class="link" href="#_get_paged_list_of_distribution_set_tags">Get paged list of distribution set tags</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tags/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettags' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
@@ -456,20 +458,53 @@
<div class="paragraph">
<p>A <code>GET</code> request is used to access the distribution set tags</p>
</div>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tags/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettags HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tags-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example"><a class="link" href="#_request_parameter_example">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tags-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettags?limit=10&sort=name:ASC&offset=0&q=name%3D%3DDsTag HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -477,14 +512,119 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tags/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tags/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 419
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564643976509,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564643976518,
+ "name" : "DsTag",
+ "description" : "My name is DsTag",
+ "colour" : "default",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettags/2"
+ }
+ },
+ "id" : 2
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -552,8 +692,10 @@
<h3 id="_get_a_single_distribution_set_tag"><a class="link" href="#_get_a_single_distribution_set_tag">Get a single distribution set tag</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tag/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettags/6' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
@@ -561,29 +703,140 @@
<div class="paragraph">
<p>A <code>GET</code> request is used to access the distribution set tag</p>
</div>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tag/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettags/6 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tag/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionsetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tag/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.assignedDistributionSets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to assigned distribution sets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-distribution-set-tag/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 523
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564643998014,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564643998019,
+ "name" : "DsTag",
+ "description" : "My name is DsTag",
+ "colour" : "default",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettags/6"
+ },
+ "assignedDistributionSets" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettags/6/assigned?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ },
+ "id" : 6
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -651,35 +904,175 @@
<h3 id="_create_list_of_distribution_set_tags"><a class="link" href="#_create_list_of_distribution_set_tags">Create list of distribution set tags</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/create-distribution-set-tags/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettags' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "colour" : "red",
+ "name" : "ds tag",
+ "description" : "ds tag description"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/create-distribution-set-tags/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsettags HTTP/1.1
+Content-Length: 87
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "colour" : "red",
+ "name" : "ds tag",
+ "description" : "ds tag description"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/create-distribution-set-tags/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201"><a class="link" href="#_response_status_201">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/create-distribution-set-tags/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/create-distribution-set-tags/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 343
+
+[ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644003288,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644003288,
+ "name" : "ds tag",
+ "description" : "ds tag description",
+ "colour" : "red",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettags/7"
+ }
+ },
+ "id" : 7
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -757,41 +1150,206 @@
<h3 id="_update_a_distribution_set_tag"><a class="link" href="#_update_a_distribution_set_tag">Update a distribution set tag</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/update-distribution-set-tag/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettags/1' -i -X PUT \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "colour" : "red",
+ "name" : "ds tag",
+ "description" : "ds tag description"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/update-distribution-set-tag/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/distributionsettags/1 HTTP/1.1
+Content-Length: 83
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "colour" : "red",
+ "name" : "ds tag",
+ "description" : "ds tag description"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/update-distribution-set-tag/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionsetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/update-distribution-set-tag/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/update-distribution-set-tag/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.assignedDistributionSets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to assigned distribution sets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/update-distribution-set-tag/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 522
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564643970689,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564643970882,
+ "name" : "ds tag",
+ "description" : "ds tag description",
+ "colour" : "red",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettags/1"
+ },
+ "assignedDistributionSets" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettags/1/assigned?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ },
+ "id" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -874,29 +1432,53 @@
<h3 id="_deleting_a_distribution_set_tag"><a class="link" href="#_deleting_a_distribution_set_tag">Deleting a distribution set tag</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/delete-distribution-set-tag/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettags/4' -i -X DELETE \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/delete-distribution-set-tag/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/distributionsettags/4 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/delete-distribution-set-tag/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionsetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/delete-distribution-set-tag/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -979,35 +1561,242 @@
<h3 id="_get_a_list_of_assigned_distributions"><a class="link" href="#_get_a_list_of_assigned_distributions">Get a list of assigned distributions</a></h3>
<div class="sect3">
<h4 id="_curl_6"><a class="link" href="#_curl_6">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-assigned-distribution-sets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettags/3/assigned' -i -X GET \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-assigned-distribution-sets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettags/3/assigned HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-assigned-distribution-sets/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionsetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_5"><a class="link" href="#_response_status_200_5">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-assigned-distribution-sets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True of the distribution set software module setup is complete as defined by the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/get-assigned-distribution-sets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 2125
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564643981803,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564643981973,
+ "name" : "DS",
+ "description" : "The descption of the distribution set.",
+ "version" : "1.0",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564643981754,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564643981894,
+ "name" : "app runtime",
+ "description" : "Description of the software module",
+ "version" : "1.0.21",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/8"
+ }
+ },
+ "id" : 8
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564643981740,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564643981923,
+ "name" : "application",
+ "description" : "Description of the software module",
+ "version" : "1.0.89",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/7"
+ }
+ },
+ "id" : 7
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564643981767,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564643981859,
+ "name" : "Firmware",
+ "description" : "Description of the software module",
+ "version" : "1.0.44",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/9"
+ }
+ },
+ "id" : 9
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/3"
+ }
+ },
+ "id" : 3
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1080,35 +1869,196 @@
<h3 id="_toogle_distribution_assignment"><a class="link" href="#_toogle_distribution_assignment">Toogle distribution assignment</a></h3>
<div class="sect3">
<h4 id="_curl_7"><a class="link" href="#_curl_7">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/toggle-tag-assignment/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettags/9/assigned/toggleTagAssignment' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "id" : 9
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/toggle-tag-assignment/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsettags/9/assigned/toggleTagAssignment HTTP/1.1
+Content-Length: 18
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "id" : 9
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields_3"><a class="link" href="#_request_fields_3">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/toggle-tag-assignment/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_6"><a class="link" href="#_response_fields_6">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/toggle-tag-assignment/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">assignedDistributionSets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array[Object]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Assigned distribution sets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">unassignedDistributionSets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array[Object]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Unassigned distribution sets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_7"><a class="link" href="#_response_example_7">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/toggle-tag-assignment/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+Content-Length: 2645
+
+{
+ "assignedDistributionSets" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644013706,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644013842,
+ "name" : "DS",
+ "description" : "The descption of the distribution set.",
+ "version" : "1.0",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644013689,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644013761,
+ "name" : "Firmware",
+ "description" : "Description of the software module",
+ "version" : "1.0.33",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/27",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ],
+ "id" : 27
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644013675,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644013732,
+ "name" : "application",
+ "description" : "Description of the software module",
+ "version" : "1.0.92",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/25",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ],
+ "id" : 25
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644013682,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644013747,
+ "name" : "app runtime",
+ "description" : "Description of the software module",
+ "version" : "1.0.22",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/26",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ],
+ "id" : 26
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/9",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ],
+ "id" : 9
+ } ],
+ "unassignedDistributionSets" : [ ]
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1186,35 +2136,237 @@
<h3 id="_distribution_assignment"><a class="link" href="#_distribution_assignment">Distribution assignment</a></h3>
<div class="sect3">
<h4 id="_curl_8"><a class="link" href="#_curl_8">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/assign-distribution-sets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettags/8/assigned' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "id" : 8
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_8"><a class="link" href="#_request_url_8">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/assign-distribution-sets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsettags/8/assigned HTTP/1.1
+Content-Length: 18
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "id" : 8
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields_4"><a class="link" href="#_request_fields_4">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/assign-distribution-sets/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_7"><a class="link" href="#_response_status_200_7">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_7"><a class="link" href="#_response_fields_7">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/assign-distribution-sets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True of the distribution set software module setup is complete as defined by the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_8"><a class="link" href="#_response_example_8">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/assign-distribution-sets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 1944
+
+[ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644008472,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644008549,
+ "name" : "DS",
+ "description" : "The descption of the distribution set.",
+ "version" : "1.0",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644008455,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644008511,
+ "name" : "Firmware",
+ "description" : "Description of the software module",
+ "version" : "1.0.48",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/24"
+ }
+ },
+ "id" : 24
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644008443,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644008527,
+ "name" : "application",
+ "description" : "Description of the software module",
+ "version" : "1.0.67",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/22"
+ }
+ },
+ "id" : 22
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644008449,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644008496,
+ "name" : "app runtime",
+ "description" : "Description of the software module",
+ "version" : "1.0.11",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/23"
+ }
+ },
+ "id" : 23
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/8"
+ }
+ },
+ "id" : 8
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -1292,29 +2444,57 @@
<h3 id="_unassign_a_distribution"><a class="link" href="#_unassign_a_distribution">Unassign a distribution</a></h3>
<div class="sect3">
<h4 id="_curl_9"><a class="link" href="#_curl_9">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/unassign-distribution-set/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettags/10/assigned/11' -i -X DELETE \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_9"><a class="link" href="#_request_url_9">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/unassign-distribution-set/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/distributionsettags/10/assigned/11 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/unassign-distribution-set/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionsetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionsetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_8"><a class="link" href="#_response_status_200_8">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_9"><a class="link" href="#_response_example_9">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettag/unassign-distribution-set/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/distributionsettypes-api-guide/index.html b/rest-api/distributionsettypes-api-guide/index.html
index a9ef665..2521798 100644
--- a/rest-api/distributionsettypes-api-guide/index.html
+++ b/rest-api/distributionsettypes-api-guide/index.html
@@ -452,26 +452,64 @@
<h3 id="_get_distribution_set_types"><a class="link" href="#_get_distribution_set_types">Get distribution set types</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-types/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url"><a class="link" href="#_request_url">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-types/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettypes HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-types-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example"><a class="link" href="#_request_parameter_example">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-types-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettypes?offset=1&limit=2&sort=name%3ADESC&q=name%3D%3Da* HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -479,14 +517,165 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-types/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Functional key of the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-types/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+Content-Length: 1756
+
+{
+ "content" : [ {
+ "createdBy" : "system",
+ "createdAt" : 1564644603533,
+ "lastModifiedBy" : "system",
+ "lastModifiedAt" : 1564644603533,
+ "name" : "App(s) only",
+ "description" : "Default type with app(s) only.",
+ "key" : "app",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/423"
+ }
+ },
+ "id" : 423
+ }, {
+ "createdBy" : "system",
+ "createdAt" : 1564644603534,
+ "lastModifiedBy" : "system",
+ "lastModifiedAt" : 1564644603534,
+ "name" : "OS with app(s)",
+ "description" : "Default type with Firmware/OS and optional app(s).",
+ "key" : "os_app",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/424"
+ }
+ },
+ "id" : 424
+ }, {
+ "createdBy" : "system",
+ "createdAt" : 1564644603533,
+ "lastModifiedBy" : "system",
+ "lastModifiedAt" : 1564644603533,
+ "name" : "OS only",
+ "description" : "Default type with Firmware/OS only.",
+ "key" : "os",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/425"
+ }
+ },
+ "id" : 425
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644603549,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644603583,
+ "name" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
+ "description" : "Desc1234",
+ "key" : "test_default_ds_type",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/426"
+ }
+ },
+ "id" : 426
+ } ],
+ "total" : 4,
+ "size" : 4
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -554,35 +743,210 @@
<h3 id="_create_distribution_set_types"><a class="link" href="#_create_distribution_set_types">Create distribution set types</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-distribution-set-types/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes' -i -X POST \
+ -H 'Accept: application/json' \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "optionalmodules" : [ {
+ "id" : 309
+ } ],
+ "name" : "TestName1",
+ "description" : "Desc1",
+ "mandatorymodules" : [ {
+ "id" : 308
+ } ],
+ "key" : "test1"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-distribution-set-types/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsettypes HTTP/1.1
+Content-Length: 173
+Accept: application/json
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "optionalmodules" : [ {
+ "id" : 309
+ } ],
+ "name" : "TestName1",
+ "description" : "Desc1",
+ "mandatorymodules" : [ {
+ "id" : 308
+ } ],
+ "key" : "test1"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-distribution-set-types/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Functional key of the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]mandatorymodules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Mandatory module type IDs.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]optionalmodules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Optional module type IDs.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201"><a class="link" href="#_response_status_201">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-distribution-set-types/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Functional key of the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-distribution-set-types/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Length: 370
+Content-Type: application/json;charset=UTF-8
+
+[ {
+ "createdBy" : "uploadTester",
+ "createdAt" : 1564644588212,
+ "lastModifiedBy" : "uploadTester",
+ "lastModifiedAt" : 1564644588212,
+ "name" : "TestName1",
+ "description" : "Desc1",
+ "key" : "test1",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/413"
+ }
+ },
+ "id" : 413
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -665,29 +1029,51 @@
<h3 id="_delete_distribution_set_type"><a class="link" href="#_delete_distribution_set_type">Delete distribution set type</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-distribution-set-type/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/449' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-distribution-set-type/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/distributionsettypes/449 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-distribution-set-type/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-distribution-set-type/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -760,35 +1146,165 @@
<h3 id="_get_distribution_set_type"><a class="link" href="#_get_distribution_set_type">Get distribution set type</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-type/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/422' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-type/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettypes/422 HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-type/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-type/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Functional key of the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.mandatorymodules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to mandatory software modules types in this distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.optionalmodules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to optional software modules types in this distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-distribution-set-type/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 688
+Content-Type: application/json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644598349,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644598492,
+ "name" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
+ "description" : "Desc1234",
+ "key" : "test_default_ds_type",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/422"
+ },
+ "mandatorymodules" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/422/mandatorymoduletypes"
+ },
+ "optionalmodules" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/422/optionalmoduletypes"
+ }
+ },
+ "id" : 422
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -861,41 +1377,203 @@
<h3 id="_update_distribution_set_type"><a class="link" href="#_update_distribution_set_type">Update distribution set type</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/put-distribution-set-type/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/453' -i -X PUT \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "description" : "an updated desription"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/put-distribution-set-type/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/distributionsettypes/453 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 45
+Host: management-api.host.com
+
+{
+ "description" : "an updated desription"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/put-distribution-set-type/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/put-distribution-set-type/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/put-distribution-set-type/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Functional key of the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.mandatorymodules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to mandatory software modules types in this distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.optionalmodules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to optional software modules types in this distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/put-distribution-set-type/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 701
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644634027,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644634075,
+ "name" : "OS (FW) mandatory, runtime (FW) and app (SW) optional",
+ "description" : "an updated desription",
+ "key" : "test_default_ds_type",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/453"
+ },
+ "mandatorymodules" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/453/mandatorymoduletypes"
+ },
+ "optionalmodules" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/453/optionalmoduletypes"
+ }
+ },
+ "id" : 453
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -978,35 +1656,154 @@
<h3 id="_lists_all_mandatory_software_module_types"><a class="link" href="#_lists_all_mandatory_software_module_types">Lists all mandatory software module types</a></h3>
<div class="sect3">
<h4 id="_curl_6"><a class="link" href="#_curl_6">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-modules/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/440/mandatorymoduletypes' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-modules/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettypes/440/mandatorymoduletypes HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-modules/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_5"><a class="link" href="#_response_status_200_5">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-modules/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Key that can be interpreted by the target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]maxAssignments</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Software modules of that type can be assigned at this maximum number (e.g. operating system only once).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-modules/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+Content-Length: 386
+
+[ {
+ "createdBy" : "system",
+ "createdAt" : 1564644618752,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644618759,
+ "name" : "OS",
+ "description" : "Updated description.",
+ "key" : "os",
+ "maxAssignments" : 1,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/325"
+ }
+ },
+ "id" : 325
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -1079,35 +1876,91 @@
<h3 id="_add_mandatory_software_module_type"><a class="link" href="#_add_mandatory_software_module_type">Add mandatory software module type</a></h3>
<div class="sect3">
<h4 id="_curl_7"><a class="link" href="#_curl_7">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-mandatory-module/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/435/mandatorymoduletypes' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "id" : 322
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-mandatory-module/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsettypes/435/mandatorymoduletypes HTTP/1.1
+Content-Length: 16
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "id" : 322
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-mandatory-module/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_3"><a class="link" href="#_request_fields_3">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-mandatory-module/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201_2"><a class="link" href="#_response_status_201_2">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_example_7"><a class="link" href="#_response_example_7">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-mandatory-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1193,29 +2046,57 @@
<h3 id="_remove_mandatory_module_from_distribution_set_type"><a class="link" href="#_remove_mandatory_module_from_distribution_set_type">Remove mandatory module from distribution set type</a></h3>
<div class="sect3">
<h4 id="_curl_8"><a class="link" href="#_curl_8">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-mandatory-module/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/467/mandatorymoduletypes/343' -i -X DELETE \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_8"><a class="link" href="#_request_url_8">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-mandatory-module/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/distributionsettypes/467/mandatorymoduletypes/343 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_6"><a class="link" href="#_request_path_parameter_6">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-mandatory-module/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_8"><a class="link" href="#_response_example_8">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-mandatory-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1288,35 +2169,158 @@
<h3 id="_retrieve_mandatory_software_module_type"><a class="link" href="#_retrieve_mandatory_software_module_type">Retrieve mandatory software module type</a></h3>
<div class="sect3">
<h4 id="_curl_9"><a class="link" href="#_curl_9">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-module/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/458/mandatorymoduletypes/338' -i -X GET \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_9"><a class="link" href="#_request_url_9">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-module/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettypes/458/mandatorymoduletypes/338 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_7"><a class="link" href="#_request_path_parameter_7">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-module/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_7"><a class="link" href="#_response_status_200_7">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_6"><a class="link" href="#_response_fields_6">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-module/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Key that can be interpreted by the target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maxAssignments</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Software modules of that type can be assigned at this maximum number (e.g. operating system only once).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_9"><a class="link" href="#_response_example_9">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-mandatory-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 382
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "system",
+ "createdAt" : 1564644639118,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644639125,
+ "name" : "OS",
+ "description" : "Updated description.",
+ "key" : "os",
+ "maxAssignments" : 1,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/338"
+ }
+ },
+ "id" : 338
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1389,35 +2393,154 @@
<h3 id="_lists_all_optional_software_module_types"><a class="link" href="#_lists_all_optional_software_module_types">Lists all optional software module types</a></h3>
<div class="sect3">
<h4 id="_curl_10"><a class="link" href="#_curl_10">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-optional-modules/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/445/optionalmoduletypes' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_10"><a class="link" href="#_request_url_10">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-optional-modules/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettypes/445/optionalmoduletypes HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_8"><a class="link" href="#_request_path_parameter_8">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-optional-modules/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_8"><a class="link" href="#_response_status_200_8">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_7"><a class="link" href="#_response_fields_7">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-optional-modules/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Key that can be interpreted by the target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]maxAssignments</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Software modules of that type can be assigned at this maximum number (e.g. operating system only once).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_10"><a class="link" href="#_response_example_10">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-optional-modules/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 396
+Content-Type: application/json;charset=UTF-8
+
+[ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644623839,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644623841,
+ "name" : "runtime",
+ "description" : "Updated description.",
+ "key" : "runtime",
+ "maxAssignments" : 1,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/330"
+ }
+ },
+ "id" : 330
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -1490,35 +2613,91 @@
<h3 id="_add_optional_software_module_type"><a class="link" href="#_add_optional_software_module_type">Add optional software module type</a></h3>
<div class="sect3">
<h4 id="_curl_11"><a class="link" href="#_curl_11">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-optional-module/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/472/optionalmoduletypes' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "id" : 347
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_11"><a class="link" href="#_request_url_11">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-optional-module/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/distributionsettypes/472/optionalmoduletypes HTTP/1.1
+Content-Length: 16
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "id" : 347
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_9"><a class="link" href="#_request_path_parameter_9">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-optional-module/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_4"><a class="link" href="#_request_fields_4">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-optional-module/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201_3"><a class="link" href="#_response_status_201_3">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_example_11"><a class="link" href="#_response_example_11">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-optional-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1607,29 +2786,57 @@
<h3 id="_remove_optional_module_from_distribution_set_type"><a class="link" href="#_remove_optional_module_from_distribution_set_type">Remove optional module from distribution set type</a></h3>
<div class="sect3">
<h4 id="_curl_12"><a class="link" href="#_curl_12">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-optional-module/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/477/optionalmoduletypes/349' -i -X DELETE \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_12"><a class="link" href="#_request_url_12">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-optional-module/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/distributionsettypes/477/optionalmoduletypes/349 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_10"><a class="link" href="#_request_path_parameter_10">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-optional-module/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_9"><a class="link" href="#_response_status_200_9">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_12"><a class="link" href="#_response_example_12">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/delete-optional-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1702,35 +2909,154 @@
<h3 id="_retrieve_optional_software_module_type"><a class="link" href="#_retrieve_optional_software_module_type">Retrieve optional software module type</a></h3>
<div class="sect3">
<h4 id="_curl_13"><a class="link" href="#_curl_13">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-optional-module/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/distributionsettypes/418/optionalmoduletypes/311' -i -X GET \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_13"><a class="link" href="#_request_url_13">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-optional-module/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/distributionsettypes/418/optionalmoduletypes/311 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_11"><a class="link" href="#_request_path_parameter_11">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/post-optional-module/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetTypeId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_10"><a class="link" href="#_response_status_200_10">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_8"><a class="link" href="#_response_fields_8">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-optional-module/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Key that can be interpreted by the target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maxAssignments</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Software modules of that type can be assigned at this maximum number (e.g. operating system only once).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_13"><a class="link" href="#_response_example_13">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in distributionsettypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/distributionsettypes/get-optional-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 409
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "system",
+ "createdAt" : 1564644593250,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644593260,
+ "name" : "Application",
+ "description" : "Updated description.",
+ "key" : "application",
+ "maxAssignments" : 2147483647,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/311"
+ }
+ },
+ "id" : 311
+}</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/rollout-api-guide/index.html b/rest-api/rollout-api-guide/index.html
index 1fff757..08b1d46 100644
--- a/rest-api/rollout-api-guide/index.html
+++ b/rest-api/rollout-api-guide/index.html
@@ -450,26 +450,64 @@
<h3 id="_get_paged_list_of_rollouts"><a class="link" href="#_get_paged_list_of_rollouts">Get paged list of Rollouts</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollouts/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts' -i -X GET \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url"><a class="link" href="#_request_url">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollouts/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/rollouts HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollouts-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_example"><a class="link" href="#_request_query_parameter_example">Request query parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollouts-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/rollouts?offset=0&limit=2&sort=id%3ADESC&q=name%3D%3DexampleRollout* HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -477,14 +515,154 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollouts/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">list of rollouts</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].targetFilterQuery</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query language expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the ID of distributionset of this rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the status of this rollout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['creating','ready','paused','running','finished']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of this rollout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced','soft','timeforced','downloadonly']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].totalTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets of a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollouts/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 578
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644177252,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644177385,
+ "name" : "exampleRollout",
+ "description" : "exampleDescription",
+ "targetFilterQuery" : "controllerId==exampleTarget*",
+ "distributionSetId" : 31,
+ "status" : "ready",
+ "totalTargets" : 20,
+ "deleted" : false,
+ "type" : "forced",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/15"
+ }
+ },
+ "id" : 15
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -552,35 +730,246 @@
<h3 id="_get_rollout"><a class="link" href="#_get_rollout">Get Rollout</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/2' -i -X GET \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/rollouts/2 HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rolloutId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQuery</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query language expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the ID of distributionset of this rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the status of this rollout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['creating','ready','paused','running','finished']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of this rollout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced','soft','timeforced','downloadonly']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">totalTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets of a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">totalTargetsPerStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets per status</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.start</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to start the rollout in sync mode</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.pause</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to pause a running rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.resume</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to resume a paused rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.groups</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to retrieve the groups a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.approve</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to approve a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.deny</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to deny a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 1359
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644107815,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644108005,
+ "name" : "exampleRollout",
+ "description" : "exampleDescription",
+ "targetFilterQuery" : "controllerId==exampleTarget*",
+ "distributionSetId" : 18,
+ "status" : "ready",
+ "totalTargets" : 20,
+ "totalTargetsPerStatus" : {
+ "running" : 0,
+ "notstarted" : 20,
+ "scheduled" : 0,
+ "cancelled" : 0,
+ "finished" : 0,
+ "error" : 0
+ },
+ "deleted" : false,
+ "type" : "forced",
+ "_links" : {
+ "start" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/2/start"
+ },
+ "pause" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/2/pause"
+ },
+ "resume" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/2/resume"
+ },
+ "approve" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/2/approve{?remark}",
+ "templated" : true
+ },
+ "deny" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/2/deny{?remark}",
+ "templated" : true
+ },
+ "groups" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/2/deploygroups?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ },
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/2"
+ }
+ },
+ "id" : 2
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -653,35 +1042,417 @@
<h3 id="_create_rollout_with_defined_amount_of_groups"><a class="link" href="#_create_rollout_with_defined_amount_of_groups">Create Rollout with defined amount of groups</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts' -i -X POST \
+ -H 'Content-Type: application/hal+json;charset=UTF-8' \
+ -H 'Accept: application/hal+json' \
+ -d '{
+ "distributionSetId" : 22,
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "successAction" : {
+ "expression" : "",
+ "action" : "NEXTGROUP"
+ },
+ "targetFilterQuery" : "id==targets-*",
+ "name" : "exampleRollout",
+ "description" : "Rollout for all named targets",
+ "amountGroups" : 10,
+ "errorAction" : {
+ "expression" : "",
+ "action" : "PAUSE"
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "80"
+ }
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/rollouts HTTP/1.1
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 490
+Accept: application/hal+json
+Host: management-api.host.com
+
+{
+ "distributionSetId" : 22,
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "successAction" : {
+ "expression" : "",
+ "action" : "NEXTGROUP"
+ },
+ "targetFilterQuery" : "id==targets-*",
+ "name" : "exampleRollout",
+ "description" : "Rollout for all named targets",
+ "amountGroups" : 10,
+ "errorAction" : {
+ "expression" : "",
+ "action" : "PAUSE"
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "80"
+ }
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the ID of distributionset of this rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQuery</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query language expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">amountGroups</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the amount of groups the rollout should split targets into</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success condition which takes in place to evaluate if a rollout group is successful and so the next group can be started</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['threshold']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action which takes in place to execute in case the success action is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action to execute</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['nextgroup']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the success action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error condition which takes in place to evaluate if a rollout group encounter errors</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['threshold']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action which is executed if the error condition is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action to execute</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['pause']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the error action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201"><a class="link" href="#_response_status_201">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQuery</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query language expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the ID of distributionset of this rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the status of this rollout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['creating','ready','paused','running','finished']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of this rollout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced','soft','timeforced','downloadonly']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">totalTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets of a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">totalTargetsPerStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets per status</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.start</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to start the rollout in sync mode</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.pause</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to pause a running rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.resume</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to resume a paused rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.groups</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to retrieve the groups a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.approve</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to approve a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.deny</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to deny a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 1358
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644129892,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644129892,
+ "name" : "exampleRollout",
+ "description" : "Rollout for all named targets",
+ "targetFilterQuery" : "id==targets-*",
+ "distributionSetId" : 22,
+ "status" : "creating",
+ "totalTargets" : 20,
+ "totalTargetsPerStatus" : {
+ "running" : 0,
+ "notstarted" : 20,
+ "scheduled" : 0,
+ "cancelled" : 0,
+ "finished" : 0,
+ "error" : 0
+ },
+ "deleted" : false,
+ "type" : "forced",
+ "_links" : {
+ "start" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/6/start"
+ },
+ "pause" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/6/pause"
+ },
+ "resume" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/6/resume"
+ },
+ "approve" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/6/approve{?remark}",
+ "templated" : true
+ },
+ "deny" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/6/deny{?remark}",
+ "templated" : true
+ },
+ "groups" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/6/deploygroups?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ },
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/6"
+ }
+ },
+ "id" : 6
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -689,35 +1460,591 @@
<h3 id="_create_rollout_with_groups_definition"><a class="link" href="#_create_rollout_with_groups_definition">Create Rollout with groups definition</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout-with-groups-definition/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts' -i -X POST \
+ -H 'Content-Type: application/json' \
+ -H 'Accept: application/hal+json' \
+ -d '{
+ "distributionSetId" : 24,
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "successAction" : {
+ "expression" : "",
+ "action" : "NEXTGROUP"
+ },
+ "targetFilterQuery" : "id==targets-*",
+ "name" : "exampleRolloutWithDefinedGroups",
+ "description" : "Rollout for all named targets",
+ "groups" : [ {
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "90"
+ },
+ "targetPercentage" : 20,
+ "successAction" : {
+ "expression" : "",
+ "action" : "NEXTGROUP"
+ },
+ "targetFilterQuery" : "name==targets-1*",
+ "name" : "Group1",
+ "description" : "Group1desc",
+ "errorAction" : {
+ "expression" : "",
+ "action" : "PAUSE"
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "30"
+ }
+ }, {
+ "successCondition" : {
+ "condition" : "THRESHOLD"
+ },
+ "targetPercentage" : 100,
+ "successAction" : {
+ "action" : "NEXTGROUP"
+ },
+ "name" : "Group2",
+ "description" : "Group2desc"
+ } ],
+ "errorAction" : {
+ "expression" : "",
+ "action" : "PAUSE"
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "80"
+ }
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout-with-groups-definition/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/rollouts HTTP/1.1
+Content-Type: application/json
+Accept: application/hal+json
+Content-Length: 1206
+Host: management-api.host.com
+
+{
+ "distributionSetId" : 24,
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "successAction" : {
+ "expression" : "",
+ "action" : "NEXTGROUP"
+ },
+ "targetFilterQuery" : "id==targets-*",
+ "name" : "exampleRolloutWithDefinedGroups",
+ "description" : "Rollout for all named targets",
+ "groups" : [ {
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "90"
+ },
+ "targetPercentage" : 20,
+ "successAction" : {
+ "expression" : "",
+ "action" : "NEXTGROUP"
+ },
+ "targetFilterQuery" : "name==targets-1*",
+ "name" : "Group1",
+ "description" : "Group1desc",
+ "errorAction" : {
+ "expression" : "",
+ "action" : "PAUSE"
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "30"
+ }
+ }, {
+ "successCondition" : {
+ "condition" : "THRESHOLD"
+ },
+ "targetPercentage" : 100,
+ "successAction" : {
+ "action" : "NEXTGROUP"
+ },
+ "name" : "Group2",
+ "description" : "Group2desc"
+ } ],
+ "errorAction" : {
+ "expression" : "",
+ "action" : "PAUSE"
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "80"
+ }
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout-with-groups-definition/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the ID of distributionset of this rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQuery</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query language expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success condition which takes in place to evaluate if a rollout group is successful and so the next group can be started</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['threshold']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action which takes in place to execute in case the success action is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action to execute</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['nextgroup']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the success action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error condition which takes in place to evaluate if a rollout group encounter errors</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['threshold']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action which is executed if the error condition is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action to execute</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['pause']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the error action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the list of group definitions</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].targetFilterQuery</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query language expression that selects a subset of targets which match the target filter of the Rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].targetPercentage</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">percentage of remaining and matching targets that should be added to this group</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">0..100</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].successCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success condition which takes in place to evaluate if a rollout group is successful and so the next group can be started</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].successCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['threshold']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].successCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].successAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action which takes in place to execute in case the success action is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].successAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action to execute</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['nextgroup']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].successAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the success action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].errorCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error condition which takes in place to evaluate if a rollout group encounter errors</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].errorCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['threshold']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].errorCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].errorAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action which is executed if the error condition is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].errorAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action to execute</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['pause']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">groups[].errorAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the error action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201_2"><a class="link" href="#_response_status_201_2">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout-with-groups-definition/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQuery</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query language expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">distributionSetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the ID of distributionset of this rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the status of this rollout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['creating','ready','paused','running','finished']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of this rollout</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced','soft','timeforced','downloadonly']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">totalTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets of a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">totalTargetsPerStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets per status</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.start</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to start the rollout in sync mode</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.pause</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to pause a running rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.resume</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to resume a paused rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.groups</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to retrieve the groups a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.approve</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to approve a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.deny</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to deny a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/create-rollout-with-groups-definition/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Length: 1375
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644140321,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644140321,
+ "name" : "exampleRolloutWithDefinedGroups",
+ "description" : "Rollout for all named targets",
+ "targetFilterQuery" : "id==targets-*",
+ "distributionSetId" : 24,
+ "status" : "creating",
+ "totalTargets" : 10,
+ "totalTargetsPerStatus" : {
+ "running" : 0,
+ "notstarted" : 10,
+ "scheduled" : 0,
+ "cancelled" : 0,
+ "finished" : 0,
+ "error" : 0
+ },
+ "deleted" : false,
+ "type" : "forced",
+ "_links" : {
+ "start" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/8/start"
+ },
+ "pause" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/8/pause"
+ },
+ "resume" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/8/resume"
+ },
+ "approve" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/8/approve{?remark}",
+ "templated" : true
+ },
+ "deny" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/8/deny{?remark}",
+ "templated" : true
+ },
+ "groups" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/8/deploygroups?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ },
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/8"
+ }
+ },
+ "id" : 8
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -797,14 +2124,21 @@
<h3 id="_approve_rollout"><a class="link" href="#_approve_rollout">Approve Rollout</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/approve-rollout/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/1/approve' -i -X POST \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/approve-rollout/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/rollouts/1/approve HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -812,8 +2146,10 @@
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/approve-rollout/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -881,14 +2217,21 @@
<h3 id="_deny_rollout"><a class="link" href="#_deny_rollout">Deny Rollout</a></h3>
<div class="sect3">
<h4 id="_curl_6"><a class="link" href="#_curl_6">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/deny-rollout/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/7/deny' -i -X POST \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/deny-rollout/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/rollouts/7/deny HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -896,8 +2239,10 @@
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/deny-rollout/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -963,14 +2308,21 @@
<h3 id="_start_rollout"><a class="link" href="#_start_rollout">Start Rollout</a></h3>
<div class="sect3">
<h4 id="_curl_7"><a class="link" href="#_curl_7">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/start-rollout/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/12/start' -i -X POST \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/start-rollout/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/rollouts/12/start HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -978,8 +2330,10 @@
<h3 id="_response_status_200_5"><a class="link" href="#_response_status_200_5">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_7"><a class="link" href="#_response_example_7">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/start-rollout/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1045,20 +2399,29 @@
<h3 id="_pause_rollout"><a class="link" href="#_pause_rollout">Pause Rollout</a></h3>
<div class="sect3">
<h4 id="_curl_8"><a class="link" href="#_curl_8">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/pause-rollout/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/5/pause' -i -X POST \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_8"><a class="link" href="#_request_url_8">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/pause-rollout/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/rollouts/5/pause HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_example_8"><a class="link" href="#_response_example_8">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/pause-rollout/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1124,20 +2487,29 @@
<h3 id="_resume_rollout"><a class="link" href="#_resume_rollout">Resume Rollout</a></h3>
<div class="sect3">
<h4 id="_curl_9"><a class="link" href="#_curl_9">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/resume-rollout/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/4/resume' -i -X POST \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_9"><a class="link" href="#_request_url_9">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/resume-rollout/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/rollouts/4/resume HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_example_9"><a class="link" href="#_response_example_9">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/resume-rollout/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1203,29 +2575,51 @@
<h3 id="_deleting_a_rollout"><a class="link" href="#_deleting_a_rollout">Deleting a rollout</a></h3>
<div class="sect3">
<h4 id="_curl_10"><a class="link" href="#_curl_10">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/delete-rollout/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/11' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_10"><a class="link" href="#_request_url_10">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/delete-rollout/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/rollouts/11 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/delete-rollout/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rolloutId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_10"><a class="link" href="#_response_example_10">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/delete-rollout/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1298,32 +2692,85 @@
<h3 id="_get_deploy_groups"><a class="link" href="#_get_deploy_groups">Get Deploy Groups</a></h3>
<div class="sect3">
<h4 id="_curl_11"><a class="link" href="#_curl_11">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-groups/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/13/deploygroups' -i -X GET \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_11"><a class="link" href="#_request_url_11">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-groups/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/rollouts/13/deploygroups HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-groups/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rolloutId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_2"><a class="link" href="#_request_query_parameter_2">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollouts-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_example_2"><a class="link" href="#_request_query_parameter_example_2">Request query parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollouts-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/rollouts?offset=0&limit=2&sort=id%3ADESC&q=name%3D%3DexampleRollout* HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1331,14 +2778,525 @@
<h3 id="_response_status_200_7"><a class="link" href="#_response_status_200_7">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-groups/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">list of rollouts</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the status of this rollout group</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['creating','ready','paused','running','finished']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].totalTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets of a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].targetFilterQuery</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query language expression that selects a subset of targets which match the target filter of the Rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].targetPercentage</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">percentage of remaining and matching targets that should be added to this group</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].successCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success condition which takes in place to evaluate if a rollout group is successful and so the next group can be started</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].successCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].successCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].successAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action which takes in place to execute in case the success action is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].successAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action to execute</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].successAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the success action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].errorCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error condition which takes in place to evaluate if a rollout group encounter errors</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].errorCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].errorCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].errorAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action which is executed if the error condition is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].errorAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action to execute</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].errorAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the error action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_11"><a class="link" href="#_response_example_11">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-groups/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 8104
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166652,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166782,
+ "name" : "group-1",
+ "description" : "group-1",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 10.0,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/113"
+ }
+ },
+ "id" : 113
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166654,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166783,
+ "name" : "group-2",
+ "description" : "group-2",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 11.111112,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/114"
+ }
+ },
+ "id" : 114
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166655,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166784,
+ "name" : "group-3",
+ "description" : "group-3",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 12.5,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/115"
+ }
+ },
+ "id" : 115
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166657,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166785,
+ "name" : "group-4",
+ "description" : "group-4",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 14.285715,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/116"
+ }
+ },
+ "id" : 116
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166658,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166786,
+ "name" : "group-5",
+ "description" : "group-5",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 16.666668,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/117"
+ }
+ },
+ "id" : 117
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166659,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166787,
+ "name" : "group-6",
+ "description" : "group-6",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 20.0,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/118"
+ }
+ },
+ "id" : 118
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166660,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166788,
+ "name" : "group-7",
+ "description" : "group-7",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 25.0,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/119"
+ }
+ },
+ "id" : 119
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166661,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166789,
+ "name" : "group-8",
+ "description" : "group-8",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 33.333336,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/120"
+ }
+ },
+ "id" : 120
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166662,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166790,
+ "name" : "group-9",
+ "description" : "group-9",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 50.0,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/121"
+ }
+ },
+ "id" : 121
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644166663,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644166791,
+ "name" : "group-10",
+ "description" : "group-10",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 100.0,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/13/deploygroups/122"
+ }
+ },
+ "id" : 122
+ } ],
+ "total" : 10,
+ "size" : 10
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1411,35 +3369,267 @@
<h3 id="_get_deploy_groups_2"><a class="link" href="#_get_deploy_groups_2">Get Deploy Groups</a></h3>
<div class="sect3">
<h4 id="_curl_12"><a class="link" href="#_curl_12">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/16/deploygroups/143' -i -X GET \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_12"><a class="link" href="#_request_url_12">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/rollouts/16/deploygroups/143 HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rolloutId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployGroupId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_8"><a class="link" href="#_response_status_200_8">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_6"><a class="link" href="#_response_fields_6">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the status of this rollout group</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['creating','ready','paused','running','finished']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">totalTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets of a rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">totalTargetsPerStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the total targets per status</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQuery</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query language expression that selects a subset of targets which match the target filter of the Rollout</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetPercentage</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">percentage of remaining and matching targets that should be added to this group</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success condition which takes in place to evaluate if a rollout group is successful and so the next group can be started</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action which takes in place to execute in case the success action is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the success action to execute</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">successAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the success action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorCondition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error condition which takes in place to evaluate if a rollout group encounter errors</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorCondition.condition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the type of the condition</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorCondition.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression according to the condition, e.g. the value of threshold in percentage</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action which is executed if the error condition is fulfilled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorAction.action</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the error action to execute</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">errorAction.expression</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the expression for the error action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_12"><a class="link" href="#_response_example_12">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 889
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644182519,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644182628,
+ "name" : "group-1",
+ "description" : "group-1",
+ "successCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "10"
+ },
+ "successAction" : {
+ "action" : "NEXTGROUP",
+ "expression" : ""
+ },
+ "errorCondition" : {
+ "condition" : "THRESHOLD",
+ "expression" : "50"
+ },
+ "errorAction" : {
+ "action" : "PAUSE",
+ "expression" : ""
+ },
+ "targetFilterQuery" : "",
+ "targetPercentage" : 10.0,
+ "status" : "ready",
+ "totalTargets" : 2,
+ "totalTargetsPerStatus" : {
+ "running" : 0,
+ "notstarted" : 2,
+ "scheduled" : 0,
+ "cancelled" : 0,
+ "finished" : 0,
+ "error" : 0
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/rollouts/16/deploygroups/143"
+ }
+ },
+ "id" : 143
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1512,32 +3702,89 @@
<h3 id="_get_deploy_group_targets"><a class="link" href="#_get_deploy_group_targets">Get Deploy Group Targets</a></h3>
<div class="sect3">
<h4 id="_curl_13"><a class="link" href="#_curl_13">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group-targets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/rollouts/14/deploygroups/123/targets' -i -X GET \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_13"><a class="link" href="#_request_url_13">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group-targets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/rollouts/14/deploygroups/123/targets HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group-targets/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rolloutId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployGroupId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_3"><a class="link" href="#_request_query_parameter_3">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group-targets-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_example_3"><a class="link" href="#_request_query_parameter_example_3">Request query parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group-targets-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/rollouts/3/deploygroups/21/targets?offset=0&limit=2&sort=name%3AASC&q=controllerId%3D%3DexampleTarget0 HTTP/1.1
+Accept: application/hal+json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1545,14 +3792,167 @@
<h3 id="_response_status_200_9"><a class="link" href="#_response_status_200_9">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_7"><a class="link" href="#_response_fields_7">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group-targets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">class java.lang.String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">class java.lang.String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].updateStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current update status of the target.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['error', 'in_sync', 'pending', 'registered', 'unknown']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].securityToken</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].installedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">class java.lang.Long</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Installation time of current installed DistributionSet.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].ipAddress</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last known IP address of the target. Only presented if IP address of the target itself is known (connected directly through DDI API).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastControllerRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last time where the target polled the server, same as pollStatus.lastRequestAt.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_13"><a class="link" href="#_response_example_13">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rollout-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rollouts/get-rollout-deploy-group-targets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 1077
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644171915,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644171915,
+ "name" : "exampleTarget-00000",
+ "description" : "exampleTarget0",
+ "controllerId" : "exampleTarget-00000",
+ "updateStatus" : "unknown",
+ "securityToken" : "ec332b452b9661ba156e12eed7ad3b5a",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/exampleTarget-00000"
+ }
+ }
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644171916,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644171916,
+ "name" : "exampleTarget-00001",
+ "description" : "exampleTarget1",
+ "controllerId" : "exampleTarget-00001",
+ "updateStatus" : "unknown",
+ "securityToken" : "4a4d756f0be0cef975d36ac300d682c2",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/exampleTarget-00001"
+ }
+ }
+ } ],
+ "total" : 2,
+ "size" : 2
+}</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/rootcontroller-api-guide/index.html b/rest-api/rootcontroller-api-guide/index.html
index 3a331b4..5a4796c 100644
--- a/rest-api/rootcontroller-api-guide/index.html
+++ b/rest-api/rootcontroller-api-guide/index.html
@@ -445,35 +445,126 @@
<h3 id="_controller_base_poll_resource"><a class="link" href="#_controller_base_poll_resource">Controller base poll resource</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-base-with-open-deplyoment/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID' -i -X GET \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url"><a class="link" href="#_request_url">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-base-with-open-deplyoment/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /TENANT_ID/controller/v1/CONTROLLER_ID HTTP/1.1
+Host: ddi-api.host.com
+Accept: application/hal+json</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-base-with-open-deplyoment/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">tenant</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The tenant</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the controller</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_with_an_active_deployment"><a class="link" href="#_response_status_200_with_an_active_deployment">Response (Status 200) with an active deployment</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-base-with-open-deplyoment/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">config.polling</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">suggested sleep time between polls</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">config.polling.sleep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">sleep time in HH:MM:SS notation</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Open Actions that the server has for the target</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.deploymentBase</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Detailed deployment operation</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.configData</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">configuration data as key/value list</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-base-with-open-deplyoment/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 355
+
+{
+ "config" : {
+ "polling" : {
+ "sleep" : "12:00:00"
+ }
+ },
+ "_links" : {
+ "deploymentBase" : {
+ "href" : "https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/deploymentBase/81?c=-2056995960"
+ },
+ "configData" : {
+ "href" : "https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/configData"
+ }
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -481,14 +572,79 @@
<h3 id="_response_status_200_with_an_active_cancellation"><a class="link" href="#_response_status_200_with_an_active_cancellation">Response (Status 200) with an active cancellation</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-base-with-open-deployment-cancellation/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">config.polling</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">suggested sleep time between polls</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">config.polling.sleep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">sleep time in HH:MM:SS notation</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Open Actions that the server has for the target</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.cancelAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Detailed deployment operation</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.configData</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">configuration data as key/value list</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-base-with-open-deployment-cancellation/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 337
+
+{
+ "config" : {
+ "polling" : {
+ "sleep" : "12:00:00"
+ }
+ },
+ "_links" : {
+ "cancelAction" : {
+ "href" : "https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/cancelAction/79"
+ },
+ "configData" : {
+ "href" : "https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/configData"
+ }
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -556,35 +712,109 @@
<h3 id="_cancel_an_action"><a class="link" href="#_cancel_an_action">Cancel an action</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-cancel-action/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/cancelAction/84' -i -X GET \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-cancel-action/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /TENANT_ID/controller/v1/CONTROLLER_ID/cancelAction/84 HTTP/1.1
+Host: ddi-api.host.com
+Accept: application/hal+json</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-cancel-action/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">tenant</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The tenant</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the controller</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action that needs to be canceled (typically identical to id field on the cancel action itself)</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-cancel-action/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">cancelAction</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">action that needs to be canceled</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">cancelAction.stopId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action that needs to be canceled (typically identical to id field on the cancel action itself)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-cancel-action/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 63
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "id" : "84",
+ "cancelAction" : {
+ "stopId" : "84"
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -652,27 +882,147 @@
<h3 id="_feedback_channel_for_cancel_actions"><a class="link" href="#_feedback_channel_for_cancel_actions">Feedback channel for cancel actions</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/post-cancel-action-feedback/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/cancelAction/87/feedback' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "id" : "87",
+ "time" : "20140511T121314",
+ "status" : {
+ "result" : {
+ "finished" : "success"
+ },
+ "execution" : "closed",
+ "details" : [ "Some feedback" ]
+ }
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/post-cancel-action-feedback/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /TENANT_ID/controller/v1/CONTROLLER_ID/cancelAction/87/feedback HTTP/1.1
+Content-Length: 184
+Host: ddi-api.host.com
+Content-Type: application/json;charset=UTF-8
+
+{
+ "id" : "87",
+ "time" : "20140511T121314",
+ "status" : {
+ "result" : {
+ "finished" : "success"
+ },
+ "execution" : "closed",
+ "details" : [ "Some feedback" ]
+ }
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/post-cancel-action-feedback/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">tenant</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The tenant</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the controller</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action that needs to be canceled (typically identical to id field on the cancel action itself)</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/post-cancel-action-feedback/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">time</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">time on the target device</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target action status</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.execution</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status of the action execution</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['closed', 'proceeding', 'canceled','scheduled', 'rejected', 'resumed']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.result</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">result of the action execution</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.result.finished</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">defined status of the result</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['success', 'failure', 'none']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.details</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of details message information</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
@@ -753,27 +1103,167 @@
<h3 id="_response_to_a_requested_metadata_pull_from_the_provisioning_target_device"><a class="link" href="#_response_to_a_requested_metadata_pull_from_the_provisioning_target_device">Response to a requested metadata pull from the provisioning target device.</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/put-config-data/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/configData' -i -X PUT \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "mode" : "merge",
+ "data" : {
+ "VIN" : "JH4TB2H26CC000000",
+ "hwRevision" : "2"
+ },
+ "id" : "",
+ "time" : "20140511T121314",
+ "status" : {
+ "result" : {
+ "finished" : "success"
+ },
+ "execution" : "closed",
+ "details" : [ ]
+ }
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/put-config-data/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /TENANT_ID/controller/v1/CONTROLLER_ID/configData HTTP/1.1
+Host: ddi-api.host.com
+Content-Length: 260
+Content-Type: application/json;charset=UTF-8
+
+{
+ "mode" : "merge",
+ "data" : {
+ "VIN" : "JH4TB2H26CC000000",
+ "hwRevision" : "2"
+ },
+ "id" : "",
+ "time" : "20140511T121314",
+ "status" : {
+ "result" : {
+ "finished" : "success"
+ },
+ "execution" : "closed",
+ "details" : [ ]
+ }
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/put-config-data/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">tenant</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The tenant</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the controller</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/put-config-data/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">time</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">time on the target device</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target action status</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.execution</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status of the action execution</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['closed', 'proceeding', 'canceled','scheduled', 'rejected', 'resumed']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.result</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">result of the action execution</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.result.finished</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">defined status of the result</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['success', 'failure', 'none']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.details</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of details message information</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">data</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">configuration data as key/value list</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">mode</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Optional parameter to specify the update mode that should be applied when updating target attributes. Valid values are 'merge', 'replace', and 'remove'. Defaults to 'merge'.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['merge', 'replace', 'remove']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
@@ -857,44 +1347,429 @@
<h3 id="_deployment_or_update_action"><a class="link" href="#_deployment_or_update_action">Deployment or update action</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-basedeployment-action/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/deploymentBase/82?actionHistory=10' -i -X GET \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-basedeployment-action/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /TENANT_ID/controller/v1/CONTROLLER_ID/deploymentBase/82?actionHistory=10 HTTP/1.1
+Host: ddi-api.host.com
+Accept: application/hal+json</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-basedeployment-action/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">tenant</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The tenant</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the controller</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-basedeployment-action/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>actionHistory</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Optional GET parameter to retrieve a given number of messages which are previously provided by the device. Useful if the devices sent state information to the feedback channel and never stored them locally.</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-basedeployment-action/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Detailed deployment operation</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.download</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">handling for the download part of the provisioning process ('skip': do not download yet, 'attempt': server asks to download, 'forced': server requests immediate download)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['skip', 'attempt', 'forced']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.update</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">handling for the update part of the provisioning process ('skip': do not update yet, 'attempt': server asks to update, 'forced': server requests immediate update)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['skip', 'attempt', 'forced']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.maintenanceWindow</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">separation of download and installation by defining a maintenance window for the installation. Status shows if currently in a window.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['available', 'unavailable']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Software chunks of an update. In server mapped by Software Module.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">meta data of the respective software module that has been marked with 'target visible'</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].metadata[].key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key of meta data entry</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].metadata[].value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value of meta data entry</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].part</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Type of the chunk, e.g. firmware, bundle, app. In update server mapped to Software Module Type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name of the chunk</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">software version of the chunk</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">list of artifacts</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[].filename</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">list of artifacts</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[].hashes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">list of artifacts</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[].hashes.sha1</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact in Base 16 format</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[].hashes.md5</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[].hashes.sha256</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">SHA-256 hash of the artifact in Base 16 format</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[].size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size of the artifact</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[]._links.download</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">HTTPs Download resource for artifacts. The resource supports partial download as specified by RFC7233 (range requests). Keep in mind that the target needs to have the artifact assigned in order to be granted permission to download.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[]._links.md5sum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">HTTPs Download resource for MD5SUM file is an optional auto generated artifact that is especially useful for Linux based devices on order to check artifact consistency after download by using the md5sum command line tool. The MD5 and SHA1 are in addition available as metadata in the deployment command itself.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[]._links.download-http</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">HTTP Download resource for artifacts. The resource supports partial download as specified by RFC7233 (range requests). Keep in mind that the target needs to have the artifact assigned in order to be granted permission to download. (note: anonymous download needs to be enabled on the service account for non-TLS access)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deployment.chunks[].artifacts[]._links.md5sum-http</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">HTTP Download resource for MD5SUM file is an optional auto generated artifact that is especially useful for Linux based devices on order to check artifact consistency after download by using the md5sum command line tool. The MD5 and SHA1 are in addition available as metadata in the deployment command itself. (note: anonymous download needs to be enabled on the service account for non-TLS access)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionHistory</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current deployment state.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionHistory.status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Status of the deployment based on previous feedback by the device.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionHistory.messages</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Messages are previously sent to the feedback channel in LIFO order by the device.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
<div class="paragraph">
<p>In this case the (optional) query for the last 10 messages, previously provided by the device, are included. Useful if the devices provide state information previously on the feedback channel and won’t store it locally.</p>
</div>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-basedeployment-action/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 7198
+
+{
+ "id" : "82",
+ "deployment" : {
+ "download" : "forced",
+ "update" : "forced",
+ "maintenanceWindow" : "available",
+ "chunks" : [ {
+ "part" : "bApp",
+ "version" : "1.0.46",
+ "name" : "oneapplication",
+ "artifacts" : [ {
+ "filename" : "binary.tgz",
+ "hashes" : {
+ "sha1" : "2d86c2a659e364e9abba49ea6ffcd53dd5559f05",
+ "md5" : "0d1b08c34858921bc7c662b228acb7ba",
+ "sha256" : "a03b221c6c6eae7122ca51695d456d5222e524889136394944b2f9763b483615"
+ },
+ "size" : 3,
+ "_links" : {
+ "download" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/305/filename/binary.tgz"
+ },
+ "download-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/305/filename/binary.tgz"
+ },
+ "md5sum-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/305/filename/binary.tgz.MD5SUM"
+ },
+ "md5sum" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/305/filename/binary.tgz.MD5SUM"
+ }
+ }
+ }, {
+ "filename" : "file.signature",
+ "hashes" : {
+ "sha1" : "2d86c2a659e364e9abba49ea6ffcd53dd5559f05",
+ "md5" : "0d1b08c34858921bc7c662b228acb7ba",
+ "sha256" : "a03b221c6c6eae7122ca51695d456d5222e524889136394944b2f9763b483615"
+ },
+ "size" : 3,
+ "_links" : {
+ "download" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/305/filename/file.signature"
+ },
+ "download-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/305/filename/file.signature"
+ },
+ "md5sum-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/305/filename/file.signature.MD5SUM"
+ },
+ "md5sum" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/305/filename/file.signature.MD5SUM"
+ }
+ }
+ } ]
+ }, {
+ "part" : "jvm",
+ "version" : "1.0.26",
+ "name" : "oneapp runtime",
+ "artifacts" : [ {
+ "filename" : "binary.tgz",
+ "hashes" : {
+ "sha1" : "3b93fd2d045d59af27a25c719945db1d9fe3decb",
+ "md5" : "e94f0bfab8c987a7437ba4e1697c1cc0",
+ "sha256" : "5d04c6a96439100ad3cb4672ef2fdc219dae8aaa655c9a3095c9e7ad25f4d96c"
+ },
+ "size" : 4,
+ "_links" : {
+ "download" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/306/filename/binary.tgz"
+ },
+ "download-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/306/filename/binary.tgz"
+ },
+ "md5sum-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/306/filename/binary.tgz.MD5SUM"
+ },
+ "md5sum" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/306/filename/binary.tgz.MD5SUM"
+ }
+ }
+ }, {
+ "filename" : "file.signature",
+ "hashes" : {
+ "sha1" : "3b93fd2d045d59af27a25c719945db1d9fe3decb",
+ "md5" : "e94f0bfab8c987a7437ba4e1697c1cc0",
+ "sha256" : "5d04c6a96439100ad3cb4672ef2fdc219dae8aaa655c9a3095c9e7ad25f4d96c"
+ },
+ "size" : 4,
+ "_links" : {
+ "download" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/306/filename/file.signature"
+ },
+ "download-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/306/filename/file.signature"
+ },
+ "md5sum-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/306/filename/file.signature.MD5SUM"
+ },
+ "md5sum" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/306/filename/file.signature.MD5SUM"
+ }
+ }
+ } ]
+ }, {
+ "part" : "os",
+ "version" : "1.0.99",
+ "name" : "one Firmware",
+ "artifacts" : [ {
+ "filename" : "binary.tgz",
+ "hashes" : {
+ "sha1" : "3b93fd2d045d59af27a25c719945db1d9fe3decb",
+ "md5" : "e94f0bfab8c987a7437ba4e1697c1cc0",
+ "sha256" : "5d04c6a96439100ad3cb4672ef2fdc219dae8aaa655c9a3095c9e7ad25f4d96c"
+ },
+ "size" : 4,
+ "_links" : {
+ "download" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/307/filename/binary.tgz"
+ },
+ "download-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/307/filename/binary.tgz"
+ },
+ "md5sum-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/307/filename/binary.tgz.MD5SUM"
+ },
+ "md5sum" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/307/filename/binary.tgz.MD5SUM"
+ }
+ }
+ }, {
+ "filename" : "file.signature",
+ "hashes" : {
+ "sha1" : "3b93fd2d045d59af27a25c719945db1d9fe3decb",
+ "md5" : "e94f0bfab8c987a7437ba4e1697c1cc0",
+ "sha256" : "5d04c6a96439100ad3cb4672ef2fdc219dae8aaa655c9a3095c9e7ad25f4d96c"
+ },
+ "size" : 4,
+ "_links" : {
+ "download" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/307/filename/file.signature"
+ },
+ "download-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/307/filename/file.signature"
+ },
+ "md5sum-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/307/filename/file.signature.MD5SUM"
+ },
+ "md5sum" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/307/filename/file.signature.MD5SUM"
+ }
+ }
+ } ],
+ "metadata" : [ {
+ "key" : "aMetadataKey",
+ "value" : "Metadata value as defined in software module"
+ } ]
+ } ]
+ },
+ "actionHistory" : {
+ "status" : "RUNNING",
+ "messages" : [ "Reboot", "Write firmware", "Download done", "Download failed. ErrorCode #5876745. Retry", "Started download" ]
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -911,8 +1786,37 @@
<div class="paragraph">
<p>Note: artifact details not shown in this example.</p>
</div>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-controller-basedeployment-action-with-maintenance-window/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 496
+
+{
+ "id" : "85",
+ "deployment" : {
+ "download" : "forced",
+ "update" : "skip",
+ "maintenanceWindow" : "unavailable",
+ "chunks" : [ {
+ "part" : "jvm",
+ "version" : "1.0.94",
+ "name" : "oneapp runtime",
+ "artifacts" : [ ]
+ }, {
+ "part" : "bApp",
+ "version" : "1.0.39",
+ "name" : "oneapplication",
+ "artifacts" : [ ]
+ }, {
+ "part" : "os",
+ "version" : "1.0.57",
+ "name" : "one Firmware",
+ "artifacts" : [ ]
+ } ]
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -980,27 +1884,164 @@
<h3 id="_feedback_channel_for_update_action"><a class="link" href="#_feedback_channel_for_update_action">Feedback channel for update action</a></h3>
<div class="sect3">
<h4 id="_curl_6"><a class="link" href="#_curl_6">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/post-basedeployment-action-feedback/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/deploymentBase/83/feedback' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -H 'Accept: application/hal+json' \
+ -d '{
+ "id" : "83",
+ "time" : "20140511T121314",
+ "status" : {
+ "result" : {
+ "progress" : {
+ "of" : 5,
+ "cnt" : 2
+ },
+ "finished" : "none"
+ },
+ "execution" : "closed",
+ "details" : [ "Feddback message" ]
+ }
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/post-basedeployment-action-feedback/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /TENANT_ID/controller/v1/CONTROLLER_ID/deploymentBase/83/feedback HTTP/1.1
+Content-Length: 250
+Host: ddi-api.host.com
+Content-Type: application/json;charset=UTF-8
+Accept: application/hal+json
+
+{
+ "id" : "83",
+ "time" : "20140511T121314",
+ "status" : {
+ "result" : {
+ "progress" : {
+ "of" : 5,
+ "cnt" : 2
+ },
+ "finished" : "none"
+ },
+ "execution" : "closed",
+ "details" : [ "Feddback message" ]
+ }
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_6"><a class="link" href="#_request_path_parameter_6">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/post-basedeployment-action-feedback/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">tenant</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The tenant</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the controller</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_3"><a class="link" href="#_request_fields_3">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/post-basedeployment-action-feedback/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the action</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">time</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">time on the target device</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target action status</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.execution</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status of the action execution</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['closed', 'proceeding', 'canceled','scheduled', 'rejected', 'resumed']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.result</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">result of the action execution</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.result.finished</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">defined status of the result</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['success', 'failure', 'none']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.result.progress</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">progress assumption of the device</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status.details</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of details message information</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
@@ -1081,35 +2122,168 @@
<h3 id="_returns_artifacts_of_given_software_module"><a class="link" href="#_returns_artifacts_of_given_software_module">Returns artifacts of given software module</a></h3>
<div class="sect3">
<h4 id="_curl_7"><a class="link" href="#_curl_7">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-software-modules-artifacts/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://ddi-api.host.com/TENANT_ID/controller/v1/CONTROLLER_ID/softwaremodules/318/artifacts' -i -X GET \
+ -H 'Accept: application/hal+json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-software-modules-artifacts/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /TENANT_ID/controller/v1/CONTROLLER_ID/softwaremodules/318/artifacts HTTP/1.1
+Host: ddi-api.host.com
+Accept: application/hal+json</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_7"><a class="link" href="#_request_path_parameter_7">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-software-modules-artifacts/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">tenant</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The tenant</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the controller</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">moduleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id of the software module</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-software-modules-artifacts/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]filename</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">list of artifacts</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]hashes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">list of artifacts</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]hashes.sha1</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact in Base 16 format</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]hashes.md5</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]hashes.sha256</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">SHA-256 hash of the artifact in Base 16 format</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size of the artifact</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]_links.download</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">HTTPs Download resource for artifacts. The resource supports partial download as specified by RFC7233 (range requests). Keep in mind that the target needs to have the artifact assigned in order to be granted permission to download.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]_links.md5sum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">HTTPs Download resource for MD5SUM file is an optional auto generated artifact that is especially useful for Linux based devices on order to check artifact consistency after download by using the md5sum command line tool. The MD5 and SHA1 are in addition available as metadata in the deployment command itself.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]_links.download-http</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">HTTP Download resource for artifacts. The resource supports partial download as specified by RFC7233 (range requests). Keep in mind that the target needs to have the artifact assigned in order to be granted permission to download. (note: anonymous download needs to be enabled on the service account for non-TLS access)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]_links.md5sum-http</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">HTTP Download resource for MD5SUM file is an optional auto generated artifact that is especially useful for Linux based devices on order to check artifact consistency after download by using the md5sum command line tool. The MD5 and SHA1 are in addition available as metadata in the deployment command itself. (note: anonymous download needs to be enabled on the service account for non-TLS access)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in rootcontroller-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/rootcontroller/get-software-modules-artifacts/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 925
+
+[ {
+ "filename" : "binaryFile",
+ "hashes" : {
+ "sha1" : "3b93fd2d045d59af27a25c719945db1d9fe3decb",
+ "md5" : "e94f0bfab8c987a7437ba4e1697c1cc0",
+ "sha256" : "5d04c6a96439100ad3cb4672ef2fdc219dae8aaa655c9a3095c9e7ad25f4d96c"
+ },
+ "size" : 4,
+ "_links" : {
+ "download" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/318/filename/binaryFile"
+ },
+ "download-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/318/filename/binaryFile"
+ },
+ "md5sum-http" : {
+ "href" : "http://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/318/filename/binaryFile.MD5SUM"
+ },
+ "md5sum" : {
+ "href" : "https://link-to-cdn.com/api/v1/TENANT_ID/download/controller/CONTROLLER_ID/softwaremodules/318/filename/binaryFile.MD5SUM"
+ }
+ }
+} ]</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/softwaremodules-api-guide/index.html b/rest-api/softwaremodules-api-guide/index.html
index 06baf70..1bab82e 100644
--- a/rest-api/softwaremodules-api-guide/index.html
+++ b/rest-api/softwaremodules-api-guide/index.html
@@ -453,26 +453,61 @@
<h3 id="_get_software_modules"><a class="link" href="#_get_software_modules">Get software modules</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-modules/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url"><a class="link" href="#_request_url">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-modules/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_parameter"><a class="link" href="#_request_parameter">Request parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-modules-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example"><a class="link" href="#_request_parameter_example">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-modules-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules?offset=1&limit=2&sort=version%3ADESC&q=name%3D%3DSM* HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -480,14 +515,151 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-modules/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of software modules.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].vendor</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-modules/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 963
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644253220,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644253223,
+ "name" : "os",
+ "description" : "a description",
+ "version" : "1.0",
+ "type" : "os",
+ "vendor" : "Vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/113"
+ }
+ },
+ "id" : 113
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644253227,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644253230,
+ "name" : "application",
+ "description" : "a description",
+ "version" : "1.0",
+ "type" : "application",
+ "vendor" : "Vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/114"
+ }
+ },
+ "id" : 114
+ } ],
+ "total" : 2,
+ "size" : 2
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -555,35 +727,243 @@
<h3 id="_create_software_modules"><a class="link" href="#_create_software_modules">Create software modules</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-software-modules/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules' -i -X POST \
+ -H 'Content-Type: application/hal+json;charset=UTF-8' \
+ -d '[ {
+ "vendor" : "vendor1",
+ "name" : "name1",
+ "description" : "description1",
+ "type" : "os",
+ "version" : "version1"
+}, {
+ "vendor" : "vendor1",
+ "name" : "name3",
+ "description" : "description1",
+ "type" : "application",
+ "version" : "version1"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-software-modules/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/softwaremodules HTTP/1.1
+Content-Length: 261
+Content-Type: application/hal+json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "vendor" : "vendor1",
+ "name" : "name1",
+ "description" : "description1",
+ "type" : "os",
+ "version" : "version1"
+}, {
+ "vendor" : "vendor1",
+ "name" : "name3",
+ "description" : "description1",
+ "type" : "application",
+ "version" : "version1"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-software-modules/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]vendor</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the software module identified by its key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201"><a class="link" href="#_response_status_201">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-software-modules/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].vendor</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-software-modules/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 815
+
+[ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644217462,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644217462,
+ "name" : "name1",
+ "description" : "description1",
+ "version" : "version1",
+ "type" : "os",
+ "vendor" : "vendor1",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/100"
+ }
+ },
+ "id" : 100
+}, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644217464,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644217464,
+ "name" : "name3",
+ "description" : "description1",
+ "version" : "version1",
+ "type" : "application",
+ "vendor" : "vendor1",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/101"
+ }
+ },
+ "id" : 101
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -666,29 +1046,51 @@
<h3 id="_delete_software_module"><a class="link" href="#_delete_software_module">Delete software module</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-software-module/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/98' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-software-module/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/softwaremodules/98 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-software-module/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-software-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -761,35 +1163,186 @@
<h3 id="_get_software_module"><a class="link" href="#_get_software_module">Get software module</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-module/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/102' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-module/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/102 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-module/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-module/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">vendor</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.artifacts</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of artifacts of given software module.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-software-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 759
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644222552,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644222556,
+ "name" : "os",
+ "description" : "a description",
+ "version" : "1.0",
+ "type" : "os",
+ "vendor" : "Vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/102"
+ },
+ "artifacts" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/102/artifacts"
+ },
+ "type" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/119"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/102/metadata?offset=0&limit=50"
+ }
+ },
+ "id" : 102
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -862,41 +1415,235 @@
<h3 id="_update_software_module"><a class="link" href="#_update_software_module">Update software module</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-software-module/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/99' -i -X PUT \
+ -H 'Content-Type: application/hal+json;charset=UTF-8' \
+ -d '{
+ "vendor" : "another Vendor",
+ "description" : "a new description"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-software-module/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/softwaremodules/99 HTTP/1.1
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 72
+Host: management-api.host.com
+
+{
+ "vendor" : "another Vendor",
+ "description" : "a new description"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-software-module/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-software-module/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">vendor</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-software-module/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">vendor</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software vendor.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The software module type of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.artifacts</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of artifacts of given software module.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-software-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 747
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644212345,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644212357,
+ "name" : "os",
+ "description" : "a new description",
+ "version" : "1.0",
+ "type" : "os",
+ "vendor" : "another Vendor",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/99"
+ },
+ "artifacts" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/99/artifacts"
+ },
+ "type" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/112"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/99/metadata?offset=0&limit=50"
+ }
+ },
+ "id" : 99
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -979,35 +1726,147 @@
<h3 id="_list_artifacts_metadata"><a class="link" href="#_list_artifacts_metadata">List artifacts metadata</a></h3>
<div class="sect3">
<h4 id="_curl_6"><a class="link" href="#_curl_6">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifacts/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/112/artifacts' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifacts/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/112/artifacts HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifacts/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_5"><a class="link" href="#_response_status_200_5">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifacts/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Size of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].hashes.md5</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].hashes.sha1</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[].providedFilename</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Filename of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifacts/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 444
+
+[ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644248143,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644248143,
+ "hashes" : {
+ "sha1" : "2d86c2a659e364e9abba49ea6ffcd53dd5559f05",
+ "md5" : "0d1b08c34858921bc7c662b228acb7ba"
+ },
+ "providedFilename" : "file1",
+ "size" : 3,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/112/artifacts/47"
+ }
+ },
+ "id" : 47
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -1080,32 +1939,114 @@
<h3 id="_upload_artifact"><a class="link" href="#_upload_artifact">Upload artifact</a></h3>
<div class="sect3">
<h4 id="_curl_7"><a class="link" href="#_curl_7">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-artifact/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/97/artifacts' -i -X POST \
+ -H 'Content-Type: multipart/form-data' \
+ -F 'file=@origFilename'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-artifact/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/softwaremodules/97/artifacts HTTP/1.1
+Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Host: management-api.host.com
+
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Content-Disposition: form-data; name=file; filename=origFilename
+
+????
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-artifact/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-artifact-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>filename</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Filename of the artifact.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>file</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Binary of file.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>md5sum</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sha1sum</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_2"><a class="link" href="#_request_parameter_example_2">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-artifact-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/softwaremodules/111/artifacts HTTP/1.1
+Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Host: management-api.host.com
+
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Content-Disposition: form-data; name=filename
+
+filename
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Content-Disposition: form-data; name=file
+
+s
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Content-Disposition: form-data; name=md5sum
+
+md5sum
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Content-Disposition: form-data; name=sha1sum
+
+sha1sum
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
+Content-Disposition: form-data; name=file; filename=origFilename
+
+???
+--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--</code></pre>
+</div>
</div>
</div>
</div>
@@ -1113,14 +2054,115 @@
<h3 id="_response_status_201_2"><a class="link" href="#_response_status_201_2">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_6"><a class="link" href="#_response_fields_6">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-artifact/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Size of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.download</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Download link of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">hashes.md5</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">hashes.sha1</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">providedFilename</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Filename of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_7"><a class="link" href="#_response_example_7">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-artifact/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Length: 570
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644202166,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644202166,
+ "hashes" : {
+ "sha1" : "3b93fd2d045d59af27a25c719945db1d9fe3decb",
+ "md5" : "e94f0bfab8c987a7437ba4e1697c1cc0"
+ },
+ "providedFilename" : "origFilename",
+ "size" : 4,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/97/artifacts/46"
+ },
+ "download" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/97/artifacts/46/download"
+ }
+ },
+ "id" : 46
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1198,29 +2240,55 @@
<h3 id="_delete_arifact"><a class="link" href="#_delete_arifact">Delete arifact</a></h3>
<div class="sect3">
<h4 id="_curl_8"><a class="link" href="#_curl_8">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-artifact/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/117/artifacts/50' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_8"><a class="link" href="#_request_url_8">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-artifact/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/softwaremodules/117/artifacts/50 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_6"><a class="link" href="#_request_path_parameter_6">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-artifact/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">artifactId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_8"><a class="link" href="#_response_example_8">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-artifact/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1293,35 +2361,160 @@
<h3 id="_get_artifact_metadata"><a class="link" href="#_get_artifact_metadata">Get artifact metadata</a></h3>
<div class="sect3">
<h4 id="_curl_9"><a class="link" href="#_curl_9">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifact/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/115/artifacts/48' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_9"><a class="link" href="#_request_url_9">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifact/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/115/artifacts/48 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_7"><a class="link" href="#_request_path_parameter_7">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifact/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">artifactId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_7"><a class="link" href="#_response_status_200_7">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_7"><a class="link" href="#_response_fields_7">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifact/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Size of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">hashes.md5</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">MD5 hash of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">hashes.sha1</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">SHA1 hash of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">providedFilename</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Filename of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.download</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Download link of the artifact.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_9"><a class="link" href="#_response_example_9">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-artifact/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 565
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644258317,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644258317,
+ "hashes" : {
+ "sha1" : "8b71973e835cd0718827238b1cf89f0079e44dae",
+ "md5" : "a90218782025c48e09ba0436cf30d029"
+ },
+ "providedFilename" : "file1",
+ "size" : 5,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/115/artifacts/48"
+ },
+ "download" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/115/artifacts/48/download"
+ }
+ },
+ "id" : 48
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1394,29 +2587,66 @@
<h3 id="_download_artifact"><a class="link" href="#_download_artifact">Download artifact</a></h3>
<div class="sect3">
<h4 id="_curl_10"><a class="link" href="#_curl_10">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-download-artifact/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/116/artifacts/49/download' -i -X GET \
+ -H 'Accept: application/octet-stream'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_10"><a class="link" href="#_request_url_10">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-download-artifact/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/116/artifacts/49/download HTTP/1.1
+Accept: application/octet-stream
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_8"><a class="link" href="#_request_path_parameter_8">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-download-artifact/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">artifactId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_8"><a class="link" href="#_response_status_200_8">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_10"><a class="link" href="#_response_example_10">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-download-artifact/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Last-Modified: Thu, 01 Aug 2019 07:24:23 GMT
+Accept-Ranges: bytes
+Content-Range: bytes 0-2/3
+Content-Type: application/octet-stream
+Content-Disposition: attachment;filename=file1
+Content-Length: 3
+ETag: 2d86c2a659e364e9abba49ea6ffcd53dd5559f05
+
+???</code></pre>
+</div>
</div>
</div>
</div>
@@ -1489,32 +2719,82 @@
<h3 id="_get_a_paged_list_of_metadata"><a class="link" href="#_get_a_paged_list_of_metadata">Get a paged list of metadata</a></h3>
<div class="sect3">
<h4 id="_curl_11"><a class="link" href="#_curl_11">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/126/metadata' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_11"><a class="link" href="#_request_url_11">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/126/metadata HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_9"><a class="link" href="#_request_path_parameter_9">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_2"><a class="link" href="#_request_query_parameter_2">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_3"><a class="link" href="#_request_parameter_example_3">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/123/metadata?offset=1&limit=2&sort=key%3ADESC&q=key%3D%3Dknown* HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1522,14 +2802,91 @@
<h3 id="_response_status_200_9"><a class="link" href="#_response_status_200_9">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_8"><a class="link" href="#_response_fields_8">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].targetVisible</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_11"><a class="link" href="#_response_example_11">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 405
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "content" : [ {
+ "key" : "knownKey0",
+ "value" : "knownValue0",
+ "targetVisible" : false
+ }, {
+ "key" : "knownKey1",
+ "value" : "knownValue1",
+ "targetVisible" : false
+ }, {
+ "key" : "knownKey2",
+ "value" : "knownValue2",
+ "targetVisible" : false
+ }, {
+ "key" : "knownKey3",
+ "value" : "knownValue3",
+ "targetVisible" : false
+ } ],
+ "total" : 4,
+ "size" : 4
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1602,41 +2959,166 @@
<h3 id="_create_a_list_of_metadata_entries"><a class="link" href="#_create_a_list_of_metadata_entries">Create a list of metadata entries</a></h3>
<div class="sect3">
<h4 id="_curl_12"><a class="link" href="#_curl_12">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/105/metadata' -i -X POST \
+ -H 'Content-Type: application/hal+json;charset=UTF-8' \
+ -d '[ {
+ "value" : "knownValue1",
+ "key" : "knownKey1"
+}, {
+ "targetVisible" : true,
+ "value" : "knownValue2",
+ "key" : "knownKey2"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_12"><a class="link" href="#_request_url_12">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/softwaremodules/105/metadata HTTP/1.1
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 136
+Host: management-api.host.com
+
+[ {
+ "value" : "knownValue1",
+ "key" : "knownKey1"
+}, {
+ "targetVisible" : true,
+ "value" : "knownValue2",
+ "key" : "knownKey2"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_10"><a class="link" href="#_request_path_parameter_10">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_3"><a class="link" href="#_request_fields_3">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-metadata/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]targetVisible</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201_3"><a class="link" href="#_response_status_201_3">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_9"><a class="link" href="#_response_fields_9">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-metadata/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]targetVisible</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_12"><a class="link" href="#_response_example_12">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/post-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Length: 163
+Content-Type: application/hal+json;charset=UTF-8
+
+[ {
+ "key" : "knownKey1",
+ "value" : "knownValue1",
+ "targetVisible" : false
+}, {
+ "key" : "knownKey2",
+ "value" : "knownValue2",
+ "targetVisible" : true
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -1719,29 +3201,55 @@
<h3 id="_deleting_a_single_metadata"><a class="link" href="#_deleting_a_single_metadata">Deleting a single metadata</a></h3>
<div class="sect3">
<h4 id="_curl_13"><a class="link" href="#_curl_13">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/129/metadata/knownKey' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_13"><a class="link" href="#_request_url_13">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/softwaremodules/129/metadata/knownKey HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_11"><a class="link" href="#_request_path_parameter_11">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">{metadataKey</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_10"><a class="link" href="#_response_status_200_10">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_13"><a class="link" href="#_response_example_13">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/delete-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -1814,35 +3322,102 @@
<h3 id="_get_a_single_metadata_value"><a class="link" href="#_get_a_single_metadata_value">Get a single metadata value</a></h3>
<div class="sect3">
<h4 id="_curl_14"><a class="link" href="#_curl_14">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata-value/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/120/metadata/knownKey' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_14"><a class="link" href="#_request_url_14">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata-value/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremodules/120/metadata/knownKey HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_12"><a class="link" href="#_request_path_parameter_12">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata-value/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">metadataKey</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_11"><a class="link" href="#_response_status_200_11">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_10"><a class="link" href="#_response_fields_10">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata-value/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetVisible</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_14"><a class="link" href="#_response_example_14">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/get-metadata-value/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 77
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "key" : "knownKey",
+ "value" : "knownValue",
+ "targetVisible" : false
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1915,41 +3490,182 @@
<h3 id="_updating_a_single_metadata_value"><a class="link" href="#_updating_a_single_metadata_value">Updating a single metadata value</a></h3>
<div class="sect3">
<h4 id="_curl_15"><a class="link" href="#_curl_15">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremodules/110/metadata/knownKey' -i -X PUT \
+ -H 'Content-Type: application/hal+json;charset=UTF-8' \
+ -d '{
+ "targetVisible" : true,
+ "value" : "valueForUpdate",
+ "key" : "knownKey"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_15"><a class="link" href="#_request_url_15">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/softwaremodules/110/metadata/knownKey HTTP/1.1
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 80
+Host: management-api.host.com
+
+{
+ "targetVisible" : true,
+ "value" : "valueForUpdate",
+ "key" : "knownKey"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_13"><a class="link" href="#_request_path_parameter_13">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">metadataKey</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_4"><a class="link" href="#_request_fields_4">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-metadata/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetVisible</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_12"><a class="link" href="#_response_status_200_12">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_11"><a class="link" href="#_response_fields_11">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-metadata/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetVisible</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property is visible to targets as part of software update action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_15"><a class="link" href="#_response_example_15">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremodules-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremodules/put-software-module/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 747
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644212345,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644212357,
+ "name" : "os",
+ "description" : "a new description",
+ "version" : "1.0",
+ "type" : "os",
+ "vendor" : "another Vendor",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/99"
+ },
+ "artifacts" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/99/artifacts"
+ },
+ "type" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/112"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/99/metadata?offset=0&limit=50"
+ }
+ },
+ "id" : 99
+}</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/softwaremoduletypes-api-guide/index.html b/rest-api/softwaremoduletypes-api-guide/index.html
index 79f751c..ec1a752 100644
--- a/rest-api/softwaremoduletypes-api-guide/index.html
+++ b/rest-api/softwaremoduletypes-api-guide/index.html
@@ -443,26 +443,64 @@
<h3 id="_get_software_module_types"><a class="link" href="#_get_software_module_types">Get software module types</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-types/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremoduletypes' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url"><a class="link" href="#_request_url">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-types/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremoduletypes HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-types-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example"><a class="link" href="#_request_parameter_example">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-types-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremoduletypes?limit=10&sort=name:ASC&offset=0&q=name%3D%3Da HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -470,14 +508,163 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-types/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-types/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 1760
+Content-Type: application/json;charset=UTF-8
+
+{
+ "content" : [ {
+ "createdBy" : "system",
+ "createdAt" : 1564644698975,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644698981,
+ "name" : "OS",
+ "description" : "Updated description.",
+ "key" : "os",
+ "maxAssignments" : 1,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/368"
+ }
+ },
+ "id" : 368
+ }, {
+ "createdBy" : "system",
+ "createdAt" : 1564644698974,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644698983,
+ "name" : "Application",
+ "description" : "Updated description.",
+ "key" : "application",
+ "maxAssignments" : 2147483647,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/369"
+ }
+ },
+ "id" : 369
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644698985,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644698987,
+ "name" : "runtime",
+ "description" : "Updated description.",
+ "key" : "runtime",
+ "maxAssignments" : 1,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/370"
+ }
+ },
+ "id" : 370
+ }, {
+ "createdBy" : "uploadTester",
+ "createdAt" : 1564644699003,
+ "lastModifiedBy" : "uploadTester",
+ "lastModifiedAt" : 1564644699004,
+ "name" : "test123",
+ "description" : "Desc1234",
+ "key" : "test123",
+ "maxAssignments" : 1,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/371"
+ }
+ },
+ "id" : 371
+ } ],
+ "total" : 4,
+ "size" : 4
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -545,35 +732,200 @@
<h3 id="_creating_software_module_types"><a class="link" href="#_creating_software_module_types">Creating software module types</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/post-software-module-types/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremoduletypes' -i -X POST \
+ -H 'Accept: application/json' \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "name" : "TestName1",
+ "description" : "Desc1",
+ "maxAssignments" : 1,
+ "key" : "test1"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/post-software-module-types/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/softwaremoduletypes HTTP/1.1
+Accept: application/json
+Content-Type: application/json;charset=UTF-8
+Content-Length: 100
+Host: management-api.host.com
+
+[ {
+ "name" : "TestName1",
+ "description" : "Desc1",
+ "maxAssignments" : 1,
+ "key" : "test1"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/post-software-module-types/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The key of the software module type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]maxAssignments</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Maximum number of assignments to a distribution set/target, e.g. only one firmware but multiple applications.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201"><a class="link" href="#_response_status_201">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/post-software-module-types/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The key of the software module type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]maxAssignments</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Software modules of that type can be assigned at this maximum number (e.g. operating system only once).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/post-software-module-types/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Length: 393
+Content-Type: application/json;charset=UTF-8
+
+[ {
+ "createdBy" : "uploadTester",
+ "createdAt" : 1564644704073,
+ "lastModifiedBy" : "uploadTester",
+ "lastModifiedAt" : 1564644704073,
+ "name" : "TestName1",
+ "description" : "Desc1",
+ "key" : "test1",
+ "maxAssignments" : 1,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/375"
+ }
+ },
+ "id" : 375
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -656,29 +1008,51 @@
<h3 id="_delete_software_module_type"><a class="link" href="#_delete_software_module_type">Delete software module type</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/delete-software-module-type/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremoduletypes/359' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/delete-software-module-type/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/softwaremoduletypes/359 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/delete-software-module-type/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleTypeID</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/delete-software-module-type/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -751,35 +1125,154 @@
<h3 id="_accessing_a_software_module_type"><a class="link" href="#_accessing_a_software_module_type">Accessing a software module type</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-type/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremoduletypes/367' -i -X GET \
+ -H 'Accept: application/json'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-type/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/softwaremoduletypes/367 HTTP/1.1
+Accept: application/json
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-type/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleTypeID</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-type/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The key of the software module type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maxAssignments</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Software modules of that type can be assigned at this maximum number (e.g. operating system only once).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/get-software-module-type/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 392
+Content-Type: application/json;charset=UTF-8
+
+{
+ "createdBy" : "uploadTester",
+ "createdAt" : 1564644693946,
+ "lastModifiedBy" : "uploadTester",
+ "lastModifiedAt" : 1564644693949,
+ "name" : "test123",
+ "description" : "Desc1234",
+ "key" : "test123",
+ "maxAssignments" : 1,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/367"
+ }
+ },
+ "id" : 367
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -847,41 +1340,192 @@
<h3 id="_updating_a_software_module_types"><a class="link" href="#_updating_a_software_module_types">Updating a software module types</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/put-software-module-type/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/softwaremoduletypes/363' -i -X PUT \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "description" : "a new description"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/put-software-module-type/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/softwaremoduletypes/363 HTTP/1.1
+Content-Length: 41
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "description" : "a new description"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/put-software-module-type/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">softwareModuleTypeID</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/put-software-module-type/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/put-software-module-type/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The key of the software module type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maxAssignments</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Software modules of that type can be assigned at this maximum number (e.g. operating system only once).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in softwaremoduletypes-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/softwaremoduletypes/put-software-module-type/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 389
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644688874,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644688879,
+ "name" : "test123",
+ "description" : "a new description",
+ "key" : "test123",
+ "maxAssignments" : 1,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremoduletypes/363"
+ }
+ },
+ "id" : 363
+}</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/targetfilters-api-guide/index.html b/rest-api/targetfilters-api-guide/index.html
index 31e080e..0118272 100644
--- a/rest-api/targetfilters-api-guide/index.html
+++ b/rest-api/targetfilters-api-guide/index.html
@@ -446,8 +446,10 @@
<h3 id="_get_paged_list_of_target_filter_queries"><a class="link" href="#_get_paged_list_of_target_filter_queries">Get paged list of target filter queries</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-queries/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targetfilters' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
@@ -455,20 +457,53 @@
<div class="paragraph">
<p>A <code>GET</code> request is used to access the target filter queries</p>
</div>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-queries/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targetfilters HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-queries-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example"><a class="link" href="#_request_parameter_example">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-queries-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targetfilters?limit=10&sort=name:ASC&offset=0&q=name%3D%3D*1 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -476,14 +511,126 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-queries/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of target filter queries.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].query</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].autoAssignDistributionSet</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auto assign distribution set id</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].autoAssignActionType</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Force type of the action that provides a hint if the controller should apply the action immediately or whenever possible.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced', 'soft', 'downloadonly']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-queries/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 451
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644050389,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644050398,
+ "name" : "filter1",
+ "query" : "name==*",
+ "autoAssignDistributionSet" : 13,
+ "autoAssignActionType" : "forced",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/2"
+ }
+ },
+ "id" : 2
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -551,35 +698,182 @@
<h3 id="_create_a_target_filter_query"><a class="link" href="#_create_a_target_filter_query">Create a target filter query</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-target-filter-query/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targetfilters' -i -X POST \
+ -H 'Content-Type: application/json' \
+ -d '{
+ "query" : "name==*",
+ "name" : "filter1"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-target-filter-query/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/targetfilters HTTP/1.1
+Content-Type: application/json
+Content-Length: 47
+Host: management-api.host.com
+
+{
+ "query" : "name==*",
+ "name" : "filter1"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-target-filter-query/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">query</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201"><a class="link" href="#_response_status_201">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-target-filter-query/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">query</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">autoAssignDistributionSet</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auto assign distribution set id</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">autoAssignActionType</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Force type of the action that provides a hint if the controller should apply the action immediately or whenever possible.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced', 'soft', 'downloadonly']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.autoAssignDS</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to manage the auto assign distribution set</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-target-filter-query/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Length: 484
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644055537,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644055537,
+ "name" : "filter1",
+ "query" : "name==*",
+ "autoAssignDistributionSet" : null,
+ "autoAssignActionType" : null,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/3"
+ },
+ "autoAssignDS" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/3/autoAssignDS"
+ }
+ },
+ "id" : 3
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -657,29 +951,51 @@
<h3 id="_deleting_a_target"><a class="link" href="#_deleting_a_target">Deleting a target</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/delete-target-filter-query/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targetfilters/6' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/delete-target-filter-query/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/targetfilters/6 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/delete-target-filter-query/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQueryId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/delete-target-filter-query/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -752,35 +1068,154 @@
<h3 id="_get_single_target"><a class="link" href="#_get_single_target">Get single target</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-query/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targetfilters/5' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-query/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targetfilters/5 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-query/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQueryId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-query/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">query</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">autoAssignDistributionSet</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auto assign distribution set id</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">autoAssignActionType</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Force type of the action that provides a hint if the controller should apply the action immediately or whenever possible.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced', 'soft', 'downloadonly']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.autoAssignDS</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to manage the auto assign distribution set</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-target-filter-query/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 486
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644065981,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644066000,
+ "name" : "filter1",
+ "query" : "name==*",
+ "autoAssignDistributionSet" : 14,
+ "autoAssignActionType" : "forced",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/5"
+ },
+ "autoAssignDS" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/5/autoAssignDS"
+ }
+ },
+ "id" : 5
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -853,41 +1288,203 @@
<h3 id="_update_a_target"><a class="link" href="#_update_a_target">Update a target</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/put-target-filter-query/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targetfilters/4' -i -X PUT \
+ -H 'Content-Type: application/json' \
+ -d '{
+ "query" : "attribute.hwRevision==2",
+ "name" : "newFilterName"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/put-target-filter-query/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/targetfilters/4 HTTP/1.1
+Content-Type: application/json
+Content-Length: 69
+Host: management-api.host.com
+
+{
+ "query" : "attribute.hwRevision==2",
+ "name" : "newFilterName"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/put-target-filter-query/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQueryId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/put-target-filter-query/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">query</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/put-target-filter-query/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">query</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">autoAssignDistributionSet</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auto assign distribution set id</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">autoAssignActionType</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Force type of the action that provides a hint if the controller should apply the action immediately or whenever possible.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced', 'soft', 'downloadonly']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.autoAssignDS</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to manage the auto assign distribution set</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/put-target-filter-query/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 506
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644060655,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644060664,
+ "name" : "newFilterName",
+ "query" : "attribute.hwRevision==2",
+ "autoAssignDistributionSet" : null,
+ "autoAssignActionType" : null,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/4"
+ },
+ "autoAssignDS" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/4/autoAssignDS"
+ }
+ },
+ "id" : 4
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -970,35 +1567,247 @@
<h3 id="_get_auto_assign_distribution_set"><a class="link" href="#_get_auto_assign_distribution_set">Get auto assign distribution set</a></h3>
<div class="sect3">
<h4 id="_curl_6"><a class="link" href="#_curl_6">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-assign-d-s/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targetfilters/8/autoAssignDS' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-assign-d-s/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targetfilters/8/autoAssignDS HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-assign-d-s/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQueryId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_5"><a class="link" href="#_response_status_200_5">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-assign-d-s/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True of the distribution set software module setup is complete as defined by the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.modules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of software modules.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/get-assign-d-s/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 2374
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644081602,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644081611,
+ "name" : "DS",
+ "description" : "The descption of the distribution set.",
+ "version" : "1.0",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644081561,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644081696,
+ "name" : "application",
+ "description" : "Description of the software module",
+ "version" : "1.0.54",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/46"
+ }
+ },
+ "id" : 46
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644081569,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644081644,
+ "name" : "app runtime",
+ "description" : "Description of the software module",
+ "version" : "1.0.57",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/47"
+ }
+ },
+ "id" : 47
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644081579,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644081669,
+ "name" : "Firmware",
+ "description" : "Description of the software module",
+ "version" : "1.0.54",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/48"
+ }
+ },
+ "id" : 48
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/16"
+ },
+ "modules" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/16/assignedSM?offset=0&limit=50{&sort}",
+ "templated" : true
+ },
+ "type" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/76"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/16/metadata?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ },
+ "id" : 16
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1067,41 +1876,203 @@
<h3 id="_set_auto_assign_distribution_set"><a class="link" href="#_set_auto_assign_distribution_set">Set auto assign distribution set</a></h3>
<div class="sect3">
<h4 id="_curl_7"><a class="link" href="#_curl_7">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-auto-assign-d-s/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targetfilters/7/autoAssignDS' -i -X POST \
+ -H 'Content-Type: application/json' \
+ -d '{
+ "id" : "15",
+ "type" : "soft"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-auto-assign-d-s/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/targetfilters/7/autoAssignDS HTTP/1.1
+Content-Type: application/json
+Content-Length: 36
+Host: management-api.host.com
+
+{
+ "id" : "15",
+ "type" : "soft"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-auto-assign-d-s/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQueryId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_3"><a class="link" href="#_request_fields_3">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-auto-assign-d-s/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Id of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Force type of the action that provides a hint if the controller should apply the action immediately or whenever possible.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced', 'soft', 'downloadonly']</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_6"><a class="link" href="#_response_fields_6">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-auto-assign-d-s/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">query</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">target filter query expression</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">autoAssignDistributionSet</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Auto assign distribution set id</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">autoAssignActionType</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Force type of the action that provides a hint if the controller should apply the action immediately or whenever possible.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced', 'soft', 'downloadonly']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.autoAssignDS</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Link to manage the auto assign distribution set</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_7"><a class="link" href="#_response_example_7">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/post-auto-assign-d-s/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 484
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644076311,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644076419,
+ "name" : "filter1",
+ "query" : "name==*",
+ "autoAssignDistributionSet" : 15,
+ "autoAssignActionType" : "soft",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/7"
+ },
+ "autoAssignDS" : {
+ "href" : "https://management-api.host.com/rest/v1/targetfilters/7/autoAssignDS"
+ }
+ },
+ "id" : 7
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1179,29 +2150,51 @@
<h3 id="_removing_the_auto_assign_distribution_set"><a class="link" href="#_removing_the_auto_assign_distribution_set">Removing the auto assign distribution set</a></h3>
<div class="sect3">
<h4 id="_curl_8"><a class="link" href="#_curl_8">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/delete-auto-assign-d-s/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targetfilters/1/autoAssignDS' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_8"><a class="link" href="#_request_url_8">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/delete-auto-assign-d-s/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/targetfilters/1/autoAssignDS HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_6"><a class="link" href="#_request_path_parameter_6">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/delete-auto-assign-d-s/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetFilterQueryId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_204"><a class="link" href="#_response_status_204">Response (Status 204)</a></h3>
<div class="sect3">
<h4 id="_response_example_8"><a class="link" href="#_response_example_8">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targetfilters-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targetfilters/delete-auto-assign-d-s/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 204 No Content</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/targets-api-guide/index.html b/rest-api/targets-api-guide/index.html
index 6c7515d..6450532 100644
--- a/rest-api/targets-api-guide/index.html
+++ b/rest-api/targets-api-guide/index.html
@@ -457,8 +457,10 @@
<h3 id="_get_paged_list_of_targets"><a class="link" href="#_get_paged_list_of_targets">Get paged list of targets</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-targets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
@@ -466,20 +468,53 @@
<div class="paragraph">
<p>A <code>GET</code> request is used to access the targets</p>
</div>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-targets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-targets-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example"><a class="link" href="#_request_parameter_example">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-targets-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets?limit=10&sort=name:ASC&offset=0&q=name%3D%3Da HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -487,14 +522,161 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-targets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].updateStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current update status of the target.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['error', 'in_sync', 'pending', 'registered', 'unknown']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].securityToken</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].requestAttributes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Request re-transmission of target attributes.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].installedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Installation time of current installed DistributionSet.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].ipAddress</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last known IP address of the target. Only presented if IP address of the target itself is known (connected directly through DDI API).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastControllerRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last time where the target polled the server, same as pollStatus.lastRequestAt.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-targets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 668
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644486924,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644486943,
+ "name" : "137",
+ "description" : "My name is 137",
+ "controllerId" : "137",
+ "updateStatus" : "in_sync",
+ "lastControllerRequestAt" : 1564644486923,
+ "installedAt" : 1564644486941,
+ "ipAddress" : "192.168.0.1",
+ "address" : "http://192.168.0.1",
+ "securityToken" : "84f959a57b2cd05ee694c678e050c969",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137"
+ }
+ }
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -562,35 +744,221 @@
<h3 id="_create_list_of_targets"><a class="link" href="#_create_list_of_targets">Create list of targets</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-targets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "securityToken" : "2345678DGGDGFTDzztgf",
+ "address" : "https://192.168.0.1",
+ "controllerId" : "123456",
+ "name" : "controllerId",
+ "description" : "test"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-targets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/targets HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 169
+Host: management-api.host.com
+
+[ {
+ "securityToken" : "2345678DGGDGFTDzztgf",
+ "address" : "https://192.168.0.1",
+ "controllerId" : "123456",
+ "name" : "controllerId",
+ "description" : "test"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-targets/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]securityToken</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201"><a class="link" href="#_response_status_201">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-targets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]ipAddress</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last known IP address of the target. Only presented if IP address of the target itself is known (connected directly through DDI API).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]updateStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current update status of the target.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['error', 'in_sync', 'pending', 'registered', 'unknown']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]securityToken</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]requestAttributes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Request re-transmission of target attributes.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-targets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 497
+
+[ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644471623,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644471623,
+ "name" : "controllerId",
+ "description" : "test",
+ "controllerId" : "123456",
+ "updateStatus" : "unknown",
+ "ipAddress" : "192.168.0.1",
+ "address" : "https://192.168.0.1",
+ "securityToken" : "2345678DGGDGFTDzztgf",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/123456"
+ }
+ }
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -668,29 +1036,51 @@
<h3 id="_deleting_a_target"><a class="link" href="#_deleting_a_target">Deleting a target</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/targets/137 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -763,35 +1153,255 @@
<h3 id="_get_single_target"><a class="link" href="#_get_single_target">Get single target</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-target/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">updateStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current update status of the target.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['error', 'in_sync', 'pending', 'registered', 'unknown']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">securityToken</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">requestAttributes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Request re-transmission of target attributes.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">installedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Installation time of current installed DistributionSet.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ipAddress</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last known IP address of the target. Only presented if IP address of the target itself is known (connected directly through DDI API).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastControllerRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last time where the target polled the server, same as pollStatus.lastRequestAt.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">pollStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Poll status of the target. In many scenarios that target will poll the update server on a regular basis to look for potential updates. If that poll does not happen it might imply that the target is offline.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">pollStatus.lastRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last time when the target polled the server.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">pollStatus.nextExpectedRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Next expected time when the target polls the server.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">pollStatus.overdue</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Defines if the target poll time is overdue based on the next expected poll time plus the configured overdue poll time threshold.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.assignedDS</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to assigned distribution sets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.installedDS</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to installed distribution sets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.attributes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to attributes of the target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.actions</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to actions of the target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 1321
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644528081,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644528104,
+ "name" : "137",
+ "description" : "My name is 137",
+ "controllerId" : "137",
+ "updateStatus" : "in_sync",
+ "lastControllerRequestAt" : 1564644528081,
+ "installedAt" : 1564644528101,
+ "ipAddress" : "192.168.0.1",
+ "address" : "http://192.168.0.1",
+ "pollStatus" : {
+ "lastRequestAt" : 1564644528081,
+ "nextExpectedRequestAt" : 1564687728081,
+ "overdue" : false
+ },
+ "securityToken" : "b2811228f869eb5b8f1b0852f39f7e8f",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137"
+ },
+ "assignedDS" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/assignedDS"
+ },
+ "installedDS" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/installedDS"
+ },
+ "attributes" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/attributes"
+ },
+ "actions" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id:DESC"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -864,41 +1474,340 @@
<h3 id="_update_a_target"><a class="link" href="#_update_a_target">Update a target</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/put-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137' -i -X PUT \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "securityToken" : "2345678DGGDGFTDzztgf",
+ "requestAttributes" : true,
+ "address" : "https://192.168.0.1",
+ "controllerId" : "137",
+ "name" : "newTargetName",
+ "description" : "I've been updated"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/put-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/targets/137 HTTP/1.1
+Content-Length: 206
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "securityToken" : "2345678DGGDGFTDzztgf",
+ "requestAttributes" : true,
+ "address" : "https://192.168.0.1",
+ "controllerId" : "137",
+ "name" : "newTargetName",
+ "description" : "I've been updated"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/put-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/put-target/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">securityToken</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">requestAttributes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Request re-transmission of target attributes.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/put-target/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">updateStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current update status of the target.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['error', 'in_sync', 'pending', 'registered', 'unknown']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">securityToken</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">requestAttributes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Request re-transmission of target attributes.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">installedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Installation time of current installed DistributionSet.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ipAddress</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last known IP address of the target. Only presented if IP address of the target itself is known (connected directly through DDI API).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastControllerRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last time where the target polled the server, same as pollStatus.lastRequestAt.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">pollStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Poll status of the target. In many scenarios that target will poll the update server on a regular basis to look for potential updates. If that poll does not happen it might imply that the target is offline.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">pollStatus.lastRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last time when the target polled the server.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">pollStatus.nextExpectedRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Next expected time when the target polls the server.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">pollStatus.overdue</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Defines if the target poll time is overdue based on the next expected poll time plus the configured overdue poll time threshold.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.assignedDS</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to assigned distribution sets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.installedDS</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to installed distribution sets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.attributes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to attributes of the target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.actions</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to actions of the target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/put-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 1323
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644492065,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644492096,
+ "name" : "newTargetName",
+ "description" : "I've been updated",
+ "controllerId" : "137",
+ "updateStatus" : "in_sync",
+ "lastControllerRequestAt" : 1564644492064,
+ "installedAt" : 1564644492082,
+ "ipAddress" : "192.168.0.1",
+ "address" : "https://192.168.0.1",
+ "pollStatus" : {
+ "lastRequestAt" : 1564644492064,
+ "nextExpectedRequestAt" : 1564687692064,
+ "overdue" : false
+ },
+ "securityToken" : "2345678DGGDGFTDzztgf",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137"
+ },
+ "assignedDS" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/assignedDS"
+ },
+ "installedDS" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/installedDS"
+ },
+ "attributes" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/attributes"
+ },
+ "actions" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions?offset=0&limit=50&sort=id:DESC"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/metadata?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -981,32 +1890,82 @@
<h3 id="_list_all_actions_of_target"><a class="link" href="#_list_all_actions_of_target">List all actions of Target</a></h3>
<div class="sect3">
<h4 id="_curl_6"><a class="link" href="#_curl_6">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-actions-from-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/actions' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-actions-from-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/actions HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-actions-from-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_2"><a class="link" href="#_request_query_parameter_2">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-actions-from-target-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_2"><a class="link" href="#_request_parameter_example_2">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-actions-from-target-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/actions?limit=10&sort=id:ASC&offset=0&q=status%3D%3Dpending HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1014,20 +1973,185 @@
<h3 id="_response_status_200_5"><a class="link" href="#_response_status_200_5">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-actions-from-target-with-maintenance-window/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of actions.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Type of action.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['update', 'cancel']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Status of action.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['finished', 'pending']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[]._links</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The link to the action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ID of the action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].maintenanceWindow</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Separation of download and install by defining a maintenance window for the installation.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].maintenanceWindow.schedule</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Schedule for the maintenance window start in quartz cron notation, such as '0 15 10 * * ? 2018' for 10:15am every day during the year 2018.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].maintenanceWindow.duration</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Duration of the window, such as '02:00:00' for 2 hours.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].maintenanceWindow.timezone</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">A time-zone offset from Greenwich/UTC, such as '+02:00'.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].maintenanceWindow.nextStartAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The time (timestamp UTC in milliseconds) of the next maintenance window start</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-actions-from-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 411
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644512734,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644512748,
+ "type" : "update",
+ "status" : "finished",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions/68"
+ }
+ },
+ "id" : 68,
+ "forceType" : "forced"
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_example_with_maintenance_window"><a class="link" href="#_response_example_with_maintenance_window">Response example with Maintenance Window</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-actions-from-target-with-maintenance-window/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 583
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644558796,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644558807,
+ "type" : "update",
+ "status" : "finished",
+ "maintenanceWindow" : {
+ "schedule" : "18 31 9 1 8 ? 2019",
+ "duration" : "00:01:00",
+ "timezone" : "+02:00",
+ "nextStartAt" : 1564644678000
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions/72"
+ }
+ },
+ "id" : 72,
+ "forceType" : "forced"
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1095,41 +2219,200 @@
<h3 id="_update_a_target_2"><a class="link" href="#_update_a_target_2">Update a target</a></h3>
<div class="sect3">
<h4 id="_curl_7"><a class="link" href="#_curl_7">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/switch-action-to-forced/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/actions/62' -i -X PUT \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "forceType" : "forced"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/switch-action-to-forced/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/targets/137/actions/62 HTTP/1.1
+Content-Length: 28
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "forceType" : "forced"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/switch-action-to-forced/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_3"><a class="link" href="#_request_fields_3">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/switch-action-to-forced/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">forceType</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Set to forced in order to switch action to forced mode.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_6"><a class="link" href="#_response_fields_6">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/switch-action-to-forced/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ID of the action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Type of action.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['update', 'cancel']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">forceType</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Force type of the action that provides a hint if the controller should apply the action immediately or whenever possible.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced', 'soft', 'timeforced']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Status of action.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['finished', 'pending']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.distributionset</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The link to the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The link to all statuses of the action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_7"><a class="link" href="#_response_example_7">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/switch-action-to-forced/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 583
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644481782,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644481793,
+ "type" : "update",
+ "status" : "pending",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions/62"
+ },
+ "distributionset" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/70"
+ },
+ "status" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions/62/status?offset=0&limit=50&sort=id:DESC"
+ }
+ },
+ "id" : 62,
+ "forceType" : "forced"
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1212,32 +2495,74 @@
<h3 id="_canceling_an_active_action"><a class="link" href="#_canceling_an_active_action">Canceling an active action</a></h3>
<div class="sect3">
<h4 id="_curl_8"><a class="link" href="#_curl_8">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-action-from-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/actions/61' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_8"><a class="link" href="#_request_url_8">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-action-from-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/targets/137/actions/61 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_6"><a class="link" href="#_request_path_parameter_6">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-action-from-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_3"><a class="link" href="#_request_query_parameter_3">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-actions-from-target-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>force</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Force as boolean.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_3"><a class="link" href="#_request_parameter_example_3">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-actions-from-target-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/actions?force=true HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1245,8 +2570,10 @@
<h3 id="_response_status_204"><a class="link" href="#_response_status_204">Response (Status 204)</a></h3>
<div class="sect3">
<h4 id="_response_example_8"><a class="link" href="#_response_example_8">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-action-from-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 204 No Content</code></pre>
+</div>
</div>
</div>
</div>
@@ -1319,41 +2646,236 @@
<h3 id="_get_assigned_action_of_target"><a class="link" href="#_get_assigned_action_of_target">Get assigned action of target</a></h3>
<div class="sect3">
<h4 id="_curl_9"><a class="link" href="#_curl_9">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-action-from-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/actions/71' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_9"><a class="link" href="#_request_url_9">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-action-from-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/actions/71 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_7"><a class="link" href="#_request_path_parameter_7">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-action-from-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_7"><a class="link" href="#_response_status_200_7">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_7"><a class="link" href="#_response_fields_7">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-action-from-target-with-maintenance-window/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ID of the action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Type of action.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['update', 'cancel']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">forceType</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Force type of the action that provides a hint if the controller should apply the action immediately or whenever possible.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['forced', 'soft', 'timeforced']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">forceTime</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">In case of timeforced mode the difference, measured in milliseconds, between the time the action should switch to forced and midnight, January 1, 1970 UTC.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Status of action.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['finished', 'pending']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maintenanceWindow</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Separation of download and install by defining a maintenance window for the installation.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maintenanceWindow.schedule</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Schedule for the maintenance window start in quartz cron notation, such as '0 15 10 * * ? 2018' for 10:15am every day during the year 2018.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maintenanceWindow.duration</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Duration of the window, such as '02:00:00' for 2 hours.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maintenanceWindow.timezone</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">A time-zone offset from Greenwich/UTC, such as '+02:00'.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maintenanceWindow.nextStartAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The time (timestamp UTC in milliseconds) of the next maintenance window start</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.distributionset</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The link to the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.status</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The link to all statuses of the action.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_9"><a class="link" href="#_response_example_9">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-action-from-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 619
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644548577,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644548592,
+ "type" : "update",
+ "status" : "finished",
+ "forceTime" : 1564644548569,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions/71"
+ },
+ "distributionset" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/79"
+ },
+ "status" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions/71/status?offset=0&limit=50&sort=id:DESC"
+ }
+ },
+ "id" : 71,
+ "forceType" : "timeforced"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_response_example_with_maintenance_window_2"><a class="link" href="#_response_example_with_maintenance_window_2">Response example with Maintenance Window</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-action-from-target-with-maintenance-window/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 779
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644440883,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644440950,
+ "type" : "update",
+ "status" : "finished",
+ "forceTime" : 1564644440834,
+ "maintenanceWindow" : {
+ "schedule" : "20 29 9 1 8 ? 2019",
+ "duration" : "00:01:00",
+ "timezone" : "+02:00",
+ "nextStartAt" : 1564644560000
+ },
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions/58"
+ },
+ "distributionset" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/66"
+ },
+ "status" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/137/actions/58/status?offset=0&limit=50&sort=id:DESC"
+ }
+ },
+ "id" : 58,
+ "forceType" : "timeforced"
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1426,32 +2948,82 @@
<h3 id="_get_statuses_of_assigned_action"><a class="link" href="#_get_statuses_of_assigned_action">Get statuses of assigned action</a></h3>
<div class="sect3">
<h4 id="_curl_10"><a class="link" href="#_curl_10">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-status-from-action/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/actions/59/status' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_10"><a class="link" href="#_request_url_10">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-status-from-action/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/actions/59/status HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_8"><a class="link" href="#_request_path_parameter_8">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-status-from-action/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">actionId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter"><a class="link" href="#_request_parameter">Request parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-status-from-action-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_4"><a class="link" href="#_request_parameter_example_4">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-status-from-action-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/actions/65/status?limit=10&sort=id:ASC&offset=0 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1459,14 +3031,91 @@
<h3 id="_response_status_200_8"><a class="link" href="#_response_status_200_8">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_8"><a class="link" href="#_response_fields_8">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-status-from-action/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of action status.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].messages</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Messages related to the status.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].reportedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Time at which the status was reported (server time).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Type of the action status.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['finished', 'error', 'warning', 'pending', 'running', 'canceled', 'retrieved', 'canceling']</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_10"><a class="link" href="#_response_example_10">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-status-from-action/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 262
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "content" : [ {
+ "type" : "finished",
+ "messages" : [ null ],
+ "reportedAt" : 1564644446110,
+ "id" : 31
+ }, {
+ "type" : "running",
+ "messages" : [ null ],
+ "reportedAt" : 1564644446102,
+ "id" : 30
+ } ],
+ "total" : 2,
+ "size" : 2
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1539,35 +3188,247 @@
<h3 id="_get_assigned_distribution_set_of_target"><a class="link" href="#_get_assigned_distribution_set_of_target">Get assigned distribution set of target</a></h3>
<div class="sect3">
<h4 id="_curl_11"><a class="link" href="#_curl_11">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-assigned-distribution-set-from-action/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/assignedDS' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_11"><a class="link" href="#_request_url_11">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-assigned-distribution-set-from-action/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/assignedDS HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_9"><a class="link" href="#_request_path_parameter_9">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-assigned-distribution-set-from-action/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_9"><a class="link" href="#_response_status_200_9">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_9"><a class="link" href="#_response_fields_9">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-assigned-distribution-set-from-action/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True of the distribution set software module setup is complete as defined by the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.modules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of software modules.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_11"><a class="link" href="#_response_example_11">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-assigned-distribution-set-from-action/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 2380
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644507544,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644507546,
+ "name" : "DS",
+ "description" : "The descption of the distribution set.",
+ "version" : "1.0",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644507537,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644507556,
+ "name" : "Firmware",
+ "description" : "Description of the software module",
+ "version" : "1.0.92",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/232"
+ }
+ },
+ "id" : 232
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644507530,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644507565,
+ "name" : "application",
+ "description" : "Description of the software module",
+ "version" : "1.0.6",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/230"
+ }
+ },
+ "id" : 230
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644507534,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644507573,
+ "name" : "app runtime",
+ "description" : "Description of the software module",
+ "version" : "1.0.24",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/231"
+ }
+ },
+ "id" : 231
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/75"
+ },
+ "modules" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/75/assignedSM?offset=0&limit=50{&sort}",
+ "templated" : true
+ },
+ "type" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/360"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/75/metadata?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ },
+ "id" : 75
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1640,32 +3501,157 @@
<h3 id="_asssin_distribution_set_to_target"><a class="link" href="#_asssin_distribution_set_to_target">Asssin distribution set to target</a></h3>
<div class="sect3">
<h4 id="_curl_12"><a class="link" href="#_curl_12">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-assign-distribution-set-to-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/assignedDS' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "31 7 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644451205,
+ "id" : 68,
+ "type" : "timeforced"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_10"><a class="link" href="#_request_path_parameter_10">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-assign-distribution-set-to-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_4"><a class="link" href="#_request_query_parameter_4">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-assign-distribution-set-to-target/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offline</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Offline update (set param to true) that is only reported but not managed by the service, e.g. defaults set in factory, manual updates or migrations from other update systems. A completed action is added to the history of the target(s). Target is set to IN_SYNC state as both assigend and installed DS are set. Note: only executed if the target has currently no running update.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_4"><a class="link" href="#_request_fields_4">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-assign-distribution-set-to-target/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">forcetime</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Forcetime in milliseconds.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maintenanceWindow</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Separation of download and install by defining a maintenance window for the installation.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maintenanceWindow.schedule</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Schedule for the maintenance window start in quartz cron notation, such as '0 15 10 * * ? 2018' for 10:15am every day during the year 2018.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maintenanceWindow.duration</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Duration of the window, such as '02:00:00' for 2 hours.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">maintenanceWindow.timezone</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">A time-zone offset from Greenwich/UTC, such as '+02:00'.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the forcetime.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['soft', 'forced','timeforced', 'downloadonly']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_url_12"><a class="link" href="#_request_url_12">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-assign-distribution-set-to-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/targets/137/assignedDS HTTP/1.1
+Content-Length: 196
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "maintenanceWindow" : {
+ "duration" : "00:10:00",
+ "schedule" : "31 7 11 1 8 ? 2019",
+ "timezone" : "+02:00"
+ },
+ "forcetime" : 1564644451205,
+ "id" : 68,
+ "type" : "timeforced"
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1673,8 +3659,18 @@
<h3 id="_response_status_200_10"><a class="link" href="#_response_status_200_10">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_12"><a class="link" href="#_response_example_12">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/post-assign-distribution-set-to-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 60
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "assigned" : 1,
+ "alreadyAssigned" : 0,
+ "total" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1757,29 +3753,58 @@
<h3 id="_get_attributes_of_target"><a class="link" href="#_get_attributes_of_target">Get attributes of target</a></h3>
<div class="sect3">
<h4 id="_curl_13"><a class="link" href="#_curl_13">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-controller-attributes/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/attributes' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_13"><a class="link" href="#_request_url_13">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-controller-attributes/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/attributes HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_11"><a class="link" href="#_request_path_parameter_11">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-controller-attributes/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_11"><a class="link" href="#_response_status_200_11">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_13"><a class="link" href="#_response_example_13">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-controller-attributes/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 28
+
+{
+ "a" : "1",
+ "b" : "2"
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1852,35 +3877,247 @@
<h3 id="_get_installed_distribution_set_of_target"><a class="link" href="#_get_installed_distribution_set_of_target">Get installed distribution set of target</a></h3>
<div class="sect3">
<h4 id="_curl_14"><a class="link" href="#_curl_14">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-installed-distribution-set-from-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/installedDS' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_14"><a class="link" href="#_request_url_14">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-installed-distribution-set-from-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/installedDS HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_12"><a class="link" href="#_request_path_parameter_12">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-installed-distribution-set-from-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_12"><a class="link" href="#_response_status_200_12">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_10"><a class="link" href="#_response_fields_10">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-installed-distribution-set-from-target/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">requiredMigrationStep</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">complete</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">True of the distribution set software module setup is complete as defined by the distribution set type.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deleted</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Deleted flag, used for soft deleted entities</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Package version.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The type of the distribution set.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.metadata</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.modules</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of software modules.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_14"><a class="link" href="#_response_example_14">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-installed-distribution-set-from-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 2381
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644502370,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644502376,
+ "name" : "DS",
+ "description" : "The descption of the distribution set.",
+ "version" : "1.0",
+ "modules" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644502350,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644502397,
+ "name" : "app runtime",
+ "description" : "Description of the software module",
+ "version" : "1.0.54",
+ "type" : "runtime",
+ "vendor" : "vendor GmbH, Stuttgart, Germany",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/228"
+ }
+ },
+ "id" : 228
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644502345,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644502405,
+ "name" : "application",
+ "description" : "Description of the software module",
+ "version" : "1.0.71",
+ "type" : "application",
+ "vendor" : "vendor Limited, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/227"
+ }
+ },
+ "id" : 227
+ }, {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644502355,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644502389,
+ "name" : "Firmware",
+ "description" : "Description of the software module",
+ "version" : "1.0.78",
+ "type" : "os",
+ "vendor" : "vendor Limited Inc, California",
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/softwaremodules/229"
+ }
+ },
+ "id" : 229
+ } ],
+ "requiredMigrationStep" : false,
+ "type" : "test_default_ds_type",
+ "complete" : true,
+ "deleted" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/74"
+ },
+ "modules" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/74/assignedSM?offset=0&limit=50{&sort}",
+ "templated" : true
+ },
+ "type" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsettypes/356"
+ },
+ "metadata" : {
+ "href" : "https://management-api.host.com/rest/v1/distributionsets/74/metadata?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ },
+ "id" : 74
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1953,32 +4190,82 @@
<h3 id="_get_a_paged_list_of_meta_data"><a class="link" href="#_get_a_paged_list_of_meta_data">Get a paged list of meta data</a></h3>
<div class="sect3">
<h4 id="_curl_15"><a class="link" href="#_curl_15">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/metadata' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_15"><a class="link" href="#_request_url_15">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/metadata HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_13"><a class="link" href="#_request_path_parameter_13">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_query_parameter_5"><a class="link" href="#_request_query_parameter_5">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example_5"><a class="link" href="#_request_parameter_example_5">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/metadata?offset=1&limit=2&sort=key%3ADESC&q=key%3D%3Dknown* HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -1986,14 +4273,81 @@
<h3 id="_response_status_200_13"><a class="link" href="#_response_status_200_13">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_11"><a class="link" href="#_response_fields_11">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of metadata.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_15"><a class="link" href="#_response_example_15">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 289
+
+{
+ "content" : [ {
+ "key" : "knownKey0",
+ "value" : "knownValue0"
+ }, {
+ "key" : "knownKey1",
+ "value" : "knownValue1"
+ }, {
+ "key" : "knownKey2",
+ "value" : "knownValue2"
+ }, {
+ "key" : "knownKey3",
+ "value" : "knownValue3"
+ } ],
+ "total" : 4,
+ "size" : 4
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -2061,35 +4415,116 @@
<h3 id="_create_a_list_of_meta_data_entries"><a class="link" href="#_create_a_list_of_meta_data_entries">Create a list of meta data entries</a></h3>
<div class="sect3">
<h4 id="_curl_16"><a class="link" href="#_curl_16">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/create-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/metadata' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "value" : "knownValue1",
+ "key" : "knownKey1"
+}, {
+ "value" : "knownValue2",
+ "key" : "knownKey2"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_16"><a class="link" href="#_request_url_16">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/create-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/targets/137/metadata HTTP/1.1
+Content-Length: 110
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "value" : "knownValue1",
+ "key" : "knownKey1"
+}, {
+ "value" : "knownValue2",
+ "key" : "knownKey2"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_14"><a class="link" href="#_request_path_parameter_14">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/create-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_5"><a class="link" href="#_request_fields_5">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/create-metadata/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_14"><a class="link" href="#_response_status_200_14">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_16"><a class="link" href="#_response_example_16">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/create-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Length: 110
+Content-Type: application/hal+json;charset=UTF-8
+
+[ {
+ "key" : "knownKey1",
+ "value" : "knownValue1"
+}, {
+ "key" : "knownKey2",
+ "value" : "knownValue2"
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -2172,29 +4607,55 @@
<h3 id="_delete_a_single_meta_data"><a class="link" href="#_delete_a_single_meta_data">Delete a single meta data</a></h3>
<div class="sect3">
<h4 id="_curl_17"><a class="link" href="#_curl_17">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/metadata/knownKey' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_17"><a class="link" href="#_request_url_17">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/targets/137/metadata/knownKey HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_15"><a class="link" href="#_request_path_parameter_15">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_15"><a class="link" href="#_response_status_200_15">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_17"><a class="link" href="#_response_example_17">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/delete-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -2267,35 +4728,95 @@
<h3 id="_get_a_single_meta_data_value"><a class="link" href="#_get_a_single_meta_data_value">Get a single meta data value</a></h3>
<div class="sect3">
<h4 id="_curl_18"><a class="link" href="#_curl_18">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata-value/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/metadata/knownKey' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_18"><a class="link" href="#_request_url_18">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata-value/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targets/137/metadata/knownKey HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_16"><a class="link" href="#_request_path_parameter_16">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata-value/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">metadatakey</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_16"><a class="link" href="#_response_status_200_16">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_12"><a class="link" href="#_response_fields_12">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata-value/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_18"><a class="link" href="#_response_example_18">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/get-metadata-value/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 50
+Content-Type: application/json;charset=UTF-8
+
+{
+ "key" : "knownKey",
+ "value" : "knownValue"
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -2363,41 +4884,144 @@
<h3 id="_update_a_single_meta_data_value"><a class="link" href="#_update_a_single_meta_data_value">Update a single meta data value</a></h3>
<div class="sect3">
<h4 id="_curl_19"><a class="link" href="#_curl_19">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/update-metadata/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targets/137/metadata/knownKey' -i -X PUT \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "value" : "valueForUpdate",
+ "key" : "knownKey"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_19"><a class="link" href="#_request_url_19">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/update-metadata/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/targets/137/metadata/knownKey HTTP/1.1
+Content-Length: 54
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "value" : "valueForUpdate",
+ "key" : "knownKey"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_17"><a class="link" href="#_request_path_parameter_17">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/update-metadata/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">metadatakey</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_6"><a class="link" href="#_request_fields_6">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/update-metadata/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_17"><a class="link" href="#_response_status_200_17">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_13"><a class="link" href="#_response_fields_13">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/update-metadata/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property key.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Metadata property value.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_19"><a class="link" href="#_response_example_19">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targets-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targets/update-metadata/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 54
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "key" : "knownKey",
+ "value" : "valueForUpdate"
+}</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/targettag-api-guide/index.html b/rest-api/targettag-api-guide/index.html
index 6f5e1cb..3cfbd52 100644
--- a/rest-api/targettag-api-guide/index.html
+++ b/rest-api/targettag-api-guide/index.html
@@ -447,8 +447,10 @@
<h3 id="_get_paged_list_of_target_tags"><a class="link" href="#_get_paged_list_of_target_tags">Get paged list of target tags</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tags/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targettags' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
@@ -456,20 +458,53 @@
<div class="paragraph">
<p>A <code>GET</code> request is used to access the target tags</p>
</div>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tags/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targettags HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_query_parameter"><a class="link" href="#_request_query_parameter">Request query parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tags-with-parameters/request-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>limit</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The maximum number of entries in a page (default is 50).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>offset</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The paging offset (default is 0).</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>q</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_parameter_example"><a class="link" href="#_request_parameter_example">Request parameter example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tags-with-parameters/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targettags?limit=10&sort=name:ASC&offset=0&q=name%3D%3DtargetTag HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -477,14 +512,119 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tags/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tags/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 418
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644748713,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644748715,
+ "name" : "targetTag",
+ "description" : "My name is targetTag",
+ "colour" : "default",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targettags/6"
+ }
+ },
+ "id" : 6
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -552,8 +692,10 @@
<h3 id="_get_a_single_target_tag"><a class="link" href="#_get_a_single_target_tag">Get a single target tag</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tag/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targettags/3' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
@@ -561,29 +703,140 @@
<div class="paragraph">
<p>A <code>GET</code> request is used to access the target tag</p>
</div>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tag/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targettags/3 HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tag/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tag/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.assignedTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to assigned targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-target-tag/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 504
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644733343,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644733346,
+ "name" : "targetTag",
+ "description" : "My name is targetTag",
+ "colour" : "default",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targettags/3"
+ },
+ "assignedTargets" : {
+ "href" : "https://management-api.host.com/rest/v1/targettags/3/assigned?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ },
+ "id" : 3
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -651,35 +904,175 @@
<h3 id="_create_list_of_target_tags"><a class="link" href="#_create_list_of_target_tags">Create list of target tags</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/create-target-tags/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targettags' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "colour" : "red",
+ "name" : "target tag",
+ "description" : "target tag description"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/create-target-tags/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/targettags HTTP/1.1
+Content-Length: 95
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+[ {
+ "colour" : "red",
+ "name" : "target tag",
+ "description" : "target tag description"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/create-target-tags/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_201"><a class="link" href="#_response_status_201">Response (Status 201)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/create-target-tags/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/create-target-tags/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 342
+
+[ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644722903,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644722903,
+ "name" : "target tag",
+ "description" : "target tag description",
+ "colour" : "red",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targettags/1"
+ }
+ },
+ "id" : 1
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -757,41 +1150,206 @@
<h3 id="_update_a_target_tag"><a class="link" href="#_update_a_target_tag">Update a target tag</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">Curl</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/update-tagret-tag/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targettags/4' -i -X PUT \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '{
+ "colour" : "red",
+ "name" : "target tag",
+ "description" : "target tag description"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/update-tagret-tag/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/targettags/4 HTTP/1.1
+Content-Length: 91
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com
+
+{
+ "colour" : "red",
+ "name" : "target tag",
+ "description" : "target tag description"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/update-tagret-tag/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields_2"><a class="link" href="#_request_fields_2">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/update-tagret-tag/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_4"><a class="link" href="#_response_fields_4">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/update-tagret-tag/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">colour</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The colour of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">_links.assignedTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Object</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Links to assigned targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/update-tagret-tag/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 503
+
+{
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644738448,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644738454,
+ "name" : "target tag",
+ "description" : "target tag description",
+ "colour" : "red",
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targettags/4"
+ },
+ "assignedTargets" : {
+ "href" : "https://management-api.host.com/rest/v1/targettags/4/assigned?offset=0&limit=50{&sort,q}",
+ "templated" : true
+ }
+ },
+ "id" : 4
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -874,29 +1432,53 @@
<h3 id="_deleting_a_target_tag"><a class="link" href="#_deleting_a_target_tag">Deleting a target tag</a></h3>
<div class="sect3">
<h4 id="_curl_5"><a class="link" href="#_curl_5">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/delete-target-tag/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targettags/5' -i -X DELETE \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_5"><a class="link" href="#_request_url_5">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/delete-target-tag/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/targettags/5 HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/delete-target-tag/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_4"><a class="link" href="#_response_status_200_4">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_5"><a class="link" href="#_response_example_5">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/delete-target-tag/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
@@ -969,35 +1551,204 @@
<h3 id="_get_a_list_of_assigned_targets"><a class="link" href="#_get_a_list_of_assigned_targets">Get a list of assigned targets</a></h3>
<div class="sect3">
<h4 id="_curl_6"><a class="link" href="#_curl_6">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-assigned-targets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targettags/2/assigned' -i -X GET \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_6"><a class="link" href="#_request_url_6">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-assigned-targets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/targettags/2/assigned HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_4"><a class="link" href="#_request_path_parameter_4">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-assigned-targets/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_5"><a class="link" href="#_response_status_200_5">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_5"><a class="link" href="#_response_fields_5">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-assigned-targets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].updateStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current update status of the target.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['error', 'in_sync', 'pending', 'registered', 'unknown']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].securityToken</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].requestAttributes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Request re-transmission of target attributes.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].installedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Installation time of current installed DistributionSet.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].ipAddress</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last known IP address of the target. Only presented if IP address of the target itself is known (connected directly through DDI API).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content[].lastControllerRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last time where the target polled the server, same as pollStatus.lastRequestAt.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current page size</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">total</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Total number of elements</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">content</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List of provisioning targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_6"><a class="link" href="#_response_example_6">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/get-assigned-targets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 684
+
+{
+ "content" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644728095,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644728237,
+ "name" : "Target1",
+ "description" : "My name is Target1",
+ "controllerId" : "Target1",
+ "updateStatus" : "in_sync",
+ "lastControllerRequestAt" : 1564644728050,
+ "installedAt" : 1564644728220,
+ "ipAddress" : "192.168.0.1",
+ "address" : "http://192.168.0.1",
+ "securityToken" : "deaddfdf8e1c7640b777b070ad056f37",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/Target1"
+ }
+ }
+ } ],
+ "total" : 1,
+ "size" : 1
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1070,35 +1821,133 @@
<h3 id="_toogle_target_assignment"><a class="link" href="#_toogle_target_assignment">Toogle target assignment</a></h3>
<div class="sect3">
<h4 id="_curl_7"><a class="link" href="#_curl_7">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/toggle-tag-assignment/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targettags/10/assigned/toggleTagAssignment' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "controllerId" : "Target1"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_7"><a class="link" href="#_request_url_7">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/toggle-tag-assignment/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/targettags/10/assigned/toggleTagAssignment HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 36
+Host: management-api.host.com
+
+[ {
+ "controllerId" : "Target1"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields_3"><a class="link" href="#_request_fields_3">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/toggle-tag-assignment/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_6"><a class="link" href="#_response_status_200_6">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_6"><a class="link" href="#_response_fields_6">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/toggle-tag-assignment/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">assignedTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array[Object]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Assigned targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">unassignedTargets</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Array[Object]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Unassigned targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_7"><a class="link" href="#_response_example_7">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/toggle-tag-assignment/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 773
+
+{
+ "assignedTargets" : [ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644769340,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644769375,
+ "name" : "Target1",
+ "description" : "My name is Target1",
+ "controllerId" : "Target1",
+ "updateStatus" : "pending",
+ "lastControllerRequestAt" : 1564644769339,
+ "ipAddress" : "192.168.0.1",
+ "address" : "http://192.168.0.1",
+ "securityToken" : "13fcd5073f8c9f89690c4e01ec6c799b",
+ "requestAttributes" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/targets/Target1",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ } ],
+ "unassignedTargets" : [ ]
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -1176,35 +2025,199 @@
<h3 id="_target_assignment"><a class="link" href="#_target_assignment">Target assignment</a></h3>
<div class="sect3">
<h4 id="_curl_8"><a class="link" href="#_curl_8">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/assign-targets/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targettags/8/assigned' -i -X POST \
+ -H 'Content-Type: application/json;charset=UTF-8' \
+ -d '[ {
+ "controllerId" : "Target1"
+} ]'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_8"><a class="link" href="#_request_url_8">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/assign-targets/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /rest/v1/targettags/8/assigned HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Content-Length: 36
+Host: management-api.host.com
+
+[ {
+ "controllerId" : "Target1"
+} ]</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_fields_4"><a class="link" href="#_request_fields_4">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/assign-targets/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_7"><a class="link" href="#_response_status_200_7">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_7"><a class="link" href="#_response_fields_7">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/assign-targets/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]address</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The description of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]updateStatus</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">enum</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current update status of the target.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['error', 'in_sync', 'pending', 'registered', 'unknown']</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]securityToken</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]requestAttributes</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Request re-transmission of target attributes.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]installedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Installation time of current installed DistributionSet.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]ipAddress</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last known IP address of the target. Only presented if IP address of the target itself is known (connected directly through DDI API).</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[]lastControllerRequestAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Last time where the target polled the server, same as pollStatus.lastRequestAt.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_8"><a class="link" href="#_response_example_8">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/assign-targets/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 597
+
+[ {
+ "createdBy" : "bumlux",
+ "createdAt" : 1564644758974,
+ "lastModifiedBy" : "bumlux",
+ "lastModifiedAt" : 1564644758999,
+ "name" : "Target1",
+ "description" : "My name is Target1",
+ "controllerId" : "Target1",
+ "updateStatus" : "in_sync",
+ "lastControllerRequestAt" : 1564644758973,
+ "installedAt" : 1564644758989,
+ "ipAddress" : "192.168.0.1",
+ "address" : "http://192.168.0.1",
+ "securityToken" : "7e96e5a9f69817afa4a289b0679eeadf",
+ "requestAttributes" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/targets/Target1"
+ }
+ }
+} ]</code></pre>
+</div>
</div>
</div>
</div>
@@ -1282,29 +2295,57 @@
<h3 id="_unassign_a_target"><a class="link" href="#_unassign_a_target">Unassign a target</a></h3>
<div class="sect3">
<h4 id="_curl_9"><a class="link" href="#_curl_9">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/unassign-target/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/targettags/7/assigned/targetExist' -i -X DELETE \
+ -H 'Content-Type: application/json;charset=UTF-8'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_9"><a class="link" href="#_request_url_9">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/unassign-target/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/targettags/7/assigned/targetExist HTTP/1.1
+Content-Type: application/json;charset=UTF-8
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_5"><a class="link" href="#_request_path_parameter_5">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/unassign-target/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">targetTagId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">controllerId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The technical identifier of the entity</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_8"><a class="link" href="#_response_status_200_8">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_example_9"><a class="link" href="#_response_example_9">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in targettag-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/targettag/unassign-target/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
diff --git a/rest-api/tenant-api-guide/index.html b/rest-api/tenant-api-guide/index.html
index d70d980..19d9bc1 100644
--- a/rest-api/tenant-api-guide/index.html
+++ b/rest-api/tenant-api-guide/index.html
@@ -442,14 +442,19 @@
<h3 id="_get_all_configuration_parameters"><a class="link" href="#_get_all_configuration_parameters">Get all configuration parameters</a></h3>
<div class="sect3">
<h4 id="_curl"><a class="link" href="#_curl">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/get-tenant-configrations/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/system/configs/' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url"><a class="link" href="#_request_url">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/get-tenant-configrations/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/system/configs/ HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
</div>
@@ -457,14 +462,340 @@
<h3 id="_response_status_200"><a class="link" href="#_response_status_200">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields"><a class="link" href="#_response_fields">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/get-tenant-configrations/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['rollout.approval.enabled']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'rollout.approval.enabled' defines if approval mode for Rollout Management is enabled.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['repository.actions.autoclose.enabled']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'repository.actions.autoclose.enabled' defines if autoclose running actions with new Distribution Set assignment is enabled.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['authentication.gatewaytoken.enabled']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'authentication.gatewaytoken.enabled' defines if the authentication mode 'gateway security token' is enabled.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['action.cleanup.enabled']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'action.cleanup.enabled' defines if automatic cleanup of deployment actions is enabled.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['action.cleanup.actionExpiry']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Long</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'action.cleanup.actionExpiry' defines the expiry time in milliseconds that needs to elapse before an action may be cleaned up.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['authentication.header.enabled']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'authentication.header.enabled' defines if the authentication mode 'authority header' is enabled.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['maintenanceWindowPollCount']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Integer</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'maintenanceWindowPollCount' defines the polling interval so that controller tries to poll at least these many times between the last polling and before start of maintenance window. The polling interval is bounded by configured pollingTime and minPollingTime. The polling interval is modified as per following scheme: pollingTime(@time=t) = (maintenanceWindowStartTime - t)/maintenanceWindowPollCount.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['authentication.targettoken.enabled']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'authentication.targettoken.enabled' defines if the authentication mode 'target security token' is enabled.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['pollingTime']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'pollingTime' defines the time interval between two poll requests of a target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['anonymous.download.enabled']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'anonymous.download.enabled' defines if the anonymous download mode is enabled.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['authentication.header.authority']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'authentication.header.authority' defines the name of the 'authority header'.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['minPollingTime']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'minPollingTime' defines the smallest time interval permitted between two poll requests of a target.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['authentication.gatewaytoken.key']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'authentication.gatewaytoken.key' defines the key of the gateway security token.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['action.cleanup.actionStatus']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'action.cleanup.actionStatus' defines the list of action status that should be taken into account for the cleanup.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['pollingOverdueTime']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'pollingOverdueTime' defines the period of time after the SP server will recognize a target, which is not performing pull requests anymore.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">['multi.assignments.enabled']</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The configuration key 'multi.assignments.enabled' defines if multiple distribution sets can be assigned to the same targets.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example"><a class="link" href="#_response_example">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/get-tenant-configrations/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 5574
+
+{
+ "anonymous.download.enabled" : {
+ "value" : false,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/anonymous.download.enabled",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "authentication.header.authority" : {
+ "value" : "",
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/authentication.header.authority",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "authentication.gatewaytoken.enabled" : {
+ "value" : false,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.enabled",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "authentication.gatewaytoken.key" : {
+ "value" : "",
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "action.cleanup.actionStatus" : {
+ "value" : "CANCELED,ERROR",
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/action.cleanup.actionStatus",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "action.cleanup.enabled" : {
+ "value" : false,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/action.cleanup.enabled",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "pollingTime" : {
+ "value" : "12:00:00",
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/pollingTime",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "authentication.targettoken.enabled" : {
+ "value" : false,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/authentication.targettoken.enabled",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "rollout.approval.enabled" : {
+ "value" : false,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/rollout.approval.enabled",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "maintenanceWindowPollCount" : {
+ "value" : 3,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/maintenanceWindowPollCount",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "repository.actions.autoclose.enabled" : {
+ "value" : false,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/repository.actions.autoclose.enabled",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "action.cleanup.actionExpiry" : {
+ "value" : 2592000000,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/action.cleanup.actionExpiry",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "pollingOverdueTime" : {
+ "value" : "23:59:59",
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/pollingOverdueTime",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "authentication.header.enabled" : {
+ "value" : true,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/authentication.header.enabled",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "minPollingTime" : {
+ "value" : "00:00:30",
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/minPollingTime",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ },
+ "multi.assignments.enabled" : {
+ "value" : false,
+ "global" : true,
+ "links" : [ {
+ "rel" : "self",
+ "href" : "https://management-api.host.com/rest/v1/system/configs/multi.assignments.enabled",
+ "hreflang" : null,
+ "media" : null,
+ "title" : null,
+ "type" : null,
+ "deprecation" : null
+ } ]
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -537,35 +868,120 @@
<h3 id="_read_a_configuration_parameter"><a class="link" href="#_read_a_configuration_parameter">Read a configuration parameter</a></h3>
<div class="sect3">
<h4 id="_curl_2"><a class="link" href="#_curl_2">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/get-tenant-configration/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key/' -i -X GET</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_2"><a class="link" href="#_request_url_2">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/get-tenant-configration/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /rest/v1/system/configs/authentication.gatewaytoken.key/ HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter"><a class="link" href="#_request_path_parameter">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/get-tenant-configration/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">keyName</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the configuration parameter.</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_2"><a class="link" href="#_response_status_200_2">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/get-tenant-configration/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current value of of configuration parameter.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">global</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true - if the current value is the global configuration value, false - if there is a tenant specific value configured.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_2"><a class="link" href="#_response_example_2">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/get-tenant-configration/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Length: 182
+Content-Type: application/hal+json;charset=UTF-8
+
+{
+ "value" : "",
+ "global" : true,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key"
+ }
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -638,41 +1054,164 @@
<h3 id="_change_a_configuration_parameter"><a class="link" href="#_change_a_configuration_parameter">Change a configuration parameter</a></h3>
<div class="sect3">
<h4 id="_curl_3"><a class="link" href="#_curl_3">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/put-tenant-configration/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key/' -i -X PUT \
+ -H 'Content-Type: application/json' \
+ -d '{
+ "value" : "exampleToken"
+}'</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_3"><a class="link" href="#_request_url_3">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/put-tenant-configration/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /rest/v1/system/configs/authentication.gatewaytoken.key/ HTTP/1.1
+Content-Length: 30
+Content-Type: application/json
+Host: management-api.host.com
+
+{
+ "value" : "exampleToken"
+}</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_2"><a class="link" href="#_request_path_parameter_2">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/put-tenant-configration/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">keyName</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the configuration parameter.</p></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_request_fields"><a class="link" href="#_request_fields">Request fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/put-tenant-configration/request-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+<th class="tableblock halign-left valign-top">Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current value of of configuration parameter.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">X</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_200_3"><a class="link" href="#_response_status_200_3">Response (Status 200)</a></h3>
<div class="sect3">
<h4 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response fields</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/put-tenant-configration/response-fields.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 25%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Allowed Values</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Current value of of configuration parameter.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">global</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Boolean</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true - if the current value is the global configuration value, false - if there is a tenant specific value configured.</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">createdAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was originally created at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedAt</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified at (timestamp UTC in milliseconds)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">lastModifiedBy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Entity was last modified by User, AMQP-Controller, anonymous etc.)</p></td>
+<td class="tableblock halign-left valign-top"></td>
+</tr>
+</tbody>
+</table>
</div>
<div class="sect3">
<h4 id="_response_example_3"><a class="link" href="#_response_example_3">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/put-tenant-configration/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
+Content-Type: application/hal+json;charset=UTF-8
+Content-Length: 319
+
+{
+ "value" : "exampleToken",
+ "lastModifiedAt" : 1564644798708,
+ "lastModifiedBy" : "bumlux",
+ "createdAt" : 1564644798708,
+ "createdBy" : "bumlux",
+ "global" : false,
+ "_links" : {
+ "self" : {
+ "href" : "https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key"
+ }
+ }
+}</code></pre>
+</div>
</div>
</div>
</div>
@@ -755,29 +1294,51 @@
<h3 id="_removes_a_configuration_parameter"><a class="link" href="#_removes_a_configuration_parameter">Removes a configuration parameter</a></h3>
<div class="sect3">
<h4 id="_curl_4"><a class="link" href="#_curl_4">CURL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/delete-tenant-configration/curl-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://management-api.host.com/rest/v1/system/configs/authentication.gatewaytoken.key/' -i -X DELETE</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_url_4"><a class="link" href="#_request_url_4">Request URL</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/delete-tenant-configration/http-request.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /rest/v1/system/configs/authentication.gatewaytoken.key/ HTTP/1.1
+Host: management-api.host.com</code></pre>
+</div>
</div>
</div>
<div class="sect3">
<h4 id="_request_path_parameter_3"><a class="link" href="#_request_path_parameter_3">Request path parameter</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/delete-tenant-configration/path-parameters.adoc[]</p>
-</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Parameter</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">keyName</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the configuration parameter.</p></td>
+</tr>
+</tbody>
+</table>
</div>
</div>
<div class="sect2">
<h3 id="_response_status_204"><a class="link" href="#_response_status_204">Response (Status 204)</a></h3>
<div class="sect3">
<h4 id="_response_example_4"><a class="link" href="#_response_example_4">Response example</a></h4>
-<div class="paragraph">
-<p>Unresolved directive in tenant-api-guide.adoc - include::/Users/laverman/IdeaProjects/hawkbit/hawkbit-rest/hawkbit-rest-docs/target/generated-snippets/tenant/delete-tenant-configration/http-response.adoc[]</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK</code></pre>
+</div>
</div>
</div>
</div>
