@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": "Data And Privacy Security",
5
5
  "description": "Pattern-based detection for personally identifiable information across request and response payloads. Custom data type definitions enable organization-specific classification beyond built-in PII categories. Regional log and metrics aggregation with Clickhouse, Elasticsearch, and Kafka export options. Geo-configuration policies enforce data residency requirements and jurisdiction-specific privacy regulations.",
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": "Sensitive data policies with custom classification rules. LMA region configuration and geo-based compliance controls.",
16
- "x-f5xc-cli-domain": "data_and_privacy_security"
16
+ "x-f5xc-cli-domain": "data_and_privacy_security",
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
  {
@@ -276,6 +326,13 @@
276
326
  "latency": "low",
277
327
  "resource_usage": "low"
278
328
  }
329
+ },
330
+ "x-f5xc-discovered-response-time": {
331
+ "p50_ms": 1000,
332
+ "p95_ms": 3000,
333
+ "p99_ms": 8000,
334
+ "sample_count": 0,
335
+ "source": "estimate"
279
336
  }
280
337
  },
281
338
  "x-displayname": "Data Type",
@@ -498,6 +555,13 @@
498
555
  "latency": "low",
499
556
  "resource_usage": "low"
500
557
  }
558
+ },
559
+ "x-f5xc-discovered-response-time": {
560
+ "p50_ms": 800,
561
+ "p95_ms": 2500,
562
+ "p99_ms": 6000,
563
+ "sample_count": 0,
564
+ "source": "estimate"
501
565
  }
502
566
  },
503
567
  "x-displayname": "Data Type",
@@ -725,6 +789,13 @@
725
789
  "latency": "moderate",
726
790
  "resource_usage": "moderate"
727
791
  }
792
+ },
793
+ "x-f5xc-discovered-response-time": {
794
+ "p50_ms": 200,
795
+ "p95_ms": 800,
796
+ "p99_ms": 2000,
797
+ "sample_count": 0,
798
+ "source": "estimate"
728
799
  }
729
800
  },
730
801
  "x-displayname": "Data Type",
@@ -946,6 +1017,13 @@
946
1017
  "latency": "low",
947
1018
  "resource_usage": "low"
948
1019
  }
1020
+ },
1021
+ "x-f5xc-discovered-response-time": {
1022
+ "p50_ms": 200,
1023
+ "p95_ms": 800,
1024
+ "p99_ms": 2000,
1025
+ "sample_count": 0,
1026
+ "source": "estimate"
949
1027
  }
950
1028
  },
951
1029
  "delete": {
@@ -1165,6 +1243,13 @@
1165
1243
  "latency": "high",
1166
1244
  "resource_usage": "moderate"
1167
1245
  }
1246
+ },
1247
+ "x-f5xc-discovered-response-time": {
1248
+ "p50_ms": 500,
1249
+ "p95_ms": 1500,
1250
+ "p99_ms": 4000,
1251
+ "sample_count": 0,
1252
+ "source": "estimate"
1168
1253
  }
1169
1254
  },
1170
1255
  "x-displayname": "Data Type",
@@ -1384,6 +1469,13 @@
1384
1469
  "latency": "low",
1385
1470
  "resource_usage": "low"
1386
1471
  }
1472
+ },
1473
+ "x-f5xc-discovered-response-time": {
1474
+ "p50_ms": 200,
1475
+ "p95_ms": 800,
1476
+ "p99_ms": 2000,
1477
+ "sample_count": 0,
1478
+ "source": "estimate"
1387
1479
  }
1388
1480
  },
1389
1481
  "x-displayname": "Geo Config.",
@@ -1611,6 +1703,13 @@
1611
1703
  "latency": "moderate",
1612
1704
  "resource_usage": "moderate"
1613
1705
  }
1706
+ },
1707
+ "x-f5xc-discovered-response-time": {
1708
+ "p50_ms": 200,
1709
+ "p95_ms": 800,
1710
+ "p99_ms": 2000,
1711
+ "sample_count": 0,
1712
+ "source": "estimate"
1614
1713
  }
1615
1714
  },
1616
1715
  "x-displayname": "LMA Region.",
@@ -1830,6 +1929,13 @@
1830
1929
  "latency": "low",
1831
1930
  "resource_usage": "low"
1832
1931
  }
1932
+ },
1933
+ "x-f5xc-discovered-response-time": {
1934
+ "p50_ms": 200,
1935
+ "p95_ms": 800,
1936
+ "p99_ms": 2000,
1937
+ "sample_count": 0,
1938
+ "source": "estimate"
1833
1939
  }
1834
1940
  },
1835
1941
  "x-displayname": "LMA Region.",
@@ -2045,6 +2151,13 @@
2045
2151
  "latency": "low",
2046
2152
  "resource_usage": "low"
2047
2153
  }
2154
+ },
2155
+ "x-f5xc-discovered-response-time": {
2156
+ "p50_ms": 1000,
2157
+ "p95_ms": 3000,
2158
+ "p99_ms": 8000,
2159
+ "sample_count": 0,
2160
+ "source": "estimate"
2048
2161
  }
2049
2162
  },
2050
2163
  "x-displayname": "Sensitive Data Discovery.",
@@ -2268,6 +2381,13 @@
2268
2381
  "latency": "low",
2269
2382
  "resource_usage": "low"
2270
2383
  }
2384
+ },
2385
+ "x-f5xc-discovered-response-time": {
2386
+ "p50_ms": 800,
2387
+ "p95_ms": 2500,
2388
+ "p99_ms": 6000,
2389
+ "sample_count": 0,
2390
+ "source": "estimate"
2271
2391
  }
2272
2392
  },
2273
2393
  "x-displayname": "Sensitive Data Discovery.",
@@ -2498,7 +2618,15 @@
2498
2618
  }
2499
2619
  },
2500
2620
  "x-discovered-response-time-ms": 159.77,
2501
- "x-discovered-sample-size": 1
2621
+ "x-discovered-sample-size": 1,
2622
+ "x-f5xc-discovered-response-time": {
2623
+ "p50_ms": 159.77,
2624
+ "p95_ms": 319.54,
2625
+ "p99_ms": 479.31,
2626
+ "sample_count": 1,
2627
+ "source": "discovery",
2628
+ "last_measured": "2025-12-20T19:39:20.211392+00:00"
2629
+ }
2502
2630
  },
2503
2631
  "x-displayname": "Sensitive Data Discovery.",
2504
2632
  "x-ves-proto-service": "ves.io.schema.sensitive_data_policy.API",
@@ -2720,6 +2848,13 @@
2720
2848
  "latency": "low",
2721
2849
  "resource_usage": "low"
2722
2850
  }
2851
+ },
2852
+ "x-f5xc-discovered-response-time": {
2853
+ "p50_ms": 200,
2854
+ "p95_ms": 800,
2855
+ "p99_ms": 2000,
2856
+ "sample_count": 0,
2857
+ "source": "estimate"
2723
2858
  }
2724
2859
  },
2725
2860
  "delete": {
@@ -2940,6 +3075,13 @@
2940
3075
  "latency": "high",
2941
3076
  "resource_usage": "moderate"
2942
3077
  }
3078
+ },
3079
+ "x-f5xc-discovered-response-time": {
3080
+ "p50_ms": 500,
3081
+ "p95_ms": 1500,
3082
+ "p99_ms": 4000,
3083
+ "sample_count": 0,
3084
+ "source": "estimate"
2943
3085
  }
2944
3086
  },
2945
3087
  "x-displayname": "Sensitive Data Discovery.",
@@ -3075,6 +3217,8 @@
3075
3217
  "ves.io.schema.rules.repeated.max_items": "17",
3076
3218
  "ves.io.schema.rules.repeated.unique": "true"
3077
3219
  },
3220
+ "x-f5xc-description-short": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints...",
3221
+ "x-f5xc-description-medium": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach.",
3078
3222
  "x-f5xc-required-for": {
3079
3223
  "minimum_config": false,
3080
3224
  "create": false,
@@ -3087,6 +3231,7 @@
3087
3231
  "description": "Select this option to classify the custom data type as personally identifiable information (PII)",
3088
3232
  "format": "boolean",
3089
3233
  "x-displayname": "Mark as PII.",
3234
+ "x-f5xc-description-short": "Select this option to classify the custom data type as personally identifiable information (PII).",
3090
3235
  "x-f5xc-required-for": {
3091
3236
  "minimum_config": false,
3092
3237
  "create": false,
@@ -3099,6 +3244,9 @@
3099
3244
  "description": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
3100
3245
  "format": "boolean",
3101
3246
  "x-displayname": "Mark as Sensitive Data.",
3247
+ "x-f5xc-example": "{\"key\": \"value\"}",
3248
+ "x-f5xc-description-short": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
3249
+ "x-f5xc-description-medium": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
3102
3250
  "x-f5xc-required-for": {
3103
3251
  "minimum_config": false,
3104
3252
  "create": false,
@@ -3130,6 +3278,8 @@
3130
3278
  "ves.io.schema.rules.repeated.min_items": "1",
3131
3279
  "ves.io.schema.rules.repeated.unique": "true"
3132
3280
  },
3281
+ "x-f5xc-description-short": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
3282
+ "x-f5xc-description-medium": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
3133
3283
  "x-f5xc-required-for": {
3134
3284
  "minimum_config": false,
3135
3285
  "create": false,
@@ -3138,6 +3288,7 @@
3138
3288
  }
3139
3289
  }
3140
3290
  },
3291
+ "x-f5xc-description-short": "Create data_type creates a new object in the storage backend for metadata.namespace.",
3141
3292
  "x-f5xc-minimum-configuration": {
3142
3293
  "description": "Minimum configuration for data_typeCreateSpecType",
3143
3294
  "required_fields": [
@@ -3166,6 +3317,7 @@
3166
3317
  "title": "Fail_if_referred.",
3167
3318
  "format": "boolean",
3168
3319
  "x-displayname": "Fail-If-Referred.",
3320
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
3169
3321
  "x-f5xc-required-for": {
3170
3322
  "minimum_config": false,
3171
3323
  "create": false,
@@ -3190,7 +3342,7 @@
3190
3342
  },
3191
3343
  "x-original-maxLength": 1024,
3192
3344
  "x-reconciled-from-discovery": true,
3193
- "x-reconciled-at": "2026-01-05T14:38:15.534615+00:00"
3345
+ "x-reconciled-at": "2026-01-07T15:28:32.248260+00:00"
3194
3346
  },
3195
3347
  "namespace": {
3196
3348
  "type": "string",
@@ -3199,6 +3351,7 @@
3199
3351
  "x-displayname": "Namespace",
3200
3352
  "x-ves-example": "Ns1",
3201
3353
  "x-f5xc-example": "ns1",
3354
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
3202
3355
  "minLength": 0,
3203
3356
  "maxLength": 6,
3204
3357
  "x-f5xc-required-for": {
@@ -3209,7 +3362,7 @@
3209
3362
  },
3210
3363
  "x-original-maxLength": 1024,
3211
3364
  "x-reconciled-from-discovery": true,
3212
- "x-reconciled-at": "2026-01-05T14:38:15.534622+00:00"
3365
+ "x-reconciled-at": "2026-01-07T15:28:32.248267+00:00"
3213
3366
  }
3214
3367
  },
3215
3368
  "x-f5xc-minimum-configuration": {
@@ -3244,6 +3397,7 @@
3244
3397
  "$ref": "#/components/schemas/data_typeRulePatternType"
3245
3398
  }
3246
3399
  },
3400
+ "x-f5xc-description-short": "The detection rule specifies patterns and values to detect data type by.",
3247
3401
  "x-f5xc-minimum-configuration": {
3248
3402
  "description": "Minimum configuration for data_typeDetectionRule",
3249
3403
  "required_fields": [
@@ -3287,6 +3441,7 @@
3287
3441
  "ves.io.schema.rules.repeated.items.string.max_bytes": "1024",
3288
3442
  "ves.io.schema.rules.repeated.unique": "true"
3289
3443
  },
3444
+ "x-f5xc-description-short": "List of exact values to match. Required: YES.",
3290
3445
  "x-f5xc-required-for": {
3291
3446
  "minimum_config": false,
3292
3447
  "create": false,
@@ -3325,6 +3480,7 @@
3325
3480
  "$ref": "#/components/schemas/schemaObjectRefType"
3326
3481
  },
3327
3482
  "x-displayname": "Deleted Referred Objects.",
3483
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
3328
3484
  "x-f5xc-required-for": {
3329
3485
  "minimum_config": false,
3330
3486
  "create": false,
@@ -3340,6 +3496,7 @@
3340
3496
  "$ref": "#/components/schemas/schemaObjectRefType"
3341
3497
  },
3342
3498
  "x-displayname": "Disabled Referred Objects.",
3499
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
3343
3500
  "x-f5xc-required-for": {
3344
3501
  "minimum_config": false,
3345
3502
  "create": false,
@@ -3358,6 +3515,7 @@
3358
3515
  "$ref": "#/components/schemas/schemaObjectRefType"
3359
3516
  },
3360
3517
  "x-displayname": "Referring Objects.",
3518
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
3361
3519
  "x-f5xc-required-for": {
3362
3520
  "minimum_config": false,
3363
3521
  "create": false,
@@ -3379,6 +3537,8 @@
3379
3537
  "$ref": "#/components/schemas/data_typeStatusObject"
3380
3538
  },
3381
3539
  "x-displayname": "Status",
3540
+ "x-f5xc-example": "active",
3541
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
3382
3542
  "x-f5xc-required-for": {
3383
3543
  "minimum_config": false,
3384
3544
  "create": false,
@@ -3388,7 +3548,7 @@
3388
3548
  "maxLength": 17,
3389
3549
  "minLength": 17,
3390
3550
  "x-reconciled-from-discovery": true,
3391
- "x-reconciled-at": "2026-01-05T14:38:15.534645+00:00"
3551
+ "x-reconciled-at": "2026-01-07T15:28:32.248288+00:00"
3392
3552
  },
3393
3553
  "system_metadata": {
3394
3554
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -3428,6 +3588,8 @@
3428
3588
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
3429
3589
  ],
3430
3590
  "default": "GET_RSP_FORMAT_DEFAULT",
3591
+ "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...",
3592
+ "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...",
3431
3593
  "x-f5xc-minimum-configuration": {
3432
3594
  "description": "Minimum configuration for data_typeGetResponseFormatCode",
3433
3595
  "required_fields": [],
@@ -3465,6 +3627,8 @@
3465
3627
  "ves.io.schema.rules.repeated.max_items": "17",
3466
3628
  "ves.io.schema.rules.repeated.unique": "true"
3467
3629
  },
3630
+ "x-f5xc-description-short": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints...",
3631
+ "x-f5xc-description-medium": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach.",
3468
3632
  "x-f5xc-required-for": {
3469
3633
  "minimum_config": false,
3470
3634
  "create": false,
@@ -3477,6 +3641,7 @@
3477
3641
  "description": "Select this option to classify the custom data type as personally identifiable information (PII)",
3478
3642
  "format": "boolean",
3479
3643
  "x-displayname": "Mark as PII.",
3644
+ "x-f5xc-description-short": "Select this option to classify the custom data type as personally identifiable information (PII).",
3480
3645
  "x-f5xc-required-for": {
3481
3646
  "minimum_config": false,
3482
3647
  "create": false,
@@ -3489,6 +3654,9 @@
3489
3654
  "description": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
3490
3655
  "format": "boolean",
3491
3656
  "x-displayname": "Mark as Sensitive Data.",
3657
+ "x-f5xc-example": "{\"key\": \"value\"}",
3658
+ "x-f5xc-description-short": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
3659
+ "x-f5xc-description-medium": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
3492
3660
  "x-f5xc-required-for": {
3493
3661
  "minimum_config": false,
3494
3662
  "create": false,
@@ -3520,6 +3688,8 @@
3520
3688
  "ves.io.schema.rules.repeated.min_items": "1",
3521
3689
  "ves.io.schema.rules.repeated.unique": "true"
3522
3690
  },
3691
+ "x-f5xc-description-short": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
3692
+ "x-f5xc-description-medium": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
3523
3693
  "x-f5xc-required-for": {
3524
3694
  "minimum_config": false,
3525
3695
  "create": false,
@@ -3531,6 +3701,7 @@
3531
3701
  "$ref": "#/components/schemas/data_typeOriginType"
3532
3702
  }
3533
3703
  },
3704
+ "x-f5xc-description-short": "GET data_type reads a given object from storage backend for metadata.namespace.",
3534
3705
  "x-f5xc-minimum-configuration": {
3535
3706
  "description": "Minimum configuration for data_typeGetSpecType",
3536
3707
  "required_fields": [
@@ -3561,6 +3732,7 @@
3561
3732
  "$ref": "#/components/schemas/data_typeRulePatternType"
3562
3733
  }
3563
3734
  },
3735
+ "x-f5xc-description-short": "Search for specific key & value patterns in the specified sections.",
3564
3736
  "x-f5xc-minimum-configuration": {
3565
3737
  "description": "Minimum configuration for data_typeKeyValuePattern",
3566
3738
  "required_fields": [
@@ -3589,6 +3761,7 @@
3589
3761
  "$ref": "#/components/schemas/schemaErrorType"
3590
3762
  },
3591
3763
  "x-displayname": "Errors",
3764
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
3592
3765
  "x-f5xc-required-for": {
3593
3766
  "minimum_config": false,
3594
3767
  "create": false,
@@ -3604,6 +3777,8 @@
3604
3777
  "$ref": "#/components/schemas/data_typeListResponseItem"
3605
3778
  },
3606
3779
  "x-displayname": "Items",
3780
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
3781
+ "x-f5xc-description-short": "Items represents the collection in response.",
3607
3782
  "x-f5xc-required-for": {
3608
3783
  "minimum_config": false,
3609
3784
  "create": false,
@@ -3637,6 +3812,8 @@
3637
3812
  "description": "The set of annotations present on this data_type.",
3638
3813
  "title": "Annotations.",
3639
3814
  "x-displayname": "Annotations.",
3815
+ "x-f5xc-example": "{\"key\": \"value\"}",
3816
+ "x-f5xc-description-short": "The set of annotations present on this data_type.",
3640
3817
  "x-f5xc-required-for": {
3641
3818
  "minimum_config": false,
3642
3819
  "create": false,
@@ -3659,7 +3836,7 @@
3659
3836
  },
3660
3837
  "x-original-maxLength": 1024,
3661
3838
  "x-reconciled-from-discovery": true,
3662
- "x-reconciled-at": "2026-01-05T14:38:15.534669+00:00"
3839
+ "x-reconciled-at": "2026-01-07T15:28:32.248310+00:00"
3663
3840
  },
3664
3841
  "disabled": {
3665
3842
  "type": "boolean",
@@ -3667,6 +3844,8 @@
3667
3844
  "title": "Disabled",
3668
3845
  "format": "boolean",
3669
3846
  "x-displayname": "Disabled",
3847
+ "x-f5xc-example": "True",
3848
+ "x-f5xc-description-short": "Value of true indicates data_type is administratively disabled.",
3670
3849
  "x-f5xc-required-for": {
3671
3850
  "minimum_config": false,
3672
3851
  "create": false,
@@ -3682,6 +3861,8 @@
3682
3861
  "description": "The set of labels present on this data_type.",
3683
3862
  "title": "Labels",
3684
3863
  "x-displayname": "Labels",
3864
+ "x-f5xc-example": "{\"key\": \"value\"}",
3865
+ "x-f5xc-description-short": "The set of labels present on this data_type.",
3685
3866
  "x-f5xc-required-for": {
3686
3867
  "minimum_config": false,
3687
3868
  "create": false,
@@ -3709,7 +3890,7 @@
3709
3890
  },
3710
3891
  "x-original-maxLength": 1024,
3711
3892
  "x-reconciled-from-discovery": true,
3712
- "x-reconciled-at": "2026-01-05T14:38:15.534680+00:00"
3893
+ "x-reconciled-at": "2026-01-07T15:28:32.248320+00:00"
3713
3894
  },
3714
3895
  "namespace": {
3715
3896
  "type": "string",
@@ -3728,7 +3909,7 @@
3728
3909
  },
3729
3910
  "x-original-maxLength": 1024,
3730
3911
  "x-reconciled-from-discovery": true,
3731
- "x-reconciled-at": "2026-01-05T14:38:15.534685+00:00"
3912
+ "x-reconciled-at": "2026-01-07T15:28:32.248324+00:00"
3732
3913
  },
3733
3914
  "owner_view": {
3734
3915
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -3741,6 +3922,7 @@
3741
3922
  "$ref": "#/components/schemas/data_typeStatusObject"
3742
3923
  },
3743
3924
  "x-displayname": "Status",
3925
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
3744
3926
  "x-f5xc-required-for": {
3745
3927
  "minimum_config": false,
3746
3928
  "create": false,
@@ -3769,7 +3951,7 @@
3769
3951
  "x-field-mutability": "read-only",
3770
3952
  "x-original-maxLength": 1024,
3771
3953
  "x-reconciled-from-discovery": true,
3772
- "x-reconciled-at": "2026-01-05T14:38:15.534694+00:00"
3954
+ "x-reconciled-at": "2026-01-07T15:28:32.248332+00:00"
3773
3955
  },
3774
3956
  "uid": {
3775
3957
  "type": "string",
@@ -3790,9 +3972,11 @@
3790
3972
  "x-original-maxLength": 1024,
3791
3973
  "format": "uuid",
3792
3974
  "x-reconciled-from-discovery": true,
3793
- "x-reconciled-at": "2026-01-05T14:38:15.534700+00:00"
3975
+ "x-reconciled-at": "2026-01-07T15:28:32.248338+00:00"
3794
3976
  }
3795
3977
  },
3978
+ "x-f5xc-description-short": "By default a summary of data_type is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
3979
+ "x-f5xc-description-medium": "By default a summary of data_type is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
3796
3980
  "x-f5xc-minimum-configuration": {
3797
3981
  "description": "Minimum configuration for data_typeListResponseItem",
3798
3982
  "required_fields": [
@@ -3909,6 +4093,8 @@
3909
4093
  "ves.io.schema.rules.repeated.max_items": "17",
3910
4094
  "ves.io.schema.rules.repeated.unique": "true"
3911
4095
  },
4096
+ "x-f5xc-description-short": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints...",
4097
+ "x-f5xc-description-medium": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach.",
3912
4098
  "x-f5xc-required-for": {
3913
4099
  "minimum_config": false,
3914
4100
  "create": false,
@@ -3921,6 +4107,7 @@
3921
4107
  "description": "Select this option to classify the custom data type as personally identifiable information (PII)",
3922
4108
  "format": "boolean",
3923
4109
  "x-displayname": "Mark as PII.",
4110
+ "x-f5xc-description-short": "Select this option to classify the custom data type as personally identifiable information (PII).",
3924
4111
  "x-f5xc-required-for": {
3925
4112
  "minimum_config": false,
3926
4113
  "create": false,
@@ -3933,6 +4120,9 @@
3933
4120
  "description": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
3934
4121
  "format": "boolean",
3935
4122
  "x-displayname": "Mark as Sensitive Data.",
4123
+ "x-f5xc-example": "{\"key\": \"value\"}",
4124
+ "x-f5xc-description-short": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
4125
+ "x-f5xc-description-medium": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
3936
4126
  "x-f5xc-required-for": {
3937
4127
  "minimum_config": false,
3938
4128
  "create": false,
@@ -3964,6 +4154,8 @@
3964
4154
  "ves.io.schema.rules.repeated.min_items": "1",
3965
4155
  "ves.io.schema.rules.repeated.unique": "true"
3966
4156
  },
4157
+ "x-f5xc-description-short": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
4158
+ "x-f5xc-description-medium": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
3967
4159
  "x-f5xc-required-for": {
3968
4160
  "minimum_config": false,
3969
4161
  "create": false,
@@ -3972,6 +4164,7 @@
3972
4164
  }
3973
4165
  }
3974
4166
  },
4167
+ "x-f5xc-description-short": "Replace data_type replaces an existing object in the storage backend for metadata.namespace.",
3975
4168
  "x-f5xc-minimum-configuration": {
3976
4169
  "description": "Minimum configuration for data_typeReplaceSpecType",
3977
4170
  "required_fields": [
@@ -4014,6 +4207,7 @@
4014
4207
  "ves.io.schema.rules.string.max_bytes": "1024",
4015
4208
  "ves.io.schema.rules.string.regex": "true"
4016
4209
  },
4210
+ "x-f5xc-description-short": "Exclusive with [exact_values substring_value] Search for values matching this regular expression.",
4017
4211
  "minLength": 0,
4018
4212
  "x-f5xc-required-for": {
4019
4213
  "minimum_config": false,
@@ -4036,6 +4230,7 @@
4036
4230
  "x-validation-rules": {
4037
4231
  "ves.io.schema.rules.string.max_bytes": "1024"
4038
4232
  },
4233
+ "x-f5xc-description-short": "Exclusive with [exact_values regex_value] Search for values that include this substring.",
4039
4234
  "minLength": 0,
4040
4235
  "x-f5xc-required-for": {
4041
4236
  "minimum_config": false,
@@ -4073,6 +4268,7 @@
4073
4268
  "$ref": "#/components/schemas/schemaConditionType"
4074
4269
  },
4075
4270
  "x-displayname": "Conditions.",
4271
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
4076
4272
  "x-f5xc-required-for": {
4077
4273
  "minimum_config": false,
4078
4274
  "create": false,
@@ -4119,6 +4315,7 @@
4119
4315
  "title": "Empty",
4120
4316
  "x-displayname": "Empty",
4121
4317
  "x-ves-proto-message": "ves.io.schema.Empty",
4318
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
4122
4319
  "x-f5xc-minimum-configuration": {
4123
4320
  "description": "Minimum configuration for ioschemaEmpty",
4124
4321
  "required_fields": [],
@@ -4136,6 +4333,8 @@
4136
4333
  "type_url": {
4137
4334
  "type": "string",
4138
4335
  "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.",
4336
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
4337
+ "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 ).",
4139
4338
  "minLength": 0,
4140
4339
  "maxLength": 1024,
4141
4340
  "x-f5xc-required-for": {
@@ -4159,9 +4358,11 @@
4159
4358
  },
4160
4359
  "x-original-maxLength": 1024,
4161
4360
  "x-reconciled-from-discovery": true,
4162
- "x-reconciled-at": "2026-01-05T14:38:15.534730+00:00"
4361
+ "x-reconciled-at": "2026-01-07T15:28:32.248366+00:00"
4163
4362
  }
4164
4363
  },
4364
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
4365
+ "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...",
4165
4366
  "x-f5xc-minimum-configuration": {
4166
4367
  "description": "Minimum configuration for protobufAny",
4167
4368
  "required_fields": [
@@ -4187,6 +4388,8 @@
4187
4388
  "description": "Hostname of the instance of the site that sent the status.",
4188
4389
  "title": "Hostname",
4189
4390
  "x-displayname": "Hostname",
4391
+ "x-f5xc-example": "example-resource",
4392
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
4190
4393
  "minLength": 0,
4191
4394
  "maxLength": 1024,
4192
4395
  "x-f5xc-required-for": {
@@ -4218,6 +4421,8 @@
4218
4421
  "x-displayname": "Reason",
4219
4422
  "x-ves-example": "Value",
4220
4423
  "x-f5xc-example": "value",
4424
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
4425
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
4221
4426
  "minLength": 0,
4222
4427
  "maxLength": 43,
4223
4428
  "x-f5xc-required-for": {
@@ -4228,13 +4433,15 @@
4228
4433
  },
4229
4434
  "x-original-maxLength": 1024,
4230
4435
  "x-reconciled-from-discovery": true,
4231
- "x-reconciled-at": "2026-01-05T14:38:15.534738+00:00"
4436
+ "x-reconciled-at": "2026-01-07T15:28:32.248374+00:00"
4232
4437
  },
4233
4438
  "service_name": {
4234
4439
  "type": "string",
4235
4440
  "description": "Name of the service that sent the status.",
4236
4441
  "title": "Service name.",
4237
4442
  "x-displayname": "Service Name.",
4443
+ "x-f5xc-example": "example-resource",
4444
+ "x-f5xc-description-short": "Name of the service that sent the status.",
4238
4445
  "minLength": 0,
4239
4446
  "maxLength": 1024,
4240
4447
  "x-f5xc-required-for": {
@@ -4257,6 +4464,8 @@
4257
4464
  "x-validation-rules": {
4258
4465
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
4259
4466
  },
4467
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
4468
+ "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...",
4260
4469
  "minLength": 0,
4261
4470
  "maxLength": 17,
4262
4471
  "x-f5xc-required-for": {
@@ -4267,7 +4476,7 @@
4267
4476
  },
4268
4477
  "x-original-maxLength": 1024,
4269
4478
  "x-reconciled-from-discovery": true,
4270
- "x-reconciled-at": "2026-01-05T14:38:15.534744+00:00"
4479
+ "x-reconciled-at": "2026-01-07T15:28:32.248380+00:00"
4271
4480
  },
4272
4481
  "type": {
4273
4482
  "type": "string",
@@ -4282,6 +4491,8 @@
4282
4491
  "x-validation-rules": {
4283
4492
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
4284
4493
  },
4494
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
4495
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
4285
4496
  "minLength": 0,
4286
4497
  "maxLength": 1024,
4287
4498
  "x-f5xc-required-for": {
@@ -4292,6 +4503,8 @@
4292
4503
  }
4293
4504
  }
4294
4505
  },
4506
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
4507
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
4295
4508
  "x-f5xc-minimum-configuration": {
4296
4509
  "description": "Minimum configuration for schemaConditionType",
4297
4510
  "required_fields": [
@@ -4327,6 +4540,8 @@
4327
4540
  "default": "EOK",
4328
4541
  "x-displayname": "Error Code.",
4329
4542
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
4543
+ "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...",
4544
+ "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...",
4330
4545
  "x-f5xc-minimum-configuration": {
4331
4546
  "description": "Minimum configuration for schemaErrorCode",
4332
4547
  "required_fields": [],
@@ -4367,6 +4582,7 @@
4367
4582
  }
4368
4583
  }
4369
4584
  },
4585
+ "x-f5xc-description-short": "Information about a error in API operation.",
4370
4586
  "x-f5xc-minimum-configuration": {
4371
4587
  "description": "Minimum configuration for schemaErrorType",
4372
4588
  "required_fields": [
@@ -4394,6 +4610,7 @@
4394
4610
  "title": "Name",
4395
4611
  "x-displayname": "Name",
4396
4612
  "x-f5xc-example": "example-resource",
4613
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
4397
4614
  "minLength": 0,
4398
4615
  "maxLength": 16,
4399
4616
  "x-f5xc-required-for": {
@@ -4404,9 +4621,10 @@
4404
4621
  },
4405
4622
  "x-original-maxLength": 1024,
4406
4623
  "x-reconciled-from-discovery": true,
4407
- "x-reconciled-at": "2026-01-05T14:38:15.534768+00:00"
4624
+ "x-reconciled-at": "2026-01-07T15:28:32.248391+00:00"
4408
4625
  }
4409
4626
  },
4627
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
4410
4628
  "x-f5xc-minimum-configuration": {
4411
4629
  "description": "Minimum configuration for schemaInitializerType",
4412
4630
  "required_fields": [
@@ -4434,6 +4652,8 @@
4434
4652
  "$ref": "#/components/schemas/schemaInitializerType"
4435
4653
  },
4436
4654
  "x-displayname": "Pending",
4655
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
4656
+ "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.",
4437
4657
  "x-f5xc-required-for": {
4438
4658
  "minimum_config": false,
4439
4659
  "create": false,
@@ -4445,6 +4665,7 @@
4445
4665
  "$ref": "#/components/schemas/schemaStatusType"
4446
4666
  }
4447
4667
  },
4668
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
4448
4669
  "x-f5xc-minimum-configuration": {
4449
4670
  "description": "Minimum configuration for schemaInitializersType",
4450
4671
  "required_fields": [
@@ -4483,6 +4704,8 @@
4483
4704
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4484
4705
  "ves.io.schema.rules.map.values.string.min_len": "1"
4485
4706
  },
4707
+ "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.",
4708
+ "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.",
4486
4709
  "x-f5xc-required-for": {
4487
4710
  "minimum_config": false,
4488
4711
  "create": false,
@@ -4504,6 +4727,7 @@
4504
4727
  "x-validation-rules": {
4505
4728
  "ves.io.schema.rules.string.max_bytes": "1200"
4506
4729
  },
4730
+ "x-f5xc-description-short": "Human readable description for the object.",
4507
4731
  "minLength": 0,
4508
4732
  "x-f5xc-required-for": {
4509
4733
  "minimum_config": false,
@@ -4513,7 +4737,7 @@
4513
4737
  },
4514
4738
  "x-original-maxLength": 1200,
4515
4739
  "x-reconciled-from-discovery": true,
4516
- "x-reconciled-at": "2026-01-05T14:38:15.534779+00:00"
4740
+ "x-reconciled-at": "2026-01-07T15:28:32.248400+00:00"
4517
4741
  },
4518
4742
  "disable": {
4519
4743
  "type": "boolean",
@@ -4522,6 +4746,7 @@
4522
4746
  "format": "boolean",
4523
4747
  "x-displayname": "Disable",
4524
4748
  "x-f5xc-example": "true",
4749
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4525
4750
  "x-f5xc-required-for": {
4526
4751
  "minimum_config": false,
4527
4752
  "create": false,
@@ -4535,6 +4760,8 @@
4535
4760
  "title": "Labels",
4536
4761
  "x-displayname": "Labels",
4537
4762
  "x-f5xc-example": "value",
4763
+ "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.",
4764
+ "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.",
4538
4765
  "x-f5xc-required-for": {
4539
4766
  "minimum_config": false,
4540
4767
  "create": false,
@@ -4556,6 +4783,8 @@
4556
4783
  "x-validation-rules": {
4557
4784
  "ves.io.schema.rules.message.required": "true"
4558
4785
  },
4786
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4787
+ "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.",
4559
4788
  "minLength": 0,
4560
4789
  "maxLength": 16,
4561
4790
  "x-f5xc-required-for": {
@@ -4566,7 +4795,7 @@
4566
4795
  },
4567
4796
  "x-original-maxLength": 1024,
4568
4797
  "x-reconciled-from-discovery": true,
4569
- "x-reconciled-at": "2026-01-05T14:38:15.534787+00:00"
4798
+ "x-reconciled-at": "2026-01-07T15:28:32.248407+00:00"
4570
4799
  },
4571
4800
  "namespace": {
4572
4801
  "type": "string",
@@ -4575,6 +4804,8 @@
4575
4804
  "x-displayname": "Namespace",
4576
4805
  "x-ves-example": "Staging",
4577
4806
  "x-f5xc-example": "staging",
4807
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4808
+ "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 \"\".",
4578
4809
  "minLength": 0,
4579
4810
  "maxLength": 6,
4580
4811
  "x-f5xc-required-for": {
@@ -4585,9 +4816,10 @@
4585
4816
  },
4586
4817
  "x-original-maxLength": 1024,
4587
4818
  "x-reconciled-from-discovery": true,
4588
- "x-reconciled-at": "2026-01-05T14:38:15.534792+00:00"
4819
+ "x-reconciled-at": "2026-01-07T15:28:32.248411+00:00"
4589
4820
  }
4590
4821
  },
4822
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
4591
4823
  "x-f5xc-minimum-configuration": {
4592
4824
  "description": "Minimum configuration for schemaObjectCreateMetaType",
4593
4825
  "required_fields": [
@@ -4631,6 +4863,8 @@
4631
4863
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4632
4864
  "ves.io.schema.rules.map.values.string.min_len": "1"
4633
4865
  },
4866
+ "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.",
4867
+ "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.",
4634
4868
  "x-f5xc-required-for": {
4635
4869
  "minimum_config": false,
4636
4870
  "create": false,
@@ -4652,6 +4886,7 @@
4652
4886
  "x-validation-rules": {
4653
4887
  "ves.io.schema.rules.string.max_bytes": "1200"
4654
4888
  },
4889
+ "x-f5xc-description-short": "Human readable description for the object.",
4655
4890
  "minLength": 0,
4656
4891
  "x-f5xc-required-for": {
4657
4892
  "minimum_config": false,
@@ -4661,7 +4896,7 @@
4661
4896
  },
4662
4897
  "x-original-maxLength": 1200,
4663
4898
  "x-reconciled-from-discovery": true,
4664
- "x-reconciled-at": "2026-01-05T14:38:15.534798+00:00"
4899
+ "x-reconciled-at": "2026-01-07T15:28:32.248418+00:00"
4665
4900
  },
4666
4901
  "disable": {
4667
4902
  "type": "boolean",
@@ -4671,6 +4906,7 @@
4671
4906
  "x-displayname": "Disable",
4672
4907
  "x-ves-example": "True",
4673
4908
  "x-f5xc-example": "true",
4909
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4674
4910
  "x-f5xc-required-for": {
4675
4911
  "minimum_config": false,
4676
4912
  "create": false,
@@ -4685,6 +4921,8 @@
4685
4921
  "x-displayname": "Labels",
4686
4922
  "x-ves-example": "Value",
4687
4923
  "x-f5xc-example": "value",
4924
+ "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.",
4925
+ "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.",
4688
4926
  "x-f5xc-required-for": {
4689
4927
  "minimum_config": false,
4690
4928
  "create": false,
@@ -4706,6 +4944,8 @@
4706
4944
  "x-validation-rules": {
4707
4945
  "ves.io.schema.rules.message.required": "true"
4708
4946
  },
4947
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
4948
+ "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.",
4709
4949
  "minLength": 0,
4710
4950
  "maxLength": 16,
4711
4951
  "x-f5xc-required-for": {
@@ -4716,7 +4956,7 @@
4716
4956
  },
4717
4957
  "x-original-maxLength": 1024,
4718
4958
  "x-reconciled-from-discovery": true,
4719
- "x-reconciled-at": "2026-01-05T14:38:15.534806+00:00"
4959
+ "x-reconciled-at": "2026-01-07T15:28:32.248425+00:00"
4720
4960
  },
4721
4961
  "namespace": {
4722
4962
  "type": "string",
@@ -4725,6 +4965,8 @@
4725
4965
  "x-displayname": "Namespace",
4726
4966
  "x-ves-example": "Staging",
4727
4967
  "x-f5xc-example": "staging",
4968
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
4969
+ "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 \"\".",
4728
4970
  "minLength": 0,
4729
4971
  "maxLength": 6,
4730
4972
  "x-f5xc-required-for": {
@@ -4735,9 +4977,10 @@
4735
4977
  },
4736
4978
  "x-original-maxLength": 1024,
4737
4979
  "x-reconciled-from-discovery": true,
4738
- "x-reconciled-at": "2026-01-05T14:38:15.534810+00:00"
4980
+ "x-reconciled-at": "2026-01-07T15:28:32.248428+00:00"
4739
4981
  }
4740
4982
  },
4983
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
4741
4984
  "x-f5xc-minimum-configuration": {
4742
4985
  "description": "Minimum configuration for schemaObjectGetMetaType",
4743
4986
  "required_fields": [
@@ -4769,6 +5012,8 @@
4769
5012
  "x-displayname": "Kind",
4770
5013
  "x-ves-example": "Virtual_site.",
4771
5014
  "x-f5xc-example": "virtual_site",
5015
+ "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\")",
5016
+ "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\").",
4772
5017
  "minLength": 0,
4773
5018
  "maxLength": 14,
4774
5019
  "x-f5xc-required-for": {
@@ -4780,7 +5025,7 @@
4780
5025
  "readOnly": true,
4781
5026
  "x-original-maxLength": 1024,
4782
5027
  "x-reconciled-from-discovery": true,
4783
- "x-reconciled-at": "2026-01-05T14:38:15.534815+00:00"
5028
+ "x-reconciled-at": "2026-01-07T15:28:32.248433+00:00"
4784
5029
  },
4785
5030
  "name": {
4786
5031
  "type": "string",
@@ -4789,6 +5034,8 @@
4789
5034
  "x-displayname": "Name",
4790
5035
  "x-ves-example": "Contactus-route.",
4791
5036
  "x-f5xc-example": "contactus-route",
5037
+ "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.",
5038
+ "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.",
4792
5039
  "minLength": 0,
4793
5040
  "maxLength": 16,
4794
5041
  "x-f5xc-required-for": {
@@ -4799,7 +5046,7 @@
4799
5046
  },
4800
5047
  "x-original-maxLength": 1024,
4801
5048
  "x-reconciled-from-discovery": true,
4802
- "x-reconciled-at": "2026-01-05T14:38:15.534819+00:00"
5049
+ "x-reconciled-at": "2026-01-07T15:28:32.248437+00:00"
4803
5050
  },
4804
5051
  "namespace": {
4805
5052
  "type": "string",
@@ -4808,6 +5055,8 @@
4808
5055
  "x-displayname": "Namespace",
4809
5056
  "x-ves-example": "Ns1",
4810
5057
  "x-f5xc-example": "ns1",
5058
+ "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.",
5059
+ "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.",
4811
5060
  "minLength": 0,
4812
5061
  "maxLength": 6,
4813
5062
  "x-f5xc-required-for": {
@@ -4818,7 +5067,7 @@
4818
5067
  },
4819
5068
  "x-original-maxLength": 1024,
4820
5069
  "x-reconciled-from-discovery": true,
4821
- "x-reconciled-at": "2026-01-05T14:38:15.534823+00:00"
5070
+ "x-reconciled-at": "2026-01-07T15:28:32.248440+00:00"
4822
5071
  },
4823
5072
  "tenant": {
4824
5073
  "type": "string",
@@ -4827,6 +5076,8 @@
4827
5076
  "x-displayname": "Tenant",
4828
5077
  "x-ves-example": "Example-corp.",
4829
5078
  "x-f5xc-example": "example-corp",
5079
+ "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.",
5080
+ "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.",
4830
5081
  "minLength": 0,
4831
5082
  "maxLength": 18,
4832
5083
  "x-f5xc-required-for": {
@@ -4839,7 +5090,7 @@
4839
5090
  "x-field-mutability": "read-only",
4840
5091
  "x-original-maxLength": 1024,
4841
5092
  "x-reconciled-from-discovery": true,
4842
- "x-reconciled-at": "2026-01-05T14:38:15.534827+00:00"
5093
+ "x-reconciled-at": "2026-01-07T15:28:32.248444+00:00"
4843
5094
  },
4844
5095
  "uid": {
4845
5096
  "type": "string",
@@ -4848,6 +5099,8 @@
4848
5099
  "x-displayname": "UID",
4849
5100
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
4850
5101
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5102
+ "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.",
5103
+ "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.",
4851
5104
  "minLength": 0,
4852
5105
  "maxLength": 36,
4853
5106
  "x-f5xc-required-for": {
@@ -4861,9 +5114,11 @@
4861
5114
  "x-original-maxLength": 1024,
4862
5115
  "format": "uuid",
4863
5116
  "x-reconciled-from-discovery": true,
4864
- "x-reconciled-at": "2026-01-05T14:38:15.534832+00:00"
5117
+ "x-reconciled-at": "2026-01-07T15:28:32.248450+00:00"
4865
5118
  }
4866
5119
  },
5120
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
5121
+ "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...",
4867
5122
  "x-f5xc-minimum-configuration": {
4868
5123
  "description": "Minimum configuration for schemaObjectRefType",
4869
5124
  "required_fields": [
@@ -4906,6 +5161,8 @@
4906
5161
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4907
5162
  "ves.io.schema.rules.map.values.string.min_len": "1"
4908
5163
  },
5164
+ "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.",
5165
+ "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.",
4909
5166
  "x-f5xc-required-for": {
4910
5167
  "minimum_config": false,
4911
5168
  "create": false,
@@ -4927,6 +5184,7 @@
4927
5184
  "x-validation-rules": {
4928
5185
  "ves.io.schema.rules.string.max_bytes": "1200"
4929
5186
  },
5187
+ "x-f5xc-description-short": "Human readable description for the object.",
4930
5188
  "minLength": 0,
4931
5189
  "x-f5xc-required-for": {
4932
5190
  "minimum_config": false,
@@ -4936,7 +5194,7 @@
4936
5194
  },
4937
5195
  "x-original-maxLength": 1200,
4938
5196
  "x-reconciled-from-discovery": true,
4939
- "x-reconciled-at": "2026-01-05T14:38:15.534839+00:00"
5197
+ "x-reconciled-at": "2026-01-07T15:28:32.248457+00:00"
4940
5198
  },
4941
5199
  "disable": {
4942
5200
  "type": "boolean",
@@ -4945,6 +5203,7 @@
4945
5203
  "format": "boolean",
4946
5204
  "x-displayname": "Disable",
4947
5205
  "x-f5xc-example": "true",
5206
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4948
5207
  "x-f5xc-required-for": {
4949
5208
  "minimum_config": false,
4950
5209
  "create": false,
@@ -4959,6 +5218,8 @@
4959
5218
  "x-displayname": "Labels",
4960
5219
  "x-ves-example": "Value",
4961
5220
  "x-f5xc-example": "value",
5221
+ "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.",
5222
+ "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.",
4962
5223
  "x-f5xc-required-for": {
4963
5224
  "minimum_config": false,
4964
5225
  "create": false,
@@ -4979,6 +5240,8 @@
4979
5240
  "x-validation-rules": {
4980
5241
  "ves.io.schema.rules.message.required": "true"
4981
5242
  },
5243
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
5244
+ "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.",
4982
5245
  "minLength": 0,
4983
5246
  "maxLength": 16,
4984
5247
  "x-f5xc-required-for": {
@@ -4989,7 +5252,7 @@
4989
5252
  },
4990
5253
  "x-original-maxLength": 1024,
4991
5254
  "x-reconciled-from-discovery": true,
4992
- "x-reconciled-at": "2026-01-05T14:38:15.534847+00:00"
5255
+ "x-reconciled-at": "2026-01-07T15:28:32.248464+00:00"
4993
5256
  },
4994
5257
  "namespace": {
4995
5258
  "type": "string",
@@ -4998,6 +5261,8 @@
4998
5261
  "x-displayname": "Namespace",
4999
5262
  "x-ves-example": "Staging",
5000
5263
  "x-f5xc-example": "staging",
5264
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
5265
+ "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 \"\".",
5001
5266
  "minLength": 0,
5002
5267
  "maxLength": 6,
5003
5268
  "x-f5xc-required-for": {
@@ -5008,9 +5273,10 @@
5008
5273
  },
5009
5274
  "x-original-maxLength": 1024,
5010
5275
  "x-reconciled-from-discovery": true,
5011
- "x-reconciled-at": "2026-01-05T14:38:15.534852+00:00"
5276
+ "x-reconciled-at": "2026-01-07T15:28:32.248468+00:00"
5012
5277
  }
5013
5278
  },
5279
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
5014
5280
  "x-f5xc-minimum-configuration": {
5015
5281
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
5016
5282
  "required_fields": [
@@ -5041,6 +5307,8 @@
5041
5307
  "title": "Creation_timestamp.",
5042
5308
  "format": "date-time",
5043
5309
  "x-displayname": "Creation Timestamp.",
5310
+ "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.",
5311
+ "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.",
5044
5312
  "minLength": 0,
5045
5313
  "maxLength": 1024,
5046
5314
  "x-f5xc-required-for": {
@@ -5058,6 +5326,8 @@
5058
5326
  "x-displayname": "Creator Class.",
5059
5327
  "x-ves-example": "ver.re1.int.ves.I/O.",
5060
5328
  "x-f5xc-example": "ver.re1.int.F5 XC",
5329
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
5330
+ "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.",
5061
5331
  "minLength": 0,
5062
5332
  "maxLength": 1024,
5063
5333
  "x-f5xc-required-for": {
@@ -5075,6 +5345,8 @@
5075
5345
  "x-displayname": "Creator ID.",
5076
5346
  "x-ves-example": "Ver-instance-1.",
5077
5347
  "x-f5xc-example": "ver-instance-1",
5348
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
5349
+ "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.",
5078
5350
  "minLength": 0,
5079
5351
  "maxLength": 1024,
5080
5352
  "x-f5xc-required-for": {
@@ -5093,6 +5365,8 @@
5093
5365
  "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)",
5094
5366
  "title": "Status_id",
5095
5367
  "x-displayname": "Status ID",
5368
+ "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...",
5369
+ "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).",
5096
5370
  "minLength": 0,
5097
5371
  "maxLength": 1024,
5098
5372
  "x-f5xc-required-for": {
@@ -5110,6 +5384,7 @@
5110
5384
  "x-displayname": "UID",
5111
5385
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5112
5386
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5387
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
5113
5388
  "minLength": 0,
5114
5389
  "maxLength": 36,
5115
5390
  "x-f5xc-required-for": {
@@ -5122,13 +5397,14 @@
5122
5397
  "x-original-maxLength": 1024,
5123
5398
  "format": "uuid",
5124
5399
  "x-reconciled-from-discovery": true,
5125
- "x-reconciled-at": "2026-01-05T14:38:15.534865+00:00"
5400
+ "x-reconciled-at": "2026-01-07T15:28:32.248480+00:00"
5126
5401
  },
5127
5402
  "vtrp_id": {
5128
5403
  "type": "string",
5129
5404
  "description": "Origin of this status exchanged by VTRP.",
5130
5405
  "title": "Vtrp_id",
5131
5406
  "x-displayname": "VTRP ID",
5407
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
5132
5408
  "minLength": 0,
5133
5409
  "maxLength": 1024,
5134
5410
  "x-f5xc-required-for": {
@@ -5145,6 +5421,7 @@
5145
5421
  "title": "Vtrp_stale.",
5146
5422
  "format": "boolean",
5147
5423
  "x-displayname": "VTRP Stale.",
5424
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
5148
5425
  "x-f5xc-required-for": {
5149
5426
  "minimum_config": false,
5150
5427
  "create": false,
@@ -5153,6 +5430,7 @@
5153
5430
  }
5154
5431
  }
5155
5432
  },
5433
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
5156
5434
  "x-f5xc-minimum-configuration": {
5157
5435
  "description": "Minimum configuration for schemaStatusMetaType",
5158
5436
  "required_fields": [
@@ -5183,6 +5461,8 @@
5183
5461
  "default": "STATUS_DO_NOT_PUBLISH",
5184
5462
  "x-displayname": "Status Publish Type.",
5185
5463
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
5464
+ "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.",
5465
+ "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.",
5186
5466
  "x-f5xc-minimum-configuration": {
5187
5467
  "description": "Minimum configuration for schemaStatusPublishType",
5188
5468
  "required_fields": [],
@@ -5208,6 +5488,7 @@
5208
5488
  "x-displayname": "Code",
5209
5489
  "x-ves-example": "0",
5210
5490
  "x-f5xc-example": "0",
5491
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
5211
5492
  "minimum": 0,
5212
5493
  "maximum": 2147483647,
5213
5494
  "x-f5xc-required-for": {
@@ -5224,6 +5505,8 @@
5224
5505
  "x-displayname": "Reason",
5225
5506
  "x-ves-example": "Value",
5226
5507
  "x-f5xc-example": "value",
5508
+ "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.",
5509
+ "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.",
5227
5510
  "minLength": 0,
5228
5511
  "maxLength": 43,
5229
5512
  "x-f5xc-required-for": {
@@ -5234,7 +5517,7 @@
5234
5517
  },
5235
5518
  "x-original-maxLength": 1024,
5236
5519
  "x-reconciled-from-discovery": true,
5237
- "x-reconciled-at": "2026-01-05T14:38:15.534875+00:00"
5520
+ "x-reconciled-at": "2026-01-07T15:28:32.248489+00:00"
5238
5521
  },
5239
5522
  "status": {
5240
5523
  "type": "string",
@@ -5243,6 +5526,7 @@
5243
5526
  "x-displayname": "Status",
5244
5527
  "x-ves-example": "Value",
5245
5528
  "x-f5xc-example": "value",
5529
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
5246
5530
  "minLength": 0,
5247
5531
  "maxLength": 17,
5248
5532
  "x-f5xc-required-for": {
@@ -5253,9 +5537,10 @@
5253
5537
  },
5254
5538
  "x-original-maxLength": 1024,
5255
5539
  "x-reconciled-from-discovery": true,
5256
- "x-reconciled-at": "2026-01-05T14:38:15.534880+00:00"
5540
+ "x-reconciled-at": "2026-01-07T15:28:32.248493+00:00"
5257
5541
  }
5258
5542
  },
5543
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
5259
5544
  "x-f5xc-minimum-configuration": {
5260
5545
  "description": "Minimum configuration for schemaStatusType",
5261
5546
  "required_fields": [
@@ -5283,6 +5568,8 @@
5283
5568
  "title": "Creation_timestamp.",
5284
5569
  "format": "date-time",
5285
5570
  "x-displayname": "Creation Timestamp.",
5571
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
5572
+ "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.",
5286
5573
  "minLength": 0,
5287
5574
  "maxLength": 1024,
5288
5575
  "x-f5xc-required-for": {
@@ -5300,6 +5587,7 @@
5300
5587
  "x-displayname": "Creator Class.",
5301
5588
  "x-ves-example": "Prism",
5302
5589
  "x-f5xc-example": "value",
5590
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
5303
5591
  "minLength": 0,
5304
5592
  "maxLength": 1024,
5305
5593
  "x-f5xc-required-for": {
@@ -5317,6 +5605,7 @@
5317
5605
  "x-displayname": "Creator ID.",
5318
5606
  "x-ves-example": "Admin@example-corp.com.",
5319
5607
  "x-f5xc-example": "value",
5608
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
5320
5609
  "minLength": 0,
5321
5610
  "maxLength": 1024,
5322
5611
  "x-f5xc-required-for": {
@@ -5333,6 +5622,8 @@
5333
5622
  "title": "Deletion_timestamp.",
5334
5623
  "format": "date-time",
5335
5624
  "x-displayname": "Deletion Timestamp.",
5625
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
5626
+ "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...",
5336
5627
  "minLength": 0,
5337
5628
  "maxLength": 1024,
5338
5629
  "x-f5xc-required-for": {
@@ -5352,6 +5643,8 @@
5352
5643
  "x-displayname": "Finalizers.",
5353
5644
  "x-ves-example": "Value",
5354
5645
  "x-f5xc-example": "value",
5646
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
5647
+ "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.",
5355
5648
  "x-f5xc-required-for": {
5356
5649
  "minimum_config": false,
5357
5650
  "create": false,
@@ -5369,6 +5662,8 @@
5369
5662
  "x-displayname": "Labels",
5370
5663
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
5371
5664
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
5665
+ "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.",
5666
+ "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).",
5372
5667
  "x-f5xc-required-for": {
5373
5668
  "minimum_config": false,
5374
5669
  "create": false,
@@ -5382,6 +5677,8 @@
5382
5677
  "title": "Modification_timestamp.",
5383
5678
  "format": "date-time",
5384
5679
  "x-displayname": "Modification Timestamp.",
5680
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5681
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
5385
5682
  "minLength": 0,
5386
5683
  "maxLength": 1024,
5387
5684
  "x-f5xc-required-for": {
@@ -5400,6 +5697,8 @@
5400
5697
  "x-displayname": "Object Index.",
5401
5698
  "x-ves-example": "0",
5402
5699
  "x-f5xc-example": "0",
5700
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
5701
+ "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.",
5403
5702
  "minimum": 0,
5404
5703
  "maximum": 2147483647,
5405
5704
  "x-f5xc-required-for": {
@@ -5420,6 +5719,8 @@
5420
5719
  "x-displayname": "Tenant",
5421
5720
  "x-ves-example": "Example-corp.",
5422
5721
  "x-f5xc-example": "example-corp",
5722
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5723
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
5423
5724
  "minLength": 0,
5424
5725
  "maxLength": 18,
5425
5726
  "x-f5xc-required-for": {
@@ -5431,7 +5732,7 @@
5431
5732
  "x-field-mutability": "read-only",
5432
5733
  "x-original-maxLength": 1024,
5433
5734
  "x-reconciled-from-discovery": true,
5434
- "x-reconciled-at": "2026-01-05T14:38:15.534899+00:00"
5735
+ "x-reconciled-at": "2026-01-07T15:28:32.248523+00:00"
5435
5736
  },
5436
5737
  "uid": {
5437
5738
  "type": "string",
@@ -5440,6 +5741,8 @@
5440
5741
  "x-displayname": "UID",
5441
5742
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5442
5743
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
5744
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
5745
+ "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.",
5443
5746
  "minLength": 0,
5444
5747
  "maxLength": 36,
5445
5748
  "x-f5xc-required-for": {
@@ -5452,9 +5755,11 @@
5452
5755
  "x-original-maxLength": 1024,
5453
5756
  "format": "uuid",
5454
5757
  "x-reconciled-from-discovery": true,
5455
- "x-reconciled-at": "2026-01-05T14:38:15.534904+00:00"
5758
+ "x-reconciled-at": "2026-01-07T15:28:32.248528+00:00"
5456
5759
  }
5457
5760
  },
5761
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5762
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
5458
5763
  "x-f5xc-minimum-configuration": {
5459
5764
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
5460
5765
  "required_fields": [
@@ -5502,7 +5807,7 @@
5502
5807
  },
5503
5808
  "x-original-maxLength": 1024,
5504
5809
  "x-reconciled-from-discovery": true,
5505
- "x-reconciled-at": "2026-01-05T14:38:15.534909+00:00"
5810
+ "x-reconciled-at": "2026-01-07T15:28:32.248533+00:00"
5506
5811
  },
5507
5812
  "name": {
5508
5813
  "type": "string",
@@ -5511,6 +5816,8 @@
5511
5816
  "x-displayname": "Name",
5512
5817
  "x-ves-example": "Contactus-route.",
5513
5818
  "x-f5xc-example": "contactus-route",
5819
+ "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.",
5820
+ "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.",
5514
5821
  "minLength": 0,
5515
5822
  "maxLength": 16,
5516
5823
  "x-f5xc-required-for": {
@@ -5521,7 +5828,7 @@
5521
5828
  },
5522
5829
  "x-original-maxLength": 1024,
5523
5830
  "x-reconciled-from-discovery": true,
5524
- "x-reconciled-at": "2026-01-05T14:38:15.534913+00:00"
5831
+ "x-reconciled-at": "2026-01-07T15:28:32.248537+00:00"
5525
5832
  },
5526
5833
  "namespace": {
5527
5834
  "type": "string",
@@ -5530,6 +5837,8 @@
5530
5837
  "x-displayname": "Namespace",
5531
5838
  "x-ves-example": "Ns1",
5532
5839
  "x-f5xc-example": "ns1",
5840
+ "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.",
5841
+ "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.",
5533
5842
  "minLength": 0,
5534
5843
  "maxLength": 6,
5535
5844
  "x-f5xc-required-for": {
@@ -5540,7 +5849,7 @@
5540
5849
  },
5541
5850
  "x-original-maxLength": 1024,
5542
5851
  "x-reconciled-from-discovery": true,
5543
- "x-reconciled-at": "2026-01-05T14:38:15.534917+00:00"
5852
+ "x-reconciled-at": "2026-01-07T15:28:32.248541+00:00"
5544
5853
  },
5545
5854
  "uid": {
5546
5855
  "type": "string",
@@ -5561,9 +5870,10 @@
5561
5870
  "x-original-maxLength": 1024,
5562
5871
  "format": "uuid",
5563
5872
  "x-reconciled-from-discovery": true,
5564
- "x-reconciled-at": "2026-01-05T14:38:15.534922+00:00"
5873
+ "x-reconciled-at": "2026-01-07T15:28:32.248546+00:00"
5565
5874
  }
5566
5875
  },
5876
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
5567
5877
  "x-f5xc-minimum-configuration": {
5568
5878
  "description": "Minimum configuration for schemaViewRefType",
5569
5879
  "required_fields": [
@@ -5594,6 +5904,7 @@
5594
5904
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5595
5905
  },
5596
5906
  "x-displayname": "Deleted Referred Objects.",
5907
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5597
5908
  "x-f5xc-required-for": {
5598
5909
  "minimum_config": false,
5599
5910
  "create": false,
@@ -5609,6 +5920,7 @@
5609
5920
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5610
5921
  },
5611
5922
  "x-displayname": "Disabled Referred Objects.",
5923
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5612
5924
  "x-f5xc-required-for": {
5613
5925
  "minimum_config": false,
5614
5926
  "create": false,
@@ -5627,6 +5939,7 @@
5627
5939
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5628
5940
  },
5629
5941
  "x-displayname": "Referring Objects.",
5942
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
5630
5943
  "x-f5xc-required-for": {
5631
5944
  "minimum_config": false,
5632
5945
  "create": false,
@@ -5645,6 +5958,8 @@
5645
5958
  "$ref": "#/components/schemas/geo_configStatusObject"
5646
5959
  },
5647
5960
  "x-displayname": "Status",
5961
+ "x-f5xc-example": "active",
5962
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5648
5963
  "x-f5xc-required-for": {
5649
5964
  "minimum_config": false,
5650
5965
  "create": false,
@@ -5654,7 +5969,7 @@
5654
5969
  "maxLength": 17,
5655
5970
  "minLength": 17,
5656
5971
  "x-reconciled-from-discovery": true,
5657
- "x-reconciled-at": "2026-01-05T14:38:23.458935+00:00"
5972
+ "x-reconciled-at": "2026-01-07T15:28:41.450733+00:00"
5658
5973
  },
5659
5974
  "system_metadata": {
5660
5975
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -5690,6 +6005,8 @@
5690
6005
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
5691
6006
  ],
5692
6007
  "default": "GET_RSP_FORMAT_DEFAULT",
6008
+ "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...",
6009
+ "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...",
5693
6010
  "x-f5xc-minimum-configuration": {
5694
6011
  "description": "Minimum configuration for geo_configGetResponseFormatCode",
5695
6012
  "required_fields": [],
@@ -5758,6 +6075,7 @@
5758
6075
  "$ref": "#/components/schemas/schemaConditionType"
5759
6076
  },
5760
6077
  "x-displayname": "Conditions.",
6078
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
5761
6079
  "x-f5xc-required-for": {
5762
6080
  "minimum_config": false,
5763
6081
  "create": false,
@@ -5784,6 +6102,7 @@
5784
6102
  }
5785
6103
  }
5786
6104
  },
6105
+ "x-f5xc-description-short": "Most recently observed status of object.",
5787
6106
  "x-f5xc-minimum-configuration": {
5788
6107
  "description": "Minimum configuration for geo_configStatusObject",
5789
6108
  "required_fields": [
@@ -5812,6 +6131,8 @@
5812
6131
  "x-displayname": "Kind",
5813
6132
  "x-ves-example": "Virtual_site.",
5814
6133
  "x-f5xc-example": "virtual_site",
6134
+ "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\")",
6135
+ "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\").",
5815
6136
  "minLength": 0,
5816
6137
  "maxLength": 14,
5817
6138
  "x-f5xc-required-for": {
@@ -5823,7 +6144,7 @@
5823
6144
  "readOnly": true,
5824
6145
  "x-original-maxLength": 1024,
5825
6146
  "x-reconciled-from-discovery": true,
5826
- "x-reconciled-at": "2026-01-05T14:38:23.458953+00:00"
6147
+ "x-reconciled-at": "2026-01-07T15:28:41.450750+00:00"
5827
6148
  },
5828
6149
  "name": {
5829
6150
  "type": "string",
@@ -5832,6 +6153,8 @@
5832
6153
  "x-displayname": "Name",
5833
6154
  "x-ves-example": "Contactus-route.",
5834
6155
  "x-f5xc-example": "contactus-route",
6156
+ "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.",
6157
+ "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.",
5835
6158
  "minLength": 0,
5836
6159
  "maxLength": 16,
5837
6160
  "x-f5xc-required-for": {
@@ -5842,7 +6165,7 @@
5842
6165
  },
5843
6166
  "x-original-maxLength": 1024,
5844
6167
  "x-reconciled-from-discovery": true,
5845
- "x-reconciled-at": "2026-01-05T14:38:23.458958+00:00"
6168
+ "x-reconciled-at": "2026-01-07T15:28:41.450756+00:00"
5846
6169
  },
5847
6170
  "namespace": {
5848
6171
  "type": "string",
@@ -5851,6 +6174,8 @@
5851
6174
  "x-displayname": "Namespace",
5852
6175
  "x-ves-example": "Ns1",
5853
6176
  "x-f5xc-example": "ns1",
6177
+ "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.",
6178
+ "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.",
5854
6179
  "minLength": 0,
5855
6180
  "maxLength": 6,
5856
6181
  "x-f5xc-required-for": {
@@ -5861,7 +6186,7 @@
5861
6186
  },
5862
6187
  "x-original-maxLength": 1024,
5863
6188
  "x-reconciled-from-discovery": true,
5864
- "x-reconciled-at": "2026-01-05T14:38:23.458963+00:00"
6189
+ "x-reconciled-at": "2026-01-07T15:28:41.450760+00:00"
5865
6190
  },
5866
6191
  "tenant": {
5867
6192
  "type": "string",
@@ -5870,6 +6195,8 @@
5870
6195
  "x-displayname": "Tenant",
5871
6196
  "x-ves-example": "Example-corp.",
5872
6197
  "x-f5xc-example": "example-corp",
6198
+ "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.",
6199
+ "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.",
5873
6200
  "minLength": 0,
5874
6201
  "maxLength": 18,
5875
6202
  "x-f5xc-required-for": {
@@ -5882,7 +6209,7 @@
5882
6209
  "x-field-mutability": "read-only",
5883
6210
  "x-original-maxLength": 1024,
5884
6211
  "x-reconciled-from-discovery": true,
5885
- "x-reconciled-at": "2026-01-05T14:38:23.458968+00:00"
6212
+ "x-reconciled-at": "2026-01-07T15:28:41.450765+00:00"
5886
6213
  },
5887
6214
  "uid": {
5888
6215
  "type": "string",
@@ -5891,6 +6218,8 @@
5891
6218
  "x-displayname": "UID",
5892
6219
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5893
6220
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
6221
+ "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.",
6222
+ "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.",
5894
6223
  "minLength": 0,
5895
6224
  "maxLength": 36,
5896
6225
  "x-f5xc-required-for": {
@@ -5904,9 +6233,11 @@
5904
6233
  "x-original-maxLength": 1024,
5905
6234
  "format": "uuid",
5906
6235
  "x-reconciled-from-discovery": true,
5907
- "x-reconciled-at": "2026-01-05T14:38:23.458974+00:00"
6236
+ "x-reconciled-at": "2026-01-07T15:28:41.450771+00:00"
5908
6237
  }
5909
6238
  },
6239
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
6240
+ "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...",
5910
6241
  "x-f5xc-minimum-configuration": {
5911
6242
  "description": "Minimum configuration for ioschemaObjectRefType",
5912
6243
  "required_fields": [
@@ -5942,6 +6273,7 @@
5942
6273
  "x-validation-rules": {
5943
6274
  "ves.io.schema.rules.message.required": "true"
5944
6275
  },
6276
+ "x-f5xc-example": "api.example.com",
5945
6277
  "minLength": 0,
5946
6278
  "maxLength": 1024,
5947
6279
  "x-f5xc-required-for": {
@@ -6074,6 +6406,7 @@
6074
6406
  "$ref": "#/components/schemas/ioschemaObjectRefType"
6075
6407
  },
6076
6408
  "x-displayname": "Deleted Referred Objects.",
6409
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6077
6410
  "x-f5xc-required-for": {
6078
6411
  "minimum_config": false,
6079
6412
  "create": false,
@@ -6089,6 +6422,7 @@
6089
6422
  "$ref": "#/components/schemas/ioschemaObjectRefType"
6090
6423
  },
6091
6424
  "x-displayname": "Disabled Referred Objects.",
6425
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6092
6426
  "x-f5xc-required-for": {
6093
6427
  "minimum_config": false,
6094
6428
  "create": false,
@@ -6107,6 +6441,7 @@
6107
6441
  "$ref": "#/components/schemas/ioschemaObjectRefType"
6108
6442
  },
6109
6443
  "x-displayname": "Referring Objects.",
6444
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
6110
6445
  "x-f5xc-required-for": {
6111
6446
  "minimum_config": false,
6112
6447
  "create": false,
@@ -6125,6 +6460,8 @@
6125
6460
  "$ref": "#/components/schemas/lma_regionStatusObject"
6126
6461
  },
6127
6462
  "x-displayname": "Status",
6463
+ "x-f5xc-example": "active",
6464
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6128
6465
  "x-f5xc-required-for": {
6129
6466
  "minimum_config": false,
6130
6467
  "create": false,
@@ -6134,7 +6471,7 @@
6134
6471
  "maxLength": 17,
6135
6472
  "minLength": 17,
6136
6473
  "x-reconciled-from-discovery": true,
6137
- "x-reconciled-at": "2026-01-05T14:38:33.866745+00:00"
6474
+ "x-reconciled-at": "2026-01-07T15:28:53.424896+00:00"
6138
6475
  },
6139
6476
  "system_metadata": {
6140
6477
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -6170,6 +6507,8 @@
6170
6507
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
6171
6508
  ],
6172
6509
  "default": "GET_RSP_FORMAT_DEFAULT",
6510
+ "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...",
6511
+ "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...",
6173
6512
  "x-f5xc-minimum-configuration": {
6174
6513
  "description": "Minimum configuration for lma_regionGetResponseFormatCode",
6175
6514
  "required_fields": [],
@@ -6250,6 +6589,8 @@
6250
6589
  "ves.io.schema.rules.message.required": "true",
6251
6590
  "ves.io.schema.rules.string.max_len": "8096"
6252
6591
  },
6592
+ "x-f5xc-description-short": "Servers in a Kafka cluster that a client should use to bootstrap its connection to the cluster.",
6593
+ "x-f5xc-description-medium": "Servers in a Kafka cluster that a client should use to bootstrap its connection to the cluster. Required: YES.",
6253
6594
  "x-f5xc-required-for": {
6254
6595
  "minimum_config": false,
6255
6596
  "create": false,
@@ -6285,6 +6626,7 @@
6285
6626
  "$ref": "#/components/schemas/schemaErrorType"
6286
6627
  },
6287
6628
  "x-displayname": "Errors",
6629
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
6288
6630
  "x-f5xc-required-for": {
6289
6631
  "minimum_config": false,
6290
6632
  "create": false,
@@ -6300,6 +6642,8 @@
6300
6642
  "$ref": "#/components/schemas/lma_regionListResponseItem"
6301
6643
  },
6302
6644
  "x-displayname": "Items",
6645
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
6646
+ "x-f5xc-description-short": "Items represents the collection in response.",
6303
6647
  "x-f5xc-required-for": {
6304
6648
  "minimum_config": false,
6305
6649
  "create": false,
@@ -6333,6 +6677,8 @@
6333
6677
  "description": "The set of annotations present on this lma_region.",
6334
6678
  "title": "Annotations.",
6335
6679
  "x-displayname": "Annotations.",
6680
+ "x-f5xc-example": "{\"key\": \"value\"}",
6681
+ "x-f5xc-description-short": "The set of annotations present on this lma_region.",
6336
6682
  "x-f5xc-required-for": {
6337
6683
  "minimum_config": false,
6338
6684
  "create": false,
@@ -6345,6 +6691,7 @@
6345
6691
  "description": "The description set for this lma_region.",
6346
6692
  "title": "Description.",
6347
6693
  "x-displayname": "Description.",
6694
+ "x-f5xc-description-short": "The description set for this lma_region.",
6348
6695
  "minLength": 0,
6349
6696
  "maxLength": 0,
6350
6697
  "x-f5xc-required-for": {
@@ -6355,7 +6702,7 @@
6355
6702
  },
6356
6703
  "x-original-maxLength": 1024,
6357
6704
  "x-reconciled-from-discovery": true,
6358
- "x-reconciled-at": "2026-01-05T14:38:33.866777+00:00"
6705
+ "x-reconciled-at": "2026-01-07T15:28:53.424916+00:00"
6359
6706
  },
6360
6707
  "disabled": {
6361
6708
  "type": "boolean",
@@ -6363,6 +6710,8 @@
6363
6710
  "title": "Disabled",
6364
6711
  "format": "boolean",
6365
6712
  "x-displayname": "Disabled",
6713
+ "x-f5xc-example": "True",
6714
+ "x-f5xc-description-short": "Value of true indicates lma_region is administratively disabled.",
6366
6715
  "x-f5xc-required-for": {
6367
6716
  "minimum_config": false,
6368
6717
  "create": false,
@@ -6378,6 +6727,8 @@
6378
6727
  "description": "The set of labels present on this lma_region.",
6379
6728
  "title": "Labels",
6380
6729
  "x-displayname": "Labels",
6730
+ "x-f5xc-example": "{\"key\": \"value\"}",
6731
+ "x-f5xc-description-short": "The set of labels present on this lma_region.",
6381
6732
  "x-f5xc-required-for": {
6382
6733
  "minimum_config": false,
6383
6734
  "create": false,
@@ -6405,7 +6756,7 @@
6405
6756
  },
6406
6757
  "x-original-maxLength": 1024,
6407
6758
  "x-reconciled-from-discovery": true,
6408
- "x-reconciled-at": "2026-01-05T14:38:33.866788+00:00"
6759
+ "x-reconciled-at": "2026-01-07T15:28:53.424928+00:00"
6409
6760
  },
6410
6761
  "namespace": {
6411
6762
  "type": "string",
@@ -6424,7 +6775,7 @@
6424
6775
  },
6425
6776
  "x-original-maxLength": 1024,
6426
6777
  "x-reconciled-from-discovery": true,
6427
- "x-reconciled-at": "2026-01-05T14:38:33.866792+00:00"
6778
+ "x-reconciled-at": "2026-01-07T15:28:53.424933+00:00"
6428
6779
  },
6429
6780
  "owner_view": {
6430
6781
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -6437,6 +6788,7 @@
6437
6788
  "$ref": "#/components/schemas/lma_regionStatusObject"
6438
6789
  },
6439
6790
  "x-displayname": "Status",
6791
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6440
6792
  "x-f5xc-required-for": {
6441
6793
  "minimum_config": false,
6442
6794
  "create": false,
@@ -6465,7 +6817,7 @@
6465
6817
  "x-field-mutability": "read-only",
6466
6818
  "x-original-maxLength": 1024,
6467
6819
  "x-reconciled-from-discovery": true,
6468
- "x-reconciled-at": "2026-01-05T14:38:33.866801+00:00"
6820
+ "x-reconciled-at": "2026-01-07T15:28:53.424942+00:00"
6469
6821
  },
6470
6822
  "uid": {
6471
6823
  "type": "string",
@@ -6486,9 +6838,11 @@
6486
6838
  "x-original-maxLength": 1024,
6487
6839
  "format": "uuid",
6488
6840
  "x-reconciled-from-discovery": true,
6489
- "x-reconciled-at": "2026-01-05T14:38:33.866806+00:00"
6841
+ "x-reconciled-at": "2026-01-07T15:28:53.424947+00:00"
6490
6842
  }
6491
6843
  },
6844
+ "x-f5xc-description-short": "By default a summary of lma_region is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6845
+ "x-f5xc-description-medium": "By default a summary of lma_region is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
6492
6846
  "x-f5xc-minimum-configuration": {
6493
6847
  "description": "Minimum configuration for lma_regionListResponseItem",
6494
6848
  "required_fields": [
@@ -6528,6 +6882,7 @@
6528
6882
  "$ref": "#/components/schemas/schemaConditionType"
6529
6883
  },
6530
6884
  "x-displayname": "Conditions.",
6885
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
6531
6886
  "x-f5xc-required-for": {
6532
6887
  "minimum_config": false,
6533
6888
  "create": false,
@@ -6554,6 +6909,7 @@
6554
6909
  }
6555
6910
  }
6556
6911
  },
6912
+ "x-f5xc-description-short": "Most recently observed status of object.",
6557
6913
  "x-f5xc-minimum-configuration": {
6558
6914
  "description": "Minimum configuration for lma_regionStatusObject",
6559
6915
  "required_fields": [
@@ -6583,6 +6939,8 @@
6583
6939
  "x-displayname": "Decryption Provider.",
6584
6940
  "x-ves-example": "Value",
6585
6941
  "x-f5xc-example": "value",
6942
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
6943
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
6586
6944
  "minLength": 0,
6587
6945
  "maxLength": 1024,
6588
6946
  "x-f5xc-required-for": {
@@ -6608,6 +6966,8 @@
6608
6966
  "ves.io.schema.rules.message.required": "true",
6609
6967
  "ves.io.schema.rules.string.uri_ref": "true"
6610
6968
  },
6969
+ "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.",
6970
+ "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.",
6611
6971
  "minLength": 0,
6612
6972
  "maxLength": 4,
6613
6973
  "x-f5xc-required-for": {
@@ -6618,7 +6978,7 @@
6618
6978
  },
6619
6979
  "x-original-maxLength": 1024,
6620
6980
  "x-reconciled-from-discovery": true,
6621
- "x-reconciled-at": "2026-01-05T14:38:33.866825+00:00"
6981
+ "x-reconciled-at": "2026-01-07T15:28:53.424966+00:00"
6622
6982
  },
6623
6983
  "store_provider": {
6624
6984
  "type": "string",
@@ -6627,6 +6987,8 @@
6627
6987
  "x-displayname": "Store Provider.",
6628
6988
  "x-ves-example": "Value",
6629
6989
  "x-f5xc-example": "value",
6990
+ "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...",
6991
+ "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:///.",
6630
6992
  "minLength": 0,
6631
6993
  "maxLength": 1024,
6632
6994
  "x-f5xc-required-for": {
@@ -6637,6 +6999,7 @@
6637
6999
  }
6638
7000
  }
6639
7001
  },
7002
+ "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
6640
7003
  "x-f5xc-minimum-configuration": {
6641
7004
  "description": "Minimum configuration for schemaBlindfoldSecretInfoType",
6642
7005
  "required_fields": [
@@ -6666,6 +7029,8 @@
6666
7029
  "x-displayname": "Provider",
6667
7030
  "x-ves-example": "Box-provider.",
6668
7031
  "x-f5xc-example": "box-provider",
7032
+ "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...",
7033
+ "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:///.",
6669
7034
  "minLength": 0,
6670
7035
  "maxLength": 8,
6671
7036
  "x-f5xc-required-for": {
@@ -6676,7 +7041,7 @@
6676
7041
  },
6677
7042
  "x-original-maxLength": 1024,
6678
7043
  "x-reconciled-from-discovery": true,
6679
- "x-reconciled-at": "2026-01-05T14:38:33.866832+00:00"
7044
+ "x-reconciled-at": "2026-01-07T15:28:53.424973+00:00"
6680
7045
  },
6681
7046
  "url": {
6682
7047
  "type": "string",
@@ -6697,6 +7062,8 @@
6697
7062
  "ves.io.schema.rules.string.max_bytes": "131072",
6698
7063
  "ves.io.schema.rules.string.uri_ref": "true"
6699
7064
  },
7065
+ "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
7066
+ "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.",
6700
7067
  "format": "uri",
6701
7068
  "minLength": 0,
6702
7069
  "x-f5xc-required-for": {
@@ -6707,6 +7074,7 @@
6707
7074
  }
6708
7075
  }
6709
7076
  },
7077
+ "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
6710
7078
  "x-f5xc-minimum-configuration": {
6711
7079
  "description": "Minimum configuration for schemaClearSecretInfoType",
6712
7080
  "required_fields": [
@@ -6729,6 +7097,8 @@
6729
7097
  "EncodingBase64"
6730
7098
  ],
6731
7099
  "default": "EncodingNone",
7100
+ "x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
7101
+ "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.",
6732
7102
  "x-f5xc-minimum-configuration": {
6733
7103
  "description": "Minimum configuration for schemaSecretEncodingType",
6734
7104
  "required_fields": [],
@@ -6754,6 +7124,7 @@
6754
7124
  "$ref": "#/components/schemas/schemaClearSecretInfoType"
6755
7125
  }
6756
7126
  },
7127
+ "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
6757
7128
  "x-f5xc-minimum-configuration": {
6758
7129
  "description": "Minimum configuration for schemaSecretType",
6759
7130
  "required_fields": [
@@ -6777,6 +7148,8 @@
6777
7148
  "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.",
6778
7149
  "title": "Key",
6779
7150
  "x-f5xc-example": "key_pem",
7151
+ "x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
7152
+ "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.",
6780
7153
  "minLength": 0,
6781
7154
  "maxLength": 16,
6782
7155
  "x-f5xc-required-for": {
@@ -6787,13 +7160,14 @@
6787
7160
  },
6788
7161
  "x-original-maxLength": 1024,
6789
7162
  "x-reconciled-from-discovery": true,
6790
- "x-reconciled-at": "2026-01-05T14:38:33.866943+00:00"
7163
+ "x-reconciled-at": "2026-01-07T15:28:53.425085+00:00"
6791
7164
  },
6792
7165
  "location": {
6793
7166
  "type": "string",
6794
7167
  "description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
6795
7168
  "title": "Location",
6796
7169
  "x-f5xc-example": "v1/data/vhost_key",
7170
+ "x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
6797
7171
  "minLength": 0,
6798
7172
  "maxLength": 4,
6799
7173
  "x-f5xc-required-for": {
@@ -6804,13 +7178,15 @@
6804
7178
  },
6805
7179
  "x-original-maxLength": 1024,
6806
7180
  "x-reconciled-from-discovery": true,
6807
- "x-reconciled-at": "2026-01-05T14:38:33.866947+00:00"
7181
+ "x-reconciled-at": "2026-01-07T15:28:53.425089+00:00"
6808
7182
  },
6809
7183
  "provider": {
6810
7184
  "type": "string",
6811
7185
  "description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
6812
7186
  "title": "Provider",
6813
7187
  "x-f5xc-example": "vault-vh-provider",
7188
+ "x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
7189
+ "x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
6814
7190
  "minLength": 0,
6815
7191
  "maxLength": 8,
6816
7192
  "x-f5xc-required-for": {
@@ -6821,7 +7197,7 @@
6821
7197
  },
6822
7198
  "x-original-maxLength": 1024,
6823
7199
  "x-reconciled-from-discovery": true,
6824
- "x-reconciled-at": "2026-01-05T14:38:33.866952+00:00"
7200
+ "x-reconciled-at": "2026-01-07T15:28:53.425094+00:00"
6825
7201
  },
6826
7202
  "secret_encoding": {
6827
7203
  "$ref": "#/components/schemas/schemaSecretEncodingType"
@@ -6832,6 +7208,8 @@
6832
7208
  "title": "Version",
6833
7209
  "format": "int64",
6834
7210
  "x-f5xc-example": "1",
7211
+ "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.",
7212
+ "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.",
6835
7213
  "minimum": 0,
6836
7214
  "maximum": 2147483647,
6837
7215
  "x-f5xc-required-for": {
@@ -6843,9 +7221,11 @@
6843
7221
  "maxLength": 1,
6844
7222
  "minLength": 1,
6845
7223
  "x-reconciled-from-discovery": true,
6846
- "x-reconciled-at": "2026-01-05T14:38:33.866958+00:00"
7224
+ "x-reconciled-at": "2026-01-07T15:28:53.425100+00:00"
6847
7225
  }
6848
7226
  },
7227
+ "x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
7228
+ "x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
6849
7229
  "x-f5xc-minimum-configuration": {
6850
7230
  "description": "Minimum configuration for schemaVaultSecretInfoType",
6851
7231
  "required_fields": [
@@ -6872,6 +7252,7 @@
6872
7252
  "description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
6873
7253
  "title": "Name",
6874
7254
  "x-f5xc-example": "ChargeBack-API-Key",
7255
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
6875
7256
  "minLength": 0,
6876
7257
  "maxLength": 16,
6877
7258
  "x-f5xc-required-for": {
@@ -6882,9 +7263,10 @@
6882
7263
  },
6883
7264
  "x-original-maxLength": 1024,
6884
7265
  "x-reconciled-from-discovery": true,
6885
- "x-reconciled-at": "2026-01-05T14:38:33.866983+00:00"
7266
+ "x-reconciled-at": "2026-01-07T15:28:53.425124+00:00"
6886
7267
  }
6887
7268
  },
7269
+ "x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
6888
7270
  "x-f5xc-minimum-configuration": {
6889
7271
  "description": "Minimum configuration for schemaWingmanSecretInfoType",
6890
7272
  "required_fields": [
@@ -6924,6 +7306,8 @@
6924
7306
  "ves.io.schema.rules.repeated.max_items": "17",
6925
7307
  "ves.io.schema.rules.repeated.unique": "true"
6926
7308
  },
7309
+ "x-f5xc-description-short": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
7310
+ "x-f5xc-description-medium": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
6927
7311
  "x-f5xc-required-for": {
6928
7312
  "minimum_config": false,
6929
7313
  "create": false,
@@ -6944,6 +7328,8 @@
6944
7328
  "x-validation-rules": {
6945
7329
  "ves.io.schema.rules.repeated.unique": "true"
6946
7330
  },
7331
+ "x-f5xc-example": "{\"key\": \"value\"}",
7332
+ "x-f5xc-description-short": "Select your custom data types to be monitored in the API discovery.",
6947
7333
  "x-f5xc-required-for": {
6948
7334
  "minimum_config": false,
6949
7335
  "create": false,
@@ -6970,6 +7356,9 @@
6970
7356
  "ves.io.schema.rules.repeated.unique": "true",
6971
7357
  "ves.io.schema.rules.string.max_len": "64"
6972
7358
  },
7359
+ "x-f5xc-example": "{\"key\": \"value\"}",
7360
+ "x-f5xc-description-short": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
7361
+ "x-f5xc-description-medium": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
6973
7362
  "x-f5xc-required-for": {
6974
7363
  "minimum_config": false,
6975
7364
  "create": false,
@@ -6978,6 +7367,7 @@
6978
7367
  }
6979
7368
  }
6980
7369
  },
7370
+ "x-f5xc-description-short": "Create sensitive_data_policy creates a new object in the storage backend for metadata.namespace.",
6981
7371
  "x-f5xc-minimum-configuration": {
6982
7372
  "description": "Minimum configuration for schemasensitive_data_policyCreateSpecType",
6983
7373
  "required_fields": [
@@ -7019,6 +7409,8 @@
7019
7409
  "ves.io.schema.rules.repeated.max_items": "17",
7020
7410
  "ves.io.schema.rules.repeated.unique": "true"
7021
7411
  },
7412
+ "x-f5xc-description-short": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
7413
+ "x-f5xc-description-medium": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
7022
7414
  "x-f5xc-required-for": {
7023
7415
  "minimum_config": false,
7024
7416
  "create": false,
@@ -7039,6 +7431,8 @@
7039
7431
  "x-validation-rules": {
7040
7432
  "ves.io.schema.rules.repeated.unique": "true"
7041
7433
  },
7434
+ "x-f5xc-example": "{\"key\": \"value\"}",
7435
+ "x-f5xc-description-short": "Select your custom data types to be monitored in the API discovery.",
7042
7436
  "x-f5xc-required-for": {
7043
7437
  "minimum_config": false,
7044
7438
  "create": false,
@@ -7065,6 +7459,9 @@
7065
7459
  "ves.io.schema.rules.repeated.unique": "true",
7066
7460
  "ves.io.schema.rules.string.max_len": "64"
7067
7461
  },
7462
+ "x-f5xc-example": "{\"key\": \"value\"}",
7463
+ "x-f5xc-description-short": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
7464
+ "x-f5xc-description-medium": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
7068
7465
  "x-f5xc-required-for": {
7069
7466
  "minimum_config": false,
7070
7467
  "create": false,
@@ -7073,6 +7470,7 @@
7073
7470
  }
7074
7471
  }
7075
7472
  },
7473
+ "x-f5xc-description-short": "GET sensitive_data_policy reads a given object from storage backend for metadata.namespace.",
7076
7474
  "x-f5xc-minimum-configuration": {
7077
7475
  "description": "Minimum configuration for schemasensitive_data_policyGetSpecType",
7078
7476
  "required_fields": [
@@ -7114,6 +7512,8 @@
7114
7512
  "ves.io.schema.rules.repeated.max_items": "17",
7115
7513
  "ves.io.schema.rules.repeated.unique": "true"
7116
7514
  },
7515
+ "x-f5xc-description-short": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
7516
+ "x-f5xc-description-medium": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
7117
7517
  "x-f5xc-required-for": {
7118
7518
  "minimum_config": false,
7119
7519
  "create": false,
@@ -7134,6 +7534,8 @@
7134
7534
  "x-validation-rules": {
7135
7535
  "ves.io.schema.rules.repeated.unique": "true"
7136
7536
  },
7537
+ "x-f5xc-example": "{\"key\": \"value\"}",
7538
+ "x-f5xc-description-short": "Select your custom data types to be monitored in the API discovery.",
7137
7539
  "x-f5xc-required-for": {
7138
7540
  "minimum_config": false,
7139
7541
  "create": false,
@@ -7160,6 +7562,9 @@
7160
7562
  "ves.io.schema.rules.repeated.unique": "true",
7161
7563
  "ves.io.schema.rules.string.max_len": "64"
7162
7564
  },
7565
+ "x-f5xc-example": "{\"key\": \"value\"}",
7566
+ "x-f5xc-description-short": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
7567
+ "x-f5xc-description-medium": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
7163
7568
  "x-f5xc-required-for": {
7164
7569
  "minimum_config": false,
7165
7570
  "create": false,
@@ -7168,6 +7573,8 @@
7168
7573
  }
7169
7574
  }
7170
7575
  },
7576
+ "x-f5xc-description-short": "Replace sensitive_data_policy replaces an existing object in the storage backend for metadata.namespace.",
7577
+ "x-f5xc-description-medium": "Replace sensitive_data_policy replaces an existing object in the storage backend for metadata.namespace.",
7171
7578
  "x-f5xc-minimum-configuration": {
7172
7579
  "description": "Minimum configuration for schemasensitive_data_policyReplaceSpecType",
7173
7580
  "required_fields": [
@@ -7197,6 +7604,7 @@
7197
7604
  "$ref": "#/components/schemas/schemaConditionType"
7198
7605
  },
7199
7606
  "x-displayname": "Conditions.",
7607
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
7200
7608
  "x-f5xc-required-for": {
7201
7609
  "minimum_config": false,
7202
7610
  "create": false,
@@ -7223,6 +7631,7 @@
7223
7631
  }
7224
7632
  }
7225
7633
  },
7634
+ "x-f5xc-description-short": "Most recently observed status of object.",
7226
7635
  "x-f5xc-minimum-configuration": {
7227
7636
  "description": "Minimum configuration for schemasensitive_data_policyStatusObject",
7228
7637
  "required_fields": [
@@ -7264,6 +7673,8 @@
7264
7673
  "ves.io.schema.rules.string.max_bytes": "128",
7265
7674
  "ves.io.schema.rules.string.min_bytes": "1"
7266
7675
  },
7676
+ "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.",
7677
+ "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.",
7267
7678
  "x-f5xc-required-for": {
7268
7679
  "minimum_config": false,
7269
7680
  "create": false,
@@ -7272,7 +7683,7 @@
7272
7683
  },
7273
7684
  "x-original-maxLength": 128,
7274
7685
  "x-reconciled-from-discovery": true,
7275
- "x-reconciled-at": "2026-01-05T14:38:56.016904+00:00"
7686
+ "x-reconciled-at": "2026-01-07T15:29:18.176392+00:00"
7276
7687
  },
7277
7688
  "namespace": {
7278
7689
  "type": "string",
@@ -7288,6 +7699,8 @@
7288
7699
  "x-validation-rules": {
7289
7700
  "ves.io.schema.rules.string.max_bytes": "64"
7290
7701
  },
7702
+ "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.",
7703
+ "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.",
7291
7704
  "minLength": 0,
7292
7705
  "x-f5xc-required-for": {
7293
7706
  "minimum_config": false,
@@ -7297,7 +7710,7 @@
7297
7710
  },
7298
7711
  "x-original-maxLength": 64,
7299
7712
  "x-reconciled-from-discovery": true,
7300
- "x-reconciled-at": "2026-01-05T14:38:56.016908+00:00"
7713
+ "x-reconciled-at": "2026-01-07T15:29:18.176397+00:00"
7301
7714
  },
7302
7715
  "tenant": {
7303
7716
  "type": "string",
@@ -7313,6 +7726,8 @@
7313
7726
  "x-validation-rules": {
7314
7727
  "ves.io.schema.rules.string.max_bytes": "64"
7315
7728
  },
7729
+ "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.",
7730
+ "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.",
7316
7731
  "minLength": 0,
7317
7732
  "x-f5xc-required-for": {
7318
7733
  "minimum_config": false,
@@ -7324,9 +7739,11 @@
7324
7739
  "x-field-mutability": "read-only",
7325
7740
  "x-original-maxLength": 64,
7326
7741
  "x-reconciled-from-discovery": true,
7327
- "x-reconciled-at": "2026-01-05T14:38:56.016913+00:00"
7742
+ "x-reconciled-at": "2026-01-07T15:29:18.176401+00:00"
7328
7743
  }
7329
7744
  },
7745
+ "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
7746
+ "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.",
7330
7747
  "x-f5xc-minimum-configuration": {
7331
7748
  "description": "Minimum configuration for schemaviewsObjectRefType",
7332
7749
  "required_fields": [
@@ -7432,6 +7849,7 @@
7432
7849
  "title": "Fail_if_referred.",
7433
7850
  "format": "boolean",
7434
7851
  "x-displayname": "Fail-If-Referred.",
7852
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
7435
7853
  "x-f5xc-required-for": {
7436
7854
  "minimum_config": false,
7437
7855
  "create": false,
@@ -7456,7 +7874,7 @@
7456
7874
  },
7457
7875
  "x-original-maxLength": 1024,
7458
7876
  "x-reconciled-from-discovery": true,
7459
- "x-reconciled-at": "2026-01-05T14:38:56.016928+00:00"
7877
+ "x-reconciled-at": "2026-01-07T15:29:18.176415+00:00"
7460
7878
  },
7461
7879
  "namespace": {
7462
7880
  "type": "string",
@@ -7465,6 +7883,7 @@
7465
7883
  "x-displayname": "Namespace",
7466
7884
  "x-ves-example": "Ns1",
7467
7885
  "x-f5xc-example": "ns1",
7886
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
7468
7887
  "minLength": 0,
7469
7888
  "maxLength": 6,
7470
7889
  "x-f5xc-required-for": {
@@ -7475,7 +7894,7 @@
7475
7894
  },
7476
7895
  "x-original-maxLength": 1024,
7477
7896
  "x-reconciled-from-discovery": true,
7478
- "x-reconciled-at": "2026-01-05T14:38:56.016932+00:00"
7897
+ "x-reconciled-at": "2026-01-07T15:29:18.176419+00:00"
7479
7898
  }
7480
7899
  },
7481
7900
  "x-f5xc-minimum-configuration": {
@@ -7510,6 +7929,7 @@
7510
7929
  "$ref": "#/components/schemas/ioschemaObjectRefType"
7511
7930
  },
7512
7931
  "x-displayname": "Deleted Referred Objects.",
7932
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
7513
7933
  "x-f5xc-required-for": {
7514
7934
  "minimum_config": false,
7515
7935
  "create": false,
@@ -7525,6 +7945,7 @@
7525
7945
  "$ref": "#/components/schemas/ioschemaObjectRefType"
7526
7946
  },
7527
7947
  "x-displayname": "Disabled Referred Objects.",
7948
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
7528
7949
  "x-f5xc-required-for": {
7529
7950
  "minimum_config": false,
7530
7951
  "create": false,
@@ -7543,6 +7964,7 @@
7543
7964
  "$ref": "#/components/schemas/ioschemaObjectRefType"
7544
7965
  },
7545
7966
  "x-displayname": "Referring Objects.",
7967
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
7546
7968
  "x-f5xc-required-for": {
7547
7969
  "minimum_config": false,
7548
7970
  "create": false,
@@ -7564,6 +7986,8 @@
7564
7986
  "$ref": "#/components/schemas/schemasensitive_data_policyStatusObject"
7565
7987
  },
7566
7988
  "x-displayname": "Status",
7989
+ "x-f5xc-example": "active",
7990
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
7567
7991
  "x-f5xc-required-for": {
7568
7992
  "minimum_config": false,
7569
7993
  "create": false,
@@ -7573,7 +7997,7 @@
7573
7997
  "maxLength": 17,
7574
7998
  "minLength": 17,
7575
7999
  "x-reconciled-from-discovery": true,
7576
- "x-reconciled-at": "2026-01-05T14:38:56.016947+00:00"
8000
+ "x-reconciled-at": "2026-01-07T15:29:18.176433+00:00"
7577
8001
  },
7578
8002
  "system_metadata": {
7579
8003
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -7613,6 +8037,8 @@
7613
8037
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
7614
8038
  ],
7615
8039
  "default": "GET_RSP_FORMAT_DEFAULT",
8040
+ "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...",
8041
+ "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...",
7616
8042
  "x-f5xc-minimum-configuration": {
7617
8043
  "description": "Minimum configuration for sensitive_data_policyGetResponseFormatCode",
7618
8044
  "required_fields": [],
@@ -7638,6 +8064,7 @@
7638
8064
  "$ref": "#/components/schemas/schemaErrorType"
7639
8065
  },
7640
8066
  "x-displayname": "Errors",
8067
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
7641
8068
  "x-f5xc-required-for": {
7642
8069
  "minimum_config": false,
7643
8070
  "create": false,
@@ -7653,6 +8080,8 @@
7653
8080
  "$ref": "#/components/schemas/sensitive_data_policyListResponseItem"
7654
8081
  },
7655
8082
  "x-displayname": "Items",
8083
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
8084
+ "x-f5xc-description-short": "Items represents the collection in response.",
7656
8085
  "x-f5xc-required-for": {
7657
8086
  "minimum_config": false,
7658
8087
  "create": false,
@@ -7686,6 +8115,8 @@
7686
8115
  "description": "The set of annotations present on this sensitive_data_policy.",
7687
8116
  "title": "Annotations.",
7688
8117
  "x-displayname": "Annotations.",
8118
+ "x-f5xc-example": "{\"key\": \"value\"}",
8119
+ "x-f5xc-description-short": "The set of annotations present on this sensitive_data_policy.",
7689
8120
  "x-f5xc-required-for": {
7690
8121
  "minimum_config": false,
7691
8122
  "create": false,
@@ -7698,6 +8129,7 @@
7698
8129
  "description": "The description set for this sensitive_data_policy.",
7699
8130
  "title": "Description.",
7700
8131
  "x-displayname": "Description.",
8132
+ "x-f5xc-description-short": "The description set for this sensitive_data_policy.",
7701
8133
  "minLength": 0,
7702
8134
  "maxLength": 0,
7703
8135
  "x-f5xc-required-for": {
@@ -7708,7 +8140,7 @@
7708
8140
  },
7709
8141
  "x-original-maxLength": 1024,
7710
8142
  "x-reconciled-from-discovery": true,
7711
- "x-reconciled-at": "2026-01-05T14:38:56.016959+00:00"
8143
+ "x-reconciled-at": "2026-01-07T15:29:18.176445+00:00"
7712
8144
  },
7713
8145
  "disabled": {
7714
8146
  "type": "boolean",
@@ -7716,6 +8148,8 @@
7716
8148
  "title": "Disabled",
7717
8149
  "format": "boolean",
7718
8150
  "x-displayname": "Disabled",
8151
+ "x-f5xc-example": "True",
8152
+ "x-f5xc-description-short": "Value of true indicates sensitive_data_policy is administratively disabled.",
7719
8153
  "x-f5xc-required-for": {
7720
8154
  "minimum_config": false,
7721
8155
  "create": false,
@@ -7731,6 +8165,8 @@
7731
8165
  "description": "The set of labels present on this sensitive_data_policy.",
7732
8166
  "title": "Labels",
7733
8167
  "x-displayname": "Labels",
8168
+ "x-f5xc-example": "{\"key\": \"value\"}",
8169
+ "x-f5xc-description-short": "The set of labels present on this sensitive_data_policy.",
7734
8170
  "x-f5xc-required-for": {
7735
8171
  "minimum_config": false,
7736
8172
  "create": false,
@@ -7758,7 +8194,7 @@
7758
8194
  },
7759
8195
  "x-original-maxLength": 1024,
7760
8196
  "x-reconciled-from-discovery": true,
7761
- "x-reconciled-at": "2026-01-05T14:38:56.016969+00:00"
8197
+ "x-reconciled-at": "2026-01-07T15:29:18.176454+00:00"
7762
8198
  },
7763
8199
  "namespace": {
7764
8200
  "type": "string",
@@ -7777,7 +8213,7 @@
7777
8213
  },
7778
8214
  "x-original-maxLength": 1024,
7779
8215
  "x-reconciled-from-discovery": true,
7780
- "x-reconciled-at": "2026-01-05T14:38:56.016974+00:00"
8216
+ "x-reconciled-at": "2026-01-07T15:29:18.176458+00:00"
7781
8217
  },
7782
8218
  "owner_view": {
7783
8219
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -7790,6 +8226,7 @@
7790
8226
  "$ref": "#/components/schemas/schemasensitive_data_policyStatusObject"
7791
8227
  },
7792
8228
  "x-displayname": "Status",
8229
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
7793
8230
  "x-f5xc-required-for": {
7794
8231
  "minimum_config": false,
7795
8232
  "create": false,
@@ -7818,7 +8255,7 @@
7818
8255
  "x-field-mutability": "read-only",
7819
8256
  "x-original-maxLength": 1024,
7820
8257
  "x-reconciled-from-discovery": true,
7821
- "x-reconciled-at": "2026-01-05T14:38:56.016982+00:00"
8258
+ "x-reconciled-at": "2026-01-07T15:29:18.176466+00:00"
7822
8259
  },
7823
8260
  "uid": {
7824
8261
  "type": "string",
@@ -7827,6 +8264,7 @@
7827
8264
  "x-displayname": "UID",
7828
8265
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
7829
8266
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
8267
+ "x-f5xc-description-short": "The unique uid of this sensitive_data_policy.",
7830
8268
  "minLength": 0,
7831
8269
  "maxLength": 36,
7832
8270
  "x-f5xc-required-for": {
@@ -7839,9 +8277,11 @@
7839
8277
  "x-original-maxLength": 1024,
7840
8278
  "format": "uuid",
7841
8279
  "x-reconciled-from-discovery": true,
7842
- "x-reconciled-at": "2026-01-05T14:38:56.016987+00:00"
8280
+ "x-reconciled-at": "2026-01-07T15:29:18.176471+00:00"
7843
8281
  }
7844
8282
  },
8283
+ "x-f5xc-description-short": "By default a summary of sensitive_data_policy is returned in 'List'.",
8284
+ "x-f5xc-description-medium": "By default a summary of sensitive_data_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
7845
8285
  "x-f5xc-minimum-configuration": {
7846
8286
  "description": "Minimum configuration for sensitive_data_policyListResponseItem",
7847
8287
  "required_fields": [