-
Notifications
You must be signed in to change notification settings - Fork 5.6k
/
Entity.schema.json
70 lines (70 loc) · 1.76 KB
/
Entity.schema.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
{
"$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": {
"$ref": "EntityMeta"
},
"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": "common#relation"
}
},
"status": {
"$ref": "common#status"
}
}
}