Files
hawkbit/hawkbit-rest/hawkbit-rest-docs
Stanislav Trailov 64bc0417b1 Add new endpoint for single action (#1316)
* Add new endpoint for single action
* Adding the new endpoint to the documentation
+ reverse the representation mode to FULL

Signed-off-by: Stanislav Trailov <stanislav.trailov@bosch.io>
2023-02-06 13:13:58 +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.