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

Colour property in Mgmt API response for DS/SM type (#1174)

Browse Source 
* Update name SP to hawkbit in api guide adocs

Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>

* fix javadoc class descriptions of existing resource/api classes

Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>

* Add color property to api response of ds/sw type

Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>

* Add color property to sw type test data & adapt rest docu

Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>

* Add missing property description for "colour" and "deleted"

Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>

* fix review findings

Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>
This commit is contained in:
Natalia Kislicyn
2021-09-02 10:09:17 +02:00
committed by GitHub
parent 42b1fc9439
commit b5fcb48ab1
25 changed files with 176 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/distributionsets-api-guide.adoc
View File

@@ -15,7 +15,7 @@ toc::[]
=== Implementation notes
Handles the GET request of retrieving all distribution sets within SP. Required permission: READ_REPOSITORY
Handles the GET request of retrieving all distribution sets within Hawkbit. Required permission: READ_REPOSITORY
=== Get paged list of Distribution Sets
@@ -62,7 +62,7 @@ include::../errors/429.adoc[]
== POST /rest/v1/distributionsets
=== Implementation Notes
Handles the POST request of creating new distribution sets within SP. The request body must always be a list of sets. Required permission: CREATE_REPOSITORY
Handles the POST request of creating new distribution sets within Hawkbit. The request body must always be a list of sets. Required permission: CREATE_REPOSITORY
=== Create Distribution Sets
@@ -111,7 +111,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the DELETE request for a single Distribution Set within SP. Required permission: DELETE_REPOSITORY
Handles the DELETE request for a single Distribution Set within Hawkbit. Required permission: DELETE_REPOSITORY
=== Delete Distribution Set
@@ -151,7 +151,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the GET request of retrieving a single distribution set within SP. Required permission: READ_REPOSITORY
Handles the GET request of retrieving a single distribution set within Hawkbit. Required permission: READ_REPOSITORY
=== Get Distribution Set
@@ -196,7 +196,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the UPDATE request for a single Distribution Set within SP. Required permission: UPDATE_REPOSITORY
Handles the UPDATE request for a single Distribution Set within Hawkbit. Required permission: UPDATE_REPOSITORY
=== Updating a Distribution Set
@@ -246,7 +246,7 @@ include::../errors/429.adoc[]
== GET /rest/v1/distributionsets/{distributionSetId}/assignedSM
=== Implementation Notes
Handles the GET request of retrieving a single distribution set within SP. Required permission: READ_REPOSITORY
Handles the GET request of retrieving a single distribution set within Hawkbit. Required permission: READ_REPOSITORY
=== Get assigned Software Modules

14
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/distributionsettypes-api-guide.adoc
View File

@@ -15,7 +15,7 @@ toc::[]
=== Implementation notes
Handles the GET request of retrieving all distribution set types withinfGET /rest/v1/distributionsettypes SP. Required Permission: READ_REPOSITORY
Handles the GET request of retrieving all distribution set types within Hawkbit. Required Permission: READ_REPOSITORY
=== Get distribution set types
@@ -63,7 +63,7 @@ include::../errors/429.adoc[]
=== Implementation notes
Handles the POST request for creating new distribution set types within SP. The request body must always be a list of types. Required Permission: CREATE_REPOSITORY
Handles the POST request for creating new distribution set types within Hawkbit. The request body must always be a list of types. Required Permission: CREATE_REPOSITORY
=== Create distribution set types
@@ -114,7 +114,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the DELETE request for a single distribution set type within SP. Required Permission: DELETE_REPOSITORY
Handles the DELETE request for a single distribution set type within Hawkbit. Required Permission: DELETE_REPOSITORY
=== Delete distribution set type
@@ -157,7 +157,7 @@ include::../errors/429.adoc[]
=== Implementation notes
Handles the GET request of retrieving a single distribution set type within SP. Required Permission: READ_REPOSITORY
Handles the GET request of retrieving a single distribution set type within Hawkbit. Required Permission: READ_REPOSITORY
=== Get distribution set type
@@ -203,7 +203,7 @@ include::../errors/429.adoc[]
=== Implementation notes
Handles the PUT request for a single distribution set type within SP. Required Permission: UPDATE_REPOSITORY
Handles the PUT request for a single distribution set type within Hawkbit. Required Permission: UPDATE_REPOSITORY
=== Update distribution set type
@@ -354,7 +354,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the DELETE request for removing a software module type from a single distribution set type within SP. Required Permission: DELETE_REPOSITORY
Handles the DELETE request for removing a software module type from a single distribution set type within Hawkbit. Required Permission: DELETE_REPOSITORY
Delete mandatory software module type.
@@ -541,8 +541,6 @@ include::../errors/429.adoc[]
== DELETE /rest/v1/distributionsettypes/{distributionSetTypeId}/optionalmoduletypes/{softwareModuleTypeId}
== DELETE /rest/v1/distributionsettypes/{distributionSetTypeId}/mandatorymoduletypes/{softwareModuleTypeId}
=== Implementation Notes
Handles DELETE request for removing an optional module from the distribution set type.Note that a DS type cannot be changed after it has been used by a DS. Required Permission: UPDATE_REPOSITORY and READ_REPOSITORY

24
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/rollout-api-guide.adoc
View File

@@ -18,7 +18,7 @@ toc::[]
=== Implementation notes
Handles the GET request of retrieving all rollouts within SP. Required Permission: READ_ROLLOUT
Handles the GET request of retrieving all rollouts within Hawkbit. Required Permission: READ_ROLLOUT
=== Get paged list of Rollouts
@@ -65,7 +65,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the GET request of retrieving a single rollout within SP. Required Permission: READ_ROLLOUT
Handles the GET request of retrieving a single rollout within Hawkbit. Required Permission: READ_ROLLOUT
=== Get Rollout
@@ -108,7 +108,7 @@ include::../errors/429.adoc[]
== POST /rest/v1/rollouts
=== Implementation Notes
Handles the POST request of creating new rollout within SP. Required Permission: CREATE_ROLLOUT
Handles the POST request of creating new rollout within Hawkbit. Required Permission: CREATE_ROLLOUT
=== Create Rollout with defined amount of groups
@@ -182,7 +182,7 @@ include::../errors/429.adoc[]
== POST /rest/v1/rollouts/{rolloutId}/approve
=== Implementation Notes
Handles the POST request of approving a created rollout within SP.
Handles the POST request of approving a created rollout within Hawkbit.
Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL.
Required Permission: APPROVE_ROLLOUT
@@ -219,7 +219,7 @@ include::../errors/429.adoc[]
== POST /rest/v1/rollouts/{rolloutId}/deny
=== Implementation Notes
Handles the POST request of denying a created rollout within SP.
Handles the POST request of denying a created rollout within Hawkbit.
Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL.
Required Permission: APPROVE_ROLLOUT
@@ -257,7 +257,7 @@ include::../errors/429.adoc[]
== POST /rest/v1/rollouts/{rolloutId}/start
=== Implementation Notes
Handles the POST request of starting a created rollout within SP. Required Permission: HANDLE_ROLLOUT
Handles the POST request of starting a created rollout within Hawkbit. Required Permission: HANDLE_ROLLOUT
=== Start Rollout
@@ -293,7 +293,7 @@ include::../errors/429.adoc[]
== POST /rest/v1/rollouts/{rolloutId}/pause
=== Implementation Notes
Handles the POST request of pausing a running rollout within SP. Required Permission: HANDLE_ROLLOUT
Handles the POST request of pausing a running rollout within Hawkbit. Required Permission: HANDLE_ROLLOUT
=== Pause Rollout
@@ -326,7 +326,7 @@ include::../errors/429.adoc[]
== POST /rest/v1/rollouts/{rolloutId}/resume
=== Implementation Notes
Handles the POST request of resuming a paused rollout within SP. Required Permission: HANDLE_ROLLOUT
Handles the POST request of resuming a paused rollout within Hawkbit. Required Permission: HANDLE_ROLLOUT
=== Resume Rollout
@@ -360,7 +360,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the DELETE request of deleting a rollout within SP. Required Permission: DELETE_ROLLOUT
Handles the DELETE request of deleting a rollout within Hawkbit. Required Permission: DELETE_ROLLOUT
=== Deleting a rollout
@@ -400,7 +400,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the GET request of retrieving all deploy groups of a specific rollout within SP. Required Permission: READ_ROLLOUT
Handles the GET request of retrieving all deploy groups of a specific rollout within Hawkbit. Required Permission: READ_ROLLOUT
=== Get Deploy Groups
@@ -452,7 +452,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the GET request of a single deploy group of a specific rollout within SP. Required Permission: READ_ROLLOUT
Handles the GET request of a single deploy group of a specific rollout within Hawkbit. Required Permission: READ_ROLLOUT
=== Get Deploy Groups
@@ -496,7 +496,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the GET request of retrieving all targets of a single deploy group of a specific rollout within SP. Required Permissions: READ_ROLLOUT, READ_TARGET.
Handles the GET request of retrieving all targets of a single deploy group of a specific rollout within Hawkbit. Required Permissions: READ_ROLLOUT, READ_TARGET.
=== Get Deploy Group Targets

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

@@ -69,7 +69,7 @@ include::../errors/429.adoc[]
=== Implementation notes
The SP server might cancel an operation, e.g. an unfinished update has a sucessor. It is up to the provisiong target to decide to accept the cancelation or reject it.
The Hawkbit server might cancel an operation, e.g. an unfinished update has a sucessor. It is up to the provisiong target to decide to accept the cancelation or reject it.
=== Cancel an action

12
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/softwaremodules-api-guide.adoc
View File

@@ -15,7 +15,7 @@ toc::[]
=== Implementation notes
Handles the GET request of retrieving all softwaremodules within SP. Required Permission: READ_REPOSITORY
Handles the GET request of retrieving all softwaremodules within Hawkbit. Required Permission: READ_REPOSITORY
=== Get software modules
@@ -63,7 +63,7 @@ include::../errors/429.adoc[]
=== Implementation notes
Handles the POST request of creating new software modules within SP. The request body must always be a list of modules. Required Permission: CREATE_REPOSITORY
Handles the POST request of creating new software modules within Hawkbit. The request body must always be a list of modules. Required Permission: CREATE_REPOSITORY
=== Create software modules
@@ -112,7 +112,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the DELETE request for a single softwaremodule within SP. Required Permission: DELETE_REPOSITORY
Handles the DELETE request for a single softwaremodule within Hawkbit. Required Permission: DELETE_REPOSITORY
=== Delete software module
@@ -155,7 +155,7 @@ include::../errors/429.adoc[]
=== Implementation notes
Handles the GET request of retrieving a single softwaremodule within SP. Required Permission: READ_REPOSITORY
Handles the GET request of retrieving a single softwaremodule within Hawkbit. Required Permission: READ_REPOSITORY
=== Get software module
@@ -202,7 +202,7 @@ include::../errors/429.adoc[]
=== Implementation notes
Handles the PUT request for a single softwaremodule within SP. Required Permission: UPDATE_REPOSITORY
Handles the PUT request for a single softwaremodule within Hawkbit. Required Permission: UPDATE_REPOSITORY
=== Update software module
@@ -358,7 +358,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the DELETE request for a single SoftwareModule within SP. Required Permission: DELETE_REPOSITORY
Handles the DELETE request for a single SoftwareModule within Hawkbit. Required Permission: DELETE_REPOSITORY
=== Delete arifact

10
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/softwaremoduletypes-api-guide.adoc
View File

@@ -15,7 +15,7 @@ toc::[]
=== Implementation notes
Handles the GET request of retrieving all software module types within SP. Required Permission: READ_REPOSITORY
Handles the GET request of retrieving all software module types within Hawkbit. Required Permission: READ_REPOSITORY
=== Get software module types
@@ -63,7 +63,7 @@ include::../errors/429.adoc[]
=== Implementation notes
Handles the POST request of creating new software module types within SP. The request body must always be a list of module types. Required Permission: CREATE_REPOSITORY
Handles the POST request of creating new software module types within Hawkbit. The request body must always be a list of module types. Required Permission: CREATE_REPOSITORY
=== Creating software module types
@@ -112,7 +112,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the DELETE request for a single software module type within SP. Required Permission: DELETE_REPOSITORY
Handles the DELETE request for a single software module type within Hawkbit. Required Permission: DELETE_REPOSITORY
=== Delete software module type
@@ -153,7 +153,7 @@ include::../errors/429.adoc[]
=== Implementation notes
Handles the GET request of retrieving a single software module type within SP. Required Permission: READ_REPOSITORY
Handles the GET request of retrieving a single software module type within Hawkbit. Required Permission: READ_REPOSITORY
=== Accessing a software module type
@@ -197,7 +197,7 @@ include::../errors/429.adoc[]
=== Implementation notes
Handles the PUT request for a single software module type within SP. Required Permission: UPDATE_REPOSITORY
Handles the PUT request for a single software module type within Hawkbit. Required Permission: UPDATE_REPOSITORY
=== Updating a software module types

10
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/targetfilters-api-guide.adoc
View File

@@ -16,7 +16,7 @@ toc::[]
=== Implementation notes
Handles the GET request of retrieving all target filter queries within SP. Required permission: READ_TARGET
Handles the GET request of retrieving all target filter queries within Hawkbit. Required permission: READ_TARGET
=== Get paged list of target filter queries
@@ -66,7 +66,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the POST request to create a new target filter query within SP. Required permission: CREATE_TARGET
Handles the POST request to create a new target filter query within Hawkbit. Required permission: CREATE_TARGET
=== Create a target filter query
@@ -112,7 +112,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the DELETE request of deleting a target filter query within SP. Required permission: DELETE_TARGET
Handles the DELETE request of deleting a target filter query within Hawkbit. Required permission: DELETE_TARGET
=== Deleting a target
@@ -153,7 +153,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the GET request of retrieving a single target filter query within SP. Required permission: READ_TARGET
Handles the GET request of retrieving a single target filter query within Hawkbit. Required permission: READ_TARGET
=== Get single target
@@ -198,7 +198,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the PUT request of updating a target filter query within SP. Required permission: UPDATE_TARGET
Handles the PUT request of updating a target filter query within Hawkbit. Required permission: UPDATE_TARGET
=== Update a target

10
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/targets-api-guide.adoc
View File

@@ -16,7 +16,7 @@ toc::[]
=== Implementation notes
Handles the GET request of retrieving all targets within SP. Required permission: READ_TARGET
Handles the GET request of retrieving all targets within Hawkbit. Required permission: READ_TARGET
=== Get paged list of targets
@@ -66,7 +66,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the POST request of creating new targets within SP. The request body must always be a list of targets. Required Permission: CREATE_TARGET
Handles the POST request of creating new targets within Hawkbit. The request body must always be a list of targets. Required Permission: CREATE_TARGET
=== Create list of targets
@@ -112,7 +112,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the DELETE request of deleting a single target within SP. Required Permission: DELETE_TARGET
Handles the DELETE request of deleting a single target within Hawkbit. Required Permission: DELETE_TARGET
=== Deleting a target
@@ -153,7 +153,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the GET request of retrieving a single target within SP. Required Permission: READ_TARGET
Handles the GET request of retrieving a single target within Hawkbit. Required Permission: READ_TARGET
=== Get single target
@@ -198,7 +198,7 @@ include::../errors/429.adoc[]
=== Implementation Notes
Handles the PUT request of updating a target within SP. Required Permission: UPDATE_TARGET
Handles the PUT request of updating a target within Hawkbit. Required Permission: UPDATE_TARGET
=== Update a target