@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.20-2601072244

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 (49) hide show
  1. package/README.md +23 -0
  2. package/dist/config/paths.d.ts.map +1 -1
  3. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  4. package/dist/tools/generated/ce_management/index.js +179 -1582
  5. package/dist/tools/generated/ce_management/index.js.map +1 -1
  6. package/dist/tools/generated/dependency-graph.json +2 -265
  7. package/dist/version.d.ts +2 -2
  8. package/dist/version.js +2 -2
  9. package/manifest.json +1 -1
  10. package/package.json +1 -1
  11. package/specs/domains/admin_console_and_ui.json +111 -25
  12. package/specs/domains/ai_services.json +114 -35
  13. package/specs/domains/api.json +1082 -177
  14. package/specs/domains/authentication.json +205 -45
  15. package/specs/domains/bigip.json +593 -101
  16. package/specs/domains/billing_and_usage.json +440 -82
  17. package/specs/domains/blindfold.json +713 -110
  18. package/specs/domains/bot_and_threat_defense.json +359 -65
  19. package/specs/domains/cdn.json +2131 -194
  20. package/specs/domains/ce_management.json +9110 -15844
  21. package/specs/domains/certificates.json +362 -75
  22. package/specs/domains/cloud_infrastructure.json +802 -119
  23. package/specs/domains/container_services.json +613 -95
  24. package/specs/domains/data_and_privacy_security.json +364 -66
  25. package/specs/domains/data_intelligence.json +324 -63
  26. package/specs/domains/ddos.json +766 -159
  27. package/specs/domains/dns.json +820 -161
  28. package/specs/domains/managed_kubernetes.json +455 -85
  29. package/specs/domains/marketplace.json +670 -104
  30. package/specs/domains/network.json +1620 -238
  31. package/specs/domains/network_security.json +1401 -191
  32. package/specs/domains/nginx_one.json +326 -62
  33. package/specs/domains/object_storage.json +49 -15
  34. package/specs/domains/observability.json +999 -147
  35. package/specs/domains/rate_limiting.json +300 -55
  36. package/specs/domains/secops_and_incident_response.json +189 -36
  37. package/specs/domains/service_mesh.json +955 -124
  38. package/specs/domains/shape.json +2150 -397
  39. package/specs/domains/sites.json +3830 -364
  40. package/specs/domains/statistics.json +2117 -235
  41. package/specs/domains/support.json +602 -108
  42. package/specs/domains/telemetry_and_insights.json +753 -79
  43. package/specs/domains/tenant_and_identity.json +1874 -308
  44. package/specs/domains/threat_campaign.json +637 -71
  45. package/specs/domains/users.json +278 -66
  46. package/specs/domains/virtual.json +2803 -260
  47. package/specs/domains/vpm_and_node_management.json +3 -1
  48. package/specs/domains/waf.json +1125 -148
  49. package/specs/index.json +24 -24
@@ -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.13",
6
+ "version": "2.0.20",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -3622,6 +3622,7 @@
3622
3622
  "ves.io.schema.rules.message.required": "true",
3623
3623
  "ves.io.schema.rules.uint32.gte": "1"
3624
3624
  },
3625
+ "x-f5xc-description-short": "The maximum size permitted for bursts of data. E.g. 10000 pps burst Required: YES.",
3625
3626
  "minimum": 0,
3626
3627
  "maximum": 2147483647,
3627
3628
  "x-f5xc-required-for": {
@@ -3649,6 +3650,8 @@
3649
3650
  "ves.io.schema.rules.uint32.gte": "1",
3650
3651
  "ves.io.schema.rules.uint32.lte": "10000000"
3651
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.",
3652
3655
  "minimum": 0,
3653
3656
  "maximum": 2147483647,
3654
3657
  "x-f5xc-required-for": {
@@ -3665,6 +3668,7 @@
3665
3668
  "$ref": "#/components/schemas/policerPolicerType"
3666
3669
  }
3667
3670
  },
3671
+ "x-f5xc-description-short": "Create a new policer with traffic rate limits.",
3668
3672
  "x-f5xc-minimum-configuration": {
3669
3673
  "description": "Minimum configuration for policerCreateSpecType",
3670
3674
  "required_fields": [
@@ -3693,6 +3697,7 @@
3693
3697
  "title": "Fail_if_referred.",
3694
3698
  "format": "boolean",
3695
3699
  "x-displayname": "Fail-If-Referred.",
3700
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
3696
3701
  "x-f5xc-required-for": {
3697
3702
  "minimum_config": false,
3698
3703
  "create": false,
@@ -3717,7 +3722,7 @@
3717
3722
  },
3718
3723
  "x-original-maxLength": 1024,
3719
3724
  "x-reconciled-from-discovery": true,
3720
- "x-reconciled-at": "2026-01-05T18:29:42.290052+00:00"
3725
+ "x-reconciled-at": "2026-01-07T15:53:48.649160+00:00"
3721
3726
  },
3722
3727
  "namespace": {
3723
3728
  "type": "string",
@@ -3726,6 +3731,7 @@
3726
3731
  "x-displayname": "Namespace",
3727
3732
  "x-ves-example": "Ns1",
3728
3733
  "x-f5xc-example": "ns1",
3734
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
3729
3735
  "minLength": 0,
3730
3736
  "maxLength": 6,
3731
3737
  "x-f5xc-required-for": {
@@ -3736,7 +3742,7 @@
3736
3742
  },
3737
3743
  "x-original-maxLength": 1024,
3738
3744
  "x-reconciled-from-discovery": true,
3739
- "x-reconciled-at": "2026-01-05T18:29:42.290059+00:00"
3745
+ "x-reconciled-at": "2026-01-07T15:53:48.649167+00:00"
3740
3746
  }
3741
3747
  },
3742
3748
  "x-f5xc-minimum-configuration": {
@@ -3771,6 +3777,7 @@
3771
3777
  "$ref": "#/components/schemas/schemaObjectRefType"
3772
3778
  },
3773
3779
  "x-displayname": "Deleted Referred Objects.",
3780
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
3774
3781
  "x-f5xc-required-for": {
3775
3782
  "minimum_config": false,
3776
3783
  "create": false,
@@ -3786,6 +3793,7 @@
3786
3793
  "$ref": "#/components/schemas/schemaObjectRefType"
3787
3794
  },
3788
3795
  "x-displayname": "Disabled Referred Objects.",
3796
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
3789
3797
  "x-f5xc-required-for": {
3790
3798
  "minimum_config": false,
3791
3799
  "create": false,
@@ -3804,6 +3812,7 @@
3804
3812
  "$ref": "#/components/schemas/schemaObjectRefType"
3805
3813
  },
3806
3814
  "x-displayname": "Referring Objects.",
3815
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
3807
3816
  "x-f5xc-required-for": {
3808
3817
  "minimum_config": false,
3809
3818
  "create": false,
@@ -3825,6 +3834,8 @@
3825
3834
  "$ref": "#/components/schemas/policerStatusObject"
3826
3835
  },
3827
3836
  "x-displayname": "Status",
3837
+ "x-f5xc-example": "active",
3838
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
3828
3839
  "x-f5xc-required-for": {
3829
3840
  "minimum_config": false,
3830
3841
  "create": false,
@@ -3834,7 +3845,7 @@
3834
3845
  "maxLength": 17,
3835
3846
  "minLength": 17,
3836
3847
  "x-reconciled-from-discovery": true,
3837
- "x-reconciled-at": "2026-01-05T18:29:42.290075+00:00"
3848
+ "x-reconciled-at": "2026-01-07T15:53:48.649183+00:00"
3838
3849
  },
3839
3850
  "system_metadata": {
3840
3851
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -3874,6 +3885,8 @@
3874
3885
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
3875
3886
  ],
3876
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...",
3877
3890
  "x-f5xc-minimum-configuration": {
3878
3891
  "description": "Minimum configuration for policerGetResponseFormatCode",
3879
3892
  "required_fields": [],
@@ -3908,6 +3921,7 @@
3908
3921
  "ves.io.schema.rules.message.required": "true",
3909
3922
  "ves.io.schema.rules.uint32.gte": "1"
3910
3923
  },
3924
+ "x-f5xc-description-short": "The maximum size permitted for bursts of data. E.g. 10000 pps burst Required: YES.",
3911
3925
  "minimum": 0,
3912
3926
  "maximum": 2147483647,
3913
3927
  "x-f5xc-required-for": {
@@ -3935,6 +3949,8 @@
3935
3949
  "ves.io.schema.rules.uint32.gte": "1",
3936
3950
  "ves.io.schema.rules.uint32.lte": "10000000"
3937
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.",
3938
3954
  "minimum": 0,
3939
3955
  "maximum": 2147483647,
3940
3956
  "x-f5xc-required-for": {
@@ -3981,6 +3997,7 @@
3981
3997
  "$ref": "#/components/schemas/schemaErrorType"
3982
3998
  },
3983
3999
  "x-displayname": "Errors",
4000
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
3984
4001
  "x-f5xc-required-for": {
3985
4002
  "minimum_config": false,
3986
4003
  "create": false,
@@ -3996,6 +4013,8 @@
3996
4013
  "$ref": "#/components/schemas/policerListResponseItem"
3997
4014
  },
3998
4015
  "x-displayname": "Items",
4016
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
4017
+ "x-f5xc-description-short": "Items represents the collection in response.",
3999
4018
  "x-f5xc-required-for": {
4000
4019
  "minimum_config": false,
4001
4020
  "create": false,
@@ -4029,6 +4048,8 @@
4029
4048
  "description": "The set of annotations present on this policer.",
4030
4049
  "title": "Annotations.",
4031
4050
  "x-displayname": "Annotations.",
4051
+ "x-f5xc-example": "{\"key\": \"value\"}",
4052
+ "x-f5xc-description-short": "The set of annotations present on this policer.",
4032
4053
  "x-f5xc-required-for": {
4033
4054
  "minimum_config": false,
4034
4055
  "create": false,
@@ -4051,7 +4072,7 @@
4051
4072
  },
4052
4073
  "x-original-maxLength": 1024,
4053
4074
  "x-reconciled-from-discovery": true,
4054
- "x-reconciled-at": "2026-01-05T18:29:42.290094+00:00"
4075
+ "x-reconciled-at": "2026-01-07T15:53:48.649201+00:00"
4055
4076
  },
4056
4077
  "disabled": {
4057
4078
  "type": "boolean",
@@ -4059,6 +4080,8 @@
4059
4080
  "title": "Disabled",
4060
4081
  "format": "boolean",
4061
4082
  "x-displayname": "Disabled",
4083
+ "x-f5xc-example": "True",
4084
+ "x-f5xc-description-short": "Value of true indicates policer is administratively disabled.",
4062
4085
  "x-f5xc-required-for": {
4063
4086
  "minimum_config": false,
4064
4087
  "create": false,
@@ -4074,6 +4097,8 @@
4074
4097
  "description": "The set of labels present on this policer.",
4075
4098
  "title": "Labels",
4076
4099
  "x-displayname": "Labels",
4100
+ "x-f5xc-example": "{\"key\": \"value\"}",
4101
+ "x-f5xc-description-short": "The set of labels present on this policer.",
4077
4102
  "x-f5xc-required-for": {
4078
4103
  "minimum_config": false,
4079
4104
  "create": false,
@@ -4101,7 +4126,7 @@
4101
4126
  },
4102
4127
  "x-original-maxLength": 1024,
4103
4128
  "x-reconciled-from-discovery": true,
4104
- "x-reconciled-at": "2026-01-05T18:29:42.290104+00:00"
4129
+ "x-reconciled-at": "2026-01-07T15:53:48.649211+00:00"
4105
4130
  },
4106
4131
  "namespace": {
4107
4132
  "type": "string",
@@ -4120,7 +4145,7 @@
4120
4145
  },
4121
4146
  "x-original-maxLength": 1024,
4122
4147
  "x-reconciled-from-discovery": true,
4123
- "x-reconciled-at": "2026-01-05T18:29:42.290109+00:00"
4148
+ "x-reconciled-at": "2026-01-07T15:53:48.649216+00:00"
4124
4149
  },
4125
4150
  "owner_view": {
4126
4151
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -4133,6 +4158,7 @@
4133
4158
  "$ref": "#/components/schemas/policerStatusObject"
4134
4159
  },
4135
4160
  "x-displayname": "Status",
4161
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
4136
4162
  "x-f5xc-required-for": {
4137
4163
  "minimum_config": false,
4138
4164
  "create": false,
@@ -4161,7 +4187,7 @@
4161
4187
  "x-field-mutability": "read-only",
4162
4188
  "x-original-maxLength": 1024,
4163
4189
  "x-reconciled-from-discovery": true,
4164
- "x-reconciled-at": "2026-01-05T18:29:42.290116+00:00"
4190
+ "x-reconciled-at": "2026-01-07T15:53:48.649223+00:00"
4165
4191
  },
4166
4192
  "uid": {
4167
4193
  "type": "string",
@@ -4182,9 +4208,11 @@
4182
4208
  "x-original-maxLength": 1024,
4183
4209
  "format": "uuid",
4184
4210
  "x-reconciled-from-discovery": true,
4185
- "x-reconciled-at": "2026-01-05T18:29:42.290122+00:00"
4211
+ "x-reconciled-at": "2026-01-07T15:53:48.649229+00:00"
4186
4212
  }
4187
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.",
4188
4216
  "x-f5xc-minimum-configuration": {
4189
4217
  "description": "Minimum configuration for policerListResponseItem",
4190
4218
  "required_fields": [
@@ -4220,6 +4248,8 @@
4220
4248
  "default": "POLICER_MODE_NOT_SHARED",
4221
4249
  "x-displayname": "Policer Mode.",
4222
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.",
4223
4253
  "x-f5xc-minimum-configuration": {
4224
4254
  "description": "Minimum configuration for policerPolicerMode",
4225
4255
  "required_fields": [],
@@ -4240,6 +4270,7 @@
4240
4270
  "default": "POLICER_SINGLE_RATE_TWO_COLOR",
4241
4271
  "x-displayname": "Policer Type.",
4242
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.",
4243
4274
  "x-f5xc-minimum-configuration": {
4244
4275
  "description": "Minimum configuration for policerPolicerType",
4245
4276
  "required_fields": [],
@@ -4314,6 +4345,7 @@
4314
4345
  "ves.io.schema.rules.message.required": "true",
4315
4346
  "ves.io.schema.rules.uint32.gte": "1"
4316
4347
  },
4348
+ "x-f5xc-description-short": "The maximum size permitted for bursts of data. E.g. 10000 pps burst Required: YES.",
4317
4349
  "minimum": 0,
4318
4350
  "maximum": 2147483647,
4319
4351
  "x-f5xc-required-for": {
@@ -4341,6 +4373,8 @@
4341
4373
  "ves.io.schema.rules.uint32.gte": "1",
4342
4374
  "ves.io.schema.rules.uint32.lte": "10000000"
4343
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.",
4344
4378
  "minimum": 0,
4345
4379
  "maximum": 2147483647,
4346
4380
  "x-f5xc-required-for": {
@@ -4357,6 +4391,7 @@
4357
4391
  "$ref": "#/components/schemas/policerPolicerType"
4358
4392
  }
4359
4393
  },
4394
+ "x-f5xc-description-short": "Replace a given policer with changed traffic rate limits.",
4360
4395
  "x-f5xc-minimum-configuration": {
4361
4396
  "description": "Minimum configuration for policerReplaceSpecType",
4362
4397
  "required_fields": [
@@ -4388,6 +4423,7 @@
4388
4423
  "$ref": "#/components/schemas/schemaConditionType"
4389
4424
  },
4390
4425
  "x-displayname": "Conditions.",
4426
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
4391
4427
  "x-f5xc-required-for": {
4392
4428
  "minimum_config": false,
4393
4429
  "create": false,
@@ -4414,6 +4450,7 @@
4414
4450
  }
4415
4451
  }
4416
4452
  },
4453
+ "x-f5xc-description-short": "Most recently observed status of object.",
4417
4454
  "x-f5xc-minimum-configuration": {
4418
4455
  "description": "Minimum configuration for policerStatusObject",
4419
4456
  "required_fields": [
@@ -4435,6 +4472,8 @@
4435
4472
  "type_url": {
4436
4473
  "type": "string",
4437
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 ).",
4438
4477
  "minLength": 0,
4439
4478
  "maxLength": 1024,
4440
4479
  "x-f5xc-required-for": {
@@ -4458,9 +4497,11 @@
4458
4497
  },
4459
4498
  "x-original-maxLength": 1024,
4460
4499
  "x-reconciled-from-discovery": true,
4461
- "x-reconciled-at": "2026-01-05T18:29:42.290144+00:00"
4500
+ "x-reconciled-at": "2026-01-07T15:53:48.649250+00:00"
4462
4501
  }
4463
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...",
4464
4505
  "x-f5xc-minimum-configuration": {
4465
4506
  "description": "Minimum configuration for protobufAny",
4466
4507
  "required_fields": [
@@ -4486,6 +4527,8 @@
4486
4527
  "description": "Hostname of the instance of the site that sent the status.",
4487
4528
  "title": "Hostname",
4488
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.",
4489
4532
  "minLength": 0,
4490
4533
  "maxLength": 1024,
4491
4534
  "x-f5xc-required-for": {
@@ -4517,6 +4560,8 @@
4517
4560
  "x-displayname": "Reason",
4518
4561
  "x-ves-example": "Value",
4519
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.",
4520
4565
  "minLength": 0,
4521
4566
  "maxLength": 43,
4522
4567
  "x-f5xc-required-for": {
@@ -4527,13 +4572,15 @@
4527
4572
  },
4528
4573
  "x-original-maxLength": 1024,
4529
4574
  "x-reconciled-from-discovery": true,
4530
- "x-reconciled-at": "2026-01-05T18:29:42.290152+00:00"
4575
+ "x-reconciled-at": "2026-01-07T15:53:48.649259+00:00"
4531
4576
  },
4532
4577
  "service_name": {
4533
4578
  "type": "string",
4534
4579
  "description": "Name of the service that sent the status.",
4535
4580
  "title": "Service name.",
4536
4581
  "x-displayname": "Service Name.",
4582
+ "x-f5xc-example": "example-resource",
4583
+ "x-f5xc-description-short": "Name of the service that sent the status.",
4537
4584
  "minLength": 0,
4538
4585
  "maxLength": 1024,
4539
4586
  "x-f5xc-required-for": {
@@ -4556,6 +4603,8 @@
4556
4603
  "x-validation-rules": {
4557
4604
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
4558
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...",
4559
4608
  "minLength": 0,
4560
4609
  "maxLength": 17,
4561
4610
  "x-f5xc-required-for": {
@@ -4566,7 +4615,7 @@
4566
4615
  },
4567
4616
  "x-original-maxLength": 1024,
4568
4617
  "x-reconciled-from-discovery": true,
4569
- "x-reconciled-at": "2026-01-05T18:29:42.290158+00:00"
4618
+ "x-reconciled-at": "2026-01-07T15:53:48.649264+00:00"
4570
4619
  },
4571
4620
  "type": {
4572
4621
  "type": "string",
@@ -4581,6 +4630,8 @@
4581
4630
  "x-validation-rules": {
4582
4631
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
4583
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.",
4584
4635
  "minLength": 0,
4585
4636
  "maxLength": 1024,
4586
4637
  "x-f5xc-required-for": {
@@ -4591,6 +4642,8 @@
4591
4642
  }
4592
4643
  }
4593
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.",
4594
4647
  "x-f5xc-minimum-configuration": {
4595
4648
  "description": "Minimum configuration for schemaConditionType",
4596
4649
  "required_fields": [
@@ -4626,6 +4679,8 @@
4626
4679
  "default": "EOK",
4627
4680
  "x-displayname": "Error Code.",
4628
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...",
4629
4684
  "x-f5xc-minimum-configuration": {
4630
4685
  "description": "Minimum configuration for schemaErrorCode",
4631
4686
  "required_fields": [],
@@ -4666,6 +4721,7 @@
4666
4721
  }
4667
4722
  }
4668
4723
  },
4724
+ "x-f5xc-description-short": "Information about a error in API operation.",
4669
4725
  "x-f5xc-minimum-configuration": {
4670
4726
  "description": "Minimum configuration for schemaErrorType",
4671
4727
  "required_fields": [
@@ -4693,6 +4749,7 @@
4693
4749
  "title": "Name",
4694
4750
  "x-displayname": "Name",
4695
4751
  "x-f5xc-example": "example-resource",
4752
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
4696
4753
  "minLength": 0,
4697
4754
  "maxLength": 16,
4698
4755
  "x-f5xc-required-for": {
@@ -4703,9 +4760,10 @@
4703
4760
  },
4704
4761
  "x-original-maxLength": 1024,
4705
4762
  "x-reconciled-from-discovery": true,
4706
- "x-reconciled-at": "2026-01-05T18:29:42.290169+00:00"
4763
+ "x-reconciled-at": "2026-01-07T15:53:48.649276+00:00"
4707
4764
  }
4708
4765
  },
4766
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
4709
4767
  "x-f5xc-minimum-configuration": {
4710
4768
  "description": "Minimum configuration for schemaInitializerType",
4711
4769
  "required_fields": [
@@ -4733,6 +4791,8 @@
4733
4791
  "$ref": "#/components/schemas/schemaInitializerType"
4734
4792
  },
4735
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.",
4736
4796
  "x-f5xc-required-for": {
4737
4797
  "minimum_config": false,
4738
4798
  "create": false,
@@ -4744,6 +4804,7 @@
4744
4804
  "$ref": "#/components/schemas/schemaStatusType"
4745
4805
  }
4746
4806
  },
4807
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
4747
4808
  "x-f5xc-minimum-configuration": {
4748
4809
  "description": "Minimum configuration for schemaInitializersType",
4749
4810
  "required_fields": [
@@ -4782,6 +4843,8 @@
4782
4843
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4783
4844
  "ves.io.schema.rules.map.values.string.min_len": "1"
4784
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.",
4785
4848
  "x-f5xc-required-for": {
4786
4849
  "minimum_config": false,
4787
4850
  "create": false,
@@ -4803,6 +4866,7 @@
4803
4866
  "x-validation-rules": {
4804
4867
  "ves.io.schema.rules.string.max_bytes": "1200"
4805
4868
  },
4869
+ "x-f5xc-description-short": "Human readable description for the object.",
4806
4870
  "minLength": 0,
4807
4871
  "x-f5xc-required-for": {
4808
4872
  "minimum_config": false,
@@ -4812,7 +4876,7 @@
4812
4876
  },
4813
4877
  "x-original-maxLength": 1200,
4814
4878
  "x-reconciled-from-discovery": true,
4815
- "x-reconciled-at": "2026-01-05T18:29:42.290179+00:00"
4879
+ "x-reconciled-at": "2026-01-07T15:53:48.649285+00:00"
4816
4880
  },
4817
4881
  "disable": {
4818
4882
  "type": "boolean",
@@ -4821,6 +4885,7 @@
4821
4885
  "format": "boolean",
4822
4886
  "x-displayname": "Disable",
4823
4887
  "x-f5xc-example": "true",
4888
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4824
4889
  "x-f5xc-required-for": {
4825
4890
  "minimum_config": false,
4826
4891
  "create": false,
@@ -4834,6 +4899,8 @@
4834
4899
  "title": "Labels",
4835
4900
  "x-displayname": "Labels",
4836
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.",
4837
4904
  "x-f5xc-required-for": {
4838
4905
  "minimum_config": false,
4839
4906
  "create": false,
@@ -4855,6 +4922,8 @@
4855
4922
  "x-validation-rules": {
4856
4923
  "ves.io.schema.rules.message.required": "true"
4857
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.",
4858
4927
  "minLength": 0,
4859
4928
  "maxLength": 16,
4860
4929
  "x-f5xc-required-for": {
@@ -4865,7 +4934,7 @@
4865
4934
  },
4866
4935
  "x-original-maxLength": 1024,
4867
4936
  "x-reconciled-from-discovery": true,
4868
- "x-reconciled-at": "2026-01-05T18:29:42.290186+00:00"
4937
+ "x-reconciled-at": "2026-01-07T15:53:48.649293+00:00"
4869
4938
  },
4870
4939
  "namespace": {
4871
4940
  "type": "string",
@@ -4874,6 +4943,8 @@
4874
4943
  "x-displayname": "Namespace",
4875
4944
  "x-ves-example": "Staging",
4876
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 \"\".",
4877
4948
  "minLength": 0,
4878
4949
  "maxLength": 6,
4879
4950
  "x-f5xc-required-for": {
@@ -4884,9 +4955,10 @@
4884
4955
  },
4885
4956
  "x-original-maxLength": 1024,
4886
4957
  "x-reconciled-from-discovery": true,
4887
- "x-reconciled-at": "2026-01-05T18:29:42.290190+00:00"
4958
+ "x-reconciled-at": "2026-01-07T15:53:48.649297+00:00"
4888
4959
  }
4889
4960
  },
4961
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
4890
4962
  "x-f5xc-minimum-configuration": {
4891
4963
  "description": "Minimum configuration for schemaObjectCreateMetaType",
4892
4964
  "required_fields": [
@@ -4930,6 +5002,8 @@
4930
5002
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4931
5003
  "ves.io.schema.rules.map.values.string.min_len": "1"
4932
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.",
4933
5007
  "x-f5xc-required-for": {
4934
5008
  "minimum_config": false,
4935
5009
  "create": false,
@@ -4951,6 +5025,7 @@
4951
5025
  "x-validation-rules": {
4952
5026
  "ves.io.schema.rules.string.max_bytes": "1200"
4953
5027
  },
5028
+ "x-f5xc-description-short": "Human readable description for the object.",
4954
5029
  "minLength": 0,
4955
5030
  "x-f5xc-required-for": {
4956
5031
  "minimum_config": false,
@@ -4960,7 +5035,7 @@
4960
5035
  },
4961
5036
  "x-original-maxLength": 1200,
4962
5037
  "x-reconciled-from-discovery": true,
4963
- "x-reconciled-at": "2026-01-05T18:29:42.290197+00:00"
5038
+ "x-reconciled-at": "2026-01-07T15:53:48.649303+00:00"
4964
5039
  },
4965
5040
  "disable": {
4966
5041
  "type": "boolean",
@@ -4970,6 +5045,7 @@
4970
5045
  "x-displayname": "Disable",
4971
5046
  "x-ves-example": "True",
4972
5047
  "x-f5xc-example": "true",
5048
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4973
5049
  "x-f5xc-required-for": {
4974
5050
  "minimum_config": false,
4975
5051
  "create": false,
@@ -4984,6 +5060,8 @@
4984
5060
  "x-displayname": "Labels",
4985
5061
  "x-ves-example": "Value",
4986
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.",
4987
5065
  "x-f5xc-required-for": {
4988
5066
  "minimum_config": false,
4989
5067
  "create": false,
@@ -5005,6 +5083,8 @@
5005
5083
  "x-validation-rules": {
5006
5084
  "ves.io.schema.rules.message.required": "true"
5007
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.",
5008
5088
  "minLength": 0,
5009
5089
  "maxLength": 16,
5010
5090
  "x-f5xc-required-for": {
@@ -5015,7 +5095,7 @@
5015
5095
  },
5016
5096
  "x-original-maxLength": 1024,
5017
5097
  "x-reconciled-from-discovery": true,
5018
- "x-reconciled-at": "2026-01-05T18:29:42.290204+00:00"
5098
+ "x-reconciled-at": "2026-01-07T15:53:48.649311+00:00"
5019
5099
  },
5020
5100
  "namespace": {
5021
5101
  "type": "string",
@@ -5024,6 +5104,8 @@
5024
5104
  "x-displayname": "Namespace",
5025
5105
  "x-ves-example": "Staging",
5026
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 \"\".",
5027
5109
  "minLength": 0,
5028
5110
  "maxLength": 6,
5029
5111
  "x-f5xc-required-for": {
@@ -5034,9 +5116,10 @@
5034
5116
  },
5035
5117
  "x-original-maxLength": 1024,
5036
5118
  "x-reconciled-from-discovery": true,
5037
- "x-reconciled-at": "2026-01-05T18:29:42.290208+00:00"
5119
+ "x-reconciled-at": "2026-01-07T15:53:48.649314+00:00"
5038
5120
  }
5039
5121
  },
5122
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
5040
5123
  "x-f5xc-minimum-configuration": {
5041
5124
  "description": "Minimum configuration for schemaObjectGetMetaType",
5042
5125
  "required_fields": [
@@ -5068,6 +5151,8 @@
5068
5151
  "x-displayname": "Kind",
5069
5152
  "x-ves-example": "Virtual_site.",
5070
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\").",
5071
5156
  "minLength": 0,
5072
5157
  "maxLength": 14,
5073
5158
  "x-f5xc-required-for": {
@@ -5079,7 +5164,7 @@
5079
5164
  "readOnly": true,
5080
5165
  "x-original-maxLength": 1024,
5081
5166
  "x-reconciled-from-discovery": true,
5082
- "x-reconciled-at": "2026-01-05T18:29:42.290212+00:00"
5167
+ "x-reconciled-at": "2026-01-07T15:53:48.649319+00:00"
5083
5168
  },
5084
5169
  "name": {
5085
5170
  "type": "string",
@@ -5088,6 +5173,8 @@
5088
5173
  "x-displayname": "Name",
5089
5174
  "x-ves-example": "Contactus-route.",
5090
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.",
5091
5178
  "minLength": 0,
5092
5179
  "maxLength": 16,
5093
5180
  "x-f5xc-required-for": {
@@ -5098,7 +5185,7 @@
5098
5185
  },
5099
5186
  "x-original-maxLength": 1024,
5100
5187
  "x-reconciled-from-discovery": true,
5101
- "x-reconciled-at": "2026-01-05T18:29:42.290216+00:00"
5188
+ "x-reconciled-at": "2026-01-07T15:53:48.649323+00:00"
5102
5189
  },
5103
5190
  "namespace": {
5104
5191
  "type": "string",
@@ -5107,6 +5194,8 @@
5107
5194
  "x-displayname": "Namespace",
5108
5195
  "x-ves-example": "Ns1",
5109
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.",
5110
5199
  "minLength": 0,
5111
5200
  "maxLength": 6,
5112
5201
  "x-f5xc-required-for": {
@@ -5117,7 +5206,7 @@
5117
5206
  },
5118
5207
  "x-original-maxLength": 1024,
5119
5208
  "x-reconciled-from-discovery": true,
5120
- "x-reconciled-at": "2026-01-05T18:29:42.290220+00:00"
5209
+ "x-reconciled-at": "2026-01-07T15:53:48.649327+00:00"
5121
5210
  },
5122
5211
  "tenant": {
5123
5212
  "type": "string",
@@ -5126,6 +5215,8 @@
5126
5215
  "x-displayname": "Tenant",
5127
5216
  "x-ves-example": "Example-corp.",
5128
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.",
5129
5220
  "minLength": 0,
5130
5221
  "maxLength": 18,
5131
5222
  "x-f5xc-required-for": {
@@ -5138,7 +5229,7 @@
5138
5229
  "x-field-mutability": "read-only",
5139
5230
  "x-original-maxLength": 1024,
5140
5231
  "x-reconciled-from-discovery": true,
5141
- "x-reconciled-at": "2026-01-05T18:29:42.290224+00:00"
5232
+ "x-reconciled-at": "2026-01-07T15:53:48.649331+00:00"
5142
5233
  },
5143
5234
  "uid": {
5144
5235
  "type": "string",
@@ -5147,6 +5238,8 @@
5147
5238
  "x-displayname": "UID",
5148
5239
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5149
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.",
5150
5243
  "minLength": 0,
5151
5244
  "maxLength": 36,
5152
5245
  "x-f5xc-required-for": {
@@ -5160,9 +5253,11 @@
5160
5253
  "x-original-maxLength": 1024,
5161
5254
  "format": "uuid",
5162
5255
  "x-reconciled-from-discovery": true,
5163
- "x-reconciled-at": "2026-01-05T18:29:42.290230+00:00"
5256
+ "x-reconciled-at": "2026-01-07T15:53:48.649337+00:00"
5164
5257
  }
5165
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...",
5166
5261
  "x-f5xc-minimum-configuration": {
5167
5262
  "description": "Minimum configuration for schemaObjectRefType",
5168
5263
  "required_fields": [
@@ -5205,6 +5300,8 @@
5205
5300
  "ves.io.schema.rules.map.values.string.max_len": "1024",
5206
5301
  "ves.io.schema.rules.map.values.string.min_len": "1"
5207
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.",
5208
5305
  "x-f5xc-required-for": {
5209
5306
  "minimum_config": false,
5210
5307
  "create": false,
@@ -5226,6 +5323,7 @@
5226
5323
  "x-validation-rules": {
5227
5324
  "ves.io.schema.rules.string.max_bytes": "1200"
5228
5325
  },
5326
+ "x-f5xc-description-short": "Human readable description for the object.",
5229
5327
  "minLength": 0,
5230
5328
  "x-f5xc-required-for": {
5231
5329
  "minimum_config": false,
@@ -5235,7 +5333,7 @@
5235
5333
  },
5236
5334
  "x-original-maxLength": 1200,
5237
5335
  "x-reconciled-from-discovery": true,
5238
- "x-reconciled-at": "2026-01-05T18:29:42.290237+00:00"
5336
+ "x-reconciled-at": "2026-01-07T15:53:48.649344+00:00"
5239
5337
  },
5240
5338
  "disable": {
5241
5339
  "type": "boolean",
@@ -5244,6 +5342,7 @@
5244
5342
  "format": "boolean",
5245
5343
  "x-displayname": "Disable",
5246
5344
  "x-f5xc-example": "true",
5345
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
5247
5346
  "x-f5xc-required-for": {
5248
5347
  "minimum_config": false,
5249
5348
  "create": false,
@@ -5258,6 +5357,8 @@
5258
5357
  "x-displayname": "Labels",
5259
5358
  "x-ves-example": "Value",
5260
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.",
5261
5362
  "x-f5xc-required-for": {
5262
5363
  "minimum_config": false,
5263
5364
  "create": false,
@@ -5278,6 +5379,8 @@
5278
5379
  "x-validation-rules": {
5279
5380
  "ves.io.schema.rules.message.required": "true"
5280
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.",
5281
5384
  "minLength": 0,
5282
5385
  "maxLength": 16,
5283
5386
  "x-f5xc-required-for": {
@@ -5288,7 +5391,7 @@
5288
5391
  },
5289
5392
  "x-original-maxLength": 1024,
5290
5393
  "x-reconciled-from-discovery": true,
5291
- "x-reconciled-at": "2026-01-05T18:29:42.290245+00:00"
5394
+ "x-reconciled-at": "2026-01-07T15:53:48.649351+00:00"
5292
5395
  },
5293
5396
  "namespace": {
5294
5397
  "type": "string",
@@ -5297,6 +5400,8 @@
5297
5400
  "x-displayname": "Namespace",
5298
5401
  "x-ves-example": "Staging",
5299
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 \"\".",
5300
5405
  "minLength": 0,
5301
5406
  "maxLength": 6,
5302
5407
  "x-f5xc-required-for": {
@@ -5307,9 +5412,10 @@
5307
5412
  },
5308
5413
  "x-original-maxLength": 1024,
5309
5414
  "x-reconciled-from-discovery": true,
5310
- "x-reconciled-at": "2026-01-05T18:29:42.290249+00:00"
5415
+ "x-reconciled-at": "2026-01-07T15:53:48.649355+00:00"
5311
5416
  }
5312
5417
  },
5418
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
5313
5419
  "x-f5xc-minimum-configuration": {
5314
5420
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
5315
5421
  "required_fields": [
@@ -5340,6 +5446,8 @@
5340
5446
  "title": "Creation_timestamp.",
5341
5447
  "format": "date-time",
5342
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.",
5343
5451
  "minLength": 0,
5344
5452
  "maxLength": 1024,
5345
5453
  "x-f5xc-required-for": {
@@ -5357,6 +5465,8 @@
5357
5465
  "x-displayname": "Creator Class.",
5358
5466
  "x-ves-example": "ver.re1.int.ves.I/O.",
5359
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.",
5360
5470
  "minLength": 0,
5361
5471
  "maxLength": 1024,
5362
5472
  "x-f5xc-required-for": {
@@ -5374,6 +5484,8 @@
5374
5484
  "x-displayname": "Creator ID.",
5375
5485
  "x-ves-example": "Ver-instance-1.",
5376
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.",
5377
5489
  "minLength": 0,
5378
5490
  "maxLength": 1024,
5379
5491
  "x-f5xc-required-for": {
@@ -5392,6 +5504,8 @@
5392
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)",
5393
5505
  "title": "Status_id",
5394
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).",
5395
5509
  "minLength": 0,
5396
5510
  "maxLength": 1024,
5397
5511
  "x-f5xc-required-for": {
@@ -5409,6 +5523,7 @@
5409
5523
  "x-displayname": "UID",
5410
5524
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5411
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.",
5412
5527
  "minLength": 0,
5413
5528
  "maxLength": 36,
5414
5529
  "x-f5xc-required-for": {
@@ -5421,13 +5536,14 @@
5421
5536
  "x-original-maxLength": 1024,
5422
5537
  "format": "uuid",
5423
5538
  "x-reconciled-from-discovery": true,
5424
- "x-reconciled-at": "2026-01-05T18:29:42.290262+00:00"
5539
+ "x-reconciled-at": "2026-01-07T15:53:48.649367+00:00"
5425
5540
  },
5426
5541
  "vtrp_id": {
5427
5542
  "type": "string",
5428
5543
  "description": "Origin of this status exchanged by VTRP.",
5429
5544
  "title": "Vtrp_id",
5430
5545
  "x-displayname": "VTRP ID",
5546
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
5431
5547
  "minLength": 0,
5432
5548
  "maxLength": 1024,
5433
5549
  "x-f5xc-required-for": {
@@ -5444,6 +5560,7 @@
5444
5560
  "title": "Vtrp_stale.",
5445
5561
  "format": "boolean",
5446
5562
  "x-displayname": "VTRP Stale.",
5563
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
5447
5564
  "x-f5xc-required-for": {
5448
5565
  "minimum_config": false,
5449
5566
  "create": false,
@@ -5452,6 +5569,7 @@
5452
5569
  }
5453
5570
  }
5454
5571
  },
5572
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
5455
5573
  "x-f5xc-minimum-configuration": {
5456
5574
  "description": "Minimum configuration for schemaStatusMetaType",
5457
5575
  "required_fields": [
@@ -5482,6 +5600,8 @@
5482
5600
  "default": "STATUS_DO_NOT_PUBLISH",
5483
5601
  "x-displayname": "Status Publish Type.",
5484
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.",
5485
5605
  "x-f5xc-minimum-configuration": {
5486
5606
  "description": "Minimum configuration for schemaStatusPublishType",
5487
5607
  "required_fields": [],
@@ -5507,6 +5627,7 @@
5507
5627
  "x-displayname": "Code",
5508
5628
  "x-ves-example": "0",
5509
5629
  "x-f5xc-example": "0",
5630
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
5510
5631
  "minimum": 0,
5511
5632
  "maximum": 2147483647,
5512
5633
  "x-f5xc-required-for": {
@@ -5523,6 +5644,8 @@
5523
5644
  "x-displayname": "Reason",
5524
5645
  "x-ves-example": "Value",
5525
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.",
5526
5649
  "minLength": 0,
5527
5650
  "maxLength": 43,
5528
5651
  "x-f5xc-required-for": {
@@ -5533,7 +5656,7 @@
5533
5656
  },
5534
5657
  "x-original-maxLength": 1024,
5535
5658
  "x-reconciled-from-discovery": true,
5536
- "x-reconciled-at": "2026-01-05T18:29:42.290273+00:00"
5659
+ "x-reconciled-at": "2026-01-07T15:53:48.649376+00:00"
5537
5660
  },
5538
5661
  "status": {
5539
5662
  "type": "string",
@@ -5542,6 +5665,7 @@
5542
5665
  "x-displayname": "Status",
5543
5666
  "x-ves-example": "Value",
5544
5667
  "x-f5xc-example": "value",
5668
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
5545
5669
  "minLength": 0,
5546
5670
  "maxLength": 17,
5547
5671
  "x-f5xc-required-for": {
@@ -5552,9 +5676,10 @@
5552
5676
  },
5553
5677
  "x-original-maxLength": 1024,
5554
5678
  "x-reconciled-from-discovery": true,
5555
- "x-reconciled-at": "2026-01-05T18:29:42.290277+00:00"
5679
+ "x-reconciled-at": "2026-01-07T15:53:48.649380+00:00"
5556
5680
  }
5557
5681
  },
5682
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
5558
5683
  "x-f5xc-minimum-configuration": {
5559
5684
  "description": "Minimum configuration for schemaStatusType",
5560
5685
  "required_fields": [
@@ -5582,6 +5707,8 @@
5582
5707
  "title": "Creation_timestamp.",
5583
5708
  "format": "date-time",
5584
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.",
5585
5712
  "minLength": 0,
5586
5713
  "maxLength": 1024,
5587
5714
  "x-f5xc-required-for": {
@@ -5599,6 +5726,7 @@
5599
5726
  "x-displayname": "Creator Class.",
5600
5727
  "x-ves-example": "Prism",
5601
5728
  "x-f5xc-example": "value",
5729
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
5602
5730
  "minLength": 0,
5603
5731
  "maxLength": 1024,
5604
5732
  "x-f5xc-required-for": {
@@ -5616,6 +5744,7 @@
5616
5744
  "x-displayname": "Creator ID.",
5617
5745
  "x-ves-example": "Admin@example-corp.com.",
5618
5746
  "x-f5xc-example": "value",
5747
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
5619
5748
  "minLength": 0,
5620
5749
  "maxLength": 1024,
5621
5750
  "x-f5xc-required-for": {
@@ -5632,6 +5761,8 @@
5632
5761
  "title": "Deletion_timestamp.",
5633
5762
  "format": "date-time",
5634
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...",
5635
5766
  "minLength": 0,
5636
5767
  "maxLength": 1024,
5637
5768
  "x-f5xc-required-for": {
@@ -5651,6 +5782,8 @@
5651
5782
  "x-displayname": "Finalizers.",
5652
5783
  "x-ves-example": "Value",
5653
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.",
5654
5787
  "x-f5xc-required-for": {
5655
5788
  "minimum_config": false,
5656
5789
  "create": false,
@@ -5668,6 +5801,8 @@
5668
5801
  "x-displayname": "Labels",
5669
5802
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
5670
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).",
5671
5806
  "x-f5xc-required-for": {
5672
5807
  "minimum_config": false,
5673
5808
  "create": false,
@@ -5681,6 +5816,8 @@
5681
5816
  "title": "Modification_timestamp.",
5682
5817
  "format": "date-time",
5683
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.",
5684
5821
  "minLength": 0,
5685
5822
  "maxLength": 1024,
5686
5823
  "x-f5xc-required-for": {
@@ -5699,6 +5836,8 @@
5699
5836
  "x-displayname": "Object Index.",
5700
5837
  "x-ves-example": "0",
5701
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.",
5702
5841
  "minimum": 0,
5703
5842
  "maximum": 2147483647,
5704
5843
  "x-f5xc-required-for": {
@@ -5719,6 +5858,8 @@
5719
5858
  "x-displayname": "Tenant",
5720
5859
  "x-ves-example": "Example-corp.",
5721
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.",
5722
5863
  "minLength": 0,
5723
5864
  "maxLength": 18,
5724
5865
  "x-f5xc-required-for": {
@@ -5730,7 +5871,7 @@
5730
5871
  "x-field-mutability": "read-only",
5731
5872
  "x-original-maxLength": 1024,
5732
5873
  "x-reconciled-from-discovery": true,
5733
- "x-reconciled-at": "2026-01-05T18:29:42.290298+00:00"
5874
+ "x-reconciled-at": "2026-01-07T15:53:48.649399+00:00"
5734
5875
  },
5735
5876
  "uid": {
5736
5877
  "type": "string",
@@ -5739,6 +5880,8 @@
5739
5880
  "x-displayname": "UID",
5740
5881
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5741
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.",
5742
5885
  "minLength": 0,
5743
5886
  "maxLength": 36,
5744
5887
  "x-f5xc-required-for": {
@@ -5751,9 +5894,11 @@
5751
5894
  "x-original-maxLength": 1024,
5752
5895
  "format": "uuid",
5753
5896
  "x-reconciled-from-discovery": true,
5754
- "x-reconciled-at": "2026-01-05T18:29:42.290303+00:00"
5897
+ "x-reconciled-at": "2026-01-07T15:53:48.649404+00:00"
5755
5898
  }
5756
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.",
5757
5902
  "x-f5xc-minimum-configuration": {
5758
5903
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
5759
5904
  "required_fields": [
@@ -5801,7 +5946,7 @@
5801
5946
  },
5802
5947
  "x-original-maxLength": 1024,
5803
5948
  "x-reconciled-from-discovery": true,
5804
- "x-reconciled-at": "2026-01-05T18:29:42.290308+00:00"
5949
+ "x-reconciled-at": "2026-01-07T15:53:48.649408+00:00"
5805
5950
  },
5806
5951
  "name": {
5807
5952
  "type": "string",
@@ -5810,6 +5955,8 @@
5810
5955
  "x-displayname": "Name",
5811
5956
  "x-ves-example": "Contactus-route.",
5812
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.",
5813
5960
  "minLength": 0,
5814
5961
  "maxLength": 16,
5815
5962
  "x-f5xc-required-for": {
@@ -5820,7 +5967,7 @@
5820
5967
  },
5821
5968
  "x-original-maxLength": 1024,
5822
5969
  "x-reconciled-from-discovery": true,
5823
- "x-reconciled-at": "2026-01-05T18:29:42.290313+00:00"
5970
+ "x-reconciled-at": "2026-01-07T15:53:48.649413+00:00"
5824
5971
  },
5825
5972
  "namespace": {
5826
5973
  "type": "string",
@@ -5829,6 +5976,8 @@
5829
5976
  "x-displayname": "Namespace",
5830
5977
  "x-ves-example": "Ns1",
5831
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.",
5832
5981
  "minLength": 0,
5833
5982
  "maxLength": 6,
5834
5983
  "x-f5xc-required-for": {
@@ -5839,7 +5988,7 @@
5839
5988
  },
5840
5989
  "x-original-maxLength": 1024,
5841
5990
  "x-reconciled-from-discovery": true,
5842
- "x-reconciled-at": "2026-01-05T18:29:42.290317+00:00"
5991
+ "x-reconciled-at": "2026-01-07T15:53:48.649417+00:00"
5843
5992
  },
5844
5993
  "uid": {
5845
5994
  "type": "string",
@@ -5860,9 +6009,10 @@
5860
6009
  "x-original-maxLength": 1024,
5861
6010
  "format": "uuid",
5862
6011
  "x-reconciled-from-discovery": true,
5863
- "x-reconciled-at": "2026-01-05T18:29:42.290322+00:00"
6012
+ "x-reconciled-at": "2026-01-07T15:53:48.649421+00:00"
5864
6013
  }
5865
6014
  },
6015
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
5866
6016
  "x-f5xc-minimum-configuration": {
5867
6017
  "description": "Minimum configuration for schemaViewRefType",
5868
6018
  "required_fields": [
@@ -5957,6 +6107,7 @@
5957
6107
  "ves.io.schema.rules.repeated.max_items": "64",
5958
6108
  "ves.io.schema.rules.repeated.unique": "true"
5959
6109
  },
6110
+ "x-f5xc-description-short": "List of L4 protocol match condition and associated traffic rate limits.",
5960
6111
  "x-f5xc-required-for": {
5961
6112
  "minimum_config": false,
5962
6113
  "create": false,
@@ -5965,6 +6116,8 @@
5965
6116
  }
5966
6117
  }
5967
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.",
5968
6121
  "x-f5xc-minimum-configuration": {
5969
6122
  "description": "Minimum configuration for protocol_policerCreateSpecType",
5970
6123
  "required_fields": [
@@ -5990,6 +6143,7 @@
5990
6143
  "title": "Fail_if_referred.",
5991
6144
  "format": "boolean",
5992
6145
  "x-displayname": "Fail-If-Referred.",
6146
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
5993
6147
  "x-f5xc-required-for": {
5994
6148
  "minimum_config": false,
5995
6149
  "create": false,
@@ -6014,7 +6168,7 @@
6014
6168
  },
6015
6169
  "x-original-maxLength": 1024,
6016
6170
  "x-reconciled-from-discovery": true,
6017
- "x-reconciled-at": "2026-01-05T18:29:43.529453+00:00"
6171
+ "x-reconciled-at": "2026-01-07T15:53:50.203745+00:00"
6018
6172
  },
6019
6173
  "namespace": {
6020
6174
  "type": "string",
@@ -6023,6 +6177,7 @@
6023
6177
  "x-displayname": "Namespace",
6024
6178
  "x-ves-example": "Ns1",
6025
6179
  "x-f5xc-example": "ns1",
6180
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
6026
6181
  "minLength": 0,
6027
6182
  "maxLength": 6,
6028
6183
  "x-f5xc-required-for": {
@@ -6033,7 +6188,7 @@
6033
6188
  },
6034
6189
  "x-original-maxLength": 1024,
6035
6190
  "x-reconciled-from-discovery": true,
6036
- "x-reconciled-at": "2026-01-05T18:29:43.529458+00:00"
6191
+ "x-reconciled-at": "2026-01-07T15:53:50.203750+00:00"
6037
6192
  }
6038
6193
  },
6039
6194
  "x-f5xc-minimum-configuration": {
@@ -6056,6 +6211,7 @@
6056
6211
  "title": "DNS packets.",
6057
6212
  "x-displayname": "DNS Packets.",
6058
6213
  "x-ves-proto-message": "ves.io.schema.protocol_policer.DnsType",
6214
+ "x-f5xc-description-short": "Match all DNS packets inclusing UDP and TCP.",
6059
6215
  "x-f5xc-minimum-configuration": {
6060
6216
  "description": "Minimum configuration for protocol_policerDnsType",
6061
6217
  "required_fields": [],
@@ -6084,6 +6240,7 @@
6084
6240
  "$ref": "#/components/schemas/schemaObjectRefType"
6085
6241
  },
6086
6242
  "x-displayname": "Deleted Referred Objects.",
6243
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6087
6244
  "x-f5xc-required-for": {
6088
6245
  "minimum_config": false,
6089
6246
  "create": false,
@@ -6099,6 +6256,7 @@
6099
6256
  "$ref": "#/components/schemas/schemaObjectRefType"
6100
6257
  },
6101
6258
  "x-displayname": "Disabled Referred Objects.",
6259
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6102
6260
  "x-f5xc-required-for": {
6103
6261
  "minimum_config": false,
6104
6262
  "create": false,
@@ -6117,6 +6275,7 @@
6117
6275
  "$ref": "#/components/schemas/schemaObjectRefType"
6118
6276
  },
6119
6277
  "x-displayname": "Referring Objects.",
6278
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
6120
6279
  "x-f5xc-required-for": {
6121
6280
  "minimum_config": false,
6122
6281
  "create": false,
@@ -6138,6 +6297,8 @@
6138
6297
  "$ref": "#/components/schemas/protocol_policerStatusObject"
6139
6298
  },
6140
6299
  "x-displayname": "Status",
6300
+ "x-f5xc-example": "active",
6301
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6141
6302
  "x-f5xc-required-for": {
6142
6303
  "minimum_config": false,
6143
6304
  "create": false,
@@ -6147,7 +6308,7 @@
6147
6308
  "maxLength": 17,
6148
6309
  "minLength": 17,
6149
6310
  "x-reconciled-from-discovery": true,
6150
- "x-reconciled-at": "2026-01-05T18:29:43.529474+00:00"
6311
+ "x-reconciled-at": "2026-01-07T15:53:50.203766+00:00"
6151
6312
  },
6152
6313
  "system_metadata": {
6153
6314
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -6187,6 +6348,8 @@
6187
6348
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
6188
6349
  ],
6189
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...",
6190
6353
  "x-f5xc-minimum-configuration": {
6191
6354
  "description": "Minimum configuration for protocol_policerGetResponseFormatCode",
6192
6355
  "required_fields": [],
@@ -6221,6 +6384,7 @@
6221
6384
  "ves.io.schema.rules.repeated.max_items": "64",
6222
6385
  "ves.io.schema.rules.repeated.unique": "true"
6223
6386
  },
6387
+ "x-f5xc-description-short": "List of L4 protocol match condition and associated traffic rate limits.",
6224
6388
  "x-f5xc-required-for": {
6225
6389
  "minimum_config": false,
6226
6390
  "create": false,
@@ -6229,6 +6393,8 @@
6229
6393
  }
6230
6394
  }
6231
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.",
6232
6398
  "x-f5xc-minimum-configuration": {
6233
6399
  "description": "Minimum configuration for protocol_policerGetSpecType",
6234
6400
  "required_fields": [
@@ -6253,6 +6419,8 @@
6253
6419
  "default": "ECHO_REPLY",
6254
6420
  "x-displayname": "ICMP Message Types.",
6255
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.",
6256
6424
  "x-f5xc-minimum-configuration": {
6257
6425
  "description": "Minimum configuration for protocol_policerIcmpMsgType",
6258
6426
  "required_fields": [],
@@ -6278,6 +6446,7 @@
6278
6446
  "$ref": "#/components/schemas/protocol_policerIcmpMsgType"
6279
6447
  },
6280
6448
  "x-displayname": "ICMP type",
6449
+ "x-f5xc-description-short": "ICMP message type to be matched in packet.",
6281
6450
  "x-f5xc-required-for": {
6282
6451
  "minimum_config": false,
6283
6452
  "create": false,
@@ -6313,6 +6482,7 @@
6313
6482
  "$ref": "#/components/schemas/schemaErrorType"
6314
6483
  },
6315
6484
  "x-displayname": "Errors",
6485
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
6316
6486
  "x-f5xc-required-for": {
6317
6487
  "minimum_config": false,
6318
6488
  "create": false,
@@ -6328,6 +6498,8 @@
6328
6498
  "$ref": "#/components/schemas/protocol_policerListResponseItem"
6329
6499
  },
6330
6500
  "x-displayname": "Items",
6501
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
6502
+ "x-f5xc-description-short": "Items represents the collection in response.",
6331
6503
  "x-f5xc-required-for": {
6332
6504
  "minimum_config": false,
6333
6505
  "create": false,
@@ -6361,6 +6533,8 @@
6361
6533
  "description": "The set of annotations present on this protocol_policer.",
6362
6534
  "title": "Annotations.",
6363
6535
  "x-displayname": "Annotations.",
6536
+ "x-f5xc-example": "{\"key\": \"value\"}",
6537
+ "x-f5xc-description-short": "The set of annotations present on this protocol_policer.",
6364
6538
  "x-f5xc-required-for": {
6365
6539
  "minimum_config": false,
6366
6540
  "create": false,
@@ -6373,6 +6547,7 @@
6373
6547
  "description": "The description set for this protocol_policer.",
6374
6548
  "title": "Description.",
6375
6549
  "x-displayname": "Description.",
6550
+ "x-f5xc-description-short": "The description set for this protocol_policer.",
6376
6551
  "minLength": 0,
6377
6552
  "maxLength": 0,
6378
6553
  "x-f5xc-required-for": {
@@ -6383,7 +6558,7 @@
6383
6558
  },
6384
6559
  "x-original-maxLength": 1024,
6385
6560
  "x-reconciled-from-discovery": true,
6386
- "x-reconciled-at": "2026-01-05T18:29:43.529490+00:00"
6561
+ "x-reconciled-at": "2026-01-07T15:53:50.203783+00:00"
6387
6562
  },
6388
6563
  "disabled": {
6389
6564
  "type": "boolean",
@@ -6391,6 +6566,8 @@
6391
6566
  "title": "Disabled",
6392
6567
  "format": "boolean",
6393
6568
  "x-displayname": "Disabled",
6569
+ "x-f5xc-example": "True",
6570
+ "x-f5xc-description-short": "Value of true indicates protocol_policer is administratively disabled.",
6394
6571
  "x-f5xc-required-for": {
6395
6572
  "minimum_config": false,
6396
6573
  "create": false,
@@ -6406,6 +6583,8 @@
6406
6583
  "description": "The set of labels present on this protocol_policer.",
6407
6584
  "title": "Labels",
6408
6585
  "x-displayname": "Labels",
6586
+ "x-f5xc-example": "{\"key\": \"value\"}",
6587
+ "x-f5xc-description-short": "The set of labels present on this protocol_policer.",
6409
6588
  "x-f5xc-required-for": {
6410
6589
  "minimum_config": false,
6411
6590
  "create": false,
@@ -6433,7 +6612,7 @@
6433
6612
  },
6434
6613
  "x-original-maxLength": 1024,
6435
6614
  "x-reconciled-from-discovery": true,
6436
- "x-reconciled-at": "2026-01-05T18:29:43.529502+00:00"
6615
+ "x-reconciled-at": "2026-01-07T15:53:50.203793+00:00"
6437
6616
  },
6438
6617
  "namespace": {
6439
6618
  "type": "string",
@@ -6452,7 +6631,7 @@
6452
6631
  },
6453
6632
  "x-original-maxLength": 1024,
6454
6633
  "x-reconciled-from-discovery": true,
6455
- "x-reconciled-at": "2026-01-05T18:29:43.529507+00:00"
6634
+ "x-reconciled-at": "2026-01-07T15:53:50.203797+00:00"
6456
6635
  },
6457
6636
  "owner_view": {
6458
6637
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -6465,6 +6644,7 @@
6465
6644
  "$ref": "#/components/schemas/protocol_policerStatusObject"
6466
6645
  },
6467
6646
  "x-displayname": "Status",
6647
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6468
6648
  "x-f5xc-required-for": {
6469
6649
  "minimum_config": false,
6470
6650
  "create": false,
@@ -6493,7 +6673,7 @@
6493
6673
  "x-field-mutability": "read-only",
6494
6674
  "x-original-maxLength": 1024,
6495
6675
  "x-reconciled-from-discovery": true,
6496
- "x-reconciled-at": "2026-01-05T18:29:43.529515+00:00"
6676
+ "x-reconciled-at": "2026-01-07T15:53:50.203804+00:00"
6497
6677
  },
6498
6678
  "uid": {
6499
6679
  "type": "string",
@@ -6502,6 +6682,7 @@
6502
6682
  "x-displayname": "UID",
6503
6683
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
6504
6684
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
6685
+ "x-f5xc-description-short": "The unique uid of this protocol_policer.",
6505
6686
  "minLength": 0,
6506
6687
  "maxLength": 36,
6507
6688
  "x-f5xc-required-for": {
@@ -6514,9 +6695,11 @@
6514
6695
  "x-original-maxLength": 1024,
6515
6696
  "format": "uuid",
6516
6697
  "x-reconciled-from-discovery": true,
6517
- "x-reconciled-at": "2026-01-05T18:29:43.529520+00:00"
6698
+ "x-reconciled-at": "2026-01-07T15:53:50.203810+00:00"
6518
6699
  }
6519
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.",
6520
6703
  "x-f5xc-minimum-configuration": {
6521
6704
  "description": "Minimum configuration for protocol_policerListResponseItem",
6522
6705
  "required_fields": [
@@ -6569,6 +6752,7 @@
6569
6752
  "ves.io.schema.rules.repeated.max_items": "1",
6570
6753
  "ves.io.schema.rules.repeated.min_items": "1"
6571
6754
  },
6755
+ "x-f5xc-description-short": "Reference to policer object to apply traffic rate limits Required: YES.",
6572
6756
  "x-f5xc-required-for": {
6573
6757
  "minimum_config": false,
6574
6758
  "create": false,
@@ -6580,6 +6764,8 @@
6580
6764
  "$ref": "#/components/schemas/protocol_policerProtocolType"
6581
6765
  }
6582
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 *...",
6583
6769
  "x-f5xc-minimum-configuration": {
6584
6770
  "description": "Minimum configuration for protocol_policerProtocolPolicerType",
6585
6771
  "required_fields": [
@@ -6614,6 +6800,7 @@
6614
6800
  "$ref": "#/components/schemas/protocol_policerUdpType"
6615
6801
  }
6616
6802
  },
6803
+ "x-f5xc-description-short": "Protocol and protocol specific flags to be matched in packet.",
6617
6804
  "x-f5xc-minimum-configuration": {
6618
6805
  "description": "Minimum configuration for protocol_policerProtocolType",
6619
6806
  "required_fields": [
@@ -6693,6 +6880,7 @@
6693
6880
  "ves.io.schema.rules.repeated.max_items": "64",
6694
6881
  "ves.io.schema.rules.repeated.unique": "true"
6695
6882
  },
6883
+ "x-f5xc-description-short": "List of L4 protocol match condition and associated traffic rate limits.",
6696
6884
  "x-f5xc-required-for": {
6697
6885
  "minimum_config": false,
6698
6886
  "create": false,
@@ -6701,6 +6889,8 @@
6701
6889
  }
6702
6890
  }
6703
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.",
6704
6894
  "x-f5xc-minimum-configuration": {
6705
6895
  "description": "Minimum configuration for protocol_policerReplaceSpecType",
6706
6896
  "required_fields": [
@@ -6729,6 +6919,7 @@
6729
6919
  "$ref": "#/components/schemas/schemaConditionType"
6730
6920
  },
6731
6921
  "x-displayname": "Conditions.",
6922
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
6732
6923
  "x-f5xc-required-for": {
6733
6924
  "minimum_config": false,
6734
6925
  "create": false,
@@ -6755,6 +6946,7 @@
6755
6946
  }
6756
6947
  }
6757
6948
  },
6949
+ "x-f5xc-description-short": "Most recently observed status of object.",
6758
6950
  "x-f5xc-minimum-configuration": {
6759
6951
  "description": "Minimum configuration for protocol_policerStatusObject",
6760
6952
  "required_fields": [
@@ -6786,6 +6978,8 @@
6786
6978
  "default": "FIN",
6787
6979
  "x-displayname": "TCP Flags",
6788
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...",
6789
6983
  "x-f5xc-minimum-configuration": {
6790
6984
  "description": "Minimum configuration for protocol_policerTcpFlags",
6791
6985
  "required_fields": [],
@@ -6819,6 +7013,7 @@
6819
7013
  }
6820
7014
  }
6821
7015
  },
7016
+ "x-f5xc-description-short": "Specification of TCP flag to be matched in a TCP packet.",
6822
7017
  "x-f5xc-minimum-configuration": {
6823
7018
  "description": "Minimum configuration for protocol_policerTcpType",
6824
7019
  "required_fields": [
@@ -6853,6 +7048,7 @@
6853
7048
  "title": "Empty",
6854
7049
  "x-displayname": "Empty",
6855
7050
  "x-ves-proto-message": "ves.io.schema.Empty",
7051
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
6856
7052
  "x-f5xc-minimum-configuration": {
6857
7053
  "description": "Minimum configuration for ioschemaEmpty",
6858
7054
  "required_fields": [],
@@ -6942,6 +7138,8 @@
6942
7138
  "ves.io.schema.rules.message.required": "true",
6943
7139
  "ves.io.schema.rules.repeated.max_items": "1"
6944
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.",
6945
7143
  "x-f5xc-required-for": {
6946
7144
  "minimum_config": false,
6947
7145
  "create": false,
@@ -6963,6 +7161,8 @@
6963
7161
  "x-validation-rules": {
6964
7162
  "ves.io.schema.rules.repeated.max_items": "1"
6965
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.",
6966
7166
  "x-f5xc-required-for": {
6967
7167
  "minimum_config": false,
6968
7168
  "create": false,
@@ -6972,6 +7172,7 @@
6972
7172
  "x-field-mutability": "read-only"
6973
7173
  }
6974
7174
  },
7175
+ "x-f5xc-description-short": "Create rate_limiter creates a new object in the storage backend for metadata.namespace.",
6975
7176
  "x-f5xc-minimum-configuration": {
6976
7177
  "description": "Minimum configuration for rate_limiterCreateSpecType",
6977
7178
  "required_fields": [
@@ -6998,6 +7199,7 @@
6998
7199
  "title": "Fail_if_referred.",
6999
7200
  "format": "boolean",
7000
7201
  "x-displayname": "Fail-If-Referred.",
7202
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
7001
7203
  "x-f5xc-required-for": {
7002
7204
  "minimum_config": false,
7003
7205
  "create": false,
@@ -7022,7 +7224,7 @@
7022
7224
  },
7023
7225
  "x-original-maxLength": 1024,
7024
7226
  "x-reconciled-from-discovery": true,
7025
- "x-reconciled-at": "2026-01-05T18:29:45.279182+00:00"
7227
+ "x-reconciled-at": "2026-01-07T15:53:52.470635+00:00"
7026
7228
  },
7027
7229
  "namespace": {
7028
7230
  "type": "string",
@@ -7031,6 +7233,7 @@
7031
7233
  "x-displayname": "Namespace",
7032
7234
  "x-ves-example": "Ns1",
7033
7235
  "x-f5xc-example": "ns1",
7236
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
7034
7237
  "minLength": 0,
7035
7238
  "maxLength": 6,
7036
7239
  "x-f5xc-required-for": {
@@ -7041,7 +7244,7 @@
7041
7244
  },
7042
7245
  "x-original-maxLength": 1024,
7043
7246
  "x-reconciled-from-discovery": true,
7044
- "x-reconciled-at": "2026-01-05T18:29:45.279187+00:00"
7247
+ "x-reconciled-at": "2026-01-07T15:53:52.470640+00:00"
7045
7248
  }
7046
7249
  },
7047
7250
  "x-f5xc-minimum-configuration": {
@@ -7076,6 +7279,7 @@
7076
7279
  "$ref": "#/components/schemas/schemaObjectRefType"
7077
7280
  },
7078
7281
  "x-displayname": "Deleted Referred Objects.",
7282
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
7079
7283
  "x-f5xc-required-for": {
7080
7284
  "minimum_config": false,
7081
7285
  "create": false,
@@ -7091,6 +7295,7 @@
7091
7295
  "$ref": "#/components/schemas/schemaObjectRefType"
7092
7296
  },
7093
7297
  "x-displayname": "Disabled Referred Objects.",
7298
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
7094
7299
  "x-f5xc-required-for": {
7095
7300
  "minimum_config": false,
7096
7301
  "create": false,
@@ -7109,6 +7314,7 @@
7109
7314
  "$ref": "#/components/schemas/schemaObjectRefType"
7110
7315
  },
7111
7316
  "x-displayname": "Referring Objects.",
7317
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
7112
7318
  "x-f5xc-required-for": {
7113
7319
  "minimum_config": false,
7114
7320
  "create": false,
@@ -7130,6 +7336,8 @@
7130
7336
  "$ref": "#/components/schemas/rate_limiterStatusObject"
7131
7337
  },
7132
7338
  "x-displayname": "Status",
7339
+ "x-f5xc-example": "active",
7340
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
7133
7341
  "x-f5xc-required-for": {
7134
7342
  "minimum_config": false,
7135
7343
  "create": false,
@@ -7139,7 +7347,7 @@
7139
7347
  "maxLength": 17,
7140
7348
  "minLength": 17,
7141
7349
  "x-reconciled-from-discovery": true,
7142
- "x-reconciled-at": "2026-01-05T18:29:45.279203+00:00"
7350
+ "x-reconciled-at": "2026-01-07T15:53:52.470655+00:00"
7143
7351
  },
7144
7352
  "system_metadata": {
7145
7353
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -7179,6 +7387,8 @@
7179
7387
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
7180
7388
  ],
7181
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...",
7182
7392
  "x-f5xc-minimum-configuration": {
7183
7393
  "description": "Minimum configuration for rate_limiterGetResponseFormatCode",
7184
7394
  "required_fields": [],
@@ -7213,6 +7423,8 @@
7213
7423
  "ves.io.schema.rules.message.required": "true",
7214
7424
  "ves.io.schema.rules.repeated.max_items": "1"
7215
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.",
7216
7428
  "x-f5xc-required-for": {
7217
7429
  "minimum_config": false,
7218
7430
  "create": false,
@@ -7234,6 +7446,8 @@
7234
7446
  "x-validation-rules": {
7235
7447
  "ves.io.schema.rules.repeated.max_items": "1"
7236
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.",
7237
7451
  "x-f5xc-required-for": {
7238
7452
  "minimum_config": false,
7239
7453
  "create": false,
@@ -7243,6 +7457,7 @@
7243
7457
  "x-field-mutability": "read-only"
7244
7458
  }
7245
7459
  },
7460
+ "x-f5xc-description-short": "GET rate_limiter reads a given object from storage backend for metadata.namespace.",
7246
7461
  "x-f5xc-minimum-configuration": {
7247
7462
  "description": "Minimum configuration for rate_limiterGetSpecType",
7248
7463
  "required_fields": [
@@ -7265,7 +7480,7 @@
7265
7480
  "properties": {
7266
7481
  "duration": {
7267
7482
  "type": "integer",
7268
- "description": "",
7483
+ "description": "Configuration parameter for duration",
7269
7484
  "title": "Duration",
7270
7485
  "format": "int64",
7271
7486
  "x-displayname": "Duration",
@@ -7308,7 +7523,7 @@
7308
7523
  "properties": {
7309
7524
  "duration": {
7310
7525
  "type": "integer",
7311
- "description": "",
7526
+ "description": "Configuration parameter for duration",
7312
7527
  "title": "Duration",
7313
7528
  "format": "int64",
7314
7529
  "x-displayname": "Duration",
@@ -7351,7 +7566,7 @@
7351
7566
  "properties": {
7352
7567
  "duration": {
7353
7568
  "type": "integer",
7354
- "description": "",
7569
+ "description": "Configuration parameter for duration",
7355
7570
  "title": "Duration",
7356
7571
  "format": "int64",
7357
7572
  "x-displayname": "Duration",
@@ -7391,6 +7606,7 @@
7391
7606
  "title": "LeakyBucketRateLimiter.",
7392
7607
  "x-displayname": "Leaky Bucket Rate Limiter.",
7393
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.",
7394
7610
  "x-f5xc-minimum-configuration": {
7395
7611
  "description": "Minimum configuration for rate_limiterLeakyBucketRateLimiter",
7396
7612
  "required_fields": [],
@@ -7416,6 +7632,7 @@
7416
7632
  "$ref": "#/components/schemas/schemaErrorType"
7417
7633
  },
7418
7634
  "x-displayname": "Errors",
7635
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
7419
7636
  "x-f5xc-required-for": {
7420
7637
  "minimum_config": false,
7421
7638
  "create": false,
@@ -7431,6 +7648,8 @@
7431
7648
  "$ref": "#/components/schemas/rate_limiterListResponseItem"
7432
7649
  },
7433
7650
  "x-displayname": "Items",
7651
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
7652
+ "x-f5xc-description-short": "Items represents the collection in response.",
7434
7653
  "x-f5xc-required-for": {
7435
7654
  "minimum_config": false,
7436
7655
  "create": false,
@@ -7464,6 +7683,8 @@
7464
7683
  "description": "The set of annotations present on this rate_limiter.",
7465
7684
  "title": "Annotations.",
7466
7685
  "x-displayname": "Annotations.",
7686
+ "x-f5xc-example": "{\"key\": \"value\"}",
7687
+ "x-f5xc-description-short": "The set of annotations present on this rate_limiter.",
7467
7688
  "x-f5xc-required-for": {
7468
7689
  "minimum_config": false,
7469
7690
  "create": false,
@@ -7476,6 +7697,7 @@
7476
7697
  "description": "The description set for this rate_limiter.",
7477
7698
  "title": "Description.",
7478
7699
  "x-displayname": "Description.",
7700
+ "x-f5xc-description-short": "The description set for this rate_limiter.",
7479
7701
  "minLength": 0,
7480
7702
  "maxLength": 0,
7481
7703
  "x-f5xc-required-for": {
@@ -7486,7 +7708,7 @@
7486
7708
  },
7487
7709
  "x-original-maxLength": 1024,
7488
7710
  "x-reconciled-from-discovery": true,
7489
- "x-reconciled-at": "2026-01-05T18:29:45.279225+00:00"
7711
+ "x-reconciled-at": "2026-01-07T15:53:52.470677+00:00"
7490
7712
  },
7491
7713
  "disabled": {
7492
7714
  "type": "boolean",
@@ -7494,6 +7716,8 @@
7494
7716
  "title": "Disabled",
7495
7717
  "format": "boolean",
7496
7718
  "x-displayname": "Disabled",
7719
+ "x-f5xc-example": "True",
7720
+ "x-f5xc-description-short": "Value of true indicates rate_limiter is administratively disabled.",
7497
7721
  "x-f5xc-required-for": {
7498
7722
  "minimum_config": false,
7499
7723
  "create": false,
@@ -7509,6 +7733,8 @@
7509
7733
  "description": "The set of labels present on this rate_limiter.",
7510
7734
  "title": "Labels",
7511
7735
  "x-displayname": "Labels",
7736
+ "x-f5xc-example": "{\"key\": \"value\"}",
7737
+ "x-f5xc-description-short": "The set of labels present on this rate_limiter.",
7512
7738
  "x-f5xc-required-for": {
7513
7739
  "minimum_config": false,
7514
7740
  "create": false,
@@ -7536,7 +7762,7 @@
7536
7762
  },
7537
7763
  "x-original-maxLength": 1024,
7538
7764
  "x-reconciled-from-discovery": true,
7539
- "x-reconciled-at": "2026-01-05T18:29:45.279235+00:00"
7765
+ "x-reconciled-at": "2026-01-07T15:53:52.470688+00:00"
7540
7766
  },
7541
7767
  "namespace": {
7542
7768
  "type": "string",
@@ -7555,7 +7781,7 @@
7555
7781
  },
7556
7782
  "x-original-maxLength": 1024,
7557
7783
  "x-reconciled-from-discovery": true,
7558
- "x-reconciled-at": "2026-01-05T18:29:45.279239+00:00"
7784
+ "x-reconciled-at": "2026-01-07T15:53:52.470692+00:00"
7559
7785
  },
7560
7786
  "owner_view": {
7561
7787
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -7568,6 +7794,7 @@
7568
7794
  "$ref": "#/components/schemas/rate_limiterStatusObject"
7569
7795
  },
7570
7796
  "x-displayname": "Status",
7797
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
7571
7798
  "x-f5xc-required-for": {
7572
7799
  "minimum_config": false,
7573
7800
  "create": false,
@@ -7596,7 +7823,7 @@
7596
7823
  "x-field-mutability": "read-only",
7597
7824
  "x-original-maxLength": 1024,
7598
7825
  "x-reconciled-from-discovery": true,
7599
- "x-reconciled-at": "2026-01-05T18:29:45.279247+00:00"
7826
+ "x-reconciled-at": "2026-01-07T15:53:52.470700+00:00"
7600
7827
  },
7601
7828
  "uid": {
7602
7829
  "type": "string",
@@ -7617,9 +7844,11 @@
7617
7844
  "x-original-maxLength": 1024,
7618
7845
  "format": "uuid",
7619
7846
  "x-reconciled-from-discovery": true,
7620
- "x-reconciled-at": "2026-01-05T18:29:45.279252+00:00"
7847
+ "x-reconciled-at": "2026-01-07T15:53:52.470706+00:00"
7621
7848
  }
7622
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.",
7623
7852
  "x-f5xc-minimum-configuration": {
7624
7853
  "description": "Minimum configuration for rate_limiterListResponseItem",
7625
7854
  "required_fields": [
@@ -7662,6 +7891,7 @@
7662
7891
  "$ref": "#/components/schemas/rate_limiterInputSeconds"
7663
7892
  }
7664
7893
  },
7894
+ "x-f5xc-description-short": "Action where a user is blocked from making further requests after exceeding rate limit threshold.",
7665
7895
  "x-f5xc-minimum-configuration": {
7666
7896
  "description": "Minimum configuration for rate_limiterRateLimitBlockAction",
7667
7897
  "required_fields": [
@@ -7688,6 +7918,8 @@
7688
7918
  "default": "SECOND",
7689
7919
  "x-displayname": "Rate Limit Period Unit.",
7690
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.",
7691
7923
  "x-f5xc-minimum-configuration": {
7692
7924
  "description": "Minimum configuration for rate_limiterRateLimitPeriodUnit",
7693
7925
  "required_fields": [],
@@ -7726,6 +7958,7 @@
7726
7958
  "ves.io.schema.rules.uint32.gt": "0",
7727
7959
  "ves.io.schema.rules.uint32.lte": "100"
7728
7960
  },
7961
+ "x-f5xc-description-short": "The maximum burst of requests to accommodate, expressed as a multiple of the rate.",
7729
7962
  "minimum": 0,
7730
7963
  "maximum": 2147483647,
7731
7964
  "x-f5xc-required-for": {
@@ -7755,6 +7988,7 @@
7755
7988
  "x-validation-rules": {
7756
7989
  "ves.io.schema.rules.uint32.gte": "0"
7757
7990
  },
7991
+ "x-f5xc-description-short": "Setting, combined with Per Period units, provides a duration.",
7758
7992
  "minimum": 0,
7759
7993
  "maximum": 2147483647,
7760
7994
  "x-f5xc-required-for": {
@@ -7786,6 +8020,7 @@
7786
8020
  "ves.io.schema.rules.uint32.gt": "0",
7787
8021
  "ves.io.schema.rules.uint32.lte": "8192"
7788
8022
  },
8023
+ "x-f5xc-description-short": "The total number of allowed requests per rate-limiting period. Required: YES.",
7789
8024
  "minimum": 0,
7790
8025
  "maximum": 2147483647,
7791
8026
  "x-f5xc-required-for": {
@@ -7799,6 +8034,8 @@
7799
8034
  "$ref": "#/components/schemas/rate_limiterRateLimitPeriodUnit"
7800
8035
  }
7801
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.",
7802
8039
  "x-f5xc-minimum-configuration": {
7803
8040
  "description": "Minimum configuration for rate_limiterRateLimitValue",
7804
8041
  "required_fields": [
@@ -7882,6 +8119,8 @@
7882
8119
  "ves.io.schema.rules.message.required": "true",
7883
8120
  "ves.io.schema.rules.repeated.max_items": "1"
7884
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.",
7885
8124
  "x-f5xc-required-for": {
7886
8125
  "minimum_config": false,
7887
8126
  "create": false,
@@ -7903,6 +8142,8 @@
7903
8142
  "x-validation-rules": {
7904
8143
  "ves.io.schema.rules.repeated.max_items": "1"
7905
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.",
7906
8147
  "x-f5xc-required-for": {
7907
8148
  "minimum_config": false,
7908
8149
  "create": false,
@@ -7912,6 +8153,7 @@
7912
8153
  "x-field-mutability": "read-only"
7913
8154
  }
7914
8155
  },
8156
+ "x-f5xc-description-short": "Replace rate_limiter replaces an existing object in the storage backend for metadata.namespace.",
7915
8157
  "x-f5xc-minimum-configuration": {
7916
8158
  "description": "Minimum configuration for rate_limiterReplaceSpecType",
7917
8159
  "required_fields": [
@@ -7940,6 +8182,7 @@
7940
8182
  "$ref": "#/components/schemas/schemaConditionType"
7941
8183
  },
7942
8184
  "x-displayname": "Conditions.",
8185
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
7943
8186
  "x-f5xc-required-for": {
7944
8187
  "minimum_config": false,
7945
8188
  "create": false,
@@ -7966,6 +8209,7 @@
7966
8209
  }
7967
8210
  }
7968
8211
  },
8212
+ "x-f5xc-description-short": "Most recently observed status of object.",
7969
8213
  "x-f5xc-minimum-configuration": {
7970
8214
  "description": "Minimum configuration for rate_limiterStatusObject",
7971
8215
  "required_fields": [
@@ -7986,6 +8230,7 @@
7986
8230
  "title": "TokenBucketRateLimiter.",
7987
8231
  "x-displayname": "Token Bucket Rate Limiter.",
7988
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.",
7989
8234
  "x-f5xc-minimum-configuration": {
7990
8235
  "description": "Minimum configuration for rate_limiterTokenBucketRateLimiter",
7991
8236
  "required_fields": [],