@aifabrix/builder 2.6.3 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/bin/aifabrix.js +4 -0
  2. package/lib/cli.js +51 -2
  3. package/lib/commands/datasource.js +94 -0
  4. package/lib/datasource-deploy.js +182 -0
  5. package/lib/datasource-diff.js +73 -0
  6. package/lib/datasource-list.js +138 -0
  7. package/lib/datasource-validate.js +63 -0
  8. package/lib/diff.js +266 -0
  9. package/lib/schema/application-schema.json +829 -687
  10. package/lib/schema/external-datasource.schema.json +464 -0
  11. package/lib/schema/external-system.schema.json +262 -0
  12. package/lib/secrets.js +20 -1
  13. package/lib/utils/env-copy.js +24 -0
  14. package/lib/utils/env-endpoints.js +50 -11
  15. package/lib/utils/schema-loader.js +220 -0
  16. package/lib/utils/schema-resolver.js +174 -0
  17. package/lib/utils/secrets-helpers.js +65 -17
  18. package/lib/validate.js +299 -0
  19. package/package.json +1 -1
package/lib/schema/application-schema.json CHANGED
@@ -1,725 +1,867 @@
1
1
  {
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "title": "AI Fabrix Application Configuration Schema",
4
- "description": "Schema for AI Fabrix applications deployed via the API-Driven Deployment System",
5
- "metadata": {
6
- "key": "application-schema",
7
- "name": "Application Configuration Schema",
8
- "description": "JSON schema for validating AI Fabrix application configuration files",
9
- "version": "1.0.0",
10
- "type": "schema",
11
- "category": "infrastructure",
12
- "author": "AI Fabrix Team",
13
- "createdAt": "2024-01-01T00:00:00Z",
14
- "updatedAt": "2024-01-01T00:00:00Z",
15
- "compatibility": {
16
- "minVersion": "1.0.0",
17
- "maxVersion": "2.0.0",
18
- "deprecated": false
19
- },
20
- "tags": ["schema", "application", "validation", "configuration"],
21
- "dependencies": [],
22
- "changelog": [
23
- {
24
- "version": "1.0.0",
25
- "date": "2024-01-01T00:00:00Z",
26
- "changes": [
27
- "Initial application configuration schema",
28
- "Added application resource validation",
29
- "Added database configuration validation",
30
- "Added environment variable validation"
31
- ],
32
- "breaking": false
33
- }
34
- ]
2
+ "$schema":"http://json-schema.org/draft-07/schema#",
3
+ "$id":"https://aifabrix.ai/schemas/application-schema.json",
4
+ "title":"AI Fabrix Application Configuration Schema",
5
+ "description":"Schema for AI Fabrix applications deployed via the API-Driven Deployment System",
6
+ "metadata":{
7
+ "key":"application-schema",
8
+ "name":"Application Configuration Schema",
9
+ "description":"JSON schema for validating AI Fabrix application configuration files",
10
+ "version":"1.1.0",
11
+ "type":"schema",
12
+ "category":"infrastructure",
13
+ "author":"AI Fabrix Team",
14
+ "createdAt":"2024-01-01T00:00:00Z",
15
+ "updatedAt":"2025-11-26T00:00:00Z",
16
+ "compatibility":{
17
+ "minVersion":"1.0.0",
18
+ "maxVersion":"2.0.0",
19
+ "deprecated":false
20
+ },
21
+ "tags":[
22
+ "schema",
23
+ "application",
24
+ "validation",
25
+ "configuration",
26
+ "external-integration"
27
+ ],
28
+ "dependencies":[
29
+
30
+ ],
31
+ "changelog":[
32
+ {
33
+ "version":"1.1.0",
34
+ "date":"2025-11-26T00:00:00Z",
35
+ "changes":[
36
+ "Added externalIntegration block for ExternalSystem + ExternalDataSource pipeline deployments",
37
+ "Added schemaBasePath, systems, dataSources and autopublish fields"
38
+ ],
39
+ "breaking":false
40
+ }
41
+ ]
35
42
  },
36
- "type": "object",
37
- "required": ["key", "displayName", "description", "type", "image", "registryMode", "port", "deploymentKey"],
38
- "properties": {
39
- "key": {
40
- "type": "string",
41
- "description": "Unique application identifier (cannot be changed after registration)",
42
- "pattern": "^[a-z0-9-]+$",
43
- "minLength": 3,
44
- "maxLength": 40
45
- },
46
- "displayName": {
47
- "type": "string",
48
- "description": "Human-readable application name",
49
- "minLength": 1,
50
- "maxLength": 100
51
- },
52
- "description": {
53
- "type": "string",
54
- "description": "Application description",
55
- "minLength": 1,
56
- "maxLength": 500
57
- },
58
- "type": {
59
- "type": "string",
60
- "description": "Azure application type",
61
- "enum": ["webapp", "functionapp", "api", "service"]
62
- },
63
- "image": {
64
- "type": "string",
65
- "description": "Container image reference",
66
- "pattern": "^[a-zA-Z0-9._/-]+:[a-zA-Z0-9._-]+$"
67
- },
68
- "registryMode": {
69
- "type": "string",
70
- "description": "Registry mode for image authentication",
71
- "enum": ["acr", "external", "public"]
72
- },
73
- "port": {
74
- "type": "number",
75
- "description": "Application port number",
76
- "minimum": 1,
77
- "maximum": 65535
78
- },
79
- "deploymentKey": {
80
- "type": "string",
81
- "description": "SHA256 hash of deployment manifest (excluding deploymentKey field)",
82
- "pattern": "^[a-f0-9]{64}$"
83
- },
84
- "requiresDatabase": {
85
- "type": "boolean",
86
- "description": "Whether application requires database"
87
- },
88
- "databases": {
89
- "type": "array",
90
- "description": "Database configurations",
91
- "items": {
92
- "type": "object",
93
- "required": ["name"],
94
- "properties": {
95
- "name": {
96
- "type": "string",
97
- "description": "Database name",
98
- "pattern": "^[a-z0-9-_]+$"
99
- }
100
- },
101
- "additionalProperties": false
102
- }
103
- },
104
- "requiresRedis": {
105
- "type": "boolean",
106
- "description": "Whether application requires Redis"
107
- },
108
- "requiresStorage": {
109
- "type": "boolean",
110
- "description": "Whether application requires storage.Physical storage is mapped to /mnt/data/. Blob storage is mapped to SMB File share /data/{app-key}/."
111
- },
112
- "configuration": {
113
- "type": "array",
114
- "description": "Core application configuration",
115
- "items": {
116
- "type": "object",
117
- "required": ["name", "value", "location", "required"],
118
- "properties": {
119
- "name": {
120
- "type": "string",
121
- "description": "Configuration variable name",
122
- "pattern": "^[A-Z_][A-Z0-9_]*$"
123
- },
124
- "value": {
125
- "type": "string",
126
- "description": "Configuration value (literal or ready-made parameter reference)"
127
- },
128
- "location": {
129
- "type": "string",
130
- "description": "Where the value is stored",
131
- "enum": ["variable", "keyvault"]
132
- },
133
- "required": {
134
- "type": "boolean",
135
- "description": "Whether this configuration is required"
136
- },
137
- "portalInput": {
138
- "type": "object",
139
- "description": "Portal input configuration for user-provided values",
140
- "properties": {
141
- "field": {
142
- "type": "string",
143
- "enum": ["password", "text", "textarea", "select"]
144
- },
145
- "label": {
146
- "type": "string",
147
- "description": "Display label for the input field"
43
+ "type":"object",
44
+ "required":[
45
+ "key",
46
+ "displayName",
47
+ "description",
48
+ "type",
49
+ "image",
50
+ "registryMode",
51
+ "port",
52
+ "deploymentKey"
53
+ ],
54
+ "properties":{
55
+ "key":{
56
+ "type":"string",
57
+ "description":"Unique application identifier (cannot be changed after registration)",
58
+ "pattern":"^[a-z0-9-]+$",
59
+ "minLength":3,
60
+ "maxLength":40
61
+ },
62
+ "displayName":{
63
+ "type":"string",
64
+ "description":"Human-readable application name",
65
+ "minLength":1,
66
+ "maxLength":100
67
+ },
68
+ "description":{
69
+ "type":"string",
70
+ "description":"Application description",
71
+ "minLength":1,
72
+ "maxLength":500
73
+ },
74
+ "type":{
75
+ "type":"string",
76
+ "description":"Azure application type",
77
+ "enum":[
78
+ "webapp",
79
+ "functionapp",
80
+ "api",
81
+ "service"
82
+ ]
83
+ },
84
+ "image":{
85
+ "type":"string",
86
+ "description":"Container image reference",
87
+ "pattern":"^[a-zA-Z0-9._/-]+:[a-zA-Z0-9._-]+$"
88
+ },
89
+ "registryMode":{
90
+ "type":"string",
91
+ "description":"Registry mode for image authentication",
92
+ "enum":[
93
+ "acr",
94
+ "external",
95
+ "public"
96
+ ]
97
+ },
98
+ "port":{
99
+ "type":"number",
100
+ "description":"Application port number",
101
+ "minimum":1,
102
+ "maximum":65535
103
+ },
104
+ "deploymentKey":{
105
+ "type":"string",
106
+ "description":"SHA256 hash of deployment manifest (excluding deploymentKey field)",
107
+ "pattern":"^[a-f0-9]{64}$"
108
+ },
109
+ "requiresDatabase":{
110
+ "type":"boolean",
111
+ "description":"Whether application requires database"
112
+ },
113
+ "databases":{
114
+ "type":"array",
115
+ "description":"Database configurations",
116
+ "items":{
117
+ "type":"object",
118
+ "required":[
119
+ "name"
120
+ ],
121
+ "properties":{
122
+ "name":{
123
+ "type":"string",
124
+ "description":"Database name",
125
+ "pattern":"^[a-z0-9-_]+$"
126
+ }
127
+ },
128
+ "additionalProperties":false
129
+ }
130
+ },
131
+ "requiresRedis":{
132
+ "type":"boolean",
133
+ "description":"Whether application requires Redis"
134
+ },
135
+ "requiresStorage":{
136
+ "type":"boolean",
137
+ "description":"Whether application requires storage.Physical storage is mapped to /mnt/data/. Blob storage is mapped to SMB File share /data/{app-key}/."
138
+ },
139
+ "configuration":{
140
+ "type":"array",
141
+ "description":"Core application configuration",
142
+ "items":{
143
+ "type":"object",
144
+ "required":[
145
+ "name",
146
+ "value",
147
+ "location",
148
+ "required"
149
+ ],
150
+ "properties":{
151
+ "name":{
152
+ "type":"string",
153
+ "description":"Configuration variable name",
154
+ "pattern":"^[A-Z_][A-Z0-9_]*$"
148
155
  },
149
- "placeholder": {
150
- "type": "string",
151
- "description": "Placeholder text for the input field"
156
+ "value":{
157
+ "type":"string",
158
+ "description":"Configuration value (literal or ready-made parameter reference)"
152
159
  },
153
- "masked": {
154
- "type": "boolean",
155
- "description": "Whether to mask the input (for passwords)"
160
+ "location":{
161
+ "type":"string",
162
+ "description":"Where the value is stored",
163
+ "enum":[
164
+ "variable",
165
+ "keyvault"
166
+ ]
156
167
  },
157
- "validation": {
158
- "type": "object",
159
- "properties": {
160
- "minLength": {
161
- "type": "integer",
162
- "minimum": 1
163
- },
164
- "maxLength": {
165
- "type": "integer",
166
- "minimum": 1
167
- },
168
- "pattern": {
169
- "type": "string",
170
- "description": "Regex pattern for validation"
171
- },
172
- "required": {
173
- "type": "boolean"
174
- }
175
- },
176
- "additionalProperties": false
168
+ "required":{
169
+ "type":"boolean",
170
+ "description":"Whether this configuration is required"
177
171
  },
178
- "options": {
179
- "type": "array",
180
- "description": "Options for select fields",
181
- "items": {
182
- "type": "string"
183
- }
184
- }
185
- },
186
- "required": ["field", "label"],
187
- "additionalProperties": false
188
- }
189
- },
190
- "additionalProperties": false
191
- }
192
- },
193
- "conditionalConfiguration": {
194
- "type": "array",
195
- "description": "Conditional configuration based on service requirements",
196
- "items": {
197
- "type": "object",
198
- "required": ["condition", "configuration"],
199
- "properties": {
200
- "condition": {
201
- "type": "string",
202
- "description": "Condition for including this configuration",
203
- "pattern": "^\\{\\{.*\\}\\}$"
204
- },
205
- "configuration": {
206
- "type": "array",
207
- "description": "Configuration items to include when condition is true",
208
- "items": {
209
- "type": "object",
210
- "required": ["name", "value", "location", "required"],
211
- "properties": {
212
- "name": {
213
- "type": "string",
214
- "description": "Configuration variable name",
215
- "pattern": "^[A-Z_][A-Z0-9_]*$"
216
- },
217
- "value": {
218
- "type": "string",
219
- "description": "Configuration value (literal or ready-made parameter reference)"
220
- },
221
- "location": {
222
- "type": "string",
223
- "description": "Where the value is stored",
224
- "enum": ["variable", "keyvault"]
225
- },
226
- "required": {
227
- "type": "boolean",
228
- "description": "Whether this configuration is required"
229
- },
230
- "portalInput": {
231
- "type": "object",
232
- "description": "Portal input configuration for user-provided values",
233
- "properties": {
234
- "field": {
235
- "type": "string",
236
- "enum": ["password", "text", "textarea", "select"]
172
+ "portalInput":{
173
+ "type":"object",
174
+ "description":"Portal input configuration for user-provided values",
175
+ "properties":{
176
+ "field":{
177
+ "type":"string",
178
+ "enum":[
179
+ "password",
180
+ "text",
181
+ "textarea",
182
+ "select"
183
+ ]
237
184
  },
238
- "label": {
239
- "type": "string",
240
- "description": "Display label for the input field"
185
+ "label":{
186
+ "type":"string",
187
+ "description":"Display label for the input field"
241
188
  },
242
- "placeholder": {
243
- "type": "string",
244
- "description": "Placeholder text for the input field"
189
+ "placeholder":{
190
+ "type":"string",
191
+ "description":"Placeholder text for the input field"
245
192
  },
246
- "masked": {
247
- "type": "boolean",
248
- "description": "Whether to mask the input (for passwords)"
193
+ "masked":{
194
+ "type":"boolean",
195
+ "description":"Whether to mask the input (for passwords)"
249
196
  },
250
- "validation": {
251
- "type": "object",
252
- "properties": {
253
- "minLength": {
254
- "type": "integer",
255
- "minimum": 1
256
- },
257
- "maxLength": {
258
- "type": "integer",
259
- "minimum": 1
260
- },
261
- "pattern": {
262
- "type": "string",
263
- "description": "Regex pattern for validation"
264
- },
265
- "required": {
266
- "type": "boolean"
267
- }
268
- },
269
- "additionalProperties": false
197
+ "validation":{
198
+ "type":"object",
199
+ "properties":{
200
+ "minLength":{
201
+ "type":"integer",
202
+ "minimum":1
203
+ },
204
+ "maxLength":{
205
+ "type":"integer",
206
+ "minimum":1
207
+ },
208
+ "pattern":{
209
+ "type":"string",
210
+ "description":"Regex pattern for validation"
211
+ },
212
+ "required":{
213
+ "type":"boolean"
214
+ }
215
+ },
216
+ "additionalProperties":false
270
217
  },
271
- "options": {
272
- "type": "array",
273
- "description": "Options for select fields",
274
- "items": {
275
- "type": "string"
276
- }
218
+ "options":{
219
+ "type":"array",
220
+ "description":"Options for select fields",
221
+ "items":{
222
+ "type":"string"
223
+ }
277
224
  }
278
- },
279
- "required": ["field", "label"],
280
- "additionalProperties": false
281
- }
282
- },
283
- "additionalProperties": false
284
- }
285
- }
286
- },
287
- "additionalProperties": false
288
- }
289
- },
290
- "healthCheck": {
291
- "type": "object",
292
- "description": "Health check configuration. The health check endpoint must return HTTP 200 and a JSON response with one of the following formats: {\"status\": \"UP\"} (Keycloak format), {\"status\": \"ok\"} (standard format, optionally with {\"database\": \"connected\"}), {\"status\": \"healthy\"} (alternative format), or {\"success\": true} (success-based format). For non-JSON responses, HTTP 200 status code is sufficient.",
293
- "required": ["path", "interval"],
294
- "properties": {
295
- "path": {
296
- "type": "string",
297
- "description": "Health check endpoint path",
298
- "pattern": "^/"
299
- },
300
- "interval": {
301
- "type": "integer",
302
- "description": "Health check interval in seconds",
303
- "minimum": 10,
304
- "maximum": 300
305
- },
306
- "probePath": {
307
- "type": "string",
308
- "description": "Front Door health probe path (defaults to path if not specified)",
309
- "pattern": "^/"
310
- },
311
- "probeRequestType": {
312
- "type": "string",
313
- "description": "HTTP method for Front Door probe",
314
- "enum": ["GET", "POST", "HEAD", "PUT", "DELETE"]
315
- },
316
- "probeProtocol": {
317
- "type": "string",
318
- "description": "Protocol for Front Door probe",
319
- "enum": ["Http", "Https"]
320
- },
321
- "probeIntervalInSeconds": {
322
- "type": "integer",
323
- "description": "Front Door probe interval in seconds (default 120)",
324
- "minimum": 60,
325
- "maximum": 600
225
+ },
226
+ "required":[
227
+ "field",
228
+ "label"
229
+ ],
230
+ "additionalProperties":false
231
+ }
232
+ },
233
+ "additionalProperties":false
326
234
  }
327
- },
328
- "additionalProperties": false,
329
- "examples": [
330
- {
331
- "path": "/health",
332
- "interval": 30
333
- },
334
- {
335
- "path": "/api/health",
336
- "interval": 60,
337
- "probePath": "/api/health",
338
- "probeRequestType": "GET",
339
- "probeProtocol": "Http",
340
- "probeIntervalInSeconds": 120
235
+ },
236
+ "conditionalConfiguration":{
237
+ "type":"array",
238
+ "description":"Conditional configuration based on service requirements",
239
+ "items":{
240
+ "type":"object",
241
+ "required":[
242
+ "condition",
243
+ "configuration"
244
+ ],
245
+ "properties":{
246
+ "condition":{
247
+ "type":"string",
248
+ "description":"Condition for including this configuration",
249
+ "pattern":"^\\{\\{.*\\}\\}$"
250
+ },
251
+ "configuration":{
252
+ "type":"array",
253
+ "description":"Configuration items to include when condition is true",
254
+ "items":{
255
+ "type":"object",
256
+ "required":[
257
+ "name",
258
+ "value",
259
+ "location",
260
+ "required"
261
+ ],
262
+ "properties":{
263
+ "name":{
264
+ "type":"string",
265
+ "description":"Configuration variable name",
266
+ "pattern":"^[A-Z_][A-Z0-9_]*$"
267
+ },
268
+ "value":{
269
+ "type":"string",
270
+ "description":"Configuration value (literal or ready-made parameter reference)"
271
+ },
272
+ "location":{
273
+ "type":"string",
274
+ "description":"Where the value is stored",
275
+ "enum":[
276
+ "variable",
277
+ "keyvault"
278
+ ]
279
+ },
280
+ "required":{
281
+ "type":"boolean",
282
+ "description":"Whether this configuration is required"
283
+ },
284
+ "portalInput":{
285
+ "type":"object",
286
+ "description":"Portal input configuration for user-provided values",
287
+ "properties":{
288
+ "field":{
289
+ "type":"string",
290
+ "enum":[
291
+ "password",
292
+ "text",
293
+ "textarea",
294
+ "select"
295
+ ]
296
+ },
297
+ "label":{
298
+ "type":"string",
299
+ "description":"Display label for the input field"
300
+ },
301
+ "placeholder":{
302
+ "type":"string",
303
+ "description":"Placeholder text for the input field"
304
+ },
305
+ "masked":{
306
+ "type":"boolean",
307
+ "description":"Whether to mask the input (for passwords)"
308
+ },
309
+ "validation":{
310
+ "type":"object",
311
+ "properties":{
312
+ "minLength":{
313
+ "type":"integer",
314
+ "minimum":1
315
+ },
316
+ "maxLength":{
317
+ "type":"integer",
318
+ "minimum":1
319
+ },
320
+ "pattern":{
321
+ "type":"string",
322
+ "description":"Regex pattern for validation"
323
+ },
324
+ "required":{
325
+ "type":"boolean"
326
+ }
327
+ },
328
+ "additionalProperties":false
329
+ },
330
+ "options":{
331
+ "type":"array",
332
+ "description":"Options for select fields",
333
+ "items":{
334
+ "type":"string"
335
+ }
336
+ }
337
+ },
338
+ "required":[
339
+ "field",
340
+ "label"
341
+ ],
342
+ "additionalProperties":false
343
+ }
344
+ },
345
+ "additionalProperties":false
346
+ }
347
+ }
348
+ },
349
+ "additionalProperties":false
341
350
  }
342
- ],
343
- "responseFormats": {
344
- "description": "Valid health check response formats",
345
- "formats": [
346
- {
347
- "format": "Keycloak",
348
- "example": "{\"status\": \"UP\", \"checks\": []}",
349
- "validation": "status === 'UP'"
350
- },
351
- {
352
- "format": "Standard",
353
- "example": "{\"status\": \"ok\", \"database\": \"connected\"}",
354
- "validation": "status === 'ok' && (database === 'connected' || !database)"
355
- },
356
- {
357
- "format": "Alternative",
358
- "example": "{\"status\": \"healthy\", \"service\": \"dataplane\"}",
359
- "validation": "status === 'healthy'"
360
- },
361
- {
362
- "format": "Success-based",
363
- "example": "{\"success\": true, \"message\": \"Service is running\"}",
364
- "validation": "success === true"
365
- },
366
- {
367
- "format": "Non-JSON",
368
- "example": "OK",
369
- "validation": "HTTP status code === 200"
370
- }
371
- ]
372
- }
373
- },
374
- "frontDoorRouting": {
375
- "type": "object",
376
- "description": "Front Door routing configuration",
377
- "properties": {
378
- "pattern": {
379
- "type": "string",
380
- "description": "URL pattern for routing (e.g., '/app/*')",
381
- "pattern": "^/.+"
382
- },
383
- "requiresRuleSet": {
384
- "type": "boolean",
385
- "description": "Whether URL rewriting rule set is required"
351
+ },
352
+ "healthCheck":{
353
+ "type":"object",
354
+ "description":"Health check configuration. The health check endpoint must return HTTP 200 and a JSON response with one of the following formats: {\"status\": \"UP\"} (Keycloak format), {\"status\": \"ok\"} (standard format, optionally with {\"database\": \"connected\"}), {\"status\": \"healthy\"} (alternative format), or {\"success\": true} (success-based format). For non-JSON responses, HTTP 200 status code is sufficient.",
355
+ "required":[
356
+ "path",
357
+ "interval"
358
+ ],
359
+ "properties":{
360
+ "path":{
361
+ "type":"string",
362
+ "description":"Health check endpoint path",
363
+ "pattern":"^/"
364
+ },
365
+ "interval":{
366
+ "type":"integer",
367
+ "description":"Health check interval in seconds",
368
+ "minimum":10,
369
+ "maximum":300
370
+ },
371
+ "probePath":{
372
+ "type":"string",
373
+ "description":"Front Door health probe path (defaults to path if not specified)",
374
+ "pattern":"^/"
375
+ },
376
+ "probeRequestType":{
377
+ "type":"string",
378
+ "description":"HTTP method for Front Door probe",
379
+ "enum":[
380
+ "GET",
381
+ "POST",
382
+ "HEAD",
383
+ "PUT",
384
+ "DELETE"
385
+ ]
386
+ },
387
+ "probeProtocol":{
388
+ "type":"string",
389
+ "description":"Protocol for Front Door probe",
390
+ "enum":[
391
+ "Http",
392
+ "Https"
393
+ ]
394
+ },
395
+ "probeIntervalInSeconds":{
396
+ "type":"integer",
397
+ "description":"Front Door probe interval in seconds (default 120)",
398
+ "minimum":60,
399
+ "maximum":600
400
+ }
386
401
  },
387
- "ruleSetConditions": {
388
- "type": "array",
389
- "description": "Rule set conditions for URL rewriting",
390
- "items": {
391
- "type": "object",
392
- "properties": {
393
- "type": {
394
- "type": "string",
395
- "description": "Condition type (e.g., 'UrlPath')"
402
+ "additionalProperties":false,
403
+ "examples":[
404
+ {
405
+ "path":"/health",
406
+ "interval":30
407
+ },
408
+ {
409
+ "path":"/api/health",
410
+ "interval":60,
411
+ "probePath":"/api/health",
412
+ "probeRequestType":"GET",
413
+ "probeProtocol":"Http",
414
+ "probeIntervalInSeconds":120
415
+ }
416
+ ],
417
+ "responseFormats":{
418
+ "description":"Valid health check response formats",
419
+ "formats":[
420
+ {
421
+ "format":"Keycloak",
422
+ "example":"{\"status\": \"UP\", \"checks\": []}",
423
+ "validation":"status === 'UP'"
396
424
  },
397
- "operator": {
398
- "type": "string",
399
- "description": "Condition operator (e.g., 'BeginsWith')"
425
+ {
426
+ "format":"Standard",
427
+ "example":"{\"status\": \"ok\", \"database\": \"connected\"}",
428
+ "validation":"status === 'ok' && (database === 'connected' || !database)"
400
429
  },
401
- "matchValues": {
402
- "type": "array",
403
- "items": {
404
- "type": "string"
405
- }
406
- }
407
- }
408
- }
409
- },
410
- "ruleSetActions": {
411
- "type": "array",
412
- "description": "Rule set actions for URL rewriting",
413
- "items": {
414
- "type": "object",
415
- "properties": {
416
- "type": {
417
- "type": "string",
418
- "description": "Action type (e.g., 'UrlRewrite')"
430
+ {
431
+ "format":"Alternative",
432
+ "example":"{\"status\": \"healthy\", \"service\": \"dataplane\"}",
433
+ "validation":"status === 'healthy'"
419
434
  },
420
- "sourcePattern": {
421
- "type": "string",
422
- "description": "Source URL pattern for rewriting"
435
+ {
436
+ "format":"Success-based",
437
+ "example":"{\"success\": true, \"message\": \"Service is running\"}",
438
+ "validation":"success === true"
423
439
  },
424
- "destination": {
425
- "type": "string",
426
- "description": "Destination URL pattern"
440
+ {
441
+ "format":"Non-JSON",
442
+ "example":"OK",
443
+ "validation":"HTTP status code === 200"
427
444
  }
428
- }
429
- }
445
+ ]
430
446
  }
431
- },
432
- "additionalProperties": false
433
- },
434
- "authentication": {
435
- "type": "object",
436
- "description": "Authentication configuration. When enableSSO is false, only enableSSO is required. When enableSSO is true, type and requiredRoles are also required.",
437
- "required": ["enableSSO"],
438
- "properties": {
439
- "type": {
440
- "type": "string",
441
- "description": "Authentication type",
442
- "enum": ["azure", "local", "none"]
443
- },
444
- "enableSSO": {
445
- "type": "boolean",
446
- "description": "Whether to enable SSO"
447
+ },
448
+ "frontDoorRouting":{
449
+ "type":"object",
450
+ "description":"Front Door routing configuration",
451
+ "properties":{
452
+ "pattern":{
453
+ "type":"string",
454
+ "description":"URL pattern for routing (e.g., '/app/*')",
455
+ "pattern":"^/.+"
456
+ },
457
+ "requiresRuleSet":{
458
+ "type":"boolean",
459
+ "description":"Whether URL rewriting rule set is required"
460
+ },
461
+ "ruleSetConditions":{
462
+ "type":"array",
463
+ "description":"Rule set conditions for URL rewriting",
464
+ "items":{
465
+ "type":"object",
466
+ "properties":{
467
+ "type":{
468
+ "type":"string",
469
+ "description":"Condition type (e.g., 'UrlPath')"
470
+ },
471
+ "operator":{
472
+ "type":"string",
473
+ "description":"Condition operator (e.g., 'BeginsWith')"
474
+ },
475
+ "matchValues":{
476
+ "type":"array",
477
+ "items":{
478
+ "type":"string"
479
+ }
480
+ }
481
+ }
482
+ }
483
+ },
484
+ "ruleSetActions":{
485
+ "type":"array",
486
+ "description":"Rule set actions for URL rewriting",
487
+ "items":{
488
+ "type":"object",
489
+ "properties":{
490
+ "type":{
491
+ "type":"string",
492
+ "description":"Action type (e.g., 'UrlRewrite')"
493
+ },
494
+ "sourcePattern":{
495
+ "type":"string",
496
+ "description":"Source URL pattern for rewriting"
497
+ },
498
+ "destination":{
499
+ "type":"string",
500
+ "description":"Destination URL pattern"
501
+ }
502
+ }
503
+ }
504
+ }
447
505
  },
448
- "requiredRoles": {
449
- "type": "array",
450
- "description": "Required roles for access",
451
- "items": {
452
- "type": "string",
453
- "pattern": "^[a-z-]+$"
454
- }
506
+ "additionalProperties":false
507
+ },
508
+ "authentication":{
509
+ "type":"object",
510
+ "description":"Authentication configuration. When enableSSO is false, only enableSSO is required. When enableSSO is true, type and requiredRoles are also required.",
511
+ "required":[
512
+ "enableSSO"
513
+ ],
514
+ "properties":{
515
+ "type":{
516
+ "type":"string",
517
+ "description":"Authentication type",
518
+ "enum":[
519
+ "azure",
520
+ "local",
521
+ "none"
522
+ ]
523
+ },
524
+ "enableSSO":{
525
+ "type":"boolean",
526
+ "description":"Whether to enable SSO"
527
+ },
528
+ "requiredRoles":{
529
+ "type":"array",
530
+ "description":"Required roles for access",
531
+ "items":{
532
+ "type":"string",
533
+ "pattern":"^[a-z-]+$"
534
+ }
535
+ },
536
+ "endpoints":{
537
+ "type":"object",
538
+ "description":"Authentication endpoints",
539
+ "properties":{
540
+ "local":{
541
+ "type":"string",
542
+ "description":"Local authentication endpoint",
543
+ "pattern":"^(http|https)://.*$"
544
+ },
545
+ "custom":{
546
+ "type":"string",
547
+ "description":"Custom authentication endpoint",
548
+ "pattern":"^(http|https)://.*$"
549
+ }
550
+ },
551
+ "additionalProperties":false
552
+ }
455
553
  },
456
- "endpoints": {
457
- "type": "object",
458
- "description": "Authentication endpoints",
459
- "properties": {
460
- "local": {
461
- "type": "string",
462
- "description": "Local authentication endpoint",
463
- "pattern": "^(http|https)://.*$"
464
- },
465
- "custom": {
466
- "type": "string",
467
- "description": "Custom authentication endpoint",
468
- "pattern": "^(http|https)://.*$"
469
- }
470
- },
471
- "additionalProperties": false
554
+ "additionalProperties":false,
555
+ "allOf":[
556
+ {
557
+ "if":{
558
+ "properties":{
559
+ "enableSSO":{
560
+ "const":true
561
+ }
562
+ }
563
+ },
564
+ "then":{
565
+ "required":[
566
+ "type",
567
+ "enableSSO",
568
+ "requiredRoles"
569
+ ]
570
+ }
571
+ }
572
+ ]
573
+ },
574
+ "roles":{
575
+ "type":"array",
576
+ "description":"Application roles for Azure AD group mapping",
577
+ "items":{
578
+ "type":"object",
579
+ "required":[
580
+ "name",
581
+ "value",
582
+ "description"
583
+ ],
584
+ "properties":{
585
+ "name":{
586
+ "type":"string",
587
+ "description":"Human-readable role name",
588
+ "minLength":1,
589
+ "maxLength":100
590
+ },
591
+ "value":{
592
+ "type":"string",
593
+ "description":"Role identifier (used in JWT and ACL)",
594
+ "pattern":"^[a-z-]+$"
595
+ },
596
+ "description":{
597
+ "type":"string",
598
+ "description":"Role description",
599
+ "minLength":1,
600
+ "maxLength":500
601
+ },
602
+ "Groups":{
603
+ "type":"array",
604
+ "description":"Azure AD groups mapped to this role",
605
+ "items":{
606
+ "type":"string",
607
+ "minLength":1,
608
+ "maxLength":100
609
+ }
610
+ }
611
+ },
612
+ "additionalProperties":false
472
613
  }
473
- },
474
- "additionalProperties": false,
475
- "allOf": [
476
- {
477
- "if": {
478
- "properties": {
479
- "enableSSO": {
480
- "const": true
614
+ },
615
+ "permissions":{
616
+ "type":"array",
617
+ "description":"Application permissions with role mappings for access control",
618
+ "items":{
619
+ "type":"object",
620
+ "required":[
621
+ "name",
622
+ "roles",
623
+ "description"
624
+ ],
625
+ "properties":{
626
+ "name":{
627
+ "type":"string",
628
+ "description":"Permission identifier (e.g., 'documentstore:read', 'flowise:dev:access')",
629
+ "pattern":"^[a-z0-9-:]+$",
630
+ "minLength":1,
631
+ "maxLength":100
632
+ },
633
+ "roles":{
634
+ "type":"array",
635
+ "description":"Roles that have this permission",
636
+ "items":{
637
+ "type":"string",
638
+ "pattern":"^[a-z-]+$",
639
+ "minLength":1,
640
+ "maxLength":50
641
+ },
642
+ "minItems":1
643
+ },
644
+ "description":{
645
+ "type":"string",
646
+ "description":"Permission description",
647
+ "minLength":1,
648
+ "maxLength":500
481
649
  }
482
- }
483
- },
484
- "then": {
485
- "required": ["type", "enableSSO", "requiredRoles"]
486
- }
650
+ },
651
+ "additionalProperties":false
487
652
  }
488
- ]
489
- },
490
- "roles": {
491
- "type": "array",
492
- "description": "Application roles for Azure AD group mapping",
493
- "items": {
494
- "type": "object",
495
- "required": ["name", "value", "description"],
496
- "properties": {
497
- "name": {
498
- "type": "string",
499
- "description": "Human-readable role name",
500
- "minLength": 1,
501
- "maxLength": 100
502
- },
503
- "value": {
504
- "type": "string",
505
- "description": "Role identifier (used in JWT and ACL)",
506
- "pattern": "^[a-z-]+$"
507
- },
508
- "description": {
509
- "type": "string",
510
- "description": "Role description",
511
- "minLength": 1,
512
- "maxLength": 500
513
- },
514
- "Groups": {
515
- "type": "array",
516
- "description": "Azure AD groups mapped to this role",
517
- "items": {
518
- "type": "string",
519
- "minLength": 1,
520
- "maxLength": 100
521
- }
522
- }
653
+ },
654
+ "repository":{
655
+ "type":"object",
656
+ "description":"Repository deployment configuration",
657
+ "properties":{
658
+ "enabled":{
659
+ "type":"boolean",
660
+ "description":"Whether repository deployment is enabled"
661
+ },
662
+ "repositoryUrl":{
663
+ "type":"string",
664
+ "description":"Full repository URL for pipeline validation (same as OAuth callback)",
665
+ "pattern":"^(https://github.com/[^/]+/[^/]+|https://gitlab.com/[^/]+/[^/]+|https://dev.azure.com/[^/]+/[^/]+/[^/]+)$"
666
+ }
523
667
  },
524
- "additionalProperties": false
525
- }
526
- },
527
- "permissions": {
528
- "type": "array",
529
- "description": "Application permissions with role mappings for access control",
530
- "items": {
531
- "type": "object",
532
- "required": ["name", "roles", "description"],
533
- "properties": {
534
- "name": {
535
- "type": "string",
536
- "description": "Permission identifier (e.g., 'documentstore:read', 'flowise:dev:access')",
537
- "pattern": "^[a-z0-9-:]+$",
538
- "minLength": 1,
539
- "maxLength": 100
540
- },
541
- "roles": {
542
- "type": "array",
543
- "description": "Roles that have this permission",
544
- "items": {
545
- "type": "string",
546
- "pattern": "^[a-z-]+$",
547
- "minLength": 1,
548
- "maxLength": 50
549
- },
550
- "minItems": 1
551
- },
552
- "description": {
553
- "type": "string",
554
- "description": "Permission description",
555
- "minLength": 1,
556
- "maxLength": 500
557
- }
668
+ "required":[
669
+ "enabled"
670
+ ],
671
+ "additionalProperties":false
672
+ },
673
+ "startupCommand":{
674
+ "type":"string",
675
+ "description":"Application startup command (e.g., 'pnpm start', 'python app.py')",
676
+ "minLength":1,
677
+ "maxLength":200
678
+ },
679
+ "runtimeVersion":{
680
+ "type":"object",
681
+ "description":"Runtime version configuration",
682
+ "properties":{
683
+ "node":{
684
+ "type":"string",
685
+ "description":"Node.js version (e.g., '18.17.0')",
686
+ "pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+$"
687
+ },
688
+ "python":{
689
+ "type":"string",
690
+ "description":"Python version (e.g., '3.11')",
691
+ "pattern":"^[0-9]+\\.[0-9]+$"
692
+ },
693
+ "dotnet":{
694
+ "type":"string",
695
+ "description":".NET version (e.g., '8.0')",
696
+ "pattern":"^[0-9]+\\.[0-9]+$"
697
+ }
558
698
  },
559
- "additionalProperties": false
560
- }
561
- },
562
- "repository": {
563
- "type": "object",
564
- "description": "Repository deployment configuration",
565
- "properties": {
566
- "enabled": {
567
- "type": "boolean",
568
- "description": "Whether repository deployment is enabled"
699
+ "additionalProperties":false
700
+ },
701
+ "scaling":{
702
+ "type":"object",
703
+ "description":"Application scaling configuration",
704
+ "properties":{
705
+ "minInstances":{
706
+ "type":"integer",
707
+ "description":"Minimum number of instances",
708
+ "minimum":1,
709
+ "maximum":20
710
+ },
711
+ "maxInstances":{
712
+ "type":"integer",
713
+ "description":"Maximum number of instances",
714
+ "minimum":1,
715
+ "maximum":20
716
+ },
717
+ "cpuThreshold":{
718
+ "type":"number",
719
+ "description":"CPU threshold for scaling (percentage)",
720
+ "minimum":10,
721
+ "maximum":90
722
+ }
569
723
  },
570
- "repositoryUrl": {
571
- "type": "string",
572
- "description": "Full repository URL for pipeline validation (same as OAuth callback)",
573
- "pattern": "^(https://github.com/[^/]+/[^/]+|https://gitlab.com/[^/]+/[^/]+|https://dev.azure.com/[^/]+/[^/]+/[^/]+)$"
574
- }
575
- },
576
- "required": ["enabled"],
577
- "additionalProperties": false
578
- },
579
- "startupCommand": {
580
- "type": "string",
581
- "description": "Application startup command (e.g., 'pnpm start', 'python app.py')",
582
- "minLength": 1,
583
- "maxLength": 200
584
- },
585
- "runtimeVersion": {
586
- "type": "object",
587
- "description": "Runtime version configuration",
588
- "properties": {
589
- "node": {
590
- "type": "string",
591
- "description": "Node.js version (e.g., '18.17.0')",
592
- "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
724
+ "additionalProperties":false
725
+ },
726
+ "build":{
727
+ "type":"object",
728
+ "description":"Build and local development configuration",
729
+ "properties":{
730
+ "envOutputPath":{
731
+ "type":"string",
732
+ "description":"Path where .env file is copied for local development (relative to builder/)",
733
+ "pattern":"^[^/].*"
734
+ },
735
+ "localPort":{
736
+ "type":"integer",
737
+ "description":"Port for local development (different from Docker port)",
738
+ "minimum":1000,
739
+ "maximum":65535
740
+ },
741
+ "containerPort":{
742
+ "type":"integer",
743
+ "description":"Container internal port (defaults to port if not specified)",
744
+ "minimum":1,
745
+ "maximum":65535
746
+ },
747
+ "language":{
748
+ "type":"string",
749
+ "description":"Runtime language for template selection",
750
+ "enum":[
751
+ "typescript",
752
+ "python"
753
+ ]
754
+ },
755
+ "context":{
756
+ "type":"string",
757
+ "description":"Docker build context path (relative to builder/)",
758
+ "pattern":"^[^/].*"
759
+ },
760
+ "dockerfile":{
761
+ "type":"string",
762
+ "description":"Dockerfile name (empty or missing = use auto-generated template)",
763
+ "pattern":"^[^/].*"
764
+ }
593
765
  },
594
- "python": {
595
- "type": "string",
596
- "description": "Python version (e.g., '3.11')",
597
- "pattern": "^[0-9]+\\.[0-9]+$"
766
+ "additionalProperties":false
767
+ },
768
+ "deployment":{
769
+ "type":"object",
770
+ "description":"Deployment configuration for pipeline API",
771
+ "properties":{
772
+ "controllerUrl":{
773
+ "type":"string",
774
+ "description":"Controller API URL for deployment",
775
+ "pattern":"^https://.*$"
776
+ }
598
777
  },
599
- "dotnet": {
600
- "type": "string",
601
- "description": ".NET version (e.g., '8.0')",
602
- "pattern": "^[0-9]+\\.[0-9]+$"
603
- }
604
- },
605
- "additionalProperties": false
606
- },
607
- "scaling": {
608
- "type": "object",
609
- "description": "Application scaling configuration",
610
- "properties": {
611
- "minInstances": {
612
- "type": "integer",
613
- "description": "Minimum number of instances",
614
- "minimum": 1,
615
- "maximum": 20
778
+ "additionalProperties":false
779
+ },
780
+ "externalIntegration":{
781
+ "type":"object",
782
+ "description":"Defines External Systems & External Data Sources shipped with this application. Pipeline registers these in Miso-Controller and publishes schemas to Dataplane.",
783
+ "required":[
784
+ "schemaBasePath"
785
+ ],
786
+ "properties":{
787
+ "schemaBasePath":{
788
+ "type":"string",
789
+ "description":"Base folder path containing external-system.json and external-datasource.json files.",
790
+ "pattern":"^[^ ].*$"
791
+ },
792
+ "systems":{
793
+ "type":"array",
794
+ "description":"List of external-system JSON files to deploy via pipeline.",
795
+ "items":{
796
+ "type":"string",
797
+ "pattern":"^[^ ].+\\.json$"
798
+ },
799
+ "uniqueItems":true
800
+ },
801
+ "dataSources":{
802
+ "type":"array",
803
+ "description":"List of external-datasource JSON files belonging to this app.",
804
+ "items":{
805
+ "type":"string",
806
+ "pattern":"^[^ ].+\\.json$"
807
+ },
808
+ "uniqueItems":true
809
+ },
810
+ "autopublish":{
811
+ "type":"boolean",
812
+ "default":true,
813
+ "description":"If true, pipeline automatically publishes ExternalSystems + ExternalDataSources to Dataplane after deployment."
814
+ },
815
+ "version":{
816
+ "type":"string",
817
+ "description":"Version of the integration set (used for schema diffing & migrations).",
818
+ "pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+$"
819
+ }
616
820
  },
617
- "maxInstances": {
618
- "type": "integer",
619
- "description": "Maximum number of instances",
620
- "minimum": 1,
621
- "maximum": 20
821
+ "additionalProperties":false
822
+ }
823
+ },
824
+ "additionalProperties":false,
825
+ "allOf":[
826
+ {
827
+ "if":{
828
+ "properties":{
829
+ "requiresDatabase":{
830
+ "const":true
831
+ }
832
+ }
622
833
  },
623
- "cpuThreshold": {
624
- "type": "number",
625
- "description": "CPU threshold for scaling (percentage)",
626
- "minimum": 10,
627
- "maximum": 90
834
+ "then":{
835
+ "required":[
836
+ "databases"
837
+ ]
628
838
  }
629
- },
630
- "additionalProperties": false
631
- },
632
- "build": {
633
- "type": "object",
634
- "description": "Build and local development configuration",
635
- "properties": {
636
- "envOutputPath": {
637
- "type": "string",
638
- "description": "Path where .env file is copied for local development (relative to builder/)",
639
- "pattern": "^[^/].*"
640
- },
641
- "localPort": {
642
- "type": "integer",
643
- "description": "Port for local development (different from Docker port)",
644
- "minimum": 1000,
645
- "maximum": 65535
646
- },
647
- "containerPort": {
648
- "type": "integer",
649
- "description": "Container internal port (defaults to port if not specified)",
650
- "minimum": 1,
651
- "maximum": 65535
652
- },
653
- "language": {
654
- "type": "string",
655
- "description": "Runtime language for template selection",
656
- "enum": ["typescript", "python"]
657
- },
658
- "context": {
659
- "type": "string",
660
- "description": "Docker build context path (relative to builder/)",
661
- "pattern": "^[^/].*"
839
+ },
840
+ {
841
+ "if":{
842
+ "properties":{
843
+ "registryMode":{
844
+ "const":"external"
845
+ }
846
+ }
662
847
  },
663
- "dockerfile": {
664
- "type": "string",
665
- "description": "Dockerfile name (empty or missing = use auto-generated template)",
666
- "pattern": "^[^/].*"
667
- }
668
- },
669
- "additionalProperties": false
670
- },
671
- "deployment": {
672
- "type": "object",
673
- "description": "Deployment configuration for pipeline API",
674
- "properties": {
675
- "controllerUrl": {
676
- "type": "string",
677
- "description": "Controller API URL for deployment",
678
- "pattern": "^https://.*$"
679
- }
680
- },
681
- "additionalProperties": false
682
- }
683
- },
684
- "additionalProperties": false,
685
- "allOf": [
686
- {
687
- "if": {
688
- "properties": {
689
- "requiresDatabase": {
690
- "const": true
691
- }
692
- }
693
- },
694
- "then": {
695
- "required": ["databases"]
696
- }
697
- },
698
- {
699
- "if": {
700
- "properties": {
701
- "registryMode": {
702
- "const": "external"
703
- }
704
- }
705
- },
706
- "then": {
707
- "properties": {
708
- "configuration": {
709
- "items": {
710
- "properties": {
711
- "name": {
712
- "enum": [
713
- "DOCKER_REGISTRY_SERVER_URL",
714
- "DOCKER_REGISTRY_SERVER_USERNAME",
715
- "DOCKER_REGISTRY_SERVER_PASSWORD"
716
- ]
717
- }
848
+ "then":{
849
+ "properties":{
850
+ "configuration":{
851
+ "items":{
852
+ "properties":{
853
+ "name":{
854
+ "enum":[
855
+ "DOCKER_REGISTRY_SERVER_URL",
856
+ "DOCKER_REGISTRY_SERVER_USERNAME",
857
+ "DOCKER_REGISTRY_SERVER_PASSWORD"
858
+ ]
859
+ }
860
+ }
861
+ }
718
862
  }
719
- }
720
- }
863
+ }
721
864
  }
722
- }
723
- }
865
+ }
724
866
  ]
725
- }
867
+ }