Merge branch '33-reporting-add-possibilty-to-get-pdf-as-base64-string' of https:...
authorFabian Eichhorner <fabian.eichhorner@gmail.com>
Wed, 28 Nov 2018 21:49:35 +0000 (22:49 +0100)
committerFabian Eichhorner <fabian.eichhorner@gmail.com>
Wed, 28 Nov 2018 21:49:35 +0000 (22:49 +0100)
service-reporting/README.md

index 08ec2e92ab09cd2fb775a372316b802fc8dc1afb..49640ff5533c2410012dd38bf6f42f4d2a7463fc 100644 (file)
@@ -7,8 +7,9 @@ Provides a REST-API to generate PDF reports for terms and their sentiment analys
 - return: pdf file
 
 `POST`: `/generatePDF/` Generates a pdf report for the given terms
-- param: Term[] as Content-Type: `application/json`  
-e.g. body of request
+- Header: `Content-Type`: `application/json`  
+(optional) `Accept`: `application/base64` if the pdf should be in base64 instead of `application/pdf`  
+- Body of request: Term[] e.g.
 ```json
 [
   {
@@ -27,7 +28,7 @@ e.g. body of request
 ``` 
 - return: pdf file
 
-### Tweet model
+### Term model
 Term(string `Name`, double `Sentiment`)
 
 ## run with docker