This repository has been archived by the owner on May 4, 2022. It is now read-only.
/
swagger.yaml
386 lines (384 loc) · 11.5 KB
/
swagger.yaml
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
swagger: "2.0"
info:
description: "Atomist Explorer"
version: 1.0.0
title: Atomist Explorer
termsOfService: "http://swagger.io/terms/"
contact:
email: "info@atomist.com"
license:
name: Apache 2.0
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
basePath: /api/v1
tags:
- name: atomist
description: Explore your projects
externalDocs:
description: Find out more about how Atomist can help visualize and improve your projects
url: "https://www.atomist.com"
schemes:
- http
paths:
/{workspace}/aspects:
get:
tags:
- aspects
summary: Find all aspects in workspace
description: Find aspects in workspace
operationId: findAspects
produces:
- application/json
parameters:
- name: workspace
in: path
description: Workspace id. * for all.
required: true
type: string
responses:
"200":
description: successful operation
schema:
type: object
properties:
list:
type: array
items:
$ref: "#/definitions/Category"
"400":
description: Invalid workspace id
/{workspace}/tags:
get:
tags:
- tags
summary: Find all tags in workspace, including their usage
description: Find tags in workspace
operationId: findTags
produces:
- application/json
parameters:
- name: workspace
in: path
description: Workspace id. * for all.
required: true
type: string
responses:
"200":
description: successful operation
schema:
type: object
properties:
list:
type: array
items:
$ref: "#/definitions/Category"
"400":
description: Invalid workspace id
/{workspace}/fingerprints:
get:
tags:
- fingerprints
summary: Find all fingerprints in workspace
description: Find fingerprints in workspace
operationId: findAllFingerprints
produces:
- application/json
parameters:
- name: workspace
in: path
description: Workspace id. * for all.
required: true
type: string
responses:
"200":
description: successful operation
schema:
type: object
properties:
list:
type: array
items:
$ref: "#/definitions/Fingerprint"
"400":
description: Invalid workspace id
/{workspace}/fingerprint/{type}:
get:
tags:
- fingerprints
summary: Find all fingerprints of a given type in the workspace
description: Find fingerprints of a given type in workspace
operationId: findFingerprintsByType
produces:
- application/json
parameters:
- name: workspace
in: path
description: Workspace id. * for all.
required: true
type: string
- name: type
in: path
description: Fingerprint type
required: true
type: string
responses:
"200":
description: successful operation
schema:
type: object
properties:
list:
type: array
items:
$ref: "#/definitions/Fingerprint"
"400":
description: Invalid status value
/{workspace}/fingerprint/{type}/{name}:
get:
tags:
- fingerprints
summary: Show the distribution of a fingerprint in the workspace
description: Show the distribution of a fingerprint in the workspace, in a tree structure where the outer ring is repository
operationId: findFingerprintsByNameAndType
produces:
- application/json
parameters:
- name: workspace
in: path
description: Workspace id. * for all.
required: true
type: string
- name: type
in: path
description: Fingerprint type
required: true
type: string
- name: name
in: path
description: Fingerprint name. Use "*" to show all fingerprints of type
required: true
type: string
- name: byOrg
in: query
description: Introduce a tree layer by organization
type: string
enum:
- true
- false
required: false
default: true
- name: trim
in: query
description: Trim outer ring (repositories). Only relevant if name=*
type: string
enum:
- true
- false
required: false
default: false
responses:
"200":
description: successful operation
schema:
type: object
properties:
tree:
$ref: "#/definitions/Tree"
"400":
description: Invalid status value
/{workspace}/drift:
get:
tags:
- drift
summary: Show drift in the workspace
description: Show drift in the workspace, in a tree structure where the outer ring is fingerprint
operationId: drift
produces:
- application/json
parameters:
- name: workspace
in: path
description: Workspace id. * for all.
required: true
type: string
parameters:
- name: percentile
in: query
description: Entropy percentile (e.g. 80). Only show aspects with entropy above this.
required: false
type: integer
format: int32
default: 0
- name: band
in: query
description: Introduce a ring for size band
type: string
enum:
- true
- false
required: false
default: false
parameters:
- name: type
in: query
description: Aspect name (fingerprint type) to show drift for
required: false
type: string
responses:
"200":
description: successful operation
schema:
type: object
properties:
tree:
$ref: "#/definitions/Tree"
"400":
description: Invalid status value
/{workspace}/entropy/{type}/{name}:
put:
tags:
- entropy
summary: Calculate entropy for the given fingerprint
description: Calculate entropy for the given fingerprint
operationId: calculateEntropy
produces:
- application/json
parameters:
- name: workspace
in: path
description: Workspace id
required: true
type: string
- name: type
in: path
description: Fingerprint type
required: true
type: string
- name: name
in: path
description: Fingerprint name
required: true
type: string
responses:
"201":
description: successful operation
"400":
description: Invalid status value
/{workspace}/explore:
get:
tags:
- repositories
summary: Find all repositories in workspace matching one or more tags
description: Find all repositories in workspace matching one or more tags
operationId: findByTag
produces:
- application/json
parameters:
- name: workspace
in: path
description: Workspace id. * for all.
required: true
type: string
- name: tags
in: query
description: Comma-separate list of tags to search for.
required: false
type: string
- name: byOrg
in: query
description: Introduce a tree layer by organization
type: string
enum:
- true
- false
required: false
default: true
responses:
"200":
description: successful operation
schema:
type: object
properties:
tags:
type: array
description: Thing
items:
type: object
properties:
name:
type: string
description: Tag name
count:
description: Occurrence among matching repositories
type: integer
format: int32
selectedTags:
type: array
description: Selected tags
items:
type: string
tree:
description: Org/repositories/tags
$ref: "#/definitions/Tree"
"400":
description: Invalid workspace id
components:
schemas:
Aspect:
type: object
properties:
name:
type: string
description: Human readable aspect name
type:
type: string
description: Aspect name
description:
type: string
description: Description
url:
type: string
description: URL for futher information
definitions:
Category:
properties:
category:
type: string
description: Category tag
count:
type: integer
format: int32
aspects:
type: array
items:
$ref: "#/components/schemas/Aspect"
description: Aspects in this category
Fingerprint:
properties:
type:
type: string
description: Fingerprint type
name:
type: string
description: Fingerprint name
variants:
type: integer
format: int32
count:
type: integer
format: int32
entropy:
type: integer
format: float
description: Entropy across the organization for this fingerprint.
Tree:
properties:
name:
type: string
description: Name of this level
children:
type: array
items:
# Probably need to do https://stackoverflow.com/questions/36866035/how-to-refer-to-enclosing-type-definition-recursively-in-openapi-swagger
$ref: "#/definitions/Tree"
required:
- name