5e6d8a03fc
* Added documentation for download status of ddi feedback Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io> * Added download status to cancelAction docs Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io> * Fixed some typos in documentation Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io> * Added download status to ddi_api.md and added missing quotation marks Signed-off-by: Alexander Dobler <alexander.dobler3@bosch.io> * Added mising of in documentation Signed-off-by: Alexander Dobler <alexander.dobler3@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.