/
openapi.yml
631 lines (629 loc) · 16.4 KB
/
openapi.yml
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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
openapi: 3.0.0
info:
title: Common Fate Provider Registry
version: '1.0'
contact:
name: Common Fate
url: 'https://api.registry.commonfate.io'
description: The Common Fate Provider Registry API.
servers:
- url: 'http://localhost:9001'
paths:
'/v1alpha1/providers/{publisher}/{name}/{version}':
parameters:
- schema:
type: string
name: publisher
in: path
required: true
- schema:
type: string
name: version
in: path
required: true
- schema:
type: string
name: name
in: path
required: true
get:
summary: Get Provider
operationId: get-provider
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderDetail'
'404':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
tags:
- Public
'/v1alpha1/providers/{publisher}/{name}':
parameters:
- schema:
type: string
name: publisher
in: path
required: true
- schema:
type: string
name: name
in: path
required: true
get:
summary: List Provider Versions
operationId: list-provider-versions
responses:
'200':
$ref: '#/components/responses/ListProvidersResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
tags:
- Public
description: 'pass in a generic published/name combination and get the full list of providers '
'/v1alpha1/providers/{publisher}/{name}/{version}/readme':
parameters:
- schema:
type: string
name: publisher
in: path
required: true
- schema:
type: string
name: version
in: path
required: true
- schema:
type: string
name: name
in: path
required: true
get:
summary: Get Provider Readme
operationId: get-provider-readme
responses:
'200':
$ref: '#/components/responses/ProviderReadmeResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
tags:
- Public
description: Returns the readme for this provider
/v1alpha1/providers:
get:
summary: List Providers
tags:
- Public
responses:
'200':
$ref: '#/components/responses/ListProvidersResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
operationId: list-all-providers
parameters:
- schema:
type: boolean
in: query
name: withDev
description: withDev flag will return all providers including dev providers
/v1alpha1/health:
get:
summary: Healthcheck
tags: []
responses:
'200':
$ref: '#/components/responses/HealthResponse'
operationId: healthcheck
description: Returns a HTTP 200 OK response if the registry service is healthy.
/v1alpha1/publish:
parameters: []
post:
summary: Publish a Provider
operationId: user-publish-provider
responses:
'200':
$ref: '#/components/responses/PublishProviderResponse'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
description: |-
Publish a new Provider, you may call this API multiple times for the same provider version until you have marked the publishing as complete.
Once a file has been successfully uploaded, it cannot be overwritten.
You will need to publish with a new version number.
tags:
- Team
requestBody:
$ref: '#/components/requestBodies/PublishProviderRequest'
/v1alpha1/publish/complete:
parameters: []
post:
summary: Complete Publishing a Provider
operationId: user-complete-publish-provider
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProviderDetail'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'404':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
description: Complete publishing a new provider should be called when uploading is complete.
tags:
- Team
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Provider'
/v1alpha1/publishers:
post:
summary: Create Publisher
operationId: user-create-publisher
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Publisher'
'400':
$ref: '#/components/responses/ErrorResponse'
'401':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
description: ''
requestBody:
$ref: '#/components/requestBodies/CreatePublisherRequest'
/v1alpha1/me:
get:
summary: Get Me
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'401':
$ref: '#/components/responses/ErrorResponse'
'500':
$ref: '#/components/responses/ErrorResponse'
operationId: user-get-me
description: describes the current user
components:
schemas:
ProviderDetail:
title: ProviderDetail
x-stoplight:
id: ad9be36dbe096
type: object
description: A registered provider version
properties:
publisher:
type: string
name:
type: string
version:
type: string
lambdaAssetS3Arn:
type: string
cfnTemplateS3Arn:
type: string
schema:
$ref: '#/components/schemas/Schema'
createdAt:
type: string
updatedAt:
type: string
meta:
$ref: '#/components/schemas/ProviderMetaInfo'
required:
- publisher
- name
- version
- lambdaAssetS3Arn
- cfnTemplateS3Arn
- schema
- createdAt
- updatedAt
Provider:
title: Provider
type: object
description: A registered provider version
x-stoplight:
id: b4d9111a1ff26
properties:
publisher:
type: string
pattern: '^[a-z0-9-]+$'
name:
type: string
pattern: '^[a-z0-9-]+$'
version:
type: string
pattern: '^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-[\da-z\-]+(?:\.[\da-z\-]+)*)?(?:\+[\da-z\-]+(?:\.[\da-z\-]+)*)?$'
required:
- publisher
- name
- version
DiagnosticLog:
title: DiagnosticLog
x-stoplight:
id: xq5uhsxpiml1y
type: object
properties:
level:
$ref: '#/components/schemas/LogLevel'
msg:
type: string
required:
- level
- msg
DescribeResponse:
title: DescribeResponse
x-stoplight:
id: atffan2bx099r
type: object
properties:
provider:
$ref: '#/components/schemas/Provider'
config:
type: object
healthy:
type: boolean
diagnostics:
type: array
items:
$ref: '#/components/schemas/DiagnosticLog'
schema:
$ref: '#/components/schemas/Schema'
required:
- provider
- config
- healthy
- diagnostics
- schema
LogLevel:
title: LogLevel
x-stoplight:
id: r9cextojd3t67
type: string
enum:
- INFO
- ERROR
- WARNING
Config:
properties:
description:
description: The usage for the config variable.
title: Description
type: string
secret:
default: false
title: Secret
type: boolean
type:
enum:
- string
title: Type
type: string
required:
- type
title: Config
type: object
Loader:
description: |-
A callable function in the provider which can
load resources.
Additional fields for loader configuration may be added
in a future specification.
properties:
title:
title: Title
type: string
required:
- title
title: Loader
type: object
Meta:
properties:
framework:
description: The Provider Developer Kit framework version which published the schema.
title: Framework
type: string
title: Meta
type: object
Providers:
properties:
name:
title: Name
type: string
publisher:
title: Publisher
type: string
version:
title: Version
type: string
required:
- publisher
- name
- version
title: Provider
type: object
Resources:
properties:
loaders:
additionalProperties:
$ref: '#/components/schemas/Loader'
x-go-type: 'map[string]Loader'
title: Loaders
type: object
types:
description: the types of resources
title: Types
type: object
required:
- loaders
- types
title: Resources
type: object
description: ''
Target:
properties:
properties:
additionalProperties:
$ref: '#/components/schemas/TargetField'
x-go-type: 'map[string]TargetField'
description: the actual properties of the target.
title: Properties
type: object
type:
description: included for compatibility with JSON Schema - all targets are currently objects.
enum:
- object
title: Type
type: string
required:
- type
- properties
title: Target
type: object
TargetField:
properties:
description:
title: Description
type: string
resource:
description: 'If specified, the type of the resource the field should be populated from.'
title: Resource
type: string
title:
title: Title
type: string
type:
enum:
- string
title: Type
type: string
required:
- type
title: TargetField
type: object
Schema:
description: The schema for a Common Fate Provider.
properties:
$id:
type: string
$schema:
type: string
config:
additionalProperties:
$ref: '#/components/schemas/Config'
x-go-type: 'map[string]Config'
title: Config
type: object
meta:
$ref: '#/components/schemas/Meta'
provider:
$ref: '#/components/schemas/Provider'
resources:
$ref: '#/components/schemas/Resources'
targets:
additionalProperties:
$ref: '#/components/schemas/Target'
x-go-type: 'map[string]Target'
title: Targets
type: object
required:
- meta
- $id
- $schema
title: Schema
type: object
ProviderMetaInfo:
type: object
properties:
icon:
type: string
source:
type: string
displayName:
type: string
title: ProviderMetaInfo
description: 'Metadata from provider.toml file for a Provider '
x-stoplight:
id: 1bb8b6403eed2
Publisher:
title: Publisher
x-stoplight:
id: h3ifqy9uln5u5
type: object
description: Publisher
properties:
id:
type: string
pattern: '^[a-z0-9-]+$'
required:
- id
User:
title: User
x-stoplight:
id: twwtshp9im1fp
type: object
properties:
id:
type: string
email:
type: string
publishers:
type: array
items:
type: string
required:
- id
- email
- publishers
requestBodies:
PublishProviderRequest:
content:
application/json:
schema:
type: object
properties:
publisher:
type: string
pattern: '^[a-z0-9-]+$'
name:
type: string
pattern: '^[a-z0-9-]+$'
version:
type: string
pattern: '^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-[\da-z\-]+(?:\.[\da-z\-]+)*)?(?:\+[\da-z\-]+(?:\.[\da-z\-]+)*)?$'
description: Version must follow server format
roleFiles:
type: array
description: an array of filenames for role templates to be uploaded
items:
type: string
schema:
$ref: '#/components/schemas/Schema'
meta:
$ref: '#/components/schemas/ProviderMetaInfo'
dev:
type: boolean
required:
- publisher
- name
- version
- roleFiles
- schema
- meta
CreatePublisherRequest:
content:
application/json:
schema:
type: object
properties:
id:
type: string
pattern: '^[a-z0-9-]+$'
required:
- id
responses:
HealthResponse:
description: Healthcheck response body.
content:
application/json:
schema:
type: object
properties:
healthy:
type: boolean
required:
- healthy
examples: {}
ErrorResponse:
description: An error returned from the API.
content:
application/json:
schema:
type: object
properties:
error:
type: string
required:
- error
examples: {}
ListProvidersResponse:
description: Example response
content:
application/json:
schema:
type: object
properties:
providers:
type: array
items:
$ref: '#/components/schemas/ProviderDetail'
next:
type: string
nullable: true
required:
- providers
- next
PublishProviderResponse:
description: 'Response contai9ns presigned URLs for uploading provider assets. Once assets have been uploaded, complete publishing provider should be called.'
content:
application/json:
schema:
type: object
properties:
lambdaHandlerUploadUrl:
type: string
cloudformationTemplateUploadUrl:
type: string
readmeUploadUrl:
type: string
roleTemplateUploadURLs:
description: filename is the key and value is the upload URL
type: object
x-go-type: 'map[string]string'
required:
- lambdaHandlerUploadUrl
- cloudformationTemplateUploadUrl
- readmeUploadUrl
- roleTemplateUploadURLs
ProviderReadmeResponse:
description: Provider Readme
content:
application/json:
schema:
type: object
properties:
readme:
type: string
required:
- readme
tags:
- name: Public
- name: Team