Skip to content

Commit a3eed05

Browse files
committing read me changes
1 parent 9765c10 commit a3eed05

1 file changed

Lines changed: 14 additions & 31 deletions

File tree

README.md

Lines changed: 14 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,12 @@ This is an open source rest service written in java which can be used to connect
44

55
## Pre-requisite Configuration
66
##### Properties
7-
There is an application.properties file in the resources folder, connect the rest service and the instance of kdb by updating the properties below:
7+
There is an `application.properties` file in the resources folder, connect the rest service and the instance of kdb by updating the properties below:
88

99
kdb.host=localhost
10-
1110
kdb.port=6007
12-
1311
kdb.username=admin
14-
1512
kdb.password=admin
16-
1713
server.port=8080
1814

1915

@@ -24,48 +20,41 @@ The executeFunction provides a means to call a predefined function and pass para
2420
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:
2521

2622
e.g.
27-
{
28-
23+
24+
{
2925
"function_name" : "plus",
3026
"arguments" :
3127
{
3228
"xarg" : "96.3",
3329
"yarg" : "9.7"
3430
}
35-
}
31+
}
3632

3733
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.
3834
For example this is the format of a synchronous query request where the user expects a response to be returned:
3935

4036
e.g.
41-
{
42-
43-
"type" : "sync",
44-
45-
"query" : "select from table",
46-
47-
"response" : true
37+
4838

49-
}
39+
{
40+
"type" : "sync",
41+
"query" : "select from table",
42+
"response" : true
43+
}
5044

5145
##### Certificates
52-
The requests are sent in HTTPS format and to provide this the project has a self-signed certifiate embedded within. It is strongly recommended that you add your own certificate. Updating the certificate will require and update to the following properties in application.properties:
46+
The requests are sent in HTTPS format and to provide this the project has a self-signed certifiate embedded within. It is strongly recommended that you add your own certificate. Updating the certificate will require an update to the following properties in `application.properties`:
5347

5448
security.require-ssl=true
55-
5649
server.ssl.key-store-type=PKCS12
57-
5850
server.ssl.key-store=classpath:keystore.p12
59-
6051
server.ssl.key-store-password=aquaq2018
61-
6252
server.ssl.key-alias=tomcat
6353

6454
##### Authentication
65-
The rest service uses basic authentication and is using a single username and password which are configured in the application.properties file:
55+
The rest service uses basic authentication and is using a single username and password which are configured in the `application.properties` file:
6656

6757
basic.authentication.user=user
68-
6958
basic.authentication.password=pass
7059

7160
These value are provided within the header of the request, it is strongly recommended to invoke your own security if you use the project.
@@ -75,13 +64,7 @@ These value are provided within the header of the request, it is strongly recomm
7564

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

78-
Alternatively it can be run locally by providing the appropriate build configuration via command line or ide.
79-
80-
## Built with
81-
Maven
82-
83-
## Licensing
84-
Please see license file.
67+
Alternatively it can be run locally by providing the appropriate build configuration via command line or IDE.
8568

8669
## Contributing
87-
The branch is currently locked down and will require a pull request reviewed by a member of the aquaq team before any changes can be committed.
70+
The branch is currently locked down and will require a pull request reviewed by a member of the AQUAQ team before any changes can be committed.

0 commit comments

Comments
 (0)