-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathjsonSchemas.raml
52 lines (48 loc) · 1.53 KB
/
jsonSchemas.raml
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
#%RAML 1.0
title: JSON Schema API
version: v1
baseUri: http://localhost:8081/{version}
documentation:
- title: JSON Schema API
content: This documents the API calls that can be made to get JSON Schemas of a module defined by X-Okapi-Module-Id header
types:
errors: !include ../schemas/errors.schema
/_/jsonSchemas:
get:
description: |
Get JSON Schemas for the given module defined by header X-Okapi-Module-Id.
Without path query param will return list of JSON Schema paths.
With path query param will return the specific JSON Schema with resolvable references.
queryParameters:
path:
displayName: JSON Schema Path
type: string
description: Path to specific JSON Schema
example: userdata.json
required: false
responses:
200:
description: "JSON Schema"
body:
application/json:
example: |
[
"userdataCollection.json",
"usergroups.json",
"proxyfor.json",
"userdata.json",
"proxyforCollection.json",
"usergroup.json",
"addresstype.json",
"addresstypeCollection.json"
]
application/schema+json:
404:
description: "JSON Schema with a given path not found"
body:
text/plain:
500:
description: "Internal server error"
body:
text/plain:
example: "Internal server error, contact administrator"