@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.20-2601072244

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 (49) hide show
  1. package/README.md +23 -0
  2. package/dist/config/paths.d.ts.map +1 -1
  3. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  4. package/dist/tools/generated/ce_management/index.js +179 -1582
  5. package/dist/tools/generated/ce_management/index.js.map +1 -1
  6. package/dist/tools/generated/dependency-graph.json +2 -265
  7. package/dist/version.d.ts +2 -2
  8. package/dist/version.js +2 -2
  9. package/manifest.json +1 -1
  10. package/package.json +1 -1
  11. package/specs/domains/admin_console_and_ui.json +111 -25
  12. package/specs/domains/ai_services.json +114 -35
  13. package/specs/domains/api.json +1082 -177
  14. package/specs/domains/authentication.json +205 -45
  15. package/specs/domains/bigip.json +593 -101
  16. package/specs/domains/billing_and_usage.json +440 -82
  17. package/specs/domains/blindfold.json +713 -110
  18. package/specs/domains/bot_and_threat_defense.json +359 -65
  19. package/specs/domains/cdn.json +2131 -194
  20. package/specs/domains/ce_management.json +9110 -15844
  21. package/specs/domains/certificates.json +362 -75
  22. package/specs/domains/cloud_infrastructure.json +802 -119
  23. package/specs/domains/container_services.json +613 -95
  24. package/specs/domains/data_and_privacy_security.json +364 -66
  25. package/specs/domains/data_intelligence.json +324 -63
  26. package/specs/domains/ddos.json +766 -159
  27. package/specs/domains/dns.json +820 -161
  28. package/specs/domains/managed_kubernetes.json +455 -85
  29. package/specs/domains/marketplace.json +670 -104
  30. package/specs/domains/network.json +1620 -238
  31. package/specs/domains/network_security.json +1401 -191
  32. package/specs/domains/nginx_one.json +326 -62
  33. package/specs/domains/object_storage.json +49 -15
  34. package/specs/domains/observability.json +999 -147
  35. package/specs/domains/rate_limiting.json +300 -55
  36. package/specs/domains/secops_and_incident_response.json +189 -36
  37. package/specs/domains/service_mesh.json +955 -124
  38. package/specs/domains/shape.json +2150 -397
  39. package/specs/domains/sites.json +3830 -364
  40. package/specs/domains/statistics.json +2117 -235
  41. package/specs/domains/support.json +602 -108
  42. package/specs/domains/telemetry_and_insights.json +753 -79
  43. package/specs/domains/tenant_and_identity.json +1874 -308
  44. package/specs/domains/threat_campaign.json +637 -71
  45. package/specs/domains/users.json +278 -66
  46. package/specs/domains/virtual.json +2803 -260
  47. package/specs/domains/vpm_and_node_management.json +3 -1
  48. package/specs/domains/waf.json +1125 -148
  49. package/specs/index.json +24 -24
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Ddos",
5
5
  "description": "Network perimeter hardening through deny list configurations, rule group hierarchies, and encrypted tunnel endpoints. Attack signature detection identifies flood patterns while throttling mechanisms block anomalous traffic bursts. Tunnel health checks verify coverage across distributed segments. Priority ordering governs policy application for multi-layered screening approaches.",
6
- "version": "2.0.13",
6
+ "version": "2.0.20",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -15512,6 +15512,7 @@
15512
15512
  "x-displayname": "Data expected.",
15513
15513
  "x-ves-example": "2021-01-01T00:00:00Z.",
15514
15514
  "x-f5xc-example": "2021-01-01T00:00:00Z",
15515
+ "x-f5xc-description-short": "If set then it indicates the date when we expect the customer to have data present.",
15515
15516
  "minLength": 0,
15516
15517
  "maxLength": 1024,
15517
15518
  "x-f5xc-required-for": {
@@ -15527,6 +15528,8 @@
15527
15528
  "title": "Data present.",
15528
15529
  "format": "boolean",
15529
15530
  "x-displayname": "Data present.",
15531
+ "x-f5xc-example": "{\"key\": \"value\"}",
15532
+ "x-f5xc-description-short": "If true then the customer has some data available, otherwise no data available.",
15530
15533
  "x-f5xc-required-for": {
15531
15534
  "minimum_config": false,
15532
15535
  "create": false,
@@ -15540,6 +15543,8 @@
15540
15543
  "title": "Enabled",
15541
15544
  "format": "boolean",
15542
15545
  "x-displayname": "Enabled",
15546
+ "x-f5xc-example": "True",
15547
+ "x-f5xc-description-short": "If true then the customer has this feature enabled.",
15543
15548
  "x-f5xc-required-for": {
15544
15549
  "minimum_config": false,
15545
15550
  "create": false,
@@ -15610,6 +15615,7 @@
15610
15615
  "x-displayname": "Namespace",
15611
15616
  "x-ves-example": "Value",
15612
15617
  "x-f5xc-example": "value",
15618
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
15613
15619
  "minLength": 0,
15614
15620
  "maxLength": 6,
15615
15621
  "x-f5xc-required-for": {
@@ -15620,9 +15626,10 @@
15620
15626
  },
15621
15627
  "x-original-maxLength": 1024,
15622
15628
  "x-reconciled-from-discovery": true,
15623
- "x-reconciled-at": "2026-01-05T18:29:26.375808+00:00"
15629
+ "x-reconciled-at": "2026-01-07T15:53:27.888754+00:00"
15624
15630
  }
15625
15631
  },
15632
+ "x-f5xc-description-short": "Request to add an alert to event (link them together).",
15626
15633
  "x-f5xc-minimum-configuration": {
15627
15634
  "description": "Minimum configuration for infraprotectAddAlertToEventRequest",
15628
15635
  "required_fields": [
@@ -15692,7 +15699,7 @@
15692
15699
  },
15693
15700
  "x-original-maxLength": 1024,
15694
15701
  "x-reconciled-from-discovery": true,
15695
- "x-reconciled-at": "2026-01-05T18:29:26.375817+00:00"
15702
+ "x-reconciled-at": "2026-01-07T15:53:27.888764+00:00"
15696
15703
  },
15697
15704
  "event_id": {
15698
15705
  "type": "string",
@@ -15701,6 +15708,7 @@
15701
15708
  "x-displayname": "Event ID",
15702
15709
  "x-ves-example": "8094c17b-80c1-429d-8b17-7232f0e2937c.",
15703
15710
  "x-f5xc-example": "8094c17b-80c1-429d-8b17-7232f0e2937c",
15711
+ "x-f5xc-description-short": "Event ID we want to list the event details for.",
15704
15712
  "minLength": 0,
15705
15713
  "maxLength": 1024,
15706
15714
  "x-f5xc-required-for": {
@@ -15718,6 +15726,7 @@
15718
15726
  "x-displayname": "Namespace",
15719
15727
  "x-ves-example": "Value",
15720
15728
  "x-f5xc-example": "value",
15729
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
15721
15730
  "minLength": 0,
15722
15731
  "maxLength": 6,
15723
15732
  "x-f5xc-required-for": {
@@ -15728,7 +15737,7 @@
15728
15737
  },
15729
15738
  "x-original-maxLength": 1024,
15730
15739
  "x-reconciled-from-discovery": true,
15731
- "x-reconciled-at": "2026-01-05T18:29:26.375823+00:00"
15740
+ "x-reconciled-at": "2026-01-07T15:53:27.888771+00:00"
15732
15741
  },
15733
15742
  "time": {
15734
15743
  "type": "string",
@@ -15738,6 +15747,7 @@
15738
15747
  "x-displayname": "Time",
15739
15748
  "x-ves-example": "2021-01-01T00:00:00Z.",
15740
15749
  "x-f5xc-example": "2021-01-01T00:00:00Z",
15750
+ "x-f5xc-description-short": "Time of the event detail Format: RFC3339.",
15741
15751
  "minLength": 0,
15742
15752
  "maxLength": 1024,
15743
15753
  "x-f5xc-required-for": {
@@ -15764,9 +15774,10 @@
15764
15774
  },
15765
15775
  "x-original-maxLength": 1024,
15766
15776
  "x-reconciled-from-discovery": true,
15767
- "x-reconciled-at": "2026-01-05T18:29:26.375829+00:00"
15777
+ "x-reconciled-at": "2026-01-07T15:53:27.888776+00:00"
15768
15778
  }
15769
15779
  },
15780
+ "x-f5xc-description-short": "Request to add a single event detail to an event.",
15770
15781
  "x-f5xc-minimum-configuration": {
15771
15782
  "description": "Minimum configuration for infraprotectAddEventDetailRequest",
15772
15783
  "required_fields": [
@@ -15839,6 +15850,7 @@
15839
15850
  "x-displayname": "Bandwidth",
15840
15851
  "x-ves-example": "10000000",
15841
15852
  "x-f5xc-example": "10000000",
15853
+ "x-f5xc-description-short": "Bandwidth that triggered the alert in BPS.",
15842
15854
  "minLength": 0,
15843
15855
  "maxLength": 1024,
15844
15856
  "x-f5xc-required-for": {
@@ -15853,6 +15865,7 @@
15853
15865
  "description": "Creator of the alert (or SOC if created manually)",
15854
15866
  "title": "Creator",
15855
15867
  "x-displayname": "Creator",
15868
+ "x-f5xc-description-short": "Creator of the alert (or SOC if created manually).",
15856
15869
  "minLength": 0,
15857
15870
  "maxLength": 1024,
15858
15871
  "x-f5xc-required-for": {
@@ -15871,6 +15884,7 @@
15871
15884
  "x-displayname": "End Time",
15872
15885
  "x-ves-example": "2021-01-01T00:00:00Z.",
15873
15886
  "x-f5xc-example": "2021-01-01T00:00:00Z",
15887
+ "x-f5xc-description-short": "End time of the alert. This is when the threshold was restored.",
15874
15888
  "minLength": 0,
15875
15889
  "maxLength": 1024,
15876
15890
  "x-f5xc-required-for": {
@@ -15888,6 +15902,8 @@
15888
15902
  "$ref": "#/components/schemas/infraprotectEvent"
15889
15903
  },
15890
15904
  "x-displayname": "Events",
15905
+ "x-f5xc-example": "{\"key\": \"value\"}",
15906
+ "x-f5xc-description-short": "List of associated alerts. These alerts are normally manually associated.",
15891
15907
  "x-f5xc-required-for": {
15892
15908
  "minimum_config": false,
15893
15909
  "create": false,
@@ -15902,6 +15918,7 @@
15902
15918
  "x-displayname": "ID",
15903
15919
  "x-ves-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b.",
15904
15920
  "x-f5xc-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b",
15921
+ "x-f5xc-description-short": "ID of the alert used to uniquely identify it.",
15905
15922
  "minimum": 1,
15906
15923
  "maximum": 4094,
15907
15924
  "minLength": 0,
@@ -15920,6 +15937,7 @@
15920
15937
  "x-displayname": "IP address.",
15921
15938
  "x-ves-example": "127.0.0.1",
15922
15939
  "x-f5xc-example": "127.0.0.1",
15940
+ "x-f5xc-description-short": "IP the alert is triggered for. This is the \"protected\" IP.",
15923
15941
  "minLength": 0,
15924
15942
  "maxLength": 1024,
15925
15943
  "x-f5xc-required-for": {
@@ -15955,6 +15973,7 @@
15955
15973
  "x-displayname": "Start Time.",
15956
15974
  "x-ves-example": "2021-01-01T00:00:00Z.",
15957
15975
  "x-f5xc-example": "2021-01-01T00:00:00Z",
15976
+ "x-f5xc-description-short": "Start time of the alert. This is when a threshold was exceeded.",
15958
15977
  "minLength": 0,
15959
15978
  "maxLength": 1024,
15960
15979
  "x-f5xc-required-for": {
@@ -16033,6 +16052,7 @@
16033
16052
  "title": "Destination.",
16034
16053
  "format": "boolean",
16035
16054
  "x-displayname": "Destination.",
16055
+ "x-f5xc-description-short": "Destination flag - if rue then the port field is the destination of the alert.",
16036
16056
  "x-f5xc-required-for": {
16037
16057
  "minimum_config": false,
16038
16058
  "create": false,
@@ -16057,7 +16077,7 @@
16057
16077
  },
16058
16078
  "x-original-maxLength": 1024,
16059
16079
  "x-reconciled-from-discovery": true,
16060
- "x-reconciled-at": "2026-01-05T18:29:26.375856+00:00"
16080
+ "x-reconciled-at": "2026-01-07T15:53:27.888803+00:00"
16061
16081
  },
16062
16082
  "number": {
16063
16083
  "type": "integer",
@@ -16110,6 +16130,7 @@
16110
16130
  }
16111
16131
  }
16112
16132
  },
16133
+ "x-f5xc-description-short": "Single occurrence of a port in an alert.",
16113
16134
  "x-f5xc-minimum-configuration": {
16114
16135
  "description": "Minimum configuration for infraprotectAlertPort",
16115
16136
  "required_fields": [
@@ -16156,6 +16177,7 @@
16156
16177
  "title": "Destination.",
16157
16178
  "format": "boolean",
16158
16179
  "x-displayname": "Destination.",
16180
+ "x-f5xc-description-short": "Destination flag - if rue then the CIDR field is the destination of the alert.",
16159
16181
  "x-f5xc-required-for": {
16160
16182
  "minimum_config": false,
16161
16183
  "create": false,
@@ -16198,6 +16220,7 @@
16198
16220
  }
16199
16221
  }
16200
16222
  },
16223
+ "x-f5xc-description-short": "Single occurrence of a prefix in an alert.",
16201
16224
  "x-f5xc-minimum-configuration": {
16202
16225
  "description": "Minimum configuration for infraprotectAlertPrefix",
16203
16226
  "required_fields": [
@@ -16225,6 +16248,8 @@
16225
16248
  "default": "ALERT_SOURCE_TYPE_UNKNOWN",
16226
16249
  "x-displayname": "Alert source type.",
16227
16250
  "x-ves-proto-enum": "ves.io.schema.infraprotect.AlertSourceType",
16251
+ "x-f5xc-description-short": "Alert source type - helps the UI distinguish alerts coming from different sources - ALERT_SOURCE_TYPE_UNKNOWN: Unspecified source type ...",
16252
+ "x-f5xc-description-medium": "Alert source type - helps the UI distinguish alerts coming from different sources - ALERT_SOURCE_TYPE_UNKNOWN: Unspecified source type - ALERT_SOURCE_TYPE_MITIGATED: Alert is sourced from a mitigated-type system - ALERT_SOURCE_TYPE_AUTOMITIGATED: Alert is sourced from an automitigated-type system.",
16228
16253
  "x-f5xc-minimum-configuration": {
16229
16254
  "description": "Minimum configuration for infraprotectAlertSourceType",
16230
16255
  "required_fields": [],
@@ -16286,6 +16311,7 @@
16286
16311
  "x-displayname": "GOS name",
16287
16312
  "x-ves-example": "Attachment_123.",
16288
16313
  "x-f5xc-example": "attachment_123",
16314
+ "x-f5xc-description-short": "Generic object storage name of the attachment.",
16289
16315
  "minLength": 0,
16290
16316
  "maxLength": 1024,
16291
16317
  "x-f5xc-required-for": {
@@ -16302,6 +16328,7 @@
16302
16328
  "x-displayname": "GOS version.",
16303
16329
  "x-ves-example": "V01-00-00-00.",
16304
16330
  "x-f5xc-example": "v01-00-00-00",
16331
+ "x-f5xc-description-short": "Generic object storage version of the attachment.",
16305
16332
  "minLength": 0,
16306
16333
  "maxLength": 1024,
16307
16334
  "x-f5xc-required-for": {
@@ -16328,7 +16355,7 @@
16328
16355
  },
16329
16356
  "x-original-maxLength": 1024,
16330
16357
  "x-reconciled-from-discovery": true,
16331
- "x-reconciled-at": "2026-01-05T18:29:26.375878+00:00"
16358
+ "x-reconciled-at": "2026-01-07T15:53:27.888825+00:00"
16332
16359
  },
16333
16360
  "size_bytes": {
16334
16361
  "type": "string",
@@ -16365,6 +16392,7 @@
16365
16392
  }
16366
16393
  }
16367
16394
  },
16395
+ "x-f5xc-description-short": "Event attachment record (pcap, or any arbitrary file).",
16368
16396
  "x-f5xc-minimum-configuration": {
16369
16397
  "description": "Minimum configuration for infraprotectAttachment",
16370
16398
  "required_fields": [
@@ -16398,6 +16426,8 @@
16398
16426
  "default": "ATTACHMENT_TYPE_UNKNOWN",
16399
16427
  "x-displayname": "Attachment type.",
16400
16428
  "x-ves-proto-enum": "ves.io.schema.infraprotect.AttachmentType",
16429
+ "x-f5xc-description-short": "Attachment type - helps the UI to properly handle attachments as not all attachment cna be treated the same - ATTACHMENT_TYPE_UNKNOWN: Unspecified...",
16430
+ "x-f5xc-description-medium": "Attachment type - helps the UI to properly handle attachments as not all attachment cna be treated the same - ATTACHMENT_TYPE_UNKNOWN: Unspecified attachment - ATTACHMENT_TYPE_PCAP: Attachment is a PCAP file - ATTACHMENT_TYPE_BINARY: Attachment is a binary file - ATTACHMENT_TYPE_INVALID_PCAP...",
16401
16431
  "x-f5xc-minimum-configuration": {
16402
16432
  "description": "Minimum configuration for infraprotectAttachmentType",
16403
16433
  "required_fields": [],
@@ -16445,6 +16475,8 @@
16445
16475
  "last_established": {
16446
16476
  "type": "string",
16447
16477
  "format": "date-time",
16478
+ "description": "Configuration parameter for last established",
16479
+ "x-f5xc-description-short": "Configuration parameter for last established.",
16448
16480
  "minLength": 0,
16449
16481
  "maxLength": 1024,
16450
16482
  "x-f5xc-required-for": {
@@ -16458,6 +16490,7 @@
16458
16490
  "$ref": "#/components/schemas/infraprotectBgpPeerSessionState"
16459
16491
  }
16460
16492
  },
16493
+ "x-f5xc-description-short": "Routed DDoS BGP peer status data specific to a given router/peer combination.",
16461
16494
  "x-f5xc-minimum-configuration": {
16462
16495
  "description": "Minimum configuration for infraprotectBGPPeerStatusItem",
16463
16496
  "required_fields": [
@@ -16483,7 +16516,7 @@
16483
16516
  "properties": {
16484
16517
  "namespace": {
16485
16518
  "type": "string",
16486
- "description": "",
16519
+ "description": "Human-readable name for the resource",
16487
16520
  "title": "Namespace",
16488
16521
  "x-displayname": "Namespace",
16489
16522
  "x-ves-example": "System",
@@ -16498,7 +16531,7 @@
16498
16531
  },
16499
16532
  "x-original-maxLength": 1024,
16500
16533
  "x-reconciled-from-discovery": true,
16501
- "x-reconciled-at": "2026-01-05T18:29:26.375893+00:00"
16534
+ "x-reconciled-at": "2026-01-07T15:53:27.888840+00:00"
16502
16535
  },
16503
16536
  "time": {
16504
16537
  "type": "string",
@@ -16511,6 +16544,8 @@
16511
16544
  "x-validation-rules": {
16512
16545
  "ves.io.schema.rules.string.query_time": "true"
16513
16546
  },
16547
+ "x-f5xc-description-short": "Timestamp at which the snapshot of the BGP peer status data should be fetched.",
16548
+ "x-f5xc-description-medium": "Timestamp at which the snapshot of the BGP peer status data should be fetched. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to <current time>.",
16514
16549
  "minLength": 0,
16515
16550
  "maxLength": 1024,
16516
16551
  "x-f5xc-required-for": {
@@ -16521,6 +16556,7 @@
16521
16556
  }
16522
16557
  }
16523
16558
  },
16559
+ "x-f5xc-description-short": "Request to GET routed DDoS BGP peer status information.",
16524
16560
  "x-f5xc-minimum-configuration": {
16525
16561
  "description": "Minimum configuration for infraprotectBGPPeerStatusRequest",
16526
16562
  "required_fields": [
@@ -16549,6 +16585,8 @@
16549
16585
  "$ref": "#/components/schemas/infraprotectBGPPeerStatusItem"
16550
16586
  },
16551
16587
  "x-displayname": "BGP Peer Status Items.",
16588
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
16589
+ "x-f5xc-description-short": "BGP Peer Status Items contains routed DDoS BGP peer status data for each router/peer combination.",
16552
16590
  "x-f5xc-required-for": {
16553
16591
  "minimum_config": false,
16554
16592
  "create": false,
@@ -16557,6 +16595,7 @@
16557
16595
  }
16558
16596
  }
16559
16597
  },
16598
+ "x-f5xc-description-short": "Routed DDoS BGP peer status response data.",
16560
16599
  "x-f5xc-minimum-configuration": {
16561
16600
  "description": "Minimum configuration for infraprotectBGPPeerStatusResponse",
16562
16601
  "required_fields": [
@@ -16584,6 +16623,8 @@
16584
16623
  "default": "Idle",
16585
16624
  "x-displayname": "BGP Peer Status.",
16586
16625
  "x-ves-proto-enum": "ves.io.schema.infraprotect.BgpPeerSessionState",
16626
+ "x-f5xc-description-short": "Status of BGP connection to this Peer Connection state is Idle Connection state is Connecting Connection state is Active Connection state is Open...",
16627
+ "x-f5xc-description-medium": "Status of BGP connection to this Peer Connection state is Idle Connection state is Connecting Connection state is Active Connection state is Open Sent Connection state is Open Confirm Connection state is Established.",
16587
16628
  "x-f5xc-minimum-configuration": {
16588
16629
  "description": "Minimum configuration for infraprotectBgpPeerSessionState",
16589
16630
  "required_fields": [],
@@ -16605,6 +16646,7 @@
16605
16646
  "$ref": "#/components/schemas/infraprotectAccessFlag"
16606
16647
  }
16607
16648
  },
16649
+ "x-f5xc-description-short": "Infraprotect and L3/L4 DDoS accessibility and availability flags response.",
16608
16650
  "x-f5xc-minimum-configuration": {
16609
16651
  "description": "Minimum configuration for infraprotectCustomerAccessResponse",
16610
16652
  "required_fields": [
@@ -16667,7 +16709,7 @@
16667
16709
  },
16668
16710
  "x-original-maxLength": 256,
16669
16711
  "x-reconciled-from-discovery": true,
16670
- "x-reconciled-at": "2026-01-05T18:29:26.375904+00:00"
16712
+ "x-reconciled-at": "2026-01-07T15:53:27.888851+00:00"
16671
16713
  },
16672
16714
  "zone1": {
16673
16715
  "$ref": "#/components/schemas/schemaEmpty"
@@ -16676,6 +16718,7 @@
16676
16718
  "$ref": "#/components/schemas/schemaEmpty"
16677
16719
  }
16678
16720
  },
16721
+ "x-f5xc-description-short": "Location of a network device (aka router) where DDoS transit tunnels are provisioned.",
16679
16722
  "x-f5xc-minimum-configuration": {
16680
16723
  "description": "Minimum configuration for infraprotectDeviceLocation",
16681
16724
  "required_fields": [
@@ -16705,6 +16748,7 @@
16705
16748
  "$ref": "#/components/schemas/infraprotectAttachment"
16706
16749
  },
16707
16750
  "x-displayname": "Attachments.",
16751
+ "x-f5xc-description-short": "All attachments on an event details, missing will be removed, extras will be added.",
16708
16752
  "x-f5xc-required-for": {
16709
16753
  "minimum_config": false,
16710
16754
  "create": false,
@@ -16729,7 +16773,7 @@
16729
16773
  },
16730
16774
  "x-original-maxLength": 1024,
16731
16775
  "x-reconciled-from-discovery": true,
16732
- "x-reconciled-at": "2026-01-05T18:29:26.375912+00:00"
16776
+ "x-reconciled-at": "2026-01-07T15:53:27.888860+00:00"
16733
16777
  },
16734
16778
  "event_detail_id": {
16735
16779
  "type": "string",
@@ -16755,6 +16799,7 @@
16755
16799
  "x-displayname": "Event ID",
16756
16800
  "x-ves-example": "8094c17b-80c1-429d-8b17-7232f0e2937c.",
16757
16801
  "x-f5xc-example": "8094c17b-80c1-429d-8b17-7232f0e2937c",
16802
+ "x-f5xc-description-short": "Event ID we want to edit the event detail for.",
16758
16803
  "minLength": 0,
16759
16804
  "maxLength": 1024,
16760
16805
  "x-f5xc-required-for": {
@@ -16772,6 +16817,7 @@
16772
16817
  "x-displayname": "Namespace",
16773
16818
  "x-ves-example": "Value",
16774
16819
  "x-f5xc-example": "value",
16820
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
16775
16821
  "minLength": 0,
16776
16822
  "maxLength": 6,
16777
16823
  "x-f5xc-required-for": {
@@ -16782,7 +16828,7 @@
16782
16828
  },
16783
16829
  "x-original-maxLength": 1024,
16784
16830
  "x-reconciled-from-discovery": true,
16785
- "x-reconciled-at": "2026-01-05T18:29:26.375919+00:00"
16831
+ "x-reconciled-at": "2026-01-07T15:53:27.888867+00:00"
16786
16832
  },
16787
16833
  "time": {
16788
16834
  "type": "string",
@@ -16792,6 +16838,7 @@
16792
16838
  "x-displayname": "Time",
16793
16839
  "x-ves-example": "2021-01-01T00:00:00Z.",
16794
16840
  "x-f5xc-example": "2021-01-01T00:00:00Z",
16841
+ "x-f5xc-description-short": "Time of the event detail Format: RFC3339.",
16795
16842
  "minLength": 0,
16796
16843
  "maxLength": 1024,
16797
16844
  "x-f5xc-required-for": {
@@ -16818,9 +16865,10 @@
16818
16865
  },
16819
16866
  "x-original-maxLength": 1024,
16820
16867
  "x-reconciled-from-discovery": true,
16821
- "x-reconciled-at": "2026-01-05T18:29:26.375925+00:00"
16868
+ "x-reconciled-at": "2026-01-07T15:53:27.888872+00:00"
16822
16869
  }
16823
16870
  },
16871
+ "x-f5xc-description-short": "Request to update a single event detail.",
16824
16872
  "x-f5xc-minimum-configuration": {
16825
16873
  "description": "Minimum configuration for infraprotectEditEventDetailRequest",
16826
16874
  "required_fields": [
@@ -16886,7 +16934,7 @@
16886
16934
  },
16887
16935
  "x-original-maxLength": 1024,
16888
16936
  "x-reconciled-from-discovery": true,
16889
- "x-reconciled-at": "2026-01-05T18:29:26.375931+00:00"
16937
+ "x-reconciled-at": "2026-01-07T15:53:27.888878+00:00"
16890
16938
  },
16891
16939
  "end_time": {
16892
16940
  "type": "string",
@@ -16896,6 +16944,7 @@
16896
16944
  "x-displayname": "End time",
16897
16945
  "x-ves-example": "2021-01-01T00:00:00Z.",
16898
16946
  "x-f5xc-example": "2021-01-01T00:00:00Z",
16947
+ "x-f5xc-description-short": "New end time of the event (note that end time is always set manually).",
16899
16948
  "minLength": 0,
16900
16949
  "maxLength": 1024,
16901
16950
  "x-f5xc-required-for": {
@@ -16913,6 +16962,7 @@
16913
16962
  "$ref": "#/components/schemas/infraprotectAttachment"
16914
16963
  },
16915
16964
  "x-displayname": "Attachments.",
16965
+ "x-f5xc-example": "{\"key\": \"value\"}",
16916
16966
  "x-f5xc-required-for": {
16917
16967
  "minimum_config": false,
16918
16968
  "create": false,
@@ -16954,7 +17004,7 @@
16954
17004
  },
16955
17005
  "x-original-maxLength": 1024,
16956
17006
  "x-reconciled-from-discovery": true,
16957
- "x-reconciled-at": "2026-01-05T18:29:26.375939+00:00"
17007
+ "x-reconciled-at": "2026-01-07T15:53:27.888886+00:00"
16958
17008
  },
16959
17009
  "namespace": {
16960
17010
  "type": "string",
@@ -16963,6 +17013,7 @@
16963
17013
  "x-displayname": "Namespace",
16964
17014
  "x-ves-example": "Value",
16965
17015
  "x-f5xc-example": "value",
17016
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
16966
17017
  "minLength": 0,
16967
17018
  "maxLength": 6,
16968
17019
  "x-f5xc-required-for": {
@@ -16973,7 +17024,7 @@
16973
17024
  },
16974
17025
  "x-original-maxLength": 1024,
16975
17026
  "x-reconciled-from-discovery": true,
16976
- "x-reconciled-at": "2026-01-05T18:29:26.375942+00:00"
17027
+ "x-reconciled-at": "2026-01-07T15:53:27.888890+00:00"
16977
17028
  }
16978
17029
  },
16979
17030
  "x-f5xc-minimum-configuration": {
@@ -17004,6 +17055,7 @@
17004
17055
  "$ref": "#/components/schemas/infraprotectEvent"
17005
17056
  }
17006
17057
  },
17058
+ "x-f5xc-description-short": "Updated event as a response to an event editing.",
17007
17059
  "x-f5xc-minimum-configuration": {
17008
17060
  "description": "Minimum configuration for infraprotectEditEventResponse",
17009
17061
  "required_fields": [
@@ -17062,6 +17114,7 @@
17062
17114
  "x-displayname": "Description.",
17063
17115
  "x-ves-example": "[object_name1, object_name2]",
17064
17116
  "x-f5xc-example": "[object_name1, object_name2]",
17117
+ "x-f5xc-description-short": "More detailed description of the event. Most of the time list of actions taken.",
17065
17118
  "minLength": 0,
17066
17119
  "maxLength": 0,
17067
17120
  "x-f5xc-required-for": {
@@ -17072,7 +17125,7 @@
17072
17125
  },
17073
17126
  "x-original-maxLength": 1024,
17074
17127
  "x-reconciled-from-discovery": true,
17075
- "x-reconciled-at": "2026-01-05T18:29:26.375951+00:00"
17128
+ "x-reconciled-at": "2026-01-07T15:53:27.888901+00:00"
17076
17129
  },
17077
17130
  "end_time": {
17078
17131
  "type": "string",
@@ -17097,6 +17150,7 @@
17097
17150
  "title": "Has attachment.",
17098
17151
  "format": "boolean",
17099
17152
  "x-displayname": "Has attachment.",
17153
+ "x-f5xc-description-short": "True if event has any attachment other than PCAP files.",
17100
17154
  "x-f5xc-required-for": {
17101
17155
  "minimum_config": false,
17102
17156
  "create": false,
@@ -17110,6 +17164,7 @@
17110
17164
  "title": "Has details.",
17111
17165
  "format": "boolean",
17112
17166
  "x-displayname": "Has details.",
17167
+ "x-f5xc-description-short": "True if the event already has details assigned, otherwise false.",
17113
17168
  "x-f5xc-required-for": {
17114
17169
  "minimum_config": false,
17115
17170
  "create": false,
@@ -17124,6 +17179,7 @@
17124
17179
  "x-displayname": "ID",
17125
17180
  "x-ves-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b.",
17126
17181
  "x-f5xc-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b",
17182
+ "x-f5xc-description-short": "ID of the event used to uniquely identify it.",
17127
17183
  "minimum": 1,
17128
17184
  "maximum": 4094,
17129
17185
  "minLength": 0,
@@ -17185,7 +17241,7 @@
17185
17241
  },
17186
17242
  "x-original-maxLength": 1024,
17187
17243
  "x-reconciled-from-discovery": true,
17188
- "x-reconciled-at": "2026-01-05T18:29:26.375964+00:00"
17244
+ "x-reconciled-at": "2026-01-07T15:53:27.888913+00:00"
17189
17245
  },
17190
17246
  "network_id": {
17191
17247
  "type": "string",
@@ -17222,6 +17278,7 @@
17222
17278
  }
17223
17279
  }
17224
17280
  },
17281
+ "x-f5xc-description-short": "Event (an attack record) that holds info an attack and its mitigation(s).",
17225
17282
  "x-f5xc-minimum-configuration": {
17226
17283
  "description": "Minimum configuration for infraprotectEvent",
17227
17284
  "required_fields": [
@@ -17291,6 +17348,7 @@
17291
17348
  "x-displayname": "Description.",
17292
17349
  "x-ves-example": "List of actions taken so far ...",
17293
17350
  "x-f5xc-example": "List of actions taken so far ...",
17351
+ "x-f5xc-description-short": "Textual description of the event detail record.",
17294
17352
  "minLength": 0,
17295
17353
  "maxLength": 0,
17296
17354
  "x-f5xc-required-for": {
@@ -17301,7 +17359,7 @@
17301
17359
  },
17302
17360
  "x-original-maxLength": 1024,
17303
17361
  "x-reconciled-from-discovery": true,
17304
- "x-reconciled-at": "2026-01-05T18:29:26.375975+00:00"
17362
+ "x-reconciled-at": "2026-01-07T15:53:27.888924+00:00"
17305
17363
  },
17306
17364
  "id": {
17307
17365
  "type": "string",
@@ -17310,6 +17368,7 @@
17310
17368
  "x-displayname": "ID",
17311
17369
  "x-ves-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b.",
17312
17370
  "x-f5xc-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b",
17371
+ "x-f5xc-description-short": "ID of the event detail used to uniquely identify it.",
17313
17372
  "minimum": 1,
17314
17373
  "maximum": 4094,
17315
17374
  "minLength": 0,
@@ -17329,6 +17388,8 @@
17329
17388
  "x-displayname": "Time",
17330
17389
  "x-ves-example": "2021-01-01T00:00:00Z.",
17331
17390
  "x-f5xc-example": "2021-01-01T00:00:00Z",
17391
+ "x-f5xc-description-short": "Time the event details applies to. Details can be added retrospectively this fields allow pin point to detail to a specific time.",
17392
+ "x-f5xc-description-medium": "Time the event details applies to. Details can be added retrospectively this fields allow pin point to detail to a specific time. The value must fall within the event time range.",
17332
17393
  "minLength": 0,
17333
17394
  "maxLength": 1024,
17334
17395
  "x-f5xc-required-for": {
@@ -17355,9 +17416,11 @@
17355
17416
  },
17356
17417
  "x-original-maxLength": 1024,
17357
17418
  "x-reconciled-from-discovery": true,
17358
- "x-reconciled-at": "2026-01-05T18:29:26.375982+00:00"
17419
+ "x-reconciled-at": "2026-01-07T15:53:27.888931+00:00"
17359
17420
  }
17360
17421
  },
17422
+ "x-f5xc-description-short": "Event detail represents a single occurrence of event detail, that tracks customer, SOC notes on a given event.",
17423
+ "x-f5xc-description-medium": "Event detail represents a single occurrence of event detail, that tracks customer, SOC notes on a given event.",
17361
17424
  "x-f5xc-minimum-configuration": {
17362
17425
  "description": "Minimum configuration for infraprotectEventDetail",
17363
17426
  "required_fields": [
@@ -17407,6 +17470,7 @@
17407
17470
  "x-displayname": "Name",
17408
17471
  "x-ves-example": "Event_12345_2022.",
17409
17472
  "x-f5xc-example": "event_12345_2022",
17473
+ "x-f5xc-description-short": "Name of the event (to be displayed to the customer).",
17410
17474
  "minLength": 0,
17411
17475
  "maxLength": 16,
17412
17476
  "x-f5xc-required-for": {
@@ -17417,7 +17481,7 @@
17417
17481
  },
17418
17482
  "x-original-maxLength": 1024,
17419
17483
  "x-reconciled-from-discovery": true,
17420
- "x-reconciled-at": "2026-01-05T18:29:26.375988+00:00"
17484
+ "x-reconciled-at": "2026-01-07T15:53:27.888938+00:00"
17421
17485
  }
17422
17486
  },
17423
17487
  "x-f5xc-minimum-configuration": {
@@ -17521,6 +17585,8 @@
17521
17585
  "format": "byte",
17522
17586
  "x-displayname": "Details",
17523
17587
  "x-f5xc-example": "\"\"",
17588
+ "x-f5xc-description-short": "Base64 encoded document with mitigation details. The document resembles HTML and should be displayed as such.",
17589
+ "x-f5xc-description-medium": "Base64 encoded document with mitigation details. The document resembles HTML and should be displayed as such.",
17524
17590
  "minLength": 0,
17525
17591
  "maxLength": 1024,
17526
17592
  "x-f5xc-required-for": {
@@ -17599,6 +17665,8 @@
17599
17665
  "x-displayname": "End Time",
17600
17666
  "x-ves-example": "2021-01-01T00:00:00Z.",
17601
17667
  "x-f5xc-example": "2021-01-01T00:00:00Z",
17668
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
17669
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the end_time will be evaluated to <current time>.",
17602
17670
  "minLength": 0,
17603
17671
  "maxLength": 1024,
17604
17672
  "x-f5xc-required-for": {
@@ -17615,6 +17683,8 @@
17615
17683
  "x-displayname": "Event ID",
17616
17684
  "x-ves-example": "12345",
17617
17685
  "x-f5xc-example": "12345",
17686
+ "x-f5xc-description-short": "Event ID when we want to filter by an event start and end time. Optional: If not specified, then no events filtering occurs.",
17687
+ "x-f5xc-description-medium": "Event ID when we want to filter by an event start and end time. Optional: If not specified, then no events filtering occurs.",
17618
17688
  "minLength": 0,
17619
17689
  "maxLength": 1024,
17620
17690
  "x-f5xc-required-for": {
@@ -17632,6 +17702,7 @@
17632
17702
  "x-displayname": "Namespace",
17633
17703
  "x-ves-example": "Value",
17634
17704
  "x-f5xc-example": "value",
17705
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
17635
17706
  "minLength": 0,
17636
17707
  "maxLength": 6,
17637
17708
  "x-f5xc-required-for": {
@@ -17642,7 +17713,7 @@
17642
17713
  },
17643
17714
  "x-original-maxLength": 1024,
17644
17715
  "x-reconciled-from-discovery": true,
17645
- "x-reconciled-at": "2026-01-05T18:29:26.376005+00:00"
17716
+ "x-reconciled-at": "2026-01-07T15:53:27.888955+00:00"
17646
17717
  },
17647
17718
  "network_id": {
17648
17719
  "type": "string",
@@ -17651,6 +17722,8 @@
17651
17722
  "x-displayname": "Network ID.",
17652
17723
  "x-ves-example": "12345",
17653
17724
  "x-f5xc-example": "12345",
17725
+ "x-f5xc-description-short": "Network ID when we want to filter by a network. It is assured that the network belongs to the tenant.",
17726
+ "x-f5xc-description-medium": "Network ID when we want to filter by a network. It is assured that the network belongs to the tenant. Optional: If not specified, then no network filtering occurs.",
17654
17727
  "minLength": 0,
17655
17728
  "maxLength": 1024,
17656
17729
  "x-f5xc-required-for": {
@@ -17669,6 +17742,8 @@
17669
17742
  "x-displayname": "Start Time.",
17670
17743
  "x-ves-example": "2021-01-01T00:00:00Z.",
17671
17744
  "x-f5xc-example": "2021-01-01T00:00:00Z",
17745
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
17746
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
17672
17747
  "minLength": 0,
17673
17748
  "maxLength": 1024,
17674
17749
  "x-f5xc-required-for": {
@@ -17679,6 +17754,7 @@
17679
17754
  }
17680
17755
  }
17681
17756
  },
17757
+ "x-f5xc-description-short": "Request to GET customer alerts with optional filtering.",
17682
17758
  "x-f5xc-minimum-configuration": {
17683
17759
  "description": "Minimum configuration for infraprotectListAlertsRequest",
17684
17760
  "required_fields": [
@@ -17753,6 +17829,7 @@
17753
17829
  }
17754
17830
  }
17755
17831
  },
17832
+ "x-f5xc-description-short": "Response, list of alerts associated with an event.",
17756
17833
  "x-f5xc-minimum-configuration": {
17757
17834
  "description": "Minimum configuration for infraprotectListEventAlertsResponse",
17758
17835
  "required_fields": [
@@ -17780,6 +17857,7 @@
17780
17857
  "$ref": "#/components/schemas/infraprotectAttachment"
17781
17858
  },
17782
17859
  "x-displayname": "Attachments.",
17860
+ "x-f5xc-description-short": "List of Attachments related to the event.",
17783
17861
  "x-f5xc-required-for": {
17784
17862
  "minimum_config": false,
17785
17863
  "create": false,
@@ -17788,6 +17866,7 @@
17788
17866
  }
17789
17867
  }
17790
17868
  },
17869
+ "x-f5xc-description-short": "Response, list of attachments associated with an event.",
17791
17870
  "x-f5xc-minimum-configuration": {
17792
17871
  "description": "Minimum configuration for infraprotectListEventAttachmentsResponse",
17793
17872
  "required_fields": [
@@ -17815,6 +17894,7 @@
17815
17894
  "$ref": "#/components/schemas/infraprotectEventDetail"
17816
17895
  },
17817
17896
  "x-displayname": "Event details.",
17897
+ "x-f5xc-description-short": "List of event details the event may have.",
17818
17898
  "x-f5xc-required-for": {
17819
17899
  "minimum_config": false,
17820
17900
  "create": false,
@@ -17850,6 +17930,8 @@
17850
17930
  "$ref": "#/components/schemas/infraprotectMitigationAnnotation"
17851
17931
  },
17852
17932
  "x-displayname": "Mitigations.",
17933
+ "x-f5xc-example": "{\"key\": \"value\"}",
17934
+ "x-f5xc-description-short": "List of mitigations related to the event.",
17853
17935
  "x-f5xc-required-for": {
17854
17936
  "minimum_config": false,
17855
17937
  "create": false,
@@ -17858,6 +17940,7 @@
17858
17940
  }
17859
17941
  }
17860
17942
  },
17943
+ "x-f5xc-description-short": "Response, list of mitigations associated with an event.",
17861
17944
  "x-f5xc-minimum-configuration": {
17862
17945
  "description": "Minimum configuration for infraprotectListEventMitigationsResponse",
17863
17946
  "required_fields": [
@@ -17885,6 +17968,8 @@
17885
17968
  "x-displayname": "End Time",
17886
17969
  "x-ves-example": "2021-01-01T00:00:00Z.",
17887
17970
  "x-f5xc-example": "2021-01-01T00:00:00Z",
17971
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
17972
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the end_time will be evaluated to <current time>.",
17888
17973
  "minLength": 0,
17889
17974
  "maxLength": 1024,
17890
17975
  "x-f5xc-required-for": {
@@ -17901,6 +17986,8 @@
17901
17986
  "x-displayname": "Mitigation.",
17902
17987
  "x-ves-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b.",
17903
17988
  "x-f5xc-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b",
17989
+ "x-f5xc-description-short": "Filter events by mitigation Optional: If not specified, then events are returned regardless of mitigation.",
17990
+ "x-f5xc-description-medium": "Filter events by mitigation Optional: If not specified, then events are returned regardless of mitigation.",
17904
17991
  "minLength": 0,
17905
17992
  "maxLength": 1024,
17906
17993
  "x-f5xc-required-for": {
@@ -17918,6 +18005,7 @@
17918
18005
  "x-displayname": "Namespace",
17919
18006
  "x-ves-example": "Value",
17920
18007
  "x-f5xc-example": "value",
18008
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
17921
18009
  "minLength": 0,
17922
18010
  "maxLength": 6,
17923
18011
  "x-f5xc-required-for": {
@@ -17928,7 +18016,7 @@
17928
18016
  },
17929
18017
  "x-original-maxLength": 1024,
17930
18018
  "x-reconciled-from-discovery": true,
17931
- "x-reconciled-at": "2026-01-05T18:29:26.376023+00:00"
18019
+ "x-reconciled-at": "2026-01-07T15:53:27.888973+00:00"
17932
18020
  },
17933
18021
  "network_id": {
17934
18022
  "type": "string",
@@ -17937,6 +18025,7 @@
17937
18025
  "x-displayname": "Network",
17938
18026
  "x-ves-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b.",
17939
18027
  "x-f5xc-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b",
18028
+ "x-f5xc-description-short": "Filter events by network Optional: If not specified, then all tenant's networks are considerate.",
17940
18029
  "minLength": 0,
17941
18030
  "maxLength": 1024,
17942
18031
  "x-f5xc-required-for": {
@@ -17955,6 +18044,8 @@
17955
18044
  "x-displayname": "Start Time.",
17956
18045
  "x-ves-example": "2021-01-01T00:00:00Z.",
17957
18046
  "x-f5xc-example": "2021-01-01T00:00:00Z",
18047
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
18048
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
17958
18049
  "minLength": 0,
17959
18050
  "maxLength": 1024,
17960
18051
  "x-f5xc-required-for": {
@@ -17996,6 +18087,8 @@
17996
18087
  "$ref": "#/components/schemas/infraprotectEvent"
17997
18088
  },
17998
18089
  "x-displayname": "Events",
18090
+ "x-f5xc-example": "{\"key\": \"value\"}",
18091
+ "x-f5xc-description-short": "Recorder events filtered by events requests.",
17999
18092
  "x-f5xc-required-for": {
18000
18093
  "minimum_config": false,
18001
18094
  "create": false,
@@ -18031,6 +18124,7 @@
18031
18124
  "$ref": "#/components/schemas/infraprotectEventSummary"
18032
18125
  },
18033
18126
  "x-displayname": "Events",
18127
+ "x-f5xc-example": "{\"key\": \"value\"}",
18034
18128
  "x-f5xc-required-for": {
18035
18129
  "minimum_config": false,
18036
18130
  "create": false,
@@ -18039,6 +18133,7 @@
18039
18133
  }
18040
18134
  }
18041
18135
  },
18136
+ "x-f5xc-description-short": "Response to the simplified events view request.",
18042
18137
  "x-f5xc-minimum-configuration": {
18043
18138
  "description": "Minimum configuration for infraprotectListEventsSummaryResponse",
18044
18139
  "required_fields": [
@@ -18076,6 +18171,7 @@
18076
18171
  }
18077
18172
  }
18078
18173
  },
18174
+ "x-f5xc-description-short": "List of mitigation annotations (i.e. Mitigation notes sorted chronologically)",
18079
18175
  "x-f5xc-minimum-configuration": {
18080
18176
  "description": "Minimum configuration for infraprotectListMitigationAnnotationsResponse",
18081
18177
  "required_fields": [
@@ -18103,6 +18199,7 @@
18103
18199
  "$ref": "#/components/schemas/infraprotectMitigationIP"
18104
18200
  },
18105
18201
  "x-displayname": "IPs",
18202
+ "x-f5xc-description-short": "List of IP addresses along with log count.",
18106
18203
  "x-f5xc-required-for": {
18107
18204
  "minimum_config": false,
18108
18205
  "create": false,
@@ -18138,6 +18235,8 @@
18138
18235
  "x-displayname": "End Time",
18139
18236
  "x-ves-example": "2021-01-01T00:00:00Z.",
18140
18237
  "x-f5xc-example": "2021-01-01T00:00:00Z",
18238
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
18239
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the end_time will be evaluated to <current time>.",
18141
18240
  "minLength": 0,
18142
18241
  "maxLength": 1024,
18143
18242
  "x-f5xc-required-for": {
@@ -18154,6 +18253,8 @@
18154
18253
  "x-displayname": "Event",
18155
18254
  "x-ves-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b.",
18156
18255
  "x-f5xc-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b",
18256
+ "x-f5xc-description-short": "Filter mitigations by an event Optional: If not specified, then all tenant's events are considerate.",
18257
+ "x-f5xc-description-medium": "Filter mitigations by an event Optional: If not specified, then all tenant's events are considerate.",
18157
18258
  "minLength": 0,
18158
18259
  "maxLength": 1024,
18159
18260
  "x-f5xc-required-for": {
@@ -18171,6 +18272,7 @@
18171
18272
  "x-displayname": "Namespace",
18172
18273
  "x-ves-example": "Value",
18173
18274
  "x-f5xc-example": "value",
18275
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
18174
18276
  "minLength": 0,
18175
18277
  "maxLength": 6,
18176
18278
  "x-f5xc-required-for": {
@@ -18181,7 +18283,7 @@
18181
18283
  },
18182
18284
  "x-original-maxLength": 1024,
18183
18285
  "x-reconciled-from-discovery": true,
18184
- "x-reconciled-at": "2026-01-05T18:29:26.376052+00:00"
18286
+ "x-reconciled-at": "2026-01-07T15:53:27.888990+00:00"
18185
18287
  },
18186
18288
  "network_id": {
18187
18289
  "type": "string",
@@ -18190,6 +18292,8 @@
18190
18292
  "x-displayname": "Network",
18191
18293
  "x-ves-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b.",
18192
18294
  "x-f5xc-example": "9ba097cf-35e3-4560-9c00-5a1a36b8f85b",
18295
+ "x-f5xc-description-short": "Filter mitigations by network Optional: If not specified, then all tenant's networks are considerate.",
18296
+ "x-f5xc-description-medium": "Filter mitigations by network Optional: If not specified, then all tenant's networks are considerate.",
18193
18297
  "minLength": 0,
18194
18298
  "maxLength": 1024,
18195
18299
  "x-f5xc-required-for": {
@@ -18208,6 +18312,8 @@
18208
18312
  "x-displayname": "Start Time.",
18209
18313
  "x-ves-example": "2021-01-01T00:00:00Z.",
18210
18314
  "x-f5xc-example": "2021-01-01T00:00:00Z",
18315
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
18316
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
18211
18317
  "minLength": 0,
18212
18318
  "maxLength": 1024,
18213
18319
  "x-f5xc-required-for": {
@@ -18249,6 +18355,7 @@
18249
18355
  "$ref": "#/components/schemas/infraprotectMitigation"
18250
18356
  },
18251
18357
  "x-displayname": "Mitigations.",
18358
+ "x-f5xc-example": "{\"key\": \"value\"}",
18252
18359
  "x-f5xc-required-for": {
18253
18360
  "minimum_config": false,
18254
18361
  "create": false,
@@ -18292,6 +18399,7 @@
18292
18399
  }
18293
18400
  }
18294
18401
  },
18402
+ "x-f5xc-description-short": "Response containing all networks available to the customer.",
18295
18403
  "x-f5xc-minimum-configuration": {
18296
18404
  "description": "Minimum configuration for infraprotectListNetworksResponse",
18297
18405
  "required_fields": [
@@ -18319,6 +18427,8 @@
18319
18427
  "x-displayname": "End Time",
18320
18428
  "x-ves-example": "2021-01-01T00:00:00Z.",
18321
18429
  "x-f5xc-example": "2021-01-01T00:00:00Z",
18430
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
18431
+ "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the end_time will be evaluated to <current time>.",
18322
18432
  "minLength": 0,
18323
18433
  "maxLength": 1024,
18324
18434
  "x-f5xc-required-for": {
@@ -18335,6 +18445,7 @@
18335
18445
  "x-displayname": "Namespace",
18336
18446
  "x-ves-example": "Value",
18337
18447
  "x-f5xc-example": "value",
18448
+ "x-f5xc-description-short": "Request is supported only in system namespace.",
18338
18449
  "minLength": 0,
18339
18450
  "maxLength": 6,
18340
18451
  "x-f5xc-required-for": {
@@ -18345,7 +18456,7 @@
18345
18456
  },
18346
18457
  "x-original-maxLength": 1024,
18347
18458
  "x-reconciled-from-discovery": true,
18348
- "x-reconciled-at": "2026-01-05T18:29:26.376065+00:00"
18459
+ "x-reconciled-at": "2026-01-07T15:53:27.889002+00:00"
18349
18460
  },
18350
18461
  "start_time": {
18351
18462
  "type": "string",
@@ -18355,6 +18466,8 @@
18355
18466
  "x-displayname": "Start Time.",
18356
18467
  "x-ves-example": "2021-01-01T00:00:00Z.",
18357
18468
  "x-f5xc-example": "2021-01-01T00:00:00Z",
18469
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
18470
+ "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the start_time will be evaluated to <current time>-3d.",
18358
18471
  "minLength": 0,
18359
18472
  "maxLength": 1024,
18360
18473
  "x-f5xc-required-for": {
@@ -18365,6 +18478,7 @@
18365
18478
  }
18366
18479
  }
18367
18480
  },
18481
+ "x-f5xc-description-short": "Request to GET a list of available reports.",
18368
18482
  "x-f5xc-minimum-configuration": {
18369
18483
  "description": "Minimum configuration for infraprotectListReportsRequest",
18370
18484
  "required_fields": [
@@ -18394,6 +18508,7 @@
18394
18508
  "$ref": "#/components/schemas/infraprotectReport"
18395
18509
  },
18396
18510
  "x-displayname": "Reports",
18511
+ "x-f5xc-description-short": "List of reports available to the tenant.",
18397
18512
  "x-f5xc-required-for": {
18398
18513
  "minimum_config": false,
18399
18514
  "create": false,
@@ -18443,6 +18558,7 @@
18443
18558
  "description": "Creator of the alert (or SOC if created manually)",
18444
18559
  "title": "Creator",
18445
18560
  "x-displayname": "Creator",
18561
+ "x-f5xc-description-short": "Creator of the alert (or SOC if created manually).",
18446
18562
  "minLength": 0,
18447
18563
  "maxLength": 1024,
18448
18564
  "x-f5xc-required-for": {
@@ -18461,6 +18577,7 @@
18461
18577
  "x-displayname": "End time",
18462
18578
  "x-ves-example": "2021-01-01T00:00:00Z.",
18463
18579
  "x-f5xc-example": "2021-01-01T00:00:00Z",
18580
+ "x-f5xc-description-short": "RFC3339 string of the mitigation end time.",
18464
18581
  "minLength": 0,
18465
18582
  "maxLength": 1024,
18466
18583
  "x-f5xc-required-for": {
@@ -18494,6 +18611,7 @@
18494
18611
  "title": "Ongoing",
18495
18612
  "format": "boolean",
18496
18613
  "x-displayname": "Ongoing",
18614
+ "x-f5xc-description-short": "True if the mitigation is still ongoing.",
18497
18615
  "x-f5xc-required-for": {
18498
18616
  "minimum_config": false,
18499
18617
  "create": false,
@@ -18518,13 +18636,14 @@
18518
18636
  },
18519
18637
  "x-original-maxLength": 1024,
18520
18638
  "x-reconciled-from-discovery": true,
18521
- "x-reconciled-at": "2026-01-05T18:29:26.376080+00:00"
18639
+ "x-reconciled-at": "2026-01-07T15:53:27.889016+00:00"
18522
18640
  },
18523
18641
  "network_id": {
18524
18642
  "type": "string",
18525
18643
  "description": "ID of the network involved in the mitigation.",
18526
18644
  "title": "NetworkID",
18527
18645
  "x-displayname": "Network ID.",
18646
+ "x-f5xc-description-short": "ID of the network involved in the mitigation.",
18528
18647
  "minLength": 0,
18529
18648
  "maxLength": 1024,
18530
18649
  "x-f5xc-required-for": {
@@ -18542,6 +18661,7 @@
18542
18661
  "x-displayname": "Network",
18543
18662
  "x-ves-example": "Dosproof_123.",
18544
18663
  "x-f5xc-example": "dosproof_123",
18664
+ "x-f5xc-description-short": "Name of the network involved in the mitigation.",
18545
18665
  "minLength": 0,
18546
18666
  "maxLength": 1024,
18547
18667
  "x-f5xc-required-for": {
@@ -18575,6 +18695,7 @@
18575
18695
  "x-displayname": "Start time.",
18576
18696
  "x-ves-example": "2021-01-01T00:00:00Z.",
18577
18697
  "x-f5xc-example": "2021-01-01T00:00:00Z",
18698
+ "x-f5xc-description-short": "RFC3339 string of the mitigation start time.",
18578
18699
  "minLength": 0,
18579
18700
  "maxLength": 1024,
18580
18701
  "x-f5xc-required-for": {
@@ -18672,6 +18793,7 @@
18672
18793
  "x-displayname": "Time",
18673
18794
  "x-ves-example": "2021-01-01T00:00:00Z.",
18674
18795
  "x-f5xc-example": "2021-01-01T00:00:00Z",
18796
+ "x-f5xc-description-short": "Annotation creation time as an RFC3339 string.",
18675
18797
  "minLength": 0,
18676
18798
  "maxLength": 1024,
18677
18799
  "x-f5xc-required-for": {
@@ -18728,6 +18850,7 @@
18728
18850
  "x-displayname": "Log count",
18729
18851
  "x-ves-example": "123",
18730
18852
  "x-f5xc-example": "123",
18853
+ "x-f5xc-description-short": "Number of times the IP appears in the log.",
18731
18854
  "minLength": 0,
18732
18855
  "maxLength": 1024,
18733
18856
  "x-f5xc-required-for": {
@@ -18738,6 +18861,7 @@
18738
18861
  }
18739
18862
  }
18740
18863
  },
18864
+ "x-f5xc-description-short": "Single mitigation IP record including log record count.",
18741
18865
  "x-f5xc-minimum-configuration": {
18742
18866
  "description": "Minimum configuration for infraprotectMitigationIP",
18743
18867
  "required_fields": [
@@ -18793,7 +18917,7 @@
18793
18917
  },
18794
18918
  "x-original-maxLength": 1024,
18795
18919
  "x-reconciled-from-discovery": true,
18796
- "x-reconciled-at": "2026-01-05T18:29:26.376101+00:00"
18920
+ "x-reconciled-at": "2026-01-07T15:53:27.889037+00:00"
18797
18921
  },
18798
18922
  "prefixes": {
18799
18923
  "$ref": "#/components/schemas/schemaPrefixListType"
@@ -18804,6 +18928,8 @@
18804
18928
  "title": "Primary",
18805
18929
  "format": "boolean",
18806
18930
  "x-displayname": "Primary",
18931
+ "x-f5xc-description-short": "If true then the network is the primary customer's network and should always be preferred.",
18932
+ "x-f5xc-description-medium": "If true then the network is the primary customer's network and should always be preferred. The rules governing: * The network is flagged as such during onboarding via the signup object->infraprotect_information * Customer network called %customer_name%_local - e.g. Defensenet_local * The only...",
18807
18933
  "x-f5xc-required-for": {
18808
18934
  "minimum_config": false,
18809
18935
  "create": false,
@@ -18903,7 +19029,7 @@
18903
19029
  },
18904
19030
  "x-original-maxLength": 1024,
18905
19031
  "x-reconciled-from-discovery": true,
18906
- "x-reconciled-at": "2026-01-05T18:29:26.376112+00:00"
19032
+ "x-reconciled-at": "2026-01-07T15:53:27.889048+00:00"
18907
19033
  },
18908
19034
  "scheduled": {
18909
19035
  "type": "boolean",
@@ -18925,6 +19051,7 @@
18925
19051
  "x-displayname": "Scheduled name.",
18926
19052
  "x-ves-example": "Dos-proof-report-01-01-2022.",
18927
19053
  "x-f5xc-example": "dos-proof-report-01-01-2022",
19054
+ "x-f5xc-description-short": "Full name, including the date part. Optional, only present if is set to true.",
18928
19055
  "minLength": 0,
18929
19056
  "maxLength": 1024,
18930
19057
  "x-f5xc-required-for": {
@@ -18957,6 +19084,7 @@
18957
19084
  "x-displayname": "Version",
18958
19085
  "x-ves-example": "V01-00-00-00.",
18959
19086
  "x-f5xc-example": "v01-00-00-00",
19087
+ "x-f5xc-description-short": "Document version assigned by generic object store.",
18960
19088
  "minLength": 0,
18961
19089
  "maxLength": 1,
18962
19090
  "x-f5xc-required-for": {
@@ -18967,7 +19095,7 @@
18967
19095
  },
18968
19096
  "x-original-maxLength": 1024,
18969
19097
  "x-reconciled-from-discovery": true,
18970
- "x-reconciled-at": "2026-01-05T18:29:26.376120+00:00"
19098
+ "x-reconciled-at": "2026-01-07T15:53:27.889057+00:00"
18971
19099
  }
18972
19100
  },
18973
19101
  "x-f5xc-minimum-configuration": {
@@ -19010,6 +19138,7 @@
19010
19138
  "x-validation-rules": {
19011
19139
  "ves.io.schema.rules.string.max_len": "1024"
19012
19140
  },
19141
+ "x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.",
19013
19142
  "minLength": 0,
19014
19143
  "x-f5xc-required-for": {
19015
19144
  "minimum_config": false,
@@ -19032,6 +19161,8 @@
19032
19161
  "x-validation-rules": {
19033
19162
  "ves.io.schema.rules.string.max_len": "256"
19034
19163
  },
19164
+ "x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
19165
+ "x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
19035
19166
  "minLength": 0,
19036
19167
  "x-f5xc-required-for": {
19037
19168
  "minimum_config": false,
@@ -19047,6 +19178,7 @@
19047
19178
  "x-displayname": "Namespace",
19048
19179
  "x-ves-example": "Foobar",
19049
19180
  "x-f5xc-example": "foobar",
19181
+ "x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
19050
19182
  "minLength": 0,
19051
19183
  "maxLength": 6,
19052
19184
  "x-f5xc-required-for": {
@@ -19057,7 +19189,7 @@
19057
19189
  },
19058
19190
  "x-original-maxLength": 1024,
19059
19191
  "x-reconciled-from-discovery": true,
19060
- "x-reconciled-at": "2026-01-05T18:29:26.376127+00:00"
19192
+ "x-reconciled-at": "2026-01-07T15:53:27.889064+00:00"
19061
19193
  },
19062
19194
  "request_body": {
19063
19195
  "$ref": "#/components/schemas/protobufAny"
@@ -19093,6 +19225,7 @@
19093
19225
  "$ref": "#/components/schemas/infraprotectTransitUsageTypeData"
19094
19226
  },
19095
19227
  "x-displayname": "Data",
19228
+ "x-f5xc-example": "{\"key\": \"value\"}",
19096
19229
  "x-f5xc-required-for": {
19097
19230
  "minimum_config": false,
19098
19231
  "create": false,
@@ -19107,6 +19240,7 @@
19107
19240
  "$ref": "#/components/schemas/schemaUnitType"
19108
19241
  }
19109
19242
  },
19243
+ "x-f5xc-description-short": "Transit Usage data contains the transit usage type and the corresponding metric value.",
19110
19244
  "x-f5xc-minimum-configuration": {
19111
19245
  "description": "Minimum configuration for infraprotectTransitUsageData",
19112
19246
  "required_fields": [
@@ -19164,6 +19298,8 @@
19164
19298
  "x-validation-rules": {
19165
19299
  "ves.io.schema.rules.string.query_time": "true"
19166
19300
  },
19301
+ "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.",
19302
+ "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>.",
19167
19303
  "minLength": 0,
19168
19304
  "maxLength": 1024,
19169
19305
  "x-f5xc-required-for": {
@@ -19196,6 +19332,8 @@
19196
19332
  "ves.io.schema.rules.repeated.min_items": "1",
19197
19333
  "ves.io.schema.rules.repeated.unique": "true"
19198
19334
  },
19335
+ "x-f5xc-description-short": "Select fields to be returned in the response.",
19336
+ "x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {IN_THROUGHPUT_BYTES, IN_THROUGHPUT_PACKETS, OUT_THROUGHPUT_BYTES, OUT_THROUGHPUT_PACKETS} can be specified. Required: YES.",
19199
19337
  "x-f5xc-required-for": {
19200
19338
  "minimum_config": false,
19201
19339
  "create": false,
@@ -19210,6 +19348,8 @@
19210
19348
  "x-displayname": "Filter",
19211
19349
  "x-ves-example": "{POP=\\\"POP-1\\\"}",
19212
19350
  "x-f5xc-example": "\"{POP=\\\"pop-1\\\"}\"",
19351
+ "x-f5xc-description-short": "Filter is used to specify the list of matchers syntax for filter := {[<matcher>]} <matcher> := <label><operator>\"<value>\" <label> := string One or...",
19352
+ "x-f5xc-description-medium": "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 MetricLabel {POP, DEVICE, INTERFACE} can be specified in the filter. <value> := string <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"] = ...",
19213
19353
  "minLength": 0,
19214
19354
  "maxLength": 1024,
19215
19355
  "x-f5xc-required-for": {
@@ -19227,6 +19367,7 @@
19227
19367
  "$ref": "#/components/schemas/infraprotectTransitUsageLabel"
19228
19368
  },
19229
19369
  "x-displayname": "Group By",
19370
+ "x-f5xc-description-short": "Aggregate data by zero or more labels {POP, DEVICE, INTERFACE}.",
19230
19371
  "x-f5xc-required-for": {
19231
19372
  "minimum_config": false,
19232
19373
  "create": false,
@@ -19236,7 +19377,7 @@
19236
19377
  },
19237
19378
  "namespace": {
19238
19379
  "type": "string",
19239
- "description": "",
19380
+ "description": "Human-readable name for the resource",
19240
19381
  "title": "Namespace",
19241
19382
  "x-displayname": "Namespace",
19242
19383
  "x-ves-example": "System",
@@ -19251,7 +19392,7 @@
19251
19392
  },
19252
19393
  "x-original-maxLength": 1024,
19253
19394
  "x-reconciled-from-discovery": true,
19254
- "x-reconciled-at": "2026-01-05T18:29:26.376143+00:00"
19395
+ "x-reconciled-at": "2026-01-07T15:53:27.889080+00:00"
19255
19396
  },
19256
19397
  "range": {
19257
19398
  "type": "string",
@@ -19266,6 +19407,8 @@
19266
19407
  "x-validation-rules": {
19267
19408
  "ves.io.schema.rules.string.time_interval": "true"
19268
19409
  },
19410
+ "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.",
19411
+ "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.",
19269
19412
  "minLength": 0,
19270
19413
  "maxLength": 1024,
19271
19414
  "x-f5xc-required-for": {
@@ -19288,6 +19431,8 @@
19288
19431
  "x-validation-rules": {
19289
19432
  "ves.io.schema.rules.string.query_time": "true"
19290
19433
  },
19434
+ "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.",
19435
+ "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.",
19291
19436
  "minLength": 0,
19292
19437
  "maxLength": 1024,
19293
19438
  "x-f5xc-required-for": {
@@ -19310,6 +19455,8 @@
19310
19455
  "x-validation-rules": {
19311
19456
  "ves.io.schema.rules.string.query_step": "true"
19312
19457
  },
19458
+ "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.",
19459
+ "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.",
19313
19460
  "minLength": 0,
19314
19461
  "maxLength": 1024,
19315
19462
  "x-f5xc-required-for": {
@@ -19354,6 +19501,8 @@
19354
19501
  "$ref": "#/components/schemas/infraprotectTransitUsageData"
19355
19502
  },
19356
19503
  "x-displayname": "Data",
19504
+ "x-f5xc-example": "{\"key\": \"value\"}",
19505
+ "x-f5xc-description-short": "Data contains time-series Transit Usage data.",
19357
19506
  "x-f5xc-required-for": {
19358
19507
  "minimum_config": false,
19359
19508
  "create": false,
@@ -19374,6 +19523,8 @@
19374
19523
  "x-validation-rules": {
19375
19524
  "ves.io.schema.rules.string.time_interval": "true"
19376
19525
  },
19526
+ "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.",
19527
+ "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.",
19377
19528
  "minLength": 0,
19378
19529
  "maxLength": 1024,
19379
19530
  "x-f5xc-required-for": {
@@ -19410,6 +19561,7 @@
19410
19561
  "default": "IN_THROUGHPUT_BYTES",
19411
19562
  "x-displayname": "Transit Usage Type.",
19412
19563
  "x-ves-proto-enum": "ves.io.schema.infraprotect.TransitUsageType",
19564
+ "x-f5xc-description-short": "List of Transit Usage metric types x-unit: \"Bps\" x-unit: \"pps\" x-unit: \"Bps\" x-unit: \"pps\".",
19413
19565
  "x-f5xc-minimum-configuration": {
19414
19566
  "description": "Minimum configuration for infraprotectTransitUsageType",
19415
19567
  "required_fields": [],
@@ -19432,6 +19584,8 @@
19432
19584
  "description": "Key contains the name/value pair.\n\"name\" is the label name defined in \"TransitUsageLabel\"",
19433
19585
  "title": "Key",
19434
19586
  "x-displayname": "Key",
19587
+ "x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
19588
+ "x-f5xc-description-short": "Key contains the name/value pair. \"name\" is the label name defined in \"TransitUsageLabel\".",
19435
19589
  "x-f5xc-required-for": {
19436
19590
  "minimum_config": false,
19437
19591
  "create": false,
@@ -19441,7 +19595,7 @@
19441
19595
  "maxLength": 16,
19442
19596
  "minLength": 7,
19443
19597
  "x-reconciled-from-discovery": true,
19444
- "x-reconciled-at": "2026-01-05T18:29:26.376156+00:00"
19598
+ "x-reconciled-at": "2026-01-07T15:53:27.889094+00:00"
19445
19599
  },
19446
19600
  "value": {
19447
19601
  "type": "array",
@@ -19460,9 +19614,11 @@
19460
19614
  "maxLength": 15,
19461
19615
  "minLength": 3,
19462
19616
  "x-reconciled-from-discovery": true,
19463
- "x-reconciled-at": "2026-01-05T18:29:26.376163+00:00"
19617
+ "x-reconciled-at": "2026-01-07T15:53:27.889099+00:00"
19464
19618
  }
19465
19619
  },
19620
+ "x-f5xc-description-short": "Transit Usage Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
19621
+ "x-f5xc-description-medium": "Transit Usage Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.",
19466
19622
  "x-f5xc-minimum-configuration": {
19467
19623
  "description": "Minimum configuration for infraprotectTransitUsageTypeData",
19468
19624
  "required_fields": [
@@ -19483,6 +19639,8 @@
19483
19639
  "type_url": {
19484
19640
  "type": "string",
19485
19641
  "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.",
19642
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
19643
+ "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 ).",
19486
19644
  "minLength": 0,
19487
19645
  "maxLength": 1024,
19488
19646
  "x-f5xc-required-for": {
@@ -19506,9 +19664,11 @@
19506
19664
  },
19507
19665
  "x-original-maxLength": 1024,
19508
19666
  "x-reconciled-from-discovery": true,
19509
- "x-reconciled-at": "2026-01-05T18:29:26.376170+00:00"
19667
+ "x-reconciled-at": "2026-01-07T15:53:27.889106+00:00"
19510
19668
  }
19511
19669
  },
19670
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
19671
+ "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...",
19512
19672
  "x-f5xc-minimum-configuration": {
19513
19673
  "description": "Minimum configuration for protobufAny",
19514
19674
  "required_fields": [
@@ -19528,6 +19688,7 @@
19528
19688
  "title": "Empty",
19529
19689
  "x-displayname": "Empty",
19530
19690
  "x-ves-proto-message": "ves.io.schema.Empty",
19691
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
19531
19692
  "x-f5xc-minimum-configuration": {
19532
19693
  "description": "Minimum configuration for schemaEmpty",
19533
19694
  "required_fields": [],
@@ -19554,6 +19715,7 @@
19554
19715
  "$ref": "#/components/schemas/schemaIpv6AddressType"
19555
19716
  }
19556
19717
  },
19718
+ "x-f5xc-description-short": "IP Address used to specify an IPv4 or IPv6 address.",
19557
19719
  "x-f5xc-minimum-configuration": {
19558
19720
  "description": "Minimum configuration for schemaIpAddressType",
19559
19721
  "required_fields": [
@@ -19587,6 +19749,7 @@
19587
19749
  "x-validation-rules": {
19588
19750
  "ves.io.schema.rules.string.ipv4": "true"
19589
19751
  },
19752
+ "x-f5xc-description-short": "IPv4 Address in string form with dot-decimal notation.",
19590
19753
  "minLength": 0,
19591
19754
  "maxLength": 1024,
19592
19755
  "x-f5xc-required-for": {
@@ -19629,6 +19792,7 @@
19629
19792
  "x-validation-rules": {
19630
19793
  "ves.io.schema.rules.string.ipv6": "true"
19631
19794
  },
19795
+ "x-f5xc-description-medium": "IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':' The address can be compacted by suppressing zeros e.g. '2001:db8:0:0:0:0:2:1' becomes '2001:db8::2:1' or '2001:db8:0:0:0:2:0:0' becomes '2001:db8::2::'.",
19632
19796
  "minLength": 0,
19633
19797
  "maxLength": 1024,
19634
19798
  "x-f5xc-required-for": {
@@ -19639,6 +19803,7 @@
19639
19803
  }
19640
19804
  }
19641
19805
  },
19806
+ "x-f5xc-description-short": "IPv6 Address specified as hexadecimal numbers separated by ':'.",
19642
19807
  "x-f5xc-minimum-configuration": {
19643
19808
  "description": "Minimum configuration for schemaIpv6AddressType",
19644
19809
  "required_fields": [
@@ -19678,7 +19843,7 @@
19678
19843
  },
19679
19844
  "value": {
19680
19845
  "type": "string",
19681
- "description": "",
19846
+ "description": "Configuration parameter for value",
19682
19847
  "title": "Value",
19683
19848
  "x-displayname": "Value",
19684
19849
  "x-ves-example": "15",
@@ -19693,9 +19858,10 @@
19693
19858
  },
19694
19859
  "x-original-maxLength": 1024,
19695
19860
  "x-reconciled-from-discovery": true,
19696
- "x-reconciled-at": "2026-01-05T18:29:26.376185+00:00"
19861
+ "x-reconciled-at": "2026-01-07T15:53:27.889120+00:00"
19697
19862
  }
19698
19863
  },
19864
+ "x-f5xc-description-short": "Metric data contains timestamp and the value.",
19699
19865
  "x-f5xc-minimum-configuration": {
19700
19866
  "description": "Minimum configuration for schemaMetricValue",
19701
19867
  "required_fields": [
@@ -19736,6 +19902,7 @@
19736
19902
  "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true",
19737
19903
  "ves.io.schema.rules.repeated.max_items": "256"
19738
19904
  },
19905
+ "x-f5xc-description-short": "IP Address prefix in string format. String must contain both prefix and prefix-length.",
19739
19906
  "x-f5xc-required-for": {
19740
19907
  "minimum_config": false,
19741
19908
  "create": false,
@@ -19744,6 +19911,8 @@
19744
19911
  }
19745
19912
  }
19746
19913
  },
19914
+ "x-f5xc-description-short": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length The list can contain mix of both IPv4 and IPv6 prefixes.",
19915
+ "x-f5xc-description-medium": "List of IP Address prefixes. Prefix must contain both prefix and prefix-length The list can contain mix of both IPv4 and IPv6 prefixes.",
19747
19916
  "x-f5xc-minimum-configuration": {
19748
19917
  "description": "Minimum configuration for schemaPrefixListType",
19749
19918
  "required_fields": [
@@ -19768,6 +19937,7 @@
19768
19937
  "default": "TREND_SENTIMENT_NONE",
19769
19938
  "x-displayname": "Trend Sentiment.",
19770
19939
  "x-ves-proto-enum": "ves.io.schema.TrendSentiment",
19940
+ "x-f5xc-description-short": "Trend sentiment Indicates trend sentiment is positive Indicates trend sentiment is negative.",
19771
19941
  "x-f5xc-minimum-configuration": {
19772
19942
  "description": "Minimum configuration for schemaTrendSentiment",
19773
19943
  "required_fields": [],
@@ -19792,6 +19962,7 @@
19792
19962
  "x-displayname": "Description.",
19793
19963
  "x-ves-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval.",
19794
19964
  "x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval",
19965
+ "x-f5xc-description-short": "Description of the method used to calculate trend.",
19795
19966
  "minLength": 0,
19796
19967
  "maxLength": 0,
19797
19968
  "x-f5xc-required-for": {
@@ -19802,15 +19973,16 @@
19802
19973
  },
19803
19974
  "x-original-maxLength": 1024,
19804
19975
  "x-reconciled-from-discovery": true,
19805
- "x-reconciled-at": "2026-01-05T18:29:26.376192+00:00"
19976
+ "x-reconciled-at": "2026-01-07T15:53:27.889127+00:00"
19806
19977
  },
19807
19978
  "previous_value": {
19808
19979
  "type": "string",
19809
- "description": "",
19980
+ "description": "Configuration parameter for previous value",
19810
19981
  "title": "Previous Value.",
19811
19982
  "x-displayname": "Previous Value.",
19812
19983
  "x-ves-example": "200.00",
19813
19984
  "x-f5xc-example": "200.00",
19985
+ "x-f5xc-description-short": "Configuration parameter for previous value.",
19814
19986
  "minLength": 0,
19815
19987
  "maxLength": 1024,
19816
19988
  "x-f5xc-required-for": {
@@ -19825,7 +19997,7 @@
19825
19997
  },
19826
19998
  "value": {
19827
19999
  "type": "string",
19828
- "description": "",
20000
+ "description": "Configuration parameter for value",
19829
20001
  "title": "Value",
19830
20002
  "x-displayname": "Value",
19831
20003
  "x-ves-example": "-15",
@@ -19840,9 +20012,11 @@
19840
20012
  },
19841
20013
  "x-original-maxLength": 1024,
19842
20014
  "x-reconciled-from-discovery": true,
19843
- "x-reconciled-at": "2026-01-05T18:29:26.376199+00:00"
20015
+ "x-reconciled-at": "2026-01-07T15:53:27.889134+00:00"
19844
20016
  }
19845
20017
  },
20018
+ "x-f5xc-description-short": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
20019
+ "x-f5xc-description-medium": "Trend value contains trend value, trend sentiment and trend calculation description and window size.",
19846
20020
  "x-f5xc-minimum-configuration": {
19847
20021
  "description": "Minimum configuration for schemaTrendValue",
19848
20022
  "required_fields": [
@@ -19894,6 +20068,7 @@
19894
20068
  "default": "UNIT_MILLISECONDS",
19895
20069
  "x-displayname": "Unit",
19896
20070
  "x-ves-proto-enum": "ves.io.schema.UnitType",
20071
+ "x-f5xc-description-short": "UnitType is enumeration of units for scalar fields.",
19897
20072
  "x-f5xc-minimum-configuration": {
19898
20073
  "description": "Minimum configuration for schemaUnitType",
19899
20074
  "required_fields": [],
@@ -19919,6 +20094,7 @@
19919
20094
  "$ref": "#/components/schemas/schemainfraprotectSuggestedItem"
19920
20095
  },
19921
20096
  "x-displayname": "Suggested Items.",
20097
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
19922
20098
  "x-f5xc-required-for": {
19923
20099
  "minimum_config": false,
19924
20100
  "create": false,
@@ -19952,6 +20128,7 @@
19952
20128
  "description": "Optional description for the suggested value.",
19953
20129
  "title": "Description.",
19954
20130
  "x-displayname": "Description.",
20131
+ "x-f5xc-description-short": "Optional description for the suggested value.",
19955
20132
  "minLength": 0,
19956
20133
  "maxLength": 0,
19957
20134
  "x-f5xc-required-for": {
@@ -19962,7 +20139,7 @@
19962
20139
  },
19963
20140
  "x-original-maxLength": 1024,
19964
20141
  "x-reconciled-from-discovery": true,
19965
- "x-reconciled-at": "2026-01-05T18:29:26.376206+00:00"
20142
+ "x-reconciled-at": "2026-01-07T15:53:27.889141+00:00"
19966
20143
  },
19967
20144
  "ref_value": {
19968
20145
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
@@ -19986,6 +20163,7 @@
19986
20163
  "description": "Suggested value for the field.\nShould use value_choice.str_value instead.",
19987
20164
  "title": "Value",
19988
20165
  "x-displayname": "Value",
20166
+ "x-f5xc-description-short": "Suggested value for the field. Should use value_choice.str_value instead.",
19989
20167
  "minLength": 0,
19990
20168
  "maxLength": 15,
19991
20169
  "x-f5xc-required-for": {
@@ -19996,9 +20174,10 @@
19996
20174
  },
19997
20175
  "x-original-maxLength": 1024,
19998
20176
  "x-reconciled-from-discovery": true,
19999
- "x-reconciled-at": "2026-01-05T18:29:26.376213+00:00"
20177
+ "x-reconciled-at": "2026-01-07T15:53:27.889147+00:00"
20000
20178
  }
20001
20179
  },
20180
+ "x-f5xc-description-short": "Tuple with a suggested value and it's description.",
20002
20181
  "x-f5xc-minimum-configuration": {
20003
20182
  "description": "Minimum configuration for schemainfraprotectSuggestedItem",
20004
20183
  "required_fields": [
@@ -20041,6 +20220,8 @@
20041
20220
  "ves.io.schema.rules.string.max_bytes": "128",
20042
20221
  "ves.io.schema.rules.string.min_bytes": "1"
20043
20222
  },
20223
+ "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.",
20224
+ "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.",
20044
20225
  "x-f5xc-required-for": {
20045
20226
  "minimum_config": false,
20046
20227
  "create": false,
@@ -20049,7 +20230,7 @@
20049
20230
  },
20050
20231
  "x-original-maxLength": 128,
20051
20232
  "x-reconciled-from-discovery": true,
20052
- "x-reconciled-at": "2026-01-05T18:29:26.376218+00:00"
20233
+ "x-reconciled-at": "2026-01-07T15:53:27.889152+00:00"
20053
20234
  },
20054
20235
  "namespace": {
20055
20236
  "type": "string",
@@ -20065,6 +20246,8 @@
20065
20246
  "x-validation-rules": {
20066
20247
  "ves.io.schema.rules.string.max_bytes": "64"
20067
20248
  },
20249
+ "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.",
20250
+ "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.",
20068
20251
  "minLength": 0,
20069
20252
  "x-f5xc-required-for": {
20070
20253
  "minimum_config": false,
@@ -20074,7 +20257,7 @@
20074
20257
  },
20075
20258
  "x-original-maxLength": 64,
20076
20259
  "x-reconciled-from-discovery": true,
20077
- "x-reconciled-at": "2026-01-05T18:29:26.376222+00:00"
20260
+ "x-reconciled-at": "2026-01-07T15:53:27.889157+00:00"
20078
20261
  },
20079
20262
  "tenant": {
20080
20263
  "type": "string",
@@ -20090,6 +20273,8 @@
20090
20273
  "x-validation-rules": {
20091
20274
  "ves.io.schema.rules.string.max_bytes": "64"
20092
20275
  },
20276
+ "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.",
20277
+ "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.",
20093
20278
  "minLength": 0,
20094
20279
  "x-f5xc-required-for": {
20095
20280
  "minimum_config": false,
@@ -20101,9 +20286,11 @@
20101
20286
  "x-field-mutability": "read-only",
20102
20287
  "x-original-maxLength": 64,
20103
20288
  "x-reconciled-from-discovery": true,
20104
- "x-reconciled-at": "2026-01-05T18:29:26.376226+00:00"
20289
+ "x-reconciled-at": "2026-01-07T15:53:27.889161+00:00"
20105
20290
  }
20106
20291
  },
20292
+ "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
20293
+ "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.",
20107
20294
  "x-f5xc-minimum-configuration": {
20108
20295
  "description": "Minimum configuration for schemaviewsObjectRefType",
20109
20296
  "required_fields": [
@@ -20199,6 +20386,7 @@
20199
20386
  "ves.io.schema.rules.uint32.gte": "1",
20200
20387
  "ves.io.schema.rules.uint32.lte": "4199999999"
20201
20388
  },
20389
+ "x-f5xc-description-short": "2-byte or 4-byte Autonomous System Number (ASN) Required: YES.",
20202
20390
  "minimum": 0,
20203
20391
  "maximum": 2147483647,
20204
20392
  "x-f5xc-required-for": {
@@ -20242,6 +20430,7 @@
20242
20430
  "title": "Fail_if_referred.",
20243
20431
  "format": "boolean",
20244
20432
  "x-displayname": "Fail-If-Referred.",
20433
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
20245
20434
  "x-f5xc-required-for": {
20246
20435
  "minimum_config": false,
20247
20436
  "create": false,
@@ -20266,7 +20455,7 @@
20266
20455
  },
20267
20456
  "x-original-maxLength": 1024,
20268
20457
  "x-reconciled-from-discovery": true,
20269
- "x-reconciled-at": "2026-01-05T18:29:26.707954+00:00"
20458
+ "x-reconciled-at": "2026-01-07T15:53:28.316265+00:00"
20270
20459
  },
20271
20460
  "namespace": {
20272
20461
  "type": "string",
@@ -20275,6 +20464,7 @@
20275
20464
  "x-displayname": "Namespace",
20276
20465
  "x-ves-example": "Ns1",
20277
20466
  "x-f5xc-example": "ns1",
20467
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
20278
20468
  "minLength": 0,
20279
20469
  "maxLength": 6,
20280
20470
  "x-f5xc-required-for": {
@@ -20285,7 +20475,7 @@
20285
20475
  },
20286
20476
  "x-original-maxLength": 1024,
20287
20477
  "x-reconciled-from-discovery": true,
20288
- "x-reconciled-at": "2026-01-05T18:29:26.707961+00:00"
20478
+ "x-reconciled-at": "2026-01-07T15:53:28.316272+00:00"
20289
20479
  }
20290
20480
  },
20291
20481
  "x-f5xc-minimum-configuration": {
@@ -20320,6 +20510,7 @@
20320
20510
  "$ref": "#/components/schemas/schemaObjectRefType"
20321
20511
  },
20322
20512
  "x-displayname": "Deleted Referred Objects.",
20513
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
20323
20514
  "x-f5xc-required-for": {
20324
20515
  "minimum_config": false,
20325
20516
  "create": false,
@@ -20335,6 +20526,7 @@
20335
20526
  "$ref": "#/components/schemas/schemaObjectRefType"
20336
20527
  },
20337
20528
  "x-displayname": "Disabled Referred Objects.",
20529
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
20338
20530
  "x-f5xc-required-for": {
20339
20531
  "minimum_config": false,
20340
20532
  "create": false,
@@ -20353,6 +20545,7 @@
20353
20545
  "$ref": "#/components/schemas/schemaObjectRefType"
20354
20546
  },
20355
20547
  "x-displayname": "Referring Objects.",
20548
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
20356
20549
  "x-f5xc-required-for": {
20357
20550
  "minimum_config": false,
20358
20551
  "create": false,
@@ -20374,6 +20567,8 @@
20374
20567
  "$ref": "#/components/schemas/infraprotect_asnStatusObject"
20375
20568
  },
20376
20569
  "x-displayname": "Status",
20570
+ "x-f5xc-example": "active",
20571
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
20377
20572
  "x-f5xc-required-for": {
20378
20573
  "minimum_config": false,
20379
20574
  "create": false,
@@ -20383,7 +20578,7 @@
20383
20578
  "maxLength": 17,
20384
20579
  "minLength": 17,
20385
20580
  "x-reconciled-from-discovery": true,
20386
- "x-reconciled-at": "2026-01-05T18:29:26.707976+00:00"
20581
+ "x-reconciled-at": "2026-01-07T15:53:28.316288+00:00"
20387
20582
  },
20388
20583
  "system_metadata": {
20389
20584
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -20423,6 +20618,8 @@
20423
20618
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
20424
20619
  ],
20425
20620
  "default": "GET_RSP_FORMAT_DEFAULT",
20621
+ "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...",
20622
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
20426
20623
  "x-f5xc-minimum-configuration": {
20427
20624
  "description": "Minimum configuration for infraprotect_asnGetResponseFormatCode",
20428
20625
  "required_fields": [],
@@ -20460,6 +20657,7 @@
20460
20657
  "ves.io.schema.rules.uint32.gte": "1",
20461
20658
  "ves.io.schema.rules.uint32.lte": "4199999999"
20462
20659
  },
20660
+ "x-f5xc-description-short": "2-byte or 4-byte Autonomous System Number (ASN) Required: YES.",
20463
20661
  "minimum": 0,
20464
20662
  "maximum": 2147483647,
20465
20663
  "x-f5xc-required-for": {
@@ -20517,6 +20715,7 @@
20517
20715
  "$ref": "#/components/schemas/schemaErrorType"
20518
20716
  },
20519
20717
  "x-displayname": "Errors",
20718
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
20520
20719
  "x-f5xc-required-for": {
20521
20720
  "minimum_config": false,
20522
20721
  "create": false,
@@ -20532,6 +20731,8 @@
20532
20731
  "$ref": "#/components/schemas/infraprotect_asnListResponseItem"
20533
20732
  },
20534
20733
  "x-displayname": "Items",
20734
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
20735
+ "x-f5xc-description-short": "Items represents the collection in response.",
20535
20736
  "x-f5xc-required-for": {
20536
20737
  "minimum_config": false,
20537
20738
  "create": false,
@@ -20565,6 +20766,8 @@
20565
20766
  "description": "The set of annotations present on this infraprotect_asn.",
20566
20767
  "title": "Annotations.",
20567
20768
  "x-displayname": "Annotations.",
20769
+ "x-f5xc-example": "{\"key\": \"value\"}",
20770
+ "x-f5xc-description-short": "The set of annotations present on this infraprotect_asn.",
20568
20771
  "x-f5xc-required-for": {
20569
20772
  "minimum_config": false,
20570
20773
  "create": false,
@@ -20577,6 +20780,7 @@
20577
20780
  "description": "The description set for this infraprotect_asn.",
20578
20781
  "title": "Description.",
20579
20782
  "x-displayname": "Description.",
20783
+ "x-f5xc-description-short": "The description set for this infraprotect_asn.",
20580
20784
  "minLength": 0,
20581
20785
  "maxLength": 0,
20582
20786
  "x-f5xc-required-for": {
@@ -20587,7 +20791,7 @@
20587
20791
  },
20588
20792
  "x-original-maxLength": 1024,
20589
20793
  "x-reconciled-from-discovery": true,
20590
- "x-reconciled-at": "2026-01-05T18:29:26.707996+00:00"
20794
+ "x-reconciled-at": "2026-01-07T15:53:28.316309+00:00"
20591
20795
  },
20592
20796
  "disabled": {
20593
20797
  "type": "boolean",
@@ -20595,6 +20799,8 @@
20595
20799
  "title": "Disabled",
20596
20800
  "format": "boolean",
20597
20801
  "x-displayname": "Disabled",
20802
+ "x-f5xc-example": "True",
20803
+ "x-f5xc-description-short": "Value of true indicates infraprotect_asn is administratively disabled.",
20598
20804
  "x-f5xc-required-for": {
20599
20805
  "minimum_config": false,
20600
20806
  "create": false,
@@ -20610,6 +20816,8 @@
20610
20816
  "description": "The set of labels present on this infraprotect_asn.",
20611
20817
  "title": "Labels",
20612
20818
  "x-displayname": "Labels",
20819
+ "x-f5xc-example": "{\"key\": \"value\"}",
20820
+ "x-f5xc-description-short": "The set of labels present on this infraprotect_asn.",
20613
20821
  "x-f5xc-required-for": {
20614
20822
  "minimum_config": false,
20615
20823
  "create": false,
@@ -20637,7 +20845,7 @@
20637
20845
  },
20638
20846
  "x-original-maxLength": 1024,
20639
20847
  "x-reconciled-from-discovery": true,
20640
- "x-reconciled-at": "2026-01-05T18:29:26.708007+00:00"
20848
+ "x-reconciled-at": "2026-01-07T15:53:28.316319+00:00"
20641
20849
  },
20642
20850
  "namespace": {
20643
20851
  "type": "string",
@@ -20656,7 +20864,7 @@
20656
20864
  },
20657
20865
  "x-original-maxLength": 1024,
20658
20866
  "x-reconciled-from-discovery": true,
20659
- "x-reconciled-at": "2026-01-05T18:29:26.708011+00:00"
20867
+ "x-reconciled-at": "2026-01-07T15:53:28.316323+00:00"
20660
20868
  },
20661
20869
  "owner_view": {
20662
20870
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -20669,6 +20877,7 @@
20669
20877
  "$ref": "#/components/schemas/infraprotect_asnStatusObject"
20670
20878
  },
20671
20879
  "x-displayname": "Status",
20880
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
20672
20881
  "x-f5xc-required-for": {
20673
20882
  "minimum_config": false,
20674
20883
  "create": false,
@@ -20697,7 +20906,7 @@
20697
20906
  "x-field-mutability": "read-only",
20698
20907
  "x-original-maxLength": 1024,
20699
20908
  "x-reconciled-from-discovery": true,
20700
- "x-reconciled-at": "2026-01-05T18:29:26.708019+00:00"
20909
+ "x-reconciled-at": "2026-01-07T15:53:28.316331+00:00"
20701
20910
  },
20702
20911
  "uid": {
20703
20912
  "type": "string",
@@ -20706,6 +20915,7 @@
20706
20915
  "x-displayname": "UID",
20707
20916
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
20708
20917
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
20918
+ "x-f5xc-description-short": "The unique uid of this infraprotect_asn.",
20709
20919
  "minLength": 0,
20710
20920
  "maxLength": 36,
20711
20921
  "x-f5xc-required-for": {
@@ -20718,9 +20928,11 @@
20718
20928
  "x-original-maxLength": 1024,
20719
20929
  "format": "uuid",
20720
20930
  "x-reconciled-from-discovery": true,
20721
- "x-reconciled-at": "2026-01-05T18:29:26.708025+00:00"
20931
+ "x-reconciled-at": "2026-01-07T15:53:28.316336+00:00"
20722
20932
  }
20723
20933
  },
20934
+ "x-f5xc-description-short": "By default a summary of infraprotect_asn is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
20935
+ "x-f5xc-description-medium": "By default a summary of infraprotect_asn is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
20724
20936
  "x-f5xc-minimum-configuration": {
20725
20937
  "description": "Minimum configuration for infraprotect_asnListResponseItem",
20726
20938
  "required_fields": [
@@ -20815,6 +21027,7 @@
20815
21027
  "$ref": "#/components/schemas/schemaConditionType"
20816
21028
  },
20817
21029
  "x-displayname": "Conditions.",
21030
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
20818
21031
  "x-f5xc-required-for": {
20819
21032
  "minimum_config": false,
20820
21033
  "create": false,
@@ -20870,6 +21083,7 @@
20870
21083
  "x-displayname": "Name",
20871
21084
  "x-ves-example": "Value",
20872
21085
  "x-f5xc-example": "value",
21086
+ "x-f5xc-description-short": "The name of the infraprotect ASN object to be updated.",
20873
21087
  "minLength": 0,
20874
21088
  "maxLength": 16,
20875
21089
  "x-f5xc-required-for": {
@@ -20880,7 +21094,7 @@
20880
21094
  },
20881
21095
  "x-original-maxLength": 1024,
20882
21096
  "x-reconciled-from-discovery": true,
20883
- "x-reconciled-at": "2026-01-05T18:29:26.708050+00:00"
21097
+ "x-reconciled-at": "2026-01-07T15:53:28.316350+00:00"
20884
21098
  },
20885
21099
  "namespace": {
20886
21100
  "type": "string",
@@ -20896,6 +21110,7 @@
20896
21110
  "x-validation-rules": {
20897
21111
  "ves.io.schema.rules.message.required": "true"
20898
21112
  },
21113
+ "x-f5xc-description-short": "Namespace in which the infraprotect ASN review status is to be updated Required: YES.",
20899
21114
  "minLength": 0,
20900
21115
  "maxLength": 6,
20901
21116
  "x-f5xc-required-for": {
@@ -20906,7 +21121,7 @@
20906
21121
  },
20907
21122
  "x-original-maxLength": 1024,
20908
21123
  "x-reconciled-from-discovery": true,
20909
- "x-reconciled-at": "2026-01-05T18:29:26.708055+00:00"
21124
+ "x-reconciled-at": "2026-01-07T15:53:28.316355+00:00"
20910
21125
  },
20911
21126
  "review_type_approved": {
20912
21127
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -20918,6 +21133,7 @@
20918
21133
  "$ref": "#/components/schemas/ioschemaEmpty"
20919
21134
  }
20920
21135
  },
21136
+ "x-f5xc-description-short": "Request to update infraprotect ASN review status.",
20921
21137
  "x-f5xc-minimum-configuration": {
20922
21138
  "description": "Minimum configuration for infraprotect_asnUpdateASNReviewStatusRequest",
20923
21139
  "required_fields": [
@@ -20940,6 +21156,7 @@
20940
21156
  "title": "Update ASN Review Status Response.",
20941
21157
  "x-displayname": "Update ASN Review Status Response.",
20942
21158
  "x-ves-proto-message": "ves.io.schema.infraprotect_asn.UpdateASNReviewStatusResponse",
21159
+ "x-f5xc-description-short": "Response returned from a ASN review status update.",
20943
21160
  "x-f5xc-minimum-configuration": {
20944
21161
  "description": "Minimum configuration for infraprotect_asnUpdateASNReviewStatusResponse",
20945
21162
  "required_fields": [],
@@ -20956,6 +21173,7 @@
20956
21173
  "title": "Empty",
20957
21174
  "x-displayname": "Empty",
20958
21175
  "x-ves-proto-message": "ves.io.schema.Empty",
21176
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
20959
21177
  "x-f5xc-minimum-configuration": {
20960
21178
  "description": "Minimum configuration for ioschemaEmpty",
20961
21179
  "required_fields": [],
@@ -20978,6 +21196,8 @@
20978
21196
  "description": "Hostname of the instance of the site that sent the status.",
20979
21197
  "title": "Hostname",
20980
21198
  "x-displayname": "Hostname",
21199
+ "x-f5xc-example": "example-resource",
21200
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
20981
21201
  "minLength": 0,
20982
21202
  "maxLength": 1024,
20983
21203
  "x-f5xc-required-for": {
@@ -21009,6 +21229,8 @@
21009
21229
  "x-displayname": "Reason",
21010
21230
  "x-ves-example": "Value",
21011
21231
  "x-f5xc-example": "value",
21232
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
21233
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
21012
21234
  "minLength": 0,
21013
21235
  "maxLength": 43,
21014
21236
  "x-f5xc-required-for": {
@@ -21019,13 +21241,15 @@
21019
21241
  },
21020
21242
  "x-original-maxLength": 1024,
21021
21243
  "x-reconciled-from-discovery": true,
21022
- "x-reconciled-at": "2026-01-05T18:29:26.708073+00:00"
21244
+ "x-reconciled-at": "2026-01-07T15:53:28.316373+00:00"
21023
21245
  },
21024
21246
  "service_name": {
21025
21247
  "type": "string",
21026
21248
  "description": "Name of the service that sent the status.",
21027
21249
  "title": "Service name.",
21028
21250
  "x-displayname": "Service Name.",
21251
+ "x-f5xc-example": "example-resource",
21252
+ "x-f5xc-description-short": "Name of the service that sent the status.",
21029
21253
  "minLength": 0,
21030
21254
  "maxLength": 1024,
21031
21255
  "x-f5xc-required-for": {
@@ -21048,6 +21272,8 @@
21048
21272
  "x-validation-rules": {
21049
21273
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
21050
21274
  },
21275
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
21276
+ "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...",
21051
21277
  "minLength": 0,
21052
21278
  "maxLength": 17,
21053
21279
  "x-f5xc-required-for": {
@@ -21058,7 +21284,7 @@
21058
21284
  },
21059
21285
  "x-original-maxLength": 1024,
21060
21286
  "x-reconciled-from-discovery": true,
21061
- "x-reconciled-at": "2026-01-05T18:29:26.708079+00:00"
21287
+ "x-reconciled-at": "2026-01-07T15:53:28.316379+00:00"
21062
21288
  },
21063
21289
  "type": {
21064
21290
  "type": "string",
@@ -21073,6 +21299,8 @@
21073
21299
  "x-validation-rules": {
21074
21300
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
21075
21301
  },
21302
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
21303
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
21076
21304
  "minLength": 0,
21077
21305
  "maxLength": 1024,
21078
21306
  "x-f5xc-required-for": {
@@ -21083,6 +21311,8 @@
21083
21311
  }
21084
21312
  }
21085
21313
  },
21314
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
21315
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
21086
21316
  "x-f5xc-minimum-configuration": {
21087
21317
  "description": "Minimum configuration for schemaConditionType",
21088
21318
  "required_fields": [
@@ -21118,6 +21348,8 @@
21118
21348
  "default": "EOK",
21119
21349
  "x-displayname": "Error Code.",
21120
21350
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
21351
+ "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...",
21352
+ "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...",
21121
21353
  "x-f5xc-minimum-configuration": {
21122
21354
  "description": "Minimum configuration for schemaErrorCode",
21123
21355
  "required_fields": [],
@@ -21158,6 +21390,7 @@
21158
21390
  }
21159
21391
  }
21160
21392
  },
21393
+ "x-f5xc-description-short": "Information about a error in API operation.",
21161
21394
  "x-f5xc-minimum-configuration": {
21162
21395
  "description": "Minimum configuration for schemaErrorType",
21163
21396
  "required_fields": [
@@ -21185,6 +21418,7 @@
21185
21418
  "title": "Name",
21186
21419
  "x-displayname": "Name",
21187
21420
  "x-f5xc-example": "example-resource",
21421
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
21188
21422
  "minLength": 0,
21189
21423
  "maxLength": 16,
21190
21424
  "x-f5xc-required-for": {
@@ -21195,9 +21429,10 @@
21195
21429
  },
21196
21430
  "x-original-maxLength": 1024,
21197
21431
  "x-reconciled-from-discovery": true,
21198
- "x-reconciled-at": "2026-01-05T18:29:26.708090+00:00"
21432
+ "x-reconciled-at": "2026-01-07T15:53:28.316390+00:00"
21199
21433
  }
21200
21434
  },
21435
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
21201
21436
  "x-f5xc-minimum-configuration": {
21202
21437
  "description": "Minimum configuration for schemaInitializerType",
21203
21438
  "required_fields": [
@@ -21225,6 +21460,8 @@
21225
21460
  "$ref": "#/components/schemas/schemaInitializerType"
21226
21461
  },
21227
21462
  "x-displayname": "Pending",
21463
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
21464
+ "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.",
21228
21465
  "x-f5xc-required-for": {
21229
21466
  "minimum_config": false,
21230
21467
  "create": false,
@@ -21236,6 +21473,7 @@
21236
21473
  "$ref": "#/components/schemas/schemaStatusType"
21237
21474
  }
21238
21475
  },
21476
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
21239
21477
  "x-f5xc-minimum-configuration": {
21240
21478
  "description": "Minimum configuration for schemaInitializersType",
21241
21479
  "required_fields": [
@@ -21274,6 +21512,8 @@
21274
21512
  "ves.io.schema.rules.map.values.string.max_len": "1024",
21275
21513
  "ves.io.schema.rules.map.values.string.min_len": "1"
21276
21514
  },
21515
+ "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.",
21516
+ "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.",
21277
21517
  "x-f5xc-required-for": {
21278
21518
  "minimum_config": false,
21279
21519
  "create": false,
@@ -21295,6 +21535,7 @@
21295
21535
  "x-validation-rules": {
21296
21536
  "ves.io.schema.rules.string.max_bytes": "1200"
21297
21537
  },
21538
+ "x-f5xc-description-short": "Human readable description for the object.",
21298
21539
  "minLength": 0,
21299
21540
  "x-f5xc-required-for": {
21300
21541
  "minimum_config": false,
@@ -21304,7 +21545,7 @@
21304
21545
  },
21305
21546
  "x-original-maxLength": 1200,
21306
21547
  "x-reconciled-from-discovery": true,
21307
- "x-reconciled-at": "2026-01-05T18:29:26.708099+00:00"
21548
+ "x-reconciled-at": "2026-01-07T15:53:28.316400+00:00"
21308
21549
  },
21309
21550
  "disable": {
21310
21551
  "type": "boolean",
@@ -21313,6 +21554,7 @@
21313
21554
  "format": "boolean",
21314
21555
  "x-displayname": "Disable",
21315
21556
  "x-f5xc-example": "true",
21557
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
21316
21558
  "x-f5xc-required-for": {
21317
21559
  "minimum_config": false,
21318
21560
  "create": false,
@@ -21326,6 +21568,8 @@
21326
21568
  "title": "Labels",
21327
21569
  "x-displayname": "Labels",
21328
21570
  "x-f5xc-example": "value",
21571
+ "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.",
21572
+ "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.",
21329
21573
  "x-f5xc-required-for": {
21330
21574
  "minimum_config": false,
21331
21575
  "create": false,
@@ -21347,6 +21591,8 @@
21347
21591
  "x-validation-rules": {
21348
21592
  "ves.io.schema.rules.message.required": "true"
21349
21593
  },
21594
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
21595
+ "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.",
21350
21596
  "minLength": 0,
21351
21597
  "maxLength": 16,
21352
21598
  "x-f5xc-required-for": {
@@ -21357,7 +21603,7 @@
21357
21603
  },
21358
21604
  "x-original-maxLength": 1024,
21359
21605
  "x-reconciled-from-discovery": true,
21360
- "x-reconciled-at": "2026-01-05T18:29:26.708106+00:00"
21606
+ "x-reconciled-at": "2026-01-07T15:53:28.316407+00:00"
21361
21607
  },
21362
21608
  "namespace": {
21363
21609
  "type": "string",
@@ -21366,6 +21612,8 @@
21366
21612
  "x-displayname": "Namespace",
21367
21613
  "x-ves-example": "Staging",
21368
21614
  "x-f5xc-example": "staging",
21615
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
21616
+ "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 \"\".",
21369
21617
  "minLength": 0,
21370
21618
  "maxLength": 6,
21371
21619
  "x-f5xc-required-for": {
@@ -21376,9 +21624,10 @@
21376
21624
  },
21377
21625
  "x-original-maxLength": 1024,
21378
21626
  "x-reconciled-from-discovery": true,
21379
- "x-reconciled-at": "2026-01-05T18:29:26.708111+00:00"
21627
+ "x-reconciled-at": "2026-01-07T15:53:28.316411+00:00"
21380
21628
  }
21381
21629
  },
21630
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
21382
21631
  "x-f5xc-minimum-configuration": {
21383
21632
  "description": "Minimum configuration for schemaObjectCreateMetaType",
21384
21633
  "required_fields": [
@@ -21422,6 +21671,8 @@
21422
21671
  "ves.io.schema.rules.map.values.string.max_len": "1024",
21423
21672
  "ves.io.schema.rules.map.values.string.min_len": "1"
21424
21673
  },
21674
+ "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.",
21675
+ "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.",
21425
21676
  "x-f5xc-required-for": {
21426
21677
  "minimum_config": false,
21427
21678
  "create": false,
@@ -21443,6 +21694,7 @@
21443
21694
  "x-validation-rules": {
21444
21695
  "ves.io.schema.rules.string.max_bytes": "1200"
21445
21696
  },
21697
+ "x-f5xc-description-short": "Human readable description for the object.",
21446
21698
  "minLength": 0,
21447
21699
  "x-f5xc-required-for": {
21448
21700
  "minimum_config": false,
@@ -21452,7 +21704,7 @@
21452
21704
  },
21453
21705
  "x-original-maxLength": 1200,
21454
21706
  "x-reconciled-from-discovery": true,
21455
- "x-reconciled-at": "2026-01-05T18:29:26.708118+00:00"
21707
+ "x-reconciled-at": "2026-01-07T15:53:28.316417+00:00"
21456
21708
  },
21457
21709
  "disable": {
21458
21710
  "type": "boolean",
@@ -21462,6 +21714,7 @@
21462
21714
  "x-displayname": "Disable",
21463
21715
  "x-ves-example": "True",
21464
21716
  "x-f5xc-example": "true",
21717
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
21465
21718
  "x-f5xc-required-for": {
21466
21719
  "minimum_config": false,
21467
21720
  "create": false,
@@ -21476,6 +21729,8 @@
21476
21729
  "x-displayname": "Labels",
21477
21730
  "x-ves-example": "Value",
21478
21731
  "x-f5xc-example": "value",
21732
+ "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.",
21733
+ "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.",
21479
21734
  "x-f5xc-required-for": {
21480
21735
  "minimum_config": false,
21481
21736
  "create": false,
@@ -21497,6 +21752,8 @@
21497
21752
  "x-validation-rules": {
21498
21753
  "ves.io.schema.rules.message.required": "true"
21499
21754
  },
21755
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
21756
+ "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.",
21500
21757
  "minLength": 0,
21501
21758
  "maxLength": 16,
21502
21759
  "x-f5xc-required-for": {
@@ -21507,7 +21764,7 @@
21507
21764
  },
21508
21765
  "x-original-maxLength": 1024,
21509
21766
  "x-reconciled-from-discovery": true,
21510
- "x-reconciled-at": "2026-01-05T18:29:26.708126+00:00"
21767
+ "x-reconciled-at": "2026-01-07T15:53:28.316424+00:00"
21511
21768
  },
21512
21769
  "namespace": {
21513
21770
  "type": "string",
@@ -21516,6 +21773,8 @@
21516
21773
  "x-displayname": "Namespace",
21517
21774
  "x-ves-example": "Staging",
21518
21775
  "x-f5xc-example": "staging",
21776
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
21777
+ "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 \"\".",
21519
21778
  "minLength": 0,
21520
21779
  "maxLength": 6,
21521
21780
  "x-f5xc-required-for": {
@@ -21526,9 +21785,10 @@
21526
21785
  },
21527
21786
  "x-original-maxLength": 1024,
21528
21787
  "x-reconciled-from-discovery": true,
21529
- "x-reconciled-at": "2026-01-05T18:29:26.708130+00:00"
21788
+ "x-reconciled-at": "2026-01-07T15:53:28.316428+00:00"
21530
21789
  }
21531
21790
  },
21791
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
21532
21792
  "x-f5xc-minimum-configuration": {
21533
21793
  "description": "Minimum configuration for schemaObjectGetMetaType",
21534
21794
  "required_fields": [
@@ -21560,6 +21820,8 @@
21560
21820
  "x-displayname": "Kind",
21561
21821
  "x-ves-example": "Virtual_site.",
21562
21822
  "x-f5xc-example": "virtual_site",
21823
+ "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\")",
21824
+ "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\").",
21563
21825
  "minLength": 0,
21564
21826
  "maxLength": 14,
21565
21827
  "x-f5xc-required-for": {
@@ -21571,7 +21833,7 @@
21571
21833
  "readOnly": true,
21572
21834
  "x-original-maxLength": 1024,
21573
21835
  "x-reconciled-from-discovery": true,
21574
- "x-reconciled-at": "2026-01-05T18:29:26.708135+00:00"
21836
+ "x-reconciled-at": "2026-01-07T15:53:28.316433+00:00"
21575
21837
  },
21576
21838
  "name": {
21577
21839
  "type": "string",
@@ -21580,6 +21842,8 @@
21580
21842
  "x-displayname": "Name",
21581
21843
  "x-ves-example": "Contactus-route.",
21582
21844
  "x-f5xc-example": "contactus-route",
21845
+ "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.",
21846
+ "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.",
21583
21847
  "minLength": 0,
21584
21848
  "maxLength": 16,
21585
21849
  "x-f5xc-required-for": {
@@ -21590,7 +21854,7 @@
21590
21854
  },
21591
21855
  "x-original-maxLength": 1024,
21592
21856
  "x-reconciled-from-discovery": true,
21593
- "x-reconciled-at": "2026-01-05T18:29:26.708139+00:00"
21857
+ "x-reconciled-at": "2026-01-07T15:53:28.316436+00:00"
21594
21858
  },
21595
21859
  "namespace": {
21596
21860
  "type": "string",
@@ -21599,6 +21863,8 @@
21599
21863
  "x-displayname": "Namespace",
21600
21864
  "x-ves-example": "Ns1",
21601
21865
  "x-f5xc-example": "ns1",
21866
+ "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.",
21867
+ "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.",
21602
21868
  "minLength": 0,
21603
21869
  "maxLength": 6,
21604
21870
  "x-f5xc-required-for": {
@@ -21609,7 +21875,7 @@
21609
21875
  },
21610
21876
  "x-original-maxLength": 1024,
21611
21877
  "x-reconciled-from-discovery": true,
21612
- "x-reconciled-at": "2026-01-05T18:29:26.708143+00:00"
21878
+ "x-reconciled-at": "2026-01-07T15:53:28.316440+00:00"
21613
21879
  },
21614
21880
  "tenant": {
21615
21881
  "type": "string",
@@ -21618,6 +21884,8 @@
21618
21884
  "x-displayname": "Tenant",
21619
21885
  "x-ves-example": "Example-corp.",
21620
21886
  "x-f5xc-example": "example-corp",
21887
+ "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.",
21888
+ "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.",
21621
21889
  "minLength": 0,
21622
21890
  "maxLength": 18,
21623
21891
  "x-f5xc-required-for": {
@@ -21630,7 +21898,7 @@
21630
21898
  "x-field-mutability": "read-only",
21631
21899
  "x-original-maxLength": 1024,
21632
21900
  "x-reconciled-from-discovery": true,
21633
- "x-reconciled-at": "2026-01-05T18:29:26.708147+00:00"
21901
+ "x-reconciled-at": "2026-01-07T15:53:28.316444+00:00"
21634
21902
  },
21635
21903
  "uid": {
21636
21904
  "type": "string",
@@ -21639,6 +21907,8 @@
21639
21907
  "x-displayname": "UID",
21640
21908
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
21641
21909
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
21910
+ "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.",
21911
+ "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.",
21642
21912
  "minLength": 0,
21643
21913
  "maxLength": 36,
21644
21914
  "x-f5xc-required-for": {
@@ -21652,9 +21922,11 @@
21652
21922
  "x-original-maxLength": 1024,
21653
21923
  "format": "uuid",
21654
21924
  "x-reconciled-from-discovery": true,
21655
- "x-reconciled-at": "2026-01-05T18:29:26.708153+00:00"
21925
+ "x-reconciled-at": "2026-01-07T15:53:28.316450+00:00"
21656
21926
  }
21657
21927
  },
21928
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
21929
+ "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...",
21658
21930
  "x-f5xc-minimum-configuration": {
21659
21931
  "description": "Minimum configuration for schemaObjectRefType",
21660
21932
  "required_fields": [
@@ -21697,6 +21969,8 @@
21697
21969
  "ves.io.schema.rules.map.values.string.max_len": "1024",
21698
21970
  "ves.io.schema.rules.map.values.string.min_len": "1"
21699
21971
  },
21972
+ "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.",
21973
+ "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.",
21700
21974
  "x-f5xc-required-for": {
21701
21975
  "minimum_config": false,
21702
21976
  "create": false,
@@ -21718,6 +21992,7 @@
21718
21992
  "x-validation-rules": {
21719
21993
  "ves.io.schema.rules.string.max_bytes": "1200"
21720
21994
  },
21995
+ "x-f5xc-description-short": "Human readable description for the object.",
21721
21996
  "minLength": 0,
21722
21997
  "x-f5xc-required-for": {
21723
21998
  "minimum_config": false,
@@ -21727,7 +22002,7 @@
21727
22002
  },
21728
22003
  "x-original-maxLength": 1200,
21729
22004
  "x-reconciled-from-discovery": true,
21730
- "x-reconciled-at": "2026-01-05T18:29:26.708159+00:00"
22005
+ "x-reconciled-at": "2026-01-07T15:53:28.316456+00:00"
21731
22006
  },
21732
22007
  "disable": {
21733
22008
  "type": "boolean",
@@ -21736,6 +22011,7 @@
21736
22011
  "format": "boolean",
21737
22012
  "x-displayname": "Disable",
21738
22013
  "x-f5xc-example": "true",
22014
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
21739
22015
  "x-f5xc-required-for": {
21740
22016
  "minimum_config": false,
21741
22017
  "create": false,
@@ -21750,6 +22026,8 @@
21750
22026
  "x-displayname": "Labels",
21751
22027
  "x-ves-example": "Value",
21752
22028
  "x-f5xc-example": "value",
22029
+ "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.",
22030
+ "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.",
21753
22031
  "x-f5xc-required-for": {
21754
22032
  "minimum_config": false,
21755
22033
  "create": false,
@@ -21770,6 +22048,8 @@
21770
22048
  "x-validation-rules": {
21771
22049
  "ves.io.schema.rules.message.required": "true"
21772
22050
  },
22051
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
22052
+ "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.",
21773
22053
  "minLength": 0,
21774
22054
  "maxLength": 16,
21775
22055
  "x-f5xc-required-for": {
@@ -21780,7 +22060,7 @@
21780
22060
  },
21781
22061
  "x-original-maxLength": 1024,
21782
22062
  "x-reconciled-from-discovery": true,
21783
- "x-reconciled-at": "2026-01-05T18:29:26.708166+00:00"
22063
+ "x-reconciled-at": "2026-01-07T15:53:28.316464+00:00"
21784
22064
  },
21785
22065
  "namespace": {
21786
22066
  "type": "string",
@@ -21789,6 +22069,8 @@
21789
22069
  "x-displayname": "Namespace",
21790
22070
  "x-ves-example": "Staging",
21791
22071
  "x-f5xc-example": "staging",
22072
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
22073
+ "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 \"\".",
21792
22074
  "minLength": 0,
21793
22075
  "maxLength": 6,
21794
22076
  "x-f5xc-required-for": {
@@ -21799,9 +22081,10 @@
21799
22081
  },
21800
22082
  "x-original-maxLength": 1024,
21801
22083
  "x-reconciled-from-discovery": true,
21802
- "x-reconciled-at": "2026-01-05T18:29:26.708171+00:00"
22084
+ "x-reconciled-at": "2026-01-07T15:53:28.316468+00:00"
21803
22085
  }
21804
22086
  },
22087
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
21805
22088
  "x-f5xc-minimum-configuration": {
21806
22089
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
21807
22090
  "required_fields": [
@@ -21832,6 +22115,8 @@
21832
22115
  "title": "Creation_timestamp.",
21833
22116
  "format": "date-time",
21834
22117
  "x-displayname": "Creation Timestamp.",
22118
+ "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.",
22119
+ "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.",
21835
22120
  "minLength": 0,
21836
22121
  "maxLength": 1024,
21837
22122
  "x-f5xc-required-for": {
@@ -21849,6 +22134,8 @@
21849
22134
  "x-displayname": "Creator Class.",
21850
22135
  "x-ves-example": "ver.re1.int.ves.I/O.",
21851
22136
  "x-f5xc-example": "ver.re1.int.F5 XC",
22137
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
22138
+ "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.",
21852
22139
  "minLength": 0,
21853
22140
  "maxLength": 1024,
21854
22141
  "x-f5xc-required-for": {
@@ -21866,6 +22153,8 @@
21866
22153
  "x-displayname": "Creator ID.",
21867
22154
  "x-ves-example": "Ver-instance-1.",
21868
22155
  "x-f5xc-example": "ver-instance-1",
22156
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
22157
+ "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.",
21869
22158
  "minLength": 0,
21870
22159
  "maxLength": 1024,
21871
22160
  "x-f5xc-required-for": {
@@ -21884,6 +22173,8 @@
21884
22173
  "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)",
21885
22174
  "title": "Status_id",
21886
22175
  "x-displayname": "Status ID",
22176
+ "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...",
22177
+ "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).",
21887
22178
  "minLength": 0,
21888
22179
  "maxLength": 1024,
21889
22180
  "x-f5xc-required-for": {
@@ -21901,6 +22192,7 @@
21901
22192
  "x-displayname": "UID",
21902
22193
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
21903
22194
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
22195
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
21904
22196
  "minLength": 0,
21905
22197
  "maxLength": 36,
21906
22198
  "x-f5xc-required-for": {
@@ -21913,13 +22205,14 @@
21913
22205
  "x-original-maxLength": 1024,
21914
22206
  "format": "uuid",
21915
22207
  "x-reconciled-from-discovery": true,
21916
- "x-reconciled-at": "2026-01-05T18:29:26.708183+00:00"
22208
+ "x-reconciled-at": "2026-01-07T15:53:28.316480+00:00"
21917
22209
  },
21918
22210
  "vtrp_id": {
21919
22211
  "type": "string",
21920
22212
  "description": "Origin of this status exchanged by VTRP.",
21921
22213
  "title": "Vtrp_id",
21922
22214
  "x-displayname": "VTRP ID",
22215
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
21923
22216
  "minLength": 0,
21924
22217
  "maxLength": 1024,
21925
22218
  "x-f5xc-required-for": {
@@ -21936,6 +22229,7 @@
21936
22229
  "title": "Vtrp_stale.",
21937
22230
  "format": "boolean",
21938
22231
  "x-displayname": "VTRP Stale.",
22232
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
21939
22233
  "x-f5xc-required-for": {
21940
22234
  "minimum_config": false,
21941
22235
  "create": false,
@@ -21944,6 +22238,7 @@
21944
22238
  }
21945
22239
  }
21946
22240
  },
22241
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
21947
22242
  "x-f5xc-minimum-configuration": {
21948
22243
  "description": "Minimum configuration for schemaStatusMetaType",
21949
22244
  "required_fields": [
@@ -21974,6 +22269,8 @@
21974
22269
  "default": "STATUS_DO_NOT_PUBLISH",
21975
22270
  "x-displayname": "Status Publish Type.",
21976
22271
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
22272
+ "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.",
22273
+ "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.",
21977
22274
  "x-f5xc-minimum-configuration": {
21978
22275
  "description": "Minimum configuration for schemaStatusPublishType",
21979
22276
  "required_fields": [],
@@ -21999,6 +22296,7 @@
21999
22296
  "x-displayname": "Code",
22000
22297
  "x-ves-example": "0",
22001
22298
  "x-f5xc-example": "0",
22299
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
22002
22300
  "minimum": 0,
22003
22301
  "maximum": 2147483647,
22004
22302
  "x-f5xc-required-for": {
@@ -22015,6 +22313,8 @@
22015
22313
  "x-displayname": "Reason",
22016
22314
  "x-ves-example": "Value",
22017
22315
  "x-f5xc-example": "value",
22316
+ "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.",
22317
+ "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.",
22018
22318
  "minLength": 0,
22019
22319
  "maxLength": 43,
22020
22320
  "x-f5xc-required-for": {
@@ -22025,7 +22325,7 @@
22025
22325
  },
22026
22326
  "x-original-maxLength": 1024,
22027
22327
  "x-reconciled-from-discovery": true,
22028
- "x-reconciled-at": "2026-01-05T18:29:26.708193+00:00"
22328
+ "x-reconciled-at": "2026-01-07T15:53:28.316490+00:00"
22029
22329
  },
22030
22330
  "status": {
22031
22331
  "type": "string",
@@ -22034,6 +22334,7 @@
22034
22334
  "x-displayname": "Status",
22035
22335
  "x-ves-example": "Value",
22036
22336
  "x-f5xc-example": "value",
22337
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
22037
22338
  "minLength": 0,
22038
22339
  "maxLength": 17,
22039
22340
  "x-f5xc-required-for": {
@@ -22044,9 +22345,10 @@
22044
22345
  },
22045
22346
  "x-original-maxLength": 1024,
22046
22347
  "x-reconciled-from-discovery": true,
22047
- "x-reconciled-at": "2026-01-05T18:29:26.708198+00:00"
22348
+ "x-reconciled-at": "2026-01-07T15:53:28.316493+00:00"
22048
22349
  }
22049
22350
  },
22351
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
22050
22352
  "x-f5xc-minimum-configuration": {
22051
22353
  "description": "Minimum configuration for schemaStatusType",
22052
22354
  "required_fields": [
@@ -22074,6 +22376,8 @@
22074
22376
  "title": "Creation_timestamp.",
22075
22377
  "format": "date-time",
22076
22378
  "x-displayname": "Creation Timestamp.",
22379
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
22380
+ "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.",
22077
22381
  "minLength": 0,
22078
22382
  "maxLength": 1024,
22079
22383
  "x-f5xc-required-for": {
@@ -22091,6 +22395,7 @@
22091
22395
  "x-displayname": "Creator Class.",
22092
22396
  "x-ves-example": "Prism",
22093
22397
  "x-f5xc-example": "value",
22398
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
22094
22399
  "minLength": 0,
22095
22400
  "maxLength": 1024,
22096
22401
  "x-f5xc-required-for": {
@@ -22108,6 +22413,7 @@
22108
22413
  "x-displayname": "Creator ID.",
22109
22414
  "x-ves-example": "Admin@example-corp.com.",
22110
22415
  "x-f5xc-example": "value",
22416
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
22111
22417
  "minLength": 0,
22112
22418
  "maxLength": 1024,
22113
22419
  "x-f5xc-required-for": {
@@ -22124,6 +22430,8 @@
22124
22430
  "title": "Deletion_timestamp.",
22125
22431
  "format": "date-time",
22126
22432
  "x-displayname": "Deletion Timestamp.",
22433
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
22434
+ "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...",
22127
22435
  "minLength": 0,
22128
22436
  "maxLength": 1024,
22129
22437
  "x-f5xc-required-for": {
@@ -22143,6 +22451,8 @@
22143
22451
  "x-displayname": "Finalizers.",
22144
22452
  "x-ves-example": "Value",
22145
22453
  "x-f5xc-example": "value",
22454
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
22455
+ "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.",
22146
22456
  "x-f5xc-required-for": {
22147
22457
  "minimum_config": false,
22148
22458
  "create": false,
@@ -22160,6 +22470,8 @@
22160
22470
  "x-displayname": "Labels",
22161
22471
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
22162
22472
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
22473
+ "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.",
22474
+ "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).",
22163
22475
  "x-f5xc-required-for": {
22164
22476
  "minimum_config": false,
22165
22477
  "create": false,
@@ -22173,6 +22485,8 @@
22173
22485
  "title": "Modification_timestamp.",
22174
22486
  "format": "date-time",
22175
22487
  "x-displayname": "Modification Timestamp.",
22488
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
22489
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
22176
22490
  "minLength": 0,
22177
22491
  "maxLength": 1024,
22178
22492
  "x-f5xc-required-for": {
@@ -22191,6 +22505,8 @@
22191
22505
  "x-displayname": "Object Index.",
22192
22506
  "x-ves-example": "0",
22193
22507
  "x-f5xc-example": "0",
22508
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
22509
+ "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.",
22194
22510
  "minimum": 0,
22195
22511
  "maximum": 2147483647,
22196
22512
  "x-f5xc-required-for": {
@@ -22211,6 +22527,8 @@
22211
22527
  "x-displayname": "Tenant",
22212
22528
  "x-ves-example": "Example-corp.",
22213
22529
  "x-f5xc-example": "example-corp",
22530
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
22531
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
22214
22532
  "minLength": 0,
22215
22533
  "maxLength": 18,
22216
22534
  "x-f5xc-required-for": {
@@ -22222,7 +22540,7 @@
22222
22540
  "x-field-mutability": "read-only",
22223
22541
  "x-original-maxLength": 1024,
22224
22542
  "x-reconciled-from-discovery": true,
22225
- "x-reconciled-at": "2026-01-05T18:29:26.708217+00:00"
22543
+ "x-reconciled-at": "2026-01-07T15:53:28.316512+00:00"
22226
22544
  },
22227
22545
  "uid": {
22228
22546
  "type": "string",
@@ -22231,6 +22549,8 @@
22231
22549
  "x-displayname": "UID",
22232
22550
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
22233
22551
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
22552
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
22553
+ "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.",
22234
22554
  "minLength": 0,
22235
22555
  "maxLength": 36,
22236
22556
  "x-f5xc-required-for": {
@@ -22243,9 +22563,11 @@
22243
22563
  "x-original-maxLength": 1024,
22244
22564
  "format": "uuid",
22245
22565
  "x-reconciled-from-discovery": true,
22246
- "x-reconciled-at": "2026-01-05T18:29:26.708222+00:00"
22566
+ "x-reconciled-at": "2026-01-07T15:53:28.316517+00:00"
22247
22567
  }
22248
22568
  },
22569
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
22570
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
22249
22571
  "x-f5xc-minimum-configuration": {
22250
22572
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
22251
22573
  "required_fields": [
@@ -22293,7 +22615,7 @@
22293
22615
  },
22294
22616
  "x-original-maxLength": 1024,
22295
22617
  "x-reconciled-from-discovery": true,
22296
- "x-reconciled-at": "2026-01-05T18:29:26.708226+00:00"
22618
+ "x-reconciled-at": "2026-01-07T15:53:28.316522+00:00"
22297
22619
  },
22298
22620
  "name": {
22299
22621
  "type": "string",
@@ -22302,6 +22624,8 @@
22302
22624
  "x-displayname": "Name",
22303
22625
  "x-ves-example": "Contactus-route.",
22304
22626
  "x-f5xc-example": "contactus-route",
22627
+ "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.",
22628
+ "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.",
22305
22629
  "minLength": 0,
22306
22630
  "maxLength": 16,
22307
22631
  "x-f5xc-required-for": {
@@ -22312,7 +22636,7 @@
22312
22636
  },
22313
22637
  "x-original-maxLength": 1024,
22314
22638
  "x-reconciled-from-discovery": true,
22315
- "x-reconciled-at": "2026-01-05T18:29:26.708231+00:00"
22639
+ "x-reconciled-at": "2026-01-07T15:53:28.316526+00:00"
22316
22640
  },
22317
22641
  "namespace": {
22318
22642
  "type": "string",
@@ -22321,6 +22645,8 @@
22321
22645
  "x-displayname": "Namespace",
22322
22646
  "x-ves-example": "Ns1",
22323
22647
  "x-f5xc-example": "ns1",
22648
+ "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.",
22649
+ "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.",
22324
22650
  "minLength": 0,
22325
22651
  "maxLength": 6,
22326
22652
  "x-f5xc-required-for": {
@@ -22331,7 +22657,7 @@
22331
22657
  },
22332
22658
  "x-original-maxLength": 1024,
22333
22659
  "x-reconciled-from-discovery": true,
22334
- "x-reconciled-at": "2026-01-05T18:29:26.708235+00:00"
22660
+ "x-reconciled-at": "2026-01-07T15:53:28.316530+00:00"
22335
22661
  },
22336
22662
  "uid": {
22337
22663
  "type": "string",
@@ -22352,9 +22678,10 @@
22352
22678
  "x-original-maxLength": 1024,
22353
22679
  "format": "uuid",
22354
22680
  "x-reconciled-from-discovery": true,
22355
- "x-reconciled-at": "2026-01-05T18:29:26.708240+00:00"
22681
+ "x-reconciled-at": "2026-01-07T15:53:28.316534+00:00"
22356
22682
  }
22357
22683
  },
22684
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
22358
22685
  "x-f5xc-minimum-configuration": {
22359
22686
  "description": "Minimum configuration for schemaViewRefType",
22360
22687
  "required_fields": [
@@ -22486,6 +22813,7 @@
22486
22813
  "title": "Fail_if_referred.",
22487
22814
  "format": "boolean",
22488
22815
  "x-displayname": "Fail-If-Referred.",
22816
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
22489
22817
  "x-f5xc-required-for": {
22490
22818
  "minimum_config": false,
22491
22819
  "create": false,
@@ -22510,7 +22838,7 @@
22510
22838
  },
22511
22839
  "x-original-maxLength": 1024,
22512
22840
  "x-reconciled-from-discovery": true,
22513
- "x-reconciled-at": "2026-01-05T18:29:27.052011+00:00"
22841
+ "x-reconciled-at": "2026-01-07T15:53:28.757743+00:00"
22514
22842
  },
22515
22843
  "namespace": {
22516
22844
  "type": "string",
@@ -22519,6 +22847,7 @@
22519
22847
  "x-displayname": "Namespace",
22520
22848
  "x-ves-example": "Ns1",
22521
22849
  "x-f5xc-example": "ns1",
22850
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
22522
22851
  "minLength": 0,
22523
22852
  "maxLength": 6,
22524
22853
  "x-f5xc-required-for": {
@@ -22529,7 +22858,7 @@
22529
22858
  },
22530
22859
  "x-original-maxLength": 1024,
22531
22860
  "x-reconciled-from-discovery": true,
22532
- "x-reconciled-at": "2026-01-05T18:29:27.052018+00:00"
22861
+ "x-reconciled-at": "2026-01-07T15:53:28.757751+00:00"
22533
22862
  }
22534
22863
  },
22535
22864
  "x-f5xc-minimum-configuration": {
@@ -22564,6 +22893,7 @@
22564
22893
  "$ref": "#/components/schemas/ioschemaObjectRefType"
22565
22894
  },
22566
22895
  "x-displayname": "Deleted Referred Objects.",
22896
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
22567
22897
  "x-f5xc-required-for": {
22568
22898
  "minimum_config": false,
22569
22899
  "create": false,
@@ -22579,6 +22909,7 @@
22579
22909
  "$ref": "#/components/schemas/ioschemaObjectRefType"
22580
22910
  },
22581
22911
  "x-displayname": "Disabled Referred Objects.",
22912
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
22582
22913
  "x-f5xc-required-for": {
22583
22914
  "minimum_config": false,
22584
22915
  "create": false,
@@ -22597,6 +22928,7 @@
22597
22928
  "$ref": "#/components/schemas/ioschemaObjectRefType"
22598
22929
  },
22599
22930
  "x-displayname": "Referring Objects.",
22931
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
22600
22932
  "x-f5xc-required-for": {
22601
22933
  "minimum_config": false,
22602
22934
  "create": false,
@@ -22618,6 +22950,8 @@
22618
22950
  "$ref": "#/components/schemas/infraprotect_asn_prefixStatusObject"
22619
22951
  },
22620
22952
  "x-displayname": "Status",
22953
+ "x-f5xc-example": "active",
22954
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
22621
22955
  "x-f5xc-required-for": {
22622
22956
  "minimum_config": false,
22623
22957
  "create": false,
@@ -22627,7 +22961,7 @@
22627
22961
  "maxLength": 17,
22628
22962
  "minLength": 17,
22629
22963
  "x-reconciled-from-discovery": true,
22630
- "x-reconciled-at": "2026-01-05T18:29:27.052048+00:00"
22964
+ "x-reconciled-at": "2026-01-07T15:53:28.757767+00:00"
22631
22965
  },
22632
22966
  "system_metadata": {
22633
22967
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -22667,6 +23001,8 @@
22667
23001
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
22668
23002
  ],
22669
23003
  "default": "GET_RSP_FORMAT_DEFAULT",
23004
+ "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...",
23005
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
22670
23006
  "x-f5xc-minimum-configuration": {
22671
23007
  "description": "Minimum configuration for infraprotect_asn_prefixGetResponseFormatCode",
22672
23008
  "required_fields": [],
@@ -22818,6 +23154,7 @@
22818
23154
  "$ref": "#/components/schemas/schemaErrorType"
22819
23155
  },
22820
23156
  "x-displayname": "Errors",
23157
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
22821
23158
  "x-f5xc-required-for": {
22822
23159
  "minimum_config": false,
22823
23160
  "create": false,
@@ -22833,6 +23170,8 @@
22833
23170
  "$ref": "#/components/schemas/infraprotect_asn_prefixListResponseItem"
22834
23171
  },
22835
23172
  "x-displayname": "Items",
23173
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
23174
+ "x-f5xc-description-short": "Items represents the collection in response.",
22836
23175
  "x-f5xc-required-for": {
22837
23176
  "minimum_config": false,
22838
23177
  "create": false,
@@ -22866,6 +23205,8 @@
22866
23205
  "description": "The set of annotations present on this infraprotect_asn_prefix.",
22867
23206
  "title": "Annotations.",
22868
23207
  "x-displayname": "Annotations.",
23208
+ "x-f5xc-example": "{\"key\": \"value\"}",
23209
+ "x-f5xc-description-short": "The set of annotations present on this infraprotect_asn_prefix.",
22869
23210
  "x-f5xc-required-for": {
22870
23211
  "minimum_config": false,
22871
23212
  "create": false,
@@ -22878,6 +23219,7 @@
22878
23219
  "description": "The description set for this infraprotect_asn_prefix.",
22879
23220
  "title": "Description.",
22880
23221
  "x-displayname": "Description.",
23222
+ "x-f5xc-description-short": "The description set for this infraprotect_asn_prefix.",
22881
23223
  "minLength": 0,
22882
23224
  "maxLength": 0,
22883
23225
  "x-f5xc-required-for": {
@@ -22888,7 +23230,7 @@
22888
23230
  },
22889
23231
  "x-original-maxLength": 1024,
22890
23232
  "x-reconciled-from-discovery": true,
22891
- "x-reconciled-at": "2026-01-05T18:29:27.052079+00:00"
23233
+ "x-reconciled-at": "2026-01-07T15:53:28.757797+00:00"
22892
23234
  },
22893
23235
  "disabled": {
22894
23236
  "type": "boolean",
@@ -22896,6 +23238,8 @@
22896
23238
  "title": "Disabled",
22897
23239
  "format": "boolean",
22898
23240
  "x-displayname": "Disabled",
23241
+ "x-f5xc-example": "True",
23242
+ "x-f5xc-description-short": "Value of true indicates infraprotect_asn_prefix is administratively disabled.",
22899
23243
  "x-f5xc-required-for": {
22900
23244
  "minimum_config": false,
22901
23245
  "create": false,
@@ -22911,6 +23255,8 @@
22911
23255
  "description": "The set of labels present on this infraprotect_asn_prefix.",
22912
23256
  "title": "Labels",
22913
23257
  "x-displayname": "Labels",
23258
+ "x-f5xc-example": "{\"key\": \"value\"}",
23259
+ "x-f5xc-description-short": "The set of labels present on this infraprotect_asn_prefix.",
22914
23260
  "x-f5xc-required-for": {
22915
23261
  "minimum_config": false,
22916
23262
  "create": false,
@@ -22928,6 +23274,7 @@
22928
23274
  "x-displayname": "Name",
22929
23275
  "x-ves-example": "Name",
22930
23276
  "x-f5xc-example": "name",
23277
+ "x-f5xc-description-short": "The name of this infraprotect_asn_prefix.",
22931
23278
  "minLength": 0,
22932
23279
  "maxLength": 16,
22933
23280
  "x-f5xc-required-for": {
@@ -22938,7 +23285,7 @@
22938
23285
  },
22939
23286
  "x-original-maxLength": 1024,
22940
23287
  "x-reconciled-from-discovery": true,
22941
- "x-reconciled-at": "2026-01-05T18:29:27.052090+00:00"
23288
+ "x-reconciled-at": "2026-01-07T15:53:28.757808+00:00"
22942
23289
  },
22943
23290
  "namespace": {
22944
23291
  "type": "string",
@@ -22957,7 +23304,7 @@
22957
23304
  },
22958
23305
  "x-original-maxLength": 1024,
22959
23306
  "x-reconciled-from-discovery": true,
22960
- "x-reconciled-at": "2026-01-05T18:29:27.052094+00:00"
23307
+ "x-reconciled-at": "2026-01-07T15:53:28.757813+00:00"
22961
23308
  },
22962
23309
  "owner_view": {
22963
23310
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -22970,6 +23317,7 @@
22970
23317
  "$ref": "#/components/schemas/infraprotect_asn_prefixStatusObject"
22971
23318
  },
22972
23319
  "x-displayname": "Status",
23320
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
22973
23321
  "x-f5xc-required-for": {
22974
23322
  "minimum_config": false,
22975
23323
  "create": false,
@@ -22998,7 +23346,7 @@
22998
23346
  "x-field-mutability": "read-only",
22999
23347
  "x-original-maxLength": 1024,
23000
23348
  "x-reconciled-from-discovery": true,
23001
- "x-reconciled-at": "2026-01-05T18:29:27.052102+00:00"
23349
+ "x-reconciled-at": "2026-01-07T15:53:28.757821+00:00"
23002
23350
  },
23003
23351
  "uid": {
23004
23352
  "type": "string",
@@ -23007,6 +23355,7 @@
23007
23355
  "x-displayname": "UID",
23008
23356
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
23009
23357
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
23358
+ "x-f5xc-description-short": "The unique uid of this infraprotect_asn_prefix.",
23010
23359
  "minLength": 0,
23011
23360
  "maxLength": 36,
23012
23361
  "x-f5xc-required-for": {
@@ -23019,9 +23368,11 @@
23019
23368
  "x-original-maxLength": 1024,
23020
23369
  "format": "uuid",
23021
23370
  "x-reconciled-from-discovery": true,
23022
- "x-reconciled-at": "2026-01-05T18:29:27.052108+00:00"
23371
+ "x-reconciled-at": "2026-01-07T15:53:28.757827+00:00"
23023
23372
  }
23024
23373
  },
23374
+ "x-f5xc-description-short": "By default a summary of infraprotect_asn_prefix is returned in 'List'.",
23375
+ "x-f5xc-description-medium": "By default a summary of infraprotect_asn_prefix is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
23025
23376
  "x-f5xc-minimum-configuration": {
23026
23377
  "description": "Minimum configuration for infraprotect_asn_prefixListResponseItem",
23027
23378
  "required_fields": [
@@ -23116,6 +23467,7 @@
23116
23467
  "$ref": "#/components/schemas/schemaConditionType"
23117
23468
  },
23118
23469
  "x-displayname": "Conditions.",
23470
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
23119
23471
  "x-f5xc-required-for": {
23120
23472
  "minimum_config": false,
23121
23473
  "create": false,
@@ -23171,6 +23523,7 @@
23171
23523
  "x-displayname": "Name",
23172
23524
  "x-ves-example": "Value",
23173
23525
  "x-f5xc-example": "value",
23526
+ "x-f5xc-description-short": "The name of the infraprotect ASN prefix object to be updated.",
23174
23527
  "minLength": 0,
23175
23528
  "maxLength": 16,
23176
23529
  "x-f5xc-required-for": {
@@ -23181,7 +23534,7 @@
23181
23534
  },
23182
23535
  "x-original-maxLength": 1024,
23183
23536
  "x-reconciled-from-discovery": true,
23184
- "x-reconciled-at": "2026-01-05T18:29:27.052122+00:00"
23537
+ "x-reconciled-at": "2026-01-07T15:53:28.757846+00:00"
23185
23538
  },
23186
23539
  "namespace": {
23187
23540
  "type": "string",
@@ -23197,6 +23550,7 @@
23197
23550
  "x-validation-rules": {
23198
23551
  "ves.io.schema.rules.message.required": "true"
23199
23552
  },
23553
+ "x-f5xc-description-short": "Namespace in which the infraprotect ASN prefix irr override is to be updated Required: YES.",
23200
23554
  "minLength": 0,
23201
23555
  "maxLength": 6,
23202
23556
  "x-f5xc-required-for": {
@@ -23207,9 +23561,10 @@
23207
23561
  },
23208
23562
  "x-original-maxLength": 1024,
23209
23563
  "x-reconciled-from-discovery": true,
23210
- "x-reconciled-at": "2026-01-05T18:29:27.052127+00:00"
23564
+ "x-reconciled-at": "2026-01-07T15:53:28.757851+00:00"
23211
23565
  }
23212
23566
  },
23567
+ "x-f5xc-description-short": "Request to update infraprotect ASN irr override status.",
23213
23568
  "x-f5xc-minimum-configuration": {
23214
23569
  "description": "Minimum configuration for infraprotect_asn_prefixUpdateASNPrefixIRROverrideRequest",
23215
23570
  "required_fields": [
@@ -23229,6 +23584,7 @@
23229
23584
  "title": "Update ASN Prefix IRR Override Response.",
23230
23585
  "x-displayname": "Update ASN Prefix IRR Override Response.",
23231
23586
  "x-ves-proto-message": "ves.io.schema.infraprotect_asn_prefix.UpdateASNPrefixIRROverrideResponse",
23587
+ "x-f5xc-description-short": "Response returned from a ASN prefix irr override update.",
23232
23588
  "x-f5xc-minimum-configuration": {
23233
23589
  "description": "Minimum configuration for infraprotect_asn_prefixUpdateASNPrefixIRROverrideResponse",
23234
23590
  "required_fields": [],
@@ -23254,6 +23610,7 @@
23254
23610
  "x-displayname": "Name",
23255
23611
  "x-ves-example": "Value",
23256
23612
  "x-f5xc-example": "value",
23613
+ "x-f5xc-description-short": "The name of the infraprotect ASN prefix object to be updated.",
23257
23614
  "minLength": 0,
23258
23615
  "maxLength": 16,
23259
23616
  "x-f5xc-required-for": {
@@ -23264,7 +23621,7 @@
23264
23621
  },
23265
23622
  "x-original-maxLength": 1024,
23266
23623
  "x-reconciled-from-discovery": true,
23267
- "x-reconciled-at": "2026-01-05T18:29:27.052132+00:00"
23624
+ "x-reconciled-at": "2026-01-07T15:53:28.757858+00:00"
23268
23625
  },
23269
23626
  "namespace": {
23270
23627
  "type": "string",
@@ -23280,6 +23637,7 @@
23280
23637
  "x-validation-rules": {
23281
23638
  "ves.io.schema.rules.message.required": "true"
23282
23639
  },
23640
+ "x-f5xc-description-short": "Namespace in which the infraprotect ASN prefix review status is to be updated Required: YES.",
23283
23641
  "minLength": 0,
23284
23642
  "maxLength": 6,
23285
23643
  "x-f5xc-required-for": {
@@ -23290,7 +23648,7 @@
23290
23648
  },
23291
23649
  "x-original-maxLength": 1024,
23292
23650
  "x-reconciled-from-discovery": true,
23293
- "x-reconciled-at": "2026-01-05T18:29:27.052137+00:00"
23651
+ "x-reconciled-at": "2026-01-07T15:53:28.757864+00:00"
23294
23652
  },
23295
23653
  "review_type_approved": {
23296
23654
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -23302,6 +23660,7 @@
23302
23660
  "$ref": "#/components/schemas/ioschemaEmpty"
23303
23661
  }
23304
23662
  },
23663
+ "x-f5xc-description-short": "Request to update infraprotect ASN prefix review status.",
23305
23664
  "x-f5xc-minimum-configuration": {
23306
23665
  "description": "Minimum configuration for infraprotect_asn_prefixUpdateASNPrefixReviewStatusRequest",
23307
23666
  "required_fields": [
@@ -23324,6 +23683,7 @@
23324
23683
  "title": "Update ASN Prefix Review Status Response.",
23325
23684
  "x-displayname": "Update ASN Prefix Review Status Response.",
23326
23685
  "x-ves-proto-message": "ves.io.schema.infraprotect_asn_prefix.UpdateASNPrefixReviewStatusResponse",
23686
+ "x-f5xc-description-short": "Response returned from a ASN prefix review status update.",
23327
23687
  "x-f5xc-minimum-configuration": {
23328
23688
  "description": "Minimum configuration for infraprotect_asn_prefixUpdateASNPrefixReviewStatusResponse",
23329
23689
  "required_fields": [],
@@ -23348,6 +23708,8 @@
23348
23708
  "x-displayname": "Kind",
23349
23709
  "x-ves-example": "Virtual_site.",
23350
23710
  "x-f5xc-example": "virtual_site",
23711
+ "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\")",
23712
+ "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\").",
23351
23713
  "minLength": 0,
23352
23714
  "maxLength": 14,
23353
23715
  "x-f5xc-required-for": {
@@ -23359,7 +23721,7 @@
23359
23721
  "readOnly": true,
23360
23722
  "x-original-maxLength": 1024,
23361
23723
  "x-reconciled-from-discovery": true,
23362
- "x-reconciled-at": "2026-01-05T18:29:27.052146+00:00"
23724
+ "x-reconciled-at": "2026-01-07T15:53:28.757873+00:00"
23363
23725
  },
23364
23726
  "name": {
23365
23727
  "type": "string",
@@ -23368,6 +23730,8 @@
23368
23730
  "x-displayname": "Name",
23369
23731
  "x-ves-example": "Contactus-route.",
23370
23732
  "x-f5xc-example": "contactus-route",
23733
+ "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.",
23734
+ "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.",
23371
23735
  "minLength": 0,
23372
23736
  "maxLength": 16,
23373
23737
  "x-f5xc-required-for": {
@@ -23378,7 +23742,7 @@
23378
23742
  },
23379
23743
  "x-original-maxLength": 1024,
23380
23744
  "x-reconciled-from-discovery": true,
23381
- "x-reconciled-at": "2026-01-05T18:29:27.052150+00:00"
23745
+ "x-reconciled-at": "2026-01-07T15:53:28.757877+00:00"
23382
23746
  },
23383
23747
  "namespace": {
23384
23748
  "type": "string",
@@ -23387,6 +23751,8 @@
23387
23751
  "x-displayname": "Namespace",
23388
23752
  "x-ves-example": "Ns1",
23389
23753
  "x-f5xc-example": "ns1",
23754
+ "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.",
23755
+ "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.",
23390
23756
  "minLength": 0,
23391
23757
  "maxLength": 6,
23392
23758
  "x-f5xc-required-for": {
@@ -23397,7 +23763,7 @@
23397
23763
  },
23398
23764
  "x-original-maxLength": 1024,
23399
23765
  "x-reconciled-from-discovery": true,
23400
- "x-reconciled-at": "2026-01-05T18:29:27.052155+00:00"
23766
+ "x-reconciled-at": "2026-01-07T15:53:28.757881+00:00"
23401
23767
  },
23402
23768
  "tenant": {
23403
23769
  "type": "string",
@@ -23406,6 +23772,8 @@
23406
23772
  "x-displayname": "Tenant",
23407
23773
  "x-ves-example": "Example-corp.",
23408
23774
  "x-f5xc-example": "example-corp",
23775
+ "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.",
23776
+ "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.",
23409
23777
  "minLength": 0,
23410
23778
  "maxLength": 18,
23411
23779
  "x-f5xc-required-for": {
@@ -23418,7 +23786,7 @@
23418
23786
  "x-field-mutability": "read-only",
23419
23787
  "x-original-maxLength": 1024,
23420
23788
  "x-reconciled-from-discovery": true,
23421
- "x-reconciled-at": "2026-01-05T18:29:27.052159+00:00"
23789
+ "x-reconciled-at": "2026-01-07T15:53:28.757885+00:00"
23422
23790
  },
23423
23791
  "uid": {
23424
23792
  "type": "string",
@@ -23427,6 +23795,8 @@
23427
23795
  "x-displayname": "UID",
23428
23796
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
23429
23797
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
23798
+ "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.",
23799
+ "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.",
23430
23800
  "minLength": 0,
23431
23801
  "maxLength": 36,
23432
23802
  "x-f5xc-required-for": {
@@ -23440,9 +23810,11 @@
23440
23810
  "x-original-maxLength": 1024,
23441
23811
  "format": "uuid",
23442
23812
  "x-reconciled-from-discovery": true,
23443
- "x-reconciled-at": "2026-01-05T18:29:27.052165+00:00"
23813
+ "x-reconciled-at": "2026-01-07T15:53:28.757891+00:00"
23444
23814
  }
23445
23815
  },
23816
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
23817
+ "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...",
23446
23818
  "x-f5xc-minimum-configuration": {
23447
23819
  "description": "Minimum configuration for ioschemaObjectRefType",
23448
23820
  "required_fields": [
@@ -23530,6 +23902,8 @@
23530
23902
  "description": "Exclusive with [expiration_never one_day one_hour one_month one_year]\nThis deny list rule will expire at the given timestamp and will be removed from the system afterwards.",
23531
23903
  "format": "date-time",
23532
23904
  "x-displayname": "Expiration Time (UTC)",
23905
+ "x-f5xc-description-short": "Exclusive with [expiration_never one_day one_hour one_month one_year] This deny list rule will expire at the given timestamp and will be removed...",
23906
+ "x-f5xc-description-medium": "Exclusive with [expiration_never one_day one_hour one_month one_year] This deny list rule will expire at the given timestamp and will be removed from the system afterwards.",
23533
23907
  "minLength": 0,
23534
23908
  "maxLength": 1024,
23535
23909
  "x-f5xc-required-for": {
@@ -23607,6 +23981,7 @@
23607
23981
  "title": "Fail_if_referred.",
23608
23982
  "format": "boolean",
23609
23983
  "x-displayname": "Fail-If-Referred.",
23984
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
23610
23985
  "x-f5xc-required-for": {
23611
23986
  "minimum_config": false,
23612
23987
  "create": false,
@@ -23631,7 +24006,7 @@
23631
24006
  },
23632
24007
  "x-original-maxLength": 1024,
23633
24008
  "x-reconciled-from-discovery": true,
23634
- "x-reconciled-at": "2026-01-05T18:29:27.381241+00:00"
24009
+ "x-reconciled-at": "2026-01-07T15:53:29.184132+00:00"
23635
24010
  },
23636
24011
  "namespace": {
23637
24012
  "type": "string",
@@ -23640,6 +24015,7 @@
23640
24015
  "x-displayname": "Namespace",
23641
24016
  "x-ves-example": "Ns1",
23642
24017
  "x-f5xc-example": "ns1",
24018
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
23643
24019
  "minLength": 0,
23644
24020
  "maxLength": 6,
23645
24021
  "x-f5xc-required-for": {
@@ -23650,7 +24026,7 @@
23650
24026
  },
23651
24027
  "x-original-maxLength": 1024,
23652
24028
  "x-reconciled-from-discovery": true,
23653
- "x-reconciled-at": "2026-01-05T18:29:27.381247+00:00"
24029
+ "x-reconciled-at": "2026-01-07T15:53:29.184139+00:00"
23654
24030
  }
23655
24031
  },
23656
24032
  "x-f5xc-minimum-configuration": {
@@ -23685,6 +24061,7 @@
23685
24061
  "$ref": "#/components/schemas/schemaObjectRefType"
23686
24062
  },
23687
24063
  "x-displayname": "Deleted Referred Objects.",
24064
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
23688
24065
  "x-f5xc-required-for": {
23689
24066
  "minimum_config": false,
23690
24067
  "create": false,
@@ -23700,6 +24077,7 @@
23700
24077
  "$ref": "#/components/schemas/schemaObjectRefType"
23701
24078
  },
23702
24079
  "x-displayname": "Disabled Referred Objects.",
24080
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
23703
24081
  "x-f5xc-required-for": {
23704
24082
  "minimum_config": false,
23705
24083
  "create": false,
@@ -23718,6 +24096,7 @@
23718
24096
  "$ref": "#/components/schemas/schemaObjectRefType"
23719
24097
  },
23720
24098
  "x-displayname": "Referring Objects.",
24099
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
23721
24100
  "x-f5xc-required-for": {
23722
24101
  "minimum_config": false,
23723
24102
  "create": false,
@@ -23739,6 +24118,8 @@
23739
24118
  "$ref": "#/components/schemas/infraprotect_deny_list_ruleStatusObject"
23740
24119
  },
23741
24120
  "x-displayname": "Status",
24121
+ "x-f5xc-example": "active",
24122
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
23742
24123
  "x-f5xc-required-for": {
23743
24124
  "minimum_config": false,
23744
24125
  "create": false,
@@ -23748,7 +24129,7 @@
23748
24129
  "maxLength": 17,
23749
24130
  "minLength": 17,
23750
24131
  "x-reconciled-from-discovery": true,
23751
- "x-reconciled-at": "2026-01-05T18:29:27.381262+00:00"
24132
+ "x-reconciled-at": "2026-01-07T15:53:29.184155+00:00"
23752
24133
  },
23753
24134
  "system_metadata": {
23754
24135
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -23788,6 +24169,8 @@
23788
24169
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
23789
24170
  ],
23790
24171
  "default": "GET_RSP_FORMAT_DEFAULT",
24172
+ "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...",
24173
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
23791
24174
  "x-f5xc-minimum-configuration": {
23792
24175
  "description": "Minimum configuration for infraprotect_deny_list_ruleGetResponseFormatCode",
23793
24176
  "required_fields": [],
@@ -23814,6 +24197,8 @@
23814
24197
  "description": "Exclusive with [expiration_never]\nThis deny list rule will expire at the given timestamp and will be removed from the system afterwards.",
23815
24198
  "format": "date-time",
23816
24199
  "x-displayname": "Expiration Time (UTC)",
24200
+ "x-f5xc-description-short": "Exclusive with [expiration_never] This deny list rule will expire at the given timestamp and will be removed from the system afterwards.",
24201
+ "x-f5xc-description-medium": "Exclusive with [expiration_never] This deny list rule will expire at the given timestamp and will be removed from the system afterwards.",
23817
24202
  "minLength": 0,
23818
24203
  "maxLength": 1024,
23819
24204
  "x-f5xc-required-for": {
@@ -23877,6 +24262,7 @@
23877
24262
  "$ref": "#/components/schemas/schemaErrorType"
23878
24263
  },
23879
24264
  "x-displayname": "Errors",
24265
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
23880
24266
  "x-f5xc-required-for": {
23881
24267
  "minimum_config": false,
23882
24268
  "create": false,
@@ -23892,6 +24278,8 @@
23892
24278
  "$ref": "#/components/schemas/infraprotect_deny_list_ruleListResponseItem"
23893
24279
  },
23894
24280
  "x-displayname": "Items",
24281
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
24282
+ "x-f5xc-description-short": "Items represents the collection in response.",
23895
24283
  "x-f5xc-required-for": {
23896
24284
  "minimum_config": false,
23897
24285
  "create": false,
@@ -23925,6 +24313,8 @@
23925
24313
  "description": "The set of annotations present on this infraprotect_deny_list_rule.",
23926
24314
  "title": "Annotations.",
23927
24315
  "x-displayname": "Annotations.",
24316
+ "x-f5xc-example": "{\"key\": \"value\"}",
24317
+ "x-f5xc-description-short": "The set of annotations present on this infraprotect_deny_list_rule.",
23928
24318
  "x-f5xc-required-for": {
23929
24319
  "minimum_config": false,
23930
24320
  "create": false,
@@ -23937,6 +24327,7 @@
23937
24327
  "description": "The description set for this infraprotect_deny_list_rule.",
23938
24328
  "title": "Description.",
23939
24329
  "x-displayname": "Description.",
24330
+ "x-f5xc-description-short": "The description set for this infraprotect_deny_list_rule.",
23940
24331
  "minLength": 0,
23941
24332
  "maxLength": 0,
23942
24333
  "x-f5xc-required-for": {
@@ -23947,7 +24338,7 @@
23947
24338
  },
23948
24339
  "x-original-maxLength": 1024,
23949
24340
  "x-reconciled-from-discovery": true,
23950
- "x-reconciled-at": "2026-01-05T18:29:27.381279+00:00"
24341
+ "x-reconciled-at": "2026-01-07T15:53:29.184173+00:00"
23951
24342
  },
23952
24343
  "disabled": {
23953
24344
  "type": "boolean",
@@ -23955,6 +24346,8 @@
23955
24346
  "title": "Disabled",
23956
24347
  "format": "boolean",
23957
24348
  "x-displayname": "Disabled",
24349
+ "x-f5xc-example": "True",
24350
+ "x-f5xc-description-short": "Value of true indicates infraprotect_deny_list_rule is administratively disabled.",
23958
24351
  "x-f5xc-required-for": {
23959
24352
  "minimum_config": false,
23960
24353
  "create": false,
@@ -23970,6 +24363,8 @@
23970
24363
  "description": "The set of labels present on this infraprotect_deny_list_rule.",
23971
24364
  "title": "Labels",
23972
24365
  "x-displayname": "Labels",
24366
+ "x-f5xc-example": "{\"key\": \"value\"}",
24367
+ "x-f5xc-description-short": "The set of labels present on this infraprotect_deny_list_rule.",
23973
24368
  "x-f5xc-required-for": {
23974
24369
  "minimum_config": false,
23975
24370
  "create": false,
@@ -23987,6 +24382,7 @@
23987
24382
  "x-displayname": "Name",
23988
24383
  "x-ves-example": "Name",
23989
24384
  "x-f5xc-example": "name",
24385
+ "x-f5xc-description-short": "The name of this infraprotect_deny_list_rule.",
23990
24386
  "minLength": 0,
23991
24387
  "maxLength": 16,
23992
24388
  "x-f5xc-required-for": {
@@ -23997,7 +24393,7 @@
23997
24393
  },
23998
24394
  "x-original-maxLength": 1024,
23999
24395
  "x-reconciled-from-discovery": true,
24000
- "x-reconciled-at": "2026-01-05T18:29:27.381289+00:00"
24396
+ "x-reconciled-at": "2026-01-07T15:53:29.184183+00:00"
24001
24397
  },
24002
24398
  "namespace": {
24003
24399
  "type": "string",
@@ -24016,7 +24412,7 @@
24016
24412
  },
24017
24413
  "x-original-maxLength": 1024,
24018
24414
  "x-reconciled-from-discovery": true,
24019
- "x-reconciled-at": "2026-01-05T18:29:27.381294+00:00"
24415
+ "x-reconciled-at": "2026-01-07T15:53:29.184187+00:00"
24020
24416
  },
24021
24417
  "owner_view": {
24022
24418
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -24029,6 +24425,7 @@
24029
24425
  "$ref": "#/components/schemas/infraprotect_deny_list_ruleStatusObject"
24030
24426
  },
24031
24427
  "x-displayname": "Status",
24428
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
24032
24429
  "x-f5xc-required-for": {
24033
24430
  "minimum_config": false,
24034
24431
  "create": false,
@@ -24057,7 +24454,7 @@
24057
24454
  "x-field-mutability": "read-only",
24058
24455
  "x-original-maxLength": 1024,
24059
24456
  "x-reconciled-from-discovery": true,
24060
- "x-reconciled-at": "2026-01-05T18:29:27.381301+00:00"
24457
+ "x-reconciled-at": "2026-01-07T15:53:29.184195+00:00"
24061
24458
  },
24062
24459
  "uid": {
24063
24460
  "type": "string",
@@ -24066,6 +24463,7 @@
24066
24463
  "x-displayname": "UID",
24067
24464
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
24068
24465
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
24466
+ "x-f5xc-description-short": "The unique uid of this infraprotect_deny_list_rule.",
24069
24467
  "minLength": 0,
24070
24468
  "maxLength": 36,
24071
24469
  "x-f5xc-required-for": {
@@ -24078,9 +24476,11 @@
24078
24476
  "x-original-maxLength": 1024,
24079
24477
  "format": "uuid",
24080
24478
  "x-reconciled-from-discovery": true,
24081
- "x-reconciled-at": "2026-01-05T18:29:27.381307+00:00"
24479
+ "x-reconciled-at": "2026-01-07T15:53:29.184201+00:00"
24082
24480
  }
24083
24481
  },
24482
+ "x-f5xc-description-short": "By default a summary of infraprotect_deny_list_rule is returned in 'List'.",
24483
+ "x-f5xc-description-medium": "By default a summary of infraprotect_deny_list_rule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
24084
24484
  "x-f5xc-minimum-configuration": {
24085
24485
  "description": "Minimum configuration for infraprotect_deny_list_ruleListResponseItem",
24086
24486
  "required_fields": [
@@ -24161,6 +24561,8 @@
24161
24561
  "description": "Exclusive with [expiration_never one_day one_hour one_month one_year]\nThis deny list rule will expire at the given timestamp and will be removed from the system afterwards.",
24162
24562
  "format": "date-time",
24163
24563
  "x-displayname": "Expiration Time (UTC)",
24564
+ "x-f5xc-description-short": "Exclusive with [expiration_never one_day one_hour one_month one_year] This deny list rule will expire at the given timestamp and will be removed...",
24565
+ "x-f5xc-description-medium": "Exclusive with [expiration_never one_day one_hour one_month one_year] This deny list rule will expire at the given timestamp and will be removed from the system afterwards.",
24164
24566
  "minLength": 0,
24165
24567
  "maxLength": 1024,
24166
24568
  "x-f5xc-required-for": {
@@ -24239,6 +24641,7 @@
24239
24641
  "$ref": "#/components/schemas/schemaConditionType"
24240
24642
  },
24241
24643
  "x-displayname": "Conditions.",
24644
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
24242
24645
  "x-f5xc-required-for": {
24243
24646
  "minimum_config": false,
24244
24647
  "create": false,
@@ -24367,6 +24770,7 @@
24367
24770
  "x-validation-rules": {
24368
24771
  "ves.io.schema.rules.string.ip_prefix_globally_routable": "true"
24369
24772
  },
24773
+ "x-f5xc-description-short": "Exclusive with [destination_prefix_all] Prefix.",
24370
24774
  "minLength": 0,
24371
24775
  "maxLength": 1024,
24372
24776
  "x-f5xc-required-for": {
@@ -24422,6 +24826,7 @@
24422
24826
  "x-validation-rules": {
24423
24827
  "ves.io.schema.rules.string.ip_prefix_globally_routable": "true"
24424
24828
  },
24829
+ "x-f5xc-description-short": "Exclusive with [source_prefix_all] Prefix.",
24425
24830
  "minLength": 0,
24426
24831
  "maxLength": 1024,
24427
24832
  "x-f5xc-required-for": {
@@ -24489,6 +24894,7 @@
24489
24894
  "title": "Fail_if_referred.",
24490
24895
  "format": "boolean",
24491
24896
  "x-displayname": "Fail-If-Referred.",
24897
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
24492
24898
  "x-f5xc-required-for": {
24493
24899
  "minimum_config": false,
24494
24900
  "create": false,
@@ -24513,7 +24919,7 @@
24513
24919
  },
24514
24920
  "x-original-maxLength": 1024,
24515
24921
  "x-reconciled-from-discovery": true,
24516
- "x-reconciled-at": "2026-01-05T18:29:27.725147+00:00"
24922
+ "x-reconciled-at": "2026-01-07T15:53:29.630578+00:00"
24517
24923
  },
24518
24924
  "namespace": {
24519
24925
  "type": "string",
@@ -24522,6 +24928,7 @@
24522
24928
  "x-displayname": "Namespace",
24523
24929
  "x-ves-example": "Ns1",
24524
24930
  "x-f5xc-example": "ns1",
24931
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
24525
24932
  "minLength": 0,
24526
24933
  "maxLength": 6,
24527
24934
  "x-f5xc-required-for": {
@@ -24532,7 +24939,7 @@
24532
24939
  },
24533
24940
  "x-original-maxLength": 1024,
24534
24941
  "x-reconciled-from-discovery": true,
24535
- "x-reconciled-at": "2026-01-05T18:29:27.725154+00:00"
24942
+ "x-reconciled-at": "2026-01-07T15:53:29.630587+00:00"
24536
24943
  }
24537
24944
  },
24538
24945
  "x-f5xc-minimum-configuration": {
@@ -24567,6 +24974,7 @@
24567
24974
  "$ref": "#/components/schemas/schemaObjectRefType"
24568
24975
  },
24569
24976
  "x-displayname": "Deleted Referred Objects.",
24977
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
24570
24978
  "x-f5xc-required-for": {
24571
24979
  "minimum_config": false,
24572
24980
  "create": false,
@@ -24582,6 +24990,7 @@
24582
24990
  "$ref": "#/components/schemas/schemaObjectRefType"
24583
24991
  },
24584
24992
  "x-displayname": "Disabled Referred Objects.",
24993
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
24585
24994
  "x-f5xc-required-for": {
24586
24995
  "minimum_config": false,
24587
24996
  "create": false,
@@ -24600,6 +25009,7 @@
24600
25009
  "$ref": "#/components/schemas/schemaObjectRefType"
24601
25010
  },
24602
25011
  "x-displayname": "Referring Objects.",
25012
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
24603
25013
  "x-f5xc-required-for": {
24604
25014
  "minimum_config": false,
24605
25015
  "create": false,
@@ -24621,6 +25031,8 @@
24621
25031
  "$ref": "#/components/schemas/infraprotect_firewall_ruleStatusObject"
24622
25032
  },
24623
25033
  "x-displayname": "Status",
25034
+ "x-f5xc-example": "active",
25035
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
24624
25036
  "x-f5xc-required-for": {
24625
25037
  "minimum_config": false,
24626
25038
  "create": false,
@@ -24630,7 +25042,7 @@
24630
25042
  "maxLength": 17,
24631
25043
  "minLength": 17,
24632
25044
  "x-reconciled-from-discovery": true,
24633
- "x-reconciled-at": "2026-01-05T18:29:27.725171+00:00"
25045
+ "x-reconciled-at": "2026-01-07T15:53:29.630603+00:00"
24634
25046
  },
24635
25047
  "system_metadata": {
24636
25048
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -24670,6 +25082,8 @@
24670
25082
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
24671
25083
  ],
24672
25084
  "default": "GET_RSP_FORMAT_DEFAULT",
25085
+ "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...",
25086
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
24673
25087
  "x-f5xc-minimum-configuration": {
24674
25088
  "description": "Minimum configuration for infraprotect_firewall_ruleGetResponseFormatCode",
24675
25089
  "required_fields": [],
@@ -24713,6 +25127,7 @@
24713
25127
  "x-validation-rules": {
24714
25128
  "ves.io.schema.rules.string.ip_prefix_globally_routable": "true"
24715
25129
  },
25130
+ "x-f5xc-description-short": "Exclusive with [destination_prefix_all] Prefix.",
24716
25131
  "minLength": 0,
24717
25132
  "maxLength": 1024,
24718
25133
  "x-f5xc-required-for": {
@@ -24768,6 +25183,7 @@
24768
25183
  "x-validation-rules": {
24769
25184
  "ves.io.schema.rules.string.ip_prefix_globally_routable": "true"
24770
25185
  },
25186
+ "x-f5xc-description-short": "Exclusive with [source_prefix_all] Prefix.",
24771
25187
  "minLength": 0,
24772
25188
  "maxLength": 1024,
24773
25189
  "x-f5xc-required-for": {
@@ -25129,6 +25545,7 @@
25129
25545
  "$ref": "#/components/schemas/schemaErrorType"
25130
25546
  },
25131
25547
  "x-displayname": "Errors",
25548
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
25132
25549
  "x-f5xc-required-for": {
25133
25550
  "minimum_config": false,
25134
25551
  "create": false,
@@ -25144,6 +25561,8 @@
25144
25561
  "$ref": "#/components/schemas/infraprotect_firewall_ruleListResponseItem"
25145
25562
  },
25146
25563
  "x-displayname": "Items",
25564
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
25565
+ "x-f5xc-description-short": "Items represents the collection in response.",
25147
25566
  "x-f5xc-required-for": {
25148
25567
  "minimum_config": false,
25149
25568
  "create": false,
@@ -25177,6 +25596,8 @@
25177
25596
  "description": "The set of annotations present on this infraprotect_firewall_rule.",
25178
25597
  "title": "Annotations.",
25179
25598
  "x-displayname": "Annotations.",
25599
+ "x-f5xc-example": "{\"key\": \"value\"}",
25600
+ "x-f5xc-description-short": "The set of annotations present on this infraprotect_firewall_rule.",
25180
25601
  "x-f5xc-required-for": {
25181
25602
  "minimum_config": false,
25182
25603
  "create": false,
@@ -25189,6 +25610,7 @@
25189
25610
  "description": "The description set for this infraprotect_firewall_rule.",
25190
25611
  "title": "Description.",
25191
25612
  "x-displayname": "Description.",
25613
+ "x-f5xc-description-short": "The description set for this infraprotect_firewall_rule.",
25192
25614
  "minLength": 0,
25193
25615
  "maxLength": 0,
25194
25616
  "x-f5xc-required-for": {
@@ -25199,7 +25621,7 @@
25199
25621
  },
25200
25622
  "x-original-maxLength": 1024,
25201
25623
  "x-reconciled-from-discovery": true,
25202
- "x-reconciled-at": "2026-01-05T18:29:27.725232+00:00"
25624
+ "x-reconciled-at": "2026-01-07T15:53:29.630661+00:00"
25203
25625
  },
25204
25626
  "disabled": {
25205
25627
  "type": "boolean",
@@ -25207,6 +25629,8 @@
25207
25629
  "title": "Disabled",
25208
25630
  "format": "boolean",
25209
25631
  "x-displayname": "Disabled",
25632
+ "x-f5xc-example": "True",
25633
+ "x-f5xc-description-short": "Value of true indicates infraprotect_firewall_rule is administratively disabled.",
25210
25634
  "x-f5xc-required-for": {
25211
25635
  "minimum_config": false,
25212
25636
  "create": false,
@@ -25222,6 +25646,8 @@
25222
25646
  "description": "The set of labels present on this infraprotect_firewall_rule.",
25223
25647
  "title": "Labels",
25224
25648
  "x-displayname": "Labels",
25649
+ "x-f5xc-example": "{\"key\": \"value\"}",
25650
+ "x-f5xc-description-short": "The set of labels present on this infraprotect_firewall_rule.",
25225
25651
  "x-f5xc-required-for": {
25226
25652
  "minimum_config": false,
25227
25653
  "create": false,
@@ -25239,6 +25665,7 @@
25239
25665
  "x-displayname": "Name",
25240
25666
  "x-ves-example": "Name",
25241
25667
  "x-f5xc-example": "name",
25668
+ "x-f5xc-description-short": "The name of this infraprotect_firewall_rule.",
25242
25669
  "minLength": 0,
25243
25670
  "maxLength": 16,
25244
25671
  "x-f5xc-required-for": {
@@ -25249,7 +25676,7 @@
25249
25676
  },
25250
25677
  "x-original-maxLength": 1024,
25251
25678
  "x-reconciled-from-discovery": true,
25252
- "x-reconciled-at": "2026-01-05T18:29:27.725242+00:00"
25679
+ "x-reconciled-at": "2026-01-07T15:53:29.630671+00:00"
25253
25680
  },
25254
25681
  "namespace": {
25255
25682
  "type": "string",
@@ -25268,7 +25695,7 @@
25268
25695
  },
25269
25696
  "x-original-maxLength": 1024,
25270
25697
  "x-reconciled-from-discovery": true,
25271
- "x-reconciled-at": "2026-01-05T18:29:27.725247+00:00"
25698
+ "x-reconciled-at": "2026-01-07T15:53:29.630675+00:00"
25272
25699
  },
25273
25700
  "owner_view": {
25274
25701
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -25281,6 +25708,7 @@
25281
25708
  "$ref": "#/components/schemas/infraprotect_firewall_ruleStatusObject"
25282
25709
  },
25283
25710
  "x-displayname": "Status",
25711
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
25284
25712
  "x-f5xc-required-for": {
25285
25713
  "minimum_config": false,
25286
25714
  "create": false,
@@ -25309,7 +25737,7 @@
25309
25737
  "x-field-mutability": "read-only",
25310
25738
  "x-original-maxLength": 1024,
25311
25739
  "x-reconciled-from-discovery": true,
25312
- "x-reconciled-at": "2026-01-05T18:29:27.725254+00:00"
25740
+ "x-reconciled-at": "2026-01-07T15:53:29.630685+00:00"
25313
25741
  },
25314
25742
  "uid": {
25315
25743
  "type": "string",
@@ -25318,6 +25746,7 @@
25318
25746
  "x-displayname": "UID",
25319
25747
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
25320
25748
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
25749
+ "x-f5xc-description-short": "The unique uid of this infraprotect_firewall_rule.",
25321
25750
  "minLength": 0,
25322
25751
  "maxLength": 36,
25323
25752
  "x-f5xc-required-for": {
@@ -25330,9 +25759,11 @@
25330
25759
  "x-original-maxLength": 1024,
25331
25760
  "format": "uuid",
25332
25761
  "x-reconciled-from-discovery": true,
25333
- "x-reconciled-at": "2026-01-05T18:29:27.725260+00:00"
25762
+ "x-reconciled-at": "2026-01-07T15:53:29.630692+00:00"
25334
25763
  }
25335
25764
  },
25765
+ "x-f5xc-description-short": "By default a summary of infraprotect_firewall_rule is returned in 'List'.",
25766
+ "x-f5xc-description-medium": "By default a summary of infraprotect_firewall_rule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
25336
25767
  "x-f5xc-minimum-configuration": {
25337
25768
  "description": "Minimum configuration for infraprotect_firewall_ruleListResponseItem",
25338
25769
  "required_fields": [
@@ -25430,6 +25861,7 @@
25430
25861
  "x-validation-rules": {
25431
25862
  "ves.io.schema.rules.string.ip_prefix_globally_routable": "true"
25432
25863
  },
25864
+ "x-f5xc-description-short": "Exclusive with [destination_prefix_all] Prefix.",
25433
25865
  "minLength": 0,
25434
25866
  "maxLength": 1024,
25435
25867
  "x-f5xc-required-for": {
@@ -25485,6 +25917,7 @@
25485
25917
  "x-validation-rules": {
25486
25918
  "ves.io.schema.rules.string.ip_prefix_globally_routable": "true"
25487
25919
  },
25920
+ "x-f5xc-description-short": "Exclusive with [source_prefix_all] Prefix.",
25488
25921
  "minLength": 0,
25489
25922
  "maxLength": 1024,
25490
25923
  "x-f5xc-required-for": {
@@ -25553,6 +25986,7 @@
25553
25986
  "$ref": "#/components/schemas/schemaConditionType"
25554
25987
  },
25555
25988
  "x-displayname": "Conditions.",
25989
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
25556
25990
  "x-f5xc-required-for": {
25557
25991
  "minimum_config": false,
25558
25992
  "create": false,
@@ -25617,7 +26051,7 @@
25617
26051
  },
25618
26052
  "x-original-maxLength": 1024,
25619
26053
  "x-reconciled-from-discovery": true,
25620
- "x-reconciled-at": "2026-01-05T18:29:27.725299+00:00"
26054
+ "x-reconciled-at": "2026-01-07T15:53:29.630729+00:00"
25621
26055
  },
25622
26056
  "destination_port_all": {
25623
26057
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -25633,6 +26067,8 @@
25633
26067
  "x-validation-rules": {
25634
26068
  "ves.io.schema.rules.string.port_range": "true"
25635
26069
  },
26070
+ "x-f5xc-example": "{\"key\": \"value\"}",
26071
+ "x-f5xc-description-short": "Exclusive with [destination_port_all] Port Range.",
25636
26072
  "minLength": 0,
25637
26073
  "maxLength": 1024,
25638
26074
  "x-f5xc-required-for": {
@@ -25656,6 +26092,8 @@
25656
26092
  "x-validation-rules": {
25657
26093
  "ves.io.schema.rules.string.port_range": "true"
25658
26094
  },
26095
+ "x-f5xc-example": "{\"key\": \"value\"}",
26096
+ "x-f5xc-description-short": "Exclusive with [source_port_all] Port Range.",
25659
26097
  "minLength": 0,
25660
26098
  "maxLength": 1024,
25661
26099
  "x-f5xc-required-for": {
@@ -25707,7 +26145,7 @@
25707
26145
  },
25708
26146
  "x-original-maxLength": 1024,
25709
26147
  "x-reconciled-from-discovery": true,
25710
- "x-reconciled-at": "2026-01-05T18:29:27.725310+00:00"
26148
+ "x-reconciled-at": "2026-01-07T15:53:29.630741+00:00"
25711
26149
  },
25712
26150
  "destination_port_all": {
25713
26151
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -25723,6 +26161,8 @@
25723
26161
  "x-validation-rules": {
25724
26162
  "ves.io.schema.rules.string.port_range": "true"
25725
26163
  },
26164
+ "x-f5xc-example": "{\"key\": \"value\"}",
26165
+ "x-f5xc-description-short": "Exclusive with [destination_port_all] Port Range.",
25726
26166
  "minLength": 0,
25727
26167
  "maxLength": 1024,
25728
26168
  "x-f5xc-required-for": {
@@ -25746,6 +26186,8 @@
25746
26186
  "x-validation-rules": {
25747
26187
  "ves.io.schema.rules.string.port_range": "true"
25748
26188
  },
26189
+ "x-f5xc-example": "{\"key\": \"value\"}",
26190
+ "x-f5xc-description-short": "Exclusive with [source_port_all] Port Range.",
25749
26191
  "minLength": 0,
25750
26192
  "maxLength": 1024,
25751
26193
  "x-f5xc-required-for": {
@@ -25858,6 +26300,7 @@
25858
26300
  }
25859
26301
  }
25860
26302
  },
26303
+ "x-f5xc-description-short": "Amends a DDoS transit Firewall Rule Group.",
25861
26304
  "x-f5xc-minimum-configuration": {
25862
26305
  "description": "Minimum configuration for infraprotect_firewall_rule_groupCreateSpecType",
25863
26306
  "required_fields": [
@@ -25883,6 +26326,7 @@
25883
26326
  "title": "Fail_if_referred.",
25884
26327
  "format": "boolean",
25885
26328
  "x-displayname": "Fail-If-Referred.",
26329
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
25886
26330
  "x-f5xc-required-for": {
25887
26331
  "minimum_config": false,
25888
26332
  "create": false,
@@ -25907,7 +26351,7 @@
25907
26351
  },
25908
26352
  "x-original-maxLength": 1024,
25909
26353
  "x-reconciled-from-discovery": true,
25910
- "x-reconciled-at": "2026-01-05T18:29:28.048654+00:00"
26354
+ "x-reconciled-at": "2026-01-07T15:53:30.046899+00:00"
25911
26355
  },
25912
26356
  "namespace": {
25913
26357
  "type": "string",
@@ -25916,6 +26360,7 @@
25916
26360
  "x-displayname": "Namespace",
25917
26361
  "x-ves-example": "Ns1",
25918
26362
  "x-f5xc-example": "ns1",
26363
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
25919
26364
  "minLength": 0,
25920
26365
  "maxLength": 6,
25921
26366
  "x-f5xc-required-for": {
@@ -25926,7 +26371,7 @@
25926
26371
  },
25927
26372
  "x-original-maxLength": 1024,
25928
26373
  "x-reconciled-from-discovery": true,
25929
- "x-reconciled-at": "2026-01-05T18:29:28.048660+00:00"
26374
+ "x-reconciled-at": "2026-01-07T15:53:30.046906+00:00"
25930
26375
  }
25931
26376
  },
25932
26377
  "x-f5xc-minimum-configuration": {
@@ -25961,6 +26406,7 @@
25961
26406
  "$ref": "#/components/schemas/schemaObjectRefType"
25962
26407
  },
25963
26408
  "x-displayname": "Deleted Referred Objects.",
26409
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
25964
26410
  "x-f5xc-required-for": {
25965
26411
  "minimum_config": false,
25966
26412
  "create": false,
@@ -25976,6 +26422,7 @@
25976
26422
  "$ref": "#/components/schemas/schemaObjectRefType"
25977
26423
  },
25978
26424
  "x-displayname": "Disabled Referred Objects.",
26425
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
25979
26426
  "x-f5xc-required-for": {
25980
26427
  "minimum_config": false,
25981
26428
  "create": false,
@@ -25994,6 +26441,7 @@
25994
26441
  "$ref": "#/components/schemas/schemaObjectRefType"
25995
26442
  },
25996
26443
  "x-displayname": "Referring Objects.",
26444
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
25997
26445
  "x-f5xc-required-for": {
25998
26446
  "minimum_config": false,
25999
26447
  "create": false,
@@ -26015,6 +26463,8 @@
26015
26463
  "$ref": "#/components/schemas/infraprotect_firewall_rule_groupStatusObject"
26016
26464
  },
26017
26465
  "x-displayname": "Status",
26466
+ "x-f5xc-example": "active",
26467
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
26018
26468
  "x-f5xc-required-for": {
26019
26469
  "minimum_config": false,
26020
26470
  "create": false,
@@ -26024,7 +26474,7 @@
26024
26474
  "maxLength": 17,
26025
26475
  "minLength": 17,
26026
26476
  "x-reconciled-from-discovery": true,
26027
- "x-reconciled-at": "2026-01-05T18:29:28.048676+00:00"
26477
+ "x-reconciled-at": "2026-01-07T15:53:30.046923+00:00"
26028
26478
  },
26029
26479
  "system_metadata": {
26030
26480
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -26064,6 +26514,8 @@
26064
26514
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
26065
26515
  ],
26066
26516
  "default": "GET_RSP_FORMAT_DEFAULT",
26517
+ "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...",
26518
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
26067
26519
  "x-f5xc-minimum-configuration": {
26068
26520
  "description": "Minimum configuration for infraprotect_firewall_rule_groupGetResponseFormatCode",
26069
26521
  "required_fields": [],
@@ -26119,6 +26571,7 @@
26119
26571
  "ves.io.schema.rules.message.required": "true",
26120
26572
  "ves.io.schema.rules.repeated.unique": "true"
26121
26573
  },
26574
+ "x-f5xc-example": "{\"key\": \"value\"}",
26122
26575
  "x-f5xc-required-for": {
26123
26576
  "minimum_config": false,
26124
26577
  "create": false,
@@ -26155,6 +26608,7 @@
26155
26608
  "$ref": "#/components/schemas/schemaErrorType"
26156
26609
  },
26157
26610
  "x-displayname": "Errors",
26611
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
26158
26612
  "x-f5xc-required-for": {
26159
26613
  "minimum_config": false,
26160
26614
  "create": false,
@@ -26170,6 +26624,8 @@
26170
26624
  "$ref": "#/components/schemas/infraprotect_firewall_rule_groupListResponseItem"
26171
26625
  },
26172
26626
  "x-displayname": "Items",
26627
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
26628
+ "x-f5xc-description-short": "Items represents the collection in response.",
26173
26629
  "x-f5xc-required-for": {
26174
26630
  "minimum_config": false,
26175
26631
  "create": false,
@@ -26203,6 +26659,8 @@
26203
26659
  "description": "The set of annotations present on this infraprotect_firewall_rule_group.",
26204
26660
  "title": "Annotations.",
26205
26661
  "x-displayname": "Annotations.",
26662
+ "x-f5xc-example": "{\"key\": \"value\"}",
26663
+ "x-f5xc-description-short": "The set of annotations present on this infraprotect_firewall_rule_group.",
26206
26664
  "x-f5xc-required-for": {
26207
26665
  "minimum_config": false,
26208
26666
  "create": false,
@@ -26215,6 +26673,7 @@
26215
26673
  "description": "The description set for this infraprotect_firewall_rule_group.",
26216
26674
  "title": "Description.",
26217
26675
  "x-displayname": "Description.",
26676
+ "x-f5xc-description-short": "The description set for this infraprotect_firewall_rule_group.",
26218
26677
  "minLength": 0,
26219
26678
  "maxLength": 0,
26220
26679
  "x-f5xc-required-for": {
@@ -26225,7 +26684,7 @@
26225
26684
  },
26226
26685
  "x-original-maxLength": 1024,
26227
26686
  "x-reconciled-from-discovery": true,
26228
- "x-reconciled-at": "2026-01-05T18:29:28.048692+00:00"
26687
+ "x-reconciled-at": "2026-01-07T15:53:30.046941+00:00"
26229
26688
  },
26230
26689
  "disabled": {
26231
26690
  "type": "boolean",
@@ -26233,6 +26692,8 @@
26233
26692
  "title": "Disabled",
26234
26693
  "format": "boolean",
26235
26694
  "x-displayname": "Disabled",
26695
+ "x-f5xc-example": "True",
26696
+ "x-f5xc-description-short": "Value of true indicates infraprotect_firewall_rule_group is administratively disabled.",
26236
26697
  "x-f5xc-required-for": {
26237
26698
  "minimum_config": false,
26238
26699
  "create": false,
@@ -26248,6 +26709,8 @@
26248
26709
  "description": "The set of labels present on this infraprotect_firewall_rule_group.",
26249
26710
  "title": "Labels",
26250
26711
  "x-displayname": "Labels",
26712
+ "x-f5xc-example": "{\"key\": \"value\"}",
26713
+ "x-f5xc-description-short": "The set of labels present on this infraprotect_firewall_rule_group.",
26251
26714
  "x-f5xc-required-for": {
26252
26715
  "minimum_config": false,
26253
26716
  "create": false,
@@ -26265,6 +26728,7 @@
26265
26728
  "x-displayname": "Name",
26266
26729
  "x-ves-example": "Name",
26267
26730
  "x-f5xc-example": "name",
26731
+ "x-f5xc-description-short": "The name of this infraprotect_firewall_rule_group.",
26268
26732
  "minLength": 0,
26269
26733
  "maxLength": 16,
26270
26734
  "x-f5xc-required-for": {
@@ -26275,7 +26739,7 @@
26275
26739
  },
26276
26740
  "x-original-maxLength": 1024,
26277
26741
  "x-reconciled-from-discovery": true,
26278
- "x-reconciled-at": "2026-01-05T18:29:28.048703+00:00"
26742
+ "x-reconciled-at": "2026-01-07T15:53:30.046953+00:00"
26279
26743
  },
26280
26744
  "namespace": {
26281
26745
  "type": "string",
@@ -26294,7 +26758,7 @@
26294
26758
  },
26295
26759
  "x-original-maxLength": 1024,
26296
26760
  "x-reconciled-from-discovery": true,
26297
- "x-reconciled-at": "2026-01-05T18:29:28.048707+00:00"
26761
+ "x-reconciled-at": "2026-01-07T15:53:30.046957+00:00"
26298
26762
  },
26299
26763
  "owner_view": {
26300
26764
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -26307,6 +26771,7 @@
26307
26771
  "$ref": "#/components/schemas/infraprotect_firewall_rule_groupStatusObject"
26308
26772
  },
26309
26773
  "x-displayname": "Status",
26774
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
26310
26775
  "x-f5xc-required-for": {
26311
26776
  "minimum_config": false,
26312
26777
  "create": false,
@@ -26335,7 +26800,7 @@
26335
26800
  "x-field-mutability": "read-only",
26336
26801
  "x-original-maxLength": 1024,
26337
26802
  "x-reconciled-from-discovery": true,
26338
- "x-reconciled-at": "2026-01-05T18:29:28.048716+00:00"
26803
+ "x-reconciled-at": "2026-01-07T15:53:30.046965+00:00"
26339
26804
  },
26340
26805
  "uid": {
26341
26806
  "type": "string",
@@ -26344,6 +26809,7 @@
26344
26809
  "x-displayname": "UID",
26345
26810
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
26346
26811
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
26812
+ "x-f5xc-description-short": "The unique uid of this infraprotect_firewall_rule_group.",
26347
26813
  "minLength": 0,
26348
26814
  "maxLength": 36,
26349
26815
  "x-f5xc-required-for": {
@@ -26356,9 +26822,11 @@
26356
26822
  "x-original-maxLength": 1024,
26357
26823
  "format": "uuid",
26358
26824
  "x-reconciled-from-discovery": true,
26359
- "x-reconciled-at": "2026-01-05T18:29:28.048722+00:00"
26825
+ "x-reconciled-at": "2026-01-07T15:53:30.046971+00:00"
26360
26826
  }
26361
26827
  },
26828
+ "x-f5xc-description-short": "By default a summary of infraprotect_firewall_rule_group is returned in 'List'.",
26829
+ "x-f5xc-description-medium": "By default a summary of infraprotect_firewall_rule_group is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
26362
26830
  "x-f5xc-minimum-configuration": {
26363
26831
  "description": "Minimum configuration for infraprotect_firewall_rule_groupListResponseItem",
26364
26832
  "required_fields": [
@@ -26453,6 +26921,7 @@
26453
26921
  }
26454
26922
  }
26455
26923
  },
26924
+ "x-f5xc-description-short": "Amends a DDoS transit Firewall Rule Group.",
26456
26925
  "x-f5xc-minimum-configuration": {
26457
26926
  "description": "Minimum configuration for infraprotect_firewall_rule_groupReplaceSpecType",
26458
26927
  "required_fields": [
@@ -26479,6 +26948,7 @@
26479
26948
  "$ref": "#/components/schemas/schemaConditionType"
26480
26949
  },
26481
26950
  "x-displayname": "Conditions.",
26951
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
26482
26952
  "x-f5xc-required-for": {
26483
26953
  "minimum_config": false,
26484
26954
  "create": false,
@@ -26534,6 +27004,7 @@
26534
27004
  "$ref": "#/components/schemas/ioschemaObjectRefType"
26535
27005
  },
26536
27006
  "x-displayname": "Deleted Referred Objects.",
27007
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
26537
27008
  "x-f5xc-required-for": {
26538
27009
  "minimum_config": false,
26539
27010
  "create": false,
@@ -26549,6 +27020,7 @@
26549
27020
  "$ref": "#/components/schemas/ioschemaObjectRefType"
26550
27021
  },
26551
27022
  "x-displayname": "Disabled Referred Objects.",
27023
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
26552
27024
  "x-f5xc-required-for": {
26553
27025
  "minimum_config": false,
26554
27026
  "create": false,
@@ -26567,6 +27039,7 @@
26567
27039
  "$ref": "#/components/schemas/ioschemaObjectRefType"
26568
27040
  },
26569
27041
  "x-displayname": "Referring Objects.",
27042
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
26570
27043
  "x-f5xc-required-for": {
26571
27044
  "minimum_config": false,
26572
27045
  "create": false,
@@ -26588,6 +27061,8 @@
26588
27061
  "$ref": "#/components/schemas/infraprotect_firewall_rulesetStatusObject"
26589
27062
  },
26590
27063
  "x-displayname": "Status",
27064
+ "x-f5xc-example": "active",
27065
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
26591
27066
  "x-f5xc-required-for": {
26592
27067
  "minimum_config": false,
26593
27068
  "create": false,
@@ -26597,7 +27072,7 @@
26597
27072
  "maxLength": 17,
26598
27073
  "minLength": 17,
26599
27074
  "x-reconciled-from-discovery": true,
26600
- "x-reconciled-at": "2026-01-05T18:29:28.343791+00:00"
27075
+ "x-reconciled-at": "2026-01-07T15:53:30.434319+00:00"
26601
27076
  },
26602
27077
  "system_metadata": {
26603
27078
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -26635,6 +27110,8 @@
26635
27110
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
26636
27111
  ],
26637
27112
  "default": "GET_RSP_FORMAT_DEFAULT",
27113
+ "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...",
27114
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\" Response should...",
26638
27115
  "x-f5xc-minimum-configuration": {
26639
27116
  "description": "Minimum configuration for infraprotect_firewall_rulesetGetResponseFormatCode",
26640
27117
  "required_fields": [],
@@ -26669,6 +27146,7 @@
26669
27146
  "ves.io.schema.rules.message.required": "true",
26670
27147
  "ves.io.schema.rules.repeated.unique": "true"
26671
27148
  },
27149
+ "x-f5xc-example": "{\"key\": \"value\"}",
26672
27150
  "x-f5xc-required-for": {
26673
27151
  "minimum_config": false,
26674
27152
  "create": false,
@@ -26712,6 +27190,7 @@
26712
27190
  "$ref": "#/components/schemas/schemaErrorType"
26713
27191
  },
26714
27192
  "x-displayname": "Errors",
27193
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
26715
27194
  "x-f5xc-required-for": {
26716
27195
  "minimum_config": false,
26717
27196
  "create": false,
@@ -26727,6 +27206,8 @@
26727
27206
  "$ref": "#/components/schemas/infraprotect_firewall_rulesetListResponseItem"
26728
27207
  },
26729
27208
  "x-displayname": "Items",
27209
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
27210
+ "x-f5xc-description-short": "Items represents the collection in response.",
26730
27211
  "x-f5xc-required-for": {
26731
27212
  "minimum_config": false,
26732
27213
  "create": false,
@@ -26760,6 +27241,8 @@
26760
27241
  "description": "The set of annotations present on this infraprotect_firewall_ruleset.",
26761
27242
  "title": "Annotations.",
26762
27243
  "x-displayname": "Annotations.",
27244
+ "x-f5xc-example": "{\"key\": \"value\"}",
27245
+ "x-f5xc-description-short": "The set of annotations present on this infraprotect_firewall_ruleset.",
26763
27246
  "x-f5xc-required-for": {
26764
27247
  "minimum_config": false,
26765
27248
  "create": false,
@@ -26772,6 +27255,7 @@
26772
27255
  "description": "The description set for this infraprotect_firewall_ruleset.",
26773
27256
  "title": "Description.",
26774
27257
  "x-displayname": "Description.",
27258
+ "x-f5xc-description-short": "The description set for this infraprotect_firewall_ruleset.",
26775
27259
  "minLength": 0,
26776
27260
  "maxLength": 0,
26777
27261
  "x-f5xc-required-for": {
@@ -26782,7 +27266,7 @@
26782
27266
  },
26783
27267
  "x-original-maxLength": 1024,
26784
27268
  "x-reconciled-from-discovery": true,
26785
- "x-reconciled-at": "2026-01-05T18:29:28.343811+00:00"
27269
+ "x-reconciled-at": "2026-01-07T15:53:30.434339+00:00"
26786
27270
  },
26787
27271
  "disabled": {
26788
27272
  "type": "boolean",
@@ -26790,6 +27274,8 @@
26790
27274
  "title": "Disabled",
26791
27275
  "format": "boolean",
26792
27276
  "x-displayname": "Disabled",
27277
+ "x-f5xc-example": "True",
27278
+ "x-f5xc-description-short": "Value of true indicates infraprotect_firewall_ruleset is administratively disabled.",
26793
27279
  "x-f5xc-required-for": {
26794
27280
  "minimum_config": false,
26795
27281
  "create": false,
@@ -26805,6 +27291,8 @@
26805
27291
  "description": "The set of labels present on this infraprotect_firewall_ruleset.",
26806
27292
  "title": "Labels",
26807
27293
  "x-displayname": "Labels",
27294
+ "x-f5xc-example": "{\"key\": \"value\"}",
27295
+ "x-f5xc-description-short": "The set of labels present on this infraprotect_firewall_ruleset.",
26808
27296
  "x-f5xc-required-for": {
26809
27297
  "minimum_config": false,
26810
27298
  "create": false,
@@ -26822,6 +27310,7 @@
26822
27310
  "x-displayname": "Name",
26823
27311
  "x-ves-example": "Name",
26824
27312
  "x-f5xc-example": "name",
27313
+ "x-f5xc-description-short": "The name of this infraprotect_firewall_ruleset.",
26825
27314
  "minLength": 0,
26826
27315
  "maxLength": 16,
26827
27316
  "x-f5xc-required-for": {
@@ -26832,7 +27321,7 @@
26832
27321
  },
26833
27322
  "x-original-maxLength": 1024,
26834
27323
  "x-reconciled-from-discovery": true,
26835
- "x-reconciled-at": "2026-01-05T18:29:28.343823+00:00"
27324
+ "x-reconciled-at": "2026-01-07T15:53:30.434350+00:00"
26836
27325
  },
26837
27326
  "namespace": {
26838
27327
  "type": "string",
@@ -26851,7 +27340,7 @@
26851
27340
  },
26852
27341
  "x-original-maxLength": 1024,
26853
27342
  "x-reconciled-from-discovery": true,
26854
- "x-reconciled-at": "2026-01-05T18:29:28.343827+00:00"
27343
+ "x-reconciled-at": "2026-01-07T15:53:30.434355+00:00"
26855
27344
  },
26856
27345
  "owner_view": {
26857
27346
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -26864,6 +27353,7 @@
26864
27353
  "$ref": "#/components/schemas/infraprotect_firewall_rulesetStatusObject"
26865
27354
  },
26866
27355
  "x-displayname": "Status",
27356
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
26867
27357
  "x-f5xc-required-for": {
26868
27358
  "minimum_config": false,
26869
27359
  "create": false,
@@ -26892,7 +27382,7 @@
26892
27382
  "x-field-mutability": "read-only",
26893
27383
  "x-original-maxLength": 1024,
26894
27384
  "x-reconciled-from-discovery": true,
26895
- "x-reconciled-at": "2026-01-05T18:29:28.343835+00:00"
27385
+ "x-reconciled-at": "2026-01-07T15:53:30.434363+00:00"
26896
27386
  },
26897
27387
  "uid": {
26898
27388
  "type": "string",
@@ -26901,6 +27391,7 @@
26901
27391
  "x-displayname": "UID",
26902
27392
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
26903
27393
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
27394
+ "x-f5xc-description-short": "The unique uid of this infraprotect_firewall_ruleset.",
26904
27395
  "minLength": 0,
26905
27396
  "maxLength": 36,
26906
27397
  "x-f5xc-required-for": {
@@ -26913,9 +27404,11 @@
26913
27404
  "x-original-maxLength": 1024,
26914
27405
  "format": "uuid",
26915
27406
  "x-reconciled-from-discovery": true,
26916
- "x-reconciled-at": "2026-01-05T18:29:28.343841+00:00"
27407
+ "x-reconciled-at": "2026-01-07T15:53:30.434369+00:00"
26917
27408
  }
26918
27409
  },
27410
+ "x-f5xc-description-short": "By default a summary of infraprotect_firewall_ruleset is returned in 'List'.",
27411
+ "x-f5xc-description-medium": "By default a summary of infraprotect_firewall_ruleset is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
26919
27412
  "x-f5xc-minimum-configuration": {
26920
27413
  "description": "Minimum configuration for infraprotect_firewall_rulesetListResponseItem",
26921
27414
  "required_fields": [
@@ -27003,6 +27496,7 @@
27003
27496
  "ves.io.schema.rules.message.required": "true",
27004
27497
  "ves.io.schema.rules.repeated.unique": "true"
27005
27498
  },
27499
+ "x-f5xc-example": "{\"key\": \"value\"}",
27006
27500
  "x-f5xc-required-for": {
27007
27501
  "minimum_config": false,
27008
27502
  "create": false,
@@ -27037,6 +27531,7 @@
27037
27531
  "$ref": "#/components/schemas/schemaConditionType"
27038
27532
  },
27039
27533
  "x-displayname": "Conditions.",
27534
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
27040
27535
  "x-f5xc-required-for": {
27041
27536
  "minimum_config": false,
27042
27537
  "create": false,
@@ -27092,6 +27587,7 @@
27092
27587
  "$ref": "#/components/schemas/schemaObjectRefType"
27093
27588
  },
27094
27589
  "x-displayname": "Deleted Referred Objects.",
27590
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
27095
27591
  "x-f5xc-required-for": {
27096
27592
  "minimum_config": false,
27097
27593
  "create": false,
@@ -27107,6 +27603,7 @@
27107
27603
  "$ref": "#/components/schemas/schemaObjectRefType"
27108
27604
  },
27109
27605
  "x-displayname": "Disabled Referred Objects.",
27606
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
27110
27607
  "x-f5xc-required-for": {
27111
27608
  "minimum_config": false,
27112
27609
  "create": false,
@@ -27125,6 +27622,7 @@
27125
27622
  "$ref": "#/components/schemas/schemaObjectRefType"
27126
27623
  },
27127
27624
  "x-displayname": "Referring Objects.",
27625
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
27128
27626
  "x-f5xc-required-for": {
27129
27627
  "minimum_config": false,
27130
27628
  "create": false,
@@ -27143,6 +27641,8 @@
27143
27641
  "$ref": "#/components/schemas/infraprotect_informationStatusObject"
27144
27642
  },
27145
27643
  "x-displayname": "Status",
27644
+ "x-f5xc-example": "active",
27645
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
27146
27646
  "x-f5xc-required-for": {
27147
27647
  "minimum_config": false,
27148
27648
  "create": false,
@@ -27152,7 +27652,7 @@
27152
27652
  "maxLength": 17,
27153
27653
  "minLength": 17,
27154
27654
  "x-reconciled-from-discovery": true,
27155
- "x-reconciled-at": "2026-01-05T18:29:28.609915+00:00"
27655
+ "x-reconciled-at": "2026-01-07T15:53:30.795269+00:00"
27156
27656
  },
27157
27657
  "system_metadata": {
27158
27658
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -27188,6 +27688,8 @@
27188
27688
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
27189
27689
  ],
27190
27690
  "default": "GET_RSP_FORMAT_DEFAULT",
27691
+ "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...",
27692
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\" Response should be in...",
27191
27693
  "x-f5xc-minimum-configuration": {
27192
27694
  "description": "Minimum configuration for infraprotect_informationGetResponseFormatCode",
27193
27695
  "required_fields": [],
@@ -27267,6 +27769,7 @@
27267
27769
  "x-displayname": "Super prefixes.",
27268
27770
  "x-ves-example": "Value",
27269
27771
  "x-f5xc-example": "value",
27772
+ "x-f5xc-description-short": "List of tenant 'super' prefixes noted in CIDR.",
27270
27773
  "x-f5xc-required-for": {
27271
27774
  "minimum_config": false,
27272
27775
  "create": false,
@@ -27367,6 +27870,7 @@
27367
27870
  "x-validation-rules": {
27368
27871
  "ves.io.schema.rules.uint32.lte": "9999"
27369
27872
  },
27873
+ "x-f5xc-description-short": "Bandwidth max allowed for a customer defined by contract.",
27370
27874
  "minimum": 0,
27371
27875
  "maximum": 2147483647,
27372
27876
  "x-f5xc-required-for": {
@@ -27377,6 +27881,7 @@
27377
27881
  }
27378
27882
  }
27379
27883
  },
27884
+ "x-f5xc-description-short": "Policer config for bandwidth restrictions.",
27380
27885
  "x-f5xc-minimum-configuration": {
27381
27886
  "description": "Minimum configuration for infraprotect_informationPolicer",
27382
27887
  "required_fields": [
@@ -27403,6 +27908,7 @@
27403
27908
  "$ref": "#/components/schemas/schemaConditionType"
27404
27909
  },
27405
27910
  "x-displayname": "Conditions.",
27911
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
27406
27912
  "x-f5xc-required-for": {
27407
27913
  "minimum_config": false,
27408
27914
  "create": false,
@@ -27458,6 +27964,8 @@
27458
27964
  "x-displayname": "Decryption Provider.",
27459
27965
  "x-ves-example": "Value",
27460
27966
  "x-f5xc-example": "value",
27967
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
27968
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
27461
27969
  "minLength": 0,
27462
27970
  "maxLength": 1024,
27463
27971
  "x-f5xc-required-for": {
@@ -27483,6 +27991,8 @@
27483
27991
  "ves.io.schema.rules.message.required": "true",
27484
27992
  "ves.io.schema.rules.string.uri_ref": "true"
27485
27993
  },
27994
+ "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
27995
+ "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
27486
27996
  "minLength": 0,
27487
27997
  "maxLength": 4,
27488
27998
  "x-f5xc-required-for": {
@@ -27493,7 +28003,7 @@
27493
28003
  },
27494
28004
  "x-original-maxLength": 1024,
27495
28005
  "x-reconciled-from-discovery": true,
27496
- "x-reconciled-at": "2026-01-05T18:29:28.609956+00:00"
28006
+ "x-reconciled-at": "2026-01-07T15:53:30.795308+00:00"
27497
28007
  },
27498
28008
  "store_provider": {
27499
28009
  "type": "string",
@@ -27502,6 +28012,8 @@
27502
28012
  "x-displayname": "Store Provider.",
27503
28013
  "x-ves-example": "Value",
27504
28014
  "x-f5xc-example": "value",
28015
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
28016
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
27505
28017
  "minLength": 0,
27506
28018
  "maxLength": 1024,
27507
28019
  "x-f5xc-required-for": {
@@ -27512,6 +28024,7 @@
27512
28024
  }
27513
28025
  }
27514
28026
  },
28027
+ "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
27515
28028
  "x-f5xc-minimum-configuration": {
27516
28029
  "description": "Minimum configuration for schemaBlindfoldSecretInfoType",
27517
28030
  "required_fields": [
@@ -27541,6 +28054,8 @@
27541
28054
  "x-displayname": "Provider",
27542
28055
  "x-ves-example": "Box-provider.",
27543
28056
  "x-f5xc-example": "box-provider",
28057
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
28058
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
27544
28059
  "minLength": 0,
27545
28060
  "maxLength": 8,
27546
28061
  "x-f5xc-required-for": {
@@ -27551,7 +28066,7 @@
27551
28066
  },
27552
28067
  "x-original-maxLength": 1024,
27553
28068
  "x-reconciled-from-discovery": true,
27554
- "x-reconciled-at": "2026-01-05T18:29:28.609964+00:00"
28069
+ "x-reconciled-at": "2026-01-07T15:53:30.795316+00:00"
27555
28070
  },
27556
28071
  "url": {
27557
28072
  "type": "string",
@@ -27572,6 +28087,8 @@
27572
28087
  "ves.io.schema.rules.string.max_bytes": "131072",
27573
28088
  "ves.io.schema.rules.string.uri_ref": "true"
27574
28089
  },
28090
+ "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
28091
+ "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
27575
28092
  "format": "uri",
27576
28093
  "minLength": 0,
27577
28094
  "x-f5xc-required-for": {
@@ -27582,6 +28099,7 @@
27582
28099
  }
27583
28100
  }
27584
28101
  },
28102
+ "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
27585
28103
  "x-f5xc-minimum-configuration": {
27586
28104
  "description": "Minimum configuration for schemaClearSecretInfoType",
27587
28105
  "required_fields": [
@@ -27604,6 +28122,8 @@
27604
28122
  "EncodingBase64"
27605
28123
  ],
27606
28124
  "default": "EncodingNone",
28125
+ "x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
28126
+ "x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
27607
28127
  "x-f5xc-minimum-configuration": {
27608
28128
  "description": "Minimum configuration for schemaSecretEncodingType",
27609
28129
  "required_fields": [],
@@ -27629,6 +28149,7 @@
27629
28149
  "$ref": "#/components/schemas/schemaClearSecretInfoType"
27630
28150
  }
27631
28151
  },
28152
+ "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
27632
28153
  "x-f5xc-minimum-configuration": {
27633
28154
  "description": "Minimum configuration for schemaSecretType",
27634
28155
  "required_fields": [
@@ -27652,6 +28173,8 @@
27652
28173
  "description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
27653
28174
  "title": "Key",
27654
28175
  "x-f5xc-example": "key_pem",
28176
+ "x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
28177
+ "x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
27655
28178
  "minLength": 0,
27656
28179
  "maxLength": 16,
27657
28180
  "x-f5xc-required-for": {
@@ -27662,13 +28185,14 @@
27662
28185
  },
27663
28186
  "x-original-maxLength": 1024,
27664
28187
  "x-reconciled-from-discovery": true,
27665
- "x-reconciled-at": "2026-01-05T18:29:28.610104+00:00"
28188
+ "x-reconciled-at": "2026-01-07T15:53:30.795444+00:00"
27666
28189
  },
27667
28190
  "location": {
27668
28191
  "type": "string",
27669
28192
  "description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
27670
28193
  "title": "Location",
27671
28194
  "x-f5xc-example": "v1/data/vhost_key",
28195
+ "x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
27672
28196
  "minLength": 0,
27673
28197
  "maxLength": 4,
27674
28198
  "x-f5xc-required-for": {
@@ -27679,13 +28203,15 @@
27679
28203
  },
27680
28204
  "x-original-maxLength": 1024,
27681
28205
  "x-reconciled-from-discovery": true,
27682
- "x-reconciled-at": "2026-01-05T18:29:28.610109+00:00"
28206
+ "x-reconciled-at": "2026-01-07T15:53:30.795449+00:00"
27683
28207
  },
27684
28208
  "provider": {
27685
28209
  "type": "string",
27686
28210
  "description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
27687
28211
  "title": "Provider",
27688
28212
  "x-f5xc-example": "vault-vh-provider",
28213
+ "x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
28214
+ "x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
27689
28215
  "minLength": 0,
27690
28216
  "maxLength": 8,
27691
28217
  "x-f5xc-required-for": {
@@ -27696,7 +28222,7 @@
27696
28222
  },
27697
28223
  "x-original-maxLength": 1024,
27698
28224
  "x-reconciled-from-discovery": true,
27699
- "x-reconciled-at": "2026-01-05T18:29:28.610113+00:00"
28225
+ "x-reconciled-at": "2026-01-07T15:53:30.795453+00:00"
27700
28226
  },
27701
28227
  "secret_encoding": {
27702
28228
  "$ref": "#/components/schemas/schemaSecretEncodingType"
@@ -27707,6 +28233,8 @@
27707
28233
  "title": "Version",
27708
28234
  "format": "int64",
27709
28235
  "x-f5xc-example": "1",
28236
+ "x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
28237
+ "x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
27710
28238
  "minimum": 0,
27711
28239
  "maximum": 2147483647,
27712
28240
  "x-f5xc-required-for": {
@@ -27718,9 +28246,11 @@
27718
28246
  "maxLength": 1,
27719
28247
  "minLength": 1,
27720
28248
  "x-reconciled-from-discovery": true,
27721
- "x-reconciled-at": "2026-01-05T18:29:28.610120+00:00"
28249
+ "x-reconciled-at": "2026-01-07T15:53:30.795459+00:00"
27722
28250
  }
27723
28251
  },
28252
+ "x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
28253
+ "x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
27724
28254
  "x-f5xc-minimum-configuration": {
27725
28255
  "description": "Minimum configuration for schemaVaultSecretInfoType",
27726
28256
  "required_fields": [
@@ -27747,6 +28277,7 @@
27747
28277
  "description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
27748
28278
  "title": "Name",
27749
28279
  "x-f5xc-example": "ChargeBack-API-Key",
28280
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
27750
28281
  "minLength": 0,
27751
28282
  "maxLength": 16,
27752
28283
  "x-f5xc-required-for": {
@@ -27757,9 +28288,10 @@
27757
28288
  },
27758
28289
  "x-original-maxLength": 1024,
27759
28290
  "x-reconciled-from-discovery": true,
27760
- "x-reconciled-at": "2026-01-05T18:29:28.610142+00:00"
28291
+ "x-reconciled-at": "2026-01-07T15:53:30.795483+00:00"
27761
28292
  }
27762
28293
  },
28294
+ "x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
27763
28295
  "x-f5xc-minimum-configuration": {
27764
28296
  "description": "Minimum configuration for schemaWingmanSecretInfoType",
27765
28297
  "required_fields": [
@@ -27850,6 +28382,8 @@
27850
28382
  "description": "Exclusive with [expiration_never]\nThis advertisement will expire at the given timestamp and will be removed from the system afterwards.",
27851
28383
  "format": "date-time",
27852
28384
  "x-displayname": "Expiration Time (UTC)",
28385
+ "x-f5xc-description-short": "Exclusive with [expiration_never] This advertisement will expire at the given timestamp and will be removed from the system afterwards.",
28386
+ "x-f5xc-description-medium": "Exclusive with [expiration_never] This advertisement will expire at the given timestamp and will be removed from the system afterwards.",
27853
28387
  "minLength": 0,
27854
28388
  "maxLength": 1024,
27855
28389
  "x-f5xc-required-for": {
@@ -27874,6 +28408,7 @@
27874
28408
  "ves.io.schema.rules.message.required": "true",
27875
28409
  "ves.io.schema.rules.string.ip_prefix_globally_routable": "true"
27876
28410
  },
28411
+ "x-f5xc-description-short": "Advertisement Prefix Advertisement prefix lookup depending on type Required: YES.",
27877
28412
  "minLength": 0,
27878
28413
  "maxLength": 1024,
27879
28414
  "x-f5xc-required-for": {
@@ -27913,6 +28448,7 @@
27913
28448
  "title": "Fail_if_referred.",
27914
28449
  "format": "boolean",
27915
28450
  "x-displayname": "Fail-If-Referred.",
28451
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
27916
28452
  "x-f5xc-required-for": {
27917
28453
  "minimum_config": false,
27918
28454
  "create": false,
@@ -27937,7 +28473,7 @@
27937
28473
  },
27938
28474
  "x-original-maxLength": 1024,
27939
28475
  "x-reconciled-from-discovery": true,
27940
- "x-reconciled-at": "2026-01-05T18:29:28.943623+00:00"
28476
+ "x-reconciled-at": "2026-01-07T15:53:31.232826+00:00"
27941
28477
  },
27942
28478
  "namespace": {
27943
28479
  "type": "string",
@@ -27946,6 +28482,7 @@
27946
28482
  "x-displayname": "Namespace",
27947
28483
  "x-ves-example": "Ns1",
27948
28484
  "x-f5xc-example": "ns1",
28485
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
27949
28486
  "minLength": 0,
27950
28487
  "maxLength": 6,
27951
28488
  "x-f5xc-required-for": {
@@ -27956,7 +28493,7 @@
27956
28493
  },
27957
28494
  "x-original-maxLength": 1024,
27958
28495
  "x-reconciled-from-discovery": true,
27959
- "x-reconciled-at": "2026-01-05T18:29:28.943629+00:00"
28496
+ "x-reconciled-at": "2026-01-07T15:53:31.232833+00:00"
27960
28497
  }
27961
28498
  },
27962
28499
  "x-f5xc-minimum-configuration": {
@@ -27991,6 +28528,7 @@
27991
28528
  "$ref": "#/components/schemas/schemaObjectRefType"
27992
28529
  },
27993
28530
  "x-displayname": "Deleted Referred Objects.",
28531
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
27994
28532
  "x-f5xc-required-for": {
27995
28533
  "minimum_config": false,
27996
28534
  "create": false,
@@ -28006,6 +28544,7 @@
28006
28544
  "$ref": "#/components/schemas/schemaObjectRefType"
28007
28545
  },
28008
28546
  "x-displayname": "Disabled Referred Objects.",
28547
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
28009
28548
  "x-f5xc-required-for": {
28010
28549
  "minimum_config": false,
28011
28550
  "create": false,
@@ -28024,6 +28563,7 @@
28024
28563
  "$ref": "#/components/schemas/schemaObjectRefType"
28025
28564
  },
28026
28565
  "x-displayname": "Referring Objects.",
28566
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
28027
28567
  "x-f5xc-required-for": {
28028
28568
  "minimum_config": false,
28029
28569
  "create": false,
@@ -28045,6 +28585,8 @@
28045
28585
  "$ref": "#/components/schemas/infraprotect_internet_prefix_advertisementStatusObject"
28046
28586
  },
28047
28587
  "x-displayname": "Status",
28588
+ "x-f5xc-example": "active",
28589
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
28048
28590
  "x-f5xc-required-for": {
28049
28591
  "minimum_config": false,
28050
28592
  "create": false,
@@ -28054,7 +28596,7 @@
28054
28596
  "maxLength": 17,
28055
28597
  "minLength": 17,
28056
28598
  "x-reconciled-from-discovery": true,
28057
- "x-reconciled-at": "2026-01-05T18:29:28.943645+00:00"
28599
+ "x-reconciled-at": "2026-01-07T15:53:31.232849+00:00"
28058
28600
  },
28059
28601
  "system_metadata": {
28060
28602
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -28094,6 +28636,8 @@
28094
28636
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
28095
28637
  ],
28096
28638
  "default": "GET_RSP_FORMAT_DEFAULT",
28639
+ "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...",
28640
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
28097
28641
  "x-f5xc-minimum-configuration": {
28098
28642
  "description": "Minimum configuration for infraprotect_internet_prefix_advertisementGetResponseFormatCode",
28099
28643
  "required_fields": [],
@@ -28127,6 +28671,8 @@
28127
28671
  "description": "Exclusive with [expiration_never]\nThis advertisement will expire at the given timestamp and will be removed from the system afterwards.",
28128
28672
  "format": "date-time",
28129
28673
  "x-displayname": "Expiration Time (UTC)",
28674
+ "x-f5xc-description-short": "Exclusive with [expiration_never] This advertisement will expire at the given timestamp and will be removed from the system afterwards.",
28675
+ "x-f5xc-description-medium": "Exclusive with [expiration_never] This advertisement will expire at the given timestamp and will be removed from the system afterwards.",
28130
28676
  "minLength": 0,
28131
28677
  "maxLength": 1024,
28132
28678
  "x-f5xc-required-for": {
@@ -28151,6 +28697,7 @@
28151
28697
  "ves.io.schema.rules.message.required": "true",
28152
28698
  "ves.io.schema.rules.string.ip_prefix_globally_routable": "true"
28153
28699
  },
28700
+ "x-f5xc-description-short": "Advertisement Prefix Advertisement prefix lookup depending on type Required: YES.",
28154
28701
  "minLength": 0,
28155
28702
  "maxLength": 1024,
28156
28703
  "x-f5xc-required-for": {
@@ -28192,6 +28739,7 @@
28192
28739
  "$ref": "#/components/schemas/schemaErrorType"
28193
28740
  },
28194
28741
  "x-displayname": "Errors",
28742
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
28195
28743
  "x-f5xc-required-for": {
28196
28744
  "minimum_config": false,
28197
28745
  "create": false,
@@ -28207,6 +28755,8 @@
28207
28755
  "$ref": "#/components/schemas/infraprotect_internet_prefix_advertisementListResponseItem"
28208
28756
  },
28209
28757
  "x-displayname": "Items",
28758
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
28759
+ "x-f5xc-description-short": "Items represents the collection in response.",
28210
28760
  "x-f5xc-required-for": {
28211
28761
  "minimum_config": false,
28212
28762
  "create": false,
@@ -28240,6 +28790,8 @@
28240
28790
  "description": "The set of annotations present on this infraprotect_internet_prefix_advertisement.",
28241
28791
  "title": "Annotations.",
28242
28792
  "x-displayname": "Annotations.",
28793
+ "x-f5xc-example": "{\"key\": \"value\"}",
28794
+ "x-f5xc-description-short": "The set of annotations present on this infraprotect_internet_prefix_advertisement.",
28243
28795
  "x-f5xc-required-for": {
28244
28796
  "minimum_config": false,
28245
28797
  "create": false,
@@ -28252,6 +28804,7 @@
28252
28804
  "description": "The description set for this infraprotect_internet_prefix_advertisement.",
28253
28805
  "title": "Description.",
28254
28806
  "x-displayname": "Description.",
28807
+ "x-f5xc-description-short": "The description set for this infraprotect_internet_prefix_advertisement.",
28255
28808
  "minLength": 0,
28256
28809
  "maxLength": 0,
28257
28810
  "x-f5xc-required-for": {
@@ -28262,7 +28815,7 @@
28262
28815
  },
28263
28816
  "x-original-maxLength": 1024,
28264
28817
  "x-reconciled-from-discovery": true,
28265
- "x-reconciled-at": "2026-01-05T18:29:28.943664+00:00"
28818
+ "x-reconciled-at": "2026-01-07T15:53:31.232868+00:00"
28266
28819
  },
28267
28820
  "disabled": {
28268
28821
  "type": "boolean",
@@ -28270,6 +28823,8 @@
28270
28823
  "title": "Disabled",
28271
28824
  "format": "boolean",
28272
28825
  "x-displayname": "Disabled",
28826
+ "x-f5xc-example": "True",
28827
+ "x-f5xc-description-short": "Value of true indicates infraprotect_internet_prefix_advertisement is administratively disabled.",
28273
28828
  "x-f5xc-required-for": {
28274
28829
  "minimum_config": false,
28275
28830
  "create": false,
@@ -28285,6 +28840,8 @@
28285
28840
  "description": "The set of labels present on this infraprotect_internet_prefix_advertisement.",
28286
28841
  "title": "Labels",
28287
28842
  "x-displayname": "Labels",
28843
+ "x-f5xc-example": "{\"key\": \"value\"}",
28844
+ "x-f5xc-description-short": "The set of labels present on this infraprotect_internet_prefix_advertisement.",
28288
28845
  "x-f5xc-required-for": {
28289
28846
  "minimum_config": false,
28290
28847
  "create": false,
@@ -28302,6 +28859,7 @@
28302
28859
  "x-displayname": "Name",
28303
28860
  "x-ves-example": "Name",
28304
28861
  "x-f5xc-example": "name",
28862
+ "x-f5xc-description-short": "The name of this infraprotect_internet_prefix_advertisement.",
28305
28863
  "minLength": 0,
28306
28864
  "maxLength": 16,
28307
28865
  "x-f5xc-required-for": {
@@ -28312,7 +28870,7 @@
28312
28870
  },
28313
28871
  "x-original-maxLength": 1024,
28314
28872
  "x-reconciled-from-discovery": true,
28315
- "x-reconciled-at": "2026-01-05T18:29:28.943674+00:00"
28873
+ "x-reconciled-at": "2026-01-07T15:53:31.232879+00:00"
28316
28874
  },
28317
28875
  "namespace": {
28318
28876
  "type": "string",
@@ -28331,7 +28889,7 @@
28331
28889
  },
28332
28890
  "x-original-maxLength": 1024,
28333
28891
  "x-reconciled-from-discovery": true,
28334
- "x-reconciled-at": "2026-01-05T18:29:28.943679+00:00"
28892
+ "x-reconciled-at": "2026-01-07T15:53:31.232883+00:00"
28335
28893
  },
28336
28894
  "owner_view": {
28337
28895
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -28344,6 +28902,7 @@
28344
28902
  "$ref": "#/components/schemas/infraprotect_internet_prefix_advertisementStatusObject"
28345
28903
  },
28346
28904
  "x-displayname": "Status",
28905
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
28347
28906
  "x-f5xc-required-for": {
28348
28907
  "minimum_config": false,
28349
28908
  "create": false,
@@ -28372,7 +28931,7 @@
28372
28931
  "x-field-mutability": "read-only",
28373
28932
  "x-original-maxLength": 1024,
28374
28933
  "x-reconciled-from-discovery": true,
28375
- "x-reconciled-at": "2026-01-05T18:29:28.943687+00:00"
28934
+ "x-reconciled-at": "2026-01-07T15:53:31.232891+00:00"
28376
28935
  },
28377
28936
  "uid": {
28378
28937
  "type": "string",
@@ -28381,6 +28940,7 @@
28381
28940
  "x-displayname": "UID",
28382
28941
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
28383
28942
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
28943
+ "x-f5xc-description-short": "The unique uid of this infraprotect_internet_prefix_advertisement.",
28384
28944
  "minLength": 0,
28385
28945
  "maxLength": 36,
28386
28946
  "x-f5xc-required-for": {
@@ -28393,9 +28953,11 @@
28393
28953
  "x-original-maxLength": 1024,
28394
28954
  "format": "uuid",
28395
28955
  "x-reconciled-from-discovery": true,
28396
- "x-reconciled-at": "2026-01-05T18:29:28.943693+00:00"
28956
+ "x-reconciled-at": "2026-01-07T15:53:31.232897+00:00"
28397
28957
  }
28398
28958
  },
28959
+ "x-f5xc-description-short": "By default a summary of infraprotect_internet_prefix_advertisement is returned in 'List'.",
28960
+ "x-f5xc-description-medium": "By default a summary of infraprotect_internet_prefix_advertisement is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
28399
28961
  "x-f5xc-minimum-configuration": {
28400
28962
  "description": "Minimum configuration for infraprotect_internet_prefix_advertisementListResponseItem",
28401
28963
  "required_fields": [
@@ -28483,6 +29045,8 @@
28483
29045
  "description": "Exclusive with [expiration_never]\nThis advertisement will expire at the given timestamp and will be removed from the system afterwards.",
28484
29046
  "format": "date-time",
28485
29047
  "x-displayname": "Expiration Time (UTC)",
29048
+ "x-f5xc-description-short": "Exclusive with [expiration_never] This advertisement will expire at the given timestamp and will be removed from the system afterwards.",
29049
+ "x-f5xc-description-medium": "Exclusive with [expiration_never] This advertisement will expire at the given timestamp and will be removed from the system afterwards.",
28486
29050
  "minLength": 0,
28487
29051
  "maxLength": 1024,
28488
29052
  "x-f5xc-required-for": {
@@ -28522,6 +29086,7 @@
28522
29086
  "$ref": "#/components/schemas/schemaConditionType"
28523
29087
  },
28524
29088
  "x-displayname": "Conditions.",
29089
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
28525
29090
  "x-f5xc-required-for": {
28526
29091
  "minimum_config": false,
28527
29092
  "create": false,
@@ -28590,6 +29155,7 @@
28590
29155
  "x-validation-rules": {
28591
29156
  "ves.io.schema.rules.message.required": "true"
28592
29157
  },
29158
+ "x-f5xc-description-short": "The name of the infraprotect internet prefix advertisement that has to be updated Required: YES.",
28593
29159
  "minLength": 0,
28594
29160
  "maxLength": 16,
28595
29161
  "x-f5xc-required-for": {
@@ -28600,7 +29166,7 @@
28600
29166
  },
28601
29167
  "x-original-maxLength": 1024,
28602
29168
  "x-reconciled-from-discovery": true,
28603
- "x-reconciled-at": "2026-01-05T18:29:28.943713+00:00"
29169
+ "x-reconciled-at": "2026-01-07T15:53:31.232918+00:00"
28604
29170
  },
28605
29171
  "namespace": {
28606
29172
  "type": "string",
@@ -28616,6 +29182,7 @@
28616
29182
  "x-validation-rules": {
28617
29183
  "ves.io.schema.rules.message.required": "true"
28618
29184
  },
29185
+ "x-f5xc-description-short": "Namespace in which internet prefix advertisement status has to be updated Required: YES.",
28619
29186
  "minLength": 0,
28620
29187
  "maxLength": 6,
28621
29188
  "x-f5xc-required-for": {
@@ -28626,9 +29193,10 @@
28626
29193
  },
28627
29194
  "x-original-maxLength": 1024,
28628
29195
  "x-reconciled-from-discovery": true,
28629
- "x-reconciled-at": "2026-01-05T18:29:28.943717+00:00"
29196
+ "x-reconciled-at": "2026-01-07T15:53:31.232923+00:00"
28630
29197
  }
28631
29198
  },
29199
+ "x-f5xc-description-short": "Request to toggle Internet prefix advertisement announcement/withdrawal.",
28632
29200
  "x-f5xc-minimum-configuration": {
28633
29201
  "description": "Minimum configuration for infraprotect_internet_prefix_advertisementUpdateInternetPrefixAdvertisementRequest",
28634
29202
  "required_fields": [
@@ -28687,6 +29255,7 @@
28687
29255
  "ves.io.schema.rules.uint32.gte": "30",
28688
29256
  "ves.io.schema.rules.uint32.lte": "300"
28689
29257
  },
29258
+ "x-f5xc-description-short": "BGP hold down timer, in seconds Required: YES.",
28690
29259
  "minimum": 0,
28691
29260
  "maximum": 2147483647,
28692
29261
  "x-f5xc-required-for": {
@@ -28706,6 +29275,7 @@
28706
29275
  "$ref": "#/components/schemas/ioschemaEmpty"
28707
29276
  }
28708
29277
  },
29278
+ "x-f5xc-description-short": "BGP information associated with a DDoS transit tunnel.",
28709
29279
  "x-f5xc-minimum-configuration": {
28710
29280
  "description": "Minimum configuration for infraprotect_tunnelBGPInformation",
28711
29281
  "required_fields": [
@@ -28883,6 +29453,7 @@
28883
29453
  "title": "Fail_if_referred.",
28884
29454
  "format": "boolean",
28885
29455
  "x-displayname": "Fail-If-Referred.",
29456
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
28886
29457
  "x-f5xc-required-for": {
28887
29458
  "minimum_config": false,
28888
29459
  "create": false,
@@ -28907,7 +29478,7 @@
28907
29478
  },
28908
29479
  "x-original-maxLength": 1024,
28909
29480
  "x-reconciled-from-discovery": true,
28910
- "x-reconciled-at": "2026-01-05T18:30:06.031372+00:00"
29481
+ "x-reconciled-at": "2026-01-07T15:54:18.119988+00:00"
28911
29482
  },
28912
29483
  "namespace": {
28913
29484
  "type": "string",
@@ -28916,6 +29487,7 @@
28916
29487
  "x-displayname": "Namespace",
28917
29488
  "x-ves-example": "Ns1",
28918
29489
  "x-f5xc-example": "ns1",
29490
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
28919
29491
  "minLength": 0,
28920
29492
  "maxLength": 6,
28921
29493
  "x-f5xc-required-for": {
@@ -28926,7 +29498,7 @@
28926
29498
  },
28927
29499
  "x-original-maxLength": 1024,
28928
29500
  "x-reconciled-from-discovery": true,
28929
- "x-reconciled-at": "2026-01-05T18:30:06.031379+00:00"
29501
+ "x-reconciled-at": "2026-01-07T15:54:18.119995+00:00"
28930
29502
  }
28931
29503
  },
28932
29504
  "x-f5xc-minimum-configuration": {
@@ -28961,6 +29533,7 @@
28961
29533
  "$ref": "#/components/schemas/ioschemaObjectRefType"
28962
29534
  },
28963
29535
  "x-displayname": "Deleted Referred Objects.",
29536
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
28964
29537
  "x-f5xc-required-for": {
28965
29538
  "minimum_config": false,
28966
29539
  "create": false,
@@ -28976,6 +29549,7 @@
28976
29549
  "$ref": "#/components/schemas/ioschemaObjectRefType"
28977
29550
  },
28978
29551
  "x-displayname": "Disabled Referred Objects.",
29552
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
28979
29553
  "x-f5xc-required-for": {
28980
29554
  "minimum_config": false,
28981
29555
  "create": false,
@@ -28994,6 +29568,7 @@
28994
29568
  "$ref": "#/components/schemas/ioschemaObjectRefType"
28995
29569
  },
28996
29570
  "x-displayname": "Referring Objects.",
29571
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
28997
29572
  "x-f5xc-required-for": {
28998
29573
  "minimum_config": false,
28999
29574
  "create": false,
@@ -29015,6 +29590,8 @@
29015
29590
  "$ref": "#/components/schemas/infraprotect_tunnelStatusObject"
29016
29591
  },
29017
29592
  "x-displayname": "Status",
29593
+ "x-f5xc-example": "active",
29594
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
29018
29595
  "x-f5xc-required-for": {
29019
29596
  "minimum_config": false,
29020
29597
  "create": false,
@@ -29024,7 +29601,7 @@
29024
29601
  "maxLength": 17,
29025
29602
  "minLength": 17,
29026
29603
  "x-reconciled-from-discovery": true,
29027
- "x-reconciled-at": "2026-01-05T18:30:06.031395+00:00"
29604
+ "x-reconciled-at": "2026-01-07T15:54:18.120011+00:00"
29028
29605
  },
29029
29606
  "system_metadata": {
29030
29607
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -29064,6 +29641,8 @@
29064
29641
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
29065
29642
  ],
29066
29643
  "default": "GET_RSP_FORMAT_DEFAULT",
29644
+ "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...",
29645
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
29067
29646
  "x-f5xc-minimum-configuration": {
29068
29647
  "description": "Minimum configuration for infraprotect_tunnelGetResponseFormatCode",
29069
29648
  "required_fields": [],
@@ -29144,6 +29723,8 @@
29144
29723
  "type": "string",
29145
29724
  "description": "IP address for the F5 endpoint of the tunnel.",
29146
29725
  "x-displayname": "F5 Endpoint IP.",
29726
+ "x-f5xc-example": "{\"key\": \"value\"}",
29727
+ "x-f5xc-description-short": "IP address for the F5 endpoint of the tunnel.",
29147
29728
  "minLength": 0,
29148
29729
  "maxLength": 1024,
29149
29730
  "x-f5xc-required-for": {
@@ -29220,6 +29801,8 @@
29220
29801
  "x-displayname": "ID",
29221
29802
  "x-ves-example": "F5XC-ASH-T-000004.",
29222
29803
  "x-f5xc-example": "F5XC-ASH-T-000004",
29804
+ "x-f5xc-description-short": "ID of the tunnel used to uniquely identify it.",
29805
+ "x-f5xc-description-medium": "ID of the tunnel used to uniquely identify it. A customer can use this value in support tickets to specify which tunnel they are having trouble working with and it will facilitate lookup by internal teams into the internal systems this value travels across.",
29223
29806
  "minimum": 1,
29224
29807
  "maximum": 4094,
29225
29808
  "minLength": 0,
@@ -29314,6 +29897,7 @@
29314
29897
  "ves.io.schema.rules.message.required": "true",
29315
29898
  "ves.io.schema.rules.string.ipv4_globally_routable": "true"
29316
29899
  },
29900
+ "x-f5xc-description-short": "IPv4 address for the customer endpoint of the tunnel Required: YES.",
29317
29901
  "minLength": 0,
29318
29902
  "maxLength": 1024,
29319
29903
  "x-f5xc-required-for": {
@@ -29384,6 +29968,7 @@
29384
29968
  "ves.io.schema.rules.message.required": "true",
29385
29969
  "ves.io.schema.rules.string.ipv6_globally_routable": "true"
29386
29970
  },
29971
+ "x-f5xc-description-short": "IPv6 address for the customer endpoint of the tunnel Required: YES.",
29387
29972
  "minLength": 0,
29388
29973
  "maxLength": 1024,
29389
29974
  "x-f5xc-required-for": {
@@ -29437,6 +30022,7 @@
29437
30022
  "ves.io.schema.rules.message.required": "true",
29438
30023
  "ves.io.schema.rules.string.ipv4_globally_routable": "true"
29439
30024
  },
30025
+ "x-f5xc-description-short": "IPv4 address for the customer endpoint of the tunnel Required: YES.",
29440
30026
  "minLength": 0,
29441
30027
  "maxLength": 1024,
29442
30028
  "x-f5xc-required-for": {
@@ -29482,6 +30068,7 @@
29482
30068
  "ves.io.schema.rules.message.required": "true",
29483
30069
  "ves.io.schema.rules.string.ipv6_globally_routable": "true"
29484
30070
  },
30071
+ "x-f5xc-description-short": "IPv6 address for the customer endpoint of the tunnel Required: YES.",
29485
30072
  "minLength": 0,
29486
30073
  "maxLength": 1024,
29487
30074
  "x-f5xc-required-for": {
@@ -29583,6 +30170,7 @@
29583
30170
  "$ref": "#/components/schemas/schemaErrorType"
29584
30171
  },
29585
30172
  "x-displayname": "Errors",
30173
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
29586
30174
  "x-f5xc-required-for": {
29587
30175
  "minimum_config": false,
29588
30176
  "create": false,
@@ -29598,6 +30186,8 @@
29598
30186
  "$ref": "#/components/schemas/infraprotect_tunnelListResponseItem"
29599
30187
  },
29600
30188
  "x-displayname": "Items",
30189
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
30190
+ "x-f5xc-description-short": "Items represents the collection in response.",
29601
30191
  "x-f5xc-required-for": {
29602
30192
  "minimum_config": false,
29603
30193
  "create": false,
@@ -29631,6 +30221,8 @@
29631
30221
  "description": "The set of annotations present on this infraprotect_tunnel.",
29632
30222
  "title": "Annotations.",
29633
30223
  "x-displayname": "Annotations.",
30224
+ "x-f5xc-example": "{\"key\": \"value\"}",
30225
+ "x-f5xc-description-short": "The set of annotations present on this infraprotect_tunnel.",
29634
30226
  "x-f5xc-required-for": {
29635
30227
  "minimum_config": false,
29636
30228
  "create": false,
@@ -29643,6 +30235,7 @@
29643
30235
  "description": "The description set for this infraprotect_tunnel.",
29644
30236
  "title": "Description.",
29645
30237
  "x-displayname": "Description.",
30238
+ "x-f5xc-description-short": "The description set for this infraprotect_tunnel.",
29646
30239
  "minLength": 0,
29647
30240
  "maxLength": 0,
29648
30241
  "x-f5xc-required-for": {
@@ -29653,7 +30246,7 @@
29653
30246
  },
29654
30247
  "x-original-maxLength": 1024,
29655
30248
  "x-reconciled-from-discovery": true,
29656
- "x-reconciled-at": "2026-01-05T18:30:06.031451+00:00"
30249
+ "x-reconciled-at": "2026-01-07T15:54:18.120067+00:00"
29657
30250
  },
29658
30251
  "disabled": {
29659
30252
  "type": "boolean",
@@ -29661,6 +30254,8 @@
29661
30254
  "title": "Disabled",
29662
30255
  "format": "boolean",
29663
30256
  "x-displayname": "Disabled",
30257
+ "x-f5xc-example": "True",
30258
+ "x-f5xc-description-short": "Value of true indicates infraprotect_tunnel is administratively disabled.",
29664
30259
  "x-f5xc-required-for": {
29665
30260
  "minimum_config": false,
29666
30261
  "create": false,
@@ -29676,6 +30271,8 @@
29676
30271
  "description": "The set of labels present on this infraprotect_tunnel.",
29677
30272
  "title": "Labels",
29678
30273
  "x-displayname": "Labels",
30274
+ "x-f5xc-example": "{\"key\": \"value\"}",
30275
+ "x-f5xc-description-short": "The set of labels present on this infraprotect_tunnel.",
29679
30276
  "x-f5xc-required-for": {
29680
30277
  "minimum_config": false,
29681
30278
  "create": false,
@@ -29703,7 +30300,7 @@
29703
30300
  },
29704
30301
  "x-original-maxLength": 1024,
29705
30302
  "x-reconciled-from-discovery": true,
29706
- "x-reconciled-at": "2026-01-05T18:30:06.031462+00:00"
30303
+ "x-reconciled-at": "2026-01-07T15:54:18.120077+00:00"
29707
30304
  },
29708
30305
  "namespace": {
29709
30306
  "type": "string",
@@ -29722,7 +30319,7 @@
29722
30319
  },
29723
30320
  "x-original-maxLength": 1024,
29724
30321
  "x-reconciled-from-discovery": true,
29725
- "x-reconciled-at": "2026-01-05T18:30:06.031467+00:00"
30322
+ "x-reconciled-at": "2026-01-07T15:54:18.120082+00:00"
29726
30323
  },
29727
30324
  "owner_view": {
29728
30325
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -29735,6 +30332,7 @@
29735
30332
  "$ref": "#/components/schemas/infraprotect_tunnelStatusObject"
29736
30333
  },
29737
30334
  "x-displayname": "Status",
30335
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
29738
30336
  "x-f5xc-required-for": {
29739
30337
  "minimum_config": false,
29740
30338
  "create": false,
@@ -29763,7 +30361,7 @@
29763
30361
  "x-field-mutability": "read-only",
29764
30362
  "x-original-maxLength": 1024,
29765
30363
  "x-reconciled-from-discovery": true,
29766
- "x-reconciled-at": "2026-01-05T18:30:06.031475+00:00"
30364
+ "x-reconciled-at": "2026-01-07T15:54:18.120090+00:00"
29767
30365
  },
29768
30366
  "uid": {
29769
30367
  "type": "string",
@@ -29772,6 +30370,7 @@
29772
30370
  "x-displayname": "UID",
29773
30371
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
29774
30372
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
30373
+ "x-f5xc-description-short": "The unique uid of this infraprotect_tunnel.",
29775
30374
  "minLength": 0,
29776
30375
  "maxLength": 36,
29777
30376
  "x-f5xc-required-for": {
@@ -29784,9 +30383,11 @@
29784
30383
  "x-original-maxLength": 1024,
29785
30384
  "format": "uuid",
29786
30385
  "x-reconciled-from-discovery": true,
29787
- "x-reconciled-at": "2026-01-05T18:30:06.031480+00:00"
30386
+ "x-reconciled-at": "2026-01-07T15:54:18.120096+00:00"
29788
30387
  }
29789
30388
  },
30389
+ "x-f5xc-description-short": "By default a summary of infraprotect_tunnel is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
30390
+ "x-f5xc-description-medium": "By default a summary of infraprotect_tunnel is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
29790
30391
  "x-f5xc-minimum-configuration": {
29791
30392
  "description": "Minimum configuration for infraprotect_tunnelListResponseItem",
29792
30393
  "required_fields": [
@@ -29909,6 +30510,7 @@
29909
30510
  "$ref": "#/components/schemas/schemaConditionType"
29910
30511
  },
29911
30512
  "x-displayname": "Conditions.",
30513
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
29912
30514
  "x-f5xc-required-for": {
29913
30515
  "minimum_config": false,
29914
30516
  "create": false,
@@ -29974,6 +30576,7 @@
29974
30576
  "ves.io.schema.rules.message.required": "true",
29975
30577
  "ves.io.schema.rules.string.max_len": "256"
29976
30578
  },
30579
+ "x-f5xc-description-short": "Destination tunnel Location. Required: YES.",
29977
30580
  "minLength": 0,
29978
30581
  "x-f5xc-required-for": {
29979
30582
  "minimum_config": false,
@@ -29983,7 +30586,7 @@
29983
30586
  },
29984
30587
  "x-original-maxLength": 256,
29985
30588
  "x-reconciled-from-discovery": true,
29986
- "x-reconciled-at": "2026-01-05T18:30:06.031500+00:00"
30589
+ "x-reconciled-at": "2026-01-07T15:54:18.120117+00:00"
29987
30590
  },
29988
30591
  "zone1": {
29989
30592
  "$ref": "#/components/schemas/ioschemaEmpty"
@@ -30021,6 +30624,7 @@
30021
30624
  "default": "TUNNEL_STATUS_INACTIVE",
30022
30625
  "x-displayname": "Config Status.",
30023
30626
  "x-ves-proto-enum": "ves.io.schema.infraprotect_tunnel.TunnelStatus",
30627
+ "x-f5xc-description-medium": "Current status of the tunnel. Inactive config status Down config status Active config status Activation Pending config status Activation Error - Needs Attention Activation Initializing.",
30024
30628
  "x-f5xc-minimum-configuration": {
30025
30629
  "description": "Minimum configuration for infraprotect_tunnelTunnelStatus",
30026
30630
  "required_fields": [],
@@ -30052,6 +30656,7 @@
30052
30656
  "x-validation-rules": {
30053
30657
  "ves.io.schema.rules.message.required": "true"
30054
30658
  },
30659
+ "x-f5xc-description-short": "Namespace in which the tunnel status is to be updated Required: YES.",
30055
30660
  "minLength": 0,
30056
30661
  "maxLength": 6,
30057
30662
  "x-f5xc-required-for": {
@@ -30062,7 +30667,7 @@
30062
30667
  },
30063
30668
  "x-original-maxLength": 1024,
30064
30669
  "x-reconciled-from-discovery": true,
30065
- "x-reconciled-at": "2026-01-05T18:30:06.031508+00:00"
30670
+ "x-reconciled-at": "2026-01-07T15:54:18.120124+00:00"
30066
30671
  },
30067
30672
  "tunnel_id": {
30068
30673
  "type": "string",
@@ -30078,6 +30683,7 @@
30078
30683
  "x-validation-rules": {
30079
30684
  "ves.io.schema.rules.message.required": "true"
30080
30685
  },
30686
+ "x-f5xc-description-short": "Unique identifier of the tunnel to update Required: YES.",
30081
30687
  "minLength": 0,
30082
30688
  "maxLength": 1024,
30083
30689
  "x-f5xc-required-for": {
@@ -30112,6 +30718,7 @@
30112
30718
  "title": "Update Tunnel Status Response.",
30113
30719
  "x-displayname": "Update Tunnel Status Response.",
30114
30720
  "x-ves-proto-message": "ves.io.schema.infraprotect_tunnel.UpdateTunnelStatusResponse",
30721
+ "x-f5xc-description-short": "Response returned from a tunnel status update.",
30115
30722
  "x-f5xc-minimum-configuration": {
30116
30723
  "description": "Minimum configuration for infraprotect_tunnelUpdateTunnelStatusResponse",
30117
30724
  "required_fields": [],