@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": "Managed Kubernetes",
5
5
  "description": "Role-based access controls with cluster-scoped permissions and namespace bindings. Pod security admission levels enforce baseline, restricted, or privileged profiles. Container registry credentials support private image pulls across hybrid deployments. Policy rules define resource verbs, groups, and non-resource URL access patterns.",
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": "Kubernetes role bindings and admission policies. Registry integration for EKS, AKS, and GKE workloads.",
16
- "x-f5xc-cli-domain": "managed_kubernetes"
16
+ "x-f5xc-cli-domain": "managed_kubernetes",
17
+ "x-f5xc-best-practices": {
18
+ "common_errors": [
19
+ {
20
+ "code": 400,
21
+ "message": "Invalid request body",
22
+ "resolution": "Validate JSON structure and required fields before submission",
23
+ "prevention": "Use schema validation from OpenAPI spec"
24
+ },
25
+ {
26
+ "code": 401,
27
+ "message": "Authentication failed",
28
+ "resolution": "Verify API token is valid and not expired",
29
+ "prevention": "Use environment variables for token management"
30
+ },
31
+ {
32
+ "code": 403,
33
+ "message": "Permission denied",
34
+ "resolution": "Check user role and namespace permissions",
35
+ "prevention": "Verify RBAC policies before operations"
36
+ },
37
+ {
38
+ "code": 404,
39
+ "message": "Resource not found",
40
+ "resolution": "Verify resource name and namespace exist",
41
+ "prevention": "List resources before attempting operations"
42
+ },
43
+ {
44
+ "code": 409,
45
+ "message": "Resource already exists",
46
+ "resolution": "Use unique name or delete existing resource",
47
+ "prevention": "Check existence before creation"
48
+ },
49
+ {
50
+ "code": 429,
51
+ "message": "Rate limit exceeded",
52
+ "resolution": "Implement exponential backoff and retry logic",
53
+ "prevention": "Batch operations and add delays between requests"
54
+ }
55
+ ],
56
+ "security_notes": [
57
+ "Always use HTTPS for all API communications",
58
+ "Store API tokens securely, never in source code",
59
+ "Rotate API tokens regularly following security policies"
60
+ ],
61
+ "performance_tips": [
62
+ "Use pagination for large result sets",
63
+ "Batch related operations when possible",
64
+ "Cache read-only responses appropriately"
65
+ ]
66
+ }
17
67
  },
18
68
  "servers": [
19
69
  {
@@ -276,6 +326,13 @@
276
326
  "latency": "low",
277
327
  "resource_usage": "low"
278
328
  }
329
+ },
330
+ "x-f5xc-discovered-response-time": {
331
+ "p50_ms": 1000,
332
+ "p95_ms": 3000,
333
+ "p99_ms": 8000,
334
+ "sample_count": 0,
335
+ "source": "estimate"
279
336
  }
280
337
  },
281
338
  "x-displayname": "Container Registry.",
@@ -498,6 +555,13 @@
498
555
  "latency": "low",
499
556
  "resource_usage": "low"
500
557
  }
558
+ },
559
+ "x-f5xc-discovered-response-time": {
560
+ "p50_ms": 800,
561
+ "p95_ms": 2500,
562
+ "p99_ms": 6000,
563
+ "sample_count": 0,
564
+ "source": "estimate"
501
565
  }
502
566
  },
503
567
  "x-displayname": "Container Registry.",
@@ -725,6 +789,13 @@
725
789
  "latency": "moderate",
726
790
  "resource_usage": "moderate"
727
791
  }
792
+ },
793
+ "x-f5xc-discovered-response-time": {
794
+ "p50_ms": 200,
795
+ "p95_ms": 800,
796
+ "p99_ms": 2000,
797
+ "sample_count": 0,
798
+ "source": "estimate"
728
799
  }
729
800
  },
730
801
  "x-displayname": "Container Registry.",
@@ -946,6 +1017,13 @@
946
1017
  "latency": "low",
947
1018
  "resource_usage": "low"
948
1019
  }
1020
+ },
1021
+ "x-f5xc-discovered-response-time": {
1022
+ "p50_ms": 200,
1023
+ "p95_ms": 800,
1024
+ "p99_ms": 2000,
1025
+ "sample_count": 0,
1026
+ "source": "estimate"
949
1027
  }
950
1028
  },
951
1029
  "delete": {
@@ -1165,6 +1243,13 @@
1165
1243
  "latency": "high",
1166
1244
  "resource_usage": "moderate"
1167
1245
  }
1246
+ },
1247
+ "x-f5xc-discovered-response-time": {
1248
+ "p50_ms": 500,
1249
+ "p95_ms": 1500,
1250
+ "p99_ms": 4000,
1251
+ "sample_count": 0,
1252
+ "source": "estimate"
1168
1253
  }
1169
1254
  },
1170
1255
  "x-displayname": "Container Registry.",
@@ -1379,6 +1464,13 @@
1379
1464
  "latency": "low",
1380
1465
  "resource_usage": "low"
1381
1466
  }
1467
+ },
1468
+ "x-f5xc-discovered-response-time": {
1469
+ "p50_ms": 1000,
1470
+ "p95_ms": 3000,
1471
+ "p99_ms": 8000,
1472
+ "sample_count": 0,
1473
+ "source": "estimate"
1382
1474
  }
1383
1475
  },
1384
1476
  "x-displayname": "K8s Cluster Role.",
@@ -1601,6 +1693,13 @@
1601
1693
  "latency": "low",
1602
1694
  "resource_usage": "low"
1603
1695
  }
1696
+ },
1697
+ "x-f5xc-discovered-response-time": {
1698
+ "p50_ms": 800,
1699
+ "p95_ms": 2500,
1700
+ "p99_ms": 6000,
1701
+ "sample_count": 0,
1702
+ "source": "estimate"
1604
1703
  }
1605
1704
  },
1606
1705
  "x-displayname": "K8s Cluster Role.",
@@ -1830,7 +1929,15 @@
1830
1929
  }
1831
1930
  },
1832
1931
  "x-discovered-response-time-ms": 153.1,
1833
- "x-discovered-sample-size": 1
1932
+ "x-discovered-sample-size": 1,
1933
+ "x-f5xc-discovered-response-time": {
1934
+ "p50_ms": 153.1,
1935
+ "p95_ms": 306.2,
1936
+ "p99_ms": 459.3,
1937
+ "sample_count": 1,
1938
+ "source": "discovery",
1939
+ "last_measured": "2025-12-20T19:39:20.211392+00:00"
1940
+ }
1834
1941
  },
1835
1942
  "x-displayname": "K8s Cluster Role.",
1836
1943
  "x-ves-proto-service": "ves.io.schema.k8s_cluster_role.API",
@@ -2051,6 +2158,13 @@
2051
2158
  "latency": "low",
2052
2159
  "resource_usage": "low"
2053
2160
  }
2161
+ },
2162
+ "x-f5xc-discovered-response-time": {
2163
+ "p50_ms": 200,
2164
+ "p95_ms": 800,
2165
+ "p99_ms": 2000,
2166
+ "sample_count": 0,
2167
+ "source": "estimate"
2054
2168
  }
2055
2169
  },
2056
2170
  "delete": {
@@ -2270,6 +2384,13 @@
2270
2384
  "latency": "high",
2271
2385
  "resource_usage": "moderate"
2272
2386
  }
2387
+ },
2388
+ "x-f5xc-discovered-response-time": {
2389
+ "p50_ms": 500,
2390
+ "p95_ms": 1500,
2391
+ "p99_ms": 4000,
2392
+ "sample_count": 0,
2393
+ "source": "estimate"
2273
2394
  }
2274
2395
  },
2275
2396
  "x-displayname": "K8s Cluster Role.",
@@ -2484,6 +2605,13 @@
2484
2605
  "latency": "low",
2485
2606
  "resource_usage": "low"
2486
2607
  }
2608
+ },
2609
+ "x-f5xc-discovered-response-time": {
2610
+ "p50_ms": 1000,
2611
+ "p95_ms": 3000,
2612
+ "p99_ms": 8000,
2613
+ "sample_count": 0,
2614
+ "source": "estimate"
2487
2615
  }
2488
2616
  },
2489
2617
  "x-displayname": "K8s Cluster Role Binding.",
@@ -2706,6 +2834,13 @@
2706
2834
  "latency": "low",
2707
2835
  "resource_usage": "low"
2708
2836
  }
2837
+ },
2838
+ "x-f5xc-discovered-response-time": {
2839
+ "p50_ms": 800,
2840
+ "p95_ms": 2500,
2841
+ "p99_ms": 6000,
2842
+ "sample_count": 0,
2843
+ "source": "estimate"
2709
2844
  }
2710
2845
  },
2711
2846
  "x-displayname": "K8s Cluster Role Binding.",
@@ -2935,7 +3070,15 @@
2935
3070
  }
2936
3071
  },
2937
3072
  "x-discovered-response-time-ms": 161.41,
2938
- "x-discovered-sample-size": 1
3073
+ "x-discovered-sample-size": 1,
3074
+ "x-f5xc-discovered-response-time": {
3075
+ "p50_ms": 161.41,
3076
+ "p95_ms": 322.82,
3077
+ "p99_ms": 484.23,
3078
+ "sample_count": 1,
3079
+ "source": "discovery",
3080
+ "last_measured": "2025-12-20T19:39:20.211392+00:00"
3081
+ }
2939
3082
  },
2940
3083
  "x-displayname": "K8s Cluster Role Binding.",
2941
3084
  "x-ves-proto-service": "ves.io.schema.k8s_cluster_role_binding.API",
@@ -3156,6 +3299,13 @@
3156
3299
  "latency": "low",
3157
3300
  "resource_usage": "low"
3158
3301
  }
3302
+ },
3303
+ "x-f5xc-discovered-response-time": {
3304
+ "p50_ms": 200,
3305
+ "p95_ms": 800,
3306
+ "p99_ms": 2000,
3307
+ "sample_count": 0,
3308
+ "source": "estimate"
3159
3309
  }
3160
3310
  },
3161
3311
  "delete": {
@@ -3375,6 +3525,13 @@
3375
3525
  "latency": "high",
3376
3526
  "resource_usage": "moderate"
3377
3527
  }
3528
+ },
3529
+ "x-f5xc-discovered-response-time": {
3530
+ "p50_ms": 500,
3531
+ "p95_ms": 1500,
3532
+ "p99_ms": 4000,
3533
+ "sample_count": 0,
3534
+ "source": "estimate"
3378
3535
  }
3379
3536
  },
3380
3537
  "x-displayname": "K8s Cluster Role Binding.",
@@ -3589,6 +3746,13 @@
3589
3746
  "latency": "low",
3590
3747
  "resource_usage": "low"
3591
3748
  }
3749
+ },
3750
+ "x-f5xc-discovered-response-time": {
3751
+ "p50_ms": 1000,
3752
+ "p95_ms": 3000,
3753
+ "p99_ms": 8000,
3754
+ "sample_count": 0,
3755
+ "source": "estimate"
3592
3756
  }
3593
3757
  },
3594
3758
  "x-displayname": "K8s Pod Security Admission.",
@@ -3811,6 +3975,13 @@
3811
3975
  "latency": "low",
3812
3976
  "resource_usage": "low"
3813
3977
  }
3978
+ },
3979
+ "x-f5xc-discovered-response-time": {
3980
+ "p50_ms": 800,
3981
+ "p95_ms": 2500,
3982
+ "p99_ms": 6000,
3983
+ "sample_count": 0,
3984
+ "source": "estimate"
3814
3985
  }
3815
3986
  },
3816
3987
  "x-displayname": "K8s Pod Security Admission.",
@@ -4040,7 +4211,15 @@
4040
4211
  }
4041
4212
  },
4042
4213
  "x-discovered-response-time-ms": 155.68,
4043
- "x-discovered-sample-size": 1
4214
+ "x-discovered-sample-size": 1,
4215
+ "x-f5xc-discovered-response-time": {
4216
+ "p50_ms": 155.68,
4217
+ "p95_ms": 311.36,
4218
+ "p99_ms": 467.04,
4219
+ "sample_count": 1,
4220
+ "source": "discovery",
4221
+ "last_measured": "2025-12-20T19:39:20.211392+00:00"
4222
+ }
4044
4223
  },
4045
4224
  "x-displayname": "K8s Pod Security Admission.",
4046
4225
  "x-ves-proto-service": "ves.io.schema.k8s_pod_security_admission.API",
@@ -4261,6 +4440,13 @@
4261
4440
  "latency": "low",
4262
4441
  "resource_usage": "low"
4263
4442
  }
4443
+ },
4444
+ "x-f5xc-discovered-response-time": {
4445
+ "p50_ms": 200,
4446
+ "p95_ms": 800,
4447
+ "p99_ms": 2000,
4448
+ "sample_count": 0,
4449
+ "source": "estimate"
4264
4450
  }
4265
4451
  },
4266
4452
  "delete": {
@@ -4480,6 +4666,13 @@
4480
4666
  "latency": "high",
4481
4667
  "resource_usage": "moderate"
4482
4668
  }
4669
+ },
4670
+ "x-f5xc-discovered-response-time": {
4671
+ "p50_ms": 500,
4672
+ "p95_ms": 1500,
4673
+ "p99_ms": 4000,
4674
+ "sample_count": 0,
4675
+ "source": "estimate"
4483
4676
  }
4484
4677
  },
4485
4678
  "x-displayname": "K8s Pod Security Admission.",
@@ -4695,6 +4888,13 @@
4695
4888
  "latency": "low",
4696
4889
  "resource_usage": "low"
4697
4890
  }
4891
+ },
4892
+ "x-f5xc-discovered-response-time": {
4893
+ "p50_ms": 1000,
4894
+ "p95_ms": 3000,
4895
+ "p99_ms": 8000,
4896
+ "sample_count": 0,
4897
+ "source": "estimate"
4698
4898
  }
4699
4899
  },
4700
4900
  "x-displayname": "K8s Pod Security Policy.",
@@ -4918,6 +5118,13 @@
4918
5118
  "latency": "low",
4919
5119
  "resource_usage": "low"
4920
5120
  }
5121
+ },
5122
+ "x-f5xc-discovered-response-time": {
5123
+ "p50_ms": 800,
5124
+ "p95_ms": 2500,
5125
+ "p99_ms": 6000,
5126
+ "sample_count": 0,
5127
+ "source": "estimate"
4921
5128
  }
4922
5129
  },
4923
5130
  "x-displayname": "K8s Pod Security Policy.",
@@ -5146,6 +5353,13 @@
5146
5353
  "latency": "moderate",
5147
5354
  "resource_usage": "moderate"
5148
5355
  }
5356
+ },
5357
+ "x-f5xc-discovered-response-time": {
5358
+ "p50_ms": 200,
5359
+ "p95_ms": 800,
5360
+ "p99_ms": 2000,
5361
+ "sample_count": 0,
5362
+ "source": "estimate"
5149
5363
  }
5150
5364
  },
5151
5365
  "x-displayname": "K8s Pod Security Policy.",
@@ -5368,6 +5582,13 @@
5368
5582
  "latency": "low",
5369
5583
  "resource_usage": "low"
5370
5584
  }
5585
+ },
5586
+ "x-f5xc-discovered-response-time": {
5587
+ "p50_ms": 200,
5588
+ "p95_ms": 800,
5589
+ "p99_ms": 2000,
5590
+ "sample_count": 0,
5591
+ "source": "estimate"
5371
5592
  }
5372
5593
  },
5373
5594
  "delete": {
@@ -5588,6 +5809,13 @@
5588
5809
  "latency": "high",
5589
5810
  "resource_usage": "moderate"
5590
5811
  }
5812
+ },
5813
+ "x-f5xc-discovered-response-time": {
5814
+ "p50_ms": 500,
5815
+ "p95_ms": 1500,
5816
+ "p99_ms": 4000,
5817
+ "sample_count": 0,
5818
+ "source": "estimate"
5591
5819
  }
5592
5820
  },
5593
5821
  "x-displayname": "K8s Pod Security Policy.",
@@ -5708,6 +5936,7 @@
5708
5936
  "ves.io.schema.rules.message.required": "true",
5709
5937
  "ves.io.schema.rules.string.hostname": "true"
5710
5938
  },
5939
+ "x-f5xc-description-short": "Fully qualified name of the registry login server Required: YES.",
5711
5940
  "minLength": 0,
5712
5941
  "maxLength": 1024,
5713
5942
  "x-f5xc-required-for": {
@@ -5733,6 +5962,7 @@
5733
5962
  "ves.io.schema.rules.message.required": "true",
5734
5963
  "ves.io.schema.rules.string.max_len": "128"
5735
5964
  },
5965
+ "x-f5xc-description-short": "Username used to access the registry Required: YES.",
5736
5966
  "minLength": 0,
5737
5967
  "x-f5xc-required-for": {
5738
5968
  "minimum_config": false,
@@ -5770,6 +6000,7 @@
5770
6000
  "title": "Fail_if_referred.",
5771
6001
  "format": "boolean",
5772
6002
  "x-displayname": "Fail-If-Referred.",
6003
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
5773
6004
  "x-f5xc-required-for": {
5774
6005
  "minimum_config": false,
5775
6006
  "create": false,
@@ -5794,7 +6025,7 @@
5794
6025
  },
5795
6026
  "x-original-maxLength": 1024,
5796
6027
  "x-reconciled-from-discovery": true,
5797
- "x-reconciled-at": "2026-01-05T14:38:10.108240+00:00"
6028
+ "x-reconciled-at": "2026-01-07T15:28:26.165235+00:00"
5798
6029
  },
5799
6030
  "namespace": {
5800
6031
  "type": "string",
@@ -5803,6 +6034,7 @@
5803
6034
  "x-displayname": "Namespace",
5804
6035
  "x-ves-example": "Ns1",
5805
6036
  "x-f5xc-example": "ns1",
6037
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
5806
6038
  "minLength": 0,
5807
6039
  "maxLength": 6,
5808
6040
  "x-f5xc-required-for": {
@@ -5813,7 +6045,7 @@
5813
6045
  },
5814
6046
  "x-original-maxLength": 1024,
5815
6047
  "x-reconciled-from-discovery": true,
5816
- "x-reconciled-at": "2026-01-05T14:38:10.108247+00:00"
6048
+ "x-reconciled-at": "2026-01-07T15:28:26.165242+00:00"
5817
6049
  }
5818
6050
  },
5819
6051
  "x-f5xc-minimum-configuration": {
@@ -5848,6 +6080,7 @@
5848
6080
  "$ref": "#/components/schemas/schemaObjectRefType"
5849
6081
  },
5850
6082
  "x-displayname": "Deleted Referred Objects.",
6083
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5851
6084
  "x-f5xc-required-for": {
5852
6085
  "minimum_config": false,
5853
6086
  "create": false,
@@ -5863,6 +6096,7 @@
5863
6096
  "$ref": "#/components/schemas/schemaObjectRefType"
5864
6097
  },
5865
6098
  "x-displayname": "Disabled Referred Objects.",
6099
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5866
6100
  "x-f5xc-required-for": {
5867
6101
  "minimum_config": false,
5868
6102
  "create": false,
@@ -5881,6 +6115,7 @@
5881
6115
  "$ref": "#/components/schemas/schemaObjectRefType"
5882
6116
  },
5883
6117
  "x-displayname": "Referring Objects.",
6118
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
5884
6119
  "x-f5xc-required-for": {
5885
6120
  "minimum_config": false,
5886
6121
  "create": false,
@@ -5902,6 +6137,8 @@
5902
6137
  "$ref": "#/components/schemas/container_registryStatusObject"
5903
6138
  },
5904
6139
  "x-displayname": "Status",
6140
+ "x-f5xc-example": "active",
6141
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5905
6142
  "x-f5xc-required-for": {
5906
6143
  "minimum_config": false,
5907
6144
  "create": false,
@@ -5911,7 +6148,7 @@
5911
6148
  "maxLength": 17,
5912
6149
  "minLength": 17,
5913
6150
  "x-reconciled-from-discovery": true,
5914
- "x-reconciled-at": "2026-01-05T14:38:10.108264+00:00"
6151
+ "x-reconciled-at": "2026-01-07T15:28:26.165258+00:00"
5915
6152
  },
5916
6153
  "system_metadata": {
5917
6154
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -5951,6 +6188,8 @@
5951
6188
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
5952
6189
  ],
5953
6190
  "default": "GET_RSP_FORMAT_DEFAULT",
6191
+ "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...",
6192
+ "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...",
5954
6193
  "x-f5xc-minimum-configuration": {
5955
6194
  "description": "Minimum configuration for container_registryGetResponseFormatCode",
5956
6195
  "required_fields": [],
@@ -6009,6 +6248,7 @@
6009
6248
  "ves.io.schema.rules.message.required": "true",
6010
6249
  "ves.io.schema.rules.string.hostname": "true"
6011
6250
  },
6251
+ "x-f5xc-description-short": "Fully qualified name of the registry login server Required: YES.",
6012
6252
  "minLength": 0,
6013
6253
  "maxLength": 1024,
6014
6254
  "x-f5xc-required-for": {
@@ -6034,6 +6274,7 @@
6034
6274
  "ves.io.schema.rules.message.required": "true",
6035
6275
  "ves.io.schema.rules.string.max_len": "128"
6036
6276
  },
6277
+ "x-f5xc-description-short": "Username used to access the registry Required: YES.",
6037
6278
  "minLength": 0,
6038
6279
  "x-f5xc-required-for": {
6039
6280
  "minimum_config": false,
@@ -6073,6 +6314,7 @@
6073
6314
  "$ref": "#/components/schemas/schemaErrorType"
6074
6315
  },
6075
6316
  "x-displayname": "Errors",
6317
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
6076
6318
  "x-f5xc-required-for": {
6077
6319
  "minimum_config": false,
6078
6320
  "create": false,
@@ -6088,6 +6330,8 @@
6088
6330
  "$ref": "#/components/schemas/container_registryListResponseItem"
6089
6331
  },
6090
6332
  "x-displayname": "Items",
6333
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
6334
+ "x-f5xc-description-short": "Items represents the collection in response.",
6091
6335
  "x-f5xc-required-for": {
6092
6336
  "minimum_config": false,
6093
6337
  "create": false,
@@ -6121,6 +6365,8 @@
6121
6365
  "description": "The set of annotations present on this container_registry.",
6122
6366
  "title": "Annotations.",
6123
6367
  "x-displayname": "Annotations.",
6368
+ "x-f5xc-example": "{\"key\": \"value\"}",
6369
+ "x-f5xc-description-short": "The set of annotations present on this container_registry.",
6124
6370
  "x-f5xc-required-for": {
6125
6371
  "minimum_config": false,
6126
6372
  "create": false,
@@ -6133,6 +6379,7 @@
6133
6379
  "description": "The description set for this container_registry.",
6134
6380
  "title": "Description.",
6135
6381
  "x-displayname": "Description.",
6382
+ "x-f5xc-description-short": "The description set for this container_registry.",
6136
6383
  "minLength": 0,
6137
6384
  "maxLength": 0,
6138
6385
  "x-f5xc-required-for": {
@@ -6143,7 +6390,7 @@
6143
6390
  },
6144
6391
  "x-original-maxLength": 1024,
6145
6392
  "x-reconciled-from-discovery": true,
6146
- "x-reconciled-at": "2026-01-05T14:38:10.108284+00:00"
6393
+ "x-reconciled-at": "2026-01-07T15:28:26.165277+00:00"
6147
6394
  },
6148
6395
  "disabled": {
6149
6396
  "type": "boolean",
@@ -6151,6 +6398,8 @@
6151
6398
  "title": "Disabled",
6152
6399
  "format": "boolean",
6153
6400
  "x-displayname": "Disabled",
6401
+ "x-f5xc-example": "True",
6402
+ "x-f5xc-description-short": "Value of true indicates container_registry is administratively disabled.",
6154
6403
  "x-f5xc-required-for": {
6155
6404
  "minimum_config": false,
6156
6405
  "create": false,
@@ -6166,6 +6415,8 @@
6166
6415
  "description": "The set of labels present on this container_registry.",
6167
6416
  "title": "Labels",
6168
6417
  "x-displayname": "Labels",
6418
+ "x-f5xc-example": "{\"key\": \"value\"}",
6419
+ "x-f5xc-description-short": "The set of labels present on this container_registry.",
6169
6420
  "x-f5xc-required-for": {
6170
6421
  "minimum_config": false,
6171
6422
  "create": false,
@@ -6193,7 +6444,7 @@
6193
6444
  },
6194
6445
  "x-original-maxLength": 1024,
6195
6446
  "x-reconciled-from-discovery": true,
6196
- "x-reconciled-at": "2026-01-05T14:38:10.108295+00:00"
6447
+ "x-reconciled-at": "2026-01-07T15:28:26.165288+00:00"
6197
6448
  },
6198
6449
  "namespace": {
6199
6450
  "type": "string",
@@ -6212,7 +6463,7 @@
6212
6463
  },
6213
6464
  "x-original-maxLength": 1024,
6214
6465
  "x-reconciled-from-discovery": true,
6215
- "x-reconciled-at": "2026-01-05T14:38:10.108299+00:00"
6466
+ "x-reconciled-at": "2026-01-07T15:28:26.165292+00:00"
6216
6467
  },
6217
6468
  "owner_view": {
6218
6469
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -6225,6 +6476,7 @@
6225
6476
  "$ref": "#/components/schemas/container_registryStatusObject"
6226
6477
  },
6227
6478
  "x-displayname": "Status",
6479
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6228
6480
  "x-f5xc-required-for": {
6229
6481
  "minimum_config": false,
6230
6482
  "create": false,
@@ -6253,7 +6505,7 @@
6253
6505
  "x-field-mutability": "read-only",
6254
6506
  "x-original-maxLength": 1024,
6255
6507
  "x-reconciled-from-discovery": true,
6256
- "x-reconciled-at": "2026-01-05T14:38:10.108308+00:00"
6508
+ "x-reconciled-at": "2026-01-07T15:28:26.165300+00:00"
6257
6509
  },
6258
6510
  "uid": {
6259
6511
  "type": "string",
@@ -6262,6 +6514,7 @@
6262
6514
  "x-displayname": "UID",
6263
6515
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
6264
6516
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
6517
+ "x-f5xc-description-short": "The unique uid of this container_registry.",
6265
6518
  "minLength": 0,
6266
6519
  "maxLength": 36,
6267
6520
  "x-f5xc-required-for": {
@@ -6274,9 +6527,11 @@
6274
6527
  "x-original-maxLength": 1024,
6275
6528
  "format": "uuid",
6276
6529
  "x-reconciled-from-discovery": true,
6277
- "x-reconciled-at": "2026-01-05T14:38:10.108314+00:00"
6530
+ "x-reconciled-at": "2026-01-07T15:28:26.165306+00:00"
6278
6531
  }
6279
6532
  },
6533
+ "x-f5xc-description-short": "By default a summary of container_registry is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6534
+ "x-f5xc-description-medium": "By default a summary of container_registry is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6280
6535
  "x-f5xc-minimum-configuration": {
6281
6536
  "description": "Minimum configuration for container_registryListResponseItem",
6282
6537
  "required_fields": [
@@ -6389,6 +6644,7 @@
6389
6644
  "ves.io.schema.rules.message.required": "true",
6390
6645
  "ves.io.schema.rules.string.hostname": "true"
6391
6646
  },
6647
+ "x-f5xc-description-short": "Fully qualified name of the registry login server Required: YES.",
6392
6648
  "minLength": 0,
6393
6649
  "maxLength": 1024,
6394
6650
  "x-f5xc-required-for": {
@@ -6414,6 +6670,7 @@
6414
6670
  "ves.io.schema.rules.message.required": "true",
6415
6671
  "ves.io.schema.rules.string.max_len": "128"
6416
6672
  },
6673
+ "x-f5xc-description-short": "Username used to access the registry Required: YES.",
6417
6674
  "minLength": 0,
6418
6675
  "x-f5xc-required-for": {
6419
6676
  "minimum_config": false,
@@ -6479,6 +6736,7 @@
6479
6736
  }
6480
6737
  }
6481
6738
  },
6739
+ "x-f5xc-description-short": "Most recently observed status of the Container Registry.",
6482
6740
  "x-f5xc-minimum-configuration": {
6483
6741
  "description": "Minimum configuration for container_registryStatusObject",
6484
6742
  "required_fields": [
@@ -6500,6 +6758,8 @@
6500
6758
  "type_url": {
6501
6759
  "type": "string",
6502
6760
  "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.",
6761
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
6762
+ "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 ).",
6503
6763
  "minLength": 0,
6504
6764
  "maxLength": 1024,
6505
6765
  "x-f5xc-required-for": {
@@ -6523,9 +6783,11 @@
6523
6783
  },
6524
6784
  "x-original-maxLength": 1024,
6525
6785
  "x-reconciled-from-discovery": true,
6526
- "x-reconciled-at": "2026-01-05T14:38:10.108336+00:00"
6786
+ "x-reconciled-at": "2026-01-07T15:28:26.165326+00:00"
6527
6787
  }
6528
6788
  },
6789
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
6790
+ "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...",
6529
6791
  "x-f5xc-minimum-configuration": {
6530
6792
  "description": "Minimum configuration for protobufAny",
6531
6793
  "required_fields": [
@@ -6554,6 +6816,8 @@
6554
6816
  "x-displayname": "Decryption Provider.",
6555
6817
  "x-ves-example": "Value",
6556
6818
  "x-f5xc-example": "value",
6819
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
6820
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
6557
6821
  "minLength": 0,
6558
6822
  "maxLength": 1024,
6559
6823
  "x-f5xc-required-for": {
@@ -6579,6 +6843,8 @@
6579
6843
  "ves.io.schema.rules.message.required": "true",
6580
6844
  "ves.io.schema.rules.string.uri_ref": "true"
6581
6845
  },
6846
+ "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.",
6847
+ "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.",
6582
6848
  "minLength": 0,
6583
6849
  "maxLength": 4,
6584
6850
  "x-f5xc-required-for": {
@@ -6589,7 +6855,7 @@
6589
6855
  },
6590
6856
  "x-original-maxLength": 1024,
6591
6857
  "x-reconciled-from-discovery": true,
6592
- "x-reconciled-at": "2026-01-05T14:38:10.108343+00:00"
6858
+ "x-reconciled-at": "2026-01-07T15:28:26.165332+00:00"
6593
6859
  },
6594
6860
  "store_provider": {
6595
6861
  "type": "string",
@@ -6598,6 +6864,8 @@
6598
6864
  "x-displayname": "Store Provider.",
6599
6865
  "x-ves-example": "Value",
6600
6866
  "x-f5xc-example": "value",
6867
+ "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...",
6868
+ "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:///.",
6601
6869
  "minLength": 0,
6602
6870
  "maxLength": 1024,
6603
6871
  "x-f5xc-required-for": {
@@ -6608,6 +6876,7 @@
6608
6876
  }
6609
6877
  }
6610
6878
  },
6879
+ "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
6611
6880
  "x-f5xc-minimum-configuration": {
6612
6881
  "description": "Minimum configuration for schemaBlindfoldSecretInfoType",
6613
6882
  "required_fields": [
@@ -6637,6 +6906,8 @@
6637
6906
  "x-displayname": "Provider",
6638
6907
  "x-ves-example": "Box-provider.",
6639
6908
  "x-f5xc-example": "box-provider",
6909
+ "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...",
6910
+ "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:///.",
6640
6911
  "minLength": 0,
6641
6912
  "maxLength": 8,
6642
6913
  "x-f5xc-required-for": {
@@ -6647,7 +6918,7 @@
6647
6918
  },
6648
6919
  "x-original-maxLength": 1024,
6649
6920
  "x-reconciled-from-discovery": true,
6650
- "x-reconciled-at": "2026-01-05T14:38:10.108350+00:00"
6921
+ "x-reconciled-at": "2026-01-07T15:28:26.165338+00:00"
6651
6922
  },
6652
6923
  "url": {
6653
6924
  "type": "string",
@@ -6668,6 +6939,8 @@
6668
6939
  "ves.io.schema.rules.string.max_bytes": "131072",
6669
6940
  "ves.io.schema.rules.string.uri_ref": "true"
6670
6941
  },
6942
+ "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
6943
+ "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.",
6671
6944
  "format": "uri",
6672
6945
  "minLength": 0,
6673
6946
  "x-f5xc-required-for": {
@@ -6678,6 +6951,7 @@
6678
6951
  }
6679
6952
  }
6680
6953
  },
6954
+ "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
6681
6955
  "x-f5xc-minimum-configuration": {
6682
6956
  "description": "Minimum configuration for schemaClearSecretInfoType",
6683
6957
  "required_fields": [
@@ -6703,6 +6977,8 @@
6703
6977
  "description": "Hostname of the instance of the site that sent the status.",
6704
6978
  "title": "Hostname",
6705
6979
  "x-displayname": "Hostname",
6980
+ "x-f5xc-example": "example-resource",
6981
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
6706
6982
  "minLength": 0,
6707
6983
  "maxLength": 1024,
6708
6984
  "x-f5xc-required-for": {
@@ -6734,6 +7010,8 @@
6734
7010
  "x-displayname": "Reason",
6735
7011
  "x-ves-example": "Value",
6736
7012
  "x-f5xc-example": "value",
7013
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
7014
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
6737
7015
  "minLength": 0,
6738
7016
  "maxLength": 43,
6739
7017
  "x-f5xc-required-for": {
@@ -6744,13 +7022,15 @@
6744
7022
  },
6745
7023
  "x-original-maxLength": 1024,
6746
7024
  "x-reconciled-from-discovery": true,
6747
- "x-reconciled-at": "2026-01-05T14:38:10.108360+00:00"
7025
+ "x-reconciled-at": "2026-01-07T15:28:26.165348+00:00"
6748
7026
  },
6749
7027
  "service_name": {
6750
7028
  "type": "string",
6751
7029
  "description": "Name of the service that sent the status.",
6752
7030
  "title": "Service name.",
6753
7031
  "x-displayname": "Service Name.",
7032
+ "x-f5xc-example": "example-resource",
7033
+ "x-f5xc-description-short": "Name of the service that sent the status.",
6754
7034
  "minLength": 0,
6755
7035
  "maxLength": 1024,
6756
7036
  "x-f5xc-required-for": {
@@ -6773,6 +7053,8 @@
6773
7053
  "x-validation-rules": {
6774
7054
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
6775
7055
  },
7056
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
7057
+ "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...",
6776
7058
  "minLength": 0,
6777
7059
  "maxLength": 17,
6778
7060
  "x-f5xc-required-for": {
@@ -6783,7 +7065,7 @@
6783
7065
  },
6784
7066
  "x-original-maxLength": 1024,
6785
7067
  "x-reconciled-from-discovery": true,
6786
- "x-reconciled-at": "2026-01-05T14:38:10.108366+00:00"
7068
+ "x-reconciled-at": "2026-01-07T15:28:26.165353+00:00"
6787
7069
  },
6788
7070
  "type": {
6789
7071
  "type": "string",
@@ -6798,6 +7080,8 @@
6798
7080
  "x-validation-rules": {
6799
7081
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
6800
7082
  },
7083
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
7084
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
6801
7085
  "minLength": 0,
6802
7086
  "maxLength": 1024,
6803
7087
  "x-f5xc-required-for": {
@@ -6808,6 +7092,8 @@
6808
7092
  }
6809
7093
  }
6810
7094
  },
7095
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
7096
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
6811
7097
  "x-f5xc-minimum-configuration": {
6812
7098
  "description": "Minimum configuration for schemaConditionType",
6813
7099
  "required_fields": [
@@ -6843,6 +7129,8 @@
6843
7129
  "default": "EOK",
6844
7130
  "x-displayname": "Error Code.",
6845
7131
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
7132
+ "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...",
7133
+ "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...",
6846
7134
  "x-f5xc-minimum-configuration": {
6847
7135
  "description": "Minimum configuration for schemaErrorCode",
6848
7136
  "required_fields": [],
@@ -6883,6 +7171,7 @@
6883
7171
  }
6884
7172
  }
6885
7173
  },
7174
+ "x-f5xc-description-short": "Information about a error in API operation.",
6886
7175
  "x-f5xc-minimum-configuration": {
6887
7176
  "description": "Minimum configuration for schemaErrorType",
6888
7177
  "required_fields": [
@@ -6910,6 +7199,7 @@
6910
7199
  "title": "Name",
6911
7200
  "x-displayname": "Name",
6912
7201
  "x-f5xc-example": "example-resource",
7202
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
6913
7203
  "minLength": 0,
6914
7204
  "maxLength": 16,
6915
7205
  "x-f5xc-required-for": {
@@ -6920,9 +7210,10 @@
6920
7210
  },
6921
7211
  "x-original-maxLength": 1024,
6922
7212
  "x-reconciled-from-discovery": true,
6923
- "x-reconciled-at": "2026-01-05T14:38:10.108378+00:00"
7213
+ "x-reconciled-at": "2026-01-07T15:28:26.165364+00:00"
6924
7214
  }
6925
7215
  },
7216
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
6926
7217
  "x-f5xc-minimum-configuration": {
6927
7218
  "description": "Minimum configuration for schemaInitializerType",
6928
7219
  "required_fields": [
@@ -6950,6 +7241,8 @@
6950
7241
  "$ref": "#/components/schemas/schemaInitializerType"
6951
7242
  },
6952
7243
  "x-displayname": "Pending",
7244
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
7245
+ "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.",
6953
7246
  "x-f5xc-required-for": {
6954
7247
  "minimum_config": false,
6955
7248
  "create": false,
@@ -6961,6 +7254,7 @@
6961
7254
  "$ref": "#/components/schemas/schemaStatusType"
6962
7255
  }
6963
7256
  },
7257
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
6964
7258
  "x-f5xc-minimum-configuration": {
6965
7259
  "description": "Minimum configuration for schemaInitializersType",
6966
7260
  "required_fields": [
@@ -6999,6 +7293,8 @@
6999
7293
  "ves.io.schema.rules.map.values.string.max_len": "1024",
7000
7294
  "ves.io.schema.rules.map.values.string.min_len": "1"
7001
7295
  },
7296
+ "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.",
7297
+ "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.",
7002
7298
  "x-f5xc-required-for": {
7003
7299
  "minimum_config": false,
7004
7300
  "create": false,
@@ -7020,6 +7316,7 @@
7020
7316
  "x-validation-rules": {
7021
7317
  "ves.io.schema.rules.string.max_bytes": "1200"
7022
7318
  },
7319
+ "x-f5xc-description-short": "Human readable description for the object.",
7023
7320
  "minLength": 0,
7024
7321
  "x-f5xc-required-for": {
7025
7322
  "minimum_config": false,
@@ -7029,7 +7326,7 @@
7029
7326
  },
7030
7327
  "x-original-maxLength": 1200,
7031
7328
  "x-reconciled-from-discovery": true,
7032
- "x-reconciled-at": "2026-01-05T14:38:10.108388+00:00"
7329
+ "x-reconciled-at": "2026-01-07T15:28:26.165374+00:00"
7033
7330
  },
7034
7331
  "disable": {
7035
7332
  "type": "boolean",
@@ -7038,6 +7335,7 @@
7038
7335
  "format": "boolean",
7039
7336
  "x-displayname": "Disable",
7040
7337
  "x-f5xc-example": "true",
7338
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
7041
7339
  "x-f5xc-required-for": {
7042
7340
  "minimum_config": false,
7043
7341
  "create": false,
@@ -7051,6 +7349,8 @@
7051
7349
  "title": "Labels",
7052
7350
  "x-displayname": "Labels",
7053
7351
  "x-f5xc-example": "value",
7352
+ "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.",
7353
+ "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.",
7054
7354
  "x-f5xc-required-for": {
7055
7355
  "minimum_config": false,
7056
7356
  "create": false,
@@ -7072,6 +7372,8 @@
7072
7372
  "x-validation-rules": {
7073
7373
  "ves.io.schema.rules.message.required": "true"
7074
7374
  },
7375
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
7376
+ "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.",
7075
7377
  "minLength": 0,
7076
7378
  "maxLength": 16,
7077
7379
  "x-f5xc-required-for": {
@@ -7082,7 +7384,7 @@
7082
7384
  },
7083
7385
  "x-original-maxLength": 1024,
7084
7386
  "x-reconciled-from-discovery": true,
7085
- "x-reconciled-at": "2026-01-05T14:38:10.108395+00:00"
7387
+ "x-reconciled-at": "2026-01-07T15:28:26.165382+00:00"
7086
7388
  },
7087
7389
  "namespace": {
7088
7390
  "type": "string",
@@ -7091,6 +7393,8 @@
7091
7393
  "x-displayname": "Namespace",
7092
7394
  "x-ves-example": "Staging",
7093
7395
  "x-f5xc-example": "staging",
7396
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
7397
+ "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 \"\".",
7094
7398
  "minLength": 0,
7095
7399
  "maxLength": 6,
7096
7400
  "x-f5xc-required-for": {
@@ -7101,9 +7405,10 @@
7101
7405
  },
7102
7406
  "x-original-maxLength": 1024,
7103
7407
  "x-reconciled-from-discovery": true,
7104
- "x-reconciled-at": "2026-01-05T14:38:10.108400+00:00"
7408
+ "x-reconciled-at": "2026-01-07T15:28:26.165386+00:00"
7105
7409
  }
7106
7410
  },
7411
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
7107
7412
  "x-f5xc-minimum-configuration": {
7108
7413
  "description": "Minimum configuration for schemaObjectCreateMetaType",
7109
7414
  "required_fields": [
@@ -7147,6 +7452,8 @@
7147
7452
  "ves.io.schema.rules.map.values.string.max_len": "1024",
7148
7453
  "ves.io.schema.rules.map.values.string.min_len": "1"
7149
7454
  },
7455
+ "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.",
7456
+ "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.",
7150
7457
  "x-f5xc-required-for": {
7151
7458
  "minimum_config": false,
7152
7459
  "create": false,
@@ -7168,6 +7475,7 @@
7168
7475
  "x-validation-rules": {
7169
7476
  "ves.io.schema.rules.string.max_bytes": "1200"
7170
7477
  },
7478
+ "x-f5xc-description-short": "Human readable description for the object.",
7171
7479
  "minLength": 0,
7172
7480
  "x-f5xc-required-for": {
7173
7481
  "minimum_config": false,
@@ -7177,7 +7485,7 @@
7177
7485
  },
7178
7486
  "x-original-maxLength": 1200,
7179
7487
  "x-reconciled-from-discovery": true,
7180
- "x-reconciled-at": "2026-01-05T14:38:10.108407+00:00"
7488
+ "x-reconciled-at": "2026-01-07T15:28:26.165392+00:00"
7181
7489
  },
7182
7490
  "disable": {
7183
7491
  "type": "boolean",
@@ -7187,6 +7495,7 @@
7187
7495
  "x-displayname": "Disable",
7188
7496
  "x-ves-example": "True",
7189
7497
  "x-f5xc-example": "true",
7498
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
7190
7499
  "x-f5xc-required-for": {
7191
7500
  "minimum_config": false,
7192
7501
  "create": false,
@@ -7201,6 +7510,8 @@
7201
7510
  "x-displayname": "Labels",
7202
7511
  "x-ves-example": "Value",
7203
7512
  "x-f5xc-example": "value",
7513
+ "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.",
7514
+ "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.",
7204
7515
  "x-f5xc-required-for": {
7205
7516
  "minimum_config": false,
7206
7517
  "create": false,
@@ -7222,6 +7533,8 @@
7222
7533
  "x-validation-rules": {
7223
7534
  "ves.io.schema.rules.message.required": "true"
7224
7535
  },
7536
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
7537
+ "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.",
7225
7538
  "minLength": 0,
7226
7539
  "maxLength": 16,
7227
7540
  "x-f5xc-required-for": {
@@ -7232,7 +7545,7 @@
7232
7545
  },
7233
7546
  "x-original-maxLength": 1024,
7234
7547
  "x-reconciled-from-discovery": true,
7235
- "x-reconciled-at": "2026-01-05T14:38:10.108414+00:00"
7548
+ "x-reconciled-at": "2026-01-07T15:28:26.165400+00:00"
7236
7549
  },
7237
7550
  "namespace": {
7238
7551
  "type": "string",
@@ -7241,6 +7554,8 @@
7241
7554
  "x-displayname": "Namespace",
7242
7555
  "x-ves-example": "Staging",
7243
7556
  "x-f5xc-example": "staging",
7557
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
7558
+ "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 \"\".",
7244
7559
  "minLength": 0,
7245
7560
  "maxLength": 6,
7246
7561
  "x-f5xc-required-for": {
@@ -7251,9 +7566,10 @@
7251
7566
  },
7252
7567
  "x-original-maxLength": 1024,
7253
7568
  "x-reconciled-from-discovery": true,
7254
- "x-reconciled-at": "2026-01-05T14:38:10.108418+00:00"
7569
+ "x-reconciled-at": "2026-01-07T15:28:26.165404+00:00"
7255
7570
  }
7256
7571
  },
7572
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
7257
7573
  "x-f5xc-minimum-configuration": {
7258
7574
  "description": "Minimum configuration for schemaObjectGetMetaType",
7259
7575
  "required_fields": [
@@ -7285,6 +7601,8 @@
7285
7601
  "x-displayname": "Kind",
7286
7602
  "x-ves-example": "Virtual_site.",
7287
7603
  "x-f5xc-example": "virtual_site",
7604
+ "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\")",
7605
+ "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\").",
7288
7606
  "minLength": 0,
7289
7607
  "maxLength": 14,
7290
7608
  "x-f5xc-required-for": {
@@ -7296,7 +7614,7 @@
7296
7614
  "readOnly": true,
7297
7615
  "x-original-maxLength": 1024,
7298
7616
  "x-reconciled-from-discovery": true,
7299
- "x-reconciled-at": "2026-01-05T14:38:10.108423+00:00"
7617
+ "x-reconciled-at": "2026-01-07T15:28:26.165409+00:00"
7300
7618
  },
7301
7619
  "name": {
7302
7620
  "type": "string",
@@ -7305,6 +7623,8 @@
7305
7623
  "x-displayname": "Name",
7306
7624
  "x-ves-example": "Contactus-route.",
7307
7625
  "x-f5xc-example": "contactus-route",
7626
+ "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.",
7627
+ "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.",
7308
7628
  "minLength": 0,
7309
7629
  "maxLength": 16,
7310
7630
  "x-f5xc-required-for": {
@@ -7315,7 +7635,7 @@
7315
7635
  },
7316
7636
  "x-original-maxLength": 1024,
7317
7637
  "x-reconciled-from-discovery": true,
7318
- "x-reconciled-at": "2026-01-05T14:38:10.108427+00:00"
7638
+ "x-reconciled-at": "2026-01-07T15:28:26.165413+00:00"
7319
7639
  },
7320
7640
  "namespace": {
7321
7641
  "type": "string",
@@ -7324,6 +7644,8 @@
7324
7644
  "x-displayname": "Namespace",
7325
7645
  "x-ves-example": "Ns1",
7326
7646
  "x-f5xc-example": "ns1",
7647
+ "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.",
7648
+ "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.",
7327
7649
  "minLength": 0,
7328
7650
  "maxLength": 6,
7329
7651
  "x-f5xc-required-for": {
@@ -7334,7 +7656,7 @@
7334
7656
  },
7335
7657
  "x-original-maxLength": 1024,
7336
7658
  "x-reconciled-from-discovery": true,
7337
- "x-reconciled-at": "2026-01-05T14:38:10.108431+00:00"
7659
+ "x-reconciled-at": "2026-01-07T15:28:26.165417+00:00"
7338
7660
  },
7339
7661
  "tenant": {
7340
7662
  "type": "string",
@@ -7343,6 +7665,8 @@
7343
7665
  "x-displayname": "Tenant",
7344
7666
  "x-ves-example": "Example-corp.",
7345
7667
  "x-f5xc-example": "example-corp",
7668
+ "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.",
7669
+ "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.",
7346
7670
  "minLength": 0,
7347
7671
  "maxLength": 18,
7348
7672
  "x-f5xc-required-for": {
@@ -7355,7 +7679,7 @@
7355
7679
  "x-field-mutability": "read-only",
7356
7680
  "x-original-maxLength": 1024,
7357
7681
  "x-reconciled-from-discovery": true,
7358
- "x-reconciled-at": "2026-01-05T14:38:10.108436+00:00"
7682
+ "x-reconciled-at": "2026-01-07T15:28:26.165421+00:00"
7359
7683
  },
7360
7684
  "uid": {
7361
7685
  "type": "string",
@@ -7364,6 +7688,8 @@
7364
7688
  "x-displayname": "UID",
7365
7689
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
7366
7690
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
7691
+ "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.",
7692
+ "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.",
7367
7693
  "minLength": 0,
7368
7694
  "maxLength": 36,
7369
7695
  "x-f5xc-required-for": {
@@ -7377,9 +7703,11 @@
7377
7703
  "x-original-maxLength": 1024,
7378
7704
  "format": "uuid",
7379
7705
  "x-reconciled-from-discovery": true,
7380
- "x-reconciled-at": "2026-01-05T14:38:10.108441+00:00"
7706
+ "x-reconciled-at": "2026-01-07T15:28:26.165426+00:00"
7381
7707
  }
7382
7708
  },
7709
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
7710
+ "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...",
7383
7711
  "x-f5xc-minimum-configuration": {
7384
7712
  "description": "Minimum configuration for schemaObjectRefType",
7385
7713
  "required_fields": [
@@ -7422,6 +7750,8 @@
7422
7750
  "ves.io.schema.rules.map.values.string.max_len": "1024",
7423
7751
  "ves.io.schema.rules.map.values.string.min_len": "1"
7424
7752
  },
7753
+ "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.",
7754
+ "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.",
7425
7755
  "x-f5xc-required-for": {
7426
7756
  "minimum_config": false,
7427
7757
  "create": false,
@@ -7443,6 +7773,7 @@
7443
7773
  "x-validation-rules": {
7444
7774
  "ves.io.schema.rules.string.max_bytes": "1200"
7445
7775
  },
7776
+ "x-f5xc-description-short": "Human readable description for the object.",
7446
7777
  "minLength": 0,
7447
7778
  "x-f5xc-required-for": {
7448
7779
  "minimum_config": false,
@@ -7452,7 +7783,7 @@
7452
7783
  },
7453
7784
  "x-original-maxLength": 1200,
7454
7785
  "x-reconciled-from-discovery": true,
7455
- "x-reconciled-at": "2026-01-05T14:38:10.108448+00:00"
7786
+ "x-reconciled-at": "2026-01-07T15:28:26.165433+00:00"
7456
7787
  },
7457
7788
  "disable": {
7458
7789
  "type": "boolean",
@@ -7461,6 +7792,7 @@
7461
7792
  "format": "boolean",
7462
7793
  "x-displayname": "Disable",
7463
7794
  "x-f5xc-example": "true",
7795
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
7464
7796
  "x-f5xc-required-for": {
7465
7797
  "minimum_config": false,
7466
7798
  "create": false,
@@ -7475,6 +7807,8 @@
7475
7807
  "x-displayname": "Labels",
7476
7808
  "x-ves-example": "Value",
7477
7809
  "x-f5xc-example": "value",
7810
+ "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.",
7811
+ "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.",
7478
7812
  "x-f5xc-required-for": {
7479
7813
  "minimum_config": false,
7480
7814
  "create": false,
@@ -7495,6 +7829,8 @@
7495
7829
  "x-validation-rules": {
7496
7830
  "ves.io.schema.rules.message.required": "true"
7497
7831
  },
7832
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
7833
+ "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.",
7498
7834
  "minLength": 0,
7499
7835
  "maxLength": 16,
7500
7836
  "x-f5xc-required-for": {
@@ -7505,7 +7841,7 @@
7505
7841
  },
7506
7842
  "x-original-maxLength": 1024,
7507
7843
  "x-reconciled-from-discovery": true,
7508
- "x-reconciled-at": "2026-01-05T14:38:10.108456+00:00"
7844
+ "x-reconciled-at": "2026-01-07T15:28:26.165440+00:00"
7509
7845
  },
7510
7846
  "namespace": {
7511
7847
  "type": "string",
@@ -7514,6 +7850,8 @@
7514
7850
  "x-displayname": "Namespace",
7515
7851
  "x-ves-example": "Staging",
7516
7852
  "x-f5xc-example": "staging",
7853
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
7854
+ "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 \"\".",
7517
7855
  "minLength": 0,
7518
7856
  "maxLength": 6,
7519
7857
  "x-f5xc-required-for": {
@@ -7524,9 +7862,10 @@
7524
7862
  },
7525
7863
  "x-original-maxLength": 1024,
7526
7864
  "x-reconciled-from-discovery": true,
7527
- "x-reconciled-at": "2026-01-05T14:38:10.108460+00:00"
7865
+ "x-reconciled-at": "2026-01-07T15:28:26.165444+00:00"
7528
7866
  }
7529
7867
  },
7868
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
7530
7869
  "x-f5xc-minimum-configuration": {
7531
7870
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
7532
7871
  "required_fields": [
@@ -7553,6 +7892,8 @@
7553
7892
  "EncodingBase64"
7554
7893
  ],
7555
7894
  "default": "EncodingNone",
7895
+ "x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
7896
+ "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.",
7556
7897
  "x-f5xc-minimum-configuration": {
7557
7898
  "description": "Minimum configuration for schemaSecretEncodingType",
7558
7899
  "required_fields": [],
@@ -7578,6 +7919,7 @@
7578
7919
  "$ref": "#/components/schemas/schemaClearSecretInfoType"
7579
7920
  }
7580
7921
  },
7922
+ "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
7581
7923
  "x-f5xc-minimum-configuration": {
7582
7924
  "description": "Minimum configuration for schemaSecretType",
7583
7925
  "required_fields": [
@@ -7604,6 +7946,8 @@
7604
7946
  "title": "Creation_timestamp.",
7605
7947
  "format": "date-time",
7606
7948
  "x-displayname": "Creation Timestamp.",
7949
+ "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.",
7950
+ "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.",
7607
7951
  "minLength": 0,
7608
7952
  "maxLength": 1024,
7609
7953
  "x-f5xc-required-for": {
@@ -7621,6 +7965,8 @@
7621
7965
  "x-displayname": "Creator Class.",
7622
7966
  "x-ves-example": "ver.re1.int.ves.I/O.",
7623
7967
  "x-f5xc-example": "ver.re1.int.F5 XC",
7968
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
7969
+ "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.",
7624
7970
  "minLength": 0,
7625
7971
  "maxLength": 1024,
7626
7972
  "x-f5xc-required-for": {
@@ -7638,6 +7984,8 @@
7638
7984
  "x-displayname": "Creator ID.",
7639
7985
  "x-ves-example": "Ver-instance-1.",
7640
7986
  "x-f5xc-example": "ver-instance-1",
7987
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
7988
+ "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.",
7641
7989
  "minLength": 0,
7642
7990
  "maxLength": 1024,
7643
7991
  "x-f5xc-required-for": {
@@ -7656,6 +8004,8 @@
7656
8004
  "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)",
7657
8005
  "title": "Status_id",
7658
8006
  "x-displayname": "Status ID",
8007
+ "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...",
8008
+ "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).",
7659
8009
  "minLength": 0,
7660
8010
  "maxLength": 1024,
7661
8011
  "x-f5xc-required-for": {
@@ -7673,6 +8023,7 @@
7673
8023
  "x-displayname": "UID",
7674
8024
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
7675
8025
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
8026
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
7676
8027
  "minLength": 0,
7677
8028
  "maxLength": 36,
7678
8029
  "x-f5xc-required-for": {
@@ -7685,13 +8036,14 @@
7685
8036
  "x-original-maxLength": 1024,
7686
8037
  "format": "uuid",
7687
8038
  "x-reconciled-from-discovery": true,
7688
- "x-reconciled-at": "2026-01-05T14:38:10.108477+00:00"
8039
+ "x-reconciled-at": "2026-01-07T15:28:26.165460+00:00"
7689
8040
  },
7690
8041
  "vtrp_id": {
7691
8042
  "type": "string",
7692
8043
  "description": "Origin of this status exchanged by VTRP.",
7693
8044
  "title": "Vtrp_id",
7694
8045
  "x-displayname": "VTRP ID",
8046
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
7695
8047
  "minLength": 0,
7696
8048
  "maxLength": 1024,
7697
8049
  "x-f5xc-required-for": {
@@ -7708,6 +8060,7 @@
7708
8060
  "title": "Vtrp_stale.",
7709
8061
  "format": "boolean",
7710
8062
  "x-displayname": "VTRP Stale.",
8063
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
7711
8064
  "x-f5xc-required-for": {
7712
8065
  "minimum_config": false,
7713
8066
  "create": false,
@@ -7716,6 +8069,7 @@
7716
8069
  }
7717
8070
  }
7718
8071
  },
8072
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
7719
8073
  "x-f5xc-minimum-configuration": {
7720
8074
  "description": "Minimum configuration for schemaStatusMetaType",
7721
8075
  "required_fields": [
@@ -7746,6 +8100,8 @@
7746
8100
  "default": "STATUS_DO_NOT_PUBLISH",
7747
8101
  "x-displayname": "Status Publish Type.",
7748
8102
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
8103
+ "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.",
8104
+ "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.",
7749
8105
  "x-f5xc-minimum-configuration": {
7750
8106
  "description": "Minimum configuration for schemaStatusPublishType",
7751
8107
  "required_fields": [],
@@ -7771,6 +8127,7 @@
7771
8127
  "x-displayname": "Code",
7772
8128
  "x-ves-example": "0",
7773
8129
  "x-f5xc-example": "0",
8130
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
7774
8131
  "minimum": 0,
7775
8132
  "maximum": 2147483647,
7776
8133
  "x-f5xc-required-for": {
@@ -7787,6 +8144,8 @@
7787
8144
  "x-displayname": "Reason",
7788
8145
  "x-ves-example": "Value",
7789
8146
  "x-f5xc-example": "value",
8147
+ "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.",
8148
+ "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.",
7790
8149
  "minLength": 0,
7791
8150
  "maxLength": 43,
7792
8151
  "x-f5xc-required-for": {
@@ -7797,7 +8156,7 @@
7797
8156
  },
7798
8157
  "x-original-maxLength": 1024,
7799
8158
  "x-reconciled-from-discovery": true,
7800
- "x-reconciled-at": "2026-01-05T14:38:10.108487+00:00"
8159
+ "x-reconciled-at": "2026-01-07T15:28:26.165469+00:00"
7801
8160
  },
7802
8161
  "status": {
7803
8162
  "type": "string",
@@ -7806,6 +8165,7 @@
7806
8165
  "x-displayname": "Status",
7807
8166
  "x-ves-example": "Value",
7808
8167
  "x-f5xc-example": "value",
8168
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
7809
8169
  "minLength": 0,
7810
8170
  "maxLength": 17,
7811
8171
  "x-f5xc-required-for": {
@@ -7816,9 +8176,10 @@
7816
8176
  },
7817
8177
  "x-original-maxLength": 1024,
7818
8178
  "x-reconciled-from-discovery": true,
7819
- "x-reconciled-at": "2026-01-05T14:38:10.108491+00:00"
8179
+ "x-reconciled-at": "2026-01-07T15:28:26.165473+00:00"
7820
8180
  }
7821
8181
  },
8182
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
7822
8183
  "x-f5xc-minimum-configuration": {
7823
8184
  "description": "Minimum configuration for schemaStatusType",
7824
8185
  "required_fields": [
@@ -7846,6 +8207,8 @@
7846
8207
  "title": "Creation_timestamp.",
7847
8208
  "format": "date-time",
7848
8209
  "x-displayname": "Creation Timestamp.",
8210
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
8211
+ "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.",
7849
8212
  "minLength": 0,
7850
8213
  "maxLength": 1024,
7851
8214
  "x-f5xc-required-for": {
@@ -7863,6 +8226,7 @@
7863
8226
  "x-displayname": "Creator Class.",
7864
8227
  "x-ves-example": "Prism",
7865
8228
  "x-f5xc-example": "value",
8229
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
7866
8230
  "minLength": 0,
7867
8231
  "maxLength": 1024,
7868
8232
  "x-f5xc-required-for": {
@@ -7880,6 +8244,7 @@
7880
8244
  "x-displayname": "Creator ID.",
7881
8245
  "x-ves-example": "Admin@example-corp.com.",
7882
8246
  "x-f5xc-example": "value",
8247
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
7883
8248
  "minLength": 0,
7884
8249
  "maxLength": 1024,
7885
8250
  "x-f5xc-required-for": {
@@ -7896,6 +8261,8 @@
7896
8261
  "title": "Deletion_timestamp.",
7897
8262
  "format": "date-time",
7898
8263
  "x-displayname": "Deletion Timestamp.",
8264
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
8265
+ "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...",
7899
8266
  "minLength": 0,
7900
8267
  "maxLength": 1024,
7901
8268
  "x-f5xc-required-for": {
@@ -7915,6 +8282,8 @@
7915
8282
  "x-displayname": "Finalizers.",
7916
8283
  "x-ves-example": "Value",
7917
8284
  "x-f5xc-example": "value",
8285
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
8286
+ "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.",
7918
8287
  "x-f5xc-required-for": {
7919
8288
  "minimum_config": false,
7920
8289
  "create": false,
@@ -7932,6 +8301,8 @@
7932
8301
  "x-displayname": "Labels",
7933
8302
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
7934
8303
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
8304
+ "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.",
8305
+ "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).",
7935
8306
  "x-f5xc-required-for": {
7936
8307
  "minimum_config": false,
7937
8308
  "create": false,
@@ -7945,6 +8316,8 @@
7945
8316
  "title": "Modification_timestamp.",
7946
8317
  "format": "date-time",
7947
8318
  "x-displayname": "Modification Timestamp.",
8319
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
8320
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
7948
8321
  "minLength": 0,
7949
8322
  "maxLength": 1024,
7950
8323
  "x-f5xc-required-for": {
@@ -7963,6 +8336,8 @@
7963
8336
  "x-displayname": "Object Index.",
7964
8337
  "x-ves-example": "0",
7965
8338
  "x-f5xc-example": "0",
8339
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
8340
+ "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.",
7966
8341
  "minimum": 0,
7967
8342
  "maximum": 2147483647,
7968
8343
  "x-f5xc-required-for": {
@@ -7983,6 +8358,8 @@
7983
8358
  "x-displayname": "Tenant",
7984
8359
  "x-ves-example": "Example-corp.",
7985
8360
  "x-f5xc-example": "example-corp",
8361
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
8362
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
7986
8363
  "minLength": 0,
7987
8364
  "maxLength": 18,
7988
8365
  "x-f5xc-required-for": {
@@ -7994,7 +8371,7 @@
7994
8371
  "x-field-mutability": "read-only",
7995
8372
  "x-original-maxLength": 1024,
7996
8373
  "x-reconciled-from-discovery": true,
7997
- "x-reconciled-at": "2026-01-05T14:38:10.108511+00:00"
8374
+ "x-reconciled-at": "2026-01-07T15:28:26.165492+00:00"
7998
8375
  },
7999
8376
  "uid": {
8000
8377
  "type": "string",
@@ -8003,6 +8380,8 @@
8003
8380
  "x-displayname": "UID",
8004
8381
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
8005
8382
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
8383
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
8384
+ "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.",
8006
8385
  "minLength": 0,
8007
8386
  "maxLength": 36,
8008
8387
  "x-f5xc-required-for": {
@@ -8015,9 +8394,11 @@
8015
8394
  "x-original-maxLength": 1024,
8016
8395
  "format": "uuid",
8017
8396
  "x-reconciled-from-discovery": true,
8018
- "x-reconciled-at": "2026-01-05T14:38:10.108517+00:00"
8397
+ "x-reconciled-at": "2026-01-07T15:28:26.165497+00:00"
8019
8398
  }
8020
8399
  },
8400
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
8401
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
8021
8402
  "x-f5xc-minimum-configuration": {
8022
8403
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
8023
8404
  "required_fields": [
@@ -8051,6 +8432,8 @@
8051
8432
  "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.",
8052
8433
  "title": "Key",
8053
8434
  "x-f5xc-example": "key_pem",
8435
+ "x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
8436
+ "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.",
8054
8437
  "minLength": 0,
8055
8438
  "maxLength": 16,
8056
8439
  "x-f5xc-required-for": {
@@ -8061,13 +8444,14 @@
8061
8444
  },
8062
8445
  "x-original-maxLength": 1024,
8063
8446
  "x-reconciled-from-discovery": true,
8064
- "x-reconciled-at": "2026-01-05T14:38:10.108522+00:00"
8447
+ "x-reconciled-at": "2026-01-07T15:28:26.165502+00:00"
8065
8448
  },
8066
8449
  "location": {
8067
8450
  "type": "string",
8068
8451
  "description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
8069
8452
  "title": "Location",
8070
8453
  "x-f5xc-example": "v1/data/vhost_key",
8454
+ "x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
8071
8455
  "minLength": 0,
8072
8456
  "maxLength": 4,
8073
8457
  "x-f5xc-required-for": {
@@ -8078,13 +8462,15 @@
8078
8462
  },
8079
8463
  "x-original-maxLength": 1024,
8080
8464
  "x-reconciled-from-discovery": true,
8081
- "x-reconciled-at": "2026-01-05T14:38:10.108526+00:00"
8465
+ "x-reconciled-at": "2026-01-07T15:28:26.165518+00:00"
8082
8466
  },
8083
8467
  "provider": {
8084
8468
  "type": "string",
8085
8469
  "description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
8086
8470
  "title": "Provider",
8087
8471
  "x-f5xc-example": "vault-vh-provider",
8472
+ "x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
8473
+ "x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
8088
8474
  "minLength": 0,
8089
8475
  "maxLength": 8,
8090
8476
  "x-f5xc-required-for": {
@@ -8095,7 +8481,7 @@
8095
8481
  },
8096
8482
  "x-original-maxLength": 1024,
8097
8483
  "x-reconciled-from-discovery": true,
8098
- "x-reconciled-at": "2026-01-05T14:38:10.108530+00:00"
8484
+ "x-reconciled-at": "2026-01-07T15:28:26.165522+00:00"
8099
8485
  },
8100
8486
  "secret_encoding": {
8101
8487
  "$ref": "#/components/schemas/schemaSecretEncodingType"
@@ -8106,6 +8492,8 @@
8106
8492
  "title": "Version",
8107
8493
  "format": "int64",
8108
8494
  "x-f5xc-example": "1",
8495
+ "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.",
8496
+ "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.",
8109
8497
  "minimum": 0,
8110
8498
  "maximum": 2147483647,
8111
8499
  "x-f5xc-required-for": {
@@ -8117,9 +8505,11 @@
8117
8505
  "maxLength": 1,
8118
8506
  "minLength": 1,
8119
8507
  "x-reconciled-from-discovery": true,
8120
- "x-reconciled-at": "2026-01-05T14:38:10.108537+00:00"
8508
+ "x-reconciled-at": "2026-01-07T15:28:26.165529+00:00"
8121
8509
  }
8122
8510
  },
8511
+ "x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
8512
+ "x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
8123
8513
  "x-f5xc-minimum-configuration": {
8124
8514
  "description": "Minimum configuration for schemaVaultSecretInfoType",
8125
8515
  "required_fields": [
@@ -8160,7 +8550,7 @@
8160
8550
  },
8161
8551
  "x-original-maxLength": 1024,
8162
8552
  "x-reconciled-from-discovery": true,
8163
- "x-reconciled-at": "2026-01-05T14:38:10.108542+00:00"
8553
+ "x-reconciled-at": "2026-01-07T15:28:26.165534+00:00"
8164
8554
  },
8165
8555
  "name": {
8166
8556
  "type": "string",
@@ -8169,6 +8559,8 @@
8169
8559
  "x-displayname": "Name",
8170
8560
  "x-ves-example": "Contactus-route.",
8171
8561
  "x-f5xc-example": "contactus-route",
8562
+ "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.",
8563
+ "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.",
8172
8564
  "minLength": 0,
8173
8565
  "maxLength": 16,
8174
8566
  "x-f5xc-required-for": {
@@ -8179,7 +8571,7 @@
8179
8571
  },
8180
8572
  "x-original-maxLength": 1024,
8181
8573
  "x-reconciled-from-discovery": true,
8182
- "x-reconciled-at": "2026-01-05T14:38:10.108546+00:00"
8574
+ "x-reconciled-at": "2026-01-07T15:28:26.165538+00:00"
8183
8575
  },
8184
8576
  "namespace": {
8185
8577
  "type": "string",
@@ -8188,6 +8580,8 @@
8188
8580
  "x-displayname": "Namespace",
8189
8581
  "x-ves-example": "Ns1",
8190
8582
  "x-f5xc-example": "ns1",
8583
+ "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.",
8584
+ "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.",
8191
8585
  "minLength": 0,
8192
8586
  "maxLength": 6,
8193
8587
  "x-f5xc-required-for": {
@@ -8198,7 +8592,7 @@
8198
8592
  },
8199
8593
  "x-original-maxLength": 1024,
8200
8594
  "x-reconciled-from-discovery": true,
8201
- "x-reconciled-at": "2026-01-05T14:38:10.108551+00:00"
8595
+ "x-reconciled-at": "2026-01-07T15:28:26.165542+00:00"
8202
8596
  },
8203
8597
  "uid": {
8204
8598
  "type": "string",
@@ -8219,9 +8613,10 @@
8219
8613
  "x-original-maxLength": 1024,
8220
8614
  "format": "uuid",
8221
8615
  "x-reconciled-from-discovery": true,
8222
- "x-reconciled-at": "2026-01-05T14:38:10.108555+00:00"
8616
+ "x-reconciled-at": "2026-01-07T15:28:26.165546+00:00"
8223
8617
  }
8224
8618
  },
8619
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
8225
8620
  "x-f5xc-minimum-configuration": {
8226
8621
  "description": "Minimum configuration for schemaViewRefType",
8227
8622
  "required_fields": [
@@ -8247,6 +8642,7 @@
8247
8642
  "description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
8248
8643
  "title": "Name",
8249
8644
  "x-f5xc-example": "ChargeBack-API-Key",
8645
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
8250
8646
  "minLength": 0,
8251
8647
  "maxLength": 16,
8252
8648
  "x-f5xc-required-for": {
@@ -8257,9 +8653,10 @@
8257
8653
  },
8258
8654
  "x-original-maxLength": 1024,
8259
8655
  "x-reconciled-from-discovery": true,
8260
- "x-reconciled-at": "2026-01-05T14:38:10.108560+00:00"
8656
+ "x-reconciled-at": "2026-01-07T15:28:26.165551+00:00"
8261
8657
  }
8262
8658
  },
8659
+ "x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
8263
8660
  "x-f5xc-minimum-configuration": {
8264
8661
  "description": "Minimum configuration for schemaWingmanSecretInfoType",
8265
8662
  "required_fields": [
@@ -8354,6 +8751,7 @@
8354
8751
  "ves.io.schema.rules.string.max_len": "4096",
8355
8752
  "ves.io.schema.rules.string.uri_ref": "true"
8356
8753
  },
8754
+ "x-f5xc-description-short": "Exclusive with [k8s_cluster_role_selector policy_rule_list] K8s YAML for ClusterRole.",
8357
8755
  "minLength": 0,
8358
8756
  "x-f5xc-required-for": {
8359
8757
  "minimum_config": false,
@@ -8363,6 +8761,8 @@
8363
8761
  }
8364
8762
  }
8365
8763
  },
8764
+ "x-f5xc-description-short": "Create k8s_cluster_role will create the object in the storage backend for namespace metadata.namespace.",
8765
+ "x-f5xc-description-medium": "Create k8s_cluster_role will create the object in the storage backend for namespace metadata.namespace.",
8366
8766
  "x-f5xc-minimum-configuration": {
8367
8767
  "description": "Minimum configuration for k8s_cluster_roleCreateSpecType",
8368
8768
  "required_fields": [
@@ -8390,6 +8790,7 @@
8390
8790
  "title": "Fail_if_referred.",
8391
8791
  "format": "boolean",
8392
8792
  "x-displayname": "Fail-If-Referred.",
8793
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
8393
8794
  "x-f5xc-required-for": {
8394
8795
  "minimum_config": false,
8395
8796
  "create": false,
@@ -8414,7 +8815,7 @@
8414
8815
  },
8415
8816
  "x-original-maxLength": 1024,
8416
8817
  "x-reconciled-from-discovery": true,
8417
- "x-reconciled-at": "2026-01-05T14:38:31.953343+00:00"
8818
+ "x-reconciled-at": "2026-01-07T15:28:51.212118+00:00"
8418
8819
  },
8419
8820
  "namespace": {
8420
8821
  "type": "string",
@@ -8423,6 +8824,7 @@
8423
8824
  "x-displayname": "Namespace",
8424
8825
  "x-ves-example": "Ns1",
8425
8826
  "x-f5xc-example": "ns1",
8827
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
8426
8828
  "minLength": 0,
8427
8829
  "maxLength": 6,
8428
8830
  "x-f5xc-required-for": {
@@ -8433,7 +8835,7 @@
8433
8835
  },
8434
8836
  "x-original-maxLength": 1024,
8435
8837
  "x-reconciled-from-discovery": true,
8436
- "x-reconciled-at": "2026-01-05T14:38:31.953350+00:00"
8838
+ "x-reconciled-at": "2026-01-07T15:28:51.212125+00:00"
8437
8839
  }
8438
8840
  },
8439
8841
  "x-f5xc-minimum-configuration": {
@@ -8468,6 +8870,7 @@
8468
8870
  "$ref": "#/components/schemas/schemaObjectRefType"
8469
8871
  },
8470
8872
  "x-displayname": "Deleted Referred Objects.",
8873
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
8471
8874
  "x-f5xc-required-for": {
8472
8875
  "minimum_config": false,
8473
8876
  "create": false,
@@ -8483,6 +8886,7 @@
8483
8886
  "$ref": "#/components/schemas/schemaObjectRefType"
8484
8887
  },
8485
8888
  "x-displayname": "Disabled Referred Objects.",
8889
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
8486
8890
  "x-f5xc-required-for": {
8487
8891
  "minimum_config": false,
8488
8892
  "create": false,
@@ -8501,6 +8905,7 @@
8501
8905
  "$ref": "#/components/schemas/schemaObjectRefType"
8502
8906
  },
8503
8907
  "x-displayname": "Referring Objects.",
8908
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
8504
8909
  "x-f5xc-required-for": {
8505
8910
  "minimum_config": false,
8506
8911
  "create": false,
@@ -8522,6 +8927,8 @@
8522
8927
  "$ref": "#/components/schemas/k8s_cluster_roleStatusObject"
8523
8928
  },
8524
8929
  "x-displayname": "Status",
8930
+ "x-f5xc-example": "active",
8931
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
8525
8932
  "x-f5xc-required-for": {
8526
8933
  "minimum_config": false,
8527
8934
  "create": false,
@@ -8531,7 +8938,7 @@
8531
8938
  "maxLength": 17,
8532
8939
  "minLength": 17,
8533
8940
  "x-reconciled-from-discovery": true,
8534
- "x-reconciled-at": "2026-01-05T14:38:31.953367+00:00"
8941
+ "x-reconciled-at": "2026-01-07T15:28:51.212141+00:00"
8535
8942
  },
8536
8943
  "system_metadata": {
8537
8944
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -8571,6 +8978,8 @@
8571
8978
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
8572
8979
  ],
8573
8980
  "default": "GET_RSP_FORMAT_DEFAULT",
8981
+ "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...",
8982
+ "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...",
8574
8983
  "x-f5xc-minimum-configuration": {
8575
8984
  "description": "Minimum configuration for k8s_cluster_roleGetResponseFormatCode",
8576
8985
  "required_fields": [],
@@ -8608,6 +9017,7 @@
8608
9017
  "ves.io.schema.rules.string.max_len": "4096",
8609
9018
  "ves.io.schema.rules.string.uri_ref": "true"
8610
9019
  },
9020
+ "x-f5xc-description-short": "Exclusive with [k8s_cluster_role_selector policy_rule_list] K8s YAML for ClusterRole.",
8611
9021
  "minLength": 0,
8612
9022
  "x-f5xc-required-for": {
8613
9023
  "minimum_config": false,
@@ -8617,6 +9027,7 @@
8617
9027
  }
8618
9028
  }
8619
9029
  },
9030
+ "x-f5xc-description-short": "GET k8s_cluster_role will GET the object from the storage backend for namespace metadata.namespace.",
8620
9031
  "x-f5xc-minimum-configuration": {
8621
9032
  "description": "Minimum configuration for k8s_cluster_roleGetSpecType",
8622
9033
  "required_fields": [
@@ -8646,6 +9057,7 @@
8646
9057
  "$ref": "#/components/schemas/schemaErrorType"
8647
9058
  },
8648
9059
  "x-displayname": "Errors",
9060
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
8649
9061
  "x-f5xc-required-for": {
8650
9062
  "minimum_config": false,
8651
9063
  "create": false,
@@ -8661,6 +9073,8 @@
8661
9073
  "$ref": "#/components/schemas/k8s_cluster_roleListResponseItem"
8662
9074
  },
8663
9075
  "x-displayname": "Items",
9076
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
9077
+ "x-f5xc-description-short": "Items represents the collection in response.",
8664
9078
  "x-f5xc-required-for": {
8665
9079
  "minimum_config": false,
8666
9080
  "create": false,
@@ -8694,6 +9108,8 @@
8694
9108
  "description": "The set of annotations present on this k8s_cluster_role.",
8695
9109
  "title": "Annotations.",
8696
9110
  "x-displayname": "Annotations.",
9111
+ "x-f5xc-example": "{\"key\": \"value\"}",
9112
+ "x-f5xc-description-short": "The set of annotations present on this k8s_cluster_role.",
8697
9113
  "x-f5xc-required-for": {
8698
9114
  "minimum_config": false,
8699
9115
  "create": false,
@@ -8706,6 +9122,7 @@
8706
9122
  "description": "The description set for this k8s_cluster_role.",
8707
9123
  "title": "Description.",
8708
9124
  "x-displayname": "Description.",
9125
+ "x-f5xc-description-short": "The description set for this k8s_cluster_role.",
8709
9126
  "minLength": 0,
8710
9127
  "maxLength": 0,
8711
9128
  "x-f5xc-required-for": {
@@ -8716,7 +9133,7 @@
8716
9133
  },
8717
9134
  "x-original-maxLength": 1024,
8718
9135
  "x-reconciled-from-discovery": true,
8719
- "x-reconciled-at": "2026-01-05T14:38:31.953385+00:00"
9136
+ "x-reconciled-at": "2026-01-07T15:28:51.212159+00:00"
8720
9137
  },
8721
9138
  "disabled": {
8722
9139
  "type": "boolean",
@@ -8724,6 +9141,8 @@
8724
9141
  "title": "Disabled",
8725
9142
  "format": "boolean",
8726
9143
  "x-displayname": "Disabled",
9144
+ "x-f5xc-example": "True",
9145
+ "x-f5xc-description-short": "Value of true indicates k8s_cluster_role is administratively disabled.",
8727
9146
  "x-f5xc-required-for": {
8728
9147
  "minimum_config": false,
8729
9148
  "create": false,
@@ -8739,6 +9158,8 @@
8739
9158
  "description": "The set of labels present on this k8s_cluster_role.",
8740
9159
  "title": "Labels",
8741
9160
  "x-displayname": "Labels",
9161
+ "x-f5xc-example": "{\"key\": \"value\"}",
9162
+ "x-f5xc-description-short": "The set of labels present on this k8s_cluster_role.",
8742
9163
  "x-f5xc-required-for": {
8743
9164
  "minimum_config": false,
8744
9165
  "create": false,
@@ -8766,7 +9187,7 @@
8766
9187
  },
8767
9188
  "x-original-maxLength": 1024,
8768
9189
  "x-reconciled-from-discovery": true,
8769
- "x-reconciled-at": "2026-01-05T14:38:31.953396+00:00"
9190
+ "x-reconciled-at": "2026-01-07T15:28:51.212169+00:00"
8770
9191
  },
8771
9192
  "namespace": {
8772
9193
  "type": "string",
@@ -8785,7 +9206,7 @@
8785
9206
  },
8786
9207
  "x-original-maxLength": 1024,
8787
9208
  "x-reconciled-from-discovery": true,
8788
- "x-reconciled-at": "2026-01-05T14:38:31.953401+00:00"
9209
+ "x-reconciled-at": "2026-01-07T15:28:51.212174+00:00"
8789
9210
  },
8790
9211
  "owner_view": {
8791
9212
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -8798,6 +9219,7 @@
8798
9219
  "$ref": "#/components/schemas/k8s_cluster_roleStatusObject"
8799
9220
  },
8800
9221
  "x-displayname": "Status",
9222
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
8801
9223
  "x-f5xc-required-for": {
8802
9224
  "minimum_config": false,
8803
9225
  "create": false,
@@ -8826,7 +9248,7 @@
8826
9248
  "x-field-mutability": "read-only",
8827
9249
  "x-original-maxLength": 1024,
8828
9250
  "x-reconciled-from-discovery": true,
8829
- "x-reconciled-at": "2026-01-05T14:38:31.953409+00:00"
9251
+ "x-reconciled-at": "2026-01-07T15:28:51.212182+00:00"
8830
9252
  },
8831
9253
  "uid": {
8832
9254
  "type": "string",
@@ -8835,6 +9257,7 @@
8835
9257
  "x-displayname": "UID",
8836
9258
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
8837
9259
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
9260
+ "x-f5xc-description-short": "The unique uid of this k8s_cluster_role.",
8838
9261
  "minLength": 0,
8839
9262
  "maxLength": 36,
8840
9263
  "x-f5xc-required-for": {
@@ -8847,9 +9270,11 @@
8847
9270
  "x-original-maxLength": 1024,
8848
9271
  "format": "uuid",
8849
9272
  "x-reconciled-from-discovery": true,
8850
- "x-reconciled-at": "2026-01-05T14:38:31.953415+00:00"
9273
+ "x-reconciled-at": "2026-01-07T15:28:51.212188+00:00"
8851
9274
  }
8852
9275
  },
9276
+ "x-f5xc-description-short": "By default a summary of k8s_cluster_role is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
9277
+ "x-f5xc-description-medium": "By default a summary of k8s_cluster_role is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
8853
9278
  "x-f5xc-minimum-configuration": {
8854
9279
  "description": "Minimum configuration for k8s_cluster_roleListResponseItem",
8855
9280
  "required_fields": [
@@ -8909,6 +9334,7 @@
8909
9334
  "ves.io.schema.rules.repeated.min_items": "1",
8910
9335
  "ves.io.schema.rules.repeated.unique": "true"
8911
9336
  },
9337
+ "x-f5xc-description-short": "Allowed URL(s) that do not represent any K8s resource. URL can be suffix or regex.",
8912
9338
  "x-f5xc-required-for": {
8913
9339
  "minimum_config": false,
8914
9340
  "create": false,
@@ -8944,6 +9370,7 @@
8944
9370
  "ves.io.schema.rules.repeated.min_items": "1",
8945
9371
  "ves.io.schema.rules.repeated.unique": "true"
8946
9372
  },
9373
+ "x-f5xc-description-short": "Allowed list of verbs(operations) on resources. Use VerbAll for all operations Required: YES.",
8947
9374
  "x-f5xc-required-for": {
8948
9375
  "minimum_config": false,
8949
9376
  "create": false,
@@ -8952,6 +9379,7 @@
8952
9379
  }
8953
9380
  }
8954
9381
  },
9382
+ "x-f5xc-description-short": "Permissions for URL(s) that do not represent K8s resource.",
8955
9383
  "x-f5xc-minimum-configuration": {
8956
9384
  "description": "Minimum configuration for k8s_cluster_roleNonResourceURLListType",
8957
9385
  "required_fields": [
@@ -8995,6 +9423,8 @@
8995
9423
  "ves.io.schema.rules.repeated.min_items": "1",
8996
9424
  "ves.io.schema.rules.repeated.unique": "true"
8997
9425
  },
9426
+ "x-f5xc-example": "{\"key\": \"value\"}",
9427
+ "x-f5xc-description-short": "List of rules for role permissions Required: YES.",
8998
9428
  "x-f5xc-required-for": {
8999
9429
  "minimum_config": false,
9000
9430
  "create": false,
@@ -9110,6 +9540,7 @@
9110
9540
  "ves.io.schema.rules.string.max_len": "4096",
9111
9541
  "ves.io.schema.rules.string.uri_ref": "true"
9112
9542
  },
9543
+ "x-f5xc-description-short": "Exclusive with [k8s_cluster_role_selector policy_rule_list] K8s YAML for ClusterRole.",
9113
9544
  "minLength": 0,
9114
9545
  "x-f5xc-required-for": {
9115
9546
  "minimum_config": false,
@@ -9119,6 +9550,8 @@
9119
9550
  }
9120
9551
  }
9121
9552
  },
9553
+ "x-f5xc-description-short": "Replacing an k8s_cluster_role object will update the object by replacing the existing spec with the provided one.",
9554
+ "x-f5xc-description-medium": "Replacing an k8s_cluster_role 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.",
9122
9555
  "x-f5xc-minimum-configuration": {
9123
9556
  "description": "Minimum configuration for k8s_cluster_roleReplaceSpecType",
9124
9557
  "required_fields": [
@@ -9168,6 +9601,8 @@
9168
9601
  "ves.io.schema.rules.repeated.min_items": "1",
9169
9602
  "ves.io.schema.rules.repeated.unique": "true"
9170
9603
  },
9604
+ "x-f5xc-description-short": "Allowed list of API group that contains resources, all resources of a given API group Required: YES.",
9605
+ "x-f5xc-description-medium": "Allowed list of API group that contains resources, all resources of a given API group Required: YES.",
9171
9606
  "x-f5xc-required-for": {
9172
9607
  "minimum_config": false,
9173
9608
  "create": false,
@@ -9197,6 +9632,7 @@
9197
9632
  "ves.io.schema.rules.repeated.max_items": "16",
9198
9633
  "ves.io.schema.rules.repeated.unique": "true"
9199
9634
  },
9635
+ "x-f5xc-description-short": "Allowed list of resource instances within the resource types.",
9200
9636
  "x-f5xc-required-for": {
9201
9637
  "minimum_config": false,
9202
9638
  "create": false,
@@ -9232,6 +9668,7 @@
9232
9668
  "ves.io.schema.rules.repeated.min_items": "1",
9233
9669
  "ves.io.schema.rules.repeated.unique": "true"
9234
9670
  },
9671
+ "x-f5xc-description-short": "Allowed list of resource types within the API groups. Required: YES.",
9235
9672
  "x-f5xc-required-for": {
9236
9673
  "minimum_config": false,
9237
9674
  "create": false,
@@ -9267,6 +9704,7 @@
9267
9704
  "ves.io.schema.rules.repeated.min_items": "1",
9268
9705
  "ves.io.schema.rules.repeated.unique": "true"
9269
9706
  },
9707
+ "x-f5xc-description-short": "Allowed list of verbs(operations) on resources. Use * for all operations Required: YES.",
9270
9708
  "x-f5xc-required-for": {
9271
9709
  "minimum_config": false,
9272
9710
  "create": false,
@@ -9275,6 +9713,7 @@
9275
9713
  }
9276
9714
  }
9277
9715
  },
9716
+ "x-f5xc-description-short": "List of resources in terms of API groups/resource types/resource instances and verbs allowed.",
9278
9717
  "x-f5xc-minimum-configuration": {
9279
9718
  "description": "Minimum configuration for k8s_cluster_roleResourceListType",
9280
9719
  "required_fields": [
@@ -9331,6 +9770,7 @@
9331
9770
  }
9332
9771
  }
9333
9772
  },
9773
+ "x-f5xc-description-short": "Most recently observed status of object.",
9334
9774
  "x-f5xc-minimum-configuration": {
9335
9775
  "description": "Minimum configuration for k8s_cluster_roleStatusObject",
9336
9776
  "required_fields": [
@@ -9380,6 +9820,7 @@
9380
9820
  "ves.io.schema.rules.repeated.items.string.min_len": "1",
9381
9821
  "ves.io.schema.rules.repeated.max_items": "1"
9382
9822
  },
9823
+ "x-f5xc-description-short": "Expressions contains the Kubernetes style label expression for selections. Required: YES.",
9383
9824
  "x-f5xc-required-for": {
9384
9825
  "minimum_config": false,
9385
9826
  "create": false,
@@ -9388,6 +9829,8 @@
9388
9829
  }
9389
9830
  }
9390
9831
  },
9832
+ "x-f5xc-description-short": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the...",
9833
+ "x-f5xc-description-medium": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects.",
9391
9834
  "x-f5xc-minimum-configuration": {
9392
9835
  "description": "Minimum configuration for schemaLabelSelectorType",
9393
9836
  "required_fields": [
@@ -9414,6 +9857,8 @@
9414
9857
  "x-displayname": "Kind",
9415
9858
  "x-ves-example": "Virtual_site.",
9416
9859
  "x-f5xc-example": "virtual_site",
9860
+ "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\")",
9861
+ "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\").",
9417
9862
  "minLength": 0,
9418
9863
  "maxLength": 14,
9419
9864
  "x-f5xc-required-for": {
@@ -9425,7 +9870,7 @@
9425
9870
  "readOnly": true,
9426
9871
  "x-original-maxLength": 1024,
9427
9872
  "x-reconciled-from-discovery": true,
9428
- "x-reconciled-at": "2026-01-05T14:38:32.328360+00:00"
9873
+ "x-reconciled-at": "2026-01-07T15:28:51.642244+00:00"
9429
9874
  },
9430
9875
  "name": {
9431
9876
  "type": "string",
@@ -9434,6 +9879,8 @@
9434
9879
  "x-displayname": "Name",
9435
9880
  "x-ves-example": "Contactus-route.",
9436
9881
  "x-f5xc-example": "contactus-route",
9882
+ "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.",
9883
+ "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.",
9437
9884
  "minLength": 0,
9438
9885
  "maxLength": 16,
9439
9886
  "x-f5xc-required-for": {
@@ -9444,7 +9891,7 @@
9444
9891
  },
9445
9892
  "x-original-maxLength": 1024,
9446
9893
  "x-reconciled-from-discovery": true,
9447
- "x-reconciled-at": "2026-01-05T14:38:32.328368+00:00"
9894
+ "x-reconciled-at": "2026-01-07T15:28:51.642251+00:00"
9448
9895
  },
9449
9896
  "namespace": {
9450
9897
  "type": "string",
@@ -9453,6 +9900,8 @@
9453
9900
  "x-displayname": "Namespace",
9454
9901
  "x-ves-example": "Ns1",
9455
9902
  "x-f5xc-example": "ns1",
9903
+ "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.",
9904
+ "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.",
9456
9905
  "minLength": 0,
9457
9906
  "maxLength": 6,
9458
9907
  "x-f5xc-required-for": {
@@ -9463,7 +9912,7 @@
9463
9912
  },
9464
9913
  "x-original-maxLength": 1024,
9465
9914
  "x-reconciled-from-discovery": true,
9466
- "x-reconciled-at": "2026-01-05T14:38:32.328373+00:00"
9915
+ "x-reconciled-at": "2026-01-07T15:28:51.642256+00:00"
9467
9916
  },
9468
9917
  "tenant": {
9469
9918
  "type": "string",
@@ -9472,6 +9921,8 @@
9472
9921
  "x-displayname": "Tenant",
9473
9922
  "x-ves-example": "Example-corp.",
9474
9923
  "x-f5xc-example": "example-corp",
9924
+ "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.",
9925
+ "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.",
9475
9926
  "minLength": 0,
9476
9927
  "maxLength": 18,
9477
9928
  "x-f5xc-required-for": {
@@ -9484,7 +9935,7 @@
9484
9935
  "x-field-mutability": "read-only",
9485
9936
  "x-original-maxLength": 1024,
9486
9937
  "x-reconciled-from-discovery": true,
9487
- "x-reconciled-at": "2026-01-05T14:38:32.328378+00:00"
9938
+ "x-reconciled-at": "2026-01-07T15:28:51.642261+00:00"
9488
9939
  },
9489
9940
  "uid": {
9490
9941
  "type": "string",
@@ -9493,6 +9944,8 @@
9493
9944
  "x-displayname": "UID",
9494
9945
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
9495
9946
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
9947
+ "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.",
9948
+ "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.",
9496
9949
  "minLength": 0,
9497
9950
  "maxLength": 36,
9498
9951
  "x-f5xc-required-for": {
@@ -9506,9 +9959,11 @@
9506
9959
  "x-original-maxLength": 1024,
9507
9960
  "format": "uuid",
9508
9961
  "x-reconciled-from-discovery": true,
9509
- "x-reconciled-at": "2026-01-05T14:38:32.328384+00:00"
9962
+ "x-reconciled-at": "2026-01-07T15:28:51.642267+00:00"
9510
9963
  }
9511
9964
  },
9965
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
9966
+ "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...",
9512
9967
  "x-f5xc-minimum-configuration": {
9513
9968
  "description": "Minimum configuration for ioschemaObjectRefType",
9514
9969
  "required_fields": [
@@ -9612,6 +10067,7 @@
9612
10067
  "ves.io.schema.rules.repeated.min_items": "1",
9613
10068
  "ves.io.schema.rules.repeated.unique": "true"
9614
10069
  },
10070
+ "x-f5xc-description-short": "List of subjects (user, group or service account) to which this role is bound Required: YES.",
9615
10071
  "x-f5xc-required-for": {
9616
10072
  "minimum_config": false,
9617
10073
  "create": false,
@@ -9620,6 +10076,8 @@
9620
10076
  }
9621
10077
  }
9622
10078
  },
10079
+ "x-f5xc-description-short": "Create k8s_cluster_role_binding will create the object in the storage backend for namespace metadata.namespace.",
10080
+ "x-f5xc-description-medium": "Create k8s_cluster_role_binding will create the object in the storage backend for namespace metadata.namespace.",
9623
10081
  "x-f5xc-minimum-configuration": {
9624
10082
  "description": "Minimum configuration for k8s_cluster_role_bindingCreateSpecType",
9625
10083
  "required_fields": [
@@ -9646,6 +10104,7 @@
9646
10104
  "title": "Fail_if_referred.",
9647
10105
  "format": "boolean",
9648
10106
  "x-displayname": "Fail-If-Referred.",
10107
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
9649
10108
  "x-f5xc-required-for": {
9650
10109
  "minimum_config": false,
9651
10110
  "create": false,
@@ -9670,7 +10129,7 @@
9670
10129
  },
9671
10130
  "x-original-maxLength": 1024,
9672
10131
  "x-reconciled-from-discovery": true,
9673
- "x-reconciled-at": "2026-01-05T14:38:32.328404+00:00"
10132
+ "x-reconciled-at": "2026-01-07T15:28:51.642284+00:00"
9674
10133
  },
9675
10134
  "namespace": {
9676
10135
  "type": "string",
@@ -9679,6 +10138,7 @@
9679
10138
  "x-displayname": "Namespace",
9680
10139
  "x-ves-example": "Ns1",
9681
10140
  "x-f5xc-example": "ns1",
10141
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
9682
10142
  "minLength": 0,
9683
10143
  "maxLength": 6,
9684
10144
  "x-f5xc-required-for": {
@@ -9689,7 +10149,7 @@
9689
10149
  },
9690
10150
  "x-original-maxLength": 1024,
9691
10151
  "x-reconciled-from-discovery": true,
9692
- "x-reconciled-at": "2026-01-05T14:38:32.328408+00:00"
10152
+ "x-reconciled-at": "2026-01-07T15:28:51.642289+00:00"
9693
10153
  }
9694
10154
  },
9695
10155
  "x-f5xc-minimum-configuration": {
@@ -9724,6 +10184,7 @@
9724
10184
  "$ref": "#/components/schemas/ioschemaObjectRefType"
9725
10185
  },
9726
10186
  "x-displayname": "Deleted Referred Objects.",
10187
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
9727
10188
  "x-f5xc-required-for": {
9728
10189
  "minimum_config": false,
9729
10190
  "create": false,
@@ -9739,6 +10200,7 @@
9739
10200
  "$ref": "#/components/schemas/ioschemaObjectRefType"
9740
10201
  },
9741
10202
  "x-displayname": "Disabled Referred Objects.",
10203
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
9742
10204
  "x-f5xc-required-for": {
9743
10205
  "minimum_config": false,
9744
10206
  "create": false,
@@ -9757,6 +10219,7 @@
9757
10219
  "$ref": "#/components/schemas/ioschemaObjectRefType"
9758
10220
  },
9759
10221
  "x-displayname": "Referring Objects.",
10222
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
9760
10223
  "x-f5xc-required-for": {
9761
10224
  "minimum_config": false,
9762
10225
  "create": false,
@@ -9778,6 +10241,8 @@
9778
10241
  "$ref": "#/components/schemas/k8s_cluster_role_bindingStatusObject"
9779
10242
  },
9780
10243
  "x-displayname": "Status",
10244
+ "x-f5xc-example": "active",
10245
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
9781
10246
  "x-f5xc-required-for": {
9782
10247
  "minimum_config": false,
9783
10248
  "create": false,
@@ -9787,7 +10252,7 @@
9787
10252
  "maxLength": 17,
9788
10253
  "minLength": 17,
9789
10254
  "x-reconciled-from-discovery": true,
9790
- "x-reconciled-at": "2026-01-05T14:38:32.328425+00:00"
10255
+ "x-reconciled-at": "2026-01-07T15:28:51.642303+00:00"
9791
10256
  },
9792
10257
  "system_metadata": {
9793
10258
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -9827,6 +10292,8 @@
9827
10292
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
9828
10293
  ],
9829
10294
  "default": "GET_RSP_FORMAT_DEFAULT",
10295
+ "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...",
10296
+ "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...",
9830
10297
  "x-f5xc-minimum-configuration": {
9831
10298
  "description": "Minimum configuration for k8s_cluster_role_bindingGetResponseFormatCode",
9832
10299
  "required_fields": [],
@@ -9869,6 +10336,7 @@
9869
10336
  "ves.io.schema.rules.repeated.min_items": "1",
9870
10337
  "ves.io.schema.rules.repeated.unique": "true"
9871
10338
  },
10339
+ "x-f5xc-description-short": "List of subjects (user, group or service account) to which this role is bound Required: YES.",
9872
10340
  "x-f5xc-required-for": {
9873
10341
  "minimum_config": false,
9874
10342
  "create": false,
@@ -9877,6 +10345,8 @@
9877
10345
  }
9878
10346
  }
9879
10347
  },
10348
+ "x-f5xc-description-short": "GET k8s_cluster_role_binding will GET the object from the storage backend for namespace metadata.namespace.",
10349
+ "x-f5xc-description-medium": "GET k8s_cluster_role_binding will GET the object from the storage backend for namespace metadata.namespace.",
9880
10350
  "x-f5xc-minimum-configuration": {
9881
10351
  "description": "Minimum configuration for k8s_cluster_role_bindingGetSpecType",
9882
10352
  "required_fields": [
@@ -9905,6 +10375,7 @@
9905
10375
  "$ref": "#/components/schemas/schemaErrorType"
9906
10376
  },
9907
10377
  "x-displayname": "Errors",
10378
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
9908
10379
  "x-f5xc-required-for": {
9909
10380
  "minimum_config": false,
9910
10381
  "create": false,
@@ -9920,6 +10391,8 @@
9920
10391
  "$ref": "#/components/schemas/k8s_cluster_role_bindingListResponseItem"
9921
10392
  },
9922
10393
  "x-displayname": "Items",
10394
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
10395
+ "x-f5xc-description-short": "Items represents the collection in response.",
9923
10396
  "x-f5xc-required-for": {
9924
10397
  "minimum_config": false,
9925
10398
  "create": false,
@@ -9953,6 +10426,8 @@
9953
10426
  "description": "The set of annotations present on this k8s_cluster_role_binding.",
9954
10427
  "title": "Annotations.",
9955
10428
  "x-displayname": "Annotations.",
10429
+ "x-f5xc-example": "{\"key\": \"value\"}",
10430
+ "x-f5xc-description-short": "The set of annotations present on this k8s_cluster_role_binding.",
9956
10431
  "x-f5xc-required-for": {
9957
10432
  "minimum_config": false,
9958
10433
  "create": false,
@@ -9965,6 +10440,7 @@
9965
10440
  "description": "The description set for this k8s_cluster_role_binding.",
9966
10441
  "title": "Description.",
9967
10442
  "x-displayname": "Description.",
10443
+ "x-f5xc-description-short": "The description set for this k8s_cluster_role_binding.",
9968
10444
  "minLength": 0,
9969
10445
  "maxLength": 0,
9970
10446
  "x-f5xc-required-for": {
@@ -9975,7 +10451,7 @@
9975
10451
  },
9976
10452
  "x-original-maxLength": 1024,
9977
10453
  "x-reconciled-from-discovery": true,
9978
- "x-reconciled-at": "2026-01-05T14:38:32.328441+00:00"
10454
+ "x-reconciled-at": "2026-01-07T15:28:51.642319+00:00"
9979
10455
  },
9980
10456
  "disabled": {
9981
10457
  "type": "boolean",
@@ -9983,6 +10459,8 @@
9983
10459
  "title": "Disabled",
9984
10460
  "format": "boolean",
9985
10461
  "x-displayname": "Disabled",
10462
+ "x-f5xc-example": "True",
10463
+ "x-f5xc-description-short": "Value of true indicates k8s_cluster_role_binding is administratively disabled.",
9986
10464
  "x-f5xc-required-for": {
9987
10465
  "minimum_config": false,
9988
10466
  "create": false,
@@ -9998,6 +10476,8 @@
9998
10476
  "description": "The set of labels present on this k8s_cluster_role_binding.",
9999
10477
  "title": "Labels",
10000
10478
  "x-displayname": "Labels",
10479
+ "x-f5xc-example": "{\"key\": \"value\"}",
10480
+ "x-f5xc-description-short": "The set of labels present on this k8s_cluster_role_binding.",
10001
10481
  "x-f5xc-required-for": {
10002
10482
  "minimum_config": false,
10003
10483
  "create": false,
@@ -10015,6 +10495,7 @@
10015
10495
  "x-displayname": "Name",
10016
10496
  "x-ves-example": "Name",
10017
10497
  "x-f5xc-example": "name",
10498
+ "x-f5xc-description-short": "The name of this k8s_cluster_role_binding.",
10018
10499
  "minLength": 0,
10019
10500
  "maxLength": 16,
10020
10501
  "x-f5xc-required-for": {
@@ -10025,7 +10506,7 @@
10025
10506
  },
10026
10507
  "x-original-maxLength": 1024,
10027
10508
  "x-reconciled-from-discovery": true,
10028
- "x-reconciled-at": "2026-01-05T14:38:32.328452+00:00"
10509
+ "x-reconciled-at": "2026-01-07T15:28:51.642329+00:00"
10029
10510
  },
10030
10511
  "namespace": {
10031
10512
  "type": "string",
@@ -10044,7 +10525,7 @@
10044
10525
  },
10045
10526
  "x-original-maxLength": 1024,
10046
10527
  "x-reconciled-from-discovery": true,
10047
- "x-reconciled-at": "2026-01-05T14:38:32.328456+00:00"
10528
+ "x-reconciled-at": "2026-01-07T15:28:51.642334+00:00"
10048
10529
  },
10049
10530
  "owner_view": {
10050
10531
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -10057,6 +10538,7 @@
10057
10538
  "$ref": "#/components/schemas/k8s_cluster_role_bindingStatusObject"
10058
10539
  },
10059
10540
  "x-displayname": "Status",
10541
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
10060
10542
  "x-f5xc-required-for": {
10061
10543
  "minimum_config": false,
10062
10544
  "create": false,
@@ -10085,7 +10567,7 @@
10085
10567
  "x-field-mutability": "read-only",
10086
10568
  "x-original-maxLength": 1024,
10087
10569
  "x-reconciled-from-discovery": true,
10088
- "x-reconciled-at": "2026-01-05T14:38:32.328464+00:00"
10570
+ "x-reconciled-at": "2026-01-07T15:28:51.642342+00:00"
10089
10571
  },
10090
10572
  "uid": {
10091
10573
  "type": "string",
@@ -10094,6 +10576,7 @@
10094
10576
  "x-displayname": "UID",
10095
10577
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
10096
10578
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
10579
+ "x-f5xc-description-short": "The unique uid of this k8s_cluster_role_binding.",
10097
10580
  "minLength": 0,
10098
10581
  "maxLength": 36,
10099
10582
  "x-f5xc-required-for": {
@@ -10106,9 +10589,11 @@
10106
10589
  "x-original-maxLength": 1024,
10107
10590
  "format": "uuid",
10108
10591
  "x-reconciled-from-discovery": true,
10109
- "x-reconciled-at": "2026-01-05T14:38:32.328470+00:00"
10592
+ "x-reconciled-at": "2026-01-07T15:28:51.642347+00:00"
10110
10593
  }
10111
10594
  },
10595
+ "x-f5xc-description-short": "By default a summary of k8s_cluster_role_binding is returned in 'List'.",
10596
+ "x-f5xc-description-medium": "By default a summary of k8s_cluster_role_binding is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
10112
10597
  "x-f5xc-minimum-configuration": {
10113
10598
  "description": "Minimum configuration for k8s_cluster_role_bindingListResponseItem",
10114
10599
  "required_fields": [
@@ -10205,6 +10690,7 @@
10205
10690
  "ves.io.schema.rules.repeated.min_items": "1",
10206
10691
  "ves.io.schema.rules.repeated.unique": "true"
10207
10692
  },
10693
+ "x-f5xc-description-short": "List of subjects (user, group or service account) to which this role is bound Required: YES.",
10208
10694
  "x-f5xc-required-for": {
10209
10695
  "minimum_config": false,
10210
10696
  "create": false,
@@ -10213,6 +10699,8 @@
10213
10699
  }
10214
10700
  }
10215
10701
  },
10702
+ "x-f5xc-description-short": "Replacing an k8s_cluster_role_binding object will update the object by replacing the existing spec with the provided one.",
10703
+ "x-f5xc-description-medium": "Replacing an k8s_cluster_role_binding 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.",
10216
10704
  "x-f5xc-minimum-configuration": {
10217
10705
  "description": "Minimum configuration for k8s_cluster_role_bindingReplaceSpecType",
10218
10706
  "required_fields": [
@@ -10252,6 +10740,7 @@
10252
10740
  "ves.io.schema.rules.string.max_len": "64",
10253
10741
  "ves.io.schema.rules.string.min_len": "1"
10254
10742
  },
10743
+ "x-f5xc-description-short": "Name of the service account Required: YES.",
10255
10744
  "x-f5xc-required-for": {
10256
10745
  "minimum_config": false,
10257
10746
  "create": false,
@@ -10260,7 +10749,7 @@
10260
10749
  },
10261
10750
  "x-original-maxLength": 64,
10262
10751
  "x-reconciled-from-discovery": true,
10263
- "x-reconciled-at": "2026-01-05T14:38:32.328482+00:00"
10752
+ "x-reconciled-at": "2026-01-07T15:28:51.642359+00:00"
10264
10753
  },
10265
10754
  "namespace": {
10266
10755
  "type": "string",
@@ -10282,6 +10771,7 @@
10282
10771
  "ves.io.schema.rules.string.max_len": "64",
10283
10772
  "ves.io.schema.rules.string.min_len": "1"
10284
10773
  },
10774
+ "x-f5xc-description-short": "Namespace of the service account Required: YES.",
10285
10775
  "x-f5xc-required-for": {
10286
10776
  "minimum_config": false,
10287
10777
  "create": false,
@@ -10290,7 +10780,7 @@
10290
10780
  },
10291
10781
  "x-original-maxLength": 64,
10292
10782
  "x-reconciled-from-discovery": true,
10293
- "x-reconciled-at": "2026-01-05T14:38:32.328487+00:00"
10783
+ "x-reconciled-at": "2026-01-07T15:28:51.642364+00:00"
10294
10784
  }
10295
10785
  },
10296
10786
  "x-f5xc-minimum-configuration": {
@@ -10347,6 +10837,7 @@
10347
10837
  }
10348
10838
  }
10349
10839
  },
10840
+ "x-f5xc-description-short": "Most recently observed status of object.",
10350
10841
  "x-f5xc-minimum-configuration": {
10351
10842
  "description": "Minimum configuration for k8s_cluster_role_bindingStatusObject",
10352
10843
  "required_fields": [
@@ -10386,6 +10877,7 @@
10386
10877
  "ves.io.schema.rules.string.max_len": "64",
10387
10878
  "ves.io.schema.rules.string.min_len": "1"
10388
10879
  },
10880
+ "x-f5xc-description-short": "Exclusive with [service_account user] Group ID of the user group.",
10389
10881
  "x-f5xc-required-for": {
10390
10882
  "minimum_config": false,
10391
10883
  "create": false,
@@ -10413,6 +10905,7 @@
10413
10905
  "ves.io.schema.rules.string.max_len": "64",
10414
10906
  "ves.io.schema.rules.string.min_len": "1"
10415
10907
  },
10908
+ "x-f5xc-description-short": "Exclusive with [group service_account] User ID of the user.",
10416
10909
  "x-f5xc-required-for": {
10417
10910
  "minimum_config": false,
10418
10911
  "create": false,
@@ -10462,6 +10955,8 @@
10462
10955
  "ves.io.schema.rules.string.max_bytes": "128",
10463
10956
  "ves.io.schema.rules.string.min_bytes": "1"
10464
10957
  },
10958
+ "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.",
10959
+ "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.",
10465
10960
  "x-f5xc-required-for": {
10466
10961
  "minimum_config": false,
10467
10962
  "create": false,
@@ -10470,7 +10965,7 @@
10470
10965
  },
10471
10966
  "x-original-maxLength": 128,
10472
10967
  "x-reconciled-from-discovery": true,
10473
- "x-reconciled-at": "2026-01-05T14:38:32.328662+00:00"
10968
+ "x-reconciled-at": "2026-01-07T15:28:51.642544+00:00"
10474
10969
  },
10475
10970
  "namespace": {
10476
10971
  "type": "string",
@@ -10486,6 +10981,8 @@
10486
10981
  "x-validation-rules": {
10487
10982
  "ves.io.schema.rules.string.max_bytes": "64"
10488
10983
  },
10984
+ "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.",
10985
+ "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.",
10489
10986
  "minLength": 0,
10490
10987
  "x-f5xc-required-for": {
10491
10988
  "minimum_config": false,
@@ -10495,7 +10992,7 @@
10495
10992
  },
10496
10993
  "x-original-maxLength": 64,
10497
10994
  "x-reconciled-from-discovery": true,
10498
- "x-reconciled-at": "2026-01-05T14:38:32.328667+00:00"
10995
+ "x-reconciled-at": "2026-01-07T15:28:51.642549+00:00"
10499
10996
  },
10500
10997
  "tenant": {
10501
10998
  "type": "string",
@@ -10511,6 +11008,8 @@
10511
11008
  "x-validation-rules": {
10512
11009
  "ves.io.schema.rules.string.max_bytes": "64"
10513
11010
  },
11011
+ "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.",
11012
+ "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.",
10514
11013
  "minLength": 0,
10515
11014
  "x-f5xc-required-for": {
10516
11015
  "minimum_config": false,
@@ -10522,9 +11021,11 @@
10522
11021
  "x-field-mutability": "read-only",
10523
11022
  "x-original-maxLength": 64,
10524
11023
  "x-reconciled-from-discovery": true,
10525
- "x-reconciled-at": "2026-01-05T14:38:32.328671+00:00"
11024
+ "x-reconciled-at": "2026-01-07T15:28:51.642554+00:00"
10526
11025
  }
10527
11026
  },
11027
+ "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
11028
+ "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.",
10528
11029
  "x-f5xc-minimum-configuration": {
10529
11030
  "description": "Minimum configuration for schemaviewsObjectRefType",
10530
11031
  "required_fields": [
@@ -10545,6 +11046,7 @@
10545
11046
  "title": "Empty",
10546
11047
  "x-displayname": "Empty",
10547
11048
  "x-ves-proto-message": "ves.io.schema.Empty",
11049
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
10548
11050
  "x-f5xc-minimum-configuration": {
10549
11051
  "description": "Minimum configuration for ioschemaEmpty",
10550
11052
  "required_fields": [],
@@ -10647,6 +11149,7 @@
10647
11149
  }
10648
11150
  }
10649
11151
  },
11152
+ "x-f5xc-description-short": "Create k8s_pod_security_admission will create the object in the storage backend.",
10650
11153
  "x-f5xc-minimum-configuration": {
10651
11154
  "description": "Minimum configuration for k8s_pod_security_admissionCreateSpecType",
10652
11155
  "required_fields": [
@@ -10672,6 +11175,7 @@
10672
11175
  "title": "Fail_if_referred.",
10673
11176
  "format": "boolean",
10674
11177
  "x-displayname": "Fail-If-Referred.",
11178
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
10675
11179
  "x-f5xc-required-for": {
10676
11180
  "minimum_config": false,
10677
11181
  "create": false,
@@ -10696,7 +11200,7 @@
10696
11200
  },
10697
11201
  "x-original-maxLength": 1024,
10698
11202
  "x-reconciled-from-discovery": true,
10699
- "x-reconciled-at": "2026-01-05T14:38:32.690791+00:00"
11203
+ "x-reconciled-at": "2026-01-07T15:28:52.060311+00:00"
10700
11204
  },
10701
11205
  "namespace": {
10702
11206
  "type": "string",
@@ -10705,6 +11209,7 @@
10705
11209
  "x-displayname": "Namespace",
10706
11210
  "x-ves-example": "Ns1",
10707
11211
  "x-f5xc-example": "ns1",
11212
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
10708
11213
  "minLength": 0,
10709
11214
  "maxLength": 6,
10710
11215
  "x-f5xc-required-for": {
@@ -10715,7 +11220,7 @@
10715
11220
  },
10716
11221
  "x-original-maxLength": 1024,
10717
11222
  "x-reconciled-from-discovery": true,
10718
- "x-reconciled-at": "2026-01-05T14:38:32.690796+00:00"
11223
+ "x-reconciled-at": "2026-01-07T15:28:52.060315+00:00"
10719
11224
  }
10720
11225
  },
10721
11226
  "x-f5xc-minimum-configuration": {
@@ -10750,6 +11255,7 @@
10750
11255
  "$ref": "#/components/schemas/ioschemaObjectRefType"
10751
11256
  },
10752
11257
  "x-displayname": "Deleted Referred Objects.",
11258
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
10753
11259
  "x-f5xc-required-for": {
10754
11260
  "minimum_config": false,
10755
11261
  "create": false,
@@ -10765,6 +11271,7 @@
10765
11271
  "$ref": "#/components/schemas/ioschemaObjectRefType"
10766
11272
  },
10767
11273
  "x-displayname": "Disabled Referred Objects.",
11274
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
10768
11275
  "x-f5xc-required-for": {
10769
11276
  "minimum_config": false,
10770
11277
  "create": false,
@@ -10783,6 +11290,7 @@
10783
11290
  "$ref": "#/components/schemas/ioschemaObjectRefType"
10784
11291
  },
10785
11292
  "x-displayname": "Referring Objects.",
11293
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
10786
11294
  "x-f5xc-required-for": {
10787
11295
  "minimum_config": false,
10788
11296
  "create": false,
@@ -10804,6 +11312,8 @@
10804
11312
  "$ref": "#/components/schemas/k8s_pod_security_admissionStatusObject"
10805
11313
  },
10806
11314
  "x-displayname": "Status",
11315
+ "x-f5xc-example": "active",
11316
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
10807
11317
  "x-f5xc-required-for": {
10808
11318
  "minimum_config": false,
10809
11319
  "create": false,
@@ -10813,7 +11323,7 @@
10813
11323
  "maxLength": 17,
10814
11324
  "minLength": 17,
10815
11325
  "x-reconciled-from-discovery": true,
10816
- "x-reconciled-at": "2026-01-05T14:38:32.690813+00:00"
11326
+ "x-reconciled-at": "2026-01-07T15:28:52.060329+00:00"
10817
11327
  },
10818
11328
  "system_metadata": {
10819
11329
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -10853,6 +11363,8 @@
10853
11363
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
10854
11364
  ],
10855
11365
  "default": "GET_RSP_FORMAT_DEFAULT",
11366
+ "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...",
11367
+ "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...",
10856
11368
  "x-f5xc-minimum-configuration": {
10857
11369
  "description": "Minimum configuration for k8s_pod_security_admissionGetResponseFormatCode",
10858
11370
  "required_fields": [],
@@ -10900,6 +11412,7 @@
10900
11412
  }
10901
11413
  }
10902
11414
  },
11415
+ "x-f5xc-description-short": "GET k8s_pod_security_admission will GET the object from the storage backend.",
10903
11416
  "x-f5xc-minimum-configuration": {
10904
11417
  "description": "Minimum configuration for k8s_pod_security_admissionGetSpecType",
10905
11418
  "required_fields": [
@@ -10927,6 +11440,7 @@
10927
11440
  "$ref": "#/components/schemas/schemaErrorType"
10928
11441
  },
10929
11442
  "x-displayname": "Errors",
11443
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
10930
11444
  "x-f5xc-required-for": {
10931
11445
  "minimum_config": false,
10932
11446
  "create": false,
@@ -10942,6 +11456,8 @@
10942
11456
  "$ref": "#/components/schemas/k8s_pod_security_admissionListResponseItem"
10943
11457
  },
10944
11458
  "x-displayname": "Items",
11459
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
11460
+ "x-f5xc-description-short": "Items represents the collection in response.",
10945
11461
  "x-f5xc-required-for": {
10946
11462
  "minimum_config": false,
10947
11463
  "create": false,
@@ -10975,6 +11491,8 @@
10975
11491
  "description": "The set of annotations present on this k8s_pod_security_admission.",
10976
11492
  "title": "Annotations.",
10977
11493
  "x-displayname": "Annotations.",
11494
+ "x-f5xc-example": "{\"key\": \"value\"}",
11495
+ "x-f5xc-description-short": "The set of annotations present on this k8s_pod_security_admission.",
10978
11496
  "x-f5xc-required-for": {
10979
11497
  "minimum_config": false,
10980
11498
  "create": false,
@@ -10987,6 +11505,7 @@
10987
11505
  "description": "The description set for this k8s_pod_security_admission.",
10988
11506
  "title": "Description.",
10989
11507
  "x-displayname": "Description.",
11508
+ "x-f5xc-description-short": "The description set for this k8s_pod_security_admission.",
10990
11509
  "minLength": 0,
10991
11510
  "maxLength": 0,
10992
11511
  "x-f5xc-required-for": {
@@ -10997,7 +11516,7 @@
10997
11516
  },
10998
11517
  "x-original-maxLength": 1024,
10999
11518
  "x-reconciled-from-discovery": true,
11000
- "x-reconciled-at": "2026-01-05T14:38:32.690827+00:00"
11519
+ "x-reconciled-at": "2026-01-07T15:28:52.060344+00:00"
11001
11520
  },
11002
11521
  "disabled": {
11003
11522
  "type": "boolean",
@@ -11005,6 +11524,8 @@
11005
11524
  "title": "Disabled",
11006
11525
  "format": "boolean",
11007
11526
  "x-displayname": "Disabled",
11527
+ "x-f5xc-example": "True",
11528
+ "x-f5xc-description-short": "Value of true indicates k8s_pod_security_admission is administratively disabled.",
11008
11529
  "x-f5xc-required-for": {
11009
11530
  "minimum_config": false,
11010
11531
  "create": false,
@@ -11020,6 +11541,8 @@
11020
11541
  "description": "The set of labels present on this k8s_pod_security_admission.",
11021
11542
  "title": "Labels",
11022
11543
  "x-displayname": "Labels",
11544
+ "x-f5xc-example": "{\"key\": \"value\"}",
11545
+ "x-f5xc-description-short": "The set of labels present on this k8s_pod_security_admission.",
11023
11546
  "x-f5xc-required-for": {
11024
11547
  "minimum_config": false,
11025
11548
  "create": false,
@@ -11037,6 +11560,7 @@
11037
11560
  "x-displayname": "Name",
11038
11561
  "x-ves-example": "Name",
11039
11562
  "x-f5xc-example": "name",
11563
+ "x-f5xc-description-short": "The name of this k8s_pod_security_admission.",
11040
11564
  "minLength": 0,
11041
11565
  "maxLength": 16,
11042
11566
  "x-f5xc-required-for": {
@@ -11047,7 +11571,7 @@
11047
11571
  },
11048
11572
  "x-original-maxLength": 1024,
11049
11573
  "x-reconciled-from-discovery": true,
11050
- "x-reconciled-at": "2026-01-05T14:38:32.690838+00:00"
11574
+ "x-reconciled-at": "2026-01-07T15:28:52.060354+00:00"
11051
11575
  },
11052
11576
  "namespace": {
11053
11577
  "type": "string",
@@ -11066,7 +11590,7 @@
11066
11590
  },
11067
11591
  "x-original-maxLength": 1024,
11068
11592
  "x-reconciled-from-discovery": true,
11069
- "x-reconciled-at": "2026-01-05T14:38:32.690843+00:00"
11593
+ "x-reconciled-at": "2026-01-07T15:28:52.060358+00:00"
11070
11594
  },
11071
11595
  "owner_view": {
11072
11596
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -11079,6 +11603,7 @@
11079
11603
  "$ref": "#/components/schemas/k8s_pod_security_admissionStatusObject"
11080
11604
  },
11081
11605
  "x-displayname": "Status",
11606
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
11082
11607
  "x-f5xc-required-for": {
11083
11608
  "minimum_config": false,
11084
11609
  "create": false,
@@ -11107,7 +11632,7 @@
11107
11632
  "x-field-mutability": "read-only",
11108
11633
  "x-original-maxLength": 1024,
11109
11634
  "x-reconciled-from-discovery": true,
11110
- "x-reconciled-at": "2026-01-05T14:38:32.690851+00:00"
11635
+ "x-reconciled-at": "2026-01-07T15:28:52.060366+00:00"
11111
11636
  },
11112
11637
  "uid": {
11113
11638
  "type": "string",
@@ -11116,6 +11641,7 @@
11116
11641
  "x-displayname": "UID",
11117
11642
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
11118
11643
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
11644
+ "x-f5xc-description-short": "The unique uid of this k8s_pod_security_admission.",
11119
11645
  "minLength": 0,
11120
11646
  "maxLength": 36,
11121
11647
  "x-f5xc-required-for": {
@@ -11128,9 +11654,11 @@
11128
11654
  "x-original-maxLength": 1024,
11129
11655
  "format": "uuid",
11130
11656
  "x-reconciled-from-discovery": true,
11131
- "x-reconciled-at": "2026-01-05T14:38:32.690856+00:00"
11657
+ "x-reconciled-at": "2026-01-07T15:28:52.060371+00:00"
11132
11658
  }
11133
11659
  },
11660
+ "x-f5xc-description-short": "By default a summary of k8s_pod_security_admission is returned in 'List'.",
11661
+ "x-f5xc-description-medium": "By default a summary of k8s_pod_security_admission is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
11134
11662
  "x-f5xc-minimum-configuration": {
11135
11663
  "description": "Minimum configuration for k8s_pod_security_admissionListResponseItem",
11136
11664
  "required_fields": [
@@ -11183,6 +11711,7 @@
11183
11711
  "$ref": "#/components/schemas/ioschemaEmpty"
11184
11712
  }
11185
11713
  },
11714
+ "x-f5xc-description-short": "Pod Security Admission Spec is combination of policy type and admission mode.",
11186
11715
  "x-f5xc-minimum-configuration": {
11187
11716
  "description": "Minimum configuration for k8s_pod_security_admissionPodSecurityAdmissionSpec",
11188
11717
  "required_fields": [
@@ -11277,6 +11806,8 @@
11277
11806
  }
11278
11807
  }
11279
11808
  },
11809
+ "x-f5xc-description-short": "Replacing an k8s_pod_security_admission object will update the object by replacing the existing spec with the provided one.",
11810
+ "x-f5xc-description-medium": "Replacing an k8s_pod_security_admission 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.",
11280
11811
  "x-f5xc-minimum-configuration": {
11281
11812
  "description": "Minimum configuration for k8s_pod_security_admissionReplaceSpecType",
11282
11813
  "required_fields": [
@@ -11330,6 +11861,7 @@
11330
11861
  }
11331
11862
  }
11332
11863
  },
11864
+ "x-f5xc-description-short": "Most recently observed status of object.",
11333
11865
  "x-f5xc-minimum-configuration": {
11334
11866
  "description": "Minimum configuration for k8s_pod_security_admissionStatusObject",
11335
11867
  "required_fields": [
@@ -11376,6 +11908,7 @@
11376
11908
  "ves.io.schema.rules.repeated.min_items": "1",
11377
11909
  "ves.io.schema.rules.repeated.unique": "true"
11378
11910
  },
11911
+ "x-f5xc-description-short": "List of capabilities that docker container has. Required: YES.",
11379
11912
  "x-f5xc-required-for": {
11380
11913
  "minimum_config": false,
11381
11914
  "create": false,
@@ -11384,6 +11917,7 @@
11384
11917
  }
11385
11918
  }
11386
11919
  },
11920
+ "x-f5xc-description-short": "List of capabilities that docker container has.",
11387
11921
  "x-f5xc-minimum-configuration": {
11388
11922
  "description": "Minimum configuration for k8s_pod_security_policyCapabilityListType",
11389
11923
  "required_fields": [
@@ -11475,6 +12009,7 @@
11475
12009
  "ves.io.schema.rules.string.max_len": "4096",
11476
12010
  "ves.io.schema.rules.string.uri_ref": "true"
11477
12011
  },
12012
+ "x-f5xc-description-short": "Exclusive with [psp_spec] K8s YAML for Pod Security Policy.",
11478
12013
  "minLength": 0,
11479
12014
  "x-f5xc-required-for": {
11480
12015
  "minimum_config": false,
@@ -11484,6 +12019,8 @@
11484
12019
  }
11485
12020
  }
11486
12021
  },
12022
+ "x-f5xc-description-short": "Create k8s_pod_security_policy will create the object in the storage backend for namespace metadata.namespace.",
12023
+ "x-f5xc-description-medium": "Create k8s_pod_security_policy will create the object in the storage backend for namespace metadata.namespace.",
11487
12024
  "x-f5xc-minimum-configuration": {
11488
12025
  "description": "Minimum configuration for k8s_pod_security_policyCreateSpecType",
11489
12026
  "required_fields": [
@@ -11510,6 +12047,7 @@
11510
12047
  "title": "Fail_if_referred.",
11511
12048
  "format": "boolean",
11512
12049
  "x-displayname": "Fail-If-Referred.",
12050
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
11513
12051
  "x-f5xc-required-for": {
11514
12052
  "minimum_config": false,
11515
12053
  "create": false,
@@ -11534,7 +12072,7 @@
11534
12072
  },
11535
12073
  "x-original-maxLength": 1024,
11536
12074
  "x-reconciled-from-discovery": true,
11537
- "x-reconciled-at": "2026-01-05T14:38:33.088137+00:00"
12075
+ "x-reconciled-at": "2026-01-07T15:28:52.515713+00:00"
11538
12076
  },
11539
12077
  "namespace": {
11540
12078
  "type": "string",
@@ -11543,6 +12081,7 @@
11543
12081
  "x-displayname": "Namespace",
11544
12082
  "x-ves-example": "Ns1",
11545
12083
  "x-f5xc-example": "ns1",
12084
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
11546
12085
  "minLength": 0,
11547
12086
  "maxLength": 6,
11548
12087
  "x-f5xc-required-for": {
@@ -11553,7 +12092,7 @@
11553
12092
  },
11554
12093
  "x-original-maxLength": 1024,
11555
12094
  "x-reconciled-from-discovery": true,
11556
- "x-reconciled-at": "2026-01-05T14:38:33.088144+00:00"
12095
+ "x-reconciled-at": "2026-01-07T15:28:52.515720+00:00"
11557
12096
  }
11558
12097
  },
11559
12098
  "x-f5xc-minimum-configuration": {
@@ -11588,6 +12127,7 @@
11588
12127
  "$ref": "#/components/schemas/schemaObjectRefType"
11589
12128
  },
11590
12129
  "x-displayname": "Deleted Referred Objects.",
12130
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
11591
12131
  "x-f5xc-required-for": {
11592
12132
  "minimum_config": false,
11593
12133
  "create": false,
@@ -11603,6 +12143,7 @@
11603
12143
  "$ref": "#/components/schemas/schemaObjectRefType"
11604
12144
  },
11605
12145
  "x-displayname": "Disabled Referred Objects.",
12146
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
11606
12147
  "x-f5xc-required-for": {
11607
12148
  "minimum_config": false,
11608
12149
  "create": false,
@@ -11621,6 +12162,7 @@
11621
12162
  "$ref": "#/components/schemas/schemaObjectRefType"
11622
12163
  },
11623
12164
  "x-displayname": "Referring Objects.",
12165
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
11624
12166
  "x-f5xc-required-for": {
11625
12167
  "minimum_config": false,
11626
12168
  "create": false,
@@ -11642,6 +12184,8 @@
11642
12184
  "$ref": "#/components/schemas/k8s_pod_security_policyStatusObject"
11643
12185
  },
11644
12186
  "x-displayname": "Status",
12187
+ "x-f5xc-example": "active",
12188
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
11645
12189
  "x-f5xc-required-for": {
11646
12190
  "minimum_config": false,
11647
12191
  "create": false,
@@ -11651,7 +12195,7 @@
11651
12195
  "maxLength": 17,
11652
12196
  "minLength": 17,
11653
12197
  "x-reconciled-from-discovery": true,
11654
- "x-reconciled-at": "2026-01-05T14:38:33.088161+00:00"
12198
+ "x-reconciled-at": "2026-01-07T15:28:52.515737+00:00"
11655
12199
  },
11656
12200
  "system_metadata": {
11657
12201
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -11691,6 +12235,8 @@
11691
12235
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
11692
12236
  ],
11693
12237
  "default": "GET_RSP_FORMAT_DEFAULT",
12238
+ "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...",
12239
+ "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...",
11694
12240
  "x-f5xc-minimum-configuration": {
11695
12241
  "description": "Minimum configuration for k8s_pod_security_policyGetResponseFormatCode",
11696
12242
  "required_fields": [],
@@ -11725,6 +12271,7 @@
11725
12271
  "ves.io.schema.rules.string.max_len": "4096",
11726
12272
  "ves.io.schema.rules.string.uri_ref": "true"
11727
12273
  },
12274
+ "x-f5xc-description-short": "Exclusive with [psp_spec] K8s YAML for Pod Security Policy.",
11728
12275
  "minLength": 0,
11729
12276
  "x-f5xc-required-for": {
11730
12277
  "minimum_config": false,
@@ -11734,6 +12281,8 @@
11734
12281
  }
11735
12282
  }
11736
12283
  },
12284
+ "x-f5xc-description-short": "GET k8s_pod_security_policy will GET the object from the storage backend for namespace metadata.namespace.",
12285
+ "x-f5xc-description-medium": "GET k8s_pod_security_policy will GET the object from the storage backend for namespace metadata.namespace.",
11737
12286
  "x-f5xc-minimum-configuration": {
11738
12287
  "description": "Minimum configuration for k8s_pod_security_policyGetSpecType",
11739
12288
  "required_fields": [
@@ -11774,6 +12323,8 @@
11774
12323
  "ves.io.schema.rules.string.max_len": "128",
11775
12324
  "ves.io.schema.rules.string.min_len": "1"
11776
12325
  },
12326
+ "x-f5xc-description-short": "Host path prefix is the path prefix that the host volume must match. It does not support *.",
12327
+ "x-f5xc-description-medium": "Host path prefix is the path prefix that the host volume must match. It does not support *. Required: YES.",
11777
12328
  "x-f5xc-required-for": {
11778
12329
  "minimum_config": false,
11779
12330
  "create": false,
@@ -11787,6 +12338,7 @@
11787
12338
  "title": "Read Only",
11788
12339
  "format": "boolean",
11789
12340
  "x-displayname": "Read Only",
12341
+ "x-f5xc-description-short": "Volume will be allowed to mount read only.",
11790
12342
  "x-f5xc-required-for": {
11791
12343
  "minimum_config": false,
11792
12344
  "create": false,
@@ -11833,6 +12385,7 @@
11833
12385
  "ves.io.schema.rules.uint32.gte": "1",
11834
12386
  "ves.io.schema.rules.uint32.lte": "65535"
11835
12387
  },
12388
+ "x-f5xc-description-short": "Ending(maximum) ID for for ID range Required: YES.",
11836
12389
  "minimum": 0,
11837
12390
  "maximum": 2147483647,
11838
12391
  "x-f5xc-required-for": {
@@ -11862,6 +12415,7 @@
11862
12415
  "ves.io.schema.rules.uint32.gte": "1",
11863
12416
  "ves.io.schema.rules.uint32.lte": "65535"
11864
12417
  },
12418
+ "x-f5xc-description-short": "Starting(minimum) ID for for ID range Required: YES.",
11865
12419
  "minimum": 0,
11866
12420
  "maximum": 2147483647,
11867
12421
  "x-f5xc-required-for": {
@@ -11908,6 +12462,7 @@
11908
12462
  "x-validation-rules": {
11909
12463
  "ves.io.schema.rules.repeated.max_items": "16"
11910
12464
  },
12465
+ "x-f5xc-example": "{\"key\": \"value\"}",
11911
12466
  "x-f5xc-required-for": {
11912
12467
  "minimum_config": false,
11913
12468
  "create": false,
@@ -11932,6 +12487,7 @@
11932
12487
  "ves.io.schema.rules.string.max_bytes": "128",
11933
12488
  "ves.io.schema.rules.string.min_bytes": "1"
11934
12489
  },
12490
+ "x-f5xc-description-short": "Rule indicated how the FS group ID range is used.",
11935
12491
  "x-f5xc-required-for": {
11936
12492
  "minimum_config": false,
11937
12493
  "create": false,
@@ -11968,6 +12524,7 @@
11968
12524
  "$ref": "#/components/schemas/schemaErrorType"
11969
12525
  },
11970
12526
  "x-displayname": "Errors",
12527
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
11971
12528
  "x-f5xc-required-for": {
11972
12529
  "minimum_config": false,
11973
12530
  "create": false,
@@ -11983,6 +12540,8 @@
11983
12540
  "$ref": "#/components/schemas/k8s_pod_security_policyListResponseItem"
11984
12541
  },
11985
12542
  "x-displayname": "Items",
12543
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
12544
+ "x-f5xc-description-short": "Items represents the collection in response.",
11986
12545
  "x-f5xc-required-for": {
11987
12546
  "minimum_config": false,
11988
12547
  "create": false,
@@ -12016,6 +12575,8 @@
12016
12575
  "description": "The set of annotations present on this k8s_pod_security_policy.",
12017
12576
  "title": "Annotations.",
12018
12577
  "x-displayname": "Annotations.",
12578
+ "x-f5xc-example": "{\"key\": \"value\"}",
12579
+ "x-f5xc-description-short": "The set of annotations present on this k8s_pod_security_policy.",
12019
12580
  "x-f5xc-required-for": {
12020
12581
  "minimum_config": false,
12021
12582
  "create": false,
@@ -12028,6 +12589,7 @@
12028
12589
  "description": "The description set for this k8s_pod_security_policy.",
12029
12590
  "title": "Description.",
12030
12591
  "x-displayname": "Description.",
12592
+ "x-f5xc-description-short": "The description set for this k8s_pod_security_policy.",
12031
12593
  "minLength": 0,
12032
12594
  "maxLength": 0,
12033
12595
  "x-f5xc-required-for": {
@@ -12038,7 +12600,7 @@
12038
12600
  },
12039
12601
  "x-original-maxLength": 1024,
12040
12602
  "x-reconciled-from-discovery": true,
12041
- "x-reconciled-at": "2026-01-05T14:38:33.088190+00:00"
12603
+ "x-reconciled-at": "2026-01-07T15:28:52.515763+00:00"
12042
12604
  },
12043
12605
  "disabled": {
12044
12606
  "type": "boolean",
@@ -12046,6 +12608,8 @@
12046
12608
  "title": "Disabled",
12047
12609
  "format": "boolean",
12048
12610
  "x-displayname": "Disabled",
12611
+ "x-f5xc-example": "True",
12612
+ "x-f5xc-description-short": "Value of true indicates k8s_pod_security_policy is administratively disabled.",
12049
12613
  "x-f5xc-required-for": {
12050
12614
  "minimum_config": false,
12051
12615
  "create": false,
@@ -12061,6 +12625,8 @@
12061
12625
  "description": "The set of labels present on this k8s_pod_security_policy.",
12062
12626
  "title": "Labels",
12063
12627
  "x-displayname": "Labels",
12628
+ "x-f5xc-example": "{\"key\": \"value\"}",
12629
+ "x-f5xc-description-short": "The set of labels present on this k8s_pod_security_policy.",
12064
12630
  "x-f5xc-required-for": {
12065
12631
  "minimum_config": false,
12066
12632
  "create": false,
@@ -12078,6 +12644,7 @@
12078
12644
  "x-displayname": "Name",
12079
12645
  "x-ves-example": "Name",
12080
12646
  "x-f5xc-example": "name",
12647
+ "x-f5xc-description-short": "The name of this k8s_pod_security_policy.",
12081
12648
  "minLength": 0,
12082
12649
  "maxLength": 16,
12083
12650
  "x-f5xc-required-for": {
@@ -12088,7 +12655,7 @@
12088
12655
  },
12089
12656
  "x-original-maxLength": 1024,
12090
12657
  "x-reconciled-from-discovery": true,
12091
- "x-reconciled-at": "2026-01-05T14:38:33.088202+00:00"
12658
+ "x-reconciled-at": "2026-01-07T15:28:52.515774+00:00"
12092
12659
  },
12093
12660
  "namespace": {
12094
12661
  "type": "string",
@@ -12107,7 +12674,7 @@
12107
12674
  },
12108
12675
  "x-original-maxLength": 1024,
12109
12676
  "x-reconciled-from-discovery": true,
12110
- "x-reconciled-at": "2026-01-05T14:38:33.088207+00:00"
12677
+ "x-reconciled-at": "2026-01-07T15:28:52.515779+00:00"
12111
12678
  },
12112
12679
  "owner_view": {
12113
12680
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -12120,6 +12687,7 @@
12120
12687
  "$ref": "#/components/schemas/k8s_pod_security_policyStatusObject"
12121
12688
  },
12122
12689
  "x-displayname": "Status",
12690
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
12123
12691
  "x-f5xc-required-for": {
12124
12692
  "minimum_config": false,
12125
12693
  "create": false,
@@ -12148,7 +12716,7 @@
12148
12716
  "x-field-mutability": "read-only",
12149
12717
  "x-original-maxLength": 1024,
12150
12718
  "x-reconciled-from-discovery": true,
12151
- "x-reconciled-at": "2026-01-05T14:38:33.088215+00:00"
12719
+ "x-reconciled-at": "2026-01-07T15:28:52.515787+00:00"
12152
12720
  },
12153
12721
  "uid": {
12154
12722
  "type": "string",
@@ -12157,6 +12725,7 @@
12157
12725
  "x-displayname": "UID",
12158
12726
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
12159
12727
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
12728
+ "x-f5xc-description-short": "The unique uid of this k8s_pod_security_policy.",
12160
12729
  "minLength": 0,
12161
12730
  "maxLength": 36,
12162
12731
  "x-f5xc-required-for": {
@@ -12169,9 +12738,11 @@
12169
12738
  "x-original-maxLength": 1024,
12170
12739
  "format": "uuid",
12171
12740
  "x-reconciled-from-discovery": true,
12172
- "x-reconciled-at": "2026-01-05T14:38:33.088221+00:00"
12741
+ "x-reconciled-at": "2026-01-07T15:28:52.515793+00:00"
12173
12742
  }
12174
12743
  },
12744
+ "x-f5xc-description-short": "By default a summary of k8s_pod_security_policy is returned in 'List'.",
12745
+ "x-f5xc-description-medium": "By default a summary of k8s_pod_security_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
12175
12746
  "x-f5xc-minimum-configuration": {
12176
12747
  "description": "Minimum configuration for k8s_pod_security_policyListResponseItem",
12177
12748
  "required_fields": [
@@ -12218,6 +12789,7 @@
12218
12789
  "title": "Allow Privilege Escalation.",
12219
12790
  "format": "boolean",
12220
12791
  "x-displayname": "Allow Privilege Escalation.",
12792
+ "x-f5xc-description-short": "Pod can request to privilege escalation.",
12221
12793
  "x-f5xc-required-for": {
12222
12794
  "minimum_config": false,
12223
12795
  "create": false,
@@ -12253,6 +12825,7 @@
12253
12825
  "ves.io.schema.rules.repeated.max_items": "8",
12254
12826
  "ves.io.schema.rules.repeated.unique": "true"
12255
12827
  },
12828
+ "x-f5xc-description-short": "Restrict the available CSI drivers for POD, default all drivers are available.",
12256
12829
  "x-f5xc-required-for": {
12257
12830
  "minimum_config": false,
12258
12831
  "create": false,
@@ -12285,6 +12858,7 @@
12285
12858
  "ves.io.schema.rules.repeated.max_items": "8",
12286
12859
  "ves.io.schema.rules.repeated.unique": "true"
12287
12860
  },
12861
+ "x-f5xc-description-short": "Restrict list of Flex volumes, default all volumes are allowed.",
12288
12862
  "x-f5xc-required-for": {
12289
12863
  "minimum_config": false,
12290
12864
  "create": false,
@@ -12309,6 +12883,7 @@
12309
12883
  "ves.io.schema.rules.repeated.max_items": "8",
12310
12884
  "ves.io.schema.rules.repeated.unique": "true"
12311
12885
  },
12886
+ "x-f5xc-description-short": "Restrict list of host paths, default all host paths are allowed.",
12312
12887
  "x-f5xc-required-for": {
12313
12888
  "minimum_config": false,
12314
12889
  "create": false,
@@ -12335,6 +12910,7 @@
12335
12910
  "ves.io.schema.rules.repeated.max_items": "8",
12336
12911
  "ves.io.schema.rules.repeated.unique": "true"
12337
12912
  },
12913
+ "x-f5xc-description-short": "Allowed list of proc mounts, empty list allows default proc mounts.",
12338
12914
  "x-f5xc-required-for": {
12339
12915
  "minimum_config": false,
12340
12916
  "create": false,
@@ -12361,6 +12937,7 @@
12361
12937
  "ves.io.schema.rules.repeated.max_items": "16",
12362
12938
  "ves.io.schema.rules.repeated.unique": "true"
12363
12939
  },
12940
+ "x-f5xc-description-short": "Allowed list of unsafe sysctls, empty list allows none. Supports prefix reg-ex.",
12364
12941
  "x-f5xc-required-for": {
12365
12942
  "minimum_config": false,
12366
12943
  "create": false,
@@ -12374,6 +12951,7 @@
12374
12951
  "title": "Default Allow Privilege Escalation.",
12375
12952
  "format": "boolean",
12376
12953
  "x-displayname": "Default Allow Privilege Escalation.",
12954
+ "x-f5xc-description-short": "Pod has permission for privilege escalation by default.",
12377
12955
  "x-f5xc-required-for": {
12378
12956
  "minimum_config": false,
12379
12957
  "create": false,
@@ -12406,6 +12984,7 @@
12406
12984
  "ves.io.schema.rules.repeated.max_items": "16",
12407
12985
  "ves.io.schema.rules.repeated.unique": "true"
12408
12986
  },
12987
+ "x-f5xc-description-short": "Forbidden list of sysctls, empty list forbids none. Supports prefix reg-ex.",
12409
12988
  "x-f5xc-required-for": {
12410
12989
  "minimum_config": false,
12411
12990
  "create": false,
@@ -12422,6 +13001,7 @@
12422
13001
  "title": "Host IPC",
12423
13002
  "format": "boolean",
12424
13003
  "x-displayname": "Host IPC",
13004
+ "x-f5xc-description-short": "Host IPC determines if the policy allows the use of host IPC in the pod spec.",
12425
13005
  "x-f5xc-required-for": {
12426
13006
  "minimum_config": false,
12427
13007
  "create": false,
@@ -12435,6 +13015,7 @@
12435
13015
  "title": "Host Network.",
12436
13016
  "format": "boolean",
12437
13017
  "x-displayname": "Host Network.",
13018
+ "x-f5xc-description-short": "Host Network determines if the policy allows the use of host network in the pod spec.",
12438
13019
  "x-f5xc-required-for": {
12439
13020
  "minimum_config": false,
12440
13021
  "create": false,
@@ -12448,6 +13029,7 @@
12448
13029
  "title": "Host PID",
12449
13030
  "format": "boolean",
12450
13031
  "x-displayname": "Host PID",
13032
+ "x-f5xc-description-short": "Host PID determines if the policy allows the use of host PID in the pod spec.",
12451
13033
  "x-f5xc-required-for": {
12452
13034
  "minimum_config": false,
12453
13035
  "create": false,
@@ -12468,6 +13050,7 @@
12468
13050
  "x-validation-rules": {
12469
13051
  "ves.io.schema.rules.string.port_range_list": "true"
12470
13052
  },
13053
+ "x-f5xc-description-short": "Host port ranges determines which ports ranges are allowed to be exposed.",
12471
13054
  "minLength": 0,
12472
13055
  "maxLength": 1024,
12473
13056
  "x-f5xc-required-for": {
@@ -12510,6 +13093,7 @@
12510
13093
  "title": "Privileged.",
12511
13094
  "format": "boolean",
12512
13095
  "x-displayname": "Privileged.",
13096
+ "x-f5xc-description-short": "Privileged determines if a pod can request to be run as privileged.",
12513
13097
  "x-f5xc-required-for": {
12514
13098
  "minimum_config": false,
12515
13099
  "create": false,
@@ -12523,6 +13107,7 @@
12523
13107
  "title": "Read Only Root Filesystem.",
12524
13108
  "format": "boolean",
12525
13109
  "x-displayname": "Read Only Root Filesystem.",
13110
+ "x-f5xc-description-short": "Containers can only run with read only root filesystem.",
12526
13111
  "x-f5xc-required-for": {
12527
13112
  "minimum_config": false,
12528
13113
  "create": false,
@@ -12564,6 +13149,7 @@
12564
13149
  "ves.io.schema.rules.repeated.max_items": "8",
12565
13150
  "ves.io.schema.rules.repeated.unique": "true"
12566
13151
  },
13152
+ "x-f5xc-description-short": "Allow List of volume plugins. Empty no volumes are allowed.",
12567
13153
  "x-f5xc-required-for": {
12568
13154
  "minimum_config": false,
12569
13155
  "create": false,
@@ -12678,6 +13264,7 @@
12678
13264
  "ves.io.schema.rules.string.max_len": "4096",
12679
13265
  "ves.io.schema.rules.string.uri_ref": "true"
12680
13266
  },
13267
+ "x-f5xc-description-short": "Exclusive with [psp_spec] K8s YAML for Pod Security Policy.",
12681
13268
  "minLength": 0,
12682
13269
  "x-f5xc-required-for": {
12683
13270
  "minimum_config": false,
@@ -12687,6 +13274,8 @@
12687
13274
  }
12688
13275
  }
12689
13276
  },
13277
+ "x-f5xc-description-short": "Replacing an k8s_pod_security_policy object will update the object by replacing the existing spec with the provided one.",
13278
+ "x-f5xc-description-medium": "Replacing an k8s_pod_security_policy 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.",
12690
13279
  "x-f5xc-minimum-configuration": {
12691
13280
  "description": "Minimum configuration for k8s_pod_security_policyReplaceSpecType",
12692
13281
  "required_fields": [
@@ -12713,6 +13302,7 @@
12713
13302
  "type": "string"
12714
13303
  },
12715
13304
  "x-f5xc-example": "value",
13305
+ "x-f5xc-description-short": "X-displayName: \"Allowed Runtime Classes\" x-required List of allowed runtime class names.",
12716
13306
  "x-f5xc-required-for": {
12717
13307
  "minimum_config": false,
12718
13308
  "create": false,
@@ -12725,6 +13315,7 @@
12725
13315
  "description": "X-displayName: \"Default Runtime Class\"\ndescription.",
12726
13316
  "title": "Default Runtime Class.",
12727
13317
  "x-f5xc-example": "value",
13318
+ "x-f5xc-description-short": "X-displayName: \"Default Runtime Class\" description.",
12728
13319
  "minLength": 0,
12729
13320
  "maxLength": 1024,
12730
13321
  "x-f5xc-required-for": {
@@ -12735,6 +13326,7 @@
12735
13326
  }
12736
13327
  }
12737
13328
  },
13329
+ "x-f5xc-description-short": "X-displayName: \"Runtime Class Strategy\" Allowed runtime classes.",
12738
13330
  "x-f5xc-minimum-configuration": {
12739
13331
  "description": "Minimum configuration for k8s_pod_security_policyRuntimeClassStrategyOptions",
12740
13332
  "required_fields": [
@@ -12758,6 +13350,7 @@
12758
13350
  "description": "X-displayName: \"SE Linux Level\"\nRun as SE linux level label.",
12759
13351
  "title": "SE Linux Level.",
12760
13352
  "x-f5xc-example": "secret",
13353
+ "x-f5xc-description-short": "X-displayName: \"SE Linux Level\" Run as SE linux level label.",
12761
13354
  "minLength": 0,
12762
13355
  "maxLength": 1024,
12763
13356
  "x-f5xc-required-for": {
@@ -12772,6 +13365,7 @@
12772
13365
  "description": "X-displayName: \"SE Linux Role\"\nRun as SE linux label.",
12773
13366
  "title": "SE Linux Role.",
12774
13367
  "x-f5xc-example": "admin_r",
13368
+ "x-f5xc-description-short": "X-displayName: \"SE Linux Role\" Run as SE linux label.",
12775
13369
  "minLength": 0,
12776
13370
  "maxLength": 1024,
12777
13371
  "x-f5xc-required-for": {
@@ -12786,6 +13380,7 @@
12786
13380
  "description": "X-displayName: \"Rule\"\nRule indicated how the FS group ID range is used.",
12787
13381
  "title": "Rule",
12788
13382
  "x-f5xc-example": "MustRunAs",
13383
+ "x-f5xc-description-short": "X-displayName: \"Rule\" Rule indicated how the FS group ID range is used.",
12789
13384
  "minLength": 0,
12790
13385
  "maxLength": 1024,
12791
13386
  "x-f5xc-required-for": {
@@ -12800,6 +13395,7 @@
12800
13395
  "description": "X-displayName: \"SE Linux Type\"\nRun as SE linux type label.",
12801
13396
  "title": "SE Linux Type.",
12802
13397
  "x-f5xc-example": "admin_t",
13398
+ "x-f5xc-description-short": "X-displayName: \"SE Linux Type\" Run as SE linux type label.",
12803
13399
  "minLength": 0,
12804
13400
  "maxLength": 1024,
12805
13401
  "x-f5xc-required-for": {
@@ -12814,6 +13410,7 @@
12814
13410
  "description": "X-displayName: \"SE Linux User\"\nRun as SE linux user label.",
12815
13411
  "title": "SE Linux User.",
12816
13412
  "x-f5xc-example": "system_u",
13413
+ "x-f5xc-description-short": "X-displayName: \"SE Linux User\" Run as SE linux user label.",
12817
13414
  "minLength": 0,
12818
13415
  "maxLength": 1024,
12819
13416
  "x-f5xc-required-for": {
@@ -12881,6 +13478,7 @@
12881
13478
  }
12882
13479
  }
12883
13480
  },
13481
+ "x-f5xc-description-short": "Most recently observed status of object.",
12884
13482
  "x-f5xc-minimum-configuration": {
12885
13483
  "description": "Minimum configuration for k8s_pod_security_policyStatusObject",
12886
13484
  "required_fields": [