@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.19-2601071557

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  2. package/dist/tools/generated/ce_management/index.js +179 -1582
  3. package/dist/tools/generated/ce_management/index.js.map +1 -1
  4. package/dist/tools/generated/dependency-graph.json +2 -265
  5. package/dist/version.d.ts +2 -2
  6. package/dist/version.js +2 -2
  7. package/manifest.json +1 -1
  8. package/package.json +1 -1
  9. package/specs/domains/admin_console_and_ui.json +111 -25
  10. package/specs/domains/ai_services.json +114 -35
  11. package/specs/domains/api.json +1082 -177
  12. package/specs/domains/authentication.json +205 -45
  13. package/specs/domains/bigip.json +593 -101
  14. package/specs/domains/billing_and_usage.json +440 -82
  15. package/specs/domains/blindfold.json +713 -110
  16. package/specs/domains/bot_and_threat_defense.json +359 -65
  17. package/specs/domains/cdn.json +2131 -194
  18. package/specs/domains/ce_management.json +9110 -15844
  19. package/specs/domains/certificates.json +362 -75
  20. package/specs/domains/cloud_infrastructure.json +802 -119
  21. package/specs/domains/container_services.json +613 -95
  22. package/specs/domains/data_and_privacy_security.json +364 -66
  23. package/specs/domains/data_intelligence.json +324 -63
  24. package/specs/domains/ddos.json +766 -159
  25. package/specs/domains/dns.json +820 -161
  26. package/specs/domains/managed_kubernetes.json +455 -85
  27. package/specs/domains/marketplace.json +670 -104
  28. package/specs/domains/network.json +1620 -238
  29. package/specs/domains/network_security.json +1401 -191
  30. package/specs/domains/nginx_one.json +326 -62
  31. package/specs/domains/object_storage.json +49 -15
  32. package/specs/domains/observability.json +999 -147
  33. package/specs/domains/rate_limiting.json +300 -55
  34. package/specs/domains/secops_and_incident_response.json +189 -36
  35. package/specs/domains/service_mesh.json +955 -124
  36. package/specs/domains/shape.json +2150 -397
  37. package/specs/domains/sites.json +3830 -364
  38. package/specs/domains/statistics.json +2117 -235
  39. package/specs/domains/support.json +602 -108
  40. package/specs/domains/telemetry_and_insights.json +753 -79
  41. package/specs/domains/tenant_and_identity.json +1874 -308
  42. package/specs/domains/threat_campaign.json +637 -71
  43. package/specs/domains/users.json +278 -66
  44. package/specs/domains/virtual.json +2803 -260
  45. package/specs/domains/vpm_and_node_management.json +3 -1
  46. package/specs/domains/waf.json +1125 -148
  47. package/specs/index.json +24 -24
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Container Services",
5
5
  "description": "Namespaced isolation with configurable limits and autoscaling policies. vK8s abstracts operational overhead while providing scheduling, persistent storage, and service mesh integration. Compute profiles specify CPU, memory, and GPU allocations for reproducible environments. Telemetry tracks consumption patterns across geographically distributed infrastructure nodes.",
6
- "version": "2.0.13",
6
+ "version": "2.0.19",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -3783,6 +3783,7 @@
3783
3783
  "title": "Empty",
3784
3784
  "x-displayname": "Empty",
3785
3785
  "x-ves-proto-message": "ves.io.schema.Empty",
3786
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
3786
3787
  "x-f5xc-minimum-configuration": {
3787
3788
  "description": "Minimum configuration for ioschemaEmpty",
3788
3789
  "required_fields": [],
@@ -3807,6 +3808,8 @@
3807
3808
  "x-displayname": "Kind",
3808
3809
  "x-ves-example": "Virtual_site.",
3809
3810
  "x-f5xc-example": "virtual_site",
3811
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
3812
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
3810
3813
  "minLength": 0,
3811
3814
  "maxLength": 14,
3812
3815
  "x-f5xc-required-for": {
@@ -3818,7 +3821,7 @@
3818
3821
  "readOnly": true,
3819
3822
  "x-original-maxLength": 1024,
3820
3823
  "x-reconciled-from-discovery": true,
3821
- "x-reconciled-at": "2026-01-05T18:30:11.065678+00:00"
3824
+ "x-reconciled-at": "2026-01-07T15:29:42.657845+00:00"
3822
3825
  },
3823
3826
  "name": {
3824
3827
  "type": "string",
@@ -3827,6 +3830,8 @@
3827
3830
  "x-displayname": "Name",
3828
3831
  "x-ves-example": "Contactus-route.",
3829
3832
  "x-f5xc-example": "contactus-route",
3833
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
3834
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
3830
3835
  "minLength": 0,
3831
3836
  "maxLength": 16,
3832
3837
  "x-f5xc-required-for": {
@@ -3837,7 +3842,7 @@
3837
3842
  },
3838
3843
  "x-original-maxLength": 1024,
3839
3844
  "x-reconciled-from-discovery": true,
3840
- "x-reconciled-at": "2026-01-05T18:30:11.065685+00:00"
3845
+ "x-reconciled-at": "2026-01-07T15:29:42.657852+00:00"
3841
3846
  },
3842
3847
  "namespace": {
3843
3848
  "type": "string",
@@ -3846,6 +3851,8 @@
3846
3851
  "x-displayname": "Namespace",
3847
3852
  "x-ves-example": "Ns1",
3848
3853
  "x-f5xc-example": "ns1",
3854
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
3855
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
3849
3856
  "minLength": 0,
3850
3857
  "maxLength": 6,
3851
3858
  "x-f5xc-required-for": {
@@ -3856,7 +3863,7 @@
3856
3863
  },
3857
3864
  "x-original-maxLength": 1024,
3858
3865
  "x-reconciled-from-discovery": true,
3859
- "x-reconciled-at": "2026-01-05T18:30:11.065690+00:00"
3866
+ "x-reconciled-at": "2026-01-07T15:29:42.657857+00:00"
3860
3867
  },
3861
3868
  "tenant": {
3862
3869
  "type": "string",
@@ -3865,6 +3872,8 @@
3865
3872
  "x-displayname": "Tenant",
3866
3873
  "x-ves-example": "Example-corp.",
3867
3874
  "x-f5xc-example": "example-corp",
3875
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
3876
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
3868
3877
  "minLength": 0,
3869
3878
  "maxLength": 18,
3870
3879
  "x-f5xc-required-for": {
@@ -3877,7 +3886,7 @@
3877
3886
  "x-field-mutability": "read-only",
3878
3887
  "x-original-maxLength": 1024,
3879
3888
  "x-reconciled-from-discovery": true,
3880
- "x-reconciled-at": "2026-01-05T18:30:11.065694+00:00"
3889
+ "x-reconciled-at": "2026-01-07T15:29:42.657861+00:00"
3881
3890
  },
3882
3891
  "uid": {
3883
3892
  "type": "string",
@@ -3886,6 +3895,8 @@
3886
3895
  "x-displayname": "UID",
3887
3896
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
3888
3897
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
3898
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
3899
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
3889
3900
  "minLength": 0,
3890
3901
  "maxLength": 36,
3891
3902
  "x-f5xc-required-for": {
@@ -3899,9 +3910,11 @@
3899
3910
  "x-original-maxLength": 1024,
3900
3911
  "format": "uuid",
3901
3912
  "x-reconciled-from-discovery": true,
3902
- "x-reconciled-at": "2026-01-05T18:30:11.065701+00:00"
3913
+ "x-reconciled-at": "2026-01-07T15:29:42.657867+00:00"
3903
3914
  }
3904
3915
  },
3916
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
3917
+ "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
3905
3918
  "x-f5xc-minimum-configuration": {
3906
3919
  "description": "Minimum configuration for ioschemaObjectRefType",
3907
3920
  "required_fields": [
@@ -3925,6 +3938,8 @@
3925
3938
  "type_url": {
3926
3939
  "type": "string",
3927
3940
  "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.",
3941
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
3942
+ "x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).",
3928
3943
  "minLength": 0,
3929
3944
  "maxLength": 1024,
3930
3945
  "x-f5xc-required-for": {
@@ -3948,9 +3963,11 @@
3948
3963
  },
3949
3964
  "x-original-maxLength": 1024,
3950
3965
  "x-reconciled-from-discovery": true,
3951
- "x-reconciled-at": "2026-01-05T18:30:11.065709+00:00"
3966
+ "x-reconciled-at": "2026-01-07T15:29:42.657874+00:00"
3952
3967
  }
3953
3968
  },
3969
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
3970
+ "x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...",
3954
3971
  "x-f5xc-minimum-configuration": {
3955
3972
  "description": "Minimum configuration for protobufAny",
3956
3973
  "required_fields": [
@@ -3976,6 +3993,8 @@
3976
3993
  "description": "Hostname of the instance of the site that sent the status.",
3977
3994
  "title": "Hostname",
3978
3995
  "x-displayname": "Hostname",
3996
+ "x-f5xc-example": "example-resource",
3997
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
3979
3998
  "minLength": 0,
3980
3999
  "maxLength": 1024,
3981
4000
  "x-f5xc-required-for": {
@@ -4007,6 +4026,8 @@
4007
4026
  "x-displayname": "Reason",
4008
4027
  "x-ves-example": "Value",
4009
4028
  "x-f5xc-example": "value",
4029
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
4030
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
4010
4031
  "minLength": 0,
4011
4032
  "maxLength": 43,
4012
4033
  "x-f5xc-required-for": {
@@ -4017,13 +4038,15 @@
4017
4038
  },
4018
4039
  "x-original-maxLength": 1024,
4019
4040
  "x-reconciled-from-discovery": true,
4020
- "x-reconciled-at": "2026-01-05T18:30:11.065718+00:00"
4041
+ "x-reconciled-at": "2026-01-07T15:29:42.657882+00:00"
4021
4042
  },
4022
4043
  "service_name": {
4023
4044
  "type": "string",
4024
4045
  "description": "Name of the service that sent the status.",
4025
4046
  "title": "Service name.",
4026
4047
  "x-displayname": "Service Name.",
4048
+ "x-f5xc-example": "example-resource",
4049
+ "x-f5xc-description-short": "Name of the service that sent the status.",
4027
4050
  "minLength": 0,
4028
4051
  "maxLength": 1024,
4029
4052
  "x-f5xc-required-for": {
@@ -4046,6 +4069,8 @@
4046
4069
  "x-validation-rules": {
4047
4070
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
4048
4071
  },
4072
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
4073
+ "x-f5xc-description-medium": "Status of the condition \"Success\" Validtion has succeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...",
4049
4074
  "minLength": 0,
4050
4075
  "maxLength": 17,
4051
4076
  "x-f5xc-required-for": {
@@ -4056,7 +4081,7 @@
4056
4081
  },
4057
4082
  "x-original-maxLength": 1024,
4058
4083
  "x-reconciled-from-discovery": true,
4059
- "x-reconciled-at": "2026-01-05T18:30:11.065724+00:00"
4084
+ "x-reconciled-at": "2026-01-07T15:29:42.657888+00:00"
4060
4085
  },
4061
4086
  "type": {
4062
4087
  "type": "string",
@@ -4071,6 +4096,8 @@
4071
4096
  "x-validation-rules": {
4072
4097
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
4073
4098
  },
4099
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
4100
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
4074
4101
  "minLength": 0,
4075
4102
  "maxLength": 1024,
4076
4103
  "x-f5xc-required-for": {
@@ -4081,6 +4108,8 @@
4081
4108
  }
4082
4109
  }
4083
4110
  },
4111
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
4112
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
4084
4113
  "x-f5xc-minimum-configuration": {
4085
4114
  "description": "Minimum configuration for schemaConditionType",
4086
4115
  "required_fields": [
@@ -4116,6 +4145,8 @@
4116
4145
  "default": "EOK",
4117
4146
  "x-displayname": "Error Code.",
4118
4147
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
4148
+ "x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...",
4149
+ "x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...",
4119
4150
  "x-f5xc-minimum-configuration": {
4120
4151
  "description": "Minimum configuration for schemaErrorCode",
4121
4152
  "required_fields": [],
@@ -4156,6 +4187,7 @@
4156
4187
  }
4157
4188
  }
4158
4189
  },
4190
+ "x-f5xc-description-short": "Information about a error in API operation.",
4159
4191
  "x-f5xc-minimum-configuration": {
4160
4192
  "description": "Minimum configuration for schemaErrorType",
4161
4193
  "required_fields": [
@@ -4183,6 +4215,7 @@
4183
4215
  "title": "Name",
4184
4216
  "x-displayname": "Name",
4185
4217
  "x-f5xc-example": "example-resource",
4218
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
4186
4219
  "minLength": 0,
4187
4220
  "maxLength": 16,
4188
4221
  "x-f5xc-required-for": {
@@ -4193,9 +4226,10 @@
4193
4226
  },
4194
4227
  "x-original-maxLength": 1024,
4195
4228
  "x-reconciled-from-discovery": true,
4196
- "x-reconciled-at": "2026-01-05T18:30:11.065736+00:00"
4229
+ "x-reconciled-at": "2026-01-07T15:29:42.657899+00:00"
4197
4230
  }
4198
4231
  },
4232
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
4199
4233
  "x-f5xc-minimum-configuration": {
4200
4234
  "description": "Minimum configuration for schemaInitializerType",
4201
4235
  "required_fields": [
@@ -4223,6 +4257,8 @@
4223
4257
  "$ref": "#/components/schemas/schemaInitializerType"
4224
4258
  },
4225
4259
  "x-displayname": "Pending",
4260
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
4261
+ "x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.",
4226
4262
  "x-f5xc-required-for": {
4227
4263
  "minimum_config": false,
4228
4264
  "create": false,
@@ -4234,6 +4270,7 @@
4234
4270
  "$ref": "#/components/schemas/schemaStatusType"
4235
4271
  }
4236
4272
  },
4273
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
4237
4274
  "x-f5xc-minimum-configuration": {
4238
4275
  "description": "Minimum configuration for schemaInitializersType",
4239
4276
  "required_fields": [
@@ -4274,7 +4311,7 @@
4274
4311
  },
4275
4312
  "value": {
4276
4313
  "type": "string",
4277
- "description": "",
4314
+ "description": "Configuration parameter for value",
4278
4315
  "title": "Value",
4279
4316
  "x-displayname": "Value",
4280
4317
  "x-ves-example": "15",
@@ -4289,9 +4326,10 @@
4289
4326
  },
4290
4327
  "x-original-maxLength": 1024,
4291
4328
  "x-reconciled-from-discovery": true,
4292
- "x-reconciled-at": "2026-01-05T18:30:11.065746+00:00"
4329
+ "x-reconciled-at": "2026-01-07T15:29:42.657910+00:00"
4293
4330
  }
4294
4331
  },
4332
+ "x-f5xc-description-short": "Metric data contains timestamp and the value.",
4295
4333
  "x-f5xc-minimum-configuration": {
4296
4334
  "description": "Minimum configuration for schemaMetricValue",
4297
4335
  "required_fields": [
@@ -4331,6 +4369,8 @@
4331
4369
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4332
4370
  "ves.io.schema.rules.map.values.string.min_len": "1"
4333
4371
  },
4372
+ "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
4373
+ "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
4334
4374
  "x-f5xc-required-for": {
4335
4375
  "minimum_config": false,
4336
4376
  "create": false,
@@ -4352,6 +4392,7 @@
4352
4392
  "x-validation-rules": {
4353
4393
  "ves.io.schema.rules.string.max_bytes": "1200"
4354
4394
  },
4395
+ "x-f5xc-description-short": "Human readable description for the object.",
4355
4396
  "minLength": 0,
4356
4397
  "x-f5xc-required-for": {
4357
4398
  "minimum_config": false,
@@ -4361,7 +4402,7 @@
4361
4402
  },
4362
4403
  "x-original-maxLength": 1200,
4363
4404
  "x-reconciled-from-discovery": true,
4364
- "x-reconciled-at": "2026-01-05T18:30:11.065753+00:00"
4405
+ "x-reconciled-at": "2026-01-07T15:29:42.657917+00:00"
4365
4406
  },
4366
4407
  "disable": {
4367
4408
  "type": "boolean",
@@ -4370,6 +4411,7 @@
4370
4411
  "format": "boolean",
4371
4412
  "x-displayname": "Disable",
4372
4413
  "x-f5xc-example": "true",
4414
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4373
4415
  "x-f5xc-required-for": {
4374
4416
  "minimum_config": false,
4375
4417
  "create": false,
@@ -4383,6 +4425,8 @@
4383
4425
  "title": "Labels",
4384
4426
  "x-displayname": "Labels",
4385
4427
  "x-f5xc-example": "value",
4428
+ "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
4429
+ "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
4386
4430
  "x-f5xc-required-for": {
4387
4431
  "minimum_config": false,
4388
4432
  "create": false,
@@ -4404,6 +4448,8 @@
4404
4448
  "x-validation-rules": {
4405
4449
  "ves.io.schema.rules.message.required": "true"
4406
4450
  },
4451
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4452
+ "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
4407
4453
  "minLength": 0,
4408
4454
  "maxLength": 16,
4409
4455
  "x-f5xc-required-for": {
@@ -4414,7 +4460,7 @@
4414
4460
  },
4415
4461
  "x-original-maxLength": 1024,
4416
4462
  "x-reconciled-from-discovery": true,
4417
- "x-reconciled-at": "2026-01-05T18:30:11.065761+00:00"
4463
+ "x-reconciled-at": "2026-01-07T15:29:42.657925+00:00"
4418
4464
  },
4419
4465
  "namespace": {
4420
4466
  "type": "string",
@@ -4423,6 +4469,8 @@
4423
4469
  "x-displayname": "Namespace",
4424
4470
  "x-ves-example": "Staging",
4425
4471
  "x-f5xc-example": "staging",
4472
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4473
+ "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
4426
4474
  "minLength": 0,
4427
4475
  "maxLength": 6,
4428
4476
  "x-f5xc-required-for": {
@@ -4433,9 +4481,10 @@
4433
4481
  },
4434
4482
  "x-original-maxLength": 1024,
4435
4483
  "x-reconciled-from-discovery": true,
4436
- "x-reconciled-at": "2026-01-05T18:30:11.065765+00:00"
4484
+ "x-reconciled-at": "2026-01-07T15:29:42.657929+00:00"
4437
4485
  }
4438
4486
  },
4487
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
4439
4488
  "x-f5xc-minimum-configuration": {
4440
4489
  "description": "Minimum configuration for schemaObjectCreateMetaType",
4441
4490
  "required_fields": [
@@ -4479,6 +4528,8 @@
4479
4528
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4480
4529
  "ves.io.schema.rules.map.values.string.min_len": "1"
4481
4530
  },
4531
+ "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
4532
+ "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
4482
4533
  "x-f5xc-required-for": {
4483
4534
  "minimum_config": false,
4484
4535
  "create": false,
@@ -4500,6 +4551,7 @@
4500
4551
  "x-validation-rules": {
4501
4552
  "ves.io.schema.rules.string.max_bytes": "1200"
4502
4553
  },
4554
+ "x-f5xc-description-short": "Human readable description for the object.",
4503
4555
  "minLength": 0,
4504
4556
  "x-f5xc-required-for": {
4505
4557
  "minimum_config": false,
@@ -4509,7 +4561,7 @@
4509
4561
  },
4510
4562
  "x-original-maxLength": 1200,
4511
4563
  "x-reconciled-from-discovery": true,
4512
- "x-reconciled-at": "2026-01-05T18:30:11.065771+00:00"
4564
+ "x-reconciled-at": "2026-01-07T15:29:42.657936+00:00"
4513
4565
  },
4514
4566
  "disable": {
4515
4567
  "type": "boolean",
@@ -4519,6 +4571,7 @@
4519
4571
  "x-displayname": "Disable",
4520
4572
  "x-ves-example": "True",
4521
4573
  "x-f5xc-example": "true",
4574
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4522
4575
  "x-f5xc-required-for": {
4523
4576
  "minimum_config": false,
4524
4577
  "create": false,
@@ -4533,6 +4586,8 @@
4533
4586
  "x-displayname": "Labels",
4534
4587
  "x-ves-example": "Value",
4535
4588
  "x-f5xc-example": "value",
4589
+ "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
4590
+ "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
4536
4591
  "x-f5xc-required-for": {
4537
4592
  "minimum_config": false,
4538
4593
  "create": false,
@@ -4554,6 +4609,8 @@
4554
4609
  "x-validation-rules": {
4555
4610
  "ves.io.schema.rules.message.required": "true"
4556
4611
  },
4612
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4613
+ "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
4557
4614
  "minLength": 0,
4558
4615
  "maxLength": 16,
4559
4616
  "x-f5xc-required-for": {
@@ -4564,7 +4621,7 @@
4564
4621
  },
4565
4622
  "x-original-maxLength": 1024,
4566
4623
  "x-reconciled-from-discovery": true,
4567
- "x-reconciled-at": "2026-01-05T18:30:11.065778+00:00"
4624
+ "x-reconciled-at": "2026-01-07T15:29:42.657944+00:00"
4568
4625
  },
4569
4626
  "namespace": {
4570
4627
  "type": "string",
@@ -4573,6 +4630,8 @@
4573
4630
  "x-displayname": "Namespace",
4574
4631
  "x-ves-example": "Staging",
4575
4632
  "x-f5xc-example": "staging",
4633
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4634
+ "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
4576
4635
  "minLength": 0,
4577
4636
  "maxLength": 6,
4578
4637
  "x-f5xc-required-for": {
@@ -4583,9 +4642,10 @@
4583
4642
  },
4584
4643
  "x-original-maxLength": 1024,
4585
4644
  "x-reconciled-from-discovery": true,
4586
- "x-reconciled-at": "2026-01-05T18:30:11.065782+00:00"
4645
+ "x-reconciled-at": "2026-01-07T15:29:42.657948+00:00"
4587
4646
  }
4588
4647
  },
4648
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
4589
4649
  "x-f5xc-minimum-configuration": {
4590
4650
  "description": "Minimum configuration for schemaObjectGetMetaType",
4591
4651
  "required_fields": [
@@ -4629,6 +4689,8 @@
4629
4689
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4630
4690
  "ves.io.schema.rules.map.values.string.min_len": "1"
4631
4691
  },
4692
+ "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
4693
+ "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
4632
4694
  "x-f5xc-required-for": {
4633
4695
  "minimum_config": false,
4634
4696
  "create": false,
@@ -4650,6 +4712,7 @@
4650
4712
  "x-validation-rules": {
4651
4713
  "ves.io.schema.rules.string.max_bytes": "1200"
4652
4714
  },
4715
+ "x-f5xc-description-short": "Human readable description for the object.",
4653
4716
  "minLength": 0,
4654
4717
  "x-f5xc-required-for": {
4655
4718
  "minimum_config": false,
@@ -4659,7 +4722,7 @@
4659
4722
  },
4660
4723
  "x-original-maxLength": 1200,
4661
4724
  "x-reconciled-from-discovery": true,
4662
- "x-reconciled-at": "2026-01-05T18:30:11.065789+00:00"
4725
+ "x-reconciled-at": "2026-01-07T15:29:42.657954+00:00"
4663
4726
  },
4664
4727
  "disable": {
4665
4728
  "type": "boolean",
@@ -4668,6 +4731,7 @@
4668
4731
  "format": "boolean",
4669
4732
  "x-displayname": "Disable",
4670
4733
  "x-f5xc-example": "true",
4734
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4671
4735
  "x-f5xc-required-for": {
4672
4736
  "minimum_config": false,
4673
4737
  "create": false,
@@ -4682,6 +4746,8 @@
4682
4746
  "x-displayname": "Labels",
4683
4747
  "x-ves-example": "Value",
4684
4748
  "x-f5xc-example": "value",
4749
+ "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
4750
+ "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
4685
4751
  "x-f5xc-required-for": {
4686
4752
  "minimum_config": false,
4687
4753
  "create": false,
@@ -4702,6 +4768,8 @@
4702
4768
  "x-validation-rules": {
4703
4769
  "ves.io.schema.rules.message.required": "true"
4704
4770
  },
4771
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4772
+ "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
4705
4773
  "minLength": 0,
4706
4774
  "maxLength": 16,
4707
4775
  "x-f5xc-required-for": {
@@ -4712,7 +4780,7 @@
4712
4780
  },
4713
4781
  "x-original-maxLength": 1024,
4714
4782
  "x-reconciled-from-discovery": true,
4715
- "x-reconciled-at": "2026-01-05T18:30:11.065796+00:00"
4783
+ "x-reconciled-at": "2026-01-07T15:29:42.657961+00:00"
4716
4784
  },
4717
4785
  "namespace": {
4718
4786
  "type": "string",
@@ -4721,6 +4789,8 @@
4721
4789
  "x-displayname": "Namespace",
4722
4790
  "x-ves-example": "Staging",
4723
4791
  "x-f5xc-example": "staging",
4792
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4793
+ "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
4724
4794
  "minLength": 0,
4725
4795
  "maxLength": 6,
4726
4796
  "x-f5xc-required-for": {
@@ -4731,9 +4801,10 @@
4731
4801
  },
4732
4802
  "x-original-maxLength": 1024,
4733
4803
  "x-reconciled-from-discovery": true,
4734
- "x-reconciled-at": "2026-01-05T18:30:11.065800+00:00"
4804
+ "x-reconciled-at": "2026-01-07T15:29:42.657965+00:00"
4735
4805
  }
4736
4806
  },
4807
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
4737
4808
  "x-f5xc-minimum-configuration": {
4738
4809
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
4739
4810
  "required_fields": [
@@ -4764,6 +4835,8 @@
4764
4835
  "title": "Creation_timestamp.",
4765
4836
  "format": "date-time",
4766
4837
  "x-displayname": "Creation Timestamp.",
4838
+ "x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
4839
+ "x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
4767
4840
  "minLength": 0,
4768
4841
  "maxLength": 1024,
4769
4842
  "x-f5xc-required-for": {
@@ -4781,6 +4854,8 @@
4781
4854
  "x-displayname": "Creator Class.",
4782
4855
  "x-ves-example": "ver.re1.int.ves.I/O.",
4783
4856
  "x-f5xc-example": "ver.re1.int.F5 XC",
4857
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
4858
+ "x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.",
4784
4859
  "minLength": 0,
4785
4860
  "maxLength": 1024,
4786
4861
  "x-f5xc-required-for": {
@@ -4798,6 +4873,8 @@
4798
4873
  "x-displayname": "Creator ID.",
4799
4874
  "x-ves-example": "Ver-instance-1.",
4800
4875
  "x-f5xc-example": "ver-instance-1",
4876
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
4877
+ "x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.",
4801
4878
  "minLength": 0,
4802
4879
  "maxLength": 1024,
4803
4880
  "x-f5xc-required-for": {
@@ -4816,6 +4893,8 @@
4816
4893
  "description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)",
4817
4894
  "title": "Status_id",
4818
4895
  "x-displayname": "Status ID",
4896
+ "x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...",
4897
+ "x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).",
4819
4898
  "minLength": 0,
4820
4899
  "maxLength": 1024,
4821
4900
  "x-f5xc-required-for": {
@@ -4833,6 +4912,7 @@
4833
4912
  "x-displayname": "UID",
4834
4913
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
4835
4914
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
4915
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
4836
4916
  "minLength": 0,
4837
4917
  "maxLength": 36,
4838
4918
  "x-f5xc-required-for": {
@@ -4845,13 +4925,14 @@
4845
4925
  "x-original-maxLength": 1024,
4846
4926
  "format": "uuid",
4847
4927
  "x-reconciled-from-discovery": true,
4848
- "x-reconciled-at": "2026-01-05T18:30:11.065812+00:00"
4928
+ "x-reconciled-at": "2026-01-07T15:29:42.657978+00:00"
4849
4929
  },
4850
4930
  "vtrp_id": {
4851
4931
  "type": "string",
4852
4932
  "description": "Origin of this status exchanged by VTRP.",
4853
4933
  "title": "Vtrp_id",
4854
4934
  "x-displayname": "VTRP ID",
4935
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
4855
4936
  "minLength": 0,
4856
4937
  "maxLength": 1024,
4857
4938
  "x-f5xc-required-for": {
@@ -4868,6 +4949,7 @@
4868
4949
  "title": "Vtrp_stale.",
4869
4950
  "format": "boolean",
4870
4951
  "x-displayname": "VTRP Stale.",
4952
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
4871
4953
  "x-f5xc-required-for": {
4872
4954
  "minimum_config": false,
4873
4955
  "create": false,
@@ -4876,6 +4958,7 @@
4876
4958
  }
4877
4959
  }
4878
4960
  },
4961
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
4879
4962
  "x-f5xc-minimum-configuration": {
4880
4963
  "description": "Minimum configuration for schemaStatusMetaType",
4881
4964
  "required_fields": [
@@ -4906,6 +4989,8 @@
4906
4989
  "default": "STATUS_DO_NOT_PUBLISH",
4907
4990
  "x-displayname": "Status Publish Type.",
4908
4991
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
4992
+ "x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.",
4993
+ "x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.",
4909
4994
  "x-f5xc-minimum-configuration": {
4910
4995
  "description": "Minimum configuration for schemaStatusPublishType",
4911
4996
  "required_fields": [],
@@ -4931,6 +5016,7 @@
4931
5016
  "x-displayname": "Code",
4932
5017
  "x-ves-example": "0",
4933
5018
  "x-f5xc-example": "0",
5019
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
4934
5020
  "minimum": 0,
4935
5021
  "maximum": 2147483647,
4936
5022
  "x-f5xc-required-for": {
@@ -4947,6 +5033,8 @@
4947
5033
  "x-displayname": "Reason",
4948
5034
  "x-ves-example": "Value",
4949
5035
  "x-f5xc-example": "value",
5036
+ "x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
5037
+ "x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
4950
5038
  "minLength": 0,
4951
5039
  "maxLength": 43,
4952
5040
  "x-f5xc-required-for": {
@@ -4957,7 +5045,7 @@
4957
5045
  },
4958
5046
  "x-original-maxLength": 1024,
4959
5047
  "x-reconciled-from-discovery": true,
4960
- "x-reconciled-at": "2026-01-05T18:30:11.065822+00:00"
5048
+ "x-reconciled-at": "2026-01-07T15:29:42.657987+00:00"
4961
5049
  },
4962
5050
  "status": {
4963
5051
  "type": "string",
@@ -4966,6 +5054,7 @@
4966
5054
  "x-displayname": "Status",
4967
5055
  "x-ves-example": "Value",
4968
5056
  "x-f5xc-example": "value",
5057
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
4969
5058
  "minLength": 0,
4970
5059
  "maxLength": 17,
4971
5060
  "x-f5xc-required-for": {
@@ -4976,9 +5065,10 @@
4976
5065
  },
4977
5066
  "x-original-maxLength": 1024,
4978
5067
  "x-reconciled-from-discovery": true,
4979
- "x-reconciled-at": "2026-01-05T18:30:11.065826+00:00"
5068
+ "x-reconciled-at": "2026-01-07T15:29:42.657991+00:00"
4980
5069
  }
4981
5070
  },
5071
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
4982
5072
  "x-f5xc-minimum-configuration": {
4983
5073
  "description": "Minimum configuration for schemaStatusType",
4984
5074
  "required_fields": [
@@ -5006,6 +5096,8 @@
5006
5096
  "title": "Creation_timestamp.",
5007
5097
  "format": "date-time",
5008
5098
  "x-displayname": "Creation Timestamp.",
5099
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
5100
+ "x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.",
5009
5101
  "minLength": 0,
5010
5102
  "maxLength": 1024,
5011
5103
  "x-f5xc-required-for": {
@@ -5023,6 +5115,7 @@
5023
5115
  "x-displayname": "Creator Class.",
5024
5116
  "x-ves-example": "Prism",
5025
5117
  "x-f5xc-example": "value",
5118
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
5026
5119
  "minLength": 0,
5027
5120
  "maxLength": 1024,
5028
5121
  "x-f5xc-required-for": {
@@ -5040,6 +5133,7 @@
5040
5133
  "x-displayname": "Creator ID.",
5041
5134
  "x-ves-example": "Admin@example-corp.com.",
5042
5135
  "x-f5xc-example": "value",
5136
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
5043
5137
  "minLength": 0,
5044
5138
  "maxLength": 1024,
5045
5139
  "x-f5xc-required-for": {
@@ -5056,6 +5150,8 @@
5056
5150
  "title": "Deletion_timestamp.",
5057
5151
  "format": "date-time",
5058
5152
  "x-displayname": "Deletion Timestamp.",
5153
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
5154
+ "x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...",
5059
5155
  "minLength": 0,
5060
5156
  "maxLength": 1024,
5061
5157
  "x-f5xc-required-for": {
@@ -5075,6 +5171,8 @@
5075
5171
  "x-displayname": "Finalizers.",
5076
5172
  "x-ves-example": "Value",
5077
5173
  "x-f5xc-example": "value",
5174
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
5175
+ "x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.",
5078
5176
  "x-f5xc-required-for": {
5079
5177
  "minimum_config": false,
5080
5178
  "create": false,
@@ -5092,6 +5190,8 @@
5092
5190
  "x-displayname": "Labels",
5093
5191
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
5094
5192
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
5193
+ "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.",
5194
+ "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).",
5095
5195
  "x-f5xc-required-for": {
5096
5196
  "minimum_config": false,
5097
5197
  "create": false,
@@ -5105,6 +5205,8 @@
5105
5205
  "title": "Modification_timestamp.",
5106
5206
  "format": "date-time",
5107
5207
  "x-displayname": "Modification Timestamp.",
5208
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5209
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5108
5210
  "minLength": 0,
5109
5211
  "maxLength": 1024,
5110
5212
  "x-f5xc-required-for": {
@@ -5123,6 +5225,8 @@
5123
5225
  "x-displayname": "Object Index.",
5124
5226
  "x-ves-example": "0",
5125
5227
  "x-f5xc-example": "0",
5228
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
5229
+ "x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.",
5126
5230
  "minimum": 0,
5127
5231
  "maximum": 2147483647,
5128
5232
  "x-f5xc-required-for": {
@@ -5143,6 +5247,8 @@
5143
5247
  "x-displayname": "Tenant",
5144
5248
  "x-ves-example": "Example-corp.",
5145
5249
  "x-f5xc-example": "example-corp",
5250
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5251
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5146
5252
  "minLength": 0,
5147
5253
  "maxLength": 18,
5148
5254
  "x-f5xc-required-for": {
@@ -5154,7 +5260,7 @@
5154
5260
  "x-field-mutability": "read-only",
5155
5261
  "x-original-maxLength": 1024,
5156
5262
  "x-reconciled-from-discovery": true,
5157
- "x-reconciled-at": "2026-01-05T18:30:11.065845+00:00"
5263
+ "x-reconciled-at": "2026-01-07T15:29:42.658011+00:00"
5158
5264
  },
5159
5265
  "uid": {
5160
5266
  "type": "string",
@@ -5163,6 +5269,8 @@
5163
5269
  "x-displayname": "UID",
5164
5270
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5165
5271
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5272
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
5273
+ "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.",
5166
5274
  "minLength": 0,
5167
5275
  "maxLength": 36,
5168
5276
  "x-f5xc-required-for": {
@@ -5175,9 +5283,11 @@
5175
5283
  "x-original-maxLength": 1024,
5176
5284
  "format": "uuid",
5177
5285
  "x-reconciled-from-discovery": true,
5178
- "x-reconciled-at": "2026-01-05T18:30:11.065850+00:00"
5286
+ "x-reconciled-at": "2026-01-07T15:29:42.658017+00:00"
5179
5287
  }
5180
5288
  },
5289
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5290
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5181
5291
  "x-f5xc-minimum-configuration": {
5182
5292
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
5183
5293
  "required_fields": [
@@ -5213,6 +5323,7 @@
5213
5323
  "default": "TREND_SENTIMENT_NONE",
5214
5324
  "x-displayname": "Trend Sentiment.",
5215
5325
  "x-ves-proto-enum": "ves.io.schema.TrendSentiment",
5326
+ "x-f5xc-description-short": "Trend sentiment Indicates trend sentiment is positive Indicates trend sentiment is negative.",
5216
5327
  "x-f5xc-minimum-configuration": {
5217
5328
  "description": "Minimum configuration for schemaTrendSentiment",
5218
5329
  "required_fields": [],
@@ -5237,6 +5348,7 @@
5237
5348
  "x-displayname": "Description.",
5238
5349
  "x-ves-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval.",
5239
5350
  "x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval",
5351
+ "x-f5xc-description-short": "Description of the method used to calculate trend.",
5240
5352
  "minLength": 0,
5241
5353
  "maxLength": 0,
5242
5354
  "x-f5xc-required-for": {
@@ -5247,15 +5359,16 @@
5247
5359
  },
5248
5360
  "x-original-maxLength": 1024,
5249
5361
  "x-reconciled-from-discovery": true,
5250
- "x-reconciled-at": "2026-01-05T18:30:11.065855+00:00"
5362
+ "x-reconciled-at": "2026-01-07T15:29:42.658022+00:00"
5251
5363
  },
5252
5364
  "previous_value": {
5253
5365
  "type": "string",
5254
- "description": "",
5366
+ "description": "Configuration parameter for previous value",
5255
5367
  "title": "Previous Value.",
5256
5368
  "x-displayname": "Previous Value.",
5257
5369
  "x-ves-example": "200.00",
5258
5370
  "x-f5xc-example": "200.00",
5371
+ "x-f5xc-description-short": "Configuration parameter for previous value.",
5259
5372
  "minLength": 0,
5260
5373
  "maxLength": 1024,
5261
5374
  "x-f5xc-required-for": {
@@ -5270,7 +5383,7 @@
5270
5383
  },
5271
5384
  "value": {
5272
5385
  "type": "string",
5273
- "description": "",
5386
+ "description": "Configuration parameter for value",
5274
5387
  "title": "Value",
5275
5388
  "x-displayname": "Value",
5276
5389
  "x-ves-example": "-15",
@@ -5285,9 +5398,11 @@
5285
5398
  },
5286
5399
  "x-original-maxLength": 1024,
5287
5400
  "x-reconciled-from-discovery": true,
5288
- "x-reconciled-at": "2026-01-05T18:30:11.065861+00:00"
5401
+ "x-reconciled-at": "2026-01-07T15:29:42.658029+00:00"
5289
5402
  }
5290
5403
  },
5404
+ "x-f5xc-description-short": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
5405
+ "x-f5xc-description-medium": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
5291
5406
  "x-f5xc-minimum-configuration": {
5292
5407
  "description": "Minimum configuration for schemaTrendValue",
5293
5408
  "required_fields": [
@@ -5339,6 +5454,7 @@
5339
5454
  "default": "UNIT_MILLISECONDS",
5340
5455
  "x-displayname": "Unit",
5341
5456
  "x-ves-proto-enum": "ves.io.schema.UnitType",
5457
+ "x-f5xc-description-short": "UnitType is enumeration of units for scalar fields.",
5342
5458
  "x-f5xc-minimum-configuration": {
5343
5459
  "description": "Minimum configuration for schemaUnitType",
5344
5460
  "required_fields": [],
@@ -5373,7 +5489,7 @@
5373
5489
  },
5374
5490
  "x-original-maxLength": 1024,
5375
5491
  "x-reconciled-from-discovery": true,
5376
- "x-reconciled-at": "2026-01-05T18:30:11.065866+00:00"
5492
+ "x-reconciled-at": "2026-01-07T15:29:42.658035+00:00"
5377
5493
  },
5378
5494
  "name": {
5379
5495
  "type": "string",
@@ -5382,6 +5498,8 @@
5382
5498
  "x-displayname": "Name",
5383
5499
  "x-ves-example": "Contactus-route.",
5384
5500
  "x-f5xc-example": "contactus-route",
5501
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
5502
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
5385
5503
  "minLength": 0,
5386
5504
  "maxLength": 16,
5387
5505
  "x-f5xc-required-for": {
@@ -5392,7 +5510,7 @@
5392
5510
  },
5393
5511
  "x-original-maxLength": 1024,
5394
5512
  "x-reconciled-from-discovery": true,
5395
- "x-reconciled-at": "2026-01-05T18:30:11.065870+00:00"
5513
+ "x-reconciled-at": "2026-01-07T15:29:42.658039+00:00"
5396
5514
  },
5397
5515
  "namespace": {
5398
5516
  "type": "string",
@@ -5401,6 +5519,8 @@
5401
5519
  "x-displayname": "Namespace",
5402
5520
  "x-ves-example": "Ns1",
5403
5521
  "x-f5xc-example": "ns1",
5522
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
5523
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
5404
5524
  "minLength": 0,
5405
5525
  "maxLength": 6,
5406
5526
  "x-f5xc-required-for": {
@@ -5411,7 +5531,7 @@
5411
5531
  },
5412
5532
  "x-original-maxLength": 1024,
5413
5533
  "x-reconciled-from-discovery": true,
5414
- "x-reconciled-at": "2026-01-05T18:30:11.065874+00:00"
5534
+ "x-reconciled-at": "2026-01-07T15:29:42.658043+00:00"
5415
5535
  },
5416
5536
  "uid": {
5417
5537
  "type": "string",
@@ -5432,9 +5552,10 @@
5432
5552
  "x-original-maxLength": 1024,
5433
5553
  "format": "uuid",
5434
5554
  "x-reconciled-from-discovery": true,
5435
- "x-reconciled-at": "2026-01-05T18:30:11.065879+00:00"
5555
+ "x-reconciled-at": "2026-01-07T15:29:42.658048+00:00"
5436
5556
  }
5437
5557
  },
5558
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
5438
5559
  "x-f5xc-minimum-configuration": {
5439
5560
  "description": "Minimum configuration for schemaViewRefType",
5440
5561
  "required_fields": [
@@ -5477,6 +5598,8 @@
5477
5598
  "ves.io.schema.rules.string.max_bytes": "128",
5478
5599
  "ves.io.schema.rules.string.min_bytes": "1"
5479
5600
  },
5601
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
5602
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name. Required: YES.",
5480
5603
  "x-f5xc-required-for": {
5481
5604
  "minimum_config": false,
5482
5605
  "create": false,
@@ -5485,7 +5608,7 @@
5485
5608
  },
5486
5609
  "x-original-maxLength": 128,
5487
5610
  "x-reconciled-from-discovery": true,
5488
- "x-reconciled-at": "2026-01-05T18:30:11.065884+00:00"
5611
+ "x-reconciled-at": "2026-01-07T15:29:42.658053+00:00"
5489
5612
  },
5490
5613
  "namespace": {
5491
5614
  "type": "string",
@@ -5501,6 +5624,8 @@
5501
5624
  "x-validation-rules": {
5502
5625
  "ves.io.schema.rules.string.max_bytes": "64"
5503
5626
  },
5627
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
5628
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
5504
5629
  "minLength": 0,
5505
5630
  "x-f5xc-required-for": {
5506
5631
  "minimum_config": false,
@@ -5510,7 +5635,7 @@
5510
5635
  },
5511
5636
  "x-original-maxLength": 64,
5512
5637
  "x-reconciled-from-discovery": true,
5513
- "x-reconciled-at": "2026-01-05T18:30:11.065889+00:00"
5638
+ "x-reconciled-at": "2026-01-07T15:29:42.658058+00:00"
5514
5639
  },
5515
5640
  "tenant": {
5516
5641
  "type": "string",
@@ -5526,6 +5651,8 @@
5526
5651
  "x-validation-rules": {
5527
5652
  "ves.io.schema.rules.string.max_bytes": "64"
5528
5653
  },
5654
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
5655
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
5529
5656
  "minLength": 0,
5530
5657
  "x-f5xc-required-for": {
5531
5658
  "minimum_config": false,
@@ -5537,9 +5664,11 @@
5537
5664
  "x-field-mutability": "read-only",
5538
5665
  "x-original-maxLength": 64,
5539
5666
  "x-reconciled-from-discovery": true,
5540
- "x-reconciled-at": "2026-01-05T18:30:11.065893+00:00"
5667
+ "x-reconciled-at": "2026-01-07T15:29:42.658062+00:00"
5541
5668
  }
5542
5669
  },
5670
+ "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
5671
+ "x-f5xc-description-medium": "Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.",
5543
5672
  "x-f5xc-minimum-configuration": {
5544
5673
  "description": "Minimum configuration for schemaviewsObjectRefType",
5545
5674
  "required_fields": [
@@ -5640,6 +5769,8 @@
5640
5769
  "x-validation-rules": {
5641
5770
  "ves.io.schema.rules.repeated.max_items": "32"
5642
5771
  },
5772
+ "x-f5xc-description-short": "Reference to virtual-sites Default virtual-site of the Virtual K8s object.",
5773
+ "x-f5xc-description-medium": "Reference to virtual-sites Default virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object annotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the Kubernetes API resource object.",
5643
5774
  "x-f5xc-required-for": {
5644
5775
  "minimum_config": false,
5645
5776
  "create": false,
@@ -5648,6 +5779,7 @@
5648
5779
  }
5649
5780
  }
5650
5781
  },
5782
+ "x-f5xc-description-short": "Create virtual_k8s will create the object in the storage backend for namespace metadata.namespace.",
5651
5783
  "x-f5xc-minimum-configuration": {
5652
5784
  "description": "Minimum configuration for virtual_k8sCreateSpecType",
5653
5785
  "required_fields": [
@@ -5676,6 +5808,7 @@
5676
5808
  "title": "Fail_if_referred.",
5677
5809
  "format": "boolean",
5678
5810
  "x-displayname": "Fail-If-Referred.",
5811
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
5679
5812
  "x-f5xc-required-for": {
5680
5813
  "minimum_config": false,
5681
5814
  "create": false,
@@ -5700,7 +5833,7 @@
5700
5833
  },
5701
5834
  "x-original-maxLength": 1024,
5702
5835
  "x-reconciled-from-discovery": true,
5703
- "x-reconciled-at": "2026-01-05T18:30:11.065910+00:00"
5836
+ "x-reconciled-at": "2026-01-07T15:29:42.658080+00:00"
5704
5837
  },
5705
5838
  "namespace": {
5706
5839
  "type": "string",
@@ -5709,6 +5842,7 @@
5709
5842
  "x-displayname": "Namespace",
5710
5843
  "x-ves-example": "Ns1",
5711
5844
  "x-f5xc-example": "ns1",
5845
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
5712
5846
  "minLength": 0,
5713
5847
  "maxLength": 6,
5714
5848
  "x-f5xc-required-for": {
@@ -5719,7 +5853,7 @@
5719
5853
  },
5720
5854
  "x-original-maxLength": 1024,
5721
5855
  "x-reconciled-from-discovery": true,
5722
- "x-reconciled-at": "2026-01-05T18:30:11.065914+00:00"
5856
+ "x-reconciled-at": "2026-01-07T15:29:42.658084+00:00"
5723
5857
  }
5724
5858
  },
5725
5859
  "x-f5xc-minimum-configuration": {
@@ -5754,6 +5888,7 @@
5754
5888
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5755
5889
  },
5756
5890
  "x-displayname": "Deleted Referred Objects.",
5891
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5757
5892
  "x-f5xc-required-for": {
5758
5893
  "minimum_config": false,
5759
5894
  "create": false,
@@ -5769,6 +5904,7 @@
5769
5904
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5770
5905
  },
5771
5906
  "x-displayname": "Disabled Referred Objects.",
5907
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5772
5908
  "x-f5xc-required-for": {
5773
5909
  "minimum_config": false,
5774
5910
  "create": false,
@@ -5787,6 +5923,7 @@
5787
5923
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5788
5924
  },
5789
5925
  "x-displayname": "Referring Objects.",
5926
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
5790
5927
  "x-f5xc-required-for": {
5791
5928
  "minimum_config": false,
5792
5929
  "create": false,
@@ -5808,6 +5945,8 @@
5808
5945
  "$ref": "#/components/schemas/virtual_k8sStatusObject"
5809
5946
  },
5810
5947
  "x-displayname": "Status",
5948
+ "x-f5xc-example": "active",
5949
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5811
5950
  "x-f5xc-required-for": {
5812
5951
  "minimum_config": false,
5813
5952
  "create": false,
@@ -5817,7 +5956,7 @@
5817
5956
  "maxLength": 17,
5818
5957
  "minLength": 17,
5819
5958
  "x-reconciled-from-discovery": true,
5820
- "x-reconciled-at": "2026-01-05T18:30:11.065929+00:00"
5959
+ "x-reconciled-at": "2026-01-07T15:29:42.658098+00:00"
5821
5960
  },
5822
5961
  "system_metadata": {
5823
5962
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -5857,6 +5996,8 @@
5857
5996
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
5858
5997
  ],
5859
5998
  "default": "GET_RSP_FORMAT_DEFAULT",
5999
+ "x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
6000
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
5860
6001
  "x-f5xc-minimum-configuration": {
5861
6002
  "description": "Minimum configuration for virtual_k8sGetResponseFormatCode",
5862
6003
  "required_fields": [],
@@ -5898,6 +6039,8 @@
5898
6039
  "x-validation-rules": {
5899
6040
  "ves.io.schema.rules.repeated.max_items": "32"
5900
6041
  },
6042
+ "x-f5xc-description-short": "Reference to virtual-sites Default virtual-site of the Virtual K8s object.",
6043
+ "x-f5xc-description-medium": "Reference to virtual-sites Default virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object annotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the Kubernetes API resource object.",
5901
6044
  "x-f5xc-required-for": {
5902
6045
  "minimum_config": false,
5903
6046
  "create": false,
@@ -5906,6 +6049,7 @@
5906
6049
  }
5907
6050
  }
5908
6051
  },
6052
+ "x-f5xc-description-short": "GET virtual_k8s will GET the object from the storage backend for namesapce metadata.namespace.",
5909
6053
  "x-f5xc-minimum-configuration": {
5910
6054
  "description": "Minimum configuration for virtual_k8sGetSpecType",
5911
6055
  "required_fields": [
@@ -5936,6 +6080,7 @@
5936
6080
  "$ref": "#/components/schemas/schemaErrorType"
5937
6081
  },
5938
6082
  "x-displayname": "Errors",
6083
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
5939
6084
  "x-f5xc-required-for": {
5940
6085
  "minimum_config": false,
5941
6086
  "create": false,
@@ -5951,6 +6096,8 @@
5951
6096
  "$ref": "#/components/schemas/virtual_k8sListResponseItem"
5952
6097
  },
5953
6098
  "x-displayname": "Items",
6099
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
6100
+ "x-f5xc-description-short": "Items represents the collection in response.",
5954
6101
  "x-f5xc-required-for": {
5955
6102
  "minimum_config": false,
5956
6103
  "create": false,
@@ -5984,6 +6131,8 @@
5984
6131
  "description": "The set of annotations present on this virtual_k8s.",
5985
6132
  "title": "Annotations.",
5986
6133
  "x-displayname": "Annotations.",
6134
+ "x-f5xc-example": "{\"key\": \"value\"}",
6135
+ "x-f5xc-description-short": "The set of annotations present on this virtual_k8s.",
5987
6136
  "x-f5xc-required-for": {
5988
6137
  "minimum_config": false,
5989
6138
  "create": false,
@@ -5996,6 +6145,7 @@
5996
6145
  "description": "The description set for this virtual_k8s.",
5997
6146
  "title": "Description.",
5998
6147
  "x-displayname": "Description.",
6148
+ "x-f5xc-description-short": "The description set for this virtual_k8s.",
5999
6149
  "minLength": 0,
6000
6150
  "maxLength": 0,
6001
6151
  "x-f5xc-required-for": {
@@ -6006,7 +6156,7 @@
6006
6156
  },
6007
6157
  "x-original-maxLength": 1024,
6008
6158
  "x-reconciled-from-discovery": true,
6009
- "x-reconciled-at": "2026-01-05T18:30:11.065945+00:00"
6159
+ "x-reconciled-at": "2026-01-07T15:29:42.658115+00:00"
6010
6160
  },
6011
6161
  "disabled": {
6012
6162
  "type": "boolean",
@@ -6014,6 +6164,8 @@
6014
6164
  "title": "Disabled",
6015
6165
  "format": "boolean",
6016
6166
  "x-displayname": "Disabled",
6167
+ "x-f5xc-example": "True",
6168
+ "x-f5xc-description-short": "Value of true indicates virtual_k8s is administratively disabled.",
6017
6169
  "x-f5xc-required-for": {
6018
6170
  "minimum_config": false,
6019
6171
  "create": false,
@@ -6029,6 +6181,8 @@
6029
6181
  "description": "The set of labels present on this virtual_k8s.",
6030
6182
  "title": "Labels",
6031
6183
  "x-displayname": "Labels",
6184
+ "x-f5xc-example": "{\"key\": \"value\"}",
6185
+ "x-f5xc-description-short": "The set of labels present on this virtual_k8s.",
6032
6186
  "x-f5xc-required-for": {
6033
6187
  "minimum_config": false,
6034
6188
  "create": false,
@@ -6056,7 +6210,7 @@
6056
6210
  },
6057
6211
  "x-original-maxLength": 1024,
6058
6212
  "x-reconciled-from-discovery": true,
6059
- "x-reconciled-at": "2026-01-05T18:30:11.065956+00:00"
6213
+ "x-reconciled-at": "2026-01-07T15:29:42.658125+00:00"
6060
6214
  },
6061
6215
  "namespace": {
6062
6216
  "type": "string",
@@ -6075,7 +6229,7 @@
6075
6229
  },
6076
6230
  "x-original-maxLength": 1024,
6077
6231
  "x-reconciled-from-discovery": true,
6078
- "x-reconciled-at": "2026-01-05T18:30:11.065960+00:00"
6232
+ "x-reconciled-at": "2026-01-07T15:29:42.658129+00:00"
6079
6233
  },
6080
6234
  "owner_view": {
6081
6235
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -6088,6 +6242,7 @@
6088
6242
  "$ref": "#/components/schemas/virtual_k8sStatusObject"
6089
6243
  },
6090
6244
  "x-displayname": "Status",
6245
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6091
6246
  "x-f5xc-required-for": {
6092
6247
  "minimum_config": false,
6093
6248
  "create": false,
@@ -6116,7 +6271,7 @@
6116
6271
  "x-field-mutability": "read-only",
6117
6272
  "x-original-maxLength": 1024,
6118
6273
  "x-reconciled-from-discovery": true,
6119
- "x-reconciled-at": "2026-01-05T18:30:11.065968+00:00"
6274
+ "x-reconciled-at": "2026-01-07T15:29:42.658137+00:00"
6120
6275
  },
6121
6276
  "uid": {
6122
6277
  "type": "string",
@@ -6137,9 +6292,11 @@
6137
6292
  "x-original-maxLength": 1024,
6138
6293
  "format": "uuid",
6139
6294
  "x-reconciled-from-discovery": true,
6140
- "x-reconciled-at": "2026-01-05T18:30:11.065973+00:00"
6295
+ "x-reconciled-at": "2026-01-07T15:29:42.658142+00:00"
6141
6296
  }
6142
6297
  },
6298
+ "x-f5xc-description-short": "By default a summary of virtual_k8s is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6299
+ "x-f5xc-description-medium": "By default a summary of virtual_k8s is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6143
6300
  "x-f5xc-minimum-configuration": {
6144
6301
  "description": "Minimum configuration for virtual_k8sListResponseItem",
6145
6302
  "required_fields": [
@@ -6179,6 +6336,7 @@
6179
6336
  "$ref": "#/components/schemas/virtual_k8sPVCMetricTypeData"
6180
6337
  },
6181
6338
  "x-displayname": "Data",
6339
+ "x-f5xc-example": "{\"key\": \"value\"}",
6182
6340
  "x-f5xc-required-for": {
6183
6341
  "minimum_config": false,
6184
6342
  "create": false,
@@ -6193,6 +6351,7 @@
6193
6351
  "$ref": "#/components/schemas/schemaUnitType"
6194
6352
  }
6195
6353
  },
6354
+ "x-f5xc-description-short": "PVC Metric data contains the metric type and the corresponding metric value.",
6196
6355
  "x-f5xc-minimum-configuration": {
6197
6356
  "description": "Minimum configuration for virtual_k8sPVCMetricData",
6198
6357
  "required_fields": [
@@ -6240,6 +6399,7 @@
6240
6399
  "default": "PVC_USAGE",
6241
6400
  "x-displayname": "PVC Metric Type.",
6242
6401
  "x-ves-proto-enum": "ves.io.schema.virtual_k8s.PVCMetricType",
6402
+ "x-f5xc-description-short": "List of PVC metric types x-unit: \"bytes\" x-unit: \"bytes\".",
6243
6403
  "x-f5xc-minimum-configuration": {
6244
6404
  "description": "Minimum configuration for virtual_k8sPVCMetricType",
6245
6405
  "required_fields": [],
@@ -6262,6 +6422,8 @@
6262
6422
  "description": "Key contains the name/value pair.\n\"name\" is the label name defined in \"PVCMetricLabel\"",
6263
6423
  "title": "Key",
6264
6424
  "x-displayname": "Key",
6425
+ "x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
6426
+ "x-f5xc-description-short": "Key contains the name/value pair. \"name\" is the label name defined in \"PVCMetricLabel\".",
6265
6427
  "x-f5xc-required-for": {
6266
6428
  "minimum_config": false,
6267
6429
  "create": false,
@@ -6271,7 +6433,7 @@
6271
6433
  "maxLength": 16,
6272
6434
  "minLength": 7,
6273
6435
  "x-reconciled-from-discovery": true,
6274
- "x-reconciled-at": "2026-01-05T18:30:11.065984+00:00"
6436
+ "x-reconciled-at": "2026-01-07T15:29:42.658152+00:00"
6275
6437
  },
6276
6438
  "value": {
6277
6439
  "type": "array",
@@ -6290,9 +6452,11 @@
6290
6452
  "maxLength": 15,
6291
6453
  "minLength": 3,
6292
6454
  "x-reconciled-from-discovery": true,
6293
- "x-reconciled-at": "2026-01-05T18:30:11.065989+00:00"
6455
+ "x-reconciled-at": "2026-01-07T15:29:42.658158+00:00"
6294
6456
  }
6295
6457
  },
6458
+ "x-f5xc-description-short": "PVC Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
6459
+ "x-f5xc-description-medium": "PVC Metric Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
6296
6460
  "x-f5xc-minimum-configuration": {
6297
6461
  "description": "Minimum configuration for virtual_k8sPVCMetricTypeData",
6298
6462
  "required_fields": [
@@ -6326,6 +6490,8 @@
6326
6490
  "x-validation-rules": {
6327
6491
  "ves.io.schema.rules.string.query_time": "true"
6328
6492
  },
6493
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
6494
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
6329
6495
  "minLength": 0,
6330
6496
  "maxLength": 1024,
6331
6497
  "x-f5xc-required-for": {
@@ -6358,6 +6524,8 @@
6358
6524
  "ves.io.schema.rules.repeated.min_items": "1",
6359
6525
  "ves.io.schema.rules.repeated.unique": "true"
6360
6526
  },
6527
+ "x-f5xc-description-short": "Select fields to be returned in the response. One or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified.",
6528
+ "x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {PVC_USAGE, PVC_CAPACITY} can be specified. Required: YES.",
6361
6529
  "x-f5xc-required-for": {
6362
6530
  "minimum_config": false,
6363
6531
  "create": false,
@@ -6372,6 +6540,8 @@
6372
6540
  "x-displayname": "Filter",
6373
6541
  "x-ves-example": "{PVC=\\\"pvc-1\\\"}",
6374
6542
  "x-f5xc-example": "\"{PVC=\\\"pvc-1\\\"}\"",
6543
+ "x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
6544
+ "x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in MetricLabel {PVC, SITE} can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = : equal to != ...",
6375
6545
  "minLength": 0,
6376
6546
  "maxLength": 1024,
6377
6547
  "x-f5xc-required-for": {
@@ -6389,6 +6559,7 @@
6389
6559
  "$ref": "#/components/schemas/virtual_k8sPVCMetricLabel"
6390
6560
  },
6391
6561
  "x-displayname": "Group By",
6562
+ "x-f5xc-description-short": "Aggregate data by zero or more labels {NAMESPACE, PVC, SITE}.",
6392
6563
  "x-f5xc-required-for": {
6393
6564
  "minimum_config": false,
6394
6565
  "create": false,
@@ -6398,7 +6569,7 @@
6398
6569
  },
6399
6570
  "namespace": {
6400
6571
  "type": "string",
6401
- "description": "",
6572
+ "description": "Human-readable name for the resource",
6402
6573
  "title": "Namespace",
6403
6574
  "x-displayname": "Namespace",
6404
6575
  "x-ves-example": "Ns1",
@@ -6413,7 +6584,7 @@
6413
6584
  },
6414
6585
  "x-original-maxLength": 1024,
6415
6586
  "x-reconciled-from-discovery": true,
6416
- "x-reconciled-at": "2026-01-05T18:30:11.066000+00:00"
6587
+ "x-reconciled-at": "2026-01-07T15:29:42.658168+00:00"
6417
6588
  },
6418
6589
  "range": {
6419
6590
  "type": "string",
@@ -6428,6 +6599,8 @@
6428
6599
  "x-validation-rules": {
6429
6600
  "ves.io.schema.rules.string.time_interval": "true"
6430
6601
  },
6602
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
6603
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
6431
6604
  "minLength": 0,
6432
6605
  "maxLength": 1024,
6433
6606
  "x-f5xc-required-for": {
@@ -6450,6 +6623,8 @@
6450
6623
  "x-validation-rules": {
6451
6624
  "ves.io.schema.rules.string.query_time": "true"
6452
6625
  },
6626
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
6627
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
6453
6628
  "minLength": 0,
6454
6629
  "maxLength": 1024,
6455
6630
  "x-f5xc-required-for": {
@@ -6472,6 +6647,8 @@
6472
6647
  "x-validation-rules": {
6473
6648
  "ves.io.schema.rules.string.query_step": "true"
6474
6649
  },
6650
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
6651
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
6475
6652
  "minLength": 0,
6476
6653
  "maxLength": 1024,
6477
6654
  "x-f5xc-required-for": {
@@ -6516,6 +6693,8 @@
6516
6693
  "$ref": "#/components/schemas/virtual_k8sPVCMetricData"
6517
6694
  },
6518
6695
  "x-displayname": "Data",
6696
+ "x-f5xc-example": "{\"key\": \"value\"}",
6697
+ "x-f5xc-description-short": "Data contains time-series metric data for PVC.",
6519
6698
  "x-f5xc-required-for": {
6520
6699
  "minimum_config": false,
6521
6700
  "create": false,
@@ -6536,6 +6715,8 @@
6536
6715
  "x-validation-rules": {
6537
6716
  "ves.io.schema.rules.string.time_interval": "true"
6538
6717
  },
6718
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
6719
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
6539
6720
  "minLength": 0,
6540
6721
  "maxLength": 1024,
6541
6722
  "x-f5xc-required-for": {
@@ -6630,6 +6811,8 @@
6630
6811
  "x-validation-rules": {
6631
6812
  "ves.io.schema.rules.repeated.max_items": "32"
6632
6813
  },
6814
+ "x-f5xc-description-short": "Reference to virtual-sites Default virtual-site of the Virtual K8s object.",
6815
+ "x-f5xc-description-medium": "Reference to virtual-sites Default virtual-site of the Virtual K8s object. If no virtual-site is specified in the Kubernetes API resource object annotations via F5 XC/virtual-sites, then this virtual-site is used select sites on which to instantiate the Kubernetes API resource object.",
6633
6816
  "x-f5xc-required-for": {
6634
6817
  "minimum_config": false,
6635
6818
  "create": false,
@@ -6638,6 +6821,8 @@
6638
6821
  }
6639
6822
  }
6640
6823
  },
6824
+ "x-f5xc-description-short": "Replacing an endpoint object will update the object by replacing the existing spec with the provided one.",
6825
+ "x-f5xc-description-medium": "Replacing an endpoint object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
6641
6826
  "x-f5xc-minimum-configuration": {
6642
6827
  "description": "Minimum configuration for virtual_k8sReplaceSpecType",
6643
6828
  "required_fields": [
@@ -6694,6 +6879,7 @@
6694
6879
  }
6695
6880
  }
6696
6881
  },
6882
+ "x-f5xc-description-short": "Most recently observed status of the Virtual K8s object.",
6697
6883
  "x-f5xc-minimum-configuration": {
6698
6884
  "description": "Minimum configuration for virtual_k8sStatusObject",
6699
6885
  "required_fields": [
@@ -6723,6 +6909,8 @@
6723
6909
  "title": "Manage DNS Domain.",
6724
6910
  "format": "boolean",
6725
6911
  "x-displayname": "Automatically Manage DNS Records.",
6912
+ "x-f5xc-description-short": "DNS records for domains will be managed automatically by F5 Distributed Cloud.",
6913
+ "x-f5xc-description-medium": "DNS records for domains will be managed automatically by F5 Distributed Cloud. As a prerequisite, the domain must be delegated to F5 Distributed Cloud using Delegated domain feature or a DNS CNAME record should be created in your DNS provider's portal.",
6726
6914
  "x-f5xc-required-for": {
6727
6915
  "minimum_config": false,
6728
6916
  "create": false,
@@ -6744,6 +6932,7 @@
6744
6932
  "x-validation-rules": {
6745
6933
  "ves.io.schema.rules.uint32.lte": "65535"
6746
6934
  },
6935
+ "x-f5xc-description-short": "Exclusive with [port_ranges] HTTP port to Listen.",
6747
6936
  "minimum": 1,
6748
6937
  "maximum": 65535,
6749
6938
  "x-f5xc-required-for": {
@@ -6774,6 +6963,8 @@
6774
6963
  "ves.io.schema.rules.string.min_len": "1",
6775
6964
  "ves.io.schema.rules.string.unique_port_range_list": "true"
6776
6965
  },
6966
+ "x-f5xc-description-short": "Exclusive with [port] A string containing a comma separated list of port ranges.",
6967
+ "x-f5xc-description-medium": "Exclusive with [port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".",
6777
6968
  "x-f5xc-required-for": {
6778
6969
  "minimum_config": false,
6779
6970
  "create": false,
@@ -6832,6 +7023,7 @@
6832
7023
  "title": "Add HSTS",
6833
7024
  "format": "boolean",
6834
7025
  "x-displayname": "Add HSTS Header.",
7026
+ "x-f5xc-description-short": "Add HTTP Strict-Transport-Security response header.",
6835
7027
  "x-f5xc-required-for": {
6836
7028
  "minimum_config": false,
6837
7029
  "create": false,
@@ -6851,6 +7043,9 @@
6851
7043
  "x-validation-rules": {
6852
7044
  "ves.io.schema.rules.string.max_len": "8096"
6853
7045
  },
7046
+ "x-f5xc-example": "example-resource",
7047
+ "x-f5xc-description-short": "Exclusive with [default_header pass_through server_name] Define the header value for the header name “server”.",
7048
+ "x-f5xc-description-medium": "Exclusive with [default_header pass_through server_name] Define the header value for the header name “server”. If header value is already present, it is not overwritten and passed as-is.",
6854
7049
  "minLength": 0,
6855
7050
  "x-f5xc-required-for": {
6856
7051
  "minimum_config": false,
@@ -6876,6 +7071,8 @@
6876
7071
  "x-validation-rules": {
6877
7072
  "ves.io.schema.rules.uint32.lte": "600000"
6878
7073
  },
7074
+ "x-f5xc-description-short": "The idle timeout for downstream connections. The idle timeout is defined as the period in which there are no active requests.",
7075
+ "x-f5xc-description-medium": "The idle timeout for downstream connections. The idle timeout is defined as the period in which there are no active requests. When the idle timeout is reached the connection will be closed.",
6879
7076
  "minimum": 0,
6880
7077
  "maximum": 2147483647,
6881
7078
  "x-f5xc-required-for": {
@@ -6934,6 +7131,7 @@
6934
7131
  "x-validation-rules": {
6935
7132
  "ves.io.schema.rules.uint32.lte": "65535"
6936
7133
  },
7134
+ "x-f5xc-description-short": "Exclusive with [port_ranges] HTTPS port to Listen.",
6937
7135
  "minimum": 1,
6938
7136
  "maximum": 65535,
6939
7137
  "x-f5xc-required-for": {
@@ -6964,6 +7162,8 @@
6964
7162
  "ves.io.schema.rules.string.min_len": "1",
6965
7163
  "ves.io.schema.rules.string.unique_port_range_list": "true"
6966
7164
  },
7165
+ "x-f5xc-description-short": "Exclusive with [port] A string containing a comma separated list of port ranges.",
7166
+ "x-f5xc-description-medium": "Exclusive with [port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".",
6967
7167
  "x-f5xc-required-for": {
6968
7168
  "minimum_config": false,
6969
7169
  "create": false,
@@ -6983,6 +7183,9 @@
6983
7183
  "x-validation-rules": {
6984
7184
  "ves.io.schema.rules.string.max_len": "8096"
6985
7185
  },
7186
+ "x-f5xc-example": "example-resource",
7187
+ "x-f5xc-description-short": "Exclusive with [append_server_name default_header pass_through] Define the header value for the header name “server”.",
7188
+ "x-f5xc-description-medium": "Exclusive with [append_server_name default_header pass_through] Define the header value for the header name “server”. This will overwrite existing values, if any, for the server header.",
6986
7189
  "minLength": 0,
6987
7190
  "x-f5xc-required-for": {
6988
7191
  "minimum_config": false,
@@ -6998,6 +7201,7 @@
6998
7201
  "$ref": "#/components/schemas/schemaviewsDownstreamTlsParamsType"
6999
7202
  }
7000
7203
  },
7204
+ "x-f5xc-description-short": "Choice for selecting HTTP proxy with bring your own certificates.",
7001
7205
  "x-f5xc-minimum-configuration": {
7002
7206
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7003
7207
  "required_fields": [
@@ -7048,6 +7252,7 @@
7048
7252
  "title": "Add HSTS",
7049
7253
  "format": "boolean",
7050
7254
  "x-displayname": "Add HSTS Header.",
7255
+ "x-f5xc-description-short": "Add HTTP Strict-Transport-Security response header.",
7051
7256
  "x-f5xc-required-for": {
7052
7257
  "minimum_config": false,
7053
7258
  "create": false,
@@ -7067,6 +7272,9 @@
7067
7272
  "x-validation-rules": {
7068
7273
  "ves.io.schema.rules.string.max_len": "8096"
7069
7274
  },
7275
+ "x-f5xc-example": "example-resource",
7276
+ "x-f5xc-description-short": "Exclusive with [default_header pass_through server_name] Define the header value for the header name “server”.",
7277
+ "x-f5xc-description-medium": "Exclusive with [default_header pass_through server_name] Define the header value for the header name “server”. If header value is already present, it is not overwritten and passed as-is.",
7070
7278
  "minLength": 0,
7071
7279
  "x-f5xc-required-for": {
7072
7280
  "minimum_config": false,
@@ -7092,6 +7300,8 @@
7092
7300
  "x-validation-rules": {
7093
7301
  "ves.io.schema.rules.uint32.lte": "600000"
7094
7302
  },
7303
+ "x-f5xc-description-short": "The idle timeout for downstream connections. The idle timeout is defined as the period in which there are no active requests.",
7304
+ "x-f5xc-description-medium": "The idle timeout for downstream connections. The idle timeout is defined as the period in which there are no active requests. When the idle timeout is reached the connection will be closed.",
7095
7305
  "minimum": 0,
7096
7306
  "maximum": 2147483647,
7097
7307
  "x-f5xc-required-for": {
@@ -7152,6 +7362,7 @@
7152
7362
  "ves.io.schema.rules.uint32.lte": "65535"
7153
7363
  },
7154
7364
  "x-f5xc-example": "8080",
7365
+ "x-f5xc-description-short": "Exclusive with [port_ranges] HTTPS port to Listen.",
7155
7366
  "minimum": 1,
7156
7367
  "maximum": 65535,
7157
7368
  "x-f5xc-required-for": {
@@ -7182,6 +7393,8 @@
7182
7393
  "ves.io.schema.rules.string.min_len": "1",
7183
7394
  "ves.io.schema.rules.string.unique_port_range_list": "true"
7184
7395
  },
7396
+ "x-f5xc-description-short": "Exclusive with [port] A string containing a comma separated list of port ranges.",
7397
+ "x-f5xc-description-medium": "Exclusive with [port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".",
7185
7398
  "x-f5xc-required-for": {
7186
7399
  "minimum_config": false,
7187
7400
  "create": false,
@@ -7201,6 +7414,9 @@
7201
7414
  "x-validation-rules": {
7202
7415
  "ves.io.schema.rules.string.max_len": "8096"
7203
7416
  },
7417
+ "x-f5xc-example": "example-resource",
7418
+ "x-f5xc-description-short": "Exclusive with [append_server_name default_header pass_through] Define the header value for the header name “server”.",
7419
+ "x-f5xc-description-medium": "Exclusive with [append_server_name default_header pass_through] Define the header value for the header name “server”. This will overwrite existing values, if any, for the server header.",
7204
7420
  "minLength": 0,
7205
7421
  "x-f5xc-required-for": {
7206
7422
  "minimum_config": false,
@@ -7216,6 +7432,7 @@
7216
7432
  "$ref": "#/components/schemas/viewsDownstreamTlsValidationContext"
7217
7433
  }
7218
7434
  },
7435
+ "x-f5xc-description-short": "Choice for selecting HTTP proxy with bring your own certificates.",
7219
7436
  "x-f5xc-minimum-configuration": {
7220
7437
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7221
7438
  "required_fields": [
@@ -7258,6 +7475,7 @@
7258
7475
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
7259
7476
  }
7260
7477
  },
7478
+ "x-f5xc-description-short": "Custom route uses a route object created outside of this view.",
7261
7479
  "x-f5xc-minimum-configuration": {
7262
7480
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7263
7481
  "required_fields": [
@@ -7314,6 +7532,7 @@
7314
7532
  "ves.io.schema.rules.repeated.max_items": "16",
7315
7533
  "ves.io.schema.rules.repeated.unique": "true"
7316
7534
  },
7535
+ "x-f5xc-example": "{\"key\": \"value\"}",
7317
7536
  "x-f5xc-required-for": {
7318
7537
  "minimum_config": false,
7319
7538
  "create": false,
@@ -7334,6 +7553,8 @@
7334
7553
  "$ref": "#/components/schemas/routeRouteDirectResponse"
7335
7554
  }
7336
7555
  },
7556
+ "x-f5xc-description-short": "Direct response route matches on path, incoming header, incoming port and/or HTTP method and responds directly to the matching traffic.",
7557
+ "x-f5xc-description-medium": "Direct response route matches on path, incoming header, incoming port and/or HTTP method and responds directly to the matching traffic.",
7337
7558
  "x-f5xc-minimum-configuration": {
7338
7559
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7339
7560
  "required_fields": [
@@ -7390,6 +7611,7 @@
7390
7611
  "ves.io.schema.rules.repeated.max_items": "16",
7391
7612
  "ves.io.schema.rules.repeated.unique": "true"
7392
7613
  },
7614
+ "x-f5xc-example": "{\"key\": \"value\"}",
7393
7615
  "x-f5xc-required-for": {
7394
7616
  "minimum_config": false,
7395
7617
  "create": false,
@@ -7410,6 +7632,8 @@
7410
7632
  "$ref": "#/components/schemas/routeRouteRedirect"
7411
7633
  }
7412
7634
  },
7635
+ "x-f5xc-description-short": "Redirect route matches on path, incoming header, incoming port and/or HTTP method and redirects the matching traffic to a different URL.",
7636
+ "x-f5xc-description-medium": "Redirect route matches on path, incoming header, incoming port and/or HTTP method and redirects the matching traffic to a different URL.",
7413
7637
  "x-f5xc-minimum-configuration": {
7414
7638
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7415
7639
  "required_fields": [
@@ -7469,6 +7693,8 @@
7469
7693
  "x-validation-rules": {
7470
7694
  "ves.io.schema.rules.string.hostname": "true"
7471
7695
  },
7696
+ "x-f5xc-description-short": "Exclusive with [auto_host_rewrite disable_host_rewrite] Host header will be swapped with this value.",
7697
+ "x-f5xc-description-medium": "Exclusive with [auto_host_rewrite disable_host_rewrite] Host header will be swapped with this value.",
7472
7698
  "minLength": 0,
7473
7699
  "maxLength": 1024,
7474
7700
  "x-f5xc-required-for": {
@@ -7485,6 +7711,8 @@
7485
7711
  "$ref": "#/components/schemas/ioschemaPathMatcherType"
7486
7712
  }
7487
7713
  },
7714
+ "x-f5xc-description-short": "Simple route matches on path and/or HTTP method and forwards the matching traffic to the default origin pool specified outside.",
7715
+ "x-f5xc-description-medium": "Simple route matches on path and/or HTTP method and forwards the matching traffic to the default origin pool specified outside.",
7488
7716
  "x-f5xc-minimum-configuration": {
7489
7717
  "description": "HTTP/HTTPS load balancer for distributing traffic across origin pools",
7490
7718
  "required_fields": [
@@ -7540,6 +7768,7 @@
7540
7768
  "ves.io.schema.rules.string.max_bytes": "256",
7541
7769
  "ves.io.schema.rules.string.not_empty": "true"
7542
7770
  },
7771
+ "x-f5xc-description-short": "Exclusive with [presence regex] Header value to match exactly.",
7543
7772
  "minLength": 0,
7544
7773
  "x-f5xc-required-for": {
7545
7774
  "minimum_config": false,
@@ -7554,6 +7783,7 @@
7554
7783
  "title": "Invert_match.",
7555
7784
  "format": "boolean",
7556
7785
  "x-displayname": "NOT of match.",
7786
+ "x-f5xc-description-short": "Invert the result of the match to detect missing header or non-matching value.",
7557
7787
  "x-f5xc-required-for": {
7558
7788
  "minimum_config": false,
7559
7789
  "create": false,
@@ -7591,7 +7821,7 @@
7591
7821
  },
7592
7822
  "x-original-maxLength": 256,
7593
7823
  "x-reconciled-from-discovery": true,
7594
- "x-reconciled-at": "2026-01-05T18:30:13.960535+00:00"
7824
+ "x-reconciled-at": "2026-01-07T15:29:46.444962+00:00"
7595
7825
  },
7596
7826
  "presence": {
7597
7827
  "type": "boolean",
@@ -7599,6 +7829,7 @@
7599
7829
  "title": "Presence",
7600
7830
  "format": "boolean",
7601
7831
  "x-displayname": "Presence",
7832
+ "x-f5xc-description-short": "Exclusive with [exact regex] If true, check for presence of header.",
7602
7833
  "x-f5xc-required-for": {
7603
7834
  "minimum_config": false,
7604
7835
  "create": false,
@@ -7622,6 +7853,7 @@
7622
7853
  "ves.io.schema.rules.string.not_empty": "true",
7623
7854
  "ves.io.schema.rules.string.regex": "true"
7624
7855
  },
7856
+ "x-f5xc-description-short": "Exclusive with [exact presence] Regex match of the header value in re2 format.",
7625
7857
  "minLength": 0,
7626
7858
  "x-f5xc-required-for": {
7627
7859
  "minimum_config": false,
@@ -7631,6 +7863,8 @@
7631
7863
  }
7632
7864
  }
7633
7865
  },
7866
+ "x-f5xc-description-short": "Header match is done using the name of the header and its value.",
7867
+ "x-f5xc-description-medium": "Header match is done using the name of the header and its value. The value match is done using one of the following regex match on value exact match of value presence of header Header Match can also be inverse of above, which be used to check missing header or non-matching value.",
7634
7868
  "x-f5xc-minimum-configuration": {
7635
7869
  "description": "Minimum configuration for ioschemaHeaderMatcherType",
7636
7870
  "required_fields": [
@@ -7672,6 +7906,7 @@
7672
7906
  "ves.io.schema.rules.string.http_path": "true",
7673
7907
  "ves.io.schema.rules.string.max_len": "256"
7674
7908
  },
7909
+ "x-f5xc-description-short": "Exclusive with [prefix regex] Exact path value to match.",
7675
7910
  "minLength": 0,
7676
7911
  "x-f5xc-required-for": {
7677
7912
  "minimum_config": false,
@@ -7696,6 +7931,7 @@
7696
7931
  "ves.io.schema.rules.string.http_path": "true",
7697
7932
  "ves.io.schema.rules.string.max_len": "256"
7698
7933
  },
7934
+ "x-f5xc-description-short": "Exclusive with [path regex] Path prefix to match (e.g. The value / will match on all paths)",
7699
7935
  "minLength": 0,
7700
7936
  "x-f5xc-required-for": {
7701
7937
  "minimum_config": false,
@@ -7721,6 +7957,8 @@
7721
7957
  "ves.io.schema.rules.string.min_bytes": "1",
7722
7958
  "ves.io.schema.rules.string.regex": "true"
7723
7959
  },
7960
+ "x-f5xc-description-short": "Exclusive with [path prefix] Regular expression of path match (e.g. The value .* will match on all paths)",
7961
+ "x-f5xc-description-medium": "Exclusive with [path prefix] Regular expression of path match (e.g. The value .* will match on all paths).",
7724
7962
  "x-f5xc-required-for": {
7725
7963
  "minimum_config": false,
7726
7964
  "create": false,
@@ -7729,6 +7967,7 @@
7729
7967
  }
7730
7968
  }
7731
7969
  },
7970
+ "x-f5xc-description-short": "Path match of the URI can be either be, Prefix match or exact match or regular expression match.",
7732
7971
  "x-f5xc-minimum-configuration": {
7733
7972
  "description": "Minimum configuration for ioschemaPathMatcherType",
7734
7973
  "required_fields": [
@@ -7769,6 +8008,7 @@
7769
8008
  "x-validation-rules": {
7770
8009
  "ves.io.schema.rules.uint32.lte": "65535"
7771
8010
  },
8011
+ "x-f5xc-description-short": "Exclusive with [no_port_match port_ranges] Exact Port to match.",
7772
8012
  "minimum": 1,
7773
8013
  "maximum": 65535,
7774
8014
  "x-f5xc-required-for": {
@@ -7797,6 +8037,7 @@
7797
8037
  "ves.io.schema.rules.string.min_len": "1",
7798
8038
  "ves.io.schema.rules.string.port_range": "true"
7799
8039
  },
8040
+ "x-f5xc-description-short": "Exclusive with [no_port_match port] Port range to match.",
7800
8041
  "x-f5xc-required-for": {
7801
8042
  "minimum_config": false,
7802
8043
  "create": false,
@@ -7805,6 +8046,7 @@
7805
8046
  }
7806
8047
  }
7807
8048
  },
8049
+ "x-f5xc-description-short": "Port match of the request can be a range or a specific port.",
7808
8050
  "x-f5xc-minimum-configuration": {
7809
8051
  "description": "Minimum configuration for ioschemaPortMatcherType",
7810
8052
  "required_fields": [
@@ -7842,6 +8084,8 @@
7842
8084
  "ves.io.schema.rules.string.max_bytes": "65536",
7843
8085
  "ves.io.schema.rules.string.uri_ref": "true"
7844
8086
  },
8087
+ "x-f5xc-description-short": "Response body to send. Currently supported URL schemes is string:/// for which message should be encoded in Base64 format.",
8088
+ "x-f5xc-description-medium": "Response body to send. Currently supported URL schemes is string:/// for which message should be encoded in Base64 format. The message can be either plain text or HTML.",
7845
8089
  "minLength": 0,
7846
8090
  "x-f5xc-required-for": {
7847
8091
  "minimum_config": false,
@@ -7876,6 +8120,7 @@
7876
8120
  }
7877
8121
  }
7878
8122
  },
8123
+ "x-f5xc-description-short": "Send this direct response in case of route match action is direct response.",
7879
8124
  "x-f5xc-minimum-configuration": {
7880
8125
  "description": "Minimum configuration for routeRouteDirectResponse",
7881
8126
  "required_fields": [
@@ -7902,6 +8147,7 @@
7902
8147
  "type": "string"
7903
8148
  },
7904
8149
  "x-f5xc-example": "userid",
8150
+ "x-f5xc-description-short": "X-displayName: \"Query Parameters\" Query params keys to strip while manipulating the HTTP request.",
7905
8151
  "x-f5xc-required-for": {
7906
8152
  "minimum_config": false,
7907
8153
  "create": false,
@@ -7910,6 +8156,7 @@
7910
8156
  }
7911
8157
  }
7912
8158
  },
8159
+ "x-f5xc-description-short": "X-displayName: \"Query Parameters\" Query params keys to strip while manipulating the HTTP request.",
7913
8160
  "x-f5xc-minimum-configuration": {
7914
8161
  "description": "Minimum configuration for routeRouteQueryParams",
7915
8162
  "required_fields": [
@@ -7939,6 +8186,7 @@
7939
8186
  "x-displayname": "Host",
7940
8187
  "x-ves-example": "one.ves.I/O.",
7941
8188
  "x-f5xc-example": "one.F5 XC",
8189
+ "x-f5xc-description-short": "Swap host part of incoming URL in redirect URL.",
7942
8190
  "minLength": 0,
7943
8191
  "maxLength": 1024,
7944
8192
  "x-f5xc-required-for": {
@@ -7964,6 +8212,7 @@
7964
8212
  "ves.io.schema.rules.string.http_path": "true",
7965
8213
  "ves.io.schema.rules.string.max_len": "256"
7966
8214
  },
8215
+ "x-f5xc-description-short": "Exclusive with [prefix_rewrite] swap path part of incoming URL in redirect URL.",
7967
8216
  "minLength": 0,
7968
8217
  "x-f5xc-required-for": {
7969
8218
  "minimum_config": false,
@@ -7988,6 +8237,8 @@
7988
8237
  "ves.io.schema.rules.string.http_path": "true",
7989
8238
  "ves.io.schema.rules.string.max_len": "256"
7990
8239
  },
8240
+ "x-f5xc-description-short": "Exclusive with [path_redirect] In Redirect response, the matched prefix (or path) should be swapped with this value.",
8241
+ "x-f5xc-description-medium": "Exclusive with [path_redirect] In Redirect response, the matched prefix (or path) should be swapped with this value. This option allows redirect URLs be dynamically created based on the request.",
7991
8242
  "minLength": 0,
7992
8243
  "x-f5xc-required-for": {
7993
8244
  "minimum_config": false,
@@ -8009,6 +8260,8 @@
8009
8260
  "x-validation-rules": {
8010
8261
  "ves.io.schema.rules.string.in": "[\\\"incoming-proto\\\",\\\"http\\\",\\\"https\\\"]"
8011
8262
  },
8263
+ "x-f5xc-description-short": "Swap protocol part of incoming URL in redirect URL The protocol can be swapped with either HTTP or HTTPS When incoming-proto option is specified...",
8264
+ "x-f5xc-description-medium": "Swap protocol part of incoming URL in redirect URL The protocol can be swapped with either HTTP or HTTPS When incoming-proto option is specified, swapping of protocol is not done.",
8012
8265
  "minLength": 0,
8013
8266
  "maxLength": 1024,
8014
8267
  "x-f5xc-required-for": {
@@ -8036,6 +8289,7 @@
8036
8289
  "ves.io.schema.rules.string.max_len": "256",
8037
8290
  "ves.io.schema.rules.string.min_len": "1"
8038
8291
  },
8292
+ "x-f5xc-description-short": "Exclusive with [remove_all_params retain_all_params].",
8039
8293
  "x-f5xc-required-for": {
8040
8294
  "minimum_config": false,
8041
8295
  "create": false,
@@ -8057,6 +8311,7 @@
8057
8311
  "x-validation-rules": {
8058
8312
  "ves.io.schema.rules.uint32.lte": "599"
8059
8313
  },
8314
+ "x-f5xc-description-short": "The HTTP status code to use in the redirect response.",
8060
8315
  "minimum": 0,
8061
8316
  "maximum": 2147483647,
8062
8317
  "x-f5xc-required-for": {
@@ -8070,6 +8325,7 @@
8070
8325
  "$ref": "#/components/schemas/ioschemaEmpty"
8071
8326
  }
8072
8327
  },
8328
+ "x-f5xc-description-short": "Route redirect parameters when match action is redirect.",
8073
8329
  "x-f5xc-minimum-configuration": {
8074
8330
  "description": "Minimum configuration for routeRouteRedirect",
8075
8331
  "required_fields": [
@@ -8104,6 +8360,8 @@
8104
8360
  "x-displayname": "Decryption Provider.",
8105
8361
  "x-ves-example": "Value",
8106
8362
  "x-f5xc-example": "value",
8363
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
8364
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
8107
8365
  "minLength": 0,
8108
8366
  "maxLength": 1024,
8109
8367
  "x-f5xc-required-for": {
@@ -8129,6 +8387,8 @@
8129
8387
  "ves.io.schema.rules.message.required": "true",
8130
8388
  "ves.io.schema.rules.string.uri_ref": "true"
8131
8389
  },
8390
+ "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
8391
+ "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
8132
8392
  "minLength": 0,
8133
8393
  "maxLength": 4,
8134
8394
  "x-f5xc-required-for": {
@@ -8139,7 +8399,7 @@
8139
8399
  },
8140
8400
  "x-original-maxLength": 1024,
8141
8401
  "x-reconciled-from-discovery": true,
8142
- "x-reconciled-at": "2026-01-05T18:30:13.960606+00:00"
8402
+ "x-reconciled-at": "2026-01-07T15:29:46.445034+00:00"
8143
8403
  },
8144
8404
  "store_provider": {
8145
8405
  "type": "string",
@@ -8148,6 +8408,8 @@
8148
8408
  "x-displayname": "Store Provider.",
8149
8409
  "x-ves-example": "Value",
8150
8410
  "x-f5xc-example": "value",
8411
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
8412
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
8151
8413
  "minLength": 0,
8152
8414
  "maxLength": 1024,
8153
8415
  "x-f5xc-required-for": {
@@ -8158,6 +8420,7 @@
8158
8420
  }
8159
8421
  }
8160
8422
  },
8423
+ "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
8161
8424
  "x-f5xc-minimum-configuration": {
8162
8425
  "description": "Minimum configuration for schemaBlindfoldSecretInfoType",
8163
8426
  "required_fields": [
@@ -8187,6 +8450,8 @@
8187
8450
  "x-displayname": "Provider",
8188
8451
  "x-ves-example": "Box-provider.",
8189
8452
  "x-f5xc-example": "box-provider",
8453
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
8454
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
8190
8455
  "minLength": 0,
8191
8456
  "maxLength": 8,
8192
8457
  "x-f5xc-required-for": {
@@ -8197,7 +8462,7 @@
8197
8462
  },
8198
8463
  "x-original-maxLength": 1024,
8199
8464
  "x-reconciled-from-discovery": true,
8200
- "x-reconciled-at": "2026-01-05T18:30:13.960612+00:00"
8465
+ "x-reconciled-at": "2026-01-07T15:29:46.445040+00:00"
8201
8466
  },
8202
8467
  "url": {
8203
8468
  "type": "string",
@@ -8218,6 +8483,8 @@
8218
8483
  "ves.io.schema.rules.string.max_bytes": "131072",
8219
8484
  "ves.io.schema.rules.string.uri_ref": "true"
8220
8485
  },
8486
+ "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
8487
+ "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
8221
8488
  "format": "uri",
8222
8489
  "minLength": 0,
8223
8490
  "x-f5xc-required-for": {
@@ -8228,6 +8495,7 @@
8228
8495
  }
8229
8496
  }
8230
8497
  },
8498
+ "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
8231
8499
  "x-f5xc-minimum-configuration": {
8232
8500
  "description": "Minimum configuration for schemaClearSecretInfoType",
8233
8501
  "required_fields": [
@@ -8253,6 +8521,8 @@
8253
8521
  "default": "INVALID_HASH_ALGORITHM",
8254
8522
  "x-displayname": "Hash Algorithm.",
8255
8523
  "x-ves-proto-enum": "ves.io.schema.HashAlgorithm",
8524
+ "x-f5xc-description-short": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
8525
+ "x-f5xc-description-medium": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
8256
8526
  "x-f5xc-minimum-configuration": {
8257
8527
  "description": "Minimum configuration for schemaHashAlgorithm",
8258
8528
  "required_fields": [],
@@ -8293,6 +8563,7 @@
8293
8563
  "ves.io.schema.rules.repeated.min_items": "1",
8294
8564
  "ves.io.schema.rules.repeated.unique": "true"
8295
8565
  },
8566
+ "x-f5xc-description-short": "Ordered list of hash algorithms to be used. Required: YES.",
8296
8567
  "x-f5xc-required-for": {
8297
8568
  "minimum_config": false,
8298
8569
  "create": false,
@@ -8301,6 +8572,7 @@
8301
8572
  }
8302
8573
  }
8303
8574
  },
8575
+ "x-f5xc-description-short": "Specifies the hash algorithms to be used.",
8304
8576
  "x-f5xc-minimum-configuration": {
8305
8577
  "description": "Minimum configuration for schemaHashAlgorithms",
8306
8578
  "required_fields": [
@@ -8335,6 +8607,7 @@
8335
8607
  "$ref": "#/components/schemas/ioschemaEmpty"
8336
8608
  }
8337
8609
  },
8610
+ "x-f5xc-description-short": "Header Transformation OPTIONS for HTTP/1.1 request/response headers.",
8338
8611
  "x-f5xc-minimum-configuration": {
8339
8612
  "description": "Minimum configuration for schemaHeaderTransformationType",
8340
8613
  "required_fields": [
@@ -8370,6 +8643,7 @@
8370
8643
  "default": "ANY",
8371
8644
  "x-displayname": "HTTP Method.",
8372
8645
  "x-ves-proto-enum": "ves.io.schema.HttpMethod",
8646
+ "x-f5xc-description-short": "Specifies the HTTP method used to access a resource. Any HTTP Method.",
8373
8647
  "x-f5xc-minimum-configuration": {
8374
8648
  "description": "Minimum configuration for schemaHttpMethod",
8375
8649
  "required_fields": [],
@@ -8404,7 +8678,7 @@
8404
8678
  },
8405
8679
  "x-original-maxLength": 1024,
8406
8680
  "x-reconciled-from-discovery": true,
8407
- "x-reconciled-at": "2026-01-05T18:30:13.960654+00:00"
8681
+ "x-reconciled-at": "2026-01-07T15:29:46.445080+00:00"
8408
8682
  },
8409
8683
  "name": {
8410
8684
  "type": "string",
@@ -8423,7 +8697,7 @@
8423
8697
  },
8424
8698
  "x-original-maxLength": 1024,
8425
8699
  "x-reconciled-from-discovery": true,
8426
- "x-reconciled-at": "2026-01-05T18:30:13.960658+00:00"
8700
+ "x-reconciled-at": "2026-01-07T15:29:46.445084+00:00"
8427
8701
  },
8428
8702
  "namespace": {
8429
8703
  "type": "string",
@@ -8442,9 +8716,10 @@
8442
8716
  },
8443
8717
  "x-original-maxLength": 1024,
8444
8718
  "x-reconciled-from-discovery": true,
8445
- "x-reconciled-at": "2026-01-05T18:30:13.960662+00:00"
8719
+ "x-reconciled-at": "2026-01-07T15:29:46.445088+00:00"
8446
8720
  }
8447
8721
  },
8722
+ "x-f5xc-description-short": "KubeRefType represents a reference to a Kubernetes (K8s) object.",
8448
8723
  "x-f5xc-minimum-configuration": {
8449
8724
  "description": "Minimum configuration for schemaKubeRefType",
8450
8725
  "required_fields": [
@@ -8468,6 +8743,8 @@
8468
8743
  "EncodingBase64"
8469
8744
  ],
8470
8745
  "default": "EncodingNone",
8746
+ "x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
8747
+ "x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
8471
8748
  "x-f5xc-minimum-configuration": {
8472
8749
  "description": "Minimum configuration for schemaSecretEncodingType",
8473
8750
  "required_fields": [],
@@ -8493,6 +8770,7 @@
8493
8770
  "$ref": "#/components/schemas/schemaClearSecretInfoType"
8494
8771
  }
8495
8772
  },
8773
+ "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
8496
8774
  "x-f5xc-minimum-configuration": {
8497
8775
  "description": "Minimum configuration for schemaSecretType",
8498
8776
  "required_fields": [
@@ -8521,6 +8799,7 @@
8521
8799
  "$ref": "#/components/schemas/ioschemaEmpty"
8522
8800
  }
8523
8801
  },
8802
+ "x-f5xc-description-short": "TLS connection coalescing configuration (not compatible with mTLS).",
8524
8803
  "x-f5xc-minimum-configuration": {
8525
8804
  "description": "Minimum configuration for schemaTLSCoalescingOptions",
8526
8805
  "required_fields": [
@@ -8564,6 +8843,8 @@
8564
8843
  "ves.io.schema.rules.string.max_bytes": "131072",
8565
8844
  "ves.io.schema.rules.string.min_bytes": "1"
8566
8845
  },
8846
+ "x-f5xc-description-short": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers.",
8847
+ "x-f5xc-description-medium": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
8567
8848
  "x-f5xc-required-for": {
8568
8849
  "minimum_config": false,
8569
8850
  "create": false,
@@ -8591,7 +8872,7 @@
8591
8872
  },
8592
8873
  "x-original-maxLength": 1024,
8593
8874
  "x-reconciled-from-discovery": true,
8594
- "x-reconciled-at": "2026-01-05T18:30:13.960789+00:00"
8875
+ "x-reconciled-at": "2026-01-07T15:29:46.445225+00:00"
8595
8876
  },
8596
8877
  "disable_ocsp_stapling": {
8597
8878
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -8634,6 +8915,8 @@
8634
8915
  "default": "TLS_AUTO",
8635
8916
  "x-displayname": "TLS Protocol.",
8636
8917
  "x-ves-proto-enum": "ves.io.schema.TlsProtocol",
8918
+ "x-f5xc-description-short": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
8919
+ "x-f5xc-description-medium": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
8637
8920
  "x-f5xc-minimum-configuration": {
8638
8921
  "description": "Minimum configuration for schemaTlsProtocol",
8639
8922
  "required_fields": [],
@@ -8654,6 +8937,8 @@
8654
8937
  "description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
8655
8938
  "title": "Key",
8656
8939
  "x-f5xc-example": "key_pem",
8940
+ "x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
8941
+ "x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
8657
8942
  "minLength": 0,
8658
8943
  "maxLength": 16,
8659
8944
  "x-f5xc-required-for": {
@@ -8664,13 +8949,14 @@
8664
8949
  },
8665
8950
  "x-original-maxLength": 1024,
8666
8951
  "x-reconciled-from-discovery": true,
8667
- "x-reconciled-at": "2026-01-05T18:30:13.960809+00:00"
8952
+ "x-reconciled-at": "2026-01-07T15:29:46.445246+00:00"
8668
8953
  },
8669
8954
  "location": {
8670
8955
  "type": "string",
8671
8956
  "description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
8672
8957
  "title": "Location",
8673
8958
  "x-f5xc-example": "v1/data/vhost_key",
8959
+ "x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
8674
8960
  "minLength": 0,
8675
8961
  "maxLength": 4,
8676
8962
  "x-f5xc-required-for": {
@@ -8681,13 +8967,15 @@
8681
8967
  },
8682
8968
  "x-original-maxLength": 1024,
8683
8969
  "x-reconciled-from-discovery": true,
8684
- "x-reconciled-at": "2026-01-05T18:30:13.960814+00:00"
8970
+ "x-reconciled-at": "2026-01-07T15:29:46.445250+00:00"
8685
8971
  },
8686
8972
  "provider": {
8687
8973
  "type": "string",
8688
8974
  "description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
8689
8975
  "title": "Provider",
8690
8976
  "x-f5xc-example": "vault-vh-provider",
8977
+ "x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
8978
+ "x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
8691
8979
  "minLength": 0,
8692
8980
  "maxLength": 8,
8693
8981
  "x-f5xc-required-for": {
@@ -8698,7 +8986,7 @@
8698
8986
  },
8699
8987
  "x-original-maxLength": 1024,
8700
8988
  "x-reconciled-from-discovery": true,
8701
- "x-reconciled-at": "2026-01-05T18:30:13.960818+00:00"
8989
+ "x-reconciled-at": "2026-01-07T15:29:46.445254+00:00"
8702
8990
  },
8703
8991
  "secret_encoding": {
8704
8992
  "$ref": "#/components/schemas/schemaSecretEncodingType"
@@ -8709,6 +8997,8 @@
8709
8997
  "title": "Version",
8710
8998
  "format": "int64",
8711
8999
  "x-f5xc-example": "1",
9000
+ "x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
9001
+ "x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
8712
9002
  "minimum": 0,
8713
9003
  "maximum": 2147483647,
8714
9004
  "x-f5xc-required-for": {
@@ -8720,9 +9010,11 @@
8720
9010
  "maxLength": 1,
8721
9011
  "minLength": 1,
8722
9012
  "x-reconciled-from-discovery": true,
8723
- "x-reconciled-at": "2026-01-05T18:30:13.960825+00:00"
9013
+ "x-reconciled-at": "2026-01-07T15:29:46.445261+00:00"
8724
9014
  }
8725
9015
  },
9016
+ "x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
9017
+ "x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
8726
9018
  "x-f5xc-minimum-configuration": {
8727
9019
  "description": "Minimum configuration for schemaVaultSecretInfoType",
8728
9020
  "required_fields": [
@@ -8749,6 +9041,7 @@
8749
9041
  "description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
8750
9042
  "title": "Name",
8751
9043
  "x-f5xc-example": "ChargeBack-API-Key",
9044
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
8752
9045
  "minLength": 0,
8753
9046
  "maxLength": 16,
8754
9047
  "x-f5xc-required-for": {
@@ -8759,9 +9052,10 @@
8759
9052
  },
8760
9053
  "x-original-maxLength": 1024,
8761
9054
  "x-reconciled-from-discovery": true,
8762
- "x-reconciled-at": "2026-01-05T18:30:13.960848+00:00"
9055
+ "x-reconciled-at": "2026-01-07T15:29:46.445283+00:00"
8763
9056
  }
8764
9057
  },
9058
+ "x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
8765
9059
  "x-f5xc-minimum-configuration": {
8766
9060
  "description": "Minimum configuration for schemaWingmanSecretInfoType",
8767
9061
  "required_fields": [
@@ -8789,6 +9083,8 @@
8789
9083
  "default": "XFCC_NONE",
8790
9084
  "x-displayname": "XFCC Elements.",
8791
9085
  "x-ves-proto-enum": "ves.io.schema.XfccElement",
9086
+ "x-f5xc-description-short": "X-Forwarded-Client-Cert custom cookie elements The entire client certificate in URL encoded PEM format.",
9087
+ "x-f5xc-description-medium": "X-Forwarded-Client-Cert custom cookie elements The entire client certificate in URL encoded PEM format. The entire client certificate chain (including the leaf certificate) in URL encoded PEM format. The Subject field of the current client certificate.",
8792
9088
  "x-f5xc-minimum-configuration": {
8793
9089
  "description": "Minimum configuration for schemaXfccElement",
8794
9090
  "required_fields": [],
@@ -8831,6 +9127,8 @@
8831
9127
  "ves.io.schema.rules.repeated.max_items": "16",
8832
9128
  "ves.io.schema.rules.repeated.min_items": "1"
8833
9129
  },
9130
+ "x-f5xc-description-short": "Users can add one or more certificates that share the same set of domains.",
9131
+ "x-f5xc-description-medium": "Users can add one or more certificates that share the same set of domains. For example, domain.com and *.domain.com - but use different signature algorithms Required: YES.",
8834
9132
  "x-f5xc-required-for": {
8835
9133
  "minimum_config": false,
8836
9134
  "create": false,
@@ -8871,6 +9169,7 @@
8871
9169
  "$ref": "#/components/schemas/schemaHeaderTransformationType"
8872
9170
  }
8873
9171
  },
9172
+ "x-f5xc-description-short": "HTTP/1.1 Protocol OPTIONS for downstream connections.",
8874
9173
  "x-f5xc-minimum-configuration": {
8875
9174
  "description": "Minimum configuration for schemavirtual_hostHttp1ProtocolOptions",
8876
9175
  "required_fields": [
@@ -8912,6 +9211,7 @@
8912
9211
  "ves.io.schema.rules.repeated.items.string.in": "[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]",
8913
9212
  "ves.io.schema.rules.repeated.unique": "true"
8914
9213
  },
9214
+ "x-f5xc-description-short": "The TLS listener will only support the specified cipher list. Required: YES.",
8915
9215
  "x-f5xc-required-for": {
8916
9216
  "minimum_config": false,
8917
9217
  "create": false,
@@ -8926,6 +9226,7 @@
8926
9226
  "$ref": "#/components/schemas/schemaTlsProtocol"
8927
9227
  }
8928
9228
  },
9229
+ "x-f5xc-description-short": "Defines TLS protocol config including min/max versions and allowed ciphers.",
8929
9230
  "x-f5xc-minimum-configuration": {
8930
9231
  "description": "Minimum configuration for viewsCustomCiphers",
8931
9232
  "required_fields": [
@@ -8968,6 +9269,7 @@
8968
9269
  "ves.io.schema.rules.repeated.max_items": "32",
8969
9270
  "ves.io.schema.rules.repeated.unique": "true"
8970
9271
  },
9272
+ "x-f5xc-description-short": "Select one or more certificates with any domain names. Required: YES.",
8971
9273
  "x-f5xc-required-for": {
8972
9274
  "minimum_config": false,
8973
9275
  "create": false,
@@ -9016,6 +9318,9 @@
9016
9318
  "title": "Client_certificate_optional.",
9017
9319
  "format": "boolean",
9018
9320
  "x-displayname": "Client Certificate Optional.",
9321
+ "x-f5xc-example": "{\"key\": \"value\"}",
9322
+ "x-f5xc-description-short": "Client certificate is optional. If the client has provided a certificate, the load balancer will verify it.",
9323
+ "x-f5xc-description-medium": "Client certificate is optional. If the client has provided a certificate, the load balancer will verify it. If certification verification fails, the connection will be terminated.",
9019
9324
  "x-f5xc-required-for": {
9020
9325
  "minimum_config": false,
9021
9326
  "create": false,
@@ -9049,6 +9354,7 @@
9049
9354
  "ves.io.schema.rules.string.min_bytes": "1",
9050
9355
  "ves.io.schema.rules.string.truststore_url": "true"
9051
9356
  },
9357
+ "x-f5xc-description-short": "Exclusive with [trusted_ca] Upload a Root CA Certificate specifically for this Load Balancer.",
9052
9358
  "x-f5xc-required-for": {
9053
9359
  "minimum_config": false,
9054
9360
  "create": false,
@@ -9063,6 +9369,7 @@
9063
9369
  "$ref": "#/components/schemas/viewsXfccHeaderKeys"
9064
9370
  }
9065
9371
  },
9372
+ "x-f5xc-description-short": "Validation context for downstream client TLS connections.",
9066
9373
  "x-f5xc-minimum-configuration": {
9067
9374
  "description": "Minimum configuration for viewsDownstreamTlsValidationContext",
9068
9375
  "required_fields": [
@@ -9097,6 +9404,8 @@
9097
9404
  "default": "SITE_NETWORK_INSIDE_AND_OUTSIDE",
9098
9405
  "x-displayname": "Site Network.",
9099
9406
  "x-ves-proto-enum": "ves.io.schema.views.SiteNetwork",
9407
+ "x-f5xc-description-short": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support.",
9408
+ "x-f5xc-description-medium": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks.",
9100
9409
  "x-f5xc-minimum-configuration": {
9101
9410
  "description": "Minimum configuration for viewsSiteNetwork",
9102
9411
  "required_fields": [],
@@ -9129,6 +9438,7 @@
9129
9438
  "$ref": "#/components/schemas/ioschemaEmpty"
9130
9439
  }
9131
9440
  },
9441
+ "x-f5xc-description-short": "Defines various OPTIONS to configure TLS configuration parameters.",
9132
9442
  "x-f5xc-minimum-configuration": {
9133
9443
  "description": "Minimum configuration for viewsTlsConfig",
9134
9444
  "required_fields": [
@@ -9165,6 +9475,7 @@
9165
9475
  "x-validation-rules": {
9166
9476
  "ves.io.schema.rules.string.ipv4": "true"
9167
9477
  },
9478
+ "x-f5xc-description-short": "Use given IP address as VIP on the site.",
9168
9479
  "minLength": 0,
9169
9480
  "maxLength": 1024,
9170
9481
  "x-f5xc-required-for": {
@@ -9181,6 +9492,8 @@
9181
9492
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
9182
9493
  }
9183
9494
  },
9495
+ "x-f5xc-description-short": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.",
9496
+ "x-f5xc-description-medium": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.",
9184
9497
  "x-f5xc-minimum-configuration": {
9185
9498
  "description": "Minimum configuration for viewsWhereSite",
9186
9499
  "required_fields": [
@@ -9211,6 +9524,8 @@
9211
9524
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
9212
9525
  }
9213
9526
  },
9527
+ "x-f5xc-description-short": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.",
9528
+ "x-f5xc-description-medium": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.",
9214
9529
  "x-f5xc-minimum-configuration": {
9215
9530
  "description": "Minimum configuration for viewsWhereVK8SService",
9216
9531
  "required_fields": [
@@ -9239,6 +9554,8 @@
9239
9554
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
9240
9555
  }
9241
9556
  },
9557
+ "x-f5xc-description-short": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.",
9558
+ "x-f5xc-description-medium": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.",
9242
9559
  "x-f5xc-minimum-configuration": {
9243
9560
  "description": "Minimum configuration for viewsWhereVirtualSite",
9244
9561
  "required_fields": [
@@ -9278,6 +9595,7 @@
9278
9595
  "ves.io.schema.rules.repeated.items.enum.defined_only": "true",
9279
9596
  "ves.io.schema.rules.repeated.items.enum.not_in": "[0]"
9280
9597
  },
9598
+ "x-f5xc-description-short": "X-Forwarded-Client-Cert header elements to be added to requests Required: YES.",
9281
9599
  "x-f5xc-required-for": {
9282
9600
  "minimum_config": false,
9283
9601
  "create": false,
@@ -9286,6 +9604,7 @@
9286
9604
  }
9287
9605
  }
9288
9606
  },
9607
+ "x-f5xc-description-short": "X-Forwarded-Client-Cert header elements to be added to requests.",
9289
9608
  "x-f5xc-minimum-configuration": {
9290
9609
  "description": "Minimum configuration for viewsXfccHeaderKeys",
9291
9610
  "required_fields": [
@@ -9384,6 +9703,8 @@
9384
9703
  "default": "PROTOCOL_TCP",
9385
9704
  "x-displayname": "Protocol Type.",
9386
9705
  "x-ves-proto-enum": "ves.io.schema.views.workload.ProtocolType",
9706
+ "x-f5xc-description-short": "Type of protocol - PROTOCOL_TCP: TCP TCP - PROTOCOL_HTTP: HTTP HTTP - PROTOCOL_HTTP2: HTTP2 HTTP2 - PROTOCOL_TLS_WITH_SNI: TLS with SNI TLS with...",
9707
+ "x-f5xc-description-medium": "Type of protocol - PROTOCOL_TCP: TCP TCP - PROTOCOL_HTTP: HTTP HTTP - PROTOCOL_HTTP2: HTTP2 HTTP2 - PROTOCOL_TLS_WITH_SNI: TLS with SNI TLS with SNI - PROTOCOL_UDP: UDP UDP.",
9387
9708
  "x-f5xc-minimum-configuration": {
9388
9709
  "description": "Minimum configuration for viewsworkloadProtocolType",
9389
9710
  "required_fields": [],
@@ -9460,6 +9781,7 @@
9460
9781
  }
9461
9782
  }
9462
9783
  },
9784
+ "x-f5xc-description-short": "Defines various OPTIONS to define a route.",
9463
9785
  "x-f5xc-minimum-configuration": {
9464
9786
  "description": "Minimum configuration for viewsworkloadRouteType",
9465
9787
  "required_fields": [
@@ -9504,6 +9826,7 @@
9504
9826
  "ves.io.schema.rules.message.required": "true",
9505
9827
  "ves.io.schema.rules.repeated.max_items": "16"
9506
9828
  },
9829
+ "x-f5xc-description-short": "Containers to use for service Required: YES.",
9507
9830
  "x-f5xc-required-for": {
9508
9831
  "minimum_config": false,
9509
9832
  "create": false,
@@ -9530,6 +9853,7 @@
9530
9853
  "ves.io.schema.rules.int32.gt": "0",
9531
9854
  "ves.io.schema.rules.int32.lte": "5"
9532
9855
  },
9856
+ "x-f5xc-description-short": "Exclusive with [scale_to_zero] Number of replicas of service to spawn per site.",
9533
9857
  "minimum": 0,
9534
9858
  "maximum": 2147483647,
9535
9859
  "x-f5xc-required-for": {
@@ -9565,6 +9889,8 @@
9565
9889
  }
9566
9890
  }
9567
9891
  },
9892
+ "x-f5xc-description-short": "Service does not maintain per replica state, however it can be configured to use persistent storage that is shared amongst all the replicas.",
9893
+ "x-f5xc-description-medium": "Service does not maintain per replica state, however it can be configured to use persistent storage that is shared amongst all the replicas. Replicas of a service are fungible and do not have a stable network identity or storage. Common examples of services are web servers, application servers...",
9568
9894
  "x-f5xc-minimum-configuration": {
9569
9895
  "description": "Minimum configuration for viewsworkloadServiceType",
9570
9896
  "required_fields": [
@@ -9602,6 +9928,7 @@
9602
9928
  "$ref": "#/components/schemas/ioschemaEmpty"
9603
9929
  }
9604
9930
  },
9931
+ "x-f5xc-description-short": "HTTP protocol configuration OPTIONS for downstream connections.",
9605
9932
  "x-f5xc-minimum-configuration": {
9606
9933
  "description": "Minimum configuration for virtual_hostHttpProtocolOptions",
9607
9934
  "required_fields": [
@@ -9646,6 +9973,7 @@
9646
9973
  "ves.io.schema.rules.repeated.min_items": "1",
9647
9974
  "ves.io.schema.rules.repeated.unique": "true"
9648
9975
  },
9976
+ "x-f5xc-description-short": "Where should this load balancer be available Required: YES.",
9649
9977
  "x-f5xc-required-for": {
9650
9978
  "minimum_config": false,
9651
9979
  "create": false,
@@ -9679,6 +10007,7 @@
9679
10007
  }
9680
10008
  }
9681
10009
  },
10010
+ "x-f5xc-description-short": "Advertise this workload via loadbalancer on specific sites.",
9682
10011
  "x-f5xc-minimum-configuration": {
9683
10012
  "description": "Minimum configuration for workloadAdvertiseCustomType",
9684
10013
  "required_fields": [
@@ -9707,6 +10036,7 @@
9707
10036
  "$ref": "#/components/schemas/workloadSinglePortType"
9708
10037
  }
9709
10038
  },
10039
+ "x-f5xc-description-short": "Advertise the workload locally in-cluster.",
9710
10040
  "x-f5xc-minimum-configuration": {
9711
10041
  "description": "Minimum configuration for workloadAdvertiseInClusterType",
9712
10042
  "required_fields": [
@@ -9786,6 +10116,8 @@
9786
10116
  "$ref": "#/components/schemas/ioschemaEmpty"
9787
10117
  }
9788
10118
  },
10119
+ "x-f5xc-description-short": "Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers.",
10120
+ "x-f5xc-description-medium": "Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers.",
9789
10121
  "x-f5xc-minimum-configuration": {
9790
10122
  "description": "Minimum configuration for workloadAdvertiseOptionsType",
9791
10123
  "required_fields": [
@@ -9848,6 +10180,7 @@
9848
10180
  "$ref": "#/components/schemas/workloadAdvertiseSinglePortType"
9849
10181
  }
9850
10182
  },
10183
+ "x-f5xc-description-short": "Advertise this workload via loadbalancer on Internet with default VIP.",
9851
10184
  "x-f5xc-minimum-configuration": {
9852
10185
  "description": "Minimum configuration for workloadAdvertisePublicType",
9853
10186
  "required_fields": [
@@ -9901,6 +10234,8 @@
9901
10234
  "ves.io.schema.rules.repeated.min_items": "1",
9902
10235
  "ves.io.schema.rules.repeated.unique": "true"
9903
10236
  },
10237
+ "x-f5xc-description-short": "List of Domains (host/authority header) that will be matched to Load Balancer.",
10238
+ "x-f5xc-description-medium": "List of Domains (host/authority header) that will be matched to Load Balancer. Wildcard hosts are supported in the suffix or prefix form Supported Domains and search order: 1. Exact Domain names: www.example.com. 2.",
9904
10239
  "x-f5xc-required-for": {
9905
10240
  "minimum_config": false,
9906
10241
  "create": false,
@@ -9927,6 +10262,7 @@
9927
10262
  "ves.io.schema.rules.uint32.gte": "1024",
9928
10263
  "ves.io.schema.rules.uint32.lte": "65535"
9929
10264
  },
10265
+ "x-f5xc-description-short": "Service port to advertise on Internet via HTTP loadbalancer using port 80 Required: YES.",
9930
10266
  "minimum": 0,
9931
10267
  "maximum": 2147483647,
9932
10268
  "x-f5xc-required-for": {
@@ -10000,6 +10336,7 @@
10000
10336
  "$ref": "#/components/schemas/viewsWhereVK8SService"
10001
10337
  }
10002
10338
  },
10339
+ "x-f5xc-description-short": "Defines various OPTIONS where a load balancer could be advertised.",
10003
10340
  "x-f5xc-minimum-configuration": {
10004
10341
  "description": "Minimum configuration for workloadAdvertiseWhereType",
10005
10342
  "required_fields": [
@@ -10074,7 +10411,7 @@
10074
10411
  },
10075
10412
  "x-original-maxLength": 256,
10076
10413
  "x-reconciled-from-discovery": true,
10077
- "x-reconciled-at": "2026-01-05T18:30:13.960971+00:00"
10414
+ "x-reconciled-at": "2026-01-07T15:29:46.445402+00:00"
10078
10415
  },
10079
10416
  "volume_name": {
10080
10417
  "type": "string",
@@ -10132,6 +10469,7 @@
10132
10469
  "$ref": "#/components/schemas/workloadConfigurationFileType"
10133
10470
  }
10134
10471
  },
10472
+ "x-f5xc-description-short": "Configuration parameter for the workload.",
10135
10473
  "x-f5xc-minimum-configuration": {
10136
10474
  "description": "Minimum configuration for workloadConfigurationParameterType",
10137
10475
  "required_fields": [
@@ -10177,6 +10515,7 @@
10177
10515
  }
10178
10516
  }
10179
10517
  },
10518
+ "x-f5xc-description-short": "Configuration parameters of the workload.",
10180
10519
  "x-f5xc-minimum-configuration": {
10181
10520
  "description": "Minimum configuration for workloadConfigurationParametersType",
10182
10521
  "required_fields": [
@@ -10201,6 +10540,8 @@
10201
10540
  "default": "CONTAINER_FLAVOR_TYPE_TINY",
10202
10541
  "x-displayname": "Container Flavor Type.",
10203
10542
  "x-ves-proto-enum": "ves.io.schema.views.workload.ContainerFlavorType",
10543
+ "x-f5xc-description-short": "Container Flavor type - CONTAINER_FLAVOR_TYPE_TINY: Tiny Tiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory ...",
10544
+ "x-f5xc-description-medium": "Container Flavor type - CONTAINER_FLAVOR_TYPE_TINY: Tiny Tiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_MEDIUM: Medium Medium containers have limit of 0.25 vCPU and 512 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_LARGE: Large Large containers have...",
10204
10545
  "x-f5xc-minimum-configuration": {
10205
10546
  "description": "Minimum configuration for workloadContainerFlavorType",
10206
10547
  "required_fields": [],
@@ -10236,6 +10577,7 @@
10236
10577
  "x-validation-rules": {
10237
10578
  "ves.io.schema.rules.repeated.max_items": "128"
10238
10579
  },
10580
+ "x-f5xc-description-short": "Arguments to the entrypoint. Overrides the docker image's CMD.",
10239
10581
  "x-f5xc-required-for": {
10240
10582
  "minimum_config": false,
10241
10583
  "create": false,
@@ -10260,6 +10602,7 @@
10260
10602
  "x-validation-rules": {
10261
10603
  "ves.io.schema.rules.repeated.max_items": "128"
10262
10604
  },
10605
+ "x-f5xc-description-short": "Command to execute. Overrides the docker image's ENTRYPOINT.",
10263
10606
  "x-f5xc-required-for": {
10264
10607
  "minimum_config": false,
10265
10608
  "create": false,
@@ -10285,6 +10628,7 @@
10285
10628
  "title": "Init Container.",
10286
10629
  "format": "boolean",
10287
10630
  "x-displayname": "Initialization Container.",
10631
+ "x-f5xc-description-short": "Specialized container that runs before application container and runs to completion.",
10288
10632
  "x-f5xc-required-for": {
10289
10633
  "minimum_config": false,
10290
10634
  "create": false,
@@ -10321,12 +10665,13 @@
10321
10665
  },
10322
10666
  "x-original-maxLength": 256,
10323
10667
  "x-reconciled-from-discovery": true,
10324
- "x-reconciled-at": "2026-01-05T18:30:13.960991+00:00"
10668
+ "x-reconciled-at": "2026-01-07T15:29:46.445422+00:00"
10325
10669
  },
10326
10670
  "readiness_check": {
10327
10671
  "$ref": "#/components/schemas/workloadHealthCheckType"
10328
10672
  }
10329
10673
  },
10674
+ "x-f5xc-description-short": "ContainerType configures the container information.",
10330
10675
  "x-f5xc-minimum-configuration": {
10331
10676
  "description": "Minimum configuration for workloadContainerType",
10332
10677
  "required_fields": [
@@ -10416,6 +10761,7 @@
10416
10761
  "title": "Fail_if_referred.",
10417
10762
  "format": "boolean",
10418
10763
  "x-displayname": "Fail-If-Referred.",
10764
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
10419
10765
  "x-f5xc-required-for": {
10420
10766
  "minimum_config": false,
10421
10767
  "create": false,
@@ -10440,7 +10786,7 @@
10440
10786
  },
10441
10787
  "x-original-maxLength": 1024,
10442
10788
  "x-reconciled-from-discovery": true,
10443
- "x-reconciled-at": "2026-01-05T18:30:13.961005+00:00"
10789
+ "x-reconciled-at": "2026-01-07T15:29:46.445435+00:00"
10444
10790
  },
10445
10791
  "namespace": {
10446
10792
  "type": "string",
@@ -10449,6 +10795,7 @@
10449
10795
  "x-displayname": "Namespace",
10450
10796
  "x-ves-example": "Ns1",
10451
10797
  "x-f5xc-example": "ns1",
10798
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
10452
10799
  "minLength": 0,
10453
10800
  "maxLength": 6,
10454
10801
  "x-f5xc-required-for": {
@@ -10459,7 +10806,7 @@
10459
10806
  },
10460
10807
  "x-original-maxLength": 1024,
10461
10808
  "x-reconciled-from-discovery": true,
10462
- "x-reconciled-at": "2026-01-05T18:30:13.961009+00:00"
10809
+ "x-reconciled-at": "2026-01-07T15:29:46.445439+00:00"
10463
10810
  }
10464
10811
  },
10465
10812
  "x-f5xc-minimum-configuration": {
@@ -10506,6 +10853,7 @@
10506
10853
  "ves.io.schema.rules.repeated.min_items": "1",
10507
10854
  "ves.io.schema.rules.repeated.unique": "true"
10508
10855
  },
10856
+ "x-f5xc-description-short": "Which customer sites should this workload be deployed Required: YES.",
10509
10857
  "x-f5xc-required-for": {
10510
10858
  "minimum_config": false,
10511
10859
  "create": false,
@@ -10514,6 +10862,7 @@
10514
10862
  }
10515
10863
  }
10516
10864
  },
10865
+ "x-f5xc-description-short": "Defines a way to deploy a workload on specific Customer sites.",
10517
10866
  "x-f5xc-minimum-configuration": {
10518
10867
  "description": "Minimum configuration for workloadDeployCESiteType",
10519
10868
  "required_fields": [
@@ -10556,6 +10905,7 @@
10556
10905
  "ves.io.schema.rules.repeated.min_items": "1",
10557
10906
  "ves.io.schema.rules.repeated.unique": "true"
10558
10907
  },
10908
+ "x-f5xc-description-short": "Which customer virtual sites should this workload be deployed Required: YES.",
10559
10909
  "x-f5xc-required-for": {
10560
10910
  "minimum_config": false,
10561
10911
  "create": false,
@@ -10564,6 +10914,7 @@
10564
10914
  }
10565
10915
  }
10566
10916
  },
10917
+ "x-f5xc-description-short": "Defines a way to deploy a workload on specific Customer virtual sites.",
10567
10918
  "x-f5xc-minimum-configuration": {
10568
10919
  "description": "Minimum configuration for workloadDeployCEVirtualSiteType",
10569
10920
  "required_fields": [
@@ -10603,6 +10954,7 @@
10603
10954
  "$ref": "#/components/schemas/workloadDeployREVirtualSiteType"
10604
10955
  }
10605
10956
  },
10957
+ "x-f5xc-description-short": "Deploy OPTIONS are used to configure the workload deployment OPTIONS.",
10606
10958
  "x-f5xc-minimum-configuration": {
10607
10959
  "description": "Minimum configuration for workloadDeployOptionsType",
10608
10960
  "required_fields": [
@@ -10650,6 +11002,7 @@
10650
11002
  "ves.io.schema.rules.repeated.min_items": "1",
10651
11003
  "ves.io.schema.rules.repeated.unique": "true"
10652
11004
  },
11005
+ "x-f5xc-description-short": "Which regional edge sites should this workload be deployed Required: YES.",
10653
11006
  "x-f5xc-required-for": {
10654
11007
  "minimum_config": false,
10655
11008
  "create": false,
@@ -10658,6 +11011,7 @@
10658
11011
  }
10659
11012
  }
10660
11013
  },
11014
+ "x-f5xc-description-short": "Defines a way to deploy a workload on specific Regional Edge sites.",
10661
11015
  "x-f5xc-minimum-configuration": {
10662
11016
  "description": "Minimum configuration for workloadDeployRESiteType",
10663
11017
  "required_fields": [
@@ -10700,6 +11054,7 @@
10700
11054
  "ves.io.schema.rules.repeated.min_items": "1",
10701
11055
  "ves.io.schema.rules.repeated.unique": "true"
10702
11056
  },
11057
+ "x-f5xc-description-short": "Which regional edge virtual sites should this workload be deployed Required: YES.",
10703
11058
  "x-f5xc-required-for": {
10704
11059
  "minimum_config": false,
10705
11060
  "create": false,
@@ -10708,6 +11063,7 @@
10708
11063
  }
10709
11064
  }
10710
11065
  },
11066
+ "x-f5xc-description-short": "Defines a way to deploy a workload on specific Regional Edge virtual sites.",
10711
11067
  "x-f5xc-minimum-configuration": {
10712
11068
  "description": "Minimum configuration for workloadDeployREVirtualSiteType",
10713
11069
  "required_fields": [
@@ -10755,6 +11111,7 @@
10755
11111
  }
10756
11112
  }
10757
11113
  },
11114
+ "x-f5xc-description-short": "Volume containing a temporary directory whose lifetime is the same as a replica of a workload.",
10758
11115
  "x-f5xc-minimum-configuration": {
10759
11116
  "description": "Minimum configuration for workloadEmptyDirectoryVolumeType",
10760
11117
  "required_fields": [
@@ -10798,7 +11155,7 @@
10798
11155
  },
10799
11156
  "x-original-maxLength": 256,
10800
11157
  "x-reconciled-from-discovery": true,
10801
- "x-reconciled-at": "2026-01-05T18:30:13.961042+00:00"
11158
+ "x-reconciled-at": "2026-01-07T15:29:46.445464+00:00"
10802
11159
  },
10803
11160
  "value": {
10804
11161
  "type": "string",
@@ -10823,7 +11180,7 @@
10823
11180
  },
10824
11181
  "x-original-maxLength": 256,
10825
11182
  "x-reconciled-from-discovery": true,
10826
- "x-reconciled-at": "2026-01-05T18:30:13.961048+00:00"
11183
+ "x-reconciled-at": "2026-01-07T15:29:46.445468+00:00"
10827
11184
  }
10828
11185
  },
10829
11186
  "x-f5xc-minimum-configuration": {
@@ -10876,9 +11233,10 @@
10876
11233
  },
10877
11234
  "x-original-maxLength": 1024,
10878
11235
  "x-reconciled-from-discovery": true,
10879
- "x-reconciled-at": "2026-01-05T18:30:13.961055+00:00"
11236
+ "x-reconciled-at": "2026-01-07T15:29:46.445475+00:00"
10880
11237
  }
10881
11238
  },
11239
+ "x-f5xc-description-short": "Ephemeral storage volume configuration for the workload.",
10882
11240
  "x-f5xc-minimum-configuration": {
10883
11241
  "description": "Minimum configuration for workloadEphemeralStorageVolumeType",
10884
11242
  "required_fields": [
@@ -10928,6 +11286,8 @@
10928
11286
  "ves.io.schema.rules.repeated.max_items": "16",
10929
11287
  "ves.io.schema.rules.repeated.unique": "true"
10930
11288
  },
11289
+ "x-f5xc-description-short": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem.",
11290
+ "x-f5xc-description-medium": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to...",
10931
11291
  "x-f5xc-required-for": {
10932
11292
  "minimum_config": false,
10933
11293
  "create": false,
@@ -10936,6 +11296,8 @@
10936
11296
  }
10937
11297
  }
10938
11298
  },
11299
+ "x-f5xc-description-short": "ExecHealthCheckType describes a health check based on \"run in container\" action.",
11300
+ "x-f5xc-description-medium": "ExecHealthCheckType describes a health check based on \"run in container\" action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
10939
11301
  "x-f5xc-minimum-configuration": {
10940
11302
  "description": "Health check configuration for monitoring origin servers",
10941
11303
  "required_fields": [
@@ -10977,6 +11339,7 @@
10977
11339
  "$ref": "#/components/schemas/ioschemaObjectRefType"
10978
11340
  },
10979
11341
  "x-displayname": "Deleted Referred Objects.",
11342
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
10980
11343
  "x-f5xc-required-for": {
10981
11344
  "minimum_config": false,
10982
11345
  "create": false,
@@ -10992,6 +11355,7 @@
10992
11355
  "$ref": "#/components/schemas/ioschemaObjectRefType"
10993
11356
  },
10994
11357
  "x-displayname": "Disabled Referred Objects.",
11358
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
10995
11359
  "x-f5xc-required-for": {
10996
11360
  "minimum_config": false,
10997
11361
  "create": false,
@@ -11010,6 +11374,7 @@
11010
11374
  "$ref": "#/components/schemas/ioschemaObjectRefType"
11011
11375
  },
11012
11376
  "x-displayname": "Referring Objects.",
11377
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
11013
11378
  "x-f5xc-required-for": {
11014
11379
  "minimum_config": false,
11015
11380
  "create": false,
@@ -11031,6 +11396,8 @@
11031
11396
  "$ref": "#/components/schemas/workloadStatusObject"
11032
11397
  },
11033
11398
  "x-displayname": "Status",
11399
+ "x-f5xc-example": "active",
11400
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
11034
11401
  "x-f5xc-required-for": {
11035
11402
  "minimum_config": false,
11036
11403
  "create": false,
@@ -11040,7 +11407,7 @@
11040
11407
  "maxLength": 17,
11041
11408
  "minLength": 17,
11042
11409
  "x-reconciled-from-discovery": true,
11043
- "x-reconciled-at": "2026-01-05T18:30:13.961072+00:00"
11410
+ "x-reconciled-at": "2026-01-07T15:29:46.445491+00:00"
11044
11411
  },
11045
11412
  "system_metadata": {
11046
11413
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -11080,6 +11447,8 @@
11080
11447
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
11081
11448
  ],
11082
11449
  "default": "GET_RSP_FORMAT_DEFAULT",
11450
+ "x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
11451
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
11083
11452
  "x-f5xc-minimum-configuration": {
11084
11453
  "description": "Minimum configuration for workloadGetResponseFormatCode",
11085
11454
  "required_fields": [],
@@ -11118,6 +11487,8 @@
11118
11487
  "ves.io.schema.rules.map.values.string.max_len": "2048",
11119
11488
  "ves.io.schema.rules.map.values.string.min_len": "1"
11120
11489
  },
11490
+ "x-f5xc-description-short": "Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container.",
11491
+ "x-f5xc-description-medium": "Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs.",
11121
11492
  "x-f5xc-required-for": {
11122
11493
  "minimum_config": false,
11123
11494
  "create": false,
@@ -11141,6 +11512,7 @@
11141
11512
  "ves.io.schema.rules.string.hostport": "true",
11142
11513
  "ves.io.schema.rules.string.max_len": "262"
11143
11514
  },
11515
+ "x-f5xc-description-short": "The value of the host header in the HTTP health check request.",
11144
11516
  "minLength": 0,
11145
11517
  "x-f5xc-required-for": {
11146
11518
  "minimum_config": false,
@@ -11168,6 +11540,7 @@
11168
11540
  "ves.io.schema.rules.string.http_path": "true",
11169
11541
  "ves.io.schema.rules.string.max_len": "2048"
11170
11542
  },
11543
+ "x-f5xc-description-short": "Path to access on the HTTP server. Required: YES.",
11171
11544
  "minLength": 0,
11172
11545
  "x-f5xc-required-for": {
11173
11546
  "minimum_config": false,
@@ -11180,6 +11553,7 @@
11180
11553
  "$ref": "#/components/schemas/workloadPortChoiceType"
11181
11554
  }
11182
11555
  },
11556
+ "x-f5xc-description-short": "HTTPHealthCheckType describes a health check based on HTTP GET requests.",
11183
11557
  "x-f5xc-minimum-configuration": {
11184
11558
  "description": "Health check configuration for monitoring origin servers",
11185
11559
  "required_fields": [
@@ -11248,6 +11622,8 @@
11248
11622
  "ves.io.schema.rules.repeated.min_items": "1",
11249
11623
  "ves.io.schema.rules.repeated.unique": "true"
11250
11624
  },
11625
+ "x-f5xc-description-short": "List of domains (host/authority header) that will be matched to loadbalancer.",
11626
+ "x-f5xc-description-medium": "List of domains (host/authority header) that will be matched to loadbalancer. Wildcard hosts are supported in the suffix or prefix form Domain search order: 1. Exact domain names: `` is invalid Domains are also used for SNI matching if the loadbalancer type is HTTPS Domains also indicate the...",
11251
11627
  "x-f5xc-required-for": {
11252
11628
  "minimum_config": false,
11253
11629
  "create": false,
@@ -11315,6 +11691,8 @@
11315
11691
  "ves.io.schema.rules.uint32.gte": "1",
11316
11692
  "ves.io.schema.rules.uint32.lte": "16"
11317
11693
  },
11694
+ "x-f5xc-description-short": "Number of consecutive successful responses after having failed before declaring healthy.",
11695
+ "x-f5xc-description-medium": "Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container...",
11318
11696
  "minimum": 0,
11319
11697
  "maximum": 2147483647,
11320
11698
  "x-f5xc-required-for": {
@@ -11341,6 +11719,7 @@
11341
11719
  "x-validation-rules": {
11342
11720
  "ves.io.schema.rules.uint32.lte": "600"
11343
11721
  },
11722
+ "x-f5xc-description-short": "Number of seconds after the container has started before health checks are initiated.",
11344
11723
  "minimum": 0,
11345
11724
  "maximum": 2147483647,
11346
11725
  "x-f5xc-required-for": {
@@ -11369,6 +11748,7 @@
11369
11748
  "ves.io.schema.rules.uint32.gte": "1",
11370
11749
  "ves.io.schema.rules.uint32.lte": "600"
11371
11750
  },
11751
+ "x-f5xc-description-short": "Time interval in seconds between two health check requests. Required: YES.",
11372
11752
  "minimum": 0,
11373
11753
  "maximum": 2147483647,
11374
11754
  "x-f5xc-required-for": {
@@ -11400,6 +11780,8 @@
11400
11780
  "ves.io.schema.rules.uint32.gte": "1",
11401
11781
  "ves.io.schema.rules.uint32.lte": "600"
11402
11782
  },
11783
+ "x-f5xc-description-short": "Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response.",
11784
+ "x-f5xc-description-medium": "Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure.",
11403
11785
  "minimum": 0,
11404
11786
  "maximum": 2147483647,
11405
11787
  "x-f5xc-required-for": {
@@ -11428,6 +11810,8 @@
11428
11810
  "ves.io.schema.rules.uint32.gte": "1",
11429
11811
  "ves.io.schema.rules.uint32.lte": "16"
11430
11812
  },
11813
+ "x-f5xc-description-short": "Number of consecutive failed responses before declaring unhealthy.",
11814
+ "x-f5xc-description-medium": "Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy. Required: YES.",
11431
11815
  "minimum": 0,
11432
11816
  "maximum": 2147483647,
11433
11817
  "x-f5xc-required-for": {
@@ -11438,6 +11822,8 @@
11438
11822
  }
11439
11823
  }
11440
11824
  },
11825
+ "x-f5xc-description-short": "HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to...",
11826
+ "x-f5xc-description-medium": "HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic.",
11441
11827
  "x-f5xc-minimum-configuration": {
11442
11828
  "description": "Health check configuration for monitoring origin servers",
11443
11829
  "required_fields": [
@@ -11490,6 +11876,7 @@
11490
11876
  "ves.io.schema.rules.string.max_len": "256",
11491
11877
  "ves.io.schema.rules.string.pattern": "[^\\\\0]+"
11492
11878
  },
11879
+ "x-f5xc-description-short": "Path of the directory on the host Required: YES.",
11493
11880
  "minLength": 0,
11494
11881
  "x-f5xc-required-for": {
11495
11882
  "minimum_config": false,
@@ -11499,6 +11886,7 @@
11499
11886
  }
11500
11887
  }
11501
11888
  },
11889
+ "x-f5xc-description-short": "Volume containing a host mapped path into the workload.",
11502
11890
  "x-f5xc-minimum-configuration": {
11503
11891
  "description": "Minimum configuration for workloadHostPathVolumeType",
11504
11892
  "required_fields": [
@@ -11558,6 +11946,8 @@
11558
11946
  "default": "IMAGE_PULL_POLICY_DEFAULT",
11559
11947
  "x-displayname": "Image Pull Policy Type.",
11560
11948
  "x-ves-proto-enum": "ves.io.schema.views.workload.ImagePullPolicyType",
11949
+ "x-f5xc-description-short": "Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload - IMAGE_PULL_POLICY_DEFAULT...",
11950
+ "x-f5xc-description-medium": "Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload - IMAGE_PULL_POLICY_DEFAULT: Default Default will always pull image if :latest tag is specified in image name. If :latest tag is not specified in image name, it will pull image only...",
11561
11951
  "x-f5xc-minimum-configuration": {
11562
11952
  "description": "Minimum configuration for workloadImagePullPolicyType",
11563
11953
  "required_fields": [],
@@ -11596,6 +11986,8 @@
11596
11986
  "ves.io.schema.rules.message.required": "true",
11597
11987
  "ves.io.schema.rules.string.max_len": "256"
11598
11988
  },
11989
+ "x-f5xc-description-short": "Name is a container image which are usually given a name such as alpine, ubuntu, or quay.I/O/etcd:0.13.",
11990
+ "x-f5xc-description-medium": "Name is a container image which are usually given a name such as alpine, ubuntu, or quay.I/O/etcd:0.13. The format is registry/image:tag or registry/image@image-digest. If registry is not specified, the Docker public registry is assumed.",
11599
11991
  "minLength": 0,
11600
11992
  "x-f5xc-required-for": {
11601
11993
  "minimum_config": false,
@@ -11605,7 +11997,7 @@
11605
11997
  },
11606
11998
  "x-original-maxLength": 256,
11607
11999
  "x-reconciled-from-discovery": true,
11608
- "x-reconciled-at": "2026-01-05T18:30:13.961113+00:00"
12000
+ "x-reconciled-at": "2026-01-07T15:29:46.445543+00:00"
11609
12001
  },
11610
12002
  "public": {
11611
12003
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -11614,6 +12006,8 @@
11614
12006
  "$ref": "#/components/schemas/workloadImagePullPolicyType"
11615
12007
  }
11616
12008
  },
12009
+ "x-f5xc-description-short": "ImageType configures the image to use, how to pull the image, and the associated secrets to use if any.",
12010
+ "x-f5xc-description-medium": "ImageType configures the image to use, how to pull the image, and the associated secrets to use if any.",
11617
12011
  "x-f5xc-minimum-configuration": {
11618
12012
  "description": "Minimum configuration for workloadImageType",
11619
12013
  "required_fields": [
@@ -11657,6 +12051,7 @@
11657
12051
  "ves.io.schema.rules.message.required": "true",
11658
12052
  "ves.io.schema.rules.repeated.max_items": "16"
11659
12053
  },
12054
+ "x-f5xc-description-short": "Containers to use for the job Required: YES.",
11660
12055
  "x-f5xc-required-for": {
11661
12056
  "minimum_config": false,
11662
12057
  "create": false,
@@ -11681,6 +12076,7 @@
11681
12076
  "x-validation-rules": {
11682
12077
  "ves.io.schema.rules.int32.lte": "5"
11683
12078
  },
12079
+ "x-f5xc-description-short": "Number of replicas of the batch job to spawn per site.",
11684
12080
  "minimum": 0,
11685
12081
  "maximum": 2147483647,
11686
12082
  "x-f5xc-required-for": {
@@ -11713,6 +12109,8 @@
11713
12109
  }
11714
12110
  }
11715
12111
  },
12112
+ "x-f5xc-description-short": "Jobs are used for running batch processing tasks and run to completion.",
12113
+ "x-f5xc-description-medium": "Jobs are used for running batch processing tasks and run to completion. Jobs are generally used for tasks like report generation, billing, parallel data processing, ETL processing, etc.",
11716
12114
  "x-f5xc-minimum-configuration": {
11717
12115
  "description": "Minimum configuration for workloadJobType",
11718
12116
  "required_fields": [
@@ -11744,6 +12142,7 @@
11744
12142
  "$ref": "#/components/schemas/schemaErrorType"
11745
12143
  },
11746
12144
  "x-displayname": "Errors",
12145
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
11747
12146
  "x-f5xc-required-for": {
11748
12147
  "minimum_config": false,
11749
12148
  "create": false,
@@ -11759,6 +12158,8 @@
11759
12158
  "$ref": "#/components/schemas/workloadListResponseItem"
11760
12159
  },
11761
12160
  "x-displayname": "Items",
12161
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
12162
+ "x-f5xc-description-short": "Items represents the collection in response.",
11762
12163
  "x-f5xc-required-for": {
11763
12164
  "minimum_config": false,
11764
12165
  "create": false,
@@ -11792,6 +12193,8 @@
11792
12193
  "description": "The set of annotations present on this workload.",
11793
12194
  "title": "Annotations.",
11794
12195
  "x-displayname": "Annotations.",
12196
+ "x-f5xc-example": "{\"key\": \"value\"}",
12197
+ "x-f5xc-description-short": "The set of annotations present on this workload.",
11795
12198
  "x-f5xc-required-for": {
11796
12199
  "minimum_config": false,
11797
12200
  "create": false,
@@ -11814,7 +12217,7 @@
11814
12217
  },
11815
12218
  "x-original-maxLength": 1024,
11816
12219
  "x-reconciled-from-discovery": true,
11817
- "x-reconciled-at": "2026-01-05T18:30:13.961133+00:00"
12220
+ "x-reconciled-at": "2026-01-07T15:29:46.445562+00:00"
11818
12221
  },
11819
12222
  "disabled": {
11820
12223
  "type": "boolean",
@@ -11822,6 +12225,8 @@
11822
12225
  "title": "Disabled",
11823
12226
  "format": "boolean",
11824
12227
  "x-displayname": "Disabled",
12228
+ "x-f5xc-example": "True",
12229
+ "x-f5xc-description-short": "Value of true indicates workload is administratively disabled.",
11825
12230
  "x-f5xc-required-for": {
11826
12231
  "minimum_config": false,
11827
12232
  "create": false,
@@ -11837,6 +12242,8 @@
11837
12242
  "description": "The set of labels present on this workload.",
11838
12243
  "title": "Labels",
11839
12244
  "x-displayname": "Labels",
12245
+ "x-f5xc-example": "{\"key\": \"value\"}",
12246
+ "x-f5xc-description-short": "The set of labels present on this workload.",
11840
12247
  "x-f5xc-required-for": {
11841
12248
  "minimum_config": false,
11842
12249
  "create": false,
@@ -11864,7 +12271,7 @@
11864
12271
  },
11865
12272
  "x-original-maxLength": 1024,
11866
12273
  "x-reconciled-from-discovery": true,
11867
- "x-reconciled-at": "2026-01-05T18:30:13.961143+00:00"
12274
+ "x-reconciled-at": "2026-01-07T15:29:46.445572+00:00"
11868
12275
  },
11869
12276
  "namespace": {
11870
12277
  "type": "string",
@@ -11883,7 +12290,7 @@
11883
12290
  },
11884
12291
  "x-original-maxLength": 1024,
11885
12292
  "x-reconciled-from-discovery": true,
11886
- "x-reconciled-at": "2026-01-05T18:30:13.961147+00:00"
12293
+ "x-reconciled-at": "2026-01-07T15:29:46.445576+00:00"
11887
12294
  },
11888
12295
  "owner_view": {
11889
12296
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -11896,6 +12303,7 @@
11896
12303
  "$ref": "#/components/schemas/workloadStatusObject"
11897
12304
  },
11898
12305
  "x-displayname": "Status",
12306
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
11899
12307
  "x-f5xc-required-for": {
11900
12308
  "minimum_config": false,
11901
12309
  "create": false,
@@ -11924,7 +12332,7 @@
11924
12332
  "x-field-mutability": "read-only",
11925
12333
  "x-original-maxLength": 1024,
11926
12334
  "x-reconciled-from-discovery": true,
11927
- "x-reconciled-at": "2026-01-05T18:30:13.961155+00:00"
12335
+ "x-reconciled-at": "2026-01-07T15:29:46.445583+00:00"
11928
12336
  },
11929
12337
  "uid": {
11930
12338
  "type": "string",
@@ -11945,9 +12353,11 @@
11945
12353
  "x-original-maxLength": 1024,
11946
12354
  "format": "uuid",
11947
12355
  "x-reconciled-from-discovery": true,
11948
- "x-reconciled-at": "2026-01-05T18:30:13.961161+00:00"
12356
+ "x-reconciled-at": "2026-01-07T15:29:46.445588+00:00"
11949
12357
  }
11950
12358
  },
12359
+ "x-f5xc-description-short": "By default a summary of workload is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
12360
+ "x-f5xc-description-medium": "By default a summary of workload is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
11951
12361
  "x-f5xc-minimum-configuration": {
11952
12362
  "description": "Minimum configuration for workloadListResponseItem",
11953
12363
  "required_fields": [
@@ -11999,6 +12409,8 @@
11999
12409
  "x-validation-rules": {
12000
12410
  "ves.io.schema.rules.string.hostname": "true"
12001
12411
  },
12412
+ "x-f5xc-description-short": "Exclusive with [auto_host_rewrite disable_host_rewrite] Host header will be swapped with this value.",
12413
+ "x-f5xc-description-medium": "Exclusive with [auto_host_rewrite disable_host_rewrite] Host header will be swapped with this value.",
12002
12414
  "minLength": 0,
12003
12415
  "maxLength": 1024,
12004
12416
  "x-f5xc-required-for": {
@@ -12080,6 +12492,8 @@
12080
12492
  "default": "ACCESS_MODE_READ_WRITE_ONCE",
12081
12493
  "x-displayname": "Persistent Storage Access Mode.",
12082
12494
  "x-ves-proto-enum": "ves.io.schema.views.workload.PersistentStorageAccessModeType",
12495
+ "x-f5xc-description-short": "Persistence storage access mode is used to configure access mode for persistent storage - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once Read Write...",
12496
+ "x-f5xc-description-medium": "Persistence storage access mode is used to configure access mode for persistent storage - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once Read Write Once is used to mount persistent storage in read/write mode to exactly 1 host - ACCESS_MODE_READ_WRITE_MANY: Read Write Many Read Write Many is used...",
12083
12497
  "x-f5xc-minimum-configuration": {
12084
12498
  "description": "Minimum configuration for workloadPersistentStorageAccessModeType",
12085
12499
  "required_fields": [],
@@ -12114,6 +12528,8 @@
12114
12528
  "x-validation-rules": {
12115
12529
  "ves.io.schema.rules.string.max_len": "256"
12116
12530
  },
12531
+ "x-f5xc-example": "example-resource",
12532
+ "x-f5xc-description-short": "Exclusive with [default] Use the specified class name.",
12117
12533
  "minLength": 0,
12118
12534
  "x-f5xc-required-for": {
12119
12535
  "minimum_config": false,
@@ -12144,6 +12560,7 @@
12144
12560
  "ves.io.schema.rules.double.lte": "256",
12145
12561
  "ves.io.schema.rules.message.required": "true"
12146
12562
  },
12563
+ "x-f5xc-description-short": "Size in GiB of the persistent storage Required: YES.",
12147
12564
  "x-f5xc-required-for": {
12148
12565
  "minimum_config": false,
12149
12566
  "create": false,
@@ -12152,6 +12569,7 @@
12152
12569
  }
12153
12570
  }
12154
12571
  },
12572
+ "x-f5xc-description-short": "Persistent storage configuration is used to configure Persistent Volume Claim (PVC).",
12155
12573
  "x-f5xc-minimum-configuration": {
12156
12574
  "description": "Minimum configuration for workloadPersistentStorageType",
12157
12575
  "required_fields": [
@@ -12181,6 +12599,7 @@
12181
12599
  "$ref": "#/components/schemas/workloadPersistentStorageType"
12182
12600
  }
12183
12601
  },
12602
+ "x-f5xc-description-short": "Volume containing the Persistent Storage for the workload.",
12184
12603
  "x-f5xc-minimum-configuration": {
12185
12604
  "description": "Minimum configuration for workloadPersistentStorageVolumeType",
12186
12605
  "required_fields": [
@@ -12227,12 +12646,13 @@
12227
12646
  },
12228
12647
  "x-original-maxLength": 1024,
12229
12648
  "x-reconciled-from-discovery": true,
12230
- "x-reconciled-at": "2026-01-05T18:30:13.961180+00:00"
12649
+ "x-reconciled-at": "2026-01-07T15:29:46.445607+00:00"
12231
12650
  },
12232
12651
  "persistent_volume": {
12233
12652
  "$ref": "#/components/schemas/workloadPersistentStorageVolumeType"
12234
12653
  }
12235
12654
  },
12655
+ "x-f5xc-description-short": "Persistent storage volume configuration for the workload.",
12236
12656
  "x-f5xc-minimum-configuration": {
12237
12657
  "description": "Minimum configuration for workloadPersistentVolumeType",
12238
12658
  "required_fields": [
@@ -12276,7 +12696,7 @@
12276
12696
  },
12277
12697
  "x-original-maxLength": 1024,
12278
12698
  "x-reconciled-from-discovery": true,
12279
- "x-reconciled-at": "2026-01-05T18:30:13.961186+00:00"
12699
+ "x-reconciled-at": "2026-01-07T15:29:46.445613+00:00"
12280
12700
  },
12281
12701
  "num": {
12282
12702
  "type": "integer",
@@ -12343,6 +12763,7 @@
12343
12763
  "ves.io.schema.rules.uint32.gt": "0",
12344
12764
  "ves.io.schema.rules.uint32.lte": "65535"
12345
12765
  },
12766
+ "x-f5xc-description-short": "Port the workload can be reached on Required: YES.",
12346
12767
  "minimum": 1,
12347
12768
  "maximum": 65535,
12348
12769
  "x-f5xc-required-for": {
@@ -12372,6 +12793,7 @@
12372
12793
  "ves.io.schema.rules.uint32.gt": "0",
12373
12794
  "ves.io.schema.rules.uint32.lte": "65535"
12374
12795
  },
12796
+ "x-f5xc-description-short": "Exclusive with [same_as_port] Port the workload is listening on.",
12375
12797
  "minimum": 0,
12376
12798
  "maximum": 2147483647,
12377
12799
  "x-f5xc-required-for": {
@@ -12434,7 +12856,7 @@
12434
12856
  },
12435
12857
  "x-original-maxLength": 1024,
12436
12858
  "x-reconciled-from-discovery": true,
12437
- "x-reconciled-at": "2026-01-05T18:30:13.961199+00:00"
12859
+ "x-reconciled-at": "2026-01-07T15:29:46.445626+00:00"
12438
12860
  }
12439
12861
  },
12440
12862
  "x-f5xc-minimum-configuration": {
@@ -12511,6 +12933,7 @@
12511
12933
  "$ref": "#/components/schemas/http_loadbalancerRouteTypeSimpleWithDefaultOriginPool"
12512
12934
  }
12513
12935
  },
12936
+ "x-f5xc-description-short": "Defines various OPTIONS to define a route.",
12514
12937
  "x-f5xc-minimum-configuration": {
12515
12938
  "description": "Minimum configuration for workloadRouteInfoType",
12516
12939
  "required_fields": [
@@ -12556,6 +12979,7 @@
12556
12979
  "title": "Scale down to zero.",
12557
12980
  "format": "boolean",
12558
12981
  "x-displayname": "Scale Down to Zero.",
12982
+ "x-f5xc-description-short": "Scale down replicas of the service to zero.",
12559
12983
  "x-f5xc-required-for": {
12560
12984
  "minimum_config": false,
12561
12985
  "create": false,
@@ -12567,6 +12991,8 @@
12567
12991
  "$ref": "#/components/schemas/workloadAdvertiseSimpleServiceType"
12568
12992
  }
12569
12993
  },
12994
+ "x-f5xc-description-short": "SimpleService is a service having one container and one replica that is deployed on all Regional Edges and advertised on Internet via HTTP...",
12995
+ "x-f5xc-description-medium": "SimpleService is a service having one container and one replica that is deployed on all Regional Edges and advertised on Internet via HTTP loadbalancer on default VIP.",
12570
12996
  "x-f5xc-minimum-configuration": {
12571
12997
  "description": "Minimum configuration for workloadSimpleServiceType",
12572
12998
  "required_fields": [
@@ -12640,6 +13066,7 @@
12640
13066
  "ves.io.schema.rules.message.required": "true",
12641
13067
  "ves.io.schema.rules.repeated.max_items": "16"
12642
13068
  },
13069
+ "x-f5xc-description-short": "Containers to use for service Required: YES.",
12643
13070
  "x-f5xc-required-for": {
12644
13071
  "minimum_config": false,
12645
13072
  "create": false,
@@ -12666,6 +13093,7 @@
12666
13093
  "ves.io.schema.rules.int32.gt": "0",
12667
13094
  "ves.io.schema.rules.int32.lte": "5"
12668
13095
  },
13096
+ "x-f5xc-description-short": "Exclusive with [scale_to_zero] Number of replicas of service to spawn per site.",
12669
13097
  "minimum": 0,
12670
13098
  "maximum": 2147483647,
12671
13099
  "x-f5xc-required-for": {
@@ -12693,6 +13121,7 @@
12693
13121
  "ves.io.schema.rules.message.required": "true",
12694
13122
  "ves.io.schema.rules.repeated.max_items": "16"
12695
13123
  },
13124
+ "x-f5xc-description-short": "Persistent storage configuration for the service Required: YES.",
12696
13125
  "x-f5xc-required-for": {
12697
13126
  "minimum_config": false,
12698
13127
  "create": false,
@@ -12726,6 +13155,8 @@
12726
13155
  }
12727
13156
  }
12728
13157
  },
13158
+ "x-f5xc-description-short": "StatefulService maintains per replica state and each replica has its own persistent storage.",
13159
+ "x-f5xc-description-medium": "StatefulService maintains per replica state and each replica has its own persistent storage. Each replica has a unique network identity and stable storage. Stateful service are used for distributed stateful applications like cassandra, mongodb, redis, etc.",
12729
13160
  "x-f5xc-minimum-configuration": {
12730
13161
  "description": "Minimum configuration for workloadStatefulServiceType",
12731
13162
  "required_fields": [
@@ -12801,6 +13232,7 @@
12801
13232
  }
12802
13233
  }
12803
13234
  },
13235
+ "x-f5xc-description-short": "Most recently observed status of the workload.",
12804
13236
  "x-f5xc-minimum-configuration": {
12805
13237
  "description": "Minimum configuration for workloadStatusObject",
12806
13238
  "required_fields": [
@@ -12853,12 +13285,13 @@
12853
13285
  },
12854
13286
  "x-original-maxLength": 1024,
12855
13287
  "x-reconciled-from-discovery": true,
12856
- "x-reconciled-at": "2026-01-05T18:30:13.961240+00:00"
13288
+ "x-reconciled-at": "2026-01-07T15:29:46.445664+00:00"
12857
13289
  },
12858
13290
  "persistent_volume": {
12859
13291
  "$ref": "#/components/schemas/workloadPersistentStorageVolumeType"
12860
13292
  }
12861
13293
  },
13294
+ "x-f5xc-description-short": "Storage volume configuration for the workload.",
12862
13295
  "x-f5xc-minimum-configuration": {
12863
13296
  "description": "Minimum configuration for workloadStorageVolumeType",
12864
13297
  "required_fields": [
@@ -12885,6 +13318,7 @@
12885
13318
  "$ref": "#/components/schemas/workloadPortChoiceType"
12886
13319
  }
12887
13320
  },
13321
+ "x-f5xc-description-short": "TCPHealthCheckType describes a health check based on opening a TCP connection.",
12888
13322
  "x-f5xc-minimum-configuration": {
12889
13323
  "description": "Health check configuration for monitoring origin servers",
12890
13324
  "required_fields": [
@@ -12936,6 +13370,8 @@
12936
13370
  "ves.io.schema.rules.repeated.max_items": "32",
12937
13371
  "ves.io.schema.rules.repeated.unique": "true"
12938
13372
  },
13373
+ "x-f5xc-description-short": "List of additional domains (host/authority header) that will be matched to this loadbalancer.",
13374
+ "x-f5xc-description-medium": "List of additional domains (host/authority header) that will be matched to this loadbalancer. Domains are also used for SNI matching if the is true Domains also indicate the list of names for which DNS resolution will be done by VER.",
12939
13375
  "x-f5xc-required-for": {
12940
13376
  "minimum_config": false,
12941
13377
  "create": false,
@@ -12951,6 +13387,7 @@
12951
13387
  "x-displayname": "With SNI",
12952
13388
  "x-ves-example": "True",
12953
13389
  "x-f5xc-example": "true",
13390
+ "x-f5xc-description-short": "Set to true to enable TCP loadbalancer with SNI.",
12954
13391
  "x-f5xc-required-for": {
12955
13392
  "minimum_config": false,
12956
13393
  "create": false,
@@ -12987,6 +13424,7 @@
12987
13424
  "$ref": "#/components/schemas/workloadUsageTypeData"
12988
13425
  },
12989
13426
  "x-displayname": "Data",
13427
+ "x-f5xc-example": "{\"key\": \"value\"}",
12990
13428
  "x-f5xc-required-for": {
12991
13429
  "minimum_config": false,
12992
13430
  "create": false,
@@ -13001,6 +13439,7 @@
13001
13439
  "$ref": "#/components/schemas/schemaUnitType"
13002
13440
  }
13003
13441
  },
13442
+ "x-f5xc-description-short": "Usage data contains the usage type and the corresponding metric.",
13004
13443
  "x-f5xc-minimum-configuration": {
13005
13444
  "description": "Minimum configuration for workloadUsageData",
13006
13445
  "required_fields": [
@@ -13059,6 +13498,8 @@
13059
13498
  "x-validation-rules": {
13060
13499
  "ves.io.schema.rules.string.query_time": "true"
13061
13500
  },
13501
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
13502
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
13062
13503
  "minLength": 0,
13063
13504
  "maxLength": 1024,
13064
13505
  "x-f5xc-required-for": {
@@ -13091,6 +13532,8 @@
13091
13532
  "ves.io.schema.rules.repeated.min_items": "1",
13092
13533
  "ves.io.schema.rules.repeated.unique": "true"
13093
13534
  },
13535
+ "x-f5xc-description-short": "Select fields to be returned in the response. One or more fields in {CPU_USAGE, MEMORY_USAGE, DISK_READS, DISK_WRITES} can be specified.",
13536
+ "x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {CPU_USAGE, MEMORY_USAGE, DISK_READS, DISK_WRITES} can be specified. Required: YES.",
13094
13537
  "x-f5xc-required-for": {
13095
13538
  "minimum_config": false,
13096
13539
  "create": false,
@@ -13105,6 +13548,8 @@
13105
13548
  "x-displayname": "Filter",
13106
13549
  "x-ves-example": "{POD=\\\"pod-1\\\"}",
13107
13550
  "x-f5xc-example": "\"{POD=\\\"pod-1\\\"}\"",
13551
+ "x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
13552
+ "x-f5xc-description-medium": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in UsageLabel {CONTAINER, POD, SITE} can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = ...",
13108
13553
  "minLength": 0,
13109
13554
  "maxLength": 1024,
13110
13555
  "x-f5xc-required-for": {
@@ -13122,6 +13567,7 @@
13122
13567
  "$ref": "#/components/schemas/workloadUsageLabel"
13123
13568
  },
13124
13569
  "x-displayname": "Group By",
13570
+ "x-f5xc-description-short": "Aggregate data by zero or more labels {NAMESPACE, CONTAINER, POD, SITE}.",
13125
13571
  "x-f5xc-required-for": {
13126
13572
  "minimum_config": false,
13127
13573
  "create": false,
@@ -13135,6 +13581,8 @@
13135
13581
  "title": "Include System Workloads.",
13136
13582
  "format": "boolean",
13137
13583
  "x-displayname": "Include System Workloads.",
13584
+ "x-f5xc-description-short": "Allows user to specify if the usage of system workloads (such as pods running in F5 Distributed Cloud namespaces and the Kubernetes pods) should...",
13585
+ "x-f5xc-description-medium": "Allows user to specify if the usage of system workloads (such as pods running in F5 Distributed Cloud namespaces and the Kubernetes pods) should be included in the response. This field is applicable only in the namespace where the response contains data across all namespaces. Optional: If not...",
13138
13586
  "x-f5xc-required-for": {
13139
13587
  "minimum_config": false,
13140
13588
  "create": false,
@@ -13149,6 +13597,7 @@
13149
13597
  "x-displayname": "Namespace",
13150
13598
  "x-ves-example": "Ns1",
13151
13599
  "x-f5xc-example": "ns1",
13600
+ "x-f5xc-description-short": "Namespace is used to scope the workload usage to a given namespace.",
13152
13601
  "minLength": 0,
13153
13602
  "maxLength": 6,
13154
13603
  "x-f5xc-required-for": {
@@ -13159,7 +13608,7 @@
13159
13608
  },
13160
13609
  "x-original-maxLength": 1024,
13161
13610
  "x-reconciled-from-discovery": true,
13162
- "x-reconciled-at": "2026-01-05T18:30:13.961263+00:00"
13611
+ "x-reconciled-at": "2026-01-07T15:29:46.445685+00:00"
13163
13612
  },
13164
13613
  "range": {
13165
13614
  "type": "string",
@@ -13174,6 +13623,8 @@
13174
13623
  "x-validation-rules": {
13175
13624
  "ves.io.schema.rules.string.time_interval": "true"
13176
13625
  },
13626
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
13627
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
13177
13628
  "minLength": 0,
13178
13629
  "maxLength": 1024,
13179
13630
  "x-f5xc-required-for": {
@@ -13196,6 +13647,8 @@
13196
13647
  "x-validation-rules": {
13197
13648
  "ves.io.schema.rules.string.query_time": "true"
13198
13649
  },
13650
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
13651
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
13199
13652
  "minLength": 0,
13200
13653
  "maxLength": 1024,
13201
13654
  "x-f5xc-required-for": {
@@ -13218,6 +13671,8 @@
13218
13671
  "x-validation-rules": {
13219
13672
  "ves.io.schema.rules.string.query_step": "true"
13220
13673
  },
13674
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
13675
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
13221
13676
  "minLength": 0,
13222
13677
  "maxLength": 1024,
13223
13678
  "x-f5xc-required-for": {
@@ -13228,6 +13683,7 @@
13228
13683
  }
13229
13684
  }
13230
13685
  },
13686
+ "x-f5xc-description-short": "Request to GET workload usage in the given namespace.",
13231
13687
  "x-f5xc-minimum-configuration": {
13232
13688
  "description": "Minimum configuration for workloadUsageRequest",
13233
13689
  "required_fields": [
@@ -13263,6 +13719,8 @@
13263
13719
  "$ref": "#/components/schemas/workloadUsageData"
13264
13720
  },
13265
13721
  "x-displayname": "Data",
13722
+ "x-f5xc-example": "{\"key\": \"value\"}",
13723
+ "x-f5xc-description-short": "Data contains time-series data for the workload usage.",
13266
13724
  "x-f5xc-required-for": {
13267
13725
  "minimum_config": false,
13268
13726
  "create": false,
@@ -13283,6 +13741,8 @@
13283
13741
  "x-validation-rules": {
13284
13742
  "ves.io.schema.rules.string.time_interval": "true"
13285
13743
  },
13744
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
13745
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
13286
13746
  "minLength": 0,
13287
13747
  "maxLength": 1024,
13288
13748
  "x-f5xc-required-for": {
@@ -13319,6 +13779,8 @@
13319
13779
  "default": "CPU_USAGE",
13320
13780
  "x-displayname": "Usage Type.",
13321
13781
  "x-ves-proto-enum": "ves.io.schema.views.workload.UsageType",
13782
+ "x-f5xc-description-short": "List of usage types that can be queried x-unit: \"Number of cores\" x-unit: \"Bytes\" x-unit: \"Bytes per second\" x-unit: \"Bytes per second\".",
13783
+ "x-f5xc-description-medium": "List of usage types that can be queried x-unit: \"Number of cores\" x-unit: \"Bytes\" x-unit: \"Bytes per second\" x-unit: \"Bytes per second\".",
13322
13784
  "x-f5xc-minimum-configuration": {
13323
13785
  "description": "Minimum configuration for workloadUsageType",
13324
13786
  "required_fields": [],
@@ -13341,6 +13803,8 @@
13341
13803
  "description": "Key contains the name/value pair.\n\"name\" is the label name defined in \"UsageLabel\"",
13342
13804
  "title": "Key",
13343
13805
  "x-displayname": "Key",
13806
+ "x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
13807
+ "x-f5xc-description-short": "Key contains the name/value pair. \"name\" is the label name defined in \"UsageLabel\".",
13344
13808
  "x-f5xc-required-for": {
13345
13809
  "minimum_config": false,
13346
13810
  "create": false,
@@ -13350,7 +13814,7 @@
13350
13814
  "maxLength": 16,
13351
13815
  "minLength": 7,
13352
13816
  "x-reconciled-from-discovery": true,
13353
- "x-reconciled-at": "2026-01-05T18:30:13.961276+00:00"
13817
+ "x-reconciled-at": "2026-01-07T15:29:46.445698+00:00"
13354
13818
  },
13355
13819
  "value": {
13356
13820
  "type": "array",
@@ -13369,9 +13833,11 @@
13369
13833
  "maxLength": 15,
13370
13834
  "minLength": 3,
13371
13835
  "x-reconciled-from-discovery": true,
13372
- "x-reconciled-at": "2026-01-05T18:30:13.961282+00:00"
13836
+ "x-reconciled-at": "2026-01-07T15:29:46.445704+00:00"
13373
13837
  }
13374
13838
  },
13839
+ "x-f5xc-description-short": "Usage Type Data contains key/value pair that uniquely identifies a workload in the response and the corresponding metric data.",
13840
+ "x-f5xc-description-medium": "Usage Type Data contains key/value pair that uniquely identifies a workload in the response and the corresponding metric data.",
13375
13841
  "x-f5xc-minimum-configuration": {
13376
13842
  "description": "Minimum configuration for workloadUsageTypeData",
13377
13843
  "required_fields": [
@@ -13396,6 +13862,8 @@
13396
13862
  "default": "VOLUME_MOUNT_READ_ONLY",
13397
13863
  "x-displayname": "Mode",
13398
13864
  "x-ves-proto-enum": "ves.io.schema.views.workload.VolumeMountModeType",
13865
+ "x-f5xc-description-short": "Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode ...",
13866
+ "x-f5xc-description-medium": "Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode.",
13399
13867
  "x-f5xc-minimum-configuration": {
13400
13868
  "description": "Minimum configuration for workloadVolumeMountModeType",
13401
13869
  "required_fields": [],
@@ -13435,6 +13903,8 @@
13435
13903
  "ves.io.schema.rules.string.max_len": "256",
13436
13904
  "ves.io.schema.rules.string.pattern": "^[^:]*$"
13437
13905
  },
13906
+ "x-f5xc-description-short": "Path within the workload container at which the volume should be mounted. Must not contain ':'.",
13907
+ "x-f5xc-description-medium": "Path within the workload container at which the volume should be mounted. Must not contain ':'. Required: YES.",
13438
13908
  "minLength": 0,
13439
13909
  "x-f5xc-required-for": {
13440
13910
  "minimum_config": false,
@@ -13457,6 +13927,8 @@
13457
13927
  "x-validation-rules": {
13458
13928
  "ves.io.schema.rules.string.max_len": "256"
13459
13929
  },
13930
+ "x-f5xc-description-short": "Path within the volume from which the workload's volume should be mounted. Defaults to \"\" (volume's root).",
13931
+ "x-f5xc-description-medium": "Path within the volume from which the workload's volume should be mounted. Defaults to \"\" (volume's root).",
13460
13932
  "minLength": 0,
13461
13933
  "x-f5xc-required-for": {
13462
13934
  "minimum_config": false,
@@ -13466,6 +13938,7 @@
13466
13938
  }
13467
13939
  }
13468
13940
  },
13941
+ "x-f5xc-description-short": "Volume mount describes how volume is mounted inside a workload.",
13469
13942
  "x-f5xc-minimum-configuration": {
13470
13943
  "description": "Minimum configuration for workloadVolumeMountType",
13471
13944
  "required_fields": [
@@ -13494,6 +13967,8 @@
13494
13967
  "x-displayname": "Kind",
13495
13968
  "x-ves-example": "Virtual_site.",
13496
13969
  "x-f5xc-example": "virtual_site",
13970
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
13971
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
13497
13972
  "minLength": 0,
13498
13973
  "maxLength": 14,
13499
13974
  "x-f5xc-required-for": {
@@ -13505,7 +13980,7 @@
13505
13980
  "readOnly": true,
13506
13981
  "x-original-maxLength": 1024,
13507
13982
  "x-reconciled-from-discovery": true,
13508
- "x-reconciled-at": "2026-01-05T18:30:14.288113+00:00"
13983
+ "x-reconciled-at": "2026-01-07T15:29:46.860480+00:00"
13509
13984
  },
13510
13985
  "name": {
13511
13986
  "type": "string",
@@ -13514,6 +13989,8 @@
13514
13989
  "x-displayname": "Name",
13515
13990
  "x-ves-example": "Contactus-route.",
13516
13991
  "x-f5xc-example": "contactus-route",
13992
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
13993
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
13517
13994
  "minLength": 0,
13518
13995
  "maxLength": 16,
13519
13996
  "x-f5xc-required-for": {
@@ -13524,7 +14001,7 @@
13524
14001
  },
13525
14002
  "x-original-maxLength": 1024,
13526
14003
  "x-reconciled-from-discovery": true,
13527
- "x-reconciled-at": "2026-01-05T18:30:14.288117+00:00"
14004
+ "x-reconciled-at": "2026-01-07T15:29:46.860484+00:00"
13528
14005
  },
13529
14006
  "namespace": {
13530
14007
  "type": "string",
@@ -13533,6 +14010,8 @@
13533
14010
  "x-displayname": "Namespace",
13534
14011
  "x-ves-example": "Ns1",
13535
14012
  "x-f5xc-example": "ns1",
14013
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
14014
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
13536
14015
  "minLength": 0,
13537
14016
  "maxLength": 6,
13538
14017
  "x-f5xc-required-for": {
@@ -13543,7 +14022,7 @@
13543
14022
  },
13544
14023
  "x-original-maxLength": 1024,
13545
14024
  "x-reconciled-from-discovery": true,
13546
- "x-reconciled-at": "2026-01-05T18:30:14.288121+00:00"
14025
+ "x-reconciled-at": "2026-01-07T15:29:46.860488+00:00"
13547
14026
  },
13548
14027
  "tenant": {
13549
14028
  "type": "string",
@@ -13552,6 +14031,8 @@
13552
14031
  "x-displayname": "Tenant",
13553
14032
  "x-ves-example": "Example-corp.",
13554
14033
  "x-f5xc-example": "example-corp",
14034
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
14035
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
13555
14036
  "minLength": 0,
13556
14037
  "maxLength": 18,
13557
14038
  "x-f5xc-required-for": {
@@ -13564,7 +14045,7 @@
13564
14045
  "x-field-mutability": "read-only",
13565
14046
  "x-original-maxLength": 1024,
13566
14047
  "x-reconciled-from-discovery": true,
13567
- "x-reconciled-at": "2026-01-05T18:30:14.288125+00:00"
14048
+ "x-reconciled-at": "2026-01-07T15:29:46.860493+00:00"
13568
14049
  },
13569
14050
  "uid": {
13570
14051
  "type": "string",
@@ -13573,6 +14054,8 @@
13573
14054
  "x-displayname": "UID",
13574
14055
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
13575
14056
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
14057
+ "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
14058
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
13576
14059
  "minLength": 0,
13577
14060
  "maxLength": 36,
13578
14061
  "x-f5xc-required-for": {
@@ -13586,9 +14069,11 @@
13586
14069
  "x-original-maxLength": 1024,
13587
14070
  "format": "uuid",
13588
14071
  "x-reconciled-from-discovery": true,
13589
- "x-reconciled-at": "2026-01-05T18:30:14.288131+00:00"
14072
+ "x-reconciled-at": "2026-01-07T15:29:46.860499+00:00"
13590
14073
  }
13591
14074
  },
14075
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
14076
+ "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
13592
14077
  "x-f5xc-minimum-configuration": {
13593
14078
  "description": "Minimum configuration for schemaObjectRefType",
13594
14079
  "required_fields": [
@@ -13680,6 +14165,7 @@
13680
14165
  "x-validation-rules": {
13681
14166
  "ves.io.schema.rules.uint32.ranges": "1-6000"
13682
14167
  },
14168
+ "x-f5xc-description-short": "Ephemeral storage in MiB (mebibyte) allocated for the workload_flavor.",
13683
14169
  "minLength": 0,
13684
14170
  "maxLength": 1024,
13685
14171
  "x-f5xc-required-for": {
@@ -13702,6 +14188,7 @@
13702
14188
  "x-validation-rules": {
13703
14189
  "ves.io.schema.rules.uint32.ranges": "1-32768"
13704
14190
  },
14191
+ "x-f5xc-description-short": "Memory in MiB (mebibyte) allocated for the workload_flavor.",
13705
14192
  "minLength": 0,
13706
14193
  "maxLength": 1024,
13707
14194
  "x-f5xc-required-for": {
@@ -13726,6 +14213,7 @@
13726
14213
  "ves.io.schema.rules.float.gte": "0.0",
13727
14214
  "ves.io.schema.rules.float.lte": "8.0"
13728
14215
  },
14216
+ "x-f5xc-description-short": "Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core.",
13729
14217
  "x-f5xc-required-for": {
13730
14218
  "minimum_config": false,
13731
14219
  "create": false,
@@ -13761,6 +14249,7 @@
13761
14249
  "title": "Fail_if_referred.",
13762
14250
  "format": "boolean",
13763
14251
  "x-displayname": "Fail-If-Referred.",
14252
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
13764
14253
  "x-f5xc-required-for": {
13765
14254
  "minimum_config": false,
13766
14255
  "create": false,
@@ -13785,7 +14274,7 @@
13785
14274
  },
13786
14275
  "x-original-maxLength": 1024,
13787
14276
  "x-reconciled-from-discovery": true,
13788
- "x-reconciled-at": "2026-01-05T18:30:14.288240+00:00"
14277
+ "x-reconciled-at": "2026-01-07T15:29:46.860641+00:00"
13789
14278
  },
13790
14279
  "namespace": {
13791
14280
  "type": "string",
@@ -13794,6 +14283,7 @@
13794
14283
  "x-displayname": "Namespace",
13795
14284
  "x-ves-example": "Ns1",
13796
14285
  "x-f5xc-example": "ns1",
14286
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
13797
14287
  "minLength": 0,
13798
14288
  "maxLength": 6,
13799
14289
  "x-f5xc-required-for": {
@@ -13804,7 +14294,7 @@
13804
14294
  },
13805
14295
  "x-original-maxLength": 1024,
13806
14296
  "x-reconciled-from-discovery": true,
13807
- "x-reconciled-at": "2026-01-05T18:30:14.288245+00:00"
14297
+ "x-reconciled-at": "2026-01-07T15:29:46.860645+00:00"
13808
14298
  }
13809
14299
  },
13810
14300
  "x-f5xc-minimum-configuration": {
@@ -13839,6 +14329,7 @@
13839
14329
  "$ref": "#/components/schemas/schemaObjectRefType"
13840
14330
  },
13841
14331
  "x-displayname": "Deleted Referred Objects.",
14332
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13842
14333
  "x-f5xc-required-for": {
13843
14334
  "minimum_config": false,
13844
14335
  "create": false,
@@ -13854,6 +14345,7 @@
13854
14345
  "$ref": "#/components/schemas/schemaObjectRefType"
13855
14346
  },
13856
14347
  "x-displayname": "Disabled Referred Objects.",
14348
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13857
14349
  "x-f5xc-required-for": {
13858
14350
  "minimum_config": false,
13859
14351
  "create": false,
@@ -13872,6 +14364,7 @@
13872
14364
  "$ref": "#/components/schemas/schemaObjectRefType"
13873
14365
  },
13874
14366
  "x-displayname": "Referring Objects.",
14367
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
13875
14368
  "x-f5xc-required-for": {
13876
14369
  "minimum_config": false,
13877
14370
  "create": false,
@@ -13893,6 +14386,8 @@
13893
14386
  "$ref": "#/components/schemas/workload_flavorStatusObject"
13894
14387
  },
13895
14388
  "x-displayname": "Status",
14389
+ "x-f5xc-example": "active",
14390
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
13896
14391
  "x-f5xc-required-for": {
13897
14392
  "minimum_config": false,
13898
14393
  "create": false,
@@ -13902,7 +14397,7 @@
13902
14397
  "maxLength": 17,
13903
14398
  "minLength": 17,
13904
14399
  "x-reconciled-from-discovery": true,
13905
- "x-reconciled-at": "2026-01-05T18:30:14.288259+00:00"
14400
+ "x-reconciled-at": "2026-01-07T15:29:46.860660+00:00"
13906
14401
  },
13907
14402
  "system_metadata": {
13908
14403
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -13942,6 +14437,8 @@
13942
14437
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
13943
14438
  ],
13944
14439
  "default": "GET_RSP_FORMAT_DEFAULT",
14440
+ "x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
14441
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
13945
14442
  "x-f5xc-minimum-configuration": {
13946
14443
  "description": "Minimum configuration for workload_flavorGetResponseFormatCode",
13947
14444
  "required_fields": [],
@@ -13972,6 +14469,7 @@
13972
14469
  "x-validation-rules": {
13973
14470
  "ves.io.schema.rules.uint32.ranges": "1-6000"
13974
14471
  },
14472
+ "x-f5xc-description-short": "Ephemeral storage in MiB (mebibyte) allocated for the workload_flavor.",
13975
14473
  "minLength": 0,
13976
14474
  "maxLength": 1024,
13977
14475
  "x-f5xc-required-for": {
@@ -13994,6 +14492,7 @@
13994
14492
  "x-validation-rules": {
13995
14493
  "ves.io.schema.rules.uint32.ranges": "1-32768"
13996
14494
  },
14495
+ "x-f5xc-description-short": "Memory in MiB (mebibyte) allocated for the workload_flavor.",
13997
14496
  "minLength": 0,
13998
14497
  "maxLength": 1024,
13999
14498
  "x-f5xc-required-for": {
@@ -14018,6 +14517,7 @@
14018
14517
  "ves.io.schema.rules.float.gte": "0.0",
14019
14518
  "ves.io.schema.rules.float.lte": "8.0"
14020
14519
  },
14520
+ "x-f5xc-description-short": "Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core.",
14021
14521
  "x-f5xc-required-for": {
14022
14522
  "minimum_config": false,
14023
14523
  "create": false,
@@ -14055,6 +14555,7 @@
14055
14555
  "$ref": "#/components/schemas/schemaErrorType"
14056
14556
  },
14057
14557
  "x-displayname": "Errors",
14558
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
14058
14559
  "x-f5xc-required-for": {
14059
14560
  "minimum_config": false,
14060
14561
  "create": false,
@@ -14070,6 +14571,8 @@
14070
14571
  "$ref": "#/components/schemas/workload_flavorListResponseItem"
14071
14572
  },
14072
14573
  "x-displayname": "Items",
14574
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
14575
+ "x-f5xc-description-short": "Items represents the collection in response.",
14073
14576
  "x-f5xc-required-for": {
14074
14577
  "minimum_config": false,
14075
14578
  "create": false,
@@ -14103,6 +14606,8 @@
14103
14606
  "description": "The set of annotations present on this workload_flavor.",
14104
14607
  "title": "Annotations.",
14105
14608
  "x-displayname": "Annotations.",
14609
+ "x-f5xc-example": "{\"key\": \"value\"}",
14610
+ "x-f5xc-description-short": "The set of annotations present on this workload_flavor.",
14106
14611
  "x-f5xc-required-for": {
14107
14612
  "minimum_config": false,
14108
14613
  "create": false,
@@ -14115,6 +14620,7 @@
14115
14620
  "description": "The description set for this workload_flavor.",
14116
14621
  "title": "Description.",
14117
14622
  "x-displayname": "Description.",
14623
+ "x-f5xc-description-short": "The description set for this workload_flavor.",
14118
14624
  "minLength": 0,
14119
14625
  "maxLength": 0,
14120
14626
  "x-f5xc-required-for": {
@@ -14125,7 +14631,7 @@
14125
14631
  },
14126
14632
  "x-original-maxLength": 1024,
14127
14633
  "x-reconciled-from-discovery": true,
14128
- "x-reconciled-at": "2026-01-05T18:30:14.288276+00:00"
14634
+ "x-reconciled-at": "2026-01-07T15:29:46.860676+00:00"
14129
14635
  },
14130
14636
  "disabled": {
14131
14637
  "type": "boolean",
@@ -14133,6 +14639,8 @@
14133
14639
  "title": "Disabled",
14134
14640
  "format": "boolean",
14135
14641
  "x-displayname": "Disabled",
14642
+ "x-f5xc-example": "True",
14643
+ "x-f5xc-description-short": "Value of true indicates workload_flavor is administratively disabled.",
14136
14644
  "x-f5xc-required-for": {
14137
14645
  "minimum_config": false,
14138
14646
  "create": false,
@@ -14148,6 +14656,8 @@
14148
14656
  "description": "The set of labels present on this workload_flavor.",
14149
14657
  "title": "Labels",
14150
14658
  "x-displayname": "Labels",
14659
+ "x-f5xc-example": "{\"key\": \"value\"}",
14660
+ "x-f5xc-description-short": "The set of labels present on this workload_flavor.",
14151
14661
  "x-f5xc-required-for": {
14152
14662
  "minimum_config": false,
14153
14663
  "create": false,
@@ -14175,7 +14685,7 @@
14175
14685
  },
14176
14686
  "x-original-maxLength": 1024,
14177
14687
  "x-reconciled-from-discovery": true,
14178
- "x-reconciled-at": "2026-01-05T18:30:14.288286+00:00"
14688
+ "x-reconciled-at": "2026-01-07T15:29:46.860686+00:00"
14179
14689
  },
14180
14690
  "namespace": {
14181
14691
  "type": "string",
@@ -14194,7 +14704,7 @@
14194
14704
  },
14195
14705
  "x-original-maxLength": 1024,
14196
14706
  "x-reconciled-from-discovery": true,
14197
- "x-reconciled-at": "2026-01-05T18:30:14.288290+00:00"
14707
+ "x-reconciled-at": "2026-01-07T15:29:46.860691+00:00"
14198
14708
  },
14199
14709
  "owner_view": {
14200
14710
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -14207,6 +14717,7 @@
14207
14717
  "$ref": "#/components/schemas/workload_flavorStatusObject"
14208
14718
  },
14209
14719
  "x-displayname": "Status",
14720
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
14210
14721
  "x-f5xc-required-for": {
14211
14722
  "minimum_config": false,
14212
14723
  "create": false,
@@ -14235,7 +14746,7 @@
14235
14746
  "x-field-mutability": "read-only",
14236
14747
  "x-original-maxLength": 1024,
14237
14748
  "x-reconciled-from-discovery": true,
14238
- "x-reconciled-at": "2026-01-05T18:30:14.288298+00:00"
14749
+ "x-reconciled-at": "2026-01-07T15:29:46.860698+00:00"
14239
14750
  },
14240
14751
  "uid": {
14241
14752
  "type": "string",
@@ -14256,9 +14767,11 @@
14256
14767
  "x-original-maxLength": 1024,
14257
14768
  "format": "uuid",
14258
14769
  "x-reconciled-from-discovery": true,
14259
- "x-reconciled-at": "2026-01-05T18:30:14.288303+00:00"
14770
+ "x-reconciled-at": "2026-01-07T15:29:46.860703+00:00"
14260
14771
  }
14261
14772
  },
14773
+ "x-f5xc-description-short": "By default a summary of workload_flavor is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
14774
+ "x-f5xc-description-medium": "By default a summary of workload_flavor is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
14262
14775
  "x-f5xc-minimum-configuration": {
14263
14776
  "description": "Minimum configuration for workload_flavorListResponseItem",
14264
14777
  "required_fields": [
@@ -14343,6 +14856,7 @@
14343
14856
  "x-validation-rules": {
14344
14857
  "ves.io.schema.rules.uint32.ranges": "1-6000"
14345
14858
  },
14859
+ "x-f5xc-description-short": "Ephemeral storage in MiB (mebibyte) allocated for the workload_flavor.",
14346
14860
  "minLength": 0,
14347
14861
  "maxLength": 1024,
14348
14862
  "x-f5xc-required-for": {
@@ -14365,6 +14879,7 @@
14365
14879
  "x-validation-rules": {
14366
14880
  "ves.io.schema.rules.uint32.ranges": "1-32768"
14367
14881
  },
14882
+ "x-f5xc-description-short": "Memory in MiB (mebibyte) allocated for the workload_flavor.",
14368
14883
  "minLength": 0,
14369
14884
  "maxLength": 1024,
14370
14885
  "x-f5xc-required-for": {
@@ -14389,6 +14904,7 @@
14389
14904
  "ves.io.schema.rules.float.gte": "0.0",
14390
14905
  "ves.io.schema.rules.float.lte": "8.0"
14391
14906
  },
14907
+ "x-f5xc-description-short": "Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core.",
14392
14908
  "x-f5xc-required-for": {
14393
14909
  "minimum_config": false,
14394
14910
  "create": false,
@@ -14426,6 +14942,7 @@
14426
14942
  "$ref": "#/components/schemas/schemaConditionType"
14427
14943
  },
14428
14944
  "x-displayname": "Conditions.",
14945
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
14429
14946
  "x-f5xc-required-for": {
14430
14947
  "minimum_config": false,
14431
14948
  "create": false,
@@ -14452,6 +14969,7 @@
14452
14969
  }
14453
14970
  }
14454
14971
  },
14972
+ "x-f5xc-description-short": "Most recently observed status of object.",
14455
14973
  "x-f5xc-minimum-configuration": {
14456
14974
  "description": "Minimum configuration for workload_flavorStatusObject",
14457
14975
  "required_fields": [