@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 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.
Files changed (47) hide show
  1. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  2. package/dist/tools/generated/ce_management/index.js +179 -1582
  3. package/dist/tools/generated/ce_management/index.js.map +1 -1
  4. package/dist/tools/generated/dependency-graph.json +2 -265
  5. package/dist/version.d.ts +2 -2
  6. package/dist/version.js +2 -2
  7. package/manifest.json +1 -1
  8. package/package.json +1 -1
  9. package/specs/domains/admin_console_and_ui.json +111 -25
  10. package/specs/domains/ai_services.json +114 -35
  11. package/specs/domains/api.json +1082 -177
  12. package/specs/domains/authentication.json +205 -45
  13. package/specs/domains/bigip.json +593 -101
  14. package/specs/domains/billing_and_usage.json +440 -82
  15. package/specs/domains/blindfold.json +713 -110
  16. package/specs/domains/bot_and_threat_defense.json +359 -65
  17. package/specs/domains/cdn.json +2131 -194
  18. package/specs/domains/ce_management.json +9110 -15844
  19. package/specs/domains/certificates.json +362 -75
  20. package/specs/domains/cloud_infrastructure.json +802 -119
  21. package/specs/domains/container_services.json +613 -95
  22. package/specs/domains/data_and_privacy_security.json +364 -66
  23. package/specs/domains/data_intelligence.json +324 -63
  24. package/specs/domains/ddos.json +766 -159
  25. package/specs/domains/dns.json +820 -161
  26. package/specs/domains/managed_kubernetes.json +455 -85
  27. package/specs/domains/marketplace.json +670 -104
  28. package/specs/domains/network.json +1620 -238
  29. package/specs/domains/network_security.json +1401 -191
  30. package/specs/domains/nginx_one.json +326 -62
  31. package/specs/domains/object_storage.json +49 -15
  32. package/specs/domains/observability.json +999 -147
  33. package/specs/domains/rate_limiting.json +300 -55
  34. package/specs/domains/secops_and_incident_response.json +189 -36
  35. package/specs/domains/service_mesh.json +955 -124
  36. package/specs/domains/shape.json +2150 -397
  37. package/specs/domains/sites.json +3830 -364
  38. package/specs/domains/statistics.json +2117 -235
  39. package/specs/domains/support.json +602 -108
  40. package/specs/domains/telemetry_and_insights.json +753 -79
  41. package/specs/domains/tenant_and_identity.json +1874 -308
  42. package/specs/domains/threat_campaign.json +637 -71
  43. package/specs/domains/users.json +278 -66
  44. package/specs/domains/virtual.json +2803 -260
  45. package/specs/domains/vpm_and_node_management.json +3 -1
  46. package/specs/domains/waf.json +1125 -148
  47. package/specs/index.json +24 -24
@@ -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.13",
6
+ "version": "2.0.19",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -1273,6 +1273,7 @@
1273
1273
  "title": "Empty",
1274
1274
  "x-displayname": "Empty",
1275
1275
  "x-ves-proto-message": "ves.io.schema.Empty",
1276
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
1276
1277
  "x-f5xc-minimum-configuration": {
1277
1278
  "description": "Minimum configuration for ioschemaEmpty",
1278
1279
  "required_fields": [],
@@ -1349,6 +1350,8 @@
1349
1350
  "$ref": "#/components/schemas/malicious_user_mitigationMaliciousUserMitigationType"
1350
1351
  }
1351
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.",
1352
1355
  "x-f5xc-minimum-configuration": {
1353
1356
  "description": "Minimum configuration for malicious_user_mitigationCreateSpecType",
1354
1357
  "required_fields": [
@@ -1374,6 +1377,7 @@
1374
1377
  "title": "Fail_if_referred.",
1375
1378
  "format": "boolean",
1376
1379
  "x-displayname": "Fail-If-Referred.",
1380
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
1377
1381
  "x-f5xc-required-for": {
1378
1382
  "minimum_config": false,
1379
1383
  "create": false,
@@ -1398,7 +1402,7 @@
1398
1402
  },
1399
1403
  "x-original-maxLength": 1024,
1400
1404
  "x-reconciled-from-discovery": true,
1401
- "x-reconciled-at": "2026-01-05T18:29:33.213888+00:00"
1405
+ "x-reconciled-at": "2026-01-07T15:28:55.516420+00:00"
1402
1406
  },
1403
1407
  "namespace": {
1404
1408
  "type": "string",
@@ -1407,6 +1411,7 @@
1407
1411
  "x-displayname": "Namespace",
1408
1412
  "x-ves-example": "Ns1",
1409
1413
  "x-f5xc-example": "ns1",
1414
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
1410
1415
  "minLength": 0,
1411
1416
  "maxLength": 6,
1412
1417
  "x-f5xc-required-for": {
@@ -1417,7 +1422,7 @@
1417
1422
  },
1418
1423
  "x-original-maxLength": 1024,
1419
1424
  "x-reconciled-from-discovery": true,
1420
- "x-reconciled-at": "2026-01-05T18:29:33.213895+00:00"
1425
+ "x-reconciled-at": "2026-01-07T15:28:55.516427+00:00"
1421
1426
  }
1422
1427
  },
1423
1428
  "x-f5xc-minimum-configuration": {
@@ -1452,6 +1457,7 @@
1452
1457
  "$ref": "#/components/schemas/schemaObjectRefType"
1453
1458
  },
1454
1459
  "x-displayname": "Deleted Referred Objects.",
1460
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
1455
1461
  "x-f5xc-required-for": {
1456
1462
  "minimum_config": false,
1457
1463
  "create": false,
@@ -1467,6 +1473,7 @@
1467
1473
  "$ref": "#/components/schemas/schemaObjectRefType"
1468
1474
  },
1469
1475
  "x-displayname": "Disabled Referred Objects.",
1476
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
1470
1477
  "x-f5xc-required-for": {
1471
1478
  "minimum_config": false,
1472
1479
  "create": false,
@@ -1485,6 +1492,7 @@
1485
1492
  "$ref": "#/components/schemas/schemaObjectRefType"
1486
1493
  },
1487
1494
  "x-displayname": "Referring Objects.",
1495
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
1488
1496
  "x-f5xc-required-for": {
1489
1497
  "minimum_config": false,
1490
1498
  "create": false,
@@ -1506,6 +1514,8 @@
1506
1514
  "$ref": "#/components/schemas/malicious_user_mitigationStatusObject"
1507
1515
  },
1508
1516
  "x-displayname": "Status",
1517
+ "x-f5xc-example": "active",
1518
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
1509
1519
  "x-f5xc-required-for": {
1510
1520
  "minimum_config": false,
1511
1521
  "create": false,
@@ -1515,7 +1525,7 @@
1515
1525
  "maxLength": 17,
1516
1526
  "minLength": 17,
1517
1527
  "x-reconciled-from-discovery": true,
1518
- "x-reconciled-at": "2026-01-05T18:29:33.213911+00:00"
1528
+ "x-reconciled-at": "2026-01-07T15:28:55.516443+00:00"
1519
1529
  },
1520
1530
  "system_metadata": {
1521
1531
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -1555,6 +1565,8 @@
1555
1565
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
1556
1566
  ],
1557
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...",
1558
1570
  "x-f5xc-minimum-configuration": {
1559
1571
  "description": "Minimum configuration for malicious_user_mitigationGetResponseFormatCode",
1560
1572
  "required_fields": [],
@@ -1576,6 +1588,7 @@
1576
1588
  "$ref": "#/components/schemas/malicious_user_mitigationMaliciousUserMitigationType"
1577
1589
  }
1578
1590
  },
1591
+ "x-f5xc-description-short": "GET malicious_user_mitigation reads a given object from storage backend for metadata.namespace.",
1579
1592
  "x-f5xc-minimum-configuration": {
1580
1593
  "description": "Minimum configuration for malicious_user_mitigationGetSpecType",
1581
1594
  "required_fields": [
@@ -1603,6 +1616,7 @@
1603
1616
  "$ref": "#/components/schemas/schemaErrorType"
1604
1617
  },
1605
1618
  "x-displayname": "Errors",
1619
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
1606
1620
  "x-f5xc-required-for": {
1607
1621
  "minimum_config": false,
1608
1622
  "create": false,
@@ -1618,6 +1632,8 @@
1618
1632
  "$ref": "#/components/schemas/malicious_user_mitigationListResponseItem"
1619
1633
  },
1620
1634
  "x-displayname": "Items",
1635
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
1636
+ "x-f5xc-description-short": "Items represents the collection in response.",
1621
1637
  "x-f5xc-required-for": {
1622
1638
  "minimum_config": false,
1623
1639
  "create": false,
@@ -1651,6 +1667,8 @@
1651
1667
  "description": "The set of annotations present on this malicious_user_mitigation.",
1652
1668
  "title": "Annotations.",
1653
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.",
1654
1672
  "x-f5xc-required-for": {
1655
1673
  "minimum_config": false,
1656
1674
  "create": false,
@@ -1663,6 +1681,7 @@
1663
1681
  "description": "The description set for this malicious_user_mitigation.",
1664
1682
  "title": "Description.",
1665
1683
  "x-displayname": "Description.",
1684
+ "x-f5xc-description-short": "The description set for this malicious_user_mitigation.",
1666
1685
  "minLength": 0,
1667
1686
  "maxLength": 0,
1668
1687
  "x-f5xc-required-for": {
@@ -1673,7 +1692,7 @@
1673
1692
  },
1674
1693
  "x-original-maxLength": 1024,
1675
1694
  "x-reconciled-from-discovery": true,
1676
- "x-reconciled-at": "2026-01-05T18:29:33.213926+00:00"
1695
+ "x-reconciled-at": "2026-01-07T15:28:55.516457+00:00"
1677
1696
  },
1678
1697
  "disabled": {
1679
1698
  "type": "boolean",
@@ -1681,6 +1700,8 @@
1681
1700
  "title": "Disabled",
1682
1701
  "format": "boolean",
1683
1702
  "x-displayname": "Disabled",
1703
+ "x-f5xc-example": "True",
1704
+ "x-f5xc-description-short": "Value of true indicates malicious_user_mitigation is administratively disabled.",
1684
1705
  "x-f5xc-required-for": {
1685
1706
  "minimum_config": false,
1686
1707
  "create": false,
@@ -1696,6 +1717,8 @@
1696
1717
  "description": "The set of labels present on this malicious_user_mitigation.",
1697
1718
  "title": "Labels",
1698
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.",
1699
1722
  "x-f5xc-required-for": {
1700
1723
  "minimum_config": false,
1701
1724
  "create": false,
@@ -1713,6 +1736,7 @@
1713
1736
  "x-displayname": "Name",
1714
1737
  "x-ves-example": "Name",
1715
1738
  "x-f5xc-example": "name",
1739
+ "x-f5xc-description-short": "The name of this malicious_user_mitigation.",
1716
1740
  "minLength": 0,
1717
1741
  "maxLength": 16,
1718
1742
  "x-f5xc-required-for": {
@@ -1723,7 +1747,7 @@
1723
1747
  },
1724
1748
  "x-original-maxLength": 1024,
1725
1749
  "x-reconciled-from-discovery": true,
1726
- "x-reconciled-at": "2026-01-05T18:29:33.213936+00:00"
1750
+ "x-reconciled-at": "2026-01-07T15:28:55.516467+00:00"
1727
1751
  },
1728
1752
  "namespace": {
1729
1753
  "type": "string",
@@ -1742,7 +1766,7 @@
1742
1766
  },
1743
1767
  "x-original-maxLength": 1024,
1744
1768
  "x-reconciled-from-discovery": true,
1745
- "x-reconciled-at": "2026-01-05T18:29:33.213940+00:00"
1769
+ "x-reconciled-at": "2026-01-07T15:28:55.516471+00:00"
1746
1770
  },
1747
1771
  "owner_view": {
1748
1772
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -1755,6 +1779,7 @@
1755
1779
  "$ref": "#/components/schemas/malicious_user_mitigationStatusObject"
1756
1780
  },
1757
1781
  "x-displayname": "Status",
1782
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
1758
1783
  "x-f5xc-required-for": {
1759
1784
  "minimum_config": false,
1760
1785
  "create": false,
@@ -1783,7 +1808,7 @@
1783
1808
  "x-field-mutability": "read-only",
1784
1809
  "x-original-maxLength": 1024,
1785
1810
  "x-reconciled-from-discovery": true,
1786
- "x-reconciled-at": "2026-01-05T18:29:33.213948+00:00"
1811
+ "x-reconciled-at": "2026-01-07T15:28:55.516479+00:00"
1787
1812
  },
1788
1813
  "uid": {
1789
1814
  "type": "string",
@@ -1792,6 +1817,7 @@
1792
1817
  "x-displayname": "UID",
1793
1818
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
1794
1819
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
1820
+ "x-f5xc-description-short": "The unique uid of this malicious_user_mitigation.",
1795
1821
  "minLength": 0,
1796
1822
  "maxLength": 36,
1797
1823
  "x-f5xc-required-for": {
@@ -1804,9 +1830,11 @@
1804
1830
  "x-original-maxLength": 1024,
1805
1831
  "format": "uuid",
1806
1832
  "x-reconciled-from-discovery": true,
1807
- "x-reconciled-at": "2026-01-05T18:29:33.213953+00:00"
1833
+ "x-reconciled-at": "2026-01-07T15:28:55.516485+00:00"
1808
1834
  }
1809
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.",
1810
1838
  "x-f5xc-minimum-configuration": {
1811
1839
  "description": "Minimum configuration for malicious_user_mitigationListResponseItem",
1812
1840
  "required_fields": [
@@ -1849,6 +1877,7 @@
1849
1877
  "$ref": "#/components/schemas/ioschemaEmpty"
1850
1878
  }
1851
1879
  },
1880
+ "x-f5xc-description-short": "Supported actions that can be taken to mitigate malicious activity from a user.",
1852
1881
  "x-f5xc-minimum-configuration": {
1853
1882
  "description": "Minimum configuration for malicious_user_mitigationMaliciousUserMitigationAction",
1854
1883
  "required_fields": [
@@ -1877,6 +1906,8 @@
1877
1906
  "$ref": "#/components/schemas/malicious_user_mitigationMaliciousUserThreatLevel"
1878
1907
  }
1879
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.",
1880
1911
  "x-f5xc-minimum-configuration": {
1881
1912
  "description": "Minimum configuration for malicious_user_mitigationMaliciousUserMitigationRule",
1882
1913
  "required_fields": [
@@ -1919,6 +1950,8 @@
1919
1950
  "ves.io.schema.rules.repeated.unique": "true",
1920
1951
  "ves.io.schema.rules.repeated.unique_threat_level": "true"
1921
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.",
1922
1955
  "x-f5xc-required-for": {
1923
1956
  "minimum_config": false,
1924
1957
  "create": false,
@@ -1927,6 +1960,8 @@
1927
1960
  }
1928
1961
  }
1929
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.",
1930
1965
  "x-f5xc-minimum-configuration": {
1931
1966
  "description": "Minimum configuration for malicious_user_mitigationMaliciousUserMitigationType",
1932
1967
  "required_fields": [
@@ -1957,6 +1992,7 @@
1957
1992
  "$ref": "#/components/schemas/ioschemaEmpty"
1958
1993
  }
1959
1994
  },
1995
+ "x-f5xc-description-short": "Threat level estimated for each user based on the user's activity and reputation.",
1960
1996
  "x-f5xc-minimum-configuration": {
1961
1997
  "description": "Minimum configuration for malicious_user_mitigationMaliciousUserThreatLevel",
1962
1998
  "required_fields": [
@@ -2022,6 +2058,8 @@
2022
2058
  "$ref": "#/components/schemas/malicious_user_mitigationMaliciousUserMitigationType"
2023
2059
  }
2024
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.",
2025
2063
  "x-f5xc-minimum-configuration": {
2026
2064
  "description": "Minimum configuration for malicious_user_mitigationReplaceSpecType",
2027
2065
  "required_fields": [
@@ -2049,6 +2087,7 @@
2049
2087
  "$ref": "#/components/schemas/schemaConditionType"
2050
2088
  },
2051
2089
  "x-displayname": "Conditions.",
2090
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
2052
2091
  "x-f5xc-required-for": {
2053
2092
  "minimum_config": false,
2054
2093
  "create": false,
@@ -2075,6 +2114,7 @@
2075
2114
  }
2076
2115
  }
2077
2116
  },
2117
+ "x-f5xc-description-short": "Most recently observed status of object.",
2078
2118
  "x-f5xc-minimum-configuration": {
2079
2119
  "description": "Minimum configuration for malicious_user_mitigationStatusObject",
2080
2120
  "required_fields": [
@@ -2096,6 +2136,8 @@
2096
2136
  "type_url": {
2097
2137
  "type": "string",
2098
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 ).",
2099
2141
  "minLength": 0,
2100
2142
  "maxLength": 1024,
2101
2143
  "x-f5xc-required-for": {
@@ -2119,9 +2161,11 @@
2119
2161
  },
2120
2162
  "x-original-maxLength": 1024,
2121
2163
  "x-reconciled-from-discovery": true,
2122
- "x-reconciled-at": "2026-01-05T18:29:33.213981+00:00"
2164
+ "x-reconciled-at": "2026-01-07T15:28:55.516527+00:00"
2123
2165
  }
2124
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...",
2125
2169
  "x-f5xc-minimum-configuration": {
2126
2170
  "description": "Minimum configuration for protobufAny",
2127
2171
  "required_fields": [
@@ -2147,6 +2191,8 @@
2147
2191
  "description": "Hostname of the instance of the site that sent the status.",
2148
2192
  "title": "Hostname",
2149
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.",
2150
2196
  "minLength": 0,
2151
2197
  "maxLength": 1024,
2152
2198
  "x-f5xc-required-for": {
@@ -2178,6 +2224,8 @@
2178
2224
  "x-displayname": "Reason",
2179
2225
  "x-ves-example": "Value",
2180
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.",
2181
2229
  "minLength": 0,
2182
2230
  "maxLength": 43,
2183
2231
  "x-f5xc-required-for": {
@@ -2188,13 +2236,15 @@
2188
2236
  },
2189
2237
  "x-original-maxLength": 1024,
2190
2238
  "x-reconciled-from-discovery": true,
2191
- "x-reconciled-at": "2026-01-05T18:29:33.213989+00:00"
2239
+ "x-reconciled-at": "2026-01-07T15:28:55.516536+00:00"
2192
2240
  },
2193
2241
  "service_name": {
2194
2242
  "type": "string",
2195
2243
  "description": "Name of the service that sent the status.",
2196
2244
  "title": "Service name.",
2197
2245
  "x-displayname": "Service Name.",
2246
+ "x-f5xc-example": "example-resource",
2247
+ "x-f5xc-description-short": "Name of the service that sent the status.",
2198
2248
  "minLength": 0,
2199
2249
  "maxLength": 1024,
2200
2250
  "x-f5xc-required-for": {
@@ -2217,6 +2267,8 @@
2217
2267
  "x-validation-rules": {
2218
2268
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
2219
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...",
2220
2272
  "minLength": 0,
2221
2273
  "maxLength": 17,
2222
2274
  "x-f5xc-required-for": {
@@ -2227,7 +2279,7 @@
2227
2279
  },
2228
2280
  "x-original-maxLength": 1024,
2229
2281
  "x-reconciled-from-discovery": true,
2230
- "x-reconciled-at": "2026-01-05T18:29:33.213995+00:00"
2282
+ "x-reconciled-at": "2026-01-07T15:28:55.516541+00:00"
2231
2283
  },
2232
2284
  "type": {
2233
2285
  "type": "string",
@@ -2242,6 +2294,8 @@
2242
2294
  "x-validation-rules": {
2243
2295
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
2244
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.",
2245
2299
  "minLength": 0,
2246
2300
  "maxLength": 1024,
2247
2301
  "x-f5xc-required-for": {
@@ -2252,6 +2306,8 @@
2252
2306
  }
2253
2307
  }
2254
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.",
2255
2311
  "x-f5xc-minimum-configuration": {
2256
2312
  "description": "Minimum configuration for schemaConditionType",
2257
2313
  "required_fields": [
@@ -2287,6 +2343,8 @@
2287
2343
  "default": "EOK",
2288
2344
  "x-displayname": "Error Code.",
2289
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...",
2290
2348
  "x-f5xc-minimum-configuration": {
2291
2349
  "description": "Minimum configuration for schemaErrorCode",
2292
2350
  "required_fields": [],
@@ -2327,6 +2385,7 @@
2327
2385
  }
2328
2386
  }
2329
2387
  },
2388
+ "x-f5xc-description-short": "Information about a error in API operation.",
2330
2389
  "x-f5xc-minimum-configuration": {
2331
2390
  "description": "Minimum configuration for schemaErrorType",
2332
2391
  "required_fields": [
@@ -2354,6 +2413,7 @@
2354
2413
  "title": "Name",
2355
2414
  "x-displayname": "Name",
2356
2415
  "x-f5xc-example": "example-resource",
2416
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
2357
2417
  "minLength": 0,
2358
2418
  "maxLength": 16,
2359
2419
  "x-f5xc-required-for": {
@@ -2364,9 +2424,10 @@
2364
2424
  },
2365
2425
  "x-original-maxLength": 1024,
2366
2426
  "x-reconciled-from-discovery": true,
2367
- "x-reconciled-at": "2026-01-05T18:29:33.214006+00:00"
2427
+ "x-reconciled-at": "2026-01-07T15:28:55.516552+00:00"
2368
2428
  }
2369
2429
  },
2430
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
2370
2431
  "x-f5xc-minimum-configuration": {
2371
2432
  "description": "Minimum configuration for schemaInitializerType",
2372
2433
  "required_fields": [
@@ -2394,6 +2455,8 @@
2394
2455
  "$ref": "#/components/schemas/schemaInitializerType"
2395
2456
  },
2396
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.",
2397
2460
  "x-f5xc-required-for": {
2398
2461
  "minimum_config": false,
2399
2462
  "create": false,
@@ -2405,6 +2468,7 @@
2405
2468
  "$ref": "#/components/schemas/schemaStatusType"
2406
2469
  }
2407
2470
  },
2471
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
2408
2472
  "x-f5xc-minimum-configuration": {
2409
2473
  "description": "Minimum configuration for schemaInitializersType",
2410
2474
  "required_fields": [
@@ -2443,6 +2507,8 @@
2443
2507
  "ves.io.schema.rules.map.values.string.max_len": "1024",
2444
2508
  "ves.io.schema.rules.map.values.string.min_len": "1"
2445
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.",
2446
2512
  "x-f5xc-required-for": {
2447
2513
  "minimum_config": false,
2448
2514
  "create": false,
@@ -2464,6 +2530,7 @@
2464
2530
  "x-validation-rules": {
2465
2531
  "ves.io.schema.rules.string.max_bytes": "1200"
2466
2532
  },
2533
+ "x-f5xc-description-short": "Human readable description for the object.",
2467
2534
  "minLength": 0,
2468
2535
  "x-f5xc-required-for": {
2469
2536
  "minimum_config": false,
@@ -2473,7 +2540,7 @@
2473
2540
  },
2474
2541
  "x-original-maxLength": 1200,
2475
2542
  "x-reconciled-from-discovery": true,
2476
- "x-reconciled-at": "2026-01-05T18:29:33.214016+00:00"
2543
+ "x-reconciled-at": "2026-01-07T15:28:55.516562+00:00"
2477
2544
  },
2478
2545
  "disable": {
2479
2546
  "type": "boolean",
@@ -2482,6 +2549,7 @@
2482
2549
  "format": "boolean",
2483
2550
  "x-displayname": "Disable",
2484
2551
  "x-f5xc-example": "true",
2552
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
2485
2553
  "x-f5xc-required-for": {
2486
2554
  "minimum_config": false,
2487
2555
  "create": false,
@@ -2495,6 +2563,8 @@
2495
2563
  "title": "Labels",
2496
2564
  "x-displayname": "Labels",
2497
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.",
2498
2568
  "x-f5xc-required-for": {
2499
2569
  "minimum_config": false,
2500
2570
  "create": false,
@@ -2516,6 +2586,8 @@
2516
2586
  "x-validation-rules": {
2517
2587
  "ves.io.schema.rules.message.required": "true"
2518
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.",
2519
2591
  "minLength": 0,
2520
2592
  "maxLength": 16,
2521
2593
  "x-f5xc-required-for": {
@@ -2526,7 +2598,7 @@
2526
2598
  },
2527
2599
  "x-original-maxLength": 1024,
2528
2600
  "x-reconciled-from-discovery": true,
2529
- "x-reconciled-at": "2026-01-05T18:29:33.214023+00:00"
2601
+ "x-reconciled-at": "2026-01-07T15:28:55.516570+00:00"
2530
2602
  },
2531
2603
  "namespace": {
2532
2604
  "type": "string",
@@ -2535,6 +2607,8 @@
2535
2607
  "x-displayname": "Namespace",
2536
2608
  "x-ves-example": "Staging",
2537
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 \"\".",
2538
2612
  "minLength": 0,
2539
2613
  "maxLength": 6,
2540
2614
  "x-f5xc-required-for": {
@@ -2545,9 +2619,10 @@
2545
2619
  },
2546
2620
  "x-original-maxLength": 1024,
2547
2621
  "x-reconciled-from-discovery": true,
2548
- "x-reconciled-at": "2026-01-05T18:29:33.214027+00:00"
2622
+ "x-reconciled-at": "2026-01-07T15:28:55.516574+00:00"
2549
2623
  }
2550
2624
  },
2625
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
2551
2626
  "x-f5xc-minimum-configuration": {
2552
2627
  "description": "Minimum configuration for schemaObjectCreateMetaType",
2553
2628
  "required_fields": [
@@ -2591,6 +2666,8 @@
2591
2666
  "ves.io.schema.rules.map.values.string.max_len": "1024",
2592
2667
  "ves.io.schema.rules.map.values.string.min_len": "1"
2593
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.",
2594
2671
  "x-f5xc-required-for": {
2595
2672
  "minimum_config": false,
2596
2673
  "create": false,
@@ -2612,6 +2689,7 @@
2612
2689
  "x-validation-rules": {
2613
2690
  "ves.io.schema.rules.string.max_bytes": "1200"
2614
2691
  },
2692
+ "x-f5xc-description-short": "Human readable description for the object.",
2615
2693
  "minLength": 0,
2616
2694
  "x-f5xc-required-for": {
2617
2695
  "minimum_config": false,
@@ -2621,7 +2699,7 @@
2621
2699
  },
2622
2700
  "x-original-maxLength": 1200,
2623
2701
  "x-reconciled-from-discovery": true,
2624
- "x-reconciled-at": "2026-01-05T18:29:33.214046+00:00"
2702
+ "x-reconciled-at": "2026-01-07T15:28:55.516580+00:00"
2625
2703
  },
2626
2704
  "disable": {
2627
2705
  "type": "boolean",
@@ -2631,6 +2709,7 @@
2631
2709
  "x-displayname": "Disable",
2632
2710
  "x-ves-example": "True",
2633
2711
  "x-f5xc-example": "true",
2712
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
2634
2713
  "x-f5xc-required-for": {
2635
2714
  "minimum_config": false,
2636
2715
  "create": false,
@@ -2645,6 +2724,8 @@
2645
2724
  "x-displayname": "Labels",
2646
2725
  "x-ves-example": "Value",
2647
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.",
2648
2729
  "x-f5xc-required-for": {
2649
2730
  "minimum_config": false,
2650
2731
  "create": false,
@@ -2666,6 +2747,8 @@
2666
2747
  "x-validation-rules": {
2667
2748
  "ves.io.schema.rules.message.required": "true"
2668
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.",
2669
2752
  "minLength": 0,
2670
2753
  "maxLength": 16,
2671
2754
  "x-f5xc-required-for": {
@@ -2676,7 +2759,7 @@
2676
2759
  },
2677
2760
  "x-original-maxLength": 1024,
2678
2761
  "x-reconciled-from-discovery": true,
2679
- "x-reconciled-at": "2026-01-05T18:29:33.214053+00:00"
2762
+ "x-reconciled-at": "2026-01-07T15:28:55.516587+00:00"
2680
2763
  },
2681
2764
  "namespace": {
2682
2765
  "type": "string",
@@ -2685,6 +2768,8 @@
2685
2768
  "x-displayname": "Namespace",
2686
2769
  "x-ves-example": "Staging",
2687
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 \"\".",
2688
2773
  "minLength": 0,
2689
2774
  "maxLength": 6,
2690
2775
  "x-f5xc-required-for": {
@@ -2695,9 +2780,10 @@
2695
2780
  },
2696
2781
  "x-original-maxLength": 1024,
2697
2782
  "x-reconciled-from-discovery": true,
2698
- "x-reconciled-at": "2026-01-05T18:29:33.214057+00:00"
2783
+ "x-reconciled-at": "2026-01-07T15:28:55.516591+00:00"
2699
2784
  }
2700
2785
  },
2786
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
2701
2787
  "x-f5xc-minimum-configuration": {
2702
2788
  "description": "Minimum configuration for schemaObjectGetMetaType",
2703
2789
  "required_fields": [
@@ -2729,6 +2815,8 @@
2729
2815
  "x-displayname": "Kind",
2730
2816
  "x-ves-example": "Virtual_site.",
2731
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\").",
2732
2820
  "minLength": 0,
2733
2821
  "maxLength": 14,
2734
2822
  "x-f5xc-required-for": {
@@ -2740,7 +2828,7 @@
2740
2828
  "readOnly": true,
2741
2829
  "x-original-maxLength": 1024,
2742
2830
  "x-reconciled-from-discovery": true,
2743
- "x-reconciled-at": "2026-01-05T18:29:33.214062+00:00"
2831
+ "x-reconciled-at": "2026-01-07T15:28:55.516595+00:00"
2744
2832
  },
2745
2833
  "name": {
2746
2834
  "type": "string",
@@ -2749,6 +2837,8 @@
2749
2837
  "x-displayname": "Name",
2750
2838
  "x-ves-example": "Contactus-route.",
2751
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.",
2752
2842
  "minLength": 0,
2753
2843
  "maxLength": 16,
2754
2844
  "x-f5xc-required-for": {
@@ -2759,7 +2849,7 @@
2759
2849
  },
2760
2850
  "x-original-maxLength": 1024,
2761
2851
  "x-reconciled-from-discovery": true,
2762
- "x-reconciled-at": "2026-01-05T18:29:33.214066+00:00"
2852
+ "x-reconciled-at": "2026-01-07T15:28:55.516599+00:00"
2763
2853
  },
2764
2854
  "namespace": {
2765
2855
  "type": "string",
@@ -2768,6 +2858,8 @@
2768
2858
  "x-displayname": "Namespace",
2769
2859
  "x-ves-example": "Ns1",
2770
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.",
2771
2863
  "minLength": 0,
2772
2864
  "maxLength": 6,
2773
2865
  "x-f5xc-required-for": {
@@ -2778,7 +2870,7 @@
2778
2870
  },
2779
2871
  "x-original-maxLength": 1024,
2780
2872
  "x-reconciled-from-discovery": true,
2781
- "x-reconciled-at": "2026-01-05T18:29:33.214069+00:00"
2873
+ "x-reconciled-at": "2026-01-07T15:28:55.516603+00:00"
2782
2874
  },
2783
2875
  "tenant": {
2784
2876
  "type": "string",
@@ -2787,6 +2879,8 @@
2787
2879
  "x-displayname": "Tenant",
2788
2880
  "x-ves-example": "Example-corp.",
2789
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.",
2790
2884
  "minLength": 0,
2791
2885
  "maxLength": 18,
2792
2886
  "x-f5xc-required-for": {
@@ -2799,7 +2893,7 @@
2799
2893
  "x-field-mutability": "read-only",
2800
2894
  "x-original-maxLength": 1024,
2801
2895
  "x-reconciled-from-discovery": true,
2802
- "x-reconciled-at": "2026-01-05T18:29:33.214073+00:00"
2896
+ "x-reconciled-at": "2026-01-07T15:28:55.516607+00:00"
2803
2897
  },
2804
2898
  "uid": {
2805
2899
  "type": "string",
@@ -2808,6 +2902,8 @@
2808
2902
  "x-displayname": "UID",
2809
2903
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
2810
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.",
2811
2907
  "minLength": 0,
2812
2908
  "maxLength": 36,
2813
2909
  "x-f5xc-required-for": {
@@ -2821,9 +2917,11 @@
2821
2917
  "x-original-maxLength": 1024,
2822
2918
  "format": "uuid",
2823
2919
  "x-reconciled-from-discovery": true,
2824
- "x-reconciled-at": "2026-01-05T18:29:33.214078+00:00"
2920
+ "x-reconciled-at": "2026-01-07T15:28:55.516613+00:00"
2825
2921
  }
2826
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...",
2827
2925
  "x-f5xc-minimum-configuration": {
2828
2926
  "description": "Minimum configuration for schemaObjectRefType",
2829
2927
  "required_fields": [
@@ -2866,6 +2964,8 @@
2866
2964
  "ves.io.schema.rules.map.values.string.max_len": "1024",
2867
2965
  "ves.io.schema.rules.map.values.string.min_len": "1"
2868
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.",
2869
2969
  "x-f5xc-required-for": {
2870
2970
  "minimum_config": false,
2871
2971
  "create": false,
@@ -2887,6 +2987,7 @@
2887
2987
  "x-validation-rules": {
2888
2988
  "ves.io.schema.rules.string.max_bytes": "1200"
2889
2989
  },
2990
+ "x-f5xc-description-short": "Human readable description for the object.",
2890
2991
  "minLength": 0,
2891
2992
  "x-f5xc-required-for": {
2892
2993
  "minimum_config": false,
@@ -2896,7 +2997,7 @@
2896
2997
  },
2897
2998
  "x-original-maxLength": 1200,
2898
2999
  "x-reconciled-from-discovery": true,
2899
- "x-reconciled-at": "2026-01-05T18:29:33.214085+00:00"
3000
+ "x-reconciled-at": "2026-01-07T15:28:55.516619+00:00"
2900
3001
  },
2901
3002
  "disable": {
2902
3003
  "type": "boolean",
@@ -2905,6 +3006,7 @@
2905
3006
  "format": "boolean",
2906
3007
  "x-displayname": "Disable",
2907
3008
  "x-f5xc-example": "true",
3009
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
2908
3010
  "x-f5xc-required-for": {
2909
3011
  "minimum_config": false,
2910
3012
  "create": false,
@@ -2919,6 +3021,8 @@
2919
3021
  "x-displayname": "Labels",
2920
3022
  "x-ves-example": "Value",
2921
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.",
2922
3026
  "x-f5xc-required-for": {
2923
3027
  "minimum_config": false,
2924
3028
  "create": false,
@@ -2939,6 +3043,8 @@
2939
3043
  "x-validation-rules": {
2940
3044
  "ves.io.schema.rules.message.required": "true"
2941
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.",
2942
3048
  "minLength": 0,
2943
3049
  "maxLength": 16,
2944
3050
  "x-f5xc-required-for": {
@@ -2949,7 +3055,7 @@
2949
3055
  },
2950
3056
  "x-original-maxLength": 1024,
2951
3057
  "x-reconciled-from-discovery": true,
2952
- "x-reconciled-at": "2026-01-05T18:29:33.214092+00:00"
3058
+ "x-reconciled-at": "2026-01-07T15:28:55.516626+00:00"
2953
3059
  },
2954
3060
  "namespace": {
2955
3061
  "type": "string",
@@ -2958,6 +3064,8 @@
2958
3064
  "x-displayname": "Namespace",
2959
3065
  "x-ves-example": "Staging",
2960
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 \"\".",
2961
3069
  "minLength": 0,
2962
3070
  "maxLength": 6,
2963
3071
  "x-f5xc-required-for": {
@@ -2968,9 +3076,10 @@
2968
3076
  },
2969
3077
  "x-original-maxLength": 1024,
2970
3078
  "x-reconciled-from-discovery": true,
2971
- "x-reconciled-at": "2026-01-05T18:29:33.214096+00:00"
3079
+ "x-reconciled-at": "2026-01-07T15:28:55.516630+00:00"
2972
3080
  }
2973
3081
  },
3082
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
2974
3083
  "x-f5xc-minimum-configuration": {
2975
3084
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
2976
3085
  "required_fields": [
@@ -3001,6 +3110,8 @@
3001
3110
  "title": "Creation_timestamp.",
3002
3111
  "format": "date-time",
3003
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.",
3004
3115
  "minLength": 0,
3005
3116
  "maxLength": 1024,
3006
3117
  "x-f5xc-required-for": {
@@ -3018,6 +3129,8 @@
3018
3129
  "x-displayname": "Creator Class.",
3019
3130
  "x-ves-example": "ver.re1.int.ves.I/O.",
3020
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.",
3021
3134
  "minLength": 0,
3022
3135
  "maxLength": 1024,
3023
3136
  "x-f5xc-required-for": {
@@ -3035,6 +3148,8 @@
3035
3148
  "x-displayname": "Creator ID.",
3036
3149
  "x-ves-example": "Ver-instance-1.",
3037
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.",
3038
3153
  "minLength": 0,
3039
3154
  "maxLength": 1024,
3040
3155
  "x-f5xc-required-for": {
@@ -3053,6 +3168,8 @@
3053
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)",
3054
3169
  "title": "Status_id",
3055
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).",
3056
3173
  "minLength": 0,
3057
3174
  "maxLength": 1024,
3058
3175
  "x-f5xc-required-for": {
@@ -3070,6 +3187,7 @@
3070
3187
  "x-displayname": "UID",
3071
3188
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
3072
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.",
3073
3191
  "minLength": 0,
3074
3192
  "maxLength": 36,
3075
3193
  "x-f5xc-required-for": {
@@ -3082,13 +3200,14 @@
3082
3200
  "x-original-maxLength": 1024,
3083
3201
  "format": "uuid",
3084
3202
  "x-reconciled-from-discovery": true,
3085
- "x-reconciled-at": "2026-01-05T18:29:33.214109+00:00"
3203
+ "x-reconciled-at": "2026-01-07T15:28:55.516643+00:00"
3086
3204
  },
3087
3205
  "vtrp_id": {
3088
3206
  "type": "string",
3089
3207
  "description": "Origin of this status exchanged by VTRP.",
3090
3208
  "title": "Vtrp_id",
3091
3209
  "x-displayname": "VTRP ID",
3210
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
3092
3211
  "minLength": 0,
3093
3212
  "maxLength": 1024,
3094
3213
  "x-f5xc-required-for": {
@@ -3105,6 +3224,7 @@
3105
3224
  "title": "Vtrp_stale.",
3106
3225
  "format": "boolean",
3107
3226
  "x-displayname": "VTRP Stale.",
3227
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
3108
3228
  "x-f5xc-required-for": {
3109
3229
  "minimum_config": false,
3110
3230
  "create": false,
@@ -3113,6 +3233,7 @@
3113
3233
  }
3114
3234
  }
3115
3235
  },
3236
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
3116
3237
  "x-f5xc-minimum-configuration": {
3117
3238
  "description": "Minimum configuration for schemaStatusMetaType",
3118
3239
  "required_fields": [
@@ -3143,6 +3264,8 @@
3143
3264
  "default": "STATUS_DO_NOT_PUBLISH",
3144
3265
  "x-displayname": "Status Publish Type.",
3145
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.",
3146
3269
  "x-f5xc-minimum-configuration": {
3147
3270
  "description": "Minimum configuration for schemaStatusPublishType",
3148
3271
  "required_fields": [],
@@ -3168,6 +3291,7 @@
3168
3291
  "x-displayname": "Code",
3169
3292
  "x-ves-example": "0",
3170
3293
  "x-f5xc-example": "0",
3294
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
3171
3295
  "minimum": 0,
3172
3296
  "maximum": 2147483647,
3173
3297
  "x-f5xc-required-for": {
@@ -3184,6 +3308,8 @@
3184
3308
  "x-displayname": "Reason",
3185
3309
  "x-ves-example": "Value",
3186
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.",
3187
3313
  "minLength": 0,
3188
3314
  "maxLength": 43,
3189
3315
  "x-f5xc-required-for": {
@@ -3194,7 +3320,7 @@
3194
3320
  },
3195
3321
  "x-original-maxLength": 1024,
3196
3322
  "x-reconciled-from-discovery": true,
3197
- "x-reconciled-at": "2026-01-05T18:29:33.214118+00:00"
3323
+ "x-reconciled-at": "2026-01-07T15:28:55.516652+00:00"
3198
3324
  },
3199
3325
  "status": {
3200
3326
  "type": "string",
@@ -3203,6 +3329,7 @@
3203
3329
  "x-displayname": "Status",
3204
3330
  "x-ves-example": "Value",
3205
3331
  "x-f5xc-example": "value",
3332
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
3206
3333
  "minLength": 0,
3207
3334
  "maxLength": 17,
3208
3335
  "x-f5xc-required-for": {
@@ -3213,9 +3340,10 @@
3213
3340
  },
3214
3341
  "x-original-maxLength": 1024,
3215
3342
  "x-reconciled-from-discovery": true,
3216
- "x-reconciled-at": "2026-01-05T18:29:33.214123+00:00"
3343
+ "x-reconciled-at": "2026-01-07T15:28:55.516656+00:00"
3217
3344
  }
3218
3345
  },
3346
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
3219
3347
  "x-f5xc-minimum-configuration": {
3220
3348
  "description": "Minimum configuration for schemaStatusType",
3221
3349
  "required_fields": [
@@ -3243,6 +3371,8 @@
3243
3371
  "title": "Creation_timestamp.",
3244
3372
  "format": "date-time",
3245
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.",
3246
3376
  "minLength": 0,
3247
3377
  "maxLength": 1024,
3248
3378
  "x-f5xc-required-for": {
@@ -3260,6 +3390,7 @@
3260
3390
  "x-displayname": "Creator Class.",
3261
3391
  "x-ves-example": "Prism",
3262
3392
  "x-f5xc-example": "value",
3393
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
3263
3394
  "minLength": 0,
3264
3395
  "maxLength": 1024,
3265
3396
  "x-f5xc-required-for": {
@@ -3277,6 +3408,7 @@
3277
3408
  "x-displayname": "Creator ID.",
3278
3409
  "x-ves-example": "Admin@example-corp.com.",
3279
3410
  "x-f5xc-example": "value",
3411
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
3280
3412
  "minLength": 0,
3281
3413
  "maxLength": 1024,
3282
3414
  "x-f5xc-required-for": {
@@ -3293,6 +3425,8 @@
3293
3425
  "title": "Deletion_timestamp.",
3294
3426
  "format": "date-time",
3295
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...",
3296
3430
  "minLength": 0,
3297
3431
  "maxLength": 1024,
3298
3432
  "x-f5xc-required-for": {
@@ -3312,6 +3446,8 @@
3312
3446
  "x-displayname": "Finalizers.",
3313
3447
  "x-ves-example": "Value",
3314
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.",
3315
3451
  "x-f5xc-required-for": {
3316
3452
  "minimum_config": false,
3317
3453
  "create": false,
@@ -3329,6 +3465,8 @@
3329
3465
  "x-displayname": "Labels",
3330
3466
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
3331
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).",
3332
3470
  "x-f5xc-required-for": {
3333
3471
  "minimum_config": false,
3334
3472
  "create": false,
@@ -3342,6 +3480,8 @@
3342
3480
  "title": "Modification_timestamp.",
3343
3481
  "format": "date-time",
3344
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.",
3345
3485
  "minLength": 0,
3346
3486
  "maxLength": 1024,
3347
3487
  "x-f5xc-required-for": {
@@ -3360,6 +3500,8 @@
3360
3500
  "x-displayname": "Object Index.",
3361
3501
  "x-ves-example": "0",
3362
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.",
3363
3505
  "minimum": 0,
3364
3506
  "maximum": 2147483647,
3365
3507
  "x-f5xc-required-for": {
@@ -3380,6 +3522,8 @@
3380
3522
  "x-displayname": "Tenant",
3381
3523
  "x-ves-example": "Example-corp.",
3382
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.",
3383
3527
  "minLength": 0,
3384
3528
  "maxLength": 18,
3385
3529
  "x-f5xc-required-for": {
@@ -3391,7 +3535,7 @@
3391
3535
  "x-field-mutability": "read-only",
3392
3536
  "x-original-maxLength": 1024,
3393
3537
  "x-reconciled-from-discovery": true,
3394
- "x-reconciled-at": "2026-01-05T18:29:33.214141+00:00"
3538
+ "x-reconciled-at": "2026-01-07T15:28:55.516674+00:00"
3395
3539
  },
3396
3540
  "uid": {
3397
3541
  "type": "string",
@@ -3400,6 +3544,8 @@
3400
3544
  "x-displayname": "UID",
3401
3545
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
3402
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.",
3403
3549
  "minLength": 0,
3404
3550
  "maxLength": 36,
3405
3551
  "x-f5xc-required-for": {
@@ -3412,9 +3558,11 @@
3412
3558
  "x-original-maxLength": 1024,
3413
3559
  "format": "uuid",
3414
3560
  "x-reconciled-from-discovery": true,
3415
- "x-reconciled-at": "2026-01-05T18:29:33.214146+00:00"
3561
+ "x-reconciled-at": "2026-01-07T15:28:55.516679+00:00"
3416
3562
  }
3417
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.",
3418
3566
  "x-f5xc-minimum-configuration": {
3419
3567
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
3420
3568
  "required_fields": [
@@ -3462,7 +3610,7 @@
3462
3610
  },
3463
3611
  "x-original-maxLength": 1024,
3464
3612
  "x-reconciled-from-discovery": true,
3465
- "x-reconciled-at": "2026-01-05T18:29:33.214151+00:00"
3613
+ "x-reconciled-at": "2026-01-07T15:28:55.516684+00:00"
3466
3614
  },
3467
3615
  "name": {
3468
3616
  "type": "string",
@@ -3471,6 +3619,8 @@
3471
3619
  "x-displayname": "Name",
3472
3620
  "x-ves-example": "Contactus-route.",
3473
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.",
3474
3624
  "minLength": 0,
3475
3625
  "maxLength": 16,
3476
3626
  "x-f5xc-required-for": {
@@ -3481,7 +3631,7 @@
3481
3631
  },
3482
3632
  "x-original-maxLength": 1024,
3483
3633
  "x-reconciled-from-discovery": true,
3484
- "x-reconciled-at": "2026-01-05T18:29:33.214155+00:00"
3634
+ "x-reconciled-at": "2026-01-07T15:28:55.516688+00:00"
3485
3635
  },
3486
3636
  "namespace": {
3487
3637
  "type": "string",
@@ -3490,6 +3640,8 @@
3490
3640
  "x-displayname": "Namespace",
3491
3641
  "x-ves-example": "Ns1",
3492
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.",
3493
3645
  "minLength": 0,
3494
3646
  "maxLength": 6,
3495
3647
  "x-f5xc-required-for": {
@@ -3500,7 +3652,7 @@
3500
3652
  },
3501
3653
  "x-original-maxLength": 1024,
3502
3654
  "x-reconciled-from-discovery": true,
3503
- "x-reconciled-at": "2026-01-05T18:29:33.214159+00:00"
3655
+ "x-reconciled-at": "2026-01-07T15:28:55.516692+00:00"
3504
3656
  },
3505
3657
  "uid": {
3506
3658
  "type": "string",
@@ -3521,9 +3673,10 @@
3521
3673
  "x-original-maxLength": 1024,
3522
3674
  "format": "uuid",
3523
3675
  "x-reconciled-from-discovery": true,
3524
- "x-reconciled-at": "2026-01-05T18:29:33.214164+00:00"
3676
+ "x-reconciled-at": "2026-01-07T15:28:55.516696+00:00"
3525
3677
  }
3526
3678
  },
3679
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
3527
3680
  "x-f5xc-minimum-configuration": {
3528
3681
  "description": "Minimum configuration for schemaViewRefType",
3529
3682
  "required_fields": [