@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": "Users",
5
5
  "description": "Token lifecycle governs automated site onboarding through cloud-init integration with configurable validity periods. Explicit category keys establish permitted classification hierarchies enforced across deployments. Inferred attributes attach automatically based on object characteristics and placement context. Namespace-scoped operations handle credential generation, revocation, and state transitions for streamlined provisioning workflows.",
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"
@@ -3366,7 +3366,7 @@
3366
3366
  },
3367
3367
  "x-original-maxLength": 1024,
3368
3368
  "x-reconciled-from-discovery": true,
3369
- "x-reconciled-at": "2026-01-05T18:29:25.855212+00:00"
3369
+ "x-reconciled-at": "2026-01-07T15:28:46.181203+00:00"
3370
3370
  },
3371
3371
  "key": {
3372
3372
  "type": "string",
@@ -3385,7 +3385,7 @@
3385
3385
  },
3386
3386
  "x-original-maxLength": 1024,
3387
3387
  "x-reconciled-from-discovery": true,
3388
- "x-reconciled-at": "2026-01-05T18:29:25.855219+00:00"
3388
+ "x-reconciled-at": "2026-01-07T15:28:46.181210+00:00"
3389
3389
  },
3390
3390
  "value": {
3391
3391
  "type": "string",
@@ -3404,9 +3404,10 @@
3404
3404
  },
3405
3405
  "x-original-maxLength": 1024,
3406
3406
  "x-reconciled-from-discovery": true,
3407
- "x-reconciled-at": "2026-01-05T18:29:25.855224+00:00"
3407
+ "x-reconciled-at": "2026-01-07T15:28:46.181215+00:00"
3408
3408
  }
3409
3409
  },
3410
+ "x-f5xc-description-short": "Generic Label type label.key(label.value).",
3410
3411
  "x-f5xc-minimum-configuration": {
3411
3412
  "description": "Minimum configuration for implicit_labelLabelType",
3412
3413
  "required_fields": [
@@ -3434,6 +3435,8 @@
3434
3435
  "QUERY_KEY_SUBSTRING"
3435
3436
  ],
3436
3437
  "default": "QUERY_ALL_LABELS",
3438
+ "x-f5xc-description-short": "X-displayName: \"Label Query\" Type of query for implicit labels - QUERY_ALL_LABELS: x-displayName: \"All Labels\" GET all available implicit labels ...",
3439
+ "x-f5xc-description-medium": "X-displayName: \"Label Query\" Type of query for implicit labels - QUERY_ALL_LABELS: x-displayName: \"All Labels\" GET all available implicit labels - QUERY_EXACT_LABEL: x-displayName: \"Exact Label\" GET exact match of label.key = label.value Or label.key(label.value) - QUERY_VALUE_PREFIX_LABELS...",
3437
3440
  "x-f5xc-minimum-configuration": {
3438
3441
  "description": "Minimum configuration for implicit_labelQueryType",
3439
3442
  "required_fields": [],
@@ -3460,6 +3463,8 @@
3460
3463
  "KEY_CLASS_AWS"
3461
3464
  ],
3462
3465
  "default": "KEY_CLASS_GENERIC",
3466
+ "x-f5xc-description-short": "X-displayName: \"LabelKeyClass\" LabelKeyClass is an enumeration of supported label key classes - KEY_CLASS_GENERIC: x-displayName: \"Key Class...",
3467
+ "x-f5xc-description-medium": "X-displayName: \"LabelKeyClass\" LabelKeyClass is an enumeration of supported label key classes - KEY_CLASS_GENERIC: x-displayName: \"Key Class Generic\" Includes label keys with generic names such as \"example-key\", \"foobar-key\" etc. - KEY_CLASS_KNOWN: x-displayName: \"Key Class Known\" Keys that are...",
3463
3468
  "x-f5xc-minimum-configuration": {
3464
3469
  "description": "Minimum configuration for schemaLabelKeyClass",
3465
3470
  "required_fields": [],
@@ -3494,7 +3499,7 @@
3494
3499
  },
3495
3500
  "x-original-maxLength": 1024,
3496
3501
  "x-reconciled-from-discovery": true,
3497
- "x-reconciled-at": "2026-01-05T18:29:31.036769+00:00"
3502
+ "x-reconciled-at": "2026-01-07T15:28:52.777987+00:00"
3498
3503
  },
3499
3504
  "key": {
3500
3505
  "type": "string",
@@ -3513,7 +3518,7 @@
3513
3518
  },
3514
3519
  "x-original-maxLength": 1024,
3515
3520
  "x-reconciled-from-discovery": true,
3516
- "x-reconciled-at": "2026-01-05T18:29:31.036776+00:00"
3521
+ "x-reconciled-at": "2026-01-07T15:28:52.777994+00:00"
3517
3522
  },
3518
3523
  "namespace": {
3519
3524
  "type": "string",
@@ -3532,7 +3537,7 @@
3532
3537
  },
3533
3538
  "x-original-maxLength": 1024,
3534
3539
  "x-reconciled-from-discovery": true,
3535
- "x-reconciled-at": "2026-01-05T18:29:31.036781+00:00"
3540
+ "x-reconciled-at": "2026-01-07T15:28:52.777999+00:00"
3536
3541
  },
3537
3542
  "value": {
3538
3543
  "type": "string",
@@ -3557,9 +3562,10 @@
3557
3562
  },
3558
3563
  "x-original-maxLength": 1024,
3559
3564
  "x-reconciled-from-discovery": true,
3560
- "x-reconciled-at": "2026-01-05T18:29:31.036786+00:00"
3565
+ "x-reconciled-at": "2026-01-07T15:28:52.778004+00:00"
3561
3566
  }
3562
3567
  },
3568
+ "x-f5xc-description-short": "Create label request in shared namespace. Only shared namespace supported.",
3563
3569
  "x-f5xc-minimum-configuration": {
3564
3570
  "description": "Minimum configuration for known_labelCreateRequest",
3565
3571
  "required_fields": [
@@ -3622,7 +3628,7 @@
3622
3628
  },
3623
3629
  "x-original-maxLength": 1024,
3624
3630
  "x-reconciled-from-discovery": true,
3625
- "x-reconciled-at": "2026-01-05T18:29:31.036793+00:00"
3631
+ "x-reconciled-at": "2026-01-07T15:28:52.778012+00:00"
3626
3632
  },
3627
3633
  "namespace": {
3628
3634
  "type": "string",
@@ -3641,7 +3647,7 @@
3641
3647
  },
3642
3648
  "x-original-maxLength": 1024,
3643
3649
  "x-reconciled-from-discovery": true,
3644
- "x-reconciled-at": "2026-01-05T18:29:31.036798+00:00"
3650
+ "x-reconciled-at": "2026-01-07T15:28:52.778016+00:00"
3645
3651
  },
3646
3652
  "value": {
3647
3653
  "type": "string",
@@ -3666,9 +3672,10 @@
3666
3672
  },
3667
3673
  "x-original-maxLength": 1024,
3668
3674
  "x-reconciled-from-discovery": true,
3669
- "x-reconciled-at": "2026-01-05T18:29:31.036803+00:00"
3675
+ "x-reconciled-at": "2026-01-07T15:28:52.778020+00:00"
3670
3676
  }
3671
3677
  },
3678
+ "x-f5xc-description-short": "Deletes Label matching label.key=label.value.",
3672
3679
  "x-f5xc-minimum-configuration": {
3673
3680
  "description": "Minimum configuration for known_labelDeleteRequest",
3674
3681
  "required_fields": [
@@ -3758,7 +3765,7 @@
3758
3765
  },
3759
3766
  "x-original-maxLength": 1024,
3760
3767
  "x-reconciled-from-discovery": true,
3761
- "x-reconciled-at": "2026-01-05T18:29:31.036810+00:00"
3768
+ "x-reconciled-at": "2026-01-07T15:28:52.778027+00:00"
3762
3769
  },
3763
3770
  "key": {
3764
3771
  "type": "string",
@@ -3777,7 +3784,7 @@
3777
3784
  },
3778
3785
  "x-original-maxLength": 1024,
3779
3786
  "x-reconciled-from-discovery": true,
3780
- "x-reconciled-at": "2026-01-05T18:29:31.036814+00:00"
3787
+ "x-reconciled-at": "2026-01-07T15:28:52.778031+00:00"
3781
3788
  },
3782
3789
  "value": {
3783
3790
  "type": "string",
@@ -3796,9 +3803,10 @@
3796
3803
  },
3797
3804
  "x-original-maxLength": 1024,
3798
3805
  "x-reconciled-from-discovery": true,
3799
- "x-reconciled-at": "2026-01-05T18:29:31.036818+00:00"
3806
+ "x-reconciled-at": "2026-01-07T15:28:52.778035+00:00"
3800
3807
  }
3801
3808
  },
3809
+ "x-f5xc-description-short": "Generic Label type label.key(label.value).",
3802
3810
  "x-f5xc-minimum-configuration": {
3803
3811
  "description": "Minimum configuration for known_labelLabelType",
3804
3812
  "required_fields": [
@@ -3824,6 +3832,8 @@
3824
3832
  "QUERY_KEY_PREFIX_LABELS"
3825
3833
  ],
3826
3834
  "default": "QUERY_ALL_LABELS",
3835
+ "x-f5xc-description-short": "X-displayName: \"Query Type\" Type of label query - QUERY_ALL_LABELS: x-displayName: \"All Labels\" Generic GET of all available labels for a given...",
3836
+ "x-f5xc-description-medium": "X-displayName: \"Query Type\" Type of label query - QUERY_ALL_LABELS: x-displayName: \"All Labels\" Generic GET of all available labels for a given tenant - QUERY_EXACT_LABEL: x-displayName: \"Exact Label\" GET exact match of label.key = label.value Or label.key(label.value) ...",
3827
3837
  "x-f5xc-minimum-configuration": {
3828
3838
  "description": "Minimum configuration for known_labelQueryType",
3829
3839
  "required_fields": [],
@@ -3858,7 +3868,7 @@
3858
3868
  },
3859
3869
  "x-original-maxLength": 1024,
3860
3870
  "x-reconciled-from-discovery": true,
3861
- "x-reconciled-at": "2026-01-05T18:29:31.218902+00:00"
3871
+ "x-reconciled-at": "2026-01-07T15:28:53.037110+00:00"
3862
3872
  },
3863
3873
  "key": {
3864
3874
  "type": "string",
@@ -3877,7 +3887,7 @@
3877
3887
  },
3878
3888
  "x-original-maxLength": 1024,
3879
3889
  "x-reconciled-from-discovery": true,
3880
- "x-reconciled-at": "2026-01-05T18:29:31.218909+00:00"
3890
+ "x-reconciled-at": "2026-01-07T15:28:53.037118+00:00"
3881
3891
  },
3882
3892
  "namespace": {
3883
3893
  "type": "string",
@@ -3896,9 +3906,10 @@
3896
3906
  },
3897
3907
  "x-original-maxLength": 1024,
3898
3908
  "x-reconciled-from-discovery": true,
3899
- "x-reconciled-at": "2026-01-05T18:29:31.218914+00:00"
3909
+ "x-reconciled-at": "2026-01-07T15:28:53.037123+00:00"
3900
3910
  }
3901
3911
  },
3912
+ "x-f5xc-description-short": "Create label Key request in shared namespace. Only shared namespace supported.",
3902
3913
  "x-f5xc-minimum-configuration": {
3903
3914
  "description": "Minimum configuration for known_label_keyCreateRequest",
3904
3915
  "required_fields": [
@@ -3960,7 +3971,7 @@
3960
3971
  },
3961
3972
  "x-original-maxLength": 1024,
3962
3973
  "x-reconciled-from-discovery": true,
3963
- "x-reconciled-at": "2026-01-05T18:29:31.218922+00:00"
3974
+ "x-reconciled-at": "2026-01-07T15:28:53.037132+00:00"
3964
3975
  },
3965
3976
  "namespace": {
3966
3977
  "type": "string",
@@ -3969,6 +3980,7 @@
3969
3980
  "x-displayname": "Namespace",
3970
3981
  "x-ves-example": "Value",
3971
3982
  "x-f5xc-example": "value",
3983
+ "x-f5xc-description-short": "Namespace in which to DELETE the label key.",
3972
3984
  "minLength": 0,
3973
3985
  "maxLength": 6,
3974
3986
  "x-f5xc-required-for": {
@@ -3979,7 +3991,7 @@
3979
3991
  },
3980
3992
  "x-original-maxLength": 1024,
3981
3993
  "x-reconciled-from-discovery": true,
3982
- "x-reconciled-at": "2026-01-05T18:29:31.218926+00:00"
3994
+ "x-reconciled-at": "2026-01-07T15:28:53.037136+00:00"
3983
3995
  }
3984
3996
  },
3985
3997
  "x-f5xc-minimum-configuration": {
@@ -4060,6 +4072,7 @@
4060
4072
  "x-displayname": "Description.",
4061
4073
  "x-ves-example": "Value",
4062
4074
  "x-f5xc-example": "value",
4075
+ "x-f5xc-description-short": "Description of what this label key means.",
4063
4076
  "minLength": 0,
4064
4077
  "maxLength": 0,
4065
4078
  "x-f5xc-required-for": {
@@ -4070,7 +4083,7 @@
4070
4083
  },
4071
4084
  "x-original-maxLength": 1024,
4072
4085
  "x-reconciled-from-discovery": true,
4073
- "x-reconciled-at": "2026-01-05T18:29:31.218933+00:00"
4086
+ "x-reconciled-at": "2026-01-07T15:28:53.037143+00:00"
4074
4087
  },
4075
4088
  "key": {
4076
4089
  "type": "string",
@@ -4089,7 +4102,7 @@
4089
4102
  },
4090
4103
  "x-original-maxLength": 1024,
4091
4104
  "x-reconciled-from-discovery": true,
4092
- "x-reconciled-at": "2026-01-05T18:29:31.218937+00:00"
4105
+ "x-reconciled-at": "2026-01-07T15:28:53.037147+00:00"
4093
4106
  }
4094
4107
  },
4095
4108
  "x-f5xc-minimum-configuration": {
@@ -4115,6 +4128,8 @@
4115
4128
  "QUERY_PREFIX_LABEL_KEYS"
4116
4129
  ],
4117
4130
  "default": "QUERY_ALL_LABEL_KEYS",
4131
+ "x-f5xc-description-short": "X-displayName: \"Query Type\" Type of label key query - QUERY_ALL_LABEL_KEYS: x-displayName: \"All Labels\" Generic GET of all available labels for a...",
4132
+ "x-f5xc-description-medium": "X-displayName: \"Query Type\" Type of label key query - QUERY_ALL_LABEL_KEYS: x-displayName: \"All Labels\" Generic GET of all available labels for a given tenant - QUERY_EXACT_LABEL_KEY: x-displayName: \"Exact Label Key\" GET exact match of label.key = label.value Or label.key(label.value) ...",
4118
4133
  "x-f5xc-minimum-configuration": {
4119
4134
  "description": "Minimum configuration for known_label_keyQueryType",
4120
4135
  "required_fields": [],
@@ -4132,6 +4147,8 @@
4132
4147
  "type_url": {
4133
4148
  "type": "string",
4134
4149
  "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.",
4150
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
4151
+ "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 ).",
4135
4152
  "minLength": 0,
4136
4153
  "maxLength": 1024,
4137
4154
  "x-f5xc-required-for": {
@@ -4155,9 +4172,11 @@
4155
4172
  },
4156
4173
  "x-original-maxLength": 1024,
4157
4174
  "x-reconciled-from-discovery": true,
4158
- "x-reconciled-at": "2026-01-05T18:30:04.621926+00:00"
4175
+ "x-reconciled-at": "2026-01-07T15:29:34.556577+00:00"
4159
4176
  }
4160
4177
  },
4178
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
4179
+ "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...",
4161
4180
  "x-f5xc-minimum-configuration": {
4162
4181
  "description": "Minimum configuration for protobufAny",
4163
4182
  "required_fields": [
@@ -4183,6 +4202,8 @@
4183
4202
  "description": "Hostname of the instance of the site that sent the status.",
4184
4203
  "title": "Hostname",
4185
4204
  "x-displayname": "Hostname",
4205
+ "x-f5xc-example": "example-resource",
4206
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
4186
4207
  "minLength": 0,
4187
4208
  "maxLength": 1024,
4188
4209
  "x-f5xc-required-for": {
@@ -4214,6 +4235,8 @@
4214
4235
  "x-displayname": "Reason",
4215
4236
  "x-ves-example": "Value",
4216
4237
  "x-f5xc-example": "value",
4238
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
4239
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
4217
4240
  "minLength": 0,
4218
4241
  "maxLength": 43,
4219
4242
  "x-f5xc-required-for": {
@@ -4224,13 +4247,15 @@
4224
4247
  },
4225
4248
  "x-original-maxLength": 1024,
4226
4249
  "x-reconciled-from-discovery": true,
4227
- "x-reconciled-at": "2026-01-05T18:30:04.621938+00:00"
4250
+ "x-reconciled-at": "2026-01-07T15:29:34.556588+00:00"
4228
4251
  },
4229
4252
  "service_name": {
4230
4253
  "type": "string",
4231
4254
  "description": "Name of the service that sent the status.",
4232
4255
  "title": "Service name.",
4233
4256
  "x-displayname": "Service Name.",
4257
+ "x-f5xc-example": "example-resource",
4258
+ "x-f5xc-description-short": "Name of the service that sent the status.",
4234
4259
  "minLength": 0,
4235
4260
  "maxLength": 1024,
4236
4261
  "x-f5xc-required-for": {
@@ -4253,6 +4278,8 @@
4253
4278
  "x-validation-rules": {
4254
4279
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
4255
4280
  },
4281
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
4282
+ "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...",
4256
4283
  "minLength": 0,
4257
4284
  "maxLength": 17,
4258
4285
  "x-f5xc-required-for": {
@@ -4263,7 +4290,7 @@
4263
4290
  },
4264
4291
  "x-original-maxLength": 1024,
4265
4292
  "x-reconciled-from-discovery": true,
4266
- "x-reconciled-at": "2026-01-05T18:30:04.621945+00:00"
4293
+ "x-reconciled-at": "2026-01-07T15:29:34.556595+00:00"
4267
4294
  },
4268
4295
  "type": {
4269
4296
  "type": "string",
@@ -4278,6 +4305,8 @@
4278
4305
  "x-validation-rules": {
4279
4306
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
4280
4307
  },
4308
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
4309
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
4281
4310
  "minLength": 0,
4282
4311
  "maxLength": 1024,
4283
4312
  "x-f5xc-required-for": {
@@ -4288,6 +4317,8 @@
4288
4317
  }
4289
4318
  }
4290
4319
  },
4320
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
4321
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
4291
4322
  "x-f5xc-minimum-configuration": {
4292
4323
  "description": "Minimum configuration for schemaConditionType",
4293
4324
  "required_fields": [
@@ -4323,6 +4354,8 @@
4323
4354
  "default": "EOK",
4324
4355
  "x-displayname": "Error Code.",
4325
4356
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
4357
+ "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...",
4358
+ "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...",
4326
4359
  "x-f5xc-minimum-configuration": {
4327
4360
  "description": "Minimum configuration for schemaErrorCode",
4328
4361
  "required_fields": [],
@@ -4363,6 +4396,7 @@
4363
4396
  }
4364
4397
  }
4365
4398
  },
4399
+ "x-f5xc-description-short": "Information about a error in API operation.",
4366
4400
  "x-f5xc-minimum-configuration": {
4367
4401
  "description": "Minimum configuration for schemaErrorType",
4368
4402
  "required_fields": [
@@ -4390,6 +4424,7 @@
4390
4424
  "title": "Name",
4391
4425
  "x-displayname": "Name",
4392
4426
  "x-f5xc-example": "example-resource",
4427
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
4393
4428
  "minLength": 0,
4394
4429
  "maxLength": 16,
4395
4430
  "x-f5xc-required-for": {
@@ -4400,9 +4435,10 @@
4400
4435
  },
4401
4436
  "x-original-maxLength": 1024,
4402
4437
  "x-reconciled-from-discovery": true,
4403
- "x-reconciled-at": "2026-01-05T18:30:04.621957+00:00"
4438
+ "x-reconciled-at": "2026-01-07T15:29:34.556606+00:00"
4404
4439
  }
4405
4440
  },
4441
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
4406
4442
  "x-f5xc-minimum-configuration": {
4407
4443
  "description": "Minimum configuration for schemaInitializerType",
4408
4444
  "required_fields": [
@@ -4430,6 +4466,8 @@
4430
4466
  "$ref": "#/components/schemas/schemaInitializerType"
4431
4467
  },
4432
4468
  "x-displayname": "Pending",
4469
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
4470
+ "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.",
4433
4471
  "x-f5xc-required-for": {
4434
4472
  "minimum_config": false,
4435
4473
  "create": false,
@@ -4441,6 +4479,7 @@
4441
4479
  "$ref": "#/components/schemas/schemaStatusType"
4442
4480
  }
4443
4481
  },
4482
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
4444
4483
  "x-f5xc-minimum-configuration": {
4445
4484
  "description": "Minimum configuration for schemaInitializersType",
4446
4485
  "required_fields": [
@@ -4479,6 +4518,8 @@
4479
4518
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4480
4519
  "ves.io.schema.rules.map.values.string.min_len": "1"
4481
4520
  },
4521
+ "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.",
4522
+ "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
4523
  "x-f5xc-required-for": {
4483
4524
  "minimum_config": false,
4484
4525
  "create": false,
@@ -4500,6 +4541,7 @@
4500
4541
  "x-validation-rules": {
4501
4542
  "ves.io.schema.rules.string.max_bytes": "1200"
4502
4543
  },
4544
+ "x-f5xc-description-short": "Human readable description for the object.",
4503
4545
  "minLength": 0,
4504
4546
  "x-f5xc-required-for": {
4505
4547
  "minimum_config": false,
@@ -4509,7 +4551,7 @@
4509
4551
  },
4510
4552
  "x-original-maxLength": 1200,
4511
4553
  "x-reconciled-from-discovery": true,
4512
- "x-reconciled-at": "2026-01-05T18:30:04.621967+00:00"
4554
+ "x-reconciled-at": "2026-01-07T15:29:34.556617+00:00"
4513
4555
  },
4514
4556
  "disable": {
4515
4557
  "type": "boolean",
@@ -4518,6 +4560,7 @@
4518
4560
  "format": "boolean",
4519
4561
  "x-displayname": "Disable",
4520
4562
  "x-f5xc-example": "true",
4563
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4521
4564
  "x-f5xc-required-for": {
4522
4565
  "minimum_config": false,
4523
4566
  "create": false,
@@ -4531,6 +4574,8 @@
4531
4574
  "title": "Labels",
4532
4575
  "x-displayname": "Labels",
4533
4576
  "x-f5xc-example": "value",
4577
+ "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.",
4578
+ "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.",
4534
4579
  "x-f5xc-required-for": {
4535
4580
  "minimum_config": false,
4536
4581
  "create": false,
@@ -4552,6 +4597,8 @@
4552
4597
  "x-validation-rules": {
4553
4598
  "ves.io.schema.rules.message.required": "true"
4554
4599
  },
4600
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4601
+ "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.",
4555
4602
  "minLength": 0,
4556
4603
  "maxLength": 16,
4557
4604
  "x-f5xc-required-for": {
@@ -4562,7 +4609,7 @@
4562
4609
  },
4563
4610
  "x-original-maxLength": 1024,
4564
4611
  "x-reconciled-from-discovery": true,
4565
- "x-reconciled-at": "2026-01-05T18:30:04.621975+00:00"
4612
+ "x-reconciled-at": "2026-01-07T15:29:34.556624+00:00"
4566
4613
  },
4567
4614
  "namespace": {
4568
4615
  "type": "string",
@@ -4571,6 +4618,8 @@
4571
4618
  "x-displayname": "Namespace",
4572
4619
  "x-ves-example": "Staging",
4573
4620
  "x-f5xc-example": "staging",
4621
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4622
+ "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 \"\".",
4574
4623
  "minLength": 0,
4575
4624
  "maxLength": 6,
4576
4625
  "x-f5xc-required-for": {
@@ -4581,9 +4630,10 @@
4581
4630
  },
4582
4631
  "x-original-maxLength": 1024,
4583
4632
  "x-reconciled-from-discovery": true,
4584
- "x-reconciled-at": "2026-01-05T18:30:04.621979+00:00"
4633
+ "x-reconciled-at": "2026-01-07T15:29:34.556628+00:00"
4585
4634
  }
4586
4635
  },
4636
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
4587
4637
  "x-f5xc-minimum-configuration": {
4588
4638
  "description": "Minimum configuration for schemaObjectCreateMetaType",
4589
4639
  "required_fields": [
@@ -4627,6 +4677,8 @@
4627
4677
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4628
4678
  "ves.io.schema.rules.map.values.string.min_len": "1"
4629
4679
  },
4680
+ "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.",
4681
+ "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
4630
4682
  "x-f5xc-required-for": {
4631
4683
  "minimum_config": false,
4632
4684
  "create": false,
@@ -4648,6 +4700,7 @@
4648
4700
  "x-validation-rules": {
4649
4701
  "ves.io.schema.rules.string.max_bytes": "1200"
4650
4702
  },
4703
+ "x-f5xc-description-short": "Human readable description for the object.",
4651
4704
  "minLength": 0,
4652
4705
  "x-f5xc-required-for": {
4653
4706
  "minimum_config": false,
@@ -4657,7 +4710,7 @@
4657
4710
  },
4658
4711
  "x-original-maxLength": 1200,
4659
4712
  "x-reconciled-from-discovery": true,
4660
- "x-reconciled-at": "2026-01-05T18:30:04.621985+00:00"
4713
+ "x-reconciled-at": "2026-01-07T15:29:34.556634+00:00"
4661
4714
  },
4662
4715
  "disable": {
4663
4716
  "type": "boolean",
@@ -4667,6 +4720,7 @@
4667
4720
  "x-displayname": "Disable",
4668
4721
  "x-ves-example": "True",
4669
4722
  "x-f5xc-example": "true",
4723
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4670
4724
  "x-f5xc-required-for": {
4671
4725
  "minimum_config": false,
4672
4726
  "create": false,
@@ -4681,6 +4735,8 @@
4681
4735
  "x-displayname": "Labels",
4682
4736
  "x-ves-example": "Value",
4683
4737
  "x-f5xc-example": "value",
4738
+ "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.",
4739
+ "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.",
4684
4740
  "x-f5xc-required-for": {
4685
4741
  "minimum_config": false,
4686
4742
  "create": false,
@@ -4702,6 +4758,8 @@
4702
4758
  "x-validation-rules": {
4703
4759
  "ves.io.schema.rules.message.required": "true"
4704
4760
  },
4761
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4762
+ "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
4763
  "minLength": 0,
4706
4764
  "maxLength": 16,
4707
4765
  "x-f5xc-required-for": {
@@ -4712,7 +4770,7 @@
4712
4770
  },
4713
4771
  "x-original-maxLength": 1024,
4714
4772
  "x-reconciled-from-discovery": true,
4715
- "x-reconciled-at": "2026-01-05T18:30:04.621993+00:00"
4773
+ "x-reconciled-at": "2026-01-07T15:29:34.556641+00:00"
4716
4774
  },
4717
4775
  "namespace": {
4718
4776
  "type": "string",
@@ -4721,6 +4779,8 @@
4721
4779
  "x-displayname": "Namespace",
4722
4780
  "x-ves-example": "Staging",
4723
4781
  "x-f5xc-example": "staging",
4782
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4783
+ "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
4784
  "minLength": 0,
4725
4785
  "maxLength": 6,
4726
4786
  "x-f5xc-required-for": {
@@ -4731,9 +4791,10 @@
4731
4791
  },
4732
4792
  "x-original-maxLength": 1024,
4733
4793
  "x-reconciled-from-discovery": true,
4734
- "x-reconciled-at": "2026-01-05T18:30:04.621997+00:00"
4794
+ "x-reconciled-at": "2026-01-07T15:29:34.556645+00:00"
4735
4795
  }
4736
4796
  },
4797
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
4737
4798
  "x-f5xc-minimum-configuration": {
4738
4799
  "description": "Minimum configuration for schemaObjectGetMetaType",
4739
4800
  "required_fields": [
@@ -4777,6 +4838,8 @@
4777
4838
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4778
4839
  "ves.io.schema.rules.map.values.string.min_len": "1"
4779
4840
  },
4841
+ "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.",
4842
+ "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.",
4780
4843
  "x-f5xc-required-for": {
4781
4844
  "minimum_config": false,
4782
4845
  "create": false,
@@ -4798,6 +4861,7 @@
4798
4861
  "x-validation-rules": {
4799
4862
  "ves.io.schema.rules.string.max_bytes": "1200"
4800
4863
  },
4864
+ "x-f5xc-description-short": "Human readable description for the object.",
4801
4865
  "minLength": 0,
4802
4866
  "x-f5xc-required-for": {
4803
4867
  "minimum_config": false,
@@ -4807,7 +4871,7 @@
4807
4871
  },
4808
4872
  "x-original-maxLength": 1200,
4809
4873
  "x-reconciled-from-discovery": true,
4810
- "x-reconciled-at": "2026-01-05T18:30:04.622003+00:00"
4874
+ "x-reconciled-at": "2026-01-07T15:29:34.556652+00:00"
4811
4875
  },
4812
4876
  "disable": {
4813
4877
  "type": "boolean",
@@ -4817,6 +4881,7 @@
4817
4881
  "x-displayname": "Disable",
4818
4882
  "x-ves-example": "True",
4819
4883
  "x-f5xc-example": "true",
4884
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4820
4885
  "x-f5xc-required-for": {
4821
4886
  "minimum_config": false,
4822
4887
  "create": false,
@@ -4831,6 +4896,8 @@
4831
4896
  "x-displayname": "Labels",
4832
4897
  "x-ves-example": "Value",
4833
4898
  "x-f5xc-example": "value",
4899
+ "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.",
4900
+ "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.",
4834
4901
  "x-f5xc-required-for": {
4835
4902
  "minimum_config": false,
4836
4903
  "create": false,
@@ -4852,6 +4919,8 @@
4852
4919
  "x-validation-rules": {
4853
4920
  "ves.io.schema.rules.message.required": "true"
4854
4921
  },
4922
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4923
+ "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.",
4855
4924
  "minLength": 0,
4856
4925
  "maxLength": 16,
4857
4926
  "x-f5xc-required-for": {
@@ -4862,7 +4931,7 @@
4862
4931
  },
4863
4932
  "x-original-maxLength": 1024,
4864
4933
  "x-reconciled-from-discovery": true,
4865
- "x-reconciled-at": "2026-01-05T18:30:04.622010+00:00"
4934
+ "x-reconciled-at": "2026-01-07T15:29:34.556659+00:00"
4866
4935
  },
4867
4936
  "namespace": {
4868
4937
  "type": "string",
@@ -4871,6 +4940,8 @@
4871
4940
  "x-displayname": "Namespace",
4872
4941
  "x-ves-example": "Staging",
4873
4942
  "x-f5xc-example": "staging",
4943
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4944
+ "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 \"\".",
4874
4945
  "minLength": 0,
4875
4946
  "maxLength": 6,
4876
4947
  "x-f5xc-required-for": {
@@ -4881,7 +4952,7 @@
4881
4952
  },
4882
4953
  "x-original-maxLength": 1024,
4883
4954
  "x-reconciled-from-discovery": true,
4884
- "x-reconciled-at": "2026-01-05T18:30:04.622014+00:00"
4955
+ "x-reconciled-at": "2026-01-07T15:29:34.556663+00:00"
4885
4956
  },
4886
4957
  "uid": {
4887
4958
  "type": "string",
@@ -4890,6 +4961,8 @@
4890
4961
  "x-displayname": "UID",
4891
4962
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
4892
4963
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
4964
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system.",
4965
+ "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system. Typically generated by the server on successful creation of an object and is not allowed to change once populated.",
4893
4966
  "minLength": 0,
4894
4967
  "maxLength": 36,
4895
4968
  "x-f5xc-required-for": {
@@ -4903,9 +4976,11 @@
4903
4976
  "x-original-maxLength": 1024,
4904
4977
  "format": "uuid",
4905
4978
  "x-reconciled-from-discovery": true,
4906
- "x-reconciled-at": "2026-01-05T18:30:04.622019+00:00"
4979
+ "x-reconciled-at": "2026-01-07T15:29:34.556669+00:00"
4907
4980
  }
4908
4981
  },
4982
+ "x-f5xc-description-short": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.",
4983
+ "x-f5xc-description-medium": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have. The information in this type can be specified by user during create and replace APIs.",
4909
4984
  "x-f5xc-minimum-configuration": {
4910
4985
  "description": "Minimum configuration for schemaObjectMetaType",
4911
4986
  "required_fields": [
@@ -4938,6 +5013,8 @@
4938
5013
  "x-displayname": "Kind",
4939
5014
  "x-ves-example": "Virtual_site.",
4940
5015
  "x-f5xc-example": "virtual_site",
5016
+ "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\")",
5017
+ "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\").",
4941
5018
  "minLength": 0,
4942
5019
  "maxLength": 14,
4943
5020
  "x-f5xc-required-for": {
@@ -4949,7 +5026,7 @@
4949
5026
  "readOnly": true,
4950
5027
  "x-original-maxLength": 1024,
4951
5028
  "x-reconciled-from-discovery": true,
4952
- "x-reconciled-at": "2026-01-05T18:30:04.622025+00:00"
5029
+ "x-reconciled-at": "2026-01-07T15:29:34.556674+00:00"
4953
5030
  },
4954
5031
  "name": {
4955
5032
  "type": "string",
@@ -4958,6 +5035,8 @@
4958
5035
  "x-displayname": "Name",
4959
5036
  "x-ves-example": "Contactus-route.",
4960
5037
  "x-f5xc-example": "contactus-route",
5038
+ "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.",
5039
+ "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.",
4961
5040
  "minLength": 0,
4962
5041
  "maxLength": 16,
4963
5042
  "x-f5xc-required-for": {
@@ -4968,7 +5047,7 @@
4968
5047
  },
4969
5048
  "x-original-maxLength": 1024,
4970
5049
  "x-reconciled-from-discovery": true,
4971
- "x-reconciled-at": "2026-01-05T18:30:04.622029+00:00"
5050
+ "x-reconciled-at": "2026-01-07T15:29:34.556679+00:00"
4972
5051
  },
4973
5052
  "namespace": {
4974
5053
  "type": "string",
@@ -4977,6 +5056,8 @@
4977
5056
  "x-displayname": "Namespace",
4978
5057
  "x-ves-example": "Ns1",
4979
5058
  "x-f5xc-example": "ns1",
5059
+ "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.",
5060
+ "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.",
4980
5061
  "minLength": 0,
4981
5062
  "maxLength": 6,
4982
5063
  "x-f5xc-required-for": {
@@ -4987,7 +5068,7 @@
4987
5068
  },
4988
5069
  "x-original-maxLength": 1024,
4989
5070
  "x-reconciled-from-discovery": true,
4990
- "x-reconciled-at": "2026-01-05T18:30:04.622060+00:00"
5071
+ "x-reconciled-at": "2026-01-07T15:29:34.556683+00:00"
4991
5072
  },
4992
5073
  "tenant": {
4993
5074
  "type": "string",
@@ -4996,6 +5077,8 @@
4996
5077
  "x-displayname": "Tenant",
4997
5078
  "x-ves-example": "Example-corp.",
4998
5079
  "x-f5xc-example": "example-corp",
5080
+ "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.",
5081
+ "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.",
4999
5082
  "minLength": 0,
5000
5083
  "maxLength": 18,
5001
5084
  "x-f5xc-required-for": {
@@ -5008,7 +5091,7 @@
5008
5091
  "x-field-mutability": "read-only",
5009
5092
  "x-original-maxLength": 1024,
5010
5093
  "x-reconciled-from-discovery": true,
5011
- "x-reconciled-at": "2026-01-05T18:30:04.622066+00:00"
5094
+ "x-reconciled-at": "2026-01-07T15:29:34.556687+00:00"
5012
5095
  },
5013
5096
  "uid": {
5014
5097
  "type": "string",
@@ -5017,6 +5100,8 @@
5017
5100
  "x-displayname": "UID",
5018
5101
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5019
5102
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5103
+ "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.",
5104
+ "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.",
5020
5105
  "minLength": 0,
5021
5106
  "maxLength": 36,
5022
5107
  "x-f5xc-required-for": {
@@ -5030,9 +5115,11 @@
5030
5115
  "x-original-maxLength": 1024,
5031
5116
  "format": "uuid",
5032
5117
  "x-reconciled-from-discovery": true,
5033
- "x-reconciled-at": "2026-01-05T18:30:04.622073+00:00"
5118
+ "x-reconciled-at": "2026-01-07T15:29:34.556692+00:00"
5034
5119
  }
5035
5120
  },
5121
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
5122
+ "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...",
5036
5123
  "x-f5xc-minimum-configuration": {
5037
5124
  "description": "Minimum configuration for schemaObjectRefType",
5038
5125
  "required_fields": [
@@ -5075,6 +5162,8 @@
5075
5162
  "ves.io.schema.rules.map.values.string.max_len": "1024",
5076
5163
  "ves.io.schema.rules.map.values.string.min_len": "1"
5077
5164
  },
5165
+ "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.",
5166
+ "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.",
5078
5167
  "x-f5xc-required-for": {
5079
5168
  "minimum_config": false,
5080
5169
  "create": false,
@@ -5096,6 +5185,7 @@
5096
5185
  "x-validation-rules": {
5097
5186
  "ves.io.schema.rules.string.max_bytes": "1200"
5098
5187
  },
5188
+ "x-f5xc-description-short": "Human readable description for the object.",
5099
5189
  "minLength": 0,
5100
5190
  "x-f5xc-required-for": {
5101
5191
  "minimum_config": false,
@@ -5105,7 +5195,7 @@
5105
5195
  },
5106
5196
  "x-original-maxLength": 1200,
5107
5197
  "x-reconciled-from-discovery": true,
5108
- "x-reconciled-at": "2026-01-05T18:30:04.622081+00:00"
5198
+ "x-reconciled-at": "2026-01-07T15:29:34.556699+00:00"
5109
5199
  },
5110
5200
  "disable": {
5111
5201
  "type": "boolean",
@@ -5114,6 +5204,7 @@
5114
5204
  "format": "boolean",
5115
5205
  "x-displayname": "Disable",
5116
5206
  "x-f5xc-example": "true",
5207
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
5117
5208
  "x-f5xc-required-for": {
5118
5209
  "minimum_config": false,
5119
5210
  "create": false,
@@ -5128,6 +5219,8 @@
5128
5219
  "x-displayname": "Labels",
5129
5220
  "x-ves-example": "Value",
5130
5221
  "x-f5xc-example": "value",
5222
+ "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.",
5223
+ "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.",
5131
5224
  "x-f5xc-required-for": {
5132
5225
  "minimum_config": false,
5133
5226
  "create": false,
@@ -5148,6 +5241,8 @@
5148
5241
  "x-validation-rules": {
5149
5242
  "ves.io.schema.rules.message.required": "true"
5150
5243
  },
5244
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
5245
+ "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.",
5151
5246
  "minLength": 0,
5152
5247
  "maxLength": 16,
5153
5248
  "x-f5xc-required-for": {
@@ -5158,7 +5253,7 @@
5158
5253
  },
5159
5254
  "x-original-maxLength": 1024,
5160
5255
  "x-reconciled-from-discovery": true,
5161
- "x-reconciled-at": "2026-01-05T18:30:04.622090+00:00"
5256
+ "x-reconciled-at": "2026-01-07T15:29:34.556707+00:00"
5162
5257
  },
5163
5258
  "namespace": {
5164
5259
  "type": "string",
@@ -5167,6 +5262,8 @@
5167
5262
  "x-displayname": "Namespace",
5168
5263
  "x-ves-example": "Staging",
5169
5264
  "x-f5xc-example": "staging",
5265
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
5266
+ "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 \"\".",
5170
5267
  "minLength": 0,
5171
5268
  "maxLength": 6,
5172
5269
  "x-f5xc-required-for": {
@@ -5177,9 +5274,10 @@
5177
5274
  },
5178
5275
  "x-original-maxLength": 1024,
5179
5276
  "x-reconciled-from-discovery": true,
5180
- "x-reconciled-at": "2026-01-05T18:30:04.622094+00:00"
5277
+ "x-reconciled-at": "2026-01-07T15:29:34.556711+00:00"
5181
5278
  }
5182
5279
  },
5280
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
5183
5281
  "x-f5xc-minimum-configuration": {
5184
5282
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
5185
5283
  "required_fields": [
@@ -5210,6 +5308,8 @@
5210
5308
  "title": "Creation_timestamp.",
5211
5309
  "format": "date-time",
5212
5310
  "x-displayname": "Creation Timestamp.",
5311
+ "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.",
5312
+ "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.",
5213
5313
  "minLength": 0,
5214
5314
  "maxLength": 1024,
5215
5315
  "x-f5xc-required-for": {
@@ -5227,6 +5327,8 @@
5227
5327
  "x-displayname": "Creator Class.",
5228
5328
  "x-ves-example": "ver.re1.int.ves.I/O.",
5229
5329
  "x-f5xc-example": "ver.re1.int.F5 XC",
5330
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
5331
+ "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.",
5230
5332
  "minLength": 0,
5231
5333
  "maxLength": 1024,
5232
5334
  "x-f5xc-required-for": {
@@ -5244,6 +5346,8 @@
5244
5346
  "x-displayname": "Creator ID.",
5245
5347
  "x-ves-example": "Ver-instance-1.",
5246
5348
  "x-f5xc-example": "ver-instance-1",
5349
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
5350
+ "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.",
5247
5351
  "minLength": 0,
5248
5352
  "maxLength": 1024,
5249
5353
  "x-f5xc-required-for": {
@@ -5262,6 +5366,8 @@
5262
5366
  "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)",
5263
5367
  "title": "Status_id",
5264
5368
  "x-displayname": "Status ID",
5369
+ "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...",
5370
+ "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).",
5265
5371
  "minLength": 0,
5266
5372
  "maxLength": 1024,
5267
5373
  "x-f5xc-required-for": {
@@ -5279,6 +5385,7 @@
5279
5385
  "x-displayname": "UID",
5280
5386
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5281
5387
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5388
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
5282
5389
  "minLength": 0,
5283
5390
  "maxLength": 36,
5284
5391
  "x-f5xc-required-for": {
@@ -5291,13 +5398,14 @@
5291
5398
  "x-original-maxLength": 1024,
5292
5399
  "format": "uuid",
5293
5400
  "x-reconciled-from-discovery": true,
5294
- "x-reconciled-at": "2026-01-05T18:30:04.622108+00:00"
5401
+ "x-reconciled-at": "2026-01-07T15:29:34.556723+00:00"
5295
5402
  },
5296
5403
  "vtrp_id": {
5297
5404
  "type": "string",
5298
5405
  "description": "Origin of this status exchanged by VTRP.",
5299
5406
  "title": "Vtrp_id",
5300
5407
  "x-displayname": "VTRP ID",
5408
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
5301
5409
  "minLength": 0,
5302
5410
  "maxLength": 1024,
5303
5411
  "x-f5xc-required-for": {
@@ -5314,6 +5422,7 @@
5314
5422
  "title": "Vtrp_stale.",
5315
5423
  "format": "boolean",
5316
5424
  "x-displayname": "VTRP Stale.",
5425
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
5317
5426
  "x-f5xc-required-for": {
5318
5427
  "minimum_config": false,
5319
5428
  "create": false,
@@ -5322,6 +5431,7 @@
5322
5431
  }
5323
5432
  }
5324
5433
  },
5434
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
5325
5435
  "x-f5xc-minimum-configuration": {
5326
5436
  "description": "Minimum configuration for schemaStatusMetaType",
5327
5437
  "required_fields": [
@@ -5352,6 +5462,8 @@
5352
5462
  "default": "STATUS_DO_NOT_PUBLISH",
5353
5463
  "x-displayname": "Status Publish Type.",
5354
5464
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
5465
+ "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.",
5466
+ "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.",
5355
5467
  "x-f5xc-minimum-configuration": {
5356
5468
  "description": "Minimum configuration for schemaStatusPublishType",
5357
5469
  "required_fields": [],
@@ -5377,6 +5489,7 @@
5377
5489
  "x-displayname": "Code",
5378
5490
  "x-ves-example": "0",
5379
5491
  "x-f5xc-example": "0",
5492
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
5380
5493
  "minimum": 0,
5381
5494
  "maximum": 2147483647,
5382
5495
  "x-f5xc-required-for": {
@@ -5393,6 +5506,8 @@
5393
5506
  "x-displayname": "Reason",
5394
5507
  "x-ves-example": "Value",
5395
5508
  "x-f5xc-example": "value",
5509
+ "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.",
5510
+ "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.",
5396
5511
  "minLength": 0,
5397
5512
  "maxLength": 43,
5398
5513
  "x-f5xc-required-for": {
@@ -5403,7 +5518,7 @@
5403
5518
  },
5404
5519
  "x-original-maxLength": 1024,
5405
5520
  "x-reconciled-from-discovery": true,
5406
- "x-reconciled-at": "2026-01-05T18:30:04.622118+00:00"
5521
+ "x-reconciled-at": "2026-01-07T15:29:34.556732+00:00"
5407
5522
  },
5408
5523
  "status": {
5409
5524
  "type": "string",
@@ -5412,6 +5527,7 @@
5412
5527
  "x-displayname": "Status",
5413
5528
  "x-ves-example": "Value",
5414
5529
  "x-f5xc-example": "value",
5530
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
5415
5531
  "minLength": 0,
5416
5532
  "maxLength": 17,
5417
5533
  "x-f5xc-required-for": {
@@ -5422,9 +5538,10 @@
5422
5538
  },
5423
5539
  "x-original-maxLength": 1024,
5424
5540
  "x-reconciled-from-discovery": true,
5425
- "x-reconciled-at": "2026-01-05T18:30:04.622122+00:00"
5541
+ "x-reconciled-at": "2026-01-07T15:29:34.556736+00:00"
5426
5542
  }
5427
5543
  },
5544
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
5428
5545
  "x-f5xc-minimum-configuration": {
5429
5546
  "description": "Minimum configuration for schemaStatusType",
5430
5547
  "required_fields": [
@@ -5452,6 +5569,8 @@
5452
5569
  "title": "Creation_timestamp.",
5453
5570
  "format": "date-time",
5454
5571
  "x-displayname": "Creation Timestamp.",
5572
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
5573
+ "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.",
5455
5574
  "minLength": 0,
5456
5575
  "maxLength": 1024,
5457
5576
  "x-f5xc-required-for": {
@@ -5469,6 +5588,7 @@
5469
5588
  "x-displayname": "Creator Class.",
5470
5589
  "x-ves-example": "Prism",
5471
5590
  "x-f5xc-example": "value",
5591
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
5472
5592
  "minLength": 0,
5473
5593
  "maxLength": 1024,
5474
5594
  "x-f5xc-required-for": {
@@ -5486,6 +5606,7 @@
5486
5606
  "x-displayname": "Creator ID.",
5487
5607
  "x-ves-example": "Admin@example-corp.com.",
5488
5608
  "x-f5xc-example": "value",
5609
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
5489
5610
  "minLength": 0,
5490
5611
  "maxLength": 1024,
5491
5612
  "x-f5xc-required-for": {
@@ -5502,6 +5623,8 @@
5502
5623
  "title": "Deletion_timestamp.",
5503
5624
  "format": "date-time",
5504
5625
  "x-displayname": "Deletion Timestamp.",
5626
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
5627
+ "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...",
5505
5628
  "minLength": 0,
5506
5629
  "maxLength": 1024,
5507
5630
  "x-f5xc-required-for": {
@@ -5521,6 +5644,8 @@
5521
5644
  "x-displayname": "Finalizers.",
5522
5645
  "x-ves-example": "Value",
5523
5646
  "x-f5xc-example": "value",
5647
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
5648
+ "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.",
5524
5649
  "x-f5xc-required-for": {
5525
5650
  "minimum_config": false,
5526
5651
  "create": false,
@@ -5538,6 +5663,8 @@
5538
5663
  "x-displayname": "Labels",
5539
5664
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
5540
5665
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
5666
+ "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.",
5667
+ "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).",
5541
5668
  "x-f5xc-required-for": {
5542
5669
  "minimum_config": false,
5543
5670
  "create": false,
@@ -5551,6 +5678,8 @@
5551
5678
  "title": "Modification_timestamp.",
5552
5679
  "format": "date-time",
5553
5680
  "x-displayname": "Modification Timestamp.",
5681
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5682
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5554
5683
  "minLength": 0,
5555
5684
  "maxLength": 1024,
5556
5685
  "x-f5xc-required-for": {
@@ -5569,6 +5698,8 @@
5569
5698
  "x-displayname": "Object Index.",
5570
5699
  "x-ves-example": "0",
5571
5700
  "x-f5xc-example": "0",
5701
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
5702
+ "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.",
5572
5703
  "minimum": 0,
5573
5704
  "maximum": 2147483647,
5574
5705
  "x-f5xc-required-for": {
@@ -5589,6 +5720,8 @@
5589
5720
  "x-displayname": "Tenant",
5590
5721
  "x-ves-example": "Example-corp.",
5591
5722
  "x-f5xc-example": "example-corp",
5723
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5724
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5592
5725
  "minLength": 0,
5593
5726
  "maxLength": 18,
5594
5727
  "x-f5xc-required-for": {
@@ -5600,7 +5733,7 @@
5600
5733
  "x-field-mutability": "read-only",
5601
5734
  "x-original-maxLength": 1024,
5602
5735
  "x-reconciled-from-discovery": true,
5603
- "x-reconciled-at": "2026-01-05T18:30:04.622143+00:00"
5736
+ "x-reconciled-at": "2026-01-07T15:29:34.556755+00:00"
5604
5737
  },
5605
5738
  "uid": {
5606
5739
  "type": "string",
@@ -5609,6 +5742,8 @@
5609
5742
  "x-displayname": "UID",
5610
5743
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5611
5744
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5745
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
5746
+ "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.",
5612
5747
  "minLength": 0,
5613
5748
  "maxLength": 36,
5614
5749
  "x-f5xc-required-for": {
@@ -5621,9 +5756,11 @@
5621
5756
  "x-original-maxLength": 1024,
5622
5757
  "format": "uuid",
5623
5758
  "x-reconciled-from-discovery": true,
5624
- "x-reconciled-at": "2026-01-05T18:30:04.622148+00:00"
5759
+ "x-reconciled-at": "2026-01-07T15:29:34.556760+00:00"
5625
5760
  }
5626
5761
  },
5762
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5763
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5627
5764
  "x-f5xc-minimum-configuration": {
5628
5765
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
5629
5766
  "required_fields": [
@@ -5660,6 +5797,8 @@
5660
5797
  "title": "Creation_timestamp.",
5661
5798
  "format": "date-time",
5662
5799
  "x-displayname": "Creation Timestamp.",
5800
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
5801
+ "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.",
5663
5802
  "minLength": 0,
5664
5803
  "maxLength": 1024,
5665
5804
  "x-f5xc-required-for": {
@@ -5678,6 +5817,7 @@
5678
5817
  "x-displayname": "Creator Class.",
5679
5818
  "x-ves-example": "Value",
5680
5819
  "x-f5xc-example": "value",
5820
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
5681
5821
  "minLength": 0,
5682
5822
  "maxLength": 1024,
5683
5823
  "x-f5xc-required-for": {
@@ -5696,6 +5836,8 @@
5696
5836
  "x-displayname": "Creator Cookie.",
5697
5837
  "x-ves-example": "Value",
5698
5838
  "x-f5xc-example": "value",
5839
+ "x-f5xc-description-short": "Can used by the creator of the object for later audit for e.g.",
5840
+ "x-f5xc-description-medium": "Can used by the creator of the object for later audit for e.g. By storing the version identifying information of the object so at future it can be determined if version present at remote end is current or stale.",
5699
5841
  "minLength": 0,
5700
5842
  "maxLength": 1024,
5701
5843
  "x-f5xc-required-for": {
@@ -5713,6 +5855,7 @@
5713
5855
  "x-displayname": "Creator ID.",
5714
5856
  "x-ves-example": "Value",
5715
5857
  "x-f5xc-example": "value",
5858
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
5716
5859
  "minLength": 0,
5717
5860
  "maxLength": 1024,
5718
5861
  "x-f5xc-required-for": {
@@ -5730,6 +5873,8 @@
5730
5873
  "title": "Deletion_timestamp.",
5731
5874
  "format": "date-time",
5732
5875
  "x-displayname": "Deletion Timestamp.",
5876
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
5877
+ "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...",
5733
5878
  "minLength": 0,
5734
5879
  "maxLength": 1024,
5735
5880
  "x-f5xc-required-for": {
@@ -5744,6 +5889,8 @@
5744
5889
  "description": "A hash of the UIDs of direct references on this object. This can be used to determine if\nthis object hash has had references become resolved/unresolved.",
5745
5890
  "title": "Direct_ref_hash.",
5746
5891
  "x-displayname": "Direct Reference Hash.",
5892
+ "x-f5xc-description-short": "Hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.",
5893
+ "x-f5xc-description-medium": "Hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.",
5747
5894
  "minLength": 0,
5748
5895
  "maxLength": 1024,
5749
5896
  "x-f5xc-required-for": {
@@ -5763,6 +5910,8 @@
5763
5910
  "x-displayname": "Finalizers.",
5764
5911
  "x-ves-example": "Value",
5765
5912
  "x-f5xc-example": "value",
5913
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
5914
+ "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.",
5766
5915
  "x-f5xc-required-for": {
5767
5916
  "minimum_config": false,
5768
5917
  "create": false,
@@ -5780,6 +5929,8 @@
5780
5929
  "x-displayname": "Labels",
5781
5930
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
5782
5931
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
5932
+ "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.",
5933
+ "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).",
5783
5934
  "x-f5xc-required-for": {
5784
5935
  "minimum_config": false,
5785
5936
  "create": false,
@@ -5793,6 +5944,8 @@
5793
5944
  "title": "Modification_timestamp.",
5794
5945
  "format": "date-time",
5795
5946
  "x-displayname": "Modification Timestamp.",
5947
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5948
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5796
5949
  "minLength": 0,
5797
5950
  "maxLength": 1024,
5798
5951
  "x-f5xc-required-for": {
@@ -5819,6 +5972,9 @@
5819
5972
  "x-validation-rules": {
5820
5973
  "ves.io.schema.rules.repeated.max_items": "1"
5821
5974
  },
5975
+ "x-f5xc-example": "example-resource",
5976
+ "x-f5xc-description-short": "The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.",
5977
+ "x-f5xc-description-medium": "The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.",
5822
5978
  "x-f5xc-required-for": {
5823
5979
  "minimum_config": false,
5824
5980
  "create": false,
@@ -5828,7 +5984,7 @@
5828
5984
  "maxLength": 6,
5829
5985
  "minLength": 6,
5830
5986
  "x-reconciled-from-discovery": true,
5831
- "x-reconciled-at": "2026-01-05T18:30:04.622169+00:00"
5987
+ "x-reconciled-at": "2026-01-07T15:29:34.556780+00:00"
5832
5988
  },
5833
5989
  "object_index": {
5834
5990
  "type": "integer",
@@ -5838,6 +5994,8 @@
5838
5994
  "x-displayname": "Object Index.",
5839
5995
  "x-ves-example": "0",
5840
5996
  "x-f5xc-example": "0",
5997
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
5998
+ "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.",
5841
5999
  "minimum": 0,
5842
6000
  "maximum": 2147483647,
5843
6001
  "x-f5xc-required-for": {
@@ -5858,6 +6016,8 @@
5858
6016
  "title": "Revision",
5859
6017
  "format": "int64",
5860
6018
  "x-displayname": "Revision",
6019
+ "x-f5xc-description-short": "Revision number which always increases with each modification of the object in storage This doesn't necessarily increase sequentially, but should...",
6020
+ "x-f5xc-description-medium": "Revision number which always increases with each modification of the object in storage This doesn't necessarily increase sequentially, but should always increase. This will be 0 when first created, and before any modifications.",
5861
6021
  "minLength": 0,
5862
6022
  "maxLength": 1024,
5863
6023
  "x-f5xc-required-for": {
@@ -5875,6 +6035,8 @@
5875
6035
  "x-displayname": "SRE Disable.",
5876
6036
  "x-ves-example": "True",
5877
6037
  "x-f5xc-example": "true",
6038
+ "x-f5xc-description-short": "Should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g.",
6039
+ "x-f5xc-description-medium": "Should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g. Due to bad-form/issue-causing Object). This is meant only to be used in temporary situations for operational continuity till a fix is rolled out in business-logic.",
5878
6040
  "x-f5xc-required-for": {
5879
6041
  "minimum_config": false,
5880
6042
  "create": false,
@@ -5889,6 +6051,8 @@
5889
6051
  "x-displayname": "Tenant",
5890
6052
  "x-ves-example": "Example-corp.",
5891
6053
  "x-f5xc-example": "example-corp",
6054
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
6055
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5892
6056
  "minLength": 0,
5893
6057
  "maxLength": 18,
5894
6058
  "x-f5xc-required-for": {
@@ -5901,7 +6065,7 @@
5901
6065
  "x-field-mutability": "read-only",
5902
6066
  "x-original-maxLength": 1024,
5903
6067
  "x-reconciled-from-discovery": true,
5904
- "x-reconciled-at": "2026-01-05T18:30:04.622179+00:00"
6068
+ "x-reconciled-at": "2026-01-07T15:29:34.556790+00:00"
5905
6069
  },
5906
6070
  "trace_info": {
5907
6071
  "type": "string",
@@ -5910,6 +6074,8 @@
5910
6074
  "x-displayname": "Trace Info.",
5911
6075
  "x-ves-example": "Value",
5912
6076
  "x-f5xc-example": "value",
6077
+ "x-f5xc-description-short": "Trace_info holds information(<trace-ID>:<span-ID>:<parent-span-ID>) of the request doing the object modification.",
6078
+ "x-f5xc-description-medium": "Trace_info holds information(<trace-ID>:<span-ID>:<parent-span-ID>) of the request doing the object modification. This can be used on the watch side to create subsequent spans. This information can be used to co-relate activities across services (modulo state compression) for a synchronous API.",
5913
6079
  "minLength": 0,
5914
6080
  "maxLength": 1024,
5915
6081
  "x-f5xc-required-for": {
@@ -5926,6 +6092,8 @@
5926
6092
  "x-displayname": "UID",
5927
6093
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5928
6094
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
6095
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
6096
+ "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.",
5929
6097
  "minLength": 0,
5930
6098
  "maxLength": 36,
5931
6099
  "x-f5xc-required-for": {
@@ -5939,7 +6107,7 @@
5939
6107
  "x-original-maxLength": 1024,
5940
6108
  "format": "uuid",
5941
6109
  "x-reconciled-from-discovery": true,
5942
- "x-reconciled-at": "2026-01-05T18:30:04.622186+00:00"
6110
+ "x-reconciled-at": "2026-01-07T15:29:34.556797+00:00"
5943
6111
  },
5944
6112
  "vtrp_id": {
5945
6113
  "type": "string",
@@ -5962,6 +6130,7 @@
5962
6130
  "title": "Vtrp_stale.",
5963
6131
  "format": "boolean",
5964
6132
  "x-displayname": "VTRP Stale.",
6133
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
5965
6134
  "x-f5xc-required-for": {
5966
6135
  "minimum_config": false,
5967
6136
  "create": false,
@@ -5970,6 +6139,8 @@
5970
6139
  }
5971
6140
  }
5972
6141
  },
6142
+ "x-f5xc-description-short": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
6143
+ "x-f5xc-description-medium": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5973
6144
  "x-f5xc-minimum-configuration": {
5974
6145
  "description": "Minimum configuration for schemaSystemObjectMetaType",
5975
6146
  "required_fields": [
@@ -6025,7 +6196,7 @@
6025
6196
  },
6026
6197
  "x-original-maxLength": 1024,
6027
6198
  "x-reconciled-from-discovery": true,
6028
- "x-reconciled-at": "2026-01-05T18:30:04.622194+00:00"
6199
+ "x-reconciled-at": "2026-01-07T15:29:34.556804+00:00"
6029
6200
  },
6030
6201
  "name": {
6031
6202
  "type": "string",
@@ -6034,6 +6205,8 @@
6034
6205
  "x-displayname": "Name",
6035
6206
  "x-ves-example": "Contactus-route.",
6036
6207
  "x-f5xc-example": "contactus-route",
6208
+ "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.",
6209
+ "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.",
6037
6210
  "minLength": 0,
6038
6211
  "maxLength": 16,
6039
6212
  "x-f5xc-required-for": {
@@ -6044,7 +6217,7 @@
6044
6217
  },
6045
6218
  "x-original-maxLength": 1024,
6046
6219
  "x-reconciled-from-discovery": true,
6047
- "x-reconciled-at": "2026-01-05T18:30:04.622199+00:00"
6220
+ "x-reconciled-at": "2026-01-07T15:29:34.556808+00:00"
6048
6221
  },
6049
6222
  "namespace": {
6050
6223
  "type": "string",
@@ -6053,6 +6226,8 @@
6053
6226
  "x-displayname": "Namespace",
6054
6227
  "x-ves-example": "Ns1",
6055
6228
  "x-f5xc-example": "ns1",
6229
+ "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.",
6230
+ "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.",
6056
6231
  "minLength": 0,
6057
6232
  "maxLength": 6,
6058
6233
  "x-f5xc-required-for": {
@@ -6063,7 +6238,7 @@
6063
6238
  },
6064
6239
  "x-original-maxLength": 1024,
6065
6240
  "x-reconciled-from-discovery": true,
6066
- "x-reconciled-at": "2026-01-05T18:30:04.622203+00:00"
6241
+ "x-reconciled-at": "2026-01-07T15:29:34.556812+00:00"
6067
6242
  },
6068
6243
  "uid": {
6069
6244
  "type": "string",
@@ -6084,9 +6259,10 @@
6084
6259
  "x-original-maxLength": 1024,
6085
6260
  "format": "uuid",
6086
6261
  "x-reconciled-from-discovery": true,
6087
- "x-reconciled-at": "2026-01-05T18:30:04.622208+00:00"
6262
+ "x-reconciled-at": "2026-01-07T15:29:34.556817+00:00"
6088
6263
  }
6089
6264
  },
6265
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
6090
6266
  "x-f5xc-minimum-configuration": {
6091
6267
  "description": "Minimum configuration for schemaViewRefType",
6092
6268
  "required_fields": [
@@ -6111,6 +6287,8 @@
6111
6287
  "JWT"
6112
6288
  ],
6113
6289
  "default": "NORMAL",
6290
+ "x-f5xc-description-short": "X-displayName: \"Token Type\" Token type has two values, 1. \"normal\", 2. \"JWT\".",
6291
+ "x-f5xc-description-medium": "X-displayName: \"Token Type\" Token type has two values, 1. \"normal\", 2. \"JWT\". For Secure Mesh Site v2 UI, JWT is used, other workflow sticks to normal Single token can be used to register multiple sites - NORMAL: x-displayName: \"Normal\" token is in UUID format - JWT: x-displayName: \"JWT\" token...",
6114
6292
  "x-f5xc-minimum-configuration": {
6115
6293
  "description": "Minimum configuration for schematokenType",
6116
6294
  "required_fields": [],
@@ -6182,6 +6360,8 @@
6182
6360
  "title": "Create token.",
6183
6361
  "x-displayname": "Create Token.",
6184
6362
  "x-ves-proto-message": "ves.io.schema.token.CreateSpecType",
6363
+ "x-f5xc-description-short": "Creates new token. Token object is used to manage site admission.",
6364
+ "x-f5xc-description-medium": "Creates new token. Token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.",
6185
6365
  "x-f5xc-minimum-configuration": {
6186
6366
  "description": "Minimum configuration for tokenCreateSpecType",
6187
6367
  "required_fields": [],
@@ -6205,6 +6385,7 @@
6205
6385
  "title": "Fail_if_referred.",
6206
6386
  "format": "boolean",
6207
6387
  "x-displayname": "Fail-If-Referred.",
6388
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
6208
6389
  "x-f5xc-required-for": {
6209
6390
  "minimum_config": false,
6210
6391
  "create": false,
@@ -6229,7 +6410,7 @@
6229
6410
  },
6230
6411
  "x-original-maxLength": 1024,
6231
6412
  "x-reconciled-from-discovery": true,
6232
- "x-reconciled-at": "2026-01-05T18:30:04.622221+00:00"
6413
+ "x-reconciled-at": "2026-01-07T15:29:34.556830+00:00"
6233
6414
  },
6234
6415
  "namespace": {
6235
6416
  "type": "string",
@@ -6238,6 +6419,7 @@
6238
6419
  "x-displayname": "Namespace",
6239
6420
  "x-ves-example": "Ns1",
6240
6421
  "x-f5xc-example": "ns1",
6422
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
6241
6423
  "minLength": 0,
6242
6424
  "maxLength": 6,
6243
6425
  "x-f5xc-required-for": {
@@ -6248,7 +6430,7 @@
6248
6430
  },
6249
6431
  "x-original-maxLength": 1024,
6250
6432
  "x-reconciled-from-discovery": true,
6251
- "x-reconciled-at": "2026-01-05T18:30:04.622226+00:00"
6433
+ "x-reconciled-at": "2026-01-07T15:29:34.556834+00:00"
6252
6434
  }
6253
6435
  },
6254
6436
  "x-f5xc-minimum-configuration": {
@@ -6287,7 +6469,7 @@
6287
6469
  },
6288
6470
  "x-original-maxLength": 1024,
6289
6471
  "x-reconciled-from-discovery": true,
6290
- "x-reconciled-at": "2026-01-05T18:30:04.622231+00:00"
6472
+ "x-reconciled-at": "2026-01-07T15:29:34.556839+00:00"
6291
6473
  }
6292
6474
  },
6293
6475
  "x-f5xc-minimum-configuration": {
@@ -6320,6 +6502,7 @@
6320
6502
  "$ref": "#/components/schemas/schemaObjectRefType"
6321
6503
  },
6322
6504
  "x-displayname": "Deleted Referred Objects.",
6505
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6323
6506
  "x-f5xc-required-for": {
6324
6507
  "minimum_config": false,
6325
6508
  "create": false,
@@ -6335,6 +6518,7 @@
6335
6518
  "$ref": "#/components/schemas/schemaObjectRefType"
6336
6519
  },
6337
6520
  "x-displayname": "Disabled Referred Objects.",
6521
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6338
6522
  "x-f5xc-required-for": {
6339
6523
  "minimum_config": false,
6340
6524
  "create": false,
@@ -6353,6 +6537,7 @@
6353
6537
  "$ref": "#/components/schemas/schemaObjectRefType"
6354
6538
  },
6355
6539
  "x-displayname": "Referring Objects.",
6540
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
6356
6541
  "x-f5xc-required-for": {
6357
6542
  "minimum_config": false,
6358
6543
  "create": false,
@@ -6374,6 +6559,8 @@
6374
6559
  "$ref": "#/components/schemas/tokenStatusObject"
6375
6560
  },
6376
6561
  "x-displayname": "Status",
6562
+ "x-f5xc-example": "active",
6563
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6377
6564
  "x-f5xc-required-for": {
6378
6565
  "minimum_config": false,
6379
6566
  "create": false,
@@ -6383,7 +6570,7 @@
6383
6570
  "maxLength": 17,
6384
6571
  "minLength": 17,
6385
6572
  "x-reconciled-from-discovery": true,
6386
- "x-reconciled-at": "2026-01-05T18:30:04.622245+00:00"
6573
+ "x-reconciled-at": "2026-01-07T15:29:34.556854+00:00"
6387
6574
  },
6388
6575
  "system_metadata": {
6389
6576
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -6423,6 +6610,8 @@
6423
6610
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
6424
6611
  ],
6425
6612
  "default": "GET_RSP_FORMAT_DEFAULT",
6613
+ "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...",
6614
+ "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...",
6426
6615
  "x-f5xc-minimum-configuration": {
6427
6616
  "description": "Minimum configuration for tokenGetResponseFormatCode",
6428
6617
  "required_fields": [],
@@ -6444,6 +6633,8 @@
6444
6633
  "$ref": "#/components/schemas/tokenState"
6445
6634
  }
6446
6635
  },
6636
+ "x-f5xc-description-short": "GET token. Token object is used to manage site admission.",
6637
+ "x-f5xc-description-medium": "GET token. Token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.",
6447
6638
  "x-f5xc-minimum-configuration": {
6448
6639
  "description": "Minimum configuration for tokenGetSpecType",
6449
6640
  "required_fields": [
@@ -6494,6 +6685,7 @@
6494
6685
  "$ref": "#/components/schemas/schemaErrorType"
6495
6686
  },
6496
6687
  "x-displayname": "Errors",
6688
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
6497
6689
  "x-f5xc-required-for": {
6498
6690
  "minimum_config": false,
6499
6691
  "create": false,
@@ -6509,6 +6701,8 @@
6509
6701
  "$ref": "#/components/schemas/tokenListResponseItem"
6510
6702
  },
6511
6703
  "x-displayname": "Items",
6704
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
6705
+ "x-f5xc-description-short": "Items represents the collection in response.",
6512
6706
  "x-f5xc-required-for": {
6513
6707
  "minimum_config": false,
6514
6708
  "create": false,
@@ -6542,6 +6736,8 @@
6542
6736
  "description": "The set of annotations present on this token.",
6543
6737
  "title": "Annotations.",
6544
6738
  "x-displayname": "Annotations.",
6739
+ "x-f5xc-example": "{\"key\": \"value\"}",
6740
+ "x-f5xc-description-short": "The set of annotations present on this token.",
6545
6741
  "x-f5xc-required-for": {
6546
6742
  "minimum_config": false,
6547
6743
  "create": false,
@@ -6564,7 +6760,7 @@
6564
6760
  },
6565
6761
  "x-original-maxLength": 1024,
6566
6762
  "x-reconciled-from-discovery": true,
6567
- "x-reconciled-at": "2026-01-05T18:30:04.622260+00:00"
6763
+ "x-reconciled-at": "2026-01-07T15:29:34.556867+00:00"
6568
6764
  },
6569
6765
  "disabled": {
6570
6766
  "type": "boolean",
@@ -6572,6 +6768,8 @@
6572
6768
  "title": "Disabled",
6573
6769
  "format": "boolean",
6574
6770
  "x-displayname": "Disabled",
6771
+ "x-f5xc-example": "True",
6772
+ "x-f5xc-description-short": "Value of true indicates token is administratively disabled.",
6575
6773
  "x-f5xc-required-for": {
6576
6774
  "minimum_config": false,
6577
6775
  "create": false,
@@ -6587,6 +6785,8 @@
6587
6785
  "description": "The set of labels present on this token.",
6588
6786
  "title": "Labels",
6589
6787
  "x-displayname": "Labels",
6788
+ "x-f5xc-example": "{\"key\": \"value\"}",
6789
+ "x-f5xc-description-short": "The set of labels present on this token.",
6590
6790
  "x-f5xc-required-for": {
6591
6791
  "minimum_config": false,
6592
6792
  "create": false,
@@ -6614,7 +6814,7 @@
6614
6814
  },
6615
6815
  "x-original-maxLength": 1024,
6616
6816
  "x-reconciled-from-discovery": true,
6617
- "x-reconciled-at": "2026-01-05T18:30:04.622270+00:00"
6817
+ "x-reconciled-at": "2026-01-07T15:29:34.556877+00:00"
6618
6818
  },
6619
6819
  "namespace": {
6620
6820
  "type": "string",
@@ -6633,7 +6833,7 @@
6633
6833
  },
6634
6834
  "x-original-maxLength": 1024,
6635
6835
  "x-reconciled-from-discovery": true,
6636
- "x-reconciled-at": "2026-01-05T18:30:04.622274+00:00"
6836
+ "x-reconciled-at": "2026-01-07T15:29:34.556881+00:00"
6637
6837
  },
6638
6838
  "owner_view": {
6639
6839
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -6646,6 +6846,7 @@
6646
6846
  "$ref": "#/components/schemas/tokenStatusObject"
6647
6847
  },
6648
6848
  "x-displayname": "Status",
6849
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6649
6850
  "x-f5xc-required-for": {
6650
6851
  "minimum_config": false,
6651
6852
  "create": false,
@@ -6674,7 +6875,7 @@
6674
6875
  "x-field-mutability": "read-only",
6675
6876
  "x-original-maxLength": 1024,
6676
6877
  "x-reconciled-from-discovery": true,
6677
- "x-reconciled-at": "2026-01-05T18:30:04.622281+00:00"
6878
+ "x-reconciled-at": "2026-01-07T15:29:34.556889+00:00"
6678
6879
  },
6679
6880
  "uid": {
6680
6881
  "type": "string",
@@ -6695,9 +6896,11 @@
6695
6896
  "x-original-maxLength": 1024,
6696
6897
  "format": "uuid",
6697
6898
  "x-reconciled-from-discovery": true,
6698
- "x-reconciled-at": "2026-01-05T18:30:04.622286+00:00"
6899
+ "x-reconciled-at": "2026-01-07T15:29:34.556894+00:00"
6699
6900
  }
6700
6901
  },
6902
+ "x-f5xc-description-short": "By default a summary of token is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6903
+ "x-f5xc-description-medium": "By default a summary of token is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6701
6904
  "x-f5xc-minimum-configuration": {
6702
6905
  "description": "Minimum configuration for tokenListResponseItem",
6703
6906
  "required_fields": [
@@ -6740,6 +6943,7 @@
6740
6943
  "$ref": "#/components/schemas/schemaSystemObjectMetaType"
6741
6944
  }
6742
6945
  },
6946
+ "x-f5xc-description-short": "Token object store token specification and state.",
6743
6947
  "x-f5xc-minimum-configuration": {
6744
6948
  "description": "Minimum configuration for tokenObject",
6745
6949
  "required_fields": [
@@ -6765,6 +6969,7 @@
6765
6969
  "$ref": "#/components/schemas/tokenObject"
6766
6970
  }
6767
6971
  },
6972
+ "x-f5xc-description-short": "Generic response when object is changed.",
6768
6973
  "x-f5xc-minimum-configuration": {
6769
6974
  "description": "Minimum configuration for tokenObjectChangeResp",
6770
6975
  "required_fields": [
@@ -6823,6 +7028,8 @@
6823
7028
  "title": "Replace token.",
6824
7029
  "x-displayname": "Replace Token.",
6825
7030
  "x-ves-proto-message": "ves.io.schema.token.ReplaceSpecType",
7031
+ "x-f5xc-description-short": "Replaces token. Token object is used to manage site admission.",
7032
+ "x-f5xc-description-medium": "Replaces token. Token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.",
6826
7033
  "x-f5xc-minimum-configuration": {
6827
7034
  "description": "Minimum configuration for tokenReplaceSpecType",
6828
7035
  "required_fields": [],
@@ -6867,6 +7074,8 @@
6867
7074
  "default": "UNKNOWN",
6868
7075
  "x-displayname": "Token State Values.",
6869
7076
  "x-ves-proto-enum": "ves.io.schema.token.State",
7077
+ "x-f5xc-description-short": "Token state defines whether token can be used or node. VALID token is required, other states are invalid.",
7078
+ "x-f5xc-description-medium": "Token state defines whether token can be used or node. VALID token is required, other states are invalid. Single token can be used to register multiple sites Token state isn't set Token can be (RE)used Token can't be used anymore.",
6870
7079
  "x-f5xc-minimum-configuration": {
6871
7080
  "description": "Minimum configuration for tokenState",
6872
7081
  "required_fields": [],
@@ -6891,6 +7100,7 @@
6891
7100
  "x-displayname": "Name",
6892
7101
  "x-ves-example": "Value",
6893
7102
  "x-f5xc-example": "value",
7103
+ "x-f5xc-description-short": "Token object name to change, it's usually same as metadata.uid.",
6894
7104
  "minLength": 0,
6895
7105
  "maxLength": 16,
6896
7106
  "x-f5xc-required-for": {
@@ -6901,7 +7111,7 @@
6901
7111
  },
6902
7112
  "x-original-maxLength": 1024,
6903
7113
  "x-reconciled-from-discovery": true,
6904
- "x-reconciled-at": "2026-01-05T18:30:04.622302+00:00"
7114
+ "x-reconciled-at": "2026-01-07T15:29:34.556908+00:00"
6905
7115
  },
6906
7116
  "namespace": {
6907
7117
  "type": "string",
@@ -6920,12 +7130,13 @@
6920
7130
  },
6921
7131
  "x-original-maxLength": 1024,
6922
7132
  "x-reconciled-from-discovery": true,
6923
- "x-reconciled-at": "2026-01-05T18:30:04.622306+00:00"
7133
+ "x-reconciled-at": "2026-01-07T15:29:34.556912+00:00"
6924
7134
  },
6925
7135
  "state": {
6926
7136
  "$ref": "#/components/schemas/tokenState"
6927
7137
  }
6928
7138
  },
7139
+ "x-f5xc-description-short": "Changes token state, only state is changing, namespace and name is used to find token to change.",
6929
7140
  "x-f5xc-minimum-configuration": {
6930
7141
  "description": "Minimum configuration for tokenStateReq",
6931
7142
  "required_fields": [
@@ -6955,6 +7166,7 @@
6955
7166
  "$ref": "#/components/schemas/schemaConditionType"
6956
7167
  },
6957
7168
  "x-displayname": "Conditions.",
7169
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
6958
7170
  "x-f5xc-required-for": {
6959
7171
  "minimum_config": false,
6960
7172
  "create": false,