@robinmordasiewicz/f5xc-api-mcp 2.0.10-2601051503 → 2.0.19-2601071557

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/CHANGELOG.md +25 -14
  2. package/README.md +9 -5
  3. package/dist/generator/domain-metadata.d.ts +1 -3
  4. package/dist/generator/domain-metadata.d.ts.map +1 -1
  5. package/dist/generator/domain-metadata.js +0 -20
  6. package/dist/generator/domain-metadata.js.map +1 -1
  7. package/dist/generator/naming/acronyms.d.ts +1 -1
  8. package/dist/generator/naming/acronyms.js +1 -1
  9. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  10. package/dist/tools/generated/ce_management/index.js +179 -1582
  11. package/dist/tools/generated/ce_management/index.js.map +1 -1
  12. package/dist/tools/generated/dependency-graph.json +2 -265
  13. package/dist/version.d.ts +2 -2
  14. package/dist/version.js +2 -2
  15. package/manifest.json +1 -1
  16. package/package.json +1 -1
  17. package/specs/domains/admin_console_and_ui.json +176 -26
  18. package/specs/domains/ai_services.json +242 -36
  19. package/specs/domains/api.json +1507 -183
  20. package/specs/domains/authentication.json +358 -46
  21. package/specs/domains/bigip.json +825 -105
  22. package/specs/domains/billing_and_usage.json +666 -83
  23. package/specs/domains/blindfold.json +988 -111
  24. package/specs/domains/bot_and_threat_defense.json +550 -66
  25. package/specs/domains/cdn.json +2431 -198
  26. package/specs/domains/ce_management.json +9272 -15726
  27. package/specs/domains/certificates.json +540 -78
  28. package/specs/domains/cloud_infrastructure.json +1102 -122
  29. package/specs/domains/container_services.json +782 -99
  30. package/specs/domains/data_and_privacy_security.json +508 -68
  31. package/specs/domains/data_intelligence.json +487 -64
  32. package/specs/domains/ddos.json +1302 -161
  33. package/specs/domains/dns.json +1286 -162
  34. package/specs/domains/managed_kubernetes.json +687 -89
  35. package/specs/domains/marketplace.json +994 -105
  36. package/specs/domains/network.json +2340 -239
  37. package/specs/domains/network_security.json +1963 -192
  38. package/specs/domains/nginx_one.json +475 -63
  39. package/specs/domains/object_storage.json +163 -16
  40. package/specs/domains/observability.json +1519 -148
  41. package/specs/domains/rate_limiting.json +456 -56
  42. package/specs/domains/secops_and_incident_response.json +275 -37
  43. package/specs/domains/service_mesh.json +1320 -128
  44. package/specs/domains/shape.json +4196 -398
  45. package/specs/domains/sites.json +5053 -405
  46. package/specs/domains/statistics.json +2784 -236
  47. package/specs/domains/support.json +1038 -109
  48. package/specs/domains/telemetry_and_insights.json +993 -80
  49. package/specs/domains/tenant_and_identity.json +3487 -313
  50. package/specs/domains/threat_campaign.json +695 -72
  51. package/specs/domains/users.json +437 -72
  52. package/specs/domains/virtual.json +3716 -261
  53. package/specs/domains/vpm_and_node_management.json +61 -2
  54. package/specs/domains/waf.json +1551 -149
  55. package/specs/index.json +121 -26
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Authentication",
5
5
  "description": "F5 Distributed Cloud Authentication API specifications",
6
- "version": "2.0.10",
6
+ "version": "2.0.19",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -12,7 +12,33 @@
12
12
  "name": "Proprietary",
13
13
  "url": "https://www.f5.com/company/policies/eula"
14
14
  },
15
- "x-f5xc-cli-domain": "authentication"
15
+ "x-f5xc-cli-domain": "authentication",
16
+ "x-f5xc-best-practices": {
17
+ "common_errors": [
18
+ {
19
+ "code": 401,
20
+ "message": "Token expired",
21
+ "resolution": "Refresh token or re-authenticate",
22
+ "prevention": "Implement automatic token refresh"
23
+ },
24
+ {
25
+ "code": 403,
26
+ "message": "Insufficient permissions",
27
+ "resolution": "Request additional role assignments",
28
+ "prevention": "Verify permissions before operations"
29
+ }
30
+ ],
31
+ "security_notes": [
32
+ "Use short-lived tokens with refresh capability",
33
+ "Enable MFA for administrative access",
34
+ "Implement least privilege access policies"
35
+ ],
36
+ "performance_tips": [
37
+ "Cache authentication tokens appropriately",
38
+ "Use service accounts for automation",
39
+ "Implement token pooling for high-volume scenarios"
40
+ ]
41
+ }
16
42
  },
17
43
  "servers": [
18
44
  {
@@ -253,6 +279,13 @@
253
279
  "latency": "high",
254
280
  "resource_usage": "high"
255
281
  }
282
+ },
283
+ "x-f5xc-discovered-response-time": {
284
+ "p50_ms": 1000,
285
+ "p95_ms": 3000,
286
+ "p99_ms": 8000,
287
+ "sample_count": 0,
288
+ "source": "estimate"
256
289
  }
257
290
  },
258
291
  "x-displayname": "API/Service Credentials.",
@@ -445,6 +478,13 @@
445
478
  "latency": "high",
446
479
  "resource_usage": "high"
447
480
  }
481
+ },
482
+ "x-f5xc-discovered-response-time": {
483
+ "p50_ms": 1000,
484
+ "p95_ms": 3000,
485
+ "p99_ms": 8000,
486
+ "sample_count": 0,
487
+ "source": "estimate"
448
488
  }
449
489
  },
450
490
  "x-displayname": "API/Service Credentials.",
@@ -652,6 +692,13 @@
652
692
  "latency": "low",
653
693
  "resource_usage": "low"
654
694
  }
695
+ },
696
+ "x-f5xc-discovered-response-time": {
697
+ "p50_ms": 1000,
698
+ "p95_ms": 3000,
699
+ "p99_ms": 8000,
700
+ "sample_count": 0,
701
+ "source": "estimate"
655
702
  }
656
703
  },
657
704
  "x-displayname": "API/Service Credentials.",
@@ -859,6 +906,13 @@
859
906
  "latency": "low",
860
907
  "resource_usage": "low"
861
908
  }
909
+ },
910
+ "x-f5xc-discovered-response-time": {
911
+ "p50_ms": 1000,
912
+ "p95_ms": 3000,
913
+ "p99_ms": 8000,
914
+ "sample_count": 0,
915
+ "source": "estimate"
862
916
  }
863
917
  },
864
918
  "x-displayname": "API/Service Credentials.",
@@ -1047,6 +1101,13 @@
1047
1101
  "latency": "moderate",
1048
1102
  "resource_usage": "moderate"
1049
1103
  }
1104
+ },
1105
+ "x-f5xc-discovered-response-time": {
1106
+ "p50_ms": 200,
1107
+ "p95_ms": 800,
1108
+ "p99_ms": 2000,
1109
+ "sample_count": 0,
1110
+ "source": "estimate"
1050
1111
  }
1051
1112
  },
1052
1113
  "post": {
@@ -1256,6 +1317,13 @@
1256
1317
  "latency": "low",
1257
1318
  "resource_usage": "low"
1258
1319
  }
1320
+ },
1321
+ "x-f5xc-discovered-response-time": {
1322
+ "p50_ms": 1000,
1323
+ "p95_ms": 3000,
1324
+ "p99_ms": 8000,
1325
+ "sample_count": 0,
1326
+ "source": "estimate"
1259
1327
  }
1260
1328
  },
1261
1329
  "x-displayname": "API/Service Credentials.",
@@ -1457,6 +1525,13 @@
1457
1525
  "latency": "low",
1458
1526
  "resource_usage": "low"
1459
1527
  }
1528
+ },
1529
+ "x-f5xc-discovered-response-time": {
1530
+ "p50_ms": 200,
1531
+ "p95_ms": 800,
1532
+ "p99_ms": 2000,
1533
+ "sample_count": 0,
1534
+ "source": "estimate"
1460
1535
  }
1461
1536
  },
1462
1537
  "x-displayname": "API/Service Credentials.",
@@ -1664,6 +1739,13 @@
1664
1739
  "latency": "low",
1665
1740
  "resource_usage": "low"
1666
1741
  }
1742
+ },
1743
+ "x-f5xc-discovered-response-time": {
1744
+ "p50_ms": 1000,
1745
+ "p95_ms": 3000,
1746
+ "p99_ms": 8000,
1747
+ "sample_count": 0,
1748
+ "source": "estimate"
1667
1749
  }
1668
1750
  },
1669
1751
  "x-displayname": "API/Service Credentials.",
@@ -1871,6 +1953,13 @@
1871
1953
  "latency": "low",
1872
1954
  "resource_usage": "low"
1873
1955
  }
1956
+ },
1957
+ "x-f5xc-discovered-response-time": {
1958
+ "p50_ms": 1000,
1959
+ "p95_ms": 3000,
1960
+ "p99_ms": 8000,
1961
+ "sample_count": 0,
1962
+ "source": "estimate"
1874
1963
  }
1875
1964
  },
1876
1965
  "x-displayname": "API/Service Credentials.",
@@ -2078,6 +2167,13 @@
2078
2167
  "latency": "low",
2079
2168
  "resource_usage": "low"
2080
2169
  }
2170
+ },
2171
+ "x-f5xc-discovered-response-time": {
2172
+ "p50_ms": 1000,
2173
+ "p95_ms": 3000,
2174
+ "p99_ms": 8000,
2175
+ "sample_count": 0,
2176
+ "source": "estimate"
2081
2177
  }
2082
2178
  },
2083
2179
  "x-displayname": "API/Service Credentials.",
@@ -2292,6 +2388,13 @@
2292
2388
  "latency": "low",
2293
2389
  "resource_usage": "low"
2294
2390
  }
2391
+ },
2392
+ "x-f5xc-discovered-response-time": {
2393
+ "p50_ms": 1000,
2394
+ "p95_ms": 3000,
2395
+ "p99_ms": 8000,
2396
+ "sample_count": 0,
2397
+ "source": "estimate"
2295
2398
  }
2296
2399
  },
2297
2400
  "x-displayname": "API/Service Credentials.",
@@ -2499,6 +2602,13 @@
2499
2602
  "latency": "low",
2500
2603
  "resource_usage": "low"
2501
2604
  }
2605
+ },
2606
+ "x-f5xc-discovered-response-time": {
2607
+ "p50_ms": 1000,
2608
+ "p95_ms": 3000,
2609
+ "p99_ms": 8000,
2610
+ "sample_count": 0,
2611
+ "source": "estimate"
2502
2612
  }
2503
2613
  },
2504
2614
  "x-displayname": "API/Service Credentials.",
@@ -2687,6 +2797,13 @@
2687
2797
  "latency": "moderate",
2688
2798
  "resource_usage": "moderate"
2689
2799
  }
2800
+ },
2801
+ "x-f5xc-discovered-response-time": {
2802
+ "p50_ms": 200,
2803
+ "p95_ms": 800,
2804
+ "p99_ms": 2000,
2805
+ "sample_count": 0,
2806
+ "source": "estimate"
2690
2807
  }
2691
2808
  },
2692
2809
  "post": {
@@ -2896,6 +3013,13 @@
2896
3013
  "latency": "low",
2897
3014
  "resource_usage": "low"
2898
3015
  }
3016
+ },
3017
+ "x-f5xc-discovered-response-time": {
3018
+ "p50_ms": 1000,
3019
+ "p95_ms": 3000,
3020
+ "p99_ms": 8000,
3021
+ "sample_count": 0,
3022
+ "source": "estimate"
2899
3023
  }
2900
3024
  },
2901
3025
  "x-displayname": "API/Service Credentials.",
@@ -3084,6 +3208,13 @@
3084
3208
  "latency": "moderate",
3085
3209
  "resource_usage": "moderate"
3086
3210
  }
3211
+ },
3212
+ "x-f5xc-discovered-response-time": {
3213
+ "p50_ms": 200,
3214
+ "p95_ms": 800,
3215
+ "p99_ms": 2000,
3216
+ "sample_count": 0,
3217
+ "source": "estimate"
3087
3218
  }
3088
3219
  },
3089
3220
  "post": {
@@ -3293,6 +3424,13 @@
3293
3424
  "latency": "low",
3294
3425
  "resource_usage": "low"
3295
3426
  }
3427
+ },
3428
+ "x-f5xc-discovered-response-time": {
3429
+ "p50_ms": 1000,
3430
+ "p95_ms": 3000,
3431
+ "p99_ms": 8000,
3432
+ "sample_count": 0,
3433
+ "source": "estimate"
3296
3434
  }
3297
3435
  },
3298
3436
  "x-displayname": "API/Service Credentials.",
@@ -3494,6 +3632,13 @@
3494
3632
  "latency": "low",
3495
3633
  "resource_usage": "low"
3496
3634
  }
3635
+ },
3636
+ "x-f5xc-discovered-response-time": {
3637
+ "p50_ms": 200,
3638
+ "p95_ms": 800,
3639
+ "p99_ms": 2000,
3640
+ "sample_count": 0,
3641
+ "source": "estimate"
3497
3642
  }
3498
3643
  },
3499
3644
  "put": {
@@ -3711,6 +3856,13 @@
3711
3856
  "latency": "low",
3712
3857
  "resource_usage": "low"
3713
3858
  }
3859
+ },
3860
+ "x-f5xc-discovered-response-time": {
3861
+ "p50_ms": 800,
3862
+ "p95_ms": 2500,
3863
+ "p99_ms": 6000,
3864
+ "sample_count": 0,
3865
+ "source": "estimate"
3714
3866
  }
3715
3867
  },
3716
3868
  "x-displayname": "API/Service Credentials.",
@@ -3746,6 +3898,8 @@
3746
3898
  "default": "API_CERTIFICATE",
3747
3899
  "x-displayname": "Credential Type.",
3748
3900
  "x-ves-proto-enum": "ves.io.schema.api_credential.APICredentialType",
3901
+ "x-f5xc-description-short": "Types of API credential given when requesting credentials from F5 Distributed Cloud F5XC user certificate to access F5XC public API using mTLS...",
3902
+ "x-f5xc-description-medium": "Types of API credential given when requesting credentials from F5 Distributed Cloud F5XC user certificate to access F5XC public API using mTLS using self credential (my credential) Kubernetes config file to access Virtual Kubernetes API in F5 Distributed Cloud using self credential (my...",
3749
3903
  "x-f5xc-minimum-configuration": {
3750
3904
  "description": "Minimum configuration for api_credentialAPICredentialType",
3751
3905
  "required_fields": [],
@@ -3783,6 +3937,8 @@
3783
3937
  "ves.io.schema.rules.string.max_bytes": "50",
3784
3938
  "ves.io.schema.rules.string.min_bytes": "6"
3785
3939
  },
3940
+ "x-f5xc-description-short": "Password is used for generating an API certificate P12 bundle user can use to protect access to it.",
3941
+ "x-f5xc-description-medium": "Password is used for generating an API certificate P12 bundle user can use to protect access to it. This password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE Users have to use this password when they use the certificate, e.g.",
3786
3942
  "x-f5xc-required-for": {
3787
3943
  "minimum_config": false,
3788
3944
  "create": false,
@@ -3818,6 +3974,7 @@
3818
3974
  "$ref": "#/components/schemas/api_credentialNameSelector"
3819
3975
  }
3820
3976
  },
3977
+ "x-f5xc-description-short": "Request format for revoking multiple API credentials.",
3821
3978
  "x-f5xc-minimum-configuration": {
3822
3979
  "description": "Minimum configuration for api_credentialBulkRevokeRequest",
3823
3980
  "required_fields": [
@@ -3846,6 +4003,7 @@
3846
4003
  "type": "string"
3847
4004
  },
3848
4005
  "x-displayname": "Credentials Failed.",
4006
+ "x-f5xc-description-short": "Names of credentials that are not marked as DELETE due to some error.",
3849
4007
  "x-f5xc-required-for": {
3850
4008
  "minimum_config": false,
3851
4009
  "create": false,
@@ -3861,6 +4019,7 @@
3861
4019
  "type": "string"
3862
4020
  },
3863
4021
  "x-displayname": "Credentials Success.",
4022
+ "x-f5xc-description-short": "Names of credentials that are successfully marked for deletion.",
3864
4023
  "x-f5xc-required-for": {
3865
4024
  "minimum_config": false,
3866
4025
  "create": false,
@@ -3873,6 +4032,7 @@
3873
4032
  "description": "Error message about the failures of bulk revoke of credentials.",
3874
4033
  "title": "Error message.",
3875
4034
  "x-displayname": "Error Message.",
4035
+ "x-f5xc-description-short": "Error message about the failures of bulk revoke of credentials.",
3876
4036
  "minLength": 0,
3877
4037
  "maxLength": 1024,
3878
4038
  "x-f5xc-required-for": {
@@ -3883,6 +4043,7 @@
3883
4043
  }
3884
4044
  }
3885
4045
  },
4046
+ "x-f5xc-description-short": "Response format for revoking multiple API credentials.",
3886
4047
  "x-f5xc-minimum-configuration": {
3887
4048
  "description": "Minimum configuration for api_credentialBulkRevokeResponse",
3888
4049
  "required_fields": [
@@ -3913,6 +4074,7 @@
3913
4074
  "x-displayname": "Expiry in days.",
3914
4075
  "x-ves-example": "Value",
3915
4076
  "x-f5xc-example": "value",
4077
+ "x-f5xc-description-short": "Qty of days of service credential expiration.",
3916
4078
  "minimum": 0,
3917
4079
  "maximum": 2147483647,
3918
4080
  "x-f5xc-required-for": {
@@ -3929,6 +4091,7 @@
3929
4091
  "x-displayname": "Name",
3930
4092
  "x-ves-example": "Value",
3931
4093
  "x-f5xc-example": "value",
4094
+ "x-f5xc-description-short": "Name of API credential record. It will be saved in metadata.",
3932
4095
  "minLength": 0,
3933
4096
  "maxLength": 16,
3934
4097
  "x-f5xc-required-for": {
@@ -3939,7 +4102,7 @@
3939
4102
  },
3940
4103
  "x-original-maxLength": 1024,
3941
4104
  "x-reconciled-from-discovery": true,
3942
- "x-reconciled-at": "2026-01-05T14:37:35.878958+00:00"
4105
+ "x-reconciled-at": "2026-01-07T15:27:46.954169+00:00"
3943
4106
  },
3944
4107
  "namespace": {
3945
4108
  "type": "string",
@@ -3958,12 +4121,13 @@
3958
4121
  },
3959
4122
  "x-original-maxLength": 1024,
3960
4123
  "x-reconciled-from-discovery": true,
3961
- "x-reconciled-at": "2026-01-05T14:37:35.878964+00:00"
4124
+ "x-reconciled-at": "2026-01-07T15:27:46.954182+00:00"
3962
4125
  },
3963
4126
  "spec": {
3964
4127
  "$ref": "#/components/schemas/api_credentialCustomCreateSpecType"
3965
4128
  }
3966
4129
  },
4130
+ "x-f5xc-description-short": "CreateRequest is the request format for generating API credential.",
3967
4131
  "x-f5xc-minimum-configuration": {
3968
4132
  "description": "Minimum configuration for api_credentialCreateRequest",
3969
4133
  "required_fields": [
@@ -3990,6 +4154,8 @@
3990
4154
  "active": {
3991
4155
  "type": "boolean",
3992
4156
  "format": "boolean",
4157
+ "description": "Indicates if the resource is active",
4158
+ "x-f5xc-example": "True",
3993
4159
  "x-f5xc-required-for": {
3994
4160
  "minimum_config": false,
3995
4161
  "create": false,
@@ -4004,6 +4170,8 @@
4004
4170
  "x-displayname": "Credentials.",
4005
4171
  "x-ves-example": "Value",
4006
4172
  "x-f5xc-example": "value",
4173
+ "x-f5xc-description-short": "Data is the response format based on the API credential type.",
4174
+ "x-f5xc-description-medium": "Data is the response format based on the API credential type. In case of API_CERTIFICATES, the response is the base64 encoded value of certificate in PKCS12 format. In case of KUBE_CONFIG, the response is the base64 encoded value of the K8s kubeconfig file with contents as requested ...",
4007
4175
  "minLength": 0,
4008
4176
  "maxLength": 1024,
4009
4177
  "x-f5xc-required-for": {
@@ -4016,6 +4184,8 @@
4016
4184
  "expiration_timestamp": {
4017
4185
  "type": "string",
4018
4186
  "format": "date-time",
4187
+ "description": "Configuration parameter for expiration timestamp",
4188
+ "x-f5xc-description-short": "Configuration parameter for expiration timestamp.",
4019
4189
  "minLength": 0,
4020
4190
  "maxLength": 1024,
4021
4191
  "x-f5xc-required-for": {
@@ -4039,9 +4209,10 @@
4039
4209
  },
4040
4210
  "x-original-maxLength": 1024,
4041
4211
  "x-reconciled-from-discovery": true,
4042
- "x-reconciled-at": "2026-01-05T14:37:35.878977+00:00"
4212
+ "x-reconciled-at": "2026-01-07T15:27:46.954202+00:00"
4043
4213
  }
4044
4214
  },
4215
+ "x-f5xc-description-short": "CreateResponse is the response format for the credential's create request.",
4045
4216
  "x-f5xc-minimum-configuration": {
4046
4217
  "description": "Minimum configuration for api_credentialCreateResponse",
4047
4218
  "required_fields": [
@@ -4079,6 +4250,7 @@
4079
4250
  "x-displayname": "Expiry in days.",
4080
4251
  "x-ves-example": "Value",
4081
4252
  "x-f5xc-example": "value",
4253
+ "x-f5xc-description-short": "Qty of days of service credential expiration.",
4082
4254
  "minimum": 0,
4083
4255
  "maximum": 2147483647,
4084
4256
  "x-f5xc-required-for": {
@@ -4095,6 +4267,7 @@
4095
4267
  "x-displayname": "Name",
4096
4268
  "x-ves-example": "Svc-cred-app1.",
4097
4269
  "x-f5xc-example": "svc-cred-app1",
4270
+ "x-f5xc-description-short": "Name of API credential record. It will be saved in metadata.",
4098
4271
  "minLength": 0,
4099
4272
  "maxLength": 16,
4100
4273
  "x-f5xc-required-for": {
@@ -4105,7 +4278,7 @@
4105
4278
  },
4106
4279
  "x-original-maxLength": 1024,
4107
4280
  "x-reconciled-from-discovery": true,
4108
- "x-reconciled-at": "2026-01-05T14:37:35.878986+00:00"
4281
+ "x-reconciled-at": "2026-01-07T15:27:46.954219+00:00"
4109
4282
  },
4110
4283
  "namespace": {
4111
4284
  "type": "string",
@@ -4124,7 +4297,7 @@
4124
4297
  },
4125
4298
  "x-original-maxLength": 1024,
4126
4299
  "x-reconciled-from-discovery": true,
4127
- "x-reconciled-at": "2026-01-05T14:37:35.878991+00:00"
4300
+ "x-reconciled-at": "2026-01-07T15:27:46.954228+00:00"
4128
4301
  },
4129
4302
  "namespace_roles": {
4130
4303
  "type": "array",
@@ -4136,6 +4309,7 @@
4136
4309
  "x-displayname": "List of roles.",
4137
4310
  "x-ves-example": "Value",
4138
4311
  "x-f5xc-example": "value",
4312
+ "x-f5xc-description-short": "List of roles per namespace to be assigned to service credentials.",
4139
4313
  "x-f5xc-required-for": {
4140
4314
  "minimum_config": false,
4141
4315
  "create": false,
@@ -4157,6 +4331,8 @@
4157
4331
  "x-validation-rules": {
4158
4332
  "ves.io.schema.rules.message.required": "true"
4159
4333
  },
4334
+ "x-f5xc-description-short": "Password is used for generating an API certificate P12 bundle user can use to protect access to it.",
4335
+ "x-f5xc-description-medium": "Password is used for generating an API certificate P12 bundle user can use to protect access to it. This password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE Users have to use this password when they use the certificate, e.g.",
4160
4336
  "minLength": 0,
4161
4337
  "maxLength": 1024,
4162
4338
  "x-f5xc-required-for": {
@@ -4182,6 +4358,7 @@
4182
4358
  "x-displayname": "Groups",
4183
4359
  "x-ves-example": "[\"dev-group-1\"]",
4184
4360
  "x-f5xc-example": "\"[\"dev-group-1\"]\"",
4361
+ "x-f5xc-description-short": "List of user_groups assigned to this service credential.",
4185
4362
  "x-f5xc-required-for": {
4186
4363
  "minimum_config": false,
4187
4364
  "create": false,
@@ -4196,6 +4373,7 @@
4196
4373
  "x-displayname": "VK8s Cluster.",
4197
4374
  "x-ves-example": "Vk8s-product-app1.",
4198
4375
  "x-f5xc-example": "vk8s-product-app1",
4376
+ "x-f5xc-description-short": "Name of virtual_k8s cluster. Applicable for KUBE_CONFIG.",
4199
4377
  "minLength": 0,
4200
4378
  "maxLength": 1024,
4201
4379
  "x-f5xc-required-for": {
@@ -4212,6 +4390,7 @@
4212
4390
  "x-displayname": "VK8s Namespace.",
4213
4391
  "x-ves-example": "App-ns1",
4214
4392
  "x-f5xc-example": "app-ns1",
4393
+ "x-f5xc-description-short": "Namespace of virtual_k8s cluster. Applicable for KUBE_CONFIG.",
4215
4394
  "minLength": 0,
4216
4395
  "maxLength": 1024,
4217
4396
  "x-f5xc-required-for": {
@@ -4225,6 +4404,7 @@
4225
4404
  "$ref": "#/components/schemas/api_credentialVk8sKubeconfigType"
4226
4405
  }
4227
4406
  },
4407
+ "x-f5xc-description-short": "CreateServiceCredentialsRequest is the request format for creating service credentials.",
4228
4408
  "x-f5xc-minimum-configuration": {
4229
4409
  "description": "Minimum configuration for api_credentialCreateServiceCredentialsRequest",
4230
4410
  "required_fields": [
@@ -4271,6 +4451,8 @@
4271
4451
  "x-validation-rules": {
4272
4452
  "ves.io.schema.rules.message.required": "true"
4273
4453
  },
4454
+ "x-f5xc-description-short": "Password is used for generating an API certificate P12 bundle user can use to protect access to it.",
4455
+ "x-f5xc-description-medium": "Password is used for generating an API certificate P12 bundle user can use to protect access to it. This password will not be saved/persisted anywhere in the system. Applicable for credential type API_CERTIFICATE Users have to use this password when they use the certificate, e.g.",
4274
4456
  "minLength": 0,
4275
4457
  "maxLength": 1024,
4276
4458
  "x-f5xc-required-for": {
@@ -4290,6 +4472,7 @@
4290
4472
  "x-displayname": "VK8s Cluster.",
4291
4473
  "x-ves-example": "Vk8s-product-app1.",
4292
4474
  "x-f5xc-example": "vk8s-product-app1",
4475
+ "x-f5xc-description-short": "Name of virtual K8s cluster. Applicable for KUBE_CONFIG.",
4293
4476
  "minLength": 0,
4294
4477
  "maxLength": 1024,
4295
4478
  "x-f5xc-required-for": {
@@ -4306,6 +4489,7 @@
4306
4489
  "x-displayname": "VK8s Namespace.",
4307
4490
  "x-ves-example": "App-ns1",
4308
4491
  "x-f5xc-example": "app-ns1",
4492
+ "x-f5xc-description-short": "Namespace of virtual K8s cluster. Applicable for KUBE_CONFIG.",
4309
4493
  "minLength": 0,
4310
4494
  "maxLength": 1024,
4311
4495
  "x-f5xc-required-for": {
@@ -4346,6 +4530,7 @@
4346
4530
  "$ref": "#/components/schemas/api_credentialAPICredentialType"
4347
4531
  }
4348
4532
  },
4533
+ "x-f5xc-description-short": "It specifies which expired credentials needs to be deleted.",
4349
4534
  "x-f5xc-minimum-configuration": {
4350
4535
  "description": "Minimum configuration for api_credentialExpiredSelector",
4351
4536
  "required_fields": [
@@ -4390,7 +4575,7 @@
4390
4575
  },
4391
4576
  "x-original-maxLength": 1024,
4392
4577
  "x-reconciled-from-discovery": true,
4393
- "x-reconciled-at": "2026-01-05T14:37:35.879017+00:00"
4578
+ "x-reconciled-at": "2026-01-07T15:27:46.954273+00:00"
4394
4579
  },
4395
4580
  "namespace": {
4396
4581
  "type": "string",
@@ -4406,6 +4591,7 @@
4406
4591
  "x-validation-rules": {
4407
4592
  "ves.io.schema.rules.message.required": "true"
4408
4593
  },
4594
+ "x-f5xc-description-short": "Value of namespace is always \"system\". Required: YES.",
4409
4595
  "minLength": 0,
4410
4596
  "maxLength": 6,
4411
4597
  "x-f5xc-required-for": {
@@ -4416,9 +4602,10 @@
4416
4602
  },
4417
4603
  "x-original-maxLength": 1024,
4418
4604
  "x-reconciled-from-discovery": true,
4419
- "x-reconciled-at": "2026-01-05T14:37:35.879021+00:00"
4605
+ "x-reconciled-at": "2026-01-07T15:27:46.954284+00:00"
4420
4606
  }
4421
4607
  },
4608
+ "x-f5xc-description-short": "GET credential object with a given name.",
4422
4609
  "x-f5xc-minimum-configuration": {
4423
4610
  "description": "Minimum configuration for api_credentialGetRequest",
4424
4611
  "required_fields": [
@@ -4443,6 +4630,7 @@
4443
4630
  "$ref": "#/components/schemas/api_credentialObject"
4444
4631
  }
4445
4632
  },
4633
+ "x-f5xc-description-short": "Response of GET credential request with a given name.",
4446
4634
  "x-f5xc-minimum-configuration": {
4447
4635
  "description": "Minimum configuration for api_credentialGetResponse",
4448
4636
  "required_fields": [
@@ -4470,6 +4658,7 @@
4470
4658
  "x-displayname": "Active",
4471
4659
  "x-ves-example": "True",
4472
4660
  "x-f5xc-example": "true",
4661
+ "x-f5xc-description-short": "Possibility to deactivate credential with no deletion.",
4473
4662
  "x-f5xc-required-for": {
4474
4663
  "minimum_config": false,
4475
4664
  "create": false,
@@ -4524,7 +4713,7 @@
4524
4713
  },
4525
4714
  "x-original-maxLength": 1024,
4526
4715
  "x-reconciled-from-discovery": true,
4527
- "x-reconciled-at": "2026-01-05T14:37:35.879033+00:00"
4716
+ "x-reconciled-at": "2026-01-07T15:27:46.954302+00:00"
4528
4717
  },
4529
4718
  "namespace": {
4530
4719
  "type": "string",
@@ -4543,7 +4732,7 @@
4543
4732
  },
4544
4733
  "x-original-maxLength": 1024,
4545
4734
  "x-reconciled-from-discovery": true,
4546
- "x-reconciled-at": "2026-01-05T14:37:35.879037+00:00"
4735
+ "x-reconciled-at": "2026-01-07T15:27:46.954311+00:00"
4547
4736
  },
4548
4737
  "namespace_access": {
4549
4738
  "$ref": "#/components/schemas/schemaNamespaceAccessType"
@@ -4570,7 +4759,7 @@
4570
4759
  "x-original-maxLength": 1024,
4571
4760
  "format": "uuid",
4572
4761
  "x-reconciled-from-discovery": true,
4573
- "x-reconciled-at": "2026-01-05T14:37:35.879046+00:00"
4762
+ "x-reconciled-at": "2026-01-07T15:27:46.954326+00:00"
4574
4763
  },
4575
4764
  "user_email": {
4576
4765
  "type": "string",
@@ -4579,6 +4768,7 @@
4579
4768
  "x-displayname": "User",
4580
4769
  "x-ves-example": "Admin@example-corp.com.",
4581
4770
  "x-f5xc-example": "admin@example-corp.com",
4771
+ "x-f5xc-description-short": "Email of the service user attached to service credential .",
4582
4772
  "minLength": 0,
4583
4773
  "maxLength": 1024,
4584
4774
  "x-f5xc-required-for": {
@@ -4598,6 +4788,7 @@
4598
4788
  "x-displayname": "User Groups.",
4599
4789
  "x-ves-example": "[\"dev-group-1\"]",
4600
4790
  "x-f5xc-example": "\"[\"dev-group-1\"]\"",
4791
+ "x-f5xc-description-short": "User group list associated to this service credential.",
4601
4792
  "x-f5xc-required-for": {
4602
4793
  "minimum_config": false,
4603
4794
  "create": false,
@@ -4606,6 +4797,7 @@
4606
4797
  }
4607
4798
  }
4608
4799
  },
4800
+ "x-f5xc-description-short": "Response of GET service credentials request with a given name.",
4609
4801
  "x-f5xc-minimum-configuration": {
4610
4802
  "description": "Minimum configuration for api_credentialGetServiceCredentialsResponse",
4611
4803
  "required_fields": [
@@ -4640,6 +4832,8 @@
4640
4832
  "title": "Active",
4641
4833
  "format": "boolean",
4642
4834
  "x-displayname": "Active",
4835
+ "x-f5xc-example": "True",
4836
+ "x-f5xc-description-short": "Possibility to deactivate/activate credential with no deletion.",
4643
4837
  "x-f5xc-required-for": {
4644
4838
  "minimum_config": false,
4645
4839
  "create": false,
@@ -4659,6 +4853,7 @@
4659
4853
  "x-validation-rules": {
4660
4854
  "ves.io.schema.rules.string.max_len": "32"
4661
4855
  },
4856
+ "x-f5xc-description-short": "Serial number of the client certificate part of credential type API Certificate or Kubeconfig.",
4662
4857
  "minLength": 0,
4663
4858
  "x-f5xc-required-for": {
4664
4859
  "minimum_config": false,
@@ -4716,6 +4911,8 @@
4716
4911
  "description": "Site name when global kubeconfig is issued for physical K8s site.",
4717
4912
  "title": "Site Name",
4718
4913
  "x-displayname": "Site Name",
4914
+ "x-f5xc-example": "example-resource",
4915
+ "x-f5xc-description-short": "Site name when global kubeconfig is issued for physical K8s site.",
4719
4916
  "minLength": 0,
4720
4917
  "maxLength": 1024,
4721
4918
  "x-f5xc-required-for": {
@@ -4743,6 +4940,7 @@
4743
4940
  "x-validation-rules": {
4744
4941
  "ves.io.schema.rules.repeated.max_items": "1"
4745
4942
  },
4943
+ "x-f5xc-description-short": "Reference to user for whom API credential is created.",
4746
4944
  "x-f5xc-required-for": {
4747
4945
  "minimum_config": false,
4748
4946
  "create": false,
@@ -4755,6 +4953,7 @@
4755
4953
  "description": "Name of virtual K8s cluster.",
4756
4954
  "title": "Virtual K8s.",
4757
4955
  "x-displayname": "Virtual K8s.",
4956
+ "x-f5xc-example": "example-resource",
4758
4957
  "minLength": 0,
4759
4958
  "maxLength": 1024,
4760
4959
  "x-f5xc-required-for": {
@@ -4769,6 +4968,7 @@
4769
4968
  "description": "Namespace of virtual_k8s.",
4770
4969
  "title": "Virtual K8s namespace.",
4771
4970
  "x-displayname": "Namespace",
4971
+ "x-f5xc-example": "example-resource",
4772
4972
  "minLength": 0,
4773
4973
  "maxLength": 1024,
4774
4974
  "x-f5xc-required-for": {
@@ -4779,6 +4979,7 @@
4779
4979
  }
4780
4980
  }
4781
4981
  },
4982
+ "x-f5xc-description-short": "Keeps track of user requested API credentials.",
4782
4983
  "x-f5xc-minimum-configuration": {
4783
4984
  "description": "Minimum configuration for api_credentialGlobalSpecType",
4784
4985
  "required_fields": [
@@ -4815,6 +5016,7 @@
4815
5016
  "$ref": "#/components/schemas/api_credentialListResponseItem"
4816
5017
  },
4817
5018
  "x-displayname": "Credentials.",
5019
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
4818
5020
  "x-f5xc-required-for": {
4819
5021
  "minimum_config": false,
4820
5022
  "create": false,
@@ -4823,6 +5025,7 @@
4823
5025
  }
4824
5026
  }
4825
5027
  },
5028
+ "x-f5xc-description-short": "Response of request to list all of users credential objects.",
4826
5029
  "x-f5xc-minimum-configuration": {
4827
5030
  "description": "Minimum configuration for api_credentialListResponse",
4828
5031
  "required_fields": [
@@ -4850,6 +5053,7 @@
4850
5053
  "x-displayname": "Active",
4851
5054
  "x-ves-example": "True",
4852
5055
  "x-f5xc-example": "true",
5056
+ "x-f5xc-description-short": "Possibility to deactivate credential with no deletion.",
4853
5057
  "x-f5xc-required-for": {
4854
5058
  "minimum_config": false,
4855
5059
  "create": false,
@@ -4904,7 +5108,7 @@
4904
5108
  },
4905
5109
  "x-original-maxLength": 1024,
4906
5110
  "x-reconciled-from-discovery": true,
4907
- "x-reconciled-at": "2026-01-05T14:37:35.879077+00:00"
5111
+ "x-reconciled-at": "2026-01-07T15:27:46.954376+00:00"
4908
5112
  },
4909
5113
  "namespace": {
4910
5114
  "type": "string",
@@ -4923,7 +5127,7 @@
4923
5127
  },
4924
5128
  "x-original-maxLength": 1024,
4925
5129
  "x-reconciled-from-discovery": true,
4926
- "x-reconciled-at": "2026-01-05T14:37:35.879081+00:00"
5130
+ "x-reconciled-at": "2026-01-07T15:27:46.954385+00:00"
4927
5131
  },
4928
5132
  "type": {
4929
5133
  "$ref": "#/components/schemas/api_credentialAPICredentialType"
@@ -4947,7 +5151,7 @@
4947
5151
  "x-original-maxLength": 1024,
4948
5152
  "format": "uuid",
4949
5153
  "x-reconciled-from-discovery": true,
4950
- "x-reconciled-at": "2026-01-05T14:37:35.879088+00:00"
5154
+ "x-reconciled-at": "2026-01-07T15:27:46.954397+00:00"
4951
5155
  },
4952
5156
  "user_email": {
4953
5157
  "type": "string",
@@ -4956,6 +5160,7 @@
4956
5160
  "x-displayname": "User",
4957
5161
  "x-ves-example": "Admin@example-corp.com.",
4958
5162
  "x-f5xc-example": "admin@example-corp.com",
5163
+ "x-f5xc-description-short": "User email of user that requested credential .",
4959
5164
  "minLength": 0,
4960
5165
  "maxLength": 1024,
4961
5166
  "x-f5xc-required-for": {
@@ -5000,6 +5205,7 @@
5000
5205
  "$ref": "#/components/schemas/api_credentialListServiceCredentialsResponseItem"
5001
5206
  },
5002
5207
  "x-displayname": "Service Credentials.",
5208
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
5003
5209
  "x-f5xc-required-for": {
5004
5210
  "minimum_config": false,
5005
5211
  "create": false,
@@ -5008,6 +5214,7 @@
5008
5214
  }
5009
5215
  }
5010
5216
  },
5217
+ "x-f5xc-description-short": "Response of request to list all of service credential objects.",
5011
5218
  "x-f5xc-minimum-configuration": {
5012
5219
  "description": "Minimum configuration for api_credentialListServiceCredentialsResponse",
5013
5220
  "required_fields": [
@@ -5035,6 +5242,7 @@
5035
5242
  "x-displayname": "Active",
5036
5243
  "x-ves-example": "True",
5037
5244
  "x-f5xc-example": "true",
5245
+ "x-f5xc-description-short": "Possibility to deactivate credential with no deletion.",
5038
5246
  "x-f5xc-required-for": {
5039
5247
  "minimum_config": false,
5040
5248
  "create": false,
@@ -5089,7 +5297,7 @@
5089
5297
  },
5090
5298
  "x-original-maxLength": 1024,
5091
5299
  "x-reconciled-from-discovery": true,
5092
- "x-reconciled-at": "2026-01-05T14:37:35.879101+00:00"
5300
+ "x-reconciled-at": "2026-01-07T15:27:46.954419+00:00"
5093
5301
  },
5094
5302
  "namespace": {
5095
5303
  "type": "string",
@@ -5108,7 +5316,7 @@
5108
5316
  },
5109
5317
  "x-original-maxLength": 1024,
5110
5318
  "x-reconciled-from-discovery": true,
5111
- "x-reconciled-at": "2026-01-05T14:37:35.879106+00:00"
5319
+ "x-reconciled-at": "2026-01-07T15:27:46.954427+00:00"
5112
5320
  },
5113
5321
  "namespace_access": {
5114
5322
  "$ref": "#/components/schemas/schemaNamespaceAccessType"
@@ -5135,7 +5343,7 @@
5135
5343
  "x-original-maxLength": 1024,
5136
5344
  "format": "uuid",
5137
5345
  "x-reconciled-from-discovery": true,
5138
- "x-reconciled-at": "2026-01-05T14:37:35.879114+00:00"
5346
+ "x-reconciled-at": "2026-01-07T15:27:46.954440+00:00"
5139
5347
  },
5140
5348
  "user_email": {
5141
5349
  "type": "string",
@@ -5144,6 +5352,7 @@
5144
5352
  "x-displayname": "User",
5145
5353
  "x-ves-example": "Admin@example-corp.com.",
5146
5354
  "x-f5xc-example": "admin@example-corp.com",
5355
+ "x-f5xc-description-short": "User email of user that requested credential .",
5147
5356
  "minLength": 0,
5148
5357
  "maxLength": 1024,
5149
5358
  "x-f5xc-required-for": {
@@ -5163,6 +5372,7 @@
5163
5372
  "x-displayname": "User Groups.",
5164
5373
  "x-ves-example": "[\"dev-group-1\"]",
5165
5374
  "x-f5xc-example": "\"[\"dev-group-1\"]\"",
5375
+ "x-f5xc-description-short": "User group list associated to this service credential.",
5166
5376
  "x-f5xc-required-for": {
5167
5377
  "minimum_config": false,
5168
5378
  "create": false,
@@ -5171,6 +5381,7 @@
5171
5381
  }
5172
5382
  }
5173
5383
  },
5384
+ "x-f5xc-description-short": "Each item of service credential list request.",
5174
5385
  "x-f5xc-minimum-configuration": {
5175
5386
  "description": "Minimum configuration for api_credentialListServiceCredentialsResponseItem",
5176
5387
  "required_fields": [
@@ -5222,6 +5433,8 @@
5222
5433
  "ves.io.schema.rules.repeated.min_items": "1",
5223
5434
  "ves.io.schema.rules.repeated.unique": "true"
5224
5435
  },
5436
+ "x-f5xc-example": "example-resource",
5437
+ "x-f5xc-description-short": "It contains the names of credentials which needs to be deleted. Required: YES.",
5225
5438
  "x-f5xc-required-for": {
5226
5439
  "minimum_config": false,
5227
5440
  "create": false,
@@ -5259,6 +5472,7 @@
5259
5472
  "$ref": "#/components/schemas/schemaSystemObjectMetaType"
5260
5473
  }
5261
5474
  },
5475
+ "x-f5xc-description-short": "API Credential object represents the user request to create a certificate.",
5262
5476
  "x-f5xc-minimum-configuration": {
5263
5477
  "description": "Minimum configuration for api_credentialObject",
5264
5478
  "required_fields": [
@@ -5296,6 +5510,8 @@
5296
5510
  "ves.io.schema.rules.uint32.gte": "1",
5297
5511
  "ves.io.schema.rules.uint32.lte": "730"
5298
5512
  },
5513
+ "x-f5xc-description-short": "Qty of days of service credential expiration. Default value is 180.",
5514
+ "x-f5xc-description-medium": "Qty of days of service credential expiration. Default value is 180. Expiration days value can range between 1 and 730.",
5299
5515
  "minimum": 0,
5300
5516
  "maximum": 2147483647,
5301
5517
  "x-f5xc-required-for": {
@@ -5322,9 +5538,10 @@
5322
5538
  },
5323
5539
  "x-original-maxLength": 1024,
5324
5540
  "x-reconciled-from-discovery": true,
5325
- "x-reconciled-at": "2026-01-05T14:37:35.879130+00:00"
5541
+ "x-reconciled-at": "2026-01-07T15:27:46.954466+00:00"
5326
5542
  }
5327
5543
  },
5544
+ "x-f5xc-description-short": "RecreateScimTokenRequest is the request format for generating SCIM API credential.",
5328
5545
  "x-f5xc-minimum-configuration": {
5329
5546
  "description": "Minimum configuration for api_credentialRecreateScimTokenRequest",
5330
5547
  "required_fields": [
@@ -5353,6 +5570,7 @@
5353
5570
  "x-displayname": "Expiry in days.",
5354
5571
  "x-ves-example": "Value",
5355
5572
  "x-f5xc-example": "value",
5573
+ "x-f5xc-description-short": "Qty of days of service credential expiration.",
5356
5574
  "minimum": 0,
5357
5575
  "maximum": 2147483647,
5358
5576
  "x-f5xc-required-for": {
@@ -5376,6 +5594,7 @@
5376
5594
  "x-validation-rules": {
5377
5595
  "ves.io.schema.rules.message.required": "true"
5378
5596
  },
5597
+ "x-f5xc-description-short": "Name of API credential object. Required: YES.",
5379
5598
  "minLength": 0,
5380
5599
  "maxLength": 16,
5381
5600
  "x-f5xc-required-for": {
@@ -5386,7 +5605,7 @@
5386
5605
  },
5387
5606
  "x-original-maxLength": 1024,
5388
5607
  "x-reconciled-from-discovery": true,
5389
- "x-reconciled-at": "2026-01-05T14:37:35.879137+00:00"
5608
+ "x-reconciled-at": "2026-01-07T15:27:46.954479+00:00"
5390
5609
  },
5391
5610
  "namespace": {
5392
5611
  "type": "string",
@@ -5402,6 +5621,7 @@
5402
5621
  "x-validation-rules": {
5403
5622
  "ves.io.schema.rules.message.required": "true"
5404
5623
  },
5624
+ "x-f5xc-description-short": "Value of namespace is always \"system\" . Required: YES.",
5405
5625
  "minLength": 0,
5406
5626
  "maxLength": 6,
5407
5627
  "x-f5xc-required-for": {
@@ -5412,7 +5632,7 @@
5412
5632
  },
5413
5633
  "x-original-maxLength": 1024,
5414
5634
  "x-reconciled-from-discovery": true,
5415
- "x-reconciled-at": "2026-01-05T14:37:35.879141+00:00"
5635
+ "x-reconciled-at": "2026-01-07T15:27:46.954484+00:00"
5416
5636
  }
5417
5637
  },
5418
5638
  "x-f5xc-minimum-configuration": {
@@ -5450,6 +5670,7 @@
5450
5670
  "x-validation-rules": {
5451
5671
  "ves.io.schema.rules.message.required": "true"
5452
5672
  },
5673
+ "x-f5xc-description-short": "Name of service credential object. Required: YES.",
5453
5674
  "minLength": 0,
5454
5675
  "maxLength": 16,
5455
5676
  "x-f5xc-required-for": {
@@ -5460,7 +5681,7 @@
5460
5681
  },
5461
5682
  "x-original-maxLength": 1024,
5462
5683
  "x-reconciled-from-discovery": true,
5463
- "x-reconciled-at": "2026-01-05T14:37:35.879146+00:00"
5684
+ "x-reconciled-at": "2026-01-07T15:27:46.954489+00:00"
5464
5685
  },
5465
5686
  "namespace": {
5466
5687
  "type": "string",
@@ -5469,6 +5690,7 @@
5469
5690
  "x-displayname": "Namespace",
5470
5691
  "x-ves-example": "System",
5471
5692
  "x-f5xc-example": "system",
5693
+ "x-f5xc-description-short": "Namespace of the service credential user. Value of namespace is always \"system\".",
5472
5694
  "minLength": 0,
5473
5695
  "maxLength": 6,
5474
5696
  "x-f5xc-required-for": {
@@ -5479,7 +5701,7 @@
5479
5701
  },
5480
5702
  "x-original-maxLength": 1024,
5481
5703
  "x-reconciled-from-discovery": true,
5482
- "x-reconciled-at": "2026-01-05T14:37:35.879150+00:00"
5704
+ "x-reconciled-at": "2026-01-07T15:27:46.954493+00:00"
5483
5705
  },
5484
5706
  "namespace_access": {
5485
5707
  "$ref": "#/components/schemas/schemaNamespaceAccessType"
@@ -5494,6 +5716,7 @@
5494
5716
  "x-displayname": "Groups",
5495
5717
  "x-ves-example": "[\"dev-group-1\"]",
5496
5718
  "x-f5xc-example": "\"[\"dev-group-1\"]\"",
5719
+ "x-f5xc-description-short": "List of user_groups to be replaced for this service credentials.",
5497
5720
  "x-f5xc-required-for": {
5498
5721
  "minimum_config": false,
5499
5722
  "create": false,
@@ -5502,6 +5725,7 @@
5502
5725
  }
5503
5726
  }
5504
5727
  },
5728
+ "x-f5xc-description-short": "Request format for replacing service credentials.",
5505
5729
  "x-f5xc-minimum-configuration": {
5506
5730
  "description": "Minimum configuration for api_credentialReplaceServiceCredentialsRequest",
5507
5731
  "required_fields": [
@@ -5532,6 +5756,7 @@
5532
5756
  "x-displayname": "Active",
5533
5757
  "x-ves-example": "True",
5534
5758
  "x-f5xc-example": "true",
5759
+ "x-f5xc-description-short": "Specifies if service credential is active or not.",
5535
5760
  "x-f5xc-required-for": {
5536
5761
  "minimum_config": false,
5537
5762
  "create": false,
@@ -5571,9 +5796,10 @@
5571
5796
  },
5572
5797
  "x-original-maxLength": 1024,
5573
5798
  "x-reconciled-from-discovery": true,
5574
- "x-reconciled-at": "2026-01-05T14:37:35.879161+00:00"
5799
+ "x-reconciled-at": "2026-01-07T15:27:46.954518+00:00"
5575
5800
  }
5576
5801
  },
5802
+ "x-f5xc-description-short": "Response format for the credential's replace request.",
5577
5803
  "x-f5xc-minimum-configuration": {
5578
5804
  "description": "Minimum configuration for api_credentialReplaceServiceCredentialsResponse",
5579
5805
  "required_fields": [
@@ -5609,6 +5835,7 @@
5609
5835
  "x-validation-rules": {
5610
5836
  "ves.io.schema.rules.message.required": "true"
5611
5837
  },
5838
+ "x-f5xc-description-short": "Value of namespace is always \"system\". Required: YES.",
5612
5839
  "minLength": 0,
5613
5840
  "maxLength": 6,
5614
5841
  "x-f5xc-required-for": {
@@ -5619,9 +5846,10 @@
5619
5846
  },
5620
5847
  "x-original-maxLength": 1024,
5621
5848
  "x-reconciled-from-discovery": true,
5622
- "x-reconciled-at": "2026-01-05T14:37:35.879166+00:00"
5849
+ "x-reconciled-at": "2026-01-07T15:27:46.954524+00:00"
5623
5850
  }
5624
5851
  },
5852
+ "x-f5xc-description-short": "ScimTokenRequest is used for fetching or revoking scim token.",
5625
5853
  "x-f5xc-minimum-configuration": {
5626
5854
  "description": "Minimum configuration for api_credentialScimTokenRequest",
5627
5855
  "required_fields": [
@@ -5661,6 +5889,7 @@
5661
5889
  "ves.io.schema.rules.string.max_bytes": "64",
5662
5890
  "ves.io.schema.rules.string.min_bytes": "1"
5663
5891
  },
5892
+ "x-f5xc-description-short": "Name of the site for which kubeconfig is being requested. Required: YES.",
5664
5893
  "x-f5xc-required-for": {
5665
5894
  "minimum_config": false,
5666
5895
  "create": false,
@@ -5692,6 +5921,7 @@
5692
5921
  "$ref": "#/components/schemas/api_credentialGlobalSpecType"
5693
5922
  }
5694
5923
  },
5924
+ "x-f5xc-description-short": "Shape of the API credential specification.",
5695
5925
  "x-f5xc-minimum-configuration": {
5696
5926
  "description": "Minimum configuration for api_credentialSpecType",
5697
5927
  "required_fields": [
@@ -5728,7 +5958,7 @@
5728
5958
  "maxLength": 17,
5729
5959
  "minLength": 17,
5730
5960
  "x-reconciled-from-discovery": true,
5731
- "x-reconciled-at": "2026-01-05T14:37:35.879175+00:00"
5961
+ "x-reconciled-at": "2026-01-07T15:27:46.954534+00:00"
5732
5962
  }
5733
5963
  },
5734
5964
  "x-f5xc-minimum-configuration": {
@@ -5785,6 +6015,7 @@
5785
6015
  "x-validation-rules": {
5786
6016
  "ves.io.schema.rules.string.ves_object_name": "true"
5787
6017
  },
6018
+ "x-f5xc-description-short": "Namespace of virtual K8s cluster. Applicable for KUBE_CONFIG.",
5788
6019
  "minLength": 0,
5789
6020
  "maxLength": 1024,
5790
6021
  "x-f5xc-required-for": {
@@ -5814,6 +6045,7 @@
5814
6045
  "title": "Empty",
5815
6046
  "x-displayname": "Empty",
5816
6047
  "x-ves-proto-message": "ves.io.schema.Empty",
6048
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
5817
6049
  "x-f5xc-minimum-configuration": {
5818
6050
  "description": "Minimum configuration for schemaEmpty",
5819
6051
  "required_fields": [],
@@ -5837,6 +6069,7 @@
5837
6069
  "title": "Name",
5838
6070
  "x-displayname": "Name",
5839
6071
  "x-f5xc-example": "example-resource",
6072
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
5840
6073
  "minLength": 0,
5841
6074
  "maxLength": 16,
5842
6075
  "x-f5xc-required-for": {
@@ -5847,9 +6080,10 @@
5847
6080
  },
5848
6081
  "x-original-maxLength": 1024,
5849
6082
  "x-reconciled-from-discovery": true,
5850
- "x-reconciled-at": "2026-01-05T14:37:35.879185+00:00"
6083
+ "x-reconciled-at": "2026-01-07T15:27:46.954544+00:00"
5851
6084
  }
5852
6085
  },
6086
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
5853
6087
  "x-f5xc-minimum-configuration": {
5854
6088
  "description": "Minimum configuration for schemaInitializerType",
5855
6089
  "required_fields": [
@@ -5877,6 +6111,8 @@
5877
6111
  "$ref": "#/components/schemas/schemaInitializerType"
5878
6112
  },
5879
6113
  "x-displayname": "Pending",
6114
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
6115
+ "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.",
5880
6116
  "x-f5xc-required-for": {
5881
6117
  "minimum_config": false,
5882
6118
  "create": false,
@@ -5888,6 +6124,7 @@
5888
6124
  "$ref": "#/components/schemas/schemaStatusType"
5889
6125
  }
5890
6126
  },
6127
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
5891
6128
  "x-f5xc-minimum-configuration": {
5892
6129
  "description": "Minimum configuration for schemaInitializersType",
5893
6130
  "required_fields": [
@@ -5923,6 +6160,7 @@
5923
6160
  "ves.io.schema.rules.map.keys.string.max_len": "256",
5924
6161
  "ves.io.schema.rules.message.required": "true"
5925
6162
  },
6163
+ "x-f5xc-description-short": "List of all the roles for the entity in the namespaces Required: YES.",
5926
6164
  "x-f5xc-required-for": {
5927
6165
  "minimum_config": false,
5928
6166
  "create": false,
@@ -5931,6 +6169,7 @@
5931
6169
  }
5932
6170
  }
5933
6171
  },
6172
+ "x-f5xc-description-short": "Access info in the namespaces for the entity.",
5934
6173
  "x-f5xc-minimum-configuration": {
5935
6174
  "description": "Minimum configuration for schemaNamespaceAccessType",
5936
6175
  "required_fields": [
@@ -5967,6 +6206,7 @@
5967
6206
  "ves.io.schema.rules.message.required": "true",
5968
6207
  "ves.io.schema.rules.string.max_len": "256"
5969
6208
  },
6209
+ "x-f5xc-description-short": "Namespace the role applies to '*' value implies all namespaces Required: YES.",
5970
6210
  "minLength": 0,
5971
6211
  "x-f5xc-required-for": {
5972
6212
  "minimum_config": false,
@@ -5976,7 +6216,7 @@
5976
6216
  },
5977
6217
  "x-original-maxLength": 256,
5978
6218
  "x-reconciled-from-discovery": true,
5979
- "x-reconciled-at": "2026-01-05T14:37:35.879196+00:00"
6219
+ "x-reconciled-at": "2026-01-07T15:27:46.954555+00:00"
5980
6220
  },
5981
6221
  "role": {
5982
6222
  "type": "string",
@@ -5997,6 +6237,7 @@
5997
6237
  "ves.io.schema.rules.string.max_len": "256",
5998
6238
  "ves.io.schema.rules.string.ves_object_name": "true"
5999
6239
  },
6240
+ "x-f5xc-description-short": "Users role for this namespace Required: YES.",
6000
6241
  "minLength": 0,
6001
6242
  "x-f5xc-required-for": {
6002
6243
  "minimum_config": false,
@@ -6045,6 +6286,8 @@
6045
6286
  "ves.io.schema.rules.map.values.string.max_len": "1024",
6046
6287
  "ves.io.schema.rules.map.values.string.min_len": "1"
6047
6288
  },
6289
+ "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.",
6290
+ "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.",
6048
6291
  "x-f5xc-required-for": {
6049
6292
  "minimum_config": false,
6050
6293
  "create": false,
@@ -6066,6 +6309,7 @@
6066
6309
  "x-validation-rules": {
6067
6310
  "ves.io.schema.rules.string.max_bytes": "1200"
6068
6311
  },
6312
+ "x-f5xc-description-short": "Human readable description for the object.",
6069
6313
  "minLength": 0,
6070
6314
  "x-f5xc-required-for": {
6071
6315
  "minimum_config": false,
@@ -6075,7 +6319,7 @@
6075
6319
  },
6076
6320
  "x-original-maxLength": 1200,
6077
6321
  "x-reconciled-from-discovery": true,
6078
- "x-reconciled-at": "2026-01-05T14:37:35.879205+00:00"
6322
+ "x-reconciled-at": "2026-01-07T15:27:46.954564+00:00"
6079
6323
  },
6080
6324
  "disable": {
6081
6325
  "type": "boolean",
@@ -6085,6 +6329,7 @@
6085
6329
  "x-displayname": "Disable",
6086
6330
  "x-ves-example": "True",
6087
6331
  "x-f5xc-example": "true",
6332
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
6088
6333
  "x-f5xc-required-for": {
6089
6334
  "minimum_config": false,
6090
6335
  "create": false,
@@ -6099,6 +6344,8 @@
6099
6344
  "x-displayname": "Labels",
6100
6345
  "x-ves-example": "Value",
6101
6346
  "x-f5xc-example": "value",
6347
+ "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.",
6348
+ "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.",
6102
6349
  "x-f5xc-required-for": {
6103
6350
  "minimum_config": false,
6104
6351
  "create": false,
@@ -6120,6 +6367,8 @@
6120
6367
  "x-validation-rules": {
6121
6368
  "ves.io.schema.rules.message.required": "true"
6122
6369
  },
6370
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
6371
+ "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.",
6123
6372
  "minLength": 0,
6124
6373
  "maxLength": 16,
6125
6374
  "x-f5xc-required-for": {
@@ -6130,7 +6379,7 @@
6130
6379
  },
6131
6380
  "x-original-maxLength": 1024,
6132
6381
  "x-reconciled-from-discovery": true,
6133
- "x-reconciled-at": "2026-01-05T14:37:35.879213+00:00"
6382
+ "x-reconciled-at": "2026-01-07T15:27:46.954572+00:00"
6134
6383
  },
6135
6384
  "namespace": {
6136
6385
  "type": "string",
@@ -6139,6 +6388,8 @@
6139
6388
  "x-displayname": "Namespace",
6140
6389
  "x-ves-example": "Staging",
6141
6390
  "x-f5xc-example": "staging",
6391
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
6392
+ "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 \"\".",
6142
6393
  "minLength": 0,
6143
6394
  "maxLength": 6,
6144
6395
  "x-f5xc-required-for": {
@@ -6149,7 +6400,7 @@
6149
6400
  },
6150
6401
  "x-original-maxLength": 1024,
6151
6402
  "x-reconciled-from-discovery": true,
6152
- "x-reconciled-at": "2026-01-05T14:37:35.879218+00:00"
6403
+ "x-reconciled-at": "2026-01-07T15:27:46.954577+00:00"
6153
6404
  },
6154
6405
  "uid": {
6155
6406
  "type": "string",
@@ -6158,6 +6409,8 @@
6158
6409
  "x-displayname": "UID",
6159
6410
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
6160
6411
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
6412
+ "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.",
6413
+ "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.",
6161
6414
  "minLength": 0,
6162
6415
  "maxLength": 36,
6163
6416
  "x-f5xc-required-for": {
@@ -6171,9 +6424,11 @@
6171
6424
  "x-original-maxLength": 1024,
6172
6425
  "format": "uuid",
6173
6426
  "x-reconciled-from-discovery": true,
6174
- "x-reconciled-at": "2026-01-05T14:37:35.879223+00:00"
6427
+ "x-reconciled-at": "2026-01-07T15:27:46.954582+00:00"
6175
6428
  }
6176
6429
  },
6430
+ "x-f5xc-description-short": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.",
6431
+ "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.",
6177
6432
  "x-f5xc-minimum-configuration": {
6178
6433
  "description": "Minimum configuration for schemaObjectMetaType",
6179
6434
  "required_fields": [
@@ -6206,6 +6461,8 @@
6206
6461
  "x-displayname": "Kind",
6207
6462
  "x-ves-example": "Virtual_site.",
6208
6463
  "x-f5xc-example": "virtual_site",
6464
+ "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\")",
6465
+ "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\").",
6209
6466
  "minLength": 0,
6210
6467
  "maxLength": 14,
6211
6468
  "x-f5xc-required-for": {
@@ -6217,7 +6474,7 @@
6217
6474
  "readOnly": true,
6218
6475
  "x-original-maxLength": 1024,
6219
6476
  "x-reconciled-from-discovery": true,
6220
- "x-reconciled-at": "2026-01-05T14:37:35.879228+00:00"
6477
+ "x-reconciled-at": "2026-01-07T15:27:46.954587+00:00"
6221
6478
  },
6222
6479
  "name": {
6223
6480
  "type": "string",
@@ -6226,6 +6483,8 @@
6226
6483
  "x-displayname": "Name",
6227
6484
  "x-ves-example": "Contactus-route.",
6228
6485
  "x-f5xc-example": "contactus-route",
6486
+ "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.",
6487
+ "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.",
6229
6488
  "minLength": 0,
6230
6489
  "maxLength": 16,
6231
6490
  "x-f5xc-required-for": {
@@ -6236,7 +6495,7 @@
6236
6495
  },
6237
6496
  "x-original-maxLength": 1024,
6238
6497
  "x-reconciled-from-discovery": true,
6239
- "x-reconciled-at": "2026-01-05T14:37:35.879232+00:00"
6498
+ "x-reconciled-at": "2026-01-07T15:27:46.954591+00:00"
6240
6499
  },
6241
6500
  "namespace": {
6242
6501
  "type": "string",
@@ -6245,6 +6504,8 @@
6245
6504
  "x-displayname": "Namespace",
6246
6505
  "x-ves-example": "Ns1",
6247
6506
  "x-f5xc-example": "ns1",
6507
+ "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.",
6508
+ "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.",
6248
6509
  "minLength": 0,
6249
6510
  "maxLength": 6,
6250
6511
  "x-f5xc-required-for": {
@@ -6255,7 +6516,7 @@
6255
6516
  },
6256
6517
  "x-original-maxLength": 1024,
6257
6518
  "x-reconciled-from-discovery": true,
6258
- "x-reconciled-at": "2026-01-05T14:37:35.879237+00:00"
6519
+ "x-reconciled-at": "2026-01-07T15:27:46.954595+00:00"
6259
6520
  },
6260
6521
  "tenant": {
6261
6522
  "type": "string",
@@ -6264,6 +6525,8 @@
6264
6525
  "x-displayname": "Tenant",
6265
6526
  "x-ves-example": "Example-corp.",
6266
6527
  "x-f5xc-example": "example-corp",
6528
+ "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.",
6529
+ "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.",
6267
6530
  "minLength": 0,
6268
6531
  "maxLength": 18,
6269
6532
  "x-f5xc-required-for": {
@@ -6276,7 +6539,7 @@
6276
6539
  "x-field-mutability": "read-only",
6277
6540
  "x-original-maxLength": 1024,
6278
6541
  "x-reconciled-from-discovery": true,
6279
- "x-reconciled-at": "2026-01-05T14:37:35.879241+00:00"
6542
+ "x-reconciled-at": "2026-01-07T15:27:46.954599+00:00"
6280
6543
  },
6281
6544
  "uid": {
6282
6545
  "type": "string",
@@ -6285,6 +6548,8 @@
6285
6548
  "x-displayname": "UID",
6286
6549
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
6287
6550
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
6551
+ "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.",
6552
+ "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.",
6288
6553
  "minLength": 0,
6289
6554
  "maxLength": 36,
6290
6555
  "x-f5xc-required-for": {
@@ -6298,9 +6563,11 @@
6298
6563
  "x-original-maxLength": 1024,
6299
6564
  "format": "uuid",
6300
6565
  "x-reconciled-from-discovery": true,
6301
- "x-reconciled-at": "2026-01-05T14:37:35.879246+00:00"
6566
+ "x-reconciled-at": "2026-01-07T15:27:46.954604+00:00"
6302
6567
  }
6303
6568
  },
6569
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
6570
+ "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...",
6304
6571
  "x-f5xc-minimum-configuration": {
6305
6572
  "description": "Minimum configuration for schemaObjectRefType",
6306
6573
  "required_fields": [
@@ -6329,6 +6596,7 @@
6329
6596
  "items": {
6330
6597
  "type": "string"
6331
6598
  },
6599
+ "x-f5xc-example": "example-resource",
6332
6600
  "x-f5xc-required-for": {
6333
6601
  "minimum_config": false,
6334
6602
  "create": false,
@@ -6364,6 +6632,7 @@
6364
6632
  "x-displayname": "Code",
6365
6633
  "x-ves-example": "0",
6366
6634
  "x-f5xc-example": "0",
6635
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
6367
6636
  "minimum": 0,
6368
6637
  "maximum": 2147483647,
6369
6638
  "x-f5xc-required-for": {
@@ -6380,6 +6649,8 @@
6380
6649
  "x-displayname": "Reason",
6381
6650
  "x-ves-example": "Value",
6382
6651
  "x-f5xc-example": "value",
6652
+ "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.",
6653
+ "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.",
6383
6654
  "minLength": 0,
6384
6655
  "maxLength": 43,
6385
6656
  "x-f5xc-required-for": {
@@ -6390,7 +6661,7 @@
6390
6661
  },
6391
6662
  "x-original-maxLength": 1024,
6392
6663
  "x-reconciled-from-discovery": true,
6393
- "x-reconciled-at": "2026-01-05T14:37:35.879255+00:00"
6664
+ "x-reconciled-at": "2026-01-07T15:27:46.954613+00:00"
6394
6665
  },
6395
6666
  "status": {
6396
6667
  "type": "string",
@@ -6399,6 +6670,7 @@
6399
6670
  "x-displayname": "Status",
6400
6671
  "x-ves-example": "Value",
6401
6672
  "x-f5xc-example": "value",
6673
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
6402
6674
  "minLength": 0,
6403
6675
  "maxLength": 17,
6404
6676
  "x-f5xc-required-for": {
@@ -6409,9 +6681,10 @@
6409
6681
  },
6410
6682
  "x-original-maxLength": 1024,
6411
6683
  "x-reconciled-from-discovery": true,
6412
- "x-reconciled-at": "2026-01-05T14:37:35.879259+00:00"
6684
+ "x-reconciled-at": "2026-01-07T15:27:46.954617+00:00"
6413
6685
  }
6414
6686
  },
6687
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
6415
6688
  "x-f5xc-minimum-configuration": {
6416
6689
  "description": "Minimum configuration for schemaStatusType",
6417
6690
  "required_fields": [
@@ -6439,6 +6712,8 @@
6439
6712
  "title": "Creation_timestamp.",
6440
6713
  "format": "date-time",
6441
6714
  "x-displayname": "Creation Timestamp.",
6715
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
6716
+ "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.",
6442
6717
  "minLength": 0,
6443
6718
  "maxLength": 1024,
6444
6719
  "x-f5xc-required-for": {
@@ -6457,6 +6732,7 @@
6457
6732
  "x-displayname": "Creator Class.",
6458
6733
  "x-ves-example": "Value",
6459
6734
  "x-f5xc-example": "value",
6735
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
6460
6736
  "minLength": 0,
6461
6737
  "maxLength": 1024,
6462
6738
  "x-f5xc-required-for": {
@@ -6475,6 +6751,8 @@
6475
6751
  "x-displayname": "Creator Cookie.",
6476
6752
  "x-ves-example": "Value",
6477
6753
  "x-f5xc-example": "value",
6754
+ "x-f5xc-description-short": "Can used by the creator of the object for later audit for e.g.",
6755
+ "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.",
6478
6756
  "minLength": 0,
6479
6757
  "maxLength": 1024,
6480
6758
  "x-f5xc-required-for": {
@@ -6492,6 +6770,7 @@
6492
6770
  "x-displayname": "Creator ID.",
6493
6771
  "x-ves-example": "Value",
6494
6772
  "x-f5xc-example": "value",
6773
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
6495
6774
  "minLength": 0,
6496
6775
  "maxLength": 1024,
6497
6776
  "x-f5xc-required-for": {
@@ -6509,6 +6788,8 @@
6509
6788
  "title": "Deletion_timestamp.",
6510
6789
  "format": "date-time",
6511
6790
  "x-displayname": "Deletion Timestamp.",
6791
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
6792
+ "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...",
6512
6793
  "minLength": 0,
6513
6794
  "maxLength": 1024,
6514
6795
  "x-f5xc-required-for": {
@@ -6523,6 +6804,8 @@
6523
6804
  "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.",
6524
6805
  "title": "Direct_ref_hash.",
6525
6806
  "x-displayname": "Direct Reference Hash.",
6807
+ "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.",
6808
+ "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.",
6526
6809
  "minLength": 0,
6527
6810
  "maxLength": 1024,
6528
6811
  "x-f5xc-required-for": {
@@ -6542,6 +6825,8 @@
6542
6825
  "x-displayname": "Finalizers.",
6543
6826
  "x-ves-example": "Value",
6544
6827
  "x-f5xc-example": "value",
6828
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
6829
+ "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.",
6545
6830
  "x-f5xc-required-for": {
6546
6831
  "minimum_config": false,
6547
6832
  "create": false,
@@ -6559,6 +6844,8 @@
6559
6844
  "x-displayname": "Labels",
6560
6845
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
6561
6846
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
6847
+ "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.",
6848
+ "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).",
6562
6849
  "x-f5xc-required-for": {
6563
6850
  "minimum_config": false,
6564
6851
  "create": false,
@@ -6572,6 +6859,8 @@
6572
6859
  "title": "Modification_timestamp.",
6573
6860
  "format": "date-time",
6574
6861
  "x-displayname": "Modification Timestamp.",
6862
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
6863
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
6575
6864
  "minLength": 0,
6576
6865
  "maxLength": 1024,
6577
6866
  "x-f5xc-required-for": {
@@ -6598,6 +6887,9 @@
6598
6887
  "x-validation-rules": {
6599
6888
  "ves.io.schema.rules.repeated.max_items": "1"
6600
6889
  },
6890
+ "x-f5xc-example": "example-resource",
6891
+ "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.",
6892
+ "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.",
6601
6893
  "x-f5xc-required-for": {
6602
6894
  "minimum_config": false,
6603
6895
  "create": false,
@@ -6607,7 +6899,7 @@
6607
6899
  "maxLength": 6,
6608
6900
  "minLength": 6,
6609
6901
  "x-reconciled-from-discovery": true,
6610
- "x-reconciled-at": "2026-01-05T14:37:35.879281+00:00"
6902
+ "x-reconciled-at": "2026-01-07T15:27:46.954638+00:00"
6611
6903
  },
6612
6904
  "object_index": {
6613
6905
  "type": "integer",
@@ -6617,6 +6909,8 @@
6617
6909
  "x-displayname": "Object Index.",
6618
6910
  "x-ves-example": "0",
6619
6911
  "x-f5xc-example": "0",
6912
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
6913
+ "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.",
6620
6914
  "minimum": 0,
6621
6915
  "maximum": 2147483647,
6622
6916
  "x-f5xc-required-for": {
@@ -6637,6 +6931,8 @@
6637
6931
  "title": "Revision",
6638
6932
  "format": "int64",
6639
6933
  "x-displayname": "Revision",
6934
+ "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...",
6935
+ "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.",
6640
6936
  "minLength": 0,
6641
6937
  "maxLength": 1024,
6642
6938
  "x-f5xc-required-for": {
@@ -6654,6 +6950,8 @@
6654
6950
  "x-displayname": "SRE Disable.",
6655
6951
  "x-ves-example": "True",
6656
6952
  "x-f5xc-example": "true",
6953
+ "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.",
6954
+ "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.",
6657
6955
  "x-f5xc-required-for": {
6658
6956
  "minimum_config": false,
6659
6957
  "create": false,
@@ -6668,6 +6966,8 @@
6668
6966
  "x-displayname": "Tenant",
6669
6967
  "x-ves-example": "Example-corp.",
6670
6968
  "x-f5xc-example": "example-corp",
6969
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
6970
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
6671
6971
  "minLength": 0,
6672
6972
  "maxLength": 18,
6673
6973
  "x-f5xc-required-for": {
@@ -6680,7 +6980,7 @@
6680
6980
  "x-field-mutability": "read-only",
6681
6981
  "x-original-maxLength": 1024,
6682
6982
  "x-reconciled-from-discovery": true,
6683
- "x-reconciled-at": "2026-01-05T14:37:35.879291+00:00"
6983
+ "x-reconciled-at": "2026-01-07T15:27:46.954647+00:00"
6684
6984
  },
6685
6985
  "trace_info": {
6686
6986
  "type": "string",
@@ -6689,6 +6989,8 @@
6689
6989
  "x-displayname": "Trace Info.",
6690
6990
  "x-ves-example": "Value",
6691
6991
  "x-f5xc-example": "value",
6992
+ "x-f5xc-description-short": "Trace_info holds information(<trace-ID>:<span-ID>:<parent-span-ID>) of the request doing the object modification.",
6993
+ "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.",
6692
6994
  "minLength": 0,
6693
6995
  "maxLength": 1024,
6694
6996
  "x-f5xc-required-for": {
@@ -6705,6 +7007,8 @@
6705
7007
  "x-displayname": "UID",
6706
7008
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
6707
7009
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
7010
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
7011
+ "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.",
6708
7012
  "minLength": 0,
6709
7013
  "maxLength": 36,
6710
7014
  "x-f5xc-required-for": {
@@ -6718,7 +7022,7 @@
6718
7022
  "x-original-maxLength": 1024,
6719
7023
  "format": "uuid",
6720
7024
  "x-reconciled-from-discovery": true,
6721
- "x-reconciled-at": "2026-01-05T14:37:35.879298+00:00"
7025
+ "x-reconciled-at": "2026-01-07T15:27:46.954654+00:00"
6722
7026
  },
6723
7027
  "vtrp_id": {
6724
7028
  "type": "string",
@@ -6741,6 +7045,7 @@
6741
7045
  "title": "Vtrp_stale.",
6742
7046
  "format": "boolean",
6743
7047
  "x-displayname": "VTRP Stale.",
7048
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
6744
7049
  "x-f5xc-required-for": {
6745
7050
  "minimum_config": false,
6746
7051
  "create": false,
@@ -6749,6 +7054,8 @@
6749
7054
  }
6750
7055
  }
6751
7056
  },
7057
+ "x-f5xc-description-short": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
7058
+ "x-f5xc-description-medium": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
6752
7059
  "x-f5xc-minimum-configuration": {
6753
7060
  "description": "Minimum configuration for schemaSystemObjectMetaType",
6754
7061
  "required_fields": [
@@ -6804,7 +7111,7 @@
6804
7111
  },
6805
7112
  "x-original-maxLength": 1024,
6806
7113
  "x-reconciled-from-discovery": true,
6807
- "x-reconciled-at": "2026-01-05T14:37:35.879306+00:00"
7114
+ "x-reconciled-at": "2026-01-07T15:27:46.954662+00:00"
6808
7115
  },
6809
7116
  "name": {
6810
7117
  "type": "string",
@@ -6813,6 +7120,8 @@
6813
7120
  "x-displayname": "Name",
6814
7121
  "x-ves-example": "Contactus-route.",
6815
7122
  "x-f5xc-example": "contactus-route",
7123
+ "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.",
7124
+ "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.",
6816
7125
  "minLength": 0,
6817
7126
  "maxLength": 16,
6818
7127
  "x-f5xc-required-for": {
@@ -6823,7 +7132,7 @@
6823
7132
  },
6824
7133
  "x-original-maxLength": 1024,
6825
7134
  "x-reconciled-from-discovery": true,
6826
- "x-reconciled-at": "2026-01-05T14:37:35.879311+00:00"
7135
+ "x-reconciled-at": "2026-01-07T15:27:46.954666+00:00"
6827
7136
  },
6828
7137
  "namespace": {
6829
7138
  "type": "string",
@@ -6832,6 +7141,8 @@
6832
7141
  "x-displayname": "Namespace",
6833
7142
  "x-ves-example": "Ns1",
6834
7143
  "x-f5xc-example": "ns1",
7144
+ "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.",
7145
+ "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.",
6835
7146
  "minLength": 0,
6836
7147
  "maxLength": 6,
6837
7148
  "x-f5xc-required-for": {
@@ -6842,7 +7153,7 @@
6842
7153
  },
6843
7154
  "x-original-maxLength": 1024,
6844
7155
  "x-reconciled-from-discovery": true,
6845
- "x-reconciled-at": "2026-01-05T14:37:35.879315+00:00"
7156
+ "x-reconciled-at": "2026-01-07T15:27:46.954670+00:00"
6846
7157
  },
6847
7158
  "uid": {
6848
7159
  "type": "string",
@@ -6863,9 +7174,10 @@
6863
7174
  "x-original-maxLength": 1024,
6864
7175
  "format": "uuid",
6865
7176
  "x-reconciled-from-discovery": true,
6866
- "x-reconciled-at": "2026-01-05T14:37:35.879320+00:00"
7177
+ "x-reconciled-at": "2026-01-07T15:27:46.954675+00:00"
6867
7178
  }
6868
7179
  },
7180
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
6869
7181
  "x-f5xc-minimum-configuration": {
6870
7182
  "description": "Minimum configuration for schemaViewRefType",
6871
7183
  "required_fields": [