From c629e62761e9d7d8b4cfd8fe79aec25199d131d9 Mon Sep 17 00:00:00 2001 From: Fabian Eichhorner Date: Sun, 25 Nov 2018 20:52:42 +0100 Subject: [PATCH] updated readme and changed to uppercase --- service-reporting/{readme.md => README.md} | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) rename service-reporting/{readme.md => README.md} (72%) diff --git a/service-reporting/readme.md b/service-reporting/README.md similarity index 72% rename from service-reporting/readme.md rename to service-reporting/README.md index 8530277..0fd645c 100644 --- a/service-reporting/readme.md +++ b/service-reporting/README.md @@ -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 -- 2.43.0