@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": "Rate Limiting",
5
5
  "description": "Threshold-based request blocking using sliding window calculations. Burst smoothing algorithms maintain sustained throughput without exceeding defined maximums. Per-connection controls apply granular restrictions by protocol type. Automatic block actions trigger when request counts surpass configured limits within specified intervals.",
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": "Time-based quota enforcement with configurable windows in hours, minutes, or seconds. Protocol-specific controls for traffic shaping.",
16
- "x-f5xc-cli-domain": "rate_limiting"
16
+ "x-f5xc-cli-domain": "rate_limiting",
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": "Policer",
@@ -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": "Policer",
@@ -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": "Policer",
@@ -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": "Policer",
@@ -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": "Protocol Policer.",
@@ -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": "Protocol Policer.",
@@ -1828,6 +1927,13 @@
1828
1927
  "latency": "moderate",
1829
1928
  "resource_usage": "moderate"
1830
1929
  }
1930
+ },
1931
+ "x-f5xc-discovered-response-time": {
1932
+ "p50_ms": 200,
1933
+ "p95_ms": 800,
1934
+ "p99_ms": 2000,
1935
+ "sample_count": 0,
1936
+ "source": "estimate"
1831
1937
  }
1832
1938
  },
1833
1939
  "x-displayname": "Protocol Policer.",
@@ -2049,6 +2155,13 @@
2049
2155
  "latency": "low",
2050
2156
  "resource_usage": "low"
2051
2157
  }
2158
+ },
2159
+ "x-f5xc-discovered-response-time": {
2160
+ "p50_ms": 200,
2161
+ "p95_ms": 800,
2162
+ "p99_ms": 2000,
2163
+ "sample_count": 0,
2164
+ "source": "estimate"
2052
2165
  }
2053
2166
  },
2054
2167
  "delete": {
@@ -2268,6 +2381,13 @@
2268
2381
  "latency": "high",
2269
2382
  "resource_usage": "moderate"
2270
2383
  }
2384
+ },
2385
+ "x-f5xc-discovered-response-time": {
2386
+ "p50_ms": 500,
2387
+ "p95_ms": 1500,
2388
+ "p99_ms": 4000,
2389
+ "sample_count": 0,
2390
+ "source": "estimate"
2271
2391
  }
2272
2392
  },
2273
2393
  "x-displayname": "Protocol Policer.",
@@ -2482,6 +2602,13 @@
2482
2602
  "latency": "low",
2483
2603
  "resource_usage": "low"
2484
2604
  }
2605
+ },
2606
+ "x-f5xc-discovered-response-time": {
2607
+ "p50_ms": 1000,
2608
+ "p95_ms": 3000,
2609
+ "p99_ms": 8000,
2610
+ "sample_count": 0,
2611
+ "source": "estimate"
2485
2612
  }
2486
2613
  },
2487
2614
  "x-displayname": "Rate Limiter.",
@@ -2704,6 +2831,13 @@
2704
2831
  "latency": "low",
2705
2832
  "resource_usage": "low"
2706
2833
  }
2834
+ },
2835
+ "x-f5xc-discovered-response-time": {
2836
+ "p50_ms": 800,
2837
+ "p95_ms": 2500,
2838
+ "p99_ms": 6000,
2839
+ "sample_count": 0,
2840
+ "source": "estimate"
2707
2841
  }
2708
2842
  },
2709
2843
  "x-displayname": "Rate Limiter.",
@@ -2931,6 +3065,13 @@
2931
3065
  "latency": "moderate",
2932
3066
  "resource_usage": "moderate"
2933
3067
  }
3068
+ },
3069
+ "x-f5xc-discovered-response-time": {
3070
+ "p50_ms": 200,
3071
+ "p95_ms": 800,
3072
+ "p99_ms": 2000,
3073
+ "sample_count": 0,
3074
+ "source": "estimate"
2934
3075
  }
2935
3076
  },
2936
3077
  "x-displayname": "Rate Limiter.",
@@ -3152,6 +3293,13 @@
3152
3293
  "latency": "low",
3153
3294
  "resource_usage": "low"
3154
3295
  }
3296
+ },
3297
+ "x-f5xc-discovered-response-time": {
3298
+ "p50_ms": 200,
3299
+ "p95_ms": 800,
3300
+ "p99_ms": 2000,
3301
+ "sample_count": 0,
3302
+ "source": "estimate"
3155
3303
  }
3156
3304
  },
3157
3305
  "delete": {
@@ -3371,6 +3519,13 @@
3371
3519
  "latency": "high",
3372
3520
  "resource_usage": "moderate"
3373
3521
  }
3522
+ },
3523
+ "x-f5xc-discovered-response-time": {
3524
+ "p50_ms": 500,
3525
+ "p95_ms": 1500,
3526
+ "p99_ms": 4000,
3527
+ "sample_count": 0,
3528
+ "source": "estimate"
3374
3529
  }
3375
3530
  },
3376
3531
  "x-displayname": "Rate Limiter.",
@@ -3467,6 +3622,7 @@
3467
3622
  "ves.io.schema.rules.message.required": "true",
3468
3623
  "ves.io.schema.rules.uint32.gte": "1"
3469
3624
  },
3625
+ "x-f5xc-description-short": "The maximum size permitted for bursts of data. E.g. 10000 pps burst Required: YES.",
3470
3626
  "minimum": 0,
3471
3627
  "maximum": 2147483647,
3472
3628
  "x-f5xc-required-for": {
@@ -3494,6 +3650,8 @@
3494
3650
  "ves.io.schema.rules.uint32.gte": "1",
3495
3651
  "ves.io.schema.rules.uint32.lte": "10000000"
3496
3652
  },
3653
+ "x-f5xc-description-short": "The committed information rate is the guaranteed packets rate for traffic arriving or departing under normal conditions.",
3654
+ "x-f5xc-description-medium": "The committed information rate is the guaranteed packets rate for traffic arriving or departing under normal conditions. E.g. 10000 pps Required: YES.",
3497
3655
  "minimum": 0,
3498
3656
  "maximum": 2147483647,
3499
3657
  "x-f5xc-required-for": {
@@ -3510,6 +3668,7 @@
3510
3668
  "$ref": "#/components/schemas/policerPolicerType"
3511
3669
  }
3512
3670
  },
3671
+ "x-f5xc-description-short": "Create a new policer with traffic rate limits.",
3513
3672
  "x-f5xc-minimum-configuration": {
3514
3673
  "description": "Minimum configuration for policerCreateSpecType",
3515
3674
  "required_fields": [
@@ -3538,6 +3697,7 @@
3538
3697
  "title": "Fail_if_referred.",
3539
3698
  "format": "boolean",
3540
3699
  "x-displayname": "Fail-If-Referred.",
3700
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
3541
3701
  "x-f5xc-required-for": {
3542
3702
  "minimum_config": false,
3543
3703
  "create": false,
@@ -3562,7 +3722,7 @@
3562
3722
  },
3563
3723
  "x-original-maxLength": 1024,
3564
3724
  "x-reconciled-from-discovery": true,
3565
- "x-reconciled-at": "2026-01-05T14:38:45.902045+00:00"
3725
+ "x-reconciled-at": "2026-01-07T15:29:07.299541+00:00"
3566
3726
  },
3567
3727
  "namespace": {
3568
3728
  "type": "string",
@@ -3571,6 +3731,7 @@
3571
3731
  "x-displayname": "Namespace",
3572
3732
  "x-ves-example": "Ns1",
3573
3733
  "x-f5xc-example": "ns1",
3734
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
3574
3735
  "minLength": 0,
3575
3736
  "maxLength": 6,
3576
3737
  "x-f5xc-required-for": {
@@ -3581,7 +3742,7 @@
3581
3742
  },
3582
3743
  "x-original-maxLength": 1024,
3583
3744
  "x-reconciled-from-discovery": true,
3584
- "x-reconciled-at": "2026-01-05T14:38:45.902052+00:00"
3745
+ "x-reconciled-at": "2026-01-07T15:29:07.299548+00:00"
3585
3746
  }
3586
3747
  },
3587
3748
  "x-f5xc-minimum-configuration": {
@@ -3616,6 +3777,7 @@
3616
3777
  "$ref": "#/components/schemas/schemaObjectRefType"
3617
3778
  },
3618
3779
  "x-displayname": "Deleted Referred Objects.",
3780
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
3619
3781
  "x-f5xc-required-for": {
3620
3782
  "minimum_config": false,
3621
3783
  "create": false,
@@ -3631,6 +3793,7 @@
3631
3793
  "$ref": "#/components/schemas/schemaObjectRefType"
3632
3794
  },
3633
3795
  "x-displayname": "Disabled Referred Objects.",
3796
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
3634
3797
  "x-f5xc-required-for": {
3635
3798
  "minimum_config": false,
3636
3799
  "create": false,
@@ -3649,6 +3812,7 @@
3649
3812
  "$ref": "#/components/schemas/schemaObjectRefType"
3650
3813
  },
3651
3814
  "x-displayname": "Referring Objects.",
3815
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
3652
3816
  "x-f5xc-required-for": {
3653
3817
  "minimum_config": false,
3654
3818
  "create": false,
@@ -3670,6 +3834,8 @@
3670
3834
  "$ref": "#/components/schemas/policerStatusObject"
3671
3835
  },
3672
3836
  "x-displayname": "Status",
3837
+ "x-f5xc-example": "active",
3838
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
3673
3839
  "x-f5xc-required-for": {
3674
3840
  "minimum_config": false,
3675
3841
  "create": false,
@@ -3679,7 +3845,7 @@
3679
3845
  "maxLength": 17,
3680
3846
  "minLength": 17,
3681
3847
  "x-reconciled-from-discovery": true,
3682
- "x-reconciled-at": "2026-01-05T14:38:45.902069+00:00"
3848
+ "x-reconciled-at": "2026-01-07T15:29:07.299564+00:00"
3683
3849
  },
3684
3850
  "system_metadata": {
3685
3851
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -3719,6 +3885,8 @@
3719
3885
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
3720
3886
  ],
3721
3887
  "default": "GET_RSP_FORMAT_DEFAULT",
3888
+ "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...",
3889
+ "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...",
3722
3890
  "x-f5xc-minimum-configuration": {
3723
3891
  "description": "Minimum configuration for policerGetResponseFormatCode",
3724
3892
  "required_fields": [],
@@ -3753,6 +3921,7 @@
3753
3921
  "ves.io.schema.rules.message.required": "true",
3754
3922
  "ves.io.schema.rules.uint32.gte": "1"
3755
3923
  },
3924
+ "x-f5xc-description-short": "The maximum size permitted for bursts of data. E.g. 10000 pps burst Required: YES.",
3756
3925
  "minimum": 0,
3757
3926
  "maximum": 2147483647,
3758
3927
  "x-f5xc-required-for": {
@@ -3780,6 +3949,8 @@
3780
3949
  "ves.io.schema.rules.uint32.gte": "1",
3781
3950
  "ves.io.schema.rules.uint32.lte": "10000000"
3782
3951
  },
3952
+ "x-f5xc-description-short": "The committed information rate is the guaranteed packets rate for traffic arriving or departing under normal conditions.",
3953
+ "x-f5xc-description-medium": "The committed information rate is the guaranteed packets rate for traffic arriving or departing under normal conditions. E.g. 10000 pps Required: YES.",
3783
3954
  "minimum": 0,
3784
3955
  "maximum": 2147483647,
3785
3956
  "x-f5xc-required-for": {
@@ -3826,6 +3997,7 @@
3826
3997
  "$ref": "#/components/schemas/schemaErrorType"
3827
3998
  },
3828
3999
  "x-displayname": "Errors",
4000
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
3829
4001
  "x-f5xc-required-for": {
3830
4002
  "minimum_config": false,
3831
4003
  "create": false,
@@ -3841,6 +4013,8 @@
3841
4013
  "$ref": "#/components/schemas/policerListResponseItem"
3842
4014
  },
3843
4015
  "x-displayname": "Items",
4016
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
4017
+ "x-f5xc-description-short": "Items represents the collection in response.",
3844
4018
  "x-f5xc-required-for": {
3845
4019
  "minimum_config": false,
3846
4020
  "create": false,
@@ -3874,6 +4048,8 @@
3874
4048
  "description": "The set of annotations present on this policer.",
3875
4049
  "title": "Annotations.",
3876
4050
  "x-displayname": "Annotations.",
4051
+ "x-f5xc-example": "{\"key\": \"value\"}",
4052
+ "x-f5xc-description-short": "The set of annotations present on this policer.",
3877
4053
  "x-f5xc-required-for": {
3878
4054
  "minimum_config": false,
3879
4055
  "create": false,
@@ -3896,7 +4072,7 @@
3896
4072
  },
3897
4073
  "x-original-maxLength": 1024,
3898
4074
  "x-reconciled-from-discovery": true,
3899
- "x-reconciled-at": "2026-01-05T14:38:45.902088+00:00"
4075
+ "x-reconciled-at": "2026-01-07T15:29:07.299583+00:00"
3900
4076
  },
3901
4077
  "disabled": {
3902
4078
  "type": "boolean",
@@ -3904,6 +4080,8 @@
3904
4080
  "title": "Disabled",
3905
4081
  "format": "boolean",
3906
4082
  "x-displayname": "Disabled",
4083
+ "x-f5xc-example": "True",
4084
+ "x-f5xc-description-short": "Value of true indicates policer is administratively disabled.",
3907
4085
  "x-f5xc-required-for": {
3908
4086
  "minimum_config": false,
3909
4087
  "create": false,
@@ -3919,6 +4097,8 @@
3919
4097
  "description": "The set of labels present on this policer.",
3920
4098
  "title": "Labels",
3921
4099
  "x-displayname": "Labels",
4100
+ "x-f5xc-example": "{\"key\": \"value\"}",
4101
+ "x-f5xc-description-short": "The set of labels present on this policer.",
3922
4102
  "x-f5xc-required-for": {
3923
4103
  "minimum_config": false,
3924
4104
  "create": false,
@@ -3946,7 +4126,7 @@
3946
4126
  },
3947
4127
  "x-original-maxLength": 1024,
3948
4128
  "x-reconciled-from-discovery": true,
3949
- "x-reconciled-at": "2026-01-05T14:38:45.902099+00:00"
4129
+ "x-reconciled-at": "2026-01-07T15:29:07.299594+00:00"
3950
4130
  },
3951
4131
  "namespace": {
3952
4132
  "type": "string",
@@ -3965,7 +4145,7 @@
3965
4145
  },
3966
4146
  "x-original-maxLength": 1024,
3967
4147
  "x-reconciled-from-discovery": true,
3968
- "x-reconciled-at": "2026-01-05T14:38:45.902104+00:00"
4148
+ "x-reconciled-at": "2026-01-07T15:29:07.299598+00:00"
3969
4149
  },
3970
4150
  "owner_view": {
3971
4151
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -3978,6 +4158,7 @@
3978
4158
  "$ref": "#/components/schemas/policerStatusObject"
3979
4159
  },
3980
4160
  "x-displayname": "Status",
4161
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
3981
4162
  "x-f5xc-required-for": {
3982
4163
  "minimum_config": false,
3983
4164
  "create": false,
@@ -4006,7 +4187,7 @@
4006
4187
  "x-field-mutability": "read-only",
4007
4188
  "x-original-maxLength": 1024,
4008
4189
  "x-reconciled-from-discovery": true,
4009
- "x-reconciled-at": "2026-01-05T14:38:45.902113+00:00"
4190
+ "x-reconciled-at": "2026-01-07T15:29:07.299606+00:00"
4010
4191
  },
4011
4192
  "uid": {
4012
4193
  "type": "string",
@@ -4027,9 +4208,11 @@
4027
4208
  "x-original-maxLength": 1024,
4028
4209
  "format": "uuid",
4029
4210
  "x-reconciled-from-discovery": true,
4030
- "x-reconciled-at": "2026-01-05T14:38:45.902119+00:00"
4211
+ "x-reconciled-at": "2026-01-07T15:29:07.299612+00:00"
4031
4212
  }
4032
4213
  },
4214
+ "x-f5xc-description-short": "By default a summary of policer is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
4215
+ "x-f5xc-description-medium": "By default a summary of policer is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
4033
4216
  "x-f5xc-minimum-configuration": {
4034
4217
  "description": "Minimum configuration for policerListResponseItem",
4035
4218
  "required_fields": [
@@ -4065,6 +4248,8 @@
4065
4248
  "default": "POLICER_MODE_NOT_SHARED",
4066
4249
  "x-displayname": "Policer Mode.",
4067
4250
  "x-ves-proto-enum": "ves.io.schema.policer.PolicerMode",
4251
+ "x-f5xc-description-short": "- POLICER_MODE_NOT_SHARED: Not Shared A separate policer instance is created for each reference to the policer - POLICER_MODE_SHARED: Shared A...",
4252
+ "x-f5xc-description-medium": "- POLICER_MODE_NOT_SHARED: Not Shared A separate policer instance is created for each reference to the policer - POLICER_MODE_SHARED: Shared A common policer instance is used for for all references to the policer.",
4068
4253
  "x-f5xc-minimum-configuration": {
4069
4254
  "description": "Minimum configuration for policerPolicerMode",
4070
4255
  "required_fields": [],
@@ -4085,6 +4270,7 @@
4085
4270
  "default": "POLICER_SINGLE_RATE_TWO_COLOR",
4086
4271
  "x-displayname": "Policer Type.",
4087
4272
  "x-ves-proto-enum": "ves.io.schema.policer.PolicerType",
4273
+ "x-f5xc-description-short": "Specifies the type of Policer Basic Single-Rate Two-Color Policer.",
4088
4274
  "x-f5xc-minimum-configuration": {
4089
4275
  "description": "Minimum configuration for policerPolicerType",
4090
4276
  "required_fields": [],
@@ -4159,6 +4345,7 @@
4159
4345
  "ves.io.schema.rules.message.required": "true",
4160
4346
  "ves.io.schema.rules.uint32.gte": "1"
4161
4347
  },
4348
+ "x-f5xc-description-short": "The maximum size permitted for bursts of data. E.g. 10000 pps burst Required: YES.",
4162
4349
  "minimum": 0,
4163
4350
  "maximum": 2147483647,
4164
4351
  "x-f5xc-required-for": {
@@ -4186,6 +4373,8 @@
4186
4373
  "ves.io.schema.rules.uint32.gte": "1",
4187
4374
  "ves.io.schema.rules.uint32.lte": "10000000"
4188
4375
  },
4376
+ "x-f5xc-description-short": "The committed information rate is the guaranteed packets rate for traffic arriving or departing under normal conditions.",
4377
+ "x-f5xc-description-medium": "The committed information rate is the guaranteed packets rate for traffic arriving or departing under normal conditions. E.g. 10000 pps Required: YES.",
4189
4378
  "minimum": 0,
4190
4379
  "maximum": 2147483647,
4191
4380
  "x-f5xc-required-for": {
@@ -4202,6 +4391,7 @@
4202
4391
  "$ref": "#/components/schemas/policerPolicerType"
4203
4392
  }
4204
4393
  },
4394
+ "x-f5xc-description-short": "Replace a given policer with changed traffic rate limits.",
4205
4395
  "x-f5xc-minimum-configuration": {
4206
4396
  "description": "Minimum configuration for policerReplaceSpecType",
4207
4397
  "required_fields": [
@@ -4233,6 +4423,7 @@
4233
4423
  "$ref": "#/components/schemas/schemaConditionType"
4234
4424
  },
4235
4425
  "x-displayname": "Conditions.",
4426
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
4236
4427
  "x-f5xc-required-for": {
4237
4428
  "minimum_config": false,
4238
4429
  "create": false,
@@ -4259,6 +4450,7 @@
4259
4450
  }
4260
4451
  }
4261
4452
  },
4453
+ "x-f5xc-description-short": "Most recently observed status of object.",
4262
4454
  "x-f5xc-minimum-configuration": {
4263
4455
  "description": "Minimum configuration for policerStatusObject",
4264
4456
  "required_fields": [
@@ -4280,6 +4472,8 @@
4280
4472
  "type_url": {
4281
4473
  "type": "string",
4282
4474
  "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.",
4475
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
4476
+ "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 ).",
4283
4477
  "minLength": 0,
4284
4478
  "maxLength": 1024,
4285
4479
  "x-f5xc-required-for": {
@@ -4303,9 +4497,11 @@
4303
4497
  },
4304
4498
  "x-original-maxLength": 1024,
4305
4499
  "x-reconciled-from-discovery": true,
4306
- "x-reconciled-at": "2026-01-05T14:38:45.902141+00:00"
4500
+ "x-reconciled-at": "2026-01-07T15:29:07.299632+00:00"
4307
4501
  }
4308
4502
  },
4503
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
4504
+ "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...",
4309
4505
  "x-f5xc-minimum-configuration": {
4310
4506
  "description": "Minimum configuration for protobufAny",
4311
4507
  "required_fields": [
@@ -4331,6 +4527,8 @@
4331
4527
  "description": "Hostname of the instance of the site that sent the status.",
4332
4528
  "title": "Hostname",
4333
4529
  "x-displayname": "Hostname",
4530
+ "x-f5xc-example": "example-resource",
4531
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
4334
4532
  "minLength": 0,
4335
4533
  "maxLength": 1024,
4336
4534
  "x-f5xc-required-for": {
@@ -4362,6 +4560,8 @@
4362
4560
  "x-displayname": "Reason",
4363
4561
  "x-ves-example": "Value",
4364
4562
  "x-f5xc-example": "value",
4563
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
4564
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
4365
4565
  "minLength": 0,
4366
4566
  "maxLength": 43,
4367
4567
  "x-f5xc-required-for": {
@@ -4372,13 +4572,15 @@
4372
4572
  },
4373
4573
  "x-original-maxLength": 1024,
4374
4574
  "x-reconciled-from-discovery": true,
4375
- "x-reconciled-at": "2026-01-05T14:38:45.902150+00:00"
4575
+ "x-reconciled-at": "2026-01-07T15:29:07.299640+00:00"
4376
4576
  },
4377
4577
  "service_name": {
4378
4578
  "type": "string",
4379
4579
  "description": "Name of the service that sent the status.",
4380
4580
  "title": "Service name.",
4381
4581
  "x-displayname": "Service Name.",
4582
+ "x-f5xc-example": "example-resource",
4583
+ "x-f5xc-description-short": "Name of the service that sent the status.",
4382
4584
  "minLength": 0,
4383
4585
  "maxLength": 1024,
4384
4586
  "x-f5xc-required-for": {
@@ -4401,6 +4603,8 @@
4401
4603
  "x-validation-rules": {
4402
4604
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
4403
4605
  },
4606
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
4607
+ "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...",
4404
4608
  "minLength": 0,
4405
4609
  "maxLength": 17,
4406
4610
  "x-f5xc-required-for": {
@@ -4411,7 +4615,7 @@
4411
4615
  },
4412
4616
  "x-original-maxLength": 1024,
4413
4617
  "x-reconciled-from-discovery": true,
4414
- "x-reconciled-at": "2026-01-05T14:38:45.902156+00:00"
4618
+ "x-reconciled-at": "2026-01-07T15:29:07.299645+00:00"
4415
4619
  },
4416
4620
  "type": {
4417
4621
  "type": "string",
@@ -4426,6 +4630,8 @@
4426
4630
  "x-validation-rules": {
4427
4631
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
4428
4632
  },
4633
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
4634
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
4429
4635
  "minLength": 0,
4430
4636
  "maxLength": 1024,
4431
4637
  "x-f5xc-required-for": {
@@ -4436,6 +4642,8 @@
4436
4642
  }
4437
4643
  }
4438
4644
  },
4645
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
4646
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
4439
4647
  "x-f5xc-minimum-configuration": {
4440
4648
  "description": "Minimum configuration for schemaConditionType",
4441
4649
  "required_fields": [
@@ -4471,6 +4679,8 @@
4471
4679
  "default": "EOK",
4472
4680
  "x-displayname": "Error Code.",
4473
4681
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
4682
+ "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...",
4683
+ "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...",
4474
4684
  "x-f5xc-minimum-configuration": {
4475
4685
  "description": "Minimum configuration for schemaErrorCode",
4476
4686
  "required_fields": [],
@@ -4511,6 +4721,7 @@
4511
4721
  }
4512
4722
  }
4513
4723
  },
4724
+ "x-f5xc-description-short": "Information about a error in API operation.",
4514
4725
  "x-f5xc-minimum-configuration": {
4515
4726
  "description": "Minimum configuration for schemaErrorType",
4516
4727
  "required_fields": [
@@ -4538,6 +4749,7 @@
4538
4749
  "title": "Name",
4539
4750
  "x-displayname": "Name",
4540
4751
  "x-f5xc-example": "example-resource",
4752
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
4541
4753
  "minLength": 0,
4542
4754
  "maxLength": 16,
4543
4755
  "x-f5xc-required-for": {
@@ -4548,9 +4760,10 @@
4548
4760
  },
4549
4761
  "x-original-maxLength": 1024,
4550
4762
  "x-reconciled-from-discovery": true,
4551
- "x-reconciled-at": "2026-01-05T14:38:45.902168+00:00"
4763
+ "x-reconciled-at": "2026-01-07T15:29:07.299656+00:00"
4552
4764
  }
4553
4765
  },
4766
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
4554
4767
  "x-f5xc-minimum-configuration": {
4555
4768
  "description": "Minimum configuration for schemaInitializerType",
4556
4769
  "required_fields": [
@@ -4578,6 +4791,8 @@
4578
4791
  "$ref": "#/components/schemas/schemaInitializerType"
4579
4792
  },
4580
4793
  "x-displayname": "Pending",
4794
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
4795
+ "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.",
4581
4796
  "x-f5xc-required-for": {
4582
4797
  "minimum_config": false,
4583
4798
  "create": false,
@@ -4589,6 +4804,7 @@
4589
4804
  "$ref": "#/components/schemas/schemaStatusType"
4590
4805
  }
4591
4806
  },
4807
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
4592
4808
  "x-f5xc-minimum-configuration": {
4593
4809
  "description": "Minimum configuration for schemaInitializersType",
4594
4810
  "required_fields": [
@@ -4627,6 +4843,8 @@
4627
4843
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4628
4844
  "ves.io.schema.rules.map.values.string.min_len": "1"
4629
4845
  },
4846
+ "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.",
4847
+ "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.",
4630
4848
  "x-f5xc-required-for": {
4631
4849
  "minimum_config": false,
4632
4850
  "create": false,
@@ -4648,6 +4866,7 @@
4648
4866
  "x-validation-rules": {
4649
4867
  "ves.io.schema.rules.string.max_bytes": "1200"
4650
4868
  },
4869
+ "x-f5xc-description-short": "Human readable description for the object.",
4651
4870
  "minLength": 0,
4652
4871
  "x-f5xc-required-for": {
4653
4872
  "minimum_config": false,
@@ -4657,7 +4876,7 @@
4657
4876
  },
4658
4877
  "x-original-maxLength": 1200,
4659
4878
  "x-reconciled-from-discovery": true,
4660
- "x-reconciled-at": "2026-01-05T14:38:45.902178+00:00"
4879
+ "x-reconciled-at": "2026-01-07T15:29:07.299666+00:00"
4661
4880
  },
4662
4881
  "disable": {
4663
4882
  "type": "boolean",
@@ -4666,6 +4885,7 @@
4666
4885
  "format": "boolean",
4667
4886
  "x-displayname": "Disable",
4668
4887
  "x-f5xc-example": "true",
4888
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4669
4889
  "x-f5xc-required-for": {
4670
4890
  "minimum_config": false,
4671
4891
  "create": false,
@@ -4679,6 +4899,8 @@
4679
4899
  "title": "Labels",
4680
4900
  "x-displayname": "Labels",
4681
4901
  "x-f5xc-example": "value",
4902
+ "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.",
4903
+ "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.",
4682
4904
  "x-f5xc-required-for": {
4683
4905
  "minimum_config": false,
4684
4906
  "create": false,
@@ -4700,6 +4922,8 @@
4700
4922
  "x-validation-rules": {
4701
4923
  "ves.io.schema.rules.message.required": "true"
4702
4924
  },
4925
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4926
+ "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.",
4703
4927
  "minLength": 0,
4704
4928
  "maxLength": 16,
4705
4929
  "x-f5xc-required-for": {
@@ -4710,7 +4934,7 @@
4710
4934
  },
4711
4935
  "x-original-maxLength": 1024,
4712
4936
  "x-reconciled-from-discovery": true,
4713
- "x-reconciled-at": "2026-01-05T14:38:45.902185+00:00"
4937
+ "x-reconciled-at": "2026-01-07T15:29:07.299673+00:00"
4714
4938
  },
4715
4939
  "namespace": {
4716
4940
  "type": "string",
@@ -4719,6 +4943,8 @@
4719
4943
  "x-displayname": "Namespace",
4720
4944
  "x-ves-example": "Staging",
4721
4945
  "x-f5xc-example": "staging",
4946
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4947
+ "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 \"\".",
4722
4948
  "minLength": 0,
4723
4949
  "maxLength": 6,
4724
4950
  "x-f5xc-required-for": {
@@ -4729,9 +4955,10 @@
4729
4955
  },
4730
4956
  "x-original-maxLength": 1024,
4731
4957
  "x-reconciled-from-discovery": true,
4732
- "x-reconciled-at": "2026-01-05T14:38:45.902190+00:00"
4958
+ "x-reconciled-at": "2026-01-07T15:29:07.299677+00:00"
4733
4959
  }
4734
4960
  },
4961
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
4735
4962
  "x-f5xc-minimum-configuration": {
4736
4963
  "description": "Minimum configuration for schemaObjectCreateMetaType",
4737
4964
  "required_fields": [
@@ -4775,6 +5002,8 @@
4775
5002
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4776
5003
  "ves.io.schema.rules.map.values.string.min_len": "1"
4777
5004
  },
5005
+ "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.",
5006
+ "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.",
4778
5007
  "x-f5xc-required-for": {
4779
5008
  "minimum_config": false,
4780
5009
  "create": false,
@@ -4796,6 +5025,7 @@
4796
5025
  "x-validation-rules": {
4797
5026
  "ves.io.schema.rules.string.max_bytes": "1200"
4798
5027
  },
5028
+ "x-f5xc-description-short": "Human readable description for the object.",
4799
5029
  "minLength": 0,
4800
5030
  "x-f5xc-required-for": {
4801
5031
  "minimum_config": false,
@@ -4805,7 +5035,7 @@
4805
5035
  },
4806
5036
  "x-original-maxLength": 1200,
4807
5037
  "x-reconciled-from-discovery": true,
4808
- "x-reconciled-at": "2026-01-05T14:38:45.902196+00:00"
5038
+ "x-reconciled-at": "2026-01-07T15:29:07.299683+00:00"
4809
5039
  },
4810
5040
  "disable": {
4811
5041
  "type": "boolean",
@@ -4815,6 +5045,7 @@
4815
5045
  "x-displayname": "Disable",
4816
5046
  "x-ves-example": "True",
4817
5047
  "x-f5xc-example": "true",
5048
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4818
5049
  "x-f5xc-required-for": {
4819
5050
  "minimum_config": false,
4820
5051
  "create": false,
@@ -4829,6 +5060,8 @@
4829
5060
  "x-displayname": "Labels",
4830
5061
  "x-ves-example": "Value",
4831
5062
  "x-f5xc-example": "value",
5063
+ "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.",
5064
+ "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.",
4832
5065
  "x-f5xc-required-for": {
4833
5066
  "minimum_config": false,
4834
5067
  "create": false,
@@ -4850,6 +5083,8 @@
4850
5083
  "x-validation-rules": {
4851
5084
  "ves.io.schema.rules.message.required": "true"
4852
5085
  },
5086
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
5087
+ "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.",
4853
5088
  "minLength": 0,
4854
5089
  "maxLength": 16,
4855
5090
  "x-f5xc-required-for": {
@@ -4860,7 +5095,7 @@
4860
5095
  },
4861
5096
  "x-original-maxLength": 1024,
4862
5097
  "x-reconciled-from-discovery": true,
4863
- "x-reconciled-at": "2026-01-05T14:38:45.902204+00:00"
5098
+ "x-reconciled-at": "2026-01-07T15:29:07.299690+00:00"
4864
5099
  },
4865
5100
  "namespace": {
4866
5101
  "type": "string",
@@ -4869,6 +5104,8 @@
4869
5104
  "x-displayname": "Namespace",
4870
5105
  "x-ves-example": "Staging",
4871
5106
  "x-f5xc-example": "staging",
5107
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
5108
+ "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 \"\".",
4872
5109
  "minLength": 0,
4873
5110
  "maxLength": 6,
4874
5111
  "x-f5xc-required-for": {
@@ -4879,9 +5116,10 @@
4879
5116
  },
4880
5117
  "x-original-maxLength": 1024,
4881
5118
  "x-reconciled-from-discovery": true,
4882
- "x-reconciled-at": "2026-01-05T14:38:45.902208+00:00"
5119
+ "x-reconciled-at": "2026-01-07T15:29:07.299694+00:00"
4883
5120
  }
4884
5121
  },
5122
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
4885
5123
  "x-f5xc-minimum-configuration": {
4886
5124
  "description": "Minimum configuration for schemaObjectGetMetaType",
4887
5125
  "required_fields": [
@@ -4913,6 +5151,8 @@
4913
5151
  "x-displayname": "Kind",
4914
5152
  "x-ves-example": "Virtual_site.",
4915
5153
  "x-f5xc-example": "virtual_site",
5154
+ "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\")",
5155
+ "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\").",
4916
5156
  "minLength": 0,
4917
5157
  "maxLength": 14,
4918
5158
  "x-f5xc-required-for": {
@@ -4924,7 +5164,7 @@
4924
5164
  "readOnly": true,
4925
5165
  "x-original-maxLength": 1024,
4926
5166
  "x-reconciled-from-discovery": true,
4927
- "x-reconciled-at": "2026-01-05T14:38:45.902213+00:00"
5167
+ "x-reconciled-at": "2026-01-07T15:29:07.299699+00:00"
4928
5168
  },
4929
5169
  "name": {
4930
5170
  "type": "string",
@@ -4933,6 +5173,8 @@
4933
5173
  "x-displayname": "Name",
4934
5174
  "x-ves-example": "Contactus-route.",
4935
5175
  "x-f5xc-example": "contactus-route",
5176
+ "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.",
5177
+ "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.",
4936
5178
  "minLength": 0,
4937
5179
  "maxLength": 16,
4938
5180
  "x-f5xc-required-for": {
@@ -4943,7 +5185,7 @@
4943
5185
  },
4944
5186
  "x-original-maxLength": 1024,
4945
5187
  "x-reconciled-from-discovery": true,
4946
- "x-reconciled-at": "2026-01-05T14:38:45.902217+00:00"
5188
+ "x-reconciled-at": "2026-01-07T15:29:07.299703+00:00"
4947
5189
  },
4948
5190
  "namespace": {
4949
5191
  "type": "string",
@@ -4952,6 +5194,8 @@
4952
5194
  "x-displayname": "Namespace",
4953
5195
  "x-ves-example": "Ns1",
4954
5196
  "x-f5xc-example": "ns1",
5197
+ "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.",
5198
+ "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.",
4955
5199
  "minLength": 0,
4956
5200
  "maxLength": 6,
4957
5201
  "x-f5xc-required-for": {
@@ -4962,7 +5206,7 @@
4962
5206
  },
4963
5207
  "x-original-maxLength": 1024,
4964
5208
  "x-reconciled-from-discovery": true,
4965
- "x-reconciled-at": "2026-01-05T14:38:45.902221+00:00"
5209
+ "x-reconciled-at": "2026-01-07T15:29:07.299707+00:00"
4966
5210
  },
4967
5211
  "tenant": {
4968
5212
  "type": "string",
@@ -4971,6 +5215,8 @@
4971
5215
  "x-displayname": "Tenant",
4972
5216
  "x-ves-example": "Example-corp.",
4973
5217
  "x-f5xc-example": "example-corp",
5218
+ "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.",
5219
+ "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.",
4974
5220
  "minLength": 0,
4975
5221
  "maxLength": 18,
4976
5222
  "x-f5xc-required-for": {
@@ -4983,7 +5229,7 @@
4983
5229
  "x-field-mutability": "read-only",
4984
5230
  "x-original-maxLength": 1024,
4985
5231
  "x-reconciled-from-discovery": true,
4986
- "x-reconciled-at": "2026-01-05T14:38:45.902225+00:00"
5232
+ "x-reconciled-at": "2026-01-07T15:29:07.299711+00:00"
4987
5233
  },
4988
5234
  "uid": {
4989
5235
  "type": "string",
@@ -4992,6 +5238,8 @@
4992
5238
  "x-displayname": "UID",
4993
5239
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
4994
5240
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5241
+ "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.",
5242
+ "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.",
4995
5243
  "minLength": 0,
4996
5244
  "maxLength": 36,
4997
5245
  "x-f5xc-required-for": {
@@ -5005,9 +5253,11 @@
5005
5253
  "x-original-maxLength": 1024,
5006
5254
  "format": "uuid",
5007
5255
  "x-reconciled-from-discovery": true,
5008
- "x-reconciled-at": "2026-01-05T14:38:45.902231+00:00"
5256
+ "x-reconciled-at": "2026-01-07T15:29:07.299716+00:00"
5009
5257
  }
5010
5258
  },
5259
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
5260
+ "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...",
5011
5261
  "x-f5xc-minimum-configuration": {
5012
5262
  "description": "Minimum configuration for schemaObjectRefType",
5013
5263
  "required_fields": [
@@ -5050,6 +5300,8 @@
5050
5300
  "ves.io.schema.rules.map.values.string.max_len": "1024",
5051
5301
  "ves.io.schema.rules.map.values.string.min_len": "1"
5052
5302
  },
5303
+ "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.",
5304
+ "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.",
5053
5305
  "x-f5xc-required-for": {
5054
5306
  "minimum_config": false,
5055
5307
  "create": false,
@@ -5071,6 +5323,7 @@
5071
5323
  "x-validation-rules": {
5072
5324
  "ves.io.schema.rules.string.max_bytes": "1200"
5073
5325
  },
5326
+ "x-f5xc-description-short": "Human readable description for the object.",
5074
5327
  "minLength": 0,
5075
5328
  "x-f5xc-required-for": {
5076
5329
  "minimum_config": false,
@@ -5080,7 +5333,7 @@
5080
5333
  },
5081
5334
  "x-original-maxLength": 1200,
5082
5335
  "x-reconciled-from-discovery": true,
5083
- "x-reconciled-at": "2026-01-05T14:38:45.902238+00:00"
5336
+ "x-reconciled-at": "2026-01-07T15:29:07.299723+00:00"
5084
5337
  },
5085
5338
  "disable": {
5086
5339
  "type": "boolean",
@@ -5089,6 +5342,7 @@
5089
5342
  "format": "boolean",
5090
5343
  "x-displayname": "Disable",
5091
5344
  "x-f5xc-example": "true",
5345
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
5092
5346
  "x-f5xc-required-for": {
5093
5347
  "minimum_config": false,
5094
5348
  "create": false,
@@ -5103,6 +5357,8 @@
5103
5357
  "x-displayname": "Labels",
5104
5358
  "x-ves-example": "Value",
5105
5359
  "x-f5xc-example": "value",
5360
+ "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.",
5361
+ "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.",
5106
5362
  "x-f5xc-required-for": {
5107
5363
  "minimum_config": false,
5108
5364
  "create": false,
@@ -5123,6 +5379,8 @@
5123
5379
  "x-validation-rules": {
5124
5380
  "ves.io.schema.rules.message.required": "true"
5125
5381
  },
5382
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
5383
+ "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.",
5126
5384
  "minLength": 0,
5127
5385
  "maxLength": 16,
5128
5386
  "x-f5xc-required-for": {
@@ -5133,7 +5391,7 @@
5133
5391
  },
5134
5392
  "x-original-maxLength": 1024,
5135
5393
  "x-reconciled-from-discovery": true,
5136
- "x-reconciled-at": "2026-01-05T14:38:45.902245+00:00"
5394
+ "x-reconciled-at": "2026-01-07T15:29:07.299730+00:00"
5137
5395
  },
5138
5396
  "namespace": {
5139
5397
  "type": "string",
@@ -5142,6 +5400,8 @@
5142
5400
  "x-displayname": "Namespace",
5143
5401
  "x-ves-example": "Staging",
5144
5402
  "x-f5xc-example": "staging",
5403
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
5404
+ "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 \"\".",
5145
5405
  "minLength": 0,
5146
5406
  "maxLength": 6,
5147
5407
  "x-f5xc-required-for": {
@@ -5152,9 +5412,10 @@
5152
5412
  },
5153
5413
  "x-original-maxLength": 1024,
5154
5414
  "x-reconciled-from-discovery": true,
5155
- "x-reconciled-at": "2026-01-05T14:38:45.902250+00:00"
5415
+ "x-reconciled-at": "2026-01-07T15:29:07.299734+00:00"
5156
5416
  }
5157
5417
  },
5418
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
5158
5419
  "x-f5xc-minimum-configuration": {
5159
5420
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
5160
5421
  "required_fields": [
@@ -5185,6 +5446,8 @@
5185
5446
  "title": "Creation_timestamp.",
5186
5447
  "format": "date-time",
5187
5448
  "x-displayname": "Creation Timestamp.",
5449
+ "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.",
5450
+ "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.",
5188
5451
  "minLength": 0,
5189
5452
  "maxLength": 1024,
5190
5453
  "x-f5xc-required-for": {
@@ -5202,6 +5465,8 @@
5202
5465
  "x-displayname": "Creator Class.",
5203
5466
  "x-ves-example": "ver.re1.int.ves.I/O.",
5204
5467
  "x-f5xc-example": "ver.re1.int.F5 XC",
5468
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
5469
+ "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.",
5205
5470
  "minLength": 0,
5206
5471
  "maxLength": 1024,
5207
5472
  "x-f5xc-required-for": {
@@ -5219,6 +5484,8 @@
5219
5484
  "x-displayname": "Creator ID.",
5220
5485
  "x-ves-example": "Ver-instance-1.",
5221
5486
  "x-f5xc-example": "ver-instance-1",
5487
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
5488
+ "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.",
5222
5489
  "minLength": 0,
5223
5490
  "maxLength": 1024,
5224
5491
  "x-f5xc-required-for": {
@@ -5237,6 +5504,8 @@
5237
5504
  "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)",
5238
5505
  "title": "Status_id",
5239
5506
  "x-displayname": "Status ID",
5507
+ "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...",
5508
+ "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).",
5240
5509
  "minLength": 0,
5241
5510
  "maxLength": 1024,
5242
5511
  "x-f5xc-required-for": {
@@ -5254,6 +5523,7 @@
5254
5523
  "x-displayname": "UID",
5255
5524
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5256
5525
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5526
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
5257
5527
  "minLength": 0,
5258
5528
  "maxLength": 36,
5259
5529
  "x-f5xc-required-for": {
@@ -5266,13 +5536,14 @@
5266
5536
  "x-original-maxLength": 1024,
5267
5537
  "format": "uuid",
5268
5538
  "x-reconciled-from-discovery": true,
5269
- "x-reconciled-at": "2026-01-05T14:38:45.902263+00:00"
5539
+ "x-reconciled-at": "2026-01-07T15:29:07.299746+00:00"
5270
5540
  },
5271
5541
  "vtrp_id": {
5272
5542
  "type": "string",
5273
5543
  "description": "Origin of this status exchanged by VTRP.",
5274
5544
  "title": "Vtrp_id",
5275
5545
  "x-displayname": "VTRP ID",
5546
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
5276
5547
  "minLength": 0,
5277
5548
  "maxLength": 1024,
5278
5549
  "x-f5xc-required-for": {
@@ -5289,6 +5560,7 @@
5289
5560
  "title": "Vtrp_stale.",
5290
5561
  "format": "boolean",
5291
5562
  "x-displayname": "VTRP Stale.",
5563
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
5292
5564
  "x-f5xc-required-for": {
5293
5565
  "minimum_config": false,
5294
5566
  "create": false,
@@ -5297,6 +5569,7 @@
5297
5569
  }
5298
5570
  }
5299
5571
  },
5572
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
5300
5573
  "x-f5xc-minimum-configuration": {
5301
5574
  "description": "Minimum configuration for schemaStatusMetaType",
5302
5575
  "required_fields": [
@@ -5327,6 +5600,8 @@
5327
5600
  "default": "STATUS_DO_NOT_PUBLISH",
5328
5601
  "x-displayname": "Status Publish Type.",
5329
5602
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
5603
+ "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.",
5604
+ "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.",
5330
5605
  "x-f5xc-minimum-configuration": {
5331
5606
  "description": "Minimum configuration for schemaStatusPublishType",
5332
5607
  "required_fields": [],
@@ -5352,6 +5627,7 @@
5352
5627
  "x-displayname": "Code",
5353
5628
  "x-ves-example": "0",
5354
5629
  "x-f5xc-example": "0",
5630
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
5355
5631
  "minimum": 0,
5356
5632
  "maximum": 2147483647,
5357
5633
  "x-f5xc-required-for": {
@@ -5368,6 +5644,8 @@
5368
5644
  "x-displayname": "Reason",
5369
5645
  "x-ves-example": "Value",
5370
5646
  "x-f5xc-example": "value",
5647
+ "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.",
5648
+ "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.",
5371
5649
  "minLength": 0,
5372
5650
  "maxLength": 43,
5373
5651
  "x-f5xc-required-for": {
@@ -5378,7 +5656,7 @@
5378
5656
  },
5379
5657
  "x-original-maxLength": 1024,
5380
5658
  "x-reconciled-from-discovery": true,
5381
- "x-reconciled-at": "2026-01-05T14:38:45.902273+00:00"
5659
+ "x-reconciled-at": "2026-01-07T15:29:07.299755+00:00"
5382
5660
  },
5383
5661
  "status": {
5384
5662
  "type": "string",
@@ -5387,6 +5665,7 @@
5387
5665
  "x-displayname": "Status",
5388
5666
  "x-ves-example": "Value",
5389
5667
  "x-f5xc-example": "value",
5668
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
5390
5669
  "minLength": 0,
5391
5670
  "maxLength": 17,
5392
5671
  "x-f5xc-required-for": {
@@ -5397,9 +5676,10 @@
5397
5676
  },
5398
5677
  "x-original-maxLength": 1024,
5399
5678
  "x-reconciled-from-discovery": true,
5400
- "x-reconciled-at": "2026-01-05T14:38:45.902277+00:00"
5679
+ "x-reconciled-at": "2026-01-07T15:29:07.299759+00:00"
5401
5680
  }
5402
5681
  },
5682
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
5403
5683
  "x-f5xc-minimum-configuration": {
5404
5684
  "description": "Minimum configuration for schemaStatusType",
5405
5685
  "required_fields": [
@@ -5427,6 +5707,8 @@
5427
5707
  "title": "Creation_timestamp.",
5428
5708
  "format": "date-time",
5429
5709
  "x-displayname": "Creation Timestamp.",
5710
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
5711
+ "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.",
5430
5712
  "minLength": 0,
5431
5713
  "maxLength": 1024,
5432
5714
  "x-f5xc-required-for": {
@@ -5444,6 +5726,7 @@
5444
5726
  "x-displayname": "Creator Class.",
5445
5727
  "x-ves-example": "Prism",
5446
5728
  "x-f5xc-example": "value",
5729
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
5447
5730
  "minLength": 0,
5448
5731
  "maxLength": 1024,
5449
5732
  "x-f5xc-required-for": {
@@ -5461,6 +5744,7 @@
5461
5744
  "x-displayname": "Creator ID.",
5462
5745
  "x-ves-example": "Admin@example-corp.com.",
5463
5746
  "x-f5xc-example": "value",
5747
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
5464
5748
  "minLength": 0,
5465
5749
  "maxLength": 1024,
5466
5750
  "x-f5xc-required-for": {
@@ -5477,6 +5761,8 @@
5477
5761
  "title": "Deletion_timestamp.",
5478
5762
  "format": "date-time",
5479
5763
  "x-displayname": "Deletion Timestamp.",
5764
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
5765
+ "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...",
5480
5766
  "minLength": 0,
5481
5767
  "maxLength": 1024,
5482
5768
  "x-f5xc-required-for": {
@@ -5496,6 +5782,8 @@
5496
5782
  "x-displayname": "Finalizers.",
5497
5783
  "x-ves-example": "Value",
5498
5784
  "x-f5xc-example": "value",
5785
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
5786
+ "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.",
5499
5787
  "x-f5xc-required-for": {
5500
5788
  "minimum_config": false,
5501
5789
  "create": false,
@@ -5513,6 +5801,8 @@
5513
5801
  "x-displayname": "Labels",
5514
5802
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
5515
5803
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
5804
+ "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.",
5805
+ "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).",
5516
5806
  "x-f5xc-required-for": {
5517
5807
  "minimum_config": false,
5518
5808
  "create": false,
@@ -5526,6 +5816,8 @@
5526
5816
  "title": "Modification_timestamp.",
5527
5817
  "format": "date-time",
5528
5818
  "x-displayname": "Modification Timestamp.",
5819
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5820
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5529
5821
  "minLength": 0,
5530
5822
  "maxLength": 1024,
5531
5823
  "x-f5xc-required-for": {
@@ -5544,6 +5836,8 @@
5544
5836
  "x-displayname": "Object Index.",
5545
5837
  "x-ves-example": "0",
5546
5838
  "x-f5xc-example": "0",
5839
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
5840
+ "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.",
5547
5841
  "minimum": 0,
5548
5842
  "maximum": 2147483647,
5549
5843
  "x-f5xc-required-for": {
@@ -5564,6 +5858,8 @@
5564
5858
  "x-displayname": "Tenant",
5565
5859
  "x-ves-example": "Example-corp.",
5566
5860
  "x-f5xc-example": "example-corp",
5861
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5862
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5567
5863
  "minLength": 0,
5568
5864
  "maxLength": 18,
5569
5865
  "x-f5xc-required-for": {
@@ -5575,7 +5871,7 @@
5575
5871
  "x-field-mutability": "read-only",
5576
5872
  "x-original-maxLength": 1024,
5577
5873
  "x-reconciled-from-discovery": true,
5578
- "x-reconciled-at": "2026-01-05T14:38:45.902297+00:00"
5874
+ "x-reconciled-at": "2026-01-07T15:29:07.299778+00:00"
5579
5875
  },
5580
5876
  "uid": {
5581
5877
  "type": "string",
@@ -5584,6 +5880,8 @@
5584
5880
  "x-displayname": "UID",
5585
5881
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5586
5882
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5883
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
5884
+ "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.",
5587
5885
  "minLength": 0,
5588
5886
  "maxLength": 36,
5589
5887
  "x-f5xc-required-for": {
@@ -5596,9 +5894,11 @@
5596
5894
  "x-original-maxLength": 1024,
5597
5895
  "format": "uuid",
5598
5896
  "x-reconciled-from-discovery": true,
5599
- "x-reconciled-at": "2026-01-05T14:38:45.902302+00:00"
5897
+ "x-reconciled-at": "2026-01-07T15:29:07.299783+00:00"
5600
5898
  }
5601
5899
  },
5900
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5901
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5602
5902
  "x-f5xc-minimum-configuration": {
5603
5903
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
5604
5904
  "required_fields": [
@@ -5646,7 +5946,7 @@
5646
5946
  },
5647
5947
  "x-original-maxLength": 1024,
5648
5948
  "x-reconciled-from-discovery": true,
5649
- "x-reconciled-at": "2026-01-05T14:38:45.902307+00:00"
5949
+ "x-reconciled-at": "2026-01-07T15:29:07.299788+00:00"
5650
5950
  },
5651
5951
  "name": {
5652
5952
  "type": "string",
@@ -5655,6 +5955,8 @@
5655
5955
  "x-displayname": "Name",
5656
5956
  "x-ves-example": "Contactus-route.",
5657
5957
  "x-f5xc-example": "contactus-route",
5958
+ "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.",
5959
+ "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.",
5658
5960
  "minLength": 0,
5659
5961
  "maxLength": 16,
5660
5962
  "x-f5xc-required-for": {
@@ -5665,7 +5967,7 @@
5665
5967
  },
5666
5968
  "x-original-maxLength": 1024,
5667
5969
  "x-reconciled-from-discovery": true,
5668
- "x-reconciled-at": "2026-01-05T14:38:45.902311+00:00"
5970
+ "x-reconciled-at": "2026-01-07T15:29:07.299792+00:00"
5669
5971
  },
5670
5972
  "namespace": {
5671
5973
  "type": "string",
@@ -5674,6 +5976,8 @@
5674
5976
  "x-displayname": "Namespace",
5675
5977
  "x-ves-example": "Ns1",
5676
5978
  "x-f5xc-example": "ns1",
5979
+ "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.",
5980
+ "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.",
5677
5981
  "minLength": 0,
5678
5982
  "maxLength": 6,
5679
5983
  "x-f5xc-required-for": {
@@ -5684,7 +5988,7 @@
5684
5988
  },
5685
5989
  "x-original-maxLength": 1024,
5686
5990
  "x-reconciled-from-discovery": true,
5687
- "x-reconciled-at": "2026-01-05T14:38:45.902315+00:00"
5991
+ "x-reconciled-at": "2026-01-07T15:29:07.299796+00:00"
5688
5992
  },
5689
5993
  "uid": {
5690
5994
  "type": "string",
@@ -5705,9 +6009,10 @@
5705
6009
  "x-original-maxLength": 1024,
5706
6010
  "format": "uuid",
5707
6011
  "x-reconciled-from-discovery": true,
5708
- "x-reconciled-at": "2026-01-05T14:38:45.902320+00:00"
6012
+ "x-reconciled-at": "2026-01-07T15:29:07.299800+00:00"
5709
6013
  }
5710
6014
  },
6015
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
5711
6016
  "x-f5xc-minimum-configuration": {
5712
6017
  "description": "Minimum configuration for schemaViewRefType",
5713
6018
  "required_fields": [
@@ -5802,6 +6107,7 @@
5802
6107
  "ves.io.schema.rules.repeated.max_items": "64",
5803
6108
  "ves.io.schema.rules.repeated.unique": "true"
5804
6109
  },
6110
+ "x-f5xc-description-short": "List of L4 protocol match condition and associated traffic rate limits.",
5805
6111
  "x-f5xc-required-for": {
5806
6112
  "minimum_config": false,
5807
6113
  "create": false,
@@ -5810,6 +6116,8 @@
5810
6116
  }
5811
6117
  }
5812
6118
  },
6119
+ "x-f5xc-description-short": "Create a protocol_policer object, protocol_policer object contains list of L4 protocol match condition and corresponding traffic rate limits.",
6120
+ "x-f5xc-description-medium": "Create a protocol_policer object, protocol_policer object contains list of L4 protocol match condition and corresponding traffic rate limits.",
5813
6121
  "x-f5xc-minimum-configuration": {
5814
6122
  "description": "Minimum configuration for protocol_policerCreateSpecType",
5815
6123
  "required_fields": [
@@ -5835,6 +6143,7 @@
5835
6143
  "title": "Fail_if_referred.",
5836
6144
  "format": "boolean",
5837
6145
  "x-displayname": "Fail-If-Referred.",
6146
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
5838
6147
  "x-f5xc-required-for": {
5839
6148
  "minimum_config": false,
5840
6149
  "create": false,
@@ -5859,7 +6168,7 @@
5859
6168
  },
5860
6169
  "x-original-maxLength": 1024,
5861
6170
  "x-reconciled-from-discovery": true,
5862
- "x-reconciled-at": "2026-01-05T14:38:47.251108+00:00"
6171
+ "x-reconciled-at": "2026-01-07T15:29:08.837250+00:00"
5863
6172
  },
5864
6173
  "namespace": {
5865
6174
  "type": "string",
@@ -5868,6 +6177,7 @@
5868
6177
  "x-displayname": "Namespace",
5869
6178
  "x-ves-example": "Ns1",
5870
6179
  "x-f5xc-example": "ns1",
6180
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
5871
6181
  "minLength": 0,
5872
6182
  "maxLength": 6,
5873
6183
  "x-f5xc-required-for": {
@@ -5878,7 +6188,7 @@
5878
6188
  },
5879
6189
  "x-original-maxLength": 1024,
5880
6190
  "x-reconciled-from-discovery": true,
5881
- "x-reconciled-at": "2026-01-05T14:38:47.251113+00:00"
6191
+ "x-reconciled-at": "2026-01-07T15:29:08.837255+00:00"
5882
6192
  }
5883
6193
  },
5884
6194
  "x-f5xc-minimum-configuration": {
@@ -5901,6 +6211,7 @@
5901
6211
  "title": "DNS packets.",
5902
6212
  "x-displayname": "DNS Packets.",
5903
6213
  "x-ves-proto-message": "ves.io.schema.protocol_policer.DnsType",
6214
+ "x-f5xc-description-short": "Match all DNS packets inclusing UDP and TCP.",
5904
6215
  "x-f5xc-minimum-configuration": {
5905
6216
  "description": "Minimum configuration for protocol_policerDnsType",
5906
6217
  "required_fields": [],
@@ -5929,6 +6240,7 @@
5929
6240
  "$ref": "#/components/schemas/schemaObjectRefType"
5930
6241
  },
5931
6242
  "x-displayname": "Deleted Referred Objects.",
6243
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5932
6244
  "x-f5xc-required-for": {
5933
6245
  "minimum_config": false,
5934
6246
  "create": false,
@@ -5944,6 +6256,7 @@
5944
6256
  "$ref": "#/components/schemas/schemaObjectRefType"
5945
6257
  },
5946
6258
  "x-displayname": "Disabled Referred Objects.",
6259
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5947
6260
  "x-f5xc-required-for": {
5948
6261
  "minimum_config": false,
5949
6262
  "create": false,
@@ -5962,6 +6275,7 @@
5962
6275
  "$ref": "#/components/schemas/schemaObjectRefType"
5963
6276
  },
5964
6277
  "x-displayname": "Referring Objects.",
6278
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
5965
6279
  "x-f5xc-required-for": {
5966
6280
  "minimum_config": false,
5967
6281
  "create": false,
@@ -5983,6 +6297,8 @@
5983
6297
  "$ref": "#/components/schemas/protocol_policerStatusObject"
5984
6298
  },
5985
6299
  "x-displayname": "Status",
6300
+ "x-f5xc-example": "active",
6301
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5986
6302
  "x-f5xc-required-for": {
5987
6303
  "minimum_config": false,
5988
6304
  "create": false,
@@ -5992,7 +6308,7 @@
5992
6308
  "maxLength": 17,
5993
6309
  "minLength": 17,
5994
6310
  "x-reconciled-from-discovery": true,
5995
- "x-reconciled-at": "2026-01-05T14:38:47.251130+00:00"
6311
+ "x-reconciled-at": "2026-01-07T15:29:08.837271+00:00"
5996
6312
  },
5997
6313
  "system_metadata": {
5998
6314
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -6032,6 +6348,8 @@
6032
6348
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
6033
6349
  ],
6034
6350
  "default": "GET_RSP_FORMAT_DEFAULT",
6351
+ "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...",
6352
+ "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...",
6035
6353
  "x-f5xc-minimum-configuration": {
6036
6354
  "description": "Minimum configuration for protocol_policerGetResponseFormatCode",
6037
6355
  "required_fields": [],
@@ -6066,6 +6384,7 @@
6066
6384
  "ves.io.schema.rules.repeated.max_items": "64",
6067
6385
  "ves.io.schema.rules.repeated.unique": "true"
6068
6386
  },
6387
+ "x-f5xc-description-short": "List of L4 protocol match condition and associated traffic rate limits.",
6069
6388
  "x-f5xc-required-for": {
6070
6389
  "minimum_config": false,
6071
6390
  "create": false,
@@ -6074,6 +6393,8 @@
6074
6393
  }
6075
6394
  }
6076
6395
  },
6396
+ "x-f5xc-description-short": "GET specification of a protocol_policer object with L4 protocol match condition and corresponding traffic rate limits.",
6397
+ "x-f5xc-description-medium": "GET specification of a protocol_policer object with L4 protocol match condition and corresponding traffic rate limits.",
6077
6398
  "x-f5xc-minimum-configuration": {
6078
6399
  "description": "Minimum configuration for protocol_policerGetSpecType",
6079
6400
  "required_fields": [
@@ -6098,6 +6419,8 @@
6098
6419
  "default": "ECHO_REPLY",
6099
6420
  "x-displayname": "ICMP Message Types.",
6100
6421
  "x-ves-proto-enum": "ves.io.schema.protocol_policer.IcmpMsgType",
6422
+ "x-f5xc-description-short": "ICMP echo request packet which is sent by originator of Ping packet ICMP echo reply packet which is sent in responce to ICMP echo request packet...",
6423
+ "x-f5xc-description-medium": "ICMP echo request packet which is sent by originator of Ping packet ICMP echo reply packet which is sent in responce to ICMP echo request packet All ICMP packet types including TTL exceeded, destination unreachable and source quench etc.",
6101
6424
  "x-f5xc-minimum-configuration": {
6102
6425
  "description": "Minimum configuration for protocol_policerIcmpMsgType",
6103
6426
  "required_fields": [],
@@ -6123,6 +6446,7 @@
6123
6446
  "$ref": "#/components/schemas/protocol_policerIcmpMsgType"
6124
6447
  },
6125
6448
  "x-displayname": "ICMP type",
6449
+ "x-f5xc-description-short": "ICMP message type to be matched in packet.",
6126
6450
  "x-f5xc-required-for": {
6127
6451
  "minimum_config": false,
6128
6452
  "create": false,
@@ -6158,6 +6482,7 @@
6158
6482
  "$ref": "#/components/schemas/schemaErrorType"
6159
6483
  },
6160
6484
  "x-displayname": "Errors",
6485
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
6161
6486
  "x-f5xc-required-for": {
6162
6487
  "minimum_config": false,
6163
6488
  "create": false,
@@ -6173,6 +6498,8 @@
6173
6498
  "$ref": "#/components/schemas/protocol_policerListResponseItem"
6174
6499
  },
6175
6500
  "x-displayname": "Items",
6501
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
6502
+ "x-f5xc-description-short": "Items represents the collection in response.",
6176
6503
  "x-f5xc-required-for": {
6177
6504
  "minimum_config": false,
6178
6505
  "create": false,
@@ -6206,6 +6533,8 @@
6206
6533
  "description": "The set of annotations present on this protocol_policer.",
6207
6534
  "title": "Annotations.",
6208
6535
  "x-displayname": "Annotations.",
6536
+ "x-f5xc-example": "{\"key\": \"value\"}",
6537
+ "x-f5xc-description-short": "The set of annotations present on this protocol_policer.",
6209
6538
  "x-f5xc-required-for": {
6210
6539
  "minimum_config": false,
6211
6540
  "create": false,
@@ -6218,6 +6547,7 @@
6218
6547
  "description": "The description set for this protocol_policer.",
6219
6548
  "title": "Description.",
6220
6549
  "x-displayname": "Description.",
6550
+ "x-f5xc-description-short": "The description set for this protocol_policer.",
6221
6551
  "minLength": 0,
6222
6552
  "maxLength": 0,
6223
6553
  "x-f5xc-required-for": {
@@ -6228,7 +6558,7 @@
6228
6558
  },
6229
6559
  "x-original-maxLength": 1024,
6230
6560
  "x-reconciled-from-discovery": true,
6231
- "x-reconciled-at": "2026-01-05T14:38:47.251147+00:00"
6561
+ "x-reconciled-at": "2026-01-07T15:29:08.837288+00:00"
6232
6562
  },
6233
6563
  "disabled": {
6234
6564
  "type": "boolean",
@@ -6236,6 +6566,8 @@
6236
6566
  "title": "Disabled",
6237
6567
  "format": "boolean",
6238
6568
  "x-displayname": "Disabled",
6569
+ "x-f5xc-example": "True",
6570
+ "x-f5xc-description-short": "Value of true indicates protocol_policer is administratively disabled.",
6239
6571
  "x-f5xc-required-for": {
6240
6572
  "minimum_config": false,
6241
6573
  "create": false,
@@ -6251,6 +6583,8 @@
6251
6583
  "description": "The set of labels present on this protocol_policer.",
6252
6584
  "title": "Labels",
6253
6585
  "x-displayname": "Labels",
6586
+ "x-f5xc-example": "{\"key\": \"value\"}",
6587
+ "x-f5xc-description-short": "The set of labels present on this protocol_policer.",
6254
6588
  "x-f5xc-required-for": {
6255
6589
  "minimum_config": false,
6256
6590
  "create": false,
@@ -6278,7 +6612,7 @@
6278
6612
  },
6279
6613
  "x-original-maxLength": 1024,
6280
6614
  "x-reconciled-from-discovery": true,
6281
- "x-reconciled-at": "2026-01-05T14:38:47.251158+00:00"
6615
+ "x-reconciled-at": "2026-01-07T15:29:08.837298+00:00"
6282
6616
  },
6283
6617
  "namespace": {
6284
6618
  "type": "string",
@@ -6297,7 +6631,7 @@
6297
6631
  },
6298
6632
  "x-original-maxLength": 1024,
6299
6633
  "x-reconciled-from-discovery": true,
6300
- "x-reconciled-at": "2026-01-05T14:38:47.251163+00:00"
6634
+ "x-reconciled-at": "2026-01-07T15:29:08.837302+00:00"
6301
6635
  },
6302
6636
  "owner_view": {
6303
6637
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -6310,6 +6644,7 @@
6310
6644
  "$ref": "#/components/schemas/protocol_policerStatusObject"
6311
6645
  },
6312
6646
  "x-displayname": "Status",
6647
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6313
6648
  "x-f5xc-required-for": {
6314
6649
  "minimum_config": false,
6315
6650
  "create": false,
@@ -6338,7 +6673,7 @@
6338
6673
  "x-field-mutability": "read-only",
6339
6674
  "x-original-maxLength": 1024,
6340
6675
  "x-reconciled-from-discovery": true,
6341
- "x-reconciled-at": "2026-01-05T14:38:47.251171+00:00"
6676
+ "x-reconciled-at": "2026-01-07T15:29:08.837310+00:00"
6342
6677
  },
6343
6678
  "uid": {
6344
6679
  "type": "string",
@@ -6347,6 +6682,7 @@
6347
6682
  "x-displayname": "UID",
6348
6683
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
6349
6684
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
6685
+ "x-f5xc-description-short": "The unique uid of this protocol_policer.",
6350
6686
  "minLength": 0,
6351
6687
  "maxLength": 36,
6352
6688
  "x-f5xc-required-for": {
@@ -6359,9 +6695,11 @@
6359
6695
  "x-original-maxLength": 1024,
6360
6696
  "format": "uuid",
6361
6697
  "x-reconciled-from-discovery": true,
6362
- "x-reconciled-at": "2026-01-05T14:38:47.251177+00:00"
6698
+ "x-reconciled-at": "2026-01-07T15:29:08.837316+00:00"
6363
6699
  }
6364
6700
  },
6701
+ "x-f5xc-description-short": "By default a summary of protocol_policer is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6702
+ "x-f5xc-description-medium": "By default a summary of protocol_policer is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6365
6703
  "x-f5xc-minimum-configuration": {
6366
6704
  "description": "Minimum configuration for protocol_policerListResponseItem",
6367
6705
  "required_fields": [
@@ -6414,6 +6752,7 @@
6414
6752
  "ves.io.schema.rules.repeated.max_items": "1",
6415
6753
  "ves.io.schema.rules.repeated.min_items": "1"
6416
6754
  },
6755
+ "x-f5xc-description-short": "Reference to policer object to apply traffic rate limits Required: YES.",
6417
6756
  "x-f5xc-required-for": {
6418
6757
  "minimum_config": false,
6419
6758
  "create": false,
@@ -6425,6 +6764,8 @@
6425
6764
  "$ref": "#/components/schemas/protocol_policerProtocolType"
6426
6765
  }
6427
6766
  },
6767
+ "x-f5xc-description-short": "Protocol policer has set or network protocol fields and flags to be match on a layer 4 packet and corresponding rate limit to be applied, this...",
6768
+ "x-f5xc-description-medium": "Protocol policer has set or network protocol fields and flags to be match on a layer 4 packet and corresponding rate limit to be applied, this would be useful in specifying * Ratelimiting TCP sessions accepted from in a given duration * Ratelimiting various ICMP message type packets *...",
6428
6769
  "x-f5xc-minimum-configuration": {
6429
6770
  "description": "Minimum configuration for protocol_policerProtocolPolicerType",
6430
6771
  "required_fields": [
@@ -6459,6 +6800,7 @@
6459
6800
  "$ref": "#/components/schemas/protocol_policerUdpType"
6460
6801
  }
6461
6802
  },
6803
+ "x-f5xc-description-short": "Protocol and protocol specific flags to be matched in packet.",
6462
6804
  "x-f5xc-minimum-configuration": {
6463
6805
  "description": "Minimum configuration for protocol_policerProtocolType",
6464
6806
  "required_fields": [
@@ -6538,6 +6880,7 @@
6538
6880
  "ves.io.schema.rules.repeated.max_items": "64",
6539
6881
  "ves.io.schema.rules.repeated.unique": "true"
6540
6882
  },
6883
+ "x-f5xc-description-short": "List of L4 protocol match condition and associated traffic rate limits.",
6541
6884
  "x-f5xc-required-for": {
6542
6885
  "minimum_config": false,
6543
6886
  "create": false,
@@ -6546,6 +6889,8 @@
6546
6889
  }
6547
6890
  }
6548
6891
  },
6892
+ "x-f5xc-description-short": "Replace a protocol_policer object with new L4 protocol match condition and corresponding traffic rate limits.",
6893
+ "x-f5xc-description-medium": "Replace a protocol_policer object with new L4 protocol match condition and corresponding traffic rate limits.",
6549
6894
  "x-f5xc-minimum-configuration": {
6550
6895
  "description": "Minimum configuration for protocol_policerReplaceSpecType",
6551
6896
  "required_fields": [
@@ -6574,6 +6919,7 @@
6574
6919
  "$ref": "#/components/schemas/schemaConditionType"
6575
6920
  },
6576
6921
  "x-displayname": "Conditions.",
6922
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
6577
6923
  "x-f5xc-required-for": {
6578
6924
  "minimum_config": false,
6579
6925
  "create": false,
@@ -6600,6 +6946,7 @@
6600
6946
  }
6601
6947
  }
6602
6948
  },
6949
+ "x-f5xc-description-short": "Most recently observed status of object.",
6603
6950
  "x-f5xc-minimum-configuration": {
6604
6951
  "description": "Minimum configuration for protocol_policerStatusObject",
6605
6952
  "required_fields": [
@@ -6631,6 +6978,8 @@
6631
6978
  "default": "FIN",
6632
6979
  "x-displayname": "TCP Flags",
6633
6980
  "x-ves-proto-enum": "ves.io.schema.protocol_policer.TcpFlags",
6981
+ "x-f5xc-description-short": "TCP flags indicate a particular connection state FIN flag which indicates that there is no more data from the sender, used in the last packet sent...",
6982
+ "x-f5xc-description-medium": "TCP flags indicate a particular connection state FIN flag which indicates that there is no more data from the sender, used in the last packet sent from the sender SYN flag set in the first packet from sender and receiver while establishing three way handshake between two hosts RST flag that...",
6634
6983
  "x-f5xc-minimum-configuration": {
6635
6984
  "description": "Minimum configuration for protocol_policerTcpFlags",
6636
6985
  "required_fields": [],
@@ -6664,6 +7013,7 @@
6664
7013
  }
6665
7014
  }
6666
7015
  },
7016
+ "x-f5xc-description-short": "Specification of TCP flag to be matched in a TCP packet.",
6667
7017
  "x-f5xc-minimum-configuration": {
6668
7018
  "description": "Minimum configuration for protocol_policerTcpType",
6669
7019
  "required_fields": [
@@ -6698,6 +7048,7 @@
6698
7048
  "title": "Empty",
6699
7049
  "x-displayname": "Empty",
6700
7050
  "x-ves-proto-message": "ves.io.schema.Empty",
7051
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
6701
7052
  "x-f5xc-minimum-configuration": {
6702
7053
  "description": "Minimum configuration for ioschemaEmpty",
6703
7054
  "required_fields": [],
@@ -6787,6 +7138,8 @@
6787
7138
  "ves.io.schema.rules.message.required": "true",
6788
7139
  "ves.io.schema.rules.repeated.max_items": "1"
6789
7140
  },
7141
+ "x-f5xc-description-short": "List of RateLimitValues that specifies the total number of allowed requests for each specified period.",
7142
+ "x-f5xc-description-medium": "List of RateLimitValues that specifies the total number of allowed requests for each specified period. Required: YES.",
6790
7143
  "x-f5xc-required-for": {
6791
7144
  "minimum_config": false,
6792
7145
  "create": false,
@@ -6808,6 +7161,8 @@
6808
7161
  "x-validation-rules": {
6809
7162
  "ves.io.schema.rules.repeated.max_items": "1"
6810
7163
  },
7164
+ "x-f5xc-description-short": "Reference to user_identification object.",
7165
+ "x-f5xc-description-medium": "Reference to user_identification object. The rules in the user_identification object are evaluated to determine the user identifier to be rate limited.",
6811
7166
  "x-f5xc-required-for": {
6812
7167
  "minimum_config": false,
6813
7168
  "create": false,
@@ -6817,6 +7172,7 @@
6817
7172
  "x-field-mutability": "read-only"
6818
7173
  }
6819
7174
  },
7175
+ "x-f5xc-description-short": "Create rate_limiter creates a new object in the storage backend for metadata.namespace.",
6820
7176
  "x-f5xc-minimum-configuration": {
6821
7177
  "description": "Minimum configuration for rate_limiterCreateSpecType",
6822
7178
  "required_fields": [
@@ -6843,6 +7199,7 @@
6843
7199
  "title": "Fail_if_referred.",
6844
7200
  "format": "boolean",
6845
7201
  "x-displayname": "Fail-If-Referred.",
7202
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
6846
7203
  "x-f5xc-required-for": {
6847
7204
  "minimum_config": false,
6848
7205
  "create": false,
@@ -6867,7 +7224,7 @@
6867
7224
  },
6868
7225
  "x-original-maxLength": 1024,
6869
7226
  "x-reconciled-from-discovery": true,
6870
- "x-reconciled-at": "2026-01-05T14:38:49.201277+00:00"
7227
+ "x-reconciled-at": "2026-01-07T15:29:11.074330+00:00"
6871
7228
  },
6872
7229
  "namespace": {
6873
7230
  "type": "string",
@@ -6876,6 +7233,7 @@
6876
7233
  "x-displayname": "Namespace",
6877
7234
  "x-ves-example": "Ns1",
6878
7235
  "x-f5xc-example": "ns1",
7236
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
6879
7237
  "minLength": 0,
6880
7238
  "maxLength": 6,
6881
7239
  "x-f5xc-required-for": {
@@ -6886,7 +7244,7 @@
6886
7244
  },
6887
7245
  "x-original-maxLength": 1024,
6888
7246
  "x-reconciled-from-discovery": true,
6889
- "x-reconciled-at": "2026-01-05T14:38:49.201283+00:00"
7247
+ "x-reconciled-at": "2026-01-07T15:29:11.074335+00:00"
6890
7248
  }
6891
7249
  },
6892
7250
  "x-f5xc-minimum-configuration": {
@@ -6921,6 +7279,7 @@
6921
7279
  "$ref": "#/components/schemas/schemaObjectRefType"
6922
7280
  },
6923
7281
  "x-displayname": "Deleted Referred Objects.",
7282
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6924
7283
  "x-f5xc-required-for": {
6925
7284
  "minimum_config": false,
6926
7285
  "create": false,
@@ -6936,6 +7295,7 @@
6936
7295
  "$ref": "#/components/schemas/schemaObjectRefType"
6937
7296
  },
6938
7297
  "x-displayname": "Disabled Referred Objects.",
7298
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6939
7299
  "x-f5xc-required-for": {
6940
7300
  "minimum_config": false,
6941
7301
  "create": false,
@@ -6954,6 +7314,7 @@
6954
7314
  "$ref": "#/components/schemas/schemaObjectRefType"
6955
7315
  },
6956
7316
  "x-displayname": "Referring Objects.",
7317
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
6957
7318
  "x-f5xc-required-for": {
6958
7319
  "minimum_config": false,
6959
7320
  "create": false,
@@ -6975,6 +7336,8 @@
6975
7336
  "$ref": "#/components/schemas/rate_limiterStatusObject"
6976
7337
  },
6977
7338
  "x-displayname": "Status",
7339
+ "x-f5xc-example": "active",
7340
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6978
7341
  "x-f5xc-required-for": {
6979
7342
  "minimum_config": false,
6980
7343
  "create": false,
@@ -6984,7 +7347,7 @@
6984
7347
  "maxLength": 17,
6985
7348
  "minLength": 17,
6986
7349
  "x-reconciled-from-discovery": true,
6987
- "x-reconciled-at": "2026-01-05T14:38:49.201299+00:00"
7350
+ "x-reconciled-at": "2026-01-07T15:29:11.074353+00:00"
6988
7351
  },
6989
7352
  "system_metadata": {
6990
7353
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -7024,6 +7387,8 @@
7024
7387
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
7025
7388
  ],
7026
7389
  "default": "GET_RSP_FORMAT_DEFAULT",
7390
+ "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...",
7391
+ "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...",
7027
7392
  "x-f5xc-minimum-configuration": {
7028
7393
  "description": "Minimum configuration for rate_limiterGetResponseFormatCode",
7029
7394
  "required_fields": [],
@@ -7058,6 +7423,8 @@
7058
7423
  "ves.io.schema.rules.message.required": "true",
7059
7424
  "ves.io.schema.rules.repeated.max_items": "1"
7060
7425
  },
7426
+ "x-f5xc-description-short": "List of RateLimitValues that specifies the total number of allowed requests for each specified period.",
7427
+ "x-f5xc-description-medium": "List of RateLimitValues that specifies the total number of allowed requests for each specified period. Required: YES.",
7061
7428
  "x-f5xc-required-for": {
7062
7429
  "minimum_config": false,
7063
7430
  "create": false,
@@ -7079,6 +7446,8 @@
7079
7446
  "x-validation-rules": {
7080
7447
  "ves.io.schema.rules.repeated.max_items": "1"
7081
7448
  },
7449
+ "x-f5xc-description-short": "Reference to user_identification object.",
7450
+ "x-f5xc-description-medium": "Reference to user_identification object. The rules in the user_identification object are evaluated to determine the user identifier to be rate limited.",
7082
7451
  "x-f5xc-required-for": {
7083
7452
  "minimum_config": false,
7084
7453
  "create": false,
@@ -7088,6 +7457,7 @@
7088
7457
  "x-field-mutability": "read-only"
7089
7458
  }
7090
7459
  },
7460
+ "x-f5xc-description-short": "GET rate_limiter reads a given object from storage backend for metadata.namespace.",
7091
7461
  "x-f5xc-minimum-configuration": {
7092
7462
  "description": "Minimum configuration for rate_limiterGetSpecType",
7093
7463
  "required_fields": [
@@ -7110,7 +7480,7 @@
7110
7480
  "properties": {
7111
7481
  "duration": {
7112
7482
  "type": "integer",
7113
- "description": "",
7483
+ "description": "Configuration parameter for duration",
7114
7484
  "title": "Duration",
7115
7485
  "format": "int64",
7116
7486
  "x-displayname": "Duration",
@@ -7153,7 +7523,7 @@
7153
7523
  "properties": {
7154
7524
  "duration": {
7155
7525
  "type": "integer",
7156
- "description": "",
7526
+ "description": "Configuration parameter for duration",
7157
7527
  "title": "Duration",
7158
7528
  "format": "int64",
7159
7529
  "x-displayname": "Duration",
@@ -7196,7 +7566,7 @@
7196
7566
  "properties": {
7197
7567
  "duration": {
7198
7568
  "type": "integer",
7199
- "description": "",
7569
+ "description": "Configuration parameter for duration",
7200
7570
  "title": "Duration",
7201
7571
  "format": "int64",
7202
7572
  "x-displayname": "Duration",
@@ -7236,6 +7606,7 @@
7236
7606
  "title": "LeakyBucketRateLimiter.",
7237
7607
  "x-displayname": "Leaky Bucket Rate Limiter.",
7238
7608
  "x-ves-proto-message": "ves.io.schema.rate_limiter.LeakyBucketRateLimiter",
7609
+ "x-f5xc-description-short": "Leaky-Bucket is the default rate limiter algorithm for F5.",
7239
7610
  "x-f5xc-minimum-configuration": {
7240
7611
  "description": "Minimum configuration for rate_limiterLeakyBucketRateLimiter",
7241
7612
  "required_fields": [],
@@ -7261,6 +7632,7 @@
7261
7632
  "$ref": "#/components/schemas/schemaErrorType"
7262
7633
  },
7263
7634
  "x-displayname": "Errors",
7635
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
7264
7636
  "x-f5xc-required-for": {
7265
7637
  "minimum_config": false,
7266
7638
  "create": false,
@@ -7276,6 +7648,8 @@
7276
7648
  "$ref": "#/components/schemas/rate_limiterListResponseItem"
7277
7649
  },
7278
7650
  "x-displayname": "Items",
7651
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
7652
+ "x-f5xc-description-short": "Items represents the collection in response.",
7279
7653
  "x-f5xc-required-for": {
7280
7654
  "minimum_config": false,
7281
7655
  "create": false,
@@ -7309,6 +7683,8 @@
7309
7683
  "description": "The set of annotations present on this rate_limiter.",
7310
7684
  "title": "Annotations.",
7311
7685
  "x-displayname": "Annotations.",
7686
+ "x-f5xc-example": "{\"key\": \"value\"}",
7687
+ "x-f5xc-description-short": "The set of annotations present on this rate_limiter.",
7312
7688
  "x-f5xc-required-for": {
7313
7689
  "minimum_config": false,
7314
7690
  "create": false,
@@ -7321,6 +7697,7 @@
7321
7697
  "description": "The description set for this rate_limiter.",
7322
7698
  "title": "Description.",
7323
7699
  "x-displayname": "Description.",
7700
+ "x-f5xc-description-short": "The description set for this rate_limiter.",
7324
7701
  "minLength": 0,
7325
7702
  "maxLength": 0,
7326
7703
  "x-f5xc-required-for": {
@@ -7331,7 +7708,7 @@
7331
7708
  },
7332
7709
  "x-original-maxLength": 1024,
7333
7710
  "x-reconciled-from-discovery": true,
7334
- "x-reconciled-at": "2026-01-05T14:38:49.201322+00:00"
7711
+ "x-reconciled-at": "2026-01-07T15:29:11.074376+00:00"
7335
7712
  },
7336
7713
  "disabled": {
7337
7714
  "type": "boolean",
@@ -7339,6 +7716,8 @@
7339
7716
  "title": "Disabled",
7340
7717
  "format": "boolean",
7341
7718
  "x-displayname": "Disabled",
7719
+ "x-f5xc-example": "True",
7720
+ "x-f5xc-description-short": "Value of true indicates rate_limiter is administratively disabled.",
7342
7721
  "x-f5xc-required-for": {
7343
7722
  "minimum_config": false,
7344
7723
  "create": false,
@@ -7354,6 +7733,8 @@
7354
7733
  "description": "The set of labels present on this rate_limiter.",
7355
7734
  "title": "Labels",
7356
7735
  "x-displayname": "Labels",
7736
+ "x-f5xc-example": "{\"key\": \"value\"}",
7737
+ "x-f5xc-description-short": "The set of labels present on this rate_limiter.",
7357
7738
  "x-f5xc-required-for": {
7358
7739
  "minimum_config": false,
7359
7740
  "create": false,
@@ -7381,7 +7762,7 @@
7381
7762
  },
7382
7763
  "x-original-maxLength": 1024,
7383
7764
  "x-reconciled-from-discovery": true,
7384
- "x-reconciled-at": "2026-01-05T14:38:49.201333+00:00"
7765
+ "x-reconciled-at": "2026-01-07T15:29:11.074386+00:00"
7385
7766
  },
7386
7767
  "namespace": {
7387
7768
  "type": "string",
@@ -7400,7 +7781,7 @@
7400
7781
  },
7401
7782
  "x-original-maxLength": 1024,
7402
7783
  "x-reconciled-from-discovery": true,
7403
- "x-reconciled-at": "2026-01-05T14:38:49.201337+00:00"
7784
+ "x-reconciled-at": "2026-01-07T15:29:11.074391+00:00"
7404
7785
  },
7405
7786
  "owner_view": {
7406
7787
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -7413,6 +7794,7 @@
7413
7794
  "$ref": "#/components/schemas/rate_limiterStatusObject"
7414
7795
  },
7415
7796
  "x-displayname": "Status",
7797
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
7416
7798
  "x-f5xc-required-for": {
7417
7799
  "minimum_config": false,
7418
7800
  "create": false,
@@ -7441,7 +7823,7 @@
7441
7823
  "x-field-mutability": "read-only",
7442
7824
  "x-original-maxLength": 1024,
7443
7825
  "x-reconciled-from-discovery": true,
7444
- "x-reconciled-at": "2026-01-05T14:38:49.201345+00:00"
7826
+ "x-reconciled-at": "2026-01-07T15:29:11.074398+00:00"
7445
7827
  },
7446
7828
  "uid": {
7447
7829
  "type": "string",
@@ -7462,9 +7844,11 @@
7462
7844
  "x-original-maxLength": 1024,
7463
7845
  "format": "uuid",
7464
7846
  "x-reconciled-from-discovery": true,
7465
- "x-reconciled-at": "2026-01-05T14:38:49.201351+00:00"
7847
+ "x-reconciled-at": "2026-01-07T15:29:11.074404+00:00"
7466
7848
  }
7467
7849
  },
7850
+ "x-f5xc-description-short": "By default a summary of rate_limiter is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
7851
+ "x-f5xc-description-medium": "By default a summary of rate_limiter is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
7468
7852
  "x-f5xc-minimum-configuration": {
7469
7853
  "description": "Minimum configuration for rate_limiterListResponseItem",
7470
7854
  "required_fields": [
@@ -7507,6 +7891,7 @@
7507
7891
  "$ref": "#/components/schemas/rate_limiterInputSeconds"
7508
7892
  }
7509
7893
  },
7894
+ "x-f5xc-description-short": "Action where a user is blocked from making further requests after exceeding rate limit threshold.",
7510
7895
  "x-f5xc-minimum-configuration": {
7511
7896
  "description": "Minimum configuration for rate_limiterRateLimitBlockAction",
7512
7897
  "required_fields": [
@@ -7533,6 +7918,8 @@
7533
7918
  "default": "SECOND",
7534
7919
  "x-displayname": "Rate Limit Period Unit.",
7535
7920
  "x-ves-proto-enum": "ves.io.schema.rate_limiter.RateLimitPeriodUnit",
7921
+ "x-f5xc-description-short": "Unit for the period per which the rate limit is applied. - SECOND: Second Rate limit period unit is seconds - MINUTE: Minute Rate limit period...",
7922
+ "x-f5xc-description-medium": "Unit for the period per which the rate limit is applied. - SECOND: Second Rate limit period unit is seconds - MINUTE: Minute Rate limit period unit is minutes - HOUR: Hour Rate limit period unit is hours - DAY: Day Rate limit period unit is days.",
7536
7923
  "x-f5xc-minimum-configuration": {
7537
7924
  "description": "Minimum configuration for rate_limiterRateLimitPeriodUnit",
7538
7925
  "required_fields": [],
@@ -7571,6 +7958,7 @@
7571
7958
  "ves.io.schema.rules.uint32.gt": "0",
7572
7959
  "ves.io.schema.rules.uint32.lte": "100"
7573
7960
  },
7961
+ "x-f5xc-description-short": "The maximum burst of requests to accommodate, expressed as a multiple of the rate.",
7574
7962
  "minimum": 0,
7575
7963
  "maximum": 2147483647,
7576
7964
  "x-f5xc-required-for": {
@@ -7600,6 +7988,7 @@
7600
7988
  "x-validation-rules": {
7601
7989
  "ves.io.schema.rules.uint32.gte": "0"
7602
7990
  },
7991
+ "x-f5xc-description-short": "Setting, combined with Per Period units, provides a duration.",
7603
7992
  "minimum": 0,
7604
7993
  "maximum": 2147483647,
7605
7994
  "x-f5xc-required-for": {
@@ -7631,6 +8020,7 @@
7631
8020
  "ves.io.schema.rules.uint32.gt": "0",
7632
8021
  "ves.io.schema.rules.uint32.lte": "8192"
7633
8022
  },
8023
+ "x-f5xc-description-short": "The total number of allowed requests per rate-limiting period. Required: YES.",
7634
8024
  "minimum": 0,
7635
8025
  "maximum": 2147483647,
7636
8026
  "x-f5xc-required-for": {
@@ -7644,6 +8034,8 @@
7644
8034
  "$ref": "#/components/schemas/rate_limiterRateLimitPeriodUnit"
7645
8035
  }
7646
8036
  },
8037
+ "x-f5xc-description-short": "Tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
8038
+ "x-f5xc-description-medium": "Tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
7647
8039
  "x-f5xc-minimum-configuration": {
7648
8040
  "description": "Minimum configuration for rate_limiterRateLimitValue",
7649
8041
  "required_fields": [
@@ -7727,6 +8119,8 @@
7727
8119
  "ves.io.schema.rules.message.required": "true",
7728
8120
  "ves.io.schema.rules.repeated.max_items": "1"
7729
8121
  },
8122
+ "x-f5xc-description-short": "List of RateLimitValues that specifies the total number of allowed requests for each specified period.",
8123
+ "x-f5xc-description-medium": "List of RateLimitValues that specifies the total number of allowed requests for each specified period. Required: YES.",
7730
8124
  "x-f5xc-required-for": {
7731
8125
  "minimum_config": false,
7732
8126
  "create": false,
@@ -7748,6 +8142,8 @@
7748
8142
  "x-validation-rules": {
7749
8143
  "ves.io.schema.rules.repeated.max_items": "1"
7750
8144
  },
8145
+ "x-f5xc-description-short": "Reference to user_identification object.",
8146
+ "x-f5xc-description-medium": "Reference to user_identification object. The rules in the user_identification object are evaluated to determine the user identifier to be rate limited.",
7751
8147
  "x-f5xc-required-for": {
7752
8148
  "minimum_config": false,
7753
8149
  "create": false,
@@ -7757,6 +8153,7 @@
7757
8153
  "x-field-mutability": "read-only"
7758
8154
  }
7759
8155
  },
8156
+ "x-f5xc-description-short": "Replace rate_limiter replaces an existing object in the storage backend for metadata.namespace.",
7760
8157
  "x-f5xc-minimum-configuration": {
7761
8158
  "description": "Minimum configuration for rate_limiterReplaceSpecType",
7762
8159
  "required_fields": [
@@ -7785,6 +8182,7 @@
7785
8182
  "$ref": "#/components/schemas/schemaConditionType"
7786
8183
  },
7787
8184
  "x-displayname": "Conditions.",
8185
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
7788
8186
  "x-f5xc-required-for": {
7789
8187
  "minimum_config": false,
7790
8188
  "create": false,
@@ -7811,6 +8209,7 @@
7811
8209
  }
7812
8210
  }
7813
8211
  },
8212
+ "x-f5xc-description-short": "Most recently observed status of object.",
7814
8213
  "x-f5xc-minimum-configuration": {
7815
8214
  "description": "Minimum configuration for rate_limiterStatusObject",
7816
8215
  "required_fields": [
@@ -7831,6 +8230,7 @@
7831
8230
  "title": "TokenBucketRateLimiter.",
7832
8231
  "x-displayname": "Token Bucket Rate Limiter.",
7833
8232
  "x-ves-proto-message": "ves.io.schema.rate_limiter.TokenBucketRateLimiter",
8233
+ "x-f5xc-description-short": "Token-Bucket is a rate limiter algorithm that is stricter with enforcing limits.",
7834
8234
  "x-f5xc-minimum-configuration": {
7835
8235
  "description": "Minimum configuration for rate_limiterTokenBucketRateLimiter",
7836
8236
  "required_fields": [],