Files
hawkbit/hawkbit-rest/hawkbit-rest-docs
Dominic Schabel 76fa389eeb Unused time field removed from DDI docs
Back in the days "time" was specified in API but never implemented/evaluated by hawkBit.
So we better remove it from the docs in order to avoid confusion.

Signed-off-by: Dominic Schabel <dominic.schabel@bosch.io>
2020-12-15 17:13:17 +01:00
..
2019-01-31 07:29:27 +01:00

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.