forked from SchemaStore/schemastore
-
Notifications
You must be signed in to change notification settings - Fork 0
/
catalog-info.json
1126 lines (1126 loc) · 43.7 KB
/
catalog-info.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
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
{
"$id": "https://json.schemastore.org/catalog-info.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"anyOf": [
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "ApiV1alpha1",
"description": "An API describes an interface that can be exposed by a component. The API can be defined in different formats, like OpenAPI, AsyncAPI, GraphQL, gRPC, or other formats.",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
"kind": "API",
"metadata": {
"name": "artist-api",
"description": "Retrieve artist details",
"labels": {
"product_name": "Random value Generator"
},
"annotations": {
"docs": "https://github.com/..../tree/develop/doc"
}
},
"spec": {
"type": "openapi",
"lifecycle": "production",
"owner": "artist-relations-team",
"system": "artist-engagement-portal",
"definition": "openapi: \"3.0.0\"\ninfo:..."
}
}
],
"allOf": [
{
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/entity"
},
{
"type": "object",
"required": ["spec"],
"properties": {
"apiVersion": {
"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]
},
"kind": {
"enum": ["API"]
},
"spec": {
"type": "object",
"required": ["type", "lifecycle", "owner", "definition"],
"properties": {
"type": {
"type": "string",
"description": "The type of the API definition.",
"examples": ["openapi", "asyncapi", "graphql", "grpc"],
"minLength": 1
},
"lifecycle": {
"type": "string",
"description": "The lifecycle state of the API.",
"examples": ["experimental", "production", "deprecated"],
"minLength": 1
},
"owner": {
"type": "string",
"description": "An entity reference to the owner of the API.",
"examples": ["artist-relations-team", "user:john.johnson"],
"minLength": 1
},
"system": {
"type": "string",
"description": "An entity reference to the system that the API belongs to.",
"minLength": 1
},
"definition": {
"type": ["string", "object"],
"description": "The definition of the API, based on the format defined by the type.",
"minLength": 1,
"properties": {
"$text": {
"type": "string",
"description": "Interprets the contents of the referenced file as plain text and embeds it as a string.",
"minLength": 1
},
"$json": {
"type": "string",
"description": "Interprets the contents of the referenced file as JSON and embeds the parsed structure.",
"minLength": 1
},
"$yaml": {
"type": "string",
"description": "Interprets the contents of the referenced file as YAML and embeds the parsed structure.",
"minLength": 1
}
},
"minProperties": 1,
"maxProperties": 1
}
}
}
}
}
]
},
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "ComponentV1alpha1",
"description": "A Component describes a software component. It is typically intimately linked to the source code that constitutes the component, and should be what a developer may regard a \"unit of software\", usually with a distinct deployable or linkable artifact.",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
"kind": "Component",
"metadata": {
"name": "LoremService",
"description": "Creates Lorems like a pro.",
"labels": {
"product_name": "Random value Generator"
},
"annotations": {
"docs": "https://github.com/..../tree/develop/doc"
}
},
"spec": {
"type": "service",
"lifecycle": "production",
"owner": "tools"
}
}
],
"allOf": [
{
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/entity"
},
{
"type": "object",
"required": ["spec"],
"properties": {
"apiVersion": {
"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]
},
"kind": {
"enum": ["Component"]
},
"spec": {
"type": "object",
"required": ["type", "lifecycle", "owner"],
"properties": {
"type": {
"type": "string",
"description": "The type of component.",
"examples": ["service", "website", "library"],
"minLength": 1
},
"lifecycle": {
"type": "string",
"description": "The lifecycle state of the component.",
"examples": ["experimental", "production", "deprecated"],
"minLength": 1
},
"owner": {
"type": "string",
"description": "An entity reference to the owner of the component.",
"examples": ["artist-relations-team", "user:john.johnson"],
"minLength": 1
},
"system": {
"type": "string",
"description": "An entity reference to the system that the component belongs to.",
"minLength": 1
},
"subcomponentOf": {
"type": "string",
"description": "An entity reference to another component of which the component is a part.",
"minLength": 1
},
"providesApis": {
"type": "array",
"description": "An array of entity references to the APIs that are provided by the component.",
"items": {
"type": "string",
"minLength": 1
}
},
"consumesApis": {
"type": "array",
"description": "An array of entity references to the APIs that are consumed by the component.",
"items": {
"type": "string",
"minLength": 1
}
},
"dependsOn": {
"type": "array",
"description": "An array of references to other entities that the component depends on to function.",
"items": {
"type": "string",
"minLength": 1
}
}
}
}
}
}
]
},
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "DomainV1alpha1",
"description": "A Domain groups a collection of systems that share terminology, domain models, business purpose, or documentation, i.e. form a bounded context.",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
"kind": "Domain",
"metadata": {
"name": "artists",
"description": "Everything about artists"
},
"spec": {
"owner": "artist-relations-team"
}
}
],
"allOf": [
{
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/entity"
},
{
"type": "object",
"required": ["spec"],
"properties": {
"apiVersion": {
"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]
},
"kind": {
"enum": ["Domain"]
},
"spec": {
"type": "object",
"required": ["owner"],
"properties": {
"owner": {
"type": "string",
"description": "An entity reference to the owner of the component.",
"examples": ["artist-relations-team", "user:john.johnson"],
"minLength": 1
}
}
}
}
}
]
},
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "GroupV1alpha1",
"description": "A group describes an organizational entity, such as for example a team, a business unit, or a loose collection of people in an interest group. Members of these groups are modeled in the catalog as kind User.",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
"kind": "Group",
"metadata": {
"name": "infrastructure",
"description": "The infra business unit"
},
"spec": {
"type": "business-unit",
"profile": {
"displayName": "Infrastructure",
"email": "[email protected]",
"picture": "https://example.com/groups/bu-infrastructure.jpeg"
},
"parent": "ops",
"children": ["backstage", "other"]
}
}
],
"allOf": [
{
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/entity"
},
{
"type": "object",
"required": ["spec"],
"properties": {
"apiVersion": {
"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]
},
"kind": {
"enum": ["Group"]
},
"spec": {
"type": "object",
"required": ["type", "children"],
"properties": {
"type": {
"type": "string",
"description": "The type of group. There is currently no enforced set of values for this field, so it is left up to the adopting organization to choose a nomenclature that matches their org hierarchy.",
"examples": ["team", "business-unit", "product-area", "root"],
"minLength": 1
},
"profile": {
"type": "object",
"description": "Optional profile information about the group, mainly for display purposes. All fields of this structure are also optional. The email would be a group email of some form, that the group may wish to be used for contacting them. The picture is expected to be a URL pointing to an image that's representative of the group, and that a browser could fetch and render on a group page or similar.",
"properties": {
"displayName": {
"type": "string",
"description": "A simple display name to present to users.",
"examples": ["Infrastructure"],
"minLength": 1
},
"email": {
"type": "string",
"description": "An email where this entity can be reached.",
"examples": ["[email protected]"],
"minLength": 1
},
"picture": {
"type": "string",
"description": "The URL of an image that represents this entity.",
"examples": [
"https://example.com/groups/bu-infrastructure.jpeg"
],
"minLength": 1
}
}
},
"parent": {
"type": "string",
"description": "The immediate parent group in the hierarchy, if any. Not all groups must have a parent; the catalog supports multi-root hierarchies. Groups may however not have more than one parent. This field is an entity reference.",
"examples": ["ops"],
"minLength": 1
},
"children": {
"type": "array",
"description": "The immediate child groups of this group in the hierarchy (whose parent field points to this group). The list must be present, but may be empty if there are no child groups. The items are not guaranteed to be ordered in any particular way. The entries of this array are entity references.",
"items": {
"type": "string",
"examples": ["backstage", "other"],
"minLength": 1
}
},
"members": {
"type": "array",
"description": "The users that are members of this group. The entries of this array are entity references.",
"items": {
"type": "string",
"examples": ["jdoe"],
"minLength": 1
}
}
}
}
}
}
]
},
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "LocationV1alpha1",
"description": "A location is a marker that references other places to look for catalog data.",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
"kind": "Location",
"metadata": {
"name": "org-data"
},
"spec": {
"type": "url",
"targets": [
"http://github.com/myorg/myproject/org-data-dump/catalog-info-staff.yaml",
"http://github.com/myorg/myproject/org-data-dump/catalog-info-consultants.yaml"
]
}
}
],
"allOf": [
{
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/entity"
},
{
"type": "object",
"required": ["spec"],
"properties": {
"apiVersion": {
"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]
},
"kind": {
"enum": ["Location"]
},
"spec": {
"type": "object",
"required": [],
"properties": {
"type": {
"type": "string",
"description": "The single location type, that's common to the targets specified in the spec. If it is left out, it is inherited from the location type that originally read the entity data.",
"examples": ["url"],
"minLength": 1
},
"target": {
"type": "string",
"description": "A single target as a string. Can be either an absolute path/URL (depending on the type), or a relative path such as ./details/catalog-info.yaml which is resolved relative to the location of this Location entity itself.",
"examples": ["./details/catalog-info.yaml"],
"minLength": 1
},
"targets": {
"type": "array",
"description": "A list of targets as strings. They can all be either absolute paths/URLs (depending on the type), or relative paths such as ./details/catalog-info.yaml which are resolved relative to the location of this Location entity itself.",
"items": {
"type": "string",
"examples": [
"./details/catalog-info.yaml",
"http://github.com/myorg/myproject/org-data-dump/catalog-info-staff.yaml"
],
"minLength": 1
}
}
}
}
}
}
]
},
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "ResourceV1alpha1",
"description": "A resource describes the infrastructure a system needs to operate, like BigTable databases, Pub/Sub topics, S3 buckets or CDNs. Modelling them together with components and systems allows to visualize resource footprint, and create tooling around them.",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
"kind": "Resource",
"metadata": {
"name": "artists-db",
"description": "Stores artist details"
},
"spec": {
"type": "database",
"owner": "artist-relations-team",
"system": "artist-engagement-portal"
}
}
],
"allOf": [
{
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/entity"
},
{
"type": "object",
"required": ["spec"],
"properties": {
"apiVersion": {
"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]
},
"kind": {
"enum": ["Resource"]
},
"spec": {
"type": "object",
"required": ["type", "owner"],
"properties": {
"type": {
"type": "string",
"description": "The type of resource.",
"examples": ["database", "s3-bucket", "cluster"],
"minLength": 1
},
"owner": {
"type": "string",
"description": "An entity reference to the owner of the resource.",
"examples": ["artist-relations-team", "user:john.johnson"],
"minLength": 1
},
"dependsOn": {
"type": "array",
"description": "An array of references to other entities that the resource depends on to function.",
"items": {
"type": "string",
"minLength": 1
}
},
"system": {
"type": "string",
"description": "An entity reference to the system that the resource belongs to.",
"minLength": 1
}
}
}
}
}
]
},
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "SystemV1alpha1",
"description": "A system is a collection of resources and components. The system may expose or consume one or several APIs. It is viewed as abstraction level that provides potential consumers insights into exposed features without needing a too detailed view into the details of all components. This also gives the owning team the possibility to decide about published artifacts and APIs.",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
"kind": "System",
"metadata": {
"name": "artist-engagement-portal",
"description": "Handy tools to keep artists in the loop"
},
"spec": {
"owner": "artist-relations-team",
"domain": "artists"
}
}
],
"allOf": [
{
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/entity"
},
{
"type": "object",
"required": ["spec"],
"properties": {
"apiVersion": {
"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]
},
"kind": {
"enum": ["System"]
},
"spec": {
"type": "object",
"required": ["owner"],
"properties": {
"owner": {
"type": "string",
"description": "An entity reference to the owner of the component.",
"examples": ["artist-relations-team", "user:john.johnson"],
"minLength": 1
},
"domain": {
"type": "string",
"description": "An entity reference to the domain that the system belongs to.",
"examples": ["artists"],
"minLength": 1
}
}
}
}
}
]
},
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "TemplateV1beta2",
"description": "A Template describes a scaffolding task for use with the Scaffolder. It describes the required parameters as well as a series of steps that will be taken to execute the scaffolding task.",
"examples": [
{
"apiVersion": "backstage.io/v1beta2",
"kind": "Template",
"metadata": {
"name": "react-ssr-template",
"title": "React SSR Template",
"description": "Next.js application skeleton for creating isomorphic web applications.",
"tags": ["recommended", "react"]
},
"spec": {
"owner": "artist-relations-team",
"type": "website",
"parameters": {
"required": ["name", "description"],
"properties": {
"name": {
"title": "Name",
"type": "string",
"description": "Unique name of the component"
},
"description": {
"title": "Description",
"type": "string",
"description": "Description of the component"
}
}
},
"steps": [
{
"id": "fetch",
"name": "Fetch",
"action": "fetch:plain",
"parameters": {
"url": "./template"
}
},
{
"id": "publish",
"name": "Publish to GitHub",
"action": "publish:github",
"parameters": {
"repoUrl": "{{ parameters.repoUrl }}"
},
"if": "{{ parameters.repoUrl }}"
}
],
"output": {
"catalogInfoUrl": "{{ steps.publish.output.catalogInfoUrl }}"
}
}
}
],
"allOf": [
{
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/entity"
},
{
"type": "object",
"required": ["spec"],
"properties": {
"apiVersion": {
"enum": ["backstage.io/v1beta2"]
},
"kind": {
"enum": ["Template"]
},
"spec": {
"type": "object",
"required": ["type", "steps"],
"properties": {
"type": {
"type": "string",
"description": "The type of component created by the template. The software catalog accepts any type value, but an organization should take great care to establish a proper taxonomy for these. Tools including Backstage itself may read this field and behave differently depending on its value. For example, a website type component may present tooling in the Backstage interface that is specific to just websites.",
"examples": ["service", "website", "library"],
"minLength": 1
},
"parameters": {
"oneOf": [
{
"type": "object",
"description": "The JSONSchema describing the inputs for the template."
},
{
"type": "array",
"description": "A list of separate forms to collect parameters.",
"items": {
"type": "object",
"description": "The JSONSchema describing the inputs for the template."
}
}
]
},
"steps": {
"type": "array",
"description": "A list of steps to execute.",
"items": {
"type": "object",
"description": "A description of the step to execute.",
"required": ["action"],
"properties": {
"id": {
"type": "string",
"description": "The ID of the step, which can be used to refer to its outputs."
},
"name": {
"type": "string",
"description": "The name of the step, which will be displayed in the UI during the scaffolding process."
},
"action": {
"type": "string",
"description": "The name of the action to execute."
},
"input": {
"type": "object",
"description": "A templated object describing the inputs to the action."
},
"if": {
"type": ["string", "boolean"],
"description": "A templated condition that skips the step when evaluated to false. If the condition is true or not defined, the step is executed. The condition is true, if the input is not `false`, `undefined`, `null`, `\"\"`, `0`, or `[]`."
}
}
}
},
"output": {
"type": "object",
"description": "A templated object describing the outputs of the scaffolding task.",
"properties": {
"links": {
"type": "array",
"description": "A list of external hyperlinks, typically pointing to resources created or updated by the template",
"items": {
"type": "object",
"required": [],
"properties": {
"url": {
"type": "string",
"description": "A url in a standard uri format.",
"examples": [
"https://github.com/my-org/my-new-repo"
],
"minLength": 1
},
"entityRef": {
"type": "string",
"description": "An entity reference to an entity in the catalog.",
"examples": ["Component:default/my-app"],
"minLength": 1
},
"title": {
"type": "string",
"description": "A user friendly display name for the link.",
"examples": ["View new repo"],
"minLength": 1
},
"icon": {
"type": "string",
"description": "A key representing a visual icon to be displayed in the UI.",
"examples": ["dashboard"],
"minLength": 1
}
}
}
}
},
"additionalProperties": {
"type": "string"
}
},
"owner": {
"type": "string",
"description": "The user (or group) owner of the template",
"minLength": 1
}
}
}
}
}
]
},
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "UserV1alpha1",
"description": "A user describes a person, such as an employee, a contractor, or similar. Users belong to Group entities in the catalog. These catalog user entries are connected to the way that authentication within the Backstage ecosystem works. See the auth section of the docs for a discussion of these concepts.",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
"kind": "User",
"metadata": {
"name": "jdoe"
},
"spec": {
"profile": {
"displayName": "Jenny Doe",
"email": "[email protected]",
"picture": "https://example.com/staff/jenny-with-party-hat.jpeg"
},
"memberOf": ["team-b", "employees"]
}
}
],
"allOf": [
{
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/entity"
},
{
"type": "object",
"required": ["spec"],
"properties": {
"apiVersion": {
"enum": ["backstage.io/v1alpha1", "backstage.io/v1beta1"]
},
"kind": {
"enum": ["User"]
},
"spec": {
"type": "object",
"required": ["memberOf"],
"properties": {
"profile": {
"type": "object",
"description": "Optional profile information about the user, mainly for display purposes. All fields of this structure are also optional. The email would be a primary email of some form, that the user may wish to be used for contacting them. The picture is expected to be a URL pointing to an image that's representative of the user, and that a browser could fetch and render on a profile page or similar.",
"properties": {
"displayName": {
"type": "string",
"description": "A simple display name to present to users.",
"examples": ["Jenny Doe"],
"minLength": 1
},
"email": {
"type": "string",
"description": "An email where this user can be reached.",
"examples": ["[email protected]"],
"minLength": 1
},
"picture": {
"type": "string",
"description": "The URL of an image that represents this user.",
"examples": [
"https://example.com/staff/jenny-with-party-hat.jpeg"
],
"minLength": 1
}
}
},
"memberOf": {
"type": "array",
"description": "The list of groups that the user is a direct member of (i.e., no transitive memberships are listed here). The list must be present, but may be empty if the user is not member of any groups. The items are not guaranteed to be ordered in any particular way. The entries of this array are entity references.",
"items": {
"type": "string",
"examples": ["team-b", "employees"],
"minLength": 1
}
}
}
}
}
}
]
}
],
"definitions": {
"entity": {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "Entity",
"description": "The parts of the format that's common to all versions/kinds of entity.",
"examples": [
{
"apiVersion": "backstage.io/v1alpha1",
"kind": "Component",
"metadata": {
"name": "LoremService",
"description": "Creates Lorems like a pro.",
"labels": {
"product_name": "Random value Generator"
},
"annotations": {
"docs": "https://github.com/..../tree/develop/doc"
}
},
"spec": {
"type": "service",
"lifecycle": "production",
"owner": "tools"
}
}
],
"type": "object",
"required": ["apiVersion", "kind", "metadata"],
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string",
"description": "The version of specification format for this particular entity that this is written against.",
"minLength": 1,
"examples": ["backstage.io/v1alpha1", "my-company.net/v1", "1.0"]
},
"kind": {
"type": "string",
"description": "The high level entity type being described.",
"minLength": 1,
"examples": [
"API",
"Component",
"Domain",
"Group",
"Location",
"Resource",
"System",
"Template",
"User"
]
},
"metadata": {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "EntityMeta",
"description": "Metadata fields common to all versions/kinds of entity.",
"examples": [
{
"uid": "e01199ab-08cc-44c2-8e19-5c29ded82521",
"etag": "lsndfkjsndfkjnsdfkjnsd==",
"generation": 13,
"name": "my-component-yay",
"namespace": "the-namespace",
"labels": {
"backstage.io/custom": "ValueStuff"
},
"annotations": {
"example.com/bindings": "are-secret"
},
"tags": ["java", "data"]
}
],
"type": "object",
"required": ["name"],
"additionalProperties": true,
"properties": {
"uid": {
"type": "string",
"description": "A globally unique ID for the entity. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, but the server is free to reject requests that do so in such a way that it breaks semantics.",
"examples": ["e01199ab-08cc-44c2-8e19-5c29ded82521"],
"minLength": 1
},
"etag": {
"type": "string",
"description": "An opaque string that changes for each update operation to any part of the entity, including metadata. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, and the server will then reject the operation if it does not match the current stored value.",
"examples": ["lsndfkjsndfkjnsdfkjnsd=="],
"minLength": 1
},
"generation": {
"type": "integer",
"description": "A positive nonzero number that indicates the current generation of data for this entity; the value is incremented each time the spec changes. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations.",
"examples": [1],
"minimum": 1
},
"name": {
"type": "string",
"description": "The name of the entity. Must be unique within the catalog at any given point in time, for any given namespace + kind pair.",
"examples": ["metadata-proxy"],
"minLength": 1
},
"namespace": {
"type": "string",
"description": "The namespace that the entity belongs to.",
"default": "default",
"examples": ["default", "admin"],
"minLength": 1
},
"title": {
"type": "string",
"description": "A display name of the entity, to be presented in user interfaces instead of the name property, when available.",
"examples": ["React SSR Template"],
"minLength": 1
},
"description": {
"type": "string",
"description": "A short (typically relatively few words, on one line) description of the entity."
},
"labels": {
"type": "object",
"description": "Key/value pairs of identifying information attached to the entity.",
"additionalProperties": true,
"patternProperties": {
"^.+$": {
"type": "string"
}
}
},
"annotations": {
"type": "object",
"description": "Key/value pairs of non-identifying auxiliary information attached to the entity.",
"additionalProperties": true,
"patternProperties": {
"^.+$": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"description": "A list of single-valued strings, to for example classify catalog entities in various ways.",
"items": {
"type": "string",
"minLength": 1
}
},
"links": {
"type": "array",
"description": "A list of external hyperlinks related to the entity. Links can provide additional contextual information that may be located outside of Backstage itself. For example, an admin dashboard or external CMS page.",
"items": {
"type": "object",
"required": ["url"],
"properties": {
"url": {
"type": "string",
"description": "A url in a standard uri format.",
"examples": ["https://admin.example-org.com"],
"minLength": 1
},
"title": {
"type": "string",
"description": "A user friendly display name for the link.",
"examples": ["Admin Dashboard"],
"minLength": 1
},
"icon": {
"type": "string",
"description": "A key representing a visual icon to be displayed in the UI.",
"examples": ["dashboard"],
"minLength": 1
}
}
}
}
}
},
"spec": {
"type": "object",
"description": "The specification data describing the entity itself."
},
"relations": {
"type": "array",
"description": "The relations that this entity has with other entities.",
"items": {
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/common/definitions/relation"
}
},
"status": {
"$ref": "https://json.schemastore.org/catalog-info.json#/definitions/common/definitions/status"
}
}
},