Skip to content

Commit 3325384

Browse files
updating read me
1 parent 58f10b9 commit 3325384

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ server.port=8080
2121
The kdb-rest-service provides two endpoints:executeFunction and executeQuery.
2222

2323
The executeFunction provides a means to call a predefined function and pass parameters to the kdb instance.
24-
The format of the request:
24+
For example this is the format of a request call a function called plus which passes two arguments labelled "xarg" and "yarg" with values 96.3 and 9.7:
2525

2626
e.g.
2727
{
@@ -33,9 +33,8 @@ e.g.
3333
}
3434

3535
The executeQuery provides a means to provide a query to the kdb instance, by default this endpoint is disabled using the property freeform.query.mode.enabled, to enable change the value to true.
36-
The format of the request:
36+
For example this is the format of a synchronous query request where the user expects a response to be returned:
3737

38-
e.g.
3938
{
4039
"type" : "sync",
4140
"query" : "select from table",
@@ -56,11 +55,15 @@ server.ssl.key-store-password=aquaq2018
5655
server.ssl.key-alias=tomcat
5756

5857
#####Authentication
59-
The rest service uses basic authentication and is using a single username and password which are configured in the applicationm.properties file and provided within the header of the request; again it is strongly recommeded to invoke your own security if you use the project.
58+
The rest service uses basic authentication and is using a single username and password which are configured in the application.properties file:
6059

6160
basic.authentication.user=user
61+
6262
basic.authentication.password=pass
6363

64+
These value are provided within the header of the request, it is strongly recommended to invoke your own security if you use the project.
65+
66+
6467
##Deploying
6568

6669
There is a DockerFile within the project for deploying the project on docker.

0 commit comments

Comments
 (0)