updated readme and changed to uppercase
authorFabian Eichhorner <fabian.eichhorner@gmail.com>
Sun, 25 Nov 2018 19:52:42 +0000 (20:52 +0100)
committerFabian Eichhorner <fabian.eichhorner@gmail.com>
Sun, 25 Nov 2018 19:52:42 +0000 (20:52 +0100)
service-reporting/README.md [moved from service-reporting/readme.md with 72% similarity]

similarity index 72%
rename from service-reporting/readme.md
rename to service-reporting/README.md
index 8530277787f01ee0cca264e883ab3b7bd423d5b7..0fd645c47b4482b4906805785a346020ba64d65b 100644 (file)
@@ -7,11 +7,19 @@ Provides an API interface to generate PDF reports for terms and their sentiment
 - return: pdf file
 
 `POST`: `/generatePDF/` Generates a pdf report for the given terms
-- param: Term[] as Content-Type: `application/json`  
+- param: Term[] as Content-Type: `application/json`
+e.g. body of request
+```javascript
+[
+  { "name": "term 1", "sentiment": 0.1 },
+  { "name": "term 2", "sentiment": 0.3 },
+  { "name": "term 3", "sentiment": 0.7 }
+]
+``` 
 - return: pdf file
 
 ### Tweet model
-Term(string `Name`, float `Sentiment`)
+Term(string `Name`, double `Sentiment`)
 
 ## run with docker