-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathmicroservices-schema.json
212 lines (212 loc) · 8.79 KB
/
microservices-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
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
{
"definitions": {},
"type": "object",
"$id": "https://raw.githubusercontent.com/hmcts/cnp-api-docs/master/docs/microservices.json",
"required": [
"groups",
"apis"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"colour"
],
"properties": {
"name": {
"type": "string",
"title": "Group name",
"description": "Group name is shown in the legend",
"default": "",
"examples": [
"Payments"
]
},
"colour": {
"type": "string",
"title": "Group colour",
"description": "Colour used to paint and group APIs in the network graph",
"default": "",
"examples": [
"#8e44ad"
]
},
"info": {
"type": "string",
"title": "Introductory text for the group",
"description": "Add a link to confluence with some extra context about the group",
"default": "",
"examples": [
"Overview of the Probate components and how they interact with other CFT components. View our <a href=\"\">confluence</a> page for low level implementation details."
]
}
}
}
},
"apis": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"group"
],
"properties": {
"id": {
"type": "string",
"title": "API id",
"description": "ID is used to connect API network bubbles together",
"default": "",
"examples": [
"payments",
"draft-store"
]
},
"name": {
"type": "string",
"title": "API name",
"description": "The name of the API, usually a match of GitHub repo README title",
"default": "",
"examples": [
"Payments"
]
},
"description": {
"type": ["string", "null"],
"title": "API description",
"description": "Short description of the API",
"default": null,
"examples": [
"Payment methods provided to the customer"
]
},
"repository": {
"type": ["string", "null"],
"$id": "https://raw.githubusercontent.com/hmcts/cnp-api-docs/master/docs/microservices.json/items/properties/repository",
"title": "API repository",
"description": "Link to the API repository",
"default": null,
"examples": [
"https://github.com/hmcts/payments"
]
},
"spec": {
"type": ["string", "null"],
"title": "API specs",
"description": "Link to API specification json file",
"default": null,
"examples": [
"https://hmcts.github.io/cnp-api-docs/specs/payments.json"
]
},
"urls": {
"type": "array",
"items": {
"type": "object",
"required": [
"url",
"name"
],
"properties": {
"url": {
"type": "string",
"title": "Versioned API url",
"description": "Link to API specification json file",
"default": "",
"examples": [
"https://hmcts.github.io/cnp-api-docs/specs/ccd-data-store-api.v1_external.json"
]
},
"name": {
"type": "string",
"title": "API version",
"description": "Version of the API if we want to support multiple API versions",
"default": "",
"examples": [
"v1_external"
]
}
}
}
},
"group": {
"type": "string",
"title": "API group",
"description": "Group to which API belongs to",
"default": "",
"examples": [
"Draft Store"
]
},
"dependencies": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"hard"
],
"properties": {
"id": {
"type": "string",
"title": "API id",
"description": "The ID defined in the top level of list of APIs",
"default": "",
"examples": [
"idam-s2s"
]
},
"hard": {
"type": "boolean",
"title": "API dependency type",
"description": "Whether API survives (still works OK) if the dependency is turned off or gone for some reason",
"default": false,
"examples": [
true
]
},
"apis": {
"type": "array",
"items": {
"type": "string",
"title": "???",
"description": "???",
"default": "???",
"examples": [
"???"
]
}
}
}
}
},
"apis": {
"type": "array",
"items": {
"type": "string",
"title": "???",
"description": "???",
"default": "???",
"examples": [
"???"
]
}
},
"version": {
"type": ["string", "null"],
"title": "API version",
"description": "Version of the API",
"default": null,
"examples": [
"1.0.0"
]
}
}
}
}
}
}