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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  2. package/dist/tools/generated/ce_management/index.js +179 -1582
  3. package/dist/tools/generated/ce_management/index.js.map +1 -1
  4. package/dist/tools/generated/dependency-graph.json +2 -265
  5. package/dist/version.d.ts +2 -2
  6. package/dist/version.js +2 -2
  7. package/manifest.json +1 -1
  8. package/package.json +1 -1
  9. package/specs/domains/admin_console_and_ui.json +111 -25
  10. package/specs/domains/ai_services.json +114 -35
  11. package/specs/domains/api.json +1082 -177
  12. package/specs/domains/authentication.json +205 -45
  13. package/specs/domains/bigip.json +593 -101
  14. package/specs/domains/billing_and_usage.json +440 -82
  15. package/specs/domains/blindfold.json +713 -110
  16. package/specs/domains/bot_and_threat_defense.json +359 -65
  17. package/specs/domains/cdn.json +2131 -194
  18. package/specs/domains/ce_management.json +9110 -15844
  19. package/specs/domains/certificates.json +362 -75
  20. package/specs/domains/cloud_infrastructure.json +802 -119
  21. package/specs/domains/container_services.json +613 -95
  22. package/specs/domains/data_and_privacy_security.json +364 -66
  23. package/specs/domains/data_intelligence.json +324 -63
  24. package/specs/domains/ddos.json +766 -159
  25. package/specs/domains/dns.json +820 -161
  26. package/specs/domains/managed_kubernetes.json +455 -85
  27. package/specs/domains/marketplace.json +670 -104
  28. package/specs/domains/network.json +1620 -238
  29. package/specs/domains/network_security.json +1401 -191
  30. package/specs/domains/nginx_one.json +326 -62
  31. package/specs/domains/object_storage.json +49 -15
  32. package/specs/domains/observability.json +999 -147
  33. package/specs/domains/rate_limiting.json +300 -55
  34. package/specs/domains/secops_and_incident_response.json +189 -36
  35. package/specs/domains/service_mesh.json +955 -124
  36. package/specs/domains/shape.json +2150 -397
  37. package/specs/domains/sites.json +3830 -364
  38. package/specs/domains/statistics.json +2117 -235
  39. package/specs/domains/support.json +602 -108
  40. package/specs/domains/telemetry_and_insights.json +753 -79
  41. package/specs/domains/tenant_and_identity.json +1874 -308
  42. package/specs/domains/threat_campaign.json +637 -71
  43. package/specs/domains/users.json +278 -66
  44. package/specs/domains/virtual.json +2803 -260
  45. package/specs/domains/vpm_and_node_management.json +3 -1
  46. package/specs/domains/waf.json +1125 -148
  47. package/specs/index.json +24 -24
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Support",
5
5
  "description": "Case management workflows including submission, commentary, and closure paths. Urgency adjustments and routing for time-sensitive incidents. Tax exemption verification requests. Site-level tcpdump operations—initiation, enumeration, and termination—for low-level network troubleshooting and protocol analysis.",
6
- "version": "2.0.13",
6
+ "version": "2.0.19",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -12650,6 +12650,7 @@
12650
12650
  "title": "CRL Name",
12651
12651
  "x-displayname": "CRL Name",
12652
12652
  "x-f5xc-example": "example-resource",
12653
+ "x-f5xc-description-short": "Exclusive with [uid] Name of the CRL object.",
12653
12654
  "minLength": 0,
12654
12655
  "maxLength": 16,
12655
12656
  "x-f5xc-required-for": {
@@ -12660,7 +12661,7 @@
12660
12661
  },
12661
12662
  "x-original-maxLength": 1024,
12662
12663
  "x-reconciled-from-discovery": true,
12663
- "x-reconciled-at": "2026-01-05T18:28:53.452195+00:00"
12664
+ "x-reconciled-at": "2026-01-07T15:28:05.308544+00:00"
12664
12665
  },
12665
12666
  "namespace": {
12666
12667
  "type": "string",
@@ -12669,6 +12670,7 @@
12669
12670
  "x-displayname": "Namespace",
12670
12671
  "x-ves-example": "System",
12671
12672
  "x-f5xc-example": "system",
12673
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
12672
12674
  "minLength": 0,
12673
12675
  "maxLength": 6,
12674
12676
  "x-f5xc-required-for": {
@@ -12679,7 +12681,7 @@
12679
12681
  },
12680
12682
  "x-original-maxLength": 1024,
12681
12683
  "x-reconciled-from-discovery": true,
12682
- "x-reconciled-at": "2026-01-05T18:28:53.452203+00:00"
12684
+ "x-reconciled-at": "2026-01-07T15:28:05.308551+00:00"
12683
12685
  },
12684
12686
  "site": {
12685
12687
  "type": "string",
@@ -12688,6 +12690,7 @@
12688
12690
  "x-displayname": "Site Name",
12689
12691
  "x-ves-example": "Value",
12690
12692
  "x-f5xc-example": "value",
12693
+ "x-f5xc-description-short": "Name of the site for which request is sent.",
12691
12694
  "minLength": 0,
12692
12695
  "maxLength": 1024,
12693
12696
  "x-f5xc-required-for": {
@@ -12702,6 +12705,7 @@
12702
12705
  "description": "Exclusive with [name]\nUID of the CRL object.",
12703
12706
  "title": "CRL UID",
12704
12707
  "x-displayname": "CRL UID",
12708
+ "x-f5xc-description-short": "Exclusive with [name] UID of the CRL object.",
12705
12709
  "minLength": 0,
12706
12710
  "maxLength": 36,
12707
12711
  "x-f5xc-required-for": {
@@ -12714,9 +12718,10 @@
12714
12718
  "x-original-maxLength": 1024,
12715
12719
  "format": "uuid",
12716
12720
  "x-reconciled-from-discovery": true,
12717
- "x-reconciled-at": "2026-01-05T18:28:53.452212+00:00"
12721
+ "x-reconciled-at": "2026-01-07T15:28:05.308560+00:00"
12718
12722
  }
12719
12723
  },
12724
+ "x-f5xc-description-short": "Request to trigger resync of CRL in VER.",
12720
12725
  "x-f5xc-minimum-configuration": {
12721
12726
  "description": "Minimum configuration for crlResyncCRLRequest",
12722
12727
  "required_fields": [
@@ -12745,6 +12750,7 @@
12745
12750
  "description": "Status of the CRL request.",
12746
12751
  "title": "Status",
12747
12752
  "x-displayname": "Status",
12753
+ "x-f5xc-example": "active",
12748
12754
  "minLength": 0,
12749
12755
  "maxLength": 17,
12750
12756
  "x-f5xc-required-for": {
@@ -12755,7 +12761,7 @@
12755
12761
  },
12756
12762
  "x-original-maxLength": 1024,
12757
12763
  "x-reconciled-from-discovery": true,
12758
- "x-reconciled-at": "2026-01-05T18:28:53.452219+00:00"
12764
+ "x-reconciled-at": "2026-01-07T15:28:05.308566+00:00"
12759
12765
  }
12760
12766
  },
12761
12767
  "x-f5xc-minimum-configuration": {
@@ -12785,6 +12791,8 @@
12785
12791
  "x-displayname": "Attachment data.",
12786
12792
  "x-ves-example": "DGVzdCBhdHRhY2htZW50.",
12787
12793
  "x-f5xc-example": "dGVzdCBhdHRhY2htZW50",
12794
+ "x-f5xc-description-short": "Any binary attachment (such as screenshots, plain text files, PDFs) encoded as base64 if used over HTTP.",
12795
+ "x-f5xc-description-medium": "Any binary attachment (such as screenshots, plain text files, PDFs) encoded as base64 if used over HTTP.",
12788
12796
  "minLength": 0,
12789
12797
  "maxLength": 1024,
12790
12798
  "x-f5xc-required-for": {
@@ -12801,6 +12809,7 @@
12801
12809
  "x-displayname": "Content type.",
12802
12810
  "x-ves-example": "Application/pdf.",
12803
12811
  "x-f5xc-example": "application/pdf",
12812
+ "x-f5xc-description-short": "Mime content type of the attachment. Helps the UI to properly display the data.",
12804
12813
  "minLength": 0,
12805
12814
  "maxLength": 1024,
12806
12815
  "x-f5xc-required-for": {
@@ -12817,6 +12826,7 @@
12817
12826
  "x-displayname": "Filename",
12818
12827
  "x-ves-example": "attachment.pdf.",
12819
12828
  "x-f5xc-example": "attachment.pdf",
12829
+ "x-f5xc-description-short": "Filename of the attachment as provided by the caller.",
12820
12830
  "minLength": 0,
12821
12831
  "maxLength": 1024,
12822
12832
  "x-f5xc-required-for": {
@@ -12833,6 +12843,7 @@
12833
12843
  "x-displayname": "3rd party ID.",
12834
12844
  "x-ves-example": "1234",
12835
12845
  "x-f5xc-example": "1234",
12846
+ "x-f5xc-description-short": "Optional ID as assigned by the 3rd party actually storing the data.",
12836
12847
  "minLength": 0,
12837
12848
  "maxLength": 1024,
12838
12849
  "x-f5xc-required-for": {
@@ -12844,6 +12855,8 @@
12844
12855
  "x-field-mutability": "read-only"
12845
12856
  }
12846
12857
  },
12858
+ "x-f5xc-description-short": "Attachment represents a single support ticket comment attachment.",
12859
+ "x-f5xc-description-medium": "Attachment represents a single support ticket comment attachment. Attachment are normally not store with the ticket itself, they represent a handle in the third party, so the contact can be retrieved omn demand.",
12847
12860
  "x-f5xc-minimum-configuration": {
12848
12861
  "description": "Minimum configuration for customer_supportAttachmentType",
12849
12862
  "required_fields": [
@@ -12873,6 +12886,7 @@
12873
12886
  "x-displayname": "Name",
12874
12887
  "x-ves-example": "Value",
12875
12888
  "x-f5xc-example": "value",
12889
+ "x-f5xc-description-short": "The name of the customer support ticket object to be closed.",
12876
12890
  "minLength": 0,
12877
12891
  "maxLength": 16,
12878
12892
  "x-f5xc-required-for": {
@@ -12883,7 +12897,7 @@
12883
12897
  },
12884
12898
  "x-original-maxLength": 1024,
12885
12899
  "x-reconciled-from-discovery": true,
12886
- "x-reconciled-at": "2026-01-05T18:29:10.542441+00:00"
12900
+ "x-reconciled-at": "2026-01-07T15:28:26.688842+00:00"
12887
12901
  },
12888
12902
  "namespace": {
12889
12903
  "type": "string",
@@ -12892,6 +12906,7 @@
12892
12906
  "x-displayname": "Namespace",
12893
12907
  "x-ves-example": "Value",
12894
12908
  "x-f5xc-example": "value",
12909
+ "x-f5xc-description-short": "The namespace in which the support ticket object is present.",
12895
12910
  "minLength": 0,
12896
12911
  "maxLength": 6,
12897
12912
  "x-f5xc-required-for": {
@@ -12902,9 +12917,10 @@
12902
12917
  },
12903
12918
  "x-original-maxLength": 1024,
12904
12919
  "x-reconciled-from-discovery": true,
12905
- "x-reconciled-at": "2026-01-05T18:29:10.542447+00:00"
12920
+ "x-reconciled-at": "2026-01-07T15:28:26.688849+00:00"
12906
12921
  }
12907
12922
  },
12923
+ "x-f5xc-description-short": "Closes an open existing customer support ticket.",
12908
12924
  "x-f5xc-minimum-configuration": {
12909
12925
  "description": "Minimum configuration for customer_supportCloseRequest",
12910
12926
  "required_fields": [
@@ -12929,6 +12945,7 @@
12929
12945
  "$ref": "#/components/schemas/schemacustomer_supportErrorCode"
12930
12946
  }
12931
12947
  },
12948
+ "x-f5xc-description-short": "Gives details of result of closing a customer support ticket.",
12932
12949
  "x-f5xc-minimum-configuration": {
12933
12950
  "description": "Minimum configuration for customer_supportCloseResponse",
12934
12951
  "required_fields": [
@@ -12956,6 +12973,7 @@
12956
12973
  "$ref": "#/components/schemas/customer_supportAttachmentType"
12957
12974
  },
12958
12975
  "x-displayname": "Attachments.",
12976
+ "x-f5xc-description-short": "Any binary attachments (such as screenshots, plain text files) encoded as base64 if used over HTTP.",
12959
12977
  "x-f5xc-required-for": {
12960
12978
  "minimum_config": false,
12961
12979
  "create": false,
@@ -12970,6 +12988,7 @@
12970
12988
  "x-displayname": "Name",
12971
12989
  "x-ves-example": "Value",
12972
12990
  "x-f5xc-example": "value",
12991
+ "x-f5xc-description-short": "The name of the customer support ticket object to be updated.",
12973
12992
  "minLength": 0,
12974
12993
  "maxLength": 1024,
12975
12994
  "x-f5xc-required-for": {
@@ -12986,6 +13005,7 @@
12986
13005
  "x-displayname": "Name",
12987
13006
  "x-ves-example": "Value",
12988
13007
  "x-f5xc-example": "value",
13008
+ "x-f5xc-description-short": "The name of the customer support ticket object to be updated.",
12989
13009
  "minLength": 0,
12990
13010
  "maxLength": 16,
12991
13011
  "x-f5xc-required-for": {
@@ -12996,7 +13016,7 @@
12996
13016
  },
12997
13017
  "x-original-maxLength": 1024,
12998
13018
  "x-reconciled-from-discovery": true,
12999
- "x-reconciled-at": "2026-01-05T18:29:10.542458+00:00"
13019
+ "x-reconciled-at": "2026-01-07T15:28:26.688860+00:00"
13000
13020
  },
13001
13021
  "namespace": {
13002
13022
  "type": "string",
@@ -13005,6 +13025,7 @@
13005
13025
  "x-displayname": "Namespace",
13006
13026
  "x-ves-example": "Value",
13007
13027
  "x-f5xc-example": "value",
13028
+ "x-f5xc-description-short": "The namespace in which the support ticket object is present.",
13008
13029
  "minLength": 0,
13009
13030
  "maxLength": 6,
13010
13031
  "x-f5xc-required-for": {
@@ -13015,9 +13036,10 @@
13015
13036
  },
13016
13037
  "x-original-maxLength": 1024,
13017
13038
  "x-reconciled-from-discovery": true,
13018
- "x-reconciled-at": "2026-01-05T18:29:10.542463+00:00"
13039
+ "x-reconciled-at": "2026-01-07T15:28:26.688864+00:00"
13019
13040
  }
13020
13041
  },
13042
+ "x-f5xc-description-short": "Adds a new comment to an existing customer support ticket.",
13021
13043
  "x-f5xc-minimum-configuration": {
13022
13044
  "description": "Minimum configuration for customer_supportCommentRequest",
13023
13045
  "required_fields": [
@@ -13044,6 +13066,7 @@
13044
13066
  "$ref": "#/components/schemas/schemacustomer_supportErrorCode"
13045
13067
  }
13046
13068
  },
13069
+ "x-f5xc-description-short": "Gives details of result of adding a customer support ticket.",
13047
13070
  "x-f5xc-minimum-configuration": {
13048
13071
  "description": "Minimum configuration for customer_supportCommentResponse",
13049
13072
  "required_fields": [
@@ -13073,6 +13096,7 @@
13073
13096
  "x-displayname": "Attachment IDs.",
13074
13097
  "x-ves-example": "12345",
13075
13098
  "x-f5xc-example": "12345",
13099
+ "x-f5xc-description-short": "Third party ID of any attachment related to this ticket comment.",
13076
13100
  "x-f5xc-required-for": {
13077
13101
  "minimum_config": false,
13078
13102
  "create": false,
@@ -13089,6 +13113,7 @@
13089
13113
  "$ref": "#/components/schemas/customer_supportAttachmentType"
13090
13114
  },
13091
13115
  "x-displayname": "Attachments details.",
13116
+ "x-f5xc-description-short": "Information about any attachments (such as screenshots, plain text files) the comment can have.",
13092
13117
  "x-f5xc-required-for": {
13093
13118
  "minimum_config": false,
13094
13119
  "create": false,
@@ -13179,6 +13204,8 @@
13179
13204
  }
13180
13205
  }
13181
13206
  },
13207
+ "x-f5xc-description-short": "Comment represents a single comment on an issue. It contains information like name of the person commenting, timestamp and the comment itself.",
13208
+ "x-f5xc-description-medium": "Comment represents a single comment on an issue. It contains information like name of the person commenting, timestamp and the comment itself. Customers usually download all comments on an issue which resembles a conversation on an issue.",
13182
13209
  "x-f5xc-minimum-configuration": {
13183
13210
  "description": "Minimum configuration for customer_supportCommentType",
13184
13211
  "required_fields": [
@@ -13266,6 +13293,7 @@
13266
13293
  "x-displayname": "Name",
13267
13294
  "x-ves-example": "Value",
13268
13295
  "x-f5xc-example": "value",
13296
+ "x-f5xc-description-short": "The name of the customer support ticket object to be escalated.",
13269
13297
  "minLength": 0,
13270
13298
  "maxLength": 16,
13271
13299
  "x-f5xc-required-for": {
@@ -13276,7 +13304,7 @@
13276
13304
  },
13277
13305
  "x-original-maxLength": 1024,
13278
13306
  "x-reconciled-from-discovery": true,
13279
- "x-reconciled-at": "2026-01-05T18:29:10.542486+00:00"
13307
+ "x-reconciled-at": "2026-01-07T15:28:26.688888+00:00"
13280
13308
  },
13281
13309
  "namespace": {
13282
13310
  "type": "string",
@@ -13285,6 +13313,7 @@
13285
13313
  "x-displayname": "Namespace",
13286
13314
  "x-ves-example": "Value",
13287
13315
  "x-f5xc-example": "value",
13316
+ "x-f5xc-description-short": "The namespace in which the support ticket object is present in.",
13288
13317
  "minLength": 0,
13289
13318
  "maxLength": 6,
13290
13319
  "x-f5xc-required-for": {
@@ -13295,9 +13324,10 @@
13295
13324
  },
13296
13325
  "x-original-maxLength": 1024,
13297
13326
  "x-reconciled-from-discovery": true,
13298
- "x-reconciled-at": "2026-01-05T18:29:10.542490+00:00"
13327
+ "x-reconciled-at": "2026-01-07T15:28:26.688892+00:00"
13299
13328
  }
13300
13329
  },
13330
+ "x-f5xc-description-short": "Changes priority of an existing customer support ticket.",
13301
13331
  "x-f5xc-minimum-configuration": {
13302
13332
  "description": "Minimum configuration for customer_supportEscalationRequest",
13303
13333
  "required_fields": [
@@ -13322,6 +13352,7 @@
13322
13352
  "$ref": "#/components/schemas/schemacustomer_supportErrorCode"
13323
13353
  }
13324
13354
  },
13355
+ "x-f5xc-description-short": "Any error that may occurred during escalating of a ticket.",
13325
13356
  "x-f5xc-minimum-configuration": {
13326
13357
  "description": "Minimum configuration for customer_supportEscalationResponse",
13327
13358
  "required_fields": [
@@ -13352,6 +13383,7 @@
13352
13383
  "$ref": "#/components/schemas/schemaObjectRefType"
13353
13384
  },
13354
13385
  "x-displayname": "Deleted Referred Objects.",
13386
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13355
13387
  "x-f5xc-required-for": {
13356
13388
  "minimum_config": false,
13357
13389
  "create": false,
@@ -13367,6 +13399,7 @@
13367
13399
  "$ref": "#/components/schemas/schemaObjectRefType"
13368
13400
  },
13369
13401
  "x-displayname": "Disabled Referred Objects.",
13402
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13370
13403
  "x-f5xc-required-for": {
13371
13404
  "minimum_config": false,
13372
13405
  "create": false,
@@ -13385,6 +13418,7 @@
13385
13418
  "$ref": "#/components/schemas/schemaObjectRefType"
13386
13419
  },
13387
13420
  "x-displayname": "Referring Objects.",
13421
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
13388
13422
  "x-f5xc-required-for": {
13389
13423
  "minimum_config": false,
13390
13424
  "create": false,
@@ -13403,6 +13437,8 @@
13403
13437
  "$ref": "#/components/schemas/customer_supportStatusObject"
13404
13438
  },
13405
13439
  "x-displayname": "Status",
13440
+ "x-f5xc-example": "active",
13441
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
13406
13442
  "x-f5xc-required-for": {
13407
13443
  "minimum_config": false,
13408
13444
  "create": false,
@@ -13412,7 +13448,7 @@
13412
13448
  "maxLength": 17,
13413
13449
  "minLength": 17,
13414
13450
  "x-reconciled-from-discovery": true,
13415
- "x-reconciled-at": "2026-01-05T18:29:10.542505+00:00"
13451
+ "x-reconciled-at": "2026-01-07T15:28:26.688907+00:00"
13416
13452
  },
13417
13453
  "system_metadata": {
13418
13454
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -13450,6 +13486,8 @@
13450
13486
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
13451
13487
  ],
13452
13488
  "default": "GET_RSP_FORMAT_DEFAULT",
13489
+ "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...",
13490
+ "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...",
13453
13491
  "x-f5xc-minimum-configuration": {
13454
13492
  "description": "Minimum configuration for customer_supportGetResponseFormatCode",
13455
13493
  "required_fields": [],
@@ -13475,6 +13513,7 @@
13475
13513
  "$ref": "#/components/schemas/schemaErrorType"
13476
13514
  },
13477
13515
  "x-displayname": "Errors",
13516
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
13478
13517
  "x-f5xc-required-for": {
13479
13518
  "minimum_config": false,
13480
13519
  "create": false,
@@ -13490,6 +13529,8 @@
13490
13529
  "$ref": "#/components/schemas/customer_supportListResponseItem"
13491
13530
  },
13492
13531
  "x-displayname": "Items",
13532
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
13533
+ "x-f5xc-description-short": "Items represents the collection in response.",
13493
13534
  "x-f5xc-required-for": {
13494
13535
  "minimum_config": false,
13495
13536
  "create": false,
@@ -13523,6 +13564,8 @@
13523
13564
  "description": "The set of annotations present on this customer_support.",
13524
13565
  "title": "Annotations.",
13525
13566
  "x-displayname": "Annotations.",
13567
+ "x-f5xc-example": "{\"key\": \"value\"}",
13568
+ "x-f5xc-description-short": "The set of annotations present on this customer_support.",
13526
13569
  "x-f5xc-required-for": {
13527
13570
  "minimum_config": false,
13528
13571
  "create": false,
@@ -13535,6 +13578,7 @@
13535
13578
  "description": "The description set for this customer_support.",
13536
13579
  "title": "Description.",
13537
13580
  "x-displayname": "Description.",
13581
+ "x-f5xc-description-short": "The description set for this customer_support.",
13538
13582
  "minLength": 0,
13539
13583
  "maxLength": 0,
13540
13584
  "x-f5xc-required-for": {
@@ -13545,7 +13589,7 @@
13545
13589
  },
13546
13590
  "x-original-maxLength": 1024,
13547
13591
  "x-reconciled-from-discovery": true,
13548
- "x-reconciled-at": "2026-01-05T18:29:10.542518+00:00"
13592
+ "x-reconciled-at": "2026-01-07T15:28:26.688919+00:00"
13549
13593
  },
13550
13594
  "disabled": {
13551
13595
  "type": "boolean",
@@ -13553,6 +13597,8 @@
13553
13597
  "title": "Disabled",
13554
13598
  "format": "boolean",
13555
13599
  "x-displayname": "Disabled",
13600
+ "x-f5xc-example": "True",
13601
+ "x-f5xc-description-short": "Value of true indicates customer_support is administratively disabled.",
13556
13602
  "x-f5xc-required-for": {
13557
13603
  "minimum_config": false,
13558
13604
  "create": false,
@@ -13568,6 +13614,8 @@
13568
13614
  "description": "The set of labels present on this customer_support.",
13569
13615
  "title": "Labels",
13570
13616
  "x-displayname": "Labels",
13617
+ "x-f5xc-example": "{\"key\": \"value\"}",
13618
+ "x-f5xc-description-short": "The set of labels present on this customer_support.",
13571
13619
  "x-f5xc-required-for": {
13572
13620
  "minimum_config": false,
13573
13621
  "create": false,
@@ -13595,7 +13643,7 @@
13595
13643
  },
13596
13644
  "x-original-maxLength": 1024,
13597
13645
  "x-reconciled-from-discovery": true,
13598
- "x-reconciled-at": "2026-01-05T18:29:10.542529+00:00"
13646
+ "x-reconciled-at": "2026-01-07T15:28:26.688929+00:00"
13599
13647
  },
13600
13648
  "namespace": {
13601
13649
  "type": "string",
@@ -13614,7 +13662,7 @@
13614
13662
  },
13615
13663
  "x-original-maxLength": 1024,
13616
13664
  "x-reconciled-from-discovery": true,
13617
- "x-reconciled-at": "2026-01-05T18:29:10.542533+00:00"
13665
+ "x-reconciled-at": "2026-01-07T15:28:26.688934+00:00"
13618
13666
  },
13619
13667
  "owner_view": {
13620
13668
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -13627,6 +13675,7 @@
13627
13675
  "$ref": "#/components/schemas/customer_supportStatusObject"
13628
13676
  },
13629
13677
  "x-displayname": "Status",
13678
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
13630
13679
  "x-f5xc-required-for": {
13631
13680
  "minimum_config": false,
13632
13681
  "create": false,
@@ -13655,7 +13704,7 @@
13655
13704
  "x-field-mutability": "read-only",
13656
13705
  "x-original-maxLength": 1024,
13657
13706
  "x-reconciled-from-discovery": true,
13658
- "x-reconciled-at": "2026-01-05T18:29:10.542541+00:00"
13707
+ "x-reconciled-at": "2026-01-07T15:28:26.688941+00:00"
13659
13708
  },
13660
13709
  "uid": {
13661
13710
  "type": "string",
@@ -13664,6 +13713,7 @@
13664
13713
  "x-displayname": "UID",
13665
13714
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
13666
13715
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
13716
+ "x-f5xc-description-short": "The unique uid of this customer_support.",
13667
13717
  "minLength": 0,
13668
13718
  "maxLength": 36,
13669
13719
  "x-f5xc-required-for": {
@@ -13676,9 +13726,11 @@
13676
13726
  "x-original-maxLength": 1024,
13677
13727
  "format": "uuid",
13678
13728
  "x-reconciled-from-discovery": true,
13679
- "x-reconciled-at": "2026-01-05T18:29:10.542547+00:00"
13729
+ "x-reconciled-at": "2026-01-07T15:28:26.688948+00:00"
13680
13730
  }
13681
13731
  },
13732
+ "x-f5xc-description-short": "By default a summary of customer_support is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
13733
+ "x-f5xc-description-medium": "By default a summary of customer_support is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
13682
13734
  "x-f5xc-minimum-configuration": {
13683
13735
  "description": "Minimum configuration for customer_supportListResponseItem",
13684
13736
  "required_fields": [
@@ -13734,6 +13786,8 @@
13734
13786
  "ves.io.schema.rules.repeated.min_items": "1",
13735
13787
  "ves.io.schema.rules.repeated.unique": "true"
13736
13788
  },
13789
+ "x-f5xc-example": "10",
13790
+ "x-f5xc-description-short": "List of priorities for filtering the customer support ticket list. Required: YES.",
13737
13791
  "x-f5xc-required-for": {
13738
13792
  "minimum_config": false,
13739
13793
  "create": false,
@@ -13765,6 +13819,8 @@
13765
13819
  "ves.io.schema.rules.repeated.min_items": "1",
13766
13820
  "ves.io.schema.rules.repeated.unique": "true"
13767
13821
  },
13822
+ "x-f5xc-example": "active",
13823
+ "x-f5xc-description-short": "List of status for filtering the customer support ticket list. Required: YES.",
13768
13824
  "x-f5xc-required-for": {
13769
13825
  "minimum_config": false,
13770
13826
  "create": false,
@@ -13774,9 +13830,11 @@
13774
13830
  "maxLength": 17,
13775
13831
  "minLength": 17,
13776
13832
  "x-reconciled-from-discovery": true,
13777
- "x-reconciled-at": "2026-01-05T18:29:10.542556+00:00"
13833
+ "x-reconciled-at": "2026-01-07T15:28:26.688955+00:00"
13778
13834
  }
13779
13835
  },
13836
+ "x-f5xc-description-short": "Input message of the 'ListCTSupportTickets' RPC. Fields can be used to control scope and filtering of collection.",
13837
+ "x-f5xc-description-medium": "Input message of the 'ListCTSupportTickets' RPC. Fields can be used to control scope and filtering of collection.",
13780
13838
  "x-f5xc-minimum-configuration": {
13781
13839
  "description": "Minimum configuration for customer_supportListSupportRequest",
13782
13840
  "required_fields": [
@@ -13805,6 +13863,7 @@
13805
13863
  "$ref": "#/components/schemas/schemaErrorType"
13806
13864
  },
13807
13865
  "x-displayname": "Errors",
13866
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
13808
13867
  "x-f5xc-required-for": {
13809
13868
  "minimum_config": false,
13810
13869
  "create": false,
@@ -13820,6 +13879,8 @@
13820
13879
  "$ref": "#/components/schemas/customer_supportListResponseItem"
13821
13880
  },
13822
13881
  "x-displayname": "Items",
13882
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
13883
+ "x-f5xc-description-short": "Items represents the collection in response.",
13823
13884
  "x-f5xc-required-for": {
13824
13885
  "minimum_config": false,
13825
13886
  "create": false,
@@ -13828,6 +13889,7 @@
13828
13889
  }
13829
13890
  }
13830
13891
  },
13892
+ "x-f5xc-description-short": "Output message of 'ListCTSupportTickets' RPC.",
13831
13893
  "x-f5xc-minimum-configuration": {
13832
13894
  "description": "Minimum configuration for customer_supportListSupportResponse",
13833
13895
  "required_fields": [
@@ -13855,6 +13917,7 @@
13855
13917
  "x-displayname": "Name",
13856
13918
  "x-ves-example": "Value",
13857
13919
  "x-f5xc-example": "value",
13920
+ "x-f5xc-description-short": "The name of the customer support ticket object to have its priority changed.",
13858
13921
  "minLength": 0,
13859
13922
  "maxLength": 16,
13860
13923
  "x-f5xc-required-for": {
@@ -13865,7 +13928,7 @@
13865
13928
  },
13866
13929
  "x-original-maxLength": 1024,
13867
13930
  "x-reconciled-from-discovery": true,
13868
- "x-reconciled-at": "2026-01-05T18:29:10.542564+00:00"
13931
+ "x-reconciled-at": "2026-01-07T15:28:26.688963+00:00"
13869
13932
  },
13870
13933
  "namespace": {
13871
13934
  "type": "string",
@@ -13874,6 +13937,7 @@
13874
13937
  "x-displayname": "Namespace",
13875
13938
  "x-ves-example": "Value",
13876
13939
  "x-f5xc-example": "value",
13940
+ "x-f5xc-description-short": "The namespace in which the support ticket object is present.",
13877
13941
  "minLength": 0,
13878
13942
  "maxLength": 6,
13879
13943
  "x-f5xc-required-for": {
@@ -13884,12 +13948,13 @@
13884
13948
  },
13885
13949
  "x-original-maxLength": 1024,
13886
13950
  "x-reconciled-from-discovery": true,
13887
- "x-reconciled-at": "2026-01-05T18:29:10.542568+00:00"
13951
+ "x-reconciled-at": "2026-01-07T15:28:26.688968+00:00"
13888
13952
  },
13889
13953
  "priority": {
13890
13954
  "$ref": "#/components/schemas/customer_supportSupportTicketPriority"
13891
13955
  }
13892
13956
  },
13957
+ "x-f5xc-description-short": "Changes priority of an existing customer support ticket.",
13893
13958
  "x-f5xc-minimum-configuration": {
13894
13959
  "description": "Minimum configuration for customer_supportPriorityRequest",
13895
13960
  "required_fields": [
@@ -13915,6 +13980,7 @@
13915
13980
  "$ref": "#/components/schemas/schemacustomer_supportErrorCode"
13916
13981
  }
13917
13982
  },
13983
+ "x-f5xc-description-short": "Gives details of result of changing priority a customer support ticket.",
13918
13984
  "x-f5xc-minimum-configuration": {
13919
13985
  "description": "Minimum configuration for customer_supportPriorityResponse",
13920
13986
  "required_fields": [
@@ -13942,6 +14008,8 @@
13942
14008
  "$ref": "#/components/schemas/customer_supportAttachmentType"
13943
14009
  },
13944
14010
  "x-displayname": "Attachments details.",
14011
+ "x-f5xc-description-short": "Information about any attachments (such as screenshots, plain text files) to support the tax exemption review request.",
14012
+ "x-f5xc-description-medium": "Information about any attachments (such as screenshots, plain text files) to support the tax exemption review request.",
13945
14013
  "x-f5xc-required-for": {
13946
14014
  "minimum_config": false,
13947
14015
  "create": false,
@@ -13956,6 +14024,7 @@
13956
14024
  "x-displayname": "Description.",
13957
14025
  "x-ves-example": "Requesting a tax exemption status review as we'RE a not-for-profit organisation.",
13958
14026
  "x-f5xc-example": "requesting a tax exemption status review as we're a not-for-profit organisation",
14027
+ "x-f5xc-description-short": "Description introducing reasons for tax exemption status verification.",
13959
14028
  "minLength": 0,
13960
14029
  "maxLength": 1024,
13961
14030
  "x-f5xc-required-for": {
@@ -13966,6 +14035,8 @@
13966
14035
  }
13967
14036
  }
13968
14037
  },
14038
+ "x-f5xc-description-short": "Provides ability to request tax status of the customer, eventually flagging them as tax exempt (U.S.",
14039
+ "x-f5xc-description-medium": "Provides ability to request tax status of the customer, eventually flagging them as tax exempt (U.S. Only).",
13969
14040
  "x-f5xc-minimum-configuration": {
13970
14041
  "description": "Minimum configuration for customer_supportRaiseTaxExemptVerificationSupportTicketRequest",
13971
14042
  "required_fields": [
@@ -13994,6 +14065,7 @@
13994
14065
  "description": "X-displayName : \"Name\"\nname of the ticket created on the back of the request.",
13995
14066
  "title": "Name of ticket.",
13996
14067
  "x-f5xc-example": "example-resource",
14068
+ "x-f5xc-description-short": "X-displayName : \"Name\" name of the ticket created on the back of the request.",
13997
14069
  "minLength": 0,
13998
14070
  "maxLength": 16,
13999
14071
  "x-f5xc-required-for": {
@@ -14004,9 +14076,11 @@
14004
14076
  },
14005
14077
  "x-original-maxLength": 1024,
14006
14078
  "x-reconciled-from-discovery": true,
14007
- "x-reconciled-at": "2026-01-05T18:29:10.542581+00:00"
14079
+ "x-reconciled-at": "2026-01-07T15:28:26.688980+00:00"
14008
14080
  }
14009
14081
  },
14082
+ "x-f5xc-description-short": "Any error that may occurred during tax status verification request.",
14083
+ "x-f5xc-description-medium": "Any error that may occurred during tax status verification request. Note that the verification process itself takes a lot of time (days) - this message only indicates the reception of the request.",
14010
14084
  "x-f5xc-minimum-configuration": {
14011
14085
  "description": "Minimum configuration for customer_supportRaiseTaxExemptVerificationSupportTicketResponse",
14012
14086
  "required_fields": [
@@ -14034,6 +14108,7 @@
14034
14108
  "x-displayname": "Name",
14035
14109
  "x-ves-example": "Value",
14036
14110
  "x-f5xc-example": "value",
14111
+ "x-f5xc-description-short": "The name of the customer support ticket object to be open again.",
14037
14112
  "minLength": 0,
14038
14113
  "maxLength": 16,
14039
14114
  "x-f5xc-required-for": {
@@ -14044,7 +14119,7 @@
14044
14119
  },
14045
14120
  "x-original-maxLength": 1024,
14046
14121
  "x-reconciled-from-discovery": true,
14047
- "x-reconciled-at": "2026-01-05T18:29:10.542586+00:00"
14122
+ "x-reconciled-at": "2026-01-07T15:28:26.688984+00:00"
14048
14123
  },
14049
14124
  "namespace": {
14050
14125
  "type": "string",
@@ -14053,6 +14128,7 @@
14053
14128
  "x-displayname": "Namespace",
14054
14129
  "x-ves-example": "Value",
14055
14130
  "x-f5xc-example": "value",
14131
+ "x-f5xc-description-short": "The namespace in which the support ticket object is present.",
14056
14132
  "minLength": 0,
14057
14133
  "maxLength": 6,
14058
14134
  "x-f5xc-required-for": {
@@ -14063,9 +14139,10 @@
14063
14139
  },
14064
14140
  "x-original-maxLength": 1024,
14065
14141
  "x-reconciled-from-discovery": true,
14066
- "x-reconciled-at": "2026-01-05T18:29:10.542590+00:00"
14142
+ "x-reconciled-at": "2026-01-07T15:28:26.688989+00:00"
14067
14143
  }
14068
14144
  },
14145
+ "x-f5xc-description-short": "Reopens a closed existing customer support ticket.",
14069
14146
  "x-f5xc-minimum-configuration": {
14070
14147
  "description": "Minimum configuration for customer_supportReopenRequest",
14071
14148
  "required_fields": [
@@ -14090,6 +14167,7 @@
14090
14167
  "$ref": "#/components/schemas/schemacustomer_supportErrorCode"
14091
14168
  }
14092
14169
  },
14170
+ "x-f5xc-description-short": "Gives details of result of reopening a customer support ticket.",
14093
14171
  "x-f5xc-minimum-configuration": {
14094
14172
  "description": "Minimum configuration for customer_supportReopenResponse",
14095
14173
  "required_fields": [
@@ -14143,6 +14221,7 @@
14143
14221
  }
14144
14222
  }
14145
14223
  },
14224
+ "x-f5xc-description-short": "Most recently observed status of object.",
14146
14225
  "x-f5xc-minimum-configuration": {
14147
14226
  "description": "Minimum configuration for customer_supportStatusObject",
14148
14227
  "required_fields": [
@@ -14194,6 +14273,8 @@
14194
14273
  "default": "SS_UNKNOWN",
14195
14274
  "x-displayname": "Support Service.",
14196
14275
  "x-ves-proto-enum": "ves.io.schema.customer_support.SupportService",
14276
+ "x-f5xc-description-short": "Indicates the list of support service Unknown Support Service Account Protection Support Service Administration Support Service Application...",
14277
+ "x-f5xc-description-medium": "Indicates the list of support service Unknown Support Service Account Protection Support Service Administration Support Service Application Traffic Insight Support Service Audit Logs & Alerts Support Service Authentication Intelligence Support Service Billing Support Service Client Side Defense...",
14197
14278
  "x-f5xc-minimum-configuration": {
14198
14279
  "description": "Minimum configuration for customer_supportSupportService",
14199
14280
  "required_fields": [],
@@ -14217,6 +14298,8 @@
14217
14298
  "default": "PRIORITY_UNKNOWN",
14218
14299
  "x-displayname": "Priority",
14219
14300
  "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketPriority",
14301
+ "x-f5xc-description-short": "Support ticket priority helps understand importance of the ticket and focus more on more critical issues.",
14302
+ "x-f5xc-description-medium": "Support ticket priority helps understand importance of the ticket and focus more on more critical issues. Unknown/empty priority Normal priority issue High priority issue Urgent priority issue.",
14220
14303
  "x-f5xc-minimum-configuration": {
14221
14304
  "description": "Minimum configuration for customer_supportSupportTicketPriority",
14222
14305
  "required_fields": [],
@@ -14244,6 +14327,8 @@
14244
14327
  "default": "STATUS_UNKNOWN",
14245
14328
  "x-displayname": "Support Ticket Status.",
14246
14329
  "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketStatus",
14330
+ "x-f5xc-description-short": "State of the ticket so the customers know if the problem is being looked into Unknown or empty support ticket status Indicates a new ticket...",
14331
+ "x-f5xc-description-medium": "State of the ticket so the customers know if the problem is being looked into Unknown or empty support ticket status Indicates a new ticket, waiting to be assigned to an agent Indicates an open issues, actively being looked into Indicates a pending issue, an open issue not actively being looked...",
14247
14332
  "x-f5xc-minimum-configuration": {
14248
14333
  "description": "Minimum configuration for customer_supportSupportTicketStatus",
14249
14334
  "required_fields": [],
@@ -14271,6 +14356,8 @@
14271
14356
  "default": "TYPE_UNKNOWN",
14272
14357
  "x-displayname": "Support Ticket.",
14273
14358
  "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketType",
14359
+ "x-f5xc-description-short": "Several types of issues are supported, such as problems, questions. Unknown or empty ticket type Indicates a problem (e.g.",
14360
+ "x-f5xc-description-medium": "Several types of issues are supported, such as problems, questions. Unknown or empty ticket type Indicates a problem (e.g. Misconfiguration) Indicates a task (a request to do something) Indicates a question (billing, services related) Indicates an incident (something is not working) Indicates a...",
14274
14361
  "x-f5xc-minimum-configuration": {
14275
14362
  "description": "Minimum configuration for customer_supportSupportTicketType",
14276
14363
  "required_fields": [],
@@ -14315,6 +14402,8 @@
14315
14402
  "default": "TOPIC_UNKNOWN",
14316
14403
  "x-displayname": "Support Topic.",
14317
14404
  "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTopic",
14405
+ "x-f5xc-description-short": "Support Topic indicates the list of topics for service tickets Unknown/empty priority ACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST...",
14406
+ "x-f5xc-description-medium": "Support Topic indicates the list of topics for service tickets Unknown/empty priority ACCOUNT_SUPPORT_TOPIC_ACCESS_REQUEST ACCOUNT_SUPPORT_TOPIC_ACCOUNT ACCOUNT_SUPPORT_TOPIC_BILLING ACCOUNT_SUPPORT_TOPIC_BILLING_PLAN_CHANGE ACCOUNT_SUPPORT_TOPIC_PUBLIC_IP ACCOUNT_SUPPORT_TOPIC_QUOTA_INCREASE...",
14318
14407
  "x-f5xc-minimum-configuration": {
14319
14408
  "description": "Minimum configuration for customer_supportSupportTopic",
14320
14409
  "required_fields": [],
@@ -14343,6 +14432,8 @@
14343
14432
  "default": "EOK",
14344
14433
  "x-displayname": "Error Code.",
14345
14434
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
14435
+ "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...",
14436
+ "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...",
14346
14437
  "x-f5xc-minimum-configuration": {
14347
14438
  "description": "Minimum configuration for ioschemaErrorCode",
14348
14439
  "required_fields": [],
@@ -14360,6 +14451,8 @@
14360
14451
  "type_url": {
14361
14452
  "type": "string",
14362
14453
  "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.",
14454
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
14455
+ "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 ).",
14363
14456
  "minLength": 0,
14364
14457
  "maxLength": 1024,
14365
14458
  "x-f5xc-required-for": {
@@ -14383,9 +14476,11 @@
14383
14476
  },
14384
14477
  "x-original-maxLength": 1024,
14385
14478
  "x-reconciled-from-discovery": true,
14386
- "x-reconciled-at": "2026-01-05T18:29:10.542604+00:00"
14479
+ "x-reconciled-at": "2026-01-07T15:28:26.689002+00:00"
14387
14480
  }
14388
14481
  },
14482
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
14483
+ "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...",
14389
14484
  "x-f5xc-minimum-configuration": {
14390
14485
  "description": "Minimum configuration for protobufAny",
14391
14486
  "required_fields": [
@@ -14411,6 +14506,8 @@
14411
14506
  "description": "Hostname of the instance of the site that sent the status.",
14412
14507
  "title": "Hostname",
14413
14508
  "x-displayname": "Hostname",
14509
+ "x-f5xc-example": "example-resource",
14510
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
14414
14511
  "minLength": 0,
14415
14512
  "maxLength": 1024,
14416
14513
  "x-f5xc-required-for": {
@@ -14442,6 +14539,8 @@
14442
14539
  "x-displayname": "Reason",
14443
14540
  "x-ves-example": "Value",
14444
14541
  "x-f5xc-example": "value",
14542
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
14543
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
14445
14544
  "minLength": 0,
14446
14545
  "maxLength": 43,
14447
14546
  "x-f5xc-required-for": {
@@ -14452,13 +14551,15 @@
14452
14551
  },
14453
14552
  "x-original-maxLength": 1024,
14454
14553
  "x-reconciled-from-discovery": true,
14455
- "x-reconciled-at": "2026-01-05T18:29:10.542611+00:00"
14554
+ "x-reconciled-at": "2026-01-07T15:28:26.689009+00:00"
14456
14555
  },
14457
14556
  "service_name": {
14458
14557
  "type": "string",
14459
14558
  "description": "Name of the service that sent the status.",
14460
14559
  "title": "Service name.",
14461
14560
  "x-displayname": "Service Name.",
14561
+ "x-f5xc-example": "example-resource",
14562
+ "x-f5xc-description-short": "Name of the service that sent the status.",
14462
14563
  "minLength": 0,
14463
14564
  "maxLength": 1024,
14464
14565
  "x-f5xc-required-for": {
@@ -14481,6 +14582,8 @@
14481
14582
  "x-validation-rules": {
14482
14583
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
14483
14584
  },
14585
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
14586
+ "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...",
14484
14587
  "minLength": 0,
14485
14588
  "maxLength": 17,
14486
14589
  "x-f5xc-required-for": {
@@ -14491,7 +14594,7 @@
14491
14594
  },
14492
14595
  "x-original-maxLength": 1024,
14493
14596
  "x-reconciled-from-discovery": true,
14494
- "x-reconciled-at": "2026-01-05T18:29:10.542618+00:00"
14597
+ "x-reconciled-at": "2026-01-07T15:28:26.689015+00:00"
14495
14598
  },
14496
14599
  "type": {
14497
14600
  "type": "string",
@@ -14506,6 +14609,8 @@
14506
14609
  "x-validation-rules": {
14507
14610
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
14508
14611
  },
14612
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
14613
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
14509
14614
  "minLength": 0,
14510
14615
  "maxLength": 1024,
14511
14616
  "x-f5xc-required-for": {
@@ -14516,6 +14621,8 @@
14516
14621
  }
14517
14622
  }
14518
14623
  },
14624
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
14625
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
14519
14626
  "x-f5xc-minimum-configuration": {
14520
14627
  "description": "Minimum configuration for schemaConditionType",
14521
14628
  "required_fields": [
@@ -14563,6 +14670,7 @@
14563
14670
  }
14564
14671
  }
14565
14672
  },
14673
+ "x-f5xc-description-short": "Information about a error in API operation.",
14566
14674
  "x-f5xc-minimum-configuration": {
14567
14675
  "description": "Minimum configuration for schemaErrorType",
14568
14676
  "required_fields": [
@@ -14590,6 +14698,7 @@
14590
14698
  "title": "Name",
14591
14699
  "x-displayname": "Name",
14592
14700
  "x-f5xc-example": "example-resource",
14701
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
14593
14702
  "minLength": 0,
14594
14703
  "maxLength": 16,
14595
14704
  "x-f5xc-required-for": {
@@ -14600,9 +14709,10 @@
14600
14709
  },
14601
14710
  "x-original-maxLength": 1024,
14602
14711
  "x-reconciled-from-discovery": true,
14603
- "x-reconciled-at": "2026-01-05T18:29:10.542628+00:00"
14712
+ "x-reconciled-at": "2026-01-07T15:28:26.689026+00:00"
14604
14713
  }
14605
14714
  },
14715
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
14606
14716
  "x-f5xc-minimum-configuration": {
14607
14717
  "description": "Minimum configuration for schemaInitializerType",
14608
14718
  "required_fields": [
@@ -14630,6 +14740,8 @@
14630
14740
  "$ref": "#/components/schemas/schemaInitializerType"
14631
14741
  },
14632
14742
  "x-displayname": "Pending",
14743
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
14744
+ "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.",
14633
14745
  "x-f5xc-required-for": {
14634
14746
  "minimum_config": false,
14635
14747
  "create": false,
@@ -14641,6 +14753,7 @@
14641
14753
  "$ref": "#/components/schemas/schemaStatusType"
14642
14754
  }
14643
14755
  },
14756
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
14644
14757
  "x-f5xc-minimum-configuration": {
14645
14758
  "description": "Minimum configuration for schemaInitializersType",
14646
14759
  "required_fields": [
@@ -14679,6 +14792,8 @@
14679
14792
  "ves.io.schema.rules.map.values.string.max_len": "1024",
14680
14793
  "ves.io.schema.rules.map.values.string.min_len": "1"
14681
14794
  },
14795
+ "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.",
14796
+ "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.",
14682
14797
  "x-f5xc-required-for": {
14683
14798
  "minimum_config": false,
14684
14799
  "create": false,
@@ -14700,6 +14815,7 @@
14700
14815
  "x-validation-rules": {
14701
14816
  "ves.io.schema.rules.string.max_bytes": "1200"
14702
14817
  },
14818
+ "x-f5xc-description-short": "Human readable description for the object.",
14703
14819
  "minLength": 0,
14704
14820
  "x-f5xc-required-for": {
14705
14821
  "minimum_config": false,
@@ -14709,7 +14825,7 @@
14709
14825
  },
14710
14826
  "x-original-maxLength": 1200,
14711
14827
  "x-reconciled-from-discovery": true,
14712
- "x-reconciled-at": "2026-01-05T18:29:10.542637+00:00"
14828
+ "x-reconciled-at": "2026-01-07T15:28:26.689035+00:00"
14713
14829
  },
14714
14830
  "disable": {
14715
14831
  "type": "boolean",
@@ -14718,6 +14834,7 @@
14718
14834
  "format": "boolean",
14719
14835
  "x-displayname": "Disable",
14720
14836
  "x-f5xc-example": "true",
14837
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
14721
14838
  "x-f5xc-required-for": {
14722
14839
  "minimum_config": false,
14723
14840
  "create": false,
@@ -14731,6 +14848,8 @@
14731
14848
  "title": "Labels",
14732
14849
  "x-displayname": "Labels",
14733
14850
  "x-f5xc-example": "value",
14851
+ "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.",
14852
+ "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.",
14734
14853
  "x-f5xc-required-for": {
14735
14854
  "minimum_config": false,
14736
14855
  "create": false,
@@ -14752,6 +14871,8 @@
14752
14871
  "x-validation-rules": {
14753
14872
  "ves.io.schema.rules.message.required": "true"
14754
14873
  },
14874
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
14875
+ "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.",
14755
14876
  "minLength": 0,
14756
14877
  "maxLength": 16,
14757
14878
  "x-f5xc-required-for": {
@@ -14762,7 +14883,7 @@
14762
14883
  },
14763
14884
  "x-original-maxLength": 1024,
14764
14885
  "x-reconciled-from-discovery": true,
14765
- "x-reconciled-at": "2026-01-05T18:29:10.542645+00:00"
14886
+ "x-reconciled-at": "2026-01-07T15:28:26.689044+00:00"
14766
14887
  },
14767
14888
  "namespace": {
14768
14889
  "type": "string",
@@ -14771,6 +14892,8 @@
14771
14892
  "x-displayname": "Namespace",
14772
14893
  "x-ves-example": "Staging",
14773
14894
  "x-f5xc-example": "staging",
14895
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
14896
+ "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 \"\".",
14774
14897
  "minLength": 0,
14775
14898
  "maxLength": 6,
14776
14899
  "x-f5xc-required-for": {
@@ -14781,9 +14904,10 @@
14781
14904
  },
14782
14905
  "x-original-maxLength": 1024,
14783
14906
  "x-reconciled-from-discovery": true,
14784
- "x-reconciled-at": "2026-01-05T18:29:10.542649+00:00"
14907
+ "x-reconciled-at": "2026-01-07T15:28:26.689048+00:00"
14785
14908
  }
14786
14909
  },
14910
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
14787
14911
  "x-f5xc-minimum-configuration": {
14788
14912
  "description": "Minimum configuration for schemaObjectCreateMetaType",
14789
14913
  "required_fields": [
@@ -14827,6 +14951,8 @@
14827
14951
  "ves.io.schema.rules.map.values.string.max_len": "1024",
14828
14952
  "ves.io.schema.rules.map.values.string.min_len": "1"
14829
14953
  },
14954
+ "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.",
14955
+ "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.",
14830
14956
  "x-f5xc-required-for": {
14831
14957
  "minimum_config": false,
14832
14958
  "create": false,
@@ -14848,6 +14974,7 @@
14848
14974
  "x-validation-rules": {
14849
14975
  "ves.io.schema.rules.string.max_bytes": "1200"
14850
14976
  },
14977
+ "x-f5xc-description-short": "Human readable description for the object.",
14851
14978
  "minLength": 0,
14852
14979
  "x-f5xc-required-for": {
14853
14980
  "minimum_config": false,
@@ -14857,7 +14984,7 @@
14857
14984
  },
14858
14985
  "x-original-maxLength": 1200,
14859
14986
  "x-reconciled-from-discovery": true,
14860
- "x-reconciled-at": "2026-01-05T18:29:10.542655+00:00"
14987
+ "x-reconciled-at": "2026-01-07T15:28:26.689055+00:00"
14861
14988
  },
14862
14989
  "disable": {
14863
14990
  "type": "boolean",
@@ -14867,6 +14994,7 @@
14867
14994
  "x-displayname": "Disable",
14868
14995
  "x-ves-example": "True",
14869
14996
  "x-f5xc-example": "true",
14997
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
14870
14998
  "x-f5xc-required-for": {
14871
14999
  "minimum_config": false,
14872
15000
  "create": false,
@@ -14881,6 +15009,8 @@
14881
15009
  "x-displayname": "Labels",
14882
15010
  "x-ves-example": "Value",
14883
15011
  "x-f5xc-example": "value",
15012
+ "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.",
15013
+ "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.",
14884
15014
  "x-f5xc-required-for": {
14885
15015
  "minimum_config": false,
14886
15016
  "create": false,
@@ -14902,6 +15032,8 @@
14902
15032
  "x-validation-rules": {
14903
15033
  "ves.io.schema.rules.message.required": "true"
14904
15034
  },
15035
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
15036
+ "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.",
14905
15037
  "minLength": 0,
14906
15038
  "maxLength": 16,
14907
15039
  "x-f5xc-required-for": {
@@ -14912,7 +15044,7 @@
14912
15044
  },
14913
15045
  "x-original-maxLength": 1024,
14914
15046
  "x-reconciled-from-discovery": true,
14915
- "x-reconciled-at": "2026-01-05T18:29:10.542663+00:00"
15047
+ "x-reconciled-at": "2026-01-07T15:28:26.689063+00:00"
14916
15048
  },
14917
15049
  "namespace": {
14918
15050
  "type": "string",
@@ -14921,6 +15053,8 @@
14921
15053
  "x-displayname": "Namespace",
14922
15054
  "x-ves-example": "Staging",
14923
15055
  "x-f5xc-example": "staging",
15056
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
15057
+ "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 \"\".",
14924
15058
  "minLength": 0,
14925
15059
  "maxLength": 6,
14926
15060
  "x-f5xc-required-for": {
@@ -14931,9 +15065,10 @@
14931
15065
  },
14932
15066
  "x-original-maxLength": 1024,
14933
15067
  "x-reconciled-from-discovery": true,
14934
- "x-reconciled-at": "2026-01-05T18:29:10.542668+00:00"
15068
+ "x-reconciled-at": "2026-01-07T15:28:26.689067+00:00"
14935
15069
  }
14936
15070
  },
15071
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
14937
15072
  "x-f5xc-minimum-configuration": {
14938
15073
  "description": "Minimum configuration for schemaObjectGetMetaType",
14939
15074
  "required_fields": [
@@ -14965,6 +15100,8 @@
14965
15100
  "x-displayname": "Kind",
14966
15101
  "x-ves-example": "Virtual_site.",
14967
15102
  "x-f5xc-example": "virtual_site",
15103
+ "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\")",
15104
+ "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\").",
14968
15105
  "minLength": 0,
14969
15106
  "maxLength": 14,
14970
15107
  "x-f5xc-required-for": {
@@ -14976,7 +15113,7 @@
14976
15113
  "readOnly": true,
14977
15114
  "x-original-maxLength": 1024,
14978
15115
  "x-reconciled-from-discovery": true,
14979
- "x-reconciled-at": "2026-01-05T18:29:10.542673+00:00"
15116
+ "x-reconciled-at": "2026-01-07T15:28:26.689071+00:00"
14980
15117
  },
14981
15118
  "name": {
14982
15119
  "type": "string",
@@ -14985,6 +15122,8 @@
14985
15122
  "x-displayname": "Name",
14986
15123
  "x-ves-example": "Contactus-route.",
14987
15124
  "x-f5xc-example": "contactus-route",
15125
+ "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.",
15126
+ "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.",
14988
15127
  "minLength": 0,
14989
15128
  "maxLength": 16,
14990
15129
  "x-f5xc-required-for": {
@@ -14995,7 +15134,7 @@
14995
15134
  },
14996
15135
  "x-original-maxLength": 1024,
14997
15136
  "x-reconciled-from-discovery": true,
14998
- "x-reconciled-at": "2026-01-05T18:29:10.542678+00:00"
15137
+ "x-reconciled-at": "2026-01-07T15:28:26.689076+00:00"
14999
15138
  },
15000
15139
  "namespace": {
15001
15140
  "type": "string",
@@ -15004,6 +15143,8 @@
15004
15143
  "x-displayname": "Namespace",
15005
15144
  "x-ves-example": "Ns1",
15006
15145
  "x-f5xc-example": "ns1",
15146
+ "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.",
15147
+ "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.",
15007
15148
  "minLength": 0,
15008
15149
  "maxLength": 6,
15009
15150
  "x-f5xc-required-for": {
@@ -15014,7 +15155,7 @@
15014
15155
  },
15015
15156
  "x-original-maxLength": 1024,
15016
15157
  "x-reconciled-from-discovery": true,
15017
- "x-reconciled-at": "2026-01-05T18:29:10.542682+00:00"
15158
+ "x-reconciled-at": "2026-01-07T15:28:26.689080+00:00"
15018
15159
  },
15019
15160
  "tenant": {
15020
15161
  "type": "string",
@@ -15023,6 +15164,8 @@
15023
15164
  "x-displayname": "Tenant",
15024
15165
  "x-ves-example": "Example-corp.",
15025
15166
  "x-f5xc-example": "example-corp",
15167
+ "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.",
15168
+ "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.",
15026
15169
  "minLength": 0,
15027
15170
  "maxLength": 18,
15028
15171
  "x-f5xc-required-for": {
@@ -15035,7 +15178,7 @@
15035
15178
  "x-field-mutability": "read-only",
15036
15179
  "x-original-maxLength": 1024,
15037
15180
  "x-reconciled-from-discovery": true,
15038
- "x-reconciled-at": "2026-01-05T18:29:10.542686+00:00"
15181
+ "x-reconciled-at": "2026-01-07T15:28:26.689084+00:00"
15039
15182
  },
15040
15183
  "uid": {
15041
15184
  "type": "string",
@@ -15044,6 +15187,8 @@
15044
15187
  "x-displayname": "UID",
15045
15188
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
15046
15189
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
15190
+ "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.",
15191
+ "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.",
15047
15192
  "minLength": 0,
15048
15193
  "maxLength": 36,
15049
15194
  "x-f5xc-required-for": {
@@ -15057,9 +15202,11 @@
15057
15202
  "x-original-maxLength": 1024,
15058
15203
  "format": "uuid",
15059
15204
  "x-reconciled-from-discovery": true,
15060
- "x-reconciled-at": "2026-01-05T18:29:10.542692+00:00"
15205
+ "x-reconciled-at": "2026-01-07T15:28:26.689090+00:00"
15061
15206
  }
15062
15207
  },
15208
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
15209
+ "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...",
15063
15210
  "x-f5xc-minimum-configuration": {
15064
15211
  "description": "Minimum configuration for schemaObjectRefType",
15065
15212
  "required_fields": [
@@ -15089,6 +15236,8 @@
15089
15236
  "title": "Creation_timestamp.",
15090
15237
  "format": "date-time",
15091
15238
  "x-displayname": "Creation Timestamp.",
15239
+ "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.",
15240
+ "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.",
15092
15241
  "minLength": 0,
15093
15242
  "maxLength": 1024,
15094
15243
  "x-f5xc-required-for": {
@@ -15106,6 +15255,8 @@
15106
15255
  "x-displayname": "Creator Class.",
15107
15256
  "x-ves-example": "ver.re1.int.ves.I/O.",
15108
15257
  "x-f5xc-example": "ver.re1.int.F5 XC",
15258
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
15259
+ "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.",
15109
15260
  "minLength": 0,
15110
15261
  "maxLength": 1024,
15111
15262
  "x-f5xc-required-for": {
@@ -15123,6 +15274,8 @@
15123
15274
  "x-displayname": "Creator ID.",
15124
15275
  "x-ves-example": "Ver-instance-1.",
15125
15276
  "x-f5xc-example": "ver-instance-1",
15277
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
15278
+ "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.",
15126
15279
  "minLength": 0,
15127
15280
  "maxLength": 1024,
15128
15281
  "x-f5xc-required-for": {
@@ -15141,6 +15294,8 @@
15141
15294
  "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)",
15142
15295
  "title": "Status_id",
15143
15296
  "x-displayname": "Status ID",
15297
+ "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...",
15298
+ "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).",
15144
15299
  "minLength": 0,
15145
15300
  "maxLength": 1024,
15146
15301
  "x-f5xc-required-for": {
@@ -15158,6 +15313,7 @@
15158
15313
  "x-displayname": "UID",
15159
15314
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
15160
15315
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
15316
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
15161
15317
  "minLength": 0,
15162
15318
  "maxLength": 36,
15163
15319
  "x-f5xc-required-for": {
@@ -15170,13 +15326,14 @@
15170
15326
  "x-original-maxLength": 1024,
15171
15327
  "format": "uuid",
15172
15328
  "x-reconciled-from-discovery": true,
15173
- "x-reconciled-at": "2026-01-05T18:29:10.542705+00:00"
15329
+ "x-reconciled-at": "2026-01-07T15:28:26.689102+00:00"
15174
15330
  },
15175
15331
  "vtrp_id": {
15176
15332
  "type": "string",
15177
15333
  "description": "Origin of this status exchanged by VTRP.",
15178
15334
  "title": "Vtrp_id",
15179
15335
  "x-displayname": "VTRP ID",
15336
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
15180
15337
  "minLength": 0,
15181
15338
  "maxLength": 1024,
15182
15339
  "x-f5xc-required-for": {
@@ -15193,6 +15350,7 @@
15193
15350
  "title": "Vtrp_stale.",
15194
15351
  "format": "boolean",
15195
15352
  "x-displayname": "VTRP Stale.",
15353
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
15196
15354
  "x-f5xc-required-for": {
15197
15355
  "minimum_config": false,
15198
15356
  "create": false,
@@ -15201,6 +15359,7 @@
15201
15359
  }
15202
15360
  }
15203
15361
  },
15362
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
15204
15363
  "x-f5xc-minimum-configuration": {
15205
15364
  "description": "Minimum configuration for schemaStatusMetaType",
15206
15365
  "required_fields": [
@@ -15231,6 +15390,8 @@
15231
15390
  "default": "STATUS_DO_NOT_PUBLISH",
15232
15391
  "x-displayname": "Status Publish Type.",
15233
15392
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
15393
+ "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.",
15394
+ "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.",
15234
15395
  "x-f5xc-minimum-configuration": {
15235
15396
  "description": "Minimum configuration for schemaStatusPublishType",
15236
15397
  "required_fields": [],
@@ -15256,6 +15417,7 @@
15256
15417
  "x-displayname": "Code",
15257
15418
  "x-ves-example": "0",
15258
15419
  "x-f5xc-example": "0",
15420
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
15259
15421
  "minimum": 0,
15260
15422
  "maximum": 2147483647,
15261
15423
  "x-f5xc-required-for": {
@@ -15272,6 +15434,8 @@
15272
15434
  "x-displayname": "Reason",
15273
15435
  "x-ves-example": "Value",
15274
15436
  "x-f5xc-example": "value",
15437
+ "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.",
15438
+ "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.",
15275
15439
  "minLength": 0,
15276
15440
  "maxLength": 43,
15277
15441
  "x-f5xc-required-for": {
@@ -15282,7 +15446,7 @@
15282
15446
  },
15283
15447
  "x-original-maxLength": 1024,
15284
15448
  "x-reconciled-from-discovery": true,
15285
- "x-reconciled-at": "2026-01-05T18:29:10.542715+00:00"
15449
+ "x-reconciled-at": "2026-01-07T15:28:26.689111+00:00"
15286
15450
  },
15287
15451
  "status": {
15288
15452
  "type": "string",
@@ -15291,6 +15455,7 @@
15291
15455
  "x-displayname": "Status",
15292
15456
  "x-ves-example": "Value",
15293
15457
  "x-f5xc-example": "value",
15458
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
15294
15459
  "minLength": 0,
15295
15460
  "maxLength": 17,
15296
15461
  "x-f5xc-required-for": {
@@ -15301,9 +15466,10 @@
15301
15466
  },
15302
15467
  "x-original-maxLength": 1024,
15303
15468
  "x-reconciled-from-discovery": true,
15304
- "x-reconciled-at": "2026-01-05T18:29:10.542719+00:00"
15469
+ "x-reconciled-at": "2026-01-07T15:28:26.689115+00:00"
15305
15470
  }
15306
15471
  },
15472
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
15307
15473
  "x-f5xc-minimum-configuration": {
15308
15474
  "description": "Minimum configuration for schemaStatusType",
15309
15475
  "required_fields": [
@@ -15331,6 +15497,8 @@
15331
15497
  "title": "Creation_timestamp.",
15332
15498
  "format": "date-time",
15333
15499
  "x-displayname": "Creation Timestamp.",
15500
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
15501
+ "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.",
15334
15502
  "minLength": 0,
15335
15503
  "maxLength": 1024,
15336
15504
  "x-f5xc-required-for": {
@@ -15348,6 +15516,7 @@
15348
15516
  "x-displayname": "Creator Class.",
15349
15517
  "x-ves-example": "Prism",
15350
15518
  "x-f5xc-example": "value",
15519
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
15351
15520
  "minLength": 0,
15352
15521
  "maxLength": 1024,
15353
15522
  "x-f5xc-required-for": {
@@ -15365,6 +15534,7 @@
15365
15534
  "x-displayname": "Creator ID.",
15366
15535
  "x-ves-example": "Admin@example-corp.com.",
15367
15536
  "x-f5xc-example": "value",
15537
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
15368
15538
  "minLength": 0,
15369
15539
  "maxLength": 1024,
15370
15540
  "x-f5xc-required-for": {
@@ -15381,6 +15551,8 @@
15381
15551
  "title": "Deletion_timestamp.",
15382
15552
  "format": "date-time",
15383
15553
  "x-displayname": "Deletion Timestamp.",
15554
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
15555
+ "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...",
15384
15556
  "minLength": 0,
15385
15557
  "maxLength": 1024,
15386
15558
  "x-f5xc-required-for": {
@@ -15400,6 +15572,8 @@
15400
15572
  "x-displayname": "Finalizers.",
15401
15573
  "x-ves-example": "Value",
15402
15574
  "x-f5xc-example": "value",
15575
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
15576
+ "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.",
15403
15577
  "x-f5xc-required-for": {
15404
15578
  "minimum_config": false,
15405
15579
  "create": false,
@@ -15417,6 +15591,8 @@
15417
15591
  "x-displayname": "Labels",
15418
15592
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
15419
15593
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
15594
+ "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.",
15595
+ "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).",
15420
15596
  "x-f5xc-required-for": {
15421
15597
  "minimum_config": false,
15422
15598
  "create": false,
@@ -15430,6 +15606,8 @@
15430
15606
  "title": "Modification_timestamp.",
15431
15607
  "format": "date-time",
15432
15608
  "x-displayname": "Modification Timestamp.",
15609
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
15610
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
15433
15611
  "minLength": 0,
15434
15612
  "maxLength": 1024,
15435
15613
  "x-f5xc-required-for": {
@@ -15448,6 +15626,8 @@
15448
15626
  "x-displayname": "Object Index.",
15449
15627
  "x-ves-example": "0",
15450
15628
  "x-f5xc-example": "0",
15629
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
15630
+ "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.",
15451
15631
  "minimum": 0,
15452
15632
  "maximum": 2147483647,
15453
15633
  "x-f5xc-required-for": {
@@ -15468,6 +15648,8 @@
15468
15648
  "x-displayname": "Tenant",
15469
15649
  "x-ves-example": "Example-corp.",
15470
15650
  "x-f5xc-example": "example-corp",
15651
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
15652
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
15471
15653
  "minLength": 0,
15472
15654
  "maxLength": 18,
15473
15655
  "x-f5xc-required-for": {
@@ -15479,7 +15661,7 @@
15479
15661
  "x-field-mutability": "read-only",
15480
15662
  "x-original-maxLength": 1024,
15481
15663
  "x-reconciled-from-discovery": true,
15482
- "x-reconciled-at": "2026-01-05T18:29:10.542738+00:00"
15664
+ "x-reconciled-at": "2026-01-07T15:28:26.689134+00:00"
15483
15665
  },
15484
15666
  "uid": {
15485
15667
  "type": "string",
@@ -15488,6 +15670,8 @@
15488
15670
  "x-displayname": "UID",
15489
15671
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
15490
15672
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
15673
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
15674
+ "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.",
15491
15675
  "minLength": 0,
15492
15676
  "maxLength": 36,
15493
15677
  "x-f5xc-required-for": {
@@ -15500,9 +15684,11 @@
15500
15684
  "x-original-maxLength": 1024,
15501
15685
  "format": "uuid",
15502
15686
  "x-reconciled-from-discovery": true,
15503
- "x-reconciled-at": "2026-01-05T18:29:10.542743+00:00"
15687
+ "x-reconciled-at": "2026-01-07T15:28:26.689139+00:00"
15504
15688
  }
15505
15689
  },
15690
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
15691
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
15506
15692
  "x-f5xc-minimum-configuration": {
15507
15693
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
15508
15694
  "required_fields": [
@@ -15550,7 +15736,7 @@
15550
15736
  },
15551
15737
  "x-original-maxLength": 1024,
15552
15738
  "x-reconciled-from-discovery": true,
15553
- "x-reconciled-at": "2026-01-05T18:29:10.542748+00:00"
15739
+ "x-reconciled-at": "2026-01-07T15:28:26.689144+00:00"
15554
15740
  },
15555
15741
  "name": {
15556
15742
  "type": "string",
@@ -15559,6 +15745,8 @@
15559
15745
  "x-displayname": "Name",
15560
15746
  "x-ves-example": "Contactus-route.",
15561
15747
  "x-f5xc-example": "contactus-route",
15748
+ "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.",
15749
+ "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.",
15562
15750
  "minLength": 0,
15563
15751
  "maxLength": 16,
15564
15752
  "x-f5xc-required-for": {
@@ -15569,7 +15757,7 @@
15569
15757
  },
15570
15758
  "x-original-maxLength": 1024,
15571
15759
  "x-reconciled-from-discovery": true,
15572
- "x-reconciled-at": "2026-01-05T18:29:10.542752+00:00"
15760
+ "x-reconciled-at": "2026-01-07T15:28:26.689148+00:00"
15573
15761
  },
15574
15762
  "namespace": {
15575
15763
  "type": "string",
@@ -15578,6 +15766,8 @@
15578
15766
  "x-displayname": "Namespace",
15579
15767
  "x-ves-example": "Ns1",
15580
15768
  "x-f5xc-example": "ns1",
15769
+ "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.",
15770
+ "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.",
15581
15771
  "minLength": 0,
15582
15772
  "maxLength": 6,
15583
15773
  "x-f5xc-required-for": {
@@ -15588,7 +15778,7 @@
15588
15778
  },
15589
15779
  "x-original-maxLength": 1024,
15590
15780
  "x-reconciled-from-discovery": true,
15591
- "x-reconciled-at": "2026-01-05T18:29:10.542756+00:00"
15781
+ "x-reconciled-at": "2026-01-07T15:28:26.689152+00:00"
15592
15782
  },
15593
15783
  "uid": {
15594
15784
  "type": "string",
@@ -15609,9 +15799,10 @@
15609
15799
  "x-original-maxLength": 1024,
15610
15800
  "format": "uuid",
15611
15801
  "x-reconciled-from-discovery": true,
15612
- "x-reconciled-at": "2026-01-05T18:29:10.542761+00:00"
15802
+ "x-reconciled-at": "2026-01-07T15:28:26.689157+00:00"
15613
15803
  }
15614
15804
  },
15805
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
15615
15806
  "x-f5xc-minimum-configuration": {
15616
15807
  "description": "Minimum configuration for schemaViewRefType",
15617
15808
  "required_fields": [
@@ -15642,6 +15833,8 @@
15642
15833
  "x-ves-deprecated": "Replaced by 'topic'",
15643
15834
  "x-ves-example": "Infrastructure.",
15644
15835
  "x-f5xc-example": "infrastructure",
15836
+ "x-f5xc-description-short": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.",
15837
+ "x-f5xc-description-medium": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.",
15645
15838
  "minLength": 0,
15646
15839
  "maxLength": 1024,
15647
15840
  "x-f5xc-required-for": {
@@ -15659,6 +15852,8 @@
15659
15852
  },
15660
15853
  "x-displayname": "Comments",
15661
15854
  "x-f5xc-example": "[\"I'm looking into it\", \"Thanks\", \"Fixed, can you please retry?\", \"It works!\", \"Thanks, closing the issue\"]",
15855
+ "x-f5xc-description-short": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
15856
+ "x-f5xc-description-medium": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
15662
15857
  "x-f5xc-required-for": {
15663
15858
  "minimum_config": false,
15664
15859
  "create": false,
@@ -15672,6 +15867,7 @@
15672
15867
  "x-displayname": "Description.",
15673
15868
  "x-ves-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John.",
15674
15869
  "x-f5xc-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John",
15870
+ "x-f5xc-description-short": "Customer's description of the issue (free text).",
15675
15871
  "minLength": 0,
15676
15872
  "maxLength": 0,
15677
15873
  "x-f5xc-required-for": {
@@ -15682,13 +15878,14 @@
15682
15878
  },
15683
15879
  "x-original-maxLength": 1024,
15684
15880
  "x-reconciled-from-discovery": true,
15685
- "x-reconciled-at": "2026-01-05T18:29:10.542769+00:00"
15881
+ "x-reconciled-at": "2026-01-07T15:28:26.689165+00:00"
15686
15882
  },
15687
15883
  "ongoing": {
15688
15884
  "type": "boolean",
15689
15885
  "description": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
15690
15886
  "format": "boolean",
15691
15887
  "x-displayname": "Ongoing",
15888
+ "x-f5xc-description-short": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
15692
15889
  "x-f5xc-required-for": {
15693
15890
  "minimum_config": false,
15694
15891
  "create": false,
@@ -15705,6 +15902,7 @@
15705
15902
  "x-displayname": "Product Data.",
15706
15903
  "x-ves-example": "Happening in the loreimpsum namespace and impacts most of our sites.",
15707
15904
  "x-f5xc-example": "Happening in the loreimpsum namespace and impacts most of our sites",
15905
+ "x-f5xc-description-short": "Product data is a free text field that can be used to describe the issue in more detail.",
15708
15906
  "minLength": 0,
15709
15907
  "maxLength": 1024,
15710
15908
  "x-f5xc-required-for": {
@@ -15721,6 +15919,7 @@
15721
15919
  "$ref": "#/components/schemas/schemaObjectRefType"
15722
15920
  },
15723
15921
  "x-displayname": "Ticket which this one relates to.",
15922
+ "x-f5xc-description-short": "Optional reference to any original ticket in case the ticket being created is a followup.",
15724
15923
  "x-f5xc-required-for": {
15725
15924
  "minimum_config": false,
15726
15925
  "create": false,
@@ -15755,6 +15954,7 @@
15755
15954
  "x-displayname": "Timeline",
15756
15955
  "x-ves-example": "Both LBs have been down since noon on Jan 5, 2022.",
15757
15956
  "x-f5xc-example": "Both LBs have been down since noon on Jan 5, 2022.",
15957
+ "x-f5xc-description-short": "Timeline is a free text field that can be used to describe the issue in more detail.",
15758
15958
  "minLength": 0,
15759
15959
  "maxLength": 1024,
15760
15960
  "x-f5xc-required-for": {
@@ -15773,6 +15973,7 @@
15773
15973
  "x-displayname": "Third Party ID.",
15774
15974
  "x-ves-example": "123",
15775
15975
  "x-f5xc-example": "123",
15976
+ "x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
15776
15977
  "minLength": 0,
15777
15978
  "maxLength": 1024,
15778
15979
  "x-f5xc-required-for": {
@@ -15787,6 +15988,7 @@
15787
15988
  "$ref": "#/components/schemas/customer_supportSupportTicketType"
15788
15989
  }
15789
15990
  },
15991
+ "x-f5xc-description-short": "Creates a new customer support ticket in our customer support provider system.",
15790
15992
  "x-f5xc-minimum-configuration": {
15791
15993
  "description": "Minimum configuration for schemacustomer_supportCreateSpecType",
15792
15994
  "required_fields": [
@@ -15827,6 +16029,8 @@
15827
16029
  "default": "EUNKNOWN",
15828
16030
  "x-displayname": "Error Code.",
15829
16031
  "x-ves-proto-enum": "ves.io.schema.customer_support.ErrorCode",
16032
+ "x-f5xc-description-short": "ErrorCode is used to know the specific reason for customer support operation failures - EUNKNOWN: an unknown error occurred - EOK: Successful...",
16033
+ "x-f5xc-description-medium": "ErrorCode is used to know the specific reason for customer support operation failures - EUNKNOWN: an unknown error occurred - EOK: Successful operation - E_NOT_CLOSED: Customer support ticket not closed - E_NOT_OPEN: Customer support ticket not open - E_NOT_ELIGIBLE: Customer is not eligible for...",
15830
16034
  "x-f5xc-minimum-configuration": {
15831
16035
  "description": "Minimum configuration for schemacustomer_supportErrorCode",
15832
16036
  "required_fields": [],
@@ -15867,6 +16071,8 @@
15867
16071
  "x-ves-deprecated": "Replaced by 'topic'",
15868
16072
  "x-ves-example": "Infrastructure.",
15869
16073
  "x-f5xc-example": "infrastructure",
16074
+ "x-f5xc-description-short": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.",
16075
+ "x-f5xc-description-medium": "Ticket area further narrows down the ticket - infrastructure, application, dashboards can be examples.",
15870
16076
  "minLength": 0,
15871
16077
  "maxLength": 1024,
15872
16078
  "x-f5xc-required-for": {
@@ -15884,6 +16090,8 @@
15884
16090
  },
15885
16091
  "x-displayname": "Comments",
15886
16092
  "x-f5xc-example": "[\"I'm looking into it\", \"Thanks\", \"Fixed, can you please retry?\", \"It works!\", \"Thanks, closing the issue\"]",
16093
+ "x-f5xc-description-short": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
16094
+ "x-f5xc-description-medium": "Comments are all public comments on an issue. They'RE usually conversation between the support personnel and the customer.",
15887
16095
  "x-f5xc-required-for": {
15888
16096
  "minimum_config": false,
15889
16097
  "create": false,
@@ -15917,6 +16125,8 @@
15917
16125
  "x-displayname": "Custom Fields.",
15918
16126
  "x-ves-example": "Custom-field-ID:custom-field-value.",
15919
16127
  "x-f5xc-example": "custom-field-id:custom-field-value",
16128
+ "x-f5xc-description-short": "Any custom fields (read only). Custom fields have to be defined first before they'RE used.",
16129
+ "x-f5xc-description-medium": "Any custom fields (read only). Custom fields have to be defined first before they'RE used. Custom fields have no direct impact on the issue but help to better categorize issues.",
15920
16130
  "x-f5xc-required-for": {
15921
16131
  "minimum_config": false,
15922
16132
  "create": false,
@@ -15930,6 +16140,7 @@
15930
16140
  "x-displayname": "Description.",
15931
16141
  "x-ves-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John.",
15932
16142
  "x-f5xc-example": "Hello support, I cannot login to example account. Can you please look into it. Thank you, John",
16143
+ "x-f5xc-description-short": "Customer's description of the issue (free text).",
15933
16144
  "minLength": 0,
15934
16145
  "maxLength": 0,
15935
16146
  "x-f5xc-required-for": {
@@ -15940,13 +16151,15 @@
15940
16151
  },
15941
16152
  "x-original-maxLength": 1024,
15942
16153
  "x-reconciled-from-discovery": true,
15943
- "x-reconciled-at": "2026-01-05T18:29:10.542796+00:00"
16154
+ "x-reconciled-at": "2026-01-07T15:28:26.689190+00:00"
15944
16155
  },
15945
16156
  "escalated": {
15946
16157
  "type": "boolean",
15947
16158
  "description": "Indicates escalated ticket - i.e. A ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it.\nOnly existing enterprise customer tickets with priority other then PRIORITY_URGENT can be escalated.",
15948
16159
  "format": "boolean",
15949
16160
  "x-displayname": "Escalated",
16161
+ "x-f5xc-description-short": "Indicates escalated ticket - i.e. A ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it.",
16162
+ "x-f5xc-description-medium": "Indicates escalated ticket - i.e. A ticket its priority has been increased to PRIORITY_URGENT and L1 support has been notified of it. Only existing enterprise customer tickets with priority other then PRIORITY_URGENT can be escalated.",
15950
16163
  "x-f5xc-required-for": {
15951
16164
  "minimum_config": false,
15952
16165
  "create": false,
@@ -15961,6 +16174,8 @@
15961
16174
  "$ref": "#/components/schemas/schemaObjectRefType"
15962
16175
  },
15963
16176
  "x-displayname": "Followup tickets.",
16177
+ "x-f5xc-description-short": "Optional reference to followup tickets. It only applies to closed tickets and points to any ticket that is open as a followup to this closed ticket.",
16178
+ "x-f5xc-description-medium": "Optional reference to followup tickets. It only applies to closed tickets and points to any ticket that is open as a followup to this closed ticket. Used in situations when the original ticket has been closed but the issue occurred again or a new problem occurred in relation to this closed ticket.",
15964
16179
  "x-f5xc-required-for": {
15965
16180
  "minimum_config": false,
15966
16181
  "create": false,
@@ -15973,6 +16188,7 @@
15973
16188
  "description": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
15974
16189
  "format": "boolean",
15975
16190
  "x-displayname": "Ongoing",
16191
+ "x-f5xc-description-short": "Ongoing is a flag that indicates whether the issue is ongoing or not.",
15976
16192
  "x-f5xc-required-for": {
15977
16193
  "minimum_config": false,
15978
16194
  "create": false,
@@ -15989,6 +16205,7 @@
15989
16205
  "x-displayname": "Product Data.",
15990
16206
  "x-ves-example": "Happening in the loreimpsum namespace and impacts most of our sites.",
15991
16207
  "x-f5xc-example": "Happening in the loreimpsum namespace and impacts most of our sites",
16208
+ "x-f5xc-description-short": "Product data is a free text field that can be used to describe the issue in more detail.",
15992
16209
  "minLength": 0,
15993
16210
  "maxLength": 1024,
15994
16211
  "x-f5xc-required-for": {
@@ -16005,6 +16222,7 @@
16005
16222
  "$ref": "#/components/schemas/schemaObjectRefType"
16006
16223
  },
16007
16224
  "x-displayname": "Ticket which this one relates to.",
16225
+ "x-f5xc-description-short": "Optional reference to any original ticket in case the ticket being created is a followup.",
16008
16226
  "x-f5xc-required-for": {
16009
16227
  "minimum_config": false,
16010
16228
  "create": false,
@@ -16042,6 +16260,7 @@
16042
16260
  "x-displayname": "Tags",
16043
16261
  "x-ves-example": "UAM,UI",
16044
16262
  "x-f5xc-example": "UAM,UI",
16263
+ "x-f5xc-description-short": "Tags help to further categorize issues (read-only field).",
16045
16264
  "x-f5xc-required-for": {
16046
16265
  "minimum_config": false,
16047
16266
  "create": false,
@@ -16055,6 +16274,7 @@
16055
16274
  "x-displayname": "Timeline",
16056
16275
  "x-ves-example": "Both LBs have been down since noon on Jan 5, 2022.",
16057
16276
  "x-f5xc-example": "Both LBs have been down since noon on Jan 5, 2022.",
16277
+ "x-f5xc-description-short": "Timeline is a free text field that can be used to describe the issue in more detail.",
16058
16278
  "minLength": 0,
16059
16279
  "maxLength": 1024,
16060
16280
  "x-f5xc-required-for": {
@@ -16073,6 +16293,7 @@
16073
16293
  "x-displayname": "Third Party ID.",
16074
16294
  "x-ves-example": "123",
16075
16295
  "x-f5xc-example": "123",
16296
+ "x-f5xc-description-short": "ID assigned to this ticket by our support provider.",
16076
16297
  "minLength": 0,
16077
16298
  "maxLength": 1024,
16078
16299
  "x-f5xc-required-for": {
@@ -16124,6 +16345,7 @@
16124
16345
  "x-displayname": "Via",
16125
16346
  "x-ves-example": "['channel':'web', 'source': '{}']",
16126
16347
  "x-f5xc-example": "['channel':'web', 'source''{}']",
16348
+ "x-f5xc-description-short": "Via describes the way of a ticket reaching us (read-only).",
16127
16349
  "x-f5xc-required-for": {
16128
16350
  "minimum_config": false,
16129
16351
  "create": false,
@@ -16132,6 +16354,8 @@
16132
16354
  }
16133
16355
  }
16134
16356
  },
16357
+ "x-f5xc-description-short": "Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.",
16358
+ "x-f5xc-description-medium": "Support ticket representation we display to customers. There's much more information associated with a ticker but this maybe sensitive/irrelevant.",
16135
16359
  "x-f5xc-minimum-configuration": {
16136
16360
  "description": "Minimum configuration for schemacustomer_supportGetSpecType",
16137
16361
  "required_fields": [
@@ -16173,6 +16397,7 @@
16173
16397
  "content_type": {
16174
16398
  "type": "string",
16175
16399
  "description": "The HTTP Content-Type header value specifying the content type of the body.",
16400
+ "x-f5xc-description-short": "The HTTP Content-Type header value specifying the content type of the body.",
16176
16401
  "minLength": 0,
16177
16402
  "maxLength": 1024,
16178
16403
  "x-f5xc-required-for": {
@@ -16186,6 +16411,8 @@
16186
16411
  "type": "string",
16187
16412
  "description": "The HTTP request/response body as raw binary.",
16188
16413
  "format": "byte",
16414
+ "x-f5xc-example": "{\"key\": \"value\"}",
16415
+ "x-f5xc-description-short": "The HTTP request/response body as raw binary.",
16189
16416
  "minLength": 0,
16190
16417
  "maxLength": 1024,
16191
16418
  "x-f5xc-required-for": {
@@ -16201,6 +16428,7 @@
16201
16428
  "items": {
16202
16429
  "$ref": "#/components/schemas/protobufAny"
16203
16430
  },
16431
+ "x-f5xc-description-short": "Application specific response metadata. Must be set in the first response for streaming APIs.",
16204
16432
  "x-f5xc-required-for": {
16205
16433
  "minimum_config": false,
16206
16434
  "create": false,
@@ -16209,6 +16437,8 @@
16209
16437
  }
16210
16438
  }
16211
16439
  },
16440
+ "x-f5xc-description-short": "Message that represents an arbitrary HTTP body.",
16441
+ "x-f5xc-description-medium": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response.",
16212
16442
  "x-f5xc-minimum-configuration": {
16213
16443
  "description": "Minimum configuration for apiHttpBody",
16214
16444
  "required_fields": [
@@ -16237,6 +16467,7 @@
16237
16467
  "x-displayname": "User",
16238
16468
  "x-ves-example": "Console-user.",
16239
16469
  "x-f5xc-example": "console-user",
16470
+ "x-f5xc-description-short": "Name of the console user who runs this command.",
16240
16471
  "minLength": 0,
16241
16472
  "maxLength": 1024,
16242
16473
  "x-f5xc-required-for": {
@@ -16332,6 +16563,7 @@
16332
16563
  "x-displayname": "Collect Start Time.",
16333
16564
  "x-ves-example": "2024-06-18T0012.",
16334
16565
  "x-f5xc-example": "2024-06-18T0012",
16566
+ "x-f5xc-description-short": "The UTC timestamp when the collection start.",
16335
16567
  "minLength": 0,
16336
16568
  "maxLength": 1024,
16337
16569
  "x-f5xc-required-for": {
@@ -16379,6 +16611,7 @@
16379
16611
  "x-displayname": "Debug Bundle Validity.",
16380
16612
  "x-ves-example": "2024-06-18T2237.",
16381
16613
  "x-f5xc-example": "2024-06-18T2237",
16614
+ "x-f5xc-description-short": "The UTC timestamp of the validity of debug bundle.",
16382
16615
  "minLength": 0,
16383
16616
  "maxLength": 1024,
16384
16617
  "x-f5xc-required-for": {
@@ -16412,6 +16645,7 @@
16412
16645
  "description": "X-displayName: \"Status\"\nThe map of curl status with key = node name, value = OK / Error.",
16413
16646
  "title": "Status",
16414
16647
  "x-f5xc-example": "map<node-name, OK>",
16648
+ "x-f5xc-description-short": "X-displayName: \"Status\" The map of curl status with key = node name, value = OK / Error.",
16415
16649
  "x-f5xc-required-for": {
16416
16650
  "minimum_config": false,
16417
16651
  "create": false,
@@ -16421,7 +16655,7 @@
16421
16655
  "maxLength": 17,
16422
16656
  "minLength": 17,
16423
16657
  "x-reconciled-from-discovery": true,
16424
- "x-reconciled-at": "2026-01-05T18:29:15.395534+00:00"
16658
+ "x-reconciled-at": "2026-01-07T15:28:32.752579+00:00"
16425
16659
  }
16426
16660
  },
16427
16661
  "x-f5xc-minimum-configuration": {
@@ -16444,6 +16678,7 @@
16444
16678
  "description": "X-displayName: \"ARP Result\"\nFull response of address resolution protocol \"ARP -an\" on host.",
16445
16679
  "title": "ARP Result.",
16446
16680
  "x-f5xc-example": "? (169.254.0.11) at 06:4d:57:fb:c4:07 [ether]...",
16681
+ "x-f5xc-description-short": "X-displayName: \"ARP Result\" Full response of address resolution protocol \"ARP -an\" on host.",
16447
16682
  "minLength": 0,
16448
16683
  "maxLength": 1024,
16449
16684
  "x-f5xc-required-for": {
@@ -16460,6 +16695,7 @@
16460
16695
  "items": {
16461
16696
  "$ref": "#/components/schemas/debugHostPingResponse"
16462
16697
  },
16698
+ "x-f5xc-description-short": "X-displayName: \"DNS Connectivity\" Ping DNS (from /etc/resolv.conf) to check connectivity.",
16463
16699
  "x-f5xc-required-for": {
16464
16700
  "minimum_config": false,
16465
16701
  "create": false,
@@ -16475,6 +16711,7 @@
16475
16711
  "type": "string"
16476
16712
  },
16477
16713
  "x-f5xc-example": "@192.168.0.2 https://downloads.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioioioio\\n; (1 server found)...",
16714
+ "x-f5xc-description-short": "X-displayName: \"DNS Query Result\" Dig DNS to resolve DNS for domains.",
16478
16715
  "x-f5xc-required-for": {
16479
16716
  "minimum_config": false,
16480
16717
  "create": false,
@@ -16487,6 +16724,7 @@
16487
16724
  "description": "X-displayName: \"Domain Curl Result\"\nThe curl status for all required domains from all nodes.",
16488
16725
  "title": "Domain Curl Result.",
16489
16726
  "x-f5xc-example": "map<domain-url, curl-status>",
16727
+ "x-f5xc-description-short": "X-displayName: \"Domain Curl Result\" The curl status for all required domains from all nodes.",
16490
16728
  "x-f5xc-required-for": {
16491
16729
  "minimum_config": false,
16492
16730
  "create": false,
@@ -16499,6 +16737,8 @@
16499
16737
  "description": "X-displayName: \"Errors\"\nThe map of errors with key = diagnosis command, value = all error messages for that command.",
16500
16738
  "title": "Errors",
16501
16739
  "x-f5xc-example": "map<command, error-messages>",
16740
+ "x-f5xc-description-short": "X-displayName: \"Errors\" The map of errors with key = diagnosis command, value = all error messages for that command.",
16741
+ "x-f5xc-description-medium": "X-displayName: \"Errors\" The map of errors with key = diagnosis command, value = all error messages for that command.",
16502
16742
  "x-f5xc-required-for": {
16503
16743
  "minimum_config": false,
16504
16744
  "create": false,
@@ -16514,6 +16754,7 @@
16514
16754
  "description": "X-displayName: \"Interface Config\"\nFull response of interface configuration \"ifconfig -a\" on host.",
16515
16755
  "title": "Interface Config.",
16516
16756
  "x-f5xc-example": "argo-end: flags=4163\\u003cUP,BROADCAST,...",
16757
+ "x-f5xc-description-short": "X-displayName: \"Interface Config\" Full response of interface configuration \"ifconfig -a\" on host.",
16517
16758
  "minLength": 0,
16518
16759
  "maxLength": 1024,
16519
16760
  "x-f5xc-required-for": {
@@ -16528,6 +16769,7 @@
16528
16769
  "description": "X-displayName: \"Node Name\"\nName of the node.",
16529
16770
  "title": "Node Name",
16530
16771
  "x-f5xc-example": "master-0",
16772
+ "x-f5xc-description-short": "X-displayName: \"Node Name\" Name of the node.",
16531
16773
  "minLength": 0,
16532
16774
  "maxLength": 1024,
16533
16775
  "x-f5xc-required-for": {
@@ -16544,6 +16786,7 @@
16544
16786
  "items": {
16545
16787
  "$ref": "#/components/schemas/debugHostPingResponse"
16546
16788
  },
16789
+ "x-f5xc-description-short": "X-displayName: \"Nodes Connectivity\" Ping nodes (if multiple) to check connectivity.",
16547
16790
  "x-f5xc-required-for": {
16548
16791
  "minimum_config": false,
16549
16792
  "create": false,
@@ -16556,6 +16799,7 @@
16556
16799
  "description": "X-displayName: \"NTP Sync Status\"\nFull response from \"timedatectl status\" on host.",
16557
16800
  "title": "NTP Sync Status.",
16558
16801
  "x-f5xc-example": "System clock synchronized: yes...",
16802
+ "x-f5xc-description-short": "X-displayName: \"NTP Sync Status\" Full response from \"timedatectl status\" on host.",
16559
16803
  "minLength": 0,
16560
16804
  "maxLength": 1024,
16561
16805
  "x-f5xc-required-for": {
@@ -16570,6 +16814,8 @@
16570
16814
  "description": "X-displayName: \"Registration Status\"\nIndicate whether registration is success or failed with some error.",
16571
16815
  "title": "Registration Status.",
16572
16816
  "x-f5xc-example": "OK",
16817
+ "x-f5xc-description-short": "X-displayName: \"Registration Status\" Indicate whether registration is success or failed with some error.",
16818
+ "x-f5xc-description-medium": "X-displayName: \"Registration Status\" Indicate whether registration is success or failed with some error.",
16573
16819
  "minLength": 0,
16574
16820
  "maxLength": 1024,
16575
16821
  "x-f5xc-required-for": {
@@ -16584,6 +16830,7 @@
16584
16830
  "description": "X-displayName: \"Resolv Conf\"\nFull response of /etc/resolv.conf information.",
16585
16831
  "title": "Resolv Conf.",
16586
16832
  "x-f5xc-example": "nameserver 192.168.0.2...",
16833
+ "x-f5xc-description-short": "X-displayName: \"Resolv Conf\" Full response of /etc/resolv.conf information.",
16587
16834
  "minLength": 0,
16588
16835
  "maxLength": 1024,
16589
16836
  "x-f5xc-required-for": {
@@ -16598,6 +16845,7 @@
16598
16845
  "description": "X-displayName: \"Route Result\"\nFull response from \"route -n\" on host.",
16599
16846
  "title": "Route Result.",
16600
16847
  "x-f5xc-example": "Kernel IP routing table...",
16848
+ "x-f5xc-description-short": "X-displayName: \"Route Result\" Full response from \"route -n\" on host.",
16601
16849
  "minLength": 0,
16602
16850
  "maxLength": 1024,
16603
16851
  "x-f5xc-required-for": {
@@ -16646,6 +16894,8 @@
16646
16894
  "x-displayname": "Curl Responses.",
16647
16895
  "x-ves-example": "Map<domain-URL, curl-status>",
16648
16896
  "x-f5xc-example": "map<domain-url, curl-status>",
16897
+ "x-f5xc-description-short": "The subset from full diagnosis response of Domain Curl Result for all required domains from all nodes.",
16898
+ "x-f5xc-description-medium": "The subset from full diagnosis response of Domain Curl Result for all required domains from all nodes.",
16649
16899
  "x-f5xc-required-for": {
16650
16900
  "minimum_config": false,
16651
16901
  "create": false,
@@ -16660,6 +16910,7 @@
16660
16910
  "x-displayname": "Registration Status.",
16661
16911
  "x-ves-example": "Map<node-name, registration-status>",
16662
16912
  "x-f5xc-example": "map<node-name, registration-status>",
16913
+ "x-f5xc-description-short": "The subset from full diagnosis response of Registration Status from all nodes.",
16663
16914
  "x-f5xc-required-for": {
16664
16915
  "minimum_config": false,
16665
16916
  "create": false,
@@ -16674,6 +16925,7 @@
16674
16925
  "x-displayname": "Responses",
16675
16926
  "x-ves-example": "Map<node-name, diganosis-response-object>",
16676
16927
  "x-f5xc-example": "map<node-name, diganosis-response-object>",
16928
+ "x-f5xc-description-short": "The full diagnosis response of all nodes.",
16677
16929
  "x-f5xc-required-for": {
16678
16930
  "minimum_config": false,
16679
16931
  "create": false,
@@ -16760,6 +17012,7 @@
16760
17012
  "x-displayname": "User",
16761
17013
  "x-ves-example": "Console-user.",
16762
17014
  "x-f5xc-example": "console-user",
17015
+ "x-f5xc-description-short": "Name of the console user who runs this command.",
16763
17016
  "minLength": 0,
16764
17017
  "maxLength": 1024,
16765
17018
  "x-f5xc-required-for": {
@@ -16776,6 +17029,7 @@
16776
17029
  "x-displayname": "Namespace",
16777
17030
  "x-ves-example": "Value",
16778
17031
  "x-f5xc-example": "value",
17032
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
16779
17033
  "minLength": 0,
16780
17034
  "maxLength": 6,
16781
17035
  "x-f5xc-required-for": {
@@ -16786,7 +17040,7 @@
16786
17040
  },
16787
17041
  "x-original-maxLength": 1024,
16788
17042
  "x-reconciled-from-discovery": true,
16789
- "x-reconciled-at": "2026-01-05T18:29:15.395572+00:00"
17043
+ "x-reconciled-at": "2026-01-07T15:28:32.752616+00:00"
16790
17044
  },
16791
17045
  "node": {
16792
17046
  "type": "string",
@@ -16821,6 +17075,7 @@
16821
17075
  }
16822
17076
  }
16823
17077
  },
17078
+ "x-f5xc-description-short": "Request to execute CLI command on a specific node in site.",
16824
17079
  "x-f5xc-minimum-configuration": {
16825
17080
  "description": "Minimum configuration for debugExecRequest",
16826
17081
  "required_fields": [
@@ -16917,6 +17172,7 @@
16917
17172
  "description": "Hostname of the node.",
16918
17173
  "title": "Hostname",
16919
17174
  "x-displayname": "Hostname",
17175
+ "x-f5xc-example": "example-resource",
16920
17176
  "minLength": 0,
16921
17177
  "maxLength": 1024,
16922
17178
  "x-f5xc-required-for": {
@@ -16932,6 +17188,7 @@
16932
17188
  "title": "Factory Password Changed.",
16933
17189
  "format": "boolean",
16934
17190
  "x-displayname": "Factory Password Changed.",
17191
+ "x-f5xc-description-short": "If the factory password changed on host.",
16935
17192
  "x-f5xc-required-for": {
16936
17193
  "minimum_config": false,
16937
17194
  "create": false,
@@ -16974,6 +17231,7 @@
16974
17231
  "description": "Public IP gives vhost0 or other primary IP.",
16975
17232
  "title": "Public IP",
16976
17233
  "x-displayname": "Public IP",
17234
+ "x-f5xc-description-short": "Public IP gives vhost0 or other primary IP.",
16977
17235
  "minLength": 0,
16978
17236
  "maxLength": 1024,
16979
17237
  "x-f5xc-required-for": {
@@ -17020,6 +17278,7 @@
17020
17278
  "description": "VPM version running on host.",
17021
17279
  "title": "VPM Version.",
17022
17280
  "x-displayname": "VPM version.",
17281
+ "x-f5xc-example": "v1.2.3",
17023
17282
  "minLength": 0,
17024
17283
  "maxLength": 1,
17025
17284
  "x-f5xc-required-for": {
@@ -17030,7 +17289,7 @@
17030
17289
  },
17031
17290
  "x-original-maxLength": 1024,
17032
17291
  "x-reconciled-from-discovery": true,
17033
- "x-reconciled-at": "2026-01-05T18:29:15.395598+00:00"
17292
+ "x-reconciled-at": "2026-01-07T15:28:32.752641+00:00"
17034
17293
  },
17035
17294
  "wifi_support": {
17036
17295
  "type": "boolean",
@@ -17100,6 +17359,7 @@
17100
17359
  "x-displayname": "Destination.",
17101
17360
  "x-ves-example": "google.com.",
17102
17361
  "x-f5xc-example": "google.com",
17362
+ "x-f5xc-description-short": "Destination to ping can be IP Address or DNS name.",
17103
17363
  "minLength": 0,
17104
17364
  "maxLength": 1024,
17105
17365
  "x-f5xc-required-for": {
@@ -17117,6 +17377,7 @@
17117
17377
  "x-displayname": "Interval",
17118
17378
  "x-ves-example": "1000",
17119
17379
  "x-f5xc-example": "1000",
17380
+ "x-f5xc-description-short": "Interval is the wait time between each packet send. Default is 1s (1000ms).",
17120
17381
  "minimum": 0,
17121
17382
  "maximum": 2147483647,
17122
17383
  "x-f5xc-required-for": {
@@ -17150,6 +17411,7 @@
17150
17411
  "x-displayname": "Namespace",
17151
17412
  "x-ves-example": "Value",
17152
17413
  "x-f5xc-example": "value",
17414
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
17153
17415
  "minLength": 0,
17154
17416
  "maxLength": 6,
17155
17417
  "x-f5xc-required-for": {
@@ -17160,7 +17422,7 @@
17160
17422
  },
17161
17423
  "x-original-maxLength": 1024,
17162
17424
  "x-reconciled-from-discovery": true,
17163
- "x-reconciled-at": "2026-01-05T18:29:15.395612+00:00"
17425
+ "x-reconciled-at": "2026-01-07T15:28:32.752653+00:00"
17164
17426
  },
17165
17427
  "node": {
17166
17428
  "type": "string",
@@ -17243,6 +17505,7 @@
17243
17505
  "x-displayname": "Destination IP.",
17244
17506
  "x-ves-example": "8.8.8.8",
17245
17507
  "x-f5xc-example": "8.8.8.8",
17508
+ "x-f5xc-description-short": "Destination IP is the address of the host being pinged.",
17246
17509
  "minLength": 0,
17247
17510
  "maxLength": 1024,
17248
17511
  "x-f5xc-required-for": {
@@ -17309,6 +17572,7 @@
17309
17572
  "x-displayname": "Packets Received.",
17310
17573
  "x-ves-example": "5",
17311
17574
  "x-f5xc-example": "5",
17575
+ "x-f5xc-description-short": "Received is the number of packets received.",
17312
17576
  "minimum": 0,
17313
17577
  "maximum": 2147483647,
17314
17578
  "x-f5xc-required-for": {
@@ -17342,6 +17606,7 @@
17342
17606
  "x-displayname": "Standard Deviation RTT.",
17343
17607
  "x-ves-example": "30.619µs",
17344
17608
  "x-f5xc-example": "30.619µs",
17609
+ "x-f5xc-description-short": "StdDevRtt is the standard deviation of the round-trip times.",
17345
17610
  "minLength": 0,
17346
17611
  "maxLength": 1024,
17347
17612
  "x-f5xc-required-for": {
@@ -17352,6 +17617,7 @@
17352
17617
  }
17353
17618
  }
17354
17619
  },
17620
+ "x-f5xc-description-short": "Response to initiated ping from the site.",
17355
17621
  "x-f5xc-minimum-configuration": {
17356
17622
  "description": "Minimum configuration for debugHostPingResponse",
17357
17623
  "required_fields": [
@@ -17454,6 +17720,7 @@
17454
17720
  "x-displayname": "Namespace",
17455
17721
  "x-ves-example": "Value",
17456
17722
  "x-f5xc-example": "value",
17723
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
17457
17724
  "minLength": 0,
17458
17725
  "maxLength": 6,
17459
17726
  "x-f5xc-required-for": {
@@ -17464,7 +17731,7 @@
17464
17731
  },
17465
17732
  "x-original-maxLength": 1024,
17466
17733
  "x-reconciled-from-discovery": true,
17467
- "x-reconciled-at": "2026-01-05T18:29:15.395635+00:00"
17734
+ "x-reconciled-at": "2026-01-07T15:28:32.752675+00:00"
17468
17735
  },
17469
17736
  "node": {
17470
17737
  "type": "string",
@@ -17499,6 +17766,7 @@
17499
17766
  }
17500
17767
  }
17501
17768
  },
17769
+ "x-f5xc-description-short": "Request to reboot specific node in site.",
17502
17770
  "x-f5xc-minimum-configuration": {
17503
17771
  "description": "Minimum configuration for debugRebootRequest",
17504
17772
  "required_fields": [
@@ -17553,7 +17821,7 @@
17553
17821
  },
17554
17822
  "x-original-maxLength": 1024,
17555
17823
  "x-reconciled-from-discovery": true,
17556
- "x-reconciled-at": "2026-01-05T18:29:15.395644+00:00"
17824
+ "x-reconciled-at": "2026-01-07T15:28:32.752683+00:00"
17557
17825
  },
17558
17826
  "node": {
17559
17827
  "type": "string",
@@ -17588,9 +17856,10 @@
17588
17856
  },
17589
17857
  "x-original-maxLength": 1024,
17590
17858
  "x-reconciled-from-discovery": true,
17591
- "x-reconciled-at": "2026-01-05T18:29:15.395650+00:00"
17859
+ "x-reconciled-at": "2026-01-07T15:28:32.752689+00:00"
17592
17860
  }
17593
17861
  },
17862
+ "x-f5xc-description-short": "Name and formal displayed name of the service.",
17594
17863
  "x-f5xc-minimum-configuration": {
17595
17864
  "description": "Minimum configuration for debugService",
17596
17865
  "required_fields": [
@@ -17619,6 +17888,7 @@
17619
17888
  "x-displayname": "Namespace",
17620
17889
  "x-ves-example": "Value",
17621
17890
  "x-f5xc-example": "value",
17891
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
17622
17892
  "minLength": 0,
17623
17893
  "maxLength": 6,
17624
17894
  "x-f5xc-required-for": {
@@ -17629,7 +17899,7 @@
17629
17899
  },
17630
17900
  "x-original-maxLength": 1024,
17631
17901
  "x-reconciled-from-discovery": true,
17632
- "x-reconciled-at": "2026-01-05T18:29:15.395655+00:00"
17902
+ "x-reconciled-at": "2026-01-07T15:28:32.752693+00:00"
17633
17903
  },
17634
17904
  "node": {
17635
17905
  "type": "string",
@@ -17680,6 +17950,7 @@
17680
17950
  }
17681
17951
  }
17682
17952
  },
17953
+ "x-f5xc-description-short": "Request to soft restart reloads VER instance on the node.",
17683
17954
  "x-f5xc-minimum-configuration": {
17684
17955
  "description": "Minimum configuration for debugSoftRestartRequest",
17685
17956
  "required_fields": [
@@ -17751,7 +18022,7 @@
17751
18022
  },
17752
18023
  "x-original-maxLength": 1024,
17753
18024
  "x-reconciled-from-discovery": true,
17754
- "x-reconciled-at": "2026-01-05T18:29:15.395666+00:00"
18025
+ "x-reconciled-at": "2026-01-07T15:28:32.752703+00:00"
17755
18026
  },
17756
18027
  "node": {
17757
18028
  "type": "string",
@@ -17786,7 +18057,7 @@
17786
18057
  },
17787
18058
  "x-original-maxLength": 1024,
17788
18059
  "x-reconciled-from-discovery": true,
17789
- "x-reconciled-at": "2026-01-05T18:29:15.395671+00:00"
18060
+ "x-reconciled-at": "2026-01-07T15:28:32.752709+00:00"
17790
18061
  }
17791
18062
  },
17792
18063
  "x-f5xc-minimum-configuration": {
@@ -17819,6 +18090,7 @@
17819
18090
  "$ref": "#/components/schemas/debugStatus"
17820
18091
  },
17821
18092
  "x-displayname": "Status",
18093
+ "x-f5xc-example": "active",
17822
18094
  "x-f5xc-required-for": {
17823
18095
  "minimum_config": false,
17824
18096
  "create": false,
@@ -17828,7 +18100,7 @@
17828
18100
  "maxLength": 17,
17829
18101
  "minLength": 17,
17830
18102
  "x-reconciled-from-discovery": true,
17831
- "x-reconciled-at": "2026-01-05T18:29:15.395677+00:00"
18103
+ "x-reconciled-at": "2026-01-07T15:28:32.752714+00:00"
17832
18104
  }
17833
18105
  },
17834
18106
  "x-f5xc-minimum-configuration": {
@@ -17858,6 +18130,8 @@
17858
18130
  "default": "WAITING_FOR_CONFIG",
17859
18131
  "x-displayname": "Site State.",
17860
18132
  "x-ves-proto-enum": "ves.io.schema.operate.debug.VpmState",
18133
+ "x-f5xc-description-short": "State of Site defines in which operational state site itself is. Site is waiting for input configuration.",
18134
+ "x-f5xc-description-medium": "State of Site defines in which operational state site itself is. Site is waiting for input configuration. Site is waiting for approval. Site is in provisioning state. Site is in provisioned.",
17861
18135
  "x-f5xc-minimum-configuration": {
17862
18136
  "description": "Minimum configuration for debugVpmState",
17863
18137
  "required_fields": [],
@@ -17883,6 +18157,8 @@
17883
18157
  "x-displayname": "Decryption Provider.",
17884
18158
  "x-ves-example": "Value",
17885
18159
  "x-f5xc-example": "value",
18160
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
18161
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
17886
18162
  "minLength": 0,
17887
18163
  "maxLength": 1024,
17888
18164
  "x-f5xc-required-for": {
@@ -17908,6 +18184,8 @@
17908
18184
  "ves.io.schema.rules.message.required": "true",
17909
18185
  "ves.io.schema.rules.string.uri_ref": "true"
17910
18186
  },
18187
+ "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.",
18188
+ "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.",
17911
18189
  "minLength": 0,
17912
18190
  "maxLength": 4,
17913
18191
  "x-f5xc-required-for": {
@@ -17918,7 +18196,7 @@
17918
18196
  },
17919
18197
  "x-original-maxLength": 1024,
17920
18198
  "x-reconciled-from-discovery": true,
17921
- "x-reconciled-at": "2026-01-05T18:29:15.395692+00:00"
18199
+ "x-reconciled-at": "2026-01-07T15:28:32.752728+00:00"
17922
18200
  },
17923
18201
  "store_provider": {
17924
18202
  "type": "string",
@@ -17927,6 +18205,8 @@
17927
18205
  "x-displayname": "Store Provider.",
17928
18206
  "x-ves-example": "Value",
17929
18207
  "x-f5xc-example": "value",
18208
+ "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...",
18209
+ "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:///.",
17930
18210
  "minLength": 0,
17931
18211
  "maxLength": 1024,
17932
18212
  "x-f5xc-required-for": {
@@ -17937,6 +18217,7 @@
17937
18217
  }
17938
18218
  }
17939
18219
  },
18220
+ "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
17940
18221
  "x-f5xc-minimum-configuration": {
17941
18222
  "description": "Minimum configuration for schemaBlindfoldSecretInfoType",
17942
18223
  "required_fields": [
@@ -17966,6 +18247,8 @@
17966
18247
  "x-displayname": "Provider",
17967
18248
  "x-ves-example": "Box-provider.",
17968
18249
  "x-f5xc-example": "box-provider",
18250
+ "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...",
18251
+ "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:///.",
17969
18252
  "minLength": 0,
17970
18253
  "maxLength": 8,
17971
18254
  "x-f5xc-required-for": {
@@ -17976,7 +18259,7 @@
17976
18259
  },
17977
18260
  "x-original-maxLength": 1024,
17978
18261
  "x-reconciled-from-discovery": true,
17979
- "x-reconciled-at": "2026-01-05T18:29:15.395698+00:00"
18262
+ "x-reconciled-at": "2026-01-07T15:28:32.752734+00:00"
17980
18263
  },
17981
18264
  "url": {
17982
18265
  "type": "string",
@@ -17997,6 +18280,8 @@
17997
18280
  "ves.io.schema.rules.string.max_bytes": "131072",
17998
18281
  "ves.io.schema.rules.string.uri_ref": "true"
17999
18282
  },
18283
+ "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
18284
+ "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.",
18000
18285
  "format": "uri",
18001
18286
  "minLength": 0,
18002
18287
  "x-f5xc-required-for": {
@@ -18007,6 +18292,7 @@
18007
18292
  }
18008
18293
  }
18009
18294
  },
18295
+ "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
18010
18296
  "x-f5xc-minimum-configuration": {
18011
18297
  "description": "Minimum configuration for schemaClearSecretInfoType",
18012
18298
  "required_fields": [
@@ -18029,6 +18315,8 @@
18029
18315
  "EncodingBase64"
18030
18316
  ],
18031
18317
  "default": "EncodingNone",
18318
+ "x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
18319
+ "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.",
18032
18320
  "x-f5xc-minimum-configuration": {
18033
18321
  "description": "Minimum configuration for schemaSecretEncodingType",
18034
18322
  "required_fields": [],
@@ -18054,6 +18342,7 @@
18054
18342
  "$ref": "#/components/schemas/schemaClearSecretInfoType"
18055
18343
  }
18056
18344
  },
18345
+ "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
18057
18346
  "x-f5xc-minimum-configuration": {
18058
18347
  "description": "Minimum configuration for schemaSecretType",
18059
18348
  "required_fields": [
@@ -18077,6 +18366,8 @@
18077
18366
  "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.",
18078
18367
  "title": "Key",
18079
18368
  "x-f5xc-example": "key_pem",
18369
+ "x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
18370
+ "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.",
18080
18371
  "minLength": 0,
18081
18372
  "maxLength": 16,
18082
18373
  "x-f5xc-required-for": {
@@ -18087,13 +18378,14 @@
18087
18378
  },
18088
18379
  "x-original-maxLength": 1024,
18089
18380
  "x-reconciled-from-discovery": true,
18090
- "x-reconciled-at": "2026-01-05T18:29:15.395710+00:00"
18381
+ "x-reconciled-at": "2026-01-07T15:28:32.752745+00:00"
18091
18382
  },
18092
18383
  "location": {
18093
18384
  "type": "string",
18094
18385
  "description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
18095
18386
  "title": "Location",
18096
18387
  "x-f5xc-example": "v1/data/vhost_key",
18388
+ "x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
18097
18389
  "minLength": 0,
18098
18390
  "maxLength": 4,
18099
18391
  "x-f5xc-required-for": {
@@ -18104,13 +18396,15 @@
18104
18396
  },
18105
18397
  "x-original-maxLength": 1024,
18106
18398
  "x-reconciled-from-discovery": true,
18107
- "x-reconciled-at": "2026-01-05T18:29:15.395715+00:00"
18399
+ "x-reconciled-at": "2026-01-07T15:28:32.752750+00:00"
18108
18400
  },
18109
18401
  "provider": {
18110
18402
  "type": "string",
18111
18403
  "description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
18112
18404
  "title": "Provider",
18113
18405
  "x-f5xc-example": "vault-vh-provider",
18406
+ "x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
18407
+ "x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
18114
18408
  "minLength": 0,
18115
18409
  "maxLength": 8,
18116
18410
  "x-f5xc-required-for": {
@@ -18121,7 +18415,7 @@
18121
18415
  },
18122
18416
  "x-original-maxLength": 1024,
18123
18417
  "x-reconciled-from-discovery": true,
18124
- "x-reconciled-at": "2026-01-05T18:29:15.395719+00:00"
18418
+ "x-reconciled-at": "2026-01-07T15:28:32.752754+00:00"
18125
18419
  },
18126
18420
  "secret_encoding": {
18127
18421
  "$ref": "#/components/schemas/schemaSecretEncodingType"
@@ -18132,6 +18426,8 @@
18132
18426
  "title": "Version",
18133
18427
  "format": "int64",
18134
18428
  "x-f5xc-example": "1",
18429
+ "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.",
18430
+ "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.",
18135
18431
  "minimum": 0,
18136
18432
  "maximum": 2147483647,
18137
18433
  "x-f5xc-required-for": {
@@ -18143,9 +18439,11 @@
18143
18439
  "maxLength": 1,
18144
18440
  "minLength": 1,
18145
18441
  "x-reconciled-from-discovery": true,
18146
- "x-reconciled-at": "2026-01-05T18:29:15.395726+00:00"
18442
+ "x-reconciled-at": "2026-01-07T15:28:32.752760+00:00"
18147
18443
  }
18148
18444
  },
18445
+ "x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
18446
+ "x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
18149
18447
  "x-f5xc-minimum-configuration": {
18150
18448
  "description": "Minimum configuration for schemaVaultSecretInfoType",
18151
18449
  "required_fields": [
@@ -18172,6 +18470,7 @@
18172
18470
  "description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
18173
18471
  "title": "Name",
18174
18472
  "x-f5xc-example": "ChargeBack-API-Key",
18473
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
18175
18474
  "minLength": 0,
18176
18475
  "maxLength": 16,
18177
18476
  "x-f5xc-required-for": {
@@ -18182,9 +18481,10 @@
18182
18481
  },
18183
18482
  "x-original-maxLength": 1024,
18184
18483
  "x-reconciled-from-discovery": true,
18185
- "x-reconciled-at": "2026-01-05T18:29:15.395731+00:00"
18484
+ "x-reconciled-at": "2026-01-07T15:28:32.752765+00:00"
18186
18485
  }
18187
18486
  },
18487
+ "x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
18188
18488
  "x-f5xc-minimum-configuration": {
18189
18489
  "description": "Minimum configuration for schemaWingmanSecretInfoType",
18190
18490
  "required_fields": [
@@ -18211,6 +18511,7 @@
18211
18511
  "x-displayname": "Date",
18212
18512
  "x-ves-example": "Value",
18213
18513
  "x-f5xc-example": "value",
18514
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/bios_date.",
18214
18515
  "minLength": 0,
18215
18516
  "maxLength": 1024,
18216
18517
  "x-f5xc-required-for": {
@@ -18227,6 +18528,7 @@
18227
18528
  "x-displayname": "Vendor",
18228
18529
  "x-ves-example": "Value",
18229
18530
  "x-f5xc-example": "value",
18531
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/bios_vendor.",
18230
18532
  "minLength": 0,
18231
18533
  "maxLength": 1024,
18232
18534
  "x-f5xc-required-for": {
@@ -18243,6 +18545,7 @@
18243
18545
  "x-displayname": "Version",
18244
18546
  "x-ves-example": "Value",
18245
18547
  "x-f5xc-example": "value",
18548
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/bios_version.",
18246
18549
  "minLength": 0,
18247
18550
  "maxLength": 1,
18248
18551
  "x-f5xc-required-for": {
@@ -18253,7 +18556,7 @@
18253
18556
  },
18254
18557
  "x-original-maxLength": 1024,
18255
18558
  "x-reconciled-from-discovery": true,
18256
- "x-reconciled-at": "2026-01-05T18:29:15.395739+00:00"
18559
+ "x-reconciled-at": "2026-01-07T15:28:32.752773+00:00"
18257
18560
  }
18258
18561
  },
18259
18562
  "x-f5xc-minimum-configuration": {
@@ -18284,6 +18587,7 @@
18284
18587
  "x-displayname": "Asset Tag",
18285
18588
  "x-ves-example": "Value",
18286
18589
  "x-f5xc-example": "value",
18590
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_asset_tag.",
18287
18591
  "minLength": 0,
18288
18592
  "maxLength": 1024,
18289
18593
  "x-f5xc-required-for": {
@@ -18300,6 +18604,7 @@
18300
18604
  "x-displayname": "Name",
18301
18605
  "x-ves-example": "Value",
18302
18606
  "x-f5xc-example": "value",
18607
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_name.",
18303
18608
  "minLength": 0,
18304
18609
  "maxLength": 16,
18305
18610
  "x-f5xc-required-for": {
@@ -18310,7 +18615,7 @@
18310
18615
  },
18311
18616
  "x-original-maxLength": 1024,
18312
18617
  "x-reconciled-from-discovery": true,
18313
- "x-reconciled-at": "2026-01-05T18:29:15.395746+00:00"
18618
+ "x-reconciled-at": "2026-01-07T15:28:32.752779+00:00"
18314
18619
  },
18315
18620
  "serial": {
18316
18621
  "type": "string",
@@ -18319,6 +18624,7 @@
18319
18624
  "x-displayname": "Serial Number.",
18320
18625
  "x-ves-example": "Value",
18321
18626
  "x-f5xc-example": "value",
18627
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_serial.",
18322
18628
  "minLength": 0,
18323
18629
  "maxLength": 1024,
18324
18630
  "x-f5xc-required-for": {
@@ -18335,6 +18641,7 @@
18335
18641
  "x-displayname": "Vendor",
18336
18642
  "x-ves-example": "Value",
18337
18643
  "x-f5xc-example": "value",
18644
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_vendor.",
18338
18645
  "minLength": 0,
18339
18646
  "maxLength": 1024,
18340
18647
  "x-f5xc-required-for": {
@@ -18351,6 +18658,7 @@
18351
18658
  "x-displayname": "Version",
18352
18659
  "x-ves-example": "Value",
18353
18660
  "x-f5xc-example": "value",
18661
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/board_version.",
18354
18662
  "minLength": 0,
18355
18663
  "maxLength": 1,
18356
18664
  "x-f5xc-required-for": {
@@ -18361,7 +18669,7 @@
18361
18669
  },
18362
18670
  "x-original-maxLength": 1024,
18363
18671
  "x-reconciled-from-discovery": true,
18364
- "x-reconciled-at": "2026-01-05T18:29:15.395753+00:00"
18672
+ "x-reconciled-at": "2026-01-07T15:28:32.752786+00:00"
18365
18673
  }
18366
18674
  },
18367
18675
  "x-f5xc-minimum-configuration": {
@@ -18394,6 +18702,7 @@
18394
18702
  "x-displayname": "Asset Tag",
18395
18703
  "x-ves-example": "Value",
18396
18704
  "x-f5xc-example": "value",
18705
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_asset_tag.",
18397
18706
  "minLength": 0,
18398
18707
  "maxLength": 1024,
18399
18708
  "x-f5xc-required-for": {
@@ -18410,6 +18719,7 @@
18410
18719
  "x-displayname": "Serial Number.",
18411
18720
  "x-ves-example": "Value",
18412
18721
  "x-f5xc-example": "value",
18722
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_serial.",
18413
18723
  "minLength": 0,
18414
18724
  "maxLength": 1024,
18415
18725
  "x-f5xc-required-for": {
@@ -18427,6 +18737,7 @@
18427
18737
  "x-displayname": "Type",
18428
18738
  "x-ves-example": "0",
18429
18739
  "x-f5xc-example": "0",
18740
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_type.",
18430
18741
  "minimum": 0,
18431
18742
  "maximum": 2147483647,
18432
18743
  "x-f5xc-required-for": {
@@ -18443,6 +18754,7 @@
18443
18754
  "x-displayname": "Vendor",
18444
18755
  "x-ves-example": "Value",
18445
18756
  "x-f5xc-example": "value",
18757
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_vendor.",
18446
18758
  "minLength": 0,
18447
18759
  "maxLength": 1024,
18448
18760
  "x-f5xc-required-for": {
@@ -18459,6 +18771,7 @@
18459
18771
  "x-displayname": "Version",
18460
18772
  "x-ves-example": "Value",
18461
18773
  "x-f5xc-example": "value",
18774
+ "x-f5xc-description-short": "Information from /sys/class/dmi/ID/chassis_version.",
18462
18775
  "minLength": 0,
18463
18776
  "maxLength": 1,
18464
18777
  "x-f5xc-required-for": {
@@ -18469,7 +18782,7 @@
18469
18782
  },
18470
18783
  "x-original-maxLength": 1024,
18471
18784
  "x-reconciled-from-discovery": true,
18472
- "x-reconciled-at": "2026-01-05T18:29:15.395764+00:00"
18785
+ "x-reconciled-at": "2026-01-07T15:28:32.752795+00:00"
18473
18786
  }
18474
18787
  },
18475
18788
  "x-f5xc-minimum-configuration": {
@@ -18827,7 +19140,7 @@
18827
19140
  },
18828
19141
  "x-original-maxLength": 1024,
18829
19142
  "x-reconciled-from-discovery": true,
18830
- "x-reconciled-at": "2026-01-05T18:29:15.395791+00:00"
19143
+ "x-reconciled-at": "2026-01-07T15:28:32.752823+00:00"
18831
19144
  }
18832
19145
  },
18833
19146
  "x-f5xc-minimum-configuration": {
@@ -18857,6 +19170,8 @@
18857
19170
  "default": "QUALITY_UNKNOWN",
18858
19171
  "x-displayname": "Link quality.",
18859
19172
  "x-ves-proto-enum": "ves.io.schema.site.LinkQuality",
19173
+ "x-f5xc-description-short": "Link quality determined by VER using different probes Unknown quality Link quality is good Link quality is poor Quality disabled.",
19174
+ "x-f5xc-description-medium": "Link quality determined by VER using different probes Unknown quality Link quality is good Link quality is poor Quality disabled.",
18860
19175
  "x-f5xc-minimum-configuration": {
18861
19176
  "description": "Minimum configuration for siteLinkQuality",
18862
19177
  "required_fields": [],
@@ -18883,6 +19198,8 @@
18883
19198
  "default": "LINK_TYPE_UNKNOWN",
18884
19199
  "x-displayname": "Link type",
18885
19200
  "x-ves-proto-enum": "ves.io.schema.site.LinkType",
19201
+ "x-f5xc-description-short": "Link type of interface determined operationally Link type unknown Link type ethernet WiFi link of type 802.11ac WiFi link of type 802.11bgn Link...",
19202
+ "x-f5xc-description-medium": "Link type of interface determined operationally Link type unknown Link type ethernet WiFi link of type 802.11ac WiFi link of type 802.11bgn Link type 4G WiFi link Wan link.",
18886
19203
  "x-f5xc-minimum-configuration": {
18887
19204
  "description": "Minimum configuration for siteLinkType",
18888
19205
  "required_fields": [],
@@ -19044,7 +19361,7 @@
19044
19361
  },
19045
19362
  "x-original-maxLength": 1024,
19046
19363
  "x-reconciled-from-discovery": true,
19047
- "x-reconciled-at": "2026-01-05T18:29:15.395808+00:00"
19364
+ "x-reconciled-at": "2026-01-07T15:28:32.752839+00:00"
19048
19365
  },
19049
19366
  "port": {
19050
19367
  "type": "string",
@@ -19141,7 +19458,7 @@
19141
19458
  },
19142
19459
  "x-original-maxLength": 1024,
19143
19460
  "x-reconciled-from-discovery": true,
19144
- "x-reconciled-at": "2026-01-05T18:29:15.395818+00:00"
19461
+ "x-reconciled-at": "2026-01-07T15:28:32.752848+00:00"
19145
19462
  },
19146
19463
  "release": {
19147
19464
  "type": "string",
@@ -19192,7 +19509,7 @@
19192
19509
  },
19193
19510
  "x-original-maxLength": 1024,
19194
19511
  "x-reconciled-from-discovery": true,
19195
- "x-reconciled-at": "2026-01-05T18:29:15.395825+00:00"
19512
+ "x-reconciled-at": "2026-01-07T15:28:32.752855+00:00"
19196
19513
  }
19197
19514
  },
19198
19515
  "x-f5xc-minimum-configuration": {
@@ -19247,6 +19564,7 @@
19247
19564
  "$ref": "#/components/schemas/siteNetworkDevice"
19248
19565
  },
19249
19566
  "x-displayname": "Network",
19567
+ "x-f5xc-example": "192.0.2.0/24",
19250
19568
  "x-f5xc-required-for": {
19251
19569
  "minimum_config": false,
19252
19570
  "create": false,
@@ -19268,6 +19586,7 @@
19268
19586
  "x-validation-rules": {
19269
19587
  "ves.io.schema.rules.int32.gte": "0"
19270
19588
  },
19589
+ "x-f5xc-description-short": "Non-uniform memory access (NUMA) nodes count.",
19271
19590
  "minimum": 0,
19272
19591
  "maximum": 2147483647,
19273
19592
  "x-f5xc-required-for": {
@@ -19314,6 +19633,7 @@
19314
19633
  }
19315
19634
  }
19316
19635
  },
19636
+ "x-f5xc-description-short": "OsInfo holds information about host OS and HW.",
19317
19637
  "x-f5xc-minimum-configuration": {
19318
19638
  "description": "Minimum configuration for siteOsInfo",
19319
19639
  "required_fields": [
@@ -19362,7 +19682,7 @@
19362
19682
  },
19363
19683
  "x-original-maxLength": 1024,
19364
19684
  "x-reconciled-from-discovery": true,
19365
- "x-reconciled-at": "2026-01-05T18:29:15.395846+00:00"
19685
+ "x-reconciled-at": "2026-01-07T15:28:32.752875+00:00"
19366
19686
  },
19367
19687
  "serial": {
19368
19688
  "type": "string",
@@ -19371,6 +19691,8 @@
19371
19691
  "x-displayname": "Serial Number.",
19372
19692
  "x-ves-example": "Ec254b6d-9676-1a51-8b10-21370dbdc3e5.",
19373
19693
  "x-f5xc-example": "ec254b6d-9676-1a51-8b10-21370dbdc3e5",
19694
+ "x-f5xc-description-short": "Serial number, eg. For AWS ec254b6d-9676-1a51-8b10-21370dbdc3e5.",
19695
+ "x-f5xc-description-medium": "Serial number, eg. For AWS ec254b6d-9676-1a51-8b10-21370dbdc3e5. Info taken from /sys/class/dmi/ID/product_serial.",
19374
19696
  "minLength": 0,
19375
19697
  "maxLength": 1024,
19376
19698
  "x-f5xc-required-for": {
@@ -19403,6 +19725,7 @@
19403
19725
  "x-displayname": "Version",
19404
19726
  "x-ves-example": "Value",
19405
19727
  "x-f5xc-example": "value",
19728
+ "x-f5xc-description-short": "Version name. Info taken from /sys/class/dmi/ID/product_version.",
19406
19729
  "minLength": 0,
19407
19730
  "maxLength": 1,
19408
19731
  "x-f5xc-required-for": {
@@ -19413,7 +19736,7 @@
19413
19736
  },
19414
19737
  "x-original-maxLength": 1024,
19415
19738
  "x-reconciled-from-discovery": true,
19416
- "x-reconciled-at": "2026-01-05T18:29:15.395853+00:00"
19739
+ "x-reconciled-at": "2026-01-07T15:28:32.752882+00:00"
19417
19740
  }
19418
19741
  },
19419
19742
  "x-f5xc-minimum-configuration": {
@@ -19487,7 +19810,7 @@
19487
19810
  },
19488
19811
  "x-original-maxLength": 1024,
19489
19812
  "x-reconciled-from-discovery": true,
19490
- "x-reconciled-at": "2026-01-05T18:29:15.395860+00:00"
19813
+ "x-reconciled-at": "2026-01-07T15:28:32.752890+00:00"
19491
19814
  },
19492
19815
  "serial": {
19493
19816
  "type": "string",
@@ -19571,6 +19894,7 @@
19571
19894
  "x-displayname": "Address",
19572
19895
  "x-ves-example": "4",
19573
19896
  "x-f5xc-example": "4",
19897
+ "x-f5xc-description-short": "Address of the device on the bus in decimal.",
19574
19898
  "minimum": 0,
19575
19899
  "maximum": 2147483647,
19576
19900
  "x-f5xc-required-for": {
@@ -19603,6 +19927,7 @@
19603
19927
  "x-displayname": "Protocol",
19604
19928
  "x-ves-example": "0002",
19605
19929
  "x-f5xc-example": "0002",
19930
+ "x-f5xc-description-short": "The protocol (within the sub-class) of this device.",
19606
19931
  "minLength": 0,
19607
19932
  "maxLength": 1024,
19608
19933
  "x-f5xc-required-for": {
@@ -19619,6 +19944,7 @@
19619
19944
  "x-displayname": "Subclass",
19620
19945
  "x-ves-example": "Hub",
19621
19946
  "x-f5xc-example": "hub",
19947
+ "x-f5xc-description-short": "The sub-class (within the class) of this device.",
19622
19948
  "minLength": 0,
19623
19949
  "maxLength": 1024,
19624
19950
  "x-f5xc-required-for": {
@@ -19685,6 +20011,7 @@
19685
20011
  "x-displayname": "Bus",
19686
20012
  "x-ves-example": "1",
19687
20013
  "x-f5xc-example": "1",
20014
+ "x-f5xc-description-short": "The bus on which the device was detected in decimal.",
19688
20015
  "minimum": 0,
19689
20016
  "maximum": 2147483647,
19690
20017
  "x-f5xc-required-for": {
@@ -19711,7 +20038,7 @@
19711
20038
  },
19712
20039
  "x-original-maxLength": 1024,
19713
20040
  "x-reconciled-from-discovery": true,
19714
- "x-reconciled-at": "2026-01-05T18:29:15.395880+00:00"
20041
+ "x-reconciled-at": "2026-01-07T15:28:32.752911+00:00"
19715
20042
  },
19716
20043
  "i_manufacturer": {
19717
20044
  "type": "string",
@@ -19752,6 +20079,7 @@
19752
20079
  "x-displayname": "ISerialNumber.",
19753
20080
  "x-ves-example": "0000:00:14.0.",
19754
20081
  "x-f5xc-example": "0000:00:14.0",
20082
+ "x-f5xc-description-short": "Index of Serial Number String Descriptor.",
19755
20083
  "minLength": 0,
19756
20084
  "maxLength": 1024,
19757
20085
  "x-f5xc-required-for": {
@@ -19768,6 +20096,7 @@
19768
20096
  "x-displayname": "Product ID.",
19769
20097
  "x-ves-example": "0x0002",
19770
20098
  "x-f5xc-example": "0x0002",
20099
+ "x-f5xc-description-short": "Product ID (Assigned by Manufacturer) in hex.",
19771
20100
  "minLength": 0,
19772
20101
  "maxLength": 1024,
19773
20102
  "x-f5xc-required-for": {
@@ -19801,6 +20130,7 @@
19801
20130
  "x-displayname": "Port",
19802
20131
  "x-ves-example": "3",
19803
20132
  "x-f5xc-example": "3",
20133
+ "x-f5xc-description-short": "Port on which the device was detected in decimal.",
19804
20134
  "minimum": 1,
19805
20135
  "maximum": 65535,
19806
20136
  "x-f5xc-required-for": {
@@ -19817,6 +20147,7 @@
19817
20147
  "x-displayname": "Product name.",
19818
20148
  "x-ves-example": "NetVista Full Width Keyboard.",
19819
20149
  "x-f5xc-example": "NetVista Full Width Keyboard",
20150
+ "x-f5xc-description-short": "Product ID translated to name (if available).",
19820
20151
  "minLength": 0,
19821
20152
  "maxLength": 1024,
19822
20153
  "x-f5xc-required-for": {
@@ -19833,6 +20164,7 @@
19833
20164
  "x-displayname": "Speed",
19834
20165
  "x-ves-example": "High",
19835
20166
  "x-f5xc-example": "high",
20167
+ "x-f5xc-description-short": "The negotiated operating speed for the device.",
19836
20168
  "minLength": 0,
19837
20169
  "maxLength": 1024,
19838
20170
  "x-f5xc-required-for": {
@@ -19852,6 +20184,7 @@
19852
20184
  "x-displayname": "Vendor name.",
19853
20185
  "x-ves-example": "IBM Corp.",
19854
20186
  "x-f5xc-example": "IBM Corp.",
20187
+ "x-f5xc-description-short": "Vendor ID translated to name (if available).",
19855
20188
  "minLength": 0,
19856
20189
  "maxLength": 1024,
19857
20190
  "x-f5xc-required-for": {
@@ -19905,6 +20238,8 @@
19905
20238
  "default": "UNKNOWN_USB",
19906
20239
  "x-displayname": "USB Type",
19907
20240
  "x-ves-proto-enum": "ves.io.schema.site.UsbType",
20241
+ "x-f5xc-description-short": "Type of USB device Unknown USB device type Internal USB present in Certified HW USB device present during node registration USB device that can be...",
20242
+ "x-f5xc-description-medium": "Type of USB device Unknown USB device type Internal USB present in Certified HW USB device present during node registration USB device that can be matched by USB rules.",
19908
20243
  "x-f5xc-minimum-configuration": {
19909
20244
  "description": "Minimum configuration for siteUsbType",
19910
20245
  "required_fields": [],
@@ -19927,6 +20262,7 @@
19927
20262
  "description": "Option key.",
19928
20263
  "title": "Key",
19929
20264
  "x-displayname": "Key",
20265
+ "x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
19930
20266
  "minLength": 0,
19931
20267
  "maxLength": 16,
19932
20268
  "x-f5xc-required-for": {
@@ -19937,7 +20273,7 @@
19937
20273
  },
19938
20274
  "x-original-maxLength": 1024,
19939
20275
  "x-reconciled-from-discovery": true,
19940
- "x-reconciled-at": "2026-01-05T18:29:15.566727+00:00"
20276
+ "x-reconciled-at": "2026-01-07T15:28:33.001972+00:00"
19941
20277
  },
19942
20278
  "value": {
19943
20279
  "type": "string",
@@ -19954,9 +20290,10 @@
19954
20290
  },
19955
20291
  "x-original-maxLength": 1024,
19956
20292
  "x-reconciled-from-discovery": true,
19957
- "x-reconciled-at": "2026-01-05T18:29:15.566734+00:00"
20293
+ "x-reconciled-at": "2026-01-07T15:28:33.001979+00:00"
19958
20294
  }
19959
20295
  },
20296
+ "x-f5xc-description-short": "DHCP Option information as a (key, value) pair.",
19960
20297
  "x-f5xc-minimum-configuration": {
19961
20298
  "description": "Minimum configuration for dhcpDhcpKeyValuePair",
19962
20299
  "required_fields": [
@@ -20009,7 +20346,7 @@
20009
20346
  },
20010
20347
  "x-original-maxLength": 1024,
20011
20348
  "x-reconciled-from-discovery": true,
20012
- "x-reconciled-at": "2026-01-05T18:29:15.566743+00:00"
20349
+ "x-reconciled-at": "2026-01-07T15:28:33.001988+00:00"
20013
20350
  },
20014
20351
  "expiry": {
20015
20352
  "type": "string",
@@ -20031,6 +20368,7 @@
20031
20368
  "description": "Host name of the client.",
20032
20369
  "title": "Host Name",
20033
20370
  "x-displayname": "Host Name",
20371
+ "x-f5xc-example": "example-resource",
20034
20372
  "minLength": 0,
20035
20373
  "maxLength": 1024,
20036
20374
  "x-f5xc-required-for": {
@@ -20045,6 +20383,7 @@
20045
20383
  "description": "Name of the ver interface to which the client is connected.",
20046
20384
  "title": "Interface",
20047
20385
  "x-displayname": "Interface",
20386
+ "x-f5xc-description-short": "Name of the ver interface to which the client is connected.",
20048
20387
  "minLength": 0,
20049
20388
  "maxLength": 1024,
20050
20389
  "x-f5xc-required-for": {
@@ -20121,6 +20460,7 @@
20121
20460
  "description": "Subnet of the client.",
20122
20461
  "title": "Subnet",
20123
20462
  "x-displayname": "Subnet",
20463
+ "x-f5xc-example": "192.0.2.0/24",
20124
20464
  "minLength": 0,
20125
20465
  "maxLength": 1024,
20126
20466
  "x-f5xc-required-for": {
@@ -20131,6 +20471,7 @@
20131
20471
  }
20132
20472
  }
20133
20473
  },
20474
+ "x-f5xc-description-short": "Information about DHCP lease given by VER DHCP server.",
20134
20475
  "x-f5xc-minimum-configuration": {
20135
20476
  "description": "Minimum configuration for dhcpDhcpLeaseInfo",
20136
20477
  "required_fields": [
@@ -20190,6 +20531,7 @@
20190
20531
  }
20191
20532
  }
20192
20533
  },
20534
+ "x-f5xc-description-short": "Active list of DHCP leases that have been leased by VER DHCP server.",
20193
20535
  "x-f5xc-minimum-configuration": {
20194
20536
  "description": "Minimum configuration for dhcpDhcpLeases",
20195
20537
  "required_fields": [
@@ -20216,6 +20558,7 @@
20216
20558
  "title": "Address Count.",
20217
20559
  "format": "int64",
20218
20560
  "x-displayname": "Address Count.",
20561
+ "x-f5xc-description-short": "Number of addresses in the subnet that DHCP can lease.",
20219
20562
  "minimum": 0,
20220
20563
  "maximum": 2147483647,
20221
20564
  "x-f5xc-required-for": {
@@ -20231,6 +20574,7 @@
20231
20574
  "title": "Free Addresses.",
20232
20575
  "format": "int64",
20233
20576
  "x-displayname": "Free Addresses.",
20577
+ "x-f5xc-description-short": "Number of addresses in the subnet that are free (not allocated).",
20234
20578
  "minimum": 0,
20235
20579
  "maximum": 2147483647,
20236
20580
  "x-f5xc-required-for": {
@@ -20245,6 +20589,7 @@
20245
20589
  "description": "Name of the ver interface to which the subnet is assigned.",
20246
20590
  "title": "Interface",
20247
20591
  "x-displayname": "Interface",
20592
+ "x-f5xc-description-short": "Name of the ver interface to which the subnet is assigned.",
20248
20593
  "minLength": 0,
20249
20594
  "maxLength": 1024,
20250
20595
  "x-f5xc-required-for": {
@@ -20259,6 +20604,7 @@
20259
20604
  "description": "Subnet address.",
20260
20605
  "title": "Subnet",
20261
20606
  "x-displayname": "Subnet",
20607
+ "x-f5xc-example": "192.0.2.0/24",
20262
20608
  "minLength": 0,
20263
20609
  "maxLength": 1024,
20264
20610
  "x-f5xc-required-for": {
@@ -20299,6 +20645,7 @@
20299
20645
  "x-displayname": "Connected",
20300
20646
  "x-ves-example": "True",
20301
20647
  "x-f5xc-example": "true",
20648
+ "x-f5xc-description-short": "Whether the device is connected to LTE network.",
20302
20649
  "x-f5xc-required-for": {
20303
20650
  "minimum_config": false,
20304
20651
  "create": false,
@@ -20313,6 +20660,7 @@
20313
20660
  "x-displayname": "Network Operator.",
20314
20661
  "x-ves-example": "T-Mobile",
20315
20662
  "x-f5xc-example": "T-Mobile",
20663
+ "x-f5xc-description-short": "Network Operator to which is device connected.",
20316
20664
  "minLength": 0,
20317
20665
  "maxLength": 1024,
20318
20666
  "x-f5xc-required-for": {
@@ -20355,6 +20703,7 @@
20355
20703
  "x-displayname": "Uptime",
20356
20704
  "x-ves-example": "4380",
20357
20705
  "x-f5xc-example": "4380",
20706
+ "x-f5xc-description-short": "Number of seconds the device is connected to network.",
20358
20707
  "minimum": 0,
20359
20708
  "maximum": 2147483647,
20360
20709
  "x-f5xc-required-for": {
@@ -20397,6 +20746,7 @@
20397
20746
  "x-displayname": "APN",
20398
20747
  "x-ves-example": "Internet",
20399
20748
  "x-f5xc-example": "internet",
20749
+ "x-f5xc-description-short": "Access Point Name is the name of a gateway between a mobile network and another computer network.",
20400
20750
  "minLength": 0,
20401
20751
  "maxLength": 1024,
20402
20752
  "x-f5xc-required-for": {
@@ -20446,6 +20796,7 @@
20446
20796
  "x-displayname": "Primary",
20447
20797
  "x-ves-example": "True",
20448
20798
  "x-f5xc-example": "true",
20799
+ "x-f5xc-description-short": "LTE interface is used as Primary Site Local Outside.",
20449
20800
  "x-f5xc-required-for": {
20450
20801
  "minimum_config": false,
20451
20802
  "create": false,
@@ -20500,6 +20851,7 @@
20500
20851
  "x-displayname": "Namespace",
20501
20852
  "x-ves-example": "Value",
20502
20853
  "x-f5xc-example": "value",
20854
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
20503
20855
  "minLength": 0,
20504
20856
  "maxLength": 6,
20505
20857
  "x-f5xc-required-for": {
@@ -20510,7 +20862,7 @@
20510
20862
  },
20511
20863
  "x-original-maxLength": 1024,
20512
20864
  "x-reconciled-from-discovery": true,
20513
- "x-reconciled-at": "2026-01-05T18:29:31.721347+00:00"
20865
+ "x-reconciled-at": "2026-01-07T15:28:53.702416+00:00"
20514
20866
  },
20515
20867
  "node": {
20516
20868
  "type": "string",
@@ -20609,6 +20961,7 @@
20609
20961
  "$ref": "#/components/schemas/lteLte"
20610
20962
  }
20611
20963
  },
20964
+ "x-f5xc-description-short": "Runtime LTE information obtained from site.",
20612
20965
  "x-f5xc-minimum-configuration": {
20613
20966
  "description": "Minimum configuration for lteLteInfoResponse",
20614
20967
  "required_fields": [
@@ -20638,6 +20991,7 @@
20638
20991
  "x-displayname": "Namespace",
20639
20992
  "x-ves-example": "Value",
20640
20993
  "x-f5xc-example": "value",
20994
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
20641
20995
  "minLength": 0,
20642
20996
  "maxLength": 6,
20643
20997
  "x-f5xc-required-for": {
@@ -20648,7 +21002,7 @@
20648
21002
  },
20649
21003
  "x-original-maxLength": 1024,
20650
21004
  "x-reconciled-from-discovery": true,
20651
- "x-reconciled-at": "2026-01-05T18:29:31.721362+00:00"
21005
+ "x-reconciled-at": "2026-01-07T15:28:53.702431+00:00"
20652
21006
  },
20653
21007
  "node": {
20654
21008
  "type": "string",
@@ -20759,6 +21113,7 @@
20759
21113
  "x-displayname": "RSSI",
20760
21114
  "x-ves-example": "-79",
20761
21115
  "x-f5xc-example": "-79",
21116
+ "x-f5xc-description-short": "The Received Signal Strength Indication.",
20762
21117
  "x-f5xc-required-for": {
20763
21118
  "minimum_config": false,
20764
21119
  "create": false,
@@ -20774,6 +21129,7 @@
20774
21129
  "x-displayname": "SINR",
20775
21130
  "x-ves-example": "12.200000000000001.",
20776
21131
  "x-f5xc-example": "12.200000000000001",
21132
+ "x-f5xc-description-short": "The Signal to Interference plus Noise Ratio.",
20777
21133
  "x-f5xc-required-for": {
20778
21134
  "minimum_config": false,
20779
21135
  "create": false,
@@ -20811,6 +21167,8 @@
20811
21167
  "default": "UNKNOWN",
20812
21168
  "x-displayname": "Signal Strength.",
20813
21169
  "x-ves-proto-enum": "ves.io.schema.operate.lte.SignalStrength",
21170
+ "x-f5xc-description-short": "Current Signal Strength - UNKNOWN: UNKNOWN RSSI not received - EXCELLENT: EXCELLENT RSSI greater then -65 - GOOD: GOOD RSSI between -65 and -75 ...",
21171
+ "x-f5xc-description-medium": "Current Signal Strength - UNKNOWN: UNKNOWN RSSI not received - EXCELLENT: EXCELLENT RSSI greater then -65 - GOOD: GOOD RSSI between -65 and -75 - FAIR: FAIR RSSI between -75 and -85 - POOR: POOR RSSI lower then -85.",
20814
21172
  "x-f5xc-minimum-configuration": {
20815
21173
  "description": "Minimum configuration for lteSignalStrength",
20816
21174
  "required_fields": [],
@@ -20849,6 +21207,7 @@
20849
21207
  "x-displayname": "IMEI",
20850
21208
  "x-ves-example": "867698041438378.",
20851
21209
  "x-f5xc-example": "867698041438378",
21210
+ "x-f5xc-description-short": "The International Mobile Equipment Identity.",
20852
21211
  "minLength": 0,
20853
21212
  "maxLength": 1024,
20854
21213
  "x-f5xc-required-for": {
@@ -20863,6 +21222,7 @@
20863
21222
  "description": "The International Mobile Subscriber Identity.",
20864
21223
  "title": "IMSI",
20865
21224
  "x-displayname": "IMSI",
21225
+ "x-f5xc-description-short": "The International Mobile Subscriber Identity.",
20866
21226
  "minLength": 0,
20867
21227
  "maxLength": 1024,
20868
21228
  "x-f5xc-required-for": {
@@ -20954,6 +21314,7 @@
20954
21314
  "ves.io.schema.rules.uint32.gte": "300",
20955
21315
  "ves.io.schema.rules.uint32.lte": "10000"
20956
21316
  },
21317
+ "x-f5xc-description-short": "Interval between ping requests, in milliseconds.",
20957
21318
  "minimum": 0,
20958
21319
  "maximum": 2147483647,
20959
21320
  "x-f5xc-required-for": {
@@ -20973,6 +21334,7 @@
20973
21334
  "x-displayname": "Namespace",
20974
21335
  "x-ves-example": "System",
20975
21336
  "x-f5xc-example": "system",
21337
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
20976
21338
  "minLength": 0,
20977
21339
  "maxLength": 6,
20978
21340
  "x-f5xc-required-for": {
@@ -20983,7 +21345,7 @@
20983
21345
  },
20984
21346
  "x-original-maxLength": 1024,
20985
21347
  "x-reconciled-from-discovery": true,
20986
- "x-reconciled-at": "2026-01-05T18:29:41.491028+00:00"
21348
+ "x-reconciled-at": "2026-01-07T15:29:06.248230+00:00"
20987
21349
  },
20988
21350
  "node": {
20989
21351
  "type": "string",
@@ -21005,6 +21367,7 @@
21005
21367
  "ves.io.schema.rules.string.max_len": "64",
21006
21368
  "ves.io.schema.rules.string.min_len": "1"
21007
21369
  },
21370
+ "x-f5xc-description-short": "Name of the node from which ping is initiated Required: YES.",
21008
21371
  "x-f5xc-required-for": {
21009
21372
  "minimum_config": false,
21010
21373
  "create": false,
@@ -21044,6 +21407,7 @@
21044
21407
  "x-displayname": "Site Name",
21045
21408
  "x-ves-example": "Value",
21046
21409
  "x-f5xc-example": "value",
21410
+ "x-f5xc-description-short": "Name of the site from which ping is initiated.",
21047
21411
  "minLength": 0,
21048
21412
  "maxLength": 1024,
21049
21413
  "x-f5xc-required-for": {
@@ -21238,6 +21602,7 @@
21238
21602
  "title": "Empty",
21239
21603
  "x-displayname": "Empty",
21240
21604
  "x-ves-proto-message": "ves.io.schema.Empty",
21605
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
21241
21606
  "x-f5xc-minimum-configuration": {
21242
21607
  "description": "Minimum configuration for schemaEmpty",
21243
21608
  "required_fields": [],
@@ -21272,6 +21637,7 @@
21272
21637
  "ves.io.schema.rules.string.hostname": "true",
21273
21638
  "ves.io.schema.rules.string.max_len": "256"
21274
21639
  },
21640
+ "x-f5xc-description-short": "Exclusive with [IP] DNS name of the host.",
21275
21641
  "minLength": 0,
21276
21642
  "x-f5xc-required-for": {
21277
21643
  "minimum_config": false,
@@ -21293,6 +21659,7 @@
21293
21659
  "x-validation-rules": {
21294
21660
  "ves.io.schema.rules.string.ip": "true"
21295
21661
  },
21662
+ "x-f5xc-description-short": "Exclusive with [hostname] IP address of the host.",
21296
21663
  "minLength": 0,
21297
21664
  "maxLength": 1024,
21298
21665
  "x-f5xc-required-for": {
@@ -21303,6 +21670,7 @@
21303
21670
  }
21304
21671
  }
21305
21672
  },
21673
+ "x-f5xc-description-short": "Host Identifier identifies a host, either by its DNS name (hostname) or by its IP address.",
21306
21674
  "x-f5xc-minimum-configuration": {
21307
21675
  "description": "Minimum configuration for schemaHostIdentifier",
21308
21676
  "required_fields": [
@@ -21344,6 +21712,7 @@
21344
21712
  "ves.io.schema.rules.string.max_len": "256",
21345
21713
  "ves.io.schema.rules.string.min_len": "1"
21346
21714
  },
21715
+ "x-f5xc-description-short": "Exclusive with [any_intf] Name of the chosen interface on the node.",
21347
21716
  "x-f5xc-required-for": {
21348
21717
  "minimum_config": false,
21349
21718
  "create": false,
@@ -21352,6 +21721,7 @@
21352
21721
  }
21353
21722
  }
21354
21723
  },
21724
+ "x-f5xc-description-short": "Interface Identifier identifies one or all interfaces on a node.",
21355
21725
  "x-f5xc-minimum-configuration": {
21356
21726
  "description": "Minimum configuration for schemaInterfaceIdentifier",
21357
21727
  "required_fields": [
@@ -21383,6 +21753,8 @@
21383
21753
  "default": "EOK",
21384
21754
  "x-displayname": "Error Code.",
21385
21755
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
21756
+ "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...",
21757
+ "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...",
21386
21758
  "x-f5xc-minimum-configuration": {
21387
21759
  "description": "Minimum configuration for schemaErrorCode",
21388
21760
  "required_fields": [],
@@ -21418,6 +21790,7 @@
21418
21790
  "ves.io.schema.rules.string.max_len": "256",
21419
21791
  "ves.io.schema.rules.string.min_len": "1"
21420
21792
  },
21793
+ "x-f5xc-description-short": "Exclusive with [pod vn vn_type] Name of the chosen interface on the node.",
21421
21794
  "x-f5xc-required-for": {
21422
21795
  "minimum_config": false,
21423
21796
  "create": false,
@@ -21442,6 +21815,7 @@
21442
21815
  "ves.io.schema.rules.string.max_len": "256",
21443
21816
  "ves.io.schema.rules.string.min_len": "1"
21444
21817
  },
21818
+ "x-f5xc-description-short": "Exclusive with [intf vn vn_type] Name of the pod whose interface on the node is chosen.",
21445
21819
  "x-f5xc-required-for": {
21446
21820
  "minimum_config": false,
21447
21821
  "create": false,
@@ -21466,6 +21840,7 @@
21466
21840
  "ves.io.schema.rules.string.max_len": "256",
21467
21841
  "ves.io.schema.rules.string.min_len": "1"
21468
21842
  },
21843
+ "x-f5xc-description-short": "Exclusive with [intf pod vn_type] Name of chosen Virtual Network.",
21469
21844
  "x-f5xc-required-for": {
21470
21845
  "minimum_config": false,
21471
21846
  "create": false,
@@ -21514,6 +21889,8 @@
21514
21889
  "default": "VIRTUAL_NETWORK_SITE_LOCAL",
21515
21890
  "x-displayname": "Virtual Network Type.",
21516
21891
  "x-ves-proto-enum": "ves.io.schema.VirtualNetworkType",
21892
+ "x-f5xc-description-short": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public...",
21893
+ "x-f5xc-description-medium": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to...",
21517
21894
  "x-f5xc-minimum-configuration": {
21518
21895
  "description": "Minimum configuration for schemaVirtualNetworkType",
21519
21896
  "required_fields": [],
@@ -21542,6 +21919,7 @@
21542
21919
  "x-displayname": "Namespace",
21543
21920
  "x-ves-example": "System",
21544
21921
  "x-f5xc-example": "system",
21922
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
21545
21923
  "minLength": 0,
21546
21924
  "maxLength": 6,
21547
21925
  "x-f5xc-required-for": {
@@ -21552,7 +21930,7 @@
21552
21930
  },
21553
21931
  "x-original-maxLength": 1024,
21554
21932
  "x-reconciled-from-discovery": true,
21555
- "x-reconciled-at": "2026-01-05T18:30:02.285394+00:00"
21933
+ "x-reconciled-at": "2026-01-07T15:29:31.510043+00:00"
21556
21934
  },
21557
21935
  "node": {
21558
21936
  "type": "string",
@@ -21574,6 +21952,7 @@
21574
21952
  "ves.io.schema.rules.string.max_len": "64",
21575
21953
  "ves.io.schema.rules.string.min_len": "1"
21576
21954
  },
21955
+ "x-f5xc-description-short": "Name of the node on which Tcpdump was run Required: YES.",
21577
21956
  "x-f5xc-required-for": {
21578
21957
  "minimum_config": false,
21579
21958
  "create": false,
@@ -21588,6 +21967,7 @@
21588
21967
  "x-displayname": "Site Name",
21589
21968
  "x-ves-example": "Value",
21590
21969
  "x-f5xc-example": "value",
21970
+ "x-f5xc-description-short": "Name of the site on which Tcpdump was run.",
21591
21971
  "minLength": 0,
21592
21972
  "maxLength": 1024,
21593
21973
  "x-f5xc-required-for": {
@@ -21598,6 +21978,7 @@
21598
21978
  }
21599
21979
  }
21600
21980
  },
21981
+ "x-f5xc-description-short": "Request to fetch captured pcap data from an earlier Tcpdump request.",
21601
21982
  "x-f5xc-minimum-configuration": {
21602
21983
  "description": "Minimum configuration for tcpdumpFetchRequest",
21603
21984
  "required_fields": [
@@ -21629,6 +22010,7 @@
21629
22010
  "description": "Timestamp of last packet capture on the Interface.",
21630
22011
  "title": "Last Capture Timestamp.",
21631
22012
  "x-displayname": "Last Capture Timestamp.",
22013
+ "x-f5xc-description-short": "Timestamp of last packet capture on the Interface.",
21632
22014
  "minLength": 0,
21633
22015
  "maxLength": 1024,
21634
22016
  "x-f5xc-required-for": {
@@ -21642,6 +22024,7 @@
21642
22024
  "$ref": "#/components/schemas/tcpdumpTcpdumpStatus"
21643
22025
  }
21644
22026
  },
22027
+ "x-f5xc-description-short": "Status of tcpdump capture on an interface.",
21645
22028
  "x-f5xc-minimum-configuration": {
21646
22029
  "description": "Minimum configuration for tcpdumpInterfaceTcpdumpStatus",
21647
22030
  "required_fields": [
@@ -21671,6 +22054,7 @@
21671
22054
  "x-displayname": "Namespace",
21672
22055
  "x-ves-example": "System",
21673
22056
  "x-f5xc-example": "system",
22057
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
21674
22058
  "minLength": 0,
21675
22059
  "maxLength": 6,
21676
22060
  "x-f5xc-required-for": {
@@ -21681,7 +22065,7 @@
21681
22065
  },
21682
22066
  "x-original-maxLength": 1024,
21683
22067
  "x-reconciled-from-discovery": true,
21684
- "x-reconciled-at": "2026-01-05T18:30:02.285407+00:00"
22068
+ "x-reconciled-at": "2026-01-07T15:29:31.510055+00:00"
21685
22069
  },
21686
22070
  "node": {
21687
22071
  "type": "string",
@@ -21703,6 +22087,7 @@
21703
22087
  "ves.io.schema.rules.string.max_len": "64",
21704
22088
  "ves.io.schema.rules.string.min_len": "1"
21705
22089
  },
22090
+ "x-f5xc-description-short": "Name of the node on which Tcpdump status is requested Required: YES.",
21706
22091
  "x-f5xc-required-for": {
21707
22092
  "minimum_config": false,
21708
22093
  "create": false,
@@ -21717,6 +22102,7 @@
21717
22102
  "x-displayname": "Site Name",
21718
22103
  "x-ves-example": "Value",
21719
22104
  "x-f5xc-example": "value",
22105
+ "x-f5xc-description-short": "Name of the site on which Tcpdump status is requested.",
21720
22106
  "minLength": 0,
21721
22107
  "maxLength": 1024,
21722
22108
  "x-f5xc-required-for": {
@@ -21727,6 +22113,7 @@
21727
22113
  }
21728
22114
  }
21729
22115
  },
22116
+ "x-f5xc-description-short": "Request to list Tcpdump capture status on a node.",
21730
22117
  "x-f5xc-minimum-configuration": {
21731
22118
  "description": "Minimum configuration for tcpdumpListRequest",
21732
22119
  "required_fields": [
@@ -21757,6 +22144,7 @@
21757
22144
  "$ref": "#/components/schemas/tcpdumpInterfaceTcpdumpStatus"
21758
22145
  },
21759
22146
  "x-displayname": "Interface Tcpdump Status.",
22147
+ "x-f5xc-description-short": "List of Interfaces along with their last run tcpdump status.",
21760
22148
  "x-f5xc-required-for": {
21761
22149
  "minimum_config": false,
21762
22150
  "create": false,
@@ -21765,6 +22153,7 @@
21765
22153
  }
21766
22154
  }
21767
22155
  },
22156
+ "x-f5xc-description-short": "List of Tcpdump capture status on a node.",
21768
22157
  "x-f5xc-minimum-configuration": {
21769
22158
  "description": "Minimum configuration for tcpdumpListResponse",
21770
22159
  "required_fields": [
@@ -21815,6 +22204,7 @@
21815
22204
  "x-validation-rules": {
21816
22205
  "ves.io.schema.rules.uint32.lte": "32768"
21817
22206
  },
22207
+ "x-f5xc-description-short": "Maximum packets to be captured. Packet capture will end once this number of packets are captured.",
21818
22208
  "minimum": 0,
21819
22209
  "maximum": 2147483647,
21820
22210
  "x-f5xc-required-for": {
@@ -21841,6 +22231,8 @@
21841
22231
  "x-validation-rules": {
21842
22232
  "ves.io.schema.rules.uint32.lte": "1800"
21843
22233
  },
22234
+ "x-f5xc-description-short": "Maximum time period, in seconds, for which packets are to be captured on the interface.",
22235
+ "x-f5xc-description-medium": "Maximum time period, in seconds, for which packets are to be captured on the interface. Packet capture will end after this time period, irrespective of the number of packets captured.",
21844
22236
  "minimum": 0,
21845
22237
  "maximum": 2147483647,
21846
22238
  "x-f5xc-required-for": {
@@ -21857,6 +22249,7 @@
21857
22249
  "x-displayname": "Namespace",
21858
22250
  "x-ves-example": "System",
21859
22251
  "x-f5xc-example": "system",
22252
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
21860
22253
  "minLength": 0,
21861
22254
  "maxLength": 6,
21862
22255
  "x-f5xc-required-for": {
@@ -21867,7 +22260,7 @@
21867
22260
  },
21868
22261
  "x-original-maxLength": 1024,
21869
22262
  "x-reconciled-from-discovery": true,
21870
- "x-reconciled-at": "2026-01-05T18:30:02.285422+00:00"
22263
+ "x-reconciled-at": "2026-01-07T15:29:31.510069+00:00"
21871
22264
  },
21872
22265
  "node": {
21873
22266
  "type": "string",
@@ -21889,6 +22282,7 @@
21889
22282
  "ves.io.schema.rules.string.max_len": "64",
21890
22283
  "ves.io.schema.rules.string.min_len": "1"
21891
22284
  },
22285
+ "x-f5xc-description-short": "Name of the node on which tcpdump is initiated Required: YES.",
21892
22286
  "x-f5xc-required-for": {
21893
22287
  "minimum_config": false,
21894
22288
  "create": false,
@@ -21913,6 +22307,8 @@
21913
22307
  "ves.io.schema.rules.string.max_len": "256",
21914
22308
  "ves.io.schema.rules.string.min_len": "1"
21915
22309
  },
22310
+ "x-f5xc-description-short": "Tcpdump OPTIONS / filter rules to be applied while running tcpdump. These filter rules will be in the same format as linux tcpdump filter rules.",
22311
+ "x-f5xc-description-medium": "Tcpdump OPTIONS / filter rules to be applied while running tcpdump. These filter rules will be in the same format as linux tcpdump filter rules.",
21916
22312
  "x-f5xc-required-for": {
21917
22313
  "minimum_config": false,
21918
22314
  "create": false,
@@ -21927,6 +22323,7 @@
21927
22323
  "x-displayname": "Site Name",
21928
22324
  "x-ves-example": "Value",
21929
22325
  "x-f5xc-example": "value",
22326
+ "x-f5xc-description-short": "Name of the site on which tcpdump is to be run.",
21930
22327
  "minLength": 0,
21931
22328
  "maxLength": 1024,
21932
22329
  "x-f5xc-required-for": {
@@ -21937,6 +22334,7 @@
21937
22334
  }
21938
22335
  }
21939
22336
  },
22337
+ "x-f5xc-description-short": "Request to run tcpdump on a ver interface.",
21940
22338
  "x-f5xc-minimum-configuration": {
21941
22339
  "description": "Minimum configuration for tcpdumpTcpdumpRequest",
21942
22340
  "required_fields": [
@@ -21971,6 +22369,7 @@
21971
22369
  "x-displayname": "Count",
21972
22370
  "x-ves-example": "600",
21973
22371
  "x-f5xc-example": "600",
22372
+ "x-f5xc-description-short": "Packet capture will end once count reaches, irrespective of time duration is still present.",
21974
22373
  "minimum": 0,
21975
22374
  "maximum": 2147483647,
21976
22375
  "x-f5xc-required-for": {
@@ -21988,6 +22387,8 @@
21988
22387
  "x-displayname": "Duration",
21989
22388
  "x-ves-example": "120",
21990
22389
  "x-f5xc-example": "120",
22390
+ "x-f5xc-description-short": "Duration in seconds, for which packets are captured on the interface.",
22391
+ "x-f5xc-description-medium": "Duration in seconds, for which packets are captured on the interface. Packet capture will end after this duration, irrespective of the number of packets captured.",
21991
22392
  "minimum": 0,
21992
22393
  "maximum": 2147483647,
21993
22394
  "x-f5xc-required-for": {
@@ -22007,6 +22408,7 @@
22007
22408
  "x-displayname": "Interface Name.",
22008
22409
  "x-ves-example": "Eth0",
22009
22410
  "x-f5xc-example": "eth0",
22411
+ "x-f5xc-description-short": "Interface Name on which tcpdump is triggered.",
22010
22412
  "minLength": 0,
22011
22413
  "maxLength": 1024,
22012
22414
  "x-f5xc-required-for": {
@@ -22023,6 +22425,7 @@
22023
22425
  "x-displayname": "Node Name",
22024
22426
  "x-ves-example": "Master-0",
22025
22427
  "x-f5xc-example": "master-0",
22428
+ "x-f5xc-description-short": "Name of the node on which tcpdump is initiated.",
22026
22429
  "minLength": 0,
22027
22430
  "maxLength": 1024,
22028
22431
  "x-f5xc-required-for": {
@@ -22049,7 +22452,7 @@
22049
22452
  },
22050
22453
  "x-original-maxLength": 1024,
22051
22454
  "x-reconciled-from-discovery": true,
22052
- "x-reconciled-at": "2026-01-05T18:30:02.285438+00:00"
22455
+ "x-reconciled-at": "2026-01-07T15:29:31.510085+00:00"
22053
22456
  }
22054
22457
  },
22055
22458
  "x-f5xc-minimum-configuration": {
@@ -22082,6 +22485,8 @@
22082
22485
  "default": "RUNNING",
22083
22486
  "x-displayname": "Tcpdump Status.",
22084
22487
  "x-ves-proto-enum": "ves.io.schema.operate.tcpdump.TcpdumpStatus",
22488
+ "x-f5xc-description-short": "Shows the status of tcpdump command on an interface Tcpdump capture on the interface is currently running Tcpdump capture on the interface is done...",
22489
+ "x-f5xc-description-medium": "Shows the status of tcpdump command on an interface Tcpdump capture on the interface is currently running Tcpdump capture on the interface is done Tcpdump capture on the interface failed Tcpdump capture on the interface has not been initiated.",
22085
22490
  "x-f5xc-minimum-configuration": {
22086
22491
  "description": "Minimum configuration for tcpdumpTcpdumpStatus",
22087
22492
  "required_fields": [],
@@ -22118,6 +22523,8 @@
22118
22523
  "ves.io.schema.rules.map.values.string.max_len": "1024",
22119
22524
  "ves.io.schema.rules.map.values.string.min_len": "1"
22120
22525
  },
22526
+ "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.",
22527
+ "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.",
22121
22528
  "x-f5xc-required-for": {
22122
22529
  "minimum_config": false,
22123
22530
  "create": false,
@@ -22139,6 +22546,7 @@
22139
22546
  "x-validation-rules": {
22140
22547
  "ves.io.schema.rules.string.max_bytes": "1200"
22141
22548
  },
22549
+ "x-f5xc-description-short": "Human readable description for the object.",
22142
22550
  "minLength": 0,
22143
22551
  "x-f5xc-required-for": {
22144
22552
  "minimum_config": false,
@@ -22148,7 +22556,7 @@
22148
22556
  },
22149
22557
  "x-original-maxLength": 1200,
22150
22558
  "x-reconciled-from-discovery": true,
22151
- "x-reconciled-at": "2026-01-05T18:30:04.235014+00:00"
22559
+ "x-reconciled-at": "2026-01-07T15:29:34.083328+00:00"
22152
22560
  },
22153
22561
  "disable": {
22154
22562
  "type": "boolean",
@@ -22157,6 +22565,7 @@
22157
22565
  "format": "boolean",
22158
22566
  "x-displayname": "Disable",
22159
22567
  "x-f5xc-example": "true",
22568
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
22160
22569
  "x-f5xc-required-for": {
22161
22570
  "minimum_config": false,
22162
22571
  "create": false,
@@ -22171,6 +22580,8 @@
22171
22580
  "x-displayname": "Labels",
22172
22581
  "x-ves-example": "Value",
22173
22582
  "x-f5xc-example": "value",
22583
+ "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.",
22584
+ "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.",
22174
22585
  "x-f5xc-required-for": {
22175
22586
  "minimum_config": false,
22176
22587
  "create": false,
@@ -22191,6 +22602,8 @@
22191
22602
  "x-validation-rules": {
22192
22603
  "ves.io.schema.rules.message.required": "true"
22193
22604
  },
22605
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
22606
+ "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.",
22194
22607
  "minLength": 0,
22195
22608
  "maxLength": 16,
22196
22609
  "x-f5xc-required-for": {
@@ -22201,7 +22614,7 @@
22201
22614
  },
22202
22615
  "x-original-maxLength": 1024,
22203
22616
  "x-reconciled-from-discovery": true,
22204
- "x-reconciled-at": "2026-01-05T18:30:04.235022+00:00"
22617
+ "x-reconciled-at": "2026-01-07T15:29:34.083336+00:00"
22205
22618
  },
22206
22619
  "namespace": {
22207
22620
  "type": "string",
@@ -22210,6 +22623,8 @@
22210
22623
  "x-displayname": "Namespace",
22211
22624
  "x-ves-example": "Staging",
22212
22625
  "x-f5xc-example": "staging",
22626
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
22627
+ "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 \"\".",
22213
22628
  "minLength": 0,
22214
22629
  "maxLength": 6,
22215
22630
  "x-f5xc-required-for": {
@@ -22220,9 +22635,10 @@
22220
22635
  },
22221
22636
  "x-original-maxLength": 1024,
22222
22637
  "x-reconciled-from-discovery": true,
22223
- "x-reconciled-at": "2026-01-05T18:30:04.235026+00:00"
22638
+ "x-reconciled-at": "2026-01-07T15:29:34.083340+00:00"
22224
22639
  }
22225
22640
  },
22641
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
22226
22642
  "x-f5xc-minimum-configuration": {
22227
22643
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
22228
22644
  "required_fields": [
@@ -22271,6 +22687,7 @@
22271
22687
  "x-displayname": "Icon URL",
22272
22688
  "x-ves-example": "https://example.atlassian.net/REST/API/2/universal_avatar/view/type/issuetype/avatar/10303?size=medium.",
22273
22689
  "x-f5xc-example": "https://example.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/10303?size=medium",
22690
+ "x-f5xc-description-short": "Externally accessible URL for the avatar of the issue type.",
22274
22691
  "minLength": 0,
22275
22692
  "maxLength": 1024,
22276
22693
  "x-f5xc-required-for": {
@@ -22305,6 +22722,7 @@
22305
22722
  "x-displayname": "Name",
22306
22723
  "x-ves-example": "Bug",
22307
22724
  "x-f5xc-example": "Bug",
22725
+ "x-f5xc-description-short": "Name (human readable) of the Jira issue type.",
22308
22726
  "minLength": 0,
22309
22727
  "maxLength": 16,
22310
22728
  "x-f5xc-required-for": {
@@ -22315,9 +22733,11 @@
22315
22733
  },
22316
22734
  "x-original-maxLength": 1024,
22317
22735
  "x-reconciled-from-discovery": true,
22318
- "x-reconciled-at": "2026-01-05T18:30:04.235136+00:00"
22736
+ "x-reconciled-at": "2026-01-07T15:29:34.083434+00:00"
22319
22737
  }
22320
22738
  },
22739
+ "x-f5xc-description-short": "Issue (ticket) type information that's specific to Jira - modeled after the JIRA REST API response format.",
22740
+ "x-f5xc-description-medium": "Issue (ticket) type information that's specific to Jira - modeled after the JIRA REST API response format.",
22321
22741
  "x-f5xc-minimum-configuration": {
22322
22742
  "description": "Minimum configuration for ticket_managementJiraIssueType",
22323
22743
  "required_fields": [
@@ -22366,6 +22786,7 @@
22366
22786
  "$ref": "#/components/schemas/ticket_managementJiraIssueType"
22367
22787
  },
22368
22788
  "x-displayname": "Issue Types.",
22789
+ "x-f5xc-description-short": "Returns available issue types for the project.",
22369
22790
  "x-f5xc-required-for": {
22370
22791
  "minimum_config": false,
22371
22792
  "create": false,
@@ -22390,7 +22811,7 @@
22390
22811
  },
22391
22812
  "x-original-maxLength": 1024,
22392
22813
  "x-reconciled-from-discovery": true,
22393
- "x-reconciled-at": "2026-01-05T18:30:04.235144+00:00"
22814
+ "x-reconciled-at": "2026-01-07T15:29:34.083441+00:00"
22394
22815
  },
22395
22816
  "name": {
22396
22817
  "type": "string",
@@ -22399,6 +22820,7 @@
22399
22820
  "x-displayname": "Name",
22400
22821
  "x-ves-example": "Test project.",
22401
22822
  "x-f5xc-example": "Test project",
22823
+ "x-f5xc-description-short": "Human readable name as it would appear in the external ticket tracking system's UI.",
22402
22824
  "minLength": 0,
22403
22825
  "maxLength": 16,
22404
22826
  "x-f5xc-required-for": {
@@ -22409,9 +22831,11 @@
22409
22831
  },
22410
22832
  "x-original-maxLength": 1024,
22411
22833
  "x-reconciled-from-discovery": true,
22412
- "x-reconciled-at": "2026-01-05T18:30:04.235148+00:00"
22834
+ "x-reconciled-at": "2026-01-07T15:29:34.083446+00:00"
22413
22835
  }
22414
22836
  },
22837
+ "x-f5xc-description-short": "Contains fields and information that are specific to Jira projects - modeled after the JIRA REST API response format.",
22838
+ "x-f5xc-description-medium": "Contains fields and information that are specific to Jira projects - modeled after the JIRA REST API response format.",
22415
22839
  "x-f5xc-minimum-configuration": {
22416
22840
  "description": "Minimum configuration for ticket_managementJiraProject",
22417
22841
  "required_fields": [
@@ -22519,6 +22943,7 @@
22519
22943
  "title": "Fail_if_referred.",
22520
22944
  "format": "boolean",
22521
22945
  "x-displayname": "Fail-If-Referred.",
22946
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
22522
22947
  "x-f5xc-required-for": {
22523
22948
  "minimum_config": false,
22524
22949
  "create": false,
@@ -22543,7 +22968,7 @@
22543
22968
  },
22544
22969
  "x-original-maxLength": 1024,
22545
22970
  "x-reconciled-from-discovery": true,
22546
- "x-reconciled-at": "2026-01-05T18:30:04.235162+00:00"
22971
+ "x-reconciled-at": "2026-01-07T15:29:34.083460+00:00"
22547
22972
  },
22548
22973
  "namespace": {
22549
22974
  "type": "string",
@@ -22552,6 +22977,7 @@
22552
22977
  "x-displayname": "Namespace",
22553
22978
  "x-ves-example": "Ns1",
22554
22979
  "x-f5xc-example": "ns1",
22980
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
22555
22981
  "minLength": 0,
22556
22982
  "maxLength": 6,
22557
22983
  "x-f5xc-required-for": {
@@ -22562,7 +22988,7 @@
22562
22988
  },
22563
22989
  "x-original-maxLength": 1024,
22564
22990
  "x-reconciled-from-discovery": true,
22565
- "x-reconciled-at": "2026-01-05T18:30:04.235166+00:00"
22991
+ "x-reconciled-at": "2026-01-07T15:29:34.083464+00:00"
22566
22992
  }
22567
22993
  },
22568
22994
  "x-f5xc-minimum-configuration": {
@@ -22597,6 +23023,7 @@
22597
23023
  "$ref": "#/components/schemas/schemaObjectRefType"
22598
23024
  },
22599
23025
  "x-displayname": "Deleted Referred Objects.",
23026
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
22600
23027
  "x-f5xc-required-for": {
22601
23028
  "minimum_config": false,
22602
23029
  "create": false,
@@ -22612,6 +23039,7 @@
22612
23039
  "$ref": "#/components/schemas/schemaObjectRefType"
22613
23040
  },
22614
23041
  "x-displayname": "Disabled Referred Objects.",
23042
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
22615
23043
  "x-f5xc-required-for": {
22616
23044
  "minimum_config": false,
22617
23045
  "create": false,
@@ -22630,6 +23058,7 @@
22630
23058
  "$ref": "#/components/schemas/schemaObjectRefType"
22631
23059
  },
22632
23060
  "x-displayname": "Referring Objects.",
23061
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
22633
23062
  "x-f5xc-required-for": {
22634
23063
  "minimum_config": false,
22635
23064
  "create": false,
@@ -22679,6 +23108,8 @@
22679
23108
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
22680
23109
  ],
22681
23110
  "default": "GET_RSP_FORMAT_DEFAULT",
23111
+ "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...",
23112
+ "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...",
22682
23113
  "x-f5xc-minimum-configuration": {
22683
23114
  "description": "Minimum configuration for ticket_tracking_systemGetResponseFormatCode",
22684
23115
  "required_fields": [],
@@ -22701,6 +23132,7 @@
22701
23132
  "$ref": "#/components/schemas/ticket_tracking_systemJiraConfigurationType"
22702
23133
  }
22703
23134
  },
23135
+ "x-f5xc-description-short": "GET attributes of a Ticket Tracking System.",
22704
23136
  "x-f5xc-minimum-configuration": {
22705
23137
  "description": "Minimum configuration for ticket_tracking_systemGetSpecType",
22706
23138
  "required_fields": [
@@ -22738,6 +23170,7 @@
22738
23170
  "ves.io.schema.rules.string.email": "true",
22739
23171
  "ves.io.schema.rules.string.min_len": "1"
22740
23172
  },
23173
+ "x-f5xc-description-short": "Username (email) for the Atlassian account Required: YES.",
22741
23174
  "maxLength": 1024,
22742
23175
  "x-f5xc-required-for": {
22743
23176
  "minimum_config": false,
@@ -22761,6 +23194,8 @@
22761
23194
  "ves.io.schema.rules.message.required": "true",
22762
23195
  "ves.io.schema.rules.string.max_len": "512"
22763
23196
  },
23197
+ "x-f5xc-description-short": "API Token (password) specified by the customer in plaintext to be used for Basic Auth.",
23198
+ "x-f5xc-description-medium": "API Token (password) specified by the customer in plaintext to be used for Basic Auth. This value is purely used for user input and is not persisted in the database. It will be converted to a blindfolded and encrypted form before saving.",
22764
23199
  "minLength": 0,
22765
23200
  "x-f5xc-required-for": {
22766
23201
  "minimum_config": false,
@@ -22788,6 +23223,7 @@
22788
23223
  "ves.io.schema.rules.string.hostname": "true",
22789
23224
  "ves.io.schema.rules.string.min_len": "1"
22790
23225
  },
23226
+ "x-f5xc-description-short": "Valid hostname for the Atlassian organization, as defined by RFC 1034 Required: YES.",
22791
23227
  "maxLength": 1024,
22792
23228
  "x-f5xc-required-for": {
22793
23229
  "minimum_config": false,
@@ -22797,6 +23233,8 @@
22797
23233
  }
22798
23234
  }
22799
23235
  },
23236
+ "x-f5xc-description-short": "V3 API Basic Auth for AD-hoc API Calls - https://developer.atlassian.com/cloud/jira/platform/REST/v3/ This message represents what is stored in...",
23237
+ "x-f5xc-description-medium": "V3 API Basic Auth for AD-hoc API Calls - https://developer.atlassian.com/cloud/jira/platform/REST/v3/ This message represents what is stored in the XC database. To see the API format, refer to the JiraAdhocRestApiConfigurationSpec message.",
22800
23238
  "x-f5xc-minimum-configuration": {
22801
23239
  "description": "Minimum configuration for ticket_tracking_systemJiraAdhocRestApiConfigurationType",
22802
23240
  "required_fields": [
@@ -22845,6 +23283,7 @@
22845
23283
  "description": "The name (identifier) of the ticket tracking system for the request.",
22846
23284
  "title": "Ticket_tracking_system.",
22847
23285
  "x-displayname": "Ticket Tracking System.",
23286
+ "x-f5xc-description-short": "The name (identifier) of the ticket tracking system for the request.",
22848
23287
  "minLength": 0,
22849
23288
  "maxLength": 1024,
22850
23289
  "x-f5xc-required-for": {
@@ -22881,6 +23320,7 @@
22881
23320
  "$ref": "#/components/schemas/ticket_managementJiraProject"
22882
23321
  },
22883
23322
  "x-displayname": "Projects",
23323
+ "x-f5xc-description-short": "List of Jira projects that are available in the specified ticket tracking system.",
22884
23324
  "x-f5xc-required-for": {
22885
23325
  "minimum_config": false,
22886
23326
  "create": false,
@@ -22893,6 +23333,7 @@
22893
23333
  "description": "The name (identifier) of the ticket tracking system for the request.",
22894
23334
  "title": "Ticket_tracking_system.",
22895
23335
  "x-displayname": "Ticket Tracking System.",
23336
+ "x-f5xc-description-short": "The name (identifier) of the ticket tracking system for the request.",
22896
23337
  "minLength": 0,
22897
23338
  "maxLength": 1024,
22898
23339
  "x-f5xc-required-for": {
@@ -22931,6 +23372,7 @@
22931
23372
  "$ref": "#/components/schemas/schemaErrorType"
22932
23373
  },
22933
23374
  "x-displayname": "Errors",
23375
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
22934
23376
  "x-f5xc-required-for": {
22935
23377
  "minimum_config": false,
22936
23378
  "create": false,
@@ -22946,6 +23388,8 @@
22946
23388
  "$ref": "#/components/schemas/ticket_tracking_systemListResponseItem"
22947
23389
  },
22948
23390
  "x-displayname": "Items",
23391
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
23392
+ "x-f5xc-description-short": "Items represents the collection in response.",
22949
23393
  "x-f5xc-required-for": {
22950
23394
  "minimum_config": false,
22951
23395
  "create": false,
@@ -22979,6 +23423,8 @@
22979
23423
  "description": "The set of annotations present on this ticket_tracking_system.",
22980
23424
  "title": "Annotations.",
22981
23425
  "x-displayname": "Annotations.",
23426
+ "x-f5xc-example": "{\"key\": \"value\"}",
23427
+ "x-f5xc-description-short": "The set of annotations present on this ticket_tracking_system.",
22982
23428
  "x-f5xc-required-for": {
22983
23429
  "minimum_config": false,
22984
23430
  "create": false,
@@ -22991,6 +23437,7 @@
22991
23437
  "description": "The description set for this ticket_tracking_system.",
22992
23438
  "title": "Description.",
22993
23439
  "x-displayname": "Description.",
23440
+ "x-f5xc-description-short": "The description set for this ticket_tracking_system.",
22994
23441
  "minLength": 0,
22995
23442
  "maxLength": 0,
22996
23443
  "x-f5xc-required-for": {
@@ -23001,7 +23448,7 @@
23001
23448
  },
23002
23449
  "x-original-maxLength": 1024,
23003
23450
  "x-reconciled-from-discovery": true,
23004
- "x-reconciled-at": "2026-01-05T18:30:04.235199+00:00"
23451
+ "x-reconciled-at": "2026-01-07T15:29:34.083497+00:00"
23005
23452
  },
23006
23453
  "disabled": {
23007
23454
  "type": "boolean",
@@ -23009,6 +23456,8 @@
23009
23456
  "title": "Disabled",
23010
23457
  "format": "boolean",
23011
23458
  "x-displayname": "Disabled",
23459
+ "x-f5xc-example": "True",
23460
+ "x-f5xc-description-short": "Value of true indicates ticket_tracking_system is administratively disabled.",
23012
23461
  "x-f5xc-required-for": {
23013
23462
  "minimum_config": false,
23014
23463
  "create": false,
@@ -23024,6 +23473,8 @@
23024
23473
  "description": "The set of labels present on this ticket_tracking_system.",
23025
23474
  "title": "Labels",
23026
23475
  "x-displayname": "Labels",
23476
+ "x-f5xc-example": "{\"key\": \"value\"}",
23477
+ "x-f5xc-description-short": "The set of labels present on this ticket_tracking_system.",
23027
23478
  "x-f5xc-required-for": {
23028
23479
  "minimum_config": false,
23029
23480
  "create": false,
@@ -23041,6 +23492,7 @@
23041
23492
  "x-displayname": "Name",
23042
23493
  "x-ves-example": "Name",
23043
23494
  "x-f5xc-example": "name",
23495
+ "x-f5xc-description-short": "The name of this ticket_tracking_system.",
23044
23496
  "minLength": 0,
23045
23497
  "maxLength": 16,
23046
23498
  "x-f5xc-required-for": {
@@ -23051,7 +23503,7 @@
23051
23503
  },
23052
23504
  "x-original-maxLength": 1024,
23053
23505
  "x-reconciled-from-discovery": true,
23054
- "x-reconciled-at": "2026-01-05T18:30:04.235209+00:00"
23506
+ "x-reconciled-at": "2026-01-07T15:29:34.083518+00:00"
23055
23507
  },
23056
23508
  "namespace": {
23057
23509
  "type": "string",
@@ -23070,7 +23522,7 @@
23070
23522
  },
23071
23523
  "x-original-maxLength": 1024,
23072
23524
  "x-reconciled-from-discovery": true,
23073
- "x-reconciled-at": "2026-01-05T18:30:04.235213+00:00"
23525
+ "x-reconciled-at": "2026-01-07T15:29:34.083523+00:00"
23074
23526
  },
23075
23527
  "owner_view": {
23076
23528
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -23096,7 +23548,7 @@
23096
23548
  "x-field-mutability": "read-only",
23097
23549
  "x-original-maxLength": 1024,
23098
23550
  "x-reconciled-from-discovery": true,
23099
- "x-reconciled-at": "2026-01-05T18:30:04.235219+00:00"
23551
+ "x-reconciled-at": "2026-01-07T15:29:34.083529+00:00"
23100
23552
  },
23101
23553
  "uid": {
23102
23554
  "type": "string",
@@ -23105,6 +23557,7 @@
23105
23557
  "x-displayname": "UID",
23106
23558
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
23107
23559
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
23560
+ "x-f5xc-description-short": "The unique uid of this ticket_tracking_system.",
23108
23561
  "minLength": 0,
23109
23562
  "maxLength": 36,
23110
23563
  "x-f5xc-required-for": {
@@ -23117,9 +23570,11 @@
23117
23570
  "x-original-maxLength": 1024,
23118
23571
  "format": "uuid",
23119
23572
  "x-reconciled-from-discovery": true,
23120
- "x-reconciled-at": "2026-01-05T18:30:04.235224+00:00"
23573
+ "x-reconciled-at": "2026-01-07T15:29:34.083535+00:00"
23121
23574
  }
23122
23575
  },
23576
+ "x-f5xc-description-short": "By default a summary of ticket_tracking_system is returned in 'List'.",
23577
+ "x-f5xc-description-medium": "By default a summary of ticket_tracking_system is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
23123
23578
  "x-f5xc-minimum-configuration": {
23124
23579
  "description": "Minimum configuration for ticket_tracking_systemListResponseItem",
23125
23580
  "required_fields": [
@@ -23195,6 +23650,7 @@
23195
23650
  "$ref": "#/components/schemas/ticket_tracking_systemJiraConfigurationType"
23196
23651
  }
23197
23652
  },
23653
+ "x-f5xc-description-short": "Replaces attributes of a Ticket Tracking System.",
23198
23654
  "x-f5xc-minimum-configuration": {
23199
23655
  "description": "Minimum configuration for ticket_tracking_systemReplaceSpecType",
23200
23656
  "required_fields": [
@@ -23219,6 +23675,8 @@
23219
23675
  "$ref": "#/components/schemas/ticket_tracking_systemJiraConfigurationType"
23220
23676
  }
23221
23677
  },
23678
+ "x-f5xc-description-short": "Request message when validating a Ticket Tracking System's credentials / organization through the custom API.",
23679
+ "x-f5xc-description-medium": "Request message when validating a Ticket Tracking System's credentials / organization through the custom API.",
23222
23680
  "x-f5xc-minimum-configuration": {
23223
23681
  "description": "Minimum configuration for ticket_tracking_systemValidateTicketTrackingSystemRequest",
23224
23682
  "required_fields": [
@@ -23246,6 +23704,8 @@
23246
23704
  "$ref": "#/components/schemas/schemaErrorType"
23247
23705
  },
23248
23706
  "x-displayname": "Errors",
23707
+ "x-f5xc-description-short": "Errors related to ticket tracking system creation - such as issues with validation of credentials + organization domain.",
23708
+ "x-f5xc-description-medium": "Errors related to ticket tracking system creation - such as issues with validation of credentials + organization domain.",
23249
23709
  "x-f5xc-required-for": {
23250
23710
  "minimum_config": false,
23251
23711
  "create": false,
@@ -23254,6 +23714,8 @@
23254
23714
  }
23255
23715
  }
23256
23716
  },
23717
+ "x-f5xc-description-short": "Response message when validating a Ticket Tracking System's credentials / organization through the custom API Empty errors means the validation...",
23718
+ "x-f5xc-description-medium": "Response message when validating a Ticket Tracking System's credentials / organization through the custom API Empty errors means the validation succeeded.",
23257
23719
  "x-f5xc-minimum-configuration": {
23258
23720
  "description": "Minimum configuration for ticket_tracking_systemValidateTicketTrackingSystemResponse",
23259
23721
  "required_fields": [
@@ -23280,6 +23742,7 @@
23280
23742
  "x-displayname": "Namespace",
23281
23743
  "x-ves-example": "Value",
23282
23744
  "x-f5xc-example": "value",
23745
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
23283
23746
  "minLength": 0,
23284
23747
  "maxLength": 6,
23285
23748
  "x-f5xc-required-for": {
@@ -23290,7 +23753,7 @@
23290
23753
  },
23291
23754
  "x-original-maxLength": 1024,
23292
23755
  "x-reconciled-from-discovery": true,
23293
- "x-reconciled-at": "2026-01-05T18:30:06.258780+00:00"
23756
+ "x-reconciled-at": "2026-01-07T15:29:36.624611+00:00"
23294
23757
  },
23295
23758
  "node": {
23296
23759
  "type": "string",
@@ -23316,6 +23779,7 @@
23316
23779
  "$ref": "#/components/schemas/usb_policyRule"
23317
23780
  },
23318
23781
  "x-displayname": "USB Enablement Rules.",
23782
+ "x-f5xc-example": "{\"key\": \"value\"}",
23319
23783
  "x-f5xc-required-for": {
23320
23784
  "minimum_config": false,
23321
23785
  "create": false,
@@ -23370,6 +23834,7 @@
23370
23834
  "$ref": "#/components/schemas/usb_policyRule"
23371
23835
  },
23372
23836
  "x-displayname": "USB Enablement Rules.",
23837
+ "x-f5xc-example": "{\"key\": \"value\"}",
23373
23838
  "x-f5xc-required-for": {
23374
23839
  "minimum_config": false,
23375
23840
  "create": false,
@@ -23404,6 +23869,7 @@
23404
23869
  "format": "boolean",
23405
23870
  "x-displayname": "USB Allow List Enable.",
23406
23871
  "x-f5xc-example": "false",
23872
+ "x-f5xc-description-short": "Enablement of USB rules list. If enabled, all new connected USB devices must be authorized.",
23407
23873
  "x-f5xc-required-for": {
23408
23874
  "minimum_config": false,
23409
23875
  "create": false,
@@ -23438,6 +23904,7 @@
23438
23904
  "x-displayname": "Namespace",
23439
23905
  "x-ves-example": "Value",
23440
23906
  "x-f5xc-example": "value",
23907
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
23441
23908
  "minLength": 0,
23442
23909
  "maxLength": 6,
23443
23910
  "x-f5xc-required-for": {
@@ -23448,7 +23915,7 @@
23448
23915
  },
23449
23916
  "x-original-maxLength": 1024,
23450
23917
  "x-reconciled-from-discovery": true,
23451
- "x-reconciled-at": "2026-01-05T18:30:06.258793+00:00"
23918
+ "x-reconciled-at": "2026-01-07T15:29:36.624626+00:00"
23452
23919
  },
23453
23920
  "node": {
23454
23921
  "type": "string",
@@ -23474,6 +23941,7 @@
23474
23941
  "$ref": "#/components/schemas/usb_policyRule"
23475
23942
  },
23476
23943
  "x-displayname": "USB Enablement Rules.",
23944
+ "x-f5xc-example": "{\"key\": \"value\"}",
23477
23945
  "x-f5xc-required-for": {
23478
23946
  "minimum_config": false,
23479
23947
  "create": false,
@@ -23528,6 +23996,7 @@
23528
23996
  "$ref": "#/components/schemas/usb_policyRule"
23529
23997
  },
23530
23998
  "x-displayname": "USB Enablement Rules.",
23999
+ "x-f5xc-example": "{\"key\": \"value\"}",
23531
24000
  "x-f5xc-required-for": {
23532
24001
  "minimum_config": false,
23533
24002
  "create": false,
@@ -23536,6 +24005,7 @@
23536
24005
  }
23537
24006
  }
23538
24007
  },
24008
+ "x-f5xc-description-short": "Response to DELETE USB Enablement Rules.",
23539
24009
  "x-f5xc-minimum-configuration": {
23540
24010
  "description": "Minimum configuration for usbUsbDeleteRulesResponse",
23541
24011
  "required_fields": [
@@ -23585,6 +24055,7 @@
23585
24055
  "x-displayname": "Namespace",
23586
24056
  "x-ves-example": "Value",
23587
24057
  "x-f5xc-example": "value",
24058
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
23588
24059
  "minLength": 0,
23589
24060
  "maxLength": 6,
23590
24061
  "x-f5xc-required-for": {
@@ -23595,7 +24066,7 @@
23595
24066
  },
23596
24067
  "x-original-maxLength": 1024,
23597
24068
  "x-reconciled-from-discovery": true,
23598
- "x-reconciled-at": "2026-01-05T18:30:06.258806+00:00"
24069
+ "x-reconciled-at": "2026-01-07T15:29:36.624640+00:00"
23599
24070
  },
23600
24071
  "node": {
23601
24072
  "type": "string",
@@ -23675,6 +24146,7 @@
23675
24146
  "$ref": "#/components/schemas/usb_policyRule"
23676
24147
  },
23677
24148
  "x-displayname": "USB Enablement Rule.",
24149
+ "x-f5xc-example": "{\"key\": \"value\"}",
23678
24150
  "x-f5xc-required-for": {
23679
24151
  "minimum_config": false,
23680
24152
  "create": false,
@@ -23712,6 +24184,7 @@
23712
24184
  "x-displayname": "Namespace",
23713
24185
  "x-ves-example": "Value",
23714
24186
  "x-f5xc-example": "value",
24187
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
23715
24188
  "minLength": 0,
23716
24189
  "maxLength": 6,
23717
24190
  "x-f5xc-required-for": {
@@ -23722,7 +24195,7 @@
23722
24195
  },
23723
24196
  "x-original-maxLength": 1024,
23724
24197
  "x-reconciled-from-discovery": true,
23725
- "x-reconciled-at": "2026-01-05T18:30:06.258817+00:00"
24198
+ "x-reconciled-at": "2026-01-07T15:29:36.624651+00:00"
23726
24199
  },
23727
24200
  "node": {
23728
24201
  "type": "string",
@@ -23818,6 +24291,7 @@
23818
24291
  "x-displayname": "Protocol",
23819
24292
  "x-ves-example": "0002",
23820
24293
  "x-f5xc-example": "0002",
24294
+ "x-f5xc-description-short": "The protocol (within the sub-class) of this device.",
23821
24295
  "minLength": 0,
23822
24296
  "maxLength": 1024,
23823
24297
  "x-f5xc-required-for": {
@@ -23834,6 +24308,7 @@
23834
24308
  "x-displayname": "Subclass",
23835
24309
  "x-ves-example": "Hub",
23836
24310
  "x-f5xc-example": "hub",
24311
+ "x-f5xc-description-short": "The sub-class (within the class) of this device.",
23837
24312
  "minLength": 0,
23838
24313
  "maxLength": 1024,
23839
24314
  "x-f5xc-required-for": {
@@ -23850,6 +24325,7 @@
23850
24325
  "x-displayname": "ISerialNumber.",
23851
24326
  "x-ves-example": "0000:00:14.0.",
23852
24327
  "x-f5xc-example": "0000:00:14.0",
24328
+ "x-f5xc-description-short": "Index of Serial Number String Descriptor.",
23853
24329
  "minLength": 0,
23854
24330
  "maxLength": 1024,
23855
24331
  "x-f5xc-required-for": {
@@ -23866,6 +24342,7 @@
23866
24342
  "x-displayname": "Product ID.",
23867
24343
  "x-ves-example": "0x0002",
23868
24344
  "x-f5xc-example": "0x0002",
24345
+ "x-f5xc-description-short": "Product ID (Assigned by Manufacturer) in hex.",
23869
24346
  "minLength": 0,
23870
24347
  "maxLength": 1024,
23871
24348
  "x-f5xc-required-for": {
@@ -23923,6 +24400,8 @@
23923
24400
  "default": "UNAVAILABLE",
23924
24401
  "x-displayname": "Signal Strength.",
23925
24402
  "x-ves-proto-enum": "ves.io.schema.operate.wifi.SignalStrength",
24403
+ "x-f5xc-description-short": "Current Signal Strength - UNAVAILABLE: UNAVAILABLE Signal not received - EXCELLENT: EXCELLENT dBm greater then -50 - GOOD: GOOD dBm between -50...",
24404
+ "x-f5xc-description-medium": "Current Signal Strength - UNAVAILABLE: UNAVAILABLE Signal not received - EXCELLENT: EXCELLENT dBm greater then -50 - GOOD: GOOD dBm between -50 and -60 - FAIR: FAIR dBm between -60 and -70 - POOR: POOR dBm lower then -70.",
23926
24405
  "x-f5xc-minimum-configuration": {
23927
24406
  "description": "Minimum configuration for wifiSignalStrength",
23928
24407
  "required_fields": [],
@@ -23947,6 +24426,8 @@
23947
24426
  "x-displayname": "BSSID",
23948
24427
  "x-ves-example": "02:18:5a:2e:ef:61.",
23949
24428
  "x-f5xc-example": "02:18:5a:2e:ef:61",
24429
+ "x-f5xc-description-short": "The BSS service set identifier. In infrastructure mode, this is the hardware address of the wireless access point that a client is associated with.",
24430
+ "x-f5xc-description-medium": "The BSS service set identifier. In infrastructure mode, this is the hardware address of the wireless access point that a client is associated with.",
23950
24431
  "minLength": 0,
23951
24432
  "maxLength": 1024,
23952
24433
  "x-f5xc-required-for": {
@@ -23964,6 +24445,7 @@
23964
24445
  "x-displayname": "Connected",
23965
24446
  "x-ves-example": "True",
23966
24447
  "x-f5xc-example": "true",
24448
+ "x-f5xc-description-short": "Whether the device is connected to wifi.",
23967
24449
  "x-f5xc-required-for": {
23968
24450
  "minimum_config": false,
23969
24451
  "create": false,
@@ -23996,6 +24478,7 @@
23996
24478
  "x-displayname": "Receive bitrate.",
23997
24479
  "x-ves-example": "702000000",
23998
24480
  "x-f5xc-example": "702000000",
24481
+ "x-f5xc-description-short": "The current data receive bitrate, in bits/second.",
23999
24482
  "minimum": 0,
24000
24483
  "maximum": 2147483647,
24001
24484
  "x-f5xc-required-for": {
@@ -24013,6 +24496,7 @@
24013
24496
  "x-displayname": "Signal",
24014
24497
  "x-ves-example": "-53",
24015
24498
  "x-f5xc-example": "-53",
24499
+ "x-f5xc-description-short": "The signal strength of this station's connection, in dBm.",
24016
24500
  "minimum": 0,
24017
24501
  "maximum": 2147483647,
24018
24502
  "x-f5xc-required-for": {
@@ -24032,6 +24516,7 @@
24032
24516
  "x-displayname": "SSID",
24033
24517
  "x-ves-example": "F5 Distributed Cloud-Guest.",
24034
24518
  "x-f5xc-example": "F5 Distributed Cloud-Guest",
24519
+ "x-f5xc-description-short": "The service set identifier, or \"network name\" of the BSS.",
24035
24520
  "minLength": 0,
24036
24521
  "maxLength": 1024,
24037
24522
  "x-f5xc-required-for": {
@@ -24049,6 +24534,7 @@
24049
24534
  "x-displayname": "Transmit bitrate.",
24050
24535
  "x-ves-example": "866700000",
24051
24536
  "x-f5xc-example": "866700000",
24537
+ "x-f5xc-description-short": "The current data transmit bitrate, in bits/second.",
24052
24538
  "minimum": 0,
24053
24539
  "maximum": 2147483647,
24054
24540
  "x-f5xc-required-for": {
@@ -24096,6 +24582,7 @@
24096
24582
  "x-displayname": "SSID",
24097
24583
  "x-ves-example": "F5 Distributed Cloud-Guest.",
24098
24584
  "x-f5xc-example": "F5 Distributed Cloud-Guest",
24585
+ "x-f5xc-description-short": "The service set identifier, or \"network name\" of the BSS.",
24099
24586
  "minLength": 0,
24100
24587
  "maxLength": 1024,
24101
24588
  "x-f5xc-required-for": {
@@ -24137,6 +24624,7 @@
24137
24624
  "x-displayname": "Namespace",
24138
24625
  "x-ves-example": "Value",
24139
24626
  "x-f5xc-example": "value",
24627
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
24140
24628
  "minLength": 0,
24141
24629
  "maxLength": 6,
24142
24630
  "x-f5xc-required-for": {
@@ -24147,7 +24635,7 @@
24147
24635
  },
24148
24636
  "x-original-maxLength": 1024,
24149
24637
  "x-reconciled-from-discovery": true,
24150
- "x-reconciled-at": "2026-01-05T18:30:13.178126+00:00"
24638
+ "x-reconciled-at": "2026-01-07T15:29:45.467759+00:00"
24151
24639
  },
24152
24640
  "node": {
24153
24641
  "type": "string",
@@ -24246,6 +24734,7 @@
24246
24734
  "$ref": "#/components/schemas/wifiWifi"
24247
24735
  }
24248
24736
  },
24737
+ "x-f5xc-description-short": "Runtime WIFI information obtained from site.",
24249
24738
  "x-f5xc-minimum-configuration": {
24250
24739
  "description": "Minimum configuration for wifiWifiInfoResponse",
24251
24740
  "required_fields": [
@@ -24275,6 +24764,7 @@
24275
24764
  "x-displayname": "SSID",
24276
24765
  "x-ves-example": "F5 Distributed Cloud-Guest.",
24277
24766
  "x-f5xc-example": "F5 Distributed Cloud-Guest",
24767
+ "x-f5xc-description-short": "The service set identifier, or \"network name\" of the BSS.",
24278
24768
  "minLength": 0,
24279
24769
  "maxLength": 1024,
24280
24770
  "x-f5xc-required-for": {
@@ -24313,6 +24803,7 @@
24313
24803
  "$ref": "#/components/schemas/wifiWifiItem"
24314
24804
  },
24315
24805
  "x-displayname": "WIFI item",
24806
+ "x-f5xc-description-short": "List of available WIFI networks to connect from wifi scan.",
24316
24807
  "x-f5xc-required-for": {
24317
24808
  "minimum_config": false,
24318
24809
  "create": false,
@@ -24346,6 +24837,8 @@
24346
24837
  "default": "UNKNOWN",
24347
24838
  "x-displayname": "Wifi Security Mechanism.",
24348
24839
  "x-ves-proto-enum": "ves.io.schema.operate.wifi.WifiSecurity",
24840
+ "x-f5xc-description-short": "WifiSecurity mechanism of authentication - UNKNOWN: UNKNOWN Unknown mechanims is not available to GET - NONE: NONE None represent no...",
24841
+ "x-f5xc-description-medium": "WifiSecurity mechanism of authentication - UNKNOWN: UNKNOWN Unknown mechanims is not available to GET - NONE: NONE None represent no authentication used - WPA2_PERSONAL: WPA2_PERSONAL WPA2 Personal (PSK) passprase should be used for wifi setup - WPA2_ENTERPRISE: WPA2_ENTERPRISE WPA2 Enterprise...",
24349
24842
  "x-f5xc-minimum-configuration": {
24350
24843
  "description": "Minimum configuration for wifiWifiSecurity",
24351
24844
  "required_fields": [],
@@ -24425,6 +24918,7 @@
24425
24918
  "x-displayname": "Namespace",
24426
24919
  "x-ves-example": "Value",
24427
24920
  "x-f5xc-example": "value",
24921
+ "x-f5xc-description-short": "Namespace for which the request is sent (system).",
24428
24922
  "minLength": 0,
24429
24923
  "maxLength": 6,
24430
24924
  "x-f5xc-required-for": {
@@ -24435,7 +24929,7 @@
24435
24929
  },
24436
24930
  "x-original-maxLength": 1024,
24437
24931
  "x-reconciled-from-discovery": true,
24438
- "x-reconciled-at": "2026-01-05T18:30:13.178148+00:00"
24932
+ "x-reconciled-at": "2026-01-07T15:29:45.467780+00:00"
24439
24933
  },
24440
24934
  "node": {
24441
24935
  "type": "string",