@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.19-2601071557

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  2. package/dist/tools/generated/ce_management/index.js +179 -1582
  3. package/dist/tools/generated/ce_management/index.js.map +1 -1
  4. package/dist/tools/generated/dependency-graph.json +2 -265
  5. package/dist/version.d.ts +2 -2
  6. package/dist/version.js +2 -2
  7. package/manifest.json +1 -1
  8. package/package.json +1 -1
  9. package/specs/domains/admin_console_and_ui.json +111 -25
  10. package/specs/domains/ai_services.json +114 -35
  11. package/specs/domains/api.json +1082 -177
  12. package/specs/domains/authentication.json +205 -45
  13. package/specs/domains/bigip.json +593 -101
  14. package/specs/domains/billing_and_usage.json +440 -82
  15. package/specs/domains/blindfold.json +713 -110
  16. package/specs/domains/bot_and_threat_defense.json +359 -65
  17. package/specs/domains/cdn.json +2131 -194
  18. package/specs/domains/ce_management.json +9110 -15844
  19. package/specs/domains/certificates.json +362 -75
  20. package/specs/domains/cloud_infrastructure.json +802 -119
  21. package/specs/domains/container_services.json +613 -95
  22. package/specs/domains/data_and_privacy_security.json +364 -66
  23. package/specs/domains/data_intelligence.json +324 -63
  24. package/specs/domains/ddos.json +766 -159
  25. package/specs/domains/dns.json +820 -161
  26. package/specs/domains/managed_kubernetes.json +455 -85
  27. package/specs/domains/marketplace.json +670 -104
  28. package/specs/domains/network.json +1620 -238
  29. package/specs/domains/network_security.json +1401 -191
  30. package/specs/domains/nginx_one.json +326 -62
  31. package/specs/domains/object_storage.json +49 -15
  32. package/specs/domains/observability.json +999 -147
  33. package/specs/domains/rate_limiting.json +300 -55
  34. package/specs/domains/secops_and_incident_response.json +189 -36
  35. package/specs/domains/service_mesh.json +955 -124
  36. package/specs/domains/shape.json +2150 -397
  37. package/specs/domains/sites.json +3830 -364
  38. package/specs/domains/statistics.json +2117 -235
  39. package/specs/domains/support.json +602 -108
  40. package/specs/domains/telemetry_and_insights.json +753 -79
  41. package/specs/domains/tenant_and_identity.json +1874 -308
  42. package/specs/domains/threat_campaign.json +637 -71
  43. package/specs/domains/users.json +278 -66
  44. package/specs/domains/virtual.json +2803 -260
  45. package/specs/domains/vpm_and_node_management.json +3 -1
  46. package/specs/domains/waf.json +1125 -148
  47. package/specs/index.json +24 -24
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Telemetry And Insights",
5
5
  "description": "F5 Distributed Cloud Telemetry And Insights API specifications",
6
- "version": "2.0.13",
6
+ "version": "2.0.19",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -6019,6 +6019,7 @@
6019
6019
  "$ref": "#/components/schemas/graphconnectivityEdgeMetricData"
6020
6020
  },
6021
6021
  "x-displayname": "Metric",
6022
+ "x-f5xc-description-short": "Edge Metric data specified in the request.",
6022
6023
  "x-f5xc-required-for": {
6023
6024
  "minimum_config": false,
6024
6025
  "create": false,
@@ -6030,6 +6031,7 @@
6030
6031
  "$ref": "#/components/schemas/connectivityId"
6031
6032
  }
6032
6033
  },
6034
+ "x-f5xc-description-short": "EdgeData wraps all the response data for an edge in the connectivity graph response.",
6033
6035
  "x-f5xc-minimum-configuration": {
6034
6036
  "description": "Minimum configuration for connectivityEdgeData",
6035
6037
  "required_fields": [
@@ -6059,6 +6061,8 @@
6059
6061
  "$ref": "#/components/schemas/graphconnectivityEdgeMetricSelector"
6060
6062
  }
6061
6063
  },
6064
+ "x-f5xc-description-short": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
6065
+ "x-f5xc-description-medium": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
6062
6066
  "x-f5xc-minimum-configuration": {
6063
6067
  "description": "Minimum configuration for connectivityEdgeFieldSelector",
6064
6068
  "required_fields": [
@@ -6092,6 +6096,8 @@
6092
6096
  "default": "EDGE_METRIC_TYPE_NONE",
6093
6097
  "x-displayname": "Edge Metric Type.",
6094
6098
  "x-ves-proto-enum": "ves.io.schema.graph.connectivity.EdgeMetricType",
6099
+ "x-f5xc-description-short": "EdgeMetricType specifies the metrics that can be queried per edge in the connectivity graph.",
6100
+ "x-f5xc-description-medium": "EdgeMetricType specifies the metrics that can be queried per edge in the connectivity graph. Indicates field not being set x-unit: \"percentage\" Reachability of the destination site from the source site x-unit: \"seconds\" Average latency for the edge reported by the source site x-unit: \"bits per...",
6095
6101
  "x-f5xc-minimum-configuration": {
6096
6102
  "description": "Minimum configuration for connectivityEdgeMetricType",
6097
6103
  "required_fields": [],
@@ -6125,6 +6131,8 @@
6125
6131
  "x-validation-rules": {
6126
6132
  "ves.io.schema.rules.string.query_time": "true"
6127
6133
  },
6134
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
6135
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
6128
6136
  "minLength": 0,
6129
6137
  "maxLength": 1024,
6130
6138
  "x-f5xc-required-for": {
@@ -6144,6 +6152,7 @@
6144
6152
  "x-displayname": "Namespace",
6145
6153
  "x-ves-example": "Value",
6146
6154
  "x-f5xc-example": "value",
6155
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
6147
6156
  "minLength": 0,
6148
6157
  "maxLength": 6,
6149
6158
  "x-f5xc-required-for": {
@@ -6154,7 +6163,7 @@
6154
6163
  },
6155
6164
  "x-original-maxLength": 1024,
6156
6165
  "x-reconciled-from-discovery": true,
6157
- "x-reconciled-at": "2026-01-05T18:29:09.440316+00:00"
6166
+ "x-reconciled-at": "2026-01-07T15:28:25.308908+00:00"
6158
6167
  },
6159
6168
  "range": {
6160
6169
  "type": "string",
@@ -6169,6 +6178,8 @@
6169
6178
  "x-validation-rules": {
6170
6179
  "ves.io.schema.rules.string.time_interval": "true"
6171
6180
  },
6181
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
6182
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
6172
6183
  "minLength": 0,
6173
6184
  "maxLength": 1024,
6174
6185
  "x-f5xc-required-for": {
@@ -6194,6 +6205,8 @@
6194
6205
  "x-validation-rules": {
6195
6206
  "ves.io.schema.rules.string.query_time": "true"
6196
6207
  },
6208
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
6209
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
6197
6210
  "minLength": 0,
6198
6211
  "maxLength": 1024,
6199
6212
  "x-f5xc-required-for": {
@@ -6216,6 +6229,8 @@
6216
6229
  "x-validation-rules": {
6217
6230
  "ves.io.schema.rules.string.query_step": "true"
6218
6231
  },
6232
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
6233
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
6219
6234
  "minLength": 0,
6220
6235
  "maxLength": 1024,
6221
6236
  "x-f5xc-required-for": {
@@ -6226,6 +6241,8 @@
6226
6241
  }
6227
6242
  }
6228
6243
  },
6244
+ "x-f5xc-description-short": "Request to GET the time-series data for an edge in the connectivity graph.",
6245
+ "x-f5xc-description-medium": "Request to GET the time-series data for an edge in the connectivity graph. While graph/connectivity API is used to GET connectivity data for all sites, where each node and edge contains the aggregated value for each field; graph/connectivity/edge API is used to GET the time-series data...",
6229
6246
  "x-f5xc-minimum-configuration": {
6230
6247
  "description": "Minimum configuration for connectivityEdgeRequest",
6231
6248
  "required_fields": [
@@ -6268,6 +6285,8 @@
6268
6285
  "x-validation-rules": {
6269
6286
  "ves.io.schema.rules.string.time_interval": "true"
6270
6287
  },
6288
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
6289
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
6271
6290
  "minLength": 0,
6272
6291
  "maxLength": 1024,
6273
6292
  "x-f5xc-required-for": {
@@ -6278,6 +6297,8 @@
6278
6297
  }
6279
6298
  }
6280
6299
  },
6300
+ "x-f5xc-description-short": "Response for graph/connectivity/edge API returns the time-series data for the edge specified in the request.",
6301
+ "x-f5xc-description-medium": "Response for graph/connectivity/edge API returns the time-series data for the edge specified in the request.",
6281
6302
  "x-f5xc-minimum-configuration": {
6282
6303
  "description": "Minimum configuration for connectivityEdgeResponse",
6283
6304
  "required_fields": [
@@ -6305,6 +6326,8 @@
6305
6326
  "$ref": "#/components/schemas/connectivityNodeFieldSelector"
6306
6327
  }
6307
6328
  },
6329
+ "x-f5xc-description-short": "FieldSelector is used to specify the list of fields to be returned in the response for connectivity graph.",
6330
+ "x-f5xc-description-medium": "FieldSelector is used to specify the list of fields to be returned in the response for connectivity graph.",
6308
6331
  "x-f5xc-minimum-configuration": {
6309
6332
  "description": "Minimum configuration for connectivityFieldSelector",
6310
6333
  "required_fields": [
@@ -6345,6 +6368,7 @@
6345
6368
  "$ref": "#/components/schemas/siteSiteType"
6346
6369
  }
6347
6370
  },
6371
+ "x-f5xc-description-short": "ID uniquely identifies a node or an edge in the connectivity graph.",
6348
6372
  "x-f5xc-minimum-configuration": {
6349
6373
  "description": "Minimum configuration for connectivityId",
6350
6374
  "required_fields": [
@@ -6369,6 +6393,8 @@
6369
6393
  "default": "NONE",
6370
6394
  "x-displayname": "ID Field",
6371
6395
  "x-ves-proto-enum": "ves.io.schema.graph.connectivity.IdField",
6396
+ "x-f5xc-description-short": "IdField is used to select one or more fields that uniquely identifies a node or an edge in the connectivity graph.",
6397
+ "x-f5xc-description-medium": "IdField is used to select one or more fields that uniquely identifies a node or an edge in the connectivity graph. Indicates the field not being set Identifies a site (CE or RE).",
6372
6398
  "x-f5xc-minimum-configuration": {
6373
6399
  "description": "Minimum configuration for connectivityIdField",
6374
6400
  "required_fields": [],
@@ -6409,9 +6435,11 @@
6409
6435
  },
6410
6436
  "x-original-maxLength": 1024,
6411
6437
  "x-reconciled-from-discovery": true,
6412
- "x-reconciled-at": "2026-01-05T18:29:09.440341+00:00"
6438
+ "x-reconciled-at": "2026-01-07T15:28:25.308933+00:00"
6413
6439
  }
6414
6440
  },
6441
+ "x-f5xc-description-short": "Metrics used in the connectivity graph are tagged with labels listed in the enum Label.",
6442
+ "x-f5xc-description-medium": "Metrics used in the connectivity graph are tagged with labels listed in the enum Label. Label Filter is used to filter the timeseries that match the specified label key/value and the operator.",
6415
6443
  "x-f5xc-minimum-configuration": {
6416
6444
  "description": "Minimum configuration for connectivityLabelFilter",
6417
6445
  "required_fields": [
@@ -6447,6 +6475,7 @@
6447
6475
  "$ref": "#/components/schemas/connectivityNodeInstanceData"
6448
6476
  },
6449
6477
  "x-displayname": "Instances",
6478
+ "x-f5xc-description-short": "Instance data for the node requested by the user.",
6450
6479
  "x-f5xc-required-for": {
6451
6480
  "minimum_config": false,
6452
6481
  "create": false,
@@ -6462,6 +6491,7 @@
6462
6491
  "$ref": "#/components/schemas/connectivityNodeInterfaceData"
6463
6492
  },
6464
6493
  "x-displayname": "Interfaces.",
6494
+ "x-f5xc-description-short": "Interface data for the node requested by the user.",
6465
6495
  "x-f5xc-required-for": {
6466
6496
  "minimum_config": false,
6467
6497
  "create": false,
@@ -6477,6 +6507,7 @@
6477
6507
  "$ref": "#/components/schemas/graphconnectivityNodeMetricData"
6478
6508
  },
6479
6509
  "x-displayname": "Metric",
6510
+ "x-f5xc-description-short": "Node Metric data specified in the request.",
6480
6511
  "x-f5xc-required-for": {
6481
6512
  "minimum_config": false,
6482
6513
  "create": false,
@@ -6485,6 +6516,7 @@
6485
6516
  }
6486
6517
  }
6487
6518
  },
6519
+ "x-f5xc-description-short": "NodeData wraps all the response data for a node in the connectivity graph response.",
6488
6520
  "x-f5xc-minimum-configuration": {
6489
6521
  "description": "Minimum configuration for connectivityNodeData",
6490
6522
  "required_fields": [
@@ -6515,6 +6547,8 @@
6515
6547
  "$ref": "#/components/schemas/graphconnectivityNodeMetricSelector"
6516
6548
  }
6517
6549
  },
6550
+ "x-f5xc-description-short": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
6551
+ "x-f5xc-description-medium": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
6518
6552
  "x-f5xc-minimum-configuration": {
6519
6553
  "description": "Minimum configuration for connectivityNodeFieldSelector",
6520
6554
  "required_fields": [
@@ -6569,6 +6603,8 @@
6569
6603
  }
6570
6604
  }
6571
6605
  },
6606
+ "x-f5xc-description-short": "NodeInstanceData is part of the connectivity graph response that contains the instance name along with the corresponding metric.",
6607
+ "x-f5xc-description-medium": "NodeInstanceData is part of the connectivity graph response that contains the instance name along with the corresponding metric.",
6572
6608
  "x-f5xc-minimum-configuration": {
6573
6609
  "description": "Minimum configuration for connectivityNodeInstanceData",
6574
6610
  "required_fields": [
@@ -6599,6 +6635,7 @@
6599
6635
  "$ref": "#/components/schemas/graphMetricFeatureData"
6600
6636
  }
6601
6637
  },
6638
+ "x-f5xc-description-short": "NodeInstanceMetricData contains the metric type and the corresponding value for a node instance.",
6602
6639
  "x-f5xc-minimum-configuration": {
6603
6640
  "description": "Minimum configuration for connectivityNodeInstanceMetricData",
6604
6641
  "required_fields": [
@@ -6632,6 +6669,8 @@
6632
6669
  "default": "NODE_INSTANCE_METRIC_TYPE_NONE",
6633
6670
  "x-displayname": "Node Interface Metric Type.",
6634
6671
  "x-ves-proto-enum": "ves.io.schema.graph.connectivity.NodeInstanceMetricType",
6672
+ "x-f5xc-description-short": "NodeInstanceMetricType lists the instance specific metrics per site.",
6673
+ "x-f5xc-description-medium": "NodeInstanceMetricType lists the instance specific metrics per site. Indicates field not being set x-unit: \"percentage\" CPU utilization x-unit: \"percentage\" CPU utilization (excludes cpus allocated to dpdk and other internal entities) x-unit: \"percentage\" Memory utilization x-unit: \"percentage\"...",
6635
6674
  "x-f5xc-minimum-configuration": {
6636
6675
  "description": "Minimum configuration for connectivityNodeInstanceMetricType",
6637
6676
  "required_fields": [],
@@ -6689,6 +6728,7 @@
6689
6728
  "x-displayname": "Network Type.",
6690
6729
  "x-ves-example": "OUTSIDE",
6691
6730
  "x-f5xc-example": "OUTSIDE",
6731
+ "x-f5xc-description-short": "Network Type can be \"INSIDE\" (LAN traffic) or \"OUTSIDE\" (WAN traffic).",
6692
6732
  "minLength": 0,
6693
6733
  "maxLength": 1024,
6694
6734
  "x-f5xc-required-for": {
@@ -6705,6 +6745,7 @@
6705
6745
  "x-displayname": "Segment Name.",
6706
6746
  "x-ves-example": "Segment-1",
6707
6747
  "x-f5xc-example": "segment-1",
6748
+ "x-f5xc-description-short": "Segment name for network_type segment should be added in response.",
6708
6749
  "minLength": 0,
6709
6750
  "maxLength": 1024,
6710
6751
  "x-f5xc-required-for": {
@@ -6715,6 +6756,8 @@
6715
6756
  }
6716
6757
  }
6717
6758
  },
6759
+ "x-f5xc-description-short": "NodeInterfaceData is part of the connectivity graph response that contains the interface name along with the corresponding metric.",
6760
+ "x-f5xc-description-medium": "NodeInterfaceData is part of the connectivity graph response that contains the interface name along with the corresponding metric.",
6718
6761
  "x-f5xc-minimum-configuration": {
6719
6762
  "description": "Minimum configuration for connectivityNodeInterfaceData",
6720
6763
  "required_fields": [
@@ -6747,6 +6790,7 @@
6747
6790
  "$ref": "#/components/schemas/graphMetricFeatureData"
6748
6791
  }
6749
6792
  },
6793
+ "x-f5xc-description-short": "NodeInterfaceMetricData contains the metric type and the corresponding value for a node interface.",
6750
6794
  "x-f5xc-minimum-configuration": {
6751
6795
  "description": "Minimum configuration for connectivityNodeInterfaceMetricData",
6752
6796
  "required_fields": [
@@ -6776,6 +6820,8 @@
6776
6820
  "default": "NODE_IF_METRIC_TYPE_NONE",
6777
6821
  "x-displayname": "Node Interface Metric Type.",
6778
6822
  "x-ves-proto-enum": "ves.io.schema.graph.connectivity.NodeInterfaceMetricType",
6823
+ "x-f5xc-description-short": "NodeInterfaceMetricType lists the interface specific metrics per site.",
6824
+ "x-f5xc-description-medium": "NodeInterfaceMetricType lists the interface specific metrics per site. Indicates field not being set x-unit: \"bool\" Indicates the interface status - 0 (down), 1 (up) x-unit: \"bits per second (bps)\" Throughput of the incoming traffic x-unit: \"bits per second (bps)\" Throughput of the outgoing...",
6779
6825
  "x-f5xc-minimum-configuration": {
6780
6826
  "description": "Minimum configuration for connectivityNodeInterfaceMetricType",
6781
6827
  "required_fields": [],
@@ -6808,6 +6854,8 @@
6808
6854
  "default": "NODE_METRIC_TYPE_NONE",
6809
6855
  "x-displayname": "Node Metric Type.",
6810
6856
  "x-ves-proto-enum": "ves.io.schema.graph.connectivity.NodeMetricType",
6857
+ "x-f5xc-description-short": "NodeMetricType specifies the metrics that can be queried per node in the connectivity graph.",
6858
+ "x-f5xc-description-medium": "NodeMetricType specifies the metrics that can be queried per node in the connectivity graph. Indicates field not being set x-unit: \"bits per second (bps)\" Throughput of incoming traffic x-unit: \"bits per second (bps)\" Throughput of outgoing traffic x-unit: \"packets per second (pps)\" Drop rate of...",
6811
6859
  "x-f5xc-minimum-configuration": {
6812
6860
  "description": "Minimum configuration for connectivityNodeMetricType",
6813
6861
  "required_fields": [],
@@ -6838,6 +6886,8 @@
6838
6886
  "x-validation-rules": {
6839
6887
  "ves.io.schema.rules.string.query_time": "true"
6840
6888
  },
6889
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
6890
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
6841
6891
  "minLength": 0,
6842
6892
  "maxLength": 1024,
6843
6893
  "x-f5xc-required-for": {
@@ -6861,6 +6911,8 @@
6861
6911
  "$ref": "#/components/schemas/connectivityLabelFilter"
6862
6912
  },
6863
6913
  "x-displayname": "Label Filter.",
6914
+ "x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
6915
+ "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, connectivity data for all sites will be returned in the response.",
6864
6916
  "x-f5xc-required-for": {
6865
6917
  "minimum_config": false,
6866
6918
  "create": false,
@@ -6875,6 +6927,7 @@
6875
6927
  "x-displayname": "Namespace",
6876
6928
  "x-ves-example": "Value",
6877
6929
  "x-f5xc-example": "value",
6930
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
6878
6931
  "minLength": 0,
6879
6932
  "maxLength": 6,
6880
6933
  "x-f5xc-required-for": {
@@ -6885,7 +6938,7 @@
6885
6938
  },
6886
6939
  "x-original-maxLength": 1024,
6887
6940
  "x-reconciled-from-discovery": true,
6888
- "x-reconciled-at": "2026-01-05T18:29:09.440380+00:00"
6941
+ "x-reconciled-at": "2026-01-07T15:28:25.308971+00:00"
6889
6942
  },
6890
6943
  "range": {
6891
6944
  "type": "string",
@@ -6900,6 +6953,8 @@
6900
6953
  "x-validation-rules": {
6901
6954
  "ves.io.schema.rules.string.time_interval": "true"
6902
6955
  },
6956
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
6957
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
6903
6958
  "minLength": 0,
6904
6959
  "maxLength": 1024,
6905
6960
  "x-f5xc-required-for": {
@@ -6922,6 +6977,8 @@
6922
6977
  "x-validation-rules": {
6923
6978
  "ves.io.schema.rules.string.query_time": "true"
6924
6979
  },
6980
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
6981
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
6925
6982
  "minLength": 0,
6926
6983
  "maxLength": 1024,
6927
6984
  "x-f5xc-required-for": {
@@ -6944,6 +7001,8 @@
6944
7001
  "x-validation-rules": {
6945
7002
  "ves.io.schema.rules.string.query_step": "true"
6946
7003
  },
7004
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
7005
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
6947
7006
  "minLength": 0,
6948
7007
  "maxLength": 1024,
6949
7008
  "x-f5xc-required-for": {
@@ -6954,6 +7013,8 @@
6954
7013
  }
6955
7014
  }
6956
7015
  },
7016
+ "x-f5xc-description-short": "Request to GET time-series data for a node in the connectivity graph.",
7017
+ "x-f5xc-description-medium": "Request to GET time-series data for a node in the connectivity graph. While graph/connectivity API is used to GET connectivity data for all sites, where each node and edge contains the aggregated value for each field; graph/connectivity/node API is used to GET the time-series data (drill-down of...",
6957
7018
  "x-f5xc-minimum-configuration": {
6958
7019
  "description": "Minimum configuration for connectivityNodeRequest",
6959
7020
  "required_fields": [
@@ -6996,6 +7057,8 @@
6996
7057
  "x-validation-rules": {
6997
7058
  "ves.io.schema.rules.string.time_interval": "true"
6998
7059
  },
7060
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
7061
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
6999
7062
  "minLength": 0,
7000
7063
  "maxLength": 1024,
7001
7064
  "x-f5xc-required-for": {
@@ -7006,6 +7069,8 @@
7006
7069
  }
7007
7070
  }
7008
7071
  },
7072
+ "x-f5xc-description-short": "Response for graph/connectivity/node API returns the time-series data for the site specified in the request.",
7073
+ "x-f5xc-description-medium": "Response for graph/connectivity/node API returns the time-series data for the site specified in the request.",
7009
7074
  "x-f5xc-minimum-configuration": {
7010
7075
  "description": "Minimum configuration for connectivityNodeResponse",
7011
7076
  "required_fields": [
@@ -7039,6 +7104,8 @@
7039
7104
  "x-validation-rules": {
7040
7105
  "ves.io.schema.rules.string.query_time": "true"
7041
7106
  },
7107
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
7108
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
7042
7109
  "minLength": 0,
7043
7110
  "maxLength": 1024,
7044
7111
  "x-f5xc-required-for": {
@@ -7059,6 +7126,7 @@
7059
7126
  "$ref": "#/components/schemas/connectivityIdField"
7060
7127
  },
7061
7128
  "x-displayname": "Group By",
7129
+ "x-f5xc-description-short": "Aggregate data by site. Optional: If not specified, then the data is aggregated/grouped by site.",
7062
7130
  "x-f5xc-required-for": {
7063
7131
  "minimum_config": false,
7064
7132
  "create": false,
@@ -7074,6 +7142,8 @@
7074
7142
  "$ref": "#/components/schemas/connectivityLabelFilter"
7075
7143
  },
7076
7144
  "x-displayname": "Label Filter.",
7145
+ "x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
7146
+ "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, connectivity data for all sites will be returned in the response.",
7077
7147
  "x-f5xc-required-for": {
7078
7148
  "minimum_config": false,
7079
7149
  "create": false,
@@ -7088,6 +7158,7 @@
7088
7158
  "x-displayname": "Namespace",
7089
7159
  "x-ves-example": "Value",
7090
7160
  "x-f5xc-example": "value",
7161
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
7091
7162
  "minLength": 0,
7092
7163
  "maxLength": 6,
7093
7164
  "x-f5xc-required-for": {
@@ -7098,7 +7169,7 @@
7098
7169
  },
7099
7170
  "x-original-maxLength": 1024,
7100
7171
  "x-reconciled-from-discovery": true,
7101
- "x-reconciled-at": "2026-01-05T18:29:09.440397+00:00"
7172
+ "x-reconciled-at": "2026-01-07T15:28:25.308989+00:00"
7102
7173
  },
7103
7174
  "start_time": {
7104
7175
  "type": "string",
@@ -7113,6 +7184,8 @@
7113
7184
  "x-validation-rules": {
7114
7185
  "ves.io.schema.rules.string.query_time": "true"
7115
7186
  },
7187
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
7188
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
7116
7189
  "minLength": 0,
7117
7190
  "maxLength": 1024,
7118
7191
  "x-f5xc-required-for": {
@@ -7123,6 +7196,8 @@
7123
7196
  }
7124
7197
  }
7125
7198
  },
7199
+ "x-f5xc-description-short": "Graph/connectivity API is used to GET the reachability, throughput and other monitoring data for the tenant's CEs and the connected REs.",
7200
+ "x-f5xc-description-medium": "Graph/connectivity API is used to GET the reachability, throughput and other monitoring data for the tenant's CEs and the connected REs.",
7126
7201
  "x-f5xc-minimum-configuration": {
7127
7202
  "description": "Minimum configuration for connectivityRequest",
7128
7203
  "required_fields": [
@@ -7155,6 +7230,7 @@
7155
7230
  "$ref": "#/components/schemas/connectivityEdgeData"
7156
7231
  },
7157
7232
  "x-displayname": "Edges",
7233
+ "x-f5xc-description-short": "Connectivity data between the the Customer sites and the Regional sites.",
7158
7234
  "x-f5xc-required-for": {
7159
7235
  "minimum_config": false,
7160
7236
  "create": false,
@@ -7170,6 +7246,7 @@
7170
7246
  "$ref": "#/components/schemas/connectivityNodeData"
7171
7247
  },
7172
7248
  "x-displayname": "Nodes",
7249
+ "x-f5xc-description-short": "Connectivity data for list of sites owned by a tenant.",
7173
7250
  "x-f5xc-required-for": {
7174
7251
  "minimum_config": false,
7175
7252
  "create": false,
@@ -7178,6 +7255,8 @@
7178
7255
  }
7179
7256
  }
7180
7257
  },
7258
+ "x-f5xc-description-short": "Response for graph/connectivity API contains list of nodes and edges.",
7259
+ "x-f5xc-description-medium": "Response for graph/connectivity API contains list of nodes and edges. Each node contains connectivity data for a site and each edge contains the connectivity data between the sites.",
7181
7260
  "x-f5xc-minimum-configuration": {
7182
7261
  "description": "Minimum configuration for connectivityResponse",
7183
7262
  "required_fields": [
@@ -7206,6 +7285,8 @@
7206
7285
  "$ref": "#/components/schemas/graphHealthscoreTypeData"
7207
7286
  },
7208
7287
  "x-displayname": "Data",
7288
+ "x-f5xc-example": "{\"key\": \"value\"}",
7289
+ "x-f5xc-description-short": "List of healthscores specified in the request.",
7209
7290
  "x-f5xc-required-for": {
7210
7291
  "minimum_config": false,
7211
7292
  "create": false,
@@ -7214,6 +7295,7 @@
7214
7295
  }
7215
7296
  }
7216
7297
  },
7298
+ "x-f5xc-description-short": "Contains the list of healthscores requested by the user.",
7217
7299
  "x-f5xc-minimum-configuration": {
7218
7300
  "description": "Minimum configuration for graphHealthscoreData",
7219
7301
  "required_fields": [
@@ -7241,6 +7323,7 @@
7241
7323
  "$ref": "#/components/schemas/graphHealthscoreType"
7242
7324
  },
7243
7325
  "x-displayname": "Types",
7326
+ "x-f5xc-description-short": "Healthscore types to be returned in the response.",
7244
7327
  "x-f5xc-required-for": {
7245
7328
  "minimum_config": false,
7246
7329
  "create": false,
@@ -7249,6 +7332,7 @@
7249
7332
  }
7250
7333
  }
7251
7334
  },
7335
+ "x-f5xc-description-short": "Healthscore Selector is used to specify the healthscore types to be returned in the response.",
7252
7336
  "x-f5xc-minimum-configuration": {
7253
7337
  "description": "Minimum configuration for graphHealthscoreSelector",
7254
7338
  "required_fields": [
@@ -7276,6 +7360,8 @@
7276
7360
  "default": "HEALTHSCORE_NONE",
7277
7361
  "x-displayname": "Healthscore Type.",
7278
7362
  "x-ves-proto-enum": "ves.io.schema.graph.HealthscoreType",
7363
+ "x-f5xc-description-short": "Healthscore for a site or service calculated based on SLAs and KPIs for the application Healthscore not requested x-unit: \"percentage\"...",
7364
+ "x-f5xc-description-medium": "Healthscore for a site or service calculated based on SLAs and KPIs for the application Healthscore not requested x-unit: \"percentage\" Connectivity Healthscore x-unit: \"percentage\" Performance Healthscore x-unit: \"percentage\" Security Healthscore x-unit: \"percentage\" Reliability Healthscore...",
7279
7365
  "x-f5xc-minimum-configuration": {
7280
7366
  "description": "Minimum configuration for graphHealthscoreType",
7281
7367
  "required_fields": [],
@@ -7300,6 +7386,7 @@
7300
7386
  "x-displayname": "Reason",
7301
7387
  "x-ves-example": "Only one healthy RE connected.",
7302
7388
  "x-f5xc-example": "Only one healthy RE connected",
7389
+ "x-f5xc-description-short": "Human readable string explaining the reason in case of bad healthscore.",
7303
7390
  "minLength": 0,
7304
7391
  "maxLength": 43,
7305
7392
  "x-f5xc-required-for": {
@@ -7310,7 +7397,7 @@
7310
7397
  },
7311
7398
  "x-original-maxLength": 1024,
7312
7399
  "x-reconciled-from-discovery": true,
7313
- "x-reconciled-at": "2026-01-05T18:29:09.440410+00:00"
7400
+ "x-reconciled-at": "2026-01-07T15:28:25.309002+00:00"
7314
7401
  },
7315
7402
  "type": {
7316
7403
  "$ref": "#/components/schemas/graphHealthscoreType"
@@ -7332,9 +7419,10 @@
7332
7419
  "maxLength": 15,
7333
7420
  "minLength": 3,
7334
7421
  "x-reconciled-from-discovery": true,
7335
- "x-reconciled-at": "2026-01-05T18:29:09.440417+00:00"
7422
+ "x-reconciled-at": "2026-01-07T15:28:25.309009+00:00"
7336
7423
  }
7337
7424
  },
7425
+ "x-f5xc-description-short": "HealthScoreTypeData contains healthscore type and the corresponding value.",
7338
7426
  "x-f5xc-minimum-configuration": {
7339
7427
  "description": "Minimum configuration for graphHealthscoreTypeData",
7340
7428
  "required_fields": [
@@ -7364,6 +7452,7 @@
7364
7452
  "$ref": "#/components/schemas/schemagraphMetricValue"
7365
7453
  },
7366
7454
  "x-displayname": "Anomaly",
7455
+ "x-f5xc-description-short": "Number of anomalies for the given time range.",
7367
7456
  "x-f5xc-required-for": {
7368
7457
  "minimum_config": false,
7369
7458
  "create": false,
@@ -7409,6 +7498,8 @@
7409
7498
  "$ref": "#/components/schemas/schemagraphMetricValue"
7410
7499
  },
7411
7500
  "x-displayname": "Healthscore.",
7501
+ "x-f5xc-description-short": "Healscore of the metric calculated based on the number of anomalies and the value of the anomalies for the time range.",
7502
+ "x-f5xc-description-medium": "Healscore of the metric calculated based on the number of anomalies and the value of the anomalies for the time range.",
7412
7503
  "x-f5xc-required-for": {
7413
7504
  "minimum_config": false,
7414
7505
  "create": false,
@@ -7424,6 +7515,7 @@
7424
7515
  "$ref": "#/components/schemas/schemagraphMetricValue"
7425
7516
  },
7426
7517
  "x-displayname": "Raw",
7518
+ "x-f5xc-description-short": "List of metric values for a given metric type.",
7427
7519
  "x-f5xc-required-for": {
7428
7520
  "minimum_config": false,
7429
7521
  "create": false,
@@ -7447,6 +7539,7 @@
7447
7539
  }
7448
7540
  }
7449
7541
  },
7542
+ "x-f5xc-description-short": "Contains metric values for timeseries features specified in the request.",
7450
7543
  "x-f5xc-minimum-configuration": {
7451
7544
  "description": "Minimum configuration for graphMetricFeatureData",
7452
7545
  "required_fields": [
@@ -7476,6 +7569,8 @@
7476
7569
  "default": "NOP",
7477
7570
  "x-displayname": "Label Operator.",
7478
7571
  "x-ves-proto-enum": "ves.io.schema.graph.QueryOp",
7572
+ "x-f5xc-description-short": "Match operators supported on a label Indicates that the field is not set Select timeseries whose label value exactly matches the specified string...",
7573
+ "x-f5xc-description-medium": "Match operators supported on a label Indicates that the field is not set Select timeseries whose label value exactly matches the specified string Select timeseries whose label value does not match the specified string.",
7479
7574
  "x-f5xc-minimum-configuration": {
7480
7575
  "description": "Minimum configuration for graphQueryOp",
7481
7576
  "required_fields": [],
@@ -7503,6 +7598,7 @@
7503
7598
  "$ref": "#/components/schemas/graphMetricFeatureData"
7504
7599
  }
7505
7600
  },
7601
+ "x-f5xc-description-short": "EdgeMetricData contains the metric type and the corresponding metric value.",
7506
7602
  "x-f5xc-minimum-configuration": {
7507
7603
  "description": "Minimum configuration for graphconnectivityEdgeMetricData",
7508
7604
  "required_fields": [
@@ -7532,6 +7628,8 @@
7532
7628
  "$ref": "#/components/schemas/timeseriesTimeseriesFeature"
7533
7629
  },
7534
7630
  "x-displayname": "Features",
7631
+ "x-f5xc-example": "True",
7632
+ "x-f5xc-description-short": "Specify list of timeseries features that should be returned for each metric type in the request.",
7535
7633
  "x-f5xc-required-for": {
7536
7634
  "minimum_config": false,
7537
7635
  "create": false,
@@ -7553,6 +7651,7 @@
7553
7651
  "x-validation-rules": {
7554
7652
  "ves.io.schema.rules.repeated.unique": "true"
7555
7653
  },
7654
+ "x-f5xc-description-short": "Specify list of metrics that should be returned for each edge in the connectivity graph.",
7556
7655
  "x-f5xc-required-for": {
7557
7656
  "minimum_config": false,
7558
7657
  "create": false,
@@ -7561,6 +7660,7 @@
7561
7660
  }
7562
7661
  }
7563
7662
  },
7663
+ "x-f5xc-description-short": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.",
7564
7664
  "x-f5xc-minimum-configuration": {
7565
7665
  "description": "Minimum configuration for graphconnectivityEdgeMetricSelector",
7566
7666
  "required_fields": [
@@ -7588,6 +7688,8 @@
7588
7688
  "default": "LABEL_NONE",
7589
7689
  "x-displayname": "Label",
7590
7690
  "x-ves-proto-enum": "ves.io.schema.graph.connectivity.Label",
7691
+ "x-f5xc-description-short": "Metrics used to construct the connectivity graph are tagged with these labels and therefore the metrics can be sliced and diced based on one or...",
7692
+ "x-f5xc-description-medium": "Metrics used to construct the connectivity graph are tagged with these labels and therefore the metrics can be sliced and diced based on one or more labels. Indicates the field not being set Identifies a site (CE or RE) Identifies a network (INSIDE or OUTSIDE or segment) Identifies a interface...",
7591
7693
  "x-f5xc-minimum-configuration": {
7592
7694
  "description": "Minimum configuration for graphconnectivityLabel",
7593
7695
  "required_fields": [],
@@ -7615,6 +7717,7 @@
7615
7717
  "$ref": "#/components/schemas/graphMetricFeatureData"
7616
7718
  }
7617
7719
  },
7720
+ "x-f5xc-description-short": "NodeMetricData contains metric type and the corresponding value for a node.",
7618
7721
  "x-f5xc-minimum-configuration": {
7619
7722
  "description": "Minimum configuration for graphconnectivityNodeMetricData",
7620
7723
  "required_fields": [
@@ -7644,6 +7747,8 @@
7644
7747
  "$ref": "#/components/schemas/timeseriesTimeseriesFeature"
7645
7748
  },
7646
7749
  "x-displayname": "Features",
7750
+ "x-f5xc-example": "True",
7751
+ "x-f5xc-description-short": "Specify list of timeseries features that should be returned for each metric type in the request.",
7647
7752
  "x-f5xc-required-for": {
7648
7753
  "minimum_config": false,
7649
7754
  "create": false,
@@ -7686,6 +7791,7 @@
7686
7791
  "x-validation-rules": {
7687
7792
  "ves.io.schema.rules.repeated.unique": "true"
7688
7793
  },
7794
+ "x-f5xc-description-short": "Specify list of metrics that should be returned for each physical interface in a site.",
7689
7795
  "x-f5xc-required-for": {
7690
7796
  "minimum_config": false,
7691
7797
  "create": false,
@@ -7707,6 +7813,7 @@
7707
7813
  "x-validation-rules": {
7708
7814
  "ves.io.schema.rules.repeated.unique": "true"
7709
7815
  },
7816
+ "x-f5xc-description-short": "Specify list of metrics that should be returned for each node in the connectivity graph.",
7710
7817
  "x-f5xc-required-for": {
7711
7818
  "minimum_config": false,
7712
7819
  "create": false,
@@ -7715,6 +7822,7 @@
7715
7822
  }
7716
7823
  }
7717
7824
  },
7825
+ "x-f5xc-description-short": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
7718
7826
  "x-f5xc-minimum-configuration": {
7719
7827
  "description": "Minimum configuration for graphconnectivityNodeMetricSelector",
7720
7828
  "required_fields": [
@@ -7742,6 +7850,7 @@
7742
7850
  "default": "TREND_SENTIMENT_NONE",
7743
7851
  "x-displayname": "Trend Sentiment.",
7744
7852
  "x-ves-proto-enum": "ves.io.schema.TrendSentiment",
7853
+ "x-f5xc-description-short": "Trend sentiment Indicates trend sentiment is positive Indicates trend sentiment is negative.",
7745
7854
  "x-f5xc-minimum-configuration": {
7746
7855
  "description": "Minimum configuration for schemaTrendSentiment",
7747
7856
  "required_fields": [],
@@ -7766,6 +7875,7 @@
7766
7875
  "x-displayname": "Description.",
7767
7876
  "x-ves-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval.",
7768
7877
  "x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval",
7878
+ "x-f5xc-description-short": "Description of the method used to calculate trend.",
7769
7879
  "minLength": 0,
7770
7880
  "maxLength": 0,
7771
7881
  "x-f5xc-required-for": {
@@ -7776,15 +7886,16 @@
7776
7886
  },
7777
7887
  "x-original-maxLength": 1024,
7778
7888
  "x-reconciled-from-discovery": true,
7779
- "x-reconciled-at": "2026-01-05T18:29:09.440448+00:00"
7889
+ "x-reconciled-at": "2026-01-07T15:28:25.309039+00:00"
7780
7890
  },
7781
7891
  "previous_value": {
7782
7892
  "type": "string",
7783
- "description": "",
7893
+ "description": "Configuration parameter for previous value",
7784
7894
  "title": "Previous Value.",
7785
7895
  "x-displayname": "Previous Value.",
7786
7896
  "x-ves-example": "200.00",
7787
7897
  "x-f5xc-example": "200.00",
7898
+ "x-f5xc-description-short": "Configuration parameter for previous value.",
7788
7899
  "minLength": 0,
7789
7900
  "maxLength": 1024,
7790
7901
  "x-f5xc-required-for": {
@@ -7799,7 +7910,7 @@
7799
7910
  },
7800
7911
  "value": {
7801
7912
  "type": "string",
7802
- "description": "",
7913
+ "description": "Configuration parameter for value",
7803
7914
  "title": "Value",
7804
7915
  "x-displayname": "Value",
7805
7916
  "x-ves-example": "-15",
@@ -7814,9 +7925,11 @@
7814
7925
  },
7815
7926
  "x-original-maxLength": 1024,
7816
7927
  "x-reconciled-from-discovery": true,
7817
- "x-reconciled-at": "2026-01-05T18:29:09.440455+00:00"
7928
+ "x-reconciled-at": "2026-01-07T15:28:25.309047+00:00"
7818
7929
  }
7819
7930
  },
7931
+ "x-f5xc-description-short": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
7932
+ "x-f5xc-description-medium": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
7820
7933
  "x-f5xc-minimum-configuration": {
7821
7934
  "description": "Minimum configuration for schemaTrendValue",
7822
7935
  "required_fields": [
@@ -7868,6 +7981,7 @@
7868
7981
  "default": "UNIT_MILLISECONDS",
7869
7982
  "x-displayname": "Unit",
7870
7983
  "x-ves-proto-enum": "ves.io.schema.UnitType",
7984
+ "x-f5xc-description-short": "UnitType is enumeration of units for scalar fields.",
7871
7985
  "x-f5xc-minimum-configuration": {
7872
7986
  "description": "Minimum configuration for schemaUnitType",
7873
7987
  "required_fields": [],
@@ -7920,9 +8034,11 @@
7920
8034
  },
7921
8035
  "x-original-maxLength": 1024,
7922
8036
  "x-reconciled-from-discovery": true,
7923
- "x-reconciled-at": "2026-01-05T18:29:09.440463+00:00"
8037
+ "x-reconciled-at": "2026-01-07T15:28:25.309056+00:00"
7924
8038
  }
7925
8039
  },
8040
+ "x-f5xc-description-short": "Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request.",
8041
+ "x-f5xc-description-medium": "Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, ...",
7926
8042
  "x-f5xc-minimum-configuration": {
7927
8043
  "description": "Minimum configuration for schemagraphMetricValue",
7928
8044
  "required_fields": [
@@ -7950,6 +8066,7 @@
7950
8066
  "default": "INVALID",
7951
8067
  "x-displayname": "Site Type",
7952
8068
  "x-ves-proto-enum": "ves.io.schema.site.SiteType",
8069
+ "x-f5xc-description-short": "Site Type which can either RE or CE Invalid type of site Regional Edge site Customer Edge site.",
7953
8070
  "x-f5xc-minimum-configuration": {
7954
8071
  "description": "Minimum configuration for siteSiteType",
7955
8072
  "required_fields": [],
@@ -7974,6 +8091,8 @@
7974
8091
  "default": "TIMESERIES_FEATURE_NONE",
7975
8092
  "x-displayname": "Timeseries.",
7976
8093
  "x-ves-proto-enum": "ves.io.schema.timeseries.TimeseriesFeature",
8094
+ "x-f5xc-description-short": "Various Timeseries Features that can be enabled Do not enable any feature Enable calculating confidence interval, upper and lower bound time...",
8095
+ "x-f5xc-description-medium": "Various Timeseries Features that can be enabled Do not enable any feature Enable calculating confidence interval, upper and lower bound time series where metric is expected to vary. Detect anomalies and generate alarm when metric goes out of confidence interval detect trend of the metric...",
7977
8096
  "x-f5xc-minimum-configuration": {
7978
8097
  "description": "Minimum configuration for timeseriesTimeseriesFeature",
7979
8098
  "required_fields": [],
@@ -8009,6 +8128,7 @@
8009
8128
  "x-validation-rules": {
8010
8129
  "ves.io.schema.rules.repeated.max_items": "50"
8011
8130
  },
8131
+ "x-f5xc-description-short": "List of pod-name to IP address mappings for the service.",
8012
8132
  "x-f5xc-required-for": {
8013
8133
  "minimum_config": false,
8014
8134
  "create": false,
@@ -8031,6 +8151,7 @@
8031
8151
  "x-validation-rules": {
8032
8152
  "ves.io.schema.rules.repeated.max_items": "50"
8033
8153
  },
8154
+ "x-f5xc-description-short": "List of ports along with protocol on which the service is exposed.",
8034
8155
  "x-f5xc-required-for": {
8035
8156
  "minimum_config": false,
8036
8157
  "create": false,
@@ -8052,6 +8173,7 @@
8052
8173
  "x-validation-rules": {
8053
8174
  "ves.io.schema.rules.message.required": "true"
8054
8175
  },
8176
+ "x-f5xc-description-short": "Name of the discovered service Required: YES.",
8055
8177
  "minLength": 0,
8056
8178
  "maxLength": 1024,
8057
8179
  "x-f5xc-required-for": {
@@ -8144,6 +8266,7 @@
8144
8266
  "x-validation-rules": {
8145
8267
  "ves.io.schema.rules.message.required": "true"
8146
8268
  },
8269
+ "x-f5xc-description-short": "Identifies the discovered service name Required: YES.",
8147
8270
  "minLength": 0,
8148
8271
  "maxLength": 16,
8149
8272
  "x-f5xc-required-for": {
@@ -8154,7 +8277,7 @@
8154
8277
  },
8155
8278
  "x-original-maxLength": 1024,
8156
8279
  "x-reconciled-from-discovery": true,
8157
- "x-reconciled-at": "2026-01-05T18:29:16.070770+00:00"
8280
+ "x-reconciled-at": "2026-01-07T15:28:33.610784+00:00"
8158
8281
  },
8159
8282
  "namespace": {
8160
8283
  "type": "string",
@@ -8170,6 +8293,7 @@
8170
8293
  "x-validation-rules": {
8171
8294
  "ves.io.schema.rules.message.required": "true"
8172
8295
  },
8296
+ "x-f5xc-description-short": "Namespace of the discovered service for current request Required: YES.",
8173
8297
  "minLength": 0,
8174
8298
  "maxLength": 6,
8175
8299
  "x-f5xc-required-for": {
@@ -8180,7 +8304,7 @@
8180
8304
  },
8181
8305
  "x-original-maxLength": 1024,
8182
8306
  "x-reconciled-from-discovery": true,
8183
- "x-reconciled-at": "2026-01-05T18:29:16.070777+00:00"
8307
+ "x-reconciled-at": "2026-01-07T15:28:33.610791+00:00"
8184
8308
  },
8185
8309
  "tcp_lb_request": {
8186
8310
  "$ref": "#/components/schemas/discovered_serviceTCPLBRequest"
@@ -8244,6 +8368,7 @@
8244
8368
  "x-validation-rules": {
8245
8369
  "ves.io.schema.rules.message.required": "true"
8246
8370
  },
8371
+ "x-f5xc-description-short": "Identifies the discovered service name Required: YES.",
8247
8372
  "minLength": 0,
8248
8373
  "maxLength": 16,
8249
8374
  "x-f5xc-required-for": {
@@ -8254,7 +8379,7 @@
8254
8379
  },
8255
8380
  "x-original-maxLength": 1024,
8256
8381
  "x-reconciled-from-discovery": true,
8257
- "x-reconciled-at": "2026-01-05T18:29:16.070786+00:00"
8382
+ "x-reconciled-at": "2026-01-07T15:28:33.610800+00:00"
8258
8383
  },
8259
8384
  "namespace": {
8260
8385
  "type": "string",
@@ -8270,6 +8395,7 @@
8270
8395
  "x-validation-rules": {
8271
8396
  "ves.io.schema.rules.message.required": "true"
8272
8397
  },
8398
+ "x-f5xc-description-short": "Namespace of the discovered service for current request Required: YES.",
8273
8399
  "minLength": 0,
8274
8400
  "maxLength": 6,
8275
8401
  "x-f5xc-required-for": {
@@ -8280,9 +8406,10 @@
8280
8406
  },
8281
8407
  "x-original-maxLength": 1024,
8282
8408
  "x-reconciled-from-discovery": true,
8283
- "x-reconciled-at": "2026-01-05T18:29:16.070791+00:00"
8409
+ "x-reconciled-at": "2026-01-07T15:28:33.610805+00:00"
8284
8410
  }
8285
8411
  },
8412
+ "x-f5xc-description-short": "Disable visibility on the discovered service.",
8286
8413
  "x-f5xc-minimum-configuration": {
8287
8414
  "description": "Minimum configuration for discovered_serviceDisableVisibilityRequest",
8288
8415
  "required_fields": [
@@ -8302,6 +8429,7 @@
8302
8429
  "title": "DisableVisibilityResponse.",
8303
8430
  "x-displayname": "Disable Visibility Response.",
8304
8431
  "x-ves-proto-message": "ves.io.schema.discovered_service.DisableVisibilityResponse",
8432
+ "x-f5xc-description-short": "Response to the Disable Visibility request.",
8305
8433
  "x-f5xc-minimum-configuration": {
8306
8434
  "description": "Minimum configuration for discovered_serviceDisableVisibilityResponse",
8307
8435
  "required_fields": [],
@@ -8327,6 +8455,7 @@
8327
8455
  "$ref": "#/components/schemas/schemaMetricValue"
8328
8456
  },
8329
8457
  "x-displayname": "Status",
8458
+ "x-f5xc-example": "active",
8330
8459
  "x-f5xc-required-for": {
8331
8460
  "minimum_config": false,
8332
8461
  "create": false,
@@ -8336,12 +8465,13 @@
8336
8465
  "maxLength": 17,
8337
8466
  "minLength": 17,
8338
8467
  "x-reconciled-from-discovery": true,
8339
- "x-reconciled-at": "2026-01-05T18:29:16.070798+00:00"
8468
+ "x-reconciled-at": "2026-01-07T15:28:33.610812+00:00"
8340
8469
  },
8341
8470
  "virtual_server_pool_members_health": {
8342
8471
  "$ref": "#/components/schemas/discovered_serviceVirtualServerPoolMemberHealth"
8343
8472
  }
8344
8473
  },
8474
+ "x-f5xc-description-short": "Response for Discovered Service Health Status Request.",
8345
8475
  "x-f5xc-minimum-configuration": {
8346
8476
  "description": "Minimum configuration for discovered_serviceDiscoveredServiceHealthStatusResponse",
8347
8477
  "required_fields": [
@@ -8376,6 +8506,7 @@
8376
8506
  "x-validation-rules": {
8377
8507
  "ves.io.schema.rules.message.required": "true"
8378
8508
  },
8509
+ "x-f5xc-description-short": "Identifies the discovered service name Required: YES.",
8379
8510
  "minLength": 0,
8380
8511
  "maxLength": 16,
8381
8512
  "x-f5xc-required-for": {
@@ -8386,7 +8517,7 @@
8386
8517
  },
8387
8518
  "x-original-maxLength": 1024,
8388
8519
  "x-reconciled-from-discovery": true,
8389
- "x-reconciled-at": "2026-01-05T18:29:16.070805+00:00"
8520
+ "x-reconciled-at": "2026-01-07T15:28:33.610819+00:00"
8390
8521
  },
8391
8522
  "namespace": {
8392
8523
  "type": "string",
@@ -8402,6 +8533,7 @@
8402
8533
  "x-validation-rules": {
8403
8534
  "ves.io.schema.rules.message.required": "true"
8404
8535
  },
8536
+ "x-f5xc-description-short": "Namespace of the discovered service for current request Required: YES.",
8405
8537
  "minLength": 0,
8406
8538
  "maxLength": 6,
8407
8539
  "x-f5xc-required-for": {
@@ -8412,9 +8544,10 @@
8412
8544
  },
8413
8545
  "x-original-maxLength": 1024,
8414
8546
  "x-reconciled-from-discovery": true,
8415
- "x-reconciled-at": "2026-01-05T18:29:16.070809+00:00"
8547
+ "x-reconciled-at": "2026-01-07T15:28:33.610823+00:00"
8416
8548
  }
8417
8549
  },
8550
+ "x-f5xc-description-short": "Enable visibility of the discovered service in all workspaces like WAAP, App Connect, etc.",
8418
8551
  "x-f5xc-minimum-configuration": {
8419
8552
  "description": "Minimum configuration for discovered_serviceEnableVisibilityRequest",
8420
8553
  "required_fields": [
@@ -8439,6 +8572,7 @@
8439
8572
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
8440
8573
  }
8441
8574
  },
8575
+ "x-f5xc-description-short": "Response to the Enable Visibility request.",
8442
8576
  "x-f5xc-minimum-configuration": {
8443
8577
  "description": "Minimum configuration for discovered_serviceEnableVisibilityResponse",
8444
8578
  "required_fields": [
@@ -8466,6 +8600,7 @@
8466
8600
  "$ref": "#/components/schemas/ioschemaObjectRefType"
8467
8601
  },
8468
8602
  "x-displayname": "Deleted Referred Objects.",
8603
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
8469
8604
  "x-f5xc-required-for": {
8470
8605
  "minimum_config": false,
8471
8606
  "create": false,
@@ -8481,6 +8616,7 @@
8481
8616
  "$ref": "#/components/schemas/ioschemaObjectRefType"
8482
8617
  },
8483
8618
  "x-displayname": "Disabled Referred Objects.",
8619
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
8484
8620
  "x-f5xc-required-for": {
8485
8621
  "minimum_config": false,
8486
8622
  "create": false,
@@ -8499,6 +8635,7 @@
8499
8635
  "$ref": "#/components/schemas/ioschemaObjectRefType"
8500
8636
  },
8501
8637
  "x-displayname": "Referring Objects.",
8638
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
8502
8639
  "x-f5xc-required-for": {
8503
8640
  "minimum_config": false,
8504
8641
  "create": false,
@@ -8541,6 +8678,8 @@
8541
8678
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
8542
8679
  ],
8543
8680
  "default": "GET_RSP_FORMAT_DEFAULT",
8681
+ "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...",
8682
+ "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_READ: x-displayName: \"GetSpecType format\" Response should be in format...",
8544
8683
  "x-f5xc-minimum-configuration": {
8545
8684
  "description": "Minimum configuration for discovered_serviceGetResponseFormatCode",
8546
8685
  "required_fields": [],
@@ -8589,7 +8728,7 @@
8589
8728
  "x-original-maxLength": 1024,
8590
8729
  "format": "hostname",
8591
8730
  "x-reconciled-from-discovery": true,
8592
- "x-reconciled-at": "2026-01-05T18:29:16.070826+00:00"
8731
+ "x-reconciled-at": "2026-01-07T15:28:33.610840+00:00"
8593
8732
  },
8594
8733
  "http": {
8595
8734
  "$ref": "#/components/schemas/discovered_serviceProxyTypeHttp"
@@ -8614,6 +8753,8 @@
8614
8753
  "x-validation-rules": {
8615
8754
  "ves.io.schema.rules.message.required": "true"
8616
8755
  },
8756
+ "x-f5xc-description-short": "The configuration object will be created with name. It has to be unique within the namespace.",
8757
+ "x-f5xc-description-medium": "The configuration object will be created with name. It has to be unique within the namespace. The value of name has to follow DNS-1035 format. Required: YES.",
8617
8758
  "minLength": 0,
8618
8759
  "maxLength": 16,
8619
8760
  "x-f5xc-required-for": {
@@ -8624,7 +8765,7 @@
8624
8765
  },
8625
8766
  "x-original-maxLength": 1024,
8626
8767
  "x-reconciled-from-discovery": true,
8627
- "x-reconciled-at": "2026-01-05T18:29:16.070835+00:00"
8768
+ "x-reconciled-at": "2026-01-07T15:28:33.610850+00:00"
8628
8769
  },
8629
8770
  "skip_server_verification": {
8630
8771
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -8676,6 +8817,7 @@
8676
8817
  "x-validation-rules": {
8677
8818
  "ves.io.schema.rules.repeated.max_items": "50"
8678
8819
  },
8820
+ "x-f5xc-description-short": "List of pod-name to IP address mappings for the service.",
8679
8821
  "x-f5xc-required-for": {
8680
8822
  "minimum_config": false,
8681
8823
  "create": false,
@@ -8698,6 +8840,7 @@
8698
8840
  "x-validation-rules": {
8699
8841
  "ves.io.schema.rules.repeated.max_items": "50"
8700
8842
  },
8843
+ "x-f5xc-description-short": "List of ports along with protocol on which the service is exposed.",
8701
8844
  "x-f5xc-required-for": {
8702
8845
  "minimum_config": false,
8703
8846
  "create": false,
@@ -8719,6 +8862,7 @@
8719
8862
  "x-validation-rules": {
8720
8863
  "ves.io.schema.rules.message.required": "true"
8721
8864
  },
8865
+ "x-f5xc-description-short": "Name of the discovered service Required: YES.",
8722
8866
  "minLength": 0,
8723
8867
  "maxLength": 1024,
8724
8868
  "x-f5xc-required-for": {
@@ -8759,6 +8903,7 @@
8759
8903
  "$ref": "#/components/schemas/schemaErrorType"
8760
8904
  },
8761
8905
  "x-displayname": "Errors",
8906
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
8762
8907
  "x-f5xc-required-for": {
8763
8908
  "minimum_config": false,
8764
8909
  "create": false,
@@ -8774,6 +8919,8 @@
8774
8919
  "$ref": "#/components/schemas/discovered_serviceListResponseItem"
8775
8920
  },
8776
8921
  "x-displayname": "Items",
8922
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
8923
+ "x-f5xc-description-short": "Items represents the collection in response.",
8777
8924
  "x-f5xc-required-for": {
8778
8925
  "minimum_config": false,
8779
8926
  "create": false,
@@ -8807,6 +8954,8 @@
8807
8954
  "description": "The set of annotations present on this discovered_service.",
8808
8955
  "title": "Annotations.",
8809
8956
  "x-displayname": "Annotations.",
8957
+ "x-f5xc-example": "{\"key\": \"value\"}",
8958
+ "x-f5xc-description-short": "The set of annotations present on this discovered_service.",
8810
8959
  "x-f5xc-required-for": {
8811
8960
  "minimum_config": false,
8812
8961
  "create": false,
@@ -8819,6 +8968,7 @@
8819
8968
  "description": "The description set for this discovered_service.",
8820
8969
  "title": "Description.",
8821
8970
  "x-displayname": "Description.",
8971
+ "x-f5xc-description-short": "The description set for this discovered_service.",
8822
8972
  "minLength": 0,
8823
8973
  "maxLength": 0,
8824
8974
  "x-f5xc-required-for": {
@@ -8829,7 +8979,7 @@
8829
8979
  },
8830
8980
  "x-original-maxLength": 1024,
8831
8981
  "x-reconciled-from-discovery": true,
8832
- "x-reconciled-at": "2026-01-05T18:29:16.070855+00:00"
8982
+ "x-reconciled-at": "2026-01-07T15:28:33.610870+00:00"
8833
8983
  },
8834
8984
  "disabled": {
8835
8985
  "type": "boolean",
@@ -8837,6 +8987,8 @@
8837
8987
  "title": "Disabled",
8838
8988
  "format": "boolean",
8839
8989
  "x-displayname": "Disabled",
8990
+ "x-f5xc-example": "True",
8991
+ "x-f5xc-description-short": "Value of true indicates discovered_service is administratively disabled.",
8840
8992
  "x-f5xc-required-for": {
8841
8993
  "minimum_config": false,
8842
8994
  "create": false,
@@ -8852,6 +9004,8 @@
8852
9004
  "description": "The set of labels present on this discovered_service.",
8853
9005
  "title": "Labels",
8854
9006
  "x-displayname": "Labels",
9007
+ "x-f5xc-example": "{\"key\": \"value\"}",
9008
+ "x-f5xc-description-short": "The set of labels present on this discovered_service.",
8855
9009
  "x-f5xc-required-for": {
8856
9010
  "minimum_config": false,
8857
9011
  "create": false,
@@ -8879,7 +9033,7 @@
8879
9033
  },
8880
9034
  "x-original-maxLength": 1024,
8881
9035
  "x-reconciled-from-discovery": true,
8882
- "x-reconciled-at": "2026-01-05T18:29:16.070865+00:00"
9036
+ "x-reconciled-at": "2026-01-07T15:28:33.610881+00:00"
8883
9037
  },
8884
9038
  "namespace": {
8885
9039
  "type": "string",
@@ -8898,7 +9052,7 @@
8898
9052
  },
8899
9053
  "x-original-maxLength": 1024,
8900
9054
  "x-reconciled-from-discovery": true,
8901
- "x-reconciled-at": "2026-01-05T18:29:16.070870+00:00"
9055
+ "x-reconciled-at": "2026-01-07T15:28:33.610886+00:00"
8902
9056
  },
8903
9057
  "owner_view": {
8904
9058
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -8924,7 +9078,7 @@
8924
9078
  "x-field-mutability": "read-only",
8925
9079
  "x-original-maxLength": 1024,
8926
9080
  "x-reconciled-from-discovery": true,
8927
- "x-reconciled-at": "2026-01-05T18:29:16.070876+00:00"
9081
+ "x-reconciled-at": "2026-01-07T15:28:33.610892+00:00"
8928
9082
  },
8929
9083
  "uid": {
8930
9084
  "type": "string",
@@ -8933,6 +9087,7 @@
8933
9087
  "x-displayname": "UID",
8934
9088
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
8935
9089
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
9090
+ "x-f5xc-description-short": "The unique uid of this discovered_service.",
8936
9091
  "minLength": 0,
8937
9092
  "maxLength": 36,
8938
9093
  "x-f5xc-required-for": {
@@ -8945,9 +9100,11 @@
8945
9100
  "x-original-maxLength": 1024,
8946
9101
  "format": "uuid",
8947
9102
  "x-reconciled-from-discovery": true,
8948
- "x-reconciled-at": "2026-01-05T18:29:16.070882+00:00"
9103
+ "x-reconciled-at": "2026-01-07T15:28:33.610898+00:00"
8949
9104
  }
8950
9105
  },
9106
+ "x-f5xc-description-short": "By default a summary of discovered_service is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
9107
+ "x-f5xc-description-medium": "By default a summary of discovered_service is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
8951
9108
  "x-f5xc-minimum-configuration": {
8952
9109
  "description": "Minimum configuration for discovered_serviceListResponseItem",
8953
9110
  "required_fields": [
@@ -8986,6 +9143,7 @@
8986
9143
  "$ref": "#/components/schemas/schemaErrorType"
8987
9144
  },
8988
9145
  "x-displayname": "Errors",
9146
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
8989
9147
  "x-f5xc-required-for": {
8990
9148
  "minimum_config": false,
8991
9149
  "create": false,
@@ -9001,6 +9159,8 @@
9001
9159
  "$ref": "#/components/schemas/discovered_serviceListServicesResponseItem"
9002
9160
  },
9003
9161
  "x-displayname": "Items",
9162
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
9163
+ "x-f5xc-description-short": "Items represents the collection in response.",
9004
9164
  "x-f5xc-required-for": {
9005
9165
  "minimum_config": false,
9006
9166
  "create": false,
@@ -9009,6 +9169,7 @@
9009
9169
  }
9010
9170
  }
9011
9171
  },
9172
+ "x-f5xc-description-short": "Output message of List for specific service type.",
9012
9173
  "x-f5xc-minimum-configuration": {
9013
9174
  "description": "Minimum configuration for discovered_serviceListServicesResponse",
9014
9175
  "required_fields": [
@@ -9034,6 +9195,8 @@
9034
9195
  "description": "The set of annotations present on this discovered service.",
9035
9196
  "title": "Annotations.",
9036
9197
  "x-displayname": "Annotations.",
9198
+ "x-f5xc-example": "{\"key\": \"value\"}",
9199
+ "x-f5xc-description-short": "The set of annotations present on this discovered service.",
9037
9200
  "x-f5xc-required-for": {
9038
9201
  "minimum_config": false,
9039
9202
  "create": false,
@@ -9046,6 +9209,7 @@
9046
9209
  "description": "The description set for this discovered service.",
9047
9210
  "title": "Description.",
9048
9211
  "x-displayname": "Description.",
9212
+ "x-f5xc-description-short": "The description set for this discovered service.",
9049
9213
  "minLength": 0,
9050
9214
  "maxLength": 0,
9051
9215
  "x-f5xc-required-for": {
@@ -9056,7 +9220,7 @@
9056
9220
  },
9057
9221
  "x-original-maxLength": 1024,
9058
9222
  "x-reconciled-from-discovery": true,
9059
- "x-reconciled-at": "2026-01-05T18:29:16.070893+00:00"
9223
+ "x-reconciled-at": "2026-01-07T15:28:33.610909+00:00"
9060
9224
  },
9061
9225
  "disabled": {
9062
9226
  "type": "boolean",
@@ -9064,6 +9228,8 @@
9064
9228
  "title": "Disabled",
9065
9229
  "format": "boolean",
9066
9230
  "x-displayname": "Disabled",
9231
+ "x-f5xc-example": "True",
9232
+ "x-f5xc-description-short": "Value of true indicates discovered service is administratively disabled.",
9067
9233
  "x-f5xc-required-for": {
9068
9234
  "minimum_config": false,
9069
9235
  "create": false,
@@ -9079,6 +9245,8 @@
9079
9245
  "description": "The set of labels present on this discovered service.",
9080
9246
  "title": "Labels",
9081
9247
  "x-displayname": "Labels",
9248
+ "x-f5xc-example": "{\"key\": \"value\"}",
9249
+ "x-f5xc-description-short": "The set of labels present on this discovered service.",
9082
9250
  "x-f5xc-required-for": {
9083
9251
  "minimum_config": false,
9084
9252
  "create": false,
@@ -9106,7 +9274,7 @@
9106
9274
  },
9107
9275
  "x-original-maxLength": 1024,
9108
9276
  "x-reconciled-from-discovery": true,
9109
- "x-reconciled-at": "2026-01-05T18:29:16.070903+00:00"
9277
+ "x-reconciled-at": "2026-01-07T15:28:33.610918+00:00"
9110
9278
  },
9111
9279
  "namespace": {
9112
9280
  "type": "string",
@@ -9125,7 +9293,7 @@
9125
9293
  },
9126
9294
  "x-original-maxLength": 1024,
9127
9295
  "x-reconciled-from-discovery": true,
9128
- "x-reconciled-at": "2026-01-05T18:29:16.070907+00:00"
9296
+ "x-reconciled-at": "2026-01-07T15:28:33.610923+00:00"
9129
9297
  },
9130
9298
  "owner_view": {
9131
9299
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -9138,6 +9306,7 @@
9138
9306
  "$ref": "#/components/schemas/discovered_serviceStatusObject"
9139
9307
  },
9140
9308
  "x-displayname": "Status",
9309
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
9141
9310
  "x-f5xc-required-for": {
9142
9311
  "minimum_config": false,
9143
9312
  "create": false,
@@ -9166,7 +9335,7 @@
9166
9335
  "x-field-mutability": "read-only",
9167
9336
  "x-original-maxLength": 1024,
9168
9337
  "x-reconciled-from-discovery": true,
9169
- "x-reconciled-at": "2026-01-05T18:29:16.070915+00:00"
9338
+ "x-reconciled-at": "2026-01-07T15:28:33.610930+00:00"
9170
9339
  },
9171
9340
  "uid": {
9172
9341
  "type": "string",
@@ -9175,6 +9344,7 @@
9175
9344
  "x-displayname": "UID",
9176
9345
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
9177
9346
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
9347
+ "x-f5xc-description-short": "The unique uid of this discovered service.",
9178
9348
  "minLength": 0,
9179
9349
  "maxLength": 36,
9180
9350
  "x-f5xc-required-for": {
@@ -9187,9 +9357,11 @@
9187
9357
  "x-original-maxLength": 1024,
9188
9358
  "format": "uuid",
9189
9359
  "x-reconciled-from-discovery": true,
9190
- "x-reconciled-at": "2026-01-05T18:29:16.070920+00:00"
9360
+ "x-reconciled-at": "2026-01-07T15:28:33.610935+00:00"
9191
9361
  }
9192
9362
  },
9363
+ "x-f5xc-description-short": "By default a summary of discovered services is returned in 'List'.",
9364
+ "x-f5xc-description-medium": "By default a summary of discovered services is returned in 'List'. By setting 'report_fields' in the ListServicesRequest more details of each item can be got.",
9193
9365
  "x-f5xc-minimum-configuration": {
9194
9366
  "description": "Minimum configuration for discovered_serviceListServicesResponseItem",
9195
9367
  "required_fields": [
@@ -9264,6 +9436,7 @@
9264
9436
  "ves.io.schema.rules.string.max_bytes": "256",
9265
9437
  "ves.io.schema.rules.string.not_empty": "true"
9266
9438
  },
9439
+ "x-f5xc-description-short": "ID of the NGINX Instance or Config Sync Group Required: YES.",
9267
9440
  "minLength": 0,
9268
9441
  "x-f5xc-required-for": {
9269
9442
  "minimum_config": false,
@@ -9278,6 +9451,8 @@
9278
9451
  "description": "Hostname value set for Instance or Name for a Config Sync Group\nin NGINX One.",
9279
9452
  "title": "NGINX Instance or Config Sync Group Name.",
9280
9453
  "x-displayname": "Instance or Config Sync Group Name.",
9454
+ "x-f5xc-example": "example-resource",
9455
+ "x-f5xc-description-short": "Hostname value set for Instance or Name for a Config Sync Group in NGINX One.",
9281
9456
  "minLength": 0,
9282
9457
  "maxLength": 1024,
9283
9458
  "x-f5xc-required-for": {
@@ -9309,6 +9484,7 @@
9309
9484
  "ves.io.schema.rules.uint32.gte": "1",
9310
9485
  "ves.io.schema.rules.uint32.lte": "65535"
9311
9486
  },
9487
+ "x-f5xc-description-short": "Port number on which the Server is exposed Required: YES.",
9312
9488
  "minimum": 1,
9313
9489
  "maximum": 65535,
9314
9490
  "x-f5xc-required-for": {
@@ -9438,6 +9614,7 @@
9438
9614
  "$ref": "#/components/schemas/schemadiscovered_serviceWhereVirtualSite"
9439
9615
  }
9440
9616
  },
9617
+ "x-f5xc-description-short": "Choice for selecting HTTP proxy with bring your own certificate.",
9441
9618
  "x-f5xc-minimum-configuration": {
9442
9619
  "description": "Minimum configuration for discovered_serviceProxyTypeHttps",
9443
9620
  "required_fields": [
@@ -9479,6 +9656,7 @@
9479
9656
  "$ref": "#/components/schemas/schemaStatusMetaType"
9480
9657
  }
9481
9658
  },
9659
+ "x-f5xc-description-short": "Most recently observed status of object.",
9482
9660
  "x-f5xc-minimum-configuration": {
9483
9661
  "description": "Minimum configuration for discovered_serviceStatusObject",
9484
9662
  "required_fields": [
@@ -9513,6 +9691,7 @@
9513
9691
  "x-validation-rules": {
9514
9692
  "ves.io.schema.rules.string.max_len": "1024"
9515
9693
  },
9694
+ "x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.",
9516
9695
  "minLength": 0,
9517
9696
  "x-f5xc-required-for": {
9518
9697
  "minimum_config": false,
@@ -9535,6 +9714,8 @@
9535
9714
  "x-validation-rules": {
9536
9715
  "ves.io.schema.rules.string.max_len": "256"
9537
9716
  },
9717
+ "x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
9718
+ "x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
9538
9719
  "minLength": 0,
9539
9720
  "x-f5xc-required-for": {
9540
9721
  "minimum_config": false,
@@ -9550,6 +9731,7 @@
9550
9731
  "x-displayname": "Namespace",
9551
9732
  "x-ves-example": "Foobar",
9552
9733
  "x-f5xc-example": "foobar",
9734
+ "x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
9553
9735
  "minLength": 0,
9554
9736
  "maxLength": 6,
9555
9737
  "x-f5xc-required-for": {
@@ -9560,7 +9742,7 @@
9560
9742
  },
9561
9743
  "x-original-maxLength": 1024,
9562
9744
  "x-reconciled-from-discovery": true,
9563
- "x-reconciled-at": "2026-01-05T18:29:16.070950+00:00"
9745
+ "x-reconciled-at": "2026-01-07T15:28:33.610966+00:00"
9564
9746
  },
9565
9747
  "request_body": {
9566
9748
  "$ref": "#/components/schemas/protobufAny"
@@ -9625,7 +9807,7 @@
9625
9807
  "x-original-maxLength": 1024,
9626
9808
  "format": "hostname",
9627
9809
  "x-reconciled-from-discovery": true,
9628
- "x-reconciled-at": "2026-01-05T18:29:16.070959+00:00"
9810
+ "x-reconciled-at": "2026-01-07T15:28:33.610975+00:00"
9629
9811
  },
9630
9812
  "listen_port": {
9631
9813
  "type": "integer",
@@ -9641,6 +9823,7 @@
9641
9823
  "x-validation-rules": {
9642
9824
  "ves.io.schema.rules.uint32.lte": "65535"
9643
9825
  },
9826
+ "x-f5xc-description-short": "Exclusive with [port_ranges] Listen Port for this load balancer.",
9644
9827
  "minimum": 0,
9645
9828
  "maximum": 2147483647,
9646
9829
  "x-f5xc-required-for": {
@@ -9664,6 +9847,8 @@
9664
9847
  "x-validation-rules": {
9665
9848
  "ves.io.schema.rules.message.required": "true"
9666
9849
  },
9850
+ "x-f5xc-description-short": "The configuration object will be created with name. It has to be unique within the namespace.",
9851
+ "x-f5xc-description-medium": "The configuration object will be created with name. It has to be unique within the namespace. The value of name has to follow DNS-1035 format. Required: YES.",
9667
9852
  "minLength": 0,
9668
9853
  "maxLength": 16,
9669
9854
  "x-f5xc-required-for": {
@@ -9674,7 +9859,7 @@
9674
9859
  },
9675
9860
  "x-original-maxLength": 1024,
9676
9861
  "x-reconciled-from-discovery": true,
9677
- "x-reconciled-at": "2026-01-05T18:29:16.070965+00:00"
9862
+ "x-reconciled-at": "2026-01-07T15:28:33.610982+00:00"
9678
9863
  },
9679
9864
  "no_sni": {
9680
9865
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -9700,6 +9885,8 @@
9700
9885
  "ves.io.schema.rules.string.min_len": "1",
9701
9886
  "ves.io.schema.rules.string.unique_port_range_list": "true"
9702
9887
  },
9888
+ "x-f5xc-description-short": "Exclusive with [listen_port] A string containing a comma separated list of port ranges.",
9889
+ "x-f5xc-description-medium": "Exclusive with [listen_port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".",
9703
9890
  "x-f5xc-required-for": {
9704
9891
  "minimum_config": false,
9705
9892
  "create": false,
@@ -9741,6 +9928,8 @@
9741
9928
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
9742
9929
  }
9743
9930
  },
9931
+ "x-f5xc-description-short": "Configure third party log source applications to send logs to your XC environment.",
9932
+ "x-f5xc-description-medium": "Configure third party log source applications to send logs to your XC environment. Define application names and allowed IP ranges using CIDR notation. See Tech Docs for detailed setup instructions.",
9744
9933
  "x-f5xc-minimum-configuration": {
9745
9934
  "description": "Minimum configuration for discovered_serviceThirdPartyApplicationDiscovery",
9746
9935
  "required_fields": [
@@ -9765,6 +9954,7 @@
9765
9954
  ],
9766
9955
  "default": "UNDEFINED",
9767
9956
  "x-f5xc-example": "TCP",
9957
+ "x-f5xc-description-short": "X-displayName: \"Transmission Protocol\" Protocol on which the virtual-server will transmit data.",
9768
9958
  "x-f5xc-minimum-configuration": {
9769
9959
  "description": "Minimum configuration for discovered_serviceTransmissionProtocol",
9770
9960
  "required_fields": [],
@@ -9797,6 +9987,7 @@
9797
9987
  "ves.io.schema.rules.message.required": "true",
9798
9988
  "ves.io.schema.rules.string.max_len": "256"
9799
9989
  },
9990
+ "x-f5xc-description-short": "Version of the BIG-IP from where the service was discovered Required: YES.",
9800
9991
  "minLength": 0,
9801
9992
  "x-f5xc-required-for": {
9802
9993
  "minimum_config": false,
@@ -9820,6 +10011,7 @@
9820
10011
  "ves.io.schema.rules.message.required": "true",
9821
10012
  "ves.io.schema.rules.string.max_len": "256"
9822
10013
  },
10014
+ "x-f5xc-example": "{\"key\": \"value\"}",
9823
10015
  "minLength": 0,
9824
10016
  "x-f5xc-required-for": {
9825
10017
  "minimum_config": false,
@@ -9849,6 +10041,7 @@
9849
10041
  "ves.io.schema.rules.string.ip": "true"
9850
10042
  },
9851
10043
  "x-f5xc-example": "192.0.2.1",
10044
+ "x-f5xc-description-short": "IP address of the BIG-IP Virtual Server Required: YES.",
9852
10045
  "minLength": 0,
9853
10046
  "maxLength": 1024,
9854
10047
  "x-f5xc-required-for": {
@@ -9873,6 +10066,7 @@
9873
10066
  "ves.io.schema.rules.message.required": "true",
9874
10067
  "ves.io.schema.rules.string.max_len": "256"
9875
10068
  },
10069
+ "x-f5xc-description-short": "Partition of virtual-server Required: YES.",
9876
10070
  "minLength": 0,
9877
10071
  "x-f5xc-required-for": {
9878
10072
  "minimum_config": false,
@@ -9897,6 +10091,7 @@
9897
10091
  "ves.io.schema.rules.uint32.gte": "1",
9898
10092
  "ves.io.schema.rules.uint32.lte": "65535"
9899
10093
  },
10094
+ "x-f5xc-description-short": "Port number on which the virtual-server is exposed.",
9900
10095
  "minimum": 1,
9901
10096
  "maximum": 65535,
9902
10097
  "x-f5xc-required-for": {
@@ -9918,6 +10113,7 @@
9918
10113
  "x-validation-rules": {
9919
10114
  "ves.io.schema.rules.string.max_len": "1024"
9920
10115
  },
10116
+ "x-f5xc-example": "example-resource",
9921
10117
  "minLength": 0,
9922
10118
  "x-f5xc-required-for": {
9923
10119
  "minimum_config": false,
@@ -9941,6 +10137,7 @@
9941
10137
  "x-validation-rules": {
9942
10138
  "ves.io.schema.rules.string.max_len": "1024"
9943
10139
  },
10140
+ "x-f5xc-description-short": "BIG-IP Virtual Server sub path in relation to partition.",
9944
10141
  "minLength": 0,
9945
10142
  "x-f5xc-required-for": {
9946
10143
  "minimum_config": false,
@@ -9983,6 +10180,8 @@
9983
10180
  "default": "NONE",
9984
10181
  "x-displayname": "Virtual Server Enabled State.",
9985
10182
  "x-ves-proto-enum": "ves.io.schema.discovered_service.VirtualServerEnabledState",
10183
+ "x-f5xc-description-short": "Enabled state of the virtual server. - NONE: NONE Invalid state. - ENABLED: ENABLED Virtual Server is enabled. - DISABLED: DISABLED Virtual Server...",
10184
+ "x-f5xc-description-medium": "Enabled state of the virtual server. - NONE: NONE Invalid state. - ENABLED: ENABLED Virtual Server is enabled. - DISABLED: DISABLED Virtual Server is administratively disabled.",
9986
10185
  "x-f5xc-minimum-configuration": {
9987
10186
  "description": "Minimum configuration for discovered_serviceVirtualServerEnabledState",
9988
10187
  "required_fields": [],
@@ -10007,6 +10206,7 @@
10007
10206
  "x-displayname": "Pool Member Name.",
10008
10207
  "x-ves-example": "Vs_pm_1",
10009
10208
  "x-f5xc-example": "vs_pm_1",
10209
+ "x-f5xc-description-short": "Name of the Virtual Server's Pool Member.",
10010
10210
  "minLength": 0,
10011
10211
  "maxLength": 16,
10012
10212
  "x-f5xc-required-for": {
@@ -10017,7 +10217,7 @@
10017
10217
  },
10018
10218
  "x-original-maxLength": 1024,
10019
10219
  "x-reconciled-from-discovery": true,
10020
- "x-reconciled-at": "2026-01-05T18:29:16.070991+00:00"
10220
+ "x-reconciled-at": "2026-01-07T15:28:33.611006+00:00"
10021
10221
  },
10022
10222
  "status": {
10023
10223
  "type": "array",
@@ -10027,6 +10227,7 @@
10027
10227
  "$ref": "#/components/schemas/schemaMetricValue"
10028
10228
  },
10029
10229
  "x-displayname": "Status",
10230
+ "x-f5xc-example": "active",
10030
10231
  "x-f5xc-required-for": {
10031
10232
  "minimum_config": false,
10032
10233
  "create": false,
@@ -10036,7 +10237,7 @@
10036
10237
  "maxLength": 17,
10037
10238
  "minLength": 17,
10038
10239
  "x-reconciled-from-discovery": true,
10039
- "x-reconciled-at": "2026-01-05T18:29:16.070996+00:00"
10240
+ "x-reconciled-at": "2026-01-07T15:28:33.611011+00:00"
10040
10241
  }
10041
10242
  },
10042
10243
  "x-f5xc-minimum-configuration": {
@@ -10067,6 +10268,7 @@
10067
10268
  "$ref": "#/components/schemas/discovered_serviceVirtualServerPoolHealthStatusListResponseItem"
10068
10269
  },
10069
10270
  "x-displayname": "Pool Member health.",
10271
+ "x-f5xc-description-short": "Collection of Pool member health status.",
10070
10272
  "x-f5xc-required-for": {
10071
10273
  "minimum_config": false,
10072
10274
  "create": false,
@@ -10075,6 +10277,7 @@
10075
10277
  }
10076
10278
  }
10077
10279
  },
10280
+ "x-f5xc-description-short": "Health of each pool member of the virtual server.",
10078
10281
  "x-f5xc-minimum-configuration": {
10079
10282
  "description": "Minimum configuration for discovered_serviceVirtualServerPoolMemberHealth",
10080
10283
  "required_fields": [
@@ -10102,6 +10305,8 @@
10102
10305
  "default": "UNSPECIFIED",
10103
10306
  "x-displayname": "Virtual Server Availability Status.",
10104
10307
  "x-ves-proto-enum": "ves.io.schema.discovered_service.VirtualServerStatus",
10308
+ "x-f5xc-description-short": "Availability Status of the virtual server. - UNSPECIFIED: UNSPECIFIED Invalid status. - AVAILABLE: AVAILABLE Virtual Server is available and...",
10309
+ "x-f5xc-description-medium": "Availability Status of the virtual server. - UNSPECIFIED: UNSPECIFIED Invalid status. - AVAILABLE: AVAILABLE Virtual Server is available and serving traffic. - OFFLINE: OFFLINE Virtual Server is not serving traffic. - UNKNOWN: UNKNOWN Virtual Server availability is unknown. It can indicate that...",
10105
10310
  "x-f5xc-minimum-configuration": {
10106
10311
  "description": "Minimum configuration for discovered_serviceVirtualServerStatus",
10107
10312
  "required_fields": [],
@@ -10152,6 +10357,7 @@
10152
10357
  }
10153
10358
  }
10154
10359
  },
10360
+ "x-f5xc-description-short": "Information about POD providing the service.",
10155
10361
  "x-f5xc-minimum-configuration": {
10156
10362
  "description": "Minimum configuration for discoveryPodInfoType",
10157
10363
  "required_fields": [
@@ -10191,6 +10397,7 @@
10191
10397
  "ves.io.schema.rules.uint32.gte": "1",
10192
10398
  "ves.io.schema.rules.uint32.lte": "65535"
10193
10399
  },
10400
+ "x-f5xc-description-short": "Port number on which the service is exposed Required: YES.",
10194
10401
  "minimum": 1,
10195
10402
  "maximum": 65535,
10196
10403
  "x-f5xc-required-for": {
@@ -10214,6 +10421,7 @@
10214
10421
  "x-validation-rules": {
10215
10422
  "ves.io.schema.rules.message.required": "true"
10216
10423
  },
10424
+ "x-f5xc-description-short": "Protocol on which the service is exposed Required: YES.",
10217
10425
  "minLength": 0,
10218
10426
  "maxLength": 1024,
10219
10427
  "x-f5xc-required-for": {
@@ -10242,6 +10450,8 @@
10242
10450
  "ves.io.schema.rules.uint32.gte": "1",
10243
10451
  "ves.io.schema.rules.uint32.lte": "65535"
10244
10452
  },
10453
+ "x-f5xc-description-short": "Port on which the pods targeted by the service can be reached. TargetPort of Kubernetes service when its type is ClusterIP.",
10454
+ "x-f5xc-description-medium": "Port on which the pods targeted by the service can be reached. TargetPort of Kubernetes service when its type is ClusterIP. NodePort of Kubernetes service when its type is NodePort.",
10245
10455
  "minimum": 0,
10246
10456
  "maximum": 2147483647,
10247
10457
  "x-f5xc-required-for": {
@@ -10252,6 +10462,7 @@
10252
10462
  }
10253
10463
  }
10254
10464
  },
10465
+ "x-f5xc-description-short": "Information about port and protocol on which the service is provided.",
10255
10466
  "x-f5xc-minimum-configuration": {
10256
10467
  "description": "Minimum configuration for discoveryPortInfoType",
10257
10468
  "required_fields": [
@@ -10272,6 +10483,7 @@
10272
10483
  "title": "Empty",
10273
10484
  "x-displayname": "Empty",
10274
10485
  "x-ves-proto-message": "ves.io.schema.Empty",
10486
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
10275
10487
  "x-f5xc-minimum-configuration": {
10276
10488
  "description": "Minimum configuration for ioschemaEmpty",
10277
10489
  "required_fields": [],
@@ -10296,6 +10508,8 @@
10296
10508
  "x-displayname": "Kind",
10297
10509
  "x-ves-example": "Virtual_site.",
10298
10510
  "x-f5xc-example": "virtual_site",
10511
+ "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\")",
10512
+ "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\").",
10299
10513
  "minLength": 0,
10300
10514
  "maxLength": 14,
10301
10515
  "x-f5xc-required-for": {
@@ -10307,7 +10521,7 @@
10307
10521
  "readOnly": true,
10308
10522
  "x-original-maxLength": 1024,
10309
10523
  "x-reconciled-from-discovery": true,
10310
- "x-reconciled-at": "2026-01-05T18:29:16.071013+00:00"
10524
+ "x-reconciled-at": "2026-01-07T15:28:33.611028+00:00"
10311
10525
  },
10312
10526
  "name": {
10313
10527
  "type": "string",
@@ -10316,6 +10530,8 @@
10316
10530
  "x-displayname": "Name",
10317
10531
  "x-ves-example": "Contactus-route.",
10318
10532
  "x-f5xc-example": "contactus-route",
10533
+ "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.",
10534
+ "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.",
10319
10535
  "minLength": 0,
10320
10536
  "maxLength": 16,
10321
10537
  "x-f5xc-required-for": {
@@ -10326,7 +10542,7 @@
10326
10542
  },
10327
10543
  "x-original-maxLength": 1024,
10328
10544
  "x-reconciled-from-discovery": true,
10329
- "x-reconciled-at": "2026-01-05T18:29:16.071017+00:00"
10545
+ "x-reconciled-at": "2026-01-07T15:28:33.611032+00:00"
10330
10546
  },
10331
10547
  "namespace": {
10332
10548
  "type": "string",
@@ -10335,6 +10551,8 @@
10335
10551
  "x-displayname": "Namespace",
10336
10552
  "x-ves-example": "Ns1",
10337
10553
  "x-f5xc-example": "ns1",
10554
+ "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.",
10555
+ "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.",
10338
10556
  "minLength": 0,
10339
10557
  "maxLength": 6,
10340
10558
  "x-f5xc-required-for": {
@@ -10345,7 +10563,7 @@
10345
10563
  },
10346
10564
  "x-original-maxLength": 1024,
10347
10565
  "x-reconciled-from-discovery": true,
10348
- "x-reconciled-at": "2026-01-05T18:29:16.071021+00:00"
10566
+ "x-reconciled-at": "2026-01-07T15:28:33.611037+00:00"
10349
10567
  },
10350
10568
  "tenant": {
10351
10569
  "type": "string",
@@ -10354,6 +10572,8 @@
10354
10572
  "x-displayname": "Tenant",
10355
10573
  "x-ves-example": "Example-corp.",
10356
10574
  "x-f5xc-example": "example-corp",
10575
+ "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.",
10576
+ "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.",
10357
10577
  "minLength": 0,
10358
10578
  "maxLength": 18,
10359
10579
  "x-f5xc-required-for": {
@@ -10366,7 +10586,7 @@
10366
10586
  "x-field-mutability": "read-only",
10367
10587
  "x-original-maxLength": 1024,
10368
10588
  "x-reconciled-from-discovery": true,
10369
- "x-reconciled-at": "2026-01-05T18:29:16.071025+00:00"
10589
+ "x-reconciled-at": "2026-01-07T15:28:33.611041+00:00"
10370
10590
  },
10371
10591
  "uid": {
10372
10592
  "type": "string",
@@ -10375,6 +10595,8 @@
10375
10595
  "x-displayname": "UID",
10376
10596
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
10377
10597
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
10598
+ "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.",
10599
+ "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.",
10378
10600
  "minLength": 0,
10379
10601
  "maxLength": 36,
10380
10602
  "x-f5xc-required-for": {
@@ -10388,9 +10610,11 @@
10388
10610
  "x-original-maxLength": 1024,
10389
10611
  "format": "uuid",
10390
10612
  "x-reconciled-from-discovery": true,
10391
- "x-reconciled-at": "2026-01-05T18:29:16.071031+00:00"
10613
+ "x-reconciled-at": "2026-01-07T15:28:33.611046+00:00"
10392
10614
  }
10393
10615
  },
10616
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
10617
+ "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...",
10394
10618
  "x-f5xc-minimum-configuration": {
10395
10619
  "description": "Minimum configuration for ioschemaObjectRefType",
10396
10620
  "required_fields": [
@@ -10414,6 +10638,8 @@
10414
10638
  "type_url": {
10415
10639
  "type": "string",
10416
10640
  "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.",
10641
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
10642
+ "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 ).",
10417
10643
  "minLength": 0,
10418
10644
  "maxLength": 1024,
10419
10645
  "x-f5xc-required-for": {
@@ -10437,9 +10663,11 @@
10437
10663
  },
10438
10664
  "x-original-maxLength": 1024,
10439
10665
  "x-reconciled-from-discovery": true,
10440
- "x-reconciled-at": "2026-01-05T18:29:16.071049+00:00"
10666
+ "x-reconciled-at": "2026-01-07T15:28:33.611052+00:00"
10441
10667
  }
10442
10668
  },
10669
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
10670
+ "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...",
10443
10671
  "x-f5xc-minimum-configuration": {
10444
10672
  "description": "Minimum configuration for protobufAny",
10445
10673
  "required_fields": [
@@ -10465,6 +10693,8 @@
10465
10693
  "description": "Hostname of the instance of the site that sent the status.",
10466
10694
  "title": "Hostname",
10467
10695
  "x-displayname": "Hostname",
10696
+ "x-f5xc-example": "example-resource",
10697
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
10468
10698
  "minLength": 0,
10469
10699
  "maxLength": 1024,
10470
10700
  "x-f5xc-required-for": {
@@ -10496,6 +10726,8 @@
10496
10726
  "x-displayname": "Reason",
10497
10727
  "x-ves-example": "Value",
10498
10728
  "x-f5xc-example": "value",
10729
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
10730
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
10499
10731
  "minLength": 0,
10500
10732
  "maxLength": 43,
10501
10733
  "x-f5xc-required-for": {
@@ -10506,13 +10738,15 @@
10506
10738
  },
10507
10739
  "x-original-maxLength": 1024,
10508
10740
  "x-reconciled-from-discovery": true,
10509
- "x-reconciled-at": "2026-01-05T18:29:16.071058+00:00"
10741
+ "x-reconciled-at": "2026-01-07T15:28:33.611059+00:00"
10510
10742
  },
10511
10743
  "service_name": {
10512
10744
  "type": "string",
10513
10745
  "description": "Name of the service that sent the status.",
10514
10746
  "title": "Service name.",
10515
10747
  "x-displayname": "Service Name.",
10748
+ "x-f5xc-example": "example-resource",
10749
+ "x-f5xc-description-short": "Name of the service that sent the status.",
10516
10750
  "minLength": 0,
10517
10751
  "maxLength": 1024,
10518
10752
  "x-f5xc-required-for": {
@@ -10535,6 +10769,8 @@
10535
10769
  "x-validation-rules": {
10536
10770
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
10537
10771
  },
10772
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
10773
+ "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...",
10538
10774
  "minLength": 0,
10539
10775
  "maxLength": 17,
10540
10776
  "x-f5xc-required-for": {
@@ -10545,7 +10781,7 @@
10545
10781
  },
10546
10782
  "x-original-maxLength": 1024,
10547
10783
  "x-reconciled-from-discovery": true,
10548
- "x-reconciled-at": "2026-01-05T18:29:16.071064+00:00"
10784
+ "x-reconciled-at": "2026-01-07T15:28:33.611065+00:00"
10549
10785
  },
10550
10786
  "type": {
10551
10787
  "type": "string",
@@ -10560,6 +10796,8 @@
10560
10796
  "x-validation-rules": {
10561
10797
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
10562
10798
  },
10799
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
10800
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
10563
10801
  "minLength": 0,
10564
10802
  "maxLength": 1024,
10565
10803
  "x-f5xc-required-for": {
@@ -10570,6 +10808,8 @@
10570
10808
  }
10571
10809
  }
10572
10810
  },
10811
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
10812
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
10573
10813
  "x-f5xc-minimum-configuration": {
10574
10814
  "description": "Minimum configuration for schemaConditionType",
10575
10815
  "required_fields": [
@@ -10605,6 +10845,8 @@
10605
10845
  "default": "EOK",
10606
10846
  "x-displayname": "Error Code.",
10607
10847
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
10848
+ "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...",
10849
+ "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...",
10608
10850
  "x-f5xc-minimum-configuration": {
10609
10851
  "description": "Minimum configuration for schemaErrorCode",
10610
10852
  "required_fields": [],
@@ -10645,6 +10887,7 @@
10645
10887
  }
10646
10888
  }
10647
10889
  },
10890
+ "x-f5xc-description-short": "Information about a error in API operation.",
10648
10891
  "x-f5xc-minimum-configuration": {
10649
10892
  "description": "Minimum configuration for schemaErrorType",
10650
10893
  "required_fields": [
@@ -10672,6 +10915,7 @@
10672
10915
  "title": "Name",
10673
10916
  "x-displayname": "Name",
10674
10917
  "x-f5xc-example": "example-resource",
10918
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
10675
10919
  "minLength": 0,
10676
10920
  "maxLength": 16,
10677
10921
  "x-f5xc-required-for": {
@@ -10682,9 +10926,10 @@
10682
10926
  },
10683
10927
  "x-original-maxLength": 1024,
10684
10928
  "x-reconciled-from-discovery": true,
10685
- "x-reconciled-at": "2026-01-05T18:29:16.071076+00:00"
10929
+ "x-reconciled-at": "2026-01-07T15:28:33.611075+00:00"
10686
10930
  }
10687
10931
  },
10932
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
10688
10933
  "x-f5xc-minimum-configuration": {
10689
10934
  "description": "Minimum configuration for schemaInitializerType",
10690
10935
  "required_fields": [
@@ -10712,6 +10957,8 @@
10712
10957
  "$ref": "#/components/schemas/schemaInitializerType"
10713
10958
  },
10714
10959
  "x-displayname": "Pending",
10960
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
10961
+ "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.",
10715
10962
  "x-f5xc-required-for": {
10716
10963
  "minimum_config": false,
10717
10964
  "create": false,
@@ -10723,6 +10970,7 @@
10723
10970
  "$ref": "#/components/schemas/schemaStatusType"
10724
10971
  }
10725
10972
  },
10973
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
10726
10974
  "x-f5xc-minimum-configuration": {
10727
10975
  "description": "Minimum configuration for schemaInitializersType",
10728
10976
  "required_fields": [
@@ -10763,7 +11011,7 @@
10763
11011
  },
10764
11012
  "value": {
10765
11013
  "type": "string",
10766
- "description": "",
11014
+ "description": "Configuration parameter for value",
10767
11015
  "title": "Value",
10768
11016
  "x-displayname": "Value",
10769
11017
  "x-ves-example": "15",
@@ -10778,9 +11026,10 @@
10778
11026
  },
10779
11027
  "x-original-maxLength": 1024,
10780
11028
  "x-reconciled-from-discovery": true,
10781
- "x-reconciled-at": "2026-01-05T18:29:16.071086+00:00"
11029
+ "x-reconciled-at": "2026-01-07T15:28:33.611086+00:00"
10782
11030
  }
10783
11031
  },
11032
+ "x-f5xc-description-short": "Metric data contains timestamp and the value.",
10784
11033
  "x-f5xc-minimum-configuration": {
10785
11034
  "description": "Minimum configuration for schemaMetricValue",
10786
11035
  "required_fields": [
@@ -10821,6 +11070,8 @@
10821
11070
  "ves.io.schema.rules.map.values.string.max_len": "1024",
10822
11071
  "ves.io.schema.rules.map.values.string.min_len": "1"
10823
11072
  },
11073
+ "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.",
11074
+ "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.",
10824
11075
  "x-f5xc-required-for": {
10825
11076
  "minimum_config": false,
10826
11077
  "create": false,
@@ -10842,6 +11093,7 @@
10842
11093
  "x-validation-rules": {
10843
11094
  "ves.io.schema.rules.string.max_bytes": "1200"
10844
11095
  },
11096
+ "x-f5xc-description-short": "Human readable description for the object.",
10845
11097
  "minLength": 0,
10846
11098
  "x-f5xc-required-for": {
10847
11099
  "minimum_config": false,
@@ -10851,7 +11103,7 @@
10851
11103
  },
10852
11104
  "x-original-maxLength": 1200,
10853
11105
  "x-reconciled-from-discovery": true,
10854
- "x-reconciled-at": "2026-01-05T18:29:16.071093+00:00"
11106
+ "x-reconciled-at": "2026-01-07T15:28:33.611093+00:00"
10855
11107
  },
10856
11108
  "disable": {
10857
11109
  "type": "boolean",
@@ -10861,6 +11113,7 @@
10861
11113
  "x-displayname": "Disable",
10862
11114
  "x-ves-example": "True",
10863
11115
  "x-f5xc-example": "true",
11116
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
10864
11117
  "x-f5xc-required-for": {
10865
11118
  "minimum_config": false,
10866
11119
  "create": false,
@@ -10875,6 +11128,8 @@
10875
11128
  "x-displayname": "Labels",
10876
11129
  "x-ves-example": "Value",
10877
11130
  "x-f5xc-example": "value",
11131
+ "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.",
11132
+ "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.",
10878
11133
  "x-f5xc-required-for": {
10879
11134
  "minimum_config": false,
10880
11135
  "create": false,
@@ -10896,6 +11151,8 @@
10896
11151
  "x-validation-rules": {
10897
11152
  "ves.io.schema.rules.message.required": "true"
10898
11153
  },
11154
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
11155
+ "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.",
10899
11156
  "minLength": 0,
10900
11157
  "maxLength": 16,
10901
11158
  "x-f5xc-required-for": {
@@ -10906,7 +11163,7 @@
10906
11163
  },
10907
11164
  "x-original-maxLength": 1024,
10908
11165
  "x-reconciled-from-discovery": true,
10909
- "x-reconciled-at": "2026-01-05T18:29:16.071101+00:00"
11166
+ "x-reconciled-at": "2026-01-07T15:28:33.611100+00:00"
10910
11167
  },
10911
11168
  "namespace": {
10912
11169
  "type": "string",
@@ -10915,6 +11172,8 @@
10915
11172
  "x-displayname": "Namespace",
10916
11173
  "x-ves-example": "Staging",
10917
11174
  "x-f5xc-example": "staging",
11175
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
11176
+ "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 \"\".",
10918
11177
  "minLength": 0,
10919
11178
  "maxLength": 6,
10920
11179
  "x-f5xc-required-for": {
@@ -10925,9 +11184,10 @@
10925
11184
  },
10926
11185
  "x-original-maxLength": 1024,
10927
11186
  "x-reconciled-from-discovery": true,
10928
- "x-reconciled-at": "2026-01-05T18:29:16.071105+00:00"
11187
+ "x-reconciled-at": "2026-01-07T15:28:33.611104+00:00"
10929
11188
  }
10930
11189
  },
11190
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
10931
11191
  "x-f5xc-minimum-configuration": {
10932
11192
  "description": "Minimum configuration for schemaObjectGetMetaType",
10933
11193
  "required_fields": [
@@ -10958,6 +11218,8 @@
10958
11218
  "title": "Creation_timestamp.",
10959
11219
  "format": "date-time",
10960
11220
  "x-displayname": "Creation Timestamp.",
11221
+ "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.",
11222
+ "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.",
10961
11223
  "minLength": 0,
10962
11224
  "maxLength": 1024,
10963
11225
  "x-f5xc-required-for": {
@@ -10975,6 +11237,8 @@
10975
11237
  "x-displayname": "Creator Class.",
10976
11238
  "x-ves-example": "ver.re1.int.ves.I/O.",
10977
11239
  "x-f5xc-example": "ver.re1.int.F5 XC",
11240
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
11241
+ "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.",
10978
11242
  "minLength": 0,
10979
11243
  "maxLength": 1024,
10980
11244
  "x-f5xc-required-for": {
@@ -10992,6 +11256,8 @@
10992
11256
  "x-displayname": "Creator ID.",
10993
11257
  "x-ves-example": "Ver-instance-1.",
10994
11258
  "x-f5xc-example": "ver-instance-1",
11259
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
11260
+ "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.",
10995
11261
  "minLength": 0,
10996
11262
  "maxLength": 1024,
10997
11263
  "x-f5xc-required-for": {
@@ -11010,6 +11276,8 @@
11010
11276
  "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)",
11011
11277
  "title": "Status_id",
11012
11278
  "x-displayname": "Status ID",
11279
+ "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...",
11280
+ "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).",
11013
11281
  "minLength": 0,
11014
11282
  "maxLength": 1024,
11015
11283
  "x-f5xc-required-for": {
@@ -11027,6 +11295,7 @@
11027
11295
  "x-displayname": "UID",
11028
11296
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
11029
11297
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
11298
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
11030
11299
  "minLength": 0,
11031
11300
  "maxLength": 36,
11032
11301
  "x-f5xc-required-for": {
@@ -11039,13 +11308,14 @@
11039
11308
  "x-original-maxLength": 1024,
11040
11309
  "format": "uuid",
11041
11310
  "x-reconciled-from-discovery": true,
11042
- "x-reconciled-at": "2026-01-05T18:29:16.071118+00:00"
11311
+ "x-reconciled-at": "2026-01-07T15:28:33.611116+00:00"
11043
11312
  },
11044
11313
  "vtrp_id": {
11045
11314
  "type": "string",
11046
11315
  "description": "Origin of this status exchanged by VTRP.",
11047
11316
  "title": "Vtrp_id",
11048
11317
  "x-displayname": "VTRP ID",
11318
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
11049
11319
  "minLength": 0,
11050
11320
  "maxLength": 1024,
11051
11321
  "x-f5xc-required-for": {
@@ -11062,6 +11332,7 @@
11062
11332
  "title": "Vtrp_stale.",
11063
11333
  "format": "boolean",
11064
11334
  "x-displayname": "VTRP Stale.",
11335
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
11065
11336
  "x-f5xc-required-for": {
11066
11337
  "minimum_config": false,
11067
11338
  "create": false,
@@ -11070,6 +11341,7 @@
11070
11341
  }
11071
11342
  }
11072
11343
  },
11344
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
11073
11345
  "x-f5xc-minimum-configuration": {
11074
11346
  "description": "Minimum configuration for schemaStatusMetaType",
11075
11347
  "required_fields": [
@@ -11100,6 +11372,8 @@
11100
11372
  "default": "STATUS_DO_NOT_PUBLISH",
11101
11373
  "x-displayname": "Status Publish Type.",
11102
11374
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
11375
+ "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.",
11376
+ "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.",
11103
11377
  "x-f5xc-minimum-configuration": {
11104
11378
  "description": "Minimum configuration for schemaStatusPublishType",
11105
11379
  "required_fields": [],
@@ -11125,6 +11399,7 @@
11125
11399
  "x-displayname": "Code",
11126
11400
  "x-ves-example": "0",
11127
11401
  "x-f5xc-example": "0",
11402
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
11128
11403
  "minimum": 0,
11129
11404
  "maximum": 2147483647,
11130
11405
  "x-f5xc-required-for": {
@@ -11141,6 +11416,8 @@
11141
11416
  "x-displayname": "Reason",
11142
11417
  "x-ves-example": "Value",
11143
11418
  "x-f5xc-example": "value",
11419
+ "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.",
11420
+ "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.",
11144
11421
  "minLength": 0,
11145
11422
  "maxLength": 43,
11146
11423
  "x-f5xc-required-for": {
@@ -11151,7 +11428,7 @@
11151
11428
  },
11152
11429
  "x-original-maxLength": 1024,
11153
11430
  "x-reconciled-from-discovery": true,
11154
- "x-reconciled-at": "2026-01-05T18:29:16.071128+00:00"
11431
+ "x-reconciled-at": "2026-01-07T15:28:33.611125+00:00"
11155
11432
  },
11156
11433
  "status": {
11157
11434
  "type": "string",
@@ -11160,6 +11437,7 @@
11160
11437
  "x-displayname": "Status",
11161
11438
  "x-ves-example": "Value",
11162
11439
  "x-f5xc-example": "value",
11440
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
11163
11441
  "minLength": 0,
11164
11442
  "maxLength": 17,
11165
11443
  "x-f5xc-required-for": {
@@ -11170,9 +11448,10 @@
11170
11448
  },
11171
11449
  "x-original-maxLength": 1024,
11172
11450
  "x-reconciled-from-discovery": true,
11173
- "x-reconciled-at": "2026-01-05T18:29:16.071132+00:00"
11451
+ "x-reconciled-at": "2026-01-07T15:28:33.611129+00:00"
11174
11452
  }
11175
11453
  },
11454
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
11176
11455
  "x-f5xc-minimum-configuration": {
11177
11456
  "description": "Minimum configuration for schemaStatusType",
11178
11457
  "required_fields": [
@@ -11200,6 +11479,8 @@
11200
11479
  "title": "Creation_timestamp.",
11201
11480
  "format": "date-time",
11202
11481
  "x-displayname": "Creation Timestamp.",
11482
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
11483
+ "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.",
11203
11484
  "minLength": 0,
11204
11485
  "maxLength": 1024,
11205
11486
  "x-f5xc-required-for": {
@@ -11217,6 +11498,7 @@
11217
11498
  "x-displayname": "Creator Class.",
11218
11499
  "x-ves-example": "Prism",
11219
11500
  "x-f5xc-example": "value",
11501
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
11220
11502
  "minLength": 0,
11221
11503
  "maxLength": 1024,
11222
11504
  "x-f5xc-required-for": {
@@ -11234,6 +11516,7 @@
11234
11516
  "x-displayname": "Creator ID.",
11235
11517
  "x-ves-example": "Admin@example-corp.com.",
11236
11518
  "x-f5xc-example": "value",
11519
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
11237
11520
  "minLength": 0,
11238
11521
  "maxLength": 1024,
11239
11522
  "x-f5xc-required-for": {
@@ -11250,6 +11533,8 @@
11250
11533
  "title": "Deletion_timestamp.",
11251
11534
  "format": "date-time",
11252
11535
  "x-displayname": "Deletion Timestamp.",
11536
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
11537
+ "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...",
11253
11538
  "minLength": 0,
11254
11539
  "maxLength": 1024,
11255
11540
  "x-f5xc-required-for": {
@@ -11269,6 +11554,8 @@
11269
11554
  "x-displayname": "Finalizers.",
11270
11555
  "x-ves-example": "Value",
11271
11556
  "x-f5xc-example": "value",
11557
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
11558
+ "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.",
11272
11559
  "x-f5xc-required-for": {
11273
11560
  "minimum_config": false,
11274
11561
  "create": false,
@@ -11286,6 +11573,8 @@
11286
11573
  "x-displayname": "Labels",
11287
11574
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
11288
11575
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
11576
+ "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.",
11577
+ "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).",
11289
11578
  "x-f5xc-required-for": {
11290
11579
  "minimum_config": false,
11291
11580
  "create": false,
@@ -11299,6 +11588,8 @@
11299
11588
  "title": "Modification_timestamp.",
11300
11589
  "format": "date-time",
11301
11590
  "x-displayname": "Modification Timestamp.",
11591
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
11592
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
11302
11593
  "minLength": 0,
11303
11594
  "maxLength": 1024,
11304
11595
  "x-f5xc-required-for": {
@@ -11317,6 +11608,8 @@
11317
11608
  "x-displayname": "Object Index.",
11318
11609
  "x-ves-example": "0",
11319
11610
  "x-f5xc-example": "0",
11611
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
11612
+ "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.",
11320
11613
  "minimum": 0,
11321
11614
  "maximum": 2147483647,
11322
11615
  "x-f5xc-required-for": {
@@ -11337,6 +11630,8 @@
11337
11630
  "x-displayname": "Tenant",
11338
11631
  "x-ves-example": "Example-corp.",
11339
11632
  "x-f5xc-example": "example-corp",
11633
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
11634
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
11340
11635
  "minLength": 0,
11341
11636
  "maxLength": 18,
11342
11637
  "x-f5xc-required-for": {
@@ -11348,7 +11643,7 @@
11348
11643
  "x-field-mutability": "read-only",
11349
11644
  "x-original-maxLength": 1024,
11350
11645
  "x-reconciled-from-discovery": true,
11351
- "x-reconciled-at": "2026-01-05T18:29:16.071151+00:00"
11646
+ "x-reconciled-at": "2026-01-07T15:28:33.611148+00:00"
11352
11647
  },
11353
11648
  "uid": {
11354
11649
  "type": "string",
@@ -11357,6 +11652,8 @@
11357
11652
  "x-displayname": "UID",
11358
11653
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
11359
11654
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
11655
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
11656
+ "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.",
11360
11657
  "minLength": 0,
11361
11658
  "maxLength": 36,
11362
11659
  "x-f5xc-required-for": {
@@ -11369,9 +11666,11 @@
11369
11666
  "x-original-maxLength": 1024,
11370
11667
  "format": "uuid",
11371
11668
  "x-reconciled-from-discovery": true,
11372
- "x-reconciled-at": "2026-01-05T18:29:16.071155+00:00"
11669
+ "x-reconciled-at": "2026-01-07T15:28:33.611152+00:00"
11373
11670
  }
11374
11671
  },
11672
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
11673
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
11375
11674
  "x-f5xc-minimum-configuration": {
11376
11675
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
11377
11676
  "required_fields": [
@@ -11419,7 +11718,7 @@
11419
11718
  },
11420
11719
  "x-original-maxLength": 1024,
11421
11720
  "x-reconciled-from-discovery": true,
11422
- "x-reconciled-at": "2026-01-05T18:29:16.071172+00:00"
11721
+ "x-reconciled-at": "2026-01-07T15:28:33.611169+00:00"
11423
11722
  },
11424
11723
  "name": {
11425
11724
  "type": "string",
@@ -11428,6 +11727,8 @@
11428
11727
  "x-displayname": "Name",
11429
11728
  "x-ves-example": "Contactus-route.",
11430
11729
  "x-f5xc-example": "contactus-route",
11730
+ "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.",
11731
+ "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.",
11431
11732
  "minLength": 0,
11432
11733
  "maxLength": 16,
11433
11734
  "x-f5xc-required-for": {
@@ -11438,7 +11739,7 @@
11438
11739
  },
11439
11740
  "x-original-maxLength": 1024,
11440
11741
  "x-reconciled-from-discovery": true,
11441
- "x-reconciled-at": "2026-01-05T18:29:16.071176+00:00"
11742
+ "x-reconciled-at": "2026-01-07T15:28:33.611173+00:00"
11442
11743
  },
11443
11744
  "namespace": {
11444
11745
  "type": "string",
@@ -11447,6 +11748,8 @@
11447
11748
  "x-displayname": "Namespace",
11448
11749
  "x-ves-example": "Ns1",
11449
11750
  "x-f5xc-example": "ns1",
11751
+ "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.",
11752
+ "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.",
11450
11753
  "minLength": 0,
11451
11754
  "maxLength": 6,
11452
11755
  "x-f5xc-required-for": {
@@ -11457,7 +11760,7 @@
11457
11760
  },
11458
11761
  "x-original-maxLength": 1024,
11459
11762
  "x-reconciled-from-discovery": true,
11460
- "x-reconciled-at": "2026-01-05T18:29:16.071180+00:00"
11763
+ "x-reconciled-at": "2026-01-07T15:28:33.611176+00:00"
11461
11764
  },
11462
11765
  "uid": {
11463
11766
  "type": "string",
@@ -11478,9 +11781,10 @@
11478
11781
  "x-original-maxLength": 1024,
11479
11782
  "format": "uuid",
11480
11783
  "x-reconciled-from-discovery": true,
11481
- "x-reconciled-at": "2026-01-05T18:29:16.071185+00:00"
11784
+ "x-reconciled-at": "2026-01-07T15:28:33.611181+00:00"
11482
11785
  }
11483
11786
  },
11787
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
11484
11788
  "x-f5xc-minimum-configuration": {
11485
11789
  "description": "Minimum configuration for schemaViewRefType",
11486
11790
  "required_fields": [
@@ -11515,6 +11819,7 @@
11515
11819
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
11516
11820
  },
11517
11821
  "x-displayname": "HTTP Load Balancers.",
11822
+ "x-f5xc-description-short": "List of references to HTTP Load Balancers using this service.",
11518
11823
  "x-f5xc-required-for": {
11519
11824
  "minimum_config": false,
11520
11825
  "create": false,
@@ -11535,6 +11840,7 @@
11535
11840
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
11536
11841
  },
11537
11842
  "x-displayname": "TCP Load Balancers.",
11843
+ "x-f5xc-description-short": "List of references to TCP Load Balancers using this service.",
11538
11844
  "x-f5xc-required-for": {
11539
11845
  "minimum_config": false,
11540
11846
  "create": false,
@@ -11590,6 +11896,7 @@
11590
11896
  "$ref": "#/components/schemas/schemadiscovered_serviceSuggestedItem"
11591
11897
  },
11592
11898
  "x-displayname": "Suggested Items.",
11899
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
11593
11900
  "x-f5xc-required-for": {
11594
11901
  "minimum_config": false,
11595
11902
  "create": false,
@@ -11623,6 +11930,7 @@
11623
11930
  "description": "Optional description for the suggested value.",
11624
11931
  "title": "Description.",
11625
11932
  "x-displayname": "Description.",
11933
+ "x-f5xc-description-short": "Optional description for the suggested value.",
11626
11934
  "minLength": 0,
11627
11935
  "maxLength": 0,
11628
11936
  "x-f5xc-required-for": {
@@ -11633,7 +11941,7 @@
11633
11941
  },
11634
11942
  "x-original-maxLength": 1024,
11635
11943
  "x-reconciled-from-discovery": true,
11636
- "x-reconciled-at": "2026-01-05T18:29:16.071203+00:00"
11944
+ "x-reconciled-at": "2026-01-07T15:28:33.611198+00:00"
11637
11945
  },
11638
11946
  "ref_value": {
11639
11947
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
@@ -11653,6 +11961,7 @@
11653
11961
  }
11654
11962
  }
11655
11963
  },
11964
+ "x-f5xc-description-short": "Tuple with a suggested value and it's description.",
11656
11965
  "x-f5xc-minimum-configuration": {
11657
11966
  "description": "Minimum configuration for schemadiscovered_serviceSuggestedItem",
11658
11967
  "required_fields": [
@@ -11700,6 +12009,7 @@
11700
12009
  }
11701
12010
  }
11702
12011
  },
12012
+ "x-f5xc-description-short": "Defines a reference to a CE site where a load balancer could be advertised.",
11703
12013
  "x-f5xc-minimum-configuration": {
11704
12014
  "description": "Minimum configuration for schemadiscovered_serviceWhereSite",
11705
12015
  "required_fields": [
@@ -11737,6 +12047,7 @@
11737
12047
  "ves.io.schema.rules.message.required": "true",
11738
12048
  "ves.io.schema.rules.repeated.max_items": "1"
11739
12049
  },
12050
+ "x-f5xc-description-short": "Reference to virtual site object Required: YES.",
11740
12051
  "x-f5xc-required-for": {
11741
12052
  "minimum_config": false,
11742
12053
  "create": false,
@@ -11745,6 +12056,7 @@
11745
12056
  }
11746
12057
  }
11747
12058
  },
12059
+ "x-f5xc-description-short": "Defines a reference to a customer site virtual site where a load balancer could be advertised.",
11748
12060
  "x-f5xc-minimum-configuration": {
11749
12061
  "description": "Minimum configuration for schemadiscovered_serviceWhereVirtualSite",
11750
12062
  "required_fields": [
@@ -11784,6 +12096,8 @@
11784
12096
  "ves.io.schema.rules.string.max_bytes": "128",
11785
12097
  "ves.io.schema.rules.string.min_bytes": "1"
11786
12098
  },
12099
+ "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.",
12100
+ "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.",
11787
12101
  "x-f5xc-required-for": {
11788
12102
  "minimum_config": false,
11789
12103
  "create": false,
@@ -11792,7 +12106,7 @@
11792
12106
  },
11793
12107
  "x-original-maxLength": 128,
11794
12108
  "x-reconciled-from-discovery": true,
11795
- "x-reconciled-at": "2026-01-05T18:29:16.071215+00:00"
12109
+ "x-reconciled-at": "2026-01-07T15:28:33.611210+00:00"
11796
12110
  },
11797
12111
  "namespace": {
11798
12112
  "type": "string",
@@ -11808,6 +12122,8 @@
11808
12122
  "x-validation-rules": {
11809
12123
  "ves.io.schema.rules.string.max_bytes": "64"
11810
12124
  },
12125
+ "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.",
12126
+ "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.",
11811
12127
  "minLength": 0,
11812
12128
  "x-f5xc-required-for": {
11813
12129
  "minimum_config": false,
@@ -11817,7 +12133,7 @@
11817
12133
  },
11818
12134
  "x-original-maxLength": 64,
11819
12135
  "x-reconciled-from-discovery": true,
11820
- "x-reconciled-at": "2026-01-05T18:29:16.071219+00:00"
12136
+ "x-reconciled-at": "2026-01-07T15:28:33.611215+00:00"
11821
12137
  },
11822
12138
  "tenant": {
11823
12139
  "type": "string",
@@ -11833,6 +12149,8 @@
11833
12149
  "x-validation-rules": {
11834
12150
  "ves.io.schema.rules.string.max_bytes": "64"
11835
12151
  },
12152
+ "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.",
12153
+ "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.",
11836
12154
  "minLength": 0,
11837
12155
  "x-f5xc-required-for": {
11838
12156
  "minimum_config": false,
@@ -11844,9 +12162,11 @@
11844
12162
  "x-field-mutability": "read-only",
11845
12163
  "x-original-maxLength": 64,
11846
12164
  "x-reconciled-from-discovery": true,
11847
- "x-reconciled-at": "2026-01-05T18:29:16.071223+00:00"
12165
+ "x-reconciled-at": "2026-01-07T15:28:33.611219+00:00"
11848
12166
  }
11849
12167
  },
12168
+ "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
12169
+ "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.",
11850
12170
  "x-f5xc-minimum-configuration": {
11851
12171
  "description": "Minimum configuration for schemaviewsObjectRefType",
11852
12172
  "required_fields": [
@@ -11882,6 +12202,7 @@
11882
12202
  "x-validation-rules": {
11883
12203
  "ves.io.schema.rules.string.ipv4": "true"
11884
12204
  },
12205
+ "x-f5xc-description-short": "Use given IP address as VIP on the site.",
11885
12206
  "minLength": 0,
11886
12207
  "maxLength": 1024,
11887
12208
  "x-f5xc-required-for": {
@@ -11898,6 +12219,8 @@
11898
12219
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
11899
12220
  }
11900
12221
  },
12222
+ "x-f5xc-description-short": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.",
12223
+ "x-f5xc-description-medium": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.",
11901
12224
  "x-f5xc-minimum-configuration": {
11902
12225
  "description": "Minimum configuration for schemaviewsWhereSite",
11903
12226
  "required_fields": [
@@ -11927,6 +12250,8 @@
11927
12250
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
11928
12251
  }
11929
12252
  },
12253
+ "x-f5xc-description-short": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.",
12254
+ "x-f5xc-description-medium": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.",
11930
12255
  "x-f5xc-minimum-configuration": {
11931
12256
  "description": "Minimum configuration for schemaviewsWhereVirtualSite",
11932
12257
  "required_fields": [
@@ -11970,6 +12295,7 @@
11970
12295
  "ves.io.schema.rules.repeated.min_items": "1",
11971
12296
  "ves.io.schema.rules.repeated.unique": "true"
11972
12297
  },
12298
+ "x-f5xc-description-short": "Where should this load balancer be available Required: YES.",
11973
12299
  "x-f5xc-required-for": {
11974
12300
  "minimum_config": false,
11975
12301
  "create": false,
@@ -11978,6 +12304,7 @@
11978
12304
  }
11979
12305
  }
11980
12306
  },
12307
+ "x-f5xc-description-short": "Defines a way to advertise a VIP on specific sites.",
11981
12308
  "x-f5xc-minimum-configuration": {
11982
12309
  "description": "Minimum configuration for viewsAdvertiseCustom",
11983
12310
  "required_fields": [
@@ -12001,6 +12328,8 @@
12001
12328
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
12002
12329
  }
12003
12330
  },
12331
+ "x-f5xc-description-short": "Defines a way to advertise a load balancer on public.",
12332
+ "x-f5xc-description-medium": "Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.",
12004
12333
  "x-f5xc-minimum-configuration": {
12005
12334
  "description": "Minimum configuration for viewsAdvertisePublic",
12006
12335
  "required_fields": [
@@ -12029,6 +12358,8 @@
12029
12358
  "default": "SITE_NETWORK_INSIDE_AND_OUTSIDE",
12030
12359
  "x-displayname": "Site Network.",
12031
12360
  "x-ves-proto-enum": "ves.io.schema.views.SiteNetwork",
12361
+ "x-f5xc-description-short": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support.",
12362
+ "x-f5xc-description-medium": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks.",
12032
12363
  "x-f5xc-minimum-configuration": {
12033
12364
  "description": "Minimum configuration for viewsSiteNetwork",
12034
12365
  "required_fields": [],
@@ -12050,6 +12381,8 @@
12050
12381
  "default": "SITE_NETWORK_SPECIFIED_VIP_OUTSIDE",
12051
12382
  "x-displayname": "Site Network.",
12052
12383
  "x-ves-proto-enum": "ves.io.schema.views.SiteNetworkSpecifiedVIP",
12384
+ "x-f5xc-description-short": "Defines network types to be used on virtual-site with specified VIP All outside networks.",
12385
+ "x-f5xc-description-medium": "Defines network types to be used on virtual-site with specified VIP All outside networks. All inside networks.",
12053
12386
  "x-f5xc-minimum-configuration": {
12054
12387
  "description": "Minimum configuration for viewsSiteNetworkSpecifiedVIP",
12055
12388
  "required_fields": [],
@@ -12073,6 +12406,7 @@
12073
12406
  "description": "X-displayName: \"IP Address\"\nx-required\nUse given IP address as VIP on the Cloud Edge.",
12074
12407
  "title": "IP address on the Cloud Edge.",
12075
12408
  "x-f5xc-example": "8.8.8.8",
12409
+ "x-f5xc-description-short": "X-displayName: \"IP Address\" x-required Use given IP address as VIP on the Cloud Edge.",
12076
12410
  "minLength": 0,
12077
12411
  "maxLength": 1024,
12078
12412
  "x-f5xc-required-for": {
@@ -12087,6 +12421,7 @@
12087
12421
  "description": "X-displayName: \"IPv6 Address\"\nUse given IPv6 address as VIP on the Cloud Edge.",
12088
12422
  "title": "IPv6 address on the Cloud Edge.",
12089
12423
  "x-f5xc-example": "2001::1",
12424
+ "x-f5xc-description-short": "X-displayName: \"IPv6 Address\" Use given IPv6 address as VIP on the Cloud Edge.",
12090
12425
  "minLength": 0,
12091
12426
  "maxLength": 1024,
12092
12427
  "x-f5xc-required-for": {
@@ -12100,6 +12435,8 @@
12100
12435
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
12101
12436
  }
12102
12437
  },
12438
+ "x-f5xc-description-short": "X-displayName: \"Segment on a Cloud Edge\" This defines a reference to a Segment on a Cloud Edge and an optional IP address where a load balancer...",
12439
+ "x-f5xc-description-medium": "X-displayName: \"Segment on a Cloud Edge\" This defines a reference to a Segment on a Cloud Edge and an optional IP address where a load balancer could be advertised.",
12103
12440
  "x-f5xc-minimum-configuration": {
12104
12441
  "description": "Minimum configuration for viewsWhereCloudEdgeSegment",
12105
12442
  "required_fields": [
@@ -12124,6 +12461,7 @@
12124
12461
  "type": "string",
12125
12462
  "description": "X-displayName: \"IPv4 VIP\"\nx-required\nConfigure IPv4 VIP address.",
12126
12463
  "title": "IPv4 VIP",
12464
+ "x-f5xc-description-short": "X-displayName: \"IPv4 VIP\" x-required Configure IPv4 VIP address.",
12127
12465
  "minLength": 0,
12128
12466
  "maxLength": 1024,
12129
12467
  "x-f5xc-required-for": {
@@ -12137,6 +12475,7 @@
12137
12475
  "type": "string",
12138
12476
  "description": "X-displayName: \"IPv6 VIP\"\nConfigure IPv6 VIP address.",
12139
12477
  "title": "IPv6 VIP",
12478
+ "x-f5xc-description-short": "X-displayName: \"IPv6 VIP\" Configure IPv6 VIP address.",
12140
12479
  "minLength": 0,
12141
12480
  "maxLength": 1024,
12142
12481
  "x-f5xc-required-for": {
@@ -12150,6 +12489,7 @@
12150
12489
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
12151
12490
  }
12152
12491
  },
12492
+ "x-f5xc-description-short": "X-displayName: \"Virtual Network\" Parameters to advertise on a given virtual network.",
12153
12493
  "x-f5xc-minimum-configuration": {
12154
12494
  "description": "Minimum configuration for viewsWhereSegment",
12155
12495
  "required_fields": [
@@ -12174,6 +12514,7 @@
12174
12514
  "description": "X-displayName: \"IP Address\"\nx-required\nUse given IP address as VIP on the site.",
12175
12515
  "title": "IP address on the site.",
12176
12516
  "x-f5xc-example": "8.8.8.8",
12517
+ "x-f5xc-description-short": "X-displayName: \"IP Address\" x-required Use given IP address as VIP on the site.",
12177
12518
  "minLength": 0,
12178
12519
  "maxLength": 1024,
12179
12520
  "x-f5xc-required-for": {
@@ -12188,6 +12529,7 @@
12188
12529
  "description": "X-displayName: \"IPv6 Address\"\nUse given IPv6 address as VIP on the site.",
12189
12530
  "title": "IPv6 address on the site.",
12190
12531
  "x-f5xc-example": "2001::1",
12532
+ "x-f5xc-description-short": "X-displayName: \"IPv6 Address\" Use given IPv6 address as VIP on the site.",
12191
12533
  "minLength": 0,
12192
12534
  "maxLength": 1024,
12193
12535
  "x-f5xc-required-for": {
@@ -12204,6 +12546,8 @@
12204
12546
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
12205
12547
  }
12206
12548
  },
12549
+ "x-f5xc-description-short": "X-displayName: \"Segment on Site\" This defines a reference to a Segment on a Site and an optional IP address where a load balancer could be advertised.",
12550
+ "x-f5xc-description-medium": "X-displayName: \"Segment on Site\" This defines a reference to a Segment on a Site and an optional IP address where a load balancer could be advertised.",
12207
12551
  "x-f5xc-minimum-configuration": {
12208
12552
  "description": "Minimum configuration for viewsWhereSiteSegment",
12209
12553
  "required_fields": [
@@ -12247,6 +12591,7 @@
12247
12591
  "ves.io.schema.rules.uint32.lte": "65535"
12248
12592
  },
12249
12593
  "x-f5xc-example": "8080",
12594
+ "x-f5xc-description-short": "Exclusive with [port_ranges use_default_port] Port to Listen.",
12250
12595
  "minimum": 1,
12251
12596
  "maximum": 65535,
12252
12597
  "x-f5xc-required-for": {
@@ -12277,6 +12622,8 @@
12277
12622
  "ves.io.schema.rules.string.min_len": "1",
12278
12623
  "ves.io.schema.rules.string.unique_port_range_list": "true"
12279
12624
  },
12625
+ "x-f5xc-description-short": "Exclusive with [port use_default_port] A string containing a comma separated list of port ranges.",
12626
+ "x-f5xc-description-medium": "Exclusive with [port use_default_port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".",
12280
12627
  "x-f5xc-required-for": {
12281
12628
  "minimum_config": false,
12282
12629
  "create": false,
@@ -12303,6 +12650,7 @@
12303
12650
  "$ref": "#/components/schemas/viewsWhereVK8SService"
12304
12651
  }
12305
12652
  },
12653
+ "x-f5xc-description-short": "Defines various OPTIONS where a Loadbalancer could be advertised.",
12306
12654
  "x-f5xc-minimum-configuration": {
12307
12655
  "description": "Minimum configuration for viewsWhereType",
12308
12656
  "required_fields": [
@@ -12339,6 +12687,8 @@
12339
12687
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
12340
12688
  }
12341
12689
  },
12690
+ "x-f5xc-description-short": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.",
12691
+ "x-f5xc-description-medium": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.",
12342
12692
  "x-f5xc-minimum-configuration": {
12343
12693
  "description": "Minimum configuration for viewsWhereVK8SService",
12344
12694
  "required_fields": [
@@ -12379,6 +12729,7 @@
12379
12729
  "x-validation-rules": {
12380
12730
  "ves.io.schema.rules.string.ipv6": "true"
12381
12731
  },
12732
+ "x-f5xc-description-short": "Exclusive with [default_v6_vip] Use given IPv6 address as VIP on virtual Network.",
12382
12733
  "minLength": 0,
12383
12734
  "maxLength": 1024,
12384
12735
  "x-f5xc-required-for": {
@@ -12399,6 +12750,7 @@
12399
12750
  "x-validation-rules": {
12400
12751
  "ves.io.schema.rules.string.ipv4": "true"
12401
12752
  },
12753
+ "x-f5xc-description-short": "Exclusive with [default_vip] Use given IPv4 address as VIP on virtual Network.",
12402
12754
  "minLength": 0,
12403
12755
  "maxLength": 1024,
12404
12756
  "x-f5xc-required-for": {
@@ -12412,6 +12764,7 @@
12412
12764
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
12413
12765
  }
12414
12766
  },
12767
+ "x-f5xc-description-short": "Parameters to advertise on a given virtual network.",
12415
12768
  "x-f5xc-minimum-configuration": {
12416
12769
  "description": "Minimum configuration for viewsWhereVirtualNetwork",
12417
12770
  "required_fields": [
@@ -12438,6 +12791,7 @@
12438
12791
  "description": "X-displayName: \"IP Address\"\nx-required\nUse given IP address as VIP on the site.",
12439
12792
  "title": "IP address on the site.",
12440
12793
  "x-f5xc-example": "8.8.8.8",
12794
+ "x-f5xc-description-short": "X-displayName: \"IP Address\" x-required Use given IP address as VIP on the site.",
12441
12795
  "minLength": 0,
12442
12796
  "maxLength": 1024,
12443
12797
  "x-f5xc-required-for": {
@@ -12452,6 +12806,7 @@
12452
12806
  "description": "X-displayName: \"IPv6 Address\"\nUse given IPv6 address as VIP on the site.",
12453
12807
  "title": "IPv6 address on the site.",
12454
12808
  "x-f5xc-example": "2001::1",
12809
+ "x-f5xc-description-short": "X-displayName: \"IPv6 Address\" Use given IPv6 address as VIP on the site.",
12455
12810
  "minLength": 0,
12456
12811
  "maxLength": 1024,
12457
12812
  "x-f5xc-required-for": {
@@ -12468,6 +12823,8 @@
12468
12823
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
12469
12824
  }
12470
12825
  },
12826
+ "x-f5xc-description-short": "X-displayName: \"Virtual Site\" This defines a reference to a customer site virtual site along with network type where a load balancer could be...",
12827
+ "x-f5xc-description-medium": "X-displayName: \"Virtual Site\" This defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.",
12471
12828
  "x-f5xc-minimum-configuration": {
12472
12829
  "description": "Minimum configuration for viewsWhereVirtualSiteSegment",
12473
12830
  "required_fields": [
@@ -12503,6 +12860,7 @@
12503
12860
  "x-validation-rules": {
12504
12861
  "ves.io.schema.rules.string.ipv4": "true"
12505
12862
  },
12863
+ "x-f5xc-description-short": "Use given IP address as VIP on the site.",
12506
12864
  "minLength": 0,
12507
12865
  "maxLength": 1024,
12508
12866
  "x-f5xc-required-for": {
@@ -12519,6 +12877,8 @@
12519
12877
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
12520
12878
  }
12521
12879
  },
12880
+ "x-f5xc-description-short": "Defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised.",
12881
+ "x-f5xc-description-medium": "Defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised.",
12522
12882
  "x-f5xc-minimum-configuration": {
12523
12883
  "description": "Minimum configuration for viewsWhereVirtualSiteSpecifiedVIP",
12524
12884
  "required_fields": [
@@ -12543,6 +12903,8 @@
12543
12903
  "type": "string",
12544
12904
  "title": "Anomalous data transferred in bytes\nx-displayName: \"Anomalous Data Transferred\"",
12545
12905
  "format": "int64",
12906
+ "description": "Data or content configuration",
12907
+ "x-f5xc-example": "{\"key\": \"value\"}",
12546
12908
  "minLength": 0,
12547
12909
  "maxLength": 1024,
12548
12910
  "x-f5xc-required-for": {
@@ -12554,7 +12916,7 @@
12554
12916
  },
12555
12917
  "anomaly_duration_seconds": {
12556
12918
  "type": "string",
12557
- "description": "",
12919
+ "description": "Security-related configuration",
12558
12920
  "title": "Time between anomaly start and last seen time.\nX-displayName: \"Anomaly duration\"\nx-example: \"300\"",
12559
12921
  "format": "int64",
12560
12922
  "x-displayname": "Anomaly duration.",
@@ -12577,6 +12939,8 @@
12577
12939
  "title": "Anomaly Score\nHigher value indicates more a anomalous datapoint.\nX-displayName: \"Anomaly score\"",
12578
12940
  "format": "float",
12579
12941
  "x-displayname": "Anomaly score.",
12942
+ "description": "Configuration parameter for anomaly score",
12943
+ "x-f5xc-description-short": "Configuration parameter for anomaly score.",
12580
12944
  "x-f5xc-required-for": {
12581
12945
  "minimum_config": false,
12582
12946
  "create": false,
@@ -12586,12 +12950,13 @@
12586
12950
  },
12587
12951
  "anomaly_start_time": {
12588
12952
  "type": "string",
12589
- "description": "",
12953
+ "description": "Configuration parameter for anomaly start time",
12590
12954
  "title": "Time when the anomaly began.\nX-displayName: \"Anomaly start time\"\nx-example: \"2021-01-22 15:46:23.767649\"",
12591
12955
  "format": "date-time",
12592
12956
  "x-displayname": "Anomaly start time.",
12593
12957
  "x-ves-example": "2021-01-22 15:46:23.767649.",
12594
12958
  "x-f5xc-example": "2021-01-22 15:46:23.767649",
12959
+ "x-f5xc-description-short": "Configuration parameter for anomaly start time.",
12595
12960
  "minLength": 0,
12596
12961
  "maxLength": 1024,
12597
12962
  "x-f5xc-required-for": {
@@ -12603,7 +12968,7 @@
12603
12968
  },
12604
12969
  "flow_count": {
12605
12970
  "type": "string",
12606
- "description": "",
12971
+ "description": "Number of items or occurrences",
12607
12972
  "title": "Count of anomalous flows\nx-displayName: \"Flow Count\"\nx-example: \"100000\"",
12608
12973
  "format": "int64",
12609
12974
  "x-displayname": "Flow Count.",
@@ -12622,6 +12987,9 @@
12622
12987
  "type": "object",
12623
12988
  "title": "Labels with metadata about the anomaly\nKey is the label name defined in the Labels enum.\nX-displayName: \"Labels\"",
12624
12989
  "x-displayname": "Labels",
12990
+ "description": "Key-value labels for organization and selection",
12991
+ "x-f5xc-example": "{\"key\": \"value\"}",
12992
+ "x-f5xc-description-short": "Key-value labels for organization and selection.",
12625
12993
  "x-f5xc-required-for": {
12626
12994
  "minimum_config": false,
12627
12995
  "create": false,
@@ -12631,7 +12999,7 @@
12631
12999
  },
12632
13000
  "scan_time": {
12633
13001
  "type": "string",
12634
- "description": "",
13002
+ "description": "Configuration parameter for scan time",
12635
13003
  "title": "Time when the anomaly detection scan was last run.\nX-displayName: \"Scan time\"\nx-example: \"2021-01-22 15:46:23.767649\"",
12636
13004
  "format": "date-time",
12637
13005
  "x-displayname": "Scan time",
@@ -12650,6 +13018,8 @@
12650
13018
  "type": "string",
12651
13019
  "title": "Total data transferred in bytes\nx-displayName: \"Total Data Transferred\"",
12652
13020
  "format": "int64",
13021
+ "description": "Data or content configuration",
13022
+ "x-f5xc-example": "{\"key\": \"value\"}",
12653
13023
  "minLength": 0,
12654
13024
  "maxLength": 1024,
12655
13025
  "x-f5xc-required-for": {
@@ -12660,6 +13030,8 @@
12660
13030
  }
12661
13031
  }
12662
13032
  },
13033
+ "x-f5xc-description-short": "Anomaly Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.",
13034
+ "x-f5xc-description-medium": "Anomaly Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.",
12663
13035
  "x-f5xc-minimum-configuration": {
12664
13036
  "description": "Minimum configuration for flowAnomalyData",
12665
13037
  "required_fields": [
@@ -12713,6 +13085,8 @@
12713
13085
  "description": "Labels contains the name/value pair.\n\"name\" is the label defined in Labels.",
12714
13086
  "title": "Labels",
12715
13087
  "x-displayname": "Labels",
13088
+ "x-f5xc-example": "{\"key\": \"value\"}",
13089
+ "x-f5xc-description-short": "Labels contains the name/value pair. \"name\" is the label defined in Labels.",
12716
13090
  "x-f5xc-required-for": {
12717
13091
  "minimum_config": false,
12718
13092
  "create": false,
@@ -12737,9 +13111,11 @@
12737
13111
  "maxLength": 15,
12738
13112
  "minLength": 3,
12739
13113
  "x-reconciled-from-discovery": true,
12740
- "x-reconciled-at": "2026-01-05T18:29:21.583604+00:00"
13114
+ "x-reconciled-at": "2026-01-07T15:28:40.700183+00:00"
12741
13115
  }
12742
13116
  },
13117
+ "x-f5xc-description-short": "Field Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.",
13118
+ "x-f5xc-description-medium": "Field Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.",
12743
13119
  "x-f5xc-minimum-configuration": {
12744
13120
  "description": "Minimum configuration for flowFieldData",
12745
13121
  "required_fields": [
@@ -12769,6 +13145,8 @@
12769
13145
  "default": "BYTES",
12770
13146
  "x-displayname": "Field selector.",
12771
13147
  "x-ves-proto-enum": "ves.io.schema.flow.FieldSelector",
13148
+ "x-f5xc-description-short": "Field selector for flow data x-unit: \"bytes\" x-unit: \"packets\" x-unit: \"packets\" x-unit: \"bytes\" x-unit: \"packets\" x-unit: \"packets\" x-unit: \"count\".",
13149
+ "x-f5xc-description-medium": "Field selector for flow data x-unit: \"bytes\" x-unit: \"packets\" x-unit: \"packets\" x-unit: \"bytes\" x-unit: \"packets\" x-unit: \"packets\" x-unit: \"count\".",
12772
13150
  "x-f5xc-minimum-configuration": {
12773
13151
  "description": "Minimum configuration for flowFieldSelector",
12774
13152
  "required_fields": [],
@@ -12791,6 +13169,8 @@
12791
13169
  "items": {
12792
13170
  "$ref": "#/components/schemas/flowAnomalyData"
12793
13171
  },
13172
+ "description": "Data or content configuration",
13173
+ "x-f5xc-example": "{\"key\": \"value\"}",
12794
13174
  "x-f5xc-required-for": {
12795
13175
  "minimum_config": false,
12796
13176
  "create": false,
@@ -12830,6 +13210,7 @@
12830
13210
  "$ref": "#/components/schemas/flowFieldData"
12831
13211
  },
12832
13212
  "x-displayname": "Data",
13213
+ "x-f5xc-example": "{\"key\": \"value\"}",
12833
13214
  "x-f5xc-required-for": {
12834
13215
  "minimum_config": false,
12835
13216
  "create": false,
@@ -12896,6 +13277,8 @@
12896
13277
  "default": "SORT_DIRECTION_DESC",
12897
13278
  "x-displayname": "Sort Direction.",
12898
13279
  "x-ves-proto-enum": "ves.io.schema.flow.SortDirection",
13280
+ "x-f5xc-description-short": "Sort Direction for sorting data Sort Direction Desc by default data is sorted in descending direction Sort Direction Asc.",
13281
+ "x-f5xc-description-medium": "Sort Direction for sorting data Sort Direction Desc by default data is sorted in descending direction Sort Direction Asc.",
12899
13282
  "x-f5xc-minimum-configuration": {
12900
13283
  "description": "Minimum configuration for flowSortDirection",
12901
13284
  "required_fields": [],
@@ -12920,6 +13303,8 @@
12920
13303
  "default": "SORT_LABEL_NONE",
12921
13304
  "x-displayname": "Sort Label.",
12922
13305
  "x-ves-proto-enum": "ves.io.schema.flow.SortLabel",
13306
+ "x-f5xc-description-short": "Sort Labels for sorting data Sort Label None Sort Label Bytes Sort Label Flow Count Sort Label Anomaly level Sort Label Anomaly Duration.",
13307
+ "x-f5xc-description-medium": "Sort Labels for sorting data Sort Label None Sort Label Bytes Sort Label Flow Count Sort Label Anomaly level Sort Label Anomaly Duration.",
12923
13308
  "x-f5xc-minimum-configuration": {
12924
13309
  "description": "Minimum configuration for flowSortLabel",
12925
13310
  "required_fields": [],
@@ -12941,6 +13326,7 @@
12941
13326
  "$ref": "#/components/schemas/schemaflowServiceType"
12942
13327
  }
12943
13328
  },
13329
+ "x-f5xc-description-short": "Request to subscribe to Flow Collection.",
12944
13330
  "x-f5xc-minimum-configuration": {
12945
13331
  "description": "Minimum configuration for flowSubscribeRequest",
12946
13332
  "required_fields": [
@@ -12968,6 +13354,7 @@
12968
13354
  "x-displayname": "Last Enabled Time.",
12969
13355
  "x-ves-example": "2021-01-22 15:46:23.767649.",
12970
13356
  "x-f5xc-example": "2021-01-22 15:46:23.767649",
13357
+ "x-f5xc-description-short": "Last Enabled Time for flow anomaly detection subscription request.",
12971
13358
  "minLength": 0,
12972
13359
  "maxLength": 1024,
12973
13360
  "x-f5xc-required-for": {
@@ -12985,6 +13372,7 @@
12985
13372
  "x-displayname": "Last Enabled Time.",
12986
13373
  "x-ves-example": "2021-01-22 15:46:23.767649.",
12987
13374
  "x-f5xc-example": "2021-01-22 15:46:23.767649",
13375
+ "x-f5xc-description-short": "Last Enabled Time for flow collection subscription request.",
12988
13376
  "minLength": 0,
12989
13377
  "maxLength": 1024,
12990
13378
  "x-f5xc-required-for": {
@@ -12995,6 +13383,7 @@
12995
13383
  }
12996
13384
  }
12997
13385
  },
13386
+ "x-f5xc-description-short": "Response of subscribe to Flow Collection.",
12998
13387
  "x-f5xc-minimum-configuration": {
12999
13388
  "description": "Minimum configuration for flowSubscribeResponse",
13000
13389
  "required_fields": [
@@ -13023,6 +13412,7 @@
13023
13412
  "x-displayname": "Last Enabled Time.",
13024
13413
  "x-ves-example": "2021-01-22 15:46:23.767649.",
13025
13414
  "x-f5xc-example": "2021-01-22 15:46:23.767649",
13415
+ "x-f5xc-description-short": "Last Enabled Time for flow anomaly detection subscription request.",
13026
13416
  "minLength": 0,
13027
13417
  "maxLength": 1024,
13028
13418
  "x-f5xc-required-for": {
@@ -13043,6 +13433,7 @@
13043
13433
  "x-displayname": "Last Enabled Time.",
13044
13434
  "x-ves-example": "2021-01-22 15:46:23.767649.",
13045
13435
  "x-f5xc-example": "2021-01-22 15:46:23.767649",
13436
+ "x-f5xc-description-short": "Last Enabled Time for flow collection subscription request.",
13046
13437
  "minLength": 0,
13047
13438
  "maxLength": 1024,
13048
13439
  "x-f5xc-required-for": {
@@ -13056,6 +13447,7 @@
13056
13447
  "$ref": "#/components/schemas/schemaAddonServiceState"
13057
13448
  }
13058
13449
  },
13450
+ "x-f5xc-description-short": "Response of subscription status for Flow Collection.",
13059
13451
  "x-f5xc-minimum-configuration": {
13060
13452
  "description": "Minimum configuration for flowSubscriptionStatusResponse",
13061
13453
  "required_fields": [
@@ -13090,6 +13482,8 @@
13090
13482
  "x-validation-rules": {
13091
13483
  "ves.io.schema.rules.string.query_time": "true"
13092
13484
  },
13485
+ "x-f5xc-description-short": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
13486
+ "x-f5xc-description-medium": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
13093
13487
  "minLength": 0,
13094
13488
  "maxLength": 1024,
13095
13489
  "x-f5xc-required-for": {
@@ -13122,6 +13516,7 @@
13122
13516
  "ves.io.schema.rules.repeated.min_items": "1",
13123
13517
  "ves.io.schema.rules.repeated.unique": "true"
13124
13518
  },
13519
+ "x-f5xc-description-short": "Select fields to be returned in the response. Required: YES.",
13125
13520
  "x-f5xc-required-for": {
13126
13521
  "minimum_config": false,
13127
13522
  "create": false,
@@ -13143,6 +13538,8 @@
13143
13538
  "x-validation-rules": {
13144
13539
  "ves.io.schema.rules.string.max_len": "1024"
13145
13540
  },
13541
+ "x-f5xc-description-short": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\"...",
13542
+ "x-f5xc-description-medium": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in Label can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"] = : equal to != : not...",
13146
13543
  "minLength": 0,
13147
13544
  "x-f5xc-required-for": {
13148
13545
  "minimum_config": false,
@@ -13168,6 +13565,7 @@
13168
13565
  "ves.io.schema.rules.enum.defined_only": "true",
13169
13566
  "ves.io.schema.rules.repeated.max_items": "20"
13170
13567
  },
13568
+ "x-f5xc-description-short": "Aggregate data by labels specified in the group_by field.",
13171
13569
  "x-f5xc-required-for": {
13172
13570
  "minimum_config": false,
13173
13571
  "create": false,
@@ -13208,6 +13606,8 @@
13208
13606
  "$ref": "#/components/schemas/flowSortBy"
13209
13607
  },
13210
13608
  "x-displayname": "Sort By",
13609
+ "x-f5xc-example": "{\"key\": \"value\"}",
13610
+ "x-f5xc-description-short": "Sort the data by specified fields, in the given direction.",
13211
13611
  "x-f5xc-required-for": {
13212
13612
  "minimum_config": false,
13213
13613
  "create": false,
@@ -13228,6 +13628,8 @@
13228
13628
  "x-validation-rules": {
13229
13629
  "ves.io.schema.rules.string.query_time": "true"
13230
13630
  },
13631
+ "x-f5xc-description-short": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If...",
13632
+ "x-f5xc-description-medium": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
13231
13633
  "minLength": 0,
13232
13634
  "maxLength": 1024,
13233
13635
  "x-f5xc-required-for": {
@@ -13270,6 +13672,7 @@
13270
13672
  "$ref": "#/components/schemas/flowFlowAnomalyData"
13271
13673
  },
13272
13674
  "x-displayname": "FlowAnomalyData.",
13675
+ "x-f5xc-description-short": "FlowAnomalyData wraps the response for flows with anomalies.",
13273
13676
  "x-f5xc-required-for": {
13274
13677
  "minimum_config": false,
13275
13678
  "create": false,
@@ -13309,6 +13712,8 @@
13309
13712
  "x-validation-rules": {
13310
13713
  "ves.io.schema.rules.string.query_time": "true"
13311
13714
  },
13715
+ "x-f5xc-description-short": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...",
13716
+ "x-f5xc-description-medium": "End time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
13312
13717
  "minLength": 0,
13313
13718
  "maxLength": 1024,
13314
13719
  "x-f5xc-required-for": {
@@ -13341,6 +13746,7 @@
13341
13746
  "ves.io.schema.rules.repeated.min_items": "1",
13342
13747
  "ves.io.schema.rules.repeated.unique": "true"
13343
13748
  },
13749
+ "x-f5xc-description-short": "Select fields to be returned in the response. Required: YES.",
13344
13750
  "x-f5xc-required-for": {
13345
13751
  "minimum_config": false,
13346
13752
  "create": false,
@@ -13355,6 +13761,8 @@
13355
13761
  "x-displayname": "Filter",
13356
13762
  "x-ves-example": "{SITE=\\\"site-1\\\"}",
13357
13763
  "x-f5xc-example": "\"{SITE=\\\"site-1\\\"}\"",
13764
+ "x-f5xc-description-short": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\"...",
13765
+ "x-f5xc-description-medium": "\\site-1\",\\\"site-2\\\")}\" filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or more labels defined in Label can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"] = : equal to != : not...",
13358
13766
  "minLength": 0,
13359
13767
  "maxLength": 1024,
13360
13768
  "x-f5xc-required-for": {
@@ -13372,6 +13780,7 @@
13372
13780
  "$ref": "#/components/schemas/schemaflowLabel"
13373
13781
  },
13374
13782
  "x-displayname": "Group By",
13783
+ "x-f5xc-description-short": "Aggregate data by labels specified in the group_by field.",
13375
13784
  "x-f5xc-required-for": {
13376
13785
  "minimum_config": false,
13377
13786
  "create": false,
@@ -13412,6 +13821,8 @@
13412
13821
  "$ref": "#/components/schemas/flowSortBy"
13413
13822
  },
13414
13823
  "x-displayname": "Sort By",
13824
+ "x-f5xc-example": "{\"key\": \"value\"}",
13825
+ "x-f5xc-description-short": "Sort the data by specified fields, in the given direction.",
13415
13826
  "x-f5xc-required-for": {
13416
13827
  "minimum_config": false,
13417
13828
  "create": false,
@@ -13432,6 +13843,8 @@
13432
13843
  "x-validation-rules": {
13433
13844
  "ves.io.schema.rules.string.query_time": "true"
13434
13845
  },
13846
+ "x-f5xc-description-short": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If...",
13847
+ "x-f5xc-description-medium": "Start time of flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
13435
13848
  "minLength": 0,
13436
13849
  "maxLength": 1024,
13437
13850
  "x-f5xc-required-for": {
@@ -13474,6 +13887,8 @@
13474
13887
  "$ref": "#/components/schemas/flowFlowData"
13475
13888
  },
13476
13889
  "x-displayname": "Data",
13890
+ "x-f5xc-example": "{\"key\": \"value\"}",
13891
+ "x-f5xc-description-short": "FlowData wraps the response for the flow request.",
13477
13892
  "x-f5xc-required-for": {
13478
13893
  "minimum_config": false,
13479
13894
  "create": false,
@@ -13505,6 +13920,7 @@
13505
13920
  "$ref": "#/components/schemas/schemaflowServiceType"
13506
13921
  }
13507
13922
  },
13923
+ "x-f5xc-description-short": "Request to unsubscribe to Flow Collection.",
13508
13924
  "x-f5xc-minimum-configuration": {
13509
13925
  "description": "Minimum configuration for flowUnsubscribeRequest",
13510
13926
  "required_fields": [
@@ -13523,6 +13939,7 @@
13523
13939
  "title": "UnsubscribeResponse.",
13524
13940
  "x-displayname": "Unsubscribe Response.",
13525
13941
  "x-ves-proto-message": "ves.io.schema.flow.UnsubscribeResponse",
13942
+ "x-f5xc-description-short": "Response of unsubscribe to Flow Collection.",
13526
13943
  "x-f5xc-minimum-configuration": {
13527
13944
  "description": "Minimum configuration for flowUnsubscribeResponse",
13528
13945
  "required_fields": [],
@@ -13546,6 +13963,8 @@
13546
13963
  "default": "AS_NONE",
13547
13964
  "x-displayname": "Addon Service State.",
13548
13965
  "x-ves-proto-enum": "ves.io.schema.AddonServiceState",
13966
+ "x-f5xc-description-short": "State of a service default state initiated subscription request and is pending to activate (requested).",
13967
+ "x-f5xc-description-medium": "State of a service default state initiated subscription request and is pending to activate (requested). Successfully subscribed service subscription request ended up in error state.",
13549
13968
  "x-f5xc-minimum-configuration": {
13550
13969
  "description": "Minimum configuration for schemaAddonServiceState",
13551
13970
  "required_fields": [],
@@ -13585,6 +14004,8 @@
13585
14004
  "default": "SITE",
13586
14005
  "x-displayname": "Labels",
13587
14006
  "x-ves-proto-enum": "ves.io.schema.flow.Label",
14007
+ "x-f5xc-description-short": "Labels is used to select one or more fields for the data Identifies the site . Identifies the source IP address.",
14008
+ "x-f5xc-description-medium": "Labels is used to select one or more fields for the data Identifies the site . Identifies the source IP address. Identifies the source port. Identifies the destination IP address. Identifies the destination port.",
13588
14009
  "x-f5xc-minimum-configuration": {
13589
14010
  "description": "Minimum configuration for schemaflowLabel",
13590
14011
  "required_fields": [],
@@ -13607,6 +14028,8 @@
13607
14028
  "default": "FLOW_COLLECTION",
13608
14029
  "x-displayname": "Service Type.",
13609
14030
  "x-ves-proto-enum": "ves.io.schema.flow.ServiceType",
14031
+ "x-f5xc-description-short": "Service type for subscribing/unsubscribing flow-collection/flow-anomaly-detection by default flow collection is subscribed/unsubscribed Flow...",
14032
+ "x-f5xc-description-medium": "Service type for subscribing/unsubscribing flow-collection/flow-anomaly-detection by default flow collection is subscribed/unsubscribed Flow Anomaly Detection Subscribe/unsubscribe to both flow collection and anomaly detection.",
13610
14033
  "x-f5xc-minimum-configuration": {
13611
14034
  "description": "Minimum configuration for schemaflowServiceType",
13612
14035
  "required_fields": [],
@@ -13632,6 +14055,8 @@
13632
14055
  "default": "APIEP_CATEGORY_DISCOVERED",
13633
14056
  "x-displayname": "Category of the API Endpoint.",
13634
14057
  "x-ves-proto-enum": "ves.io.schema.app_type.APIEPCategory",
14058
+ "x-f5xc-description-short": "The category of an API endpoint. Discovered API Endpoint.",
14059
+ "x-f5xc-description-medium": "The category of an API endpoint. Discovered API Endpoint. The API Endpoint is imported from user swagger. The API Endpoint is present at the API Inventory. The API Endpoint is considered as part of Shadow API.",
13635
14060
  "x-f5xc-minimum-configuration": {
13636
14061
  "description": "Minimum configuration for app_typeAPIEPCategory",
13637
14062
  "required_fields": [],
@@ -13659,6 +14084,7 @@
13659
14084
  "x-displayname": "Expanded URL(s)",
13660
14085
  "x-ves-example": "[d0161a1e-044e-427b-a806-3bad9eac97fc, a74eb844-6d91-474c-9874-f19fa3983f4d]",
13661
14086
  "x-f5xc-example": "[d0161a1e-044e-427b-a806-3bad9eac97fc, a74eb844-6d91-474c-9874-f19fa3983f4d]",
14087
+ "x-f5xc-description-short": "List of sample URL(s) that are collapsed.",
13662
14088
  "x-f5xc-required-for": {
13663
14089
  "minimum_config": false,
13664
14090
  "create": false,
@@ -13673,6 +14099,7 @@
13673
14099
  "x-displayname": "Dynamic Component.",
13674
14100
  "x-ves-example": "/API/v1/user_id/DYN.",
13675
14101
  "x-f5xc-example": "/api/v1/user_id/DYN",
14102
+ "x-f5xc-description-short": "Dynamic component used to collapse sample URLs given in Expanded URLs.",
13676
14103
  "minLength": 0,
13677
14104
  "maxLength": 1024,
13678
14105
  "x-f5xc-required-for": {
@@ -13684,6 +14111,8 @@
13684
14111
  "x-field-mutability": "read-only"
13685
14112
  }
13686
14113
  },
14114
+ "x-f5xc-description-short": "List of Examples of expanded URL components for API endpoints that are collapsed with a dynamic component that is identified automatically.",
14115
+ "x-f5xc-description-medium": "List of Examples of expanded URL components for API endpoints that are collapsed with a dynamic component that is identified automatically.",
13687
14116
  "x-f5xc-minimum-configuration": {
13688
14117
  "description": "Minimum configuration for app_typeAPIEPDynExample",
13689
14118
  "required_fields": [
@@ -13710,6 +14139,8 @@
13710
14139
  "title": "Access_discovery_time.",
13711
14140
  "format": "date-time",
13712
14141
  "x-displayname": "Access Discovery Time.",
14142
+ "x-f5xc-description-short": "Access_discovery_time is the time when the API endpoint was updated from the access logs by the discovery mechanism.",
14143
+ "x-f5xc-description-medium": "Access_discovery_time is the time when the API endpoint was updated from the access logs by the discovery mechanism. It is the UTC time and represented in RFC3339 form.",
13713
14144
  "minLength": 0,
13714
14145
  "maxLength": 1024,
13715
14146
  "x-f5xc-required-for": {
@@ -13728,6 +14159,7 @@
13728
14159
  },
13729
14160
  "x-displayname": "API Groups membership.",
13730
14161
  "x-f5xc-example": "[\"sensitive\", \"read-only\"]",
14162
+ "x-f5xc-description-short": "List of API Groups the API Endpoint is a member of.",
13731
14163
  "x-f5xc-required-for": {
13732
14164
  "minimum_config": false,
13733
14165
  "create": false,
@@ -13765,6 +14197,7 @@
13765
14197
  "$ref": "#/components/schemas/app_typeAuthenticationTypeLocPair"
13766
14198
  },
13767
14199
  "x-displayname": "Authentication Types and Locations.",
14200
+ "x-f5xc-description-short": "List of authentication types found in the API endpoint and their locations.",
13768
14201
  "x-f5xc-required-for": {
13769
14202
  "minimum_config": false,
13770
14203
  "create": false,
@@ -13779,6 +14212,7 @@
13779
14212
  "format": "float",
13780
14213
  "x-displayname": "Average Latency.",
13781
14214
  "x-f5xc-example": "2.34",
14215
+ "x-f5xc-description-short": "Average latency observed for the API Endpoint.",
13782
14216
  "x-f5xc-required-for": {
13783
14217
  "minimum_config": false,
13784
14218
  "create": false,
@@ -13811,6 +14245,7 @@
13811
14245
  },
13812
14246
  "x-displayname": "Category",
13813
14247
  "x-f5xc-example": "APIEP_CATEGORY_DISCOVERED, APIEP_CATEGORY_INVENTORY",
14248
+ "x-f5xc-description-short": "The category of the API Endpoint relative to API Inventory.",
13814
14249
  "x-f5xc-required-for": {
13815
14250
  "minimum_config": false,
13816
14251
  "create": false,
@@ -13843,6 +14278,7 @@
13843
14278
  },
13844
14279
  "x-displayname": "Compliances.",
13845
14280
  "x-f5xc-example": "[\"GDPR\", \"HIPAA\", \"CCPA\"]",
14281
+ "x-f5xc-description-short": "List of compliance frameworks of the Endpoint.",
13846
14282
  "x-f5xc-required-for": {
13847
14283
  "minimum_config": false,
13848
14284
  "create": false,
@@ -13877,6 +14313,8 @@
13877
14313
  "x-displayname": "Expanded URL(s)",
13878
14314
  "x-ves-example": "{component_identifier: API/v1/user_id/DYN,component_examples: [cmenomo007]}",
13879
14315
  "x-f5xc-example": "{component_identifierapi/v1/user_id/DYN,component_examples: [cmenomo007]}",
14316
+ "x-f5xc-description-short": "For example - {\"dyn_examples\": [ { \"component_identifier\": \"API/v1/user_id/DYN\", \"component_examples\": [ \"cmenomo007\", \"marcusaurelius\"...",
14317
+ "x-f5xc-description-medium": "For example - {\"dyn_examples\": [ { \"component_identifier\": \"API/v1/user_id/DYN\", \"component_examples\": [ \"cmenomo007\", \"marcusaurelius\" \"artattacksince1947\", \"johndoe83\", ] }, { \"component_identifier\": \"API/v1/user_id/DYN/vehicle_id/DYN\", \"component_examples\": [ \"JN1CV6AR3AM458367\"...",
13880
14318
  "x-f5xc-required-for": {
13881
14319
  "minimum_config": false,
13882
14320
  "create": false,
@@ -13893,6 +14331,7 @@
13893
14331
  },
13894
14332
  "x-displayname": "Engines",
13895
14333
  "x-f5xc-example": "[\"TRAFFIC_INSPECTION\", \"CODE_ANALYSIS\", \"CRAWLER\"]",
14334
+ "x-f5xc-description-short": "List of engines that detected the endpoint.",
13896
14335
  "x-f5xc-required-for": {
13897
14336
  "minimum_config": false,
13898
14337
  "create": false,
@@ -13907,6 +14346,7 @@
13907
14346
  "format": "uint64",
13908
14347
  "x-displayname": "Error Count.",
13909
14348
  "x-f5xc-example": "1234",
14349
+ "x-f5xc-description-short": "Number of request with 4xx or 5xx response for the API Endpoint.",
13910
14350
  "minLength": 0,
13911
14351
  "maxLength": 1024,
13912
14352
  "x-f5xc-required-for": {
@@ -13923,6 +14363,7 @@
13923
14363
  "format": "boolean",
13924
14364
  "x-displayname": "Has Learnt Schema.",
13925
14365
  "x-f5xc-example": "true",
14366
+ "x-f5xc-description-short": "Has Learnt Schema flag for request API endpoint.",
13926
14367
  "x-f5xc-required-for": {
13927
14368
  "minimum_config": false,
13928
14369
  "create": false,
@@ -13936,6 +14377,7 @@
13936
14377
  "title": "Last API testing.",
13937
14378
  "format": "date-time",
13938
14379
  "x-displayname": "Last tested.",
14380
+ "x-f5xc-description-short": "API testing last tested time is the time when the API endpoint was last tested.",
13939
14381
  "minLength": 0,
13940
14382
  "maxLength": 1024,
13941
14383
  "x-f5xc-required-for": {
@@ -13952,6 +14394,7 @@
13952
14394
  "format": "float",
13953
14395
  "x-displayname": "Max Latency.",
13954
14396
  "x-f5xc-example": "9.87",
14397
+ "x-f5xc-description-short": "Maximum latency observed for the API Endpoint.",
13955
14398
  "x-f5xc-required-for": {
13956
14399
  "minimum_config": false,
13957
14400
  "create": false,
@@ -14003,6 +14446,7 @@
14003
14446
  "x-displayname": "Request Percentage.",
14004
14447
  "x-ves-example": "78.5789",
14005
14448
  "x-f5xc-example": "78.5789",
14449
+ "x-f5xc-description-short": "Percentage of requests that were directed to this API Endpoint.",
14006
14450
  "x-f5xc-required-for": {
14007
14451
  "minimum_config": false,
14008
14452
  "create": false,
@@ -14018,6 +14462,7 @@
14018
14462
  "x-displayname": "Number Of Total Requests.",
14019
14463
  "x-ves-example": "1234",
14020
14464
  "x-f5xc-example": "1234",
14465
+ "x-f5xc-description-short": "Number of requests seen for this API Endpoint for the specified time-range.",
14021
14466
  "minimum": 0,
14022
14467
  "maximum": 2147483647,
14023
14468
  "x-f5xc-required-for": {
@@ -14037,6 +14482,7 @@
14037
14482
  "x-displayname": "Schema Status.",
14038
14483
  "x-ves-example": "Discovered Not-Updated.",
14039
14484
  "x-f5xc-example": "Discovered Not-Updated",
14485
+ "x-f5xc-description-short": "Schema status indicates the API Endpoint's schema origin and if it's outdated.",
14040
14486
  "minLength": 0,
14041
14487
  "maxLength": 1024,
14042
14488
  "x-f5xc-required-for": {
@@ -14054,6 +14500,7 @@
14054
14500
  "x-displayname": "Number Of Total Security Events.",
14055
14501
  "x-ves-example": "1234",
14056
14502
  "x-f5xc-example": "1234",
14503
+ "x-f5xc-description-short": "Number of sec_events seen for this API Endpoint for the specified time-range.",
14057
14504
  "minimum": 0,
14058
14505
  "maximum": 2147483647,
14059
14506
  "x-f5xc-required-for": {
@@ -14076,6 +14523,7 @@
14076
14523
  "x-displayname": "List of Sensitive Data.",
14077
14524
  "x-ves-example": "[SENSITIVE_DATA_TYPE_CCN, SENSITIVE_DATA_TYPE_SSN, SENSITIVE_DATA_TYPE_IP]",
14078
14525
  "x-f5xc-example": "[SENSITIVE_DATA_TYPE_CCN, SENSITIVE_DATA_TYPE_SSN, SENSITIVE_DATA_TYPE_IP]",
14526
+ "x-f5xc-description-short": "List of Sensitive Data found in the API endpoint.",
14079
14527
  "x-f5xc-required-for": {
14080
14528
  "minimum_config": false,
14081
14529
  "create": false,
@@ -14092,6 +14540,7 @@
14092
14540
  },
14093
14541
  "x-displayname": "Sensitive Data Location.",
14094
14542
  "x-f5xc-example": "Request",
14543
+ "x-f5xc-description-short": "Sensitive data location for the API Endpoint.",
14095
14544
  "x-f5xc-required-for": {
14096
14545
  "minimum_config": false,
14097
14546
  "create": false,
@@ -14109,6 +14558,7 @@
14109
14558
  "x-displayname": "List of Sensitive Data.",
14110
14559
  "x-ves-example": "[Social-Security-Number, Credit-Card-Number]",
14111
14560
  "x-f5xc-example": "[Social-Security-Number, Credit-Card-Number]",
14561
+ "x-f5xc-description-short": "List of Sensitive Data found in the API endpoint.",
14112
14562
  "x-f5xc-required-for": {
14113
14563
  "minimum_config": false,
14114
14564
  "create": false,
@@ -14117,6 +14567,8 @@
14117
14567
  }
14118
14568
  }
14119
14569
  },
14570
+ "x-f5xc-description-short": "Information about automatically identified API endpoint Each identified API endpoint has a CollapsedURL and Method.",
14571
+ "x-f5xc-description-medium": "Information about automatically identified API endpoint Each identified API endpoint has a CollapsedURL and Method. CollapsedURL is created by replacing dynamic components in the URL, if any, with the keyword DYN. These dynamic components are automatically identified.",
14120
14572
  "x-f5xc-minimum-configuration": {
14121
14573
  "description": "Minimum configuration for app_typeAPIEPInfo",
14122
14574
  "required_fields": [
@@ -14173,6 +14625,8 @@
14173
14625
  "title": "Creation_timestamp.",
14174
14626
  "format": "date-time",
14175
14627
  "x-displayname": "Creation Timestamp.",
14628
+ "x-f5xc-description-short": "Creation_timestamp represents the time when this PDF was created It is represented in RFC3339 form and is in UTC.",
14629
+ "x-f5xc-description-medium": "Creation_timestamp represents the time when this PDF was created It is represented in RFC3339 form and is in UTC.",
14176
14630
  "minLength": 0,
14177
14631
  "maxLength": 1024,
14178
14632
  "x-f5xc-required-for": {
@@ -14191,6 +14645,7 @@
14191
14645
  "$ref": "#/components/schemas/app_typePDFSpec"
14192
14646
  },
14193
14647
  "x-displayname": "PDF(Error Rate)",
14648
+ "x-f5xc-description-short": "List of Probability density points for PDF for error rate.",
14194
14649
  "x-f5xc-required-for": {
14195
14650
  "minimum_config": false,
14196
14651
  "create": false,
@@ -14209,6 +14664,8 @@
14209
14664
  "$ref": "#/components/schemas/app_typePDFSpec"
14210
14665
  },
14211
14666
  "x-displayname": "PDF(Latency Begin)",
14667
+ "x-f5xc-example": "{\"key\": \"value\"}",
14668
+ "x-f5xc-description-short": "List of Probability density points for PDF for latency of response begin.",
14212
14669
  "x-f5xc-required-for": {
14213
14670
  "minimum_config": false,
14214
14671
  "create": false,
@@ -14227,6 +14684,8 @@
14227
14684
  "$ref": "#/components/schemas/app_typePDFSpec"
14228
14685
  },
14229
14686
  "x-displayname": "PDF(Latency End)",
14687
+ "x-f5xc-example": "{\"key\": \"value\"}",
14688
+ "x-f5xc-description-short": "List of Probability density points for PDF for latency of response end.",
14230
14689
  "x-f5xc-required-for": {
14231
14690
  "minimum_config": false,
14232
14691
  "create": false,
@@ -14245,6 +14704,7 @@
14245
14704
  "$ref": "#/components/schemas/app_typePDFSpec"
14246
14705
  },
14247
14706
  "x-displayname": "PDF(Request Rate)",
14707
+ "x-f5xc-description-short": "List of Probability density points for PDF for request rate.",
14248
14708
  "x-f5xc-required-for": {
14249
14709
  "minimum_config": false,
14250
14710
  "create": false,
@@ -14263,6 +14723,7 @@
14263
14723
  "$ref": "#/components/schemas/app_typePDFSpec"
14264
14724
  },
14265
14725
  "x-displayname": "PDF(Request)",
14726
+ "x-f5xc-description-short": "List of Probability density points for PDF for request size.",
14266
14727
  "x-f5xc-required-for": {
14267
14728
  "minimum_config": false,
14268
14729
  "create": false,
@@ -14281,6 +14742,7 @@
14281
14742
  "$ref": "#/components/schemas/app_typePDFSpec"
14282
14743
  },
14283
14744
  "x-displayname": "PDF(Response)",
14745
+ "x-f5xc-description-short": "List of Probability density points for PDF for response size.",
14284
14746
  "x-f5xc-required-for": {
14285
14747
  "minimum_config": false,
14286
14748
  "create": false,
@@ -14299,6 +14761,7 @@
14299
14761
  "$ref": "#/components/schemas/app_typePDFSpec"
14300
14762
  },
14301
14763
  "x-displayname": "PDF(Response Throughput)",
14764
+ "x-f5xc-description-short": "List of Probability density points for PDF for response throughput.",
14302
14765
  "x-f5xc-required-for": {
14303
14766
  "minimum_config": false,
14304
14767
  "create": false,
@@ -14310,6 +14773,8 @@
14310
14773
  "$ref": "#/components/schemas/app_typePDFStat"
14311
14774
  }
14312
14775
  },
14776
+ "x-f5xc-description-short": "Metrics supported currently are request_size response_size latency_with_data, latency_no_data.",
14777
+ "x-f5xc-description-medium": "Metrics supported currently are request_size response_size latency_with_data, latency_no_data. PDF is calculated for each combination of (Tenant, App type, API endpoint). API endpoint is determined from automatically identified API (collapsed_url) and method.",
14313
14778
  "x-f5xc-minimum-configuration": {
14314
14779
  "description": "Minimum configuration for app_typeAPIEPPDFInfo",
14315
14780
  "required_fields": [
@@ -14347,6 +14812,8 @@
14347
14812
  "default": "APIEP_PII_NOT_DETECTED",
14348
14813
  "x-displayname": "API EP PII Level.",
14349
14814
  "x-ves-proto-enum": "ves.io.schema.app_type.APIEPPIILevel",
14815
+ "x-f5xc-description-short": "API Endpoint's PII Level. No PII data detected for the given API Endpoint.",
14816
+ "x-f5xc-description-medium": "API Endpoint's PII Level. No PII data detected for the given API Endpoint. Detected PII data for a given API Endpoint.",
14350
14817
  "x-f5xc-minimum-configuration": {
14351
14818
  "description": "Minimum configuration for app_typeAPIEPPIILevel",
14352
14819
  "required_fields": [],
@@ -14371,6 +14838,8 @@
14371
14838
  "default": "APIEP_SEC_RISK_NONE",
14372
14839
  "x-displayname": "API Endpoint Security Risk.",
14373
14840
  "x-ves-proto-enum": "ves.io.schema.app_type.APIEPSecurityRisk",
14841
+ "x-f5xc-description-short": "Signifies API Endpoint Security Risk Level Security risk is not detected (for example, when no traffic).",
14842
+ "x-f5xc-description-medium": "Signifies API Endpoint Security Risk Level Security risk is not detected (for example, when no traffic). API Endpoint has low security risk. API Endpoint has medium security risk.",
14374
14843
  "x-f5xc-minimum-configuration": {
14375
14844
  "description": "Minimum configuration for app_typeAPIEPSecurityRisk",
14376
14845
  "required_fields": [],
@@ -14394,6 +14863,8 @@
14394
14863
  "default": "API_TYPE_UNKNOWN",
14395
14864
  "x-displayname": "API Type",
14396
14865
  "x-ves-proto-enum": "ves.io.schema.app_type.APIType",
14866
+ "x-f5xc-description-short": "List of possible types of API that can be discovered for an APIEP. The API Type detected as unknown.",
14867
+ "x-f5xc-description-medium": "List of possible types of API that can be discovered for an APIEP. The API Type detected as unknown. The API Type detected as GraphQL. The API Type detected as REST. The API Type detected as gRPC.",
14397
14868
  "x-f5xc-minimum-configuration": {
14398
14869
  "description": "Minimum configuration for app_typeAPIType",
14399
14870
  "required_fields": [],
@@ -14417,6 +14888,8 @@
14417
14888
  "default": "AUTH_LOCATION_HEADER",
14418
14889
  "x-displayname": "API EP Authentication Location.",
14419
14890
  "x-ves-proto-enum": "ves.io.schema.app_type.AuthenticationLocation",
14891
+ "x-f5xc-description-short": "API Endpoint's Authentication Location. The API Endpoint authentication location is header.",
14892
+ "x-f5xc-description-medium": "API Endpoint's Authentication Location. The API Endpoint authentication location is header. The API Endpoint authentication location is query parameter.",
14420
14893
  "x-f5xc-minimum-configuration": {
14421
14894
  "description": "Minimum configuration for app_typeAuthenticationLocation",
14422
14895
  "required_fields": [],
@@ -14439,6 +14912,8 @@
14439
14912
  "default": "AUTH_STATE_UNKNOWN",
14440
14913
  "x-displayname": "API EP Authentication State.",
14441
14914
  "x-ves-proto-enum": "ves.io.schema.app_type.AuthenticationState",
14915
+ "x-f5xc-description-short": "API Endpoint's Authentication State. The API Endpoint authentication state is unknown.",
14916
+ "x-f5xc-description-medium": "API Endpoint's Authentication State. The API Endpoint authentication state is unknown. The API Endpoint is authenticated The API Endpoint is unauthenticated.",
14442
14917
  "x-f5xc-minimum-configuration": {
14443
14918
  "description": "Minimum configuration for app_typeAuthenticationState",
14444
14919
  "required_fields": [],
@@ -14468,6 +14943,8 @@
14468
14943
  "default": "AUTH_TYPE_BASIC",
14469
14944
  "x-displayname": "API EP Authentication Type.",
14470
14945
  "x-ves-proto-enum": "ves.io.schema.app_type.AuthenticationType",
14946
+ "x-f5xc-description-short": "API Endpoint's Authentication Type. The API Endpoint authentication type is Basic.",
14947
+ "x-f5xc-description-medium": "API Endpoint's Authentication Type. The API Endpoint authentication type is Basic. The API Endpoint authentication type is Bearer. The API Endpoint authentication type is JWT. The API Endpoint authentication type is API Key.",
14471
14948
  "x-f5xc-minimum-configuration": {
14472
14949
  "description": "Minimum configuration for app_typeAuthenticationType",
14473
14950
  "required_fields": [],
@@ -14492,6 +14969,7 @@
14492
14969
  "x-displayname": "Authentication Type.",
14493
14970
  "x-ves-example": "Basic",
14494
14971
  "x-f5xc-example": "Basic",
14972
+ "x-f5xc-description-short": "The detected authentication type by string format.",
14495
14973
  "minLength": 0,
14496
14974
  "maxLength": 1024,
14497
14975
  "x-f5xc-required-for": {
@@ -14508,6 +14986,7 @@
14508
14986
  "$ref": "#/components/schemas/app_typeAuthenticationType"
14509
14987
  }
14510
14988
  },
14989
+ "x-f5xc-description-short": "API Endpoint's Authentication Type and Location.",
14511
14990
  "x-f5xc-minimum-configuration": {
14512
14991
  "description": "Minimum configuration for app_typeAuthenticationTypeLocPair",
14513
14992
  "required_fields": [
@@ -14537,6 +15016,7 @@
14537
15016
  "x-displayname": "Probability.",
14538
15017
  "x-ves-example": "0.078",
14539
15018
  "x-f5xc-example": "0.078",
15019
+ "x-f5xc-description-short": "Probability of given Value of the metric that can be plotted on y-axis.",
14540
15020
  "x-f5xc-required-for": {
14541
15021
  "minimum_config": false,
14542
15022
  "create": false,
@@ -14552,6 +15032,7 @@
14552
15032
  "x-displayname": "Value",
14553
15033
  "x-ves-example": "121.316",
14554
15034
  "x-f5xc-example": "121.316",
15035
+ "x-f5xc-description-short": "Value of the metric that can be plotted on x-axis.",
14555
15036
  "x-f5xc-required-for": {
14556
15037
  "minimum_config": false,
14557
15038
  "create": false,
@@ -14560,6 +15041,8 @@
14560
15041
  }
14561
15042
  }
14562
15043
  },
15044
+ "x-f5xc-description-short": "Probability Density point in (PDF(x)) of the metric. X is the value of the metric, probability is the corresponding PDF(x).",
15045
+ "x-f5xc-description-medium": "Probability Density point in (PDF(x)) of the metric. X is the value of the metric, probability is the corresponding PDF(x). In the univariate case (current configuration), the value x of the metrics is a scaler.",
14563
15046
  "x-f5xc-minimum-configuration": {
14564
15047
  "description": "Minimum configuration for app_typePDFSpec",
14565
15048
  "required_fields": [
@@ -14588,6 +15071,7 @@
14588
15071
  "x-displayname": "PDF(95th Percentile)",
14589
15072
  "x-ves-example": "0.078",
14590
15073
  "x-f5xc-example": "0.078",
15074
+ "x-f5xc-description-short": "Pdf_95 represents the 95th percentile of PDF.",
14591
15075
  "x-f5xc-required-for": {
14592
15076
  "minimum_config": false,
14593
15077
  "create": false,
@@ -14609,6 +15093,8 @@
14609
15093
  }
14610
15094
  }
14611
15095
  },
15096
+ "x-f5xc-description-short": "Probability Density Function statistics of the metric. Pdf_mean is the mean PDF of the metric, pdf_95 is the 95th percentile PDF of the metric.",
15097
+ "x-f5xc-description-medium": "Probability Density Function statistics of the metric. Pdf_mean is the mean PDF of the metric, pdf_95 is the 95th percentile PDF of the metric. In the univariate case PDFStat for each metric consists of pdf_mean and pdf_95.",
14612
15098
  "x-f5xc-minimum-configuration": {
14613
15099
  "description": "Minimum configuration for app_typePDFStat",
14614
15100
  "required_fields": [
@@ -14635,6 +15121,7 @@
14635
15121
  "title": "Score",
14636
15122
  "format": "float",
14637
15123
  "x-displayname": "Score",
15124
+ "x-f5xc-description-short": "Score of the vulnerabilities found for this API Endpoint.",
14638
15125
  "x-f5xc-required-for": {
14639
15126
  "minimum_config": false,
14640
15127
  "create": false,
@@ -14646,6 +15133,7 @@
14646
15133
  "$ref": "#/components/schemas/app_typeAPIEPSecurityRisk"
14647
15134
  }
14648
15135
  },
15136
+ "x-f5xc-description-short": "Risk score of the vulnerabilities found for this API Endpoint.",
14649
15137
  "x-f5xc-minimum-configuration": {
14650
15138
  "description": "Minimum configuration for app_typeRiskScore",
14651
15139
  "required_fields": [
@@ -14677,6 +15165,8 @@
14677
15165
  "default": "SENSITIVE_DATA_TYPE_CCN",
14678
15166
  "x-displayname": "Sensitive Data Type.",
14679
15167
  "x-ves-proto-enum": "ves.io.schema.app_type.SensitiveDataType",
15168
+ "x-f5xc-description-short": "List of possible types of sensitive data that can be discovered for an APIEP. The Sensitive Data detected as credit card number.",
15169
+ "x-f5xc-description-medium": "List of possible types of sensitive data that can be discovered for an APIEP. The Sensitive Data detected as credit card number. The sensitive data detected as social security number.",
14680
15170
  "x-f5xc-minimum-configuration": {
14681
15171
  "description": "Minimum configuration for app_typeSensitiveDataType",
14682
15172
  "required_fields": [],
@@ -14702,6 +15192,8 @@
14702
15192
  "$ref": "#/components/schemas/graphMetricData"
14703
15193
  },
14704
15194
  "x-displayname": "Data",
15195
+ "x-f5xc-example": "{\"key\": \"value\"}",
15196
+ "x-f5xc-description-short": "List of metric specified in the request for an edge.",
14705
15197
  "x-f5xc-required-for": {
14706
15198
  "minimum_config": false,
14707
15199
  "create": false,
@@ -14710,6 +15202,7 @@
14710
15202
  }
14711
15203
  }
14712
15204
  },
15205
+ "x-f5xc-description-short": "EdgeMetricData contains requested metric data for an edge.",
14713
15206
  "x-f5xc-minimum-configuration": {
14714
15207
  "description": "Minimum configuration for graphEdgeMetricData",
14715
15208
  "required_fields": [
@@ -14737,6 +15230,8 @@
14737
15230
  "$ref": "#/components/schemas/timeseriesTimeseriesFeature"
14738
15231
  },
14739
15232
  "x-displayname": "Features",
15233
+ "x-f5xc-example": "True",
15234
+ "x-f5xc-description-short": "Specify list of timeseries features that should be returned for each metric type in the request.",
14740
15235
  "x-f5xc-required-for": {
14741
15236
  "minimum_config": false,
14742
15237
  "create": false,
@@ -14752,6 +15247,7 @@
14752
15247
  "$ref": "#/components/schemas/schemagraphMetricType"
14753
15248
  },
14754
15249
  "x-displayname": "Types",
15250
+ "x-f5xc-description-short": "Specify list of metrics that should be returned for each edge in the connectivity graph.",
14755
15251
  "x-f5xc-required-for": {
14756
15252
  "minimum_config": false,
14757
15253
  "create": false,
@@ -14760,6 +15256,7 @@
14760
15256
  }
14761
15257
  }
14762
15258
  },
15259
+ "x-f5xc-description-short": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.",
14763
15260
  "x-f5xc-minimum-configuration": {
14764
15261
  "description": "Minimum configuration for graphEdgeMetricSelector",
14765
15262
  "required_fields": [
@@ -14790,6 +15287,7 @@
14790
15287
  "$ref": "#/components/schemas/graphMetricFeatureData"
14791
15288
  }
14792
15289
  },
15290
+ "x-f5xc-description-short": "MetricData contains the metric type and the corresponding metric value(s).",
14793
15291
  "x-f5xc-minimum-configuration": {
14794
15292
  "description": "Minimum configuration for graphMetricData",
14795
15293
  "required_fields": [
@@ -14819,6 +15317,7 @@
14819
15317
  "$ref": "#/components/schemas/graphMetricData"
14820
15318
  },
14821
15319
  "x-displayname": "Downstream.",
15320
+ "x-f5xc-description-short": "Metric data for the source site/service.",
14822
15321
  "x-f5xc-required-for": {
14823
15322
  "minimum_config": false,
14824
15323
  "create": false,
@@ -14834,6 +15333,8 @@
14834
15333
  "$ref": "#/components/schemas/graphMetricData"
14835
15334
  },
14836
15335
  "x-displayname": "Upstream",
15336
+ "x-f5xc-example": "{\"key\": \"value\"}",
15337
+ "x-f5xc-description-short": "Metric data for the destination site/service.",
14837
15338
  "x-f5xc-required-for": {
14838
15339
  "minimum_config": false,
14839
15340
  "create": false,
@@ -14842,6 +15343,7 @@
14842
15343
  }
14843
15344
  }
14844
15345
  },
15346
+ "x-f5xc-description-short": "NodeMetricData contains the upstream and downstream metrics for a node.",
14845
15347
  "x-f5xc-minimum-configuration": {
14846
15348
  "description": "Minimum configuration for graphNodeMetricData",
14847
15349
  "required_fields": [
@@ -14876,6 +15378,7 @@
14876
15378
  "x-validation-rules": {
14877
15379
  "ves.io.schema.rules.repeated.unique": "true"
14878
15380
  },
15381
+ "x-f5xc-description-short": "Downstream refers to the service that sends requests and receives response.",
14879
15382
  "x-f5xc-required-for": {
14880
15383
  "minimum_config": false,
14881
15384
  "create": false,
@@ -14891,6 +15394,8 @@
14891
15394
  "$ref": "#/components/schemas/timeseriesTimeseriesFeature"
14892
15395
  },
14893
15396
  "x-displayname": "Features",
15397
+ "x-f5xc-example": "True",
15398
+ "x-f5xc-description-short": "Specify list of timeseries features that should be returned for each metric type in the request.",
14894
15399
  "x-f5xc-required-for": {
14895
15400
  "minimum_config": false,
14896
15401
  "create": false,
@@ -14912,6 +15417,8 @@
14912
15417
  "x-validation-rules": {
14913
15418
  "ves.io.schema.rules.repeated.unique": "true"
14914
15419
  },
15420
+ "x-f5xc-example": "{\"key\": \"value\"}",
15421
+ "x-f5xc-description-short": "Upstream refers to the service that receives requests and sends response.",
14915
15422
  "x-f5xc-required-for": {
14916
15423
  "minimum_config": false,
14917
15424
  "create": false,
@@ -14920,6 +15427,7 @@
14920
15427
  }
14921
15428
  }
14922
15429
  },
15430
+ "x-f5xc-description-short": "NodeMetricSelector is used to select the metrics that should be returned for a node.",
14923
15431
  "x-f5xc-minimum-configuration": {
14924
15432
  "description": "Minimum configuration for graphNodeMetricSelector",
14925
15433
  "required_fields": [
@@ -14951,6 +15459,8 @@
14951
15459
  "default": "LABEL_NONE",
14952
15460
  "x-displayname": "Label",
14953
15461
  "x-ves-proto-enum": "ves.io.schema.graph.service.Label",
15462
+ "x-f5xc-description-short": "Metrics used to construct the service graph are tagged with these labels and therefore the service metrics can be sliced and diced based on one or...",
15463
+ "x-f5xc-description-medium": "Metrics used to construct the service graph are tagged with these labels and therefore the service metrics can be sliced and diced based on one or more of these labels. Indicates the field not being set Identifies the source or destination site Identifies the application type associated with the...",
14954
15464
  "x-f5xc-minimum-configuration": {
14955
15465
  "description": "Minimum configuration for graphserviceLabel",
14956
15466
  "required_fields": [],
@@ -14975,6 +15485,7 @@
14975
15485
  "x-displayname": "App Type",
14976
15486
  "x-ves-example": "Example-app.",
14977
15487
  "x-f5xc-example": "example-app",
15488
+ "x-f5xc-description-short": "Identifies the application type associated with the service instance.",
14978
15489
  "minLength": 0,
14979
15490
  "maxLength": 1024,
14980
15491
  "x-f5xc-required-for": {
@@ -15007,6 +15518,7 @@
15007
15518
  "x-displayname": "Namespace",
15008
15519
  "x-ves-example": "Staging",
15009
15520
  "x-f5xc-example": "staging",
15521
+ "x-f5xc-description-short": "Identifies the workspace where the service instance is deployed.",
15010
15522
  "minLength": 0,
15011
15523
  "maxLength": 6,
15012
15524
  "x-f5xc-required-for": {
@@ -15017,7 +15529,7 @@
15017
15529
  },
15018
15530
  "x-original-maxLength": 1024,
15019
15531
  "x-reconciled-from-discovery": true,
15020
- "x-reconciled-at": "2026-01-05T18:29:51.947231+00:00"
15532
+ "x-reconciled-at": "2026-01-07T15:29:18.744479+00:00"
15021
15533
  },
15022
15534
  "service": {
15023
15535
  "type": "string",
@@ -15026,6 +15538,7 @@
15026
15538
  "x-displayname": "Service",
15027
15539
  "x-ves-example": "`N:public` or `S:productpage`",
15028
15540
  "x-f5xc-example": "`N:public` or `S:productpage`",
15541
+ "x-f5xc-description-short": "Identifies the source or destination service.",
15029
15542
  "minLength": 0,
15030
15543
  "maxLength": 1024,
15031
15544
  "x-f5xc-required-for": {
@@ -15042,6 +15555,7 @@
15042
15555
  "x-displayname": "Site",
15043
15556
  "x-ves-example": "Ce01",
15044
15557
  "x-f5xc-example": "ce01",
15558
+ "x-f5xc-description-short": "Identifies the site, where the service instance is deployed.",
15045
15559
  "minLength": 0,
15046
15560
  "maxLength": 1024,
15047
15561
  "x-f5xc-required-for": {
@@ -15068,6 +15582,7 @@
15068
15582
  }
15069
15583
  }
15070
15584
  },
15585
+ "x-f5xc-description-short": "Instance ID uniquely identifies a service instance.",
15071
15586
  "x-f5xc-minimum-configuration": {
15072
15587
  "description": "Minimum configuration for instanceInstanceId",
15073
15588
  "required_fields": [
@@ -15101,6 +15616,8 @@
15101
15616
  "default": "NONE",
15102
15617
  "x-displayname": "InstanceId Field.",
15103
15618
  "x-ves-proto-enum": "ves.io.schema.graph.service.instance.InstanceIdField",
15619
+ "x-f5xc-description-short": "InstanceId Field is used to select one or more fields that uniquely identifies an instance or a set of instances.",
15620
+ "x-f5xc-description-medium": "InstanceId Field is used to select one or more fields that uniquely identifies an instance or a set of instances. Indicates the field not being set Identifies the workspace where the service is deployed Identifies the source or destination site Identifies the application type associated with the...",
15104
15621
  "x-f5xc-minimum-configuration": {
15105
15622
  "description": "Minimum configuration for instanceInstanceIdField",
15106
15623
  "required_fields": [],
@@ -15132,6 +15649,7 @@
15132
15649
  "x-validation-rules": {
15133
15650
  "ves.io.schema.rules.message.required": "true"
15134
15651
  },
15652
+ "x-f5xc-description-short": "Application type associated with the service instance Required: YES.",
15135
15653
  "minLength": 0,
15136
15654
  "maxLength": 1024,
15137
15655
  "x-f5xc-required-for": {
@@ -15155,6 +15673,7 @@
15155
15673
  "x-validation-rules": {
15156
15674
  "ves.io.schema.rules.message.required": "true"
15157
15675
  },
15676
+ "x-f5xc-description-short": "Name of the service instance Required: YES.",
15158
15677
  "minLength": 0,
15159
15678
  "maxLength": 1024,
15160
15679
  "x-f5xc-required-for": {
@@ -15178,6 +15697,7 @@
15178
15697
  "x-validation-rules": {
15179
15698
  "ves.io.schema.rules.message.required": "true"
15180
15699
  },
15700
+ "x-f5xc-description-short": "Network name or name of the virtual service Required: YES.",
15181
15701
  "minLength": 0,
15182
15702
  "maxLength": 1024,
15183
15703
  "x-f5xc-required-for": {
@@ -15194,6 +15714,7 @@
15194
15714
  "x-displayname": "Site",
15195
15715
  "x-ves-example": "Ce01",
15196
15716
  "x-f5xc-example": "ce01",
15717
+ "x-f5xc-description-short": "Site name where the service instance is running.",
15197
15718
  "minLength": 0,
15198
15719
  "maxLength": 1024,
15199
15720
  "x-f5xc-required-for": {
@@ -15217,6 +15738,7 @@
15217
15738
  "x-validation-rules": {
15218
15739
  "ves.io.schema.rules.message.required": "true"
15219
15740
  },
15741
+ "x-f5xc-description-short": "Virtual host associated with the service instance Required: YES.",
15220
15742
  "minLength": 0,
15221
15743
  "maxLength": 1024,
15222
15744
  "x-f5xc-required-for": {
@@ -15227,6 +15749,7 @@
15227
15749
  }
15228
15750
  }
15229
15751
  },
15752
+ "x-f5xc-description-short": "Instance request ID to fetch metric from a specific service instance.",
15230
15753
  "x-f5xc-minimum-configuration": {
15231
15754
  "description": "Minimum configuration for instanceInstanceRequestId",
15232
15755
  "required_fields": [
@@ -15285,6 +15808,8 @@
15285
15808
  "default": "METRIC_TYPE_NONE",
15286
15809
  "x-displayname": "Metric Type.",
15287
15810
  "x-ves-proto-enum": "ves.io.schema.graph.MetricType",
15811
+ "x-f5xc-description-short": "List of metric types that are supported for application site and service graph Indicates field not being set x-unit: \"per second\" Number of...",
15812
+ "x-f5xc-description-medium": "List of metric types that are supported for application site and service graph Indicates field not being set x-unit: \"per second\" Number of requests per second Deprecated by HTTP_REQUEST_RATE, TCP_CONNECTION_RATE x-unit: \"per second\" Number of errors per second Deprecated by HTTP_ERROR_RATE...",
15288
15813
  "x-f5xc-minimum-configuration": {
15289
15814
  "description": "Minimum configuration for schemagraphMetricType",
15290
15815
  "required_fields": [],
@@ -15312,6 +15837,7 @@
15312
15837
  "x-displayname": "App Types",
15313
15838
  "x-ves-example": "Value",
15314
15839
  "x-f5xc-example": "value",
15840
+ "x-f5xc-description-short": "List of app types running in the given namespace.",
15315
15841
  "x-f5xc-required-for": {
15316
15842
  "minimum_config": false,
15317
15843
  "create": false,
@@ -15326,6 +15852,7 @@
15326
15852
  "x-displayname": "Namespace",
15327
15853
  "x-ves-example": "Ns1",
15328
15854
  "x-f5xc-example": "ns1",
15855
+ "x-f5xc-description-short": "Workspace where the applications are deployed.",
15329
15856
  "minLength": 0,
15330
15857
  "maxLength": 6,
15331
15858
  "x-f5xc-required-for": {
@@ -15336,9 +15863,10 @@
15336
15863
  },
15337
15864
  "x-original-maxLength": 1024,
15338
15865
  "x-reconciled-from-discovery": true,
15339
- "x-reconciled-at": "2026-01-05T18:29:51.947271+00:00"
15866
+ "x-reconciled-at": "2026-01-07T15:29:18.744530+00:00"
15340
15867
  }
15341
15868
  },
15869
+ "x-f5xc-description-short": "List of application types for a namespace.",
15342
15870
  "x-f5xc-minimum-configuration": {
15343
15871
  "description": "Minimum configuration for serviceAppTypeInfo",
15344
15872
  "required_fields": [
@@ -15367,6 +15895,7 @@
15367
15895
  "$ref": "#/components/schemas/serviceAppTypeInfo"
15368
15896
  },
15369
15897
  "x-displayname": "Data",
15898
+ "x-f5xc-example": "{\"key\": \"value\"}",
15370
15899
  "x-f5xc-required-for": {
15371
15900
  "minimum_config": false,
15372
15901
  "create": false,
@@ -15375,6 +15904,8 @@
15375
15904
  }
15376
15905
  }
15377
15906
  },
15907
+ "x-f5xc-description-short": "Response for graph/service/app_types API that returns the list of app_types scoped by namespace in the request.",
15908
+ "x-f5xc-description-medium": "Response for graph/service/app_types API that returns the list of app_types scoped by namespace in the request. For system namespace, the response will contain the list of app types for all namespaces.",
15378
15909
  "x-f5xc-minimum-configuration": {
15379
15910
  "description": "Minimum configuration for serviceAppTypeListResponse",
15380
15911
  "required_fields": [
@@ -15405,6 +15936,7 @@
15405
15936
  "$ref": "#/components/schemas/serviceCdnMetricData"
15406
15937
  },
15407
15938
  "x-displayname": "Metric",
15939
+ "x-f5xc-description-short": "List of metric specified in the request for a load balancer.",
15408
15940
  "x-f5xc-required-for": {
15409
15941
  "minimum_config": false,
15410
15942
  "create": false,
@@ -15413,6 +15945,7 @@
15413
15945
  }
15414
15946
  }
15415
15947
  },
15948
+ "x-f5xc-description-short": "Cacheable Content Data wraps all the response data for a load balancer.",
15416
15949
  "x-f5xc-minimum-configuration": {
15417
15950
  "description": "Minimum configuration for serviceCacheableData",
15418
15951
  "required_fields": [
@@ -15456,9 +15989,10 @@
15456
15989
  "maxLength": 15,
15457
15990
  "minLength": 3,
15458
15991
  "x-reconciled-from-discovery": true,
15459
- "x-reconciled-at": "2026-01-05T18:29:51.947284+00:00"
15992
+ "x-reconciled-at": "2026-01-07T15:29:18.744543+00:00"
15460
15993
  }
15461
15994
  },
15995
+ "x-f5xc-description-short": "CdnMetricData contains the metric type and the corresponding metric value(s).",
15462
15996
  "x-f5xc-minimum-configuration": {
15463
15997
  "description": "Minimum configuration for serviceCdnMetricData",
15464
15998
  "required_fields": [
@@ -15487,6 +16021,8 @@
15487
16021
  "$ref": "#/components/schemas/app_typeAPIEPPDFInfo"
15488
16022
  }
15489
16023
  },
16024
+ "x-f5xc-description-short": "Details about the discovered API Endpoints between services. Each discovered Endpoint has a collapsed URL and the associated method.",
16025
+ "x-f5xc-description-medium": "Details about the discovered API Endpoints between services. Each discovered Endpoint has a collapsed URL and the associated method. Probablity Density Function of request size, response size and latency per API Endpoint is also returned.",
15490
16026
  "x-f5xc-minimum-configuration": {
15491
16027
  "description": "Minimum configuration for serviceEdgeAPIEPData",
15492
16028
  "required_fields": [
@@ -15533,6 +16069,7 @@
15533
16069
  "$ref": "#/components/schemas/serviceId"
15534
16070
  }
15535
16071
  },
16072
+ "x-f5xc-description-short": "EdgeData wraps all the response data for an edge in the site graph response.",
15536
16073
  "x-f5xc-minimum-configuration": {
15537
16074
  "description": "Minimum configuration for serviceEdgeData",
15538
16075
  "required_fields": [
@@ -15562,6 +16099,8 @@
15562
16099
  "$ref": "#/components/schemas/serviceEdgeAPIEPData"
15563
16100
  },
15564
16101
  "x-displayname": "API Endpoints.",
16102
+ "x-f5xc-example": "{\"key\": \"value\"}",
16103
+ "x-f5xc-description-short": "Discovered API Endpoints between two services.",
15565
16104
  "x-f5xc-required-for": {
15566
16105
  "minimum_config": false,
15567
16106
  "create": false,
@@ -15576,6 +16115,7 @@
15576
16115
  "$ref": "#/components/schemas/graphEdgeMetricData"
15577
16116
  }
15578
16117
  },
16118
+ "x-f5xc-description-short": "EdgeFieldData wraps all the metric and the healthscore data for an edge.",
15579
16119
  "x-f5xc-minimum-configuration": {
15580
16120
  "description": "Minimum configuration for serviceEdgeFieldData",
15581
16121
  "required_fields": [
@@ -15607,6 +16147,8 @@
15607
16147
  "$ref": "#/components/schemas/graphEdgeMetricSelector"
15608
16148
  }
15609
16149
  },
16150
+ "x-f5xc-description-short": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
16151
+ "x-f5xc-description-medium": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.",
15610
16152
  "x-f5xc-minimum-configuration": {
15611
16153
  "description": "Minimum configuration for serviceEdgeFieldSelector",
15612
16154
  "required_fields": [
@@ -15644,6 +16186,8 @@
15644
16186
  "x-validation-rules": {
15645
16187
  "ves.io.schema.rules.string.query_time": "true"
15646
16188
  },
16189
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
16190
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
15647
16191
  "minLength": 0,
15648
16192
  "maxLength": 1024,
15649
16193
  "x-f5xc-required-for": {
@@ -15663,6 +16207,7 @@
15663
16207
  "x-displayname": "Namespace",
15664
16208
  "x-ves-example": "Value",
15665
16209
  "x-f5xc-example": "value",
16210
+ "x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.",
15666
16211
  "minLength": 0,
15667
16212
  "maxLength": 6,
15668
16213
  "x-f5xc-required-for": {
@@ -15673,7 +16218,7 @@
15673
16218
  },
15674
16219
  "x-original-maxLength": 1024,
15675
16220
  "x-reconciled-from-discovery": true,
15676
- "x-reconciled-at": "2026-01-05T18:29:51.947306+00:00"
16221
+ "x-reconciled-at": "2026-01-07T15:29:18.744565+00:00"
15677
16222
  },
15678
16223
  "range": {
15679
16224
  "type": "string",
@@ -15688,6 +16233,8 @@
15688
16233
  "x-validation-rules": {
15689
16234
  "ves.io.schema.rules.string.time_interval": "true"
15690
16235
  },
16236
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
16237
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
15691
16238
  "minLength": 0,
15692
16239
  "maxLength": 1024,
15693
16240
  "x-f5xc-required-for": {
@@ -15713,6 +16260,8 @@
15713
16260
  "x-validation-rules": {
15714
16261
  "ves.io.schema.rules.string.query_time": "true"
15715
16262
  },
16263
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
16264
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
15716
16265
  "minLength": 0,
15717
16266
  "maxLength": 1024,
15718
16267
  "x-f5xc-required-for": {
@@ -15735,6 +16284,8 @@
15735
16284
  "x-validation-rules": {
15736
16285
  "ves.io.schema.rules.string.query_step": "true"
15737
16286
  },
16287
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
16288
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
15738
16289
  "minLength": 0,
15739
16290
  "maxLength": 1024,
15740
16291
  "x-f5xc-required-for": {
@@ -15745,6 +16296,8 @@
15745
16296
  }
15746
16297
  }
15747
16298
  },
16299
+ "x-f5xc-description-short": "While graph/service API is used to GET the service mesh for an app_type, where each node and edge contains the aggregated value for each field...",
16300
+ "x-f5xc-description-medium": "While graph/service API is used to GET the service mesh for an app_type, where each node and edge contains the aggregated value for each field; graph/service/edge API is used to GET the time-series data (drill-down of aggregated data) for each field.",
15748
16301
  "x-f5xc-minimum-configuration": {
15749
16302
  "description": "Minimum configuration for serviceEdgeRequest",
15750
16303
  "required_fields": [
@@ -15787,6 +16340,8 @@
15787
16340
  "x-validation-rules": {
15788
16341
  "ves.io.schema.rules.string.time_interval": "true"
15789
16342
  },
16343
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
16344
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
15790
16345
  "minLength": 0,
15791
16346
  "maxLength": 1024,
15792
16347
  "x-f5xc-required-for": {
@@ -15797,6 +16352,8 @@
15797
16352
  }
15798
16353
  }
15799
16354
  },
16355
+ "x-f5xc-description-short": "Response for graph/service/edge API returns the time-series data for the service edge specified in the request.",
16356
+ "x-f5xc-description-medium": "Response for graph/service/edge API returns the time-series data for the service edge specified in the request.",
15800
16357
  "x-f5xc-minimum-configuration": {
15801
16358
  "description": "Minimum configuration for serviceEdgeResponse",
15802
16359
  "required_fields": [
@@ -15824,6 +16381,7 @@
15824
16381
  "$ref": "#/components/schemas/serviceNodeFieldSelector"
15825
16382
  }
15826
16383
  },
16384
+ "x-f5xc-description-short": "FieldSelector is used to specify the list of fields to be returned in the response for site graph.",
15827
16385
  "x-f5xc-minimum-configuration": {
15828
16386
  "description": "Minimum configuration for serviceFieldSelector",
15829
16387
  "required_fields": [
@@ -15852,6 +16410,8 @@
15852
16410
  "$ref": "#/components/schemas/serviceEdgeData"
15853
16411
  },
15854
16412
  "x-displayname": "Edges",
16413
+ "x-f5xc-description-short": "List of edges in the service graph. Each edge contains the application traffic flowing from/to the source service and the destination service.",
16414
+ "x-f5xc-description-medium": "List of edges in the service graph. Each edge contains the application traffic flowing from/to the source service and the destination service.",
15855
16415
  "x-f5xc-required-for": {
15856
16416
  "minimum_config": false,
15857
16417
  "create": false,
@@ -15867,6 +16427,8 @@
15867
16427
  "$ref": "#/components/schemas/serviceNodeData"
15868
16428
  },
15869
16429
  "x-displayname": "Nodes",
16430
+ "x-f5xc-description-short": "List of nodes in the service graph. Each node contains the application traffic flowing from/to the service.",
16431
+ "x-f5xc-description-medium": "List of nodes in the service graph. Each node contains the application traffic flowing from/to the service.",
15870
16432
  "x-f5xc-required-for": {
15871
16433
  "minimum_config": false,
15872
16434
  "create": false,
@@ -15875,6 +16437,8 @@
15875
16437
  }
15876
16438
  }
15877
16439
  },
16440
+ "x-f5xc-description-short": "GraphData wraps the response for the service graph request that contains all the nodes and the edges.",
16441
+ "x-f5xc-description-medium": "GraphData wraps the response for the service graph request that contains all the nodes and the edges. Each node contains the application traffic flowing from/to service and each edge contains the application traffic flowing from/to the source service and the destination service.",
15878
16442
  "x-f5xc-minimum-configuration": {
15879
16443
  "description": "Minimum configuration for serviceGraphData",
15880
16444
  "required_fields": [
@@ -15902,6 +16466,7 @@
15902
16466
  "x-displayname": "App Type",
15903
16467
  "x-ves-example": "Example-app.",
15904
16468
  "x-f5xc-example": "example-app",
16469
+ "x-f5xc-description-short": "Identifies the application type associated with the virtual host.",
15905
16470
  "minLength": 0,
15906
16471
  "maxLength": 1024,
15907
16472
  "x-f5xc-required-for": {
@@ -15918,6 +16483,7 @@
15918
16483
  "x-displayname": "CACHEABILITY.",
15919
16484
  "x-ves-example": "Cacheability.",
15920
16485
  "x-f5xc-example": "Cacheability",
16486
+ "x-f5xc-description-short": "Identifies the Cacheability associated with the Virtual Host.",
15921
16487
  "minLength": 0,
15922
16488
  "maxLength": 1024,
15923
16489
  "x-f5xc-required-for": {
@@ -15934,6 +16500,7 @@
15934
16500
  "x-displayname": "Namespace",
15935
16501
  "x-ves-example": "Staging",
15936
16502
  "x-f5xc-example": "staging",
16503
+ "x-f5xc-description-short": "Identifies the workspace where the service is deployed.",
15937
16504
  "minLength": 0,
15938
16505
  "maxLength": 6,
15939
16506
  "x-f5xc-required-for": {
@@ -15944,7 +16511,7 @@
15944
16511
  },
15945
16512
  "x-original-maxLength": 1024,
15946
16513
  "x-reconciled-from-discovery": true,
15947
- "x-reconciled-at": "2026-01-05T18:29:51.947328+00:00"
16514
+ "x-reconciled-at": "2026-01-07T15:29:18.744587+00:00"
15948
16515
  },
15949
16516
  "service": {
15950
16517
  "type": "string",
@@ -15953,6 +16520,7 @@
15953
16520
  "x-displayname": "Service",
15954
16521
  "x-ves-example": "N:public or S:productpage.",
15955
16522
  "x-f5xc-example": "N:public or S:productpage",
16523
+ "x-f5xc-description-short": "Identifies the source or destination service.",
15956
16524
  "minLength": 0,
15957
16525
  "maxLength": 1024,
15958
16526
  "x-f5xc-required-for": {
@@ -15969,6 +16537,7 @@
15969
16537
  "x-displayname": "Site",
15970
16538
  "x-ves-example": "Ce01",
15971
16539
  "x-f5xc-example": "ce01",
16540
+ "x-f5xc-description-short": "Identifies the source or destination site.",
15972
16541
  "minLength": 0,
15973
16542
  "maxLength": 1024,
15974
16543
  "x-f5xc-required-for": {
@@ -16001,6 +16570,7 @@
16001
16570
  "x-displayname": "VIP",
16002
16571
  "x-ves-example": "192.168.1.1.",
16003
16572
  "x-f5xc-example": "192.168.1.1",
16573
+ "x-f5xc-description-short": "Identifies the VIP associated with the Virtual Host.",
16004
16574
  "minLength": 0,
16005
16575
  "maxLength": 1024,
16006
16576
  "x-f5xc-required-for": {
@@ -16027,6 +16597,7 @@
16027
16597
  }
16028
16598
  }
16029
16599
  },
16600
+ "x-f5xc-description-short": "ID uniquely identifies a node or an edge in the service graph.",
16030
16601
  "x-f5xc-minimum-configuration": {
16031
16602
  "description": "Minimum configuration for serviceId",
16032
16603
  "required_fields": [
@@ -16064,6 +16635,8 @@
16064
16635
  "default": "NONE",
16065
16636
  "x-displayname": "ID Field",
16066
16637
  "x-ves-proto-enum": "ves.io.schema.graph.service.IdField",
16638
+ "x-f5xc-description-short": "IdField is used to select one or more fields that uniquely identifies a node or an edge in the service graph.",
16639
+ "x-f5xc-description-medium": "IdField is used to select one or more fields that uniquely identifies a node or an edge in the service graph. Indicates the field not being set Identifies the workspace where the service is deployed Identifies the source or destination site Identifies the application type associated with the...",
16067
16640
  "x-f5xc-minimum-configuration": {
16068
16641
  "description": "Minimum configuration for serviceIdField",
16069
16642
  "required_fields": [],
@@ -16088,6 +16661,7 @@
16088
16661
  "$ref": "#/components/schemas/instanceInstanceId"
16089
16662
  }
16090
16663
  },
16664
+ "x-f5xc-description-short": "InstanceData wraps all the response data for an instance in the graph response.",
16091
16665
  "x-f5xc-minimum-configuration": {
16092
16666
  "description": "Minimum configuration for serviceInstanceData",
16093
16667
  "required_fields": [
@@ -16121,6 +16695,8 @@
16121
16695
  "x-validation-rules": {
16122
16696
  "ves.io.schema.rules.string.query_time": "true"
16123
16697
  },
16698
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
16699
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
16124
16700
  "minLength": 0,
16125
16701
  "maxLength": 1024,
16126
16702
  "x-f5xc-required-for": {
@@ -16143,6 +16719,7 @@
16143
16719
  "x-displayname": "Namespace",
16144
16720
  "x-ves-example": "Value",
16145
16721
  "x-f5xc-example": "value",
16722
+ "x-f5xc-description-short": "Namespace is used to scope application traffic to a given namespace.",
16146
16723
  "minLength": 0,
16147
16724
  "maxLength": 6,
16148
16725
  "x-f5xc-required-for": {
@@ -16153,7 +16730,7 @@
16153
16730
  },
16154
16731
  "x-original-maxLength": 1024,
16155
16732
  "x-reconciled-from-discovery": true,
16156
- "x-reconciled-at": "2026-01-05T18:29:51.947346+00:00"
16733
+ "x-reconciled-at": "2026-01-07T15:29:18.744605+00:00"
16157
16734
  },
16158
16735
  "range": {
16159
16736
  "type": "string",
@@ -16168,6 +16745,8 @@
16168
16745
  "x-validation-rules": {
16169
16746
  "ves.io.schema.rules.string.time_interval": "true"
16170
16747
  },
16748
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
16749
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
16171
16750
  "minLength": 0,
16172
16751
  "maxLength": 1024,
16173
16752
  "x-f5xc-required-for": {
@@ -16190,6 +16769,8 @@
16190
16769
  "x-validation-rules": {
16191
16770
  "ves.io.schema.rules.string.query_time": "true"
16192
16771
  },
16772
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
16773
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
16193
16774
  "minLength": 0,
16194
16775
  "maxLength": 1024,
16195
16776
  "x-f5xc-required-for": {
@@ -16212,6 +16793,8 @@
16212
16793
  "x-validation-rules": {
16213
16794
  "ves.io.schema.rules.string.query_step": "true"
16214
16795
  },
16796
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
16797
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
16215
16798
  "minLength": 0,
16216
16799
  "maxLength": 1024,
16217
16800
  "x-f5xc-required-for": {
@@ -16222,6 +16805,7 @@
16222
16805
  }
16223
16806
  }
16224
16807
  },
16808
+ "x-f5xc-description-short": "Request to GET the time-series data for an instance in the service node.",
16225
16809
  "x-f5xc-minimum-configuration": {
16226
16810
  "description": "Minimum configuration for serviceInstanceRequest",
16227
16811
  "required_fields": [
@@ -16263,6 +16847,8 @@
16263
16847
  "x-validation-rules": {
16264
16848
  "ves.io.schema.rules.string.time_interval": "true"
16265
16849
  },
16850
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
16851
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
16266
16852
  "minLength": 0,
16267
16853
  "maxLength": 1024,
16268
16854
  "x-f5xc-required-for": {
@@ -16273,6 +16859,8 @@
16273
16859
  }
16274
16860
  }
16275
16861
  },
16862
+ "x-f5xc-description-short": "Response for graph/service/node/instance API that returns the time-series data for a service instance specified in the request.",
16863
+ "x-f5xc-description-medium": "Response for graph/service/node/instance API that returns the time-series data for a service instance specified in the request.",
16276
16864
  "x-f5xc-minimum-configuration": {
16277
16865
  "description": "Minimum configuration for serviceInstanceResponse",
16278
16866
  "required_fields": [
@@ -16309,6 +16897,7 @@
16309
16897
  }
16310
16898
  }
16311
16899
  },
16900
+ "x-f5xc-description-short": "List of service instances that matched the request.",
16312
16901
  "x-f5xc-minimum-configuration": {
16313
16902
  "description": "Minimum configuration for serviceInstancesData",
16314
16903
  "required_fields": [
@@ -16341,6 +16930,8 @@
16341
16930
  "x-validation-rules": {
16342
16931
  "ves.io.schema.rules.string.query_time": "true"
16343
16932
  },
16933
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
16934
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
16344
16935
  "minLength": 0,
16345
16936
  "maxLength": 1024,
16346
16937
  "x-f5xc-required-for": {
@@ -16361,6 +16952,8 @@
16361
16952
  "$ref": "#/components/schemas/instanceInstanceIdField"
16362
16953
  },
16363
16954
  "x-displayname": "Group By",
16955
+ "x-f5xc-description-short": "Aggregate data by any or all of NAMESPACE, SITE, APP_TYPE, SERVICE, INSTANCE and VIRTUAL_HOST Optional: If not specified, then the data is...",
16956
+ "x-f5xc-description-medium": "Aggregate data by any or all of NAMESPACE, SITE, APP_TYPE, SERVICE, INSTANCE and VIRTUAL_HOST Optional: If not specified, then the data is aggregated/grouped by all fields.",
16364
16957
  "x-f5xc-required-for": {
16365
16958
  "minimum_config": false,
16366
16959
  "create": false,
@@ -16376,6 +16969,8 @@
16376
16969
  "$ref": "#/components/schemas/serviceLabelFilter"
16377
16970
  },
16378
16971
  "x-displayname": "Label Filter.",
16972
+ "x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
16973
+ "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: To GET the instances for an (app_type, service), user should specify LABEL_APP_TYPE and LABEL_SERVICE in the...",
16379
16974
  "x-f5xc-required-for": {
16380
16975
  "minimum_config": false,
16381
16976
  "create": false,
@@ -16390,6 +16985,7 @@
16390
16985
  "x-displayname": "Namespace",
16391
16986
  "x-ves-example": "Value",
16392
16987
  "x-f5xc-example": "value",
16988
+ "x-f5xc-description-short": "Namespace is used to scope application traffic to a given namespace.",
16393
16989
  "minLength": 0,
16394
16990
  "maxLength": 6,
16395
16991
  "x-f5xc-required-for": {
@@ -16400,7 +16996,7 @@
16400
16996
  },
16401
16997
  "x-original-maxLength": 1024,
16402
16998
  "x-reconciled-from-discovery": true,
16403
- "x-reconciled-at": "2026-01-05T18:29:51.947364+00:00"
16999
+ "x-reconciled-at": "2026-01-07T15:29:18.744623+00:00"
16404
17000
  },
16405
17001
  "range": {
16406
17002
  "type": "string",
@@ -16415,6 +17011,8 @@
16415
17011
  "x-validation-rules": {
16416
17012
  "ves.io.schema.rules.string.time_interval": "true"
16417
17013
  },
17014
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
17015
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
16418
17016
  "minLength": 0,
16419
17017
  "maxLength": 1024,
16420
17018
  "x-f5xc-required-for": {
@@ -16437,6 +17035,8 @@
16437
17035
  "x-validation-rules": {
16438
17036
  "ves.io.schema.rules.string.query_time": "true"
16439
17037
  },
17038
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
17039
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
16440
17040
  "minLength": 0,
16441
17041
  "maxLength": 1024,
16442
17042
  "x-f5xc-required-for": {
@@ -16459,6 +17059,8 @@
16459
17059
  "x-validation-rules": {
16460
17060
  "ves.io.schema.rules.string.query_step": "true"
16461
17061
  },
17062
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
17063
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
16462
17064
  "minLength": 0,
16463
17065
  "maxLength": 1024,
16464
17066
  "x-f5xc-required-for": {
@@ -16469,6 +17071,7 @@
16469
17071
  }
16470
17072
  }
16471
17073
  },
17074
+ "x-f5xc-description-short": "Request to GET instances data for a node in the service graph.",
16472
17075
  "x-f5xc-minimum-configuration": {
16473
17076
  "description": "Minimum configuration for serviceInstancesRequest",
16474
17077
  "required_fields": [
@@ -16511,6 +17114,8 @@
16511
17114
  "x-validation-rules": {
16512
17115
  "ves.io.schema.rules.string.time_interval": "true"
16513
17116
  },
17117
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
17118
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
16514
17119
  "minLength": 0,
16515
17120
  "maxLength": 1024,
16516
17121
  "x-f5xc-required-for": {
@@ -16521,6 +17126,8 @@
16521
17126
  }
16522
17127
  }
16523
17128
  },
17129
+ "x-f5xc-description-short": "Response for graph/service/node/instances API that returns the instances data for a node in the service graph.",
17130
+ "x-f5xc-description-medium": "Response for graph/service/node/instances API that returns the instances data for a node in the service graph.",
16524
17131
  "x-f5xc-minimum-configuration": {
16525
17132
  "description": "Minimum configuration for serviceInstancesResponse",
16526
17133
  "required_fields": [
@@ -16554,6 +17161,8 @@
16554
17161
  "x-validation-rules": {
16555
17162
  "ves.io.schema.rules.string.query_time": "true"
16556
17163
  },
17164
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
17165
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
16557
17166
  "minLength": 0,
16558
17167
  "maxLength": 1024,
16559
17168
  "x-f5xc-required-for": {
@@ -16577,6 +17186,8 @@
16577
17186
  "x-validation-rules": {
16578
17187
  "ves.io.schema.rules.enum.in": "[1,5]"
16579
17188
  },
17189
+ "x-f5xc-description-short": "Select fields to be returned in the response. Optional: If not specified, only the following fields are returned in the response.",
17190
+ "x-f5xc-description-medium": "Select fields to be returned in the response. Optional: If not specified, only the following fields are returned in the response. REQUEST_RATE, RESPONSE_THROUGHPUT.",
16580
17191
  "x-f5xc-required-for": {
16581
17192
  "minimum_config": false,
16582
17193
  "create": false,
@@ -16601,6 +17212,8 @@
16601
17212
  "ves.io.schema.rules.repeated.max_items": "4",
16602
17213
  "ves.io.schema.rules.repeated.unique": "true"
16603
17214
  },
17215
+ "x-f5xc-description-short": "Aggregate data by any or all of namespace, cacheability, vhost. Optional: If not specified, then the data is aggregated/grouped by vh_name.",
17216
+ "x-f5xc-description-medium": "Aggregate data by any or all of namespace, cacheability, vhost. Optional: If not specified, then the data is aggregated/grouped by vh_name.",
16604
17217
  "x-f5xc-required-for": {
16605
17218
  "minimum_config": false,
16606
17219
  "create": false,
@@ -16631,6 +17244,8 @@
16631
17244
  "ves.io.schema.rules.repeated.min_items": "1",
16632
17245
  "ves.io.schema.rules.repeated.unique": "true"
16633
17246
  },
17247
+ "x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
17248
+ "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. For cacheable content, user should specify LABEL_VHOST_CACHE & LABEL_VHOST in the label_filter Required: YES.",
16634
17249
  "x-f5xc-required-for": {
16635
17250
  "minimum_config": false,
16636
17251
  "create": false,
@@ -16645,6 +17260,7 @@
16645
17260
  "x-displayname": "Namespace",
16646
17261
  "x-ves-example": "Value",
16647
17262
  "x-f5xc-example": "value",
17263
+ "x-f5xc-description-short": "Namespace is used to scope load balancers. Only LB's in given namespace will be considered.",
16648
17264
  "minLength": 0,
16649
17265
  "maxLength": 6,
16650
17266
  "x-f5xc-required-for": {
@@ -16655,7 +17271,7 @@
16655
17271
  },
16656
17272
  "x-original-maxLength": 1024,
16657
17273
  "x-reconciled-from-discovery": true,
16658
- "x-reconciled-at": "2026-01-05T18:29:51.947381+00:00"
17274
+ "x-reconciled-at": "2026-01-07T15:29:18.744641+00:00"
16659
17275
  },
16660
17276
  "start_time": {
16661
17277
  "type": "string",
@@ -16670,6 +17286,8 @@
16670
17286
  "x-validation-rules": {
16671
17287
  "ves.io.schema.rules.string.query_time": "true"
16672
17288
  },
17289
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
17290
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
16673
17291
  "minLength": 0,
16674
17292
  "maxLength": 1024,
16675
17293
  "x-f5xc-required-for": {
@@ -16692,6 +17310,8 @@
16692
17310
  "x-validation-rules": {
16693
17311
  "ves.io.schema.rules.string.query_step": "true"
16694
17312
  },
17313
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
17314
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
16695
17315
  "minLength": 0,
16696
17316
  "maxLength": 1024,
16697
17317
  "x-f5xc-required-for": {
@@ -16702,6 +17322,7 @@
16702
17322
  }
16703
17323
  }
16704
17324
  },
17325
+ "x-f5xc-description-short": "Graph/cacheable_content API is used to GET data for CDN services.",
16705
17326
  "x-f5xc-minimum-configuration": {
16706
17327
  "description": "Minimum configuration for serviceLBCacheContentRequest",
16707
17328
  "required_fields": [
@@ -16735,6 +17356,7 @@
16735
17356
  "$ref": "#/components/schemas/serviceCacheableData"
16736
17357
  },
16737
17358
  "x-displayname": "Nodes",
17359
+ "x-f5xc-description-short": "List of LB's in requested for Cacheable Content Data.",
16738
17360
  "x-f5xc-required-for": {
16739
17361
  "minimum_config": false,
16740
17362
  "create": false,
@@ -16755,6 +17377,8 @@
16755
17377
  "x-validation-rules": {
16756
17378
  "ves.io.schema.rules.string.time_interval": "true"
16757
17379
  },
17380
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
17381
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
16758
17382
  "minLength": 0,
16759
17383
  "maxLength": 1024,
16760
17384
  "x-f5xc-required-for": {
@@ -16765,6 +17389,7 @@
16765
17389
  }
16766
17390
  }
16767
17391
  },
17392
+ "x-f5xc-description-short": "Response for graph/cacheable_content request contains a list of nodes.",
16768
17393
  "x-f5xc-minimum-configuration": {
16769
17394
  "description": "Minimum configuration for serviceLBCacheContentResponse",
16770
17395
  "required_fields": [
@@ -16808,9 +17433,11 @@
16808
17433
  },
16809
17434
  "x-original-maxLength": 1024,
16810
17435
  "x-reconciled-from-discovery": true,
16811
- "x-reconciled-at": "2026-01-05T18:29:51.947394+00:00"
17436
+ "x-reconciled-at": "2026-01-07T15:29:18.744653+00:00"
16812
17437
  }
16813
17438
  },
17439
+ "x-f5xc-description-short": "Metrics used to render the service graph are tagged with labels listed in the enum Label.",
17440
+ "x-f5xc-description-medium": "Metrics used to render the service graph are tagged with labels listed in the enum Label. Label Filter is used to filter the timeseries that match the specified label key/value and the operator.",
16814
17441
  "x-f5xc-minimum-configuration": {
16815
17442
  "description": "Minimum configuration for serviceLabelFilter",
16816
17443
  "required_fields": [
@@ -16839,6 +17466,7 @@
16839
17466
  "$ref": "#/components/schemas/serviceId"
16840
17467
  }
16841
17468
  },
17469
+ "x-f5xc-description-short": "NodeData wraps all the response data for a node in the site graph response.",
16842
17470
  "x-f5xc-minimum-configuration": {
16843
17471
  "description": "Minimum configuration for serviceNodeData",
16844
17472
  "required_fields": [
@@ -16866,6 +17494,7 @@
16866
17494
  "$ref": "#/components/schemas/graphNodeMetricData"
16867
17495
  }
16868
17496
  },
17497
+ "x-f5xc-description-short": "NodeFieldData wraps all the metric and the healthscore data for a node.",
16869
17498
  "x-f5xc-minimum-configuration": {
16870
17499
  "description": "Minimum configuration for serviceNodeFieldData",
16871
17500
  "required_fields": [
@@ -16893,6 +17522,8 @@
16893
17522
  "$ref": "#/components/schemas/graphNodeMetricSelector"
16894
17523
  }
16895
17524
  },
17525
+ "x-f5xc-description-short": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
17526
+ "x-f5xc-description-medium": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.",
16896
17527
  "x-f5xc-minimum-configuration": {
16897
17528
  "description": "Minimum configuration for serviceNodeFieldSelector",
16898
17529
  "required_fields": [
@@ -16926,6 +17557,8 @@
16926
17557
  "x-validation-rules": {
16927
17558
  "ves.io.schema.rules.string.query_time": "true"
16928
17559
  },
17560
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
17561
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
16929
17562
  "minLength": 0,
16930
17563
  "maxLength": 1024,
16931
17564
  "x-f5xc-required-for": {
@@ -16948,6 +17581,7 @@
16948
17581
  "x-displayname": "Namespace",
16949
17582
  "x-ves-example": "Value",
16950
17583
  "x-f5xc-example": "value",
17584
+ "x-f5xc-description-short": "Namespace is used to scope the application traffic to a given namespace.",
16951
17585
  "minLength": 0,
16952
17586
  "maxLength": 6,
16953
17587
  "x-f5xc-required-for": {
@@ -16958,7 +17592,7 @@
16958
17592
  },
16959
17593
  "x-original-maxLength": 1024,
16960
17594
  "x-reconciled-from-discovery": true,
16961
- "x-reconciled-at": "2026-01-05T18:29:51.947410+00:00"
17595
+ "x-reconciled-at": "2026-01-07T15:29:18.744669+00:00"
16962
17596
  },
16963
17597
  "range": {
16964
17598
  "type": "string",
@@ -16973,6 +17607,8 @@
16973
17607
  "x-validation-rules": {
16974
17608
  "ves.io.schema.rules.string.time_interval": "true"
16975
17609
  },
17610
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
17611
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
16976
17612
  "minLength": 0,
16977
17613
  "maxLength": 1024,
16978
17614
  "x-f5xc-required-for": {
@@ -16995,6 +17631,8 @@
16995
17631
  "x-validation-rules": {
16996
17632
  "ves.io.schema.rules.string.query_time": "true"
16997
17633
  },
17634
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
17635
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
16998
17636
  "minLength": 0,
16999
17637
  "maxLength": 1024,
17000
17638
  "x-f5xc-required-for": {
@@ -17017,6 +17655,8 @@
17017
17655
  "x-validation-rules": {
17018
17656
  "ves.io.schema.rules.string.query_step": "true"
17019
17657
  },
17658
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
17659
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
17020
17660
  "minLength": 0,
17021
17661
  "maxLength": 1024,
17022
17662
  "x-f5xc-required-for": {
@@ -17027,6 +17667,8 @@
17027
17667
  }
17028
17668
  }
17029
17669
  },
17670
+ "x-f5xc-description-short": "Request to GET time-series data for a node in the service graph.",
17671
+ "x-f5xc-description-medium": "Request to GET time-series data for a node in the service graph. While graph/service API is used to GET the service mesh for an app_type, where each node and edge contains the aggregated value for each field; graph/service/node API is used to GET the time-series data (drill-down of aggregated...",
17030
17672
  "x-f5xc-minimum-configuration": {
17031
17673
  "description": "Minimum configuration for serviceNodeRequest",
17032
17674
  "required_fields": [
@@ -17068,6 +17710,8 @@
17068
17710
  "x-validation-rules": {
17069
17711
  "ves.io.schema.rules.string.time_interval": "true"
17070
17712
  },
17713
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
17714
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
17071
17715
  "minLength": 0,
17072
17716
  "maxLength": 1024,
17073
17717
  "x-f5xc-required-for": {
@@ -17078,6 +17722,8 @@
17078
17722
  }
17079
17723
  }
17080
17724
  },
17725
+ "x-f5xc-description-short": "Response for graph/service/node request returns the time-series data for the service node specified in the request.",
17726
+ "x-f5xc-description-medium": "Response for graph/service/node request returns the time-series data for the service node specified in the request.",
17081
17727
  "x-f5xc-minimum-configuration": {
17082
17728
  "description": "Minimum configuration for serviceNodeResponse",
17083
17729
  "required_fields": [
@@ -17111,6 +17757,8 @@
17111
17757
  "x-validation-rules": {
17112
17758
  "ves.io.schema.rules.string.query_time": "true"
17113
17759
  },
17760
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
17761
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
17114
17762
  "minLength": 0,
17115
17763
  "maxLength": 1024,
17116
17764
  "x-f5xc-required-for": {
@@ -17131,6 +17779,8 @@
17131
17779
  "$ref": "#/components/schemas/serviceIdField"
17132
17780
  },
17133
17781
  "x-displayname": "Group By",
17782
+ "x-f5xc-description-short": "Aggregate data by any or all of namespace, site, service, app_type and vhost.",
17783
+ "x-f5xc-description-medium": "Aggregate data by any or all of namespace, site, service, app_type and vhost. Optional: If not specified, then the data is aggregated/grouped by namespace and service.",
17134
17784
  "x-f5xc-required-for": {
17135
17785
  "minimum_config": false,
17136
17786
  "create": false,
@@ -17145,6 +17795,7 @@
17145
17795
  "x-displayname": "Trend calculation requested by the user.",
17146
17796
  "x-ves-example": "True",
17147
17797
  "x-f5xc-example": "true",
17798
+ "x-f5xc-description-short": "Trend value computation requested by the user Optional: default is false.",
17148
17799
  "x-f5xc-required-for": {
17149
17800
  "minimum_config": false,
17150
17801
  "create": false,
@@ -17160,6 +17811,8 @@
17160
17811
  "$ref": "#/components/schemas/serviceLabelFilter"
17161
17812
  },
17162
17813
  "x-displayname": "Label Filter.",
17814
+ "x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".",
17815
+ "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: For service mesh graph, user should specify LABEL_APP_TYPE in the label_filter to avoid aggregation across all...",
17163
17816
  "x-f5xc-required-for": {
17164
17817
  "minimum_config": false,
17165
17818
  "create": false,
@@ -17174,6 +17827,8 @@
17174
17827
  "x-displayname": "Namespace",
17175
17828
  "x-ves-example": "Value",
17176
17829
  "x-f5xc-example": "value",
17830
+ "x-f5xc-description-short": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
17831
+ "x-f5xc-description-medium": "Namespace is used to scope service mesh. Only services and virtual_host in given namespace will be considered.",
17177
17832
  "minLength": 0,
17178
17833
  "maxLength": 6,
17179
17834
  "x-f5xc-required-for": {
@@ -17184,7 +17839,7 @@
17184
17839
  },
17185
17840
  "x-original-maxLength": 1024,
17186
17841
  "x-reconciled-from-discovery": true,
17187
- "x-reconciled-at": "2026-01-05T18:29:51.947428+00:00"
17842
+ "x-reconciled-at": "2026-01-07T15:29:18.744687+00:00"
17188
17843
  },
17189
17844
  "range": {
17190
17845
  "type": "string",
@@ -17199,6 +17854,8 @@
17199
17854
  "x-validation-rules": {
17200
17855
  "ves.io.schema.rules.string.time_interval": "true"
17201
17856
  },
17857
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
17858
+ "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
17202
17859
  "minLength": 0,
17203
17860
  "maxLength": 1024,
17204
17861
  "x-f5xc-required-for": {
@@ -17221,6 +17878,8 @@
17221
17878
  "x-validation-rules": {
17222
17879
  "ves.io.schema.rules.string.query_time": "true"
17223
17880
  },
17881
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
17882
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
17224
17883
  "minLength": 0,
17225
17884
  "maxLength": 1024,
17226
17885
  "x-f5xc-required-for": {
@@ -17243,6 +17902,8 @@
17243
17902
  "x-validation-rules": {
17244
17903
  "ves.io.schema.rules.string.query_step": "true"
17245
17904
  },
17905
+ "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
17906
+ "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
17246
17907
  "minLength": 0,
17247
17908
  "maxLength": 1024,
17248
17909
  "x-f5xc-required-for": {
@@ -17253,6 +17914,7 @@
17253
17914
  }
17254
17915
  }
17255
17916
  },
17917
+ "x-f5xc-description-short": "Graph/service API is used to GET service mesh graph of related services.",
17256
17918
  "x-f5xc-minimum-configuration": {
17257
17919
  "description": "Minimum configuration for serviceRequest",
17258
17920
  "required_fields": [
@@ -17296,6 +17958,8 @@
17296
17958
  "x-validation-rules": {
17297
17959
  "ves.io.schema.rules.string.time_interval": "true"
17298
17960
  },
17961
+ "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
17962
+ "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
17299
17963
  "minLength": 0,
17300
17964
  "maxLength": 1024,
17301
17965
  "x-f5xc-required-for": {
@@ -17306,6 +17970,8 @@
17306
17970
  }
17307
17971
  }
17308
17972
  },
17973
+ "x-f5xc-description-short": "Response for graph/service request contains a list of nodes and edges.",
17974
+ "x-f5xc-description-medium": "Response for graph/service request contains a list of nodes and edges. Each node represents unique combination of fields specified in group_by in the Request. Each node respresents a service, if the group_by field in the Request is empty.",
17309
17975
  "x-f5xc-minimum-configuration": {
17310
17976
  "description": "Minimum configuration for serviceResponse",
17311
17977
  "required_fields": [
@@ -17333,6 +17999,7 @@
17333
17999
  "x-displayname": "App Type",
17334
18000
  "x-ves-example": "Example-app.",
17335
18001
  "x-f5xc-example": "example-app",
18002
+ "x-f5xc-description-short": "Application type associated with the service.",
17336
18003
  "minLength": 0,
17337
18004
  "maxLength": 1024,
17338
18005
  "x-f5xc-required-for": {
@@ -17356,6 +18023,7 @@
17356
18023
  "x-validation-rules": {
17357
18024
  "ves.io.schema.rules.message.required": "true"
17358
18025
  },
18026
+ "x-f5xc-description-short": "Network name or name of the virtual service Required: YES.",
17359
18027
  "minLength": 0,
17360
18028
  "maxLength": 1024,
17361
18029
  "x-f5xc-required-for": {
@@ -17372,6 +18040,8 @@
17372
18040
  "x-displayname": "Site",
17373
18041
  "x-ves-example": "Ce01",
17374
18042
  "x-f5xc-example": "ce01",
18043
+ "x-f5xc-description-short": "Site name where the service is running. If the service is deployed in multiple sites, only the metric from this site will be returned in the response.",
18044
+ "x-f5xc-description-medium": "Site name where the service is running. If the service is deployed in multiple sites, only the metric from this site will be returned in the response.",
17375
18045
  "minLength": 0,
17376
18046
  "maxLength": 1024,
17377
18047
  "x-f5xc-required-for": {
@@ -17411,6 +18081,7 @@
17411
18081
  "x-validation-rules": {
17412
18082
  "ves.io.schema.rules.message.required": "true"
17413
18083
  },
18084
+ "x-f5xc-description-short": "Virtual host associated with the service Required: YES.",
17414
18085
  "minLength": 0,
17415
18086
  "maxLength": 1024,
17416
18087
  "x-f5xc-required-for": {
@@ -17421,6 +18092,7 @@
17421
18092
  }
17422
18093
  }
17423
18094
  },
18095
+ "x-f5xc-description-short": "Service request ID to fetch metric for a specific service.",
17424
18096
  "x-f5xc-minimum-configuration": {
17425
18097
  "description": "Minimum configuration for serviceServiceRequestId",
17426
18098
  "required_fields": [
@@ -17452,6 +18124,7 @@
17452
18124
  "$ref": "#/components/schemas/schemaConditionType"
17453
18125
  },
17454
18126
  "x-displayname": "Conditions.",
18127
+ "x-f5xc-description-short": "List of conditions for the requested object in a given site.",
17455
18128
  "x-f5xc-required-for": {
17456
18129
  "minimum_config": false,
17457
18130
  "create": false,
@@ -17463,6 +18136,7 @@
17463
18136
  "$ref": "#/components/schemas/schemaErrorType"
17464
18137
  }
17465
18138
  },
18139
+ "x-f5xc-description-short": "Status Response for a configured object in a site.",
17466
18140
  "x-f5xc-minimum-configuration": {
17467
18141
  "description": "Minimum configuration for status_at_siteStatusResponse",
17468
18142
  "required_fields": [