forked from oracle/opengrok
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
386 lines (261 loc) · 11.3 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
HIFORMAT: 1A
# OpenGrok
OpenGrok RESTful API documentation. The following endpoints are accessible under `/api/v1`
Besides `/suggester` and `/search` endpoints, everything is accessible from `localhost` only.
## Configuration [/configuration]
### return XML representation of configuration [GET]
+ Response 200 (application/xml)
+ Body
```
<?xml version="1.0" encoding="UTF-8"?>
<java version="1.8.0_172" class="java.beans.XMLDecoder">
<object class="org.opengrok.indexer.configuration.Configuration" id="Configuration0">
<void property="allowLeadingWildcard">
<boolean>true</boolean>
</void>
</object>
</java>
```
### sets configuration from XML representation [PUT]
+ Request (application/xml)
+ Body
```
<?xml version="1.0" encoding="UTF-8"?>
<java version="1.8.0_172" class="java.beans.XMLDecoder">
<object class="org.opengrok.indexer.configuration.Configuration" id="Configuration0">
<void property="allowLeadingWildcard">
<boolean>true</boolean>
</void>
</object>
</java>
```
+ Response 201 (application/json)
## Configuration field [/configuration/{field}{?reindex}]
### returns specific configuration field [GET]
+ Response 200 (application/json)
### sets specific configuration field [PUT]
+ Parameters
+ reindex (boolean) - specifies if the underlying data were also reindexed (refreshes some searchers and additional data structures)
+ Request (application/text)
string value of the field to set
+ Response 204
## Authorization framework reload [/configuration/authorization/reload]
### reloads authorization framework [POST]
+ Request (application/text)
+ Response 204
## Messages [/messages{?tag}]
### adds message to a system [POST]
+ Request (application/json)
{
"tags": ["main"],
"cssClass": "cssClass",
"text":"test message",
"duration":"PT10M"
}
+ Response 201
### deletes messages with specified tag [DELETE]
+ Parameters
+ tag (string) - tag
+ Response 204
### returns all messages with specified tag [GET]
+ Parameters
+ tag (string) - tag
+ Response 200 (application/json)
[
{
"acceptedTime": "2018-06-28T17:49:01.793Z",
"message": {
"tags": ["main"],
"cssClass": "cssClass",
"text": "test message",
"duration": "PT10M"
},
"expirationTime": "2018-06-28T17:59:01.793Z",
"expired":false
}
]
## Projects [/projects]
### returns a list of all projects [GET]
+ Response 200 (application/json)
+ Body
["foo","bar"]
### add project [POST]
+ Request (text/plain)
+ Body
text/plain name of the project
+ Response 201
## Project management [/projects/{project}]
### delete project [DELETE]
+ Response 204
## Project metadata management [/projects/{project}/indexed]
### marks project as indexed [PUT]
+ Response 204
## Project metadata [/projects/{project}/property/{field}]
### sets property field for the project [PUT]
+ Request
+ Body
body – string representation of the value to set
+ Response 204
### returns the field value [GET]
+ Response 200 (application/json)
## Project repositories [/projects/{project}/repositories]
### returns a list of repositories for the specified project [GET]
+ Response 200 (application/json)
+ Body
["/opengrok-master/testdata/repositories/teamware",
"/opengrok-master/testdata/sources/rfe2575",
"/opengrok-master/testdata/repositories/rcs_test",
"/opengrok-master"]
## Repository type [/projects/{project}/repositories/type]
### returns types of project repositories [GET]
+ Response 200 (application/json)
+ Body
["RCS","git","SCCS"]
## Project indexed flag [/projects/indexed]
### returns a list of indexed projects [GET]
+ Response 200 (application/json)
+ Body
["sc-2","sc-1"]
## Repository type [/repositories/type{?repository}]
### return type of the repository [GET]
The repository path is relative to source root, starting with slash.
Repository type is separated from the repository path with a colon.
+ Response 200 (text/plain)
+ Body
/opengrok-master:git
+ Parameters
+ repository - repository for which to return type
## Search [/search{?full,def,symbol,path,hist,type,projects,maxresults,start}]
## return search results [GET]
+ Parameters
+ full (optional, string) - full search field value to search for
+ def (optional, string) - definition field value to search for
+ symbol (optional, string) - symbol field value to search for
+ path (optional, string) - file path field value to search for
+ hist (optional, string) - history field value to search for
+ type (optional, string) - type of the files to search for
+ projects (optional, string) - projects to search in
+ maxresults (optional, string) - maximum number of documents whose hits will be returned
+ start (optional, string) - start index from which to return results
+ Response 200 (application/json)
+ Body
{
"time": 13,
"resultCount": 35,
"startDocument": 0,
"endDocument": 0,
"results": {
"/opengrok/test/org/opensolaris/opengrok/history/hg-export-renamed.txt": [{
"line": "# User Vladimir <b>Kotal</b> <Vladimir.<b>Kotal</b>@oracle.com>",
"lineNumber": "19"
},{
"line": "# User Vladimir <b>Kotal</b> <Vladimir.<b>Kotal</b>@oracle.com>",
"lineNumber":"29"
}]
}
## Statistics [/stats]
### returns statistics [GET]
+ Response 200 (application/json)
+ Body
{"requests_per_minute_max":2,"timing":{"authorization":9,"authorization_in_stack_default stack_of_OpenGrok":0,
"authorization_in_stack_default stack_positive":0,"authorization_of_OpenGrok":9,
"authorization_positive_of_OpenGrok":9,"root":1109,"*":1109,"authorization_in_stack_default stack_positive_of_OpenGrok":0,
"authorization_positive":9},"minutes":1,"timing_min":{"authorization":0,"authorization_in_stack_default stack_of_OpenGrok":0,
"authorization_in_stack_default stack_positive":0,"authorization_of_OpenGrok":0,
"authorization_positive_of_OpenGrok":0,"root":4,"*":4,"authorization_in_stack_default stack_positive_of_OpenGrok":0,
"authorization_positive":0},"timing_avg":{"authorization":4.5,"authorization_in_stack_default stack_of_OpenGrok":0.0,
"authorization_in_stack_default stack_positive":0.0,"authorization_of_OpenGrok":4.5,
"authorization_positive_of_OpenGrok":4.5,"root":554.5,"*":554.5,
"authorization_in_stack_default stack_positive_of_OpenGrok":0.0,"authorization_positive":4.5},
"request_categories":{"authorization":2,"authorization_in_stack_default stack_of_OpenGrok":2,
"authorization_in_stack_default stack_positive":2,"authorization_cache_misses":2,
"authorization_of_OpenGrok":2,"authorization_cache_hits":4,
"authorization_positive_of_OpenGrok":2,"root":2,"*":2,
"authorization_in_stack_default stack_positive_of_OpenGrok":2,
"authorization_positive":2},
"day_histogram":[0,0,0,0,0,0,0,0,0,0,0,0,2,0,0,0,0,0,0,0,0,0,0,0],"requests":2,
"requests_per_minute_min":1,"requests_per_minute":2,"requests_per_minute_avg":2.0,
"month_histogram":[0,0,0,2,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
"timing_max":{"authorization":9,"authorization_in_stack_default stack_of_OpenGrok":0,
"authorization_in_stack_default stack_positive":0,"authorization_of_OpenGrok":9,
"authorization_positive_of_OpenGrok":9,"root":1105,"*":1105,
"authorization_in_stack_default stack_positive_of_OpenGrok":0,"authorization_positive":9}}
### deletes statistics [DELETE]
+ Response 204
## Statistics reload [/stats/reload]
### reloads statistics (useful when configuration path to statistics changed) [PUT]
+ Response 204
## Suggester [/suggest{?projects,field,caret,full,defs,refs,path,hist,type}]
### returns suggestions [GET]
+ Parameters
+ projects (string) - list of projects for which to retrieve suggestions
+ field - field for which to suggest
+ caret - position of the caret in the input field
+ full - value of the Full Search input
+ defs - value of the Definitions input
+ refs - value of Symbol input
+ path - value of the File Path input
+ hist - value of the History input
+ type - value of the Type input
+ Response 200 (application/json)
+ Body
{
"time": 60,
"suggestions": [{
"phrase": "package",
"projects": ["kotlin"],
"score": 387
}],
"identifier": "pprttq",
"queryText": "pprttq",
"partialResult":false
}
## Suggester configuration [/suggest/config]
### returns suggester configuration [GET]
+ Response 200 (application/json)
+ Body
{"enabled":true,"maxResults":10,"minChars":4,"allowedProjects":null,
"maxProjects":2147483647,
"allowedFields":["defs","path","hist","refs","type","full"],
"allowComplexQueries":true,"allowMostPopular":true,"showScores":false,
"showProjects":true,"showTime":false,"rebuildCronConfig":"0 0 * * *",
"buildTerminationTime":1800,"timeThreshold":2000}
## Suggester popularity data initialization with queries [/suggest/init/queries]
### updates popularity data based on the queries [POST]
+ Request (application/json)
+ Body
["http://localhost:8080/source/search?project=kotlin&q=text"]
+ Response 201
## Suggester popularity data initialization [/suggest/init/raw]
### updates popularity data based on the provided data [POST]
+ Request (application/json)
+ Body
[{"project":"kotlin","field":"full","token":"args","increment":100}]
+ Response 201
## Suggester popularity data [/suggest/popularity/{project}{?field,page,pageSize,all}]
### retrieves popularity data for project [GET]
+ Parameters
+ field - field for which to retrieve data, default: full
+ page - page of data, default: 0
+ pageSize - size of the page, default: 100
+ all - if all data should be retrieved, if true then page and pageSize params are ignored
+ Response 200 (application/json)
+ Body
[{"iso":3},{"the":3},{"to":3},{"conform":3},{"-":2},
{"sc_window_set":1},{"_lso_outbound":1},{"missing":1}]
## Index searchers refresh [/system/refresh]
### refreshes index searchers for specified project [PUT]
+ Request (text/plain)
+ Body
project name to refresh
+ Response 204
## Include files reload [/system/includes/reload]
### reloads all include files for web application [PUT]
+ Response 204
## Path descriptions [/system/pathdesc]
### updates path descriptions for web application [POST]
+ Request (text/plain)
+ Body
/foo bar
/foo/foo bar bar
+ Response 204