@robinmordasiewicz/f5xc-api-mcp 2.0.10-2601051503 → 2.0.19-2601071557
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/CHANGELOG.md +25 -14
- package/README.md +9 -5
- package/dist/generator/domain-metadata.d.ts +1 -3
- package/dist/generator/domain-metadata.d.ts.map +1 -1
- package/dist/generator/domain-metadata.js +0 -20
- package/dist/generator/domain-metadata.js.map +1 -1
- package/dist/generator/naming/acronyms.d.ts +1 -1
- package/dist/generator/naming/acronyms.js +1 -1
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +179 -1582
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2 -265
- package/dist/version.d.ts +2 -2
- package/dist/version.js +2 -2
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +176 -26
- package/specs/domains/ai_services.json +242 -36
- package/specs/domains/api.json +1507 -183
- package/specs/domains/authentication.json +358 -46
- package/specs/domains/bigip.json +825 -105
- package/specs/domains/billing_and_usage.json +666 -83
- package/specs/domains/blindfold.json +988 -111
- package/specs/domains/bot_and_threat_defense.json +550 -66
- package/specs/domains/cdn.json +2431 -198
- package/specs/domains/ce_management.json +9272 -15726
- package/specs/domains/certificates.json +540 -78
- package/specs/domains/cloud_infrastructure.json +1102 -122
- package/specs/domains/container_services.json +782 -99
- package/specs/domains/data_and_privacy_security.json +508 -68
- package/specs/domains/data_intelligence.json +487 -64
- package/specs/domains/ddos.json +1302 -161
- package/specs/domains/dns.json +1286 -162
- package/specs/domains/managed_kubernetes.json +687 -89
- package/specs/domains/marketplace.json +994 -105
- package/specs/domains/network.json +2340 -239
- package/specs/domains/network_security.json +1963 -192
- package/specs/domains/nginx_one.json +475 -63
- package/specs/domains/object_storage.json +163 -16
- package/specs/domains/observability.json +1519 -148
- package/specs/domains/rate_limiting.json +456 -56
- package/specs/domains/secops_and_incident_response.json +275 -37
- package/specs/domains/service_mesh.json +1320 -128
- package/specs/domains/shape.json +4196 -398
- package/specs/domains/sites.json +5053 -405
- package/specs/domains/statistics.json +2784 -236
- package/specs/domains/support.json +1038 -109
- package/specs/domains/telemetry_and_insights.json +993 -80
- package/specs/domains/tenant_and_identity.json +3487 -313
- package/specs/domains/threat_campaign.json +695 -72
- package/specs/domains/users.json +437 -72
- package/specs/domains/virtual.json +3716 -261
- package/specs/domains/vpm_and_node_management.json +61 -2
- package/specs/domains/waf.json +1551 -149
- package/specs/index.json +121 -26
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Secops And Incident Response",
|
|
5
5
|
"description": "User threat assessment with configurable risk thresholds and mitigation rules. Detection covers high, medium, and low threat levels with corresponding actions like blocking, rate limiting, or alerting. Mitigation policies link to load balancers for real-time enforcement against identified bad actors.",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.19",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -13,7 +13,57 @@
|
|
|
13
13
|
"url": "https://www.f5.com/company/policies/eula"
|
|
14
14
|
},
|
|
15
15
|
"summary": "Malicious user mitigation with threat level classification. Automated response actions for suspicious behavior patterns.",
|
|
16
|
-
"x-f5xc-cli-domain": "secops_and_incident_response"
|
|
16
|
+
"x-f5xc-cli-domain": "secops_and_incident_response",
|
|
17
|
+
"x-f5xc-best-practices": {
|
|
18
|
+
"common_errors": [
|
|
19
|
+
{
|
|
20
|
+
"code": 400,
|
|
21
|
+
"message": "Invalid request body",
|
|
22
|
+
"resolution": "Validate JSON structure and required fields before submission",
|
|
23
|
+
"prevention": "Use schema validation from OpenAPI spec"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"code": 401,
|
|
27
|
+
"message": "Authentication failed",
|
|
28
|
+
"resolution": "Verify API token is valid and not expired",
|
|
29
|
+
"prevention": "Use environment variables for token management"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"code": 403,
|
|
33
|
+
"message": "Permission denied",
|
|
34
|
+
"resolution": "Check user role and namespace permissions",
|
|
35
|
+
"prevention": "Verify RBAC policies before operations"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"code": 404,
|
|
39
|
+
"message": "Resource not found",
|
|
40
|
+
"resolution": "Verify resource name and namespace exist",
|
|
41
|
+
"prevention": "List resources before attempting operations"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"code": 409,
|
|
45
|
+
"message": "Resource already exists",
|
|
46
|
+
"resolution": "Use unique name or delete existing resource",
|
|
47
|
+
"prevention": "Check existence before creation"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"code": 429,
|
|
51
|
+
"message": "Rate limit exceeded",
|
|
52
|
+
"resolution": "Implement exponential backoff and retry logic",
|
|
53
|
+
"prevention": "Batch operations and add delays between requests"
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
"security_notes": [
|
|
57
|
+
"Always use HTTPS for all API communications",
|
|
58
|
+
"Store API tokens securely, never in source code",
|
|
59
|
+
"Rotate API tokens regularly following security policies"
|
|
60
|
+
],
|
|
61
|
+
"performance_tips": [
|
|
62
|
+
"Use pagination for large result sets",
|
|
63
|
+
"Batch related operations when possible",
|
|
64
|
+
"Cache read-only responses appropriately"
|
|
65
|
+
]
|
|
66
|
+
}
|
|
17
67
|
},
|
|
18
68
|
"servers": [
|
|
19
69
|
{
|
|
@@ -276,6 +326,13 @@
|
|
|
276
326
|
"latency": "low",
|
|
277
327
|
"resource_usage": "low"
|
|
278
328
|
}
|
|
329
|
+
},
|
|
330
|
+
"x-f5xc-discovered-response-time": {
|
|
331
|
+
"p50_ms": 1000,
|
|
332
|
+
"p95_ms": 3000,
|
|
333
|
+
"p99_ms": 8000,
|
|
334
|
+
"sample_count": 0,
|
|
335
|
+
"source": "estimate"
|
|
279
336
|
}
|
|
280
337
|
},
|
|
281
338
|
"x-displayname": "Malicious User Mitigation.",
|
|
@@ -498,6 +555,13 @@
|
|
|
498
555
|
"latency": "low",
|
|
499
556
|
"resource_usage": "low"
|
|
500
557
|
}
|
|
558
|
+
},
|
|
559
|
+
"x-f5xc-discovered-response-time": {
|
|
560
|
+
"p50_ms": 800,
|
|
561
|
+
"p95_ms": 2500,
|
|
562
|
+
"p99_ms": 6000,
|
|
563
|
+
"sample_count": 0,
|
|
564
|
+
"source": "estimate"
|
|
501
565
|
}
|
|
502
566
|
},
|
|
503
567
|
"x-displayname": "Malicious User Mitigation.",
|
|
@@ -725,6 +789,13 @@
|
|
|
725
789
|
"latency": "moderate",
|
|
726
790
|
"resource_usage": "moderate"
|
|
727
791
|
}
|
|
792
|
+
},
|
|
793
|
+
"x-f5xc-discovered-response-time": {
|
|
794
|
+
"p50_ms": 200,
|
|
795
|
+
"p95_ms": 800,
|
|
796
|
+
"p99_ms": 2000,
|
|
797
|
+
"sample_count": 0,
|
|
798
|
+
"source": "estimate"
|
|
728
799
|
}
|
|
729
800
|
},
|
|
730
801
|
"x-displayname": "Malicious User Mitigation.",
|
|
@@ -946,6 +1017,13 @@
|
|
|
946
1017
|
"latency": "low",
|
|
947
1018
|
"resource_usage": "low"
|
|
948
1019
|
}
|
|
1020
|
+
},
|
|
1021
|
+
"x-f5xc-discovered-response-time": {
|
|
1022
|
+
"p50_ms": 200,
|
|
1023
|
+
"p95_ms": 800,
|
|
1024
|
+
"p99_ms": 2000,
|
|
1025
|
+
"sample_count": 0,
|
|
1026
|
+
"source": "estimate"
|
|
949
1027
|
}
|
|
950
1028
|
},
|
|
951
1029
|
"delete": {
|
|
@@ -1165,6 +1243,13 @@
|
|
|
1165
1243
|
"latency": "high",
|
|
1166
1244
|
"resource_usage": "moderate"
|
|
1167
1245
|
}
|
|
1246
|
+
},
|
|
1247
|
+
"x-f5xc-discovered-response-time": {
|
|
1248
|
+
"p50_ms": 500,
|
|
1249
|
+
"p95_ms": 1500,
|
|
1250
|
+
"p99_ms": 4000,
|
|
1251
|
+
"sample_count": 0,
|
|
1252
|
+
"source": "estimate"
|
|
1168
1253
|
}
|
|
1169
1254
|
},
|
|
1170
1255
|
"x-displayname": "Malicious User Mitigation.",
|
|
@@ -1188,6 +1273,7 @@
|
|
|
1188
1273
|
"title": "Empty",
|
|
1189
1274
|
"x-displayname": "Empty",
|
|
1190
1275
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
1276
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
1191
1277
|
"x-f5xc-minimum-configuration": {
|
|
1192
1278
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
1193
1279
|
"required_fields": [],
|
|
@@ -1264,6 +1350,8 @@
|
|
|
1264
1350
|
"$ref": "#/components/schemas/malicious_user_mitigationMaliciousUserMitigationType"
|
|
1265
1351
|
}
|
|
1266
1352
|
},
|
|
1353
|
+
"x-f5xc-description-short": "Create malicious_user_mitigation creates a new object in the storage backend for metadata.namespace.",
|
|
1354
|
+
"x-f5xc-description-medium": "Create malicious_user_mitigation creates a new object in the storage backend for metadata.namespace.",
|
|
1267
1355
|
"x-f5xc-minimum-configuration": {
|
|
1268
1356
|
"description": "Minimum configuration for malicious_user_mitigationCreateSpecType",
|
|
1269
1357
|
"required_fields": [
|
|
@@ -1289,6 +1377,7 @@
|
|
|
1289
1377
|
"title": "Fail_if_referred.",
|
|
1290
1378
|
"format": "boolean",
|
|
1291
1379
|
"x-displayname": "Fail-If-Referred.",
|
|
1380
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
1292
1381
|
"x-f5xc-required-for": {
|
|
1293
1382
|
"minimum_config": false,
|
|
1294
1383
|
"create": false,
|
|
@@ -1313,7 +1402,7 @@
|
|
|
1313
1402
|
},
|
|
1314
1403
|
"x-original-maxLength": 1024,
|
|
1315
1404
|
"x-reconciled-from-discovery": true,
|
|
1316
|
-
"x-reconciled-at": "2026-01-
|
|
1405
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516420+00:00"
|
|
1317
1406
|
},
|
|
1318
1407
|
"namespace": {
|
|
1319
1408
|
"type": "string",
|
|
@@ -1322,6 +1411,7 @@
|
|
|
1322
1411
|
"x-displayname": "Namespace",
|
|
1323
1412
|
"x-ves-example": "Ns1",
|
|
1324
1413
|
"x-f5xc-example": "ns1",
|
|
1414
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
1325
1415
|
"minLength": 0,
|
|
1326
1416
|
"maxLength": 6,
|
|
1327
1417
|
"x-f5xc-required-for": {
|
|
@@ -1332,7 +1422,7 @@
|
|
|
1332
1422
|
},
|
|
1333
1423
|
"x-original-maxLength": 1024,
|
|
1334
1424
|
"x-reconciled-from-discovery": true,
|
|
1335
|
-
"x-reconciled-at": "2026-01-
|
|
1425
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516427+00:00"
|
|
1336
1426
|
}
|
|
1337
1427
|
},
|
|
1338
1428
|
"x-f5xc-minimum-configuration": {
|
|
@@ -1367,6 +1457,7 @@
|
|
|
1367
1457
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
1368
1458
|
},
|
|
1369
1459
|
"x-displayname": "Deleted Referred Objects.",
|
|
1460
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
1370
1461
|
"x-f5xc-required-for": {
|
|
1371
1462
|
"minimum_config": false,
|
|
1372
1463
|
"create": false,
|
|
@@ -1382,6 +1473,7 @@
|
|
|
1382
1473
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
1383
1474
|
},
|
|
1384
1475
|
"x-displayname": "Disabled Referred Objects.",
|
|
1476
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
1385
1477
|
"x-f5xc-required-for": {
|
|
1386
1478
|
"minimum_config": false,
|
|
1387
1479
|
"create": false,
|
|
@@ -1400,6 +1492,7 @@
|
|
|
1400
1492
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
1401
1493
|
},
|
|
1402
1494
|
"x-displayname": "Referring Objects.",
|
|
1495
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
1403
1496
|
"x-f5xc-required-for": {
|
|
1404
1497
|
"minimum_config": false,
|
|
1405
1498
|
"create": false,
|
|
@@ -1421,6 +1514,8 @@
|
|
|
1421
1514
|
"$ref": "#/components/schemas/malicious_user_mitigationStatusObject"
|
|
1422
1515
|
},
|
|
1423
1516
|
"x-displayname": "Status",
|
|
1517
|
+
"x-f5xc-example": "active",
|
|
1518
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
1424
1519
|
"x-f5xc-required-for": {
|
|
1425
1520
|
"minimum_config": false,
|
|
1426
1521
|
"create": false,
|
|
@@ -1430,7 +1525,7 @@
|
|
|
1430
1525
|
"maxLength": 17,
|
|
1431
1526
|
"minLength": 17,
|
|
1432
1527
|
"x-reconciled-from-discovery": true,
|
|
1433
|
-
"x-reconciled-at": "2026-01-
|
|
1528
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516443+00:00"
|
|
1434
1529
|
},
|
|
1435
1530
|
"system_metadata": {
|
|
1436
1531
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -1470,6 +1565,8 @@
|
|
|
1470
1565
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
1471
1566
|
],
|
|
1472
1567
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
1568
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
1569
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
1473
1570
|
"x-f5xc-minimum-configuration": {
|
|
1474
1571
|
"description": "Minimum configuration for malicious_user_mitigationGetResponseFormatCode",
|
|
1475
1572
|
"required_fields": [],
|
|
@@ -1491,6 +1588,7 @@
|
|
|
1491
1588
|
"$ref": "#/components/schemas/malicious_user_mitigationMaliciousUserMitigationType"
|
|
1492
1589
|
}
|
|
1493
1590
|
},
|
|
1591
|
+
"x-f5xc-description-short": "GET malicious_user_mitigation reads a given object from storage backend for metadata.namespace.",
|
|
1494
1592
|
"x-f5xc-minimum-configuration": {
|
|
1495
1593
|
"description": "Minimum configuration for malicious_user_mitigationGetSpecType",
|
|
1496
1594
|
"required_fields": [
|
|
@@ -1518,6 +1616,7 @@
|
|
|
1518
1616
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
1519
1617
|
},
|
|
1520
1618
|
"x-displayname": "Errors",
|
|
1619
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
1521
1620
|
"x-f5xc-required-for": {
|
|
1522
1621
|
"minimum_config": false,
|
|
1523
1622
|
"create": false,
|
|
@@ -1533,6 +1632,8 @@
|
|
|
1533
1632
|
"$ref": "#/components/schemas/malicious_user_mitigationListResponseItem"
|
|
1534
1633
|
},
|
|
1535
1634
|
"x-displayname": "Items",
|
|
1635
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
1636
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
1536
1637
|
"x-f5xc-required-for": {
|
|
1537
1638
|
"minimum_config": false,
|
|
1538
1639
|
"create": false,
|
|
@@ -1566,6 +1667,8 @@
|
|
|
1566
1667
|
"description": "The set of annotations present on this malicious_user_mitigation.",
|
|
1567
1668
|
"title": "Annotations.",
|
|
1568
1669
|
"x-displayname": "Annotations.",
|
|
1670
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
1671
|
+
"x-f5xc-description-short": "The set of annotations present on this malicious_user_mitigation.",
|
|
1569
1672
|
"x-f5xc-required-for": {
|
|
1570
1673
|
"minimum_config": false,
|
|
1571
1674
|
"create": false,
|
|
@@ -1578,6 +1681,7 @@
|
|
|
1578
1681
|
"description": "The description set for this malicious_user_mitigation.",
|
|
1579
1682
|
"title": "Description.",
|
|
1580
1683
|
"x-displayname": "Description.",
|
|
1684
|
+
"x-f5xc-description-short": "The description set for this malicious_user_mitigation.",
|
|
1581
1685
|
"minLength": 0,
|
|
1582
1686
|
"maxLength": 0,
|
|
1583
1687
|
"x-f5xc-required-for": {
|
|
@@ -1588,7 +1692,7 @@
|
|
|
1588
1692
|
},
|
|
1589
1693
|
"x-original-maxLength": 1024,
|
|
1590
1694
|
"x-reconciled-from-discovery": true,
|
|
1591
|
-
"x-reconciled-at": "2026-01-
|
|
1695
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516457+00:00"
|
|
1592
1696
|
},
|
|
1593
1697
|
"disabled": {
|
|
1594
1698
|
"type": "boolean",
|
|
@@ -1596,6 +1700,8 @@
|
|
|
1596
1700
|
"title": "Disabled",
|
|
1597
1701
|
"format": "boolean",
|
|
1598
1702
|
"x-displayname": "Disabled",
|
|
1703
|
+
"x-f5xc-example": "True",
|
|
1704
|
+
"x-f5xc-description-short": "Value of true indicates malicious_user_mitigation is administratively disabled.",
|
|
1599
1705
|
"x-f5xc-required-for": {
|
|
1600
1706
|
"minimum_config": false,
|
|
1601
1707
|
"create": false,
|
|
@@ -1611,6 +1717,8 @@
|
|
|
1611
1717
|
"description": "The set of labels present on this malicious_user_mitigation.",
|
|
1612
1718
|
"title": "Labels",
|
|
1613
1719
|
"x-displayname": "Labels",
|
|
1720
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
1721
|
+
"x-f5xc-description-short": "The set of labels present on this malicious_user_mitigation.",
|
|
1614
1722
|
"x-f5xc-required-for": {
|
|
1615
1723
|
"minimum_config": false,
|
|
1616
1724
|
"create": false,
|
|
@@ -1628,6 +1736,7 @@
|
|
|
1628
1736
|
"x-displayname": "Name",
|
|
1629
1737
|
"x-ves-example": "Name",
|
|
1630
1738
|
"x-f5xc-example": "name",
|
|
1739
|
+
"x-f5xc-description-short": "The name of this malicious_user_mitigation.",
|
|
1631
1740
|
"minLength": 0,
|
|
1632
1741
|
"maxLength": 16,
|
|
1633
1742
|
"x-f5xc-required-for": {
|
|
@@ -1638,7 +1747,7 @@
|
|
|
1638
1747
|
},
|
|
1639
1748
|
"x-original-maxLength": 1024,
|
|
1640
1749
|
"x-reconciled-from-discovery": true,
|
|
1641
|
-
"x-reconciled-at": "2026-01-
|
|
1750
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516467+00:00"
|
|
1642
1751
|
},
|
|
1643
1752
|
"namespace": {
|
|
1644
1753
|
"type": "string",
|
|
@@ -1657,7 +1766,7 @@
|
|
|
1657
1766
|
},
|
|
1658
1767
|
"x-original-maxLength": 1024,
|
|
1659
1768
|
"x-reconciled-from-discovery": true,
|
|
1660
|
-
"x-reconciled-at": "2026-01-
|
|
1769
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516471+00:00"
|
|
1661
1770
|
},
|
|
1662
1771
|
"owner_view": {
|
|
1663
1772
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -1670,6 +1779,7 @@
|
|
|
1670
1779
|
"$ref": "#/components/schemas/malicious_user_mitigationStatusObject"
|
|
1671
1780
|
},
|
|
1672
1781
|
"x-displayname": "Status",
|
|
1782
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
1673
1783
|
"x-f5xc-required-for": {
|
|
1674
1784
|
"minimum_config": false,
|
|
1675
1785
|
"create": false,
|
|
@@ -1698,7 +1808,7 @@
|
|
|
1698
1808
|
"x-field-mutability": "read-only",
|
|
1699
1809
|
"x-original-maxLength": 1024,
|
|
1700
1810
|
"x-reconciled-from-discovery": true,
|
|
1701
|
-
"x-reconciled-at": "2026-01-
|
|
1811
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516479+00:00"
|
|
1702
1812
|
},
|
|
1703
1813
|
"uid": {
|
|
1704
1814
|
"type": "string",
|
|
@@ -1707,6 +1817,7 @@
|
|
|
1707
1817
|
"x-displayname": "UID",
|
|
1708
1818
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
1709
1819
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
1820
|
+
"x-f5xc-description-short": "The unique uid of this malicious_user_mitigation.",
|
|
1710
1821
|
"minLength": 0,
|
|
1711
1822
|
"maxLength": 36,
|
|
1712
1823
|
"x-f5xc-required-for": {
|
|
@@ -1719,9 +1830,11 @@
|
|
|
1719
1830
|
"x-original-maxLength": 1024,
|
|
1720
1831
|
"format": "uuid",
|
|
1721
1832
|
"x-reconciled-from-discovery": true,
|
|
1722
|
-
"x-reconciled-at": "2026-01-
|
|
1833
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516485+00:00"
|
|
1723
1834
|
}
|
|
1724
1835
|
},
|
|
1836
|
+
"x-f5xc-description-short": "By default a summary of malicious_user_mitigation is returned in 'List'.",
|
|
1837
|
+
"x-f5xc-description-medium": "By default a summary of malicious_user_mitigation is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
1725
1838
|
"x-f5xc-minimum-configuration": {
|
|
1726
1839
|
"description": "Minimum configuration for malicious_user_mitigationListResponseItem",
|
|
1727
1840
|
"required_fields": [
|
|
@@ -1764,6 +1877,7 @@
|
|
|
1764
1877
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
1765
1878
|
}
|
|
1766
1879
|
},
|
|
1880
|
+
"x-f5xc-description-short": "Supported actions that can be taken to mitigate malicious activity from a user.",
|
|
1767
1881
|
"x-f5xc-minimum-configuration": {
|
|
1768
1882
|
"description": "Minimum configuration for malicious_user_mitigationMaliciousUserMitigationAction",
|
|
1769
1883
|
"required_fields": [
|
|
@@ -1792,6 +1906,8 @@
|
|
|
1792
1906
|
"$ref": "#/components/schemas/malicious_user_mitigationMaliciousUserThreatLevel"
|
|
1793
1907
|
}
|
|
1794
1908
|
},
|
|
1909
|
+
"x-f5xc-description-short": "Malicious user mitigation rules specify the actions to be taken for users mapped to different threat levels.",
|
|
1910
|
+
"x-f5xc-description-medium": "Malicious user mitigation rules specify the actions to be taken for users mapped to different threat levels.",
|
|
1795
1911
|
"x-f5xc-minimum-configuration": {
|
|
1796
1912
|
"description": "Minimum configuration for malicious_user_mitigationMaliciousUserMitigationRule",
|
|
1797
1913
|
"required_fields": [
|
|
@@ -1834,6 +1950,8 @@
|
|
|
1834
1950
|
"ves.io.schema.rules.repeated.unique": "true",
|
|
1835
1951
|
"ves.io.schema.rules.repeated.unique_threat_level": "true"
|
|
1836
1952
|
},
|
|
1953
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
1954
|
+
"x-f5xc-description-short": "Define the threat levels and the corresponding mitigation actions to be taken Required: YES.",
|
|
1837
1955
|
"x-f5xc-required-for": {
|
|
1838
1956
|
"minimum_config": false,
|
|
1839
1957
|
"create": false,
|
|
@@ -1842,6 +1960,8 @@
|
|
|
1842
1960
|
}
|
|
1843
1961
|
}
|
|
1844
1962
|
},
|
|
1963
|
+
"x-f5xc-description-short": "Settings that specify the actions to be taken when malicious users are determined to be at different threat levels.",
|
|
1964
|
+
"x-f5xc-description-medium": "Settings that specify the actions to be taken when malicious users are determined to be at different threat levels. User's activity is monitored and continuously analyzed for malicious behavior. From this analysis, a threat-level is assigned to each user.",
|
|
1845
1965
|
"x-f5xc-minimum-configuration": {
|
|
1846
1966
|
"description": "Minimum configuration for malicious_user_mitigationMaliciousUserMitigationType",
|
|
1847
1967
|
"required_fields": [
|
|
@@ -1872,6 +1992,7 @@
|
|
|
1872
1992
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
1873
1993
|
}
|
|
1874
1994
|
},
|
|
1995
|
+
"x-f5xc-description-short": "Threat level estimated for each user based on the user's activity and reputation.",
|
|
1875
1996
|
"x-f5xc-minimum-configuration": {
|
|
1876
1997
|
"description": "Minimum configuration for malicious_user_mitigationMaliciousUserThreatLevel",
|
|
1877
1998
|
"required_fields": [
|
|
@@ -1937,6 +2058,8 @@
|
|
|
1937
2058
|
"$ref": "#/components/schemas/malicious_user_mitigationMaliciousUserMitigationType"
|
|
1938
2059
|
}
|
|
1939
2060
|
},
|
|
2061
|
+
"x-f5xc-description-short": "Replace malicious_user_mitigation replaces an existing object in the storage backend for metadata.namespace.",
|
|
2062
|
+
"x-f5xc-description-medium": "Replace malicious_user_mitigation replaces an existing object in the storage backend for metadata.namespace.",
|
|
1940
2063
|
"x-f5xc-minimum-configuration": {
|
|
1941
2064
|
"description": "Minimum configuration for malicious_user_mitigationReplaceSpecType",
|
|
1942
2065
|
"required_fields": [
|
|
@@ -1964,6 +2087,7 @@
|
|
|
1964
2087
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
1965
2088
|
},
|
|
1966
2089
|
"x-displayname": "Conditions.",
|
|
2090
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
1967
2091
|
"x-f5xc-required-for": {
|
|
1968
2092
|
"minimum_config": false,
|
|
1969
2093
|
"create": false,
|
|
@@ -1990,6 +2114,7 @@
|
|
|
1990
2114
|
}
|
|
1991
2115
|
}
|
|
1992
2116
|
},
|
|
2117
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
1993
2118
|
"x-f5xc-minimum-configuration": {
|
|
1994
2119
|
"description": "Minimum configuration for malicious_user_mitigationStatusObject",
|
|
1995
2120
|
"required_fields": [
|
|
@@ -2011,6 +2136,8 @@
|
|
|
2011
2136
|
"type_url": {
|
|
2012
2137
|
"type": "string",
|
|
2013
2138
|
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.",
|
|
2139
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
2140
|
+
"x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).",
|
|
2014
2141
|
"minLength": 0,
|
|
2015
2142
|
"maxLength": 1024,
|
|
2016
2143
|
"x-f5xc-required-for": {
|
|
@@ -2034,9 +2161,11 @@
|
|
|
2034
2161
|
},
|
|
2035
2162
|
"x-original-maxLength": 1024,
|
|
2036
2163
|
"x-reconciled-from-discovery": true,
|
|
2037
|
-
"x-reconciled-at": "2026-01-
|
|
2164
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516527+00:00"
|
|
2038
2165
|
}
|
|
2039
2166
|
},
|
|
2167
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
2168
|
+
"x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...",
|
|
2040
2169
|
"x-f5xc-minimum-configuration": {
|
|
2041
2170
|
"description": "Minimum configuration for protobufAny",
|
|
2042
2171
|
"required_fields": [
|
|
@@ -2062,6 +2191,8 @@
|
|
|
2062
2191
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
2063
2192
|
"title": "Hostname",
|
|
2064
2193
|
"x-displayname": "Hostname",
|
|
2194
|
+
"x-f5xc-example": "example-resource",
|
|
2195
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
2065
2196
|
"minLength": 0,
|
|
2066
2197
|
"maxLength": 1024,
|
|
2067
2198
|
"x-f5xc-required-for": {
|
|
@@ -2093,6 +2224,8 @@
|
|
|
2093
2224
|
"x-displayname": "Reason",
|
|
2094
2225
|
"x-ves-example": "Value",
|
|
2095
2226
|
"x-f5xc-example": "value",
|
|
2227
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
2228
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
2096
2229
|
"minLength": 0,
|
|
2097
2230
|
"maxLength": 43,
|
|
2098
2231
|
"x-f5xc-required-for": {
|
|
@@ -2103,13 +2236,15 @@
|
|
|
2103
2236
|
},
|
|
2104
2237
|
"x-original-maxLength": 1024,
|
|
2105
2238
|
"x-reconciled-from-discovery": true,
|
|
2106
|
-
"x-reconciled-at": "2026-01-
|
|
2239
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516536+00:00"
|
|
2107
2240
|
},
|
|
2108
2241
|
"service_name": {
|
|
2109
2242
|
"type": "string",
|
|
2110
2243
|
"description": "Name of the service that sent the status.",
|
|
2111
2244
|
"title": "Service name.",
|
|
2112
2245
|
"x-displayname": "Service Name.",
|
|
2246
|
+
"x-f5xc-example": "example-resource",
|
|
2247
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
2113
2248
|
"minLength": 0,
|
|
2114
2249
|
"maxLength": 1024,
|
|
2115
2250
|
"x-f5xc-required-for": {
|
|
@@ -2132,6 +2267,8 @@
|
|
|
2132
2267
|
"x-validation-rules": {
|
|
2133
2268
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
2134
2269
|
},
|
|
2270
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
2271
|
+
"x-f5xc-description-medium": "Status of the condition \"Success\" Validtion has succeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...",
|
|
2135
2272
|
"minLength": 0,
|
|
2136
2273
|
"maxLength": 17,
|
|
2137
2274
|
"x-f5xc-required-for": {
|
|
@@ -2142,7 +2279,7 @@
|
|
|
2142
2279
|
},
|
|
2143
2280
|
"x-original-maxLength": 1024,
|
|
2144
2281
|
"x-reconciled-from-discovery": true,
|
|
2145
|
-
"x-reconciled-at": "2026-01-
|
|
2282
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516541+00:00"
|
|
2146
2283
|
},
|
|
2147
2284
|
"type": {
|
|
2148
2285
|
"type": "string",
|
|
@@ -2157,6 +2294,8 @@
|
|
|
2157
2294
|
"x-validation-rules": {
|
|
2158
2295
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
2159
2296
|
},
|
|
2297
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
2298
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
2160
2299
|
"minLength": 0,
|
|
2161
2300
|
"maxLength": 1024,
|
|
2162
2301
|
"x-f5xc-required-for": {
|
|
@@ -2167,6 +2306,8 @@
|
|
|
2167
2306
|
}
|
|
2168
2307
|
}
|
|
2169
2308
|
},
|
|
2309
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
2310
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
2170
2311
|
"x-f5xc-minimum-configuration": {
|
|
2171
2312
|
"description": "Minimum configuration for schemaConditionType",
|
|
2172
2313
|
"required_fields": [
|
|
@@ -2202,6 +2343,8 @@
|
|
|
2202
2343
|
"default": "EOK",
|
|
2203
2344
|
"x-displayname": "Error Code.",
|
|
2204
2345
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
2346
|
+
"x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...",
|
|
2347
|
+
"x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...",
|
|
2205
2348
|
"x-f5xc-minimum-configuration": {
|
|
2206
2349
|
"description": "Minimum configuration for schemaErrorCode",
|
|
2207
2350
|
"required_fields": [],
|
|
@@ -2242,6 +2385,7 @@
|
|
|
2242
2385
|
}
|
|
2243
2386
|
}
|
|
2244
2387
|
},
|
|
2388
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
2245
2389
|
"x-f5xc-minimum-configuration": {
|
|
2246
2390
|
"description": "Minimum configuration for schemaErrorType",
|
|
2247
2391
|
"required_fields": [
|
|
@@ -2269,6 +2413,7 @@
|
|
|
2269
2413
|
"title": "Name",
|
|
2270
2414
|
"x-displayname": "Name",
|
|
2271
2415
|
"x-f5xc-example": "example-resource",
|
|
2416
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
2272
2417
|
"minLength": 0,
|
|
2273
2418
|
"maxLength": 16,
|
|
2274
2419
|
"x-f5xc-required-for": {
|
|
@@ -2279,9 +2424,10 @@
|
|
|
2279
2424
|
},
|
|
2280
2425
|
"x-original-maxLength": 1024,
|
|
2281
2426
|
"x-reconciled-from-discovery": true,
|
|
2282
|
-
"x-reconciled-at": "2026-01-
|
|
2427
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516552+00:00"
|
|
2283
2428
|
}
|
|
2284
2429
|
},
|
|
2430
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
2285
2431
|
"x-f5xc-minimum-configuration": {
|
|
2286
2432
|
"description": "Minimum configuration for schemaInitializerType",
|
|
2287
2433
|
"required_fields": [
|
|
@@ -2309,6 +2455,8 @@
|
|
|
2309
2455
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
2310
2456
|
},
|
|
2311
2457
|
"x-displayname": "Pending",
|
|
2458
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
2459
|
+
"x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.",
|
|
2312
2460
|
"x-f5xc-required-for": {
|
|
2313
2461
|
"minimum_config": false,
|
|
2314
2462
|
"create": false,
|
|
@@ -2320,6 +2468,7 @@
|
|
|
2320
2468
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
2321
2469
|
}
|
|
2322
2470
|
},
|
|
2471
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
2323
2472
|
"x-f5xc-minimum-configuration": {
|
|
2324
2473
|
"description": "Minimum configuration for schemaInitializersType",
|
|
2325
2474
|
"required_fields": [
|
|
@@ -2358,6 +2507,8 @@
|
|
|
2358
2507
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
2359
2508
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
2360
2509
|
},
|
|
2510
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
2511
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
2361
2512
|
"x-f5xc-required-for": {
|
|
2362
2513
|
"minimum_config": false,
|
|
2363
2514
|
"create": false,
|
|
@@ -2379,6 +2530,7 @@
|
|
|
2379
2530
|
"x-validation-rules": {
|
|
2380
2531
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
2381
2532
|
},
|
|
2533
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
2382
2534
|
"minLength": 0,
|
|
2383
2535
|
"x-f5xc-required-for": {
|
|
2384
2536
|
"minimum_config": false,
|
|
@@ -2388,7 +2540,7 @@
|
|
|
2388
2540
|
},
|
|
2389
2541
|
"x-original-maxLength": 1200,
|
|
2390
2542
|
"x-reconciled-from-discovery": true,
|
|
2391
|
-
"x-reconciled-at": "2026-01-
|
|
2543
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516562+00:00"
|
|
2392
2544
|
},
|
|
2393
2545
|
"disable": {
|
|
2394
2546
|
"type": "boolean",
|
|
@@ -2397,6 +2549,7 @@
|
|
|
2397
2549
|
"format": "boolean",
|
|
2398
2550
|
"x-displayname": "Disable",
|
|
2399
2551
|
"x-f5xc-example": "true",
|
|
2552
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
2400
2553
|
"x-f5xc-required-for": {
|
|
2401
2554
|
"minimum_config": false,
|
|
2402
2555
|
"create": false,
|
|
@@ -2410,6 +2563,8 @@
|
|
|
2410
2563
|
"title": "Labels",
|
|
2411
2564
|
"x-displayname": "Labels",
|
|
2412
2565
|
"x-f5xc-example": "value",
|
|
2566
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
2567
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
2413
2568
|
"x-f5xc-required-for": {
|
|
2414
2569
|
"minimum_config": false,
|
|
2415
2570
|
"create": false,
|
|
@@ -2431,6 +2586,8 @@
|
|
|
2431
2586
|
"x-validation-rules": {
|
|
2432
2587
|
"ves.io.schema.rules.message.required": "true"
|
|
2433
2588
|
},
|
|
2589
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
2590
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
2434
2591
|
"minLength": 0,
|
|
2435
2592
|
"maxLength": 16,
|
|
2436
2593
|
"x-f5xc-required-for": {
|
|
@@ -2441,7 +2598,7 @@
|
|
|
2441
2598
|
},
|
|
2442
2599
|
"x-original-maxLength": 1024,
|
|
2443
2600
|
"x-reconciled-from-discovery": true,
|
|
2444
|
-
"x-reconciled-at": "2026-01-
|
|
2601
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516570+00:00"
|
|
2445
2602
|
},
|
|
2446
2603
|
"namespace": {
|
|
2447
2604
|
"type": "string",
|
|
@@ -2450,6 +2607,8 @@
|
|
|
2450
2607
|
"x-displayname": "Namespace",
|
|
2451
2608
|
"x-ves-example": "Staging",
|
|
2452
2609
|
"x-f5xc-example": "staging",
|
|
2610
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
2611
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
2453
2612
|
"minLength": 0,
|
|
2454
2613
|
"maxLength": 6,
|
|
2455
2614
|
"x-f5xc-required-for": {
|
|
@@ -2460,9 +2619,10 @@
|
|
|
2460
2619
|
},
|
|
2461
2620
|
"x-original-maxLength": 1024,
|
|
2462
2621
|
"x-reconciled-from-discovery": true,
|
|
2463
|
-
"x-reconciled-at": "2026-01-
|
|
2622
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516574+00:00"
|
|
2464
2623
|
}
|
|
2465
2624
|
},
|
|
2625
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
2466
2626
|
"x-f5xc-minimum-configuration": {
|
|
2467
2627
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
2468
2628
|
"required_fields": [
|
|
@@ -2506,6 +2666,8 @@
|
|
|
2506
2666
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
2507
2667
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
2508
2668
|
},
|
|
2669
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
2670
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
2509
2671
|
"x-f5xc-required-for": {
|
|
2510
2672
|
"minimum_config": false,
|
|
2511
2673
|
"create": false,
|
|
@@ -2527,6 +2689,7 @@
|
|
|
2527
2689
|
"x-validation-rules": {
|
|
2528
2690
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
2529
2691
|
},
|
|
2692
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
2530
2693
|
"minLength": 0,
|
|
2531
2694
|
"x-f5xc-required-for": {
|
|
2532
2695
|
"minimum_config": false,
|
|
@@ -2536,7 +2699,7 @@
|
|
|
2536
2699
|
},
|
|
2537
2700
|
"x-original-maxLength": 1200,
|
|
2538
2701
|
"x-reconciled-from-discovery": true,
|
|
2539
|
-
"x-reconciled-at": "2026-01-
|
|
2702
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516580+00:00"
|
|
2540
2703
|
},
|
|
2541
2704
|
"disable": {
|
|
2542
2705
|
"type": "boolean",
|
|
@@ -2546,6 +2709,7 @@
|
|
|
2546
2709
|
"x-displayname": "Disable",
|
|
2547
2710
|
"x-ves-example": "True",
|
|
2548
2711
|
"x-f5xc-example": "true",
|
|
2712
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
2549
2713
|
"x-f5xc-required-for": {
|
|
2550
2714
|
"minimum_config": false,
|
|
2551
2715
|
"create": false,
|
|
@@ -2560,6 +2724,8 @@
|
|
|
2560
2724
|
"x-displayname": "Labels",
|
|
2561
2725
|
"x-ves-example": "Value",
|
|
2562
2726
|
"x-f5xc-example": "value",
|
|
2727
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
2728
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
2563
2729
|
"x-f5xc-required-for": {
|
|
2564
2730
|
"minimum_config": false,
|
|
2565
2731
|
"create": false,
|
|
@@ -2581,6 +2747,8 @@
|
|
|
2581
2747
|
"x-validation-rules": {
|
|
2582
2748
|
"ves.io.schema.rules.message.required": "true"
|
|
2583
2749
|
},
|
|
2750
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
2751
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
2584
2752
|
"minLength": 0,
|
|
2585
2753
|
"maxLength": 16,
|
|
2586
2754
|
"x-f5xc-required-for": {
|
|
@@ -2591,7 +2759,7 @@
|
|
|
2591
2759
|
},
|
|
2592
2760
|
"x-original-maxLength": 1024,
|
|
2593
2761
|
"x-reconciled-from-discovery": true,
|
|
2594
|
-
"x-reconciled-at": "2026-01-
|
|
2762
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516587+00:00"
|
|
2595
2763
|
},
|
|
2596
2764
|
"namespace": {
|
|
2597
2765
|
"type": "string",
|
|
@@ -2600,6 +2768,8 @@
|
|
|
2600
2768
|
"x-displayname": "Namespace",
|
|
2601
2769
|
"x-ves-example": "Staging",
|
|
2602
2770
|
"x-f5xc-example": "staging",
|
|
2771
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
2772
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
2603
2773
|
"minLength": 0,
|
|
2604
2774
|
"maxLength": 6,
|
|
2605
2775
|
"x-f5xc-required-for": {
|
|
@@ -2610,9 +2780,10 @@
|
|
|
2610
2780
|
},
|
|
2611
2781
|
"x-original-maxLength": 1024,
|
|
2612
2782
|
"x-reconciled-from-discovery": true,
|
|
2613
|
-
"x-reconciled-at": "2026-01-
|
|
2783
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516591+00:00"
|
|
2614
2784
|
}
|
|
2615
2785
|
},
|
|
2786
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
2616
2787
|
"x-f5xc-minimum-configuration": {
|
|
2617
2788
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
2618
2789
|
"required_fields": [
|
|
@@ -2644,6 +2815,8 @@
|
|
|
2644
2815
|
"x-displayname": "Kind",
|
|
2645
2816
|
"x-ves-example": "Virtual_site.",
|
|
2646
2817
|
"x-f5xc-example": "virtual_site",
|
|
2818
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
|
|
2819
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
|
|
2647
2820
|
"minLength": 0,
|
|
2648
2821
|
"maxLength": 14,
|
|
2649
2822
|
"x-f5xc-required-for": {
|
|
@@ -2655,7 +2828,7 @@
|
|
|
2655
2828
|
"readOnly": true,
|
|
2656
2829
|
"x-original-maxLength": 1024,
|
|
2657
2830
|
"x-reconciled-from-discovery": true,
|
|
2658
|
-
"x-reconciled-at": "2026-01-
|
|
2831
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516595+00:00"
|
|
2659
2832
|
},
|
|
2660
2833
|
"name": {
|
|
2661
2834
|
"type": "string",
|
|
@@ -2664,6 +2837,8 @@
|
|
|
2664
2837
|
"x-displayname": "Name",
|
|
2665
2838
|
"x-ves-example": "Contactus-route.",
|
|
2666
2839
|
"x-f5xc-example": "contactus-route",
|
|
2840
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
2841
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
2667
2842
|
"minLength": 0,
|
|
2668
2843
|
"maxLength": 16,
|
|
2669
2844
|
"x-f5xc-required-for": {
|
|
@@ -2674,7 +2849,7 @@
|
|
|
2674
2849
|
},
|
|
2675
2850
|
"x-original-maxLength": 1024,
|
|
2676
2851
|
"x-reconciled-from-discovery": true,
|
|
2677
|
-
"x-reconciled-at": "2026-01-
|
|
2852
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516599+00:00"
|
|
2678
2853
|
},
|
|
2679
2854
|
"namespace": {
|
|
2680
2855
|
"type": "string",
|
|
@@ -2683,6 +2858,8 @@
|
|
|
2683
2858
|
"x-displayname": "Namespace",
|
|
2684
2859
|
"x-ves-example": "Ns1",
|
|
2685
2860
|
"x-f5xc-example": "ns1",
|
|
2861
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
2862
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
2686
2863
|
"minLength": 0,
|
|
2687
2864
|
"maxLength": 6,
|
|
2688
2865
|
"x-f5xc-required-for": {
|
|
@@ -2693,7 +2870,7 @@
|
|
|
2693
2870
|
},
|
|
2694
2871
|
"x-original-maxLength": 1024,
|
|
2695
2872
|
"x-reconciled-from-discovery": true,
|
|
2696
|
-
"x-reconciled-at": "2026-01-
|
|
2873
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516603+00:00"
|
|
2697
2874
|
},
|
|
2698
2875
|
"tenant": {
|
|
2699
2876
|
"type": "string",
|
|
@@ -2702,6 +2879,8 @@
|
|
|
2702
2879
|
"x-displayname": "Tenant",
|
|
2703
2880
|
"x-ves-example": "Example-corp.",
|
|
2704
2881
|
"x-f5xc-example": "example-corp",
|
|
2882
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
2883
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
2705
2884
|
"minLength": 0,
|
|
2706
2885
|
"maxLength": 18,
|
|
2707
2886
|
"x-f5xc-required-for": {
|
|
@@ -2714,7 +2893,7 @@
|
|
|
2714
2893
|
"x-field-mutability": "read-only",
|
|
2715
2894
|
"x-original-maxLength": 1024,
|
|
2716
2895
|
"x-reconciled-from-discovery": true,
|
|
2717
|
-
"x-reconciled-at": "2026-01-
|
|
2896
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516607+00:00"
|
|
2718
2897
|
},
|
|
2719
2898
|
"uid": {
|
|
2720
2899
|
"type": "string",
|
|
@@ -2723,6 +2902,8 @@
|
|
|
2723
2902
|
"x-displayname": "UID",
|
|
2724
2903
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
2725
2904
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
2905
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
|
|
2906
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
|
|
2726
2907
|
"minLength": 0,
|
|
2727
2908
|
"maxLength": 36,
|
|
2728
2909
|
"x-f5xc-required-for": {
|
|
@@ -2736,9 +2917,11 @@
|
|
|
2736
2917
|
"x-original-maxLength": 1024,
|
|
2737
2918
|
"format": "uuid",
|
|
2738
2919
|
"x-reconciled-from-discovery": true,
|
|
2739
|
-
"x-reconciled-at": "2026-01-
|
|
2920
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516613+00:00"
|
|
2740
2921
|
}
|
|
2741
2922
|
},
|
|
2923
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
2924
|
+
"x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
|
|
2742
2925
|
"x-f5xc-minimum-configuration": {
|
|
2743
2926
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
2744
2927
|
"required_fields": [
|
|
@@ -2781,6 +2964,8 @@
|
|
|
2781
2964
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
2782
2965
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
2783
2966
|
},
|
|
2967
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
2968
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
2784
2969
|
"x-f5xc-required-for": {
|
|
2785
2970
|
"minimum_config": false,
|
|
2786
2971
|
"create": false,
|
|
@@ -2802,6 +2987,7 @@
|
|
|
2802
2987
|
"x-validation-rules": {
|
|
2803
2988
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
2804
2989
|
},
|
|
2990
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
2805
2991
|
"minLength": 0,
|
|
2806
2992
|
"x-f5xc-required-for": {
|
|
2807
2993
|
"minimum_config": false,
|
|
@@ -2811,7 +2997,7 @@
|
|
|
2811
2997
|
},
|
|
2812
2998
|
"x-original-maxLength": 1200,
|
|
2813
2999
|
"x-reconciled-from-discovery": true,
|
|
2814
|
-
"x-reconciled-at": "2026-01-
|
|
3000
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516619+00:00"
|
|
2815
3001
|
},
|
|
2816
3002
|
"disable": {
|
|
2817
3003
|
"type": "boolean",
|
|
@@ -2820,6 +3006,7 @@
|
|
|
2820
3006
|
"format": "boolean",
|
|
2821
3007
|
"x-displayname": "Disable",
|
|
2822
3008
|
"x-f5xc-example": "true",
|
|
3009
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
2823
3010
|
"x-f5xc-required-for": {
|
|
2824
3011
|
"minimum_config": false,
|
|
2825
3012
|
"create": false,
|
|
@@ -2834,6 +3021,8 @@
|
|
|
2834
3021
|
"x-displayname": "Labels",
|
|
2835
3022
|
"x-ves-example": "Value",
|
|
2836
3023
|
"x-f5xc-example": "value",
|
|
3024
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
3025
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
2837
3026
|
"x-f5xc-required-for": {
|
|
2838
3027
|
"minimum_config": false,
|
|
2839
3028
|
"create": false,
|
|
@@ -2854,6 +3043,8 @@
|
|
|
2854
3043
|
"x-validation-rules": {
|
|
2855
3044
|
"ves.io.schema.rules.message.required": "true"
|
|
2856
3045
|
},
|
|
3046
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
3047
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
2857
3048
|
"minLength": 0,
|
|
2858
3049
|
"maxLength": 16,
|
|
2859
3050
|
"x-f5xc-required-for": {
|
|
@@ -2864,7 +3055,7 @@
|
|
|
2864
3055
|
},
|
|
2865
3056
|
"x-original-maxLength": 1024,
|
|
2866
3057
|
"x-reconciled-from-discovery": true,
|
|
2867
|
-
"x-reconciled-at": "2026-01-
|
|
3058
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516626+00:00"
|
|
2868
3059
|
},
|
|
2869
3060
|
"namespace": {
|
|
2870
3061
|
"type": "string",
|
|
@@ -2873,6 +3064,8 @@
|
|
|
2873
3064
|
"x-displayname": "Namespace",
|
|
2874
3065
|
"x-ves-example": "Staging",
|
|
2875
3066
|
"x-f5xc-example": "staging",
|
|
3067
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
3068
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
2876
3069
|
"minLength": 0,
|
|
2877
3070
|
"maxLength": 6,
|
|
2878
3071
|
"x-f5xc-required-for": {
|
|
@@ -2883,9 +3076,10 @@
|
|
|
2883
3076
|
},
|
|
2884
3077
|
"x-original-maxLength": 1024,
|
|
2885
3078
|
"x-reconciled-from-discovery": true,
|
|
2886
|
-
"x-reconciled-at": "2026-01-
|
|
3079
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516630+00:00"
|
|
2887
3080
|
}
|
|
2888
3081
|
},
|
|
3082
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
2889
3083
|
"x-f5xc-minimum-configuration": {
|
|
2890
3084
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
2891
3085
|
"required_fields": [
|
|
@@ -2916,6 +3110,8 @@
|
|
|
2916
3110
|
"title": "Creation_timestamp.",
|
|
2917
3111
|
"format": "date-time",
|
|
2918
3112
|
"x-displayname": "Creation Timestamp.",
|
|
3113
|
+
"x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
3114
|
+
"x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
2919
3115
|
"minLength": 0,
|
|
2920
3116
|
"maxLength": 1024,
|
|
2921
3117
|
"x-f5xc-required-for": {
|
|
@@ -2933,6 +3129,8 @@
|
|
|
2933
3129
|
"x-displayname": "Creator Class.",
|
|
2934
3130
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
2935
3131
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
3132
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
3133
|
+
"x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.",
|
|
2936
3134
|
"minLength": 0,
|
|
2937
3135
|
"maxLength": 1024,
|
|
2938
3136
|
"x-f5xc-required-for": {
|
|
@@ -2950,6 +3148,8 @@
|
|
|
2950
3148
|
"x-displayname": "Creator ID.",
|
|
2951
3149
|
"x-ves-example": "Ver-instance-1.",
|
|
2952
3150
|
"x-f5xc-example": "ver-instance-1",
|
|
3151
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
3152
|
+
"x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.",
|
|
2953
3153
|
"minLength": 0,
|
|
2954
3154
|
"maxLength": 1024,
|
|
2955
3155
|
"x-f5xc-required-for": {
|
|
@@ -2968,6 +3168,8 @@
|
|
|
2968
3168
|
"description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)",
|
|
2969
3169
|
"title": "Status_id",
|
|
2970
3170
|
"x-displayname": "Status ID",
|
|
3171
|
+
"x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...",
|
|
3172
|
+
"x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).",
|
|
2971
3173
|
"minLength": 0,
|
|
2972
3174
|
"maxLength": 1024,
|
|
2973
3175
|
"x-f5xc-required-for": {
|
|
@@ -2985,6 +3187,7 @@
|
|
|
2985
3187
|
"x-displayname": "UID",
|
|
2986
3188
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
2987
3189
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
3190
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
2988
3191
|
"minLength": 0,
|
|
2989
3192
|
"maxLength": 36,
|
|
2990
3193
|
"x-f5xc-required-for": {
|
|
@@ -2997,13 +3200,14 @@
|
|
|
2997
3200
|
"x-original-maxLength": 1024,
|
|
2998
3201
|
"format": "uuid",
|
|
2999
3202
|
"x-reconciled-from-discovery": true,
|
|
3000
|
-
"x-reconciled-at": "2026-01-
|
|
3203
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516643+00:00"
|
|
3001
3204
|
},
|
|
3002
3205
|
"vtrp_id": {
|
|
3003
3206
|
"type": "string",
|
|
3004
3207
|
"description": "Origin of this status exchanged by VTRP.",
|
|
3005
3208
|
"title": "Vtrp_id",
|
|
3006
3209
|
"x-displayname": "VTRP ID",
|
|
3210
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
3007
3211
|
"minLength": 0,
|
|
3008
3212
|
"maxLength": 1024,
|
|
3009
3213
|
"x-f5xc-required-for": {
|
|
@@ -3020,6 +3224,7 @@
|
|
|
3020
3224
|
"title": "Vtrp_stale.",
|
|
3021
3225
|
"format": "boolean",
|
|
3022
3226
|
"x-displayname": "VTRP Stale.",
|
|
3227
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
3023
3228
|
"x-f5xc-required-for": {
|
|
3024
3229
|
"minimum_config": false,
|
|
3025
3230
|
"create": false,
|
|
@@ -3028,6 +3233,7 @@
|
|
|
3028
3233
|
}
|
|
3029
3234
|
}
|
|
3030
3235
|
},
|
|
3236
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
3031
3237
|
"x-f5xc-minimum-configuration": {
|
|
3032
3238
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
3033
3239
|
"required_fields": [
|
|
@@ -3058,6 +3264,8 @@
|
|
|
3058
3264
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
3059
3265
|
"x-displayname": "Status Publish Type.",
|
|
3060
3266
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
3267
|
+
"x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.",
|
|
3268
|
+
"x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.",
|
|
3061
3269
|
"x-f5xc-minimum-configuration": {
|
|
3062
3270
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
3063
3271
|
"required_fields": [],
|
|
@@ -3083,6 +3291,7 @@
|
|
|
3083
3291
|
"x-displayname": "Code",
|
|
3084
3292
|
"x-ves-example": "0",
|
|
3085
3293
|
"x-f5xc-example": "0",
|
|
3294
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
3086
3295
|
"minimum": 0,
|
|
3087
3296
|
"maximum": 2147483647,
|
|
3088
3297
|
"x-f5xc-required-for": {
|
|
@@ -3099,6 +3308,8 @@
|
|
|
3099
3308
|
"x-displayname": "Reason",
|
|
3100
3309
|
"x-ves-example": "Value",
|
|
3101
3310
|
"x-f5xc-example": "value",
|
|
3311
|
+
"x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
3312
|
+
"x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
3102
3313
|
"minLength": 0,
|
|
3103
3314
|
"maxLength": 43,
|
|
3104
3315
|
"x-f5xc-required-for": {
|
|
@@ -3109,7 +3320,7 @@
|
|
|
3109
3320
|
},
|
|
3110
3321
|
"x-original-maxLength": 1024,
|
|
3111
3322
|
"x-reconciled-from-discovery": true,
|
|
3112
|
-
"x-reconciled-at": "2026-01-
|
|
3323
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516652+00:00"
|
|
3113
3324
|
},
|
|
3114
3325
|
"status": {
|
|
3115
3326
|
"type": "string",
|
|
@@ -3118,6 +3329,7 @@
|
|
|
3118
3329
|
"x-displayname": "Status",
|
|
3119
3330
|
"x-ves-example": "Value",
|
|
3120
3331
|
"x-f5xc-example": "value",
|
|
3332
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
3121
3333
|
"minLength": 0,
|
|
3122
3334
|
"maxLength": 17,
|
|
3123
3335
|
"x-f5xc-required-for": {
|
|
@@ -3128,9 +3340,10 @@
|
|
|
3128
3340
|
},
|
|
3129
3341
|
"x-original-maxLength": 1024,
|
|
3130
3342
|
"x-reconciled-from-discovery": true,
|
|
3131
|
-
"x-reconciled-at": "2026-01-
|
|
3343
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516656+00:00"
|
|
3132
3344
|
}
|
|
3133
3345
|
},
|
|
3346
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
3134
3347
|
"x-f5xc-minimum-configuration": {
|
|
3135
3348
|
"description": "Minimum configuration for schemaStatusType",
|
|
3136
3349
|
"required_fields": [
|
|
@@ -3158,6 +3371,8 @@
|
|
|
3158
3371
|
"title": "Creation_timestamp.",
|
|
3159
3372
|
"format": "date-time",
|
|
3160
3373
|
"x-displayname": "Creation Timestamp.",
|
|
3374
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
3375
|
+
"x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.",
|
|
3161
3376
|
"minLength": 0,
|
|
3162
3377
|
"maxLength": 1024,
|
|
3163
3378
|
"x-f5xc-required-for": {
|
|
@@ -3175,6 +3390,7 @@
|
|
|
3175
3390
|
"x-displayname": "Creator Class.",
|
|
3176
3391
|
"x-ves-example": "Prism",
|
|
3177
3392
|
"x-f5xc-example": "value",
|
|
3393
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
3178
3394
|
"minLength": 0,
|
|
3179
3395
|
"maxLength": 1024,
|
|
3180
3396
|
"x-f5xc-required-for": {
|
|
@@ -3192,6 +3408,7 @@
|
|
|
3192
3408
|
"x-displayname": "Creator ID.",
|
|
3193
3409
|
"x-ves-example": "Admin@example-corp.com.",
|
|
3194
3410
|
"x-f5xc-example": "value",
|
|
3411
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
3195
3412
|
"minLength": 0,
|
|
3196
3413
|
"maxLength": 1024,
|
|
3197
3414
|
"x-f5xc-required-for": {
|
|
@@ -3208,6 +3425,8 @@
|
|
|
3208
3425
|
"title": "Deletion_timestamp.",
|
|
3209
3426
|
"format": "date-time",
|
|
3210
3427
|
"x-displayname": "Deletion Timestamp.",
|
|
3428
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
3429
|
+
"x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...",
|
|
3211
3430
|
"minLength": 0,
|
|
3212
3431
|
"maxLength": 1024,
|
|
3213
3432
|
"x-f5xc-required-for": {
|
|
@@ -3227,6 +3446,8 @@
|
|
|
3227
3446
|
"x-displayname": "Finalizers.",
|
|
3228
3447
|
"x-ves-example": "Value",
|
|
3229
3448
|
"x-f5xc-example": "value",
|
|
3449
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
3450
|
+
"x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.",
|
|
3230
3451
|
"x-f5xc-required-for": {
|
|
3231
3452
|
"minimum_config": false,
|
|
3232
3453
|
"create": false,
|
|
@@ -3244,6 +3465,8 @@
|
|
|
3244
3465
|
"x-displayname": "Labels",
|
|
3245
3466
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
3246
3467
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
3468
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.",
|
|
3469
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).",
|
|
3247
3470
|
"x-f5xc-required-for": {
|
|
3248
3471
|
"minimum_config": false,
|
|
3249
3472
|
"create": false,
|
|
@@ -3257,6 +3480,8 @@
|
|
|
3257
3480
|
"title": "Modification_timestamp.",
|
|
3258
3481
|
"format": "date-time",
|
|
3259
3482
|
"x-displayname": "Modification Timestamp.",
|
|
3483
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
3484
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
3260
3485
|
"minLength": 0,
|
|
3261
3486
|
"maxLength": 1024,
|
|
3262
3487
|
"x-f5xc-required-for": {
|
|
@@ -3275,6 +3500,8 @@
|
|
|
3275
3500
|
"x-displayname": "Object Index.",
|
|
3276
3501
|
"x-ves-example": "0",
|
|
3277
3502
|
"x-f5xc-example": "0",
|
|
3503
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
3504
|
+
"x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.",
|
|
3278
3505
|
"minimum": 0,
|
|
3279
3506
|
"maximum": 2147483647,
|
|
3280
3507
|
"x-f5xc-required-for": {
|
|
@@ -3295,6 +3522,8 @@
|
|
|
3295
3522
|
"x-displayname": "Tenant",
|
|
3296
3523
|
"x-ves-example": "Example-corp.",
|
|
3297
3524
|
"x-f5xc-example": "example-corp",
|
|
3525
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
3526
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
3298
3527
|
"minLength": 0,
|
|
3299
3528
|
"maxLength": 18,
|
|
3300
3529
|
"x-f5xc-required-for": {
|
|
@@ -3306,7 +3535,7 @@
|
|
|
3306
3535
|
"x-field-mutability": "read-only",
|
|
3307
3536
|
"x-original-maxLength": 1024,
|
|
3308
3537
|
"x-reconciled-from-discovery": true,
|
|
3309
|
-
"x-reconciled-at": "2026-01-
|
|
3538
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516674+00:00"
|
|
3310
3539
|
},
|
|
3311
3540
|
"uid": {
|
|
3312
3541
|
"type": "string",
|
|
@@ -3315,6 +3544,8 @@
|
|
|
3315
3544
|
"x-displayname": "UID",
|
|
3316
3545
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
3317
3546
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
3547
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
3548
|
+
"x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.",
|
|
3318
3549
|
"minLength": 0,
|
|
3319
3550
|
"maxLength": 36,
|
|
3320
3551
|
"x-f5xc-required-for": {
|
|
@@ -3327,9 +3558,11 @@
|
|
|
3327
3558
|
"x-original-maxLength": 1024,
|
|
3328
3559
|
"format": "uuid",
|
|
3329
3560
|
"x-reconciled-from-discovery": true,
|
|
3330
|
-
"x-reconciled-at": "2026-01-
|
|
3561
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516679+00:00"
|
|
3331
3562
|
}
|
|
3332
3563
|
},
|
|
3564
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
3565
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
3333
3566
|
"x-f5xc-minimum-configuration": {
|
|
3334
3567
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
3335
3568
|
"required_fields": [
|
|
@@ -3377,7 +3610,7 @@
|
|
|
3377
3610
|
},
|
|
3378
3611
|
"x-original-maxLength": 1024,
|
|
3379
3612
|
"x-reconciled-from-discovery": true,
|
|
3380
|
-
"x-reconciled-at": "2026-01-
|
|
3613
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516684+00:00"
|
|
3381
3614
|
},
|
|
3382
3615
|
"name": {
|
|
3383
3616
|
"type": "string",
|
|
@@ -3386,6 +3619,8 @@
|
|
|
3386
3619
|
"x-displayname": "Name",
|
|
3387
3620
|
"x-ves-example": "Contactus-route.",
|
|
3388
3621
|
"x-f5xc-example": "contactus-route",
|
|
3622
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
3623
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
3389
3624
|
"minLength": 0,
|
|
3390
3625
|
"maxLength": 16,
|
|
3391
3626
|
"x-f5xc-required-for": {
|
|
@@ -3396,7 +3631,7 @@
|
|
|
3396
3631
|
},
|
|
3397
3632
|
"x-original-maxLength": 1024,
|
|
3398
3633
|
"x-reconciled-from-discovery": true,
|
|
3399
|
-
"x-reconciled-at": "2026-01-
|
|
3634
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516688+00:00"
|
|
3400
3635
|
},
|
|
3401
3636
|
"namespace": {
|
|
3402
3637
|
"type": "string",
|
|
@@ -3405,6 +3640,8 @@
|
|
|
3405
3640
|
"x-displayname": "Namespace",
|
|
3406
3641
|
"x-ves-example": "Ns1",
|
|
3407
3642
|
"x-f5xc-example": "ns1",
|
|
3643
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
3644
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
3408
3645
|
"minLength": 0,
|
|
3409
3646
|
"maxLength": 6,
|
|
3410
3647
|
"x-f5xc-required-for": {
|
|
@@ -3415,7 +3652,7 @@
|
|
|
3415
3652
|
},
|
|
3416
3653
|
"x-original-maxLength": 1024,
|
|
3417
3654
|
"x-reconciled-from-discovery": true,
|
|
3418
|
-
"x-reconciled-at": "2026-01-
|
|
3655
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516692+00:00"
|
|
3419
3656
|
},
|
|
3420
3657
|
"uid": {
|
|
3421
3658
|
"type": "string",
|
|
@@ -3436,9 +3673,10 @@
|
|
|
3436
3673
|
"x-original-maxLength": 1024,
|
|
3437
3674
|
"format": "uuid",
|
|
3438
3675
|
"x-reconciled-from-discovery": true,
|
|
3439
|
-
"x-reconciled-at": "2026-01-
|
|
3676
|
+
"x-reconciled-at": "2026-01-07T15:28:55.516696+00:00"
|
|
3440
3677
|
}
|
|
3441
3678
|
},
|
|
3679
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
3442
3680
|
"x-f5xc-minimum-configuration": {
|
|
3443
3681
|
"description": "Minimum configuration for schemaViewRefType",
|
|
3444
3682
|
"required_fields": [
|