Files
hawkbit/hawkbit-rest/hawkbit-rest-docs
Avgustin Marinov 9c86729a68 [#1393,#1008] Switch to Eclipse v2.0 license (#1427)
Switching license from EPL v1 to v2. Following
https://www.eclipse.org/legal/epl-2.0/faq.php#h.tci84nlsqpgw

Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
2023-09-14 11:03:20 +03: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.