@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": "Ai Services",
5
5
  "description": "Query handling through inference routing with production and test modes. Positive and negative quality markers with detailed categorization capture assistant performance. Streaming connections support authenticated access, subscription lifecycles, and feature flags. IP provisioning services allocate infrastructure resources for model workloads across distributed systems.",
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": "Natural language processing with quality signals and anomaly monitoring. Token authentication for data stream subscriptions.",
16
- "x-f5xc-cli-domain": "ai_services"
16
+ "x-f5xc-cli-domain": "ai_services",
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
  {
@@ -273,6 +323,13 @@
273
323
  "latency": "low",
274
324
  "resource_usage": "low"
275
325
  }
326
+ },
327
+ "x-f5xc-discovered-response-time": {
328
+ "p50_ms": 1000,
329
+ "p95_ms": 3000,
330
+ "p99_ms": 8000,
331
+ "sample_count": 0,
332
+ "source": "estimate"
276
333
  }
277
334
  },
278
335
  "x-displayname": "AI Assistant APIs.",
@@ -480,6 +537,13 @@
480
537
  "latency": "low",
481
538
  "resource_usage": "low"
482
539
  }
540
+ },
541
+ "x-f5xc-discovered-response-time": {
542
+ "p50_ms": 1000,
543
+ "p95_ms": 3000,
544
+ "p99_ms": 8000,
545
+ "sample_count": 0,
546
+ "source": "estimate"
483
547
  }
484
548
  },
485
549
  "x-displayname": "AI Assistant APIs.",
@@ -687,6 +751,13 @@
687
751
  "latency": "low",
688
752
  "resource_usage": "low"
689
753
  }
754
+ },
755
+ "x-f5xc-discovered-response-time": {
756
+ "p50_ms": 1000,
757
+ "p95_ms": 3000,
758
+ "p99_ms": 8000,
759
+ "sample_count": 0,
760
+ "source": "estimate"
690
761
  }
691
762
  },
692
763
  "x-displayname": "AI Assistant APIs.",
@@ -894,6 +965,13 @@
894
965
  "latency": "low",
895
966
  "resource_usage": "low"
896
967
  }
968
+ },
969
+ "x-f5xc-discovered-response-time": {
970
+ "p50_ms": 1000,
971
+ "p95_ms": 3000,
972
+ "p99_ms": 8000,
973
+ "sample_count": 0,
974
+ "source": "estimate"
897
975
  }
898
976
  },
899
977
  "x-displayname": "AI Assistant APIs.",
@@ -1094,6 +1172,13 @@
1094
1172
  "latency": "low",
1095
1173
  "resource_usage": "low"
1096
1174
  }
1175
+ },
1176
+ "x-f5xc-discovered-response-time": {
1177
+ "p50_ms": 1000,
1178
+ "p95_ms": 3000,
1179
+ "p99_ms": 8000,
1180
+ "sample_count": 0,
1181
+ "source": "estimate"
1097
1182
  }
1098
1183
  },
1099
1184
  "x-displayname": "BFDP APIs",
@@ -1293,6 +1378,13 @@
1293
1378
  "latency": "low",
1294
1379
  "resource_usage": "low"
1295
1380
  }
1381
+ },
1382
+ "x-f5xc-discovered-response-time": {
1383
+ "p50_ms": 1000,
1384
+ "p95_ms": 3000,
1385
+ "p99_ms": 8000,
1386
+ "sample_count": 0,
1387
+ "source": "estimate"
1296
1388
  }
1297
1389
  },
1298
1390
  "x-displayname": "BFDP APIs",
@@ -1492,6 +1584,13 @@
1492
1584
  "latency": "low",
1493
1585
  "resource_usage": "low"
1494
1586
  }
1587
+ },
1588
+ "x-f5xc-discovered-response-time": {
1589
+ "p50_ms": 1000,
1590
+ "p95_ms": 3000,
1591
+ "p99_ms": 8000,
1592
+ "sample_count": 0,
1593
+ "source": "estimate"
1495
1594
  }
1496
1595
  },
1497
1596
  "x-displayname": "BFDP Subscription API.",
@@ -1691,6 +1790,13 @@
1691
1790
  "latency": "low",
1692
1791
  "resource_usage": "low"
1693
1792
  }
1793
+ },
1794
+ "x-f5xc-discovered-response-time": {
1795
+ "p50_ms": 1000,
1796
+ "p95_ms": 3000,
1797
+ "p99_ms": 8000,
1798
+ "sample_count": 0,
1799
+ "source": "estimate"
1694
1800
  }
1695
1801
  },
1696
1802
  "x-displayname": "BFDP Subscription API.",
@@ -1890,6 +1996,13 @@
1890
1996
  "latency": "low",
1891
1997
  "resource_usage": "low"
1892
1998
  }
1999
+ },
2000
+ "x-f5xc-discovered-response-time": {
2001
+ "p50_ms": 1000,
2002
+ "p95_ms": 3000,
2003
+ "p99_ms": 8000,
2004
+ "sample_count": 0,
2005
+ "source": "estimate"
1893
2006
  }
1894
2007
  },
1895
2008
  "x-displayname": "BFDP Subscription API.",
@@ -2087,6 +2200,13 @@
2087
2200
  "latency": "low",
2088
2201
  "resource_usage": "low"
2089
2202
  }
2203
+ },
2204
+ "x-f5xc-discovered-response-time": {
2205
+ "p50_ms": 1000,
2206
+ "p95_ms": 3000,
2207
+ "p99_ms": 8000,
2208
+ "sample_count": 0,
2209
+ "source": "estimate"
2090
2210
  }
2091
2211
  },
2092
2212
  "x-displayname": "Global IP Allocator.",
@@ -2277,6 +2397,13 @@
2277
2397
  "latency": "low",
2278
2398
  "resource_usage": "low"
2279
2399
  }
2400
+ },
2401
+ "x-f5xc-discovered-response-time": {
2402
+ "p50_ms": 500,
2403
+ "p95_ms": 1500,
2404
+ "p99_ms": 4000,
2405
+ "sample_count": 0,
2406
+ "source": "estimate"
2280
2407
  }
2281
2408
  },
2282
2409
  "x-displayname": "Global IP Allocator.",
@@ -2304,7 +2431,7 @@
2304
2431
  "properties": {
2305
2432
  "comment": {
2306
2433
  "type": "string",
2307
- "description": "",
2434
+ "description": "Configuration parameter for comment",
2308
2435
  "title": "Comment",
2309
2436
  "maxLength": 4096,
2310
2437
  "x-displayname": "Comment",
@@ -2331,6 +2458,7 @@
2331
2458
  "x-displayname": "Namespace",
2332
2459
  "x-ves-example": "System",
2333
2460
  "x-f5xc-example": "system",
2461
+ "x-f5xc-description-short": "Namespace of the HTTP Load Balancer for current request.",
2334
2462
  "minLength": 0,
2335
2463
  "maxLength": 6,
2336
2464
  "x-f5xc-required-for": {
@@ -2341,7 +2469,7 @@
2341
2469
  },
2342
2470
  "x-original-maxLength": 1024,
2343
2471
  "x-reconciled-from-discovery": true,
2344
- "x-reconciled-at": "2026-01-05T14:37:33.143462+00:00"
2472
+ "x-reconciled-at": "2026-01-07T15:27:43.841215+00:00"
2345
2473
  },
2346
2474
  "negative_feedback": {
2347
2475
  "$ref": "#/components/schemas/ai_assistantNegativeFeedbackDetails"
@@ -2436,6 +2564,7 @@
2436
2564
  "x-displayname": "Namespace",
2437
2565
  "x-ves-example": "System",
2438
2566
  "x-f5xc-example": "system",
2567
+ "x-f5xc-description-short": "Namespace of the HTTP Load Balancer for current request.",
2439
2568
  "minLength": 0,
2440
2569
  "maxLength": 6,
2441
2570
  "x-f5xc-required-for": {
@@ -2446,7 +2575,7 @@
2446
2575
  },
2447
2576
  "x-original-maxLength": 1024,
2448
2577
  "x-reconciled-from-discovery": true,
2449
- "x-reconciled-at": "2026-01-05T14:37:33.143483+00:00"
2578
+ "x-reconciled-at": "2026-01-07T15:27:43.841235+00:00"
2450
2579
  }
2451
2580
  },
2452
2581
  "x-f5xc-minimum-configuration": {
@@ -2505,6 +2634,7 @@
2505
2634
  "x-validation-rules": {
2506
2635
  "ves.io.schema.rules.repeated.unique": "true"
2507
2636
  },
2637
+ "x-f5xc-description-short": "Follow up Queries to be given as suggestion to users.",
2508
2638
  "x-f5xc-required-for": {
2509
2639
  "minimum_config": false,
2510
2640
  "create": false,
@@ -2580,7 +2710,7 @@
2580
2710
  "properties": {
2581
2711
  "remarks": {
2582
2712
  "type": "array",
2583
- "description": "",
2713
+ "description": "Configuration parameter for remarks",
2584
2714
  "title": "Remarks",
2585
2715
  "items": {
2586
2716
  "$ref": "#/components/schemas/ai_assistantNegativeFeedbackType"
@@ -2630,6 +2760,8 @@
2630
2760
  "default": "OTHER",
2631
2761
  "x-displayname": "",
2632
2762
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.NegativeFeedbackType",
2763
+ "x-f5xc-description-short": "X-displayName \"Negative Feedback Type\" Type of Negative Feedback - OTHER: x-displayName \"Other\" Other - INACCURATE_DATA: x-displayName \"Inaccurate...",
2764
+ "x-f5xc-description-medium": "X-displayName \"Negative Feedback Type\" Type of Negative Feedback - OTHER: x-displayName \"Other\" Other - INACCURATE_DATA: x-displayName \"Inaccurate data\" Inaccurate data - IRRELEVANT_CONTENT: x-displayName \"Irrelevant content\" Irrelevant content - POOR_FORMAT: x-displayName \"Poor format\" Poor...",
2633
2765
  "x-f5xc-minimum-configuration": {
2634
2766
  "description": "Minimum configuration for ai_assistantNegativeFeedbackType",
2635
2767
  "required_fields": [],
@@ -2653,6 +2785,8 @@
2653
2785
  "default": "UNIT_TYPE_NONE",
2654
2786
  "x-displayname": "Unit Type",
2655
2787
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.UnitType",
2788
+ "x-f5xc-description-short": "Unit Type defines the unit for each fields. - UNIT_TYPE_NONE: None None type - GB: GB - PERCENT: Percent - BYTE: Byte.",
2789
+ "x-f5xc-description-medium": "Unit Type defines the unit for each fields. - UNIT_TYPE_NONE: None None type - GB: GB - PERCENT: Percent - BYTE: Byte.",
2656
2790
  "x-f5xc-minimum-configuration": {
2657
2791
  "description": "Minimum configuration for ai_assistantcommonUnitType",
2658
2792
  "required_fields": [],
@@ -2676,6 +2810,8 @@
2676
2810
  "default": "ACTION_NONE",
2677
2811
  "x-displayname": "Action",
2678
2812
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.Action",
2813
+ "x-f5xc-description-short": "Action taken for the request - ACTION_NONE: None No action - ALLOW: Allow The request was allowed to pass - BLOCK: Block The request was blocked ...",
2814
+ "x-f5xc-description-medium": "Action taken for the request - ACTION_NONE: None No action - ALLOW: Allow The request was allowed to pass - BLOCK: Block The request was blocked - REDIRECT: Redirect The request was redirected.",
2679
2815
  "x-f5xc-minimum-configuration": {
2680
2816
  "description": "Minimum configuration for ai_assistantexplain_log_recordAction",
2681
2817
  "required_fields": [],
@@ -2722,6 +2858,8 @@
2722
2858
  "default": "COLOUR_TYPE_NONE",
2723
2859
  "x-displayname": "Colour Type.",
2724
2860
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.ColourType",
2861
+ "x-f5xc-description-short": "Colour Type defines the colour of fields to be displayed. - COLOUR_TYPE_NONE: None No colour - DANGER: danger colour type red - INFO: info colour...",
2862
+ "x-f5xc-description-medium": "Colour Type defines the colour of fields to be displayed. - COLOUR_TYPE_NONE: None No colour - DANGER: danger colour type red - INFO: info colour type blue - WARNING: warning colour type orange - AMBER: amber colour type yellow - SUCCESS: success colour type green - MALIBU: malibu colour type blue.",
2725
2863
  "x-f5xc-minimum-configuration": {
2726
2864
  "description": "Minimum configuration for commonColourType",
2727
2865
  "required_fields": [],
@@ -2746,6 +2884,8 @@
2746
2884
  "default": "COLUMN_TYPE_NONE",
2747
2885
  "x-displayname": "Column Type.",
2748
2886
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.ColumnType",
2887
+ "x-f5xc-description-short": "Column Type defines the data type for each column. - COLUMN_TYPE_NONE: None - STRING: string - INT: integer - FLOAT: float - BOOL: boolean.",
2888
+ "x-f5xc-description-medium": "Column Type defines the data type for each column. - COLUMN_TYPE_NONE: None - STRING: string - INT: integer - FLOAT: float - BOOL: boolean.",
2749
2889
  "x-f5xc-minimum-configuration": {
2750
2890
  "description": "Minimum configuration for commonColumnType",
2751
2891
  "required_fields": [],
@@ -2777,6 +2917,7 @@
2777
2917
  "x-validation-rules": {
2778
2918
  "ves.io.schema.rules.message.required": "true"
2779
2919
  },
2920
+ "x-f5xc-description-short": "Key will present a placeholder in a text field to insert the link. For",
2780
2921
  "minLength": 0,
2781
2922
  "maxLength": 16,
2782
2923
  "x-f5xc-required-for": {
@@ -2787,7 +2928,7 @@
2787
2928
  },
2788
2929
  "x-original-maxLength": 1024,
2789
2930
  "x-reconciled-from-discovery": true,
2790
- "x-reconciled-at": "2026-01-05T14:37:33.143510+00:00"
2931
+ "x-reconciled-at": "2026-01-07T15:27:43.841261+00:00"
2791
2932
  },
2792
2933
  "log_filters": {
2793
2934
  "type": "array",
@@ -2821,7 +2962,7 @@
2821
2962
  },
2822
2963
  "x-original-maxLength": 1024,
2823
2964
  "x-reconciled-from-discovery": true,
2824
- "x-reconciled-at": "2026-01-05T14:37:33.143517+00:00"
2965
+ "x-reconciled-at": "2026-01-07T15:27:43.841268+00:00"
2825
2966
  },
2826
2967
  "object_name": {
2827
2968
  "type": "string",
@@ -2872,12 +3013,13 @@
2872
3013
  },
2873
3014
  "x-original-maxLength": 1024,
2874
3015
  "x-reconciled-from-discovery": true,
2875
- "x-reconciled-at": "2026-01-05T14:37:33.143525+00:00"
3016
+ "x-reconciled-at": "2026-01-07T15:27:43.841276+00:00"
2876
3017
  },
2877
3018
  "type": {
2878
3019
  "$ref": "#/components/schemas/commonDashboardLinkType"
2879
3020
  }
2880
3021
  },
3022
+ "x-f5xc-description-short": "Dashboard link will present common fields like type, namespace, object, dateFilter, logFilter.",
2881
3023
  "x-f5xc-minimum-configuration": {
2882
3024
  "description": "Minimum configuration for commonDashboardLink",
2883
3025
  "required_fields": [
@@ -2919,6 +3061,8 @@
2919
3061
  "default": "SECURITY_ANALYTICS_EVENTS",
2920
3062
  "x-displayname": "Link Type",
2921
3063
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.DashboardLinkType",
3064
+ "x-f5xc-description-short": "Link Type to be presented - SECURITY_ANALYTICS_EVENTS: SECURITY_ANALYTICS_EVENTS Security analytics dashboard...",
3065
+ "x-f5xc-description-medium": "Link Type to be presented - SECURITY_ANALYTICS_EVENTS: SECURITY_ANALYTICS_EVENTS Security analytics dashboard: /web/workspaces/web-app-and-API-protection/../dashboard/security-dashboard/../security_analytics/events - REQUESTS_EVENTS: REQUESTS_EVENTS Requests dashboard...",
2922
3066
  "x-f5xc-minimum-configuration": {
2923
3067
  "description": "Minimum configuration for commonDashboardLinkType",
2924
3068
  "required_fields": [],
@@ -2941,7 +3085,7 @@
2941
3085
  },
2942
3086
  "formats": {
2943
3087
  "type": "array",
2944
- "description": "",
3088
+ "description": "Data format specification",
2945
3089
  "title": "Format",
2946
3090
  "items": {
2947
3091
  "$ref": "#/components/schemas/commonFormatType"
@@ -2993,6 +3137,8 @@
2993
3137
  "default": "DISPLAY_TYPE_NONE",
2994
3138
  "x-displayname": "DisplayType Type.",
2995
3139
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.DisplayType",
3140
+ "x-f5xc-description-short": "Render Type defines the format to which data has to be rendered on UI. - DISPLAY_TYPE_NONE: None None type - ICON: icon Value to be displayed as...",
3141
+ "x-f5xc-description-medium": "Render Type defines the format to which data has to be rendered on UI. - DISPLAY_TYPE_NONE: None None type - ICON: icon Value to be displayed as ICON - PROGRESS_BAR: progress bar - DATE: date - DURATION: duration - PROVIDER_ICON: provider icon.",
2996
3142
  "x-f5xc-minimum-configuration": {
2997
3143
  "description": "Minimum configuration for commonDisplayType",
2998
3144
  "required_fields": [],
@@ -3015,7 +3161,7 @@
3015
3161
  },
3016
3162
  "name": {
3017
3163
  "type": "string",
3018
- "description": "",
3164
+ "description": "Human-readable name for the resource",
3019
3165
  "title": "Name",
3020
3166
  "x-displayname": "Name",
3021
3167
  "x-ves-example": "Provider",
@@ -3030,11 +3176,11 @@
3030
3176
  },
3031
3177
  "x-original-maxLength": 1024,
3032
3178
  "x-reconciled-from-discovery": true,
3033
- "x-reconciled-at": "2026-01-05T14:37:33.143540+00:00"
3179
+ "x-reconciled-at": "2026-01-07T15:27:43.841290+00:00"
3034
3180
  },
3035
3181
  "title": {
3036
3182
  "type": "string",
3037
- "description": "",
3183
+ "description": "Human-readable title for the resource",
3038
3184
  "title": "Title",
3039
3185
  "x-displayname": "Title",
3040
3186
  "x-ves-example": "Site Name",
@@ -3049,7 +3195,7 @@
3049
3195
  },
3050
3196
  "x-original-maxLength": 1024,
3051
3197
  "x-reconciled-from-discovery": true,
3052
- "x-reconciled-at": "2026-01-05T14:37:33.143545+00:00"
3198
+ "x-reconciled-at": "2026-01-07T15:27:43.841295+00:00"
3053
3199
  },
3054
3200
  "tooltip": {
3055
3201
  "type": "string",
@@ -3097,6 +3243,8 @@
3097
3243
  "default": "IN",
3098
3244
  "x-displayname": "Filter Operator.",
3099
3245
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.FilterOperator",
3246
+ "x-f5xc-description-short": "Operator for query filter - IN: Filter Operator Specifies that query result includes filter values - NOT_IN: Filter Operator Specifies that query...",
3247
+ "x-f5xc-description-medium": "Operator for query filter - IN: Filter Operator Specifies that query result includes filter values - NOT_IN: Filter Operator Specifies that query result excludes filter values.",
3100
3248
  "x-f5xc-minimum-configuration": {
3101
3249
  "description": "Minimum configuration for commonFilterOperator",
3102
3250
  "required_fields": [],
@@ -3121,6 +3269,8 @@
3121
3269
  "default": "FORMAT_TYPE_NONE",
3122
3270
  "x-displayname": "Format Type.",
3123
3271
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.FormatType",
3272
+ "x-f5xc-description-short": "Format Type defines the format type for each fields. - FORMAT_TYPE_NONE: None No format - INLINE: Inline Key value to be displayed in inline...",
3273
+ "x-f5xc-description-medium": "Format Type defines the format type for each fields. - FORMAT_TYPE_NONE: None No format - INLINE: Inline Key value to be displayed in inline format - BOLD: Bold Value to be displayed in bold format - REVERSE_KEY_VALUE_ORDER: ReverseKeyValueOrder Key value to be displayed in Reverse Key Value...",
3124
3274
  "x-f5xc-minimum-configuration": {
3125
3275
  "description": "Minimum configuration for commonFormatType",
3126
3276
  "required_fields": [],
@@ -3152,6 +3302,7 @@
3152
3302
  "x-validation-rules": {
3153
3303
  "ves.io.schema.rules.message.required": "true"
3154
3304
  },
3305
+ "x-f5xc-description-short": "Key will present a placeholder in a text field to insert the link. For",
3155
3306
  "minLength": 0,
3156
3307
  "maxLength": 16,
3157
3308
  "x-f5xc-required-for": {
@@ -3162,7 +3313,7 @@
3162
3313
  },
3163
3314
  "x-original-maxLength": 1024,
3164
3315
  "x-reconciled-from-discovery": true,
3165
- "x-reconciled-at": "2026-01-05T14:37:33.143553+00:00"
3316
+ "x-reconciled-at": "2026-01-07T15:27:43.841304+00:00"
3166
3317
  },
3167
3318
  "title": {
3168
3319
  "type": "string",
@@ -3181,7 +3332,7 @@
3181
3332
  },
3182
3333
  "x-original-maxLength": 1024,
3183
3334
  "x-reconciled-from-discovery": true,
3184
- "x-reconciled-at": "2026-01-05T14:37:33.143557+00:00"
3335
+ "x-reconciled-at": "2026-01-07T15:27:43.841309+00:00"
3185
3336
  },
3186
3337
  "url": {
3187
3338
  "type": "string",
@@ -3201,6 +3352,7 @@
3201
3352
  }
3202
3353
  }
3203
3354
  },
3355
+ "x-f5xc-description-short": "Generic link can have external link with full URL.",
3204
3356
  "x-f5xc-minimum-configuration": {
3205
3357
  "description": "Minimum configuration for commonGenericLink",
3206
3358
  "required_fields": [
@@ -3227,7 +3379,7 @@
3227
3379
  },
3228
3380
  "is_error": {
3229
3381
  "type": "boolean",
3230
- "description": "",
3382
+ "description": "Configuration parameter for is error",
3231
3383
  "title": "Is_error",
3232
3384
  "format": "boolean",
3233
3385
  "x-displayname": "Is_error",
@@ -3242,7 +3394,7 @@
3242
3394
  },
3243
3395
  "summary": {
3244
3396
  "type": "string",
3245
- "description": "",
3397
+ "description": "Configuration parameter for summary",
3246
3398
  "title": "Summary",
3247
3399
  "x-displayname": "Summary",
3248
3400
  "x-ves-example": "Query not supported.",
@@ -3323,7 +3475,7 @@
3323
3475
  },
3324
3476
  "x-original-maxLength": 1024,
3325
3477
  "x-reconciled-from-discovery": true,
3326
- "x-reconciled-at": "2026-01-05T14:37:33.143573+00:00"
3478
+ "x-reconciled-at": "2026-01-07T15:27:43.841325+00:00"
3327
3479
  },
3328
3480
  "op": {
3329
3481
  "$ref": "#/components/schemas/commonFilterOperator"
@@ -3393,7 +3545,7 @@
3393
3545
  },
3394
3546
  "x-original-maxLength": 1024,
3395
3547
  "x-reconciled-from-discovery": true,
3396
- "x-reconciled-at": "2026-01-05T14:37:33.143582+00:00"
3548
+ "x-reconciled-at": "2026-01-07T15:27:43.841335+00:00"
3397
3549
  },
3398
3550
  "type": {
3399
3551
  "$ref": "#/components/schemas/commonDashboardLinkType"
@@ -3517,6 +3669,7 @@
3517
3669
  }
3518
3670
  }
3519
3671
  },
3672
+ "x-f5xc-description-short": "Overlay data for creating support ticket.",
3520
3673
  "x-f5xc-minimum-configuration": {
3521
3674
  "description": "Minimum configuration for commonOverlayData",
3522
3675
  "required_fields": [
@@ -3549,6 +3702,8 @@
3549
3702
  "default": "STATUS_STYLE_UNKNOWN",
3550
3703
  "x-displayname": "Status Style.",
3551
3704
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.StatusStyle",
3705
+ "x-f5xc-description-short": "Status Style defines the colour of status to be displayed. - STATUS_STYLE_UNKNOWN: Unknown No colour - STATUS_STYLE_SUCCESS: success colour type...",
3706
+ "x-f5xc-description-medium": "Status Style defines the colour of status to be displayed. - STATUS_STYLE_UNKNOWN: Unknown No colour - STATUS_STYLE_SUCCESS: success colour type green - STATUS_STYLE_DANGER: danger colour type red - STATUS_STYLE_WARNING: warning colour type yellow - STATUS_STYLE_INACTIVE: inactive colour type...",
3552
3707
  "x-f5xc-minimum-configuration": {
3553
3708
  "description": "Minimum configuration for commonStatusStyle",
3554
3709
  "required_fields": [],
@@ -3575,6 +3730,8 @@
3575
3730
  "default": "WIDGET_TYPE_NONE",
3576
3731
  "x-displayname": "Widget Type.",
3577
3732
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.WidgetType",
3733
+ "x-f5xc-description-short": "Widget Type defines the data type for widget. - WIDGET_TYPE_NONE: None None type - TWO_VALUE: two_value Two Value type widget ...",
3734
+ "x-f5xc-description-medium": "Widget Type defines the data type for widget. - WIDGET_TYPE_NONE: None None type - TWO_VALUE: two_value Two Value type widget - DISTRIBUTION_CHART: distribution_chart Distribution Chart type widget - TABLE: table Table type widget - LIST: list List type widget - GRID: grid Grid type widget ...",
3578
3735
  "x-f5xc-minimum-configuration": {
3579
3736
  "description": "Minimum configuration for commonWidgetType",
3580
3737
  "required_fields": [],
@@ -3598,6 +3755,8 @@
3598
3755
  "default": "ACCURACY_NONE",
3599
3756
  "x-displayname": "Accuracy",
3600
3757
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.Accuracy",
3758
+ "x-f5xc-description-short": "Specifies accuracy of the signature - ACCURACY_NONE: None No accuracy - ACCURACY_LOW: Low Specifies low accuracy of the signature ...",
3759
+ "x-f5xc-description-medium": "Specifies accuracy of the signature - ACCURACY_NONE: None No accuracy - ACCURACY_LOW: Low Specifies low accuracy of the signature - ACCURACY_MEDIUM: Medium Specifies medium accuracy of the signature - ACCURACY_HIGH: High Specifies high accuracy of the signature.",
3601
3760
  "x-f5xc-minimum-configuration": {
3602
3761
  "description": "Minimum configuration for explain_log_recordAccuracy",
3603
3762
  "required_fields": [],
@@ -3648,7 +3807,7 @@
3648
3807
  },
3649
3808
  "x-original-maxLength": 1024,
3650
3809
  "x-reconciled-from-discovery": true,
3651
- "x-reconciled-at": "2026-01-05T14:37:33.143600+00:00"
3810
+ "x-reconciled-at": "2026-01-07T15:27:43.841352+00:00"
3652
3811
  },
3653
3812
  "type": {
3654
3813
  "type": "string",
@@ -3784,6 +3943,8 @@
3784
3943
  "default": "ENFORCEMENT_NONE",
3785
3944
  "x-displayname": "Enforcement Mode.",
3786
3945
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.EnforcementMode",
3946
+ "x-f5xc-description-short": "Enforcement mode of WAF - ENFORCEMENT_NONE: None No enforcement - MONITORING: Monitoring Monitoring mode of WAF - BLOCKING: Blocking Blocking mode...",
3947
+ "x-f5xc-description-medium": "Enforcement mode of WAF - ENFORCEMENT_NONE: None No enforcement - MONITORING: Monitoring Monitoring mode of WAF - BLOCKING: Blocking Blocking mode of WAF.",
3787
3948
  "x-f5xc-minimum-configuration": {
3788
3949
  "description": "Minimum configuration for explain_log_recordEnforcementMode",
3789
3950
  "required_fields": [],
@@ -3893,6 +4054,8 @@
3893
4054
  "default": "IP_REPUTATION_NONE",
3894
4055
  "x-displayname": "IP Reputation.",
3895
4056
  "x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.IPReputation",
4057
+ "x-f5xc-description-short": "Specifies IP risk/trustworthiness - IP_REPUTATION_NONE: None No IP reputation - IP_REPUTATION_LOW: Low Specifies low IP risk/trustworthiness ...",
4058
+ "x-f5xc-description-medium": "Specifies IP risk/trustworthiness - IP_REPUTATION_NONE: None No IP reputation - IP_REPUTATION_LOW: Low Specifies low IP risk/trustworthiness - IP_REPUTATION_HIGH: High Specifies high IP risk/trustworthiness.",
3896
4059
  "x-f5xc-minimum-configuration": {
3897
4060
  "description": "Minimum configuration for explain_log_recordIPReputation",
3898
4061
  "required_fields": [],
@@ -3928,7 +4091,7 @@
3928
4091
  "x-original-maxLength": 1024,
3929
4092
  "format": "hostname",
3930
4093
  "x-reconciled-from-discovery": true,
3931
- "x-reconciled-at": "2026-01-05T14:37:33.143626+00:00"
4094
+ "x-reconciled-at": "2026-01-07T15:27:43.841377+00:00"
3932
4095
  },
3933
4096
  "rsp_code": {
3934
4097
  "type": "integer",
@@ -4088,7 +4251,7 @@
4088
4251
  },
4089
4252
  "x-original-maxLength": 1024,
4090
4253
  "x-reconciled-from-discovery": true,
4091
- "x-reconciled-at": "2026-01-05T14:37:33.143644+00:00"
4254
+ "x-reconciled-at": "2026-01-07T15:27:43.841395+00:00"
4092
4255
  },
4093
4256
  "state": {
4094
4257
  "type": "string",
@@ -4097,6 +4260,7 @@
4097
4260
  "x-displayname": "State",
4098
4261
  "x-ves-example": "Enabled",
4099
4262
  "x-f5xc-example": "Enabled",
4263
+ "x-f5xc-description-short": "State of the signature, can be enabled, suppressed and etc.",
4100
4264
  "minLength": 0,
4101
4265
  "maxLength": 1024,
4102
4266
  "x-f5xc-required-for": {
@@ -4283,7 +4447,7 @@
4283
4447
  },
4284
4448
  "x-original-maxLength": 1024,
4285
4449
  "x-reconciled-from-discovery": true,
4286
- "x-reconciled-at": "2026-01-05T14:37:33.143664+00:00"
4450
+ "x-reconciled-at": "2026-01-07T15:27:43.841414+00:00"
4287
4451
  }
4288
4452
  },
4289
4453
  "x-f5xc-minimum-configuration": {
@@ -4372,7 +4536,7 @@
4372
4536
  },
4373
4537
  "x-original-maxLength": 1024,
4374
4538
  "x-reconciled-from-discovery": true,
4375
- "x-reconciled-at": "2026-01-05T14:37:33.143673+00:00"
4539
+ "x-reconciled-at": "2026-01-07T15:27:43.841423+00:00"
4376
4540
  },
4377
4541
  "state": {
4378
4542
  "type": "string",
@@ -4381,6 +4545,7 @@
4381
4545
  "x-displayname": "State",
4382
4546
  "x-ves-example": "Enabled",
4383
4547
  "x-f5xc-example": "Enabled",
4548
+ "x-f5xc-description-short": "State of the violation, can be enabled, suppressed and etc.",
4384
4549
  "minLength": 0,
4385
4550
  "maxLength": 1024,
4386
4551
  "x-f5xc-required-for": {
@@ -4447,6 +4612,7 @@
4447
4612
  "$ref": "#/components/schemas/explain_log_recordSignature"
4448
4613
  },
4449
4614
  "x-displayname": "Signatures.",
4615
+ "x-f5xc-description-short": "The signatures that were detected in the request.",
4450
4616
  "x-f5xc-required-for": {
4451
4617
  "minimum_config": false,
4452
4618
  "create": false,
@@ -4462,6 +4628,8 @@
4462
4628
  "$ref": "#/components/schemas/explain_log_recordThreatCampaign"
4463
4629
  },
4464
4630
  "x-displayname": "Threat Campaign.",
4631
+ "x-f5xc-example": "{\"key\": \"value\"}",
4632
+ "x-f5xc-description-short": "Threat campaigns that were detected in the request.",
4465
4633
  "x-f5xc-required-for": {
4466
4634
  "minimum_config": false,
4467
4635
  "create": false,
@@ -4477,6 +4645,7 @@
4477
4645
  "$ref": "#/components/schemas/explain_log_recordViolation"
4478
4646
  },
4479
4647
  "x-displayname": "Violations.",
4648
+ "x-f5xc-description-short": "The violations that were detected in the request.",
4480
4649
  "x-f5xc-required-for": {
4481
4650
  "minimum_config": false,
4482
4651
  "create": false,
@@ -4534,6 +4703,7 @@
4534
4703
  "$ref": "#/components/schemas/commonLink"
4535
4704
  },
4536
4705
  "x-displayname": "Links",
4706
+ "x-f5xc-description-short": "Links that will be presented to the user.",
4537
4707
  "x-f5xc-required-for": {
4538
4708
  "minimum_config": false,
4539
4709
  "create": false,
@@ -4615,11 +4785,11 @@
4615
4785
  "maxLength": 26,
4616
4786
  "minLength": 15,
4617
4787
  "x-reconciled-from-discovery": true,
4618
- "x-reconciled-at": "2026-01-05T14:37:33.143697+00:00"
4788
+ "x-reconciled-at": "2026-01-07T15:27:43.841447+00:00"
4619
4789
  },
4620
4790
  "title": {
4621
4791
  "type": "string",
4622
- "description": "",
4792
+ "description": "Human-readable title for the resource",
4623
4793
  "title": "Title",
4624
4794
  "x-displayname": "Title",
4625
4795
  "x-ves-example": "Cloud Sites.",
@@ -4634,7 +4804,7 @@
4634
4804
  },
4635
4805
  "x-original-maxLength": 1024,
4636
4806
  "x-reconciled-from-discovery": true,
4637
- "x-reconciled-at": "2026-01-05T14:37:33.143702+00:00"
4807
+ "x-reconciled-at": "2026-01-07T15:27:43.841452+00:00"
4638
4808
  }
4639
4809
  },
4640
4810
  "x-f5xc-minimum-configuration": {
@@ -4673,6 +4843,7 @@
4673
4843
  "ves.io.schema.rules.repeated.unique": "true",
4674
4844
  "ves.io.schema.rules.string.max_len": "6"
4675
4845
  },
4846
+ "x-f5xc-description-short": "External doc links, that will be presented to the user.",
4676
4847
  "x-f5xc-required-for": {
4677
4848
  "minimum_config": false,
4678
4849
  "create": false,
@@ -4688,6 +4859,7 @@
4688
4859
  "$ref": "#/components/schemas/listList"
4689
4860
  },
4690
4861
  "x-displayname": "List View",
4862
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
4691
4863
  "x-f5xc-required-for": {
4692
4864
  "minimum_config": false,
4693
4865
  "create": false,
@@ -4697,7 +4869,7 @@
4697
4869
  },
4698
4870
  "summary": {
4699
4871
  "type": "string",
4700
- "description": "",
4872
+ "description": "Configuration parameter for summary",
4701
4873
  "title": "Summary",
4702
4874
  "x-displayname": "Summary",
4703
4875
  "x-ves-example": "This is summary of List response.",
@@ -4747,6 +4919,8 @@
4747
4919
  "default": "SPAM_SOURCES",
4748
4920
  "x-displayname": "IP Threat Category.",
4749
4921
  "x-ves-proto-enum": "ves.io.schema.policy.IPThreatCategory",
4922
+ "x-f5xc-description-short": "The IP threat categories to use when a policy based IP threat category is configured. - SPAM_SOURCES: SPAM_SOURCES - WINDOWS_EXPLOITS...",
4923
+ "x-f5xc-description-medium": "The IP threat categories to use when a policy based IP threat category is configured. - SPAM_SOURCES: SPAM_SOURCES - WINDOWS_EXPLOITS: WINDOWS_EXPLOITS - WEB_ATTACKS: WEB_ATTACKS - BOTNETS: BOTNETS - SCANNERS: SCANNERS - REPUTATION: REPUTATION - PHISHING: PHISHING - PROXY: PROXY ...",
4750
4924
  "x-f5xc-minimum-configuration": {
4751
4925
  "description": "Minimum configuration for policyIPThreatCategory",
4752
4926
  "required_fields": [],
@@ -4764,6 +4938,8 @@
4764
4938
  "type_url": {
4765
4939
  "type": "string",
4766
4940
  "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.",
4941
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
4942
+ "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 ).",
4767
4943
  "minLength": 0,
4768
4944
  "maxLength": 1024,
4769
4945
  "x-f5xc-required-for": {
@@ -4787,9 +4963,11 @@
4787
4963
  },
4788
4964
  "x-original-maxLength": 1024,
4789
4965
  "x-reconciled-from-discovery": true,
4790
- "x-reconciled-at": "2026-01-05T14:37:33.143714+00:00"
4966
+ "x-reconciled-at": "2026-01-07T15:27:43.841464+00:00"
4791
4967
  }
4792
4968
  },
4969
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
4970
+ "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...",
4793
4971
  "x-f5xc-minimum-configuration": {
4794
4972
  "description": "Minimum configuration for protobufAny",
4795
4973
  "required_fields": [
@@ -4809,6 +4987,7 @@
4809
4987
  "title": "Empty",
4810
4988
  "x-displayname": "Empty",
4811
4989
  "x-ves-proto-message": "ves.io.schema.Empty",
4990
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
4812
4991
  "x-f5xc-minimum-configuration": {
4813
4992
  "description": "Minimum configuration for schemaEmpty",
4814
4993
  "required_fields": [],
@@ -4837,6 +5016,8 @@
4837
5016
  "default": "EOK",
4838
5017
  "x-displayname": "Error Code.",
4839
5018
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
5019
+ "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...",
5020
+ "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...",
4840
5021
  "x-f5xc-minimum-configuration": {
4841
5022
  "description": "Minimum configuration for schemaErrorCode",
4842
5023
  "required_fields": [],
@@ -4877,6 +5058,7 @@
4877
5058
  }
4878
5059
  }
4879
5060
  },
5061
+ "x-f5xc-description-short": "Information about a error in API operation.",
4880
5062
  "x-f5xc-minimum-configuration": {
4881
5063
  "description": "Minimum configuration for schemaErrorType",
4882
5064
  "required_fields": [
@@ -4914,6 +5096,7 @@
4914
5096
  "ves.io.schema.rules.repeated.unique": "true",
4915
5097
  "ves.io.schema.rules.string.max_len": "6"
4916
5098
  },
5099
+ "x-f5xc-description-short": "External doc links, that will be presented to the user.",
4917
5100
  "x-f5xc-required-for": {
4918
5101
  "minimum_config": false,
4919
5102
  "create": false,
@@ -4937,6 +5120,7 @@
4937
5120
  "ves.io.schema.rules.repeated.unique": "true",
4938
5121
  "ves.io.schema.rules.string.max_len": "6"
4939
5122
  },
5123
+ "x-f5xc-description-short": "Internal Link like dashboard links, that will be presented to the user.",
4940
5124
  "x-f5xc-required-for": {
4941
5125
  "minimum_config": false,
4942
5126
  "create": false,
@@ -4949,7 +5133,7 @@
4949
5133
  },
4950
5134
  "summary": {
4951
5135
  "type": "string",
4952
- "description": "",
5136
+ "description": "Configuration parameter for summary",
4953
5137
  "title": "Summary",
4954
5138
  "x-displayname": "Summary",
4955
5139
  "x-ves-example": "This site analysis response provides status of sites.",
@@ -4995,7 +5179,7 @@
4995
5179
  },
4996
5180
  "value": {
4997
5181
  "type": "string",
4998
- "description": "",
5182
+ "description": "Configuration parameter for value",
4999
5183
  "title": "Value",
5000
5184
  "x-displayname": "Value",
5001
5185
  "x-ves-example": "Site1",
@@ -5010,7 +5194,7 @@
5010
5194
  },
5011
5195
  "x-original-maxLength": 1024,
5012
5196
  "x-reconciled-from-discovery": true,
5013
- "x-reconciled-at": "2026-01-05T14:37:33.143735+00:00"
5197
+ "x-reconciled-at": "2026-01-07T15:27:43.841483+00:00"
5014
5198
  }
5015
5199
  },
5016
5200
  "x-f5xc-minimum-configuration": {
@@ -5036,7 +5220,7 @@
5036
5220
  "properties": {
5037
5221
  "cells": {
5038
5222
  "type": "array",
5039
- "description": "",
5223
+ "description": "Configuration parameter for cells",
5040
5224
  "title": "Values",
5041
5225
  "items": {
5042
5226
  "$ref": "#/components/schemas/widgetCell"
@@ -5052,6 +5236,7 @@
5052
5236
  }
5053
5237
  }
5054
5238
  },
5239
+ "x-f5xc-description-short": "Contains the value for each rows of table.",
5055
5240
  "x-f5xc-minimum-configuration": {
5056
5241
  "description": "Minimum configuration for widgetRow",
5057
5242
  "required_fields": [
@@ -5082,6 +5267,7 @@
5082
5267
  "x-validation-rules": {
5083
5268
  "ves.io.schema.rules.repeated.unique": "true"
5084
5269
  },
5270
+ "x-f5xc-description-short": "Lists the name of the field & corresponding properties.",
5085
5271
  "x-f5xc-required-for": {
5086
5272
  "minimum_config": false,
5087
5273
  "create": false,
@@ -5139,6 +5325,7 @@
5139
5325
  "$ref": "#/components/schemas/commonLink"
5140
5326
  },
5141
5327
  "x-displayname": "Links",
5328
+ "x-f5xc-description-short": "Links that will be presented to the user.",
5142
5329
  "x-f5xc-required-for": {
5143
5330
  "minimum_config": false,
5144
5331
  "create": false,
@@ -5154,6 +5341,8 @@
5154
5341
  "$ref": "#/components/schemas/widgetWidgetView"
5155
5342
  },
5156
5343
  "x-displayname": "Widget View.",
5344
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
5345
+ "x-f5xc-description-short": "Response will have different types of widgets.",
5157
5346
  "x-f5xc-required-for": {
5158
5347
  "minimum_config": false,
5159
5348
  "create": false,
@@ -5163,7 +5352,7 @@
5163
5352
  },
5164
5353
  "summary": {
5165
5354
  "type": "string",
5166
- "description": "",
5355
+ "description": "Configuration parameter for summary",
5167
5356
  "title": "Summary",
5168
5357
  "x-displayname": "Summary",
5169
5358
  "x-ves-example": "This is summary of widget response.",
@@ -5218,6 +5407,7 @@
5218
5407
  "title": "EnableFeatureRequest.",
5219
5408
  "x-displayname": "EnableFeature Request.",
5220
5409
  "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.EnableFeatureRequest",
5410
+ "x-f5xc-description-short": "Any payload to be passed on the GET Provision API.",
5221
5411
  "x-f5xc-minimum-configuration": {
5222
5412
  "description": "Minimum configuration for bfdpEnableFeatureRequest",
5223
5413
  "required_fields": [],
@@ -5234,6 +5424,7 @@
5234
5424
  "title": "EnableFeatureResponse.",
5235
5425
  "x-displayname": "EnableFeature Response.",
5236
5426
  "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.EnableFeatureResponse",
5427
+ "x-f5xc-description-short": "Any payload to be passed on the GET Provision API.",
5237
5428
  "x-f5xc-minimum-configuration": {
5238
5429
  "description": "Minimum configuration for bfdpEnableFeatureResponse",
5239
5430
  "required_fields": [],
@@ -5258,6 +5449,7 @@
5258
5449
  "x-displayname": "Product_name.",
5259
5450
  "x-ves-example": "Product_name.",
5260
5451
  "x-f5xc-example": "product_name",
5452
+ "x-f5xc-description-short": "Product_name is a pipeline name for which token to be generated.",
5261
5453
  "minLength": 0,
5262
5454
  "maxLength": 1024,
5263
5455
  "x-f5xc-required-for": {
@@ -5268,6 +5460,7 @@
5268
5460
  }
5269
5461
  }
5270
5462
  },
5463
+ "x-f5xc-description-short": "API to refresh token for a given pipeline.",
5271
5464
  "x-f5xc-minimum-configuration": {
5272
5465
  "description": "Minimum configuration for bfdpRefreshTokenRequest",
5273
5466
  "required_fields": [
@@ -5294,6 +5487,7 @@
5294
5487
  "x-displayname": "Result",
5295
5488
  "x-ves-example": "Result",
5296
5489
  "x-f5xc-example": "result",
5490
+ "x-f5xc-description-short": "Result will be in JSON format having token in it.",
5297
5491
  "minLength": 0,
5298
5492
  "maxLength": 1024,
5299
5493
  "x-f5xc-required-for": {
@@ -5366,6 +5560,7 @@
5366
5560
  "x-displayname": "Configured_tenant_id.",
5367
5561
  "x-ves-example": "Configured Tenant.",
5368
5562
  "x-f5xc-example": "Configured Tenant",
5563
+ "x-f5xc-description-short": "F5 product's pipeline configured tenant .",
5369
5564
  "minLength": 0,
5370
5565
  "maxLength": 1024,
5371
5566
  "x-f5xc-required-for": {
@@ -5383,6 +5578,7 @@
5383
5578
  "x-displayname": "Pipleine_id.",
5384
5579
  "x-ves-example": "Pipleine_id.",
5385
5580
  "x-f5xc-example": "pipleine_id",
5581
+ "x-f5xc-description-short": "F5 product's pipeline ID for which this tenant is configured.",
5386
5582
  "minLength": 0,
5387
5583
  "maxLength": 1024,
5388
5584
  "x-f5xc-required-for": {
@@ -5400,6 +5596,7 @@
5400
5596
  "x-displayname": "Pipeline_name.",
5401
5597
  "x-ves-example": "Pipeline_name.",
5402
5598
  "x-f5xc-example": "pipeline_name",
5599
+ "x-f5xc-description-short": "F5 product's pipeline name for which this tenant is configured.",
5403
5600
  "minLength": 0,
5404
5601
  "maxLength": 1024,
5405
5602
  "x-f5xc-required-for": {
@@ -5416,6 +5613,7 @@
5416
5613
  "x-displayname": "Token",
5417
5614
  "x-ves-example": "Token name.",
5418
5615
  "x-f5xc-example": "token name",
5616
+ "x-f5xc-description-short": "F5 product's pipeline token to ingest data .",
5419
5617
  "minLength": 0,
5420
5618
  "maxLength": 1024,
5421
5619
  "x-f5xc-required-for": {
@@ -5579,6 +5777,8 @@
5579
5777
  "x-displayname": "Context",
5580
5778
  "x-ves-example": "App-VIP-pool-1.",
5581
5779
  "x-f5xc-example": "app-vip-pool-1",
5780
+ "x-f5xc-description-short": "Global IP allocator context from which IP allocation will happen Optional: If not specified, gia will try to allocate IP from default IP range.",
5781
+ "x-f5xc-description-medium": "Global IP allocator context from which IP allocation will happen Optional: If not specified, gia will try to allocate IP from default IP range.",
5582
5782
  "minLength": 0,
5583
5783
  "maxLength": 1024,
5584
5784
  "x-f5xc-required-for": {
@@ -5595,6 +5795,7 @@
5595
5795
  "format": "boolean",
5596
5796
  "x-displayname": "Use IPv6 Range.",
5597
5797
  "x-f5xc-example": "false",
5798
+ "x-f5xc-description-short": "Optional: If not specified, v4 range for this tenant will be used.",
5598
5799
  "x-f5xc-required-for": {
5599
5800
  "minimum_config": false,
5600
5801
  "create": false,
@@ -5641,11 +5842,12 @@
5641
5842
  },
5642
5843
  "ip": {
5643
5844
  "type": "string",
5644
- "description": "",
5845
+ "description": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1)",
5645
5846
  "title": "IP address.",
5646
5847
  "x-displayname": "IP Address allocated.",
5647
5848
  "x-ves-example": "192.168.0.1.",
5648
5849
  "x-f5xc-example": "192.168.0.1",
5850
+ "x-f5xc-description-short": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1).",
5649
5851
  "minLength": 0,
5650
5852
  "maxLength": 1024,
5651
5853
  "x-f5xc-required-for": {
@@ -5683,6 +5885,8 @@
5683
5885
  "x-displayname": "Context",
5684
5886
  "x-ves-example": "App-VIP-pool-1.",
5685
5887
  "x-f5xc-example": "app-vip-pool-1",
5888
+ "x-f5xc-description-short": "Global IP allocator context from which IP deallocation will happen Optional: If not specified, gia will try to deallocate given IP from default IP...",
5889
+ "x-f5xc-description-medium": "Global IP allocator context from which IP deallocation will happen Optional: If not specified, gia will try to deallocate given IP from default IP range.",
5686
5890
  "minLength": 0,
5687
5891
  "maxLength": 1024,
5688
5892
  "x-f5xc-required-for": {
@@ -5715,6 +5919,7 @@
5715
5919
  }
5716
5920
  }
5717
5921
  },
5922
+ "x-f5xc-description-short": "Input message of the 'DeAllocateIP' RPC.",
5718
5923
  "x-f5xc-minimum-configuration": {
5719
5924
  "description": "Minimum configuration for giaDeallocateIPRequest",
5720
5925
  "required_fields": [
@@ -5752,6 +5957,7 @@
5752
5957
  }
5753
5958
  }
5754
5959
  },
5960
+ "x-f5xc-description-short": "Output message of the 'DeAllocateIP' RPC.",
5755
5961
  "x-f5xc-minimum-configuration": {
5756
5962
  "description": "Minimum configuration for giaDeallocateIPResponse",
5757
5963
  "required_fields": [