Skip to content

Commit a2d0fff

Browse files
committed
Add schemas for remaining responses.
1 parent d2ff28d commit a2d0fff

File tree

1 file changed

+114
-14
lines changed

1 file changed

+114
-14
lines changed

src/main/resources/docs/swagger.yaml

Lines changed: 114 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,14 @@ paths:
5757
content:
5858
application/json:
5959
schema:
60-
type: object
61-
properties:
62-
isConsistent:
63-
type: boolean
64-
label:
65-
type: string
66-
logicalAxiomsCount:
67-
type: integer
60+
$ref: "#/components/schemas/kbInfo"
6861
examples:
6962
response:
7063
value:
7164
label: uberon
7265
isConsistent: true
7366
logicalAxiomsCount: 43938
67+
7468
"/kbs/{kb}/subclasses":
7569
get:
7670
tags:
@@ -103,7 +97,8 @@ paths:
10397
summary: an anonymous expression, using prefix definitions
10498
- name: prefixes
10599
in: query
106-
description: JSON format prefix map, used to expand prefixes in the 'object'
100+
description: >-
101+
JSON format prefix map, used to expand prefixes in the 'object'
107102
expression
108103
required: false
109104
schema:
@@ -141,6 +136,27 @@ paths:
141136
description: subclasses
142137
content:
143138
application/json:
139+
schema:
140+
type: object
141+
additionalProperties:
142+
type: object
143+
properties:
144+
value:
145+
type: object
146+
properties:
147+
"@id":
148+
type: string
149+
format: uri
150+
superClassOf:
151+
type: array
152+
items:
153+
type: string
154+
format: uri
155+
value:
156+
type: string
157+
required:
158+
- "@id"
159+
- superClassOf
144160
examples:
145161
named class:
146162
value:
@@ -230,6 +246,22 @@ paths:
230246
description: superclasses
231247
content:
232248
application/json:
249+
schema:
250+
type: object
251+
properties:
252+
'@id':
253+
type: string
254+
format: uri
255+
value:
256+
type: string
257+
subClassOf:
258+
type: array
259+
items:
260+
type: string
261+
format: uri
262+
required:
263+
- "@id"
264+
- subClassOf
233265
examples:
234266
named class:
235267
value:
@@ -304,6 +336,27 @@ paths:
304336
description: equivalent classes
305337
content:
306338
application/json:
339+
schema:
340+
type: object
341+
additionalProperties:
342+
type: object
343+
properties:
344+
value:
345+
type: object
346+
properties:
347+
"@id":
348+
type: string
349+
format: uri
350+
equivalentClass:
351+
type: array
352+
items:
353+
type: string
354+
format: uri
355+
value:
356+
type: string
357+
required:
358+
- "@id"
359+
- equivalentClass
307360
examples:
308361
named class:
309362
value:
@@ -365,6 +418,19 @@ paths:
365418
description: satisfiability
366419
content:
367420
application/json:
421+
schema:
422+
type: object
423+
properties:
424+
"@id":
425+
type: string
426+
format: uri
427+
isSatisfiable:
428+
type: boolean
429+
value:
430+
type: string
431+
required:
432+
- "@id"
433+
- isSatisfiable
368434
examples:
369435
named class:
370436
value:
@@ -420,6 +486,17 @@ paths:
420486
description: instances
421487
content:
422488
application/json:
489+
schema:
490+
type: object
491+
properties:
492+
"@id":
493+
type: string
494+
format: uri
495+
hasInstance:
496+
type: array
497+
items:
498+
type: string
499+
format: uri
423500
examples:
424501
named class:
425502
value:
@@ -509,7 +586,9 @@ paths:
509586
'200':
510587
description: SPARQL results
511588
content:
512-
application/sparql-results+xml: {}
589+
application/sparql-results+xml:
590+
schema:
591+
type: string
513592
post:
514593
tags:
515594
- SPARQL
@@ -530,20 +609,24 @@ paths:
530609
application/sparql-query:
531610
schema:
532611
type: string
533-
format: SPARQL query
612+
# format: SPARQL query
534613
example: SELECT ?x WHERE { ?x a "blah"}
535614
application/x-www-form-urlencoded:
536615
schema:
537616
type: object
538617
properties:
539618
query:
540619
type: string
541-
format: SPARQL query
620+
# format: SPARQL query
542621
required:
543622
- query
544623
responses:
545624
'200':
546-
description: SPARQL results
625+
description: SPARQL results
626+
content:
627+
application/json:
628+
schema:
629+
type: string
547630
"/kbs/{kb}/expand":
548631
get:
549632
tags:
@@ -568,7 +651,9 @@ paths:
568651
'200':
569652
description: Expanded SPARQL query
570653
content:
571-
application/sparql-query: {}
654+
application/sparql-query:
655+
schema:
656+
type: string
572657
post:
573658
tags:
574659
- SPARQL
@@ -602,6 +687,10 @@ paths:
602687
responses:
603688
'200':
604689
description: SPARQL results
690+
content:
691+
application/json:
692+
schema:
693+
type: string
605694
components:
606695
schemas:
607696
prefixMap:
@@ -616,4 +705,15 @@ components:
616705
type: string
617706
format: JSON
618707
example: '{"obo": "http://purl.obolibrary.org/obo/", "part_of": "http://purl.obolibrary.org/obo/BFO_0000050"}'
708+
kbInfo:
709+
description: >-
710+
Information provided about a specific KB.
711+
type: object
712+
properties:
713+
isConsistent:
714+
type: boolean
715+
label:
716+
type: string
717+
logicalAxiomsCount:
718+
type: integer
619719

0 commit comments

Comments
 (0)