hawkBit rest docs (management & DDI API) (#688)
* hawkBit REST docs. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fiy gitignore. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add to website. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Switch to generated docs. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix typos. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Review findings. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Otimizations. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Revert accidental checkin. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add security link.
This commit is contained in:
17
hawkbit-rest/hawkbit-mgmt-api/README.md
Normal file
17
hawkbit-rest/hawkbit-mgmt-api/README.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Eclipse.IoT hawkBit - Management API - Model and Resources
|
||||
|
||||
This Management (Mgmt) API is used to manage and monitor the HawkBit Update Server via HTTP. This API allows Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).
|
||||
|
||||
# Version 1
|
||||
|
||||
The model follows [semantic versioning](http://semver.org) with MAJOR version, i.e. breaking changes will result in a new MAJOR version.
|
||||
|
||||
# Compile
|
||||
|
||||
#### Build hawkbit-mgmt-api
|
||||
|
||||
```
|
||||
$ cd hawkbit/hawkbit-mgmt-api
|
||||
$ mvn clean install
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user