This repository has been archived by the owner on Mar 24, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
/
swagger.json
232 lines (232 loc) · 7.59 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
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
{
"swagger": "2.0",
"responses": {
"ParseError": {
"description": "When a mask can't be parsed"
},
"MaskError": {
"description": "When any error occurs on mask"
}
},
"produces": [
"application/json"
],
"definitions": {
"Validation": {
"properties": {
"ecosystem": {
"description": "In which ecosystem is the stack specification to be validated: [pypi]",
"example": "pypi",
"type": "string"
},
"valid": {
"description": "This indicates that the Validation is valid",
"example": "true",
"type": "boolean"
},
"raw_log": {
"description": "This is the raw log of the Validation job",
"type": "string"
},
"phase": {
"description": "Phase of the Validation job: [pending, running, succeeded, failed]",
"example": "succeeded",
"type": "string"
},
"stack_specification": {
"description": "Specification of the Software Stack",
"example": "pandas\\nnumpy>=1.11.0",
"type": "string"
},
"id": {
"description": "The Validation unique identifier",
"example": "7b63d226-1d6c-11e8-968f-54ee7504b46f",
"type": "string"
}
},
"type": "object",
"required": [
"ecosystem",
"id",
"phase",
"stack_specification"
]
},
"ValidationListItem": {
"properties": {
"id": {
"description": "The Validation unique identifier",
"example": "7b63d226-1d6c-11e8-968f-54ee7504b46f",
"type": "string"
}
},
"type": "object",
"required": [
"id"
]
},
"ValidationRequest": {
"properties": {
"stack_specification": {
"description": "Specification of the Software Stack",
"example": "pandas\\nnumpy>=1.11.0",
"type": "string"
},
"ecosystem": {
"description": "In which ecosystem is the stack specification to be validated: [pypi]",
"default": "pypi",
"type": "string"
}
},
"type": "object",
"required": [
"ecosystem",
"stack_specification"
]
}
},
"info": {
"description": "The \"Dependency Monkey\" is a service for validating package dependencies within an application stack",
"version": "0.1.0",
"title": "Thoth: Dependency Monkey API"
},
"tags": [
{
"description": "Default namespace",
"name": "default"
},
{
"description": "Validations",
"name": "validations"
}
],
"paths": {
"/api/v0alpha0/validations/": {
"get": {
"parameters": [
{
"format": "mask",
"name": "X-Fields",
"description": "An optional fields mask",
"in": "header",
"type": "string"
}
],
"tags": [
"validations"
],
"responses": {
"200": {
"description": "Success",
"schema": {
"items": {
"$ref": "#/definitions/ValidationListItem"
},
"type": "array"
}
},
"503": {
"description": "Service we depend on is not available"
}
},
"operationId": "list_validations",
"summary": "List all Validations"
},
"post": {
"parameters": [
{
"name": "payload",
"schema": {
"$ref": "#/definitions/ValidationRequest"
},
"in": "body",
"required": true
},
{
"format": "mask",
"name": "X-Fields",
"description": "An optional fields mask",
"in": "header",
"type": "string"
}
],
"tags": [
"validations"
],
"responses": {
"400": {
"description": "Ecosystem not supported"
},
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Validation"
}
},
"503": {
"description": "Service we depend on is not available"
}
},
"operationId": "request_validation",
"summary": "Request a new Validation"
}
},
"/api/v0alpha0/validations/{id}": {
"get": {
"parameters": [
{
"format": "mask",
"name": "X-Fields",
"description": "An optional fields mask",
"in": "header",
"type": "string"
}
],
"tags": [
"validations"
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Validation"
}
},
"404": {
"description": "Validation not found"
}
},
"operationId": "get_validation",
"summary": "Show a specific Validation"
},
"parameters": [
{
"description": "The Validation identifier",
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"delete": {
"tags": [
"validations"
],
"responses": {
"204": {
"description": "Validation deleted"
},
"404": {
"description": "Validation not found"
}
},
"operationId": "delete_validation",
"summary": "Delete a Validation given its identifier"
}
}
},
"consumes": [
"application/json"
],
"basePath": "/"
}