Added build script for documentation.

Added bundled docs. Updated readme. Part of issue #697 Signed-off-by: David Joos <david.joos@bosch.io>
eclipse-ditto · Nov 4, 2020 · f1fb693 · f1fb693
1 parent 211eba0
commit f1fb693
Show file tree

Hide file tree

Showing 5 changed files with 9,045 additions and 0 deletions.
diff --git a/documentation/src/main/resources/openapi/README.md b/documentation/src/main/resources/openapi/README.md
@@ -3,3 +3,21 @@
 This folder contains the OpenAPI [OpenAPI](https://www.openapis.org) [Specification version 2](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) documentation for Eclipse Ditto. 
 
 You can view it as nicely rendered HTML by importing one of the files (for API version 1 or 2) into the [Swagger Online Editor](https://editor.swagger.io).
+
+### Build documenation
+
+1. Install `swagger-cli`
+```
+$ cd sources && npm i
+```
+
+2. Build api docs
+```
+$ cd sources
+// only v1
+$ npm run build-v1
+// only v2
+$ npm run build-v2
+// both
+$ npm run build
+```