@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.
Files changed (55) hide show
  1. package/CHANGELOG.md +25 -14
  2. package/README.md +9 -5
  3. package/dist/generator/domain-metadata.d.ts +1 -3
  4. package/dist/generator/domain-metadata.d.ts.map +1 -1
  5. package/dist/generator/domain-metadata.js +0 -20
  6. package/dist/generator/domain-metadata.js.map +1 -1
  7. package/dist/generator/naming/acronyms.d.ts +1 -1
  8. package/dist/generator/naming/acronyms.js +1 -1
  9. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  10. package/dist/tools/generated/ce_management/index.js +179 -1582
  11. package/dist/tools/generated/ce_management/index.js.map +1 -1
  12. package/dist/tools/generated/dependency-graph.json +2 -265
  13. package/dist/version.d.ts +2 -2
  14. package/dist/version.js +2 -2
  15. package/manifest.json +1 -1
  16. package/package.json +1 -1
  17. package/specs/domains/admin_console_and_ui.json +176 -26
  18. package/specs/domains/ai_services.json +242 -36
  19. package/specs/domains/api.json +1507 -183
  20. package/specs/domains/authentication.json +358 -46
  21. package/specs/domains/bigip.json +825 -105
  22. package/specs/domains/billing_and_usage.json +666 -83
  23. package/specs/domains/blindfold.json +988 -111
  24. package/specs/domains/bot_and_threat_defense.json +550 -66
  25. package/specs/domains/cdn.json +2431 -198
  26. package/specs/domains/ce_management.json +9272 -15726
  27. package/specs/domains/certificates.json +540 -78
  28. package/specs/domains/cloud_infrastructure.json +1102 -122
  29. package/specs/domains/container_services.json +782 -99
  30. package/specs/domains/data_and_privacy_security.json +508 -68
  31. package/specs/domains/data_intelligence.json +487 -64
  32. package/specs/domains/ddos.json +1302 -161
  33. package/specs/domains/dns.json +1286 -162
  34. package/specs/domains/managed_kubernetes.json +687 -89
  35. package/specs/domains/marketplace.json +994 -105
  36. package/specs/domains/network.json +2340 -239
  37. package/specs/domains/network_security.json +1963 -192
  38. package/specs/domains/nginx_one.json +475 -63
  39. package/specs/domains/object_storage.json +163 -16
  40. package/specs/domains/observability.json +1519 -148
  41. package/specs/domains/rate_limiting.json +456 -56
  42. package/specs/domains/secops_and_incident_response.json +275 -37
  43. package/specs/domains/service_mesh.json +1320 -128
  44. package/specs/domains/shape.json +4196 -398
  45. package/specs/domains/sites.json +5053 -405
  46. package/specs/domains/statistics.json +2784 -236
  47. package/specs/domains/support.json +1038 -109
  48. package/specs/domains/telemetry_and_insights.json +993 -80
  49. package/specs/domains/tenant_and_identity.json +3487 -313
  50. package/specs/domains/threat_campaign.json +695 -72
  51. package/specs/domains/users.json +437 -72
  52. package/specs/domains/virtual.json +3716 -261
  53. package/specs/domains/vpm_and_node_management.json +61 -2
  54. package/specs/domains/waf.json +1551 -149
  55. package/specs/index.json +121 -26
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Container Services",
5
5
  "description": "Namespaced isolation with configurable limits and autoscaling policies. vK8s abstracts operational overhead while providing scheduling, persistent storage, and service mesh integration. Compute profiles specify CPU, memory, and GPU allocations for reproducible environments. Telemetry tracks consumption patterns across geographically distributed infrastructure nodes.",
6
- "version": "2.0.10",
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": "Pod orchestration without full cluster complexity. Edge site execution, quota enforcement, and standardized compute profiles for distributed apps.",
16
- "x-f5xc-cli-domain": "container_services"
16
+ "x-f5xc-cli-domain": "container_services",
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
  {
@@ -280,6 +330,13 @@
280
330
  "latency": "low",
281
331
  "resource_usage": "low"
282
332
  }
333
+ },
334
+ "x-f5xc-discovered-response-time": {
335
+ "p50_ms": 1000,
336
+ "p95_ms": 3000,
337
+ "p99_ms": 8000,
338
+ "sample_count": 0,
339
+ "source": "estimate"
283
340
  }
284
341
  },
285
342
  "x-displayname": "Virtual Kubernetes.",
@@ -502,6 +559,13 @@
502
559
  "latency": "low",
503
560
  "resource_usage": "low"
504
561
  }
562
+ },
563
+ "x-f5xc-discovered-response-time": {
564
+ "p50_ms": 800,
565
+ "p95_ms": 2500,
566
+ "p99_ms": 6000,
567
+ "sample_count": 0,
568
+ "source": "estimate"
505
569
  }
506
570
  },
507
571
  "x-displayname": "Virtual Kubernetes.",
@@ -731,7 +795,15 @@
731
795
  }
732
796
  },
733
797
  "x-discovered-response-time-ms": 158.53,
734
- "x-discovered-sample-size": 1
798
+ "x-discovered-sample-size": 1,
799
+ "x-f5xc-discovered-response-time": {
800
+ "p50_ms": 158.53,
801
+ "p95_ms": 317.06,
802
+ "p99_ms": 475.59,
803
+ "sample_count": 1,
804
+ "source": "discovery",
805
+ "last_measured": "2025-12-20T19:39:20.211392+00:00"
806
+ }
735
807
  },
736
808
  "x-displayname": "Virtual Kubernetes.",
737
809
  "x-ves-proto-service": "ves.io.schema.virtual_k8s.API",
@@ -952,6 +1024,13 @@
952
1024
  "latency": "low",
953
1025
  "resource_usage": "low"
954
1026
  }
1027
+ },
1028
+ "x-f5xc-discovered-response-time": {
1029
+ "p50_ms": 200,
1030
+ "p95_ms": 800,
1031
+ "p99_ms": 2000,
1032
+ "sample_count": 0,
1033
+ "source": "estimate"
955
1034
  }
956
1035
  },
957
1036
  "delete": {
@@ -1171,6 +1250,13 @@
1171
1250
  "latency": "high",
1172
1251
  "resource_usage": "moderate"
1173
1252
  }
1253
+ },
1254
+ "x-f5xc-discovered-response-time": {
1255
+ "p50_ms": 500,
1256
+ "p95_ms": 1500,
1257
+ "p99_ms": 4000,
1258
+ "sample_count": 0,
1259
+ "source": "estimate"
1174
1260
  }
1175
1261
  },
1176
1262
  "x-displayname": "Virtual Kubernetes.",
@@ -1385,6 +1471,13 @@
1385
1471
  "latency": "low",
1386
1472
  "resource_usage": "low"
1387
1473
  }
1474
+ },
1475
+ "x-f5xc-discovered-response-time": {
1476
+ "p50_ms": 1000,
1477
+ "p95_ms": 3000,
1478
+ "p99_ms": 8000,
1479
+ "sample_count": 0,
1480
+ "source": "estimate"
1388
1481
  }
1389
1482
  },
1390
1483
  "x-displayname": "Workload",
@@ -1607,6 +1700,13 @@
1607
1700
  "latency": "low",
1608
1701
  "resource_usage": "low"
1609
1702
  }
1703
+ },
1704
+ "x-f5xc-discovered-response-time": {
1705
+ "p50_ms": 800,
1706
+ "p95_ms": 2500,
1707
+ "p99_ms": 6000,
1708
+ "sample_count": 0,
1709
+ "source": "estimate"
1610
1710
  }
1611
1711
  },
1612
1712
  "x-displayname": "Workload",
@@ -1836,7 +1936,15 @@
1836
1936
  }
1837
1937
  },
1838
1938
  "x-discovered-response-time-ms": 153.13,
1839
- "x-discovered-sample-size": 1
1939
+ "x-discovered-sample-size": 1,
1940
+ "x-f5xc-discovered-response-time": {
1941
+ "p50_ms": 153.13,
1942
+ "p95_ms": 306.26,
1943
+ "p99_ms": 459.39,
1944
+ "sample_count": 1,
1945
+ "source": "discovery",
1946
+ "last_measured": "2025-12-20T19:39:20.211392+00:00"
1947
+ }
1840
1948
  },
1841
1949
  "x-displayname": "Workload",
1842
1950
  "x-ves-proto-service": "ves.io.schema.views.workload.API",
@@ -2050,6 +2158,13 @@
2050
2158
  "latency": "low",
2051
2159
  "resource_usage": "low"
2052
2160
  }
2161
+ },
2162
+ "x-f5xc-discovered-response-time": {
2163
+ "p50_ms": 1000,
2164
+ "p95_ms": 3000,
2165
+ "p99_ms": 8000,
2166
+ "sample_count": 0,
2167
+ "source": "estimate"
2053
2168
  }
2054
2169
  },
2055
2170
  "x-displayname": "Workload",
@@ -2271,6 +2386,13 @@
2271
2386
  "latency": "low",
2272
2387
  "resource_usage": "low"
2273
2388
  }
2389
+ },
2390
+ "x-f5xc-discovered-response-time": {
2391
+ "p50_ms": 200,
2392
+ "p95_ms": 800,
2393
+ "p99_ms": 2000,
2394
+ "sample_count": 0,
2395
+ "source": "estimate"
2274
2396
  }
2275
2397
  },
2276
2398
  "delete": {
@@ -2490,6 +2612,13 @@
2490
2612
  "latency": "high",
2491
2613
  "resource_usage": "moderate"
2492
2614
  }
2615
+ },
2616
+ "x-f5xc-discovered-response-time": {
2617
+ "p50_ms": 500,
2618
+ "p95_ms": 1500,
2619
+ "p99_ms": 4000,
2620
+ "sample_count": 0,
2621
+ "source": "estimate"
2493
2622
  }
2494
2623
  },
2495
2624
  "x-displayname": "Workload",
@@ -2704,6 +2833,13 @@
2704
2833
  "latency": "low",
2705
2834
  "resource_usage": "low"
2706
2835
  }
2836
+ },
2837
+ "x-f5xc-discovered-response-time": {
2838
+ "p50_ms": 1000,
2839
+ "p95_ms": 3000,
2840
+ "p99_ms": 8000,
2841
+ "sample_count": 0,
2842
+ "source": "estimate"
2707
2843
  }
2708
2844
  },
2709
2845
  "x-displayname": "Workload Flavor.",
@@ -2926,6 +3062,13 @@
2926
3062
  "latency": "low",
2927
3063
  "resource_usage": "low"
2928
3064
  }
3065
+ },
3066
+ "x-f5xc-discovered-response-time": {
3067
+ "p50_ms": 800,
3068
+ "p95_ms": 2500,
3069
+ "p99_ms": 6000,
3070
+ "sample_count": 0,
3071
+ "source": "estimate"
2929
3072
  }
2930
3073
  },
2931
3074
  "x-displayname": "Workload Flavor.",
@@ -3155,7 +3298,15 @@
3155
3298
  }
3156
3299
  },
3157
3300
  "x-discovered-response-time-ms": 155.73,
3158
- "x-discovered-sample-size": 1
3301
+ "x-discovered-sample-size": 1,
3302
+ "x-f5xc-discovered-response-time": {
3303
+ "p50_ms": 155.73,
3304
+ "p95_ms": 311.46,
3305
+ "p99_ms": 467.19,
3306
+ "sample_count": 1,
3307
+ "source": "discovery",
3308
+ "last_measured": "2025-12-20T19:39:20.211392+00:00"
3309
+ }
3159
3310
  },
3160
3311
  "x-displayname": "Workload Flavor.",
3161
3312
  "x-ves-proto-service": "ves.io.schema.workload_flavor.API",
@@ -3376,6 +3527,13 @@
3376
3527
  "latency": "low",
3377
3528
  "resource_usage": "low"
3378
3529
  }
3530
+ },
3531
+ "x-f5xc-discovered-response-time": {
3532
+ "p50_ms": 200,
3533
+ "p95_ms": 800,
3534
+ "p99_ms": 2000,
3535
+ "sample_count": 0,
3536
+ "source": "estimate"
3379
3537
  }
3380
3538
  },
3381
3539
  "delete": {
@@ -3595,6 +3753,13 @@
3595
3753
  "latency": "high",
3596
3754
  "resource_usage": "moderate"
3597
3755
  }
3756
+ },
3757
+ "x-f5xc-discovered-response-time": {
3758
+ "p50_ms": 500,
3759
+ "p95_ms": 1500,
3760
+ "p99_ms": 4000,
3761
+ "sample_count": 0,
3762
+ "source": "estimate"
3598
3763
  }
3599
3764
  },
3600
3765
  "x-displayname": "Workload Flavor.",
@@ -3618,6 +3783,7 @@
3618
3783
  "title": "Empty",
3619
3784
  "x-displayname": "Empty",
3620
3785
  "x-ves-proto-message": "ves.io.schema.Empty",
3786
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
3621
3787
  "x-f5xc-minimum-configuration": {
3622
3788
  "description": "Minimum configuration for ioschemaEmpty",
3623
3789
  "required_fields": [],
@@ -3642,6 +3808,8 @@
3642
3808
  "x-displayname": "Kind",
3643
3809
  "x-ves-example": "Virtual_site.",
3644
3810
  "x-f5xc-example": "virtual_site",
3811
+ "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\")",
3812
+ "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\").",
3645
3813
  "minLength": 0,
3646
3814
  "maxLength": 14,
3647
3815
  "x-f5xc-required-for": {
@@ -3653,7 +3821,7 @@
3653
3821
  "readOnly": true,
3654
3822
  "x-original-maxLength": 1024,
3655
3823
  "x-reconciled-from-discovery": true,
3656
- "x-reconciled-at": "2026-01-05T14:39:17.609405+00:00"
3824
+ "x-reconciled-at": "2026-01-07T15:29:42.657845+00:00"
3657
3825
  },
3658
3826
  "name": {
3659
3827
  "type": "string",
@@ -3662,6 +3830,8 @@
3662
3830
  "x-displayname": "Name",
3663
3831
  "x-ves-example": "Contactus-route.",
3664
3832
  "x-f5xc-example": "contactus-route",
3833
+ "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.",
3834
+ "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.",
3665
3835
  "minLength": 0,
3666
3836
  "maxLength": 16,
3667
3837
  "x-f5xc-required-for": {
@@ -3672,7 +3842,7 @@
3672
3842
  },
3673
3843
  "x-original-maxLength": 1024,
3674
3844
  "x-reconciled-from-discovery": true,
3675
- "x-reconciled-at": "2026-01-05T14:39:17.609412+00:00"
3845
+ "x-reconciled-at": "2026-01-07T15:29:42.657852+00:00"
3676
3846
  },
3677
3847
  "namespace": {
3678
3848
  "type": "string",
@@ -3681,6 +3851,8 @@
3681
3851
  "x-displayname": "Namespace",
3682
3852
  "x-ves-example": "Ns1",
3683
3853
  "x-f5xc-example": "ns1",
3854
+ "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.",
3855
+ "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.",
3684
3856
  "minLength": 0,
3685
3857
  "maxLength": 6,
3686
3858
  "x-f5xc-required-for": {
@@ -3691,7 +3863,7 @@
3691
3863
  },
3692
3864
  "x-original-maxLength": 1024,
3693
3865
  "x-reconciled-from-discovery": true,
3694
- "x-reconciled-at": "2026-01-05T14:39:17.609417+00:00"
3866
+ "x-reconciled-at": "2026-01-07T15:29:42.657857+00:00"
3695
3867
  },
3696
3868
  "tenant": {
3697
3869
  "type": "string",
@@ -3700,6 +3872,8 @@
3700
3872
  "x-displayname": "Tenant",
3701
3873
  "x-ves-example": "Example-corp.",
3702
3874
  "x-f5xc-example": "example-corp",
3875
+ "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.",
3876
+ "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.",
3703
3877
  "minLength": 0,
3704
3878
  "maxLength": 18,
3705
3879
  "x-f5xc-required-for": {
@@ -3712,7 +3886,7 @@
3712
3886
  "x-field-mutability": "read-only",
3713
3887
  "x-original-maxLength": 1024,
3714
3888
  "x-reconciled-from-discovery": true,
3715
- "x-reconciled-at": "2026-01-05T14:39:17.609422+00:00"
3889
+ "x-reconciled-at": "2026-01-07T15:29:42.657861+00:00"
3716
3890
  },
3717
3891
  "uid": {
3718
3892
  "type": "string",
@@ -3721,6 +3895,8 @@
3721
3895
  "x-displayname": "UID",
3722
3896
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
3723
3897
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
3898
+ "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.",
3899
+ "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.",
3724
3900
  "minLength": 0,
3725
3901
  "maxLength": 36,
3726
3902
  "x-f5xc-required-for": {
@@ -3734,9 +3910,11 @@
3734
3910
  "x-original-maxLength": 1024,
3735
3911
  "format": "uuid",
3736
3912
  "x-reconciled-from-discovery": true,
3737
- "x-reconciled-at": "2026-01-05T14:39:17.609428+00:00"
3913
+ "x-reconciled-at": "2026-01-07T15:29:42.657867+00:00"
3738
3914
  }
3739
3915
  },
3916
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
3917
+ "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...",
3740
3918
  "x-f5xc-minimum-configuration": {
3741
3919
  "description": "Minimum configuration for ioschemaObjectRefType",
3742
3920
  "required_fields": [
@@ -3760,6 +3938,8 @@
3760
3938
  "type_url": {
3761
3939
  "type": "string",
3762
3940
  "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.",
3941
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
3942
+ "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 ).",
3763
3943
  "minLength": 0,
3764
3944
  "maxLength": 1024,
3765
3945
  "x-f5xc-required-for": {
@@ -3783,9 +3963,11 @@
3783
3963
  },
3784
3964
  "x-original-maxLength": 1024,
3785
3965
  "x-reconciled-from-discovery": true,
3786
- "x-reconciled-at": "2026-01-05T14:39:17.609436+00:00"
3966
+ "x-reconciled-at": "2026-01-07T15:29:42.657874+00:00"
3787
3967
  }
3788
3968
  },
3969
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
3970
+ "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...",
3789
3971
  "x-f5xc-minimum-configuration": {
3790
3972
  "description": "Minimum configuration for protobufAny",
3791
3973
  "required_fields": [
@@ -3811,6 +3993,8 @@
3811
3993
  "description": "Hostname of the instance of the site that sent the status.",
3812
3994
  "title": "Hostname",
3813
3995
  "x-displayname": "Hostname",
3996
+ "x-f5xc-example": "example-resource",
3997
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
3814
3998
  "minLength": 0,
3815
3999
  "maxLength": 1024,
3816
4000
  "x-f5xc-required-for": {
@@ -3842,6 +4026,8 @@
3842
4026
  "x-displayname": "Reason",
3843
4027
  "x-ves-example": "Value",
3844
4028
  "x-f5xc-example": "value",
4029
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
4030
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
3845
4031
  "minLength": 0,
3846
4032
  "maxLength": 43,
3847
4033
  "x-f5xc-required-for": {
@@ -3852,13 +4038,15 @@
3852
4038
  },
3853
4039
  "x-original-maxLength": 1024,
3854
4040
  "x-reconciled-from-discovery": true,
3855
- "x-reconciled-at": "2026-01-05T14:39:17.609445+00:00"
4041
+ "x-reconciled-at": "2026-01-07T15:29:42.657882+00:00"
3856
4042
  },
3857
4043
  "service_name": {
3858
4044
  "type": "string",
3859
4045
  "description": "Name of the service that sent the status.",
3860
4046
  "title": "Service name.",
3861
4047
  "x-displayname": "Service Name.",
4048
+ "x-f5xc-example": "example-resource",
4049
+ "x-f5xc-description-short": "Name of the service that sent the status.",
3862
4050
  "minLength": 0,
3863
4051
  "maxLength": 1024,
3864
4052
  "x-f5xc-required-for": {
@@ -3881,6 +4069,8 @@
3881
4069
  "x-validation-rules": {
3882
4070
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
3883
4071
  },
4072
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
4073
+ "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...",
3884
4074
  "minLength": 0,
3885
4075
  "maxLength": 17,
3886
4076
  "x-f5xc-required-for": {
@@ -3891,7 +4081,7 @@
3891
4081
  },
3892
4082
  "x-original-maxLength": 1024,
3893
4083
  "x-reconciled-from-discovery": true,
3894
- "x-reconciled-at": "2026-01-05T14:39:17.609451+00:00"
4084
+ "x-reconciled-at": "2026-01-07T15:29:42.657888+00:00"
3895
4085
  },
3896
4086
  "type": {
3897
4087
  "type": "string",
@@ -3906,6 +4096,8 @@
3906
4096
  "x-validation-rules": {
3907
4097
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
3908
4098
  },
4099
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
4100
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
3909
4101
  "minLength": 0,
3910
4102
  "maxLength": 1024,
3911
4103
  "x-f5xc-required-for": {
@@ -3916,6 +4108,8 @@
3916
4108
  }
3917
4109
  }
3918
4110
  },
4111
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
4112
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
3919
4113
  "x-f5xc-minimum-configuration": {
3920
4114
  "description": "Minimum configuration for schemaConditionType",
3921
4115
  "required_fields": [
@@ -3951,6 +4145,8 @@
3951
4145
  "default": "EOK",
3952
4146
  "x-displayname": "Error Code.",
3953
4147
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
4148
+ "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...",
4149
+ "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...",
3954
4150
  "x-f5xc-minimum-configuration": {
3955
4151
  "description": "Minimum configuration for schemaErrorCode",
3956
4152
  "required_fields": [],
@@ -3991,6 +4187,7 @@
3991
4187
  }
3992
4188
  }
3993
4189
  },
4190
+ "x-f5xc-description-short": "Information about a error in API operation.",
3994
4191
  "x-f5xc-minimum-configuration": {
3995
4192
  "description": "Minimum configuration for schemaErrorType",
3996
4193
  "required_fields": [
@@ -4018,6 +4215,7 @@
4018
4215
  "title": "Name",
4019
4216
  "x-displayname": "Name",
4020
4217
  "x-f5xc-example": "example-resource",
4218
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
4021
4219
  "minLength": 0,
4022
4220
  "maxLength": 16,
4023
4221
  "x-f5xc-required-for": {
@@ -4028,9 +4226,10 @@
4028
4226
  },
4029
4227
  "x-original-maxLength": 1024,
4030
4228
  "x-reconciled-from-discovery": true,
4031
- "x-reconciled-at": "2026-01-05T14:39:17.609463+00:00"
4229
+ "x-reconciled-at": "2026-01-07T15:29:42.657899+00:00"
4032
4230
  }
4033
4231
  },
4232
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
4034
4233
  "x-f5xc-minimum-configuration": {
4035
4234
  "description": "Minimum configuration for schemaInitializerType",
4036
4235
  "required_fields": [
@@ -4058,6 +4257,8 @@
4058
4257
  "$ref": "#/components/schemas/schemaInitializerType"
4059
4258
  },
4060
4259
  "x-displayname": "Pending",
4260
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
4261
+ "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.",
4061
4262
  "x-f5xc-required-for": {
4062
4263
  "minimum_config": false,
4063
4264
  "create": false,
@@ -4069,6 +4270,7 @@
4069
4270
  "$ref": "#/components/schemas/schemaStatusType"
4070
4271
  }
4071
4272
  },
4273
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
4072
4274
  "x-f5xc-minimum-configuration": {
4073
4275
  "description": "Minimum configuration for schemaInitializersType",
4074
4276
  "required_fields": [
@@ -4109,7 +4311,7 @@
4109
4311
  },
4110
4312
  "value": {
4111
4313
  "type": "string",
4112
- "description": "",
4314
+ "description": "Configuration parameter for value",
4113
4315
  "title": "Value",
4114
4316
  "x-displayname": "Value",
4115
4317
  "x-ves-example": "15",
@@ -4124,9 +4326,10 @@
4124
4326
  },
4125
4327
  "x-original-maxLength": 1024,
4126
4328
  "x-reconciled-from-discovery": true,
4127
- "x-reconciled-at": "2026-01-05T14:39:17.609474+00:00"
4329
+ "x-reconciled-at": "2026-01-07T15:29:42.657910+00:00"
4128
4330
  }
4129
4331
  },
4332
+ "x-f5xc-description-short": "Metric data contains timestamp and the value.",
4130
4333
  "x-f5xc-minimum-configuration": {
4131
4334
  "description": "Minimum configuration for schemaMetricValue",
4132
4335
  "required_fields": [
@@ -4166,6 +4369,8 @@
4166
4369
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4167
4370
  "ves.io.schema.rules.map.values.string.min_len": "1"
4168
4371
  },
4372
+ "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.",
4373
+ "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.",
4169
4374
  "x-f5xc-required-for": {
4170
4375
  "minimum_config": false,
4171
4376
  "create": false,
@@ -4187,6 +4392,7 @@
4187
4392
  "x-validation-rules": {
4188
4393
  "ves.io.schema.rules.string.max_bytes": "1200"
4189
4394
  },
4395
+ "x-f5xc-description-short": "Human readable description for the object.",
4190
4396
  "minLength": 0,
4191
4397
  "x-f5xc-required-for": {
4192
4398
  "minimum_config": false,
@@ -4196,7 +4402,7 @@
4196
4402
  },
4197
4403
  "x-original-maxLength": 1200,
4198
4404
  "x-reconciled-from-discovery": true,
4199
- "x-reconciled-at": "2026-01-05T14:39:17.609481+00:00"
4405
+ "x-reconciled-at": "2026-01-07T15:29:42.657917+00:00"
4200
4406
  },
4201
4407
  "disable": {
4202
4408
  "type": "boolean",
@@ -4205,6 +4411,7 @@
4205
4411
  "format": "boolean",
4206
4412
  "x-displayname": "Disable",
4207
4413
  "x-f5xc-example": "true",
4414
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4208
4415
  "x-f5xc-required-for": {
4209
4416
  "minimum_config": false,
4210
4417
  "create": false,
@@ -4218,6 +4425,8 @@
4218
4425
  "title": "Labels",
4219
4426
  "x-displayname": "Labels",
4220
4427
  "x-f5xc-example": "value",
4428
+ "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.",
4429
+ "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.",
4221
4430
  "x-f5xc-required-for": {
4222
4431
  "minimum_config": false,
4223
4432
  "create": false,
@@ -4239,6 +4448,8 @@
4239
4448
  "x-validation-rules": {
4240
4449
  "ves.io.schema.rules.message.required": "true"
4241
4450
  },
4451
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4452
+ "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.",
4242
4453
  "minLength": 0,
4243
4454
  "maxLength": 16,
4244
4455
  "x-f5xc-required-for": {
@@ -4249,7 +4460,7 @@
4249
4460
  },
4250
4461
  "x-original-maxLength": 1024,
4251
4462
  "x-reconciled-from-discovery": true,
4252
- "x-reconciled-at": "2026-01-05T14:39:17.609489+00:00"
4463
+ "x-reconciled-at": "2026-01-07T15:29:42.657925+00:00"
4253
4464
  },
4254
4465
  "namespace": {
4255
4466
  "type": "string",
@@ -4258,6 +4469,8 @@
4258
4469
  "x-displayname": "Namespace",
4259
4470
  "x-ves-example": "Staging",
4260
4471
  "x-f5xc-example": "staging",
4472
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4473
+ "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 \"\".",
4261
4474
  "minLength": 0,
4262
4475
  "maxLength": 6,
4263
4476
  "x-f5xc-required-for": {
@@ -4268,9 +4481,10 @@
4268
4481
  },
4269
4482
  "x-original-maxLength": 1024,
4270
4483
  "x-reconciled-from-discovery": true,
4271
- "x-reconciled-at": "2026-01-05T14:39:17.609493+00:00"
4484
+ "x-reconciled-at": "2026-01-07T15:29:42.657929+00:00"
4272
4485
  }
4273
4486
  },
4487
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
4274
4488
  "x-f5xc-minimum-configuration": {
4275
4489
  "description": "Minimum configuration for schemaObjectCreateMetaType",
4276
4490
  "required_fields": [
@@ -4314,6 +4528,8 @@
4314
4528
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4315
4529
  "ves.io.schema.rules.map.values.string.min_len": "1"
4316
4530
  },
4531
+ "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.",
4532
+ "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.",
4317
4533
  "x-f5xc-required-for": {
4318
4534
  "minimum_config": false,
4319
4535
  "create": false,
@@ -4335,6 +4551,7 @@
4335
4551
  "x-validation-rules": {
4336
4552
  "ves.io.schema.rules.string.max_bytes": "1200"
4337
4553
  },
4554
+ "x-f5xc-description-short": "Human readable description for the object.",
4338
4555
  "minLength": 0,
4339
4556
  "x-f5xc-required-for": {
4340
4557
  "minimum_config": false,
@@ -4344,7 +4561,7 @@
4344
4561
  },
4345
4562
  "x-original-maxLength": 1200,
4346
4563
  "x-reconciled-from-discovery": true,
4347
- "x-reconciled-at": "2026-01-05T14:39:17.609499+00:00"
4564
+ "x-reconciled-at": "2026-01-07T15:29:42.657936+00:00"
4348
4565
  },
4349
4566
  "disable": {
4350
4567
  "type": "boolean",
@@ -4354,6 +4571,7 @@
4354
4571
  "x-displayname": "Disable",
4355
4572
  "x-ves-example": "True",
4356
4573
  "x-f5xc-example": "true",
4574
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4357
4575
  "x-f5xc-required-for": {
4358
4576
  "minimum_config": false,
4359
4577
  "create": false,
@@ -4368,6 +4586,8 @@
4368
4586
  "x-displayname": "Labels",
4369
4587
  "x-ves-example": "Value",
4370
4588
  "x-f5xc-example": "value",
4589
+ "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.",
4590
+ "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.",
4371
4591
  "x-f5xc-required-for": {
4372
4592
  "minimum_config": false,
4373
4593
  "create": false,
@@ -4389,6 +4609,8 @@
4389
4609
  "x-validation-rules": {
4390
4610
  "ves.io.schema.rules.message.required": "true"
4391
4611
  },
4612
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4613
+ "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.",
4392
4614
  "minLength": 0,
4393
4615
  "maxLength": 16,
4394
4616
  "x-f5xc-required-for": {
@@ -4399,7 +4621,7 @@
4399
4621
  },
4400
4622
  "x-original-maxLength": 1024,
4401
4623
  "x-reconciled-from-discovery": true,
4402
- "x-reconciled-at": "2026-01-05T14:39:17.609508+00:00"
4624
+ "x-reconciled-at": "2026-01-07T15:29:42.657944+00:00"
4403
4625
  },
4404
4626
  "namespace": {
4405
4627
  "type": "string",
@@ -4408,6 +4630,8 @@
4408
4630
  "x-displayname": "Namespace",
4409
4631
  "x-ves-example": "Staging",
4410
4632
  "x-f5xc-example": "staging",
4633
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4634
+ "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 \"\".",
4411
4635
  "minLength": 0,
4412
4636
  "maxLength": 6,
4413
4637
  "x-f5xc-required-for": {
@@ -4418,9 +4642,10 @@
4418
4642
  },
4419
4643
  "x-original-maxLength": 1024,
4420
4644
  "x-reconciled-from-discovery": true,
4421
- "x-reconciled-at": "2026-01-05T14:39:17.609512+00:00"
4645
+ "x-reconciled-at": "2026-01-07T15:29:42.657948+00:00"
4422
4646
  }
4423
4647
  },
4648
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
4424
4649
  "x-f5xc-minimum-configuration": {
4425
4650
  "description": "Minimum configuration for schemaObjectGetMetaType",
4426
4651
  "required_fields": [
@@ -4464,6 +4689,8 @@
4464
4689
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4465
4690
  "ves.io.schema.rules.map.values.string.min_len": "1"
4466
4691
  },
4692
+ "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.",
4693
+ "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.",
4467
4694
  "x-f5xc-required-for": {
4468
4695
  "minimum_config": false,
4469
4696
  "create": false,
@@ -4485,6 +4712,7 @@
4485
4712
  "x-validation-rules": {
4486
4713
  "ves.io.schema.rules.string.max_bytes": "1200"
4487
4714
  },
4715
+ "x-f5xc-description-short": "Human readable description for the object.",
4488
4716
  "minLength": 0,
4489
4717
  "x-f5xc-required-for": {
4490
4718
  "minimum_config": false,
@@ -4494,7 +4722,7 @@
4494
4722
  },
4495
4723
  "x-original-maxLength": 1200,
4496
4724
  "x-reconciled-from-discovery": true,
4497
- "x-reconciled-at": "2026-01-05T14:39:17.609519+00:00"
4725
+ "x-reconciled-at": "2026-01-07T15:29:42.657954+00:00"
4498
4726
  },
4499
4727
  "disable": {
4500
4728
  "type": "boolean",
@@ -4503,6 +4731,7 @@
4503
4731
  "format": "boolean",
4504
4732
  "x-displayname": "Disable",
4505
4733
  "x-f5xc-example": "true",
4734
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4506
4735
  "x-f5xc-required-for": {
4507
4736
  "minimum_config": false,
4508
4737
  "create": false,
@@ -4517,6 +4746,8 @@
4517
4746
  "x-displayname": "Labels",
4518
4747
  "x-ves-example": "Value",
4519
4748
  "x-f5xc-example": "value",
4749
+ "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.",
4750
+ "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.",
4520
4751
  "x-f5xc-required-for": {
4521
4752
  "minimum_config": false,
4522
4753
  "create": false,
@@ -4537,6 +4768,8 @@
4537
4768
  "x-validation-rules": {
4538
4769
  "ves.io.schema.rules.message.required": "true"
4539
4770
  },
4771
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4772
+ "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.",
4540
4773
  "minLength": 0,
4541
4774
  "maxLength": 16,
4542
4775
  "x-f5xc-required-for": {
@@ -4547,7 +4780,7 @@
4547
4780
  },
4548
4781
  "x-original-maxLength": 1024,
4549
4782
  "x-reconciled-from-discovery": true,
4550
- "x-reconciled-at": "2026-01-05T14:39:17.609527+00:00"
4783
+ "x-reconciled-at": "2026-01-07T15:29:42.657961+00:00"
4551
4784
  },
4552
4785
  "namespace": {
4553
4786
  "type": "string",
@@ -4556,6 +4789,8 @@
4556
4789
  "x-displayname": "Namespace",
4557
4790
  "x-ves-example": "Staging",
4558
4791
  "x-f5xc-example": "staging",
4792
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4793
+ "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 \"\".",
4559
4794
  "minLength": 0,
4560
4795
  "maxLength": 6,
4561
4796
  "x-f5xc-required-for": {
@@ -4566,9 +4801,10 @@
4566
4801
  },
4567
4802
  "x-original-maxLength": 1024,
4568
4803
  "x-reconciled-from-discovery": true,
4569
- "x-reconciled-at": "2026-01-05T14:39:17.609531+00:00"
4804
+ "x-reconciled-at": "2026-01-07T15:29:42.657965+00:00"
4570
4805
  }
4571
4806
  },
4807
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
4572
4808
  "x-f5xc-minimum-configuration": {
4573
4809
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
4574
4810
  "required_fields": [
@@ -4599,6 +4835,8 @@
4599
4835
  "title": "Creation_timestamp.",
4600
4836
  "format": "date-time",
4601
4837
  "x-displayname": "Creation Timestamp.",
4838
+ "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.",
4839
+ "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.",
4602
4840
  "minLength": 0,
4603
4841
  "maxLength": 1024,
4604
4842
  "x-f5xc-required-for": {
@@ -4616,6 +4854,8 @@
4616
4854
  "x-displayname": "Creator Class.",
4617
4855
  "x-ves-example": "ver.re1.int.ves.I/O.",
4618
4856
  "x-f5xc-example": "ver.re1.int.F5 XC",
4857
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
4858
+ "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.",
4619
4859
  "minLength": 0,
4620
4860
  "maxLength": 1024,
4621
4861
  "x-f5xc-required-for": {
@@ -4633,6 +4873,8 @@
4633
4873
  "x-displayname": "Creator ID.",
4634
4874
  "x-ves-example": "Ver-instance-1.",
4635
4875
  "x-f5xc-example": "ver-instance-1",
4876
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
4877
+ "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.",
4636
4878
  "minLength": 0,
4637
4879
  "maxLength": 1024,
4638
4880
  "x-f5xc-required-for": {
@@ -4651,6 +4893,8 @@
4651
4893
  "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)",
4652
4894
  "title": "Status_id",
4653
4895
  "x-displayname": "Status ID",
4896
+ "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...",
4897
+ "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).",
4654
4898
  "minLength": 0,
4655
4899
  "maxLength": 1024,
4656
4900
  "x-f5xc-required-for": {
@@ -4668,6 +4912,7 @@
4668
4912
  "x-displayname": "UID",
4669
4913
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
4670
4914
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
4915
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
4671
4916
  "minLength": 0,
4672
4917
  "maxLength": 36,
4673
4918
  "x-f5xc-required-for": {
@@ -4680,13 +4925,14 @@
4680
4925
  "x-original-maxLength": 1024,
4681
4926
  "format": "uuid",
4682
4927
  "x-reconciled-from-discovery": true,
4683
- "x-reconciled-at": "2026-01-05T14:39:17.609544+00:00"
4928
+ "x-reconciled-at": "2026-01-07T15:29:42.657978+00:00"
4684
4929
  },
4685
4930
  "vtrp_id": {
4686
4931
  "type": "string",
4687
4932
  "description": "Origin of this status exchanged by VTRP.",
4688
4933
  "title": "Vtrp_id",
4689
4934
  "x-displayname": "VTRP ID",
4935
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
4690
4936
  "minLength": 0,
4691
4937
  "maxLength": 1024,
4692
4938
  "x-f5xc-required-for": {
@@ -4703,6 +4949,7 @@
4703
4949
  "title": "Vtrp_stale.",
4704
4950
  "format": "boolean",
4705
4951
  "x-displayname": "VTRP Stale.",
4952
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
4706
4953
  "x-f5xc-required-for": {
4707
4954
  "minimum_config": false,
4708
4955
  "create": false,
@@ -4711,6 +4958,7 @@
4711
4958
  }
4712
4959
  }
4713
4960
  },
4961
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
4714
4962
  "x-f5xc-minimum-configuration": {
4715
4963
  "description": "Minimum configuration for schemaStatusMetaType",
4716
4964
  "required_fields": [
@@ -4741,6 +4989,8 @@
4741
4989
  "default": "STATUS_DO_NOT_PUBLISH",
4742
4990
  "x-displayname": "Status Publish Type.",
4743
4991
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
4992
+ "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.",
4993
+ "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.",
4744
4994
  "x-f5xc-minimum-configuration": {
4745
4995
  "description": "Minimum configuration for schemaStatusPublishType",
4746
4996
  "required_fields": [],
@@ -4766,6 +5016,7 @@
4766
5016
  "x-displayname": "Code",
4767
5017
  "x-ves-example": "0",
4768
5018
  "x-f5xc-example": "0",
5019
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
4769
5020
  "minimum": 0,
4770
5021
  "maximum": 2147483647,
4771
5022
  "x-f5xc-required-for": {
@@ -4782,6 +5033,8 @@
4782
5033
  "x-displayname": "Reason",
4783
5034
  "x-ves-example": "Value",
4784
5035
  "x-f5xc-example": "value",
5036
+ "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.",
5037
+ "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.",
4785
5038
  "minLength": 0,
4786
5039
  "maxLength": 43,
4787
5040
  "x-f5xc-required-for": {
@@ -4792,7 +5045,7 @@
4792
5045
  },
4793
5046
  "x-original-maxLength": 1024,
4794
5047
  "x-reconciled-from-discovery": true,
4795
- "x-reconciled-at": "2026-01-05T14:39:17.609555+00:00"
5048
+ "x-reconciled-at": "2026-01-07T15:29:42.657987+00:00"
4796
5049
  },
4797
5050
  "status": {
4798
5051
  "type": "string",
@@ -4801,6 +5054,7 @@
4801
5054
  "x-displayname": "Status",
4802
5055
  "x-ves-example": "Value",
4803
5056
  "x-f5xc-example": "value",
5057
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
4804
5058
  "minLength": 0,
4805
5059
  "maxLength": 17,
4806
5060
  "x-f5xc-required-for": {
@@ -4811,9 +5065,10 @@
4811
5065
  },
4812
5066
  "x-original-maxLength": 1024,
4813
5067
  "x-reconciled-from-discovery": true,
4814
- "x-reconciled-at": "2026-01-05T14:39:17.609559+00:00"
5068
+ "x-reconciled-at": "2026-01-07T15:29:42.657991+00:00"
4815
5069
  }
4816
5070
  },
5071
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
4817
5072
  "x-f5xc-minimum-configuration": {
4818
5073
  "description": "Minimum configuration for schemaStatusType",
4819
5074
  "required_fields": [
@@ -4841,6 +5096,8 @@
4841
5096
  "title": "Creation_timestamp.",
4842
5097
  "format": "date-time",
4843
5098
  "x-displayname": "Creation Timestamp.",
5099
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
5100
+ "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.",
4844
5101
  "minLength": 0,
4845
5102
  "maxLength": 1024,
4846
5103
  "x-f5xc-required-for": {
@@ -4858,6 +5115,7 @@
4858
5115
  "x-displayname": "Creator Class.",
4859
5116
  "x-ves-example": "Prism",
4860
5117
  "x-f5xc-example": "value",
5118
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
4861
5119
  "minLength": 0,
4862
5120
  "maxLength": 1024,
4863
5121
  "x-f5xc-required-for": {
@@ -4875,6 +5133,7 @@
4875
5133
  "x-displayname": "Creator ID.",
4876
5134
  "x-ves-example": "Admin@example-corp.com.",
4877
5135
  "x-f5xc-example": "value",
5136
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
4878
5137
  "minLength": 0,
4879
5138
  "maxLength": 1024,
4880
5139
  "x-f5xc-required-for": {
@@ -4891,6 +5150,8 @@
4891
5150
  "title": "Deletion_timestamp.",
4892
5151
  "format": "date-time",
4893
5152
  "x-displayname": "Deletion Timestamp.",
5153
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
5154
+ "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...",
4894
5155
  "minLength": 0,
4895
5156
  "maxLength": 1024,
4896
5157
  "x-f5xc-required-for": {
@@ -4910,6 +5171,8 @@
4910
5171
  "x-displayname": "Finalizers.",
4911
5172
  "x-ves-example": "Value",
4912
5173
  "x-f5xc-example": "value",
5174
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
5175
+ "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.",
4913
5176
  "x-f5xc-required-for": {
4914
5177
  "minimum_config": false,
4915
5178
  "create": false,
@@ -4927,6 +5190,8 @@
4927
5190
  "x-displayname": "Labels",
4928
5191
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
4929
5192
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
5193
+ "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.",
5194
+ "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).",
4930
5195
  "x-f5xc-required-for": {
4931
5196
  "minimum_config": false,
4932
5197
  "create": false,
@@ -4940,6 +5205,8 @@
4940
5205
  "title": "Modification_timestamp.",
4941
5206
  "format": "date-time",
4942
5207
  "x-displayname": "Modification Timestamp.",
5208
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5209
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
4943
5210
  "minLength": 0,
4944
5211
  "maxLength": 1024,
4945
5212
  "x-f5xc-required-for": {
@@ -4958,6 +5225,8 @@
4958
5225
  "x-displayname": "Object Index.",
4959
5226
  "x-ves-example": "0",
4960
5227
  "x-f5xc-example": "0",
5228
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
5229
+ "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.",
4961
5230
  "minimum": 0,
4962
5231
  "maximum": 2147483647,
4963
5232
  "x-f5xc-required-for": {
@@ -4978,6 +5247,8 @@
4978
5247
  "x-displayname": "Tenant",
4979
5248
  "x-ves-example": "Example-corp.",
4980
5249
  "x-f5xc-example": "example-corp",
5250
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5251
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
4981
5252
  "minLength": 0,
4982
5253
  "maxLength": 18,
4983
5254
  "x-f5xc-required-for": {
@@ -4989,7 +5260,7 @@
4989
5260
  "x-field-mutability": "read-only",
4990
5261
  "x-original-maxLength": 1024,
4991
5262
  "x-reconciled-from-discovery": true,
4992
- "x-reconciled-at": "2026-01-05T14:39:17.609579+00:00"
5263
+ "x-reconciled-at": "2026-01-07T15:29:42.658011+00:00"
4993
5264
  },
4994
5265
  "uid": {
4995
5266
  "type": "string",
@@ -4998,6 +5269,8 @@
4998
5269
  "x-displayname": "UID",
4999
5270
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5000
5271
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5272
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
5273
+ "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.",
5001
5274
  "minLength": 0,
5002
5275
  "maxLength": 36,
5003
5276
  "x-f5xc-required-for": {
@@ -5010,9 +5283,11 @@
5010
5283
  "x-original-maxLength": 1024,
5011
5284
  "format": "uuid",
5012
5285
  "x-reconciled-from-discovery": true,
5013
- "x-reconciled-at": "2026-01-05T14:39:17.609584+00:00"
5286
+ "x-reconciled-at": "2026-01-07T15:29:42.658017+00:00"
5014
5287
  }
5015
5288
  },
5289
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5290
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5016
5291
  "x-f5xc-minimum-configuration": {
5017
5292
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
5018
5293
  "required_fields": [
@@ -5048,6 +5323,7 @@
5048
5323
  "default": "TREND_SENTIMENT_NONE",
5049
5324
  "x-displayname": "Trend Sentiment.",
5050
5325
  "x-ves-proto-enum": "ves.io.schema.TrendSentiment",
5326
+ "x-f5xc-description-short": "Trend sentiment Indicates trend sentiment is positive Indicates trend sentiment is negative.",
5051
5327
  "x-f5xc-minimum-configuration": {
5052
5328
  "description": "Minimum configuration for schemaTrendSentiment",
5053
5329
  "required_fields": [],
@@ -5072,6 +5348,7 @@
5072
5348
  "x-displayname": "Description.",
5073
5349
  "x-ves-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval.",
5074
5350
  "x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval",
5351
+ "x-f5xc-description-short": "Description of the method used to calculate trend.",
5075
5352
  "minLength": 0,
5076
5353
  "maxLength": 0,
5077
5354
  "x-f5xc-required-for": {
@@ -5082,15 +5359,16 @@
5082
5359
  },
5083
5360
  "x-original-maxLength": 1024,
5084
5361
  "x-reconciled-from-discovery": true,
5085
- "x-reconciled-at": "2026-01-05T14:39:17.609589+00:00"
5362
+ "x-reconciled-at": "2026-01-07T15:29:42.658022+00:00"
5086
5363
  },
5087
5364
  "previous_value": {
5088
5365
  "type": "string",
5089
- "description": "",
5366
+ "description": "Configuration parameter for previous value",
5090
5367
  "title": "Previous Value.",
5091
5368
  "x-displayname": "Previous Value.",
5092
5369
  "x-ves-example": "200.00",
5093
5370
  "x-f5xc-example": "200.00",
5371
+ "x-f5xc-description-short": "Configuration parameter for previous value.",
5094
5372
  "minLength": 0,
5095
5373
  "maxLength": 1024,
5096
5374
  "x-f5xc-required-for": {
@@ -5105,7 +5383,7 @@
5105
5383
  },
5106
5384
  "value": {
5107
5385
  "type": "string",
5108
- "description": "",
5386
+ "description": "Configuration parameter for value",
5109
5387
  "title": "Value",
5110
5388
  "x-displayname": "Value",
5111
5389
  "x-ves-example": "-15",
@@ -5120,9 +5398,11 @@
5120
5398
  },
5121
5399
  "x-original-maxLength": 1024,
5122
5400
  "x-reconciled-from-discovery": true,
5123
- "x-reconciled-at": "2026-01-05T14:39:17.609597+00:00"
5401
+ "x-reconciled-at": "2026-01-07T15:29:42.658029+00:00"
5124
5402
  }
5125
5403
  },
5404
+ "x-f5xc-description-short": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
5405
+ "x-f5xc-description-medium": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
5126
5406
  "x-f5xc-minimum-configuration": {
5127
5407
  "description": "Minimum configuration for schemaTrendValue",
5128
5408
  "required_fields": [
@@ -5174,6 +5454,7 @@
5174
5454
  "default": "UNIT_MILLISECONDS",
5175
5455
  "x-displayname": "Unit",
5176
5456
  "x-ves-proto-enum": "ves.io.schema.UnitType",
5457
+ "x-f5xc-description-short": "UnitType is enumeration of units for scalar fields.",
5177
5458
  "x-f5xc-minimum-configuration": {
5178
5459
  "description": "Minimum configuration for schemaUnitType",
5179
5460
  "required_fields": [],
@@ -5208,7 +5489,7 @@
5208
5489
  },
5209
5490
  "x-original-maxLength": 1024,
5210
5491
  "x-reconciled-from-discovery": true,
5211
- "x-reconciled-at": "2026-01-05T14:39:17.609602+00:00"
5492
+ "x-reconciled-at": "2026-01-07T15:29:42.658035+00:00"
5212
5493
  },
5213
5494
  "name": {
5214
5495
  "type": "string",
@@ -5217,6 +5498,8 @@
5217
5498
  "x-displayname": "Name",
5218
5499
  "x-ves-example": "Contactus-route.",
5219
5500
  "x-f5xc-example": "contactus-route",
5501
+ "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.",
5502
+ "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.",
5220
5503
  "minLength": 0,
5221
5504
  "maxLength": 16,
5222
5505
  "x-f5xc-required-for": {
@@ -5227,7 +5510,7 @@
5227
5510
  },
5228
5511
  "x-original-maxLength": 1024,
5229
5512
  "x-reconciled-from-discovery": true,
5230
- "x-reconciled-at": "2026-01-05T14:39:17.609606+00:00"
5513
+ "x-reconciled-at": "2026-01-07T15:29:42.658039+00:00"
5231
5514
  },
5232
5515
  "namespace": {
5233
5516
  "type": "string",
@@ -5236,6 +5519,8 @@
5236
5519
  "x-displayname": "Namespace",
5237
5520
  "x-ves-example": "Ns1",
5238
5521
  "x-f5xc-example": "ns1",
5522
+ "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.",
5523
+ "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.",
5239
5524
  "minLength": 0,
5240
5525
  "maxLength": 6,
5241
5526
  "x-f5xc-required-for": {
@@ -5246,7 +5531,7 @@
5246
5531
  },
5247
5532
  "x-original-maxLength": 1024,
5248
5533
  "x-reconciled-from-discovery": true,
5249
- "x-reconciled-at": "2026-01-05T14:39:17.609611+00:00"
5534
+ "x-reconciled-at": "2026-01-07T15:29:42.658043+00:00"
5250
5535
  },
5251
5536
  "uid": {
5252
5537
  "type": "string",
@@ -5267,9 +5552,10 @@
5267
5552
  "x-original-maxLength": 1024,
5268
5553
  "format": "uuid",
5269
5554
  "x-reconciled-from-discovery": true,
5270
- "x-reconciled-at": "2026-01-05T14:39:17.609615+00:00"
5555
+ "x-reconciled-at": "2026-01-07T15:29:42.658048+00:00"
5271
5556
  }
5272
5557
  },
5558
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
5273
5559
  "x-f5xc-minimum-configuration": {
5274
5560
  "description": "Minimum configuration for schemaViewRefType",
5275
5561
  "required_fields": [
@@ -5312,6 +5598,8 @@
5312
5598
  "ves.io.schema.rules.string.max_bytes": "128",
5313
5599
  "ves.io.schema.rules.string.min_bytes": "1"
5314
5600
  },
5601
+ "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.",
5602
+ "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. Required: YES.",
5315
5603
  "x-f5xc-required-for": {
5316
5604
  "minimum_config": false,
5317
5605
  "create": false,
@@ -5320,7 +5608,7 @@
5320
5608
  },
5321
5609
  "x-original-maxLength": 128,
5322
5610
  "x-reconciled-from-discovery": true,
5323
- "x-reconciled-at": "2026-01-05T14:39:17.609620+00:00"
5611
+ "x-reconciled-at": "2026-01-07T15:29:42.658053+00:00"
5324
5612
  },
5325
5613
  "namespace": {
5326
5614
  "type": "string",
@@ -5336,6 +5624,8 @@
5336
5624
  "x-validation-rules": {
5337
5625
  "ves.io.schema.rules.string.max_bytes": "64"
5338
5626
  },
5627
+ "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.",
5628
+ "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.",
5339
5629
  "minLength": 0,
5340
5630
  "x-f5xc-required-for": {
5341
5631
  "minimum_config": false,
@@ -5345,7 +5635,7 @@
5345
5635
  },
5346
5636
  "x-original-maxLength": 64,
5347
5637
  "x-reconciled-from-discovery": true,
5348
- "x-reconciled-at": "2026-01-05T14:39:17.609625+00:00"
5638
+ "x-reconciled-at": "2026-01-07T15:29:42.658058+00:00"
5349
5639
  },
5350
5640
  "tenant": {
5351
5641
  "type": "string",
@@ -5361,6 +5651,8 @@
5361
5651
  "x-validation-rules": {
5362
5652
  "ves.io.schema.rules.string.max_bytes": "64"
5363
5653
  },
5654
+ "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.",
5655
+ "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.",
5364
5656
  "minLength": 0,
5365
5657
  "x-f5xc-required-for": {
5366
5658
  "minimum_config": false,
@@ -5372,9 +5664,11 @@
5372
5664
  "x-field-mutability": "read-only",
5373
5665
  "x-original-maxLength": 64,
5374
5666
  "x-reconciled-from-discovery": true,
5375
- "x-reconciled-at": "2026-01-05T14:39:17.609629+00:00"
5667
+ "x-reconciled-at": "2026-01-07T15:29:42.658062+00:00"
5376
5668
  }
5377
5669
  },
5670
+ "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
5671
+ "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.",
5378
5672
  "x-f5xc-minimum-configuration": {
5379
5673
  "description": "Minimum configuration for schemaviewsObjectRefType",
5380
5674
  "required_fields": [
@@ -5475,6 +5769,8 @@
5475
5769
  "x-validation-rules": {
5476
5770
  "ves.io.schema.rules.repeated.max_items": "32"
5477
5771
  },
5772
+ "x-f5xc-description-short": "Reference to virtual-sites Default virtual-site of the Virtual K8s object.",
5773
+ "x-f5xc-description-medium": "Reference to virtual-sites Default virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object annotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the Kubernetes API resource object.",
5478
5774
  "x-f5xc-required-for": {
5479
5775
  "minimum_config": false,
5480
5776
  "create": false,
@@ -5483,6 +5779,7 @@
5483
5779
  }
5484
5780
  }
5485
5781
  },
5782
+ "x-f5xc-description-short": "Create virtual_k8s will create the object in the storage backend for namespace metadata.namespace.",
5486
5783
  "x-f5xc-minimum-configuration": {
5487
5784
  "description": "Minimum configuration for virtual_k8sCreateSpecType",
5488
5785
  "required_fields": [
@@ -5511,6 +5808,7 @@
5511
5808
  "title": "Fail_if_referred.",
5512
5809
  "format": "boolean",
5513
5810
  "x-displayname": "Fail-If-Referred.",
5811
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
5514
5812
  "x-f5xc-required-for": {
5515
5813
  "minimum_config": false,
5516
5814
  "create": false,
@@ -5535,7 +5833,7 @@
5535
5833
  },
5536
5834
  "x-original-maxLength": 1024,
5537
5835
  "x-reconciled-from-discovery": true,
5538
- "x-reconciled-at": "2026-01-05T14:39:17.609649+00:00"
5836
+ "x-reconciled-at": "2026-01-07T15:29:42.658080+00:00"
5539
5837
  },
5540
5838
  "namespace": {
5541
5839
  "type": "string",
@@ -5544,6 +5842,7 @@
5544
5842
  "x-displayname": "Namespace",
5545
5843
  "x-ves-example": "Ns1",
5546
5844
  "x-f5xc-example": "ns1",
5845
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
5547
5846
  "minLength": 0,
5548
5847
  "maxLength": 6,
5549
5848
  "x-f5xc-required-for": {
@@ -5554,7 +5853,7 @@
5554
5853
  },
5555
5854
  "x-original-maxLength": 1024,
5556
5855
  "x-reconciled-from-discovery": true,
5557
- "x-reconciled-at": "2026-01-05T14:39:17.609653+00:00"
5856
+ "x-reconciled-at": "2026-01-07T15:29:42.658084+00:00"
5558
5857
  }
5559
5858
  },
5560
5859
  "x-f5xc-minimum-configuration": {
@@ -5589,6 +5888,7 @@
5589
5888
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5590
5889
  },
5591
5890
  "x-displayname": "Deleted Referred Objects.",
5891
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5592
5892
  "x-f5xc-required-for": {
5593
5893
  "minimum_config": false,
5594
5894
  "create": false,
@@ -5604,6 +5904,7 @@
5604
5904
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5605
5905
  },
5606
5906
  "x-displayname": "Disabled Referred Objects.",
5907
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5607
5908
  "x-f5xc-required-for": {
5608
5909
  "minimum_config": false,
5609
5910
  "create": false,
@@ -5622,6 +5923,7 @@
5622
5923
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5623
5924
  },
5624
5925
  "x-displayname": "Referring Objects.",
5926
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
5625
5927
  "x-f5xc-required-for": {
5626
5928
  "minimum_config": false,
5627
5929
  "create": false,
@@ -5643,6 +5945,8 @@
5643
5945
  "$ref": "#/components/schemas/virtual_k8sStatusObject"
5644
5946
  },
5645
5947
  "x-displayname": "Status",
5948
+ "x-f5xc-example": "active",
5949
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5646
5950
  "x-f5xc-required-for": {
5647
5951
  "minimum_config": false,
5648
5952
  "create": false,
@@ -5652,7 +5956,7 @@
5652
5956
  "maxLength": 17,
5653
5957
  "minLength": 17,
5654
5958
  "x-reconciled-from-discovery": true,
5655
- "x-reconciled-at": "2026-01-05T14:39:17.609668+00:00"
5959
+ "x-reconciled-at": "2026-01-07T15:29:42.658098+00:00"
5656
5960
  },
5657
5961
  "system_metadata": {
5658
5962
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -5692,6 +5996,8 @@
5692
5996
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
5693
5997
  ],
5694
5998
  "default": "GET_RSP_FORMAT_DEFAULT",
5999
+ "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...",
6000
+ "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...",
5695
6001
  "x-f5xc-minimum-configuration": {
5696
6002
  "description": "Minimum configuration for virtual_k8sGetResponseFormatCode",
5697
6003
  "required_fields": [],
@@ -5733,6 +6039,8 @@
5733
6039
  "x-validation-rules": {
5734
6040
  "ves.io.schema.rules.repeated.max_items": "32"
5735
6041
  },
6042
+ "x-f5xc-description-short": "Reference to virtual-sites Default virtual-site of the Virtual K8s object.",
6043
+ "x-f5xc-description-medium": "Reference to virtual-sites Default virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object annotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the Kubernetes API resource object.",
5736
6044
  "x-f5xc-required-for": {
5737
6045
  "minimum_config": false,
5738
6046
  "create": false,
@@ -5741,6 +6049,7 @@
5741
6049
  }
5742
6050
  }
5743
6051
  },
6052
+ "x-f5xc-description-short": "GET virtual_k8s will GET the object from the storage backend for namesapce metadata.namespace.",
5744
6053
  "x-f5xc-minimum-configuration": {
5745
6054
  "description": "Minimum configuration for virtual_k8sGetSpecType",
5746
6055
  "required_fields": [
@@ -5771,6 +6080,7 @@
5771
6080
  "$ref": "#/components/schemas/schemaErrorType"
5772
6081
  },
5773
6082
  "x-displayname": "Errors",
6083
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
5774
6084
  "x-f5xc-required-for": {
5775
6085
  "minimum_config": false,
5776
6086
  "create": false,
@@ -5786,6 +6096,8 @@
5786
6096
  "$ref": "#/components/schemas/virtual_k8sListResponseItem"
5787
6097
  },
5788
6098
  "x-displayname": "Items",
6099
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
6100
+ "x-f5xc-description-short": "Items represents the collection in response.",
5789
6101
  "x-f5xc-required-for": {
5790
6102
  "minimum_config": false,
5791
6103
  "create": false,
@@ -5819,6 +6131,8 @@
5819
6131
  "description": "The set of annotations present on this virtual_k8s.",
5820
6132
  "title": "Annotations.",
5821
6133
  "x-displayname": "Annotations.",
6134
+ "x-f5xc-example": "{\"key\": \"value\"}",
6135
+ "x-f5xc-description-short": "The set of annotations present on this virtual_k8s.",
5822
6136
  "x-f5xc-required-for": {
5823
6137
  "minimum_config": false,
5824
6138
  "create": false,
@@ -5831,6 +6145,7 @@
5831
6145
  "description": "The description set for this virtual_k8s.",
5832
6146
  "title": "Description.",
5833
6147
  "x-displayname": "Description.",
6148
+ "x-f5xc-description-short": "The description set for this virtual_k8s.",
5834
6149
  "minLength": 0,
5835
6150
  "maxLength": 0,
5836
6151
  "x-f5xc-required-for": {
@@ -5841,7 +6156,7 @@
5841
6156
  },
5842
6157
  "x-original-maxLength": 1024,
5843
6158
  "x-reconciled-from-discovery": true,
5844
- "x-reconciled-at": "2026-01-05T14:39:17.609686+00:00"
6159
+ "x-reconciled-at": "2026-01-07T15:29:42.658115+00:00"
5845
6160
  },
5846
6161
  "disabled": {
5847
6162
  "type": "boolean",
@@ -5849,6 +6164,8 @@
5849
6164
  "title": "Disabled",
5850
6165
  "format": "boolean",
5851
6166
  "x-displayname": "Disabled",
6167
+ "x-f5xc-example": "True",
6168
+ "x-f5xc-description-short": "Value of true indicates virtual_k8s is administratively disabled.",
5852
6169
  "x-f5xc-required-for": {
5853
6170
  "minimum_config": false,
5854
6171
  "create": false,
@@ -5864,6 +6181,8 @@
5864
6181
  "description": "The set of labels present on this virtual_k8s.",
5865
6182
  "title": "Labels",
5866
6183
  "x-displayname": "Labels",
6184
+ "x-f5xc-example": "{\"key\": \"value\"}",
6185
+ "x-f5xc-description-short": "The set of labels present on this virtual_k8s.",
5867
6186
  "x-f5xc-required-for": {
5868
6187
  "minimum_config": false,
5869
6188
  "create": false,
@@ -5891,7 +6210,7 @@
5891
6210
  },
5892
6211
  "x-original-maxLength": 1024,
5893
6212
  "x-reconciled-from-discovery": true,
5894
- "x-reconciled-at": "2026-01-05T14:39:17.609696+00:00"
6213
+ "x-reconciled-at": "2026-01-07T15:29:42.658125+00:00"
5895
6214
  },
5896
6215
  "namespace": {
5897
6216
  "type": "string",
@@ -5910,7 +6229,7 @@
5910
6229
  },
5911
6230
  "x-original-maxLength": 1024,
5912
6231
  "x-reconciled-from-discovery": true,
5913
- "x-reconciled-at": "2026-01-05T14:39:17.609700+00:00"
6232
+ "x-reconciled-at": "2026-01-07T15:29:42.658129+00:00"
5914
6233
  },
5915
6234
  "owner_view": {
5916
6235
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -5923,6 +6242,7 @@
5923
6242
  "$ref": "#/components/schemas/virtual_k8sStatusObject"
5924
6243
  },
5925
6244
  "x-displayname": "Status",
6245
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5926
6246
  "x-f5xc-required-for": {
5927
6247
  "minimum_config": false,
5928
6248
  "create": false,
@@ -5951,7 +6271,7 @@
5951
6271
  "x-field-mutability": "read-only",
5952
6272
  "x-original-maxLength": 1024,
5953
6273
  "x-reconciled-from-discovery": true,
5954
- "x-reconciled-at": "2026-01-05T14:39:17.609709+00:00"
6274
+ "x-reconciled-at": "2026-01-07T15:29:42.658137+00:00"
5955
6275
  },
5956
6276
  "uid": {
5957
6277
  "type": "string",
@@ -5972,9 +6292,11 @@
5972
6292
  "x-original-maxLength": 1024,
5973
6293
  "format": "uuid",
5974
6294
  "x-reconciled-from-discovery": true,
5975
- "x-reconciled-at": "2026-01-05T14:39:17.609714+00:00"
6295
+ "x-reconciled-at": "2026-01-07T15:29:42.658142+00:00"
5976
6296
  }
5977
6297
  },
6298
+ "x-f5xc-description-short": "By default a summary of virtual_k8s is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6299
+ "x-f5xc-description-medium": "By default a summary of virtual_k8s is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
5978
6300
  "x-f5xc-minimum-configuration": {
5979
6301
  "description": "Minimum configuration for virtual_k8sListResponseItem",
5980
6302
  "required_fields": [
@@ -6014,6 +6336,7 @@
6014
6336
  "$ref": "#/components/schemas/virtual_k8sPVCMetricTypeData"
6015
6337
  },
6016
6338
  "x-displayname": "Data",
6339
+ "x-f5xc-example": "{\"key\": \"value\"}",
6017
6340
  "x-f5xc-required-for": {
6018
6341
  "minimum_config": false,
6019
6342
  "create": false,
@@ -6028,6 +6351,7 @@
6028
6351
  "$ref": "#/components/schemas/schemaUnitType"
6029
6352
  }
6030
6353
  },
6354
+ "x-f5xc-description-short": "PVC Metric data contains the metric type and the corresponding metric value.",
6031
6355
  "x-f5xc-minimum-configuration": {
6032
6356
  "description": "Minimum configuration for virtual_k8sPVCMetricData",
6033
6357
  "required_fields": [
@@ -6075,6 +6399,7 @@
6075
6399
  "default": "PVC_USAGE",
6076
6400
  "x-displayname": "PVC Metric Type.",
6077
6401
  "x-ves-proto-enum": "ves.io.schema.virtual_k8s.PVCMetricType",
6402
+ "x-f5xc-description-short": "List of PVC metric types x-unit: \"bytes\" x-unit: \"bytes\".",
6078
6403
  "x-f5xc-minimum-configuration": {
6079
6404
  "description": "Minimum configuration for virtual_k8sPVCMetricType",
6080
6405
  "required_fields": [],
@@ -6097,6 +6422,8 @@
6097
6422
  "description": "Key contains the name/value pair.\n\"name\" is the label name defined in \"PVCMetricLabel\"",
6098
6423
  "title": "Key",
6099
6424
  "x-displayname": "Key",
6425
+ "x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
6426
+ "x-f5xc-description-short": "Key contains the name/value pair. \"name\" is the label name defined in \"PVCMetricLabel\".",
6100
6427
  "x-f5xc-required-for": {
6101
6428
  "minimum_config": false,
6102
6429
  "create": false,
@@ -6106,7 +6433,7 @@
6106
6433
  "maxLength": 16,
6107
6434
  "minLength": 7,
6108
6435
  "x-reconciled-from-discovery": true,
6109
- "x-reconciled-at": "2026-01-05T14:39:17.609724+00:00"
6436
+ "x-reconciled-at": "2026-01-07T15:29:42.658152+00:00"
6110
6437
  },
6111
6438
  "value": {
6112
6439
  "type": "array",
@@ -6125,9 +6452,11 @@
6125
6452
  "maxLength": 15,
6126
6453
  "minLength": 3,
6127
6454
  "x-reconciled-from-discovery": true,
6128
- "x-reconciled-at": "2026-01-05T14:39:17.609730+00:00"
6455
+ "x-reconciled-at": "2026-01-07T15:29:42.658158+00:00"
6129
6456
  }
6130
6457
  },
6458
+ "x-f5xc-description-short": "PVC Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
6459
+ "x-f5xc-description-medium": "PVC Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
6131
6460
  "x-f5xc-minimum-configuration": {
6132
6461
  "description": "Minimum configuration for virtual_k8sPVCMetricTypeData",
6133
6462
  "required_fields": [
@@ -6161,6 +6490,8 @@
6161
6490
  "x-validation-rules": {
6162
6491
  "ves.io.schema.rules.string.query_time": "true"
6163
6492
  },
6493
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
6494
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
6164
6495
  "minLength": 0,
6165
6496
  "maxLength": 1024,
6166
6497
  "x-f5xc-required-for": {
@@ -6193,6 +6524,8 @@
6193
6524
  "ves.io.schema.rules.repeated.min_items": "1",
6194
6525
  "ves.io.schema.rules.repeated.unique": "true"
6195
6526
  },
6527
+ "x-f5xc-description-short": "Select fields to be returned in the response. One or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified.",
6528
+ "x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified. Required: YES.",
6196
6529
  "x-f5xc-required-for": {
6197
6530
  "minimum_config": false,
6198
6531
  "create": false,
@@ -6207,6 +6540,8 @@
6207
6540
  "x-displayname": "Filter",
6208
6541
  "x-ves-example": "{PVC=\\\"pvc-1\\\"}",
6209
6542
  "x-f5xc-example": "\"{PVC=\\\"pvc-1\\\"}\"",
6543
+ "x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
6544
+ "x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in MetricLabel {PVC, SITE} can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = : equal to != ...",
6210
6545
  "minLength": 0,
6211
6546
  "maxLength": 1024,
6212
6547
  "x-f5xc-required-for": {
@@ -6224,6 +6559,7 @@
6224
6559
  "$ref": "#/components/schemas/virtual_k8sPVCMetricLabel"
6225
6560
  },
6226
6561
  "x-displayname": "Group By",
6562
+ "x-f5xc-description-short": "Aggregate data by zero or more labels {NAMESPACE, PVC, SITE}.",
6227
6563
  "x-f5xc-required-for": {
6228
6564
  "minimum_config": false,
6229
6565
  "create": false,
@@ -6233,7 +6569,7 @@
6233
6569
  },
6234
6570
  "namespace": {
6235
6571
  "type": "string",
6236
- "description": "",
6572
+ "description": "Human-readable name for the resource",
6237
6573
  "title": "Namespace",
6238
6574
  "x-displayname": "Namespace",
6239
6575
  "x-ves-example": "Ns1",
@@ -6248,7 +6584,7 @@
6248
6584
  },
6249
6585
  "x-original-maxLength": 1024,
6250
6586
  "x-reconciled-from-discovery": true,
6251
- "x-reconciled-at": "2026-01-05T14:39:17.609741+00:00"
6587
+ "x-reconciled-at": "2026-01-07T15:29:42.658168+00:00"
6252
6588
  },
6253
6589
  "range": {
6254
6590
  "type": "string",
@@ -6263,6 +6599,8 @@
6263
6599
  "x-validation-rules": {
6264
6600
  "ves.io.schema.rules.string.time_interval": "true"
6265
6601
  },
6602
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
6603
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
6266
6604
  "minLength": 0,
6267
6605
  "maxLength": 1024,
6268
6606
  "x-f5xc-required-for": {
@@ -6285,6 +6623,8 @@
6285
6623
  "x-validation-rules": {
6286
6624
  "ves.io.schema.rules.string.query_time": "true"
6287
6625
  },
6626
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
6627
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
6288
6628
  "minLength": 0,
6289
6629
  "maxLength": 1024,
6290
6630
  "x-f5xc-required-for": {
@@ -6307,6 +6647,8 @@
6307
6647
  "x-validation-rules": {
6308
6648
  "ves.io.schema.rules.string.query_step": "true"
6309
6649
  },
6650
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
6651
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
6310
6652
  "minLength": 0,
6311
6653
  "maxLength": 1024,
6312
6654
  "x-f5xc-required-for": {
@@ -6351,6 +6693,8 @@
6351
6693
  "$ref": "#/components/schemas/virtual_k8sPVCMetricData"
6352
6694
  },
6353
6695
  "x-displayname": "Data",
6696
+ "x-f5xc-example": "{\"key\": \"value\"}",
6697
+ "x-f5xc-description-short": "Data contains time-series metric data for PVC.",
6354
6698
  "x-f5xc-required-for": {
6355
6699
  "minimum_config": false,
6356
6700
  "create": false,
@@ -6371,6 +6715,8 @@
6371
6715
  "x-validation-rules": {
6372
6716
  "ves.io.schema.rules.string.time_interval": "true"
6373
6717
  },
6718
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
6719
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
6374
6720
  "minLength": 0,
6375
6721
  "maxLength": 1024,
6376
6722
  "x-f5xc-required-for": {
@@ -6465,6 +6811,8 @@
6465
6811
  "x-validation-rules": {
6466
6812
  "ves.io.schema.rules.repeated.max_items": "32"
6467
6813
  },
6814
+ "x-f5xc-description-short": "Reference to virtual-sites Default virtual-site of the Virtual K8s object.",
6815
+ "x-f5xc-description-medium": "Reference to virtual-sites Default virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object annotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the Kubernetes API resource object.",
6468
6816
  "x-f5xc-required-for": {
6469
6817
  "minimum_config": false,
6470
6818
  "create": false,
@@ -6473,6 +6821,8 @@
6473
6821
  }
6474
6822
  }
6475
6823
  },
6824
+ "x-f5xc-description-short": "Replacing an endpoint object will update the object by replacing the existing spec with the provided one.",
6825
+ "x-f5xc-description-medium": "Replacing an endpoint object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
6476
6826
  "x-f5xc-minimum-configuration": {
6477
6827
  "description": "Minimum configuration for virtual_k8sReplaceSpecType",
6478
6828
  "required_fields": [
@@ -6529,6 +6879,7 @@
6529
6879
  }
6530
6880
  }
6531
6881
  },
6882
+ "x-f5xc-description-short": "Most recently observed status of the Virtual K8s object.",
6532
6883
  "x-f5xc-minimum-configuration": {
6533
6884
  "description": "Minimum configuration for virtual_k8sStatusObject",
6534
6885
  "required_fields": [
@@ -6558,6 +6909,8 @@
6558
6909
  "title": "Manage DNS Domain.",
6559
6910
  "format": "boolean",
6560
6911
  "x-displayname": "Automatically Manage DNS Records.",
6912
+ "x-f5xc-description-short": "DNS records for domains will be managed automatically by F5 Distributed Cloud.",
6913
+ "x-f5xc-description-medium": "DNS records for domains will be managed automatically by F5 Distributed Cloud. As a prerequisite, the domain must be delegated to F5 Distributed Cloud using Delegated domain feature or a DNS CNAME record should be created in your DNS provider's portal.",
6561
6914
  "x-f5xc-required-for": {
6562
6915
  "minimum_config": false,
6563
6916
  "create": false,
@@ -6579,6 +6932,7 @@
6579
6932
  "x-validation-rules": {
6580
6933
  "ves.io.schema.rules.uint32.lte": "65535"
6581
6934
  },
6935
+ "x-f5xc-description-short": "Exclusive with [port_ranges] HTTP port to Listen.",
6582
6936
  "minimum": 1,
6583
6937
  "maximum": 65535,
6584
6938
  "x-f5xc-required-for": {
@@ -6609,6 +6963,8 @@
6609
6963
  "ves.io.schema.rules.string.min_len": "1",
6610
6964
  "ves.io.schema.rules.string.unique_port_range_list": "true"
6611
6965
  },
6966
+ "x-f5xc-description-short": "Exclusive with [port] A string containing a comma separated list of port ranges.",
6967
+ "x-f5xc-description-medium": "Exclusive with [port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".",
6612
6968
  "x-f5xc-required-for": {
6613
6969
  "minimum_config": false,
6614
6970
  "create": false,
@@ -6667,6 +7023,7 @@
6667
7023
  "title": "Add HSTS",
6668
7024
  "format": "boolean",
6669
7025
  "x-displayname": "Add HSTS Header.",
7026
+ "x-f5xc-description-short": "Add HTTP Strict-Transport-Security response header.",
6670
7027
  "x-f5xc-required-for": {
6671
7028
  "minimum_config": false,
6672
7029
  "create": false,
@@ -6686,6 +7043,9 @@
6686
7043
  "x-validation-rules": {
6687
7044
  "ves.io.schema.rules.string.max_len": "8096"
6688
7045
  },
7046
+ "x-f5xc-example": "example-resource",
7047
+ "x-f5xc-description-short": "Exclusive with [default_header pass_through server_name] Define the header value for the header name “server”.",
7048
+ "x-f5xc-description-medium": "Exclusive with [default_header pass_through server_name] Define the header value for the header name “server”. If header value is already present, it is not overwritten and passed as-is.",
6689
7049
  "minLength": 0,
6690
7050
  "x-f5xc-required-for": {
6691
7051
  "minimum_config": false,
@@ -6711,6 +7071,8 @@
6711
7071
  "x-validation-rules": {
6712
7072
  "ves.io.schema.rules.uint32.lte": "600000"
6713
7073
  },
7074
+ "x-f5xc-description-short": "The idle timeout for downstream connections. The idle timeout is defined as the period in which there are no active requests.",
7075
+ "x-f5xc-description-medium": "The idle timeout for downstream connections. The idle timeout is defined as the period in which there are no active requests. When the idle timeout is reached the connection will be closed.",
6714
7076
  "minimum": 0,
6715
7077
  "maximum": 2147483647,
6716
7078
  "x-f5xc-required-for": {
@@ -6769,6 +7131,7 @@
6769
7131
  "x-validation-rules": {
6770
7132
  "ves.io.schema.rules.uint32.lte": "65535"
6771
7133
  },
7134
+ "x-f5xc-description-short": "Exclusive with [port_ranges] HTTPS port to Listen.",
6772
7135
  "minimum": 1,
6773
7136
  "maximum": 65535,
6774
7137
  "x-f5xc-required-for": {
@@ -6799,6 +7162,8 @@
6799
7162
  "ves.io.schema.rules.string.min_len": "1",
6800
7163
  "ves.io.schema.rules.string.unique_port_range_list": "true"
6801
7164
  },
7165
+ "x-f5xc-description-short": "Exclusive with [port] A string containing a comma separated list of port ranges.",
7166
+ "x-f5xc-description-medium": "Exclusive with [port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".",
6802
7167
  "x-f5xc-required-for": {
6803
7168
  "minimum_config": false,
6804
7169
  "create": false,
@@ -6818,6 +7183,9 @@
6818
7183
  "x-validation-rules": {
6819
7184
  "ves.io.schema.rules.string.max_len": "8096"
6820
7185
  },
7186
+ "x-f5xc-example": "example-resource",
7187
+ "x-f5xc-description-short": "Exclusive with [append_server_name default_header pass_through] Define the header value for the header name “server”.",
7188
+ "x-f5xc-description-medium": "Exclusive with [append_server_name default_header pass_through] Define the header value for the header name “server”. This will overwrite existing values, if any, for the server header.",
6821
7189
  "minLength": 0,
6822
7190
  "x-f5xc-required-for": {
6823
7191
  "minimum_config": false,
@@ -6833,6 +7201,7 @@
6833
7201
  "$ref": "#/components/schemas/schemaviewsDownstreamTlsParamsType"
6834
7202
  }
6835
7203
  },
7204
+ "x-f5xc-description-short": "Choice for selecting HTTP proxy with bring your own certificates.",
6836
7205
  "x-f5xc-minimum-configuration": {
6837
7206
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
6838
7207
  "required_fields": [
@@ -6883,6 +7252,7 @@
6883
7252
  "title": "Add HSTS",
6884
7253
  "format": "boolean",
6885
7254
  "x-displayname": "Add HSTS Header.",
7255
+ "x-f5xc-description-short": "Add HTTP Strict-Transport-Security response header.",
6886
7256
  "x-f5xc-required-for": {
6887
7257
  "minimum_config": false,
6888
7258
  "create": false,
@@ -6902,6 +7272,9 @@
6902
7272
  "x-validation-rules": {
6903
7273
  "ves.io.schema.rules.string.max_len": "8096"
6904
7274
  },
7275
+ "x-f5xc-example": "example-resource",
7276
+ "x-f5xc-description-short": "Exclusive with [default_header pass_through server_name] Define the header value for the header name “server”.",
7277
+ "x-f5xc-description-medium": "Exclusive with [default_header pass_through server_name] Define the header value for the header name “server”. If header value is already present, it is not overwritten and passed as-is.",
6905
7278
  "minLength": 0,
6906
7279
  "x-f5xc-required-for": {
6907
7280
  "minimum_config": false,
@@ -6927,6 +7300,8 @@
6927
7300
  "x-validation-rules": {
6928
7301
  "ves.io.schema.rules.uint32.lte": "600000"
6929
7302
  },
7303
+ "x-f5xc-description-short": "The idle timeout for downstream connections. The idle timeout is defined as the period in which there are no active requests.",
7304
+ "x-f5xc-description-medium": "The idle timeout for downstream connections. The idle timeout is defined as the period in which there are no active requests. When the idle timeout is reached the connection will be closed.",
6930
7305
  "minimum": 0,
6931
7306
  "maximum": 2147483647,
6932
7307
  "x-f5xc-required-for": {
@@ -6987,6 +7362,7 @@
6987
7362
  "ves.io.schema.rules.uint32.lte": "65535"
6988
7363
  },
6989
7364
  "x-f5xc-example": "8080",
7365
+ "x-f5xc-description-short": "Exclusive with [port_ranges] HTTPS port to Listen.",
6990
7366
  "minimum": 1,
6991
7367
  "maximum": 65535,
6992
7368
  "x-f5xc-required-for": {
@@ -7017,6 +7393,8 @@
7017
7393
  "ves.io.schema.rules.string.min_len": "1",
7018
7394
  "ves.io.schema.rules.string.unique_port_range_list": "true"
7019
7395
  },
7396
+ "x-f5xc-description-short": "Exclusive with [port] A string containing a comma separated list of port ranges.",
7397
+ "x-f5xc-description-medium": "Exclusive with [port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".",
7020
7398
  "x-f5xc-required-for": {
7021
7399
  "minimum_config": false,
7022
7400
  "create": false,
@@ -7036,6 +7414,9 @@
7036
7414
  "x-validation-rules": {
7037
7415
  "ves.io.schema.rules.string.max_len": "8096"
7038
7416
  },
7417
+ "x-f5xc-example": "example-resource",
7418
+ "x-f5xc-description-short": "Exclusive with [append_server_name default_header pass_through] Define the header value for the header name “server”.",
7419
+ "x-f5xc-description-medium": "Exclusive with [append_server_name default_header pass_through] Define the header value for the header name “server”. This will overwrite existing values, if any, for the server header.",
7039
7420
  "minLength": 0,
7040
7421
  "x-f5xc-required-for": {
7041
7422
  "minimum_config": false,
@@ -7051,6 +7432,7 @@
7051
7432
  "$ref": "#/components/schemas/viewsDownstreamTlsValidationContext"
7052
7433
  }
7053
7434
  },
7435
+ "x-f5xc-description-short": "Choice for selecting HTTP proxy with bring your own certificates.",
7054
7436
  "x-f5xc-minimum-configuration": {
7055
7437
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7056
7438
  "required_fields": [
@@ -7093,6 +7475,7 @@
7093
7475
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
7094
7476
  }
7095
7477
  },
7478
+ "x-f5xc-description-short": "Custom route uses a route object created outside of this view.",
7096
7479
  "x-f5xc-minimum-configuration": {
7097
7480
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7098
7481
  "required_fields": [
@@ -7149,6 +7532,7 @@
7149
7532
  "ves.io.schema.rules.repeated.max_items": "16",
7150
7533
  "ves.io.schema.rules.repeated.unique": "true"
7151
7534
  },
7535
+ "x-f5xc-example": "{\"key\": \"value\"}",
7152
7536
  "x-f5xc-required-for": {
7153
7537
  "minimum_config": false,
7154
7538
  "create": false,
@@ -7169,6 +7553,8 @@
7169
7553
  "$ref": "#/components/schemas/routeRouteDirectResponse"
7170
7554
  }
7171
7555
  },
7556
+ "x-f5xc-description-short": "Direct response route matches on path, incoming header, incoming port and/or HTTP method and responds directly to the matching traffic.",
7557
+ "x-f5xc-description-medium": "Direct response route matches on path, incoming header, incoming port and/or HTTP method and responds directly to the matching traffic.",
7172
7558
  "x-f5xc-minimum-configuration": {
7173
7559
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7174
7560
  "required_fields": [
@@ -7225,6 +7611,7 @@
7225
7611
  "ves.io.schema.rules.repeated.max_items": "16",
7226
7612
  "ves.io.schema.rules.repeated.unique": "true"
7227
7613
  },
7614
+ "x-f5xc-example": "{\"key\": \"value\"}",
7228
7615
  "x-f5xc-required-for": {
7229
7616
  "minimum_config": false,
7230
7617
  "create": false,
@@ -7245,6 +7632,8 @@
7245
7632
  "$ref": "#/components/schemas/routeRouteRedirect"
7246
7633
  }
7247
7634
  },
7635
+ "x-f5xc-description-short": "Redirect route matches on path, incoming header, incoming port and/or HTTP method and redirects the matching traffic to a different URL.",
7636
+ "x-f5xc-description-medium": "Redirect route matches on path, incoming header, incoming port and/or HTTP method and redirects the matching traffic to a different URL.",
7248
7637
  "x-f5xc-minimum-configuration": {
7249
7638
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7250
7639
  "required_fields": [
@@ -7304,6 +7693,8 @@
7304
7693
  "x-validation-rules": {
7305
7694
  "ves.io.schema.rules.string.hostname": "true"
7306
7695
  },
7696
+ "x-f5xc-description-short": "Exclusive with [auto_host_rewrite disable_host_rewrite] Host header will be swapped with this value.",
7697
+ "x-f5xc-description-medium": "Exclusive with [auto_host_rewrite disable_host_rewrite] Host header will be swapped with this value.",
7307
7698
  "minLength": 0,
7308
7699
  "maxLength": 1024,
7309
7700
  "x-f5xc-required-for": {
@@ -7320,6 +7711,8 @@
7320
7711
  "$ref": "#/components/schemas/ioschemaPathMatcherType"
7321
7712
  }
7322
7713
  },
7714
+ "x-f5xc-description-short": "Simple route matches on path and/or HTTP method and forwards the matching traffic to the default origin pool specified outside.",
7715
+ "x-f5xc-description-medium": "Simple route matches on path and/or HTTP method and forwards the matching traffic to the default origin pool specified outside.",
7323
7716
  "x-f5xc-minimum-configuration": {
7324
7717
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7325
7718
  "required_fields": [
@@ -7375,6 +7768,7 @@
7375
7768
  "ves.io.schema.rules.string.max_bytes": "256",
7376
7769
  "ves.io.schema.rules.string.not_empty": "true"
7377
7770
  },
7771
+ "x-f5xc-description-short": "Exclusive with [presence regex] Header value to match exactly.",
7378
7772
  "minLength": 0,
7379
7773
  "x-f5xc-required-for": {
7380
7774
  "minimum_config": false,
@@ -7389,6 +7783,7 @@
7389
7783
  "title": "Invert_match.",
7390
7784
  "format": "boolean",
7391
7785
  "x-displayname": "NOT of match.",
7786
+ "x-f5xc-description-short": "Invert the result of the match to detect missing header or non-matching value.",
7392
7787
  "x-f5xc-required-for": {
7393
7788
  "minimum_config": false,
7394
7789
  "create": false,
@@ -7426,7 +7821,7 @@
7426
7821
  },
7427
7822
  "x-original-maxLength": 256,
7428
7823
  "x-reconciled-from-discovery": true,
7429
- "x-reconciled-at": "2026-01-05T14:39:20.978410+00:00"
7824
+ "x-reconciled-at": "2026-01-07T15:29:46.444962+00:00"
7430
7825
  },
7431
7826
  "presence": {
7432
7827
  "type": "boolean",
@@ -7434,6 +7829,7 @@
7434
7829
  "title": "Presence",
7435
7830
  "format": "boolean",
7436
7831
  "x-displayname": "Presence",
7832
+ "x-f5xc-description-short": "Exclusive with [exact regex] If true, check for presence of header.",
7437
7833
  "x-f5xc-required-for": {
7438
7834
  "minimum_config": false,
7439
7835
  "create": false,
@@ -7457,6 +7853,7 @@
7457
7853
  "ves.io.schema.rules.string.not_empty": "true",
7458
7854
  "ves.io.schema.rules.string.regex": "true"
7459
7855
  },
7856
+ "x-f5xc-description-short": "Exclusive with [exact presence] Regex match of the header value in re2 format.",
7460
7857
  "minLength": 0,
7461
7858
  "x-f5xc-required-for": {
7462
7859
  "minimum_config": false,
@@ -7466,6 +7863,8 @@
7466
7863
  }
7467
7864
  }
7468
7865
  },
7866
+ "x-f5xc-description-short": "Header match is done using the name of the header and its value.",
7867
+ "x-f5xc-description-medium": "Header match is done using the name of the header and its value. The value match is done using one of the following regex match on value exact match of value presence of header Header Match can also be inverse of above, which be used to check missing header or non-matching value.",
7469
7868
  "x-f5xc-minimum-configuration": {
7470
7869
  "description": "Minimum configuration for ioschemaHeaderMatcherType",
7471
7870
  "required_fields": [
@@ -7507,6 +7906,7 @@
7507
7906
  "ves.io.schema.rules.string.http_path": "true",
7508
7907
  "ves.io.schema.rules.string.max_len": "256"
7509
7908
  },
7909
+ "x-f5xc-description-short": "Exclusive with [prefix regex] Exact path value to match.",
7510
7910
  "minLength": 0,
7511
7911
  "x-f5xc-required-for": {
7512
7912
  "minimum_config": false,
@@ -7531,6 +7931,7 @@
7531
7931
  "ves.io.schema.rules.string.http_path": "true",
7532
7932
  "ves.io.schema.rules.string.max_len": "256"
7533
7933
  },
7934
+ "x-f5xc-description-short": "Exclusive with [path regex] Path prefix to match (e.g. The value / will match on all paths)",
7534
7935
  "minLength": 0,
7535
7936
  "x-f5xc-required-for": {
7536
7937
  "minimum_config": false,
@@ -7556,6 +7957,8 @@
7556
7957
  "ves.io.schema.rules.string.min_bytes": "1",
7557
7958
  "ves.io.schema.rules.string.regex": "true"
7558
7959
  },
7960
+ "x-f5xc-description-short": "Exclusive with [path prefix] Regular expression of path match (e.g. The value .* will match on all paths)",
7961
+ "x-f5xc-description-medium": "Exclusive with [path prefix] Regular expression of path match (e.g. The value .* will match on all paths).",
7559
7962
  "x-f5xc-required-for": {
7560
7963
  "minimum_config": false,
7561
7964
  "create": false,
@@ -7564,6 +7967,7 @@
7564
7967
  }
7565
7968
  }
7566
7969
  },
7970
+ "x-f5xc-description-short": "Path match of the URI can be either be, Prefix match or exact match or regular expression match.",
7567
7971
  "x-f5xc-minimum-configuration": {
7568
7972
  "description": "Minimum configuration for ioschemaPathMatcherType",
7569
7973
  "required_fields": [
@@ -7604,6 +8008,7 @@
7604
8008
  "x-validation-rules": {
7605
8009
  "ves.io.schema.rules.uint32.lte": "65535"
7606
8010
  },
8011
+ "x-f5xc-description-short": "Exclusive with [no_port_match port_ranges] Exact Port to match.",
7607
8012
  "minimum": 1,
7608
8013
  "maximum": 65535,
7609
8014
  "x-f5xc-required-for": {
@@ -7632,6 +8037,7 @@
7632
8037
  "ves.io.schema.rules.string.min_len": "1",
7633
8038
  "ves.io.schema.rules.string.port_range": "true"
7634
8039
  },
8040
+ "x-f5xc-description-short": "Exclusive with [no_port_match port] Port range to match.",
7635
8041
  "x-f5xc-required-for": {
7636
8042
  "minimum_config": false,
7637
8043
  "create": false,
@@ -7640,6 +8046,7 @@
7640
8046
  }
7641
8047
  }
7642
8048
  },
8049
+ "x-f5xc-description-short": "Port match of the request can be a range or a specific port.",
7643
8050
  "x-f5xc-minimum-configuration": {
7644
8051
  "description": "Minimum configuration for ioschemaPortMatcherType",
7645
8052
  "required_fields": [
@@ -7677,6 +8084,8 @@
7677
8084
  "ves.io.schema.rules.string.max_bytes": "65536",
7678
8085
  "ves.io.schema.rules.string.uri_ref": "true"
7679
8086
  },
8087
+ "x-f5xc-description-short": "Response body to send. Currently supported URL schemes is string:/// for which message should be encoded in Base64 format.",
8088
+ "x-f5xc-description-medium": "Response body to send. Currently supported URL schemes is string:/// for which message should be encoded in Base64 format. The message can be either plain text or HTML.",
7680
8089
  "minLength": 0,
7681
8090
  "x-f5xc-required-for": {
7682
8091
  "minimum_config": false,
@@ -7711,6 +8120,7 @@
7711
8120
  }
7712
8121
  }
7713
8122
  },
8123
+ "x-f5xc-description-short": "Send this direct response in case of route match action is direct response.",
7714
8124
  "x-f5xc-minimum-configuration": {
7715
8125
  "description": "Minimum configuration for routeRouteDirectResponse",
7716
8126
  "required_fields": [
@@ -7737,6 +8147,7 @@
7737
8147
  "type": "string"
7738
8148
  },
7739
8149
  "x-f5xc-example": "userid",
8150
+ "x-f5xc-description-short": "X-displayName: \"Query Parameters\" Query params keys to strip while manipulating the HTTP request.",
7740
8151
  "x-f5xc-required-for": {
7741
8152
  "minimum_config": false,
7742
8153
  "create": false,
@@ -7745,6 +8156,7 @@
7745
8156
  }
7746
8157
  }
7747
8158
  },
8159
+ "x-f5xc-description-short": "X-displayName: \"Query Parameters\" Query params keys to strip while manipulating the HTTP request.",
7748
8160
  "x-f5xc-minimum-configuration": {
7749
8161
  "description": "Minimum configuration for routeRouteQueryParams",
7750
8162
  "required_fields": [
@@ -7774,6 +8186,7 @@
7774
8186
  "x-displayname": "Host",
7775
8187
  "x-ves-example": "one.ves.I/O.",
7776
8188
  "x-f5xc-example": "one.F5 XC",
8189
+ "x-f5xc-description-short": "Swap host part of incoming URL in redirect URL.",
7777
8190
  "minLength": 0,
7778
8191
  "maxLength": 1024,
7779
8192
  "x-f5xc-required-for": {
@@ -7799,6 +8212,7 @@
7799
8212
  "ves.io.schema.rules.string.http_path": "true",
7800
8213
  "ves.io.schema.rules.string.max_len": "256"
7801
8214
  },
8215
+ "x-f5xc-description-short": "Exclusive with [prefix_rewrite] swap path part of incoming URL in redirect URL.",
7802
8216
  "minLength": 0,
7803
8217
  "x-f5xc-required-for": {
7804
8218
  "minimum_config": false,
@@ -7823,6 +8237,8 @@
7823
8237
  "ves.io.schema.rules.string.http_path": "true",
7824
8238
  "ves.io.schema.rules.string.max_len": "256"
7825
8239
  },
8240
+ "x-f5xc-description-short": "Exclusive with [path_redirect] In Redirect response, the matched prefix (or path) should be swapped with this value.",
8241
+ "x-f5xc-description-medium": "Exclusive with [path_redirect] In Redirect response, the matched prefix (or path) should be swapped with this value. This option allows redirect URLs be dynamically created based on the request.",
7826
8242
  "minLength": 0,
7827
8243
  "x-f5xc-required-for": {
7828
8244
  "minimum_config": false,
@@ -7844,6 +8260,8 @@
7844
8260
  "x-validation-rules": {
7845
8261
  "ves.io.schema.rules.string.in": "[\\\"incoming-proto\\\",\\\"http\\\",\\\"https\\\"]"
7846
8262
  },
8263
+ "x-f5xc-description-short": "Swap protocol part of incoming URL in redirect URL The protocol can be swapped with either HTTP or HTTPS When incoming-proto option is specified...",
8264
+ "x-f5xc-description-medium": "Swap protocol part of incoming URL in redirect URL The protocol can be swapped with either HTTP or HTTPS When incoming-proto option is specified, swapping of protocol is not done.",
7847
8265
  "minLength": 0,
7848
8266
  "maxLength": 1024,
7849
8267
  "x-f5xc-required-for": {
@@ -7871,6 +8289,7 @@
7871
8289
  "ves.io.schema.rules.string.max_len": "256",
7872
8290
  "ves.io.schema.rules.string.min_len": "1"
7873
8291
  },
8292
+ "x-f5xc-description-short": "Exclusive with [remove_all_params retain_all_params].",
7874
8293
  "x-f5xc-required-for": {
7875
8294
  "minimum_config": false,
7876
8295
  "create": false,
@@ -7892,6 +8311,7 @@
7892
8311
  "x-validation-rules": {
7893
8312
  "ves.io.schema.rules.uint32.lte": "599"
7894
8313
  },
8314
+ "x-f5xc-description-short": "The HTTP status code to use in the redirect response.",
7895
8315
  "minimum": 0,
7896
8316
  "maximum": 2147483647,
7897
8317
  "x-f5xc-required-for": {
@@ -7905,6 +8325,7 @@
7905
8325
  "$ref": "#/components/schemas/ioschemaEmpty"
7906
8326
  }
7907
8327
  },
8328
+ "x-f5xc-description-short": "Route redirect parameters when match action is redirect.",
7908
8329
  "x-f5xc-minimum-configuration": {
7909
8330
  "description": "Minimum configuration for routeRouteRedirect",
7910
8331
  "required_fields": [
@@ -7939,6 +8360,8 @@
7939
8360
  "x-displayname": "Decryption Provider.",
7940
8361
  "x-ves-example": "Value",
7941
8362
  "x-f5xc-example": "value",
8363
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
8364
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
7942
8365
  "minLength": 0,
7943
8366
  "maxLength": 1024,
7944
8367
  "x-f5xc-required-for": {
@@ -7964,6 +8387,8 @@
7964
8387
  "ves.io.schema.rules.message.required": "true",
7965
8388
  "ves.io.schema.rules.string.uri_ref": "true"
7966
8389
  },
8390
+ "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
8391
+ "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
7967
8392
  "minLength": 0,
7968
8393
  "maxLength": 4,
7969
8394
  "x-f5xc-required-for": {
@@ -7974,7 +8399,7 @@
7974
8399
  },
7975
8400
  "x-original-maxLength": 1024,
7976
8401
  "x-reconciled-from-discovery": true,
7977
- "x-reconciled-at": "2026-01-05T14:39:20.978486+00:00"
8402
+ "x-reconciled-at": "2026-01-07T15:29:46.445034+00:00"
7978
8403
  },
7979
8404
  "store_provider": {
7980
8405
  "type": "string",
@@ -7983,6 +8408,8 @@
7983
8408
  "x-displayname": "Store Provider.",
7984
8409
  "x-ves-example": "Value",
7985
8410
  "x-f5xc-example": "value",
8411
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
8412
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
7986
8413
  "minLength": 0,
7987
8414
  "maxLength": 1024,
7988
8415
  "x-f5xc-required-for": {
@@ -7993,6 +8420,7 @@
7993
8420
  }
7994
8421
  }
7995
8422
  },
8423
+ "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
7996
8424
  "x-f5xc-minimum-configuration": {
7997
8425
  "description": "Minimum configuration for schemaBlindfoldSecretInfoType",
7998
8426
  "required_fields": [
@@ -8022,6 +8450,8 @@
8022
8450
  "x-displayname": "Provider",
8023
8451
  "x-ves-example": "Box-provider.",
8024
8452
  "x-f5xc-example": "box-provider",
8453
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
8454
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
8025
8455
  "minLength": 0,
8026
8456
  "maxLength": 8,
8027
8457
  "x-f5xc-required-for": {
@@ -8032,7 +8462,7 @@
8032
8462
  },
8033
8463
  "x-original-maxLength": 1024,
8034
8464
  "x-reconciled-from-discovery": true,
8035
- "x-reconciled-at": "2026-01-05T14:39:20.978493+00:00"
8465
+ "x-reconciled-at": "2026-01-07T15:29:46.445040+00:00"
8036
8466
  },
8037
8467
  "url": {
8038
8468
  "type": "string",
@@ -8053,6 +8483,8 @@
8053
8483
  "ves.io.schema.rules.string.max_bytes": "131072",
8054
8484
  "ves.io.schema.rules.string.uri_ref": "true"
8055
8485
  },
8486
+ "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
8487
+ "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
8056
8488
  "format": "uri",
8057
8489
  "minLength": 0,
8058
8490
  "x-f5xc-required-for": {
@@ -8063,6 +8495,7 @@
8063
8495
  }
8064
8496
  }
8065
8497
  },
8498
+ "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
8066
8499
  "x-f5xc-minimum-configuration": {
8067
8500
  "description": "Minimum configuration for schemaClearSecretInfoType",
8068
8501
  "required_fields": [
@@ -8088,6 +8521,8 @@
8088
8521
  "default": "INVALID_HASH_ALGORITHM",
8089
8522
  "x-displayname": "Hash Algorithm.",
8090
8523
  "x-ves-proto-enum": "ves.io.schema.HashAlgorithm",
8524
+ "x-f5xc-description-short": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
8525
+ "x-f5xc-description-medium": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
8091
8526
  "x-f5xc-minimum-configuration": {
8092
8527
  "description": "Minimum configuration for schemaHashAlgorithm",
8093
8528
  "required_fields": [],
@@ -8128,6 +8563,7 @@
8128
8563
  "ves.io.schema.rules.repeated.min_items": "1",
8129
8564
  "ves.io.schema.rules.repeated.unique": "true"
8130
8565
  },
8566
+ "x-f5xc-description-short": "Ordered list of hash algorithms to be used. Required: YES.",
8131
8567
  "x-f5xc-required-for": {
8132
8568
  "minimum_config": false,
8133
8569
  "create": false,
@@ -8136,6 +8572,7 @@
8136
8572
  }
8137
8573
  }
8138
8574
  },
8575
+ "x-f5xc-description-short": "Specifies the hash algorithms to be used.",
8139
8576
  "x-f5xc-minimum-configuration": {
8140
8577
  "description": "Minimum configuration for schemaHashAlgorithms",
8141
8578
  "required_fields": [
@@ -8170,6 +8607,7 @@
8170
8607
  "$ref": "#/components/schemas/ioschemaEmpty"
8171
8608
  }
8172
8609
  },
8610
+ "x-f5xc-description-short": "Header Transformation OPTIONS for HTTP/1.1 request/response headers.",
8173
8611
  "x-f5xc-minimum-configuration": {
8174
8612
  "description": "Minimum configuration for schemaHeaderTransformationType",
8175
8613
  "required_fields": [
@@ -8205,6 +8643,7 @@
8205
8643
  "default": "ANY",
8206
8644
  "x-displayname": "HTTP Method.",
8207
8645
  "x-ves-proto-enum": "ves.io.schema.HttpMethod",
8646
+ "x-f5xc-description-short": "Specifies the HTTP method used to access a resource. Any HTTP Method.",
8208
8647
  "x-f5xc-minimum-configuration": {
8209
8648
  "description": "Minimum configuration for schemaHttpMethod",
8210
8649
  "required_fields": [],
@@ -8239,7 +8678,7 @@
8239
8678
  },
8240
8679
  "x-original-maxLength": 1024,
8241
8680
  "x-reconciled-from-discovery": true,
8242
- "x-reconciled-at": "2026-01-05T14:39:20.978536+00:00"
8681
+ "x-reconciled-at": "2026-01-07T15:29:46.445080+00:00"
8243
8682
  },
8244
8683
  "name": {
8245
8684
  "type": "string",
@@ -8258,7 +8697,7 @@
8258
8697
  },
8259
8698
  "x-original-maxLength": 1024,
8260
8699
  "x-reconciled-from-discovery": true,
8261
- "x-reconciled-at": "2026-01-05T14:39:20.978541+00:00"
8700
+ "x-reconciled-at": "2026-01-07T15:29:46.445084+00:00"
8262
8701
  },
8263
8702
  "namespace": {
8264
8703
  "type": "string",
@@ -8277,9 +8716,10 @@
8277
8716
  },
8278
8717
  "x-original-maxLength": 1024,
8279
8718
  "x-reconciled-from-discovery": true,
8280
- "x-reconciled-at": "2026-01-05T14:39:20.978545+00:00"
8719
+ "x-reconciled-at": "2026-01-07T15:29:46.445088+00:00"
8281
8720
  }
8282
8721
  },
8722
+ "x-f5xc-description-short": "KubeRefType represents a reference to a Kubernetes (K8s) object.",
8283
8723
  "x-f5xc-minimum-configuration": {
8284
8724
  "description": "Minimum configuration for schemaKubeRefType",
8285
8725
  "required_fields": [
@@ -8303,6 +8743,8 @@
8303
8743
  "EncodingBase64"
8304
8744
  ],
8305
8745
  "default": "EncodingNone",
8746
+ "x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
8747
+ "x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
8306
8748
  "x-f5xc-minimum-configuration": {
8307
8749
  "description": "Minimum configuration for schemaSecretEncodingType",
8308
8750
  "required_fields": [],
@@ -8328,6 +8770,7 @@
8328
8770
  "$ref": "#/components/schemas/schemaClearSecretInfoType"
8329
8771
  }
8330
8772
  },
8773
+ "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
8331
8774
  "x-f5xc-minimum-configuration": {
8332
8775
  "description": "Minimum configuration for schemaSecretType",
8333
8776
  "required_fields": [
@@ -8356,6 +8799,7 @@
8356
8799
  "$ref": "#/components/schemas/ioschemaEmpty"
8357
8800
  }
8358
8801
  },
8802
+ "x-f5xc-description-short": "TLS connection coalescing configuration (not compatible with mTLS).",
8359
8803
  "x-f5xc-minimum-configuration": {
8360
8804
  "description": "Minimum configuration for schemaTLSCoalescingOptions",
8361
8805
  "required_fields": [
@@ -8399,6 +8843,8 @@
8399
8843
  "ves.io.schema.rules.string.max_bytes": "131072",
8400
8844
  "ves.io.schema.rules.string.min_bytes": "1"
8401
8845
  },
8846
+ "x-f5xc-description-short": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers.",
8847
+ "x-f5xc-description-medium": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
8402
8848
  "x-f5xc-required-for": {
8403
8849
  "minimum_config": false,
8404
8850
  "create": false,
@@ -8426,7 +8872,7 @@
8426
8872
  },
8427
8873
  "x-original-maxLength": 1024,
8428
8874
  "x-reconciled-from-discovery": true,
8429
- "x-reconciled-at": "2026-01-05T14:39:20.978675+00:00"
8875
+ "x-reconciled-at": "2026-01-07T15:29:46.445225+00:00"
8430
8876
  },
8431
8877
  "disable_ocsp_stapling": {
8432
8878
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -8469,6 +8915,8 @@
8469
8915
  "default": "TLS_AUTO",
8470
8916
  "x-displayname": "TLS Protocol.",
8471
8917
  "x-ves-proto-enum": "ves.io.schema.TlsProtocol",
8918
+ "x-f5xc-description-short": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
8919
+ "x-f5xc-description-medium": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
8472
8920
  "x-f5xc-minimum-configuration": {
8473
8921
  "description": "Minimum configuration for schemaTlsProtocol",
8474
8922
  "required_fields": [],
@@ -8489,6 +8937,8 @@
8489
8937
  "description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
8490
8938
  "title": "Key",
8491
8939
  "x-f5xc-example": "key_pem",
8940
+ "x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
8941
+ "x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
8492
8942
  "minLength": 0,
8493
8943
  "maxLength": 16,
8494
8944
  "x-f5xc-required-for": {
@@ -8499,13 +8949,14 @@
8499
8949
  },
8500
8950
  "x-original-maxLength": 1024,
8501
8951
  "x-reconciled-from-discovery": true,
8502
- "x-reconciled-at": "2026-01-05T14:39:20.978696+00:00"
8952
+ "x-reconciled-at": "2026-01-07T15:29:46.445246+00:00"
8503
8953
  },
8504
8954
  "location": {
8505
8955
  "type": "string",
8506
8956
  "description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
8507
8957
  "title": "Location",
8508
8958
  "x-f5xc-example": "v1/data/vhost_key",
8959
+ "x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
8509
8960
  "minLength": 0,
8510
8961
  "maxLength": 4,
8511
8962
  "x-f5xc-required-for": {
@@ -8516,13 +8967,15 @@
8516
8967
  },
8517
8968
  "x-original-maxLength": 1024,
8518
8969
  "x-reconciled-from-discovery": true,
8519
- "x-reconciled-at": "2026-01-05T14:39:20.978700+00:00"
8970
+ "x-reconciled-at": "2026-01-07T15:29:46.445250+00:00"
8520
8971
  },
8521
8972
  "provider": {
8522
8973
  "type": "string",
8523
8974
  "description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
8524
8975
  "title": "Provider",
8525
8976
  "x-f5xc-example": "vault-vh-provider",
8977
+ "x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
8978
+ "x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
8526
8979
  "minLength": 0,
8527
8980
  "maxLength": 8,
8528
8981
  "x-f5xc-required-for": {
@@ -8533,7 +8986,7 @@
8533
8986
  },
8534
8987
  "x-original-maxLength": 1024,
8535
8988
  "x-reconciled-from-discovery": true,
8536
- "x-reconciled-at": "2026-01-05T14:39:20.978704+00:00"
8989
+ "x-reconciled-at": "2026-01-07T15:29:46.445254+00:00"
8537
8990
  },
8538
8991
  "secret_encoding": {
8539
8992
  "$ref": "#/components/schemas/schemaSecretEncodingType"
@@ -8544,6 +8997,8 @@
8544
8997
  "title": "Version",
8545
8998
  "format": "int64",
8546
8999
  "x-f5xc-example": "1",
9000
+ "x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
9001
+ "x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
8547
9002
  "minimum": 0,
8548
9003
  "maximum": 2147483647,
8549
9004
  "x-f5xc-required-for": {
@@ -8555,9 +9010,11 @@
8555
9010
  "maxLength": 1,
8556
9011
  "minLength": 1,
8557
9012
  "x-reconciled-from-discovery": true,
8558
- "x-reconciled-at": "2026-01-05T14:39:20.978711+00:00"
9013
+ "x-reconciled-at": "2026-01-07T15:29:46.445261+00:00"
8559
9014
  }
8560
9015
  },
9016
+ "x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
9017
+ "x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
8561
9018
  "x-f5xc-minimum-configuration": {
8562
9019
  "description": "Minimum configuration for schemaVaultSecretInfoType",
8563
9020
  "required_fields": [
@@ -8584,6 +9041,7 @@
8584
9041
  "description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
8585
9042
  "title": "Name",
8586
9043
  "x-f5xc-example": "ChargeBack-API-Key",
9044
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
8587
9045
  "minLength": 0,
8588
9046
  "maxLength": 16,
8589
9047
  "x-f5xc-required-for": {
@@ -8594,9 +9052,10 @@
8594
9052
  },
8595
9053
  "x-original-maxLength": 1024,
8596
9054
  "x-reconciled-from-discovery": true,
8597
- "x-reconciled-at": "2026-01-05T14:39:20.978734+00:00"
9055
+ "x-reconciled-at": "2026-01-07T15:29:46.445283+00:00"
8598
9056
  }
8599
9057
  },
9058
+ "x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
8600
9059
  "x-f5xc-minimum-configuration": {
8601
9060
  "description": "Minimum configuration for schemaWingmanSecretInfoType",
8602
9061
  "required_fields": [
@@ -8624,6 +9083,8 @@
8624
9083
  "default": "XFCC_NONE",
8625
9084
  "x-displayname": "XFCC Elements.",
8626
9085
  "x-ves-proto-enum": "ves.io.schema.XfccElement",
9086
+ "x-f5xc-description-short": "X-Forwarded-Client-Cert custom cookie elements The entire client certificate in URL encoded PEM format.",
9087
+ "x-f5xc-description-medium": "X-Forwarded-Client-Cert custom cookie elements The entire client certificate in URL encoded PEM format. The entire client certificate chain (including the leaf certificate) in URL encoded PEM format. The Subject field of the current client certificate.",
8627
9088
  "x-f5xc-minimum-configuration": {
8628
9089
  "description": "Minimum configuration for schemaXfccElement",
8629
9090
  "required_fields": [],
@@ -8666,6 +9127,8 @@
8666
9127
  "ves.io.schema.rules.repeated.max_items": "16",
8667
9128
  "ves.io.schema.rules.repeated.min_items": "1"
8668
9129
  },
9130
+ "x-f5xc-description-short": "Users can add one or more certificates that share the same set of domains.",
9131
+ "x-f5xc-description-medium": "Users can add one or more certificates that share the same set of domains. For example, domain.com and *.domain.com - but use different signature algorithms Required: YES.",
8669
9132
  "x-f5xc-required-for": {
8670
9133
  "minimum_config": false,
8671
9134
  "create": false,
@@ -8706,6 +9169,7 @@
8706
9169
  "$ref": "#/components/schemas/schemaHeaderTransformationType"
8707
9170
  }
8708
9171
  },
9172
+ "x-f5xc-description-short": "HTTP/1.1 Protocol OPTIONS for downstream connections.",
8709
9173
  "x-f5xc-minimum-configuration": {
8710
9174
  "description": "Minimum configuration for schemavirtual_hostHttp1ProtocolOptions",
8711
9175
  "required_fields": [
@@ -8747,6 +9211,7 @@
8747
9211
  "ves.io.schema.rules.repeated.items.string.in": "[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]",
8748
9212
  "ves.io.schema.rules.repeated.unique": "true"
8749
9213
  },
9214
+ "x-f5xc-description-short": "The TLS listener will only support the specified cipher list. Required: YES.",
8750
9215
  "x-f5xc-required-for": {
8751
9216
  "minimum_config": false,
8752
9217
  "create": false,
@@ -8761,6 +9226,7 @@
8761
9226
  "$ref": "#/components/schemas/schemaTlsProtocol"
8762
9227
  }
8763
9228
  },
9229
+ "x-f5xc-description-short": "Defines TLS protocol config including min/max versions and allowed ciphers.",
8764
9230
  "x-f5xc-minimum-configuration": {
8765
9231
  "description": "Minimum configuration for viewsCustomCiphers",
8766
9232
  "required_fields": [
@@ -8803,6 +9269,7 @@
8803
9269
  "ves.io.schema.rules.repeated.max_items": "32",
8804
9270
  "ves.io.schema.rules.repeated.unique": "true"
8805
9271
  },
9272
+ "x-f5xc-description-short": "Select one or more certificates with any domain names. Required: YES.",
8806
9273
  "x-f5xc-required-for": {
8807
9274
  "minimum_config": false,
8808
9275
  "create": false,
@@ -8851,6 +9318,9 @@
8851
9318
  "title": "Client_certificate_optional.",
8852
9319
  "format": "boolean",
8853
9320
  "x-displayname": "Client Certificate Optional.",
9321
+ "x-f5xc-example": "{\"key\": \"value\"}",
9322
+ "x-f5xc-description-short": "Client certificate is optional. If the client has provided a certificate, the load balancer will verify it.",
9323
+ "x-f5xc-description-medium": "Client certificate is optional. If the client has provided a certificate, the load balancer will verify it. If certification verification fails, the connection will be terminated.",
8854
9324
  "x-f5xc-required-for": {
8855
9325
  "minimum_config": false,
8856
9326
  "create": false,
@@ -8884,6 +9354,7 @@
8884
9354
  "ves.io.schema.rules.string.min_bytes": "1",
8885
9355
  "ves.io.schema.rules.string.truststore_url": "true"
8886
9356
  },
9357
+ "x-f5xc-description-short": "Exclusive with [trusted_ca] Upload a Root CA Certificate specifically for this Load Balancer.",
8887
9358
  "x-f5xc-required-for": {
8888
9359
  "minimum_config": false,
8889
9360
  "create": false,
@@ -8898,6 +9369,7 @@
8898
9369
  "$ref": "#/components/schemas/viewsXfccHeaderKeys"
8899
9370
  }
8900
9371
  },
9372
+ "x-f5xc-description-short": "Validation context for downstream client TLS connections.",
8901
9373
  "x-f5xc-minimum-configuration": {
8902
9374
  "description": "Minimum configuration for viewsDownstreamTlsValidationContext",
8903
9375
  "required_fields": [
@@ -8932,6 +9404,8 @@
8932
9404
  "default": "SITE_NETWORK_INSIDE_AND_OUTSIDE",
8933
9405
  "x-displayname": "Site Network.",
8934
9406
  "x-ves-proto-enum": "ves.io.schema.views.SiteNetwork",
9407
+ "x-f5xc-description-short": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support.",
9408
+ "x-f5xc-description-medium": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks.",
8935
9409
  "x-f5xc-minimum-configuration": {
8936
9410
  "description": "Minimum configuration for viewsSiteNetwork",
8937
9411
  "required_fields": [],
@@ -8964,6 +9438,7 @@
8964
9438
  "$ref": "#/components/schemas/ioschemaEmpty"
8965
9439
  }
8966
9440
  },
9441
+ "x-f5xc-description-short": "Defines various OPTIONS to configure TLS configuration parameters.",
8967
9442
  "x-f5xc-minimum-configuration": {
8968
9443
  "description": "Minimum configuration for viewsTlsConfig",
8969
9444
  "required_fields": [
@@ -9000,6 +9475,7 @@
9000
9475
  "x-validation-rules": {
9001
9476
  "ves.io.schema.rules.string.ipv4": "true"
9002
9477
  },
9478
+ "x-f5xc-description-short": "Use given IP address as VIP on the site.",
9003
9479
  "minLength": 0,
9004
9480
  "maxLength": 1024,
9005
9481
  "x-f5xc-required-for": {
@@ -9016,6 +9492,8 @@
9016
9492
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
9017
9493
  }
9018
9494
  },
9495
+ "x-f5xc-description-short": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.",
9496
+ "x-f5xc-description-medium": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.",
9019
9497
  "x-f5xc-minimum-configuration": {
9020
9498
  "description": "Minimum configuration for viewsWhereSite",
9021
9499
  "required_fields": [
@@ -9046,6 +9524,8 @@
9046
9524
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
9047
9525
  }
9048
9526
  },
9527
+ "x-f5xc-description-short": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.",
9528
+ "x-f5xc-description-medium": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.",
9049
9529
  "x-f5xc-minimum-configuration": {
9050
9530
  "description": "Minimum configuration for viewsWhereVK8SService",
9051
9531
  "required_fields": [
@@ -9074,6 +9554,8 @@
9074
9554
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
9075
9555
  }
9076
9556
  },
9557
+ "x-f5xc-description-short": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.",
9558
+ "x-f5xc-description-medium": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.",
9077
9559
  "x-f5xc-minimum-configuration": {
9078
9560
  "description": "Minimum configuration for viewsWhereVirtualSite",
9079
9561
  "required_fields": [
@@ -9113,6 +9595,7 @@
9113
9595
  "ves.io.schema.rules.repeated.items.enum.defined_only": "true",
9114
9596
  "ves.io.schema.rules.repeated.items.enum.not_in": "[0]"
9115
9597
  },
9598
+ "x-f5xc-description-short": "X-Forwarded-Client-Cert header elements to be added to requests Required: YES.",
9116
9599
  "x-f5xc-required-for": {
9117
9600
  "minimum_config": false,
9118
9601
  "create": false,
@@ -9121,6 +9604,7 @@
9121
9604
  }
9122
9605
  }
9123
9606
  },
9607
+ "x-f5xc-description-short": "X-Forwarded-Client-Cert header elements to be added to requests.",
9124
9608
  "x-f5xc-minimum-configuration": {
9125
9609
  "description": "Minimum configuration for viewsXfccHeaderKeys",
9126
9610
  "required_fields": [
@@ -9219,6 +9703,8 @@
9219
9703
  "default": "PROTOCOL_TCP",
9220
9704
  "x-displayname": "Protocol Type.",
9221
9705
  "x-ves-proto-enum": "ves.io.schema.views.workload.ProtocolType",
9706
+ "x-f5xc-description-short": "Type of protocol - PROTOCOL_TCP: TCP TCP - PROTOCOL_HTTP: HTTP HTTP - PROTOCOL_HTTP2: HTTP2 HTTP2 - PROTOCOL_TLS_WITH_SNI: TLS with SNI TLS with...",
9707
+ "x-f5xc-description-medium": "Type of protocol - PROTOCOL_TCP: TCP TCP - PROTOCOL_HTTP: HTTP HTTP - PROTOCOL_HTTP2: HTTP2 HTTP2 - PROTOCOL_TLS_WITH_SNI: TLS with SNI TLS with SNI - PROTOCOL_UDP: UDP UDP.",
9222
9708
  "x-f5xc-minimum-configuration": {
9223
9709
  "description": "Minimum configuration for viewsworkloadProtocolType",
9224
9710
  "required_fields": [],
@@ -9295,6 +9781,7 @@
9295
9781
  }
9296
9782
  }
9297
9783
  },
9784
+ "x-f5xc-description-short": "Defines various OPTIONS to define a route.",
9298
9785
  "x-f5xc-minimum-configuration": {
9299
9786
  "description": "Minimum configuration for viewsworkloadRouteType",
9300
9787
  "required_fields": [
@@ -9339,6 +9826,7 @@
9339
9826
  "ves.io.schema.rules.message.required": "true",
9340
9827
  "ves.io.schema.rules.repeated.max_items": "16"
9341
9828
  },
9829
+ "x-f5xc-description-short": "Containers to use for service Required: YES.",
9342
9830
  "x-f5xc-required-for": {
9343
9831
  "minimum_config": false,
9344
9832
  "create": false,
@@ -9365,6 +9853,7 @@
9365
9853
  "ves.io.schema.rules.int32.gt": "0",
9366
9854
  "ves.io.schema.rules.int32.lte": "5"
9367
9855
  },
9856
+ "x-f5xc-description-short": "Exclusive with [scale_to_zero] Number of replicas of service to spawn per site.",
9368
9857
  "minimum": 0,
9369
9858
  "maximum": 2147483647,
9370
9859
  "x-f5xc-required-for": {
@@ -9400,6 +9889,8 @@
9400
9889
  }
9401
9890
  }
9402
9891
  },
9892
+ "x-f5xc-description-short": "Service does not maintain per replica state, however it can be configured to use persistent storage that is shared amongst all the replicas.",
9893
+ "x-f5xc-description-medium": "Service does not maintain per replica state, however it can be configured to use persistent storage that is shared amongst all the replicas. Replicas of a service are fungible and do not have a stable network identity or storage. Common examples of services are web servers, application servers...",
9403
9894
  "x-f5xc-minimum-configuration": {
9404
9895
  "description": "Minimum configuration for viewsworkloadServiceType",
9405
9896
  "required_fields": [
@@ -9437,6 +9928,7 @@
9437
9928
  "$ref": "#/components/schemas/ioschemaEmpty"
9438
9929
  }
9439
9930
  },
9931
+ "x-f5xc-description-short": "HTTP protocol configuration OPTIONS for downstream connections.",
9440
9932
  "x-f5xc-minimum-configuration": {
9441
9933
  "description": "Minimum configuration for virtual_hostHttpProtocolOptions",
9442
9934
  "required_fields": [
@@ -9481,6 +9973,7 @@
9481
9973
  "ves.io.schema.rules.repeated.min_items": "1",
9482
9974
  "ves.io.schema.rules.repeated.unique": "true"
9483
9975
  },
9976
+ "x-f5xc-description-short": "Where should this load balancer be available Required: YES.",
9484
9977
  "x-f5xc-required-for": {
9485
9978
  "minimum_config": false,
9486
9979
  "create": false,
@@ -9514,6 +10007,7 @@
9514
10007
  }
9515
10008
  }
9516
10009
  },
10010
+ "x-f5xc-description-short": "Advertise this workload via loadbalancer on specific sites.",
9517
10011
  "x-f5xc-minimum-configuration": {
9518
10012
  "description": "Minimum configuration for workloadAdvertiseCustomType",
9519
10013
  "required_fields": [
@@ -9542,6 +10036,7 @@
9542
10036
  "$ref": "#/components/schemas/workloadSinglePortType"
9543
10037
  }
9544
10038
  },
10039
+ "x-f5xc-description-short": "Advertise the workload locally in-cluster.",
9545
10040
  "x-f5xc-minimum-configuration": {
9546
10041
  "description": "Minimum configuration for workloadAdvertiseInClusterType",
9547
10042
  "required_fields": [
@@ -9621,6 +10116,8 @@
9621
10116
  "$ref": "#/components/schemas/ioschemaEmpty"
9622
10117
  }
9623
10118
  },
10119
+ "x-f5xc-description-short": "Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers.",
10120
+ "x-f5xc-description-medium": "Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers.",
9624
10121
  "x-f5xc-minimum-configuration": {
9625
10122
  "description": "Minimum configuration for workloadAdvertiseOptionsType",
9626
10123
  "required_fields": [
@@ -9683,6 +10180,7 @@
9683
10180
  "$ref": "#/components/schemas/workloadAdvertiseSinglePortType"
9684
10181
  }
9685
10182
  },
10183
+ "x-f5xc-description-short": "Advertise this workload via loadbalancer on Internet with default VIP.",
9686
10184
  "x-f5xc-minimum-configuration": {
9687
10185
  "description": "Minimum configuration for workloadAdvertisePublicType",
9688
10186
  "required_fields": [
@@ -9736,6 +10234,8 @@
9736
10234
  "ves.io.schema.rules.repeated.min_items": "1",
9737
10235
  "ves.io.schema.rules.repeated.unique": "true"
9738
10236
  },
10237
+ "x-f5xc-description-short": "List of Domains (host/authority header) that will be matched to Load Balancer.",
10238
+ "x-f5xc-description-medium": "List of Domains (host/authority header) that will be matched to Load Balancer. Wildcard hosts are supported in the suffix or prefix form Supported Domains and search order: 1. Exact Domain names: www.example.com. 2.",
9739
10239
  "x-f5xc-required-for": {
9740
10240
  "minimum_config": false,
9741
10241
  "create": false,
@@ -9762,6 +10262,7 @@
9762
10262
  "ves.io.schema.rules.uint32.gte": "1024",
9763
10263
  "ves.io.schema.rules.uint32.lte": "65535"
9764
10264
  },
10265
+ "x-f5xc-description-short": "Service port to advertise on Internet via HTTP loadbalancer using port 80 Required: YES.",
9765
10266
  "minimum": 0,
9766
10267
  "maximum": 2147483647,
9767
10268
  "x-f5xc-required-for": {
@@ -9835,6 +10336,7 @@
9835
10336
  "$ref": "#/components/schemas/viewsWhereVK8SService"
9836
10337
  }
9837
10338
  },
10339
+ "x-f5xc-description-short": "Defines various OPTIONS where a load balancer could be advertised.",
9838
10340
  "x-f5xc-minimum-configuration": {
9839
10341
  "description": "Minimum configuration for workloadAdvertiseWhereType",
9840
10342
  "required_fields": [
@@ -9909,7 +10411,7 @@
9909
10411
  },
9910
10412
  "x-original-maxLength": 256,
9911
10413
  "x-reconciled-from-discovery": true,
9912
- "x-reconciled-at": "2026-01-05T14:39:20.978877+00:00"
10414
+ "x-reconciled-at": "2026-01-07T15:29:46.445402+00:00"
9913
10415
  },
9914
10416
  "volume_name": {
9915
10417
  "type": "string",
@@ -9967,6 +10469,7 @@
9967
10469
  "$ref": "#/components/schemas/workloadConfigurationFileType"
9968
10470
  }
9969
10471
  },
10472
+ "x-f5xc-description-short": "Configuration parameter for the workload.",
9970
10473
  "x-f5xc-minimum-configuration": {
9971
10474
  "description": "Minimum configuration for workloadConfigurationParameterType",
9972
10475
  "required_fields": [
@@ -10012,6 +10515,7 @@
10012
10515
  }
10013
10516
  }
10014
10517
  },
10518
+ "x-f5xc-description-short": "Configuration parameters of the workload.",
10015
10519
  "x-f5xc-minimum-configuration": {
10016
10520
  "description": "Minimum configuration for workloadConfigurationParametersType",
10017
10521
  "required_fields": [
@@ -10036,6 +10540,8 @@
10036
10540
  "default": "CONTAINER_FLAVOR_TYPE_TINY",
10037
10541
  "x-displayname": "Container Flavor Type.",
10038
10542
  "x-ves-proto-enum": "ves.io.schema.views.workload.ContainerFlavorType",
10543
+ "x-f5xc-description-short": "Container Flavor type - CONTAINER_FLAVOR_TYPE_TINY: Tiny Tiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory ...",
10544
+ "x-f5xc-description-medium": "Container Flavor type - CONTAINER_FLAVOR_TYPE_TINY: Tiny Tiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_MEDIUM: Medium Medium containers have limit of 0.25 vCPU and 512 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_LARGE: Large Large containers have...",
10039
10545
  "x-f5xc-minimum-configuration": {
10040
10546
  "description": "Minimum configuration for workloadContainerFlavorType",
10041
10547
  "required_fields": [],
@@ -10071,6 +10577,7 @@
10071
10577
  "x-validation-rules": {
10072
10578
  "ves.io.schema.rules.repeated.max_items": "128"
10073
10579
  },
10580
+ "x-f5xc-description-short": "Arguments to the entrypoint. Overrides the docker image's CMD.",
10074
10581
  "x-f5xc-required-for": {
10075
10582
  "minimum_config": false,
10076
10583
  "create": false,
@@ -10095,6 +10602,7 @@
10095
10602
  "x-validation-rules": {
10096
10603
  "ves.io.schema.rules.repeated.max_items": "128"
10097
10604
  },
10605
+ "x-f5xc-description-short": "Command to execute. Overrides the docker image's ENTRYPOINT.",
10098
10606
  "x-f5xc-required-for": {
10099
10607
  "minimum_config": false,
10100
10608
  "create": false,
@@ -10120,6 +10628,7 @@
10120
10628
  "title": "Init Container.",
10121
10629
  "format": "boolean",
10122
10630
  "x-displayname": "Initialization Container.",
10631
+ "x-f5xc-description-short": "Specialized container that runs before application container and runs to completion.",
10123
10632
  "x-f5xc-required-for": {
10124
10633
  "minimum_config": false,
10125
10634
  "create": false,
@@ -10156,12 +10665,13 @@
10156
10665
  },
10157
10666
  "x-original-maxLength": 256,
10158
10667
  "x-reconciled-from-discovery": true,
10159
- "x-reconciled-at": "2026-01-05T14:39:20.978899+00:00"
10668
+ "x-reconciled-at": "2026-01-07T15:29:46.445422+00:00"
10160
10669
  },
10161
10670
  "readiness_check": {
10162
10671
  "$ref": "#/components/schemas/workloadHealthCheckType"
10163
10672
  }
10164
10673
  },
10674
+ "x-f5xc-description-short": "ContainerType configures the container information.",
10165
10675
  "x-f5xc-minimum-configuration": {
10166
10676
  "description": "Minimum configuration for workloadContainerType",
10167
10677
  "required_fields": [
@@ -10251,6 +10761,7 @@
10251
10761
  "title": "Fail_if_referred.",
10252
10762
  "format": "boolean",
10253
10763
  "x-displayname": "Fail-If-Referred.",
10764
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
10254
10765
  "x-f5xc-required-for": {
10255
10766
  "minimum_config": false,
10256
10767
  "create": false,
@@ -10275,7 +10786,7 @@
10275
10786
  },
10276
10787
  "x-original-maxLength": 1024,
10277
10788
  "x-reconciled-from-discovery": true,
10278
- "x-reconciled-at": "2026-01-05T14:39:20.978914+00:00"
10789
+ "x-reconciled-at": "2026-01-07T15:29:46.445435+00:00"
10279
10790
  },
10280
10791
  "namespace": {
10281
10792
  "type": "string",
@@ -10284,6 +10795,7 @@
10284
10795
  "x-displayname": "Namespace",
10285
10796
  "x-ves-example": "Ns1",
10286
10797
  "x-f5xc-example": "ns1",
10798
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
10287
10799
  "minLength": 0,
10288
10800
  "maxLength": 6,
10289
10801
  "x-f5xc-required-for": {
@@ -10294,7 +10806,7 @@
10294
10806
  },
10295
10807
  "x-original-maxLength": 1024,
10296
10808
  "x-reconciled-from-discovery": true,
10297
- "x-reconciled-at": "2026-01-05T14:39:20.978918+00:00"
10809
+ "x-reconciled-at": "2026-01-07T15:29:46.445439+00:00"
10298
10810
  }
10299
10811
  },
10300
10812
  "x-f5xc-minimum-configuration": {
@@ -10341,6 +10853,7 @@
10341
10853
  "ves.io.schema.rules.repeated.min_items": "1",
10342
10854
  "ves.io.schema.rules.repeated.unique": "true"
10343
10855
  },
10856
+ "x-f5xc-description-short": "Which customer sites should this workload be deployed Required: YES.",
10344
10857
  "x-f5xc-required-for": {
10345
10858
  "minimum_config": false,
10346
10859
  "create": false,
@@ -10349,6 +10862,7 @@
10349
10862
  }
10350
10863
  }
10351
10864
  },
10865
+ "x-f5xc-description-short": "Defines a way to deploy a workload on specific Customer sites.",
10352
10866
  "x-f5xc-minimum-configuration": {
10353
10867
  "description": "Minimum configuration for workloadDeployCESiteType",
10354
10868
  "required_fields": [
@@ -10391,6 +10905,7 @@
10391
10905
  "ves.io.schema.rules.repeated.min_items": "1",
10392
10906
  "ves.io.schema.rules.repeated.unique": "true"
10393
10907
  },
10908
+ "x-f5xc-description-short": "Which customer virtual sites should this workload be deployed Required: YES.",
10394
10909
  "x-f5xc-required-for": {
10395
10910
  "minimum_config": false,
10396
10911
  "create": false,
@@ -10399,6 +10914,7 @@
10399
10914
  }
10400
10915
  }
10401
10916
  },
10917
+ "x-f5xc-description-short": "Defines a way to deploy a workload on specific Customer virtual sites.",
10402
10918
  "x-f5xc-minimum-configuration": {
10403
10919
  "description": "Minimum configuration for workloadDeployCEVirtualSiteType",
10404
10920
  "required_fields": [
@@ -10438,6 +10954,7 @@
10438
10954
  "$ref": "#/components/schemas/workloadDeployREVirtualSiteType"
10439
10955
  }
10440
10956
  },
10957
+ "x-f5xc-description-short": "Deploy OPTIONS are used to configure the workload deployment OPTIONS.",
10441
10958
  "x-f5xc-minimum-configuration": {
10442
10959
  "description": "Minimum configuration for workloadDeployOptionsType",
10443
10960
  "required_fields": [
@@ -10485,6 +11002,7 @@
10485
11002
  "ves.io.schema.rules.repeated.min_items": "1",
10486
11003
  "ves.io.schema.rules.repeated.unique": "true"
10487
11004
  },
11005
+ "x-f5xc-description-short": "Which regional edge sites should this workload be deployed Required: YES.",
10488
11006
  "x-f5xc-required-for": {
10489
11007
  "minimum_config": false,
10490
11008
  "create": false,
@@ -10493,6 +11011,7 @@
10493
11011
  }
10494
11012
  }
10495
11013
  },
11014
+ "x-f5xc-description-short": "Defines a way to deploy a workload on specific Regional Edge sites.",
10496
11015
  "x-f5xc-minimum-configuration": {
10497
11016
  "description": "Minimum configuration for workloadDeployRESiteType",
10498
11017
  "required_fields": [
@@ -10535,6 +11054,7 @@
10535
11054
  "ves.io.schema.rules.repeated.min_items": "1",
10536
11055
  "ves.io.schema.rules.repeated.unique": "true"
10537
11056
  },
11057
+ "x-f5xc-description-short": "Which regional edge virtual sites should this workload be deployed Required: YES.",
10538
11058
  "x-f5xc-required-for": {
10539
11059
  "minimum_config": false,
10540
11060
  "create": false,
@@ -10543,6 +11063,7 @@
10543
11063
  }
10544
11064
  }
10545
11065
  },
11066
+ "x-f5xc-description-short": "Defines a way to deploy a workload on specific Regional Edge virtual sites.",
10546
11067
  "x-f5xc-minimum-configuration": {
10547
11068
  "description": "Minimum configuration for workloadDeployREVirtualSiteType",
10548
11069
  "required_fields": [
@@ -10590,6 +11111,7 @@
10590
11111
  }
10591
11112
  }
10592
11113
  },
11114
+ "x-f5xc-description-short": "Volume containing a temporary directory whose lifetime is the same as a replica of a workload.",
10593
11115
  "x-f5xc-minimum-configuration": {
10594
11116
  "description": "Minimum configuration for workloadEmptyDirectoryVolumeType",
10595
11117
  "required_fields": [
@@ -10633,7 +11155,7 @@
10633
11155
  },
10634
11156
  "x-original-maxLength": 256,
10635
11157
  "x-reconciled-from-discovery": true,
10636
- "x-reconciled-at": "2026-01-05T14:39:20.978942+00:00"
11158
+ "x-reconciled-at": "2026-01-07T15:29:46.445464+00:00"
10637
11159
  },
10638
11160
  "value": {
10639
11161
  "type": "string",
@@ -10658,7 +11180,7 @@
10658
11180
  },
10659
11181
  "x-original-maxLength": 256,
10660
11182
  "x-reconciled-from-discovery": true,
10661
- "x-reconciled-at": "2026-01-05T14:39:20.978946+00:00"
11183
+ "x-reconciled-at": "2026-01-07T15:29:46.445468+00:00"
10662
11184
  }
10663
11185
  },
10664
11186
  "x-f5xc-minimum-configuration": {
@@ -10711,9 +11233,10 @@
10711
11233
  },
10712
11234
  "x-original-maxLength": 1024,
10713
11235
  "x-reconciled-from-discovery": true,
10714
- "x-reconciled-at": "2026-01-05T14:39:20.978953+00:00"
11236
+ "x-reconciled-at": "2026-01-07T15:29:46.445475+00:00"
10715
11237
  }
10716
11238
  },
11239
+ "x-f5xc-description-short": "Ephemeral storage volume configuration for the workload.",
10717
11240
  "x-f5xc-minimum-configuration": {
10718
11241
  "description": "Minimum configuration for workloadEphemeralStorageVolumeType",
10719
11242
  "required_fields": [
@@ -10763,6 +11286,8 @@
10763
11286
  "ves.io.schema.rules.repeated.max_items": "16",
10764
11287
  "ves.io.schema.rules.repeated.unique": "true"
10765
11288
  },
11289
+ "x-f5xc-description-short": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem.",
11290
+ "x-f5xc-description-medium": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to...",
10766
11291
  "x-f5xc-required-for": {
10767
11292
  "minimum_config": false,
10768
11293
  "create": false,
@@ -10771,6 +11296,8 @@
10771
11296
  }
10772
11297
  }
10773
11298
  },
11299
+ "x-f5xc-description-short": "ExecHealthCheckType describes a health check based on \"run in container\" action.",
11300
+ "x-f5xc-description-medium": "ExecHealthCheckType describes a health check based on \"run in container\" action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
10774
11301
  "x-f5xc-minimum-configuration": {
10775
11302
  "description": "Health check configuration for monitoring origin servers",
10776
11303
  "required_fields": [
@@ -10812,6 +11339,7 @@
10812
11339
  "$ref": "#/components/schemas/ioschemaObjectRefType"
10813
11340
  },
10814
11341
  "x-displayname": "Deleted Referred Objects.",
11342
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
10815
11343
  "x-f5xc-required-for": {
10816
11344
  "minimum_config": false,
10817
11345
  "create": false,
@@ -10827,6 +11355,7 @@
10827
11355
  "$ref": "#/components/schemas/ioschemaObjectRefType"
10828
11356
  },
10829
11357
  "x-displayname": "Disabled Referred Objects.",
11358
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
10830
11359
  "x-f5xc-required-for": {
10831
11360
  "minimum_config": false,
10832
11361
  "create": false,
@@ -10845,6 +11374,7 @@
10845
11374
  "$ref": "#/components/schemas/ioschemaObjectRefType"
10846
11375
  },
10847
11376
  "x-displayname": "Referring Objects.",
11377
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
10848
11378
  "x-f5xc-required-for": {
10849
11379
  "minimum_config": false,
10850
11380
  "create": false,
@@ -10866,6 +11396,8 @@
10866
11396
  "$ref": "#/components/schemas/workloadStatusObject"
10867
11397
  },
10868
11398
  "x-displayname": "Status",
11399
+ "x-f5xc-example": "active",
11400
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
10869
11401
  "x-f5xc-required-for": {
10870
11402
  "minimum_config": false,
10871
11403
  "create": false,
@@ -10875,7 +11407,7 @@
10875
11407
  "maxLength": 17,
10876
11408
  "minLength": 17,
10877
11409
  "x-reconciled-from-discovery": true,
10878
- "x-reconciled-at": "2026-01-05T14:39:20.978970+00:00"
11410
+ "x-reconciled-at": "2026-01-07T15:29:46.445491+00:00"
10879
11411
  },
10880
11412
  "system_metadata": {
10881
11413
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -10915,6 +11447,8 @@
10915
11447
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
10916
11448
  ],
10917
11449
  "default": "GET_RSP_FORMAT_DEFAULT",
11450
+ "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...",
11451
+ "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...",
10918
11452
  "x-f5xc-minimum-configuration": {
10919
11453
  "description": "Minimum configuration for workloadGetResponseFormatCode",
10920
11454
  "required_fields": [],
@@ -10953,6 +11487,8 @@
10953
11487
  "ves.io.schema.rules.map.values.string.max_len": "2048",
10954
11488
  "ves.io.schema.rules.map.values.string.min_len": "1"
10955
11489
  },
11490
+ "x-f5xc-description-short": "Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container.",
11491
+ "x-f5xc-description-medium": "Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs.",
10956
11492
  "x-f5xc-required-for": {
10957
11493
  "minimum_config": false,
10958
11494
  "create": false,
@@ -10976,6 +11512,7 @@
10976
11512
  "ves.io.schema.rules.string.hostport": "true",
10977
11513
  "ves.io.schema.rules.string.max_len": "262"
10978
11514
  },
11515
+ "x-f5xc-description-short": "The value of the host header in the HTTP health check request.",
10979
11516
  "minLength": 0,
10980
11517
  "x-f5xc-required-for": {
10981
11518
  "minimum_config": false,
@@ -11003,6 +11540,7 @@
11003
11540
  "ves.io.schema.rules.string.http_path": "true",
11004
11541
  "ves.io.schema.rules.string.max_len": "2048"
11005
11542
  },
11543
+ "x-f5xc-description-short": "Path to access on the HTTP server. Required: YES.",
11006
11544
  "minLength": 0,
11007
11545
  "x-f5xc-required-for": {
11008
11546
  "minimum_config": false,
@@ -11015,6 +11553,7 @@
11015
11553
  "$ref": "#/components/schemas/workloadPortChoiceType"
11016
11554
  }
11017
11555
  },
11556
+ "x-f5xc-description-short": "HTTPHealthCheckType describes a health check based on HTTP GET requests.",
11018
11557
  "x-f5xc-minimum-configuration": {
11019
11558
  "description": "Health check configuration for monitoring origin servers",
11020
11559
  "required_fields": [
@@ -11083,6 +11622,8 @@
11083
11622
  "ves.io.schema.rules.repeated.min_items": "1",
11084
11623
  "ves.io.schema.rules.repeated.unique": "true"
11085
11624
  },
11625
+ "x-f5xc-description-short": "List of domains (host/authority header) that will be matched to loadbalancer.",
11626
+ "x-f5xc-description-medium": "List of domains (host/authority header) that will be matched to loadbalancer. Wildcard hosts are supported in the suffix or prefix form Domain search order: 1. Exact domain names: `` is invalid Domains are also used for SNI matching if the loadbalancer type is HTTPS Domains also indicate the...",
11086
11627
  "x-f5xc-required-for": {
11087
11628
  "minimum_config": false,
11088
11629
  "create": false,
@@ -11150,6 +11691,8 @@
11150
11691
  "ves.io.schema.rules.uint32.gte": "1",
11151
11692
  "ves.io.schema.rules.uint32.lte": "16"
11152
11693
  },
11694
+ "x-f5xc-description-short": "Number of consecutive successful responses after having failed before declaring healthy.",
11695
+ "x-f5xc-description-medium": "Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container...",
11153
11696
  "minimum": 0,
11154
11697
  "maximum": 2147483647,
11155
11698
  "x-f5xc-required-for": {
@@ -11176,6 +11719,7 @@
11176
11719
  "x-validation-rules": {
11177
11720
  "ves.io.schema.rules.uint32.lte": "600"
11178
11721
  },
11722
+ "x-f5xc-description-short": "Number of seconds after the container has started before health checks are initiated.",
11179
11723
  "minimum": 0,
11180
11724
  "maximum": 2147483647,
11181
11725
  "x-f5xc-required-for": {
@@ -11204,6 +11748,7 @@
11204
11748
  "ves.io.schema.rules.uint32.gte": "1",
11205
11749
  "ves.io.schema.rules.uint32.lte": "600"
11206
11750
  },
11751
+ "x-f5xc-description-short": "Time interval in seconds between two health check requests. Required: YES.",
11207
11752
  "minimum": 0,
11208
11753
  "maximum": 2147483647,
11209
11754
  "x-f5xc-required-for": {
@@ -11235,6 +11780,8 @@
11235
11780
  "ves.io.schema.rules.uint32.gte": "1",
11236
11781
  "ves.io.schema.rules.uint32.lte": "600"
11237
11782
  },
11783
+ "x-f5xc-description-short": "Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response.",
11784
+ "x-f5xc-description-medium": "Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure.",
11238
11785
  "minimum": 0,
11239
11786
  "maximum": 2147483647,
11240
11787
  "x-f5xc-required-for": {
@@ -11263,6 +11810,8 @@
11263
11810
  "ves.io.schema.rules.uint32.gte": "1",
11264
11811
  "ves.io.schema.rules.uint32.lte": "16"
11265
11812
  },
11813
+ "x-f5xc-description-short": "Number of consecutive failed responses before declaring unhealthy.",
11814
+ "x-f5xc-description-medium": "Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy. Required: YES.",
11266
11815
  "minimum": 0,
11267
11816
  "maximum": 2147483647,
11268
11817
  "x-f5xc-required-for": {
@@ -11273,6 +11822,8 @@
11273
11822
  }
11274
11823
  }
11275
11824
  },
11825
+ "x-f5xc-description-short": "HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to...",
11826
+ "x-f5xc-description-medium": "HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic.",
11276
11827
  "x-f5xc-minimum-configuration": {
11277
11828
  "description": "Health check configuration for monitoring origin servers",
11278
11829
  "required_fields": [
@@ -11325,6 +11876,7 @@
11325
11876
  "ves.io.schema.rules.string.max_len": "256",
11326
11877
  "ves.io.schema.rules.string.pattern": "[^\\\\0]+"
11327
11878
  },
11879
+ "x-f5xc-description-short": "Path of the directory on the host Required: YES.",
11328
11880
  "minLength": 0,
11329
11881
  "x-f5xc-required-for": {
11330
11882
  "minimum_config": false,
@@ -11334,6 +11886,7 @@
11334
11886
  }
11335
11887
  }
11336
11888
  },
11889
+ "x-f5xc-description-short": "Volume containing a host mapped path into the workload.",
11337
11890
  "x-f5xc-minimum-configuration": {
11338
11891
  "description": "Minimum configuration for workloadHostPathVolumeType",
11339
11892
  "required_fields": [
@@ -11393,6 +11946,8 @@
11393
11946
  "default": "IMAGE_PULL_POLICY_DEFAULT",
11394
11947
  "x-displayname": "Image Pull Policy Type.",
11395
11948
  "x-ves-proto-enum": "ves.io.schema.views.workload.ImagePullPolicyType",
11949
+ "x-f5xc-description-short": "Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload - IMAGE_PULL_POLICY_DEFAULT...",
11950
+ "x-f5xc-description-medium": "Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload - IMAGE_PULL_POLICY_DEFAULT: Default Default will always pull image if :latest tag is specified in image name. If :latest tag is not specified in image name, it will pull image only...",
11396
11951
  "x-f5xc-minimum-configuration": {
11397
11952
  "description": "Minimum configuration for workloadImagePullPolicyType",
11398
11953
  "required_fields": [],
@@ -11431,6 +11986,8 @@
11431
11986
  "ves.io.schema.rules.message.required": "true",
11432
11987
  "ves.io.schema.rules.string.max_len": "256"
11433
11988
  },
11989
+ "x-f5xc-description-short": "Name is a container image which are usually given a name such as alpine, ubuntu, or quay.I/O/etcd:0.13.",
11990
+ "x-f5xc-description-medium": "Name is a container image which are usually given a name such as alpine, ubuntu, or quay.I/O/etcd:0.13. The format is registry/image:tag or registry/image@image-digest. If registry is not specified, the Docker public registry is assumed.",
11434
11991
  "minLength": 0,
11435
11992
  "x-f5xc-required-for": {
11436
11993
  "minimum_config": false,
@@ -11440,7 +11997,7 @@
11440
11997
  },
11441
11998
  "x-original-maxLength": 256,
11442
11999
  "x-reconciled-from-discovery": true,
11443
- "x-reconciled-at": "2026-01-05T14:39:20.979013+00:00"
12000
+ "x-reconciled-at": "2026-01-07T15:29:46.445543+00:00"
11444
12001
  },
11445
12002
  "public": {
11446
12003
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -11449,6 +12006,8 @@
11449
12006
  "$ref": "#/components/schemas/workloadImagePullPolicyType"
11450
12007
  }
11451
12008
  },
12009
+ "x-f5xc-description-short": "ImageType configures the image to use, how to pull the image, and the associated secrets to use if any.",
12010
+ "x-f5xc-description-medium": "ImageType configures the image to use, how to pull the image, and the associated secrets to use if any.",
11452
12011
  "x-f5xc-minimum-configuration": {
11453
12012
  "description": "Minimum configuration for workloadImageType",
11454
12013
  "required_fields": [
@@ -11492,6 +12051,7 @@
11492
12051
  "ves.io.schema.rules.message.required": "true",
11493
12052
  "ves.io.schema.rules.repeated.max_items": "16"
11494
12053
  },
12054
+ "x-f5xc-description-short": "Containers to use for the job Required: YES.",
11495
12055
  "x-f5xc-required-for": {
11496
12056
  "minimum_config": false,
11497
12057
  "create": false,
@@ -11516,6 +12076,7 @@
11516
12076
  "x-validation-rules": {
11517
12077
  "ves.io.schema.rules.int32.lte": "5"
11518
12078
  },
12079
+ "x-f5xc-description-short": "Number of replicas of the batch job to spawn per site.",
11519
12080
  "minimum": 0,
11520
12081
  "maximum": 2147483647,
11521
12082
  "x-f5xc-required-for": {
@@ -11548,6 +12109,8 @@
11548
12109
  }
11549
12110
  }
11550
12111
  },
12112
+ "x-f5xc-description-short": "Jobs are used for running batch processing tasks and run to completion.",
12113
+ "x-f5xc-description-medium": "Jobs are used for running batch processing tasks and run to completion. Jobs are generally used for tasks like report generation, billing, parallel data processing, ETL processing, etc.",
11551
12114
  "x-f5xc-minimum-configuration": {
11552
12115
  "description": "Minimum configuration for workloadJobType",
11553
12116
  "required_fields": [
@@ -11579,6 +12142,7 @@
11579
12142
  "$ref": "#/components/schemas/schemaErrorType"
11580
12143
  },
11581
12144
  "x-displayname": "Errors",
12145
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
11582
12146
  "x-f5xc-required-for": {
11583
12147
  "minimum_config": false,
11584
12148
  "create": false,
@@ -11594,6 +12158,8 @@
11594
12158
  "$ref": "#/components/schemas/workloadListResponseItem"
11595
12159
  },
11596
12160
  "x-displayname": "Items",
12161
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
12162
+ "x-f5xc-description-short": "Items represents the collection in response.",
11597
12163
  "x-f5xc-required-for": {
11598
12164
  "minimum_config": false,
11599
12165
  "create": false,
@@ -11627,6 +12193,8 @@
11627
12193
  "description": "The set of annotations present on this workload.",
11628
12194
  "title": "Annotations.",
11629
12195
  "x-displayname": "Annotations.",
12196
+ "x-f5xc-example": "{\"key\": \"value\"}",
12197
+ "x-f5xc-description-short": "The set of annotations present on this workload.",
11630
12198
  "x-f5xc-required-for": {
11631
12199
  "minimum_config": false,
11632
12200
  "create": false,
@@ -11649,7 +12217,7 @@
11649
12217
  },
11650
12218
  "x-original-maxLength": 1024,
11651
12219
  "x-reconciled-from-discovery": true,
11652
- "x-reconciled-at": "2026-01-05T14:39:20.979033+00:00"
12220
+ "x-reconciled-at": "2026-01-07T15:29:46.445562+00:00"
11653
12221
  },
11654
12222
  "disabled": {
11655
12223
  "type": "boolean",
@@ -11657,6 +12225,8 @@
11657
12225
  "title": "Disabled",
11658
12226
  "format": "boolean",
11659
12227
  "x-displayname": "Disabled",
12228
+ "x-f5xc-example": "True",
12229
+ "x-f5xc-description-short": "Value of true indicates workload is administratively disabled.",
11660
12230
  "x-f5xc-required-for": {
11661
12231
  "minimum_config": false,
11662
12232
  "create": false,
@@ -11672,6 +12242,8 @@
11672
12242
  "description": "The set of labels present on this workload.",
11673
12243
  "title": "Labels",
11674
12244
  "x-displayname": "Labels",
12245
+ "x-f5xc-example": "{\"key\": \"value\"}",
12246
+ "x-f5xc-description-short": "The set of labels present on this workload.",
11675
12247
  "x-f5xc-required-for": {
11676
12248
  "minimum_config": false,
11677
12249
  "create": false,
@@ -11699,7 +12271,7 @@
11699
12271
  },
11700
12272
  "x-original-maxLength": 1024,
11701
12273
  "x-reconciled-from-discovery": true,
11702
- "x-reconciled-at": "2026-01-05T14:39:20.979043+00:00"
12274
+ "x-reconciled-at": "2026-01-07T15:29:46.445572+00:00"
11703
12275
  },
11704
12276
  "namespace": {
11705
12277
  "type": "string",
@@ -11718,7 +12290,7 @@
11718
12290
  },
11719
12291
  "x-original-maxLength": 1024,
11720
12292
  "x-reconciled-from-discovery": true,
11721
- "x-reconciled-at": "2026-01-05T14:39:20.979047+00:00"
12293
+ "x-reconciled-at": "2026-01-07T15:29:46.445576+00:00"
11722
12294
  },
11723
12295
  "owner_view": {
11724
12296
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -11731,6 +12303,7 @@
11731
12303
  "$ref": "#/components/schemas/workloadStatusObject"
11732
12304
  },
11733
12305
  "x-displayname": "Status",
12306
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
11734
12307
  "x-f5xc-required-for": {
11735
12308
  "minimum_config": false,
11736
12309
  "create": false,
@@ -11759,7 +12332,7 @@
11759
12332
  "x-field-mutability": "read-only",
11760
12333
  "x-original-maxLength": 1024,
11761
12334
  "x-reconciled-from-discovery": true,
11762
- "x-reconciled-at": "2026-01-05T14:39:20.979055+00:00"
12335
+ "x-reconciled-at": "2026-01-07T15:29:46.445583+00:00"
11763
12336
  },
11764
12337
  "uid": {
11765
12338
  "type": "string",
@@ -11780,9 +12353,11 @@
11780
12353
  "x-original-maxLength": 1024,
11781
12354
  "format": "uuid",
11782
12355
  "x-reconciled-from-discovery": true,
11783
- "x-reconciled-at": "2026-01-05T14:39:20.979060+00:00"
12356
+ "x-reconciled-at": "2026-01-07T15:29:46.445588+00:00"
11784
12357
  }
11785
12358
  },
12359
+ "x-f5xc-description-short": "By default a summary of workload is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
12360
+ "x-f5xc-description-medium": "By default a summary of workload is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
11786
12361
  "x-f5xc-minimum-configuration": {
11787
12362
  "description": "Minimum configuration for workloadListResponseItem",
11788
12363
  "required_fields": [
@@ -11834,6 +12409,8 @@
11834
12409
  "x-validation-rules": {
11835
12410
  "ves.io.schema.rules.string.hostname": "true"
11836
12411
  },
12412
+ "x-f5xc-description-short": "Exclusive with [auto_host_rewrite disable_host_rewrite] Host header will be swapped with this value.",
12413
+ "x-f5xc-description-medium": "Exclusive with [auto_host_rewrite disable_host_rewrite] Host header will be swapped with this value.",
11837
12414
  "minLength": 0,
11838
12415
  "maxLength": 1024,
11839
12416
  "x-f5xc-required-for": {
@@ -11915,6 +12492,8 @@
11915
12492
  "default": "ACCESS_MODE_READ_WRITE_ONCE",
11916
12493
  "x-displayname": "Persistent Storage Access Mode.",
11917
12494
  "x-ves-proto-enum": "ves.io.schema.views.workload.PersistentStorageAccessModeType",
12495
+ "x-f5xc-description-short": "Persistence storage access mode is used to configure access mode for persistent storage - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once Read Write...",
12496
+ "x-f5xc-description-medium": "Persistence storage access mode is used to configure access mode for persistent storage - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once Read Write Once is used to mount persistent storage in read/write mode to exactly 1 host - ACCESS_MODE_READ_WRITE_MANY: Read Write Many Read Write Many is used...",
11918
12497
  "x-f5xc-minimum-configuration": {
11919
12498
  "description": "Minimum configuration for workloadPersistentStorageAccessModeType",
11920
12499
  "required_fields": [],
@@ -11949,6 +12528,8 @@
11949
12528
  "x-validation-rules": {
11950
12529
  "ves.io.schema.rules.string.max_len": "256"
11951
12530
  },
12531
+ "x-f5xc-example": "example-resource",
12532
+ "x-f5xc-description-short": "Exclusive with [default] Use the specified class name.",
11952
12533
  "minLength": 0,
11953
12534
  "x-f5xc-required-for": {
11954
12535
  "minimum_config": false,
@@ -11979,6 +12560,7 @@
11979
12560
  "ves.io.schema.rules.double.lte": "256",
11980
12561
  "ves.io.schema.rules.message.required": "true"
11981
12562
  },
12563
+ "x-f5xc-description-short": "Size in GiB of the persistent storage Required: YES.",
11982
12564
  "x-f5xc-required-for": {
11983
12565
  "minimum_config": false,
11984
12566
  "create": false,
@@ -11987,6 +12569,7 @@
11987
12569
  }
11988
12570
  }
11989
12571
  },
12572
+ "x-f5xc-description-short": "Persistent storage configuration is used to configure Persistent Volume Claim (PVC).",
11990
12573
  "x-f5xc-minimum-configuration": {
11991
12574
  "description": "Minimum configuration for workloadPersistentStorageType",
11992
12575
  "required_fields": [
@@ -12016,6 +12599,7 @@
12016
12599
  "$ref": "#/components/schemas/workloadPersistentStorageType"
12017
12600
  }
12018
12601
  },
12602
+ "x-f5xc-description-short": "Volume containing the Persistent Storage for the workload.",
12019
12603
  "x-f5xc-minimum-configuration": {
12020
12604
  "description": "Minimum configuration for workloadPersistentStorageVolumeType",
12021
12605
  "required_fields": [
@@ -12062,12 +12646,13 @@
12062
12646
  },
12063
12647
  "x-original-maxLength": 1024,
12064
12648
  "x-reconciled-from-discovery": true,
12065
- "x-reconciled-at": "2026-01-05T14:39:20.979081+00:00"
12649
+ "x-reconciled-at": "2026-01-07T15:29:46.445607+00:00"
12066
12650
  },
12067
12651
  "persistent_volume": {
12068
12652
  "$ref": "#/components/schemas/workloadPersistentStorageVolumeType"
12069
12653
  }
12070
12654
  },
12655
+ "x-f5xc-description-short": "Persistent storage volume configuration for the workload.",
12071
12656
  "x-f5xc-minimum-configuration": {
12072
12657
  "description": "Minimum configuration for workloadPersistentVolumeType",
12073
12658
  "required_fields": [
@@ -12111,7 +12696,7 @@
12111
12696
  },
12112
12697
  "x-original-maxLength": 1024,
12113
12698
  "x-reconciled-from-discovery": true,
12114
- "x-reconciled-at": "2026-01-05T14:39:20.979086+00:00"
12699
+ "x-reconciled-at": "2026-01-07T15:29:46.445613+00:00"
12115
12700
  },
12116
12701
  "num": {
12117
12702
  "type": "integer",
@@ -12178,6 +12763,7 @@
12178
12763
  "ves.io.schema.rules.uint32.gt": "0",
12179
12764
  "ves.io.schema.rules.uint32.lte": "65535"
12180
12765
  },
12766
+ "x-f5xc-description-short": "Port the workload can be reached on Required: YES.",
12181
12767
  "minimum": 1,
12182
12768
  "maximum": 65535,
12183
12769
  "x-f5xc-required-for": {
@@ -12207,6 +12793,7 @@
12207
12793
  "ves.io.schema.rules.uint32.gt": "0",
12208
12794
  "ves.io.schema.rules.uint32.lte": "65535"
12209
12795
  },
12796
+ "x-f5xc-description-short": "Exclusive with [same_as_port] Port the workload is listening on.",
12210
12797
  "minimum": 0,
12211
12798
  "maximum": 2147483647,
12212
12799
  "x-f5xc-required-for": {
@@ -12269,7 +12856,7 @@
12269
12856
  },
12270
12857
  "x-original-maxLength": 1024,
12271
12858
  "x-reconciled-from-discovery": true,
12272
- "x-reconciled-at": "2026-01-05T14:39:20.979100+00:00"
12859
+ "x-reconciled-at": "2026-01-07T15:29:46.445626+00:00"
12273
12860
  }
12274
12861
  },
12275
12862
  "x-f5xc-minimum-configuration": {
@@ -12346,6 +12933,7 @@
12346
12933
  "$ref": "#/components/schemas/http_loadbalancerRouteTypeSimpleWithDefaultOriginPool"
12347
12934
  }
12348
12935
  },
12936
+ "x-f5xc-description-short": "Defines various OPTIONS to define a route.",
12349
12937
  "x-f5xc-minimum-configuration": {
12350
12938
  "description": "Minimum configuration for workloadRouteInfoType",
12351
12939
  "required_fields": [
@@ -12391,6 +12979,7 @@
12391
12979
  "title": "Scale down to zero.",
12392
12980
  "format": "boolean",
12393
12981
  "x-displayname": "Scale Down to Zero.",
12982
+ "x-f5xc-description-short": "Scale down replicas of the service to zero.",
12394
12983
  "x-f5xc-required-for": {
12395
12984
  "minimum_config": false,
12396
12985
  "create": false,
@@ -12402,6 +12991,8 @@
12402
12991
  "$ref": "#/components/schemas/workloadAdvertiseSimpleServiceType"
12403
12992
  }
12404
12993
  },
12994
+ "x-f5xc-description-short": "SimpleService is a service having one container and one replica that is deployed on all Regional Edges and advertised on Internet via HTTP...",
12995
+ "x-f5xc-description-medium": "SimpleService is a service having one container and one replica that is deployed on all Regional Edges and advertised on Internet via HTTP loadbalancer on default VIP.",
12405
12996
  "x-f5xc-minimum-configuration": {
12406
12997
  "description": "Minimum configuration for workloadSimpleServiceType",
12407
12998
  "required_fields": [
@@ -12475,6 +13066,7 @@
12475
13066
  "ves.io.schema.rules.message.required": "true",
12476
13067
  "ves.io.schema.rules.repeated.max_items": "16"
12477
13068
  },
13069
+ "x-f5xc-description-short": "Containers to use for service Required: YES.",
12478
13070
  "x-f5xc-required-for": {
12479
13071
  "minimum_config": false,
12480
13072
  "create": false,
@@ -12501,6 +13093,7 @@
12501
13093
  "ves.io.schema.rules.int32.gt": "0",
12502
13094
  "ves.io.schema.rules.int32.lte": "5"
12503
13095
  },
13096
+ "x-f5xc-description-short": "Exclusive with [scale_to_zero] Number of replicas of service to spawn per site.",
12504
13097
  "minimum": 0,
12505
13098
  "maximum": 2147483647,
12506
13099
  "x-f5xc-required-for": {
@@ -12528,6 +13121,7 @@
12528
13121
  "ves.io.schema.rules.message.required": "true",
12529
13122
  "ves.io.schema.rules.repeated.max_items": "16"
12530
13123
  },
13124
+ "x-f5xc-description-short": "Persistent storage configuration for the service Required: YES.",
12531
13125
  "x-f5xc-required-for": {
12532
13126
  "minimum_config": false,
12533
13127
  "create": false,
@@ -12561,6 +13155,8 @@
12561
13155
  }
12562
13156
  }
12563
13157
  },
13158
+ "x-f5xc-description-short": "StatefulService maintains per replica state and each replica has its own persistent storage.",
13159
+ "x-f5xc-description-medium": "StatefulService maintains per replica state and each replica has its own persistent storage. Each replica has a unique network identity and stable storage. Stateful service are used for distributed stateful applications like cassandra, mongodb, redis, etc.",
12564
13160
  "x-f5xc-minimum-configuration": {
12565
13161
  "description": "Minimum configuration for workloadStatefulServiceType",
12566
13162
  "required_fields": [
@@ -12636,6 +13232,7 @@
12636
13232
  }
12637
13233
  }
12638
13234
  },
13235
+ "x-f5xc-description-short": "Most recently observed status of the workload.",
12639
13236
  "x-f5xc-minimum-configuration": {
12640
13237
  "description": "Minimum configuration for workloadStatusObject",
12641
13238
  "required_fields": [
@@ -12688,12 +13285,13 @@
12688
13285
  },
12689
13286
  "x-original-maxLength": 1024,
12690
13287
  "x-reconciled-from-discovery": true,
12691
- "x-reconciled-at": "2026-01-05T14:39:20.979144+00:00"
13288
+ "x-reconciled-at": "2026-01-07T15:29:46.445664+00:00"
12692
13289
  },
12693
13290
  "persistent_volume": {
12694
13291
  "$ref": "#/components/schemas/workloadPersistentStorageVolumeType"
12695
13292
  }
12696
13293
  },
13294
+ "x-f5xc-description-short": "Storage volume configuration for the workload.",
12697
13295
  "x-f5xc-minimum-configuration": {
12698
13296
  "description": "Minimum configuration for workloadStorageVolumeType",
12699
13297
  "required_fields": [
@@ -12720,6 +13318,7 @@
12720
13318
  "$ref": "#/components/schemas/workloadPortChoiceType"
12721
13319
  }
12722
13320
  },
13321
+ "x-f5xc-description-short": "TCPHealthCheckType describes a health check based on opening a TCP connection.",
12723
13322
  "x-f5xc-minimum-configuration": {
12724
13323
  "description": "Health check configuration for monitoring origin servers",
12725
13324
  "required_fields": [
@@ -12771,6 +13370,8 @@
12771
13370
  "ves.io.schema.rules.repeated.max_items": "32",
12772
13371
  "ves.io.schema.rules.repeated.unique": "true"
12773
13372
  },
13373
+ "x-f5xc-description-short": "List of additional domains (host/authority header) that will be matched to this loadbalancer.",
13374
+ "x-f5xc-description-medium": "List of additional domains (host/authority header) that will be matched to this loadbalancer. Domains are also used for SNI matching if the is true Domains also indicate the list of names for which DNS resolution will be done by VER.",
12774
13375
  "x-f5xc-required-for": {
12775
13376
  "minimum_config": false,
12776
13377
  "create": false,
@@ -12786,6 +13387,7 @@
12786
13387
  "x-displayname": "With SNI",
12787
13388
  "x-ves-example": "True",
12788
13389
  "x-f5xc-example": "true",
13390
+ "x-f5xc-description-short": "Set to true to enable TCP loadbalancer with SNI.",
12789
13391
  "x-f5xc-required-for": {
12790
13392
  "minimum_config": false,
12791
13393
  "create": false,
@@ -12822,6 +13424,7 @@
12822
13424
  "$ref": "#/components/schemas/workloadUsageTypeData"
12823
13425
  },
12824
13426
  "x-displayname": "Data",
13427
+ "x-f5xc-example": "{\"key\": \"value\"}",
12825
13428
  "x-f5xc-required-for": {
12826
13429
  "minimum_config": false,
12827
13430
  "create": false,
@@ -12836,6 +13439,7 @@
12836
13439
  "$ref": "#/components/schemas/schemaUnitType"
12837
13440
  }
12838
13441
  },
13442
+ "x-f5xc-description-short": "Usage data contains the usage type and the corresponding metric.",
12839
13443
  "x-f5xc-minimum-configuration": {
12840
13444
  "description": "Minimum configuration for workloadUsageData",
12841
13445
  "required_fields": [
@@ -12894,6 +13498,8 @@
12894
13498
  "x-validation-rules": {
12895
13499
  "ves.io.schema.rules.string.query_time": "true"
12896
13500
  },
13501
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
13502
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
12897
13503
  "minLength": 0,
12898
13504
  "maxLength": 1024,
12899
13505
  "x-f5xc-required-for": {
@@ -12926,6 +13532,8 @@
12926
13532
  "ves.io.schema.rules.repeated.min_items": "1",
12927
13533
  "ves.io.schema.rules.repeated.unique": "true"
12928
13534
  },
13535
+ "x-f5xc-description-short": "Select fields to be returned in the response. One or more fields in {CPU_USAGE, MEMORY_USAGE, DISK_READS, DISK_WRITES} can be specified.",
13536
+ "x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {CPU_USAGE, MEMORY_USAGE, DISK_READS, DISK_WRITES} can be specified. Required: YES.",
12929
13537
  "x-f5xc-required-for": {
12930
13538
  "minimum_config": false,
12931
13539
  "create": false,
@@ -12940,6 +13548,8 @@
12940
13548
  "x-displayname": "Filter",
12941
13549
  "x-ves-example": "{POD=\\\"pod-1\\\"}",
12942
13550
  "x-f5xc-example": "\"{POD=\\\"pod-1\\\"}\"",
13551
+ "x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
13552
+ "x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in UsageLabel {CONTAINER, POD, SITE} can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = ...",
12943
13553
  "minLength": 0,
12944
13554
  "maxLength": 1024,
12945
13555
  "x-f5xc-required-for": {
@@ -12957,6 +13567,7 @@
12957
13567
  "$ref": "#/components/schemas/workloadUsageLabel"
12958
13568
  },
12959
13569
  "x-displayname": "Group By",
13570
+ "x-f5xc-description-short": "Aggregate data by zero or more labels {NAMESPACE, CONTAINER, POD, SITE}.",
12960
13571
  "x-f5xc-required-for": {
12961
13572
  "minimum_config": false,
12962
13573
  "create": false,
@@ -12970,6 +13581,8 @@
12970
13581
  "title": "Include System Workloads.",
12971
13582
  "format": "boolean",
12972
13583
  "x-displayname": "Include System Workloads.",
13584
+ "x-f5xc-description-short": "Allows user to specify if the usage of system workloads (such as pods running in F5 Distributed Cloud namespaces and the Kubernetes pods) should...",
13585
+ "x-f5xc-description-medium": "Allows user to specify if the usage of system workloads (such as pods running in F5 Distributed Cloud namespaces and the Kubernetes pods) should be included in the response. This field is applicable only in the namespace where the response contains data across all namespaces. Optional: If not...",
12973
13586
  "x-f5xc-required-for": {
12974
13587
  "minimum_config": false,
12975
13588
  "create": false,
@@ -12984,6 +13597,7 @@
12984
13597
  "x-displayname": "Namespace",
12985
13598
  "x-ves-example": "Ns1",
12986
13599
  "x-f5xc-example": "ns1",
13600
+ "x-f5xc-description-short": "Namespace is used to scope the workload usage to a given namespace.",
12987
13601
  "minLength": 0,
12988
13602
  "maxLength": 6,
12989
13603
  "x-f5xc-required-for": {
@@ -12994,7 +13608,7 @@
12994
13608
  },
12995
13609
  "x-original-maxLength": 1024,
12996
13610
  "x-reconciled-from-discovery": true,
12997
- "x-reconciled-at": "2026-01-05T14:39:20.979167+00:00"
13611
+ "x-reconciled-at": "2026-01-07T15:29:46.445685+00:00"
12998
13612
  },
12999
13613
  "range": {
13000
13614
  "type": "string",
@@ -13009,6 +13623,8 @@
13009
13623
  "x-validation-rules": {
13010
13624
  "ves.io.schema.rules.string.time_interval": "true"
13011
13625
  },
13626
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
13627
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
13012
13628
  "minLength": 0,
13013
13629
  "maxLength": 1024,
13014
13630
  "x-f5xc-required-for": {
@@ -13031,6 +13647,8 @@
13031
13647
  "x-validation-rules": {
13032
13648
  "ves.io.schema.rules.string.query_time": "true"
13033
13649
  },
13650
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
13651
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
13034
13652
  "minLength": 0,
13035
13653
  "maxLength": 1024,
13036
13654
  "x-f5xc-required-for": {
@@ -13053,6 +13671,8 @@
13053
13671
  "x-validation-rules": {
13054
13672
  "ves.io.schema.rules.string.query_step": "true"
13055
13673
  },
13674
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
13675
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
13056
13676
  "minLength": 0,
13057
13677
  "maxLength": 1024,
13058
13678
  "x-f5xc-required-for": {
@@ -13063,6 +13683,7 @@
13063
13683
  }
13064
13684
  }
13065
13685
  },
13686
+ "x-f5xc-description-short": "Request to GET workload usage in the given namespace.",
13066
13687
  "x-f5xc-minimum-configuration": {
13067
13688
  "description": "Minimum configuration for workloadUsageRequest",
13068
13689
  "required_fields": [
@@ -13098,6 +13719,8 @@
13098
13719
  "$ref": "#/components/schemas/workloadUsageData"
13099
13720
  },
13100
13721
  "x-displayname": "Data",
13722
+ "x-f5xc-example": "{\"key\": \"value\"}",
13723
+ "x-f5xc-description-short": "Data contains time-series data for the workload usage.",
13101
13724
  "x-f5xc-required-for": {
13102
13725
  "minimum_config": false,
13103
13726
  "create": false,
@@ -13118,6 +13741,8 @@
13118
13741
  "x-validation-rules": {
13119
13742
  "ves.io.schema.rules.string.time_interval": "true"
13120
13743
  },
13744
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
13745
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
13121
13746
  "minLength": 0,
13122
13747
  "maxLength": 1024,
13123
13748
  "x-f5xc-required-for": {
@@ -13154,6 +13779,8 @@
13154
13779
  "default": "CPU_USAGE",
13155
13780
  "x-displayname": "Usage Type.",
13156
13781
  "x-ves-proto-enum": "ves.io.schema.views.workload.UsageType",
13782
+ "x-f5xc-description-short": "List of usage types that can be queried x-unit: \"Number of cores\" x-unit: \"Bytes\" x-unit: \"Bytes per second\" x-unit: \"Bytes per second\".",
13783
+ "x-f5xc-description-medium": "List of usage types that can be queried x-unit: \"Number of cores\" x-unit: \"Bytes\" x-unit: \"Bytes per second\" x-unit: \"Bytes per second\".",
13157
13784
  "x-f5xc-minimum-configuration": {
13158
13785
  "description": "Minimum configuration for workloadUsageType",
13159
13786
  "required_fields": [],
@@ -13176,6 +13803,8 @@
13176
13803
  "description": "Key contains the name/value pair.\n\"name\" is the label name defined in \"UsageLabel\"",
13177
13804
  "title": "Key",
13178
13805
  "x-displayname": "Key",
13806
+ "x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
13807
+ "x-f5xc-description-short": "Key contains the name/value pair. \"name\" is the label name defined in \"UsageLabel\".",
13179
13808
  "x-f5xc-required-for": {
13180
13809
  "minimum_config": false,
13181
13810
  "create": false,
@@ -13185,7 +13814,7 @@
13185
13814
  "maxLength": 16,
13186
13815
  "minLength": 7,
13187
13816
  "x-reconciled-from-discovery": true,
13188
- "x-reconciled-at": "2026-01-05T14:39:20.979180+00:00"
13817
+ "x-reconciled-at": "2026-01-07T15:29:46.445698+00:00"
13189
13818
  },
13190
13819
  "value": {
13191
13820
  "type": "array",
@@ -13204,9 +13833,11 @@
13204
13833
  "maxLength": 15,
13205
13834
  "minLength": 3,
13206
13835
  "x-reconciled-from-discovery": true,
13207
- "x-reconciled-at": "2026-01-05T14:39:20.979186+00:00"
13836
+ "x-reconciled-at": "2026-01-07T15:29:46.445704+00:00"
13208
13837
  }
13209
13838
  },
13839
+ "x-f5xc-description-short": "Usage Type Data contains key/value pair that uniquely identifies a workload in the response and the corresponding metric data.",
13840
+ "x-f5xc-description-medium": "Usage Type Data contains key/value pair that uniquely identifies a workload in the response and the corresponding metric data.",
13210
13841
  "x-f5xc-minimum-configuration": {
13211
13842
  "description": "Minimum configuration for workloadUsageTypeData",
13212
13843
  "required_fields": [
@@ -13231,6 +13862,8 @@
13231
13862
  "default": "VOLUME_MOUNT_READ_ONLY",
13232
13863
  "x-displayname": "Mode",
13233
13864
  "x-ves-proto-enum": "ves.io.schema.views.workload.VolumeMountModeType",
13865
+ "x-f5xc-description-short": "Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode ...",
13866
+ "x-f5xc-description-medium": "Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode.",
13234
13867
  "x-f5xc-minimum-configuration": {
13235
13868
  "description": "Minimum configuration for workloadVolumeMountModeType",
13236
13869
  "required_fields": [],
@@ -13270,6 +13903,8 @@
13270
13903
  "ves.io.schema.rules.string.max_len": "256",
13271
13904
  "ves.io.schema.rules.string.pattern": "^[^:]*$"
13272
13905
  },
13906
+ "x-f5xc-description-short": "Path within the workload container at which the volume should be mounted. Must not contain ':'.",
13907
+ "x-f5xc-description-medium": "Path within the workload container at which the volume should be mounted. Must not contain ':'. Required: YES.",
13273
13908
  "minLength": 0,
13274
13909
  "x-f5xc-required-for": {
13275
13910
  "minimum_config": false,
@@ -13292,6 +13927,8 @@
13292
13927
  "x-validation-rules": {
13293
13928
  "ves.io.schema.rules.string.max_len": "256"
13294
13929
  },
13930
+ "x-f5xc-description-short": "Path within the volume from which the workload's volume should be mounted. Defaults to \"\" (volume's root).",
13931
+ "x-f5xc-description-medium": "Path within the volume from which the workload's volume should be mounted. Defaults to \"\" (volume's root).",
13295
13932
  "minLength": 0,
13296
13933
  "x-f5xc-required-for": {
13297
13934
  "minimum_config": false,
@@ -13301,6 +13938,7 @@
13301
13938
  }
13302
13939
  }
13303
13940
  },
13941
+ "x-f5xc-description-short": "Volume mount describes how volume is mounted inside a workload.",
13304
13942
  "x-f5xc-minimum-configuration": {
13305
13943
  "description": "Minimum configuration for workloadVolumeMountType",
13306
13944
  "required_fields": [
@@ -13329,6 +13967,8 @@
13329
13967
  "x-displayname": "Kind",
13330
13968
  "x-ves-example": "Virtual_site.",
13331
13969
  "x-f5xc-example": "virtual_site",
13970
+ "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\")",
13971
+ "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\").",
13332
13972
  "minLength": 0,
13333
13973
  "maxLength": 14,
13334
13974
  "x-f5xc-required-for": {
@@ -13340,7 +13980,7 @@
13340
13980
  "readOnly": true,
13341
13981
  "x-original-maxLength": 1024,
13342
13982
  "x-reconciled-from-discovery": true,
13343
- "x-reconciled-at": "2026-01-05T14:39:21.346090+00:00"
13983
+ "x-reconciled-at": "2026-01-07T15:29:46.860480+00:00"
13344
13984
  },
13345
13985
  "name": {
13346
13986
  "type": "string",
@@ -13349,6 +13989,8 @@
13349
13989
  "x-displayname": "Name",
13350
13990
  "x-ves-example": "Contactus-route.",
13351
13991
  "x-f5xc-example": "contactus-route",
13992
+ "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.",
13993
+ "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.",
13352
13994
  "minLength": 0,
13353
13995
  "maxLength": 16,
13354
13996
  "x-f5xc-required-for": {
@@ -13359,7 +14001,7 @@
13359
14001
  },
13360
14002
  "x-original-maxLength": 1024,
13361
14003
  "x-reconciled-from-discovery": true,
13362
- "x-reconciled-at": "2026-01-05T14:39:21.346094+00:00"
14004
+ "x-reconciled-at": "2026-01-07T15:29:46.860484+00:00"
13363
14005
  },
13364
14006
  "namespace": {
13365
14007
  "type": "string",
@@ -13368,6 +14010,8 @@
13368
14010
  "x-displayname": "Namespace",
13369
14011
  "x-ves-example": "Ns1",
13370
14012
  "x-f5xc-example": "ns1",
14013
+ "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.",
14014
+ "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.",
13371
14015
  "minLength": 0,
13372
14016
  "maxLength": 6,
13373
14017
  "x-f5xc-required-for": {
@@ -13378,7 +14022,7 @@
13378
14022
  },
13379
14023
  "x-original-maxLength": 1024,
13380
14024
  "x-reconciled-from-discovery": true,
13381
- "x-reconciled-at": "2026-01-05T14:39:21.346098+00:00"
14025
+ "x-reconciled-at": "2026-01-07T15:29:46.860488+00:00"
13382
14026
  },
13383
14027
  "tenant": {
13384
14028
  "type": "string",
@@ -13387,6 +14031,8 @@
13387
14031
  "x-displayname": "Tenant",
13388
14032
  "x-ves-example": "Example-corp.",
13389
14033
  "x-f5xc-example": "example-corp",
14034
+ "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.",
14035
+ "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.",
13390
14036
  "minLength": 0,
13391
14037
  "maxLength": 18,
13392
14038
  "x-f5xc-required-for": {
@@ -13399,7 +14045,7 @@
13399
14045
  "x-field-mutability": "read-only",
13400
14046
  "x-original-maxLength": 1024,
13401
14047
  "x-reconciled-from-discovery": true,
13402
- "x-reconciled-at": "2026-01-05T14:39:21.346103+00:00"
14048
+ "x-reconciled-at": "2026-01-07T15:29:46.860493+00:00"
13403
14049
  },
13404
14050
  "uid": {
13405
14051
  "type": "string",
@@ -13408,6 +14054,8 @@
13408
14054
  "x-displayname": "UID",
13409
14055
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
13410
14056
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
14057
+ "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.",
14058
+ "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.",
13411
14059
  "minLength": 0,
13412
14060
  "maxLength": 36,
13413
14061
  "x-f5xc-required-for": {
@@ -13421,9 +14069,11 @@
13421
14069
  "x-original-maxLength": 1024,
13422
14070
  "format": "uuid",
13423
14071
  "x-reconciled-from-discovery": true,
13424
- "x-reconciled-at": "2026-01-05T14:39:21.346109+00:00"
14072
+ "x-reconciled-at": "2026-01-07T15:29:46.860499+00:00"
13425
14073
  }
13426
14074
  },
14075
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
14076
+ "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...",
13427
14077
  "x-f5xc-minimum-configuration": {
13428
14078
  "description": "Minimum configuration for schemaObjectRefType",
13429
14079
  "required_fields": [
@@ -13515,6 +14165,7 @@
13515
14165
  "x-validation-rules": {
13516
14166
  "ves.io.schema.rules.uint32.ranges": "1-6000"
13517
14167
  },
14168
+ "x-f5xc-description-short": "Ephemeral storage in MiB (mebibyte) allocated for the workload_flavor.",
13518
14169
  "minLength": 0,
13519
14170
  "maxLength": 1024,
13520
14171
  "x-f5xc-required-for": {
@@ -13537,6 +14188,7 @@
13537
14188
  "x-validation-rules": {
13538
14189
  "ves.io.schema.rules.uint32.ranges": "1-32768"
13539
14190
  },
14191
+ "x-f5xc-description-short": "Memory in MiB (mebibyte) allocated for the workload_flavor.",
13540
14192
  "minLength": 0,
13541
14193
  "maxLength": 1024,
13542
14194
  "x-f5xc-required-for": {
@@ -13561,6 +14213,7 @@
13561
14213
  "ves.io.schema.rules.float.gte": "0.0",
13562
14214
  "ves.io.schema.rules.float.lte": "8.0"
13563
14215
  },
14216
+ "x-f5xc-description-short": "Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core.",
13564
14217
  "x-f5xc-required-for": {
13565
14218
  "minimum_config": false,
13566
14219
  "create": false,
@@ -13596,6 +14249,7 @@
13596
14249
  "title": "Fail_if_referred.",
13597
14250
  "format": "boolean",
13598
14251
  "x-displayname": "Fail-If-Referred.",
14252
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
13599
14253
  "x-f5xc-required-for": {
13600
14254
  "minimum_config": false,
13601
14255
  "create": false,
@@ -13620,7 +14274,7 @@
13620
14274
  },
13621
14275
  "x-original-maxLength": 1024,
13622
14276
  "x-reconciled-from-discovery": true,
13623
- "x-reconciled-at": "2026-01-05T14:39:21.346218+00:00"
14277
+ "x-reconciled-at": "2026-01-07T15:29:46.860641+00:00"
13624
14278
  },
13625
14279
  "namespace": {
13626
14280
  "type": "string",
@@ -13629,6 +14283,7 @@
13629
14283
  "x-displayname": "Namespace",
13630
14284
  "x-ves-example": "Ns1",
13631
14285
  "x-f5xc-example": "ns1",
14286
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
13632
14287
  "minLength": 0,
13633
14288
  "maxLength": 6,
13634
14289
  "x-f5xc-required-for": {
@@ -13639,7 +14294,7 @@
13639
14294
  },
13640
14295
  "x-original-maxLength": 1024,
13641
14296
  "x-reconciled-from-discovery": true,
13642
- "x-reconciled-at": "2026-01-05T14:39:21.346222+00:00"
14297
+ "x-reconciled-at": "2026-01-07T15:29:46.860645+00:00"
13643
14298
  }
13644
14299
  },
13645
14300
  "x-f5xc-minimum-configuration": {
@@ -13674,6 +14329,7 @@
13674
14329
  "$ref": "#/components/schemas/schemaObjectRefType"
13675
14330
  },
13676
14331
  "x-displayname": "Deleted Referred Objects.",
14332
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13677
14333
  "x-f5xc-required-for": {
13678
14334
  "minimum_config": false,
13679
14335
  "create": false,
@@ -13689,6 +14345,7 @@
13689
14345
  "$ref": "#/components/schemas/schemaObjectRefType"
13690
14346
  },
13691
14347
  "x-displayname": "Disabled Referred Objects.",
14348
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13692
14349
  "x-f5xc-required-for": {
13693
14350
  "minimum_config": false,
13694
14351
  "create": false,
@@ -13707,6 +14364,7 @@
13707
14364
  "$ref": "#/components/schemas/schemaObjectRefType"
13708
14365
  },
13709
14366
  "x-displayname": "Referring Objects.",
14367
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
13710
14368
  "x-f5xc-required-for": {
13711
14369
  "minimum_config": false,
13712
14370
  "create": false,
@@ -13728,6 +14386,8 @@
13728
14386
  "$ref": "#/components/schemas/workload_flavorStatusObject"
13729
14387
  },
13730
14388
  "x-displayname": "Status",
14389
+ "x-f5xc-example": "active",
14390
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
13731
14391
  "x-f5xc-required-for": {
13732
14392
  "minimum_config": false,
13733
14393
  "create": false,
@@ -13737,7 +14397,7 @@
13737
14397
  "maxLength": 17,
13738
14398
  "minLength": 17,
13739
14399
  "x-reconciled-from-discovery": true,
13740
- "x-reconciled-at": "2026-01-05T14:39:21.346237+00:00"
14400
+ "x-reconciled-at": "2026-01-07T15:29:46.860660+00:00"
13741
14401
  },
13742
14402
  "system_metadata": {
13743
14403
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -13777,6 +14437,8 @@
13777
14437
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
13778
14438
  ],
13779
14439
  "default": "GET_RSP_FORMAT_DEFAULT",
14440
+ "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...",
14441
+ "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...",
13780
14442
  "x-f5xc-minimum-configuration": {
13781
14443
  "description": "Minimum configuration for workload_flavorGetResponseFormatCode",
13782
14444
  "required_fields": [],
@@ -13807,6 +14469,7 @@
13807
14469
  "x-validation-rules": {
13808
14470
  "ves.io.schema.rules.uint32.ranges": "1-6000"
13809
14471
  },
14472
+ "x-f5xc-description-short": "Ephemeral storage in MiB (mebibyte) allocated for the workload_flavor.",
13810
14473
  "minLength": 0,
13811
14474
  "maxLength": 1024,
13812
14475
  "x-f5xc-required-for": {
@@ -13829,6 +14492,7 @@
13829
14492
  "x-validation-rules": {
13830
14493
  "ves.io.schema.rules.uint32.ranges": "1-32768"
13831
14494
  },
14495
+ "x-f5xc-description-short": "Memory in MiB (mebibyte) allocated for the workload_flavor.",
13832
14496
  "minLength": 0,
13833
14497
  "maxLength": 1024,
13834
14498
  "x-f5xc-required-for": {
@@ -13853,6 +14517,7 @@
13853
14517
  "ves.io.schema.rules.float.gte": "0.0",
13854
14518
  "ves.io.schema.rules.float.lte": "8.0"
13855
14519
  },
14520
+ "x-f5xc-description-short": "Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core.",
13856
14521
  "x-f5xc-required-for": {
13857
14522
  "minimum_config": false,
13858
14523
  "create": false,
@@ -13890,6 +14555,7 @@
13890
14555
  "$ref": "#/components/schemas/schemaErrorType"
13891
14556
  },
13892
14557
  "x-displayname": "Errors",
14558
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
13893
14559
  "x-f5xc-required-for": {
13894
14560
  "minimum_config": false,
13895
14561
  "create": false,
@@ -13905,6 +14571,8 @@
13905
14571
  "$ref": "#/components/schemas/workload_flavorListResponseItem"
13906
14572
  },
13907
14573
  "x-displayname": "Items",
14574
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
14575
+ "x-f5xc-description-short": "Items represents the collection in response.",
13908
14576
  "x-f5xc-required-for": {
13909
14577
  "minimum_config": false,
13910
14578
  "create": false,
@@ -13938,6 +14606,8 @@
13938
14606
  "description": "The set of annotations present on this workload_flavor.",
13939
14607
  "title": "Annotations.",
13940
14608
  "x-displayname": "Annotations.",
14609
+ "x-f5xc-example": "{\"key\": \"value\"}",
14610
+ "x-f5xc-description-short": "The set of annotations present on this workload_flavor.",
13941
14611
  "x-f5xc-required-for": {
13942
14612
  "minimum_config": false,
13943
14613
  "create": false,
@@ -13950,6 +14620,7 @@
13950
14620
  "description": "The description set for this workload_flavor.",
13951
14621
  "title": "Description.",
13952
14622
  "x-displayname": "Description.",
14623
+ "x-f5xc-description-short": "The description set for this workload_flavor.",
13953
14624
  "minLength": 0,
13954
14625
  "maxLength": 0,
13955
14626
  "x-f5xc-required-for": {
@@ -13960,7 +14631,7 @@
13960
14631
  },
13961
14632
  "x-original-maxLength": 1024,
13962
14633
  "x-reconciled-from-discovery": true,
13963
- "x-reconciled-at": "2026-01-05T14:39:21.346253+00:00"
14634
+ "x-reconciled-at": "2026-01-07T15:29:46.860676+00:00"
13964
14635
  },
13965
14636
  "disabled": {
13966
14637
  "type": "boolean",
@@ -13968,6 +14639,8 @@
13968
14639
  "title": "Disabled",
13969
14640
  "format": "boolean",
13970
14641
  "x-displayname": "Disabled",
14642
+ "x-f5xc-example": "True",
14643
+ "x-f5xc-description-short": "Value of true indicates workload_flavor is administratively disabled.",
13971
14644
  "x-f5xc-required-for": {
13972
14645
  "minimum_config": false,
13973
14646
  "create": false,
@@ -13983,6 +14656,8 @@
13983
14656
  "description": "The set of labels present on this workload_flavor.",
13984
14657
  "title": "Labels",
13985
14658
  "x-displayname": "Labels",
14659
+ "x-f5xc-example": "{\"key\": \"value\"}",
14660
+ "x-f5xc-description-short": "The set of labels present on this workload_flavor.",
13986
14661
  "x-f5xc-required-for": {
13987
14662
  "minimum_config": false,
13988
14663
  "create": false,
@@ -14010,7 +14685,7 @@
14010
14685
  },
14011
14686
  "x-original-maxLength": 1024,
14012
14687
  "x-reconciled-from-discovery": true,
14013
- "x-reconciled-at": "2026-01-05T14:39:21.346264+00:00"
14688
+ "x-reconciled-at": "2026-01-07T15:29:46.860686+00:00"
14014
14689
  },
14015
14690
  "namespace": {
14016
14691
  "type": "string",
@@ -14029,7 +14704,7 @@
14029
14704
  },
14030
14705
  "x-original-maxLength": 1024,
14031
14706
  "x-reconciled-from-discovery": true,
14032
- "x-reconciled-at": "2026-01-05T14:39:21.346268+00:00"
14707
+ "x-reconciled-at": "2026-01-07T15:29:46.860691+00:00"
14033
14708
  },
14034
14709
  "owner_view": {
14035
14710
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -14042,6 +14717,7 @@
14042
14717
  "$ref": "#/components/schemas/workload_flavorStatusObject"
14043
14718
  },
14044
14719
  "x-displayname": "Status",
14720
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
14045
14721
  "x-f5xc-required-for": {
14046
14722
  "minimum_config": false,
14047
14723
  "create": false,
@@ -14070,7 +14746,7 @@
14070
14746
  "x-field-mutability": "read-only",
14071
14747
  "x-original-maxLength": 1024,
14072
14748
  "x-reconciled-from-discovery": true,
14073
- "x-reconciled-at": "2026-01-05T14:39:21.346276+00:00"
14749
+ "x-reconciled-at": "2026-01-07T15:29:46.860698+00:00"
14074
14750
  },
14075
14751
  "uid": {
14076
14752
  "type": "string",
@@ -14091,9 +14767,11 @@
14091
14767
  "x-original-maxLength": 1024,
14092
14768
  "format": "uuid",
14093
14769
  "x-reconciled-from-discovery": true,
14094
- "x-reconciled-at": "2026-01-05T14:39:21.346281+00:00"
14770
+ "x-reconciled-at": "2026-01-07T15:29:46.860703+00:00"
14095
14771
  }
14096
14772
  },
14773
+ "x-f5xc-description-short": "By default a summary of workload_flavor is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
14774
+ "x-f5xc-description-medium": "By default a summary of workload_flavor is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
14097
14775
  "x-f5xc-minimum-configuration": {
14098
14776
  "description": "Minimum configuration for workload_flavorListResponseItem",
14099
14777
  "required_fields": [
@@ -14178,6 +14856,7 @@
14178
14856
  "x-validation-rules": {
14179
14857
  "ves.io.schema.rules.uint32.ranges": "1-6000"
14180
14858
  },
14859
+ "x-f5xc-description-short": "Ephemeral storage in MiB (mebibyte) allocated for the workload_flavor.",
14181
14860
  "minLength": 0,
14182
14861
  "maxLength": 1024,
14183
14862
  "x-f5xc-required-for": {
@@ -14200,6 +14879,7 @@
14200
14879
  "x-validation-rules": {
14201
14880
  "ves.io.schema.rules.uint32.ranges": "1-32768"
14202
14881
  },
14882
+ "x-f5xc-description-short": "Memory in MiB (mebibyte) allocated for the workload_flavor.",
14203
14883
  "minLength": 0,
14204
14884
  "maxLength": 1024,
14205
14885
  "x-f5xc-required-for": {
@@ -14224,6 +14904,7 @@
14224
14904
  "ves.io.schema.rules.float.gte": "0.0",
14225
14905
  "ves.io.schema.rules.float.lte": "8.0"
14226
14906
  },
14907
+ "x-f5xc-description-short": "Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core.",
14227
14908
  "x-f5xc-required-for": {
14228
14909
  "minimum_config": false,
14229
14910
  "create": false,
@@ -14261,6 +14942,7 @@
14261
14942
  "$ref": "#/components/schemas/schemaConditionType"
14262
14943
  },
14263
14944
  "x-displayname": "Conditions.",
14945
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
14264
14946
  "x-f5xc-required-for": {
14265
14947
  "minimum_config": false,
14266
14948
  "create": false,
@@ -14287,6 +14969,7 @@
14287
14969
  }
14288
14970
  }
14289
14971
  },
14972
+ "x-f5xc-description-short": "Most recently observed status of object.",
14290
14973
  "x-f5xc-minimum-configuration": {
14291
14974
  "description": "Minimum configuration for workload_flavorStatusObject",
14292
14975
  "required_fields": [