This repository has been archived by the owner on Jun 10, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ontonethub.yaml
538 lines (537 loc) · 15.7 KB
/
ontonethub.yaml
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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
{
"swagger" : "2.0",
"info" : {
"description" : "HTTP Rest services for accessing the entities defined in the ontology network.",
"version" : "0.1",
"title" : "OntoNetHub",
"contact" : {
"name" : "andrea.nuzzolese@istc.cnr.it"
},
"license" : {
"name" : "Apache 2.0",
"url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"host" : "localhost:8000",
"basePath" : "/",
"tags" : [ {
"name" : "find"
},
{
"name" : "ontology catalogue"
}
],
"schemes" : [ "http" ],
"paths" : {
"/stanbol/ontonethub/ontologies" : {
"get" : {
"tags" : [ "info", "ontology catalogue", "/ontonethub/ontologies" ],
"summary" : "Returns the list of ontologies indexed by the OntoNet Hub.",
"operationId" : "list",
"produces" : ["application/json"],
"responses" : {
"200" : {
"description" : "The list of the indexes for the ontologies. The list is provided as a JSON array.",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
}
},
"/stanbol/ontonethub/ontology" : {
"post" : {
"consumes" : ["multipart/form-data"],
"tags" : [ "Add", "/ontonethub/ontology"],
"summary" : "Add an ontology for OntoNet management.",
"description" : "",
"operationId" : "add",
"produces" : [ "application/json"],
"parameters" : [ {
"name" : "name",
"in" : "formData",
"description" : "The name of the ontology.",
"required" : true,
"type" : "string"
},
{"name" : "description",
"in" : "formData",
"description" : "A textual description of the ontology.",
"required" : true,
"type" : "string"
},
{"name" : "baseURI",
"in" : "formData",
"description" : "The URI associated in the Web with the ontology being added.",
"required" : true,
"type" : "string"
},
{"name" : "data",
"in" : "formData",
"description" : "The OWL ontology to add.",
"required" : true,
"type" : "file"
}
],
"responses" : {
"200" : {
"description" : "Ontology succesfully added. The URL of the job that is performing the indexing is returned in the JSON provided as output.",
"schema" : {
"$ref" : "#/definitions/JobLink"
}
},
"409" : {
"description" : "The ontology cannot be added as it already exists in the OntoNetHub.",
}
}
}
},
"/stanbol/ontonethub/ontology/{id}" : {
"get" : {
"consumes" : ["*/*"],
"tags" : [ "info", "/ontonethub/ontology"],
"summary" : "Return the information associated with the ontology idendified by the ID.",
"description" : "",
"operationId" : "OntologyInfo",
"produces" : [ "application/json"],
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the ontology that is object of the information seeking.",
"required" : true,
"type" : "string"
}
],
"responses" : {
"200" : {
"description" : "The ontology exists and the information is returned as JSON.",
"schema" : {
"$ref" : "#/definitions/OntologyInfo"
}
},
"404" : {
"description" : "The ontology cannot be fount in OntoNetHub.",
"schema" : {
"$ref" : "#/definitions/Error"
}
},
"500" : {
"description" : "An error occurred when retrieving the information associated with the ontology. The description of the error is returned in the body of the response.",
"schema" : {
"$ref" : "#/definitions/Error"
}
}
}
},
"delete" : {
"consumes" : ["*/*"],
"tags" : [ "delete", "/ontonethub/ontology"],
"summary" : "Delete from the OntoNetHub the ontology idendified by the ID.",
"description" : "",
"operationId" : "OntologyDelete",
"produces" : [ "application/json"],
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the ontology to delete.",
"required" : true,
"type" : "string"
}
],
"responses" : {
"200" : {
"description" : "The ontology has been deleted.",
"schema" : {
"$ref" : "#/definitions/OntologyInfo"
}
},
"404" : {
"description" : "The ontology cannot be fount in OntoNetHub.",
"schema" : {
"$ref" : "#/definitions/Error"
}
}
}
}
},
"/stanbol/ontonethub/ontology/{id}/source" : {
"get" : {
"consumes" : ["*/*"],
"tags" : [ "ontology source", "/ontonethub/ontology"],
"summary" : "Return the OWL surce of an ontology managed by the OntoNetHub.",
"description" : "",
"operationId" : "OntologySource",
"produces" : [
"application/rdf+xml",
"text/turtle",
"text/rdf+n3",
"application/rdf+json",
"application/json-ld"],
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the ontology that is object of the information seeking.",
"required" : true,
"type" : "string"
}
],
"responses" : {
"200" : {
"description" : "The OWL source is returned as output by using the requested notation as syntax."
},
"404" : {
"description" : "The ontology cannot be fount in OntoNetHub.",
"schema" : {
"$ref" : "#/definitions/Error"
}
}
}
}
},
"/stanbol/jobs/{id}" : {
"get" : {
"consumes" : ["*/*"],
"tags" : [ "processing jobs", "/jobs", "info"],
"summary" : "Return the status information of a job (identified by the specific ID provided as input).",
"description" : "",
"operationId" : "JobStatus",
"produces" : [
"application/json",
"text/html",
],
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the ontology that proceced by the OntoNetHub for processing (i.e. indexing and storage).",
"required" : true,
"type" : "string"
}
],
"responses" : {
"200" : {
"description" : "The indexing job started. The information about the status of the job cab be retrieved by accessing the output location provided as output.",
"schema" : {
"$ref" : "#/definitions/Job"
}
},
"404" : {
"description" : "The job does not exist."
}
}
},
"delete" : {
"consumes" : ["*/*"],
"tags" : [ "processing jobs", "/jobs", "delete"],
"summary" : "Delete a job. Jobs can be deleted when they are in the status 'finished'.",
"description" : "",
"operationId" : "JobDelete",
"produces" : [ ],
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The ID of the ontology that proceced by the OntoNetHub for processing (i.e. indexing and storage).",
"required" : true,
"type" : "string"
}
],
"responses" : {
"200" : {
"description" : "The indexing job has been deleted.",
"schema" : {
"$ref" : "#/definitions/Job"
}
},
"404" : {
"description" : "The job does not exist."
}
}
}
},
"/stanbol/ontonethub/ontologies/find" : {
"post" : {
"consumes" : ["application/x-www-form-urlencoded"],
"tags" : [ "find" ],
"summary" : "Find the entities of the ontology network that match a specific query string.",
"description" : "",
"operationId" : "FindOnts",
"produces" : [ "application/json"],
"parameters" : [ {
"name" : "name",
"in" : "formData",
"description" : "The name of the entity (supports wildcards e.g. \"Accu*\" for \"Accuracy\")",
"required" : true,
"type" : "string"
},
{"name" : "field",
"in" : "formData",
"description" : "The name of the field used for the query. One MUST parse the full name. Namespace prefixes are not supported yet. (default is rdfs:label)",
"required" : false,
"type" : "string"
},
{"name" : "lang",
"in" : "formData",
"description" : "The language of the parsed name can be defined",
"required" : false,
"type" : "string"
},
{"name" : "ldpath",
"in" : "formData",
"description" : "LDPath (http://marmotta.apache.org/ldpath/language.html) programs can be used to specify what information to return for Entities selected by the /find request",
"required" : false,
"type" : "string"
},
{"name" : "limit",
"in" : "formData",
"description" : "The maximum number of results",
"required" : false,
"type" : "integer"
},
{"name" : "offset",
"in" : "formData",
"description" : "The offset of first result",
"required" : false,
"type" : "integer"
}
],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ResultSet"
}
}
}
}
}
},
"/stanbol/ontonethub/ontology/{id}/find" : {
"post" : {
"consumes" : ["application/x-www-form-urlencoded"],
"tags" : [ "find", "/ontonethub/ontology"],
"summary" : "Find the entities of the ontology network that match a specific query string.",
"description" : "",
"operationId" : "FindOnt",
"produces" : [ "application/json"],
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The id of the ontology to query on.",
"required" : true,
"type" : "string"
},
{
"name" : "name",
"in" : "formData",
"description" : "The name of the entity (supports wildcards e.g. \"Accu*\" for \"Accuracy\")",
"required" : true,
"type" : "string"
},
{"name" : "field",
"in" : "formData",
"description" : "The name of the field used for the query. One MUST parse the full name. Namespace prefixes are not supported yet. (default is rdfs:label)",
"required" : false,
"type" : "string"
},
{"name" : "lang",
"in" : "formData",
"description" : "The language of the parsed name can be defined",
"required" : false,
"type" : "string"
},
{"name" : "ldpath",
"in" : "formData",
"description" : "LDPath (http://marmotta.apache.org/ldpath/language.html) programs can be used to specify what information to return for Entities selected by the /find request",
"required" : false,
"type" : "string"
},
{"name" : "limit",
"in" : "formData",
"description" : "The maximum number of results",
"required" : false,
"type" : "integer"
},
{"name" : "offset",
"in" : "formData",
"description" : "The offset of first result",
"required" : false,
"type" : "integer"
}
],
"responses" : {
"200" : {
"description" : "Successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ResultSet"
}
}
},
"404" : {
"description" : "The ontology with the specified ID does not exist.",
}
}
}
}
},
"definitions" : {
"ResultSet" : {
"type" : "object",
"properties" : {
"query" : {
"type" : "object",
"properties" : {
"selected" : {
"type" : "array",
"items": {
"type": "string"
}
},
"constraints" : {
"type" : "array",
"items": {
"$ref": "#/definitions/Constraint"
}
},
"limit" : {
"type" : "integer"
},
"offset" : {
"type" : "integer"
}
}
},
"results" : {
"type" : "array",
"items": {
"$ref": "#/definitions/Result"
}
}
}
},
"Constraint" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"patternType" : {
"type" : "string"
},
"text" : {
"type" : "string"
},
"proximityRanking" : {
"type" : "boolean"
},
"field" : {
"type" : "string"
},
"boost" : {
"type" : "integer"
}
}
},
"Result" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"constraint" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"xml:lang" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
}
}
},
"JobLink" : {
"type" : "object",
"properties" : {
"monitoringService" : {
"type" : "string"
}
}
},
"Job" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string"
},
"outputLocation" : {
"type" : "string"
},
"messages" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"OntologyInfo" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"ontologySource" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"ontologyIRI" : {
"type" : "string"
},
"owlClasses" : {
"type" : "integer"
},
"objectProperties" : {
"type" : "integer"
},
"datatypeProperties" : {
"type" : "integer"
},
"annotationProperties" : {
"type" : "integer"
},
"importedOntologies" : {
"type" : "integer"
}
}
},
"Error" : {
"type" : "object",
"properties" : {
"error" : {
"type" : "string"
}
}
}
}
}