@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": "Marketplace",
5
5
  "description": "External connector infrastructure supporting direct, GRE, and encrypted tunnel modes with IKE parameter configuration and dead peer detection intervals. Cloud provider instances for Terraform automation and vendor partnerships. Service catalog entries with per-namespace activation flags, resource quotas, and administrative dashboard tile arrangement for operational workflows.",
6
- "version": "2.0.10",
6
+ "version": "2.0.19",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -13,7 +13,57 @@
13
13
  "url": "https://www.f5.com/company/policies/eula"
14
14
  },
15
15
  "summary": "Third-party GRE and IPSec tunnel provisioning with DPD timers. Shared resource allocation across namespaces with tile placement controls.",
16
- "x-f5xc-cli-domain": "marketplace"
16
+ "x-f5xc-cli-domain": "marketplace",
17
+ "x-f5xc-best-practices": {
18
+ "common_errors": [
19
+ {
20
+ "code": 400,
21
+ "message": "Invalid request body",
22
+ "resolution": "Validate JSON structure and required fields before submission",
23
+ "prevention": "Use schema validation from OpenAPI spec"
24
+ },
25
+ {
26
+ "code": 401,
27
+ "message": "Authentication failed",
28
+ "resolution": "Verify API token is valid and not expired",
29
+ "prevention": "Use environment variables for token management"
30
+ },
31
+ {
32
+ "code": 403,
33
+ "message": "Permission denied",
34
+ "resolution": "Check user role and namespace permissions",
35
+ "prevention": "Verify RBAC policies before operations"
36
+ },
37
+ {
38
+ "code": 404,
39
+ "message": "Resource not found",
40
+ "resolution": "Verify resource name and namespace exist",
41
+ "prevention": "List resources before attempting operations"
42
+ },
43
+ {
44
+ "code": 409,
45
+ "message": "Resource already exists",
46
+ "resolution": "Use unique name or delete existing resource",
47
+ "prevention": "Check existence before creation"
48
+ },
49
+ {
50
+ "code": 429,
51
+ "message": "Rate limit exceeded",
52
+ "resolution": "Implement exponential backoff and retry logic",
53
+ "prevention": "Batch operations and add delays between requests"
54
+ }
55
+ ],
56
+ "security_notes": [
57
+ "Always use HTTPS for all API communications",
58
+ "Store API tokens securely, never in source code",
59
+ "Rotate API tokens regularly following security policies"
60
+ ],
61
+ "performance_tips": [
62
+ "Use pagination for large result sets",
63
+ "Batch related operations when possible",
64
+ "Cache read-only responses appropriately"
65
+ ]
66
+ }
17
67
  },
18
68
  "servers": [
19
69
  {
@@ -254,6 +304,13 @@
254
304
  "latency": "low",
255
305
  "resource_usage": "low"
256
306
  }
307
+ },
308
+ "x-f5xc-discovered-response-time": {
309
+ "p50_ms": 200,
310
+ "p95_ms": 800,
311
+ "p99_ms": 2000,
312
+ "sample_count": 0,
313
+ "source": "estimate"
257
314
  }
258
315
  },
259
316
  "x-displayname": "Addon Service.",
@@ -442,6 +499,13 @@
442
499
  "latency": "moderate",
443
500
  "resource_usage": "moderate"
444
501
  }
502
+ },
503
+ "x-f5xc-discovered-response-time": {
504
+ "p50_ms": 200,
505
+ "p95_ms": 800,
506
+ "p99_ms": 2000,
507
+ "sample_count": 0,
508
+ "source": "estimate"
445
509
  }
446
510
  },
447
511
  "x-displayname": "Addon Service.",
@@ -630,6 +694,13 @@
630
694
  "latency": "moderate",
631
695
  "resource_usage": "moderate"
632
696
  }
697
+ },
698
+ "x-f5xc-discovered-response-time": {
699
+ "p50_ms": 200,
700
+ "p95_ms": 800,
701
+ "p99_ms": 2000,
702
+ "sample_count": 0,
703
+ "source": "estimate"
633
704
  }
634
705
  },
635
706
  "x-displayname": "Addon Service.",
@@ -857,6 +928,13 @@
857
928
  "latency": "moderate",
858
929
  "resource_usage": "moderate"
859
930
  }
931
+ },
932
+ "x-f5xc-discovered-response-time": {
933
+ "p50_ms": 200,
934
+ "p95_ms": 800,
935
+ "p99_ms": 2000,
936
+ "sample_count": 0,
937
+ "source": "estimate"
860
938
  }
861
939
  },
862
940
  "x-displayname": "Addon Service.",
@@ -1076,6 +1154,13 @@
1076
1154
  "latency": "low",
1077
1155
  "resource_usage": "low"
1078
1156
  }
1157
+ },
1158
+ "x-f5xc-discovered-response-time": {
1159
+ "p50_ms": 200,
1160
+ "p95_ms": 800,
1161
+ "p99_ms": 2000,
1162
+ "sample_count": 0,
1163
+ "source": "estimate"
1079
1164
  }
1080
1165
  },
1081
1166
  "x-displayname": "Addon Service.",
@@ -1290,6 +1375,13 @@
1290
1375
  "latency": "low",
1291
1376
  "resource_usage": "low"
1292
1377
  }
1378
+ },
1379
+ "x-f5xc-discovered-response-time": {
1380
+ "p50_ms": 1000,
1381
+ "p95_ms": 3000,
1382
+ "p99_ms": 8000,
1383
+ "sample_count": 0,
1384
+ "source": "estimate"
1293
1385
  }
1294
1386
  },
1295
1387
  "x-displayname": "Addon Subscrption.",
@@ -1512,6 +1604,13 @@
1512
1604
  "latency": "low",
1513
1605
  "resource_usage": "low"
1514
1606
  }
1607
+ },
1608
+ "x-f5xc-discovered-response-time": {
1609
+ "p50_ms": 800,
1610
+ "p95_ms": 2500,
1611
+ "p99_ms": 6000,
1612
+ "sample_count": 0,
1613
+ "source": "estimate"
1515
1614
  }
1516
1615
  },
1517
1616
  "x-displayname": "Addon Subscrption.",
@@ -1739,6 +1838,13 @@
1739
1838
  "latency": "moderate",
1740
1839
  "resource_usage": "moderate"
1741
1840
  }
1841
+ },
1842
+ "x-f5xc-discovered-response-time": {
1843
+ "p50_ms": 200,
1844
+ "p95_ms": 800,
1845
+ "p99_ms": 2000,
1846
+ "sample_count": 0,
1847
+ "source": "estimate"
1742
1848
  }
1743
1849
  },
1744
1850
  "x-displayname": "Addon Subscrption.",
@@ -1959,6 +2065,13 @@
1959
2065
  "latency": "low",
1960
2066
  "resource_usage": "low"
1961
2067
  }
2068
+ },
2069
+ "x-f5xc-discovered-response-time": {
2070
+ "p50_ms": 200,
2071
+ "p95_ms": 800,
2072
+ "p99_ms": 2000,
2073
+ "sample_count": 0,
2074
+ "source": "estimate"
1962
2075
  }
1963
2076
  },
1964
2077
  "delete": {
@@ -2178,6 +2291,13 @@
2178
2291
  "latency": "high",
2179
2292
  "resource_usage": "moderate"
2180
2293
  }
2294
+ },
2295
+ "x-f5xc-discovered-response-time": {
2296
+ "p50_ms": 500,
2297
+ "p95_ms": 1500,
2298
+ "p99_ms": 4000,
2299
+ "sample_count": 0,
2300
+ "source": "estimate"
2181
2301
  }
2182
2302
  },
2183
2303
  "x-displayname": "Addon Subscrption.",
@@ -2392,6 +2512,13 @@
2392
2512
  "latency": "low",
2393
2513
  "resource_usage": "low"
2394
2514
  }
2515
+ },
2516
+ "x-f5xc-discovered-response-time": {
2517
+ "p50_ms": 1000,
2518
+ "p95_ms": 3000,
2519
+ "p99_ms": 8000,
2520
+ "sample_count": 0,
2521
+ "source": "estimate"
2395
2522
  }
2396
2523
  },
2397
2524
  "x-displayname": "Central Manager Instance.",
@@ -2614,6 +2741,13 @@
2614
2741
  "latency": "low",
2615
2742
  "resource_usage": "low"
2616
2743
  }
2744
+ },
2745
+ "x-f5xc-discovered-response-time": {
2746
+ "p50_ms": 800,
2747
+ "p95_ms": 2500,
2748
+ "p99_ms": 6000,
2749
+ "sample_count": 0,
2750
+ "source": "estimate"
2617
2751
  }
2618
2752
  },
2619
2753
  "x-displayname": "Central Manager Instance.",
@@ -2841,6 +2975,13 @@
2841
2975
  "latency": "moderate",
2842
2976
  "resource_usage": "moderate"
2843
2977
  }
2978
+ },
2979
+ "x-f5xc-discovered-response-time": {
2980
+ "p50_ms": 200,
2981
+ "p95_ms": 800,
2982
+ "p99_ms": 2000,
2983
+ "sample_count": 0,
2984
+ "source": "estimate"
2844
2985
  }
2845
2986
  },
2846
2987
  "x-displayname": "Central Manager Instance.",
@@ -3062,6 +3203,13 @@
3062
3203
  "latency": "low",
3063
3204
  "resource_usage": "low"
3064
3205
  }
3206
+ },
3207
+ "x-f5xc-discovered-response-time": {
3208
+ "p50_ms": 200,
3209
+ "p95_ms": 800,
3210
+ "p99_ms": 2000,
3211
+ "sample_count": 0,
3212
+ "source": "estimate"
3065
3213
  }
3066
3214
  },
3067
3215
  "delete": {
@@ -3281,6 +3429,13 @@
3281
3429
  "latency": "high",
3282
3430
  "resource_usage": "moderate"
3283
3431
  }
3432
+ },
3433
+ "x-f5xc-discovered-response-time": {
3434
+ "p50_ms": 500,
3435
+ "p95_ms": 1500,
3436
+ "p99_ms": 4000,
3437
+ "sample_count": 0,
3438
+ "source": "estimate"
3284
3439
  }
3285
3440
  },
3286
3441
  "x-displayname": "Central Manager Instance.",
@@ -3495,6 +3650,13 @@
3495
3650
  "latency": "low",
3496
3651
  "resource_usage": "low"
3497
3652
  }
3653
+ },
3654
+ "x-f5xc-discovered-response-time": {
3655
+ "p50_ms": 1000,
3656
+ "p95_ms": 3000,
3657
+ "p99_ms": 8000,
3658
+ "sample_count": 0,
3659
+ "source": "estimate"
3498
3660
  }
3499
3661
  },
3500
3662
  "x-displayname": "External Connector Configuration.",
@@ -3717,6 +3879,13 @@
3717
3879
  "latency": "low",
3718
3880
  "resource_usage": "low"
3719
3881
  }
3882
+ },
3883
+ "x-f5xc-discovered-response-time": {
3884
+ "p50_ms": 800,
3885
+ "p95_ms": 2500,
3886
+ "p99_ms": 6000,
3887
+ "sample_count": 0,
3888
+ "source": "estimate"
3720
3889
  }
3721
3890
  },
3722
3891
  "x-displayname": "External Connector Configuration.",
@@ -3944,6 +4113,13 @@
3944
4113
  "latency": "moderate",
3945
4114
  "resource_usage": "moderate"
3946
4115
  }
4116
+ },
4117
+ "x-f5xc-discovered-response-time": {
4118
+ "p50_ms": 200,
4119
+ "p95_ms": 800,
4120
+ "p99_ms": 2000,
4121
+ "sample_count": 0,
4122
+ "source": "estimate"
3947
4123
  }
3948
4124
  },
3949
4125
  "x-displayname": "External Connector Configuration.",
@@ -4165,6 +4341,13 @@
4165
4341
  "latency": "low",
4166
4342
  "resource_usage": "low"
4167
4343
  }
4344
+ },
4345
+ "x-f5xc-discovered-response-time": {
4346
+ "p50_ms": 200,
4347
+ "p95_ms": 800,
4348
+ "p99_ms": 2000,
4349
+ "sample_count": 0,
4350
+ "source": "estimate"
4168
4351
  }
4169
4352
  },
4170
4353
  "delete": {
@@ -4384,6 +4567,13 @@
4384
4567
  "latency": "high",
4385
4568
  "resource_usage": "moderate"
4386
4569
  }
4570
+ },
4571
+ "x-f5xc-discovered-response-time": {
4572
+ "p50_ms": 500,
4573
+ "p95_ms": 1500,
4574
+ "p99_ms": 4000,
4575
+ "sample_count": 0,
4576
+ "source": "estimate"
4387
4577
  }
4388
4578
  },
4389
4579
  "x-displayname": "External Connector Configuration.",
@@ -4611,6 +4801,13 @@
4611
4801
  "latency": "moderate",
4612
4802
  "resource_usage": "moderate"
4613
4803
  }
4804
+ },
4805
+ "x-f5xc-discovered-response-time": {
4806
+ "p50_ms": 200,
4807
+ "p95_ms": 800,
4808
+ "p99_ms": 2000,
4809
+ "sample_count": 0,
4810
+ "source": "estimate"
4614
4811
  }
4615
4812
  },
4616
4813
  "x-displayname": "Navigation Tile.",
@@ -4830,6 +5027,13 @@
4830
5027
  "latency": "low",
4831
5028
  "resource_usage": "low"
4832
5029
  }
5030
+ },
5031
+ "x-f5xc-discovered-response-time": {
5032
+ "p50_ms": 200,
5033
+ "p95_ms": 800,
5034
+ "p99_ms": 2000,
5035
+ "sample_count": 0,
5036
+ "source": "estimate"
4833
5037
  }
4834
5038
  },
4835
5039
  "x-displayname": "Navigation Tile.",
@@ -5029,6 +5233,13 @@
5029
5233
  "latency": "low",
5030
5234
  "resource_usage": "low"
5031
5235
  }
5236
+ },
5237
+ "x-f5xc-discovered-response-time": {
5238
+ "p50_ms": 1000,
5239
+ "p95_ms": 3000,
5240
+ "p99_ms": 8000,
5241
+ "sample_count": 0,
5242
+ "source": "estimate"
5032
5243
  }
5033
5244
  },
5034
5245
  "x-displayname": "Onboard AWS SaaS PAYG account.",
@@ -5228,6 +5439,13 @@
5228
5439
  "latency": "low",
5229
5440
  "resource_usage": "low"
5230
5441
  }
5442
+ },
5443
+ "x-f5xc-discovered-response-time": {
5444
+ "p50_ms": 1000,
5445
+ "p95_ms": 3000,
5446
+ "p99_ms": 8000,
5447
+ "sample_count": 0,
5448
+ "source": "estimate"
5231
5449
  }
5232
5450
  },
5233
5451
  "x-displayname": "Onboard AWS SaaS PAYG account.",
@@ -5455,6 +5673,13 @@
5455
5673
  "latency": "moderate",
5456
5674
  "resource_usage": "moderate"
5457
5675
  }
5676
+ },
5677
+ "x-f5xc-discovered-response-time": {
5678
+ "p50_ms": 200,
5679
+ "p95_ms": 800,
5680
+ "p99_ms": 2000,
5681
+ "sample_count": 0,
5682
+ "source": "estimate"
5458
5683
  }
5459
5684
  },
5460
5685
  "x-displayname": "Plan",
@@ -5674,6 +5899,13 @@
5674
5899
  "latency": "low",
5675
5900
  "resource_usage": "low"
5676
5901
  }
5902
+ },
5903
+ "x-f5xc-discovered-response-time": {
5904
+ "p50_ms": 200,
5905
+ "p95_ms": 800,
5906
+ "p99_ms": 2000,
5907
+ "sample_count": 0,
5908
+ "source": "estimate"
5677
5909
  }
5678
5910
  },
5679
5911
  "x-displayname": "Plan",
@@ -5896,6 +6128,13 @@
5896
6128
  "latency": "low",
5897
6129
  "resource_usage": "low"
5898
6130
  }
6131
+ },
6132
+ "x-f5xc-discovered-response-time": {
6133
+ "p50_ms": 800,
6134
+ "p95_ms": 2500,
6135
+ "p99_ms": 6000,
6136
+ "sample_count": 0,
6137
+ "source": "estimate"
5899
6138
  }
5900
6139
  },
5901
6140
  "x-displayname": "Third Party Application.",
@@ -6110,6 +6349,13 @@
6110
6349
  "latency": "low",
6111
6350
  "resource_usage": "low"
6112
6351
  }
6352
+ },
6353
+ "x-f5xc-discovered-response-time": {
6354
+ "p50_ms": 1000,
6355
+ "p95_ms": 3000,
6356
+ "p99_ms": 8000,
6357
+ "sample_count": 0,
6358
+ "source": "estimate"
6113
6359
  }
6114
6360
  },
6115
6361
  "x-displayname": "Third Party Application.",
@@ -6337,6 +6583,13 @@
6337
6583
  "latency": "moderate",
6338
6584
  "resource_usage": "moderate"
6339
6585
  }
6586
+ },
6587
+ "x-f5xc-discovered-response-time": {
6588
+ "p50_ms": 200,
6589
+ "p95_ms": 800,
6590
+ "p99_ms": 2000,
6591
+ "sample_count": 0,
6592
+ "source": "estimate"
6340
6593
  }
6341
6594
  },
6342
6595
  "x-displayname": "Third Party Application.",
@@ -6557,6 +6810,13 @@
6557
6810
  "latency": "low",
6558
6811
  "resource_usage": "low"
6559
6812
  }
6813
+ },
6814
+ "x-f5xc-discovered-response-time": {
6815
+ "p50_ms": 200,
6816
+ "p95_ms": 800,
6817
+ "p99_ms": 2000,
6818
+ "sample_count": 0,
6819
+ "source": "estimate"
6560
6820
  }
6561
6821
  },
6562
6822
  "x-displayname": "Third Party Application.",
@@ -6758,6 +7018,13 @@
6758
7018
  "latency": "moderate",
6759
7019
  "resource_usage": "moderate"
6760
7020
  }
7021
+ },
7022
+ "x-f5xc-discovered-response-time": {
7023
+ "p50_ms": 200,
7024
+ "p95_ms": 800,
7025
+ "p99_ms": 2000,
7026
+ "sample_count": 0,
7027
+ "source": "estimate"
6761
7028
  }
6762
7029
  },
6763
7030
  "x-displayname": "Third Party Application.",
@@ -6972,6 +7239,13 @@
6972
7239
  "latency": "low",
6973
7240
  "resource_usage": "low"
6974
7241
  }
7242
+ },
7243
+ "x-f5xc-discovered-response-time": {
7244
+ "p50_ms": 200,
7245
+ "p95_ms": 800,
7246
+ "p99_ms": 2000,
7247
+ "sample_count": 0,
7248
+ "source": "estimate"
6975
7249
  }
6976
7250
  },
6977
7251
  "x-displayname": "View Internal.",
@@ -7212,6 +7486,13 @@
7212
7486
  "latency": "low",
7213
7487
  "resource_usage": "low"
7214
7488
  }
7489
+ },
7490
+ "x-f5xc-discovered-response-time": {
7491
+ "p50_ms": 1000,
7492
+ "p95_ms": 3000,
7493
+ "p99_ms": 8000,
7494
+ "sample_count": 0,
7495
+ "source": "estimate"
7215
7496
  }
7216
7497
  },
7217
7498
  "x-displayname": "View Terraform Parameters.",
@@ -7452,6 +7733,13 @@
7452
7733
  "latency": "low",
7453
7734
  "resource_usage": "low"
7454
7735
  }
7736
+ },
7737
+ "x-f5xc-discovered-response-time": {
7738
+ "p50_ms": 1000,
7739
+ "p95_ms": 3000,
7740
+ "p99_ms": 8000,
7741
+ "sample_count": 0,
7742
+ "source": "estimate"
7455
7743
  }
7456
7744
  },
7457
7745
  "x-displayname": "View Terraform Parameters.",
@@ -7666,6 +7954,13 @@
7666
7954
  "latency": "low",
7667
7955
  "resource_usage": "low"
7668
7956
  }
7957
+ },
7958
+ "x-f5xc-discovered-response-time": {
7959
+ "p50_ms": 200,
7960
+ "p95_ms": 800,
7961
+ "p99_ms": 2000,
7962
+ "sample_count": 0,
7963
+ "source": "estimate"
7669
7964
  }
7670
7965
  },
7671
7966
  "x-displayname": "View Terraform Parameters.",
@@ -7880,6 +8175,13 @@
7880
8175
  "latency": "moderate",
7881
8176
  "resource_usage": "moderate"
7882
8177
  }
8178
+ },
8179
+ "x-f5xc-discovered-response-time": {
8180
+ "p50_ms": 200,
8181
+ "p95_ms": 800,
8182
+ "p99_ms": 2000,
8183
+ "sample_count": 0,
8184
+ "source": "estimate"
7883
8185
  }
7884
8186
  },
7885
8187
  "x-displayname": "View Terraform Parameters.",
@@ -8079,6 +8381,13 @@
8079
8381
  "latency": "low",
8080
8382
  "resource_usage": "low"
8081
8383
  }
8384
+ },
8385
+ "x-f5xc-discovered-response-time": {
8386
+ "p50_ms": 1000,
8387
+ "p95_ms": 3000,
8388
+ "p99_ms": 8000,
8389
+ "sample_count": 0,
8390
+ "source": "estimate"
8082
8391
  }
8083
8392
  },
8084
8393
  "x-displayname": "XC SaaS Onboarding.",
@@ -8262,6 +8571,13 @@
8262
8571
  "latency": "moderate",
8263
8572
  "resource_usage": "moderate"
8264
8573
  }
8574
+ },
8575
+ "x-f5xc-discovered-response-time": {
8576
+ "p50_ms": 200,
8577
+ "p95_ms": 800,
8578
+ "p99_ms": 2000,
8579
+ "sample_count": 0,
8580
+ "source": "estimate"
8265
8581
  }
8266
8582
  },
8267
8583
  "x-displayname": "XC SaaS Onboarding.",
@@ -8461,6 +8777,13 @@
8461
8777
  "latency": "low",
8462
8778
  "resource_usage": "low"
8463
8779
  }
8780
+ },
8781
+ "x-f5xc-discovered-response-time": {
8782
+ "p50_ms": 1000,
8783
+ "p95_ms": 3000,
8784
+ "p99_ms": 8000,
8785
+ "sample_count": 0,
8786
+ "source": "estimate"
8464
8787
  }
8465
8788
  },
8466
8789
  "x-displayname": "XC SaaS Onboarding.",
@@ -8494,6 +8817,7 @@
8494
8817
  "description": "X-displayName: \"Display Name\"\nDisplay name of the addon service.",
8495
8818
  "title": "Display_name.",
8496
8819
  "x-f5xc-example": "Addon Service 1",
8820
+ "x-f5xc-description-short": "X-displayName: \"Display Name\" Display name of the addon service.",
8497
8821
  "minLength": 0,
8498
8822
  "maxLength": 1024,
8499
8823
  "x-f5xc-required-for": {
@@ -8508,6 +8832,7 @@
8508
8832
  "description": "X-displayName: \"Name\"\nName of the addon_service.",
8509
8833
  "title": "Name",
8510
8834
  "x-f5xc-example": "addon-service-1",
8835
+ "x-f5xc-description-short": "X-displayName: \"Name\" Name of the addon_service.",
8511
8836
  "minLength": 0,
8512
8837
  "maxLength": 16,
8513
8838
  "x-f5xc-required-for": {
@@ -8518,12 +8843,14 @@
8518
8843
  },
8519
8844
  "x-original-maxLength": 1024,
8520
8845
  "x-reconciled-from-discovery": true,
8521
- "x-reconciled-at": "2026-01-05T14:37:36.248696+00:00"
8846
+ "x-reconciled-at": "2026-01-07T15:27:47.383241+00:00"
8522
8847
  },
8523
8848
  "tier": {
8524
8849
  "$ref": "#/components/schemas/schemaAddonServiceTierType"
8525
8850
  }
8526
8851
  },
8852
+ "x-f5xc-description-short": "X-displayName: \"Addon Service Activation Status\" Contains single addon service activation status information.",
8853
+ "x-f5xc-description-medium": "X-displayName: \"Addon Service Activation Status\" Contains single addon service activation status information.",
8527
8854
  "x-f5xc-minimum-configuration": {
8528
8855
  "description": "Minimum configuration for addon_serviceAddonServiceActivationStatus",
8529
8856
  "required_fields": [
@@ -8562,7 +8889,7 @@
8562
8889
  },
8563
8890
  "x-original-maxLength": 1024,
8564
8891
  "x-reconciled-from-discovery": true,
8565
- "x-reconciled-at": "2026-01-05T14:37:36.248705+00:00"
8892
+ "x-reconciled-at": "2026-01-07T15:27:47.383250+00:00"
8566
8893
  },
8567
8894
  "subject": {
8568
8895
  "type": "string",
@@ -8579,6 +8906,7 @@
8579
8906
  }
8580
8907
  }
8581
8908
  },
8909
+ "x-f5xc-description-short": "Content holds the subject and the description.",
8582
8910
  "x-f5xc-minimum-configuration": {
8583
8911
  "description": "Minimum configuration for addon_serviceContent",
8584
8912
  "required_fields": [
@@ -8612,6 +8940,7 @@
8612
8940
  "$ref": "#/components/schemas/addon_serviceContent"
8613
8941
  }
8614
8942
  },
8943
+ "x-f5xc-description-short": "CustomSupportTicket holds the template details provided by the service owner.",
8615
8944
  "x-f5xc-minimum-configuration": {
8616
8945
  "description": "Minimum configuration for addon_serviceCustomSupportTicket",
8617
8946
  "required_fields": [
@@ -8638,6 +8967,7 @@
8638
8967
  "$ref": "#/components/schemas/addon_serviceNotificationPreference"
8639
8968
  }
8640
8969
  },
8970
+ "x-f5xc-description-short": "Managed Activation and require complete manual intervention.",
8641
8971
  "x-f5xc-minimum-configuration": {
8642
8972
  "description": "Minimum configuration for addon_serviceFullyManagedActivationType",
8643
8973
  "required_fields": [
@@ -8661,6 +8991,7 @@
8661
8991
  "$ref": "#/components/schemas/schemaAddonServiceState"
8662
8992
  }
8663
8993
  },
8994
+ "x-f5xc-description-short": "Response shape for addon service activation status.",
8664
8995
  "x-f5xc-minimum-configuration": {
8665
8996
  "description": "Minimum configuration for addon_serviceGetActivationStatusResp",
8666
8997
  "required_fields": [
@@ -8688,6 +9019,7 @@
8688
9019
  "x-displayname": "Addon Service Group Display Name.",
8689
9020
  "x-ves-example": "Addon service group 1.",
8690
9021
  "x-f5xc-example": "addon service group 1",
9022
+ "x-f5xc-description-short": "Display name of the addon service group.",
8691
9023
  "minLength": 0,
8692
9024
  "maxLength": 1024,
8693
9025
  "x-f5xc-required-for": {
@@ -8742,6 +9074,7 @@
8742
9074
  "$ref": "#/components/schemas/schemaAddonServiceTierType"
8743
9075
  }
8744
9076
  },
9077
+ "x-f5xc-description-short": "Response shape for addon service details.",
8745
9078
  "x-f5xc-minimum-configuration": {
8746
9079
  "description": "Minimum configuration for addon_serviceGetAddonServiceDetailsResp",
8747
9080
  "required_fields": [
@@ -8772,6 +9105,7 @@
8772
9105
  "description": "Current state of addon service subscription. The key is the name of the service.",
8773
9106
  "title": "State",
8774
9107
  "x-displayname": "State",
9108
+ "x-f5xc-description-short": "Current state of addon service subscription. The key is the name of the service.",
8775
9109
  "x-f5xc-required-for": {
8776
9110
  "minimum_config": false,
8777
9111
  "create": false,
@@ -8780,6 +9114,7 @@
8780
9114
  }
8781
9115
  }
8782
9116
  },
9117
+ "x-f5xc-description-short": "Response shape for addon service feature tier activation statuses.",
8783
9118
  "x-f5xc-minimum-configuration": {
8784
9119
  "description": "Minimum configuration for addon_serviceGetAllServiceTiersActivationStatusResp",
8785
9120
  "required_fields": [
@@ -8807,6 +9142,7 @@
8807
9142
  "$ref": "#/components/schemas/schemaObjectRefType"
8808
9143
  },
8809
9144
  "x-displayname": "Deleted Referred Objects.",
9145
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
8810
9146
  "x-f5xc-required-for": {
8811
9147
  "minimum_config": false,
8812
9148
  "create": false,
@@ -8822,6 +9158,7 @@
8822
9158
  "$ref": "#/components/schemas/schemaObjectRefType"
8823
9159
  },
8824
9160
  "x-displayname": "Disabled Referred Objects.",
9161
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
8825
9162
  "x-f5xc-required-for": {
8826
9163
  "minimum_config": false,
8827
9164
  "create": false,
@@ -8840,6 +9177,7 @@
8840
9177
  "$ref": "#/components/schemas/schemaObjectRefType"
8841
9178
  },
8842
9179
  "x-displayname": "Referring Objects.",
9180
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
8843
9181
  "x-f5xc-required-for": {
8844
9182
  "minimum_config": false,
8845
9183
  "create": false,
@@ -8858,6 +9196,8 @@
8858
9196
  "$ref": "#/components/schemas/addon_serviceStatusObject"
8859
9197
  },
8860
9198
  "x-displayname": "Status",
9199
+ "x-f5xc-example": "active",
9200
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
8861
9201
  "x-f5xc-required-for": {
8862
9202
  "minimum_config": false,
8863
9203
  "create": false,
@@ -8867,7 +9207,7 @@
8867
9207
  "maxLength": 17,
8868
9208
  "minLength": 17,
8869
9209
  "x-reconciled-from-discovery": true,
8870
- "x-reconciled-at": "2026-01-05T14:37:36.248744+00:00"
9210
+ "x-reconciled-at": "2026-01-07T15:27:47.383285+00:00"
8871
9211
  },
8872
9212
  "system_metadata": {
8873
9213
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -8903,6 +9243,8 @@
8903
9243
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
8904
9244
  ],
8905
9245
  "default": "GET_RSP_FORMAT_DEFAULT",
9246
+ "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...",
9247
+ "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_STATUS: x-displayName: \"Status format\" Response should be in...",
8906
9248
  "x-f5xc-minimum-configuration": {
8907
9249
  "description": "Minimum configuration for addon_serviceGetResponseFormatCode",
8908
9250
  "required_fields": [],
@@ -8928,6 +9270,7 @@
8928
9270
  "$ref": "#/components/schemas/schemaErrorType"
8929
9271
  },
8930
9272
  "x-displayname": "Errors",
9273
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
8931
9274
  "x-f5xc-required-for": {
8932
9275
  "minimum_config": false,
8933
9276
  "create": false,
@@ -8943,6 +9286,8 @@
8943
9286
  "$ref": "#/components/schemas/addon_serviceListResponseItem"
8944
9287
  },
8945
9288
  "x-displayname": "Items",
9289
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
9290
+ "x-f5xc-description-short": "Items represents the collection in response.",
8946
9291
  "x-f5xc-required-for": {
8947
9292
  "minimum_config": false,
8948
9293
  "create": false,
@@ -8976,6 +9321,8 @@
8976
9321
  "description": "The set of annotations present on this addon_service.",
8977
9322
  "title": "Annotations.",
8978
9323
  "x-displayname": "Annotations.",
9324
+ "x-f5xc-example": "{\"key\": \"value\"}",
9325
+ "x-f5xc-description-short": "The set of annotations present on this addon_service.",
8979
9326
  "x-f5xc-required-for": {
8980
9327
  "minimum_config": false,
8981
9328
  "create": false,
@@ -8988,6 +9335,7 @@
8988
9335
  "description": "The description set for this addon_service.",
8989
9336
  "title": "Description.",
8990
9337
  "x-displayname": "Description.",
9338
+ "x-f5xc-description-short": "The description set for this addon_service.",
8991
9339
  "minLength": 0,
8992
9340
  "maxLength": 0,
8993
9341
  "x-f5xc-required-for": {
@@ -8998,7 +9346,7 @@
8998
9346
  },
8999
9347
  "x-original-maxLength": 1024,
9000
9348
  "x-reconciled-from-discovery": true,
9001
- "x-reconciled-at": "2026-01-05T14:37:36.248769+00:00"
9349
+ "x-reconciled-at": "2026-01-07T15:27:47.383298+00:00"
9002
9350
  },
9003
9351
  "disabled": {
9004
9352
  "type": "boolean",
@@ -9006,6 +9354,8 @@
9006
9354
  "title": "Disabled",
9007
9355
  "format": "boolean",
9008
9356
  "x-displayname": "Disabled",
9357
+ "x-f5xc-example": "True",
9358
+ "x-f5xc-description-short": "Value of true indicates addon_service is administratively disabled.",
9009
9359
  "x-f5xc-required-for": {
9010
9360
  "minimum_config": false,
9011
9361
  "create": false,
@@ -9021,6 +9371,8 @@
9021
9371
  "description": "The set of labels present on this addon_service.",
9022
9372
  "title": "Labels",
9023
9373
  "x-displayname": "Labels",
9374
+ "x-f5xc-example": "{\"key\": \"value\"}",
9375
+ "x-f5xc-description-short": "The set of labels present on this addon_service.",
9024
9376
  "x-f5xc-required-for": {
9025
9377
  "minimum_config": false,
9026
9378
  "create": false,
@@ -9048,7 +9400,7 @@
9048
9400
  },
9049
9401
  "x-original-maxLength": 1024,
9050
9402
  "x-reconciled-from-discovery": true,
9051
- "x-reconciled-at": "2026-01-05T14:37:36.248781+00:00"
9403
+ "x-reconciled-at": "2026-01-07T15:27:47.383308+00:00"
9052
9404
  },
9053
9405
  "namespace": {
9054
9406
  "type": "string",
@@ -9067,7 +9419,7 @@
9067
9419
  },
9068
9420
  "x-original-maxLength": 1024,
9069
9421
  "x-reconciled-from-discovery": true,
9070
- "x-reconciled-at": "2026-01-05T14:37:36.248786+00:00"
9422
+ "x-reconciled-at": "2026-01-07T15:27:47.383312+00:00"
9071
9423
  },
9072
9424
  "owner_view": {
9073
9425
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -9080,6 +9432,7 @@
9080
9432
  "$ref": "#/components/schemas/addon_serviceStatusObject"
9081
9433
  },
9082
9434
  "x-displayname": "Status",
9435
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
9083
9436
  "x-f5xc-required-for": {
9084
9437
  "minimum_config": false,
9085
9438
  "create": false,
@@ -9108,7 +9461,7 @@
9108
9461
  "x-field-mutability": "read-only",
9109
9462
  "x-original-maxLength": 1024,
9110
9463
  "x-reconciled-from-discovery": true,
9111
- "x-reconciled-at": "2026-01-05T14:37:36.248795+00:00"
9464
+ "x-reconciled-at": "2026-01-07T15:27:47.383320+00:00"
9112
9465
  },
9113
9466
  "uid": {
9114
9467
  "type": "string",
@@ -9129,9 +9482,11 @@
9129
9482
  "x-original-maxLength": 1024,
9130
9483
  "format": "uuid",
9131
9484
  "x-reconciled-from-discovery": true,
9132
- "x-reconciled-at": "2026-01-05T14:37:36.248800+00:00"
9485
+ "x-reconciled-at": "2026-01-07T15:27:47.383326+00:00"
9133
9486
  }
9134
9487
  },
9488
+ "x-f5xc-description-short": "By default a summary of addon_service is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
9489
+ "x-f5xc-description-medium": "By default a summary of addon_service is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
9135
9490
  "x-f5xc-minimum-configuration": {
9136
9491
  "description": "Minimum configuration for addon_serviceListResponseItem",
9137
9492
  "required_fields": [
@@ -9171,6 +9526,7 @@
9171
9526
  "$ref": "#/components/schemas/addon_serviceSupportTicketOptions"
9172
9527
  }
9173
9528
  },
9529
+ "x-f5xc-description-short": "NotificationPreference preference for receiving addon subscription notifications.",
9174
9530
  "x-f5xc-minimum-configuration": {
9175
9531
  "description": "Minimum configuration for addon_serviceNotificationPreference",
9176
9532
  "required_fields": [
@@ -9190,6 +9546,7 @@
9190
9546
  "title": "PartiallyManagedActivationType.",
9191
9547
  "x-displayname": "Partially Managed Activation.",
9192
9548
  "x-ves-proto-message": "ves.io.schema.pbac.addon_service.PartiallyManagedActivationType",
9549
+ "x-f5xc-description-short": "Addon service activation will require partial management from backend or SRE.",
9193
9550
  "x-f5xc-minimum-configuration": {
9194
9551
  "description": "Minimum configuration for addon_servicePartiallyManagedActivationType",
9195
9552
  "required_fields": [],
@@ -9222,6 +9579,9 @@
9222
9579
  "ves.io.schema.rules.message.required": "true",
9223
9580
  "ves.io.schema.rules.string.max_len": "32"
9224
9581
  },
9582
+ "x-f5xc-example": "example-resource",
9583
+ "x-f5xc-description-short": "Default landing page for the addon service after successful subscription. Value should match name of the navigation tile config object.",
9584
+ "x-f5xc-description-medium": "Default landing page for the addon service after successful subscription. Value should match name of the navigation tile config object. Required: YES.",
9225
9585
  "minLength": 0,
9226
9586
  "x-f5xc-required-for": {
9227
9587
  "minimum_config": false,
@@ -9231,6 +9591,7 @@
9231
9591
  }
9232
9592
  }
9233
9593
  },
9594
+ "x-f5xc-description-short": "Addon service can be subscribed and activated by user directly without any manual intervention.",
9234
9595
  "x-f5xc-minimum-configuration": {
9235
9596
  "description": "Minimum configuration for addon_serviceSelfActivationType",
9236
9597
  "required_fields": [
@@ -9284,6 +9645,7 @@
9284
9645
  }
9285
9646
  }
9286
9647
  },
9648
+ "x-f5xc-description-short": "Most recently observed status of object.",
9287
9649
  "x-f5xc-minimum-configuration": {
9288
9650
  "description": "Minimum configuration for addon_serviceStatusObject",
9289
9651
  "required_fields": [
@@ -9316,6 +9678,7 @@
9316
9678
  "$ref": "#/components/schemas/ioschemaEmpty"
9317
9679
  }
9318
9680
  },
9681
+ "x-f5xc-description-short": "SupportTicketOptions deals with whether the support ticket needs to be created.",
9319
9682
  "x-f5xc-minimum-configuration": {
9320
9683
  "description": "Minimum configuration for addon_serviceSupportTicketOptions",
9321
9684
  "required_fields": [
@@ -9367,6 +9730,8 @@
9367
9730
  "default": "SS_UNKNOWN",
9368
9731
  "x-displayname": "Support Service.",
9369
9732
  "x-ves-proto-enum": "ves.io.schema.customer_support.SupportService",
9733
+ "x-f5xc-description-short": "Indicates the list of support service Unknown Support Service Account Protection Support Service Administration Support Service Application...",
9734
+ "x-f5xc-description-medium": "Indicates the list of support service Unknown Support Service Account Protection Support Service Administration Support Service Application Traffic Insight Support Service Audit Logs & Alerts Support Service Authentication Intelligence Support Service Billing Support Service Client Side Defense...",
9370
9735
  "x-f5xc-minimum-configuration": {
9371
9736
  "description": "Minimum configuration for customer_supportSupportService",
9372
9737
  "required_fields": [],
@@ -9390,6 +9755,8 @@
9390
9755
  "default": "PRIORITY_UNKNOWN",
9391
9756
  "x-displayname": "Priority",
9392
9757
  "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketPriority",
9758
+ "x-f5xc-description-short": "Support ticket priority helps understand importance of the ticket and focus more on more critical issues.",
9759
+ "x-f5xc-description-medium": "Support ticket priority helps understand importance of the ticket and focus more on more critical issues. Unknown/empty priority Normal priority issue High priority issue Urgent priority issue.",
9393
9760
  "x-f5xc-minimum-configuration": {
9394
9761
  "description": "Minimum configuration for customer_supportSupportTicketPriority",
9395
9762
  "required_fields": [],
@@ -9406,6 +9773,7 @@
9406
9773
  "title": "Empty",
9407
9774
  "x-displayname": "Empty",
9408
9775
  "x-ves-proto-message": "ves.io.schema.Empty",
9776
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
9409
9777
  "x-f5xc-minimum-configuration": {
9410
9778
  "description": "Minimum configuration for ioschemaEmpty",
9411
9779
  "required_fields": [],
@@ -9441,6 +9809,7 @@
9441
9809
  "ves.io.schema.rules.repeated.items.string.email": "true",
9442
9810
  "ves.io.schema.rules.repeated.unique": "true"
9443
9811
  },
9812
+ "x-f5xc-description-short": "Email IDs associated with the Addon Subscription.",
9444
9813
  "x-f5xc-required-for": {
9445
9814
  "minimum_config": false,
9446
9815
  "create": false,
@@ -9450,6 +9819,7 @@
9450
9819
  "x-field-mutability": "read-only"
9451
9820
  }
9452
9821
  },
9822
+ "x-f5xc-description-short": "Addon Subscription Emails associated with the Addon Subscription.",
9453
9823
  "x-f5xc-minimum-configuration": {
9454
9824
  "description": "Minimum configuration for pbacEmailDL",
9455
9825
  "required_fields": [
@@ -9485,6 +9855,8 @@
9485
9855
  "x-validation-rules": {
9486
9856
  "ves.io.schema.rules.repeated.max_items": "32"
9487
9857
  },
9858
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
9859
+ "x-f5xc-description-short": "List of references to all api_group objects that belong to this addon service.",
9488
9860
  "x-f5xc-required-for": {
9489
9861
  "minimum_config": false,
9490
9862
  "create": false,
@@ -9509,6 +9881,8 @@
9509
9881
  "ves.io.schema.rules.repeated.max_items": "32",
9510
9882
  "ves.io.schema.rules.repeated.unique": "true"
9511
9883
  },
9884
+ "x-f5xc-description-short": "List of addon services this service dependent on. To subscribe/enable this service, all of dependent service should be enabled.",
9885
+ "x-f5xc-description-medium": "List of addon services this service dependent on. To subscribe/enable this service, all of dependent service should be enabled.",
9512
9886
  "x-f5xc-required-for": {
9513
9887
  "minimum_config": false,
9514
9888
  "create": false,
@@ -9531,6 +9905,7 @@
9531
9905
  "ves.io.schema.rules.string.max_len": "512"
9532
9906
  },
9533
9907
  "x-f5xc-example": "example-resource",
9908
+ "x-f5xc-description-short": "User friendly name for display purpose. Required: YES.",
9534
9909
  "minLength": 0,
9535
9910
  "x-f5xc-required-for": {
9536
9911
  "minimum_config": false,
@@ -9555,6 +9930,7 @@
9555
9930
  "ves.io.schema.rules.repeated.max_items": "32",
9556
9931
  "ves.io.schema.rules.repeated.unique": "true"
9557
9932
  },
9933
+ "x-f5xc-description-short": "List of additional addon services automatically subscribed part of this subscription.",
9558
9934
  "x-f5xc-required-for": {
9559
9935
  "minimum_config": false,
9560
9936
  "create": false,
@@ -9578,6 +9954,8 @@
9578
9954
  "$ref": "#/components/schemas/schemaFeatureTag"
9579
9955
  },
9580
9956
  "x-displayname": "Feature tag.",
9957
+ "x-f5xc-example": "{\"key\": \"value\"}",
9958
+ "x-f5xc-description-short": "Feature tag can flag an addon service as a feature (preview, new, beta, etc) and their combination.",
9581
9959
  "x-f5xc-required-for": {
9582
9960
  "minimum_config": false,
9583
9961
  "create": false,
@@ -9589,6 +9967,7 @@
9589
9967
  "$ref": "#/components/schemas/schemaAddonServiceTierType"
9590
9968
  }
9591
9969
  },
9970
+ "x-f5xc-description-short": "GET addon_service reads a given object from storage backend for metadata.namespace.",
9592
9971
  "x-f5xc-minimum-configuration": {
9593
9972
  "description": "Minimum configuration for pbacaddon_serviceGetSpecType",
9594
9973
  "required_fields": [
@@ -9616,6 +9995,8 @@
9616
9995
  "type_url": {
9617
9996
  "type": "string",
9618
9997
  "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.",
9998
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
9999
+ "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 ).",
9619
10000
  "minLength": 0,
9620
10001
  "maxLength": 1024,
9621
10002
  "x-f5xc-required-for": {
@@ -9639,9 +10020,11 @@
9639
10020
  },
9640
10021
  "x-original-maxLength": 1024,
9641
10022
  "x-reconciled-from-discovery": true,
9642
- "x-reconciled-at": "2026-01-05T14:37:36.248839+00:00"
10023
+ "x-reconciled-at": "2026-01-07T15:27:47.383361+00:00"
9643
10024
  }
9644
10025
  },
10026
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
10027
+ "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...",
9645
10028
  "x-f5xc-minimum-configuration": {
9646
10029
  "description": "Minimum configuration for protobufAny",
9647
10030
  "required_fields": [
@@ -9668,6 +10051,8 @@
9668
10051
  "AS_AC_PBAC_DENY_AS_AC_EOL"
9669
10052
  ],
9670
10053
  "default": "AS_AC_NONE",
10054
+ "x-f5xc-description-short": "X-displayName: \"Addon Service Access\" State of access into service - AS_AC_NONE: x-displayName: \"None\" default state This can mean that addon...",
10055
+ "x-f5xc-description-medium": "X-displayName: \"Addon Service Access\" State of access into service - AS_AC_NONE: x-displayName: \"None\" default state This can mean that addon service is not subscribed or is in pending subscription. - AS_AC_ALLOWED: x-displayName: \"Allow\" access is allowed - AS_AC_PBAC_DENY: x-displayName: \"PBAC...",
9671
10056
  "x-f5xc-minimum-configuration": {
9672
10057
  "description": "Minimum configuration for schemaAddonServiceAccess",
9673
10058
  "required_fields": [],
@@ -9691,6 +10076,8 @@
9691
10076
  "default": "AS_NONE",
9692
10077
  "x-displayname": "Addon Service State.",
9693
10078
  "x-ves-proto-enum": "ves.io.schema.AddonServiceState",
10079
+ "x-f5xc-description-short": "State of a service default state initiated subscription request and is pending to activate (requested).",
10080
+ "x-f5xc-description-medium": "State of a service default state initiated subscription request and is pending to activate (requested). Successfully subscribed service subscription request ended up in error state.",
9694
10081
  "x-f5xc-minimum-configuration": {
9695
10082
  "description": "Minimum configuration for schemaAddonServiceState",
9696
10083
  "required_fields": [],
@@ -9715,6 +10102,8 @@
9715
10102
  "default": "NO_TIER",
9716
10103
  "x-displayname": "Addon Service Tier.",
9717
10104
  "x-ves-proto-enum": "ves.io.schema.AddonServiceTierType",
10105
+ "x-f5xc-description-short": "AddonServiceTierType is for identifying the tier of an addon service - NO_TIER: none when tier is not applicable for a addon service - BASIC...",
10106
+ "x-f5xc-description-medium": "AddonServiceTierType is for identifying the tier of an addon service - NO_TIER: none when tier is not applicable for a addon service - BASIC: basic basic - STANDARD: standard standard - ADVANCED: advanced advanced - PREMIUM: premium premium.",
9718
10107
  "x-f5xc-minimum-configuration": {
9719
10108
  "description": "Minimum configuration for schemaAddonServiceTierType",
9720
10109
  "required_fields": [],
@@ -9737,6 +10126,8 @@
9737
10126
  "description": "Hostname of the instance of the site that sent the status.",
9738
10127
  "title": "Hostname",
9739
10128
  "x-displayname": "Hostname",
10129
+ "x-f5xc-example": "example-resource",
10130
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
9740
10131
  "minLength": 0,
9741
10132
  "maxLength": 1024,
9742
10133
  "x-f5xc-required-for": {
@@ -9768,6 +10159,8 @@
9768
10159
  "x-displayname": "Reason",
9769
10160
  "x-ves-example": "Value",
9770
10161
  "x-f5xc-example": "value",
10162
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
10163
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
9771
10164
  "minLength": 0,
9772
10165
  "maxLength": 43,
9773
10166
  "x-f5xc-required-for": {
@@ -9778,13 +10171,15 @@
9778
10171
  },
9779
10172
  "x-original-maxLength": 1024,
9780
10173
  "x-reconciled-from-discovery": true,
9781
- "x-reconciled-at": "2026-01-05T14:37:36.248848+00:00"
10174
+ "x-reconciled-at": "2026-01-07T15:27:47.383370+00:00"
9782
10175
  },
9783
10176
  "service_name": {
9784
10177
  "type": "string",
9785
10178
  "description": "Name of the service that sent the status.",
9786
10179
  "title": "Service name.",
9787
10180
  "x-displayname": "Service Name.",
10181
+ "x-f5xc-example": "example-resource",
10182
+ "x-f5xc-description-short": "Name of the service that sent the status.",
9788
10183
  "minLength": 0,
9789
10184
  "maxLength": 1024,
9790
10185
  "x-f5xc-required-for": {
@@ -9807,6 +10202,8 @@
9807
10202
  "x-validation-rules": {
9808
10203
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
9809
10204
  },
10205
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
10206
+ "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...",
9810
10207
  "minLength": 0,
9811
10208
  "maxLength": 17,
9812
10209
  "x-f5xc-required-for": {
@@ -9817,7 +10214,7 @@
9817
10214
  },
9818
10215
  "x-original-maxLength": 1024,
9819
10216
  "x-reconciled-from-discovery": true,
9820
- "x-reconciled-at": "2026-01-05T14:37:36.248854+00:00"
10217
+ "x-reconciled-at": "2026-01-07T15:27:47.383375+00:00"
9821
10218
  },
9822
10219
  "type": {
9823
10220
  "type": "string",
@@ -9832,6 +10229,8 @@
9832
10229
  "x-validation-rules": {
9833
10230
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
9834
10231
  },
10232
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
10233
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
9835
10234
  "minLength": 0,
9836
10235
  "maxLength": 1024,
9837
10236
  "x-f5xc-required-for": {
@@ -9842,6 +10241,8 @@
9842
10241
  }
9843
10242
  }
9844
10243
  },
10244
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
10245
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
9845
10246
  "x-f5xc-minimum-configuration": {
9846
10247
  "description": "Minimum configuration for schemaConditionType",
9847
10248
  "required_fields": [
@@ -9877,6 +10278,8 @@
9877
10278
  "default": "EOK",
9878
10279
  "x-displayname": "Error Code.",
9879
10280
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
10281
+ "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...",
10282
+ "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...",
9880
10283
  "x-f5xc-minimum-configuration": {
9881
10284
  "description": "Minimum configuration for schemaErrorCode",
9882
10285
  "required_fields": [],
@@ -9917,6 +10320,7 @@
9917
10320
  }
9918
10321
  }
9919
10322
  },
10323
+ "x-f5xc-description-short": "Information about a error in API operation.",
9920
10324
  "x-f5xc-minimum-configuration": {
9921
10325
  "description": "Minimum configuration for schemaErrorType",
9922
10326
  "required_fields": [
@@ -9944,6 +10348,8 @@
9944
10348
  "default": "NONE",
9945
10349
  "x-displayname": "Feature Tag.",
9946
10350
  "x-ves-proto-enum": "ves.io.schema.FeatureTag",
10351
+ "x-f5xc-description-short": "FeatureTag is for identifying the tag of feature of an offering (new, preview) Unknown (undefined) feature tag New feature tag Preview feature tag...",
10352
+ "x-f5xc-description-medium": "FeatureTag is for identifying the tag of feature of an offering (new, preview) Unknown (undefined) feature tag New feature tag Preview feature tag Private preview feature tag.",
9947
10353
  "x-f5xc-minimum-configuration": {
9948
10354
  "description": "Minimum configuration for schemaFeatureTag",
9949
10355
  "required_fields": [],
@@ -9967,6 +10373,7 @@
9967
10373
  "title": "Name",
9968
10374
  "x-displayname": "Name",
9969
10375
  "x-f5xc-example": "example-resource",
10376
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
9970
10377
  "minLength": 0,
9971
10378
  "maxLength": 16,
9972
10379
  "x-f5xc-required-for": {
@@ -9977,9 +10384,10 @@
9977
10384
  },
9978
10385
  "x-original-maxLength": 1024,
9979
10386
  "x-reconciled-from-discovery": true,
9980
- "x-reconciled-at": "2026-01-05T14:37:36.248866+00:00"
10387
+ "x-reconciled-at": "2026-01-07T15:27:47.383387+00:00"
9981
10388
  }
9982
10389
  },
10390
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
9983
10391
  "x-f5xc-minimum-configuration": {
9984
10392
  "description": "Minimum configuration for schemaInitializerType",
9985
10393
  "required_fields": [
@@ -10007,6 +10415,8 @@
10007
10415
  "$ref": "#/components/schemas/schemaInitializerType"
10008
10416
  },
10009
10417
  "x-displayname": "Pending",
10418
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
10419
+ "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.",
10010
10420
  "x-f5xc-required-for": {
10011
10421
  "minimum_config": false,
10012
10422
  "create": false,
@@ -10018,6 +10428,7 @@
10018
10428
  "$ref": "#/components/schemas/schemaStatusType"
10019
10429
  }
10020
10430
  },
10431
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
10021
10432
  "x-f5xc-minimum-configuration": {
10022
10433
  "description": "Minimum configuration for schemaInitializersType",
10023
10434
  "required_fields": [
@@ -10057,6 +10468,8 @@
10057
10468
  "ves.io.schema.rules.map.values.string.max_len": "1024",
10058
10469
  "ves.io.schema.rules.map.values.string.min_len": "1"
10059
10470
  },
10471
+ "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.",
10472
+ "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.",
10060
10473
  "x-f5xc-required-for": {
10061
10474
  "minimum_config": false,
10062
10475
  "create": false,
@@ -10078,6 +10491,7 @@
10078
10491
  "x-validation-rules": {
10079
10492
  "ves.io.schema.rules.string.max_bytes": "1200"
10080
10493
  },
10494
+ "x-f5xc-description-short": "Human readable description for the object.",
10081
10495
  "minLength": 0,
10082
10496
  "x-f5xc-required-for": {
10083
10497
  "minimum_config": false,
@@ -10087,7 +10501,7 @@
10087
10501
  },
10088
10502
  "x-original-maxLength": 1200,
10089
10503
  "x-reconciled-from-discovery": true,
10090
- "x-reconciled-at": "2026-01-05T14:37:36.248876+00:00"
10504
+ "x-reconciled-at": "2026-01-07T15:27:47.383396+00:00"
10091
10505
  },
10092
10506
  "disable": {
10093
10507
  "type": "boolean",
@@ -10097,6 +10511,7 @@
10097
10511
  "x-displayname": "Disable",
10098
10512
  "x-ves-example": "True",
10099
10513
  "x-f5xc-example": "true",
10514
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
10100
10515
  "x-f5xc-required-for": {
10101
10516
  "minimum_config": false,
10102
10517
  "create": false,
@@ -10111,6 +10526,8 @@
10111
10526
  "x-displayname": "Labels",
10112
10527
  "x-ves-example": "Value",
10113
10528
  "x-f5xc-example": "value",
10529
+ "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.",
10530
+ "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.",
10114
10531
  "x-f5xc-required-for": {
10115
10532
  "minimum_config": false,
10116
10533
  "create": false,
@@ -10132,6 +10549,8 @@
10132
10549
  "x-validation-rules": {
10133
10550
  "ves.io.schema.rules.message.required": "true"
10134
10551
  },
10552
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
10553
+ "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.",
10135
10554
  "minLength": 0,
10136
10555
  "maxLength": 16,
10137
10556
  "x-f5xc-required-for": {
@@ -10142,7 +10561,7 @@
10142
10561
  },
10143
10562
  "x-original-maxLength": 1024,
10144
10563
  "x-reconciled-from-discovery": true,
10145
- "x-reconciled-at": "2026-01-05T14:37:36.248884+00:00"
10564
+ "x-reconciled-at": "2026-01-07T15:27:47.383404+00:00"
10146
10565
  },
10147
10566
  "namespace": {
10148
10567
  "type": "string",
@@ -10151,6 +10570,8 @@
10151
10570
  "x-displayname": "Namespace",
10152
10571
  "x-ves-example": "Staging",
10153
10572
  "x-f5xc-example": "staging",
10573
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
10574
+ "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 \"\".",
10154
10575
  "minLength": 0,
10155
10576
  "maxLength": 6,
10156
10577
  "x-f5xc-required-for": {
@@ -10161,9 +10582,10 @@
10161
10582
  },
10162
10583
  "x-original-maxLength": 1024,
10163
10584
  "x-reconciled-from-discovery": true,
10164
- "x-reconciled-at": "2026-01-05T14:37:36.248888+00:00"
10585
+ "x-reconciled-at": "2026-01-07T15:27:47.383408+00:00"
10165
10586
  }
10166
10587
  },
10588
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
10167
10589
  "x-f5xc-minimum-configuration": {
10168
10590
  "description": "Minimum configuration for schemaObjectGetMetaType",
10169
10591
  "required_fields": [
@@ -10195,6 +10617,8 @@
10195
10617
  "x-displayname": "Kind",
10196
10618
  "x-ves-example": "Virtual_site.",
10197
10619
  "x-f5xc-example": "virtual_site",
10620
+ "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\")",
10621
+ "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\").",
10198
10622
  "minLength": 0,
10199
10623
  "maxLength": 14,
10200
10624
  "x-f5xc-required-for": {
@@ -10206,7 +10630,7 @@
10206
10630
  "readOnly": true,
10207
10631
  "x-original-maxLength": 1024,
10208
10632
  "x-reconciled-from-discovery": true,
10209
- "x-reconciled-at": "2026-01-05T14:37:36.248893+00:00"
10633
+ "x-reconciled-at": "2026-01-07T15:27:47.383412+00:00"
10210
10634
  },
10211
10635
  "name": {
10212
10636
  "type": "string",
@@ -10215,6 +10639,8 @@
10215
10639
  "x-displayname": "Name",
10216
10640
  "x-ves-example": "Contactus-route.",
10217
10641
  "x-f5xc-example": "contactus-route",
10642
+ "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.",
10643
+ "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.",
10218
10644
  "minLength": 0,
10219
10645
  "maxLength": 16,
10220
10646
  "x-f5xc-required-for": {
@@ -10225,7 +10651,7 @@
10225
10651
  },
10226
10652
  "x-original-maxLength": 1024,
10227
10653
  "x-reconciled-from-discovery": true,
10228
- "x-reconciled-at": "2026-01-05T14:37:36.248897+00:00"
10654
+ "x-reconciled-at": "2026-01-07T15:27:47.383416+00:00"
10229
10655
  },
10230
10656
  "namespace": {
10231
10657
  "type": "string",
@@ -10234,6 +10660,8 @@
10234
10660
  "x-displayname": "Namespace",
10235
10661
  "x-ves-example": "Ns1",
10236
10662
  "x-f5xc-example": "ns1",
10663
+ "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.",
10664
+ "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.",
10237
10665
  "minLength": 0,
10238
10666
  "maxLength": 6,
10239
10667
  "x-f5xc-required-for": {
@@ -10244,7 +10672,7 @@
10244
10672
  },
10245
10673
  "x-original-maxLength": 1024,
10246
10674
  "x-reconciled-from-discovery": true,
10247
- "x-reconciled-at": "2026-01-05T14:37:36.248901+00:00"
10675
+ "x-reconciled-at": "2026-01-07T15:27:47.383420+00:00"
10248
10676
  },
10249
10677
  "tenant": {
10250
10678
  "type": "string",
@@ -10253,6 +10681,8 @@
10253
10681
  "x-displayname": "Tenant",
10254
10682
  "x-ves-example": "Example-corp.",
10255
10683
  "x-f5xc-example": "example-corp",
10684
+ "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.",
10685
+ "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.",
10256
10686
  "minLength": 0,
10257
10687
  "maxLength": 18,
10258
10688
  "x-f5xc-required-for": {
@@ -10265,7 +10695,7 @@
10265
10695
  "x-field-mutability": "read-only",
10266
10696
  "x-original-maxLength": 1024,
10267
10697
  "x-reconciled-from-discovery": true,
10268
- "x-reconciled-at": "2026-01-05T14:37:36.248906+00:00"
10698
+ "x-reconciled-at": "2026-01-07T15:27:47.383424+00:00"
10269
10699
  },
10270
10700
  "uid": {
10271
10701
  "type": "string",
@@ -10274,6 +10704,8 @@
10274
10704
  "x-displayname": "UID",
10275
10705
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
10276
10706
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
10707
+ "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.",
10708
+ "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.",
10277
10709
  "minLength": 0,
10278
10710
  "maxLength": 36,
10279
10711
  "x-f5xc-required-for": {
@@ -10287,9 +10719,11 @@
10287
10719
  "x-original-maxLength": 1024,
10288
10720
  "format": "uuid",
10289
10721
  "x-reconciled-from-discovery": true,
10290
- "x-reconciled-at": "2026-01-05T14:37:36.248911+00:00"
10722
+ "x-reconciled-at": "2026-01-07T15:27:47.383430+00:00"
10291
10723
  }
10292
10724
  },
10725
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
10726
+ "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...",
10293
10727
  "x-f5xc-minimum-configuration": {
10294
10728
  "description": "Minimum configuration for schemaObjectRefType",
10295
10729
  "required_fields": [
@@ -10319,6 +10753,8 @@
10319
10753
  "title": "Creation_timestamp.",
10320
10754
  "format": "date-time",
10321
10755
  "x-displayname": "Creation Timestamp.",
10756
+ "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.",
10757
+ "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.",
10322
10758
  "minLength": 0,
10323
10759
  "maxLength": 1024,
10324
10760
  "x-f5xc-required-for": {
@@ -10336,6 +10772,8 @@
10336
10772
  "x-displayname": "Creator Class.",
10337
10773
  "x-ves-example": "ver.re1.int.ves.I/O.",
10338
10774
  "x-f5xc-example": "ver.re1.int.F5 XC",
10775
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
10776
+ "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.",
10339
10777
  "minLength": 0,
10340
10778
  "maxLength": 1024,
10341
10779
  "x-f5xc-required-for": {
@@ -10353,6 +10791,8 @@
10353
10791
  "x-displayname": "Creator ID.",
10354
10792
  "x-ves-example": "Ver-instance-1.",
10355
10793
  "x-f5xc-example": "ver-instance-1",
10794
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
10795
+ "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.",
10356
10796
  "minLength": 0,
10357
10797
  "maxLength": 1024,
10358
10798
  "x-f5xc-required-for": {
@@ -10371,6 +10811,8 @@
10371
10811
  "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)",
10372
10812
  "title": "Status_id",
10373
10813
  "x-displayname": "Status ID",
10814
+ "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...",
10815
+ "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).",
10374
10816
  "minLength": 0,
10375
10817
  "maxLength": 1024,
10376
10818
  "x-f5xc-required-for": {
@@ -10388,6 +10830,7 @@
10388
10830
  "x-displayname": "UID",
10389
10831
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
10390
10832
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
10833
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
10391
10834
  "minLength": 0,
10392
10835
  "maxLength": 36,
10393
10836
  "x-f5xc-required-for": {
@@ -10400,13 +10843,14 @@
10400
10843
  "x-original-maxLength": 1024,
10401
10844
  "format": "uuid",
10402
10845
  "x-reconciled-from-discovery": true,
10403
- "x-reconciled-at": "2026-01-05T14:37:36.248925+00:00"
10846
+ "x-reconciled-at": "2026-01-07T15:27:47.383442+00:00"
10404
10847
  },
10405
10848
  "vtrp_id": {
10406
10849
  "type": "string",
10407
10850
  "description": "Origin of this status exchanged by VTRP.",
10408
10851
  "title": "Vtrp_id",
10409
10852
  "x-displayname": "VTRP ID",
10853
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
10410
10854
  "minLength": 0,
10411
10855
  "maxLength": 1024,
10412
10856
  "x-f5xc-required-for": {
@@ -10423,6 +10867,7 @@
10423
10867
  "title": "Vtrp_stale.",
10424
10868
  "format": "boolean",
10425
10869
  "x-displayname": "VTRP Stale.",
10870
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
10426
10871
  "x-f5xc-required-for": {
10427
10872
  "minimum_config": false,
10428
10873
  "create": false,
@@ -10431,6 +10876,7 @@
10431
10876
  }
10432
10877
  }
10433
10878
  },
10879
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
10434
10880
  "x-f5xc-minimum-configuration": {
10435
10881
  "description": "Minimum configuration for schemaStatusMetaType",
10436
10882
  "required_fields": [
@@ -10461,6 +10907,8 @@
10461
10907
  "default": "STATUS_DO_NOT_PUBLISH",
10462
10908
  "x-displayname": "Status Publish Type.",
10463
10909
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
10910
+ "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.",
10911
+ "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.",
10464
10912
  "x-f5xc-minimum-configuration": {
10465
10913
  "description": "Minimum configuration for schemaStatusPublishType",
10466
10914
  "required_fields": [],
@@ -10486,6 +10934,7 @@
10486
10934
  "x-displayname": "Code",
10487
10935
  "x-ves-example": "0",
10488
10936
  "x-f5xc-example": "0",
10937
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
10489
10938
  "minimum": 0,
10490
10939
  "maximum": 2147483647,
10491
10940
  "x-f5xc-required-for": {
@@ -10502,6 +10951,8 @@
10502
10951
  "x-displayname": "Reason",
10503
10952
  "x-ves-example": "Value",
10504
10953
  "x-f5xc-example": "value",
10954
+ "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.",
10955
+ "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.",
10505
10956
  "minLength": 0,
10506
10957
  "maxLength": 43,
10507
10958
  "x-f5xc-required-for": {
@@ -10512,7 +10963,7 @@
10512
10963
  },
10513
10964
  "x-original-maxLength": 1024,
10514
10965
  "x-reconciled-from-discovery": true,
10515
- "x-reconciled-at": "2026-01-05T14:37:36.248934+00:00"
10966
+ "x-reconciled-at": "2026-01-07T15:27:47.383451+00:00"
10516
10967
  },
10517
10968
  "status": {
10518
10969
  "type": "string",
@@ -10521,6 +10972,7 @@
10521
10972
  "x-displayname": "Status",
10522
10973
  "x-ves-example": "Value",
10523
10974
  "x-f5xc-example": "value",
10975
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
10524
10976
  "minLength": 0,
10525
10977
  "maxLength": 17,
10526
10978
  "x-f5xc-required-for": {
@@ -10531,9 +10983,10 @@
10531
10983
  },
10532
10984
  "x-original-maxLength": 1024,
10533
10985
  "x-reconciled-from-discovery": true,
10534
- "x-reconciled-at": "2026-01-05T14:37:36.248939+00:00"
10986
+ "x-reconciled-at": "2026-01-07T15:27:47.383455+00:00"
10535
10987
  }
10536
10988
  },
10989
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
10537
10990
  "x-f5xc-minimum-configuration": {
10538
10991
  "description": "Minimum configuration for schemaStatusType",
10539
10992
  "required_fields": [
@@ -10561,6 +11014,8 @@
10561
11014
  "title": "Creation_timestamp.",
10562
11015
  "format": "date-time",
10563
11016
  "x-displayname": "Creation Timestamp.",
11017
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
11018
+ "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.",
10564
11019
  "minLength": 0,
10565
11020
  "maxLength": 1024,
10566
11021
  "x-f5xc-required-for": {
@@ -10578,6 +11033,7 @@
10578
11033
  "x-displayname": "Creator Class.",
10579
11034
  "x-ves-example": "Prism",
10580
11035
  "x-f5xc-example": "value",
11036
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
10581
11037
  "minLength": 0,
10582
11038
  "maxLength": 1024,
10583
11039
  "x-f5xc-required-for": {
@@ -10595,6 +11051,7 @@
10595
11051
  "x-displayname": "Creator ID.",
10596
11052
  "x-ves-example": "Admin@example-corp.com.",
10597
11053
  "x-f5xc-example": "value",
11054
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
10598
11055
  "minLength": 0,
10599
11056
  "maxLength": 1024,
10600
11057
  "x-f5xc-required-for": {
@@ -10611,6 +11068,8 @@
10611
11068
  "title": "Deletion_timestamp.",
10612
11069
  "format": "date-time",
10613
11070
  "x-displayname": "Deletion Timestamp.",
11071
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
11072
+ "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...",
10614
11073
  "minLength": 0,
10615
11074
  "maxLength": 1024,
10616
11075
  "x-f5xc-required-for": {
@@ -10630,6 +11089,8 @@
10630
11089
  "x-displayname": "Finalizers.",
10631
11090
  "x-ves-example": "Value",
10632
11091
  "x-f5xc-example": "value",
11092
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
11093
+ "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.",
10633
11094
  "x-f5xc-required-for": {
10634
11095
  "minimum_config": false,
10635
11096
  "create": false,
@@ -10647,6 +11108,8 @@
10647
11108
  "x-displayname": "Labels",
10648
11109
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
10649
11110
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
11111
+ "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.",
11112
+ "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).",
10650
11113
  "x-f5xc-required-for": {
10651
11114
  "minimum_config": false,
10652
11115
  "create": false,
@@ -10660,6 +11123,8 @@
10660
11123
  "title": "Modification_timestamp.",
10661
11124
  "format": "date-time",
10662
11125
  "x-displayname": "Modification Timestamp.",
11126
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
11127
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
10663
11128
  "minLength": 0,
10664
11129
  "maxLength": 1024,
10665
11130
  "x-f5xc-required-for": {
@@ -10678,6 +11143,8 @@
10678
11143
  "x-displayname": "Object Index.",
10679
11144
  "x-ves-example": "0",
10680
11145
  "x-f5xc-example": "0",
11146
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
11147
+ "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.",
10681
11148
  "minimum": 0,
10682
11149
  "maximum": 2147483647,
10683
11150
  "x-f5xc-required-for": {
@@ -10698,6 +11165,8 @@
10698
11165
  "x-displayname": "Tenant",
10699
11166
  "x-ves-example": "Example-corp.",
10700
11167
  "x-f5xc-example": "example-corp",
11168
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
11169
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
10701
11170
  "minLength": 0,
10702
11171
  "maxLength": 18,
10703
11172
  "x-f5xc-required-for": {
@@ -10709,7 +11178,7 @@
10709
11178
  "x-field-mutability": "read-only",
10710
11179
  "x-original-maxLength": 1024,
10711
11180
  "x-reconciled-from-discovery": true,
10712
- "x-reconciled-at": "2026-01-05T14:37:36.248958+00:00"
11181
+ "x-reconciled-at": "2026-01-07T15:27:47.383473+00:00"
10713
11182
  },
10714
11183
  "uid": {
10715
11184
  "type": "string",
@@ -10718,6 +11187,8 @@
10718
11187
  "x-displayname": "UID",
10719
11188
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
10720
11189
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
11190
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
11191
+ "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.",
10721
11192
  "minLength": 0,
10722
11193
  "maxLength": 36,
10723
11194
  "x-f5xc-required-for": {
@@ -10730,9 +11201,11 @@
10730
11201
  "x-original-maxLength": 1024,
10731
11202
  "format": "uuid",
10732
11203
  "x-reconciled-from-discovery": true,
10733
- "x-reconciled-at": "2026-01-05T14:37:36.248963+00:00"
11204
+ "x-reconciled-at": "2026-01-07T15:27:47.383478+00:00"
10734
11205
  }
10735
11206
  },
11207
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
11208
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
10736
11209
  "x-f5xc-minimum-configuration": {
10737
11210
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
10738
11211
  "required_fields": [
@@ -10780,7 +11253,7 @@
10780
11253
  },
10781
11254
  "x-original-maxLength": 1024,
10782
11255
  "x-reconciled-from-discovery": true,
10783
- "x-reconciled-at": "2026-01-05T14:37:36.248968+00:00"
11256
+ "x-reconciled-at": "2026-01-07T15:27:47.383484+00:00"
10784
11257
  },
10785
11258
  "name": {
10786
11259
  "type": "string",
@@ -10789,6 +11262,8 @@
10789
11262
  "x-displayname": "Name",
10790
11263
  "x-ves-example": "Contactus-route.",
10791
11264
  "x-f5xc-example": "contactus-route",
11265
+ "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.",
11266
+ "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.",
10792
11267
  "minLength": 0,
10793
11268
  "maxLength": 16,
10794
11269
  "x-f5xc-required-for": {
@@ -10799,7 +11274,7 @@
10799
11274
  },
10800
11275
  "x-original-maxLength": 1024,
10801
11276
  "x-reconciled-from-discovery": true,
10802
- "x-reconciled-at": "2026-01-05T14:37:36.248972+00:00"
11277
+ "x-reconciled-at": "2026-01-07T15:27:47.383488+00:00"
10803
11278
  },
10804
11279
  "namespace": {
10805
11280
  "type": "string",
@@ -10808,6 +11283,8 @@
10808
11283
  "x-displayname": "Namespace",
10809
11284
  "x-ves-example": "Ns1",
10810
11285
  "x-f5xc-example": "ns1",
11286
+ "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.",
11287
+ "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.",
10811
11288
  "minLength": 0,
10812
11289
  "maxLength": 6,
10813
11290
  "x-f5xc-required-for": {
@@ -10818,7 +11295,7 @@
10818
11295
  },
10819
11296
  "x-original-maxLength": 1024,
10820
11297
  "x-reconciled-from-discovery": true,
10821
- "x-reconciled-at": "2026-01-05T14:37:36.248977+00:00"
11298
+ "x-reconciled-at": "2026-01-07T15:27:47.383493+00:00"
10822
11299
  },
10823
11300
  "uid": {
10824
11301
  "type": "string",
@@ -10839,9 +11316,10 @@
10839
11316
  "x-original-maxLength": 1024,
10840
11317
  "format": "uuid",
10841
11318
  "x-reconciled-from-discovery": true,
10842
- "x-reconciled-at": "2026-01-05T14:37:36.248981+00:00"
11319
+ "x-reconciled-at": "2026-01-07T15:27:47.383498+00:00"
10843
11320
  }
10844
11321
  },
11322
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
10845
11323
  "x-f5xc-minimum-configuration": {
10846
11324
  "description": "Minimum configuration for schemaViewRefType",
10847
11325
  "required_fields": [
@@ -10870,6 +11348,8 @@
10870
11348
  "default": "SUBSCRIPTION_PENDING",
10871
11349
  "x-displayname": "Addon Subscription Type.",
10872
11350
  "x-ves-proto-enum": "ves.io.schema.pbac.addon_subscription.AddonSubscriptionState",
11351
+ "x-f5xc-description-short": "Represents the different states of an addon subscription. - SUBSCRIPTION_PENDING: Subscription Pending Indicates that the subscription is pending...",
11352
+ "x-f5xc-description-medium": "Represents the different states of an addon subscription. - SUBSCRIPTION_PENDING: Subscription Pending Indicates that the subscription is pending enablement. - SUBSCRIPTION_ENABLED: Subscription Enabled Indicates that the subscription is currently enabled and active. ...",
10873
11353
  "x-f5xc-minimum-configuration": {
10874
11354
  "description": "Minimum configuration for addon_subscriptionAddonSubscriptionState",
10875
11355
  "required_fields": [],
@@ -10953,6 +11433,7 @@
10953
11433
  "$ref": "#/components/schemas/addon_subscriptionAddonSubscriptionState"
10954
11434
  }
10955
11435
  },
11436
+ "x-f5xc-description-short": "Create a new Addon Subscription with Addon Subscription State.",
10956
11437
  "x-f5xc-minimum-configuration": {
10957
11438
  "description": "Minimum configuration for addon_subscriptionCreateSpecType",
10958
11439
  "required_fields": [
@@ -10980,6 +11461,7 @@
10980
11461
  "title": "Fail_if_referred.",
10981
11462
  "format": "boolean",
10982
11463
  "x-displayname": "Fail-If-Referred.",
11464
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
10983
11465
  "x-f5xc-required-for": {
10984
11466
  "minimum_config": false,
10985
11467
  "create": false,
@@ -11004,7 +11486,7 @@
11004
11486
  },
11005
11487
  "x-original-maxLength": 1024,
11006
11488
  "x-reconciled-from-discovery": true,
11007
- "x-reconciled-at": "2026-01-05T14:37:36.597937+00:00"
11489
+ "x-reconciled-at": "2026-01-07T15:27:47.788063+00:00"
11008
11490
  },
11009
11491
  "namespace": {
11010
11492
  "type": "string",
@@ -11013,6 +11495,7 @@
11013
11495
  "x-displayname": "Namespace",
11014
11496
  "x-ves-example": "Ns1",
11015
11497
  "x-f5xc-example": "ns1",
11498
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
11016
11499
  "minLength": 0,
11017
11500
  "maxLength": 6,
11018
11501
  "x-f5xc-required-for": {
@@ -11023,7 +11506,7 @@
11023
11506
  },
11024
11507
  "x-original-maxLength": 1024,
11025
11508
  "x-reconciled-from-discovery": true,
11026
- "x-reconciled-at": "2026-01-05T14:37:36.597944+00:00"
11509
+ "x-reconciled-at": "2026-01-07T15:27:47.788070+00:00"
11027
11510
  }
11028
11511
  },
11029
11512
  "x-f5xc-minimum-configuration": {
@@ -11058,6 +11541,7 @@
11058
11541
  "$ref": "#/components/schemas/ioschemaObjectRefType"
11059
11542
  },
11060
11543
  "x-displayname": "Deleted Referred Objects.",
11544
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
11061
11545
  "x-f5xc-required-for": {
11062
11546
  "minimum_config": false,
11063
11547
  "create": false,
@@ -11073,6 +11557,7 @@
11073
11557
  "$ref": "#/components/schemas/ioschemaObjectRefType"
11074
11558
  },
11075
11559
  "x-displayname": "Disabled Referred Objects.",
11560
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
11076
11561
  "x-f5xc-required-for": {
11077
11562
  "minimum_config": false,
11078
11563
  "create": false,
@@ -11091,6 +11576,7 @@
11091
11576
  "$ref": "#/components/schemas/ioschemaObjectRefType"
11092
11577
  },
11093
11578
  "x-displayname": "Referring Objects.",
11579
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
11094
11580
  "x-f5xc-required-for": {
11095
11581
  "minimum_config": false,
11096
11582
  "create": false,
@@ -11140,6 +11626,8 @@
11140
11626
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
11141
11627
  ],
11142
11628
  "default": "GET_RSP_FORMAT_DEFAULT",
11629
+ "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...",
11630
+ "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...",
11143
11631
  "x-f5xc-minimum-configuration": {
11144
11632
  "description": "Minimum configuration for addon_subscriptionGetResponseFormatCode",
11145
11633
  "required_fields": [],
@@ -11168,6 +11656,7 @@
11168
11656
  "$ref": "#/components/schemas/addon_subscriptionAddonSubscriptionState"
11169
11657
  }
11170
11658
  },
11659
+ "x-f5xc-description-short": "GET Addon Subsciption reads a given object from storage backend for metadata.namespace.",
11171
11660
  "x-f5xc-minimum-configuration": {
11172
11661
  "description": "Minimum configuration for addon_subscriptionGetSpecType",
11173
11662
  "required_fields": [
@@ -11197,6 +11686,7 @@
11197
11686
  "$ref": "#/components/schemas/schemaErrorType"
11198
11687
  },
11199
11688
  "x-displayname": "Errors",
11689
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
11200
11690
  "x-f5xc-required-for": {
11201
11691
  "minimum_config": false,
11202
11692
  "create": false,
@@ -11212,6 +11702,8 @@
11212
11702
  "$ref": "#/components/schemas/addon_subscriptionListResponseItem"
11213
11703
  },
11214
11704
  "x-displayname": "Items",
11705
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
11706
+ "x-f5xc-description-short": "Items represents the collection in response.",
11215
11707
  "x-f5xc-required-for": {
11216
11708
  "minimum_config": false,
11217
11709
  "create": false,
@@ -11245,6 +11737,8 @@
11245
11737
  "description": "The set of annotations present on this addon_subscription.",
11246
11738
  "title": "Annotations.",
11247
11739
  "x-displayname": "Annotations.",
11740
+ "x-f5xc-example": "{\"key\": \"value\"}",
11741
+ "x-f5xc-description-short": "The set of annotations present on this addon_subscription.",
11248
11742
  "x-f5xc-required-for": {
11249
11743
  "minimum_config": false,
11250
11744
  "create": false,
@@ -11257,6 +11751,7 @@
11257
11751
  "description": "The description set for this addon_subscription.",
11258
11752
  "title": "Description.",
11259
11753
  "x-displayname": "Description.",
11754
+ "x-f5xc-description-short": "The description set for this addon_subscription.",
11260
11755
  "minLength": 0,
11261
11756
  "maxLength": 0,
11262
11757
  "x-f5xc-required-for": {
@@ -11267,7 +11762,7 @@
11267
11762
  },
11268
11763
  "x-original-maxLength": 1024,
11269
11764
  "x-reconciled-from-discovery": true,
11270
- "x-reconciled-at": "2026-01-05T14:37:36.597972+00:00"
11765
+ "x-reconciled-at": "2026-01-07T15:27:47.788095+00:00"
11271
11766
  },
11272
11767
  "disabled": {
11273
11768
  "type": "boolean",
@@ -11275,6 +11770,8 @@
11275
11770
  "title": "Disabled",
11276
11771
  "format": "boolean",
11277
11772
  "x-displayname": "Disabled",
11773
+ "x-f5xc-example": "True",
11774
+ "x-f5xc-description-short": "Value of true indicates addon_subscription is administratively disabled.",
11278
11775
  "x-f5xc-required-for": {
11279
11776
  "minimum_config": false,
11280
11777
  "create": false,
@@ -11290,6 +11787,8 @@
11290
11787
  "description": "The set of labels present on this addon_subscription.",
11291
11788
  "title": "Labels",
11292
11789
  "x-displayname": "Labels",
11790
+ "x-f5xc-example": "{\"key\": \"value\"}",
11791
+ "x-f5xc-description-short": "The set of labels present on this addon_subscription.",
11293
11792
  "x-f5xc-required-for": {
11294
11793
  "minimum_config": false,
11295
11794
  "create": false,
@@ -11317,7 +11816,7 @@
11317
11816
  },
11318
11817
  "x-original-maxLength": 1024,
11319
11818
  "x-reconciled-from-discovery": true,
11320
- "x-reconciled-at": "2026-01-05T14:37:36.597983+00:00"
11819
+ "x-reconciled-at": "2026-01-07T15:27:47.788105+00:00"
11321
11820
  },
11322
11821
  "namespace": {
11323
11822
  "type": "string",
@@ -11336,7 +11835,7 @@
11336
11835
  },
11337
11836
  "x-original-maxLength": 1024,
11338
11837
  "x-reconciled-from-discovery": true,
11339
- "x-reconciled-at": "2026-01-05T14:37:36.597988+00:00"
11838
+ "x-reconciled-at": "2026-01-07T15:27:47.788110+00:00"
11340
11839
  },
11341
11840
  "owner_view": {
11342
11841
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -11362,7 +11861,7 @@
11362
11861
  "x-field-mutability": "read-only",
11363
11862
  "x-original-maxLength": 1024,
11364
11863
  "x-reconciled-from-discovery": true,
11365
- "x-reconciled-at": "2026-01-05T14:37:36.597995+00:00"
11864
+ "x-reconciled-at": "2026-01-07T15:27:47.788116+00:00"
11366
11865
  },
11367
11866
  "uid": {
11368
11867
  "type": "string",
@@ -11371,6 +11870,7 @@
11371
11870
  "x-displayname": "UID",
11372
11871
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
11373
11872
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
11873
+ "x-f5xc-description-short": "The unique uid of this addon_subscription.",
11374
11874
  "minLength": 0,
11375
11875
  "maxLength": 36,
11376
11876
  "x-f5xc-required-for": {
@@ -11383,9 +11883,11 @@
11383
11883
  "x-original-maxLength": 1024,
11384
11884
  "format": "uuid",
11385
11885
  "x-reconciled-from-discovery": true,
11386
- "x-reconciled-at": "2026-01-05T14:37:36.598001+00:00"
11886
+ "x-reconciled-at": "2026-01-07T15:27:47.788122+00:00"
11387
11887
  }
11388
11888
  },
11889
+ "x-f5xc-description-short": "By default a summary of addon_subscription is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
11890
+ "x-f5xc-description-medium": "By default a summary of addon_subscription is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
11389
11891
  "x-f5xc-minimum-configuration": {
11390
11892
  "description": "Minimum configuration for addon_subscriptionListResponseItem",
11391
11893
  "required_fields": [
@@ -11424,6 +11926,7 @@
11424
11926
  "$ref": "#/components/schemas/addon_subscriptionSupportTicketId"
11425
11927
  }
11426
11928
  },
11929
+ "x-f5xc-description-short": "NotificationPreference preference for receiving addon subscription notifications.",
11427
11930
  "x-f5xc-minimum-configuration": {
11428
11931
  "description": "Minimum configuration for addon_subscriptionNotificationPreference",
11429
11932
  "required_fields": [
@@ -11495,6 +11998,7 @@
11495
11998
  "$ref": "#/components/schemas/addon_subscriptionAddonSubscriptionState"
11496
11999
  }
11497
12000
  },
12001
+ "x-f5xc-description-short": "Replace a given Addon Subscription with with Addon Subscription State.",
11498
12002
  "x-f5xc-minimum-configuration": {
11499
12003
  "description": "Minimum configuration for addon_subscriptionReplaceSpecType",
11500
12004
  "required_fields": [
@@ -11522,6 +12026,7 @@
11522
12026
  "description": "Subscription_ticket_id associated with the Addon Subscription subscription.",
11523
12027
  "title": "SubscriptionTicketId.",
11524
12028
  "x-displayname": "Subscription Ticket ID.",
12029
+ "x-f5xc-description-short": "Subscription_ticket_id associated with the Addon Subscription subscription.",
11525
12030
  "minLength": 0,
11526
12031
  "maxLength": 1024,
11527
12032
  "x-f5xc-required-for": {
@@ -11537,6 +12042,7 @@
11537
12042
  "description": "Unsubscription_ticket_id associated with the Addon Subscription unsubscription.",
11538
12043
  "title": "UnsubscriptionTicketId.",
11539
12044
  "x-displayname": "Unsubscription Ticket ID.",
12045
+ "x-f5xc-description-short": "Unsubscription_ticket_id associated with the Addon Subscription unsubscription.",
11540
12046
  "minLength": 0,
11541
12047
  "maxLength": 1024,
11542
12048
  "x-f5xc-required-for": {
@@ -11548,6 +12054,7 @@
11548
12054
  "x-field-mutability": "read-only"
11549
12055
  }
11550
12056
  },
12057
+ "x-f5xc-description-short": "SupportTicketId gives the information about ticket created for managed addon subscription.",
11551
12058
  "x-f5xc-minimum-configuration": {
11552
12059
  "description": "Minimum configuration for addon_subscriptionSupportTicketId",
11553
12060
  "required_fields": [
@@ -11575,6 +12082,8 @@
11575
12082
  "x-displayname": "Kind",
11576
12083
  "x-ves-example": "Virtual_site.",
11577
12084
  "x-f5xc-example": "virtual_site",
12085
+ "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\")",
12086
+ "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\").",
11578
12087
  "minLength": 0,
11579
12088
  "maxLength": 14,
11580
12089
  "x-f5xc-required-for": {
@@ -11586,7 +12095,7 @@
11586
12095
  "readOnly": true,
11587
12096
  "x-original-maxLength": 1024,
11588
12097
  "x-reconciled-from-discovery": true,
11589
- "x-reconciled-at": "2026-01-05T14:37:36.598021+00:00"
12098
+ "x-reconciled-at": "2026-01-07T15:27:47.788141+00:00"
11590
12099
  },
11591
12100
  "name": {
11592
12101
  "type": "string",
@@ -11595,6 +12104,8 @@
11595
12104
  "x-displayname": "Name",
11596
12105
  "x-ves-example": "Contactus-route.",
11597
12106
  "x-f5xc-example": "contactus-route",
12107
+ "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.",
12108
+ "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.",
11598
12109
  "minLength": 0,
11599
12110
  "maxLength": 16,
11600
12111
  "x-f5xc-required-for": {
@@ -11605,7 +12116,7 @@
11605
12116
  },
11606
12117
  "x-original-maxLength": 1024,
11607
12118
  "x-reconciled-from-discovery": true,
11608
- "x-reconciled-at": "2026-01-05T14:37:36.598026+00:00"
12119
+ "x-reconciled-at": "2026-01-07T15:27:47.788145+00:00"
11609
12120
  },
11610
12121
  "namespace": {
11611
12122
  "type": "string",
@@ -11614,6 +12125,8 @@
11614
12125
  "x-displayname": "Namespace",
11615
12126
  "x-ves-example": "Ns1",
11616
12127
  "x-f5xc-example": "ns1",
12128
+ "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.",
12129
+ "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.",
11617
12130
  "minLength": 0,
11618
12131
  "maxLength": 6,
11619
12132
  "x-f5xc-required-for": {
@@ -11624,7 +12137,7 @@
11624
12137
  },
11625
12138
  "x-original-maxLength": 1024,
11626
12139
  "x-reconciled-from-discovery": true,
11627
- "x-reconciled-at": "2026-01-05T14:37:36.598030+00:00"
12140
+ "x-reconciled-at": "2026-01-07T15:27:47.788150+00:00"
11628
12141
  },
11629
12142
  "tenant": {
11630
12143
  "type": "string",
@@ -11633,6 +12146,8 @@
11633
12146
  "x-displayname": "Tenant",
11634
12147
  "x-ves-example": "Example-corp.",
11635
12148
  "x-f5xc-example": "example-corp",
12149
+ "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.",
12150
+ "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.",
11636
12151
  "minLength": 0,
11637
12152
  "maxLength": 18,
11638
12153
  "x-f5xc-required-for": {
@@ -11645,7 +12160,7 @@
11645
12160
  "x-field-mutability": "read-only",
11646
12161
  "x-original-maxLength": 1024,
11647
12162
  "x-reconciled-from-discovery": true,
11648
- "x-reconciled-at": "2026-01-05T14:37:36.598034+00:00"
12163
+ "x-reconciled-at": "2026-01-07T15:27:47.788154+00:00"
11649
12164
  },
11650
12165
  "uid": {
11651
12166
  "type": "string",
@@ -11654,6 +12169,8 @@
11654
12169
  "x-displayname": "UID",
11655
12170
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
11656
12171
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
12172
+ "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.",
12173
+ "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.",
11657
12174
  "minLength": 0,
11658
12175
  "maxLength": 36,
11659
12176
  "x-f5xc-required-for": {
@@ -11667,9 +12184,11 @@
11667
12184
  "x-original-maxLength": 1024,
11668
12185
  "format": "uuid",
11669
12186
  "x-reconciled-from-discovery": true,
11670
- "x-reconciled-at": "2026-01-05T14:37:36.598039+00:00"
12187
+ "x-reconciled-at": "2026-01-07T15:27:47.788160+00:00"
11671
12188
  }
11672
12189
  },
12190
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
12191
+ "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...",
11673
12192
  "x-f5xc-minimum-configuration": {
11674
12193
  "description": "Minimum configuration for ioschemaObjectRefType",
11675
12194
  "required_fields": [
@@ -11711,6 +12230,8 @@
11711
12230
  "ves.io.schema.rules.map.values.string.max_len": "1024",
11712
12231
  "ves.io.schema.rules.map.values.string.min_len": "1"
11713
12232
  },
12233
+ "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.",
12234
+ "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.",
11714
12235
  "x-f5xc-required-for": {
11715
12236
  "minimum_config": false,
11716
12237
  "create": false,
@@ -11732,6 +12253,7 @@
11732
12253
  "x-validation-rules": {
11733
12254
  "ves.io.schema.rules.string.max_bytes": "1200"
11734
12255
  },
12256
+ "x-f5xc-description-short": "Human readable description for the object.",
11735
12257
  "minLength": 0,
11736
12258
  "x-f5xc-required-for": {
11737
12259
  "minimum_config": false,
@@ -11741,7 +12263,7 @@
11741
12263
  },
11742
12264
  "x-original-maxLength": 1200,
11743
12265
  "x-reconciled-from-discovery": true,
11744
- "x-reconciled-at": "2026-01-05T14:37:36.598070+00:00"
12266
+ "x-reconciled-at": "2026-01-07T15:27:47.788189+00:00"
11745
12267
  },
11746
12268
  "disable": {
11747
12269
  "type": "boolean",
@@ -11750,6 +12272,7 @@
11750
12272
  "format": "boolean",
11751
12273
  "x-displayname": "Disable",
11752
12274
  "x-f5xc-example": "true",
12275
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
11753
12276
  "x-f5xc-required-for": {
11754
12277
  "minimum_config": false,
11755
12278
  "create": false,
@@ -11763,6 +12286,8 @@
11763
12286
  "title": "Labels",
11764
12287
  "x-displayname": "Labels",
11765
12288
  "x-f5xc-example": "value",
12289
+ "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.",
12290
+ "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.",
11766
12291
  "x-f5xc-required-for": {
11767
12292
  "minimum_config": false,
11768
12293
  "create": false,
@@ -11784,6 +12309,8 @@
11784
12309
  "x-validation-rules": {
11785
12310
  "ves.io.schema.rules.message.required": "true"
11786
12311
  },
12312
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
12313
+ "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.",
11787
12314
  "minLength": 0,
11788
12315
  "maxLength": 16,
11789
12316
  "x-f5xc-required-for": {
@@ -11794,7 +12321,7 @@
11794
12321
  },
11795
12322
  "x-original-maxLength": 1024,
11796
12323
  "x-reconciled-from-discovery": true,
11797
- "x-reconciled-at": "2026-01-05T14:37:36.598077+00:00"
12324
+ "x-reconciled-at": "2026-01-07T15:27:47.788196+00:00"
11798
12325
  },
11799
12326
  "namespace": {
11800
12327
  "type": "string",
@@ -11803,6 +12330,8 @@
11803
12330
  "x-displayname": "Namespace",
11804
12331
  "x-ves-example": "Staging",
11805
12332
  "x-f5xc-example": "staging",
12333
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
12334
+ "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 \"\".",
11806
12335
  "minLength": 0,
11807
12336
  "maxLength": 6,
11808
12337
  "x-f5xc-required-for": {
@@ -11813,9 +12342,10 @@
11813
12342
  },
11814
12343
  "x-original-maxLength": 1024,
11815
12344
  "x-reconciled-from-discovery": true,
11816
- "x-reconciled-at": "2026-01-05T14:37:36.598082+00:00"
12345
+ "x-reconciled-at": "2026-01-07T15:27:47.788201+00:00"
11817
12346
  }
11818
12347
  },
12348
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
11819
12349
  "x-f5xc-minimum-configuration": {
11820
12350
  "description": "Minimum configuration for schemaObjectCreateMetaType",
11821
12351
  "required_fields": [
@@ -11859,6 +12389,8 @@
11859
12389
  "ves.io.schema.rules.map.values.string.max_len": "1024",
11860
12390
  "ves.io.schema.rules.map.values.string.min_len": "1"
11861
12391
  },
12392
+ "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.",
12393
+ "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.",
11862
12394
  "x-f5xc-required-for": {
11863
12395
  "minimum_config": false,
11864
12396
  "create": false,
@@ -11880,6 +12412,7 @@
11880
12412
  "x-validation-rules": {
11881
12413
  "ves.io.schema.rules.string.max_bytes": "1200"
11882
12414
  },
12415
+ "x-f5xc-description-short": "Human readable description for the object.",
11883
12416
  "minLength": 0,
11884
12417
  "x-f5xc-required-for": {
11885
12418
  "minimum_config": false,
@@ -11889,7 +12422,7 @@
11889
12422
  },
11890
12423
  "x-original-maxLength": 1200,
11891
12424
  "x-reconciled-from-discovery": true,
11892
- "x-reconciled-at": "2026-01-05T14:37:36.598108+00:00"
12425
+ "x-reconciled-at": "2026-01-07T15:27:47.788225+00:00"
11893
12426
  },
11894
12427
  "disable": {
11895
12428
  "type": "boolean",
@@ -11898,6 +12431,7 @@
11898
12431
  "format": "boolean",
11899
12432
  "x-displayname": "Disable",
11900
12433
  "x-f5xc-example": "true",
12434
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
11901
12435
  "x-f5xc-required-for": {
11902
12436
  "minimum_config": false,
11903
12437
  "create": false,
@@ -11912,6 +12446,8 @@
11912
12446
  "x-displayname": "Labels",
11913
12447
  "x-ves-example": "Value",
11914
12448
  "x-f5xc-example": "value",
12449
+ "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.",
12450
+ "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.",
11915
12451
  "x-f5xc-required-for": {
11916
12452
  "minimum_config": false,
11917
12453
  "create": false,
@@ -11932,6 +12468,8 @@
11932
12468
  "x-validation-rules": {
11933
12469
  "ves.io.schema.rules.message.required": "true"
11934
12470
  },
12471
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
12472
+ "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.",
11935
12473
  "minLength": 0,
11936
12474
  "maxLength": 16,
11937
12475
  "x-f5xc-required-for": {
@@ -11942,7 +12480,7 @@
11942
12480
  },
11943
12481
  "x-original-maxLength": 1024,
11944
12482
  "x-reconciled-from-discovery": true,
11945
- "x-reconciled-at": "2026-01-05T14:37:36.598116+00:00"
12483
+ "x-reconciled-at": "2026-01-07T15:27:47.788232+00:00"
11946
12484
  },
11947
12485
  "namespace": {
11948
12486
  "type": "string",
@@ -11951,6 +12489,8 @@
11951
12489
  "x-displayname": "Namespace",
11952
12490
  "x-ves-example": "Staging",
11953
12491
  "x-f5xc-example": "staging",
12492
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
12493
+ "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 \"\".",
11954
12494
  "minLength": 0,
11955
12495
  "maxLength": 6,
11956
12496
  "x-f5xc-required-for": {
@@ -11961,9 +12501,10 @@
11961
12501
  },
11962
12502
  "x-original-maxLength": 1024,
11963
12503
  "x-reconciled-from-discovery": true,
11964
- "x-reconciled-at": "2026-01-05T14:37:36.598120+00:00"
12504
+ "x-reconciled-at": "2026-01-07T15:27:47.788237+00:00"
11965
12505
  }
11966
12506
  },
12507
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
11967
12508
  "x-f5xc-minimum-configuration": {
11968
12509
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
11969
12510
  "required_fields": [
@@ -12008,6 +12549,8 @@
12008
12549
  "ves.io.schema.rules.string.max_bytes": "128",
12009
12550
  "ves.io.schema.rules.string.min_bytes": "1"
12010
12551
  },
12552
+ "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.",
12553
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name. Required: YES.",
12011
12554
  "x-f5xc-required-for": {
12012
12555
  "minimum_config": false,
12013
12556
  "create": false,
@@ -12016,7 +12559,7 @@
12016
12559
  },
12017
12560
  "x-original-maxLength": 128,
12018
12561
  "x-reconciled-from-discovery": true,
12019
- "x-reconciled-at": "2026-01-05T14:37:36.598181+00:00"
12562
+ "x-reconciled-at": "2026-01-07T15:27:47.788294+00:00"
12020
12563
  },
12021
12564
  "namespace": {
12022
12565
  "type": "string",
@@ -12032,6 +12575,8 @@
12032
12575
  "x-validation-rules": {
12033
12576
  "ves.io.schema.rules.string.max_bytes": "64"
12034
12577
  },
12578
+ "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.",
12579
+ "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.",
12035
12580
  "minLength": 0,
12036
12581
  "x-f5xc-required-for": {
12037
12582
  "minimum_config": false,
@@ -12041,7 +12586,7 @@
12041
12586
  },
12042
12587
  "x-original-maxLength": 64,
12043
12588
  "x-reconciled-from-discovery": true,
12044
- "x-reconciled-at": "2026-01-05T14:37:36.598186+00:00"
12589
+ "x-reconciled-at": "2026-01-07T15:27:47.788299+00:00"
12045
12590
  },
12046
12591
  "tenant": {
12047
12592
  "type": "string",
@@ -12057,6 +12602,8 @@
12057
12602
  "x-validation-rules": {
12058
12603
  "ves.io.schema.rules.string.max_bytes": "64"
12059
12604
  },
12605
+ "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.",
12606
+ "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.",
12060
12607
  "minLength": 0,
12061
12608
  "x-f5xc-required-for": {
12062
12609
  "minimum_config": false,
@@ -12068,9 +12615,11 @@
12068
12615
  "x-field-mutability": "read-only",
12069
12616
  "x-original-maxLength": 64,
12070
12617
  "x-reconciled-from-discovery": true,
12071
- "x-reconciled-at": "2026-01-05T14:37:36.598190+00:00"
12618
+ "x-reconciled-at": "2026-01-07T15:27:47.788303+00:00"
12072
12619
  }
12073
12620
  },
12621
+ "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
12622
+ "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.",
12074
12623
  "x-f5xc-minimum-configuration": {
12075
12624
  "description": "Minimum configuration for schemaviewsObjectRefType",
12076
12625
  "required_fields": [
@@ -12174,6 +12723,7 @@
12174
12723
  "ves.io.schema.rules.uint32.gte": "1",
12175
12724
  "ves.io.schema.rules.uint32.lte": "65535"
12176
12725
  },
12726
+ "x-f5xc-description-short": "Port of the Central Manager instance to connect to Required: YES.",
12177
12727
  "minimum": 1,
12178
12728
  "maximum": 65535,
12179
12729
  "x-f5xc-required-for": {
@@ -12202,6 +12752,7 @@
12202
12752
  "ves.io.schema.rules.string.max_len": "128",
12203
12753
  "ves.io.schema.rules.string.min_len": "4"
12204
12754
  },
12755
+ "x-f5xc-description-short": "Username for the Central Manager instance Required: YES.",
12205
12756
  "x-f5xc-required-for": {
12206
12757
  "minimum_config": false,
12207
12758
  "create": false,
@@ -12210,6 +12761,7 @@
12210
12761
  }
12211
12762
  }
12212
12763
  },
12764
+ "x-f5xc-description-short": "Create App type will create the configuration in namespace metadata.namespace.",
12213
12765
  "x-f5xc-minimum-configuration": {
12214
12766
  "description": "Minimum configuration for cminstanceCreateSpecType",
12215
12767
  "required_fields": [
@@ -12239,6 +12791,7 @@
12239
12791
  "title": "Fail_if_referred.",
12240
12792
  "format": "boolean",
12241
12793
  "x-displayname": "Fail-If-Referred.",
12794
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
12242
12795
  "x-f5xc-required-for": {
12243
12796
  "minimum_config": false,
12244
12797
  "create": false,
@@ -12263,7 +12816,7 @@
12263
12816
  },
12264
12817
  "x-original-maxLength": 1024,
12265
12818
  "x-reconciled-from-discovery": true,
12266
- "x-reconciled-at": "2026-01-05T14:37:52.584885+00:00"
12819
+ "x-reconciled-at": "2026-01-07T15:28:06.018569+00:00"
12267
12820
  },
12268
12821
  "namespace": {
12269
12822
  "type": "string",
@@ -12272,6 +12825,7 @@
12272
12825
  "x-displayname": "Namespace",
12273
12826
  "x-ves-example": "Ns1",
12274
12827
  "x-f5xc-example": "ns1",
12828
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
12275
12829
  "minLength": 0,
12276
12830
  "maxLength": 6,
12277
12831
  "x-f5xc-required-for": {
@@ -12282,7 +12836,7 @@
12282
12836
  },
12283
12837
  "x-original-maxLength": 1024,
12284
12838
  "x-reconciled-from-discovery": true,
12285
- "x-reconciled-at": "2026-01-05T14:37:52.584892+00:00"
12839
+ "x-reconciled-at": "2026-01-07T15:28:06.018576+00:00"
12286
12840
  }
12287
12841
  },
12288
12842
  "x-f5xc-minimum-configuration": {
@@ -12317,6 +12871,7 @@
12317
12871
  "$ref": "#/components/schemas/schemaObjectRefType"
12318
12872
  },
12319
12873
  "x-displayname": "Deleted Referred Objects.",
12874
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
12320
12875
  "x-f5xc-required-for": {
12321
12876
  "minimum_config": false,
12322
12877
  "create": false,
@@ -12332,6 +12887,7 @@
12332
12887
  "$ref": "#/components/schemas/schemaObjectRefType"
12333
12888
  },
12334
12889
  "x-displayname": "Disabled Referred Objects.",
12890
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
12335
12891
  "x-f5xc-required-for": {
12336
12892
  "minimum_config": false,
12337
12893
  "create": false,
@@ -12350,6 +12906,7 @@
12350
12906
  "$ref": "#/components/schemas/schemaObjectRefType"
12351
12907
  },
12352
12908
  "x-displayname": "Referring Objects.",
12909
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
12353
12910
  "x-f5xc-required-for": {
12354
12911
  "minimum_config": false,
12355
12912
  "create": false,
@@ -12371,6 +12928,8 @@
12371
12928
  "$ref": "#/components/schemas/cminstanceStatusObject"
12372
12929
  },
12373
12930
  "x-displayname": "Status",
12931
+ "x-f5xc-example": "active",
12932
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
12374
12933
  "x-f5xc-required-for": {
12375
12934
  "minimum_config": false,
12376
12935
  "create": false,
@@ -12380,7 +12939,7 @@
12380
12939
  "maxLength": 17,
12381
12940
  "minLength": 17,
12382
12941
  "x-reconciled-from-discovery": true,
12383
- "x-reconciled-at": "2026-01-05T14:37:52.584908+00:00"
12942
+ "x-reconciled-at": "2026-01-07T15:28:06.018592+00:00"
12384
12943
  },
12385
12944
  "system_metadata": {
12386
12945
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -12420,6 +12979,8 @@
12420
12979
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
12421
12980
  ],
12422
12981
  "default": "GET_RSP_FORMAT_DEFAULT",
12982
+ "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...",
12983
+ "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...",
12423
12984
  "x-f5xc-minimum-configuration": {
12424
12985
  "description": "Minimum configuration for cminstanceGetResponseFormatCode",
12425
12986
  "required_fields": [],
@@ -12464,6 +13025,7 @@
12464
13025
  "ves.io.schema.rules.uint32.gte": "1",
12465
13026
  "ves.io.schema.rules.uint32.lte": "65535"
12466
13027
  },
13028
+ "x-f5xc-description-short": "Port of the Central Manager instance to connect to Required: YES.",
12467
13029
  "minimum": 1,
12468
13030
  "maximum": 65535,
12469
13031
  "x-f5xc-required-for": {
@@ -12492,6 +13054,7 @@
12492
13054
  "ves.io.schema.rules.string.max_len": "128",
12493
13055
  "ves.io.schema.rules.string.min_len": "4"
12494
13056
  },
13057
+ "x-f5xc-description-short": "Username for the Central Manager instance Required: YES.",
12495
13058
  "x-f5xc-required-for": {
12496
13059
  "minimum_config": false,
12497
13060
  "create": false,
@@ -12500,6 +13063,7 @@
12500
13063
  }
12501
13064
  }
12502
13065
  },
13066
+ "x-f5xc-description-short": "GET CMInstance will read the configuration from namespace metadata.namespace.",
12503
13067
  "x-f5xc-minimum-configuration": {
12504
13068
  "description": "Minimum configuration for cminstanceGetSpecType",
12505
13069
  "required_fields": [
@@ -12531,6 +13095,7 @@
12531
13095
  "$ref": "#/components/schemas/schemaErrorType"
12532
13096
  },
12533
13097
  "x-displayname": "Errors",
13098
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
12534
13099
  "x-f5xc-required-for": {
12535
13100
  "minimum_config": false,
12536
13101
  "create": false,
@@ -12546,6 +13111,8 @@
12546
13111
  "$ref": "#/components/schemas/cminstanceListResponseItem"
12547
13112
  },
12548
13113
  "x-displayname": "Items",
13114
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
13115
+ "x-f5xc-description-short": "Items represents the collection in response.",
12549
13116
  "x-f5xc-required-for": {
12550
13117
  "minimum_config": false,
12551
13118
  "create": false,
@@ -12579,6 +13146,8 @@
12579
13146
  "description": "The set of annotations present on this cminstance.",
12580
13147
  "title": "Annotations.",
12581
13148
  "x-displayname": "Annotations.",
13149
+ "x-f5xc-example": "{\"key\": \"value\"}",
13150
+ "x-f5xc-description-short": "The set of annotations present on this cminstance.",
12582
13151
  "x-f5xc-required-for": {
12583
13152
  "minimum_config": false,
12584
13153
  "create": false,
@@ -12591,6 +13160,7 @@
12591
13160
  "description": "The description set for this cminstance.",
12592
13161
  "title": "Description.",
12593
13162
  "x-displayname": "Description.",
13163
+ "x-f5xc-description-short": "The description set for this cminstance.",
12594
13164
  "minLength": 0,
12595
13165
  "maxLength": 0,
12596
13166
  "x-f5xc-required-for": {
@@ -12601,7 +13171,7 @@
12601
13171
  },
12602
13172
  "x-original-maxLength": 1024,
12603
13173
  "x-reconciled-from-discovery": true,
12604
- "x-reconciled-at": "2026-01-05T14:37:52.584929+00:00"
13174
+ "x-reconciled-at": "2026-01-07T15:28:06.018612+00:00"
12605
13175
  },
12606
13176
  "disabled": {
12607
13177
  "type": "boolean",
@@ -12609,6 +13179,8 @@
12609
13179
  "title": "Disabled",
12610
13180
  "format": "boolean",
12611
13181
  "x-displayname": "Disabled",
13182
+ "x-f5xc-example": "True",
13183
+ "x-f5xc-description-short": "Value of true indicates cminstance is administratively disabled.",
12612
13184
  "x-f5xc-required-for": {
12613
13185
  "minimum_config": false,
12614
13186
  "create": false,
@@ -12624,6 +13196,8 @@
12624
13196
  "description": "The set of labels present on this cminstance.",
12625
13197
  "title": "Labels",
12626
13198
  "x-displayname": "Labels",
13199
+ "x-f5xc-example": "{\"key\": \"value\"}",
13200
+ "x-f5xc-description-short": "The set of labels present on this cminstance.",
12627
13201
  "x-f5xc-required-for": {
12628
13202
  "minimum_config": false,
12629
13203
  "create": false,
@@ -12651,7 +13225,7 @@
12651
13225
  },
12652
13226
  "x-original-maxLength": 1024,
12653
13227
  "x-reconciled-from-discovery": true,
12654
- "x-reconciled-at": "2026-01-05T14:37:52.584940+00:00"
13228
+ "x-reconciled-at": "2026-01-07T15:28:06.018622+00:00"
12655
13229
  },
12656
13230
  "namespace": {
12657
13231
  "type": "string",
@@ -12670,7 +13244,7 @@
12670
13244
  },
12671
13245
  "x-original-maxLength": 1024,
12672
13246
  "x-reconciled-from-discovery": true,
12673
- "x-reconciled-at": "2026-01-05T14:37:52.584945+00:00"
13247
+ "x-reconciled-at": "2026-01-07T15:28:06.018627+00:00"
12674
13248
  },
12675
13249
  "owner_view": {
12676
13250
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -12683,6 +13257,7 @@
12683
13257
  "$ref": "#/components/schemas/cminstanceStatusObject"
12684
13258
  },
12685
13259
  "x-displayname": "Status",
13260
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
12686
13261
  "x-f5xc-required-for": {
12687
13262
  "minimum_config": false,
12688
13263
  "create": false,
@@ -12711,7 +13286,7 @@
12711
13286
  "x-field-mutability": "read-only",
12712
13287
  "x-original-maxLength": 1024,
12713
13288
  "x-reconciled-from-discovery": true,
12714
- "x-reconciled-at": "2026-01-05T14:37:52.584953+00:00"
13289
+ "x-reconciled-at": "2026-01-07T15:28:06.018635+00:00"
12715
13290
  },
12716
13291
  "uid": {
12717
13292
  "type": "string",
@@ -12732,9 +13307,11 @@
12732
13307
  "x-original-maxLength": 1024,
12733
13308
  "format": "uuid",
12734
13309
  "x-reconciled-from-discovery": true,
12735
- "x-reconciled-at": "2026-01-05T14:37:52.584959+00:00"
13310
+ "x-reconciled-at": "2026-01-07T15:28:06.018640+00:00"
12736
13311
  }
12737
13312
  },
13313
+ "x-f5xc-description-short": "By default a summary of cminstance is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
13314
+ "x-f5xc-description-medium": "By default a summary of cminstance is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
12738
13315
  "x-f5xc-minimum-configuration": {
12739
13316
  "description": "Minimum configuration for cminstanceListResponseItem",
12740
13317
  "required_fields": [
@@ -12833,6 +13410,7 @@
12833
13410
  "ves.io.schema.rules.uint32.gte": "1",
12834
13411
  "ves.io.schema.rules.uint32.lte": "65535"
12835
13412
  },
13413
+ "x-f5xc-description-short": "Port of the Central Manager instance to connect to Required: YES.",
12836
13414
  "minimum": 1,
12837
13415
  "maximum": 65535,
12838
13416
  "x-f5xc-required-for": {
@@ -12861,6 +13439,7 @@
12861
13439
  "ves.io.schema.rules.string.max_len": "128",
12862
13440
  "ves.io.schema.rules.string.min_len": "4"
12863
13441
  },
13442
+ "x-f5xc-description-short": "Username for the Central Manager instance Required: YES.",
12864
13443
  "x-f5xc-required-for": {
12865
13444
  "minimum_config": false,
12866
13445
  "create": false,
@@ -12869,6 +13448,8 @@
12869
13448
  }
12870
13449
  }
12871
13450
  },
13451
+ "x-f5xc-description-short": "Update the configuration by replacing the existing spec with the provided one.",
13452
+ "x-f5xc-description-medium": "Update the configuration by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
12872
13453
  "x-f5xc-minimum-configuration": {
12873
13454
  "description": "Minimum configuration for cminstanceReplaceSpecType",
12874
13455
  "required_fields": [
@@ -12926,6 +13507,7 @@
12926
13507
  }
12927
13508
  }
12928
13509
  },
13510
+ "x-f5xc-description-short": "Most recently observed status of object.",
12929
13511
  "x-f5xc-minimum-configuration": {
12930
13512
  "description": "Minimum configuration for cminstanceStatusObject",
12931
13513
  "required_fields": [
@@ -12955,6 +13537,8 @@
12955
13537
  "x-displayname": "Decryption Provider.",
12956
13538
  "x-ves-example": "Value",
12957
13539
  "x-f5xc-example": "value",
13540
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
13541
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
12958
13542
  "minLength": 0,
12959
13543
  "maxLength": 1024,
12960
13544
  "x-f5xc-required-for": {
@@ -12980,6 +13564,8 @@
12980
13564
  "ves.io.schema.rules.message.required": "true",
12981
13565
  "ves.io.schema.rules.string.uri_ref": "true"
12982
13566
  },
13567
+ "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
13568
+ "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
12983
13569
  "minLength": 0,
12984
13570
  "maxLength": 4,
12985
13571
  "x-f5xc-required-for": {
@@ -12990,7 +13576,7 @@
12990
13576
  },
12991
13577
  "x-original-maxLength": 1024,
12992
13578
  "x-reconciled-from-discovery": true,
12993
- "x-reconciled-at": "2026-01-05T14:37:52.584989+00:00"
13579
+ "x-reconciled-at": "2026-01-07T15:28:06.018668+00:00"
12994
13580
  },
12995
13581
  "store_provider": {
12996
13582
  "type": "string",
@@ -12999,6 +13585,8 @@
12999
13585
  "x-displayname": "Store Provider.",
13000
13586
  "x-ves-example": "Value",
13001
13587
  "x-f5xc-example": "value",
13588
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
13589
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
13002
13590
  "minLength": 0,
13003
13591
  "maxLength": 1024,
13004
13592
  "x-f5xc-required-for": {
@@ -13009,6 +13597,7 @@
13009
13597
  }
13010
13598
  }
13011
13599
  },
13600
+ "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
13012
13601
  "x-f5xc-minimum-configuration": {
13013
13602
  "description": "Minimum configuration for schemaBlindfoldSecretInfoType",
13014
13603
  "required_fields": [
@@ -13038,6 +13627,8 @@
13038
13627
  "x-displayname": "Provider",
13039
13628
  "x-ves-example": "Box-provider.",
13040
13629
  "x-f5xc-example": "box-provider",
13630
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
13631
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
13041
13632
  "minLength": 0,
13042
13633
  "maxLength": 8,
13043
13634
  "x-f5xc-required-for": {
@@ -13048,7 +13639,7 @@
13048
13639
  },
13049
13640
  "x-original-maxLength": 1024,
13050
13641
  "x-reconciled-from-discovery": true,
13051
- "x-reconciled-at": "2026-01-05T14:37:52.584996+00:00"
13642
+ "x-reconciled-at": "2026-01-07T15:28:06.018674+00:00"
13052
13643
  },
13053
13644
  "url": {
13054
13645
  "type": "string",
@@ -13069,6 +13660,8 @@
13069
13660
  "ves.io.schema.rules.string.max_bytes": "131072",
13070
13661
  "ves.io.schema.rules.string.uri_ref": "true"
13071
13662
  },
13663
+ "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
13664
+ "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
13072
13665
  "format": "uri",
13073
13666
  "minLength": 0,
13074
13667
  "x-f5xc-required-for": {
@@ -13079,6 +13672,7 @@
13079
13672
  }
13080
13673
  }
13081
13674
  },
13675
+ "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
13082
13676
  "x-f5xc-minimum-configuration": {
13083
13677
  "description": "Minimum configuration for schemaClearSecretInfoType",
13084
13678
  "required_fields": [
@@ -13112,6 +13706,7 @@
13112
13706
  "x-validation-rules": {
13113
13707
  "ves.io.schema.rules.string.ipv4": "true"
13114
13708
  },
13709
+ "x-f5xc-description-short": "IPv4 Address in string form with dot-decimal notation.",
13115
13710
  "minLength": 0,
13116
13711
  "maxLength": 1024,
13117
13712
  "x-f5xc-required-for": {
@@ -13143,6 +13738,8 @@
13143
13738
  "EncodingBase64"
13144
13739
  ],
13145
13740
  "default": "EncodingNone",
13741
+ "x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
13742
+ "x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
13146
13743
  "x-f5xc-minimum-configuration": {
13147
13744
  "description": "Minimum configuration for schemaSecretEncodingType",
13148
13745
  "required_fields": [],
@@ -13168,6 +13765,7 @@
13168
13765
  "$ref": "#/components/schemas/schemaClearSecretInfoType"
13169
13766
  }
13170
13767
  },
13768
+ "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
13171
13769
  "x-f5xc-minimum-configuration": {
13172
13770
  "description": "Minimum configuration for schemaSecretType",
13173
13771
  "required_fields": [
@@ -13191,6 +13789,8 @@
13191
13789
  "description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
13192
13790
  "title": "Key",
13193
13791
  "x-f5xc-example": "key_pem",
13792
+ "x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
13793
+ "x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
13194
13794
  "minLength": 0,
13195
13795
  "maxLength": 16,
13196
13796
  "x-f5xc-required-for": {
@@ -13201,13 +13801,14 @@
13201
13801
  },
13202
13802
  "x-original-maxLength": 1024,
13203
13803
  "x-reconciled-from-discovery": true,
13204
- "x-reconciled-at": "2026-01-05T14:37:52.585170+00:00"
13804
+ "x-reconciled-at": "2026-01-07T15:28:06.018840+00:00"
13205
13805
  },
13206
13806
  "location": {
13207
13807
  "type": "string",
13208
13808
  "description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
13209
13809
  "title": "Location",
13210
13810
  "x-f5xc-example": "v1/data/vhost_key",
13811
+ "x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
13211
13812
  "minLength": 0,
13212
13813
  "maxLength": 4,
13213
13814
  "x-f5xc-required-for": {
@@ -13218,13 +13819,15 @@
13218
13819
  },
13219
13820
  "x-original-maxLength": 1024,
13220
13821
  "x-reconciled-from-discovery": true,
13221
- "x-reconciled-at": "2026-01-05T14:37:52.585174+00:00"
13822
+ "x-reconciled-at": "2026-01-07T15:28:06.018844+00:00"
13222
13823
  },
13223
13824
  "provider": {
13224
13825
  "type": "string",
13225
13826
  "description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
13226
13827
  "title": "Provider",
13227
13828
  "x-f5xc-example": "vault-vh-provider",
13829
+ "x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
13830
+ "x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
13228
13831
  "minLength": 0,
13229
13832
  "maxLength": 8,
13230
13833
  "x-f5xc-required-for": {
@@ -13235,7 +13838,7 @@
13235
13838
  },
13236
13839
  "x-original-maxLength": 1024,
13237
13840
  "x-reconciled-from-discovery": true,
13238
- "x-reconciled-at": "2026-01-05T14:37:52.585178+00:00"
13841
+ "x-reconciled-at": "2026-01-07T15:28:06.018848+00:00"
13239
13842
  },
13240
13843
  "secret_encoding": {
13241
13844
  "$ref": "#/components/schemas/schemaSecretEncodingType"
@@ -13246,6 +13849,8 @@
13246
13849
  "title": "Version",
13247
13850
  "format": "int64",
13248
13851
  "x-f5xc-example": "1",
13852
+ "x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
13853
+ "x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
13249
13854
  "minimum": 0,
13250
13855
  "maximum": 2147483647,
13251
13856
  "x-f5xc-required-for": {
@@ -13257,9 +13862,11 @@
13257
13862
  "maxLength": 1,
13258
13863
  "minLength": 1,
13259
13864
  "x-reconciled-from-discovery": true,
13260
- "x-reconciled-at": "2026-01-05T14:37:52.585185+00:00"
13865
+ "x-reconciled-at": "2026-01-07T15:28:06.018855+00:00"
13261
13866
  }
13262
13867
  },
13868
+ "x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
13869
+ "x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
13263
13870
  "x-f5xc-minimum-configuration": {
13264
13871
  "description": "Minimum configuration for schemaVaultSecretInfoType",
13265
13872
  "required_fields": [
@@ -13286,6 +13893,7 @@
13286
13893
  "description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
13287
13894
  "title": "Name",
13288
13895
  "x-f5xc-example": "ChargeBack-API-Key",
13896
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
13289
13897
  "minLength": 0,
13290
13898
  "maxLength": 16,
13291
13899
  "x-f5xc-required-for": {
@@ -13296,9 +13904,10 @@
13296
13904
  },
13297
13905
  "x-original-maxLength": 1024,
13298
13906
  "x-reconciled-from-discovery": true,
13299
- "x-reconciled-at": "2026-01-05T14:37:52.585209+00:00"
13907
+ "x-reconciled-at": "2026-01-07T15:28:06.018879+00:00"
13300
13908
  }
13301
13909
  },
13910
+ "x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
13302
13911
  "x-f5xc-minimum-configuration": {
13303
13912
  "description": "Minimum configuration for schemaWingmanSecretInfoType",
13304
13913
  "required_fields": [
@@ -13315,6 +13924,7 @@
13315
13924
  "type": "object",
13316
13925
  "description": "X-displayName: \"Direct Connection Type\"\nExternal Connector with direct connection.",
13317
13926
  "title": "Direct Connection Type.",
13927
+ "x-f5xc-description-short": "X-displayName: \"Direct Connection Type\" External Connector with direct connection.",
13318
13928
  "x-f5xc-minimum-configuration": {
13319
13929
  "description": "Minimum configuration for external_connectorConnectionTypeDirect",
13320
13930
  "required_fields": [],
@@ -13334,6 +13944,7 @@
13334
13944
  "$ref": "#/components/schemas/external_connectorGRETunnelParameters"
13335
13945
  }
13336
13946
  },
13947
+ "x-f5xc-description-short": "X-displayName: \"GRE\" External Connector with GRE tunnel.",
13337
13948
  "x-f5xc-minimum-configuration": {
13338
13949
  "description": "Minimum configuration for external_connectorConnectionTypeGRE",
13339
13950
  "required_fields": [
@@ -13444,6 +14055,7 @@
13444
14055
  "$ref": "#/components/schemas/external_connectorConnectionTypeIPSec"
13445
14056
  }
13446
14057
  },
14058
+ "x-f5xc-description-short": "Shape of the external_connector configuration specification.",
13447
14059
  "x-f5xc-minimum-configuration": {
13448
14060
  "description": "Minimum configuration for external_connectorCreateSpecType",
13449
14061
  "required_fields": [
@@ -13470,6 +14082,7 @@
13470
14082
  "title": "Fail_if_referred.",
13471
14083
  "format": "boolean",
13472
14084
  "x-displayname": "Fail-If-Referred.",
14085
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
13473
14086
  "x-f5xc-required-for": {
13474
14087
  "minimum_config": false,
13475
14088
  "create": false,
@@ -13494,7 +14107,7 @@
13494
14107
  },
13495
14108
  "x-original-maxLength": 1024,
13496
14109
  "x-reconciled-from-discovery": true,
13497
- "x-reconciled-at": "2026-01-05T14:38:18.475125+00:00"
14110
+ "x-reconciled-at": "2026-01-07T15:28:35.687779+00:00"
13498
14111
  },
13499
14112
  "namespace": {
13500
14113
  "type": "string",
@@ -13503,6 +14116,7 @@
13503
14116
  "x-displayname": "Namespace",
13504
14117
  "x-ves-example": "Ns1",
13505
14118
  "x-f5xc-example": "ns1",
14119
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
13506
14120
  "minLength": 0,
13507
14121
  "maxLength": 6,
13508
14122
  "x-f5xc-required-for": {
@@ -13513,7 +14127,7 @@
13513
14127
  },
13514
14128
  "x-original-maxLength": 1024,
13515
14129
  "x-reconciled-from-discovery": true,
13516
- "x-reconciled-at": "2026-01-05T14:38:18.475132+00:00"
14130
+ "x-reconciled-at": "2026-01-07T15:28:35.687786+00:00"
13517
14131
  }
13518
14132
  },
13519
14133
  "x-f5xc-minimum-configuration": {
@@ -13538,7 +14152,7 @@
13538
14152
  "properties": {
13539
14153
  "timeout": {
13540
14154
  "type": "integer",
13541
- "description": "",
14155
+ "description": "Operation timeout duration",
13542
14156
  "title": "Keepalive Timer.",
13543
14157
  "format": "int64",
13544
14158
  "x-displayname": "Keepalive Timer.",
@@ -13550,6 +14164,7 @@
13550
14164
  "ves.io.schema.rules.uint32.gte": "1",
13551
14165
  "ves.io.schema.rules.uint32.lte": "5"
13552
14166
  },
14167
+ "x-f5xc-example": "30s",
13553
14168
  "minimum": 0,
13554
14169
  "maximum": 2147483647,
13555
14170
  "x-f5xc-required-for": {
@@ -13596,6 +14211,8 @@
13596
14211
  "items": {
13597
14212
  "$ref": "#/components/schemas/external_connectorTunnelEndpoint"
13598
14213
  },
14214
+ "x-f5xc-description-short": "X-displayName: \"Tunnel Endpoint\" x-required Configure tunnel parameters, source, destination, IP addresses.",
14215
+ "x-f5xc-description-medium": "X-displayName: \"Tunnel Endpoint\" x-required Configure tunnel parameters, source, destination, IP addresses.",
13599
14216
  "x-f5xc-required-for": {
13600
14217
  "minimum_config": false,
13601
14218
  "create": false,
@@ -13608,6 +14225,7 @@
13608
14225
  "description": "X-displayName: \"Tunnel MTU\"\nConfigure MTU for the GRE tunnel interface.",
13609
14226
  "title": "Tunnel MTU.",
13610
14227
  "format": "int64",
14228
+ "x-f5xc-description-short": "X-displayName: \"Tunnel MTU\" Configure MTU for the GRE tunnel interface.",
13611
14229
  "minimum": 0,
13612
14230
  "maximum": 2147483647,
13613
14231
  "x-f5xc-required-for": {
@@ -13618,6 +14236,8 @@
13618
14236
  }
13619
14237
  }
13620
14238
  },
14239
+ "x-f5xc-description-short": "X-displayName: \"GRE Tunnel Parameters\" GRE configuration parameters required for GRE Connection type.",
14240
+ "x-f5xc-description-medium": "X-displayName: \"GRE Tunnel Parameters\" GRE configuration parameters required for GRE Connection type.",
13621
14241
  "x-f5xc-minimum-configuration": {
13622
14242
  "description": "Minimum configuration for external_connectorGRETunnelParameters",
13623
14243
  "required_fields": [
@@ -13653,6 +14273,7 @@
13653
14273
  "$ref": "#/components/schemas/ioschemaObjectRefType"
13654
14274
  },
13655
14275
  "x-displayname": "Deleted Referred Objects.",
14276
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13656
14277
  "x-f5xc-required-for": {
13657
14278
  "minimum_config": false,
13658
14279
  "create": false,
@@ -13668,6 +14289,7 @@
13668
14289
  "$ref": "#/components/schemas/ioschemaObjectRefType"
13669
14290
  },
13670
14291
  "x-displayname": "Disabled Referred Objects.",
14292
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13671
14293
  "x-f5xc-required-for": {
13672
14294
  "minimum_config": false,
13673
14295
  "create": false,
@@ -13686,6 +14308,7 @@
13686
14308
  "$ref": "#/components/schemas/ioschemaObjectRefType"
13687
14309
  },
13688
14310
  "x-displayname": "Referring Objects.",
14311
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
13689
14312
  "x-f5xc-required-for": {
13690
14313
  "minimum_config": false,
13691
14314
  "create": false,
@@ -13707,6 +14330,8 @@
13707
14330
  "$ref": "#/components/schemas/external_connectorStatusObject"
13708
14331
  },
13709
14332
  "x-displayname": "Status",
14333
+ "x-f5xc-example": "active",
14334
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
13710
14335
  "x-f5xc-required-for": {
13711
14336
  "minimum_config": false,
13712
14337
  "create": false,
@@ -13716,7 +14341,7 @@
13716
14341
  "maxLength": 17,
13717
14342
  "minLength": 17,
13718
14343
  "x-reconciled-from-discovery": true,
13719
- "x-reconciled-at": "2026-01-05T14:38:18.475160+00:00"
14344
+ "x-reconciled-at": "2026-01-07T15:28:35.687811+00:00"
13720
14345
  },
13721
14346
  "system_metadata": {
13722
14347
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -13756,6 +14381,8 @@
13756
14381
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
13757
14382
  ],
13758
14383
  "default": "GET_RSP_FORMAT_DEFAULT",
14384
+ "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...",
14385
+ "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...",
13759
14386
  "x-f5xc-minimum-configuration": {
13760
14387
  "description": "Minimum configuration for external_connectorGetResponseFormatCode",
13761
14388
  "required_fields": [],
@@ -13782,6 +14409,7 @@
13782
14409
  "$ref": "#/components/schemas/external_connectorConnectionTypeIPSec"
13783
14410
  }
13784
14411
  },
14412
+ "x-f5xc-description-short": "Shape of the external_connector configuration specification.",
13785
14413
  "x-f5xc-minimum-configuration": {
13786
14414
  "description": "Minimum configuration for external_connectorGetSpecType",
13787
14415
  "required_fields": [
@@ -13829,6 +14457,8 @@
13829
14457
  "description": "Exclusive with [rm_ip_address use_default_remote_ike_id]\nConfigure an hostname Remote IKE ID.",
13830
14458
  "title": "Hostname",
13831
14459
  "x-displayname": "Hostname",
14460
+ "x-f5xc-example": "example-resource",
14461
+ "x-f5xc-description-short": "Exclusive with [rm_ip_address use_default_remote_ike_id] Configure an hostname Remote IKE ID.",
13832
14462
  "minLength": 0,
13833
14463
  "maxLength": 1024,
13834
14464
  "x-f5xc-required-for": {
@@ -13848,6 +14478,7 @@
13848
14478
  "$ref": "#/components/schemas/ioschemaEmpty"
13849
14479
  }
13850
14480
  },
14481
+ "x-f5xc-description-short": "IKE configuration parameters required for IPsec Connection type.",
13851
14482
  "x-f5xc-minimum-configuration": {
13852
14483
  "description": "Minimum configuration for external_connectorIkeParameters",
13853
14484
  "required_fields": [
@@ -13884,6 +14515,7 @@
13884
14515
  "$ref": "#/components/schemas/schemaErrorType"
13885
14516
  },
13886
14517
  "x-displayname": "Errors",
14518
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
13887
14519
  "x-f5xc-required-for": {
13888
14520
  "minimum_config": false,
13889
14521
  "create": false,
@@ -13899,6 +14531,8 @@
13899
14531
  "$ref": "#/components/schemas/external_connectorListResponseItem"
13900
14532
  },
13901
14533
  "x-displayname": "Items",
14534
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
14535
+ "x-f5xc-description-short": "Items represents the collection in response.",
13902
14536
  "x-f5xc-required-for": {
13903
14537
  "minimum_config": false,
13904
14538
  "create": false,
@@ -13932,6 +14566,8 @@
13932
14566
  "description": "The set of annotations present on this external_connector.",
13933
14567
  "title": "Annotations.",
13934
14568
  "x-displayname": "Annotations.",
14569
+ "x-f5xc-example": "{\"key\": \"value\"}",
14570
+ "x-f5xc-description-short": "The set of annotations present on this external_connector.",
13935
14571
  "x-f5xc-required-for": {
13936
14572
  "minimum_config": false,
13937
14573
  "create": false,
@@ -13944,6 +14580,7 @@
13944
14580
  "description": "The description set for this external_connector.",
13945
14581
  "title": "Description.",
13946
14582
  "x-displayname": "Description.",
14583
+ "x-f5xc-description-short": "The description set for this external_connector.",
13947
14584
  "minLength": 0,
13948
14585
  "maxLength": 0,
13949
14586
  "x-f5xc-required-for": {
@@ -13954,7 +14591,7 @@
13954
14591
  },
13955
14592
  "x-original-maxLength": 1024,
13956
14593
  "x-reconciled-from-discovery": true,
13957
- "x-reconciled-at": "2026-01-05T14:38:18.475189+00:00"
14594
+ "x-reconciled-at": "2026-01-07T15:28:35.687838+00:00"
13958
14595
  },
13959
14596
  "disabled": {
13960
14597
  "type": "boolean",
@@ -13962,6 +14599,8 @@
13962
14599
  "title": "Disabled",
13963
14600
  "format": "boolean",
13964
14601
  "x-displayname": "Disabled",
14602
+ "x-f5xc-example": "True",
14603
+ "x-f5xc-description-short": "Value of true indicates external_connector is administratively disabled.",
13965
14604
  "x-f5xc-required-for": {
13966
14605
  "minimum_config": false,
13967
14606
  "create": false,
@@ -13977,6 +14616,8 @@
13977
14616
  "description": "The set of labels present on this external_connector.",
13978
14617
  "title": "Labels",
13979
14618
  "x-displayname": "Labels",
14619
+ "x-f5xc-example": "{\"key\": \"value\"}",
14620
+ "x-f5xc-description-short": "The set of labels present on this external_connector.",
13980
14621
  "x-f5xc-required-for": {
13981
14622
  "minimum_config": false,
13982
14623
  "create": false,
@@ -14004,7 +14645,7 @@
14004
14645
  },
14005
14646
  "x-original-maxLength": 1024,
14006
14647
  "x-reconciled-from-discovery": true,
14007
- "x-reconciled-at": "2026-01-05T14:38:18.475200+00:00"
14648
+ "x-reconciled-at": "2026-01-07T15:28:35.687848+00:00"
14008
14649
  },
14009
14650
  "namespace": {
14010
14651
  "type": "string",
@@ -14023,7 +14664,7 @@
14023
14664
  },
14024
14665
  "x-original-maxLength": 1024,
14025
14666
  "x-reconciled-from-discovery": true,
14026
- "x-reconciled-at": "2026-01-05T14:38:18.475204+00:00"
14667
+ "x-reconciled-at": "2026-01-07T15:28:35.687852+00:00"
14027
14668
  },
14028
14669
  "owner_view": {
14029
14670
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -14036,6 +14677,7 @@
14036
14677
  "$ref": "#/components/schemas/external_connectorStatusObject"
14037
14678
  },
14038
14679
  "x-displayname": "Status",
14680
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
14039
14681
  "x-f5xc-required-for": {
14040
14682
  "minimum_config": false,
14041
14683
  "create": false,
@@ -14064,7 +14706,7 @@
14064
14706
  "x-field-mutability": "read-only",
14065
14707
  "x-original-maxLength": 1024,
14066
14708
  "x-reconciled-from-discovery": true,
14067
- "x-reconciled-at": "2026-01-05T14:38:18.475213+00:00"
14709
+ "x-reconciled-at": "2026-01-07T15:28:35.687860+00:00"
14068
14710
  },
14069
14711
  "uid": {
14070
14712
  "type": "string",
@@ -14073,6 +14715,7 @@
14073
14715
  "x-displayname": "UID",
14074
14716
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
14075
14717
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
14718
+ "x-f5xc-description-short": "The unique uid of this external_connector.",
14076
14719
  "minLength": 0,
14077
14720
  "maxLength": 36,
14078
14721
  "x-f5xc-required-for": {
@@ -14085,9 +14728,11 @@
14085
14728
  "x-original-maxLength": 1024,
14086
14729
  "format": "uuid",
14087
14730
  "x-reconciled-from-discovery": true,
14088
- "x-reconciled-at": "2026-01-05T14:38:18.475219+00:00"
14731
+ "x-reconciled-at": "2026-01-07T15:28:35.687866+00:00"
14089
14732
  }
14090
14733
  },
14734
+ "x-f5xc-description-short": "By default a summary of external_connector is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
14735
+ "x-f5xc-description-medium": "By default a summary of external_connector is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
14091
14736
  "x-f5xc-minimum-configuration": {
14092
14737
  "description": "Minimum configuration for external_connectorListResponseItem",
14093
14738
  "required_fields": [
@@ -14168,6 +14813,7 @@
14168
14813
  "$ref": "#/components/schemas/external_connectorConnectionTypeIPSec"
14169
14814
  }
14170
14815
  },
14816
+ "x-f5xc-description-short": "Shape of the external_connector configuration specification.",
14171
14817
  "x-f5xc-minimum-configuration": {
14172
14818
  "description": "Minimum configuration for external_connectorReplaceSpecType",
14173
14819
  "required_fields": [
@@ -14196,6 +14842,7 @@
14196
14842
  "$ref": "#/components/schemas/schemaConditionType"
14197
14843
  },
14198
14844
  "x-displayname": "Conditions.",
14845
+ "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.",
14199
14846
  "x-f5xc-required-for": {
14200
14847
  "minimum_config": false,
14201
14848
  "create": false,
@@ -14222,6 +14869,7 @@
14222
14869
  }
14223
14870
  }
14224
14871
  },
14872
+ "x-f5xc-description-short": "Most recently observed status of object.",
14225
14873
  "x-f5xc-minimum-configuration": {
14226
14874
  "description": "Minimum configuration for external_connectorStatusObject",
14227
14875
  "required_fields": [
@@ -14256,6 +14904,7 @@
14256
14904
  "x-validation-rules": {
14257
14905
  "ves.io.schema.rules.message.required": "true"
14258
14906
  },
14907
+ "x-f5xc-description-short": "For the chosen node, specify the interface that will be the tunnel source. Required: YES.",
14259
14908
  "minLength": 0,
14260
14909
  "maxLength": 1024,
14261
14910
  "x-f5xc-required-for": {
@@ -14281,6 +14930,8 @@
14281
14930
  "ves.io.schema.rules.message.required": "true",
14282
14931
  "ves.io.schema.rules.string.ipv4_prefix": "true"
14283
14932
  },
14933
+ "x-f5xc-description-short": "For a particular tunnel on a node, specify the local tunnel IP Address i.e.",
14934
+ "x-f5xc-description-medium": "For a particular tunnel on a node, specify the local tunnel IP Address i.e. The IP address of the tunnel on the CE node itself and a subnet prefix length Required: YES.",
14284
14935
  "minLength": 0,
14285
14936
  "maxLength": 1024,
14286
14937
  "x-f5xc-required-for": {
@@ -14302,6 +14953,8 @@
14302
14953
  "x-validation-rules": {
14303
14954
  "ves.io.schema.rules.message.required": "true"
14304
14955
  },
14956
+ "x-f5xc-description-short": "CE site is composed of multiple nodes. Choose a node that will be part of this external connection.",
14957
+ "x-f5xc-description-medium": "CE site is composed of multiple nodes. Choose a node that will be part of this external connection. Required: YES.",
14305
14958
  "minLength": 0,
14306
14959
  "maxLength": 1024,
14307
14960
  "x-f5xc-required-for": {
@@ -14327,6 +14980,8 @@
14327
14980
  "ves.io.schema.rules.message.required": "true",
14328
14981
  "ves.io.schema.rules.string.ipv4_prefix": "true"
14329
14982
  },
14983
+ "x-f5xc-description-short": "For a particular tunnel on a node, specify the remote tunnel IP Address i.e.",
14984
+ "x-f5xc-description-medium": "For a particular tunnel on a node, specify the remote tunnel IP Address i.e. The IP address of the tunnel on the remote gateway and a subnet prefix length Required: YES.",
14330
14985
  "minLength": 0,
14331
14986
  "maxLength": 1024,
14332
14987
  "x-f5xc-required-for": {
@@ -14337,6 +14992,7 @@
14337
14992
  }
14338
14993
  }
14339
14994
  },
14995
+ "x-f5xc-description-short": "Configure tunnel endpoints, local and remote IP addresses.",
14340
14996
  "x-f5xc-minimum-configuration": {
14341
14997
  "description": "Minimum configuration for external_connectorTunnelEndpoint",
14342
14998
  "required_fields": [
@@ -14375,6 +15031,8 @@
14375
15031
  "x-validation-rules": {
14376
15032
  "ves.io.schema.rules.message.required": "true"
14377
15033
  },
15034
+ "x-f5xc-description-short": "The IKE pre-shared key (PSK) is required to ensure the IKE peers can authenticate one another within IKE phase 1 negotiation.",
15035
+ "x-f5xc-description-medium": "The IKE pre-shared key (PSK) is required to ensure the IKE peers can authenticate one another within IKE phase 1 negotiation. Required: YES.",
14378
15036
  "minLength": 0,
14379
15037
  "maxLength": 1024,
14380
15038
  "x-f5xc-required-for": {
@@ -14414,6 +15072,7 @@
14414
15072
  "ves.io.schema.rules.repeated.max_items": "4",
14415
15073
  "ves.io.schema.rules.repeated.min_items": "1"
14416
15074
  },
15075
+ "x-f5xc-description-short": "Configure tunnel parameters, local and remote IP addresses Required: YES.",
14417
15076
  "x-f5xc-required-for": {
14418
15077
  "minimum_config": false,
14419
15078
  "create": false,
@@ -14438,6 +15097,8 @@
14438
15097
  "ves.io.schema.rules.uint32.gte": "512",
14439
15098
  "ves.io.schema.rules.uint32.lte": "1370"
14440
15099
  },
15100
+ "x-f5xc-description-short": "The tunnel MTU defines the maximum size of the packet that can be sent through the tunnel without needing to be fragmented Required: YES.",
15101
+ "x-f5xc-description-medium": "The tunnel MTU defines the maximum size of the packet that can be sent through the tunnel without needing to be fragmented Required: YES.",
14441
15102
  "minimum": 0,
14442
15103
  "maximum": 2147483647,
14443
15104
  "x-f5xc-required-for": {
@@ -14448,6 +15109,8 @@
14448
15109
  }
14449
15110
  }
14450
15111
  },
15112
+ "x-f5xc-description-short": "In this section, we will configure the tunnel parameters, source, destination, IP addresses, and segment.",
15113
+ "x-f5xc-description-medium": "In this section, we will configure the tunnel parameters, source, destination, IP addresses, and segment.",
14451
15114
  "x-f5xc-minimum-configuration": {
14452
15115
  "description": "Minimum configuration for external_connectorTunnelParameters",
14453
15116
  "required_fields": [
@@ -14482,6 +15145,7 @@
14482
15145
  "$ref": "#/components/schemas/schemaIpv6AddressType"
14483
15146
  }
14484
15147
  },
15148
+ "x-f5xc-description-short": "IP Address used to specify an IPv4 or IPv6 address.",
14485
15149
  "x-f5xc-minimum-configuration": {
14486
15150
  "description": "Minimum configuration for schemaIpAddressType",
14487
15151
  "required_fields": [
@@ -14515,6 +15179,7 @@
14515
15179
  "x-validation-rules": {
14516
15180
  "ves.io.schema.rules.string.ipv6": "true"
14517
15181
  },
15182
+ "x-f5xc-description-medium": "IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':' The address can be compacted by suppressing zeros e.g. '2001:db8:0:0:0:0:2:1' becomes '2001:db8::2:1' or '2001:db8:0:0:0:2:0:0' becomes '2001:db8::2::'.",
14518
15183
  "minLength": 0,
14519
15184
  "maxLength": 1024,
14520
15185
  "x-f5xc-required-for": {
@@ -14525,6 +15190,7 @@
14525
15190
  }
14526
15191
  }
14527
15192
  },
15193
+ "x-f5xc-description-short": "IPv6 Address specified as hexadecimal numbers separated by ':'.",
14528
15194
  "x-f5xc-minimum-configuration": {
14529
15195
  "description": "Minimum configuration for schemaIpv6AddressType",
14530
15196
  "required_fields": [
@@ -14562,6 +15228,7 @@
14562
15228
  "ves.io.schema.rules.message.required": "true",
14563
15229
  "ves.io.schema.rules.repeated.max_items": "1"
14564
15230
  },
15231
+ "x-f5xc-description-short": "Reference to Segment Object Required: YES.",
14565
15232
  "x-f5xc-required-for": {
14566
15233
  "minimum_config": false,
14567
15234
  "create": false,
@@ -14597,6 +15264,7 @@
14597
15264
  "$ref": "#/components/schemas/schemaObjectRefType"
14598
15265
  },
14599
15266
  "x-displayname": "Deleted Referred Objects.",
15267
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
14600
15268
  "x-f5xc-required-for": {
14601
15269
  "minimum_config": false,
14602
15270
  "create": false,
@@ -14612,6 +15280,7 @@
14612
15280
  "$ref": "#/components/schemas/schemaObjectRefType"
14613
15281
  },
14614
15282
  "x-displayname": "Disabled Referred Objects.",
15283
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
14615
15284
  "x-f5xc-required-for": {
14616
15285
  "minimum_config": false,
14617
15286
  "create": false,
@@ -14630,6 +15299,7 @@
14630
15299
  "$ref": "#/components/schemas/schemaObjectRefType"
14631
15300
  },
14632
15301
  "x-displayname": "Referring Objects.",
15302
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
14633
15303
  "x-f5xc-required-for": {
14634
15304
  "minimum_config": false,
14635
15305
  "create": false,
@@ -14648,6 +15318,8 @@
14648
15318
  "$ref": "#/components/schemas/navigation_tileStatusObject"
14649
15319
  },
14650
15320
  "x-displayname": "Status",
15321
+ "x-f5xc-example": "active",
15322
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
14651
15323
  "x-f5xc-required-for": {
14652
15324
  "minimum_config": false,
14653
15325
  "create": false,
@@ -14657,7 +15329,7 @@
14657
15329
  "maxLength": 17,
14658
15330
  "minLength": 17,
14659
15331
  "x-reconciled-from-discovery": true,
14660
- "x-reconciled-at": "2026-01-05T14:38:41.204230+00:00"
15332
+ "x-reconciled-at": "2026-01-07T15:29:01.793872+00:00"
14661
15333
  },
14662
15334
  "system_metadata": {
14663
15335
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -14693,6 +15365,8 @@
14693
15365
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
14694
15366
  ],
14695
15367
  "default": "GET_RSP_FORMAT_DEFAULT",
15368
+ "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...",
15369
+ "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_STATUS: x-displayName: \"Status format\" Response should be in...",
14696
15370
  "x-f5xc-minimum-configuration": {
14697
15371
  "description": "Minimum configuration for navigation_tileGetResponseFormatCode",
14698
15372
  "required_fields": [],
@@ -14727,6 +15401,7 @@
14727
15401
  "ves.io.schema.rules.repeated.max_items": "64",
14728
15402
  "ves.io.schema.rules.repeated.unique": "true"
14729
15403
  },
15404
+ "x-f5xc-description-short": "List of addon services linked to this navigation tile.",
14730
15405
  "x-f5xc-required-for": {
14731
15406
  "minimum_config": false,
14732
15407
  "create": false,
@@ -14745,6 +15420,8 @@
14745
15420
  "x-validation-rules": {
14746
15421
  "ves.io.schema.rules.string.max_len": "256"
14747
15422
  },
15423
+ "x-f5xc-description-short": "Default addon service landing page. Used as primary when multiple addon services are present.",
15424
+ "x-f5xc-description-medium": "Default addon service landing page. Used as primary when multiple addon services are present. Value should match the name of the addon service config object.",
14748
15425
  "minLength": 0,
14749
15426
  "x-f5xc-required-for": {
14750
15427
  "minimum_config": false,
@@ -14768,6 +15445,7 @@
14768
15445
  "ves.io.schema.rules.string.max_len": "512"
14769
15446
  },
14770
15447
  "x-f5xc-example": "example-resource",
15448
+ "x-f5xc-description-short": "User friendly name for display purpose. Required: YES.",
14771
15449
  "minLength": 0,
14772
15450
  "x-f5xc-required-for": {
14773
15451
  "minimum_config": false,
@@ -14781,6 +15459,7 @@
14781
15459
  "description": "Management flag is used to indicate that this tile is used for management purposes.",
14782
15460
  "format": "boolean",
14783
15461
  "x-displayname": "Management.",
15462
+ "x-f5xc-description-short": "Management flag is used to indicate that this tile is used for management purposes.",
14784
15463
  "x-f5xc-required-for": {
14785
15464
  "minimum_config": false,
14786
15465
  "create": false,
@@ -14804,6 +15483,7 @@
14804
15483
  "ves.io.schema.rules.repeated.max_items": "64",
14805
15484
  "ves.io.schema.rules.repeated.unique": "true"
14806
15485
  },
15486
+ "x-f5xc-description-short": "List of addon services required for this navigation tile to function.",
14807
15487
  "x-f5xc-required-for": {
14808
15488
  "minimum_config": false,
14809
15489
  "create": false,
@@ -14827,6 +15507,7 @@
14827
15507
  "ves.io.schema.rules.repeated.max_items": "32",
14828
15508
  "ves.io.schema.rules.repeated.unique": "true"
14829
15509
  },
15510
+ "x-f5xc-description-short": "List of pre-defined roles associated to this tile.",
14830
15511
  "x-f5xc-required-for": {
14831
15512
  "minimum_config": false,
14832
15513
  "create": false,
@@ -14841,6 +15522,8 @@
14841
15522
  "$ref": "#/components/schemas/schemaFeatureTag"
14842
15523
  },
14843
15524
  "x-displayname": "Tags",
15525
+ "x-f5xc-example": "{\"key\": \"value\"}",
15526
+ "x-f5xc-description-short": "Tag of the addon (new, basic level etc). Some tags may be combined e.g.",
14844
15527
  "x-f5xc-required-for": {
14845
15528
  "minimum_config": false,
14846
15529
  "create": false,
@@ -14849,6 +15532,7 @@
14849
15532
  }
14850
15533
  }
14851
15534
  },
15535
+ "x-f5xc-description-short": "GET navigation_tile reads a given object from storage backend for metadata.namespace.",
14852
15536
  "x-f5xc-minimum-configuration": {
14853
15537
  "description": "Minimum configuration for navigation_tileGetSpecType",
14854
15538
  "required_fields": [
@@ -14882,6 +15566,7 @@
14882
15566
  "$ref": "#/components/schemas/schemaErrorType"
14883
15567
  },
14884
15568
  "x-displayname": "Errors",
15569
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
14885
15570
  "x-f5xc-required-for": {
14886
15571
  "minimum_config": false,
14887
15572
  "create": false,
@@ -14897,6 +15582,8 @@
14897
15582
  "$ref": "#/components/schemas/navigation_tileListResponseItem"
14898
15583
  },
14899
15584
  "x-displayname": "Items",
15585
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
15586
+ "x-f5xc-description-short": "Items represents the collection in response.",
14900
15587
  "x-f5xc-required-for": {
14901
15588
  "minimum_config": false,
14902
15589
  "create": false,
@@ -14930,6 +15617,8 @@
14930
15617
  "description": "The set of annotations present on this navigation_tile.",
14931
15618
  "title": "Annotations.",
14932
15619
  "x-displayname": "Annotations.",
15620
+ "x-f5xc-example": "{\"key\": \"value\"}",
15621
+ "x-f5xc-description-short": "The set of annotations present on this navigation_tile.",
14933
15622
  "x-f5xc-required-for": {
14934
15623
  "minimum_config": false,
14935
15624
  "create": false,
@@ -14942,6 +15631,7 @@
14942
15631
  "description": "The description set for this navigation_tile.",
14943
15632
  "title": "Description.",
14944
15633
  "x-displayname": "Description.",
15634
+ "x-f5xc-description-short": "The description set for this navigation_tile.",
14945
15635
  "minLength": 0,
14946
15636
  "maxLength": 0,
14947
15637
  "x-f5xc-required-for": {
@@ -14952,7 +15642,7 @@
14952
15642
  },
14953
15643
  "x-original-maxLength": 1024,
14954
15644
  "x-reconciled-from-discovery": true,
14955
- "x-reconciled-at": "2026-01-05T14:38:41.204257+00:00"
15645
+ "x-reconciled-at": "2026-01-07T15:29:01.793898+00:00"
14956
15646
  },
14957
15647
  "disabled": {
14958
15648
  "type": "boolean",
@@ -14960,6 +15650,8 @@
14960
15650
  "title": "Disabled",
14961
15651
  "format": "boolean",
14962
15652
  "x-displayname": "Disabled",
15653
+ "x-f5xc-example": "True",
15654
+ "x-f5xc-description-short": "Value of true indicates navigation_tile is administratively disabled.",
14963
15655
  "x-f5xc-required-for": {
14964
15656
  "minimum_config": false,
14965
15657
  "create": false,
@@ -14975,6 +15667,8 @@
14975
15667
  "description": "The set of labels present on this navigation_tile.",
14976
15668
  "title": "Labels",
14977
15669
  "x-displayname": "Labels",
15670
+ "x-f5xc-example": "{\"key\": \"value\"}",
15671
+ "x-f5xc-description-short": "The set of labels present on this navigation_tile.",
14978
15672
  "x-f5xc-required-for": {
14979
15673
  "minimum_config": false,
14980
15674
  "create": false,
@@ -15002,7 +15696,7 @@
15002
15696
  },
15003
15697
  "x-original-maxLength": 1024,
15004
15698
  "x-reconciled-from-discovery": true,
15005
- "x-reconciled-at": "2026-01-05T14:38:41.204268+00:00"
15699
+ "x-reconciled-at": "2026-01-07T15:29:01.793909+00:00"
15006
15700
  },
15007
15701
  "namespace": {
15008
15702
  "type": "string",
@@ -15021,7 +15715,7 @@
15021
15715
  },
15022
15716
  "x-original-maxLength": 1024,
15023
15717
  "x-reconciled-from-discovery": true,
15024
- "x-reconciled-at": "2026-01-05T14:38:41.204273+00:00"
15718
+ "x-reconciled-at": "2026-01-07T15:29:01.793914+00:00"
15025
15719
  },
15026
15720
  "owner_view": {
15027
15721
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -15034,6 +15728,7 @@
15034
15728
  "$ref": "#/components/schemas/navigation_tileStatusObject"
15035
15729
  },
15036
15730
  "x-displayname": "Status",
15731
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
15037
15732
  "x-f5xc-required-for": {
15038
15733
  "minimum_config": false,
15039
15734
  "create": false,
@@ -15062,7 +15757,7 @@
15062
15757
  "x-field-mutability": "read-only",
15063
15758
  "x-original-maxLength": 1024,
15064
15759
  "x-reconciled-from-discovery": true,
15065
- "x-reconciled-at": "2026-01-05T14:38:41.204282+00:00"
15760
+ "x-reconciled-at": "2026-01-07T15:29:01.793922+00:00"
15066
15761
  },
15067
15762
  "uid": {
15068
15763
  "type": "string",
@@ -15083,9 +15778,11 @@
15083
15778
  "x-original-maxLength": 1024,
15084
15779
  "format": "uuid",
15085
15780
  "x-reconciled-from-discovery": true,
15086
- "x-reconciled-at": "2026-01-05T14:38:41.204288+00:00"
15781
+ "x-reconciled-at": "2026-01-07T15:29:01.793927+00:00"
15087
15782
  }
15088
15783
  },
15784
+ "x-f5xc-description-short": "By default a summary of navigation_tile is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
15785
+ "x-f5xc-description-medium": "By default a summary of navigation_tile is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
15089
15786
  "x-f5xc-minimum-configuration": {
15090
15787
  "description": "Minimum configuration for navigation_tileListResponseItem",
15091
15788
  "required_fields": [
@@ -15151,6 +15848,7 @@
15151
15848
  }
15152
15849
  }
15153
15850
  },
15851
+ "x-f5xc-description-short": "Most recently observed status of object.",
15154
15852
  "x-f5xc-minimum-configuration": {
15155
15853
  "description": "Minimum configuration for navigation_tileStatusObject",
15156
15854
  "required_fields": [
@@ -15254,6 +15952,7 @@
15254
15952
  }
15255
15953
  }
15256
15954
  },
15955
+ "x-f5xc-description-short": "Request to register F5XC AWS marketplace product for F5XC service.",
15257
15956
  "x-f5xc-minimum-configuration": {
15258
15957
  "description": "Minimum configuration for aws_accountRegistrationRequest",
15259
15958
  "required_fields": [
@@ -15280,6 +15979,7 @@
15280
15979
  "x-displayname": "Redirect URL.",
15281
15980
  "x-ves-example": "Redirect_url: https://console.ves.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioio/login/start.",
15282
15981
  "x-f5xc-example": "redirect_urlhttps://console.ves.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioioioio/login/start",
15982
+ "x-f5xc-description-short": "Registration redirect URL for redirecting the AWS customer to login/registration page.",
15283
15983
  "minLength": 0,
15284
15984
  "maxLength": 1024,
15285
15985
  "x-f5xc-required-for": {
@@ -15290,6 +15990,7 @@
15290
15990
  }
15291
15991
  }
15292
15992
  },
15993
+ "x-f5xc-description-short": "Response to register F5XC AWS marketplace product.",
15293
15994
  "x-f5xc-minimum-configuration": {
15294
15995
  "description": "Minimum configuration for aws_accountRegistrationResponse",
15295
15996
  "required_fields": [
@@ -15351,7 +16052,7 @@
15351
16052
  },
15352
16053
  "format": "hostname",
15353
16054
  "x-reconciled-from-discovery": true,
15354
- "x-reconciled-at": "2026-01-05T14:38:44.059346+00:00"
16055
+ "x-reconciled-at": "2026-01-07T15:29:05.166040+00:00"
15355
16056
  },
15356
16057
  "locale": {
15357
16058
  "type": "string",
@@ -15462,7 +16163,7 @@
15462
16163
  },
15463
16164
  "x-original-maxLength": 256,
15464
16165
  "x-reconciled-from-discovery": true,
15465
- "x-reconciled-at": "2026-01-05T14:38:44.059361+00:00"
16166
+ "x-reconciled-at": "2026-01-07T15:29:05.166054+00:00"
15466
16167
  }
15467
16168
  },
15468
16169
  "x-f5xc-minimum-configuration": {
@@ -15556,6 +16257,7 @@
15556
16257
  "x-displayname": "County",
15557
16258
  "x-ves-example": "Santa Clara.",
15558
16259
  "x-f5xc-example": "Santa Clara",
16260
+ "x-f5xc-description-short": "County (optional, for countries where they have counties).",
15559
16261
  "minLength": 0,
15560
16262
  "maxLength": 1024,
15561
16263
  "x-f5xc-required-for": {
@@ -15588,6 +16290,7 @@
15588
16290
  "x-displayname": "State",
15589
16291
  "x-ves-example": "California.",
15590
16292
  "x-f5xc-example": "California",
16293
+ "x-f5xc-description-short": "State (optional, for countries where they have states).",
15591
16294
  "minLength": 0,
15592
16295
  "maxLength": 1024,
15593
16296
  "x-f5xc-required-for": {
@@ -15604,6 +16307,7 @@
15604
16307
  "x-displayname": "State Code.",
15605
16308
  "x-ves-example": "CA",
15606
16309
  "x-f5xc-example": "CA",
16310
+ "x-f5xc-description-short": "State code (optional, for countries where they have states).",
15607
16311
  "minLength": 0,
15608
16312
  "maxLength": 1024,
15609
16313
  "x-f5xc-required-for": {
@@ -15630,6 +16334,8 @@
15630
16334
  }
15631
16335
  }
15632
16336
  },
16337
+ "x-f5xc-description-short": "Instance of one single contact that can be used to communicate with customers.",
16338
+ "x-f5xc-description-medium": "Instance of one single contact that can be used to communicate with customers. Depending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
15633
16339
  "x-f5xc-minimum-configuration": {
15634
16340
  "description": "Minimum configuration for signupContactMeta",
15635
16341
  "required_fields": [
@@ -15777,6 +16483,7 @@
15777
16483
  "$ref": "#/components/schemas/schemaObjectRefType"
15778
16484
  },
15779
16485
  "x-displayname": "Deleted Referred Objects.",
16486
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
15780
16487
  "x-f5xc-required-for": {
15781
16488
  "minimum_config": false,
15782
16489
  "create": false,
@@ -15792,6 +16499,7 @@
15792
16499
  "$ref": "#/components/schemas/schemaObjectRefType"
15793
16500
  },
15794
16501
  "x-displayname": "Disabled Referred Objects.",
16502
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
15795
16503
  "x-f5xc-required-for": {
15796
16504
  "minimum_config": false,
15797
16505
  "create": false,
@@ -15810,6 +16518,7 @@
15810
16518
  "$ref": "#/components/schemas/schemaObjectRefType"
15811
16519
  },
15812
16520
  "x-displayname": "Referring Objects.",
16521
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
15813
16522
  "x-f5xc-required-for": {
15814
16523
  "minimum_config": false,
15815
16524
  "create": false,
@@ -15828,6 +16537,8 @@
15828
16537
  "$ref": "#/components/schemas/planStatusObject"
15829
16538
  },
15830
16539
  "x-displayname": "Status",
16540
+ "x-f5xc-example": "active",
16541
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
15831
16542
  "x-f5xc-required-for": {
15832
16543
  "minimum_config": false,
15833
16544
  "create": false,
@@ -15837,7 +16548,7 @@
15837
16548
  "maxLength": 17,
15838
16549
  "minLength": 17,
15839
16550
  "x-reconciled-from-discovery": true,
15840
- "x-reconciled-at": "2026-01-05T14:38:45.310736+00:00"
16551
+ "x-reconciled-at": "2026-01-07T15:29:06.611231+00:00"
15841
16552
  },
15842
16553
  "system_metadata": {
15843
16554
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -15873,6 +16584,8 @@
15873
16584
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
15874
16585
  ],
15875
16586
  "default": "GET_RSP_FORMAT_DEFAULT",
16587
+ "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...",
16588
+ "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_STATUS: x-displayName: \"Status format\" Response should be in...",
15876
16589
  "x-f5xc-minimum-configuration": {
15877
16590
  "description": "Minimum configuration for planGetResponseFormatCode",
15878
16591
  "required_fields": [],
@@ -15907,6 +16620,7 @@
15907
16620
  "ves.io.schema.rules.repeated.max_items": "32",
15908
16621
  "ves.io.schema.rules.repeated.unique": "true"
15909
16622
  },
16623
+ "x-f5xc-description-short": "List of pre-defined addon services that can be subscribed part this plan.",
15910
16624
  "x-f5xc-required-for": {
15911
16625
  "minimum_config": false,
15912
16626
  "create": false,
@@ -15929,6 +16643,7 @@
15929
16643
  "ves.io.schema.rules.string.max_len": "512"
15930
16644
  },
15931
16645
  "x-f5xc-example": "example-resource",
16646
+ "x-f5xc-description-short": "User friendly name for display purpose. Required: YES.",
15932
16647
  "minLength": 0,
15933
16648
  "x-f5xc-required-for": {
15934
16649
  "minimum_config": false,
@@ -15953,6 +16668,8 @@
15953
16668
  "ves.io.schema.rules.repeated.max_items": "32",
15954
16669
  "ves.io.schema.rules.repeated.unique": "true"
15955
16670
  },
16671
+ "x-f5xc-description-short": "List of pre-defined addon services that are by default included part this plan. Tenant will be auto subscribed to all the addon services in this list.",
16672
+ "x-f5xc-description-medium": "List of pre-defined addon services that are by default included part this plan. Tenant will be auto subscribed to all the addon services in this list.",
15956
16673
  "x-f5xc-required-for": {
15957
16674
  "minimum_config": false,
15958
16675
  "create": false,
@@ -15961,6 +16678,7 @@
15961
16678
  }
15962
16679
  }
15963
16680
  },
16681
+ "x-f5xc-description-short": "GET plan reads a given object from storage backend for metadata.namespace.",
15964
16682
  "x-f5xc-minimum-configuration": {
15965
16683
  "description": "Minimum configuration for planGetSpecType",
15966
16684
  "required_fields": [
@@ -15990,6 +16708,7 @@
15990
16708
  "$ref": "#/components/schemas/schemaErrorType"
15991
16709
  },
15992
16710
  "x-displayname": "Errors",
16711
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
15993
16712
  "x-f5xc-required-for": {
15994
16713
  "minimum_config": false,
15995
16714
  "create": false,
@@ -16005,6 +16724,8 @@
16005
16724
  "$ref": "#/components/schemas/planListResponseItem"
16006
16725
  },
16007
16726
  "x-displayname": "Items",
16727
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
16728
+ "x-f5xc-description-short": "Items represents the collection in response.",
16008
16729
  "x-f5xc-required-for": {
16009
16730
  "minimum_config": false,
16010
16731
  "create": false,
@@ -16038,6 +16759,8 @@
16038
16759
  "description": "The set of annotations present on this plan.",
16039
16760
  "title": "Annotations.",
16040
16761
  "x-displayname": "Annotations.",
16762
+ "x-f5xc-example": "{\"key\": \"value\"}",
16763
+ "x-f5xc-description-short": "The set of annotations present on this plan.",
16041
16764
  "x-f5xc-required-for": {
16042
16765
  "minimum_config": false,
16043
16766
  "create": false,
@@ -16060,7 +16783,7 @@
16060
16783
  },
16061
16784
  "x-original-maxLength": 1024,
16062
16785
  "x-reconciled-from-discovery": true,
16063
- "x-reconciled-at": "2026-01-05T14:38:45.310768+00:00"
16786
+ "x-reconciled-at": "2026-01-07T15:29:06.611253+00:00"
16064
16787
  },
16065
16788
  "disabled": {
16066
16789
  "type": "boolean",
@@ -16068,6 +16791,8 @@
16068
16791
  "title": "Disabled",
16069
16792
  "format": "boolean",
16070
16793
  "x-displayname": "Disabled",
16794
+ "x-f5xc-example": "True",
16795
+ "x-f5xc-description-short": "Value of true indicates plan is administratively disabled.",
16071
16796
  "x-f5xc-required-for": {
16072
16797
  "minimum_config": false,
16073
16798
  "create": false,
@@ -16083,6 +16808,7 @@
16083
16808
  "description": "The set of labels present on this plan.",
16084
16809
  "title": "Labels",
16085
16810
  "x-displayname": "Labels",
16811
+ "x-f5xc-example": "{\"key\": \"value\"}",
16086
16812
  "x-f5xc-required-for": {
16087
16813
  "minimum_config": false,
16088
16814
  "create": false,
@@ -16110,7 +16836,7 @@
16110
16836
  },
16111
16837
  "x-original-maxLength": 1024,
16112
16838
  "x-reconciled-from-discovery": true,
16113
- "x-reconciled-at": "2026-01-05T14:38:45.310781+00:00"
16839
+ "x-reconciled-at": "2026-01-07T15:29:06.611264+00:00"
16114
16840
  },
16115
16841
  "namespace": {
16116
16842
  "type": "string",
@@ -16129,7 +16855,7 @@
16129
16855
  },
16130
16856
  "x-original-maxLength": 1024,
16131
16857
  "x-reconciled-from-discovery": true,
16132
- "x-reconciled-at": "2026-01-05T14:38:45.310786+00:00"
16858
+ "x-reconciled-at": "2026-01-07T15:29:06.611269+00:00"
16133
16859
  },
16134
16860
  "owner_view": {
16135
16861
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -16142,6 +16868,7 @@
16142
16868
  "$ref": "#/components/schemas/planStatusObject"
16143
16869
  },
16144
16870
  "x-displayname": "Status",
16871
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
16145
16872
  "x-f5xc-required-for": {
16146
16873
  "minimum_config": false,
16147
16874
  "create": false,
@@ -16170,7 +16897,7 @@
16170
16897
  "x-field-mutability": "read-only",
16171
16898
  "x-original-maxLength": 1024,
16172
16899
  "x-reconciled-from-discovery": true,
16173
- "x-reconciled-at": "2026-01-05T14:38:45.310794+00:00"
16900
+ "x-reconciled-at": "2026-01-07T15:29:06.611277+00:00"
16174
16901
  },
16175
16902
  "uid": {
16176
16903
  "type": "string",
@@ -16191,9 +16918,11 @@
16191
16918
  "x-original-maxLength": 1024,
16192
16919
  "format": "uuid",
16193
16920
  "x-reconciled-from-discovery": true,
16194
- "x-reconciled-at": "2026-01-05T14:38:45.310800+00:00"
16921
+ "x-reconciled-at": "2026-01-07T15:29:06.611283+00:00"
16195
16922
  }
16196
16923
  },
16924
+ "x-f5xc-description-short": "By default a summary of plan is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
16925
+ "x-f5xc-description-medium": "By default a summary of plan is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
16197
16926
  "x-f5xc-minimum-configuration": {
16198
16927
  "description": "Minimum configuration for planListResponseItem",
16199
16928
  "required_fields": [
@@ -16259,6 +16988,7 @@
16259
16988
  }
16260
16989
  }
16261
16990
  },
16991
+ "x-f5xc-description-short": "Most recently observed status of object.",
16262
16992
  "x-f5xc-minimum-configuration": {
16263
16993
  "description": "Minimum configuration for planStatusObject",
16264
16994
  "required_fields": [
@@ -16284,6 +17014,7 @@
16284
17014
  "title": "API endpoint path.",
16285
17015
  "x-f5xc-example": "/endpoint1",
16286
17016
  "x-required": true,
17017
+ "x-f5xc-description-short": "X-displayName: \"API Endpoint\" The rule is applied only for the specified API endpoints.",
16287
17018
  "minLength": 0,
16288
17019
  "maxLength": 1024,
16289
17020
  "x-f5xc-required-for": {
@@ -16301,6 +17032,7 @@
16301
17032
  "$ref": "#/components/schemas/schemaHttpMethod"
16302
17033
  },
16303
17034
  "x-f5xc-example": "['GET', 'POST', 'DELETE']",
17035
+ "x-f5xc-description-short": "X-displayName: \"Methods\" List of methods values to match against. X-required.",
16304
17036
  "x-f5xc-required-for": {
16305
17037
  "minimum_config": false,
16306
17038
  "create": false,
@@ -16310,6 +17042,7 @@
16310
17042
  }
16311
17043
  },
16312
17044
  "x-required": true,
17045
+ "x-f5xc-description-short": "X-displayName: \"API Endpoint\" The rule is applied only for the specified API endpoints.",
16313
17046
  "x-f5xc-minimum-configuration": {
16314
17047
  "description": "Minimum configuration for app_typeAPIEndpoint",
16315
17048
  "required_fields": [
@@ -16333,6 +17066,7 @@
16333
17066
  "description": "X-displayName: \"Name\"\nx-required\nBuilt-in rule for sensitive data detection.",
16334
17067
  "title": "Name",
16335
17068
  "x-f5xc-example": "[EMAIL, CC]",
17069
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Built-in rule for sensitive data detection.",
16336
17070
  "minLength": 0,
16337
17071
  "maxLength": 16,
16338
17072
  "x-f5xc-required-for": {
@@ -16343,10 +17077,11 @@
16343
17077
  },
16344
17078
  "x-original-maxLength": 1024,
16345
17079
  "x-reconciled-from-discovery": true,
16346
- "x-reconciled-at": "2026-01-05T14:39:09.681747+00:00"
17080
+ "x-reconciled-at": "2026-01-07T15:29:33.651326+00:00"
16347
17081
  }
16348
17082
  },
16349
17083
  "x-f5xc-example": "[EMAIL, CC]",
17084
+ "x-f5xc-description-short": "X-displayName: \"Built-In Sensitive Data Type\" Message wrapper for built-in sensitive data type.",
16350
17085
  "x-f5xc-minimum-configuration": {
16351
17086
  "description": "Minimum configuration for app_typeBuiltInSensitiveDataType",
16352
17087
  "required_fields": [
@@ -16387,6 +17122,8 @@
16387
17122
  "description": "X-displayName: \"API Group\"\nThe rule is applied on the APIs that belong to specified api_group.\nAPI groups derived from API Definition swaggers.\nFor example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers.\nCustom groups can be created if user tags paths or operations with \"x-F5 Distributed Cloud-API-group\" extensions inside swaggers.",
16388
17123
  "title": "Api_group",
16389
17124
  "x-f5xc-example": "oas-all-operations",
17125
+ "x-f5xc-description-short": "X-displayName: \"API Group\" The rule is applied on the APIs that belong to specified api_group.",
17126
+ "x-f5xc-description-medium": "X-displayName: \"API Group\" The rule is applied on the APIs that belong to specified api_group. API groups derived from API Definition swaggers. For example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers.",
16390
17127
  "minLength": 0,
16391
17128
  "maxLength": 1024,
16392
17129
  "x-f5xc-required-for": {
@@ -16401,6 +17138,8 @@
16401
17138
  "description": "X-displayName: \"Base Path\"\nThe rule is applied only for the requests matching the specified base path.",
16402
17139
  "title": "Base path",
16403
17140
  "x-f5xc-example": "/v1",
17141
+ "x-f5xc-description-short": "X-displayName: \"Base Path\" The rule is applied only for the requests matching the specified base path.",
17142
+ "x-f5xc-description-medium": "X-displayName: \"Base Path\" The rule is applied only for the requests matching the specified base path.",
16404
17143
  "minLength": 0,
16405
17144
  "maxLength": 1024,
16406
17145
  "x-f5xc-required-for": {
@@ -16424,6 +17163,7 @@
16424
17163
  "description": "X-displayName: \"Specific Domain\"\nThe rule will apply for a specific domain.\nFor example: api.example.com.",
16425
17164
  "title": "Domain",
16426
17165
  "x-f5xc-example": "api.example.com",
17166
+ "x-f5xc-description-short": "X-displayName: \"Specific Domain\" The rule will apply for a specific domain. For",
16427
17167
  "minLength": 0,
16428
17168
  "maxLength": 1024,
16429
17169
  "x-f5xc-required-for": {
@@ -16437,6 +17177,8 @@
16437
17177
  "$ref": "#/components/schemas/app_typeValuePattern"
16438
17178
  }
16439
17179
  },
17180
+ "x-f5xc-description-short": "X-displayName: \"Custom Data Detection Config\" The custom data detection config specifies targets, scopes & the pattern to be detected.",
17181
+ "x-f5xc-description-medium": "X-displayName: \"Custom Data Detection Config\" The custom data detection config specifies targets, scopes & the pattern to be detected.",
16440
17182
  "x-f5xc-minimum-configuration": {
16441
17183
  "description": "Minimum configuration for app_typeCustomDataDetectionConfig",
16442
17184
  "required_fields": [
@@ -16473,6 +17215,7 @@
16473
17215
  "items": {
16474
17216
  "$ref": "#/components/schemas/schemaHttpSections"
16475
17217
  },
17218
+ "x-f5xc-description-short": "X-displayName: \"Custom Sections\" x-required Request & Response Sections.",
16476
17219
  "x-f5xc-required-for": {
16477
17220
  "minimum_config": false,
16478
17221
  "create": false,
@@ -16481,6 +17224,7 @@
16481
17224
  }
16482
17225
  }
16483
17226
  },
17227
+ "x-f5xc-description-short": "X-displayName: \"Custom Sections\" Request & Response Sections.",
16484
17228
  "x-f5xc-minimum-configuration": {
16485
17229
  "description": "Minimum configuration for app_typeCustomSections",
16486
17230
  "required_fields": [
@@ -16508,6 +17252,7 @@
16508
17252
  "$ref": "#/components/schemas/app_typeCustomSensitiveDataType"
16509
17253
  }
16510
17254
  },
17255
+ "x-f5xc-description-short": "X-displayName: \"Custom Sensitive Data Detection Rule\" Custom Sensitive Data Rule Definition.",
16511
17256
  "x-f5xc-minimum-configuration": {
16512
17257
  "description": "Minimum configuration for app_typeCustomSensitiveDataDetectionRule",
16513
17258
  "required_fields": [
@@ -16533,6 +17278,7 @@
16533
17278
  "title": "Sensitive data type.",
16534
17279
  "x-f5xc-example": "EMAIL",
16535
17280
  "x-required": true,
17281
+ "x-f5xc-description-short": "X-displayName: \"Type\" The request is labeled as specified sensitive data type.",
16536
17282
  "minLength": 0,
16537
17283
  "maxLength": 1024,
16538
17284
  "x-f5xc-required-for": {
@@ -16543,6 +17289,8 @@
16543
17289
  }
16544
17290
  }
16545
17291
  },
17292
+ "x-f5xc-description-short": "X-displayName: \"Custom Sensitive Data Type\" The type/category of the sensitive data this rule detects.",
17293
+ "x-f5xc-description-medium": "X-displayName: \"Custom Sensitive Data Type\" The type/category of the sensitive data this rule detects. E.g. Email, Credit Card etc.",
16546
17294
  "x-f5xc-minimum-configuration": {
16547
17295
  "description": "Minimum configuration for app_typeCustomSensitiveDataType",
16548
17296
  "required_fields": [
@@ -16578,6 +17326,7 @@
16578
17326
  "ves.io.schema.rules.uint32.gte": "1",
16579
17327
  "ves.io.schema.rules.uint32.lte": "7"
16580
17328
  },
17329
+ "x-f5xc-description-short": "Inactive discovered API will be deleted after configured duration.",
16581
17330
  "minimum": 0,
16582
17331
  "maximum": 2147483647,
16583
17332
  "x-f5xc-required-for": {
@@ -16611,6 +17360,7 @@
16611
17360
  "description": "X-displayName: \"Exact Value\"\nSearch for values with exact match.",
16612
17361
  "title": "Exact value.",
16613
17362
  "x-f5xc-example": "x-volt-header",
17363
+ "x-f5xc-description-short": "X-displayName: \"Exact Value\" Search for values with exact match.",
16614
17364
  "minLength": 0,
16615
17365
  "maxLength": 1024,
16616
17366
  "x-f5xc-required-for": {
@@ -16625,6 +17375,7 @@
16625
17375
  "description": "X-displayName: \"Regex Value\"\nSearch for values matching this regular expression.",
16626
17376
  "title": "Regex value.",
16627
17377
  "x-f5xc-example": "'^new.*$', 'san f.*', '.* del .*'",
17378
+ "x-f5xc-description-short": "X-displayName: \"Regex Value\" Search for values matching this regular expression.",
16628
17379
  "minLength": 0,
16629
17380
  "maxLength": 1024,
16630
17381
  "x-f5xc-required-for": {
@@ -16635,6 +17386,7 @@
16635
17386
  }
16636
17387
  }
16637
17388
  },
17389
+ "x-f5xc-description-short": "X-displayName: \"Key Pattern\" Pattern to detect. Could be exact match or regex match.",
16638
17390
  "x-f5xc-minimum-configuration": {
16639
17391
  "description": "Minimum configuration for app_typeKeyPattern",
16640
17392
  "required_fields": [
@@ -16660,6 +17412,8 @@
16660
17412
  "$ref": "#/components/schemas/app_typeValuePattern"
16661
17413
  }
16662
17414
  },
17415
+ "x-f5xc-description-short": "X-displayName: \"Key & Value Pattern\" Search for specific key & value patterns in the specified sections.",
17416
+ "x-f5xc-description-medium": "X-displayName: \"Key & Value Pattern\" Search for specific key & value patterns in the specified sections.",
16663
17417
  "x-f5xc-minimum-configuration": {
16664
17418
  "description": "Minimum configuration for app_typeKeyValuePattern",
16665
17419
  "required_fields": [
@@ -16685,6 +17439,9 @@
16685
17439
  "items": {
16686
17440
  "$ref": "#/components/schemas/app_typeCustomSensitiveDataDetectionRule"
16687
17441
  },
17442
+ "x-f5xc-example": "{\"key\": \"value\"}",
17443
+ "x-f5xc-description-short": "X-displayName: \"Defined Custom Sensitive Data Types\" Rules to detect custom sensitive data in requests and/or responses sections.",
17444
+ "x-f5xc-description-medium": "X-displayName: \"Defined Custom Sensitive Data Types\" Rules to detect custom sensitive data in requests and/or responses sections.",
16688
17445
  "x-f5xc-required-for": {
16689
17446
  "minimum_config": false,
16690
17447
  "create": false,
@@ -16700,6 +17457,8 @@
16700
17457
  "$ref": "#/components/schemas/app_typeBuiltInSensitiveDataType"
16701
17458
  },
16702
17459
  "x-f5xc-example": "[EMAIL, CC]",
17460
+ "x-f5xc-description-short": "X-displayName: \"Disabled Built-In Sensitive Data Types\" List of disabled built-in sensitive data detection rules.",
17461
+ "x-f5xc-description-medium": "X-displayName: \"Disabled Built-In Sensitive Data Types\" List of disabled built-in sensitive data detection rules.",
16703
17462
  "x-f5xc-required-for": {
16704
17463
  "minimum_config": false,
16705
17464
  "create": false,
@@ -16708,6 +17467,8 @@
16708
17467
  }
16709
17468
  }
16710
17469
  },
17470
+ "x-f5xc-description-short": "X-displayName: \"Sensitive Data Detection Rules\" Rules to manage/configure sensitive data detection in requests and/or response sections.",
17471
+ "x-f5xc-description-medium": "X-displayName: \"Sensitive Data Detection Rules\" Rules to manage/configure sensitive data detection in requests and/or response sections.",
16711
17472
  "x-f5xc-minimum-configuration": {
16712
17473
  "description": "Minimum configuration for app_typeSensitiveDataDetectionRules",
16713
17474
  "required_fields": [
@@ -16731,6 +17492,7 @@
16731
17492
  "description": "X-displayName: \"Exact Value\"\nPattern value to be detected.",
16732
17493
  "title": "Exact value.",
16733
17494
  "x-f5xc-example": "x-volt-header",
17495
+ "x-f5xc-description-short": "X-displayName: \"Exact Value\" Pattern value to be detected.",
16734
17496
  "minLength": 0,
16735
17497
  "maxLength": 1024,
16736
17498
  "x-f5xc-required-for": {
@@ -16745,6 +17507,7 @@
16745
17507
  "description": "X-displayName: \"Regex Value\"\nRegular expression for this pattern.",
16746
17508
  "title": "Regex value.",
16747
17509
  "x-f5xc-example": "'^new.*$', 'san f.*', '.* del .*'",
17510
+ "x-f5xc-description-short": "X-displayName: \"Regex Value\" Regular expression for this pattern.",
16748
17511
  "minLength": 0,
16749
17512
  "maxLength": 1024,
16750
17513
  "x-f5xc-required-for": {
@@ -16755,6 +17518,7 @@
16755
17518
  }
16756
17519
  }
16757
17520
  },
17521
+ "x-f5xc-description-short": "X-displayName: \"Value Pattern\" Pattern to detect. Could be exact match or regex match.",
16758
17522
  "x-f5xc-minimum-configuration": {
16759
17523
  "description": "Minimum configuration for app_typeValuePattern",
16760
17524
  "required_fields": [
@@ -16781,6 +17545,7 @@
16781
17545
  "type": "string"
16782
17546
  },
16783
17547
  "x-displayname": "API Protection Configured.",
17548
+ "description": "API version or group",
16784
17549
  "x-f5xc-required-for": {
16785
17550
  "minimum_config": false,
16786
17551
  "create": false,
@@ -16795,6 +17560,8 @@
16795
17560
  "type": "string"
16796
17561
  },
16797
17562
  "x-displayname": "App Firewall Configured.",
17563
+ "description": "Configuration parameter for app firewall",
17564
+ "x-f5xc-description-short": "Configuration parameter for app firewall.",
16798
17565
  "x-f5xc-required-for": {
16799
17566
  "minimum_config": false,
16800
17567
  "create": false,
@@ -16809,6 +17576,8 @@
16809
17576
  "type": "string"
16810
17577
  },
16811
17578
  "x-displayname": "List of Load Balancers Where App Firewall is Configured Per Route.",
17579
+ "description": "Configuration parameter for app firewall per route",
17580
+ "x-f5xc-description-short": "Configuration parameter for app firewall per route.",
16812
17581
  "x-f5xc-required-for": {
16813
17582
  "minimum_config": false,
16814
17583
  "create": false,
@@ -16823,6 +17592,8 @@
16823
17592
  "type": "string"
16824
17593
  },
16825
17594
  "x-displayname": "Bot Defense Configured.",
17595
+ "description": "Configuration parameter for bot defense",
17596
+ "x-f5xc-description-short": "Configuration parameter for bot defense.",
16826
17597
  "x-f5xc-required-for": {
16827
17598
  "minimum_config": false,
16828
17599
  "create": false,
@@ -16837,6 +17608,8 @@
16837
17608
  "type": "string"
16838
17609
  },
16839
17610
  "x-displayname": "DDoS Detection Configured.",
17611
+ "description": "Configuration parameter for ddos detection",
17612
+ "x-f5xc-description-short": "Configuration parameter for ddos detection.",
16840
17613
  "x-f5xc-required-for": {
16841
17614
  "minimum_config": false,
16842
17615
  "create": false,
@@ -16851,6 +17624,8 @@
16851
17624
  "type": "string"
16852
17625
  },
16853
17626
  "x-displayname": "List of Load Balancers Secured.",
17627
+ "description": "Protection or security configuration",
17628
+ "x-f5xc-example": "{\"key\": \"value\"}",
16854
17629
  "x-f5xc-required-for": {
16855
17630
  "minimum_config": false,
16856
17631
  "create": false,
@@ -16920,6 +17695,7 @@
16920
17695
  "$ref": "#/components/schemas/ioschemaEmpty"
16921
17696
  }
16922
17697
  },
17698
+ "x-f5xc-description-short": "Settings for API specification (API definition, OpenAPI validation, etc.).",
16923
17699
  "x-f5xc-minimum-configuration": {
16924
17700
  "description": "Minimum configuration for common_wafAPISpecificationSettings",
16925
17701
  "required_fields": [
@@ -16960,6 +17736,7 @@
16960
17736
  "ves.io.schema.rules.message.required": "true",
16961
17737
  "ves.io.schema.rules.string.max_len": "256"
16962
17738
  },
17739
+ "x-f5xc-description-short": "Code repository which contain API endpoints Required: YES.",
16963
17740
  "x-f5xc-required-for": {
16964
17741
  "minimum_config": false,
16965
17742
  "create": false,
@@ -16968,6 +17745,7 @@
16968
17745
  }
16969
17746
  }
16970
17747
  },
17748
+ "x-f5xc-description-short": "Select which API repositories represent the LB applications.",
16971
17749
  "x-f5xc-minimum-configuration": {
16972
17750
  "description": "Minimum configuration for common_wafApiCodeRepos",
16973
17751
  "required_fields": [
@@ -17032,6 +17810,8 @@
17032
17810
  "ves.io.schema.rules.message.required": "true",
17033
17811
  "ves.io.schema.rules.repeated.max_items": "32"
17034
17812
  },
17813
+ "x-f5xc-description-short": "Enter domains and their credentials to allow authenticated API crawling.",
17814
+ "x-f5xc-description-medium": "Enter domains and their credentials to allow authenticated API crawling. You can only include domains you own that are associated with this Load Balancer. Required: YES.",
17035
17815
  "x-f5xc-required-for": {
17036
17816
  "minimum_config": false,
17037
17817
  "create": false,
@@ -17155,6 +17935,7 @@
17155
17935
  "$ref": "#/components/schemas/ioschemaEmpty"
17156
17936
  }
17157
17937
  },
17938
+ "x-f5xc-description-short": "Specifies the settings used for API discovery.",
17158
17939
  "x-f5xc-minimum-configuration": {
17159
17940
  "description": "Minimum configuration for common_wafApiDiscoverySetting",
17160
17941
  "required_fields": [
@@ -17307,6 +18088,7 @@
17307
18088
  "ves.io.schema.rules.repeated.max_items": "15",
17308
18089
  "ves.io.schema.rules.repeated.unique_metadata_name": "true"
17309
18090
  },
18091
+ "x-f5xc-example": "{\"key\": \"value\"}",
17310
18092
  "x-f5xc-required-for": {
17311
18093
  "minimum_config": false,
17312
18094
  "create": false,
@@ -17351,6 +18133,8 @@
17351
18133
  "ves.io.schema.rules.string.max_len": "256",
17352
18134
  "ves.io.schema.rules.string.vh_domain": "true"
17353
18135
  },
18136
+ "x-f5xc-example": "example.com",
18137
+ "x-f5xc-description-short": "Select the domain to execute API Crawling with given credentials. Required: YES.",
17354
18138
  "minLength": 0,
17355
18139
  "x-f5xc-required-for": {
17356
18140
  "minimum_config": false,
@@ -17361,7 +18145,7 @@
17361
18145
  "x-original-maxLength": 256,
17362
18146
  "format": "hostname",
17363
18147
  "x-reconciled-from-discovery": true,
17364
- "x-reconciled-at": "2026-01-05T14:39:09.681856+00:00"
18148
+ "x-reconciled-at": "2026-01-07T15:29:33.651416+00:00"
17365
18149
  },
17366
18150
  "simple_login": {
17367
18151
  "$ref": "#/components/schemas/common_wafSimpleLogin"
@@ -17415,6 +18199,7 @@
17415
18199
  "x-validation-rules": {
17416
18200
  "ves.io.schema.rules.string.max_len": "128"
17417
18201
  },
18202
+ "x-f5xc-description-short": "Exclusive with [api_endpoint base_path] The API group which this validation applies to.",
17418
18203
  "minLength": 0,
17419
18204
  "x-f5xc-required-for": {
17420
18205
  "minimum_config": false,
@@ -17439,6 +18224,7 @@
17439
18224
  "ves.io.schema.rules.string.http_path": "true",
17440
18225
  "ves.io.schema.rules.string.max_len": "128"
17441
18226
  },
18227
+ "x-f5xc-description-short": "Exclusive with [api_endpoint api_group] The base path which this validation applies to.",
17442
18228
  "minLength": 0,
17443
18229
  "x-f5xc-required-for": {
17444
18230
  "minimum_config": false,
@@ -17451,6 +18237,7 @@
17451
18237
  "$ref": "#/components/schemas/schemaMessageMetaType"
17452
18238
  }
17453
18239
  },
18240
+ "x-f5xc-description-short": "Fall Through Rule for a specific endpoint, base-path, or API group.",
17454
18241
  "x-f5xc-minimum-configuration": {
17455
18242
  "description": "Minimum configuration for common_wafFallThroughRule",
17456
18243
  "required_fields": [
@@ -17485,6 +18272,8 @@
17485
18272
  }
17486
18273
  },
17487
18274
  "x-required": true,
18275
+ "x-f5xc-description-short": "Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a.",
18276
+ "x-f5xc-description-medium": "Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. Swagger) or doesn't have a specific rule in custom rules).",
17488
18277
  "x-f5xc-minimum-configuration": {
17489
18278
  "description": "Minimum configuration for common_wafOpenApiFallThroughMode",
17490
18279
  "required_fields": [
@@ -17553,6 +18342,8 @@
17553
18342
  "$ref": "#/components/schemas/ioschemaEmpty"
17554
18343
  }
17555
18344
  },
18345
+ "x-f5xc-description-short": "OpenAPI specification validation settings relevant for \"API Inventory\" enforcement and for \"Custom list\" enforcement.",
18346
+ "x-f5xc-description-medium": "OpenAPI specification validation settings relevant for \"API Inventory\" enforcement and for \"Custom list\" enforcement.",
17556
18347
  "x-f5xc-minimum-configuration": {
17557
18348
  "description": "Minimum configuration for common_wafOpenApiValidationCommonSettings",
17558
18349
  "required_fields": [
@@ -17591,6 +18382,8 @@
17591
18382
  }
17592
18383
  },
17593
18384
  "x-required": true,
18385
+ "x-f5xc-description-short": "Validation mode of OpenAPI specification.",
18386
+ "x-f5xc-description-medium": "Validation mode of OpenAPI specification. When a validation mismatch occurs on a request to one of the endpoints listed on the OpenAPI specification file (a.k.a. Swagger).",
17594
18387
  "x-f5xc-minimum-configuration": {
17595
18388
  "description": "Minimum configuration for common_wafOpenApiValidationMode",
17596
18389
  "required_fields": [
@@ -17644,6 +18437,8 @@
17644
18437
  "ves.io.schema.rules.repeated.min_items": "1",
17645
18438
  "ves.io.schema.rules.repeated.unique": "true"
17646
18439
  },
18440
+ "x-f5xc-description-short": "List of properties of the request to validate according to the OpenAPI specification file (a.k.a.",
18441
+ "x-f5xc-description-medium": "List of properties of the request to validate according to the OpenAPI specification file (a.k.a. Swagger) Required: YES.",
17647
18442
  "x-f5xc-required-for": {
17648
18443
  "minimum_config": false,
17649
18444
  "create": false,
@@ -17704,6 +18499,8 @@
17704
18499
  "ves.io.schema.rules.repeated.min_items": "1",
17705
18500
  "ves.io.schema.rules.repeated.unique": "true"
17706
18501
  },
18502
+ "x-f5xc-description-short": "List of properties of the response to validate according to the OpenAPI specification file (a.k.a.",
18503
+ "x-f5xc-description-medium": "List of properties of the response to validate according to the OpenAPI specification file (a.k.a. Swagger) Required: YES.",
17707
18504
  "x-f5xc-required-for": {
17708
18505
  "minimum_config": false,
17709
18506
  "create": false,
@@ -17755,6 +18552,7 @@
17755
18552
  "x-validation-rules": {
17756
18553
  "ves.io.schema.rules.string.max_len": "128"
17757
18554
  },
18555
+ "x-f5xc-description-short": "Exclusive with [api_endpoint base_path] The API group which this validation applies to.",
17758
18556
  "minLength": 0,
17759
18557
  "x-f5xc-required-for": {
17760
18558
  "minimum_config": false,
@@ -17779,6 +18577,7 @@
17779
18577
  "ves.io.schema.rules.string.http_path": "true",
17780
18578
  "ves.io.schema.rules.string.max_len": "128"
17781
18579
  },
18580
+ "x-f5xc-description-short": "Exclusive with [api_endpoint api_group] The base path which this validation applies to.",
17782
18581
  "minLength": 0,
17783
18582
  "x-f5xc-required-for": {
17784
18583
  "minimum_config": false,
@@ -17804,6 +18603,7 @@
17804
18603
  "ves.io.schema.rules.string.max_len": "128",
17805
18604
  "ves.io.schema.rules.string.vh_domain": "true"
17806
18605
  },
18606
+ "x-f5xc-description-short": "Exclusive with [any_domain] The rule will apply for a specific domain.",
17807
18607
  "minLength": 0,
17808
18608
  "x-f5xc-required-for": {
17809
18609
  "minimum_config": false,
@@ -17816,6 +18616,7 @@
17816
18616
  "$ref": "#/components/schemas/common_wafOpenApiValidationMode"
17817
18617
  }
17818
18618
  },
18619
+ "x-f5xc-description-short": "OpenAPI Validation Rule for a specific endpoint, base-path, or API group.",
17819
18620
  "x-f5xc-minimum-configuration": {
17820
18621
  "description": "Minimum configuration for common_wafOpenApiValidationRule",
17821
18622
  "required_fields": [
@@ -17855,6 +18656,7 @@
17855
18656
  "x-validation-rules": {
17856
18657
  "ves.io.schema.rules.string.max_len": "64"
17857
18658
  },
18659
+ "x-f5xc-description-short": "Enter the username to assign credentials for the selected domain to crawl.",
17858
18660
  "minLength": 0,
17859
18661
  "x-f5xc-required-for": {
17860
18662
  "minimum_config": false,
@@ -17908,6 +18710,7 @@
17908
18710
  "ves.io.schema.rules.repeated.max_items": "15",
17909
18711
  "ves.io.schema.rules.repeated.unique_metadata_name": "true"
17910
18712
  },
18713
+ "x-f5xc-example": "{\"key\": \"value\"}",
17911
18714
  "x-f5xc-required-for": {
17912
18715
  "minimum_config": false,
17913
18716
  "create": false,
@@ -17919,6 +18722,8 @@
17919
18722
  "$ref": "#/components/schemas/common_wafOpenApiValidationCommonSettings"
17920
18723
  }
17921
18724
  },
18725
+ "x-f5xc-description-short": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.",
18726
+ "x-f5xc-description-medium": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes. Any other API-endpoint not listed will act according to \"Fall Through Mode\".",
17922
18727
  "x-f5xc-minimum-configuration": {
17923
18728
  "description": "Minimum configuration for common_wafValidateApiBySpecRule",
17924
18729
  "required_fields": [
@@ -17968,6 +18773,7 @@
17968
18773
  "$ref": "#/components/schemas/ioschemaEmpty"
17969
18774
  }
17970
18775
  },
18776
+ "x-f5xc-description-short": "X-displayName: \"Validation Settings For Headers\" Custom settings for headers validation.",
17971
18777
  "x-f5xc-minimum-configuration": {
17972
18778
  "description": "Minimum configuration for common_wafValidationSettingForHeaders",
17973
18779
  "required_fields": [
@@ -17996,6 +18802,7 @@
17996
18802
  "$ref": "#/components/schemas/ioschemaEmpty"
17997
18803
  }
17998
18804
  },
18805
+ "x-f5xc-description-short": "Custom settings for query parameters validation.",
17999
18806
  "x-f5xc-minimum-configuration": {
18000
18807
  "description": "Minimum configuration for common_wafValidationSettingForQueryParameters",
18001
18808
  "required_fields": [
@@ -18029,6 +18836,7 @@
18029
18836
  "default": "ANY",
18030
18837
  "x-displayname": "HTTP Method.",
18031
18838
  "x-ves-proto-enum": "ves.io.schema.HttpMethod",
18839
+ "x-f5xc-description-short": "Specifies the HTTP method used to access a resource. Any HTTP Method.",
18032
18840
  "x-f5xc-minimum-configuration": {
18033
18841
  "description": "Minimum configuration for schemaHttpMethod",
18034
18842
  "required_fields": [],
@@ -18052,6 +18860,8 @@
18052
18860
  "HTTP_SECTION_RSP_BODY"
18053
18861
  ],
18054
18862
  "default": "HTTP_SECTION_NONE",
18863
+ "x-f5xc-description-short": "X-displayName: \"HTTP Sections\" Request & Response Sections. - HTTP_SECTION_NONE: None ALL_SECTIONS x-displayName: \"None\" ...",
18864
+ "x-f5xc-description-medium": "X-displayName: \"HTTP Sections\" Request & Response Sections. - HTTP_SECTION_NONE: None ALL_SECTIONS x-displayName: \"None\" - HTTP_SECTION_QUERY_PARAMS: QUERY_PARAMS x-displayName: \"Request Query Params\" - HTTP_SECTION_REQ_HEADERS: REQ_HEADERS x-displayName: \"Request Headers\" ...",
18055
18865
  "x-f5xc-minimum-configuration": {
18056
18866
  "description": "Minimum configuration for schemaHttpSections",
18057
18867
  "required_fields": [],
@@ -18092,7 +18902,7 @@
18092
18902
  },
18093
18903
  "x-original-maxLength": 256,
18094
18904
  "x-reconciled-from-discovery": true,
18095
- "x-reconciled-at": "2026-01-05T14:39:09.682004+00:00"
18905
+ "x-reconciled-at": "2026-01-07T15:29:33.651569+00:00"
18096
18906
  },
18097
18907
  "name": {
18098
18908
  "type": "string",
@@ -18113,6 +18923,7 @@
18113
18923
  "ves.io.schema.rules.string.min_len": "1",
18114
18924
  "ves.io.schema.rules.string.ves_object_name": "true"
18115
18925
  },
18926
+ "x-f5xc-description-short": "Name of the message. The value of name has to follow DNS-1035 format.",
18116
18927
  "maxLength": 16,
18117
18928
  "x-f5xc-required-for": {
18118
18929
  "minimum_config": false,
@@ -18122,9 +18933,11 @@
18122
18933
  },
18123
18934
  "x-original-maxLength": 1024,
18124
18935
  "x-reconciled-from-discovery": true,
18125
- "x-reconciled-at": "2026-01-05T14:39:09.682009+00:00"
18936
+ "x-reconciled-at": "2026-01-07T15:29:33.651575+00:00"
18126
18937
  }
18127
18938
  },
18939
+ "x-f5xc-description-short": "MessageMetaType is metadata (common attributes) of a message that only certain messages have.",
18940
+ "x-f5xc-description-medium": "MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create...",
18128
18941
  "x-f5xc-minimum-configuration": {
18129
18942
  "description": "Minimum configuration for schemaMessageMetaType",
18130
18943
  "required_fields": [
@@ -18155,6 +18968,8 @@
18155
18968
  "default": "PROPERTY_QUERY_PARAMETERS",
18156
18969
  "x-displayname": "OpenAPI Validation Properties.",
18157
18970
  "x-ves-proto-enum": "ves.io.schema.OpenApiValidationProperties",
18971
+ "x-f5xc-description-short": "List of required properties to validate against the OpenAPI spec Validate that all query parameters are according to the OpenAPI specification...",
18972
+ "x-f5xc-description-medium": "List of required properties to validate against the OpenAPI spec Validate that all query parameters are according to the OpenAPI specification Validate that all path parameters are according to the OpenAPI specification Validate that the content type of the request is according to the OpenAPI...",
18158
18973
  "x-f5xc-minimum-configuration": {
18159
18974
  "description": "Minimum configuration for schemaOpenApiValidationProperties",
18160
18975
  "required_fields": [],
@@ -18177,6 +18992,8 @@
18177
18992
  "title": "Token",
18178
18993
  "format": "byte",
18179
18994
  "x-displayname": "Token",
18995
+ "description": "Authentication or access token",
18996
+ "x-f5xc-example": "[REDACTED_API_TOKEN]",
18180
18997
  "minLength": 0,
18181
18998
  "maxLength": 1024,
18182
18999
  "x-f5xc-required-for": {
@@ -18187,6 +19004,8 @@
18187
19004
  }
18188
19005
  }
18189
19006
  },
19007
+ "x-f5xc-description-short": "Response to the Generate Token Request token - a base64 encoding of AuthToken struct will be used in accesslog request header.",
19008
+ "x-f5xc-description-medium": "Response to the Generate Token Request token - a base64 encoding of AuthToken struct will be used in accesslog request header.",
18190
19009
  "x-f5xc-minimum-configuration": {
18191
19010
  "description": "Minimum configuration for third_party_applicationGenerateTokenResponse",
18192
19011
  "required_fields": [
@@ -18214,6 +19033,7 @@
18214
19033
  "$ref": "#/components/schemas/ioschemaObjectRefType"
18215
19034
  },
18216
19035
  "x-displayname": "Deleted Referred Objects.",
19036
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
18217
19037
  "x-f5xc-required-for": {
18218
19038
  "minimum_config": false,
18219
19039
  "create": false,
@@ -18229,6 +19049,7 @@
18229
19049
  "$ref": "#/components/schemas/ioschemaObjectRefType"
18230
19050
  },
18231
19051
  "x-displayname": "Disabled Referred Objects.",
19052
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
18232
19053
  "x-f5xc-required-for": {
18233
19054
  "minimum_config": false,
18234
19055
  "create": false,
@@ -18247,6 +19068,7 @@
18247
19068
  "$ref": "#/components/schemas/ioschemaObjectRefType"
18248
19069
  },
18249
19070
  "x-displayname": "Referring Objects.",
19071
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
18250
19072
  "x-f5xc-required-for": {
18251
19073
  "minimum_config": false,
18252
19074
  "create": false,
@@ -18268,6 +19090,8 @@
18268
19090
  "$ref": "#/components/schemas/third_party_applicationStatusObject"
18269
19091
  },
18270
19092
  "x-displayname": "Status",
19093
+ "x-f5xc-example": "active",
19094
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
18271
19095
  "x-f5xc-required-for": {
18272
19096
  "minimum_config": false,
18273
19097
  "create": false,
@@ -18277,7 +19101,7 @@
18277
19101
  "maxLength": 17,
18278
19102
  "minLength": 17,
18279
19103
  "x-reconciled-from-discovery": true,
18280
- "x-reconciled-at": "2026-01-05T14:39:09.682173+00:00"
19104
+ "x-reconciled-at": "2026-01-07T15:29:33.651740+00:00"
18281
19105
  },
18282
19106
  "system_metadata": {
18283
19107
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -18315,6 +19139,8 @@
18315
19139
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
18316
19140
  ],
18317
19141
  "default": "GET_RSP_FORMAT_DEFAULT",
19142
+ "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...",
19143
+ "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_REPLACE: x-displayName: \"Replace request format\" Response should...",
18318
19144
  "x-f5xc-minimum-configuration": {
18319
19145
  "description": "Minimum configuration for third_party_applicationGetResponseFormatCode",
18320
19146
  "required_fields": [],
@@ -18350,6 +19176,7 @@
18350
19176
  "x-validation-rules": {
18351
19177
  "ves.io.schema.rules.message.required": "true"
18352
19178
  },
19179
+ "x-f5xc-description-short": "Namespace of the Third Party Application for current request Required: YES.",
18353
19180
  "minLength": 0,
18354
19181
  "maxLength": 6,
18355
19182
  "x-f5xc-required-for": {
@@ -18360,12 +19187,13 @@
18360
19187
  },
18361
19188
  "x-original-maxLength": 1024,
18362
19189
  "x-reconciled-from-discovery": true,
18363
- "x-reconciled-at": "2026-01-05T14:39:09.682181+00:00"
19190
+ "x-reconciled-at": "2026-01-07T15:29:33.651747+00:00"
18364
19191
  },
18365
19192
  "third_party_applications_list": {
18366
19193
  "$ref": "#/components/schemas/third_party_applicationThirdPartyApplicationList"
18367
19194
  }
18368
19195
  },
19196
+ "x-f5xc-description-short": "Request of GET Security Config Spec API.",
18369
19197
  "x-f5xc-minimum-configuration": {
18370
19198
  "description": "Minimum configuration for third_party_applicationGetSecurityConfigReq",
18371
19199
  "required_fields": [
@@ -18395,6 +19223,7 @@
18395
19223
  "$ref": "#/components/schemas/schemaErrorType"
18396
19224
  },
18397
19225
  "x-displayname": "Errors",
19226
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
18398
19227
  "x-f5xc-required-for": {
18399
19228
  "minimum_config": false,
18400
19229
  "create": false,
@@ -18410,6 +19239,8 @@
18410
19239
  "$ref": "#/components/schemas/third_party_applicationListResponseItem"
18411
19240
  },
18412
19241
  "x-displayname": "Items",
19242
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
19243
+ "x-f5xc-description-short": "Items represents the collection in response.",
18413
19244
  "x-f5xc-required-for": {
18414
19245
  "minimum_config": false,
18415
19246
  "create": false,
@@ -18443,6 +19274,8 @@
18443
19274
  "description": "The set of annotations present on this third_party_application.",
18444
19275
  "title": "Annotations.",
18445
19276
  "x-displayname": "Annotations.",
19277
+ "x-f5xc-example": "{\"key\": \"value\"}",
19278
+ "x-f5xc-description-short": "The set of annotations present on this third_party_application.",
18446
19279
  "x-f5xc-required-for": {
18447
19280
  "minimum_config": false,
18448
19281
  "create": false,
@@ -18455,6 +19288,7 @@
18455
19288
  "description": "The description set for this third_party_application.",
18456
19289
  "title": "Description.",
18457
19290
  "x-displayname": "Description.",
19291
+ "x-f5xc-description-short": "The description set for this third_party_application.",
18458
19292
  "minLength": 0,
18459
19293
  "maxLength": 0,
18460
19294
  "x-f5xc-required-for": {
@@ -18465,7 +19299,7 @@
18465
19299
  },
18466
19300
  "x-original-maxLength": 1024,
18467
19301
  "x-reconciled-from-discovery": true,
18468
- "x-reconciled-at": "2026-01-05T14:39:09.682192+00:00"
19302
+ "x-reconciled-at": "2026-01-07T15:29:33.651759+00:00"
18469
19303
  },
18470
19304
  "disabled": {
18471
19305
  "type": "boolean",
@@ -18473,6 +19307,8 @@
18473
19307
  "title": "Disabled",
18474
19308
  "format": "boolean",
18475
19309
  "x-displayname": "Disabled",
19310
+ "x-f5xc-example": "True",
19311
+ "x-f5xc-description-short": "Value of true indicates third_party_application is administratively disabled.",
18476
19312
  "x-f5xc-required-for": {
18477
19313
  "minimum_config": false,
18478
19314
  "create": false,
@@ -18488,6 +19324,8 @@
18488
19324
  "description": "The set of labels present on this third_party_application.",
18489
19325
  "title": "Labels",
18490
19326
  "x-displayname": "Labels",
19327
+ "x-f5xc-example": "{\"key\": \"value\"}",
19328
+ "x-f5xc-description-short": "The set of labels present on this third_party_application.",
18491
19329
  "x-f5xc-required-for": {
18492
19330
  "minimum_config": false,
18493
19331
  "create": false,
@@ -18505,6 +19343,7 @@
18505
19343
  "x-displayname": "Name",
18506
19344
  "x-ves-example": "Name",
18507
19345
  "x-f5xc-example": "name",
19346
+ "x-f5xc-description-short": "The name of this third_party_application.",
18508
19347
  "minLength": 0,
18509
19348
  "maxLength": 16,
18510
19349
  "x-f5xc-required-for": {
@@ -18515,7 +19354,7 @@
18515
19354
  },
18516
19355
  "x-original-maxLength": 1024,
18517
19356
  "x-reconciled-from-discovery": true,
18518
- "x-reconciled-at": "2026-01-05T14:39:09.682202+00:00"
19357
+ "x-reconciled-at": "2026-01-07T15:29:33.651769+00:00"
18519
19358
  },
18520
19359
  "namespace": {
18521
19360
  "type": "string",
@@ -18534,7 +19373,7 @@
18534
19373
  },
18535
19374
  "x-original-maxLength": 1024,
18536
19375
  "x-reconciled-from-discovery": true,
18537
- "x-reconciled-at": "2026-01-05T14:39:09.682206+00:00"
19376
+ "x-reconciled-at": "2026-01-07T15:29:33.651773+00:00"
18538
19377
  },
18539
19378
  "owner_view": {
18540
19379
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -18547,6 +19386,7 @@
18547
19386
  "$ref": "#/components/schemas/third_party_applicationStatusObject"
18548
19387
  },
18549
19388
  "x-displayname": "Status",
19389
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
18550
19390
  "x-f5xc-required-for": {
18551
19391
  "minimum_config": false,
18552
19392
  "create": false,
@@ -18575,7 +19415,7 @@
18575
19415
  "x-field-mutability": "read-only",
18576
19416
  "x-original-maxLength": 1024,
18577
19417
  "x-reconciled-from-discovery": true,
18578
- "x-reconciled-at": "2026-01-05T14:39:09.682214+00:00"
19418
+ "x-reconciled-at": "2026-01-07T15:29:33.651781+00:00"
18579
19419
  },
18580
19420
  "uid": {
18581
19421
  "type": "string",
@@ -18584,6 +19424,7 @@
18584
19424
  "x-displayname": "UID",
18585
19425
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
18586
19426
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
19427
+ "x-f5xc-description-short": "The unique uid of this third_party_application.",
18587
19428
  "minLength": 0,
18588
19429
  "maxLength": 36,
18589
19430
  "x-f5xc-required-for": {
@@ -18596,9 +19437,11 @@
18596
19437
  "x-original-maxLength": 1024,
18597
19438
  "format": "uuid",
18598
19439
  "x-reconciled-from-discovery": true,
18599
- "x-reconciled-at": "2026-01-05T14:39:09.682219+00:00"
19440
+ "x-reconciled-at": "2026-01-07T15:29:33.651786+00:00"
18600
19441
  }
18601
19442
  },
19443
+ "x-f5xc-description-short": "By default a summary of third_party_application is returned in 'List'.",
19444
+ "x-f5xc-description-medium": "By default a summary of third_party_application is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
18602
19445
  "x-f5xc-minimum-configuration": {
18603
19446
  "description": "Minimum configuration for third_party_applicationListResponseItem",
18604
19447
  "required_fields": [
@@ -18678,6 +19521,7 @@
18678
19521
  "$ref": "#/components/schemas/schemaConditionType"
18679
19522
  },
18680
19523
  "x-displayname": "Conditions.",
19524
+ "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.",
18681
19525
  "x-f5xc-required-for": {
18682
19526
  "minimum_config": false,
18683
19527
  "create": false,
@@ -18696,6 +19540,7 @@
18696
19540
  "$ref": "#/components/schemas/ioschemaObjectRefType"
18697
19541
  },
18698
19542
  "x-displayname": "Config Object.",
19543
+ "x-f5xc-description-short": "Third Party Application virtual_server view object direct reference.",
18699
19544
  "x-f5xc-required-for": {
18700
19545
  "minimum_config": false,
18701
19546
  "create": false,
@@ -18704,6 +19549,7 @@
18704
19549
  }
18705
19550
  }
18706
19551
  },
19552
+ "x-f5xc-description-short": "Most recently observed status of object.",
18707
19553
  "x-f5xc-minimum-configuration": {
18708
19554
  "description": "Minimum configuration for third_party_applicationStatusObject",
18709
19555
  "required_fields": [
@@ -18805,6 +19651,7 @@
18805
19651
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
18806
19652
  }
18807
19653
  },
19654
+ "x-f5xc-description-short": "Shape of the Third Party Application specification.",
18808
19655
  "x-f5xc-minimum-configuration": {
18809
19656
  "description": "Minimum configuration for viewsthird_party_applicationGetSpecType",
18810
19657
  "required_fields": [
@@ -18855,6 +19702,7 @@
18855
19702
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
18856
19703
  }
18857
19704
  },
19705
+ "x-f5xc-description-short": "Shape of the Third Party Application specification.",
18858
19706
  "x-f5xc-minimum-configuration": {
18859
19707
  "description": "Minimum configuration for viewsthird_party_applicationReplaceSpecType",
18860
19708
  "required_fields": [
@@ -18882,6 +19730,7 @@
18882
19730
  "type": "object",
18883
19731
  "description": "X-displayName: \"Allocated Numbers\"\nAllocated Numbers.",
18884
19732
  "title": "AllocatedNumbers.",
19733
+ "x-f5xc-description-short": "X-displayName: \"Allocated Numbers\" Allocated Numbers.",
18885
19734
  "x-f5xc-required-for": {
18886
19735
  "minimum_config": false,
18887
19736
  "create": false,
@@ -18890,6 +19739,7 @@
18890
19739
  }
18891
19740
  }
18892
19741
  },
19742
+ "x-f5xc-description-short": "X-displayName: \"Allocated Numbers\" Allocated Numbers.",
18893
19743
  "x-f5xc-minimum-configuration": {
18894
19744
  "description": "Minimum configuration for view_internalAllocatedNumbers",
18895
19745
  "required_fields": [
@@ -18937,6 +19787,7 @@
18937
19787
  "description": "Allocation Map keeps track of all allocations for this view. The key is the allocator name.",
18938
19788
  "title": "Allocation Map.",
18939
19789
  "x-displayname": "Allocation Map.",
19790
+ "x-f5xc-description-short": "Allocation Map keeps track of all allocations for this view. The key is the allocator name.",
18940
19791
  "x-f5xc-required-for": {
18941
19792
  "minimum_config": false,
18942
19793
  "create": false,
@@ -18963,6 +19814,7 @@
18963
19814
  "$ref": "#/components/schemas/schemaViewRefType"
18964
19815
  }
18965
19816
  },
19817
+ "x-f5xc-description-short": "Shape of the view internal specification.",
18966
19818
  "x-f5xc-minimum-configuration": {
18967
19819
  "description": "Minimum configuration for view_internalGlobalSpecType",
18968
19820
  "required_fields": [
@@ -19052,6 +19904,8 @@
19052
19904
  "title": "Modification_timestamp.",
19053
19905
  "format": "date-time",
19054
19906
  "x-displayname": "Modification Timestamp.",
19907
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
19908
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
19055
19909
  "minLength": 0,
19056
19910
  "maxLength": 1024,
19057
19911
  "x-f5xc-required-for": {
@@ -19085,6 +19939,7 @@
19085
19939
  "x-displayname": "Terraform Output.",
19086
19940
  "x-ves-example": "Value",
19087
19941
  "x-f5xc-example": "value",
19942
+ "x-f5xc-description-short": "The value of an \"output\" variable from the terraform state file.",
19088
19943
  "minLength": 0,
19089
19944
  "maxLength": 1024,
19090
19945
  "x-f5xc-required-for": {
@@ -19165,6 +20020,7 @@
19165
20020
  "x-displayname": "Namespace",
19166
20021
  "x-ves-example": "Value",
19167
20022
  "x-f5xc-example": "value",
20023
+ "x-f5xc-description-short": "Namespace for the label to be retrieved.",
19168
20024
  "minLength": 0,
19169
20025
  "maxLength": 6,
19170
20026
  "x-f5xc-required-for": {
@@ -19175,7 +20031,7 @@
19175
20031
  },
19176
20032
  "x-original-maxLength": 1024,
19177
20033
  "x-reconciled-from-discovery": true,
19178
- "x-reconciled-at": "2026-01-05T14:39:16.010674+00:00"
20034
+ "x-reconciled-at": "2026-01-07T15:29:40.853839+00:00"
19179
20035
  },
19180
20036
  "view_kind": {
19181
20037
  "type": "string",
@@ -19184,6 +20040,7 @@
19184
20040
  "x-displayname": "Kind of View.",
19185
20041
  "x-ves-example": "Value",
19186
20042
  "x-f5xc-example": "value",
20043
+ "x-f5xc-description-short": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
19187
20044
  "minLength": 0,
19188
20045
  "maxLength": 1024,
19189
20046
  "x-f5xc-required-for": {
@@ -19200,6 +20057,7 @@
19200
20057
  "x-displayname": "Name of view.",
19201
20058
  "x-ves-example": "Value",
19202
20059
  "x-f5xc-example": "value",
20060
+ "x-f5xc-description-short": "Name of the view for which terraform parameters are requested.",
19203
20061
  "minLength": 0,
19204
20062
  "maxLength": 1024,
19205
20063
  "x-f5xc-required-for": {
@@ -19364,6 +20222,8 @@
19364
20222
  "title": "Modification_timestamp.",
19365
20223
  "format": "date-time",
19366
20224
  "x-displayname": "Modification Timestamp.",
20225
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
20226
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
19367
20227
  "minLength": 0,
19368
20228
  "maxLength": 1024,
19369
20229
  "x-f5xc-required-for": {
@@ -19400,6 +20260,7 @@
19400
20260
  "x-displayname": "Terraform Plan Output.",
19401
20261
  "x-ves-example": "Value",
19402
20262
  "x-f5xc-example": "value",
20263
+ "x-f5xc-description-medium": "Terraform \"plan\" command output. Terraform performs a refresh, unless explicitly disabled, and then determines what actions are necessary to achieve the desired state specified in the configuration files.",
19403
20264
  "minLength": 0,
19404
20265
  "maxLength": 1024,
19405
20266
  "x-f5xc-required-for": {
@@ -19458,6 +20319,8 @@
19458
20319
  "default": "APPLY",
19459
20320
  "x-displayname": "Terraform action to be performed.",
19460
20321
  "x-ves-proto-enum": "ves.io.schema.views.terraform_parameters.RunAction",
20322
+ "x-f5xc-description-short": "Terraform action to be performed for a given view e.g.",
20323
+ "x-f5xc-description-medium": "Terraform action to be performed for a given view e.g. Plan, apply Apply action used to apply the changes required to reach the desired state of the configuration Plan action is a convenient way to check whether the execution plan for a set of changes matches your expectations without making any...",
19461
20324
  "x-f5xc-minimum-configuration": {
19462
20325
  "description": "Minimum configuration for terraform_parametersRunAction",
19463
20326
  "required_fields": [],
@@ -19485,6 +20348,7 @@
19485
20348
  "x-displayname": "Namespace",
19486
20349
  "x-ves-example": "Value",
19487
20350
  "x-f5xc-example": "value",
20351
+ "x-f5xc-description-short": "Namespace for the label to be retrieved.",
19488
20352
  "minLength": 0,
19489
20353
  "maxLength": 6,
19490
20354
  "x-f5xc-required-for": {
@@ -19495,7 +20359,7 @@
19495
20359
  },
19496
20360
  "x-original-maxLength": 1024,
19497
20361
  "x-reconciled-from-discovery": true,
19498
- "x-reconciled-at": "2026-01-05T14:39:16.010697+00:00"
20362
+ "x-reconciled-at": "2026-01-07T15:29:40.853860+00:00"
19499
20363
  },
19500
20364
  "view_kind": {
19501
20365
  "type": "string",
@@ -19504,6 +20368,7 @@
19504
20368
  "x-displayname": "Kind of View.",
19505
20369
  "x-ves-example": "Value",
19506
20370
  "x-f5xc-example": "value",
20371
+ "x-f5xc-description-short": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
19507
20372
  "minLength": 0,
19508
20373
  "maxLength": 1024,
19509
20374
  "x-f5xc-required-for": {
@@ -19520,6 +20385,7 @@
19520
20385
  "x-displayname": "Name of view.",
19521
20386
  "x-ves-example": "Value",
19522
20387
  "x-f5xc-example": "value",
20388
+ "x-f5xc-description-short": "Name of the view for which terraform parameters are requested.",
19523
20389
  "minLength": 0,
19524
20390
  "maxLength": 1024,
19525
20391
  "x-f5xc-required-for": {
@@ -19530,6 +20396,7 @@
19530
20396
  }
19531
20397
  }
19532
20398
  },
20399
+ "x-f5xc-description-short": "Perform terraform actions for a given view. Supported actions are apply and plan.",
19533
20400
  "x-f5xc-minimum-configuration": {
19534
20401
  "description": "Minimum configuration for terraform_parametersRunRequest",
19535
20402
  "required_fields": [
@@ -19579,6 +20446,7 @@
19579
20446
  "$ref": "#/components/schemas/schemaConditionType"
19580
20447
  },
19581
20448
  "x-displayname": "Conditions.",
20449
+ "x-f5xc-description-short": "Conditions reported by various components of the system.",
19582
20450
  "x-f5xc-required-for": {
19583
20451
  "minimum_config": false,
19584
20452
  "create": false,
@@ -19597,6 +20465,7 @@
19597
20465
  "$ref": "#/components/schemas/ioschemaObjectRefType"
19598
20466
  },
19599
20467
  "x-displayname": "Config Object.",
20468
+ "x-f5xc-description-short": "View terraform parameters object reference for which this status object is generated.",
19600
20469
  "x-f5xc-required-for": {
19601
20470
  "minimum_config": false,
19602
20471
  "create": false,
@@ -19608,6 +20477,7 @@
19608
20477
  "$ref": "#/components/schemas/terraform_parametersPlanStatus"
19609
20478
  }
19610
20479
  },
20480
+ "x-f5xc-description-short": "View terraform parameters status object.",
19611
20481
  "x-f5xc-minimum-configuration": {
19612
20482
  "description": "Minimum configuration for terraform_parametersStatusObject",
19613
20483
  "required_fields": [
@@ -19634,6 +20504,8 @@
19634
20504
  "UPGRADE_NOT_REQUIRED"
19635
20505
  ],
19636
20506
  "default": "UPGRADE_SUCCESSFUL",
20507
+ "x-f5xc-description-short": "X-displayName: \"Upgrade State\" Terraform State after version Upgrade - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\" - UPGRADE_ERRORED...",
20508
+ "x-f5xc-description-medium": "X-displayName: \"Upgrade State\" Terraform State after version Upgrade - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\" - UPGRADE_ERRORED: x-displayName: \"Upgrade errored\" - UPGRADE_NOT_REQUIRED: x-displayName: \"Upgrade not required\".",
19637
20509
  "x-f5xc-minimum-configuration": {
19638
20510
  "description": "Minimum configuration for terraform_parametersUpgradeState",
19639
20511
  "required_fields": [],
@@ -19656,6 +20528,7 @@
19656
20528
  "description": "Container Version used to run the terrafrom.",
19657
20529
  "title": "Container Version.",
19658
20530
  "x-displayname": "Container Version.",
20531
+ "x-f5xc-description-short": "Container Version used to run the terrafrom.",
19659
20532
  "minLength": 0,
19660
20533
  "maxLength": 1024,
19661
20534
  "x-f5xc-required-for": {
@@ -19673,6 +20546,7 @@
19673
20546
  "$ref": "#/components/schemas/ioschemaObjectRefType"
19674
20547
  },
19675
20548
  "x-displayname": "Cloud Credentials.",
20549
+ "x-f5xc-description-short": "Reference to cloud credentials used in the terraform.",
19676
20550
  "x-f5xc-required-for": {
19677
20551
  "minimum_config": false,
19678
20552
  "create": false,
@@ -19696,6 +20570,7 @@
19696
20570
  }
19697
20571
  }
19698
20572
  },
20573
+ "x-f5xc-description-short": "Shape of the view terraform parameters specification.",
19699
20574
  "x-f5xc-minimum-configuration": {
19700
20575
  "description": "Minimum configuration for viewsterraform_parametersGlobalSpecType",
19701
20576
  "required_fields": [
@@ -19724,6 +20599,7 @@
19724
20599
  "x-displayname": "Console URL.",
19725
20600
  "x-ves-example": "Console_url: https://console.ves.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioio/login/start.",
19726
20601
  "x-f5xc-example": "console_urlhttps://console.ves.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioioioio/login/start",
20602
+ "x-f5xc-description-short": "URL to the console page, returned if the tenant is already signed up and active.",
19727
20603
  "minLength": 0,
19728
20604
  "maxLength": 1024,
19729
20605
  "x-f5xc-required-for": {
@@ -19738,6 +20614,8 @@
19738
20614
  "description": "The domain associated with the registered ASB message.",
19739
20615
  "title": "Domain",
19740
20616
  "x-displayname": "Domain",
20617
+ "x-f5xc-example": "example.com",
20618
+ "x-f5xc-description-short": "The domain associated with the registered ASB message.",
19741
20619
  "minLength": 0,
19742
20620
  "maxLength": 26,
19743
20621
  "x-f5xc-required-for": {
@@ -19749,7 +20627,7 @@
19749
20627
  "x-original-maxLength": 1024,
19750
20628
  "format": "hostname",
19751
20629
  "x-reconciled-from-discovery": true,
19752
- "x-reconciled-at": "2026-01-05T14:39:21.566334+00:00"
20630
+ "x-reconciled-at": "2026-01-07T15:29:47.117383+00:00"
19753
20631
  },
19754
20632
  "email": {
19755
20633
  "type": "string",
@@ -19757,6 +20635,7 @@
19757
20635
  "title": "Email",
19758
20636
  "x-displayname": "Email",
19759
20637
  "x-f5xc-example": "user@example.com",
20638
+ "x-f5xc-description-short": "The email associated with the registered ASB message.",
19760
20639
  "format": "email",
19761
20640
  "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
19762
20641
  "minLength": 0,
@@ -19775,6 +20654,7 @@
19775
20654
  "x-displayname": "Error Message.",
19776
20655
  "x-ves-example": "Error_message\": \"Your account is already active. Please log in to continue.",
19777
20656
  "x-f5xc-example": "\"error_message\"\"Your account is already active. Please log in to continue.\"",
20657
+ "x-f5xc-description-short": "Error message providing additional details (e.g., tenant already signed up).",
19778
20658
  "minLength": 0,
19779
20659
  "maxLength": 1024,
19780
20660
  "x-f5xc-required-for": {
@@ -19785,6 +20665,7 @@
19785
20665
  }
19786
20666
  }
19787
20667
  },
20668
+ "x-f5xc-description-short": "Response format for returning registration details associated with the ASB message.",
19788
20669
  "x-f5xc-minimum-configuration": {
19789
20670
  "description": "Minimum configuration for xc_saasGetRegistrationDetailsResponse",
19790
20671
  "required_fields": [
@@ -19812,6 +20693,7 @@
19812
20693
  "description": "Message provides additional context regarding the result of the email send operation.",
19813
20694
  "title": "Message",
19814
20695
  "x-displayname": "Message",
20696
+ "x-f5xc-description-short": "Message provides additional context regarding the result of the email send operation.",
19815
20697
  "minLength": 0,
19816
20698
  "maxLength": 1024,
19817
20699
  "x-f5xc-required-for": {
@@ -19827,6 +20709,7 @@
19827
20709
  "title": "Success",
19828
20710
  "format": "boolean",
19829
20711
  "x-displayname": "Success",
20712
+ "x-f5xc-description-short": "Indicates if the email was sent successfully.",
19830
20713
  "x-f5xc-required-for": {
19831
20714
  "minimum_config": false,
19832
20715
  "create": false,
@@ -19835,6 +20718,7 @@
19835
20718
  }
19836
20719
  }
19837
20720
  },
20721
+ "x-f5xc-description-short": "Response to indicate if the email was sent successfully.",
19838
20722
  "x-f5xc-minimum-configuration": {
19839
20723
  "description": "Minimum configuration for xc_saasSendEmailResponse",
19840
20724
  "required_fields": [
@@ -19862,6 +20746,7 @@
19862
20746
  "x-displayname": "Token",
19863
20747
  "x-ves-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7.",
19864
20748
  "x-f5xc-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7",
20749
+ "x-f5xc-description-short": "The token contains the encrypted data, secured using an HMAC key.",
19865
20750
  "minLength": 0,
19866
20751
  "maxLength": 1024,
19867
20752
  "x-f5xc-required-for": {
@@ -19872,6 +20757,7 @@
19872
20757
  }
19873
20758
  }
19874
20759
  },
20760
+ "x-f5xc-description-short": "The request message for SendSignupEmail.",
19875
20761
  "x-f5xc-minimum-configuration": {
19876
20762
  "description": "Minimum configuration for xc_saasSendSignupEmailRequest",
19877
20763
  "required_fields": [
@@ -19909,6 +20795,8 @@
19909
20795
  "ves.io.schema.rules.string.not_in": "[\\\"ves\\\",\\\"F5 Distributed Cloud\\\",\\\"f5\\\"]",
19910
20796
  "ves.io.schema.rules.string.ves_object_name": "true"
19911
20797
  },
20798
+ "x-f5xc-example": "example.com",
20799
+ "x-f5xc-description-short": "The domain associated with the tenant/account.",
19912
20800
  "x-f5xc-required-for": {
19913
20801
  "minimum_config": false,
19914
20802
  "create": false,
@@ -19917,7 +20805,7 @@
19917
20805
  },
19918
20806
  "format": "hostname",
19919
20807
  "x-reconciled-from-discovery": true,
19920
- "x-reconciled-at": "2026-01-05T14:39:21.566351+00:00"
20808
+ "x-reconciled-at": "2026-01-07T15:29:47.117401+00:00"
19921
20809
  },
19922
20810
  "token": {
19923
20811
  "type": "string",
@@ -19925,6 +20813,7 @@
19925
20813
  "title": "Token",
19926
20814
  "x-displayname": "Token",
19927
20815
  "x-f5xc-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7",
20816
+ "x-f5xc-description-short": "The token contains the encrypted data, secured using an HMAC key.",
19928
20817
  "minLength": 0,
19929
20818
  "maxLength": 1024,
19930
20819
  "x-f5xc-required-for": {