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

fix distribution set tag api doc (#1219)

Browse Source 
Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>
This commit is contained in:
Natalia Kislicyn
2022-01-13 10:21:39 +01:00
committed by GitHub
parent 476d1c37ed
commit 94d9e373b8
4 changed files with 21 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/distributionsettag-api-guide.adoc
View File

@@ -26,7 +26,7 @@ include::{snippets}/distributionsettag/get-distribution-set-tags/curl-request.ad
==== Request URL
A `GET` request is used to access the distribution set tags
A `GET` request is used to access the distribution set tags.
include::{snippets}/distributionsettag/get-distribution-set-tags/http-request.adoc[]
@@ -76,7 +76,7 @@ include::{snippets}/distributionsettag/get-distribution-set-tag/curl-request.ado
==== Request URL
A `GET` request is used to access the distribution set tag
A `GET` request is used to access the distribution set tag.
include::{snippets}/distributionsettag/get-distribution-set-tag/http-request.adoc[]
@@ -153,6 +153,7 @@ include::../errors/415.adoc[]
include::../errors/429.adoc[]
|===
== PUT /rest/v1/distributionsettags/{distributionsetTagId}
=== Implementation Notes
@@ -247,7 +248,7 @@ include::../errors/429.adoc[]
|===
== GET /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets
== GET /rest/v1/distributionsettags/{distributionsetTagId}/assigned
=== Implementation Notes
@@ -292,13 +293,14 @@ include::../errors/429.adoc[]
|===
== POST /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets/toggleTagAssignment
== POST /rest/v1/distributionsettags/{distributionsetTagId}/assigned/toggleTagAssignment
=== Implementation Notes
Handles the POST request of toogle distribution assignment. The request body must always be a list of controller ids.
Handles the POST request of toggle distribution assignment.
The request body must always be a list of distribution set ids.
=== Toogle distribution assignment
=== Toggle distribution assignment
==== CURL
@@ -337,7 +339,8 @@ include::../errors/415.adoc[]
include::../errors/429.adoc[]
|===
== POST /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets
== POST /rest/v1/distributionsettags/{distributionsetTagId}/assigned
=== Implementation Notes
@@ -382,11 +385,12 @@ include::../errors/415.adoc[]
include::../errors/429.adoc[]
|===
== DELETE /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets/{distributionsetId}
== DELETE /rest/v1/distributionsettags/{distributionsetTagId}/assigned/{distributionsetId}
=== Implementation Notes
Handles the DELETE request of unassign the given distribution.
Handles the DELETE request of unassign the given distribution.
=== Unassign a distribution
@@ -422,6 +426,7 @@ include::../errors/406.adoc[]
include::../errors/429.adoc[]
|===
== Additional content
[[error-body]]