@epilot/sdk 2.8.6 → 2.8.7
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.
- package/definitions/access-token-runtime.json +1 -1
- package/definitions/access-token.json +1 -155
- package/definitions/app.json +8 -101
- package/definitions/automation.json +0 -120
- package/definitions/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +349 -1643
- package/definitions/configuration-hub-runtime.json +1 -1
- package/definitions/configuration-hub.json +0 -623
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +78 -383
- package/definitions/design-runtime.json +1 -1
- package/definitions/design.json +12 -52
- package/definitions/event-catalog-runtime.json +1 -1
- package/definitions/event-catalog.json +12 -168
- package/definitions/file-runtime.json +1 -1
- package/definitions/file.json +4 -152
- package/definitions/integration-toolkit-runtime.json +1 -1
- package/definitions/integration-toolkit.json +16 -785
- package/definitions/journey-runtime.json +1 -1
- package/definitions/journey.json +1 -21
- package/definitions/notes-runtime.json +1 -1
- package/definitions/notes.json +1 -123
- package/definitions/pricing.json +406 -224
- package/definitions/targeting-runtime.json +1 -1
- package/definitions/targeting.json +7 -258
- package/definitions/user-runtime.json +1 -1
- package/definitions/user.json +0 -441
- package/definitions/webhooks.json +0 -31
- package/package.json +1 -1
- package/definitions/snapshot-runtime.json +0 -1
- package/definitions/snapshot.json +0 -950
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.2",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Blueprint Manifest API",
|
|
5
|
-
"version": "4.
|
|
5
|
+
"version": "4.6.4",
|
|
6
6
|
"description": "Service to create and install Blueprint Manifest files"
|
|
7
7
|
},
|
|
8
8
|
"tags": [
|
|
@@ -37,14 +37,6 @@
|
|
|
37
37
|
{
|
|
38
38
|
"name": "Marketplace Listing Versions",
|
|
39
39
|
"description": "Manage versions for marketplace listings"
|
|
40
|
-
},
|
|
41
|
-
{
|
|
42
|
-
"name": "Patches",
|
|
43
|
-
"description": "Manage blueprint patches for mass rollouts"
|
|
44
|
-
},
|
|
45
|
-
{
|
|
46
|
-
"name": "Uniqueness Criteria",
|
|
47
|
-
"description": "Configure per-org field sets used to match existing resources during install"
|
|
48
40
|
}
|
|
49
41
|
],
|
|
50
42
|
"security": [
|
|
@@ -932,14 +924,6 @@
|
|
|
932
924
|
"destination_blueprint_id": {
|
|
933
925
|
"$ref": "#/components/schemas/BlueprintID"
|
|
934
926
|
},
|
|
935
|
-
"source_auth_token": {
|
|
936
|
-
"type": "string",
|
|
937
|
-
"description": "Auth token with access to the source org. Required for cross-org auto-verification when the caller's bearer token belongs to the destination org."
|
|
938
|
-
},
|
|
939
|
-
"destination_auth_token": {
|
|
940
|
-
"type": "string",
|
|
941
|
-
"description": "Auth token with access to the destination org. Defaults to the caller's bearer token."
|
|
942
|
-
},
|
|
943
927
|
"options": {
|
|
944
928
|
"$ref": "#/components/schemas/BlueprintInstallationJobOptions"
|
|
945
929
|
},
|
|
@@ -1240,13 +1224,13 @@
|
|
|
1240
1224
|
}
|
|
1241
1225
|
}
|
|
1242
1226
|
},
|
|
1243
|
-
"/v2/blueprint-manifest/blueprints/{blueprint_id}
|
|
1227
|
+
"/v2/blueprint-manifest/blueprints/{blueprint_id}:export": {
|
|
1244
1228
|
"post": {
|
|
1245
|
-
"operationId": "
|
|
1246
|
-
"summary": "
|
|
1247
|
-
"description": "
|
|
1229
|
+
"operationId": "exportBlueprint",
|
|
1230
|
+
"summary": "exportBlueprint",
|
|
1231
|
+
"description": "Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.\n",
|
|
1248
1232
|
"tags": [
|
|
1249
|
-
"
|
|
1233
|
+
"Blueprints"
|
|
1250
1234
|
],
|
|
1251
1235
|
"parameters": [
|
|
1252
1236
|
{
|
|
@@ -1259,26 +1243,21 @@
|
|
|
1259
1243
|
}
|
|
1260
1244
|
],
|
|
1261
1245
|
"requestBody": {
|
|
1246
|
+
"required": false,
|
|
1262
1247
|
"content": {
|
|
1263
1248
|
"application/json": {
|
|
1264
1249
|
"schema": {
|
|
1265
1250
|
"type": "object",
|
|
1266
1251
|
"properties": {
|
|
1267
|
-
"
|
|
1268
|
-
"type": "string"
|
|
1269
|
-
"description": "Organization ID of the source org where changes were made"
|
|
1270
|
-
},
|
|
1271
|
-
"dest_org_id": {
|
|
1272
|
-
"type": "string",
|
|
1273
|
-
"description": "Organization ID of a destination org (used to load tfstate baseline)"
|
|
1252
|
+
"destination_org_id": {
|
|
1253
|
+
"type": "string"
|
|
1274
1254
|
},
|
|
1275
|
-
"
|
|
1276
|
-
"type": "string"
|
|
1277
|
-
"description": "Blueprint ID in the destination org (used to locate tfstate in S3)"
|
|
1255
|
+
"destination_blueprint_id": {
|
|
1256
|
+
"type": "string"
|
|
1278
1257
|
},
|
|
1279
|
-
"
|
|
1280
|
-
"type": "
|
|
1281
|
-
"description": "
|
|
1258
|
+
"validate": {
|
|
1259
|
+
"type": "boolean",
|
|
1260
|
+
"description": "When true, run terraform validate before creating the export zip. If validation fails, the job will be marked as FAILED with errors."
|
|
1282
1261
|
}
|
|
1283
1262
|
}
|
|
1284
1263
|
}
|
|
@@ -1286,12 +1265,25 @@
|
|
|
1286
1265
|
}
|
|
1287
1266
|
},
|
|
1288
1267
|
"responses": {
|
|
1289
|
-
"
|
|
1290
|
-
"description": "
|
|
1268
|
+
"202": {
|
|
1269
|
+
"description": "Blueprint export job started",
|
|
1270
|
+
"headers": {
|
|
1271
|
+
"Location": {
|
|
1272
|
+
"description": "URL to poll the job",
|
|
1273
|
+
"schema": {
|
|
1274
|
+
"type": "string"
|
|
1275
|
+
}
|
|
1276
|
+
}
|
|
1277
|
+
},
|
|
1291
1278
|
"content": {
|
|
1292
1279
|
"application/json": {
|
|
1293
1280
|
"schema": {
|
|
1294
|
-
"
|
|
1281
|
+
"type": "object",
|
|
1282
|
+
"properties": {
|
|
1283
|
+
"job_id": {
|
|
1284
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1285
|
+
}
|
|
1286
|
+
}
|
|
1295
1287
|
}
|
|
1296
1288
|
}
|
|
1297
1289
|
}
|
|
@@ -1299,23 +1291,67 @@
|
|
|
1299
1291
|
}
|
|
1300
1292
|
}
|
|
1301
1293
|
},
|
|
1302
|
-
"/v2/blueprint-manifest/
|
|
1303
|
-
"
|
|
1304
|
-
"operationId": "
|
|
1305
|
-
"summary": "
|
|
1306
|
-
"description": "
|
|
1294
|
+
"/v2/blueprint-manifest/marketplace/slugs": {
|
|
1295
|
+
"get": {
|
|
1296
|
+
"operationId": "listMarketplaceSlugs",
|
|
1297
|
+
"summary": "listMarketplaceSlugs",
|
|
1298
|
+
"description": "List all available marketplace blueprint slugs from Webflow CMS.\nReturns cached results when available.\n",
|
|
1307
1299
|
"tags": [
|
|
1308
|
-
"
|
|
1300
|
+
"Blueprints"
|
|
1309
1301
|
],
|
|
1310
|
-
"
|
|
1311
|
-
{
|
|
1312
|
-
"
|
|
1313
|
-
"
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1302
|
+
"responses": {
|
|
1303
|
+
"200": {
|
|
1304
|
+
"description": "List of marketplace slugs",
|
|
1305
|
+
"content": {
|
|
1306
|
+
"application/json": {
|
|
1307
|
+
"schema": {
|
|
1308
|
+
"type": "object",
|
|
1309
|
+
"properties": {
|
|
1310
|
+
"results": {
|
|
1311
|
+
"type": "array",
|
|
1312
|
+
"items": {
|
|
1313
|
+
"type": "object",
|
|
1314
|
+
"properties": {
|
|
1315
|
+
"slug": {
|
|
1316
|
+
"type": "string",
|
|
1317
|
+
"description": "The installation slug identifier for the blueprint (used for publishing).",
|
|
1318
|
+
"example": "wallbox_b2c"
|
|
1319
|
+
},
|
|
1320
|
+
"marketplace_slug": {
|
|
1321
|
+
"type": "string",
|
|
1322
|
+
"description": "The marketplace page slug for the Webflow CMS item (used for display).",
|
|
1323
|
+
"example": "wallbox-b2c"
|
|
1324
|
+
},
|
|
1325
|
+
"version": {
|
|
1326
|
+
"type": "string",
|
|
1327
|
+
"example": "v1.0.0"
|
|
1328
|
+
},
|
|
1329
|
+
"name": {
|
|
1330
|
+
"type": "string",
|
|
1331
|
+
"example": "Wallbox B2C"
|
|
1332
|
+
},
|
|
1333
|
+
"installation_link": {
|
|
1334
|
+
"type": "string",
|
|
1335
|
+
"example": "https://portal.epilot.cloud/app/blueprints/install/marketplace/wallbox_b2c?s3Ref=https://example.com/blueprint.zip"
|
|
1336
|
+
}
|
|
1337
|
+
}
|
|
1338
|
+
}
|
|
1339
|
+
}
|
|
1340
|
+
}
|
|
1341
|
+
}
|
|
1342
|
+
}
|
|
1317
1343
|
}
|
|
1318
1344
|
}
|
|
1345
|
+
}
|
|
1346
|
+
}
|
|
1347
|
+
},
|
|
1348
|
+
"/v2/blueprint-manifest/blueprints:publish": {
|
|
1349
|
+
"post": {
|
|
1350
|
+
"operationId": "publishBlueprint",
|
|
1351
|
+
"summary": "publishBlueprint",
|
|
1352
|
+
"description": "Publish a blueprint to the marketplace. Exports the blueprint, uploads it to file-api with public access, and updates the Webflow CMS listing.\n",
|
|
1353
|
+
"tags": [
|
|
1354
|
+
"Blueprints"
|
|
1319
1355
|
],
|
|
1320
1356
|
"requestBody": {
|
|
1321
1357
|
"required": true,
|
|
@@ -1325,35 +1361,23 @@
|
|
|
1325
1361
|
"type": "object",
|
|
1326
1362
|
"required": [
|
|
1327
1363
|
"blueprint_id",
|
|
1328
|
-
"
|
|
1329
|
-
"source_org_id",
|
|
1330
|
-
"name",
|
|
1331
|
-
"resources"
|
|
1364
|
+
"slug"
|
|
1332
1365
|
],
|
|
1333
1366
|
"properties": {
|
|
1334
1367
|
"blueprint_id": {
|
|
1335
1368
|
"$ref": "#/components/schemas/BlueprintID"
|
|
1336
1369
|
},
|
|
1337
|
-
"
|
|
1338
|
-
"type": "string"
|
|
1370
|
+
"slug": {
|
|
1371
|
+
"type": "string",
|
|
1372
|
+
"description": "The marketplace installation slug for the Webflow CMS item"
|
|
1339
1373
|
},
|
|
1340
|
-
"
|
|
1341
|
-
"type": "string"
|
|
1374
|
+
"version": {
|
|
1375
|
+
"type": "string",
|
|
1376
|
+
"description": "The version string to set on the marketplace CMS item (e.g. \"1.0.0\")"
|
|
1342
1377
|
},
|
|
1343
1378
|
"name": {
|
|
1344
|
-
"type": "string"
|
|
1345
|
-
|
|
1346
|
-
"description": {
|
|
1347
|
-
"type": "string"
|
|
1348
|
-
},
|
|
1349
|
-
"resources": {
|
|
1350
|
-
"type": "array",
|
|
1351
|
-
"items": {
|
|
1352
|
-
"$ref": "#/components/schemas/PatchResourceDiff"
|
|
1353
|
-
}
|
|
1354
|
-
},
|
|
1355
|
-
"changelog": {
|
|
1356
|
-
"type": "string"
|
|
1379
|
+
"type": "string",
|
|
1380
|
+
"description": "The display name for the blueprint on the marketplace CMS item"
|
|
1357
1381
|
}
|
|
1358
1382
|
}
|
|
1359
1383
|
}
|
|
@@ -1361,24 +1385,39 @@
|
|
|
1361
1385
|
}
|
|
1362
1386
|
},
|
|
1363
1387
|
"responses": {
|
|
1364
|
-
"
|
|
1365
|
-
"description": "
|
|
1388
|
+
"202": {
|
|
1389
|
+
"description": "Blueprint publish job started",
|
|
1390
|
+
"headers": {
|
|
1391
|
+
"Location": {
|
|
1392
|
+
"description": "URL to poll the job",
|
|
1393
|
+
"schema": {
|
|
1394
|
+
"type": "string"
|
|
1395
|
+
}
|
|
1396
|
+
}
|
|
1397
|
+
},
|
|
1366
1398
|
"content": {
|
|
1367
1399
|
"application/json": {
|
|
1368
1400
|
"schema": {
|
|
1369
|
-
"
|
|
1401
|
+
"type": "object",
|
|
1402
|
+
"properties": {
|
|
1403
|
+
"job_id": {
|
|
1404
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1405
|
+
}
|
|
1406
|
+
}
|
|
1370
1407
|
}
|
|
1371
1408
|
}
|
|
1372
1409
|
}
|
|
1373
1410
|
}
|
|
1374
1411
|
}
|
|
1375
|
-
}
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
"
|
|
1412
|
+
}
|
|
1413
|
+
},
|
|
1414
|
+
"/v2/blueprint-manifest/blueprints/{blueprint_id}:format-description": {
|
|
1415
|
+
"post": {
|
|
1416
|
+
"operationId": "formatBlueprintDescription",
|
|
1417
|
+
"summary": "formatBlueprintDescription",
|
|
1418
|
+
"description": "Format a blueprint description as markdown using AI.\n",
|
|
1380
1419
|
"tags": [
|
|
1381
|
-
"
|
|
1420
|
+
"Blueprints"
|
|
1382
1421
|
],
|
|
1383
1422
|
"parameters": [
|
|
1384
1423
|
{
|
|
@@ -1390,22 +1429,36 @@
|
|
|
1390
1429
|
}
|
|
1391
1430
|
}
|
|
1392
1431
|
],
|
|
1432
|
+
"requestBody": {
|
|
1433
|
+
"required": true,
|
|
1434
|
+
"content": {
|
|
1435
|
+
"application/json": {
|
|
1436
|
+
"schema": {
|
|
1437
|
+
"type": "object",
|
|
1438
|
+
"required": [
|
|
1439
|
+
"text"
|
|
1440
|
+
],
|
|
1441
|
+
"properties": {
|
|
1442
|
+
"text": {
|
|
1443
|
+
"type": "string",
|
|
1444
|
+
"description": "Plain text to format as markdown"
|
|
1445
|
+
}
|
|
1446
|
+
}
|
|
1447
|
+
}
|
|
1448
|
+
}
|
|
1449
|
+
}
|
|
1450
|
+
},
|
|
1393
1451
|
"responses": {
|
|
1394
1452
|
"200": {
|
|
1395
|
-
"description": "
|
|
1453
|
+
"description": "Successfully formatted description",
|
|
1396
1454
|
"content": {
|
|
1397
1455
|
"application/json": {
|
|
1398
1456
|
"schema": {
|
|
1399
1457
|
"type": "object",
|
|
1400
1458
|
"properties": {
|
|
1401
|
-
"
|
|
1402
|
-
"type": "
|
|
1403
|
-
|
|
1404
|
-
"results": {
|
|
1405
|
-
"type": "array",
|
|
1406
|
-
"items": {
|
|
1407
|
-
"$ref": "#/components/schemas/BlueprintPatch"
|
|
1408
|
-
}
|
|
1459
|
+
"markdown": {
|
|
1460
|
+
"type": "string",
|
|
1461
|
+
"description": "AI-formatted markdown content"
|
|
1409
1462
|
}
|
|
1410
1463
|
}
|
|
1411
1464
|
}
|
|
@@ -1415,13 +1468,13 @@
|
|
|
1415
1468
|
}
|
|
1416
1469
|
}
|
|
1417
1470
|
},
|
|
1418
|
-
"/v2/blueprint-manifest/blueprints/{blueprint_id}/
|
|
1419
|
-
"
|
|
1420
|
-
"operationId": "
|
|
1421
|
-
"summary": "
|
|
1422
|
-
"description": "
|
|
1471
|
+
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources": {
|
|
1472
|
+
"post": {
|
|
1473
|
+
"operationId": "addBlueprintResource",
|
|
1474
|
+
"summary": "addBlueprintResource",
|
|
1475
|
+
"description": "Add a resource to a Blueprint",
|
|
1423
1476
|
"tags": [
|
|
1424
|
-
"
|
|
1477
|
+
"Blueprints"
|
|
1425
1478
|
],
|
|
1426
1479
|
"parameters": [
|
|
1427
1480
|
{
|
|
@@ -1433,38 +1486,53 @@
|
|
|
1433
1486
|
}
|
|
1434
1487
|
},
|
|
1435
1488
|
{
|
|
1436
|
-
"in": "
|
|
1437
|
-
"
|
|
1438
|
-
"name": "patch_id",
|
|
1489
|
+
"in": "query",
|
|
1490
|
+
"name": "add_dependencies",
|
|
1439
1491
|
"schema": {
|
|
1440
|
-
"type": "
|
|
1492
|
+
"type": "boolean",
|
|
1493
|
+
"default": false,
|
|
1494
|
+
"description": "Whether to add this resource dependencies to the blueprint automatically"
|
|
1441
1495
|
}
|
|
1442
1496
|
}
|
|
1443
1497
|
],
|
|
1498
|
+
"requestBody": {
|
|
1499
|
+
"content": {
|
|
1500
|
+
"application/json": {
|
|
1501
|
+
"schema": {
|
|
1502
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1503
|
+
}
|
|
1504
|
+
}
|
|
1505
|
+
}
|
|
1506
|
+
},
|
|
1444
1507
|
"responses": {
|
|
1445
1508
|
"200": {
|
|
1446
|
-
"description": "
|
|
1509
|
+
"description": "Added Blueprint Resource",
|
|
1447
1510
|
"content": {
|
|
1448
1511
|
"application/json": {
|
|
1449
1512
|
"schema": {
|
|
1450
|
-
"
|
|
1513
|
+
"type": "object",
|
|
1514
|
+
"properties": {
|
|
1515
|
+
"resources": {
|
|
1516
|
+
"type": "array",
|
|
1517
|
+
"items": {
|
|
1518
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1519
|
+
}
|
|
1520
|
+
}
|
|
1521
|
+
}
|
|
1451
1522
|
}
|
|
1452
1523
|
}
|
|
1453
1524
|
}
|
|
1454
|
-
},
|
|
1455
|
-
"404": {
|
|
1456
|
-
"description": "Patch not found"
|
|
1457
1525
|
}
|
|
1458
1526
|
}
|
|
1459
1527
|
}
|
|
1460
1528
|
},
|
|
1461
|
-
"/v2/blueprint-manifest/blueprints/{blueprint_id}/
|
|
1529
|
+
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies": {
|
|
1462
1530
|
"post": {
|
|
1463
|
-
"operationId": "
|
|
1464
|
-
"summary": "
|
|
1465
|
-
"description": "
|
|
1531
|
+
"operationId": "syncDependencies",
|
|
1532
|
+
"summary": "syncDependencies",
|
|
1533
|
+
"description": "Sync dependencies of all root resources in a Blueprint",
|
|
1466
1534
|
"tags": [
|
|
1467
|
-
"
|
|
1535
|
+
"Blueprints"
|
|
1468
1536
|
],
|
|
1469
1537
|
"parameters": [
|
|
1470
1538
|
{
|
|
@@ -1474,56 +1542,28 @@
|
|
|
1474
1542
|
"schema": {
|
|
1475
1543
|
"$ref": "#/components/schemas/BlueprintID"
|
|
1476
1544
|
}
|
|
1477
|
-
},
|
|
1478
|
-
{
|
|
1479
|
-
"in": "path",
|
|
1480
|
-
"required": true,
|
|
1481
|
-
"name": "patch_id",
|
|
1482
|
-
"schema": {
|
|
1483
|
-
"type": "string"
|
|
1484
|
-
}
|
|
1485
1545
|
}
|
|
1486
1546
|
],
|
|
1487
|
-
"
|
|
1488
|
-
"
|
|
1489
|
-
|
|
1490
|
-
"
|
|
1491
|
-
"
|
|
1492
|
-
"
|
|
1493
|
-
"
|
|
1494
|
-
"
|
|
1495
|
-
"org_name",
|
|
1496
|
-
"dest_blueprint_id"
|
|
1497
|
-
],
|
|
1498
|
-
"properties": {
|
|
1499
|
-
"org_id": {
|
|
1500
|
-
"type": "string"
|
|
1501
|
-
},
|
|
1502
|
-
"org_name": {
|
|
1503
|
-
"type": "string"
|
|
1504
|
-
},
|
|
1505
|
-
"dest_blueprint_id": {
|
|
1506
|
-
"type": "string"
|
|
1507
|
-
},
|
|
1508
|
-
"dest_org_id": {
|
|
1509
|
-
"type": "string"
|
|
1510
|
-
},
|
|
1511
|
-
"destination_auth_token": {
|
|
1512
|
-
"type": "string",
|
|
1513
|
-
"description": "Auth token with access to the destination org (e.g. pipeline token)"
|
|
1514
|
-
}
|
|
1547
|
+
"responses": {
|
|
1548
|
+
"202": {
|
|
1549
|
+
"description": "Dependencies sync job started",
|
|
1550
|
+
"headers": {
|
|
1551
|
+
"Location": {
|
|
1552
|
+
"description": "URL to poll the job",
|
|
1553
|
+
"schema": {
|
|
1554
|
+
"type": "string"
|
|
1515
1555
|
}
|
|
1516
1556
|
}
|
|
1517
|
-
}
|
|
1518
|
-
}
|
|
1519
|
-
},
|
|
1520
|
-
"responses": {
|
|
1521
|
-
"200": {
|
|
1522
|
-
"description": "Patch execution result",
|
|
1557
|
+
},
|
|
1523
1558
|
"content": {
|
|
1524
1559
|
"application/json": {
|
|
1525
1560
|
"schema": {
|
|
1526
|
-
"
|
|
1561
|
+
"type": "object",
|
|
1562
|
+
"properties": {
|
|
1563
|
+
"job_id": {
|
|
1564
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1565
|
+
}
|
|
1566
|
+
}
|
|
1527
1567
|
}
|
|
1528
1568
|
}
|
|
1529
1569
|
}
|
|
@@ -1531,13 +1571,13 @@
|
|
|
1531
1571
|
}
|
|
1532
1572
|
}
|
|
1533
1573
|
},
|
|
1534
|
-
"/v2/blueprint-manifest/blueprints/{blueprint_id}/
|
|
1574
|
+
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk": {
|
|
1535
1575
|
"post": {
|
|
1536
|
-
"operationId": "
|
|
1537
|
-
"summary": "
|
|
1538
|
-
"description": "
|
|
1576
|
+
"operationId": "bulkAddBlueprintResources",
|
|
1577
|
+
"summary": "bulkAddBlueprintResources",
|
|
1578
|
+
"description": "Bulk Add resources in a Blueprint",
|
|
1539
1579
|
"tags": [
|
|
1540
|
-
"
|
|
1580
|
+
"Blueprints"
|
|
1541
1581
|
],
|
|
1542
1582
|
"parameters": [
|
|
1543
1583
|
{
|
|
@@ -1549,19 +1589,12 @@
|
|
|
1549
1589
|
}
|
|
1550
1590
|
},
|
|
1551
1591
|
{
|
|
1552
|
-
"in": "
|
|
1553
|
-
"
|
|
1554
|
-
"name": "patch_id",
|
|
1555
|
-
"schema": {
|
|
1556
|
-
"type": "string"
|
|
1557
|
-
}
|
|
1558
|
-
},
|
|
1559
|
-
{
|
|
1560
|
-
"in": "path",
|
|
1561
|
-
"required": true,
|
|
1562
|
-
"name": "org_id",
|
|
1592
|
+
"in": "query",
|
|
1593
|
+
"name": "add_dependencies",
|
|
1563
1594
|
"schema": {
|
|
1564
|
-
"type": "
|
|
1595
|
+
"type": "boolean",
|
|
1596
|
+
"default": false,
|
|
1597
|
+
"description": "Whether to add this resource dependencies to the blueprint automatically"
|
|
1565
1598
|
}
|
|
1566
1599
|
}
|
|
1567
1600
|
],
|
|
@@ -1569,17 +1602,9 @@
|
|
|
1569
1602
|
"content": {
|
|
1570
1603
|
"application/json": {
|
|
1571
1604
|
"schema": {
|
|
1572
|
-
"type": "
|
|
1573
|
-
"
|
|
1574
|
-
"
|
|
1575
|
-
"type": "string"
|
|
1576
|
-
},
|
|
1577
|
-
"dest_blueprint_id": {
|
|
1578
|
-
"type": "string"
|
|
1579
|
-
},
|
|
1580
|
-
"destination_auth_token": {
|
|
1581
|
-
"type": "string"
|
|
1582
|
-
}
|
|
1605
|
+
"type": "array",
|
|
1606
|
+
"items": {
|
|
1607
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1583
1608
|
}
|
|
1584
1609
|
}
|
|
1585
1610
|
}
|
|
@@ -1587,23 +1612,29 @@
|
|
|
1587
1612
|
},
|
|
1588
1613
|
"responses": {
|
|
1589
1614
|
"200": {
|
|
1590
|
-
"description": "
|
|
1615
|
+
"description": "Bulk updated Blueprint Resources",
|
|
1591
1616
|
"content": {
|
|
1592
1617
|
"application/json": {
|
|
1593
1618
|
"schema": {
|
|
1594
|
-
"
|
|
1619
|
+
"type": "object",
|
|
1620
|
+
"properties": {
|
|
1621
|
+
"resources": {
|
|
1622
|
+
"type": "array",
|
|
1623
|
+
"items": {
|
|
1624
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1625
|
+
}
|
|
1626
|
+
}
|
|
1627
|
+
}
|
|
1595
1628
|
}
|
|
1596
1629
|
}
|
|
1597
1630
|
}
|
|
1598
1631
|
}
|
|
1599
1632
|
}
|
|
1600
|
-
}
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
"
|
|
1605
|
-
"summary": "exportBlueprint",
|
|
1606
|
-
"description": "Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.\n",
|
|
1633
|
+
},
|
|
1634
|
+
"put": {
|
|
1635
|
+
"operationId": "bulkUpdateBlueprintResources",
|
|
1636
|
+
"summary": "bulkUpdateBlueprintResources",
|
|
1637
|
+
"description": "Bulk update resources in a Blueprint",
|
|
1607
1638
|
"tags": [
|
|
1608
1639
|
"Blueprints"
|
|
1609
1640
|
],
|
|
@@ -1618,98 +1649,29 @@
|
|
|
1618
1649
|
}
|
|
1619
1650
|
],
|
|
1620
1651
|
"requestBody": {
|
|
1621
|
-
"required": false,
|
|
1622
1652
|
"content": {
|
|
1623
1653
|
"application/json": {
|
|
1624
1654
|
"schema": {
|
|
1625
|
-
"type": "
|
|
1626
|
-
"
|
|
1627
|
-
"
|
|
1628
|
-
"type": "string"
|
|
1629
|
-
},
|
|
1630
|
-
"destination_blueprint_id": {
|
|
1631
|
-
"type": "string"
|
|
1632
|
-
},
|
|
1633
|
-
"validate": {
|
|
1634
|
-
"type": "boolean",
|
|
1635
|
-
"description": "When true, run terraform validate before creating the export zip. If validation fails, the job will be marked as FAILED with errors."
|
|
1636
|
-
}
|
|
1655
|
+
"type": "array",
|
|
1656
|
+
"items": {
|
|
1657
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1637
1658
|
}
|
|
1638
1659
|
}
|
|
1639
1660
|
}
|
|
1640
1661
|
}
|
|
1641
1662
|
},
|
|
1642
|
-
"responses": {
|
|
1643
|
-
"202": {
|
|
1644
|
-
"description": "Blueprint export job started",
|
|
1645
|
-
"headers": {
|
|
1646
|
-
"Location": {
|
|
1647
|
-
"description": "URL to poll the job",
|
|
1648
|
-
"schema": {
|
|
1649
|
-
"type": "string"
|
|
1650
|
-
}
|
|
1651
|
-
}
|
|
1652
|
-
},
|
|
1653
|
-
"content": {
|
|
1654
|
-
"application/json": {
|
|
1655
|
-
"schema": {
|
|
1656
|
-
"type": "object",
|
|
1657
|
-
"properties": {
|
|
1658
|
-
"job_id": {
|
|
1659
|
-
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1660
|
-
}
|
|
1661
|
-
}
|
|
1662
|
-
}
|
|
1663
|
-
}
|
|
1664
|
-
}
|
|
1665
|
-
}
|
|
1666
|
-
}
|
|
1667
|
-
}
|
|
1668
|
-
},
|
|
1669
|
-
"/v2/blueprint-manifest/marketplace/slugs": {
|
|
1670
|
-
"get": {
|
|
1671
|
-
"operationId": "listMarketplaceSlugs",
|
|
1672
|
-
"summary": "listMarketplaceSlugs",
|
|
1673
|
-
"description": "List all available marketplace blueprint slugs from Webflow CMS.\nReturns cached results when available.\n",
|
|
1674
|
-
"tags": [
|
|
1675
|
-
"Blueprints"
|
|
1676
|
-
],
|
|
1677
1663
|
"responses": {
|
|
1678
1664
|
"200": {
|
|
1679
|
-
"description": "
|
|
1665
|
+
"description": "Bulk updated Blueprint Resources",
|
|
1680
1666
|
"content": {
|
|
1681
1667
|
"application/json": {
|
|
1682
1668
|
"schema": {
|
|
1683
1669
|
"type": "object",
|
|
1684
1670
|
"properties": {
|
|
1685
|
-
"
|
|
1671
|
+
"resources": {
|
|
1686
1672
|
"type": "array",
|
|
1687
1673
|
"items": {
|
|
1688
|
-
"
|
|
1689
|
-
"properties": {
|
|
1690
|
-
"slug": {
|
|
1691
|
-
"type": "string",
|
|
1692
|
-
"description": "The installation slug identifier for the blueprint (used for publishing).",
|
|
1693
|
-
"example": "wallbox_b2c"
|
|
1694
|
-
},
|
|
1695
|
-
"marketplace_slug": {
|
|
1696
|
-
"type": "string",
|
|
1697
|
-
"description": "The marketplace page slug for the Webflow CMS item (used for display).",
|
|
1698
|
-
"example": "wallbox-b2c"
|
|
1699
|
-
},
|
|
1700
|
-
"version": {
|
|
1701
|
-
"type": "string",
|
|
1702
|
-
"example": "v1.0.0"
|
|
1703
|
-
},
|
|
1704
|
-
"name": {
|
|
1705
|
-
"type": "string",
|
|
1706
|
-
"example": "Wallbox B2C"
|
|
1707
|
-
},
|
|
1708
|
-
"installation_link": {
|
|
1709
|
-
"type": "string",
|
|
1710
|
-
"example": "https://portal.epilot.cloud/app/blueprints/install/marketplace/wallbox_b2c?s3Ref=https://example.com/blueprint.zip"
|
|
1711
|
-
}
|
|
1712
|
-
}
|
|
1674
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1713
1675
|
}
|
|
1714
1676
|
}
|
|
1715
1677
|
}
|
|
@@ -1718,65 +1680,49 @@
|
|
|
1718
1680
|
}
|
|
1719
1681
|
}
|
|
1720
1682
|
}
|
|
1721
|
-
}
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
"
|
|
1726
|
-
"summary": "publishBlueprint",
|
|
1727
|
-
"description": "Publish a blueprint to the marketplace. Exports the blueprint, uploads it to file-api with public access, and updates the Webflow CMS listing.\n",
|
|
1683
|
+
},
|
|
1684
|
+
"delete": {
|
|
1685
|
+
"operationId": "bulkDeleteBlueprintResources",
|
|
1686
|
+
"summary": "bulkDeleteBlueprintResources",
|
|
1687
|
+
"description": "Bulk delete resources in a Blueprint",
|
|
1728
1688
|
"tags": [
|
|
1729
1689
|
"Blueprints"
|
|
1730
1690
|
],
|
|
1691
|
+
"parameters": [
|
|
1692
|
+
{
|
|
1693
|
+
"in": "path",
|
|
1694
|
+
"required": true,
|
|
1695
|
+
"name": "blueprint_id",
|
|
1696
|
+
"schema": {
|
|
1697
|
+
"$ref": "#/components/schemas/BlueprintID"
|
|
1698
|
+
}
|
|
1699
|
+
}
|
|
1700
|
+
],
|
|
1731
1701
|
"requestBody": {
|
|
1732
|
-
"required": true,
|
|
1733
1702
|
"content": {
|
|
1734
1703
|
"application/json": {
|
|
1735
1704
|
"schema": {
|
|
1736
|
-
"type": "
|
|
1737
|
-
"
|
|
1738
|
-
"
|
|
1739
|
-
"slug"
|
|
1740
|
-
],
|
|
1741
|
-
"properties": {
|
|
1742
|
-
"blueprint_id": {
|
|
1743
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
1744
|
-
},
|
|
1745
|
-
"slug": {
|
|
1746
|
-
"type": "string",
|
|
1747
|
-
"description": "The marketplace installation slug for the Webflow CMS item"
|
|
1748
|
-
},
|
|
1749
|
-
"version": {
|
|
1750
|
-
"type": "string",
|
|
1751
|
-
"description": "The version string to set on the marketplace CMS item (e.g. \"1.0.0\")"
|
|
1752
|
-
},
|
|
1753
|
-
"name": {
|
|
1754
|
-
"type": "string",
|
|
1755
|
-
"description": "The display name for the blueprint on the marketplace CMS item"
|
|
1756
|
-
}
|
|
1705
|
+
"type": "array",
|
|
1706
|
+
"items": {
|
|
1707
|
+
"$ref": "#/components/schemas/BlueprintResourceID"
|
|
1757
1708
|
}
|
|
1758
1709
|
}
|
|
1759
1710
|
}
|
|
1760
1711
|
}
|
|
1761
1712
|
},
|
|
1762
1713
|
"responses": {
|
|
1763
|
-
"
|
|
1764
|
-
"description": "
|
|
1765
|
-
"headers": {
|
|
1766
|
-
"Location": {
|
|
1767
|
-
"description": "URL to poll the job",
|
|
1768
|
-
"schema": {
|
|
1769
|
-
"type": "string"
|
|
1770
|
-
}
|
|
1771
|
-
}
|
|
1772
|
-
},
|
|
1714
|
+
"200": {
|
|
1715
|
+
"description": "Bulk deleted Blueprint Resources",
|
|
1773
1716
|
"content": {
|
|
1774
1717
|
"application/json": {
|
|
1775
1718
|
"schema": {
|
|
1776
1719
|
"type": "object",
|
|
1777
1720
|
"properties": {
|
|
1778
|
-
"
|
|
1779
|
-
"
|
|
1721
|
+
"resources": {
|
|
1722
|
+
"type": "array",
|
|
1723
|
+
"items": {
|
|
1724
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1725
|
+
}
|
|
1780
1726
|
}
|
|
1781
1727
|
}
|
|
1782
1728
|
}
|
|
@@ -1786,11 +1732,11 @@
|
|
|
1786
1732
|
}
|
|
1787
1733
|
}
|
|
1788
1734
|
},
|
|
1789
|
-
"/v2/blueprint-manifest/blueprints/{blueprint_id}
|
|
1790
|
-
"
|
|
1791
|
-
"operationId": "
|
|
1792
|
-
"summary": "
|
|
1793
|
-
"description": "
|
|
1735
|
+
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}": {
|
|
1736
|
+
"put": {
|
|
1737
|
+
"operationId": "updateBlueprintResource",
|
|
1738
|
+
"summary": "updateBlueprintResource",
|
|
1739
|
+
"description": "Update a resource in a Blueprint",
|
|
1794
1740
|
"tags": [
|
|
1795
1741
|
"Blueprints"
|
|
1796
1742
|
],
|
|
@@ -1802,38 +1748,38 @@
|
|
|
1802
1748
|
"schema": {
|
|
1803
1749
|
"$ref": "#/components/schemas/BlueprintID"
|
|
1804
1750
|
}
|
|
1751
|
+
},
|
|
1752
|
+
{
|
|
1753
|
+
"in": "path",
|
|
1754
|
+
"required": true,
|
|
1755
|
+
"name": "resource_id",
|
|
1756
|
+
"schema": {
|
|
1757
|
+
"$ref": "#/components/schemas/BlueprintResourceID"
|
|
1758
|
+
}
|
|
1805
1759
|
}
|
|
1806
1760
|
],
|
|
1807
1761
|
"requestBody": {
|
|
1808
|
-
"required": true,
|
|
1809
1762
|
"content": {
|
|
1810
1763
|
"application/json": {
|
|
1811
1764
|
"schema": {
|
|
1812
|
-
"
|
|
1813
|
-
"required": [
|
|
1814
|
-
"text"
|
|
1815
|
-
],
|
|
1816
|
-
"properties": {
|
|
1817
|
-
"text": {
|
|
1818
|
-
"type": "string",
|
|
1819
|
-
"description": "Plain text to format as markdown"
|
|
1820
|
-
}
|
|
1821
|
-
}
|
|
1765
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1822
1766
|
}
|
|
1823
1767
|
}
|
|
1824
1768
|
}
|
|
1825
1769
|
},
|
|
1826
1770
|
"responses": {
|
|
1827
1771
|
"200": {
|
|
1828
|
-
"description": "
|
|
1772
|
+
"description": "Updated Blueprint Resource",
|
|
1829
1773
|
"content": {
|
|
1830
1774
|
"application/json": {
|
|
1831
1775
|
"schema": {
|
|
1832
1776
|
"type": "object",
|
|
1833
1777
|
"properties": {
|
|
1834
|
-
"
|
|
1835
|
-
"type": "
|
|
1836
|
-
"
|
|
1778
|
+
"resources": {
|
|
1779
|
+
"type": "array",
|
|
1780
|
+
"items": {
|
|
1781
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1782
|
+
}
|
|
1837
1783
|
}
|
|
1838
1784
|
}
|
|
1839
1785
|
}
|
|
@@ -1841,45 +1787,11 @@
|
|
|
1841
1787
|
}
|
|
1842
1788
|
}
|
|
1843
1789
|
}
|
|
1844
|
-
}
|
|
1845
|
-
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
"
|
|
1849
|
-
"summary": "suggestBlueprintResources",
|
|
1850
|
-
"description": "Suggest resources to add to a blueprint based on a natural-language prompt.\n\nWalks anchor resource types in priority order (journey > workflow_definition >\nautomation_flow > schema > entity-backed types) and returns matches per\nanchor using each upstream API's text search. Suggestions are marked\n`is_root: true` so callers can pass `add_dependencies=true` to\nbulkAddBlueprintResources and have transitive dependencies resolved\nserver-side — which means a single matched journey can stand in for its\nfull product/schema/template bundle.\n\nNo side effects on the blueprint — the caller persists the chosen resources\nvia the existing create/bulk-add endpoints.\n",
|
|
1851
|
-
"tags": [
|
|
1852
|
-
"Blueprints"
|
|
1853
|
-
],
|
|
1854
|
-
"requestBody": {
|
|
1855
|
-
"required": true,
|
|
1856
|
-
"content": {
|
|
1857
|
-
"application/json": {
|
|
1858
|
-
"schema": {
|
|
1859
|
-
"$ref": "#/components/schemas/SuggestBlueprintResourcesRequest"
|
|
1860
|
-
}
|
|
1861
|
-
}
|
|
1862
|
-
}
|
|
1863
|
-
},
|
|
1864
|
-
"responses": {
|
|
1865
|
-
"200": {
|
|
1866
|
-
"description": "Suggested resources",
|
|
1867
|
-
"content": {
|
|
1868
|
-
"application/json": {
|
|
1869
|
-
"schema": {
|
|
1870
|
-
"$ref": "#/components/schemas/SuggestBlueprintResourcesResponse"
|
|
1871
|
-
}
|
|
1872
|
-
}
|
|
1873
|
-
}
|
|
1874
|
-
}
|
|
1875
|
-
}
|
|
1876
|
-
}
|
|
1877
|
-
},
|
|
1878
|
-
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources": {
|
|
1879
|
-
"post": {
|
|
1880
|
-
"operationId": "addBlueprintResource",
|
|
1881
|
-
"summary": "addBlueprintResource",
|
|
1882
|
-
"description": "Add a resource to a Blueprint",
|
|
1790
|
+
},
|
|
1791
|
+
"delete": {
|
|
1792
|
+
"operationId": "deleteBlueprintResource",
|
|
1793
|
+
"summary": "deleteBlueprintResource",
|
|
1794
|
+
"description": "Delete a resource from a Blueprint",
|
|
1883
1795
|
"tags": [
|
|
1884
1796
|
"Blueprints"
|
|
1885
1797
|
],
|
|
@@ -1893,27 +1805,17 @@
|
|
|
1893
1805
|
}
|
|
1894
1806
|
},
|
|
1895
1807
|
{
|
|
1896
|
-
"in": "
|
|
1897
|
-
"
|
|
1808
|
+
"in": "path",
|
|
1809
|
+
"required": true,
|
|
1810
|
+
"name": "resource_id",
|
|
1898
1811
|
"schema": {
|
|
1899
|
-
"
|
|
1900
|
-
"default": false,
|
|
1901
|
-
"description": "Whether to add this resource dependencies to the blueprint automatically"
|
|
1812
|
+
"$ref": "#/components/schemas/BlueprintResourceID"
|
|
1902
1813
|
}
|
|
1903
1814
|
}
|
|
1904
1815
|
],
|
|
1905
|
-
"requestBody": {
|
|
1906
|
-
"content": {
|
|
1907
|
-
"application/json": {
|
|
1908
|
-
"schema": {
|
|
1909
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
1910
|
-
}
|
|
1911
|
-
}
|
|
1912
|
-
}
|
|
1913
|
-
},
|
|
1914
1816
|
"responses": {
|
|
1915
1817
|
"200": {
|
|
1916
|
-
"description": "
|
|
1818
|
+
"description": "Deleted Blueprint Resource",
|
|
1917
1819
|
"content": {
|
|
1918
1820
|
"application/json": {
|
|
1919
1821
|
"schema": {
|
|
@@ -1933,42 +1835,31 @@
|
|
|
1933
1835
|
}
|
|
1934
1836
|
}
|
|
1935
1837
|
},
|
|
1936
|
-
"/v2/blueprint-manifest/
|
|
1937
|
-
"
|
|
1938
|
-
"operationId": "
|
|
1939
|
-
"summary": "
|
|
1940
|
-
"description": "
|
|
1838
|
+
"/v2/blueprint-manifest/jobs": {
|
|
1839
|
+
"get": {
|
|
1840
|
+
"operationId": "listBlueprintJobs",
|
|
1841
|
+
"summary": "List Blueprint Jobs",
|
|
1842
|
+
"description": "List all blueprint jobs",
|
|
1941
1843
|
"tags": [
|
|
1942
|
-
"
|
|
1943
|
-
],
|
|
1944
|
-
"parameters": [
|
|
1945
|
-
{
|
|
1946
|
-
"in": "path",
|
|
1947
|
-
"required": true,
|
|
1948
|
-
"name": "blueprint_id",
|
|
1949
|
-
"schema": {
|
|
1950
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
1951
|
-
}
|
|
1952
|
-
}
|
|
1844
|
+
"Jobs"
|
|
1953
1845
|
],
|
|
1954
1846
|
"responses": {
|
|
1955
|
-
"
|
|
1956
|
-
"description": "
|
|
1957
|
-
"headers": {
|
|
1958
|
-
"Location": {
|
|
1959
|
-
"description": "URL to poll the job",
|
|
1960
|
-
"schema": {
|
|
1961
|
-
"type": "string"
|
|
1962
|
-
}
|
|
1963
|
-
}
|
|
1964
|
-
},
|
|
1847
|
+
"200": {
|
|
1848
|
+
"description": "Blueprint jobs",
|
|
1965
1849
|
"content": {
|
|
1966
1850
|
"application/json": {
|
|
1967
1851
|
"schema": {
|
|
1968
1852
|
"type": "object",
|
|
1969
1853
|
"properties": {
|
|
1970
|
-
"
|
|
1971
|
-
"
|
|
1854
|
+
"total": {
|
|
1855
|
+
"type": "integer",
|
|
1856
|
+
"example": 1
|
|
1857
|
+
},
|
|
1858
|
+
"results": {
|
|
1859
|
+
"type": "array",
|
|
1860
|
+
"items": {
|
|
1861
|
+
"$ref": "#/components/schemas/BlueprintJob"
|
|
1862
|
+
}
|
|
1972
1863
|
}
|
|
1973
1864
|
}
|
|
1974
1865
|
}
|
|
@@ -1978,160 +1869,105 @@
|
|
|
1978
1869
|
}
|
|
1979
1870
|
}
|
|
1980
1871
|
},
|
|
1981
|
-
"/v2/blueprint-manifest/
|
|
1982
|
-
"
|
|
1983
|
-
"operationId": "
|
|
1984
|
-
"summary": "
|
|
1985
|
-
"description": "
|
|
1872
|
+
"/v2/blueprint-manifest/jobs/{job_id}": {
|
|
1873
|
+
"get": {
|
|
1874
|
+
"operationId": "getBlueprintJob",
|
|
1875
|
+
"summary": "Get Job",
|
|
1876
|
+
"description": "Poll current state of a job.",
|
|
1986
1877
|
"tags": [
|
|
1987
|
-
"
|
|
1878
|
+
"Jobs"
|
|
1988
1879
|
],
|
|
1989
1880
|
"parameters": [
|
|
1990
1881
|
{
|
|
1991
1882
|
"in": "path",
|
|
1992
1883
|
"required": true,
|
|
1993
|
-
"name": "
|
|
1994
|
-
"schema": {
|
|
1995
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
1996
|
-
}
|
|
1997
|
-
},
|
|
1998
|
-
{
|
|
1999
|
-
"in": "query",
|
|
2000
|
-
"name": "add_dependencies",
|
|
1884
|
+
"name": "job_id",
|
|
2001
1885
|
"schema": {
|
|
2002
|
-
"
|
|
2003
|
-
"default": false,
|
|
2004
|
-
"description": "Whether to add this resource dependencies to the blueprint automatically"
|
|
1886
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
2005
1887
|
}
|
|
2006
1888
|
}
|
|
2007
1889
|
],
|
|
2008
|
-
"requestBody": {
|
|
2009
|
-
"content": {
|
|
2010
|
-
"application/json": {
|
|
2011
|
-
"schema": {
|
|
2012
|
-
"type": "array",
|
|
2013
|
-
"items": {
|
|
2014
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
2015
|
-
}
|
|
2016
|
-
}
|
|
2017
|
-
}
|
|
2018
|
-
}
|
|
2019
|
-
},
|
|
2020
1890
|
"responses": {
|
|
2021
1891
|
"200": {
|
|
2022
|
-
"description": "
|
|
1892
|
+
"description": "Job status",
|
|
2023
1893
|
"content": {
|
|
2024
1894
|
"application/json": {
|
|
2025
1895
|
"schema": {
|
|
2026
|
-
"
|
|
2027
|
-
"properties": {
|
|
2028
|
-
"resources": {
|
|
2029
|
-
"type": "array",
|
|
2030
|
-
"items": {
|
|
2031
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
2032
|
-
}
|
|
2033
|
-
}
|
|
2034
|
-
}
|
|
1896
|
+
"$ref": "#/components/schemas/BlueprintJob"
|
|
2035
1897
|
}
|
|
2036
1898
|
}
|
|
2037
1899
|
}
|
|
2038
1900
|
}
|
|
2039
1901
|
}
|
|
2040
|
-
}
|
|
2041
|
-
|
|
2042
|
-
|
|
2043
|
-
|
|
2044
|
-
"
|
|
1902
|
+
}
|
|
1903
|
+
},
|
|
1904
|
+
"/v2/blueprint-manifest/jobs/{job_id}:continue": {
|
|
1905
|
+
"post": {
|
|
1906
|
+
"operationId": "continueInstallationJob",
|
|
1907
|
+
"summary": "Continue Installation Job",
|
|
1908
|
+
"description": "Continue an installation job if it is waiting for user action.",
|
|
2045
1909
|
"tags": [
|
|
2046
|
-
"
|
|
1910
|
+
"Jobs"
|
|
2047
1911
|
],
|
|
2048
1912
|
"parameters": [
|
|
2049
1913
|
{
|
|
2050
1914
|
"in": "path",
|
|
2051
1915
|
"required": true,
|
|
2052
|
-
"name": "
|
|
1916
|
+
"name": "job_id",
|
|
2053
1917
|
"schema": {
|
|
2054
|
-
"$ref": "#/components/schemas/
|
|
1918
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
2055
1919
|
}
|
|
2056
1920
|
}
|
|
2057
1921
|
],
|
|
2058
1922
|
"requestBody": {
|
|
1923
|
+
"required": false,
|
|
2059
1924
|
"content": {
|
|
2060
1925
|
"application/json": {
|
|
2061
1926
|
"schema": {
|
|
2062
|
-
"
|
|
2063
|
-
"items": {
|
|
2064
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
2065
|
-
}
|
|
1927
|
+
"$ref": "#/components/schemas/BlueprintInstallationJobOptions"
|
|
2066
1928
|
}
|
|
2067
1929
|
}
|
|
2068
1930
|
}
|
|
2069
1931
|
},
|
|
2070
1932
|
"responses": {
|
|
2071
1933
|
"200": {
|
|
2072
|
-
"description": "
|
|
1934
|
+
"description": "Blueprint installation job continued",
|
|
2073
1935
|
"content": {
|
|
2074
1936
|
"application/json": {
|
|
2075
1937
|
"schema": {
|
|
2076
|
-
"
|
|
2077
|
-
"properties": {
|
|
2078
|
-
"resources": {
|
|
2079
|
-
"type": "array",
|
|
2080
|
-
"items": {
|
|
2081
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
2082
|
-
}
|
|
2083
|
-
}
|
|
2084
|
-
}
|
|
1938
|
+
"$ref": "#/components/schemas/BlueprintInstallationJob"
|
|
2085
1939
|
}
|
|
2086
1940
|
}
|
|
2087
1941
|
}
|
|
2088
1942
|
}
|
|
2089
1943
|
}
|
|
2090
|
-
}
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
"
|
|
1944
|
+
}
|
|
1945
|
+
},
|
|
1946
|
+
"/v2/blueprint-manifest/jobs/{job_id}:cancel": {
|
|
1947
|
+
"post": {
|
|
1948
|
+
"operationId": "cancelBlueprintJob",
|
|
1949
|
+
"summary": "Cancel Blueprint Job",
|
|
1950
|
+
"description": "Cancel a blueprint job if it is still running.",
|
|
2095
1951
|
"tags": [
|
|
2096
|
-
"
|
|
1952
|
+
"Jobs"
|
|
2097
1953
|
],
|
|
2098
1954
|
"parameters": [
|
|
2099
1955
|
{
|
|
2100
1956
|
"in": "path",
|
|
2101
1957
|
"required": true,
|
|
2102
|
-
"name": "
|
|
1958
|
+
"name": "job_id",
|
|
2103
1959
|
"schema": {
|
|
2104
|
-
"$ref": "#/components/schemas/
|
|
1960
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
2105
1961
|
}
|
|
2106
1962
|
}
|
|
2107
1963
|
],
|
|
2108
|
-
"requestBody": {
|
|
2109
|
-
"content": {
|
|
2110
|
-
"application/json": {
|
|
2111
|
-
"schema": {
|
|
2112
|
-
"type": "array",
|
|
2113
|
-
"items": {
|
|
2114
|
-
"$ref": "#/components/schemas/BlueprintResourceID"
|
|
2115
|
-
}
|
|
2116
|
-
}
|
|
2117
|
-
}
|
|
2118
|
-
}
|
|
2119
|
-
},
|
|
2120
1964
|
"responses": {
|
|
2121
1965
|
"200": {
|
|
2122
|
-
"description": "
|
|
1966
|
+
"description": "Blueprint job cancelled",
|
|
2123
1967
|
"content": {
|
|
2124
1968
|
"application/json": {
|
|
2125
1969
|
"schema": {
|
|
2126
|
-
"
|
|
2127
|
-
"properties": {
|
|
2128
|
-
"resources": {
|
|
2129
|
-
"type": "array",
|
|
2130
|
-
"items": {
|
|
2131
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
2132
|
-
}
|
|
2133
|
-
}
|
|
2134
|
-
}
|
|
1970
|
+
"$ref": "#/components/schemas/BlueprintJob"
|
|
2135
1971
|
}
|
|
2136
1972
|
}
|
|
2137
1973
|
}
|
|
@@ -2139,264 +1975,21 @@
|
|
|
2139
1975
|
}
|
|
2140
1976
|
}
|
|
2141
1977
|
},
|
|
2142
|
-
"/
|
|
2143
|
-
"
|
|
2144
|
-
"operationId": "
|
|
2145
|
-
"summary": "
|
|
2146
|
-
"description": "
|
|
1978
|
+
"/v1/blueprints/{blueprint_id}/marketplace-listing": {
|
|
1979
|
+
"post": {
|
|
1980
|
+
"operationId": "createMarketplaceListing",
|
|
1981
|
+
"summary": "createMarketplaceListing",
|
|
1982
|
+
"description": "Create a marketplace listing for a blueprint. Returns 409 if one already exists.",
|
|
2147
1983
|
"tags": [
|
|
2148
|
-
"
|
|
1984
|
+
"Marketplace Listings"
|
|
2149
1985
|
],
|
|
2150
1986
|
"parameters": [
|
|
2151
1987
|
{
|
|
1988
|
+
"name": "blueprint_id",
|
|
2152
1989
|
"in": "path",
|
|
2153
1990
|
"required": true,
|
|
2154
|
-
"name": "blueprint_id",
|
|
2155
1991
|
"schema": {
|
|
2156
|
-
"
|
|
2157
|
-
}
|
|
2158
|
-
},
|
|
2159
|
-
{
|
|
2160
|
-
"in": "path",
|
|
2161
|
-
"required": true,
|
|
2162
|
-
"name": "resource_id",
|
|
2163
|
-
"schema": {
|
|
2164
|
-
"$ref": "#/components/schemas/BlueprintResourceID"
|
|
2165
|
-
}
|
|
2166
|
-
}
|
|
2167
|
-
],
|
|
2168
|
-
"requestBody": {
|
|
2169
|
-
"content": {
|
|
2170
|
-
"application/json": {
|
|
2171
|
-
"schema": {
|
|
2172
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
2173
|
-
}
|
|
2174
|
-
}
|
|
2175
|
-
}
|
|
2176
|
-
},
|
|
2177
|
-
"responses": {
|
|
2178
|
-
"200": {
|
|
2179
|
-
"description": "Updated Blueprint Resource",
|
|
2180
|
-
"content": {
|
|
2181
|
-
"application/json": {
|
|
2182
|
-
"schema": {
|
|
2183
|
-
"type": "object",
|
|
2184
|
-
"properties": {
|
|
2185
|
-
"resources": {
|
|
2186
|
-
"type": "array",
|
|
2187
|
-
"items": {
|
|
2188
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
2189
|
-
}
|
|
2190
|
-
}
|
|
2191
|
-
}
|
|
2192
|
-
}
|
|
2193
|
-
}
|
|
2194
|
-
}
|
|
2195
|
-
}
|
|
2196
|
-
}
|
|
2197
|
-
},
|
|
2198
|
-
"delete": {
|
|
2199
|
-
"operationId": "deleteBlueprintResource",
|
|
2200
|
-
"summary": "deleteBlueprintResource",
|
|
2201
|
-
"description": "Delete a resource from a Blueprint",
|
|
2202
|
-
"tags": [
|
|
2203
|
-
"Blueprints"
|
|
2204
|
-
],
|
|
2205
|
-
"parameters": [
|
|
2206
|
-
{
|
|
2207
|
-
"in": "path",
|
|
2208
|
-
"required": true,
|
|
2209
|
-
"name": "blueprint_id",
|
|
2210
|
-
"schema": {
|
|
2211
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
2212
|
-
}
|
|
2213
|
-
},
|
|
2214
|
-
{
|
|
2215
|
-
"in": "path",
|
|
2216
|
-
"required": true,
|
|
2217
|
-
"name": "resource_id",
|
|
2218
|
-
"schema": {
|
|
2219
|
-
"$ref": "#/components/schemas/BlueprintResourceID"
|
|
2220
|
-
}
|
|
2221
|
-
}
|
|
2222
|
-
],
|
|
2223
|
-
"responses": {
|
|
2224
|
-
"200": {
|
|
2225
|
-
"description": "Deleted Blueprint Resource",
|
|
2226
|
-
"content": {
|
|
2227
|
-
"application/json": {
|
|
2228
|
-
"schema": {
|
|
2229
|
-
"type": "object",
|
|
2230
|
-
"properties": {
|
|
2231
|
-
"resources": {
|
|
2232
|
-
"type": "array",
|
|
2233
|
-
"items": {
|
|
2234
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
2235
|
-
}
|
|
2236
|
-
}
|
|
2237
|
-
}
|
|
2238
|
-
}
|
|
2239
|
-
}
|
|
2240
|
-
}
|
|
2241
|
-
}
|
|
2242
|
-
}
|
|
2243
|
-
}
|
|
2244
|
-
},
|
|
2245
|
-
"/v2/blueprint-manifest/jobs": {
|
|
2246
|
-
"get": {
|
|
2247
|
-
"operationId": "listBlueprintJobs",
|
|
2248
|
-
"summary": "List Blueprint Jobs",
|
|
2249
|
-
"description": "List all blueprint jobs",
|
|
2250
|
-
"tags": [
|
|
2251
|
-
"Jobs"
|
|
2252
|
-
],
|
|
2253
|
-
"responses": {
|
|
2254
|
-
"200": {
|
|
2255
|
-
"description": "Blueprint jobs",
|
|
2256
|
-
"content": {
|
|
2257
|
-
"application/json": {
|
|
2258
|
-
"schema": {
|
|
2259
|
-
"type": "object",
|
|
2260
|
-
"properties": {
|
|
2261
|
-
"total": {
|
|
2262
|
-
"type": "integer",
|
|
2263
|
-
"example": 1
|
|
2264
|
-
},
|
|
2265
|
-
"results": {
|
|
2266
|
-
"type": "array",
|
|
2267
|
-
"items": {
|
|
2268
|
-
"$ref": "#/components/schemas/BlueprintJob"
|
|
2269
|
-
}
|
|
2270
|
-
}
|
|
2271
|
-
}
|
|
2272
|
-
}
|
|
2273
|
-
}
|
|
2274
|
-
}
|
|
2275
|
-
}
|
|
2276
|
-
}
|
|
2277
|
-
}
|
|
2278
|
-
},
|
|
2279
|
-
"/v2/blueprint-manifest/jobs/{job_id}": {
|
|
2280
|
-
"get": {
|
|
2281
|
-
"operationId": "getBlueprintJob",
|
|
2282
|
-
"summary": "Get Job",
|
|
2283
|
-
"description": "Poll current state of a job.",
|
|
2284
|
-
"tags": [
|
|
2285
|
-
"Jobs"
|
|
2286
|
-
],
|
|
2287
|
-
"parameters": [
|
|
2288
|
-
{
|
|
2289
|
-
"in": "path",
|
|
2290
|
-
"required": true,
|
|
2291
|
-
"name": "job_id",
|
|
2292
|
-
"schema": {
|
|
2293
|
-
"$ref": "#/components/schemas/BlueprintJobID"
|
|
2294
|
-
}
|
|
2295
|
-
}
|
|
2296
|
-
],
|
|
2297
|
-
"responses": {
|
|
2298
|
-
"200": {
|
|
2299
|
-
"description": "Job status",
|
|
2300
|
-
"content": {
|
|
2301
|
-
"application/json": {
|
|
2302
|
-
"schema": {
|
|
2303
|
-
"$ref": "#/components/schemas/BlueprintJob"
|
|
2304
|
-
}
|
|
2305
|
-
}
|
|
2306
|
-
}
|
|
2307
|
-
}
|
|
2308
|
-
}
|
|
2309
|
-
}
|
|
2310
|
-
},
|
|
2311
|
-
"/v2/blueprint-manifest/jobs/{job_id}:continue": {
|
|
2312
|
-
"post": {
|
|
2313
|
-
"operationId": "continueInstallationJob",
|
|
2314
|
-
"summary": "Continue Installation Job",
|
|
2315
|
-
"description": "Continue an installation job if it is waiting for user action.",
|
|
2316
|
-
"tags": [
|
|
2317
|
-
"Jobs"
|
|
2318
|
-
],
|
|
2319
|
-
"parameters": [
|
|
2320
|
-
{
|
|
2321
|
-
"in": "path",
|
|
2322
|
-
"required": true,
|
|
2323
|
-
"name": "job_id",
|
|
2324
|
-
"schema": {
|
|
2325
|
-
"$ref": "#/components/schemas/BlueprintJobID"
|
|
2326
|
-
}
|
|
2327
|
-
}
|
|
2328
|
-
],
|
|
2329
|
-
"requestBody": {
|
|
2330
|
-
"required": false,
|
|
2331
|
-
"content": {
|
|
2332
|
-
"application/json": {
|
|
2333
|
-
"schema": {
|
|
2334
|
-
"$ref": "#/components/schemas/BlueprintInstallationJobOptions"
|
|
2335
|
-
}
|
|
2336
|
-
}
|
|
2337
|
-
}
|
|
2338
|
-
},
|
|
2339
|
-
"responses": {
|
|
2340
|
-
"200": {
|
|
2341
|
-
"description": "Blueprint installation job continued",
|
|
2342
|
-
"content": {
|
|
2343
|
-
"application/json": {
|
|
2344
|
-
"schema": {
|
|
2345
|
-
"$ref": "#/components/schemas/BlueprintInstallationJob"
|
|
2346
|
-
}
|
|
2347
|
-
}
|
|
2348
|
-
}
|
|
2349
|
-
}
|
|
2350
|
-
}
|
|
2351
|
-
}
|
|
2352
|
-
},
|
|
2353
|
-
"/v2/blueprint-manifest/jobs/{job_id}:cancel": {
|
|
2354
|
-
"post": {
|
|
2355
|
-
"operationId": "cancelBlueprintJob",
|
|
2356
|
-
"summary": "Cancel Blueprint Job",
|
|
2357
|
-
"description": "Cancel a blueprint job if it is still running.",
|
|
2358
|
-
"tags": [
|
|
2359
|
-
"Jobs"
|
|
2360
|
-
],
|
|
2361
|
-
"parameters": [
|
|
2362
|
-
{
|
|
2363
|
-
"in": "path",
|
|
2364
|
-
"required": true,
|
|
2365
|
-
"name": "job_id",
|
|
2366
|
-
"schema": {
|
|
2367
|
-
"$ref": "#/components/schemas/BlueprintJobID"
|
|
2368
|
-
}
|
|
2369
|
-
}
|
|
2370
|
-
],
|
|
2371
|
-
"responses": {
|
|
2372
|
-
"200": {
|
|
2373
|
-
"description": "Blueprint job cancelled",
|
|
2374
|
-
"content": {
|
|
2375
|
-
"application/json": {
|
|
2376
|
-
"schema": {
|
|
2377
|
-
"$ref": "#/components/schemas/BlueprintJob"
|
|
2378
|
-
}
|
|
2379
|
-
}
|
|
2380
|
-
}
|
|
2381
|
-
}
|
|
2382
|
-
}
|
|
2383
|
-
}
|
|
2384
|
-
},
|
|
2385
|
-
"/v1/blueprints/{blueprint_id}/marketplace-listing": {
|
|
2386
|
-
"post": {
|
|
2387
|
-
"operationId": "createMarketplaceListing",
|
|
2388
|
-
"summary": "createMarketplaceListing",
|
|
2389
|
-
"description": "Create a marketplace listing for a blueprint. Returns 409 if one already exists.",
|
|
2390
|
-
"tags": [
|
|
2391
|
-
"Marketplace Listings"
|
|
2392
|
-
],
|
|
2393
|
-
"parameters": [
|
|
2394
|
-
{
|
|
2395
|
-
"name": "blueprint_id",
|
|
2396
|
-
"in": "path",
|
|
2397
|
-
"required": true,
|
|
2398
|
-
"schema": {
|
|
2399
|
-
"type": "string"
|
|
1992
|
+
"type": "string"
|
|
2400
1993
|
}
|
|
2401
1994
|
}
|
|
2402
1995
|
],
|
|
@@ -2875,21 +2468,6 @@
|
|
|
2875
2468
|
"application/json": {
|
|
2876
2469
|
"schema": {
|
|
2877
2470
|
"type": "object",
|
|
2878
|
-
"oneOf": [
|
|
2879
|
-
{
|
|
2880
|
-
"required": [
|
|
2881
|
-
"source_org_id",
|
|
2882
|
-
"source_blueprint_id",
|
|
2883
|
-
"destination_org_id"
|
|
2884
|
-
]
|
|
2885
|
-
},
|
|
2886
|
-
{
|
|
2887
|
-
"required": [
|
|
2888
|
-
"source_blueprint_file",
|
|
2889
|
-
"destination_org_id"
|
|
2890
|
-
]
|
|
2891
|
-
}
|
|
2892
|
-
],
|
|
2893
2471
|
"properties": {
|
|
2894
2472
|
"source_org_id": {
|
|
2895
2473
|
"type": "string"
|
|
@@ -2949,133 +2527,6 @@
|
|
|
2949
2527
|
}
|
|
2950
2528
|
}
|
|
2951
2529
|
}
|
|
2952
|
-
},
|
|
2953
|
-
"400": {
|
|
2954
|
-
"description": "Missing required source or destination fields",
|
|
2955
|
-
"content": {
|
|
2956
|
-
"application/json": {
|
|
2957
|
-
"schema": {
|
|
2958
|
-
"type": "object",
|
|
2959
|
-
"properties": {
|
|
2960
|
-
"message": {
|
|
2961
|
-
"type": "string"
|
|
2962
|
-
}
|
|
2963
|
-
}
|
|
2964
|
-
}
|
|
2965
|
-
}
|
|
2966
|
-
}
|
|
2967
|
-
}
|
|
2968
|
-
}
|
|
2969
|
-
}
|
|
2970
|
-
},
|
|
2971
|
-
"/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:restore": {
|
|
2972
|
-
"post": {
|
|
2973
|
-
"operationId": "restoreBlueprintDeploymentV3",
|
|
2974
|
-
"summary": "Restore a specific deployment by job_id",
|
|
2975
|
-
"description": "Roll a deployment back to its pre-install state. Two phases:\n\n 1. Upsert — re-applies the captured payloads via snapshot-api's\n `:restore` (server-side; runs config-engine.apply with captured\n target ids pre-seeded). Skipped for pure-create deployments\n whose snapshot was empty.\n 2. Delete sweep — for lineage rows of this blueprint instance not\n present in the snapshot's captured set, deletes the live\n resource via the type's adapter. Co-ownership / drift /\n no-delete-capability skip the entry with the corresponding\n reason.\n\nResolves `(blueprint_id, job_id)` to the entry in\n`Blueprint.deployments[]` and reads its `snapshot_id` and\n`destination_blueprint_id` — the caller never needs to handle\nsnapshot ids directly.\n\nAsync — returns 202 with a job id. Poll the job to track progress.\nThe per-instance lock (`installation_status === 'IN_PROGRESS'`)\nrejects concurrent installs or restores with 409.\n",
|
|
2976
|
-
"tags": [
|
|
2977
|
-
"Blueprints"
|
|
2978
|
-
],
|
|
2979
|
-
"parameters": [
|
|
2980
|
-
{
|
|
2981
|
-
"in": "path",
|
|
2982
|
-
"name": "blueprint_id",
|
|
2983
|
-
"required": true,
|
|
2984
|
-
"schema": {
|
|
2985
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
2986
|
-
}
|
|
2987
|
-
},
|
|
2988
|
-
{
|
|
2989
|
-
"in": "path",
|
|
2990
|
-
"name": "job_id",
|
|
2991
|
-
"required": true,
|
|
2992
|
-
"schema": {
|
|
2993
|
-
"$ref": "#/components/schemas/BlueprintJobID"
|
|
2994
|
-
}
|
|
2995
|
-
}
|
|
2996
|
-
],
|
|
2997
|
-
"responses": {
|
|
2998
|
-
"202": {
|
|
2999
|
-
"description": "Restore job started",
|
|
3000
|
-
"headers": {
|
|
3001
|
-
"Location": {
|
|
3002
|
-
"description": "URL to poll the job",
|
|
3003
|
-
"schema": {
|
|
3004
|
-
"type": "string"
|
|
3005
|
-
}
|
|
3006
|
-
}
|
|
3007
|
-
},
|
|
3008
|
-
"content": {
|
|
3009
|
-
"application/json": {
|
|
3010
|
-
"schema": {
|
|
3011
|
-
"type": "object",
|
|
3012
|
-
"properties": {
|
|
3013
|
-
"job_id": {
|
|
3014
|
-
"$ref": "#/components/schemas/BlueprintJobID"
|
|
3015
|
-
},
|
|
3016
|
-
"blueprint_instance_id": {
|
|
3017
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
3018
|
-
},
|
|
3019
|
-
"snapshot_id": {
|
|
3020
|
-
"type": "string"
|
|
3021
|
-
}
|
|
3022
|
-
}
|
|
3023
|
-
}
|
|
3024
|
-
}
|
|
3025
|
-
}
|
|
3026
|
-
},
|
|
3027
|
-
"400": {
|
|
3028
|
-
"description": "Deployment has no snapshot, or the snapshot is not in a `completed` state."
|
|
3029
|
-
},
|
|
3030
|
-
"404": {
|
|
3031
|
-
"description": "Blueprint not found, or no deployment with the given job_id on this blueprint."
|
|
3032
|
-
},
|
|
3033
|
-
"409": {
|
|
3034
|
-
"description": "Another install or restore is in flight for this blueprint instance."
|
|
3035
|
-
}
|
|
3036
|
-
}
|
|
3037
|
-
}
|
|
3038
|
-
},
|
|
3039
|
-
"/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/restore-preview": {
|
|
3040
|
-
"get": {
|
|
3041
|
-
"operationId": "getRestorePreview",
|
|
3042
|
-
"summary": "Predicted outcome of reverting a deployment",
|
|
3043
|
-
"description": "Computes what would happen if the user triggered a restore on this\ndeployment, without performing any writes. The forecast uses the\nsnapshot's captured resources (when present) plus the current lineage\nstate plus per-adapter gates (co-ownership, no-delete-capability,\nheuristic-match, drift when wired).\n\nIdempotent and side-effect free. Safe to call repeatedly. The result\nmay shift between calls if operators edit destination resources or\nanother blueprint adopts a shared resource in the meantime.\n",
|
|
3044
|
-
"tags": [
|
|
3045
|
-
"Blueprints"
|
|
3046
|
-
],
|
|
3047
|
-
"parameters": [
|
|
3048
|
-
{
|
|
3049
|
-
"in": "path",
|
|
3050
|
-
"name": "blueprint_id",
|
|
3051
|
-
"required": true,
|
|
3052
|
-
"schema": {
|
|
3053
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
3054
|
-
}
|
|
3055
|
-
},
|
|
3056
|
-
{
|
|
3057
|
-
"in": "path",
|
|
3058
|
-
"name": "job_id",
|
|
3059
|
-
"required": true,
|
|
3060
|
-
"description": "The install job whose deployment is being previewed.",
|
|
3061
|
-
"schema": {
|
|
3062
|
-
"$ref": "#/components/schemas/BlueprintJobID"
|
|
3063
|
-
}
|
|
3064
|
-
}
|
|
3065
|
-
],
|
|
3066
|
-
"responses": {
|
|
3067
|
-
"200": {
|
|
3068
|
-
"description": "Predicted outcome. `failed`-action items are absent here — the\npreview can't forecast errors.\n",
|
|
3069
|
-
"content": {
|
|
3070
|
-
"application/json": {
|
|
3071
|
-
"schema": {
|
|
3072
|
-
"$ref": "#/components/schemas/RestoreOutcome"
|
|
3073
|
-
}
|
|
3074
|
-
}
|
|
3075
|
-
}
|
|
3076
|
-
},
|
|
3077
|
-
"404": {
|
|
3078
|
-
"description": "Blueprint or deployment not found."
|
|
3079
2530
|
}
|
|
3080
2531
|
}
|
|
3081
2532
|
}
|
|
@@ -3122,184 +2573,10 @@
|
|
|
3122
2573
|
}
|
|
3123
2574
|
}
|
|
3124
2575
|
}
|
|
3125
|
-
},
|
|
3126
|
-
"/v1/blueprint-manifest/uniqueness-criteria": {
|
|
3127
|
-
"get": {
|
|
3128
|
-
"operationId": "listUniquenessCriteria",
|
|
3129
|
-
"summary": "listUniquenessCriteria",
|
|
3130
|
-
"description": "List all custom uniqueness criteria configured for the caller's organization.\nThese overrides are applied during install (V2 and V3) when matching incoming\nresources against existing ones in the destination org, replacing the default\nper-resource-type field set with the caller's chosen fields (AND-combined).\n",
|
|
3131
|
-
"tags": [
|
|
3132
|
-
"Uniqueness Criteria"
|
|
3133
|
-
],
|
|
3134
|
-
"responses": {
|
|
3135
|
-
"200": {
|
|
3136
|
-
"description": "All configured criteria for the org",
|
|
3137
|
-
"content": {
|
|
3138
|
-
"application/json": {
|
|
3139
|
-
"schema": {
|
|
3140
|
-
"type": "object",
|
|
3141
|
-
"properties": {
|
|
3142
|
-
"results": {
|
|
3143
|
-
"type": "array",
|
|
3144
|
-
"items": {
|
|
3145
|
-
"$ref": "#/components/schemas/UniquenessCriteria"
|
|
3146
|
-
}
|
|
3147
|
-
}
|
|
3148
|
-
}
|
|
3149
|
-
}
|
|
3150
|
-
}
|
|
3151
|
-
}
|
|
3152
|
-
}
|
|
3153
|
-
}
|
|
3154
|
-
}
|
|
3155
|
-
},
|
|
3156
|
-
"/v1/blueprint-manifest/uniqueness-criteria/{resource_type}": {
|
|
3157
|
-
"parameters": [
|
|
3158
|
-
{
|
|
3159
|
-
"in": "path",
|
|
3160
|
-
"required": true,
|
|
3161
|
-
"name": "resource_type",
|
|
3162
|
-
"schema": {
|
|
3163
|
-
"$ref": "#/components/schemas/UniquenessCriteriaResourceType"
|
|
3164
|
-
}
|
|
3165
|
-
}
|
|
3166
|
-
],
|
|
3167
|
-
"get": {
|
|
3168
|
-
"operationId": "getUniquenessCriteria",
|
|
3169
|
-
"summary": "getUniquenessCriteria",
|
|
3170
|
-
"description": "Get the configured uniqueness criteria for a specific resource type, if any.",
|
|
3171
|
-
"tags": [
|
|
3172
|
-
"Uniqueness Criteria"
|
|
3173
|
-
],
|
|
3174
|
-
"responses": {
|
|
3175
|
-
"200": {
|
|
3176
|
-
"description": "Configured criteria for the resource type",
|
|
3177
|
-
"content": {
|
|
3178
|
-
"application/json": {
|
|
3179
|
-
"schema": {
|
|
3180
|
-
"$ref": "#/components/schemas/UniquenessCriteria"
|
|
3181
|
-
}
|
|
3182
|
-
}
|
|
3183
|
-
}
|
|
3184
|
-
},
|
|
3185
|
-
"404": {
|
|
3186
|
-
"description": "No custom criteria configured (defaults will be used)"
|
|
3187
|
-
}
|
|
3188
|
-
}
|
|
3189
|
-
},
|
|
3190
|
-
"put": {
|
|
3191
|
-
"operationId": "putUniquenessCriteria",
|
|
3192
|
-
"summary": "putUniquenessCriteria",
|
|
3193
|
-
"description": "Set or replace the uniqueness criteria for a resource type. The provided fields\nmust be valid attributes on the resource's schema (the UI typically loads the\nschema to populate options). All listed fields are AND-combined during matching.\n",
|
|
3194
|
-
"tags": [
|
|
3195
|
-
"Uniqueness Criteria"
|
|
3196
|
-
],
|
|
3197
|
-
"requestBody": {
|
|
3198
|
-
"required": true,
|
|
3199
|
-
"content": {
|
|
3200
|
-
"application/json": {
|
|
3201
|
-
"schema": {
|
|
3202
|
-
"type": "object",
|
|
3203
|
-
"required": [
|
|
3204
|
-
"fields"
|
|
3205
|
-
],
|
|
3206
|
-
"properties": {
|
|
3207
|
-
"fields": {
|
|
3208
|
-
"type": "array",
|
|
3209
|
-
"minItems": 1,
|
|
3210
|
-
"items": {
|
|
3211
|
-
"type": "string"
|
|
3212
|
-
}
|
|
3213
|
-
}
|
|
3214
|
-
}
|
|
3215
|
-
}
|
|
3216
|
-
}
|
|
3217
|
-
}
|
|
3218
|
-
},
|
|
3219
|
-
"responses": {
|
|
3220
|
-
"200": {
|
|
3221
|
-
"description": "Stored criteria",
|
|
3222
|
-
"content": {
|
|
3223
|
-
"application/json": {
|
|
3224
|
-
"schema": {
|
|
3225
|
-
"$ref": "#/components/schemas/UniquenessCriteria"
|
|
3226
|
-
}
|
|
3227
|
-
}
|
|
3228
|
-
}
|
|
3229
|
-
},
|
|
3230
|
-
"400": {
|
|
3231
|
-
"description": "Invalid resource type or field list"
|
|
3232
|
-
}
|
|
3233
|
-
}
|
|
3234
|
-
},
|
|
3235
|
-
"delete": {
|
|
3236
|
-
"operationId": "deleteUniquenessCriteria",
|
|
3237
|
-
"summary": "deleteUniquenessCriteria",
|
|
3238
|
-
"description": "Remove the custom criteria for a resource type, reverting to the default fields.",
|
|
3239
|
-
"tags": [
|
|
3240
|
-
"Uniqueness Criteria"
|
|
3241
|
-
],
|
|
3242
|
-
"responses": {
|
|
3243
|
-
"204": {
|
|
3244
|
-
"description": "Criteria deleted (defaults will be used)"
|
|
3245
|
-
}
|
|
3246
|
-
}
|
|
3247
|
-
}
|
|
3248
2576
|
}
|
|
3249
2577
|
},
|
|
3250
2578
|
"components": {
|
|
3251
2579
|
"schemas": {
|
|
3252
|
-
"UniquenessCriteriaResourceType": {
|
|
3253
|
-
"type": "string",
|
|
3254
|
-
"description": "Resource type for which custom uniqueness criteria can be configured.",
|
|
3255
|
-
"enum": [
|
|
3256
|
-
"emailtemplate",
|
|
3257
|
-
"product",
|
|
3258
|
-
"price",
|
|
3259
|
-
"tax",
|
|
3260
|
-
"coupon",
|
|
3261
|
-
"product_recommendation",
|
|
3262
|
-
"file",
|
|
3263
|
-
"document_template",
|
|
3264
|
-
"schema",
|
|
3265
|
-
"taxonomy",
|
|
3266
|
-
"notification_template",
|
|
3267
|
-
"family",
|
|
3268
|
-
"permission",
|
|
3269
|
-
"journey"
|
|
3270
|
-
]
|
|
3271
|
-
},
|
|
3272
|
-
"UniquenessCriteria": {
|
|
3273
|
-
"type": "object",
|
|
3274
|
-
"required": [
|
|
3275
|
-
"org_id",
|
|
3276
|
-
"resource_type",
|
|
3277
|
-
"fields",
|
|
3278
|
-
"updated_at"
|
|
3279
|
-
],
|
|
3280
|
-
"properties": {
|
|
3281
|
-
"org_id": {
|
|
3282
|
-
"type": "string"
|
|
3283
|
-
},
|
|
3284
|
-
"resource_type": {
|
|
3285
|
-
"$ref": "#/components/schemas/UniquenessCriteriaResourceType"
|
|
3286
|
-
},
|
|
3287
|
-
"fields": {
|
|
3288
|
-
"type": "array",
|
|
3289
|
-
"minItems": 1,
|
|
3290
|
-
"items": {
|
|
3291
|
-
"type": "string"
|
|
3292
|
-
}
|
|
3293
|
-
},
|
|
3294
|
-
"updated_at": {
|
|
3295
|
-
"type": "string",
|
|
3296
|
-
"format": "date-time"
|
|
3297
|
-
},
|
|
3298
|
-
"updated_by": {
|
|
3299
|
-
"type": "string"
|
|
3300
|
-
}
|
|
3301
|
-
}
|
|
3302
|
-
},
|
|
3303
2580
|
"LineageEntry": {
|
|
3304
2581
|
"type": "object",
|
|
3305
2582
|
"properties": {
|
|
@@ -3320,190 +2597,19 @@
|
|
|
3320
2597
|
"type": "string"
|
|
3321
2598
|
}
|
|
3322
2599
|
},
|
|
3323
|
-
"fidelity": {
|
|
3324
|
-
"type": "string",
|
|
3325
|
-
"enum": [
|
|
3326
|
-
"full",
|
|
3327
|
-
"partial"
|
|
3328
|
-
]
|
|
3329
|
-
},
|
|
3330
|
-
"last_synced_at": {
|
|
3331
|
-
"type": "string",
|
|
3332
|
-
"format": "date-time"
|
|
3333
|
-
}
|
|
3334
|
-
}
|
|
3335
|
-
},
|
|
3336
|
-
"PatchFieldDiff": {
|
|
3337
|
-
"type": "object",
|
|
3338
|
-
"properties": {
|
|
3339
|
-
"path": {
|
|
3340
|
-
"type": "string"
|
|
3341
|
-
},
|
|
3342
|
-
"op": {
|
|
3343
|
-
"type": "string",
|
|
3344
|
-
"enum": [
|
|
3345
|
-
"changed",
|
|
3346
|
-
"added",
|
|
3347
|
-
"removed"
|
|
3348
|
-
]
|
|
3349
|
-
},
|
|
3350
|
-
"baseline_value": {},
|
|
3351
|
-
"current_value": {}
|
|
3352
|
-
}
|
|
3353
|
-
},
|
|
3354
|
-
"PatchResourceDiff": {
|
|
3355
|
-
"type": "object",
|
|
3356
|
-
"properties": {
|
|
3357
|
-
"type": {
|
|
3358
|
-
"type": "string"
|
|
3359
|
-
},
|
|
3360
|
-
"source_id": {
|
|
3361
|
-
"type": "string"
|
|
3362
|
-
},
|
|
3363
|
-
"address": {
|
|
3364
|
-
"type": "string"
|
|
3365
|
-
},
|
|
3366
|
-
"name": {
|
|
3367
|
-
"type": "string"
|
|
3368
|
-
},
|
|
3369
|
-
"changes": {
|
|
3370
|
-
"type": "array",
|
|
3371
|
-
"items": {
|
|
3372
|
-
"$ref": "#/components/schemas/PatchFieldDiff"
|
|
3373
|
-
}
|
|
3374
|
-
}
|
|
3375
|
-
}
|
|
3376
|
-
},
|
|
3377
|
-
"DetectChangesResult": {
|
|
3378
|
-
"type": "object",
|
|
3379
|
-
"properties": {
|
|
3380
|
-
"resources": {
|
|
3381
|
-
"type": "array",
|
|
3382
|
-
"items": {
|
|
3383
|
-
"$ref": "#/components/schemas/PatchResourceDiff"
|
|
3384
|
-
}
|
|
3385
|
-
}
|
|
3386
|
-
}
|
|
3387
|
-
},
|
|
3388
|
-
"BlueprintPatch": {
|
|
3389
|
-
"type": "object",
|
|
3390
|
-
"properties": {
|
|
3391
|
-
"patch_id": {
|
|
3392
|
-
"type": "string"
|
|
3393
|
-
},
|
|
3394
|
-
"version": {
|
|
3395
|
-
"type": "integer"
|
|
3396
|
-
},
|
|
3397
|
-
"blueprint_id": {
|
|
3398
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
3399
|
-
},
|
|
3400
|
-
"rollout_id": {
|
|
3401
|
-
"type": "string"
|
|
3402
|
-
},
|
|
3403
|
-
"source_org_id": {
|
|
3404
|
-
"type": "string"
|
|
3405
|
-
},
|
|
3406
|
-
"name": {
|
|
3407
|
-
"type": "string"
|
|
3408
|
-
},
|
|
3409
|
-
"description": {
|
|
3410
|
-
"type": "string"
|
|
3411
|
-
},
|
|
3412
|
-
"status": {
|
|
3413
|
-
"type": "string",
|
|
3414
|
-
"enum": [
|
|
3415
|
-
"draft",
|
|
3416
|
-
"ready",
|
|
3417
|
-
"applying",
|
|
3418
|
-
"applied",
|
|
3419
|
-
"partial"
|
|
3420
|
-
]
|
|
3421
|
-
},
|
|
3422
|
-
"resources": {
|
|
3423
|
-
"type": "array",
|
|
3424
|
-
"items": {
|
|
3425
|
-
"$ref": "#/components/schemas/PatchResourceDiff"
|
|
3426
|
-
}
|
|
3427
|
-
},
|
|
3428
|
-
"changelog": {
|
|
3429
|
-
"type": "string"
|
|
3430
|
-
},
|
|
3431
|
-
"created_by": {
|
|
3432
|
-
"type": "string"
|
|
3433
|
-
},
|
|
3434
|
-
"created_at": {
|
|
3435
|
-
"type": "string",
|
|
3436
|
-
"format": "date-time"
|
|
3437
|
-
},
|
|
3438
|
-
"applied_at": {
|
|
3439
|
-
"type": "string",
|
|
3440
|
-
"format": "date-time"
|
|
3441
|
-
}
|
|
3442
|
-
}
|
|
3443
|
-
},
|
|
3444
|
-
"OrgPatchExecution": {
|
|
3445
|
-
"type": "object",
|
|
3446
|
-
"properties": {
|
|
3447
|
-
"patch_id": {
|
|
3448
|
-
"type": "string"
|
|
3449
|
-
},
|
|
3450
|
-
"version": {
|
|
3451
|
-
"type": "integer"
|
|
3452
|
-
},
|
|
3453
|
-
"org_id": {
|
|
3454
|
-
"type": "string"
|
|
3455
|
-
},
|
|
3456
|
-
"org_name": {
|
|
3457
|
-
"type": "string"
|
|
3458
|
-
},
|
|
3459
|
-
"dest_blueprint_id": {
|
|
3460
|
-
"type": "string"
|
|
3461
|
-
},
|
|
3462
|
-
"status": {
|
|
2600
|
+
"fidelity": {
|
|
3463
2601
|
"type": "string",
|
|
3464
2602
|
"enum": [
|
|
3465
|
-
"
|
|
3466
|
-
"
|
|
3467
|
-
"success",
|
|
3468
|
-
"failed"
|
|
2603
|
+
"full",
|
|
2604
|
+
"partial"
|
|
3469
2605
|
]
|
|
3470
2606
|
},
|
|
3471
|
-
"
|
|
3472
|
-
"type": "string"
|
|
3473
|
-
},
|
|
3474
|
-
"applied_at": {
|
|
2607
|
+
"last_synced_at": {
|
|
3475
2608
|
"type": "string",
|
|
3476
2609
|
"format": "date-time"
|
|
3477
|
-
},
|
|
3478
|
-
"retries": {
|
|
3479
|
-
"type": "integer"
|
|
3480
|
-
},
|
|
3481
|
-
"changes_applied": {
|
|
3482
|
-
"type": "array",
|
|
3483
|
-
"items": {
|
|
3484
|
-
"$ref": "#/components/schemas/PatchFieldDiff"
|
|
3485
|
-
}
|
|
3486
2610
|
}
|
|
3487
2611
|
}
|
|
3488
2612
|
},
|
|
3489
|
-
"BlueprintPatchWithResults": {
|
|
3490
|
-
"allOf": [
|
|
3491
|
-
{
|
|
3492
|
-
"$ref": "#/components/schemas/BlueprintPatch"
|
|
3493
|
-
},
|
|
3494
|
-
{
|
|
3495
|
-
"type": "object",
|
|
3496
|
-
"properties": {
|
|
3497
|
-
"org_results": {
|
|
3498
|
-
"type": "array",
|
|
3499
|
-
"items": {
|
|
3500
|
-
"$ref": "#/components/schemas/OrgPatchExecution"
|
|
3501
|
-
}
|
|
3502
|
-
}
|
|
3503
|
-
}
|
|
3504
|
-
}
|
|
3505
|
-
]
|
|
3506
|
-
},
|
|
3507
2613
|
"BlueprintID": {
|
|
3508
2614
|
"type": "string",
|
|
3509
2615
|
"description": "ID of a blueprint",
|
|
@@ -3561,10 +2667,6 @@
|
|
|
3561
2667
|
"destination_blueprint_id": {
|
|
3562
2668
|
"type": "string"
|
|
3563
2669
|
},
|
|
3564
|
-
"job_id": {
|
|
3565
|
-
"type": "string",
|
|
3566
|
-
"description": "Blueprint installation job that created or updated this deployment record"
|
|
3567
|
-
},
|
|
3568
2670
|
"triggered_at": {
|
|
3569
2671
|
"type": "string",
|
|
3570
2672
|
"format": "date-time"
|
|
@@ -3572,114 +2674,6 @@
|
|
|
3572
2674
|
"note": {
|
|
3573
2675
|
"type": "string",
|
|
3574
2676
|
"description": "User-provided note about this synchronization"
|
|
3575
|
-
},
|
|
3576
|
-
"status": {
|
|
3577
|
-
"type": "string",
|
|
3578
|
-
"description": "Outcome of this deployment",
|
|
3579
|
-
"enum": [
|
|
3580
|
-
"IN_PROGRESS",
|
|
3581
|
-
"SUCCESS",
|
|
3582
|
-
"PARTIAL_SUCCESS",
|
|
3583
|
-
"FAILED"
|
|
3584
|
-
]
|
|
3585
|
-
},
|
|
3586
|
-
"restore_details": {
|
|
3587
|
-
"type": "object",
|
|
3588
|
-
"description": "Restore lifecycle metadata for this deployment.",
|
|
3589
|
-
"properties": {
|
|
3590
|
-
"has_revertible_changes": {
|
|
3591
|
-
"type": "boolean",
|
|
3592
|
-
"description": "Whether this sync changed destination resources in a way that can\nbe reverted. `false` means the sync completed without create,\nupdate, internal-update, or delete impacts, so there is no revert\naction to offer.\n"
|
|
3593
|
-
},
|
|
3594
|
-
"resource_impact_summary": {
|
|
3595
|
-
"type": "object",
|
|
3596
|
-
"description": "Counts of resource impact values from the V3 apply result.",
|
|
3597
|
-
"properties": {
|
|
3598
|
-
"create": {
|
|
3599
|
-
"type": "integer",
|
|
3600
|
-
"minimum": 0
|
|
3601
|
-
},
|
|
3602
|
-
"update": {
|
|
3603
|
-
"type": "integer",
|
|
3604
|
-
"minimum": 0
|
|
3605
|
-
},
|
|
3606
|
-
"internal_update": {
|
|
3607
|
-
"type": "integer",
|
|
3608
|
-
"minimum": 0
|
|
3609
|
-
},
|
|
3610
|
-
"delete": {
|
|
3611
|
-
"type": "integer",
|
|
3612
|
-
"minimum": 0
|
|
3613
|
-
},
|
|
3614
|
-
"no_op": {
|
|
3615
|
-
"type": "integer",
|
|
3616
|
-
"minimum": 0
|
|
3617
|
-
},
|
|
3618
|
-
"ignored": {
|
|
3619
|
-
"type": "integer",
|
|
3620
|
-
"minimum": 0
|
|
3621
|
-
}
|
|
3622
|
-
}
|
|
3623
|
-
},
|
|
3624
|
-
"last_restore_job_id": {
|
|
3625
|
-
"type": "string",
|
|
3626
|
-
"description": "BlueprintInstallationJob id of the most recent restore that ran\nagainst this deployment. Used by the FE to keep the restore-status\nbadge visible across page reloads. Frontends poll this job to\nrender the latest restore outcome.\n"
|
|
3627
|
-
},
|
|
3628
|
-
"last_restore_at": {
|
|
3629
|
-
"type": "string",
|
|
3630
|
-
"format": "date-time",
|
|
3631
|
-
"description": "Timestamp of the most recent restore that ran against this\ndeployment. Stamped when the restore sweep finishes. Used by the\nFE to show when a sync was reverted.\n"
|
|
3632
|
-
},
|
|
3633
|
-
"last_restored_by": {
|
|
3634
|
-
"type": "object",
|
|
3635
|
-
"description": "Identity of the caller who triggered the most recent restore.\nStamped when the restore sweep finishes. Used by the FE to show\nwho reverted a sync.\n",
|
|
3636
|
-
"properties": {
|
|
3637
|
-
"name": {
|
|
3638
|
-
"type": "string",
|
|
3639
|
-
"description": "Display name (email or token name) of the restorer."
|
|
3640
|
-
},
|
|
3641
|
-
"user_id": {
|
|
3642
|
-
"type": "string",
|
|
3643
|
-
"description": "User id of the restorer, when triggered by a user."
|
|
3644
|
-
}
|
|
3645
|
-
}
|
|
3646
|
-
},
|
|
3647
|
-
"status": {
|
|
3648
|
-
"type": "string",
|
|
3649
|
-
"description": "Computed server-side from `(job_id, restore_details.last_restore_job_id, installation_status)`.\n`available` when the deployment is restorable but has no prior\nrestore (including pure-create deployments without `snapshot_id`,\nreverted via sweep-only);\n`in_progress` while an install or restore is running on this\nblueprint instance;\n`restored` / `partially_restored` / `restore_failed` reflect the\nterminal status of the job referenced by `last_restore_job_id`;\n`unavailable` means there is no revert action, for example\nmalformed deployment rows missing `job_id` or no-change syncs.\n",
|
|
3650
|
-
"enum": [
|
|
3651
|
-
"available",
|
|
3652
|
-
"in_progress",
|
|
3653
|
-
"restored",
|
|
3654
|
-
"partially_restored",
|
|
3655
|
-
"restore_failed",
|
|
3656
|
-
"unavailable"
|
|
3657
|
-
]
|
|
3658
|
-
}
|
|
3659
|
-
}
|
|
3660
|
-
},
|
|
3661
|
-
"has_revertible_changes": {
|
|
3662
|
-
"type": "boolean",
|
|
3663
|
-
"deprecated": true,
|
|
3664
|
-
"description": "Deprecated. Use `restore_details.has_revertible_changes`.\n"
|
|
3665
|
-
},
|
|
3666
|
-
"last_restore_job_id": {
|
|
3667
|
-
"type": "string",
|
|
3668
|
-
"deprecated": true,
|
|
3669
|
-
"description": "Deprecated. Use `restore_details.last_restore_job_id`.\n"
|
|
3670
|
-
},
|
|
3671
|
-
"restore_status": {
|
|
3672
|
-
"type": "string",
|
|
3673
|
-
"deprecated": true,
|
|
3674
|
-
"description": "Deprecated. Use `restore_details.status`.\n",
|
|
3675
|
-
"enum": [
|
|
3676
|
-
"available",
|
|
3677
|
-
"in_progress",
|
|
3678
|
-
"restored",
|
|
3679
|
-
"partially_restored",
|
|
3680
|
-
"restore_failed",
|
|
3681
|
-
"unavailable"
|
|
3682
|
-
]
|
|
3683
2677
|
}
|
|
3684
2678
|
}
|
|
3685
2679
|
}
|
|
@@ -3781,55 +2775,6 @@
|
|
|
3781
2775
|
"title"
|
|
3782
2776
|
]
|
|
3783
2777
|
},
|
|
3784
|
-
"SuggestBlueprintResourcesRequest": {
|
|
3785
|
-
"type": "object",
|
|
3786
|
-
"required": [
|
|
3787
|
-
"prompt"
|
|
3788
|
-
],
|
|
3789
|
-
"properties": {
|
|
3790
|
-
"prompt": {
|
|
3791
|
-
"type": "string",
|
|
3792
|
-
"description": "Natural-language description of what to include.",
|
|
3793
|
-
"example": "everything for the hausanschluss use case"
|
|
3794
|
-
},
|
|
3795
|
-
"blueprint_id": {
|
|
3796
|
-
"allOf": [
|
|
3797
|
-
{
|
|
3798
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
3799
|
-
}
|
|
3800
|
-
],
|
|
3801
|
-
"description": "When provided, suggestions are scoped as additions to this existing\nblueprint — resources already in it are excluded from the response.\n"
|
|
3802
|
-
}
|
|
3803
|
-
}
|
|
3804
|
-
},
|
|
3805
|
-
"SuggestBlueprintResourcesResponse": {
|
|
3806
|
-
"type": "object",
|
|
3807
|
-
"required": [
|
|
3808
|
-
"resources"
|
|
3809
|
-
],
|
|
3810
|
-
"properties": {
|
|
3811
|
-
"resources": {
|
|
3812
|
-
"type": "array",
|
|
3813
|
-
"description": "Suggested resources to add. All marked is_root so the caller can request transitive dependency resolution.",
|
|
3814
|
-
"items": {
|
|
3815
|
-
"$ref": "#/components/schemas/BlueprintResource"
|
|
3816
|
-
}
|
|
3817
|
-
},
|
|
3818
|
-
"suggested_blueprint_name": {
|
|
3819
|
-
"type": "string",
|
|
3820
|
-
"description": "Short title derived from the prompt. Useful when the caller is\ncreating a new blueprint as a result of the suggestion — saves the\nuser from naming it themselves.\n",
|
|
3821
|
-
"example": "Hausanschluss"
|
|
3822
|
-
},
|
|
3823
|
-
"explanation": {
|
|
3824
|
-
"type": "string",
|
|
3825
|
-
"description": "Short human-readable summary of what was matched and why."
|
|
3826
|
-
},
|
|
3827
|
-
"add_dependencies_recommended": {
|
|
3828
|
-
"type": "boolean",
|
|
3829
|
-
"description": "Hint to the caller: persist via bulkAddBlueprintResources with\n?add_dependencies=true so anchor resources (journeys, workflows)\npull their transitive dependencies.\n"
|
|
3830
|
-
}
|
|
3831
|
-
}
|
|
3832
|
-
},
|
|
3833
2778
|
"BlueprintResource": {
|
|
3834
2779
|
"type": "object",
|
|
3835
2780
|
"properties": {
|
|
@@ -4272,12 +3217,6 @@
|
|
|
4272
3217
|
{
|
|
4273
3218
|
"type": "object",
|
|
4274
3219
|
"properties": {
|
|
4275
|
-
"job_type": {
|
|
4276
|
-
"type": "string",
|
|
4277
|
-
"enum": [
|
|
4278
|
-
"export"
|
|
4279
|
-
]
|
|
4280
|
-
},
|
|
4281
3220
|
"blueprint_id": {
|
|
4282
3221
|
"$ref": "#/components/schemas/BlueprintID"
|
|
4283
3222
|
},
|
|
@@ -4305,12 +3244,6 @@
|
|
|
4305
3244
|
{
|
|
4306
3245
|
"type": "object",
|
|
4307
3246
|
"properties": {
|
|
4308
|
-
"job_type": {
|
|
4309
|
-
"type": "string",
|
|
4310
|
-
"enum": [
|
|
4311
|
-
"install"
|
|
4312
|
-
]
|
|
4313
|
-
},
|
|
4314
3247
|
"source_blueprint_id": {
|
|
4315
3248
|
"$ref": "#/components/schemas/BlueprintID"
|
|
4316
3249
|
},
|
|
@@ -4340,21 +3273,6 @@
|
|
|
4340
3273
|
"type": "string",
|
|
4341
3274
|
"description": "Blueprint slug for marketplace blueprints"
|
|
4342
3275
|
},
|
|
4343
|
-
"sync_engine": {
|
|
4344
|
-
"type": "string",
|
|
4345
|
-
"enum": [
|
|
4346
|
-
"terraform",
|
|
4347
|
-
"v3"
|
|
4348
|
-
],
|
|
4349
|
-
"description": "Engine used for this install job"
|
|
4350
|
-
},
|
|
4351
|
-
"resource_progress": {
|
|
4352
|
-
"type": "array",
|
|
4353
|
-
"description": "Per-resource live status. Populated only for V3 installs.",
|
|
4354
|
-
"items": {
|
|
4355
|
-
"$ref": "#/components/schemas/V3ResourceProgressEntry"
|
|
4356
|
-
}
|
|
4357
|
-
},
|
|
4358
3276
|
"status": {
|
|
4359
3277
|
"type": "string",
|
|
4360
3278
|
"enum": [
|
|
@@ -4370,181 +3288,6 @@
|
|
|
4370
3288
|
}
|
|
4371
3289
|
]
|
|
4372
3290
|
},
|
|
4373
|
-
"BlueprintRestoreJob": {
|
|
4374
|
-
"allOf": [
|
|
4375
|
-
{
|
|
4376
|
-
"$ref": "#/components/schemas/CommonBlueprintJobFields"
|
|
4377
|
-
},
|
|
4378
|
-
{
|
|
4379
|
-
"type": "object",
|
|
4380
|
-
"properties": {
|
|
4381
|
-
"job_type": {
|
|
4382
|
-
"type": "string",
|
|
4383
|
-
"enum": [
|
|
4384
|
-
"restore"
|
|
4385
|
-
]
|
|
4386
|
-
},
|
|
4387
|
-
"destination_blueprint_id": {
|
|
4388
|
-
"$ref": "#/components/schemas/BlueprintID"
|
|
4389
|
-
},
|
|
4390
|
-
"destination_org_id": {
|
|
4391
|
-
"type": "string"
|
|
4392
|
-
},
|
|
4393
|
-
"install_job_id": {
|
|
4394
|
-
"type": "string",
|
|
4395
|
-
"nullable": true,
|
|
4396
|
-
"description": "The install job whose deployment is being reverted. Maps back\nto the entry in `Blueprint.deployments[]`.\n"
|
|
4397
|
-
},
|
|
4398
|
-
"snapshot_id": {
|
|
4399
|
-
"type": "string",
|
|
4400
|
-
"nullable": true,
|
|
4401
|
-
"description": "The snapshot driving Phase 1 of the restore. Null for sweep-only\nrestores (pure-create deployments with no captured manifest).\n"
|
|
4402
|
-
},
|
|
4403
|
-
"sync_engine": {
|
|
4404
|
-
"type": "string",
|
|
4405
|
-
"enum": [
|
|
4406
|
-
"v3"
|
|
4407
|
-
]
|
|
4408
|
-
},
|
|
4409
|
-
"status": {
|
|
4410
|
-
"type": "string",
|
|
4411
|
-
"enum": [
|
|
4412
|
-
"IN_PROGRESS",
|
|
4413
|
-
"SUCCESS",
|
|
4414
|
-
"PARTIAL_SUCCESS",
|
|
4415
|
-
"FAILED"
|
|
4416
|
-
]
|
|
4417
|
-
},
|
|
4418
|
-
"restore_result": {
|
|
4419
|
-
"nullable": true,
|
|
4420
|
-
"description": "Absent while the job is still IN_PROGRESS.",
|
|
4421
|
-
"allOf": [
|
|
4422
|
-
{
|
|
4423
|
-
"$ref": "#/components/schemas/RestoreOutcome"
|
|
4424
|
-
}
|
|
4425
|
-
]
|
|
4426
|
-
}
|
|
4427
|
-
}
|
|
4428
|
-
}
|
|
4429
|
-
]
|
|
4430
|
-
},
|
|
4431
|
-
"V3ResourceProgressEntry": {
|
|
4432
|
-
"type": "object",
|
|
4433
|
-
"required": [
|
|
4434
|
-
"lineage_id",
|
|
4435
|
-
"type",
|
|
4436
|
-
"address",
|
|
4437
|
-
"status"
|
|
4438
|
-
],
|
|
4439
|
-
"properties": {
|
|
4440
|
-
"lineage_id": {
|
|
4441
|
-
"type": "string"
|
|
4442
|
-
},
|
|
4443
|
-
"type": {
|
|
4444
|
-
"type": "string"
|
|
4445
|
-
},
|
|
4446
|
-
"address": {
|
|
4447
|
-
"type": "string"
|
|
4448
|
-
},
|
|
4449
|
-
"name": {
|
|
4450
|
-
"type": "string"
|
|
4451
|
-
},
|
|
4452
|
-
"status": {
|
|
4453
|
-
"type": "string",
|
|
4454
|
-
"enum": [
|
|
4455
|
-
"pending",
|
|
4456
|
-
"in_progress",
|
|
4457
|
-
"done",
|
|
4458
|
-
"failed",
|
|
4459
|
-
"skipped"
|
|
4460
|
-
]
|
|
4461
|
-
},
|
|
4462
|
-
"target_id": {
|
|
4463
|
-
"type": "string"
|
|
4464
|
-
},
|
|
4465
|
-
"error_message": {
|
|
4466
|
-
"type": "string"
|
|
4467
|
-
}
|
|
4468
|
-
}
|
|
4469
|
-
},
|
|
4470
|
-
"RestoreOutcomeItem": {
|
|
4471
|
-
"type": "object",
|
|
4472
|
-
"required": [
|
|
4473
|
-
"lineage_id",
|
|
4474
|
-
"type",
|
|
4475
|
-
"action"
|
|
4476
|
-
],
|
|
4477
|
-
"properties": {
|
|
4478
|
-
"lineage_id": {
|
|
4479
|
-
"type": "string"
|
|
4480
|
-
},
|
|
4481
|
-
"type": {
|
|
4482
|
-
"type": "string"
|
|
4483
|
-
},
|
|
4484
|
-
"name": {
|
|
4485
|
-
"type": "string",
|
|
4486
|
-
"nullable": true
|
|
4487
|
-
},
|
|
4488
|
-
"target_id": {
|
|
4489
|
-
"type": "string",
|
|
4490
|
-
"nullable": true
|
|
4491
|
-
},
|
|
4492
|
-
"action": {
|
|
4493
|
-
"type": "string",
|
|
4494
|
-
"description": "On `restore-preview`: the action the restore would take.\nOn `restore_result`: the action that was applied.\n`failed` only appears on `restore_result`.\n",
|
|
4495
|
-
"enum": [
|
|
4496
|
-
"restore",
|
|
4497
|
-
"delete",
|
|
4498
|
-
"skip",
|
|
4499
|
-
"failed"
|
|
4500
|
-
]
|
|
4501
|
-
},
|
|
4502
|
-
"reason": {
|
|
4503
|
-
"type": "string",
|
|
4504
|
-
"nullable": true,
|
|
4505
|
-
"description": "Only set when `action == skip`.",
|
|
4506
|
-
"enum": [
|
|
4507
|
-
"modified",
|
|
4508
|
-
"co_owned",
|
|
4509
|
-
"delete_unsupported",
|
|
4510
|
-
"heuristic_match"
|
|
4511
|
-
]
|
|
4512
|
-
},
|
|
4513
|
-
"last_synced_at": {
|
|
4514
|
-
"type": "string",
|
|
4515
|
-
"format": "date-time",
|
|
4516
|
-
"nullable": true,
|
|
4517
|
-
"description": "Only set when `reason == modified`. From the lineage row's last install write."
|
|
4518
|
-
},
|
|
4519
|
-
"current_updated_at": {
|
|
4520
|
-
"type": "string",
|
|
4521
|
-
"format": "date-time",
|
|
4522
|
-
"nullable": true,
|
|
4523
|
-
"description": "Only set when `reason == modified`. From the destination resource's current state."
|
|
4524
|
-
},
|
|
4525
|
-
"error_message": {
|
|
4526
|
-
"type": "string",
|
|
4527
|
-
"nullable": true,
|
|
4528
|
-
"description": "Only set when `action == failed`."
|
|
4529
|
-
}
|
|
4530
|
-
}
|
|
4531
|
-
},
|
|
4532
|
-
"RestoreOutcome": {
|
|
4533
|
-
"type": "object",
|
|
4534
|
-
"properties": {
|
|
4535
|
-
"snapshot_id": {
|
|
4536
|
-
"type": "string",
|
|
4537
|
-
"nullable": true,
|
|
4538
|
-
"description": "The snapshot driving Phase 1 of the restore. Null/absent for\nsweep-only restores (pure-create deployments with no captured\nmanifest).\n"
|
|
4539
|
-
},
|
|
4540
|
-
"resources": {
|
|
4541
|
-
"type": "array",
|
|
4542
|
-
"items": {
|
|
4543
|
-
"$ref": "#/components/schemas/RestoreOutcomeItem"
|
|
4544
|
-
}
|
|
4545
|
-
}
|
|
4546
|
-
}
|
|
4547
|
-
},
|
|
4548
3291
|
"BlueprintJob": {
|
|
4549
3292
|
"oneOf": [
|
|
4550
3293
|
{
|
|
@@ -4553,9 +3296,6 @@
|
|
|
4553
3296
|
{
|
|
4554
3297
|
"$ref": "#/components/schemas/BlueprintInstallationJob"
|
|
4555
3298
|
},
|
|
4556
|
-
{
|
|
4557
|
-
"$ref": "#/components/schemas/BlueprintRestoreJob"
|
|
4558
|
-
},
|
|
4559
3299
|
{
|
|
4560
3300
|
"$ref": "#/components/schemas/BlueprintDependenciesSyncJob"
|
|
4561
3301
|
},
|
|
@@ -4565,18 +3305,7 @@
|
|
|
4565
3305
|
{
|
|
4566
3306
|
"$ref": "#/components/schemas/BlueprintVerificationJob"
|
|
4567
3307
|
}
|
|
4568
|
-
]
|
|
4569
|
-
"discriminator": {
|
|
4570
|
-
"propertyName": "job_type",
|
|
4571
|
-
"mapping": {
|
|
4572
|
-
"export": "#/components/schemas/BlueprintExportJob",
|
|
4573
|
-
"install": "#/components/schemas/BlueprintInstallationJob",
|
|
4574
|
-
"restore": "#/components/schemas/BlueprintRestoreJob",
|
|
4575
|
-
"dependencies_sync": "#/components/schemas/BlueprintDependenciesSyncJob",
|
|
4576
|
-
"validate": "#/components/schemas/BlueprintValidateJob",
|
|
4577
|
-
"verification": "#/components/schemas/BlueprintVerificationJob"
|
|
4578
|
-
}
|
|
4579
|
-
}
|
|
3308
|
+
]
|
|
4580
3309
|
},
|
|
4581
3310
|
"BlueprintDependenciesSyncJob": {
|
|
4582
3311
|
"allOf": [
|
|
@@ -4586,12 +3315,6 @@
|
|
|
4586
3315
|
{
|
|
4587
3316
|
"type": "object",
|
|
4588
3317
|
"properties": {
|
|
4589
|
-
"job_type": {
|
|
4590
|
-
"type": "string",
|
|
4591
|
-
"enum": [
|
|
4592
|
-
"dependencies_sync"
|
|
4593
|
-
]
|
|
4594
|
-
},
|
|
4595
3318
|
"blueprint_id": {
|
|
4596
3319
|
"$ref": "#/components/schemas/BlueprintID"
|
|
4597
3320
|
},
|
|
@@ -4616,12 +3339,6 @@
|
|
|
4616
3339
|
{
|
|
4617
3340
|
"type": "object",
|
|
4618
3341
|
"properties": {
|
|
4619
|
-
"job_type": {
|
|
4620
|
-
"type": "string",
|
|
4621
|
-
"enum": [
|
|
4622
|
-
"validate"
|
|
4623
|
-
]
|
|
4624
|
-
},
|
|
4625
3342
|
"blueprint_id": {
|
|
4626
3343
|
"$ref": "#/components/schemas/BlueprintID"
|
|
4627
3344
|
},
|
|
@@ -4656,12 +3373,6 @@
|
|
|
4656
3373
|
{
|
|
4657
3374
|
"type": "object",
|
|
4658
3375
|
"properties": {
|
|
4659
|
-
"job_type": {
|
|
4660
|
-
"type": "string",
|
|
4661
|
-
"enum": [
|
|
4662
|
-
"verification"
|
|
4663
|
-
]
|
|
4664
|
-
},
|
|
4665
3376
|
"source_org_id": {
|
|
4666
3377
|
"type": "string"
|
|
4667
3378
|
},
|
|
@@ -4679,7 +3390,6 @@
|
|
|
4679
3390
|
"enum": [
|
|
4680
3391
|
"IN_PROGRESS",
|
|
4681
3392
|
"SUCCESS",
|
|
4682
|
-
"PARTIAL_SUCCESS",
|
|
4683
3393
|
"FAILED"
|
|
4684
3394
|
]
|
|
4685
3395
|
},
|
|
@@ -4711,7 +3421,6 @@
|
|
|
4711
3421
|
"enum": [
|
|
4712
3422
|
"IN_PROGRESS",
|
|
4713
3423
|
"SUCCESS",
|
|
4714
|
-
"PARTIAL_SUCCESS",
|
|
4715
3424
|
"FAILED"
|
|
4716
3425
|
]
|
|
4717
3426
|
},
|
|
@@ -4980,10 +3689,7 @@
|
|
|
4980
3689
|
"flow_template",
|
|
4981
3690
|
"taxonomy",
|
|
4982
3691
|
"notification_template",
|
|
4983
|
-
"environment_variable"
|
|
4984
|
-
"datasource",
|
|
4985
|
-
"family",
|
|
4986
|
-
"permission"
|
|
3692
|
+
"environment_variable"
|
|
4987
3693
|
]
|
|
4988
3694
|
},
|
|
4989
3695
|
"PlanChanges": {
|