Skip to content

Commit 68de620

Browse files
author
Robert Diers
committed
readme
1 parent 48ab657 commit 68de620

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Container: https://github.com/opentestingapi/impl_java/pkgs/container/opentest
1414
| 1.5 | 1.0 | result content-type and logic fixed for pause endpoint, more understandable log for checks, new field description for injects and checks |
1515
| 1.6 | 1.0 | S3-Adapter, Swagger-UI bugfixes (content-type upload) |
1616
| 1.7 | 1.0 | using relative path for Swagger-UI (simplifies proxy usage, for example https) |
17+
| 1.8 | 1.0 | data generator endpoint to create mass data from testcases |
1718

1819
## Architecture
1920

@@ -89,66 +90,65 @@ Please think about using a kind of folder structure to differ between functional
8990

9091
## API Usage
9192

93+
Swagger-UI: http://<servername>:50000/swagger-ui/swagger-ui/index.html
94+
95+
9296
1. upload required files first (please use application/json for all file types):
9397
```
9498
curl -X POST "http://<servername>:50000/upload/file/<testcaseid>/<filename>" -H "accept: */*" -H "Content-Type: application/json" -d @<filename> && echo
9599
```
96-
Swagger: http://servername:50000/swagger-ui/#/upload-controller/fileuploadUsingPOST
100+
97101

98102
2. upload test case as JSON:
99103
```
100104
curl -X POST "http://<servername>:50000/upload/test" -H "accept: */*" -H "Content-Type: application/json" -d @<filename> && echo
101105
```
102-
Swagger: http://servername:50000/swagger-ui/#/upload-controller/testuploadUsingPOST
103106

104107

105108
* remove test case
106109
```
107110
curl --request DELETE --url http://<servername>:50000/upload/test/<testcaseid>
108111
```
109-
Swagger: http://servername:50000/swagger-ui/#/upload-controller/testremovalUsingDELETE
110112

111113
* read test case
112114
```
113115
curl --request GET --url 'http://<servername>:50000/reporting/test/<testcaseid>?lastchecks=100'
114116
```
115-
Swagger: http://servername:50000/swagger-ui/#/reporting-controller/getUsingGET_1
116117

117118
* read file
118119
```
119120
curl --request GET --url http://<servername>:50000/reporting/file/<testcaseid>/<filename>
120121
```
121-
Swagger: http://servername:50000/swagger-ui/#/reporting-controller/getFileUsingGET
122122

123123
* search test case (read all with /reporting/search?labels=%25)
124124
```
125125
curl --request GET --url 'http://<servername>:50000/reporting/search?labels=<yourlabel>&lastchecks=100'
126126
```
127-
Swagger: http://servername:50000/swagger-ui/#/reporting-controller/searchUsingGET
128127

129128
* list injects to trigger manually (must be activated)
130129
```
131130
curl --request GET --url 'http://<servername>:50000/trigger/'
132131
```
133-
Swagger: http://servername:50000/swagger-ui/#/trigger-controller/getUsingGET_2
134132

135133
* trigger inject (must be activated)
136134
```
137135
curl --request GET --url 'http://<servername>:50000/trigger/inject/<testcaseid>/<injectid>'
138136
```
139-
Swagger: http://servername:50000/swagger-ui/#/trigger-controller/injectUsingGET
137+
138+
* trigger data generation (inject must be activated)
139+
```
140+
curl -X POST "http://servername:50000/trigger/datagenerator" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"testId\":\"string\",\"injectId\":\"string\",\"count\":0}"
141+
```
140142

141143
* read filtered log files
142144
```
143145
curl --request GET --url 'http://<servername>:50000/reporting/log?filter=<yourfilter>&maxage=7'
144146
```
145-
Swagger: http://servername:50000/swagger-ui/#/reporting-controller/logUsingGET
146147

147148
* pause injects and checks
148149
```
149150
curl --request GET --url 'http://<servername>:50000/trigger/pause/<true/false>'
150151
```
151-
Swagger: http://servername:50000/swagger-ui/#/trigger-controller/pauseUsingGET
152152

153153

154154
## Pipeline Integration / Bulk Execution
@@ -159,13 +159,11 @@ You can use this endpoints to realize a pipeline integration.
159159
```
160160
curl -X POST "http://<servername>:50000/trigger/bulk/" -H "accept: application/json" -H "Content-Type: application/json" -d "[\"<testcaseid>.<injectid>\",\"<testcaseid>.*\"]"
161161
```
162-
Swagger: http://servername:50000/swagger-ui/#/trigger-controller/bulkUsingPOST
163162

164163
* bulk read check results
165164
```
166165
curl -X GET "http://<servername>:50000/reporting/bulk?bulkid=<bulkid>" -H "accept: application/json"
167166
```
168-
Swagger: http://servername:50000/swagger-ui/#/reporting-controller/bulkUsingGET
169167

170168

171169
## Password Encryption
@@ -177,12 +175,10 @@ Simply use this endpoint to encrypt your passwords and use in your testcase:
177175
```
178176
curl --request POST -H "Content-Type: text/plain; charset=utf-8" --url http://<servername>:50000/password/encrypt --data 'HalloWelt!123'
179177
```
180-
Swagger: http://servername:50000/swagger-ui/#/password-controller/encryptUsingPOST
181178

182179
```
183180
curl --request POST -H "Content-Type: text/plain; charset=utf-8" --url http://<servername>:50000/password/decrypt --data 'ENC(e8K7wp7CusOAwpzCrMOBw5ltwpl6woQ=)'
184181
```
185-
Swagger: http://servername:50000/swagger-ui/#/password-controller/decryptUsingPOST
186182

187183

188184
## Development Environment

0 commit comments

Comments
 (0)