b5fcb48ab1
* 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>
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.