/
copycat.raml
142 lines (138 loc) · 3.35 KB
/
copycat.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
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
#%RAML 1.0
title: copycat
version: v0.0
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost
types:
copyCatImports: !include copycatimports.json
copyCatProfile: !include copycatprofile.json
copyCatCollection: !include copycatcollection.json
error: !include raml-util/schemas/error.schema
errors: !include raml-util/schemas/errors.schema
traits:
pageable: !include raml-util/traits/pageable.raml
searchable: !include raml-util/traits/searchable.raml
/copycat:
/imports:
post:
description: Import record from external system
body:
application/json:
type: copyCatImports
responses:
200:
description: Imported OK
body:
application/json:
type: copyCatImports
400:
description: Import error
body:
application/json:
type: errors
500:
description: Internal error
body:
text/plain:
/profiles:
post:
description: Create profile
body:
application/json:
type: copyCatProfile
responses:
201:
description: Created OK
headers:
Location:
description: URI of profile
body:
application/json:
type: copyCatProfile
400:
description: Error in usage
body:
text/plain:
500:
description: Internal error
body:
text/plain:
get:
is: [pageable,
searchable: {
description: "search profiles",
example: "name = loc"}
]
description: Get profiles
responses:
200:
description: Get collection OK
body:
application/json:
type: copyCatCollection
400:
description: Error in usage
body:
text/plain:
500:
description: Internal error
body:
text/plain:
/{id}:
get:
description: Get profile
responses:
200:
description: retrieved OK
body:
application/json:
type: copyCatProfile
400:
description: User error
body:
text/plain:
404:
description: Not found
body:
text/plain:
500:
description: Internal error
body:
text/plain:
put:
description: Update target profile
body:
application/json:
type: copyCatProfile
responses:
204:
description: updated OK
400:
description: User error
body:
text/plain:
404:
description: Not found
body:
text/plain:
500:
description: Internal error
body:
text/plain:
delete:
description: Delete target profile
responses:
204:
description: deleted OK
400:
description: User error
body:
text/plain:
404:
description: Not found
body:
text/plain:
500:
description: Internal error
body:
text/plain: