cef7c2bbf2
* implement feature approval workflow Signed-off-by: Ioannis Spyropoulos <ioannis.spyropoulos@bosch-si.com> Signed-off-by: Michael Müller <Michael.Mueller17@bosch-si.com> * add documentation for REST endpoints Signed-off-by: Ioannis Spyropoulos <ioannis.spyropoulos@bosch-si.com> Signed-off-by: Michael Müller <Michael.Mueller17@bosch-si.com> * fix broken documentation test Signed-off-by: Ioannis Spyropoulos <ioannis.spyropoulos@bosch-si.com> * fix broken documentation test II Signed-off-by: Ioannis Spyropoulos <ioannis.spyropoulos@bosch-si.com>
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.