-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcatalog-info.yaml
More file actions
1281 lines (1256 loc) · 38.4 KB
/
catalog-info.yaml
File metadata and controls
1281 lines (1256 loc) · 38.4 KB
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
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: auth-core
description: Library for authentication related interfaces and utilities
tags:
- typescript
spec:
type: library
lifecycle: experimental
owner: devinfra
system: authentication
---
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: auth-bundler
description: Library for creating OPA bundles
tags:
- typescript
spec:
type: library
lifecycle: experimental
owner: devinfra
system: authentication
dependsOn:
- component:default/auth-core
---
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
name: auth-manager
description: Manages the authentication database
annotations:
github.com/project-slug: MapColonies/opa-la
tags:
- nodejs
- typescript
- expressjs
spec:
type: service
lifecycle: experimental
owner: devinfra
system: authentication
dependsOn:
- resource:default/auth-db
- component:default/auth-core
providesApis:
- auth-manager-api
---
apiVersion: backstage.io/v1alpha1
kind: API
metadata:
name: auth-manager-api
description: auth-manager service API for creating and updating authentication data.
spec:
type: openapi
lifecycle: experimental
owner: devinfra
system: authentication
definition: |
openapi: 3.0.1
info:
title: auth-manager
description: API server for managing all the authentication data
version: 1.12.0
license:
name: MIT
url: https://opensource.org/licenses/MIT
paths:
/client:
get:
operationId: getClients
summary: gets clients by filtering
tags:
- client
parameters:
- in: query
name: name
description: search by client name (partial match, case-insensitive)
schema:
type: string
- in: query
name: branch
description: search by branch name
schema:
type: string
- in: query
name: createdBefore
description: filters all clients created before given date
schema:
type: string
format: date-time
- in: query
name: createdAfter
description: filters all clients created after given date
schema:
type: string
format: date-time
- in: query
name: updatedBefore
description: filters all clients updated before given date
schema:
type: string
format: date-time
- in: query
name: updatedAfter
description: filters all clients updated after given date
schema:
type: string
format: date-time
- in: query
name: tags
description: filters based on tags
schema:
type: array
uniqueItems: true
items:
type: string
- in: query
name: sort
description: >-
Sorts the results based on the value of one or more properties.
The value is a comma-separated list of property names and sort order.
properties should be separated by a colon and sort order should be either asc or desc. For example: created-at:asc,name:asc
The default sort order is ascending. If the sort order is not specified, the default sort order is used. Each property is only allowed to appear once in the list.
The available properties are:
- created-at
- updated-at
- name
- heb-name
- branch
example:
- created-at:asc
- name:asc
required: false
explode: false
schema:
default:
- name:asc
type: array
uniqueItems: true
items:
example: name:asc
type: string
pattern: ^(created-at|updated-at|name|heb-name|branch)(:asc|:desc){0,1}$
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/pageSize"
responses:
"200":
description: OK
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/paginationResponse"
- type: object
required:
- items
properties:
items:
description: list of clients
type: array
uniqueItems: true
minItems: 0
maxItems: 1000
items:
$ref: "#/components/schemas/client"
"400":
$ref: "#/components/responses/400BadRequest"
"500":
$ref: "#/components/responses/500InternalServerError"
post:
operationId: createClient
summary: creates a new client
tags:
- client
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/client"
responses:
"201":
description: created
content:
application/json:
schema:
$ref: "#/components/schemas/client"
"400":
$ref: "#/components/responses/400BadRequest"
"409":
$ref: "#/components/responses/409Conflict"
"500":
$ref: "#/components/responses/500InternalServerError"
"/client/{clientName}":
parameters:
- $ref: "#/components/parameters/clientParam"
get:
operationId: getClient
summary: get client by name
tags:
- client
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/client"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
patch:
operationId: updateClient
summary: update the client
tags:
- client
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/namelessClient"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/client"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
"/client/{clientName}/connection":
parameters:
- $ref: "#/components/parameters/clientParam"
get:
operationId: getClientConnections
summary: gets the connections for a specific client
tags:
- connection
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/connection"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
"/client/{clientName}/connection/{environment}":
parameters:
- $ref: "#/components/parameters/clientParam"
- $ref: "#/components/parameters/environmentPathParam"
get:
operationId: getClientEnvironmentConnections
summary: get the latest client connection for specific environment
tags:
- connection
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/connection"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
"/client/{clientName}/connection/{environment}/{version}":
parameters:
- $ref: "#/components/parameters/clientParam"
- $ref: "#/components/parameters/environmentPathParam"
- $ref: "#/components/parameters/versionParam"
get:
operationId: getClientVersionedConnection
summary: get a specfic client connection for specific environment
tags:
- connection
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/connection"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
"/client/{clientName}/connection/{environment}/latest":
parameters:
- $ref: "#/components/parameters/clientParam"
- $ref: "#/components/parameters/environmentPathParam"
get:
operationId: getClientLatestConnection
summary: get the latest client connection for specific environment
tags:
- connection
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/connection"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
/connection:
get:
operationId: getConnections
summary: get a connections based on filters
tags:
- connection
parameters:
- in: query
name: name
description: search by client name (partial match, case-insensitive)
schema:
type: string
- in: query
name: onlyLatest
description: if true, returns only the latest version per (name, environment) pair
schema:
type: boolean
default: false
- $ref: "#/components/parameters/environmentQueryParam"
- in: query
name: isEnabled
schema:
type: boolean
- in: query
name: isNoBrowser
schema:
type: boolean
- in: query
name: isNoOrigin
schema:
type: boolean
- in: query
name: domains
schema:
type: array
uniqueItems: true
items:
type: string
- in: query
name: sort
description: >-
Sorts the results based on the value of one or more properties.
The value is a comma-separated list of property names and sort order.
properties should be separated by a colon and sort order should be either asc or desc. For example: created-at:asc,name:asc
The default sort order is ascending. If the sort order is not specified, the default sort order is used. Each property is only allowed to appear once in the list.
The available properties are:
- created-at
- name
- version
- enabled
- environment
example:
- created-at:asc
- name:asc
required: false
explode: false
schema:
default:
- name:asc
- environment:asc
- version:desc
type: array
uniqueItems: true
items:
example: name:asc
type: string
pattern: ^(created-at|name|version|enabled|environment)(:asc|:desc){0,1}$
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/pageSize"
responses:
"200":
description: OK
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/paginationResponse"
- type: object
required:
- items
properties:
items:
description: list of clients
type: array
uniqueItems: true
minItems: 0
maxItems: 1000
items:
$ref: "#/components/schemas/connection"
"400":
$ref: "#/components/responses/400BadRequest"
"500":
$ref: "#/components/responses/500InternalServerError"
post:
operationId: upsertConnection
summary: creates a new connection or updates it based on the version
tags:
- connection
parameters:
- in: query
name: shouldIgnoreTokenErrors
schema:
type: boolean
default: false
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/connection"
responses:
"200":
description: updated
content:
application/json:
schema:
$ref: "#/components/schemas/connection"
"201":
description: created
content:
application/json:
schema:
$ref: "#/components/schemas/connection"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"409":
$ref: "#/components/responses/409Conflict"
"500":
$ref: "#/components/responses/500InternalServerError"
/key:
get:
operationId: getLastestKeys
summary: get all latest keys
tags:
- key
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/key"
"415":
$ref: "#/components/responses/415UnsupportedMediaType"
"500":
$ref: "#/components/responses/500InternalServerError"
post:
operationId: upsertKey
summary: creates a new key or updates it based on the version
tags:
- key
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/key"
responses:
"200":
description: updated
content:
application/json:
schema:
$ref: "#/components/schemas/key"
"201":
description: created
content:
application/json:
schema:
$ref: "#/components/schemas/key"
"400":
$ref: "#/components/responses/400BadRequest"
"409":
$ref: "#/components/responses/409Conflict"
"500":
$ref: "#/components/responses/500InternalServerError"
"/key/{environment}":
parameters:
- $ref: "#/components/parameters/environmentPathParam"
get:
operationId: getKeys
summary: get keys for specific environment
tags:
- key
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/key"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
"/key/{environment}/{version}":
parameters:
- $ref: "#/components/parameters/environmentPathParam"
- $ref: "#/components/parameters/versionParam"
get:
operationId: getSpecificKey
summary: gets a specific key
tags:
- key
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/key"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
"/key/{environment}/latest":
parameters:
- $ref: "#/components/parameters/environmentPathParam"
get:
operationId: getLatestKey
summary: gets the latest key for specific environment
tags:
- key
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/key"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
/asset:
get:
operationId: getAssets
summary: get assets by filters
tags:
- asset
parameters:
- $ref: "#/components/parameters/environmentQueryParam"
- in: query
name: type
schema:
$ref: "#/components/schemas/assetType"
- in: query
name: isTemplate
schema:
type: boolean
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/asset"
"400":
$ref: "#/components/responses/400BadRequest"
"500":
$ref: "#/components/responses/500InternalServerError"
post:
operationId: upsertAsset
summary: creates a new asset or updates it based on the version
tags:
- asset
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/asset"
responses:
"200":
description: updated
content:
application/json:
schema:
$ref: "#/components/schemas/asset"
"201":
description: created
content:
application/json:
schema:
$ref: "#/components/schemas/asset"
"400":
$ref: "#/components/responses/400BadRequest"
"409":
$ref: "#/components/responses/409Conflict"
"500":
$ref: "#/components/responses/500InternalServerError"
"/asset/{assetName}":
parameters:
- $ref: "#/components/parameters/assetParam"
get:
operationId: getAsset
summary: get asset by name
tags:
- asset
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/asset"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
"/asset/{assetName}/{version}":
parameters:
- $ref: "#/components/parameters/assetParam"
- $ref: "#/components/parameters/versionParam"
get:
operationId: getVersionedAsset
summary: get asset by name and version
tags:
- asset
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/asset"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
"/asset/{assetName}/latest":
parameters:
- $ref: "#/components/parameters/assetParam"
get:
operationId: getLatestAsset
summary: get latest asset by name
tags:
- asset
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/asset"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/404NotFound"
"500":
$ref: "#/components/responses/500InternalServerError"
/bundle:
get:
operationId: getBundles
summary: get bundles by filter
tags:
- bundle
parameters:
- in: query
name: createdBefore
description: filters all clients created before given date
schema:
type: string
format: date-time
- in: query
name: createdAfter
description: filters all clients created after given date
schema:
type: string
format: date-time
- $ref: "#/components/parameters/environmentQueryParam"
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/bundle"
"400":
$ref: "#/components/responses/400BadRequest"
"500":
$ref: "#/components/responses/500InternalServerError"
"/bundle/{id}":
parameters:
- in: path
name: id
required: true
schema:
type: number
format: int32
minimum: 1
get:
operationId: getBundle
summary: get a specific bundle
tags:
- bundle
parameters:
- $ref: "#/components/parameters/environmentQueryParam"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/bundle"
"400":
$ref: "#/components/responses/400BadRequest"
"404":
$ref: "#/components/responses/400BadRequest"
"500":
$ref: "#/components/responses/500InternalServerError"
/domain:
get:
parameters:
- in: query
name: sort
description: >-
Sorts the results based on the value of one or more properties.
The value is a comma-separated list of property names and sort order.
properties should be separated by a colon and sort order should be either asc or desc. For example: domain:asc
The default sort order is ascending. If the sort order is not specified, the default sort order is used. Each property is only allowed to appear once in the list.
The available properties are:
- domain
example:
- domain:asc
required: false
explode: false
schema:
default:
- domain:asc
type: array
uniqueItems: true
items:
example: domain:asc
type: string
pattern: ^(domain)(:asc|:desc){0,1}$
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/pageSize"
operationId: getDomains
summary: get all the domains
tags:
- domain
responses:
"200":
description: OK
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/paginationResponse"
- type: object
required:
- items
properties:
items:
description: list of clients
type: array
uniqueItems: true
minItems: 0
items:
$ref: "#/components/schemas/domain"
"415":
$ref: "#/components/responses/415UnsupportedMediaType"
"500":
$ref: "#/components/responses/500InternalServerError"
post:
operationId: createDomain
summary: create a new domain
tags:
- domain
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/domain"
responses:
"201":
description: created
content:
application/json:
schema:
$ref: "#/components/schemas/domain"
"400":
$ref: "#/components/responses/400BadRequest"
"409":
$ref: "#/components/responses/409Conflict"
"500":
$ref: "#/components/responses/500InternalServerError"
security: []
components:
responses:
400BadRequest:
description: BadRequest
content:
application/json:
schema:
$ref: "#/components/schemas/error"
404NotFound:
description: Not Found - If client does not exist
content:
application/json:
schema:
$ref: "#/components/schemas/error"
409Conflict:
description: conflict
content:
application/json:
schema:
$ref: "#/components/schemas/error"
415UnsupportedMediaType:
description: Unsupported Media Type
content:
application/json:
schema:
$ref: "#/components/schemas/error"
500InternalServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: "#/components/schemas/error"
parameters:
page:
name: page
in: query
description: >
page number for pagination. The value is 1-based, meaning the first page
is 1.
If the value is greater than the total number of pages, an empty array will be returned.
This simplifies the pagination logic on the client side.
schema:
type: integer
format: int32
default: 1
minimum: 1
pageSize:
name: page_size
in: query
description: number of items per page
schema:
type: integer
format: int32
default: 10
maximum: 100
minimum: 1
clientParam:
name: clientName
in: path
required: true
schema:
type: string
minLength: 3
assetParam:
name: assetName
in: path
required: true
schema:
type: string
minLength: 3
versionParam:
name: version
in: path
required: true
schema:
$ref: "#/components/schemas/version"
environmentQueryParam:
name: environment
in: query
schema:
type: array
uniqueItems: true
items:
$ref: "#/components/schemas/environment"
environmentPathParam:
name: environment
in: path
required: true
schema:
$ref: "#/components/schemas/environment"
schemas:
error:
type: object
required:
- message
properties:
message:
type: string
environment:
type: string
enum:
- np
- stage
- prod
version:
type: number
default: 1
format: int32
minimum: 1
assetType:
type: string
enum:
- TEST
- TEST_DATA
- POLICY
- DATA
name:
type: string
minLength: 2
maxLength: 32
domain:
type: object
required:
- name
properties:
name:
$ref: "#/components/schemas/name"
pointOfContact:
type: object
required: