/
swagger.json
198 lines (198 loc) · 4.79 KB
/
swagger.json
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
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Data Integration Challenge",
"contact": {
"name": "Alexandre C. Moraes",
"email": "alcmoraes89@gmail.com",
"url": "https://www.linkedin.com/in/alexandre-moraes-9a279765/"
},
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"host": "http://localhost:8080",
"basePath": "/",
"schemes": [
"http"
],
"consumes": [
"application/json",
"multipart/form-data"
],
"produces": [
"application/json"
],
"paths": {
"/companies/upload": {
"post": {
"consumes": [
"multipart/form-data"
],
"description": "Integrate data using a CSV file.\n\nIt's **mandatory** that the CSV uses the `;` delimiter and that its first row declares each column type:\n\n`name` For the company name;\n\n`zip` For the company zipcode;\n\n`website` For the company website;",
"operationId": "UploadCompanies",
"parameters": [{
"name": "file",
"in": "formData",
"description": "The CSV file",
"required": true,
"paramType": "file",
"type": "file"
}, {
"name": "persist",
"in": "formData",
"description": "If `true` it will create companies when not matching a existent one in database. Otherwise it will discard companies that don't match any on storage.",
"required": false,
"default": "false",
"paramType": "form",
"enum": ["true", "false"],
"type": "boolean"
}],
"responses": {
"200": {
"description": "Common response",
"schema": {
"$ref": "#/definitions/Success"
}
},
"default": {
"description": "unexpected error",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
}
},
"/companies": {
"get": {
"description": "Return the first company matching the `name` and `zip` parameter given",
"operationId": "GetCompany",
"parameters": [{
"name": "name",
"in": "query",
"description": "The company name (can be just a part of it)",
"required": true,
"type": "string"
},
{
"name": "zip",
"in": "query",
"description": "The company zipcode",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Company response",
"schema": {
"$ref": "#/definitions/CompanyResponse"
}
},
"default": {
"description": "unexpected error",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
},
"post": {
"description": "Merges a company into the database",
"operationId": "MergeCompany",
"responses": {
"description": "Common response",
"schema": {
"$ref": "#/definitions/Success"
},
"default": {
"description": "Unexpected error",
"schema": {
"$ref": "#/definitions/Error"
}
}
},
"parameters": [
{
"name": "company",
"in": "body",
"description": "Company to merge to the database",
"required": true,
"schema": {
"$ref": "#/definitions/Company"
}
}
]
}
}
},
"definitions": {
"Company": {
"type": "object",
"required": [
"name",
"zip",
"website"
],
"properties": {
"name": {
"type": "string"
},
"zip": {
"type": "string"
},
"website": {
"type": "string"
}
}
},
"Success": {
"type": "object",
"properties": {
"status": {
"type": "string",
"default": "OK"
},
"message": {
"type": "string",
"default": "Done!"
}
}
},
"CompanyResponse": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"name": {
"type": "string"
},
"zip": {
"type": "string"
},
"website": {
"type": "string"
}
}
},
"Error": {
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"status": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}