69e6488004
* installedBase DDI: initial impl + rest docs Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * refactor installedBase implementation Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * ddi installed base tests Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * restructure root controller rest docs Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * fix some java docs and formatting Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * don't add action history message when calling /installedBase Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * fix test after removing action history message Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * fix review comments Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io> * fix review comments Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>
hawkBit Rest Documentation tests
The hawkBit Rest Documentation tests are based on Rest Docs. These tests generate documentation for our RESTful services.
Run and create snippets
Run the test with maven
mvn clean package
Every rest test will create snippets (e.g. curl-request.adoc, http-request.adoc) in the target\generated-snippets\ directory.
Use the snippets
The snippets get included using Asciidoc within our API documents in src\main\asciidoc. Those documents in turn are used to generate HTML documents in the target\classes directory when building with maven.