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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/README.md +23 -0
  2. package/dist/config/paths.d.ts.map +1 -1
  3. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  4. package/dist/tools/generated/ce_management/index.js +179 -1582
  5. package/dist/tools/generated/ce_management/index.js.map +1 -1
  6. package/dist/tools/generated/dependency-graph.json +2 -265
  7. package/dist/version.d.ts +2 -2
  8. package/dist/version.js +2 -2
  9. package/manifest.json +1 -1
  10. package/package.json +1 -1
  11. package/specs/domains/admin_console_and_ui.json +111 -25
  12. package/specs/domains/ai_services.json +114 -35
  13. package/specs/domains/api.json +1082 -177
  14. package/specs/domains/authentication.json +205 -45
  15. package/specs/domains/bigip.json +593 -101
  16. package/specs/domains/billing_and_usage.json +440 -82
  17. package/specs/domains/blindfold.json +713 -110
  18. package/specs/domains/bot_and_threat_defense.json +359 -65
  19. package/specs/domains/cdn.json +2131 -194
  20. package/specs/domains/ce_management.json +9110 -15844
  21. package/specs/domains/certificates.json +362 -75
  22. package/specs/domains/cloud_infrastructure.json +802 -119
  23. package/specs/domains/container_services.json +613 -95
  24. package/specs/domains/data_and_privacy_security.json +364 -66
  25. package/specs/domains/data_intelligence.json +324 -63
  26. package/specs/domains/ddos.json +766 -159
  27. package/specs/domains/dns.json +820 -161
  28. package/specs/domains/managed_kubernetes.json +455 -85
  29. package/specs/domains/marketplace.json +670 -104
  30. package/specs/domains/network.json +1620 -238
  31. package/specs/domains/network_security.json +1401 -191
  32. package/specs/domains/nginx_one.json +326 -62
  33. package/specs/domains/object_storage.json +49 -15
  34. package/specs/domains/observability.json +999 -147
  35. package/specs/domains/rate_limiting.json +300 -55
  36. package/specs/domains/secops_and_incident_response.json +189 -36
  37. package/specs/domains/service_mesh.json +955 -124
  38. package/specs/domains/shape.json +2150 -397
  39. package/specs/domains/sites.json +3830 -364
  40. package/specs/domains/statistics.json +2117 -235
  41. package/specs/domains/support.json +602 -108
  42. package/specs/domains/telemetry_and_insights.json +753 -79
  43. package/specs/domains/tenant_and_identity.json +1874 -308
  44. package/specs/domains/threat_campaign.json +637 -71
  45. package/specs/domains/users.json +278 -66
  46. package/specs/domains/virtual.json +2803 -260
  47. package/specs/domains/vpm_and_node_management.json +3 -1
  48. package/specs/domains/waf.json +1125 -148
  49. package/specs/index.json +24 -24
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Marketplace",
5
5
  "description": "External connector infrastructure supporting direct, GRE, and encrypted tunnel modes with IKE parameter configuration and dead peer detection intervals. Cloud provider instances for Terraform automation and vendor partnerships. Service catalog entries with per-namespace activation flags, resource quotas, and administrative dashboard tile arrangement for operational workflows.",
6
- "version": "2.0.13",
6
+ "version": "2.0.20",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -8817,6 +8817,7 @@
8817
8817
  "description": "X-displayName: \"Display Name\"\nDisplay name of the addon service.",
8818
8818
  "title": "Display_name.",
8819
8819
  "x-f5xc-example": "Addon Service 1",
8820
+ "x-f5xc-description-short": "X-displayName: \"Display Name\" Display name of the addon service.",
8820
8821
  "minLength": 0,
8821
8822
  "maxLength": 1024,
8822
8823
  "x-f5xc-required-for": {
@@ -8831,6 +8832,7 @@
8831
8832
  "description": "X-displayName: \"Name\"\nName of the addon_service.",
8832
8833
  "title": "Name",
8833
8834
  "x-f5xc-example": "addon-service-1",
8835
+ "x-f5xc-description-short": "X-displayName: \"Name\" Name of the addon_service.",
8834
8836
  "minLength": 0,
8835
8837
  "maxLength": 16,
8836
8838
  "x-f5xc-required-for": {
@@ -8841,12 +8843,14 @@
8841
8843
  },
8842
8844
  "x-original-maxLength": 1024,
8843
8845
  "x-reconciled-from-discovery": true,
8844
- "x-reconciled-at": "2026-01-05T18:28:39.192988+00:00"
8846
+ "x-reconciled-at": "2026-01-07T15:52:28.237976+00:00"
8845
8847
  },
8846
8848
  "tier": {
8847
8849
  "$ref": "#/components/schemas/schemaAddonServiceTierType"
8848
8850
  }
8849
8851
  },
8852
+ "x-f5xc-description-short": "X-displayName: \"Addon Service Activation Status\" Contains single addon service activation status information.",
8853
+ "x-f5xc-description-medium": "X-displayName: \"Addon Service Activation Status\" Contains single addon service activation status information.",
8850
8854
  "x-f5xc-minimum-configuration": {
8851
8855
  "description": "Minimum configuration for addon_serviceAddonServiceActivationStatus",
8852
8856
  "required_fields": [
@@ -8885,7 +8889,7 @@
8885
8889
  },
8886
8890
  "x-original-maxLength": 1024,
8887
8891
  "x-reconciled-from-discovery": true,
8888
- "x-reconciled-at": "2026-01-05T18:28:39.192998+00:00"
8892
+ "x-reconciled-at": "2026-01-07T15:52:28.237985+00:00"
8889
8893
  },
8890
8894
  "subject": {
8891
8895
  "type": "string",
@@ -8902,6 +8906,7 @@
8902
8906
  }
8903
8907
  }
8904
8908
  },
8909
+ "x-f5xc-description-short": "Content holds the subject and the description.",
8905
8910
  "x-f5xc-minimum-configuration": {
8906
8911
  "description": "Minimum configuration for addon_serviceContent",
8907
8912
  "required_fields": [
@@ -8935,6 +8940,7 @@
8935
8940
  "$ref": "#/components/schemas/addon_serviceContent"
8936
8941
  }
8937
8942
  },
8943
+ "x-f5xc-description-short": "CustomSupportTicket holds the template details provided by the service owner.",
8938
8944
  "x-f5xc-minimum-configuration": {
8939
8945
  "description": "Minimum configuration for addon_serviceCustomSupportTicket",
8940
8946
  "required_fields": [
@@ -8961,6 +8967,7 @@
8961
8967
  "$ref": "#/components/schemas/addon_serviceNotificationPreference"
8962
8968
  }
8963
8969
  },
8970
+ "x-f5xc-description-short": "Managed Activation and require complete manual intervention.",
8964
8971
  "x-f5xc-minimum-configuration": {
8965
8972
  "description": "Minimum configuration for addon_serviceFullyManagedActivationType",
8966
8973
  "required_fields": [
@@ -8984,6 +8991,7 @@
8984
8991
  "$ref": "#/components/schemas/schemaAddonServiceState"
8985
8992
  }
8986
8993
  },
8994
+ "x-f5xc-description-short": "Response shape for addon service activation status.",
8987
8995
  "x-f5xc-minimum-configuration": {
8988
8996
  "description": "Minimum configuration for addon_serviceGetActivationStatusResp",
8989
8997
  "required_fields": [
@@ -9011,6 +9019,7 @@
9011
9019
  "x-displayname": "Addon Service Group Display Name.",
9012
9020
  "x-ves-example": "Addon service group 1.",
9013
9021
  "x-f5xc-example": "addon service group 1",
9022
+ "x-f5xc-description-short": "Display name of the addon service group.",
9014
9023
  "minLength": 0,
9015
9024
  "maxLength": 1024,
9016
9025
  "x-f5xc-required-for": {
@@ -9065,6 +9074,7 @@
9065
9074
  "$ref": "#/components/schemas/schemaAddonServiceTierType"
9066
9075
  }
9067
9076
  },
9077
+ "x-f5xc-description-short": "Response shape for addon service details.",
9068
9078
  "x-f5xc-minimum-configuration": {
9069
9079
  "description": "Minimum configuration for addon_serviceGetAddonServiceDetailsResp",
9070
9080
  "required_fields": [
@@ -9095,6 +9105,7 @@
9095
9105
  "description": "Current state of addon service subscription. The key is the name of the service.",
9096
9106
  "title": "State",
9097
9107
  "x-displayname": "State",
9108
+ "x-f5xc-description-short": "Current state of addon service subscription. The key is the name of the service.",
9098
9109
  "x-f5xc-required-for": {
9099
9110
  "minimum_config": false,
9100
9111
  "create": false,
@@ -9103,6 +9114,7 @@
9103
9114
  }
9104
9115
  }
9105
9116
  },
9117
+ "x-f5xc-description-short": "Response shape for addon service feature tier activation statuses.",
9106
9118
  "x-f5xc-minimum-configuration": {
9107
9119
  "description": "Minimum configuration for addon_serviceGetAllServiceTiersActivationStatusResp",
9108
9120
  "required_fields": [
@@ -9130,6 +9142,7 @@
9130
9142
  "$ref": "#/components/schemas/schemaObjectRefType"
9131
9143
  },
9132
9144
  "x-displayname": "Deleted Referred Objects.",
9145
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
9133
9146
  "x-f5xc-required-for": {
9134
9147
  "minimum_config": false,
9135
9148
  "create": false,
@@ -9145,6 +9158,7 @@
9145
9158
  "$ref": "#/components/schemas/schemaObjectRefType"
9146
9159
  },
9147
9160
  "x-displayname": "Disabled Referred Objects.",
9161
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
9148
9162
  "x-f5xc-required-for": {
9149
9163
  "minimum_config": false,
9150
9164
  "create": false,
@@ -9163,6 +9177,7 @@
9163
9177
  "$ref": "#/components/schemas/schemaObjectRefType"
9164
9178
  },
9165
9179
  "x-displayname": "Referring Objects.",
9180
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
9166
9181
  "x-f5xc-required-for": {
9167
9182
  "minimum_config": false,
9168
9183
  "create": false,
@@ -9181,6 +9196,8 @@
9181
9196
  "$ref": "#/components/schemas/addon_serviceStatusObject"
9182
9197
  },
9183
9198
  "x-displayname": "Status",
9199
+ "x-f5xc-example": "active",
9200
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
9184
9201
  "x-f5xc-required-for": {
9185
9202
  "minimum_config": false,
9186
9203
  "create": false,
@@ -9190,7 +9207,7 @@
9190
9207
  "maxLength": 17,
9191
9208
  "minLength": 17,
9192
9209
  "x-reconciled-from-discovery": true,
9193
- "x-reconciled-at": "2026-01-05T18:28:39.193044+00:00"
9210
+ "x-reconciled-at": "2026-01-07T15:52:28.238021+00:00"
9194
9211
  },
9195
9212
  "system_metadata": {
9196
9213
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -9226,6 +9243,8 @@
9226
9243
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
9227
9244
  ],
9228
9245
  "default": "GET_RSP_FORMAT_DEFAULT",
9246
+ "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...",
9247
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\" Response should be in...",
9229
9248
  "x-f5xc-minimum-configuration": {
9230
9249
  "description": "Minimum configuration for addon_serviceGetResponseFormatCode",
9231
9250
  "required_fields": [],
@@ -9251,6 +9270,7 @@
9251
9270
  "$ref": "#/components/schemas/schemaErrorType"
9252
9271
  },
9253
9272
  "x-displayname": "Errors",
9273
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
9254
9274
  "x-f5xc-required-for": {
9255
9275
  "minimum_config": false,
9256
9276
  "create": false,
@@ -9266,6 +9286,8 @@
9266
9286
  "$ref": "#/components/schemas/addon_serviceListResponseItem"
9267
9287
  },
9268
9288
  "x-displayname": "Items",
9289
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
9290
+ "x-f5xc-description-short": "Items represents the collection in response.",
9269
9291
  "x-f5xc-required-for": {
9270
9292
  "minimum_config": false,
9271
9293
  "create": false,
@@ -9299,6 +9321,8 @@
9299
9321
  "description": "The set of annotations present on this addon_service.",
9300
9322
  "title": "Annotations.",
9301
9323
  "x-displayname": "Annotations.",
9324
+ "x-f5xc-example": "{\"key\": \"value\"}",
9325
+ "x-f5xc-description-short": "The set of annotations present on this addon_service.",
9302
9326
  "x-f5xc-required-for": {
9303
9327
  "minimum_config": false,
9304
9328
  "create": false,
@@ -9311,6 +9335,7 @@
9311
9335
  "description": "The description set for this addon_service.",
9312
9336
  "title": "Description.",
9313
9337
  "x-displayname": "Description.",
9338
+ "x-f5xc-description-short": "The description set for this addon_service.",
9314
9339
  "minLength": 0,
9315
9340
  "maxLength": 0,
9316
9341
  "x-f5xc-required-for": {
@@ -9321,7 +9346,7 @@
9321
9346
  },
9322
9347
  "x-original-maxLength": 1024,
9323
9348
  "x-reconciled-from-discovery": true,
9324
- "x-reconciled-at": "2026-01-05T18:28:39.193058+00:00"
9349
+ "x-reconciled-at": "2026-01-07T15:52:28.238033+00:00"
9325
9350
  },
9326
9351
  "disabled": {
9327
9352
  "type": "boolean",
@@ -9329,6 +9354,8 @@
9329
9354
  "title": "Disabled",
9330
9355
  "format": "boolean",
9331
9356
  "x-displayname": "Disabled",
9357
+ "x-f5xc-example": "True",
9358
+ "x-f5xc-description-short": "Value of true indicates addon_service is administratively disabled.",
9332
9359
  "x-f5xc-required-for": {
9333
9360
  "minimum_config": false,
9334
9361
  "create": false,
@@ -9344,6 +9371,8 @@
9344
9371
  "description": "The set of labels present on this addon_service.",
9345
9372
  "title": "Labels",
9346
9373
  "x-displayname": "Labels",
9374
+ "x-f5xc-example": "{\"key\": \"value\"}",
9375
+ "x-f5xc-description-short": "The set of labels present on this addon_service.",
9347
9376
  "x-f5xc-required-for": {
9348
9377
  "minimum_config": false,
9349
9378
  "create": false,
@@ -9371,7 +9400,7 @@
9371
9400
  },
9372
9401
  "x-original-maxLength": 1024,
9373
9402
  "x-reconciled-from-discovery": true,
9374
- "x-reconciled-at": "2026-01-05T18:28:39.193068+00:00"
9403
+ "x-reconciled-at": "2026-01-07T15:52:28.238043+00:00"
9375
9404
  },
9376
9405
  "namespace": {
9377
9406
  "type": "string",
@@ -9390,7 +9419,7 @@
9390
9419
  },
9391
9420
  "x-original-maxLength": 1024,
9392
9421
  "x-reconciled-from-discovery": true,
9393
- "x-reconciled-at": "2026-01-05T18:28:39.193073+00:00"
9422
+ "x-reconciled-at": "2026-01-07T15:52:28.238048+00:00"
9394
9423
  },
9395
9424
  "owner_view": {
9396
9425
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -9403,6 +9432,7 @@
9403
9432
  "$ref": "#/components/schemas/addon_serviceStatusObject"
9404
9433
  },
9405
9434
  "x-displayname": "Status",
9435
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
9406
9436
  "x-f5xc-required-for": {
9407
9437
  "minimum_config": false,
9408
9438
  "create": false,
@@ -9431,7 +9461,7 @@
9431
9461
  "x-field-mutability": "read-only",
9432
9462
  "x-original-maxLength": 1024,
9433
9463
  "x-reconciled-from-discovery": true,
9434
- "x-reconciled-at": "2026-01-05T18:28:39.193081+00:00"
9464
+ "x-reconciled-at": "2026-01-07T15:52:28.238056+00:00"
9435
9465
  },
9436
9466
  "uid": {
9437
9467
  "type": "string",
@@ -9452,9 +9482,11 @@
9452
9482
  "x-original-maxLength": 1024,
9453
9483
  "format": "uuid",
9454
9484
  "x-reconciled-from-discovery": true,
9455
- "x-reconciled-at": "2026-01-05T18:28:39.193087+00:00"
9485
+ "x-reconciled-at": "2026-01-07T15:52:28.238061+00:00"
9456
9486
  }
9457
9487
  },
9488
+ "x-f5xc-description-short": "By default a summary of addon_service is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
9489
+ "x-f5xc-description-medium": "By default a summary of addon_service is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
9458
9490
  "x-f5xc-minimum-configuration": {
9459
9491
  "description": "Minimum configuration for addon_serviceListResponseItem",
9460
9492
  "required_fields": [
@@ -9494,6 +9526,7 @@
9494
9526
  "$ref": "#/components/schemas/addon_serviceSupportTicketOptions"
9495
9527
  }
9496
9528
  },
9529
+ "x-f5xc-description-short": "NotificationPreference preference for receiving addon subscription notifications.",
9497
9530
  "x-f5xc-minimum-configuration": {
9498
9531
  "description": "Minimum configuration for addon_serviceNotificationPreference",
9499
9532
  "required_fields": [
@@ -9513,6 +9546,7 @@
9513
9546
  "title": "PartiallyManagedActivationType.",
9514
9547
  "x-displayname": "Partially Managed Activation.",
9515
9548
  "x-ves-proto-message": "ves.io.schema.pbac.addon_service.PartiallyManagedActivationType",
9549
+ "x-f5xc-description-short": "Addon service activation will require partial management from backend or SRE.",
9516
9550
  "x-f5xc-minimum-configuration": {
9517
9551
  "description": "Minimum configuration for addon_servicePartiallyManagedActivationType",
9518
9552
  "required_fields": [],
@@ -9545,6 +9579,9 @@
9545
9579
  "ves.io.schema.rules.message.required": "true",
9546
9580
  "ves.io.schema.rules.string.max_len": "32"
9547
9581
  },
9582
+ "x-f5xc-example": "example-resource",
9583
+ "x-f5xc-description-short": "Default landing page for the addon service after successful subscription. Value should match name of the navigation tile config object.",
9584
+ "x-f5xc-description-medium": "Default landing page for the addon service after successful subscription. Value should match name of the navigation tile config object. Required: YES.",
9548
9585
  "minLength": 0,
9549
9586
  "x-f5xc-required-for": {
9550
9587
  "minimum_config": false,
@@ -9554,6 +9591,7 @@
9554
9591
  }
9555
9592
  }
9556
9593
  },
9594
+ "x-f5xc-description-short": "Addon service can be subscribed and activated by user directly without any manual intervention.",
9557
9595
  "x-f5xc-minimum-configuration": {
9558
9596
  "description": "Minimum configuration for addon_serviceSelfActivationType",
9559
9597
  "required_fields": [
@@ -9607,6 +9645,7 @@
9607
9645
  }
9608
9646
  }
9609
9647
  },
9648
+ "x-f5xc-description-short": "Most recently observed status of object.",
9610
9649
  "x-f5xc-minimum-configuration": {
9611
9650
  "description": "Minimum configuration for addon_serviceStatusObject",
9612
9651
  "required_fields": [
@@ -9639,6 +9678,7 @@
9639
9678
  "$ref": "#/components/schemas/ioschemaEmpty"
9640
9679
  }
9641
9680
  },
9681
+ "x-f5xc-description-short": "SupportTicketOptions deals with whether the support ticket needs to be created.",
9642
9682
  "x-f5xc-minimum-configuration": {
9643
9683
  "description": "Minimum configuration for addon_serviceSupportTicketOptions",
9644
9684
  "required_fields": [
@@ -9690,6 +9730,8 @@
9690
9730
  "default": "SS_UNKNOWN",
9691
9731
  "x-displayname": "Support Service.",
9692
9732
  "x-ves-proto-enum": "ves.io.schema.customer_support.SupportService",
9733
+ "x-f5xc-description-short": "Indicates the list of support service Unknown Support Service Account Protection Support Service Administration Support Service Application...",
9734
+ "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...",
9693
9735
  "x-f5xc-minimum-configuration": {
9694
9736
  "description": "Minimum configuration for customer_supportSupportService",
9695
9737
  "required_fields": [],
@@ -9713,6 +9755,8 @@
9713
9755
  "default": "PRIORITY_UNKNOWN",
9714
9756
  "x-displayname": "Priority",
9715
9757
  "x-ves-proto-enum": "ves.io.schema.customer_support.SupportTicketPriority",
9758
+ "x-f5xc-description-short": "Support ticket priority helps understand importance of the ticket and focus more on more critical issues.",
9759
+ "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.",
9716
9760
  "x-f5xc-minimum-configuration": {
9717
9761
  "description": "Minimum configuration for customer_supportSupportTicketPriority",
9718
9762
  "required_fields": [],
@@ -9729,6 +9773,7 @@
9729
9773
  "title": "Empty",
9730
9774
  "x-displayname": "Empty",
9731
9775
  "x-ves-proto-message": "ves.io.schema.Empty",
9776
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
9732
9777
  "x-f5xc-minimum-configuration": {
9733
9778
  "description": "Minimum configuration for ioschemaEmpty",
9734
9779
  "required_fields": [],
@@ -9764,6 +9809,7 @@
9764
9809
  "ves.io.schema.rules.repeated.items.string.email": "true",
9765
9810
  "ves.io.schema.rules.repeated.unique": "true"
9766
9811
  },
9812
+ "x-f5xc-description-short": "Email IDs associated with the Addon Subscription.",
9767
9813
  "x-f5xc-required-for": {
9768
9814
  "minimum_config": false,
9769
9815
  "create": false,
@@ -9773,6 +9819,7 @@
9773
9819
  "x-field-mutability": "read-only"
9774
9820
  }
9775
9821
  },
9822
+ "x-f5xc-description-short": "Addon Subscription Emails associated with the Addon Subscription.",
9776
9823
  "x-f5xc-minimum-configuration": {
9777
9824
  "description": "Minimum configuration for pbacEmailDL",
9778
9825
  "required_fields": [
@@ -9808,6 +9855,8 @@
9808
9855
  "x-validation-rules": {
9809
9856
  "ves.io.schema.rules.repeated.max_items": "32"
9810
9857
  },
9858
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
9859
+ "x-f5xc-description-short": "List of references to all api_group objects that belong to this addon service.",
9811
9860
  "x-f5xc-required-for": {
9812
9861
  "minimum_config": false,
9813
9862
  "create": false,
@@ -9832,6 +9881,8 @@
9832
9881
  "ves.io.schema.rules.repeated.max_items": "32",
9833
9882
  "ves.io.schema.rules.repeated.unique": "true"
9834
9883
  },
9884
+ "x-f5xc-description-short": "List of addon services this service dependent on. To subscribe/enable this service, all of dependent service should be enabled.",
9885
+ "x-f5xc-description-medium": "List of addon services this service dependent on. To subscribe/enable this service, all of dependent service should be enabled.",
9835
9886
  "x-f5xc-required-for": {
9836
9887
  "minimum_config": false,
9837
9888
  "create": false,
@@ -9854,6 +9905,7 @@
9854
9905
  "ves.io.schema.rules.string.max_len": "512"
9855
9906
  },
9856
9907
  "x-f5xc-example": "example-resource",
9908
+ "x-f5xc-description-short": "User friendly name for display purpose. Required: YES.",
9857
9909
  "minLength": 0,
9858
9910
  "x-f5xc-required-for": {
9859
9911
  "minimum_config": false,
@@ -9878,6 +9930,7 @@
9878
9930
  "ves.io.schema.rules.repeated.max_items": "32",
9879
9931
  "ves.io.schema.rules.repeated.unique": "true"
9880
9932
  },
9933
+ "x-f5xc-description-short": "List of additional addon services automatically subscribed part of this subscription.",
9881
9934
  "x-f5xc-required-for": {
9882
9935
  "minimum_config": false,
9883
9936
  "create": false,
@@ -9901,6 +9954,8 @@
9901
9954
  "$ref": "#/components/schemas/schemaFeatureTag"
9902
9955
  },
9903
9956
  "x-displayname": "Feature tag.",
9957
+ "x-f5xc-example": "{\"key\": \"value\"}",
9958
+ "x-f5xc-description-short": "Feature tag can flag an addon service as a feature (preview, new, beta, etc) and their combination.",
9904
9959
  "x-f5xc-required-for": {
9905
9960
  "minimum_config": false,
9906
9961
  "create": false,
@@ -9912,6 +9967,7 @@
9912
9967
  "$ref": "#/components/schemas/schemaAddonServiceTierType"
9913
9968
  }
9914
9969
  },
9970
+ "x-f5xc-description-short": "GET addon_service reads a given object from storage backend for metadata.namespace.",
9915
9971
  "x-f5xc-minimum-configuration": {
9916
9972
  "description": "Minimum configuration for pbacaddon_serviceGetSpecType",
9917
9973
  "required_fields": [
@@ -9939,6 +9995,8 @@
9939
9995
  "type_url": {
9940
9996
  "type": "string",
9941
9997
  "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.",
9998
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
9999
+ "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 ).",
9942
10000
  "minLength": 0,
9943
10001
  "maxLength": 1024,
9944
10002
  "x-f5xc-required-for": {
@@ -9962,9 +10020,11 @@
9962
10020
  },
9963
10021
  "x-original-maxLength": 1024,
9964
10022
  "x-reconciled-from-discovery": true,
9965
- "x-reconciled-at": "2026-01-05T18:28:39.193122+00:00"
10023
+ "x-reconciled-at": "2026-01-07T15:52:28.238096+00:00"
9966
10024
  }
9967
10025
  },
10026
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
10027
+ "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...",
9968
10028
  "x-f5xc-minimum-configuration": {
9969
10029
  "description": "Minimum configuration for protobufAny",
9970
10030
  "required_fields": [
@@ -9991,6 +10051,8 @@
9991
10051
  "AS_AC_PBAC_DENY_AS_AC_EOL"
9992
10052
  ],
9993
10053
  "default": "AS_AC_NONE",
10054
+ "x-f5xc-description-short": "X-displayName: \"Addon Service Access\" State of access into service - AS_AC_NONE: x-displayName: \"None\" default state This can mean that addon...",
10055
+ "x-f5xc-description-medium": "X-displayName: \"Addon Service Access\" State of access into service - AS_AC_NONE: x-displayName: \"None\" default state This can mean that addon service is not subscribed or is in pending subscription. - AS_AC_ALLOWED: x-displayName: \"Allow\" access is allowed - AS_AC_PBAC_DENY: x-displayName: \"PBAC...",
9994
10056
  "x-f5xc-minimum-configuration": {
9995
10057
  "description": "Minimum configuration for schemaAddonServiceAccess",
9996
10058
  "required_fields": [],
@@ -10014,6 +10076,8 @@
10014
10076
  "default": "AS_NONE",
10015
10077
  "x-displayname": "Addon Service State.",
10016
10078
  "x-ves-proto-enum": "ves.io.schema.AddonServiceState",
10079
+ "x-f5xc-description-short": "State of a service default state initiated subscription request and is pending to activate (requested).",
10080
+ "x-f5xc-description-medium": "State of a service default state initiated subscription request and is pending to activate (requested). Successfully subscribed service subscription request ended up in error state.",
10017
10081
  "x-f5xc-minimum-configuration": {
10018
10082
  "description": "Minimum configuration for schemaAddonServiceState",
10019
10083
  "required_fields": [],
@@ -10038,6 +10102,8 @@
10038
10102
  "default": "NO_TIER",
10039
10103
  "x-displayname": "Addon Service Tier.",
10040
10104
  "x-ves-proto-enum": "ves.io.schema.AddonServiceTierType",
10105
+ "x-f5xc-description-short": "AddonServiceTierType is for identifying the tier of an addon service - NO_TIER: none when tier is not applicable for a addon service - BASIC...",
10106
+ "x-f5xc-description-medium": "AddonServiceTierType is for identifying the tier of an addon service - NO_TIER: none when tier is not applicable for a addon service - BASIC: basic basic - STANDARD: standard standard - ADVANCED: advanced advanced - PREMIUM: premium premium.",
10041
10107
  "x-f5xc-minimum-configuration": {
10042
10108
  "description": "Minimum configuration for schemaAddonServiceTierType",
10043
10109
  "required_fields": [],
@@ -10060,6 +10126,8 @@
10060
10126
  "description": "Hostname of the instance of the site that sent the status.",
10061
10127
  "title": "Hostname",
10062
10128
  "x-displayname": "Hostname",
10129
+ "x-f5xc-example": "example-resource",
10130
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
10063
10131
  "minLength": 0,
10064
10132
  "maxLength": 1024,
10065
10133
  "x-f5xc-required-for": {
@@ -10091,6 +10159,8 @@
10091
10159
  "x-displayname": "Reason",
10092
10160
  "x-ves-example": "Value",
10093
10161
  "x-f5xc-example": "value",
10162
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
10163
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
10094
10164
  "minLength": 0,
10095
10165
  "maxLength": 43,
10096
10166
  "x-f5xc-required-for": {
@@ -10101,13 +10171,15 @@
10101
10171
  },
10102
10172
  "x-original-maxLength": 1024,
10103
10173
  "x-reconciled-from-discovery": true,
10104
- "x-reconciled-at": "2026-01-05T18:28:39.193132+00:00"
10174
+ "x-reconciled-at": "2026-01-07T15:52:28.238105+00:00"
10105
10175
  },
10106
10176
  "service_name": {
10107
10177
  "type": "string",
10108
10178
  "description": "Name of the service that sent the status.",
10109
10179
  "title": "Service name.",
10110
10180
  "x-displayname": "Service Name.",
10181
+ "x-f5xc-example": "example-resource",
10182
+ "x-f5xc-description-short": "Name of the service that sent the status.",
10111
10183
  "minLength": 0,
10112
10184
  "maxLength": 1024,
10113
10185
  "x-f5xc-required-for": {
@@ -10130,6 +10202,8 @@
10130
10202
  "x-validation-rules": {
10131
10203
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
10132
10204
  },
10205
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
10206
+ "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...",
10133
10207
  "minLength": 0,
10134
10208
  "maxLength": 17,
10135
10209
  "x-f5xc-required-for": {
@@ -10140,7 +10214,7 @@
10140
10214
  },
10141
10215
  "x-original-maxLength": 1024,
10142
10216
  "x-reconciled-from-discovery": true,
10143
- "x-reconciled-at": "2026-01-05T18:28:39.193138+00:00"
10217
+ "x-reconciled-at": "2026-01-07T15:52:28.238111+00:00"
10144
10218
  },
10145
10219
  "type": {
10146
10220
  "type": "string",
@@ -10155,6 +10229,8 @@
10155
10229
  "x-validation-rules": {
10156
10230
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
10157
10231
  },
10232
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
10233
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
10158
10234
  "minLength": 0,
10159
10235
  "maxLength": 1024,
10160
10236
  "x-f5xc-required-for": {
@@ -10165,6 +10241,8 @@
10165
10241
  }
10166
10242
  }
10167
10243
  },
10244
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
10245
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
10168
10246
  "x-f5xc-minimum-configuration": {
10169
10247
  "description": "Minimum configuration for schemaConditionType",
10170
10248
  "required_fields": [
@@ -10200,6 +10278,8 @@
10200
10278
  "default": "EOK",
10201
10279
  "x-displayname": "Error Code.",
10202
10280
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
10281
+ "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...",
10282
+ "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...",
10203
10283
  "x-f5xc-minimum-configuration": {
10204
10284
  "description": "Minimum configuration for schemaErrorCode",
10205
10285
  "required_fields": [],
@@ -10240,6 +10320,7 @@
10240
10320
  }
10241
10321
  }
10242
10322
  },
10323
+ "x-f5xc-description-short": "Information about a error in API operation.",
10243
10324
  "x-f5xc-minimum-configuration": {
10244
10325
  "description": "Minimum configuration for schemaErrorType",
10245
10326
  "required_fields": [
@@ -10267,6 +10348,8 @@
10267
10348
  "default": "NONE",
10268
10349
  "x-displayname": "Feature Tag.",
10269
10350
  "x-ves-proto-enum": "ves.io.schema.FeatureTag",
10351
+ "x-f5xc-description-short": "FeatureTag is for identifying the tag of feature of an offering (new, preview) Unknown (undefined) feature tag New feature tag Preview feature tag...",
10352
+ "x-f5xc-description-medium": "FeatureTag is for identifying the tag of feature of an offering (new, preview) Unknown (undefined) feature tag New feature tag Preview feature tag Private preview feature tag.",
10270
10353
  "x-f5xc-minimum-configuration": {
10271
10354
  "description": "Minimum configuration for schemaFeatureTag",
10272
10355
  "required_fields": [],
@@ -10290,6 +10373,7 @@
10290
10373
  "title": "Name",
10291
10374
  "x-displayname": "Name",
10292
10375
  "x-f5xc-example": "example-resource",
10376
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
10293
10377
  "minLength": 0,
10294
10378
  "maxLength": 16,
10295
10379
  "x-f5xc-required-for": {
@@ -10300,9 +10384,10 @@
10300
10384
  },
10301
10385
  "x-original-maxLength": 1024,
10302
10386
  "x-reconciled-from-discovery": true,
10303
- "x-reconciled-at": "2026-01-05T18:28:39.193149+00:00"
10387
+ "x-reconciled-at": "2026-01-07T15:52:28.238122+00:00"
10304
10388
  }
10305
10389
  },
10390
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
10306
10391
  "x-f5xc-minimum-configuration": {
10307
10392
  "description": "Minimum configuration for schemaInitializerType",
10308
10393
  "required_fields": [
@@ -10330,6 +10415,8 @@
10330
10415
  "$ref": "#/components/schemas/schemaInitializerType"
10331
10416
  },
10332
10417
  "x-displayname": "Pending",
10418
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
10419
+ "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.",
10333
10420
  "x-f5xc-required-for": {
10334
10421
  "minimum_config": false,
10335
10422
  "create": false,
@@ -10341,6 +10428,7 @@
10341
10428
  "$ref": "#/components/schemas/schemaStatusType"
10342
10429
  }
10343
10430
  },
10431
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
10344
10432
  "x-f5xc-minimum-configuration": {
10345
10433
  "description": "Minimum configuration for schemaInitializersType",
10346
10434
  "required_fields": [
@@ -10380,6 +10468,8 @@
10380
10468
  "ves.io.schema.rules.map.values.string.max_len": "1024",
10381
10469
  "ves.io.schema.rules.map.values.string.min_len": "1"
10382
10470
  },
10471
+ "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.",
10472
+ "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.",
10383
10473
  "x-f5xc-required-for": {
10384
10474
  "minimum_config": false,
10385
10475
  "create": false,
@@ -10401,6 +10491,7 @@
10401
10491
  "x-validation-rules": {
10402
10492
  "ves.io.schema.rules.string.max_bytes": "1200"
10403
10493
  },
10494
+ "x-f5xc-description-short": "Human readable description for the object.",
10404
10495
  "minLength": 0,
10405
10496
  "x-f5xc-required-for": {
10406
10497
  "minimum_config": false,
@@ -10410,7 +10501,7 @@
10410
10501
  },
10411
10502
  "x-original-maxLength": 1200,
10412
10503
  "x-reconciled-from-discovery": true,
10413
- "x-reconciled-at": "2026-01-05T18:28:39.193159+00:00"
10504
+ "x-reconciled-at": "2026-01-07T15:52:28.238132+00:00"
10414
10505
  },
10415
10506
  "disable": {
10416
10507
  "type": "boolean",
@@ -10420,6 +10511,7 @@
10420
10511
  "x-displayname": "Disable",
10421
10512
  "x-ves-example": "True",
10422
10513
  "x-f5xc-example": "true",
10514
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
10423
10515
  "x-f5xc-required-for": {
10424
10516
  "minimum_config": false,
10425
10517
  "create": false,
@@ -10434,6 +10526,8 @@
10434
10526
  "x-displayname": "Labels",
10435
10527
  "x-ves-example": "Value",
10436
10528
  "x-f5xc-example": "value",
10529
+ "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.",
10530
+ "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.",
10437
10531
  "x-f5xc-required-for": {
10438
10532
  "minimum_config": false,
10439
10533
  "create": false,
@@ -10455,6 +10549,8 @@
10455
10549
  "x-validation-rules": {
10456
10550
  "ves.io.schema.rules.message.required": "true"
10457
10551
  },
10552
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
10553
+ "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.",
10458
10554
  "minLength": 0,
10459
10555
  "maxLength": 16,
10460
10556
  "x-f5xc-required-for": {
@@ -10465,7 +10561,7 @@
10465
10561
  },
10466
10562
  "x-original-maxLength": 1024,
10467
10563
  "x-reconciled-from-discovery": true,
10468
- "x-reconciled-at": "2026-01-05T18:28:39.193167+00:00"
10564
+ "x-reconciled-at": "2026-01-07T15:52:28.238140+00:00"
10469
10565
  },
10470
10566
  "namespace": {
10471
10567
  "type": "string",
@@ -10474,6 +10570,8 @@
10474
10570
  "x-displayname": "Namespace",
10475
10571
  "x-ves-example": "Staging",
10476
10572
  "x-f5xc-example": "staging",
10573
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
10574
+ "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 \"\".",
10477
10575
  "minLength": 0,
10478
10576
  "maxLength": 6,
10479
10577
  "x-f5xc-required-for": {
@@ -10484,9 +10582,10 @@
10484
10582
  },
10485
10583
  "x-original-maxLength": 1024,
10486
10584
  "x-reconciled-from-discovery": true,
10487
- "x-reconciled-at": "2026-01-05T18:28:39.193171+00:00"
10585
+ "x-reconciled-at": "2026-01-07T15:52:28.238144+00:00"
10488
10586
  }
10489
10587
  },
10588
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
10490
10589
  "x-f5xc-minimum-configuration": {
10491
10590
  "description": "Minimum configuration for schemaObjectGetMetaType",
10492
10591
  "required_fields": [
@@ -10518,6 +10617,8 @@
10518
10617
  "x-displayname": "Kind",
10519
10618
  "x-ves-example": "Virtual_site.",
10520
10619
  "x-f5xc-example": "virtual_site",
10620
+ "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\")",
10621
+ "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\").",
10521
10622
  "minLength": 0,
10522
10623
  "maxLength": 14,
10523
10624
  "x-f5xc-required-for": {
@@ -10529,7 +10630,7 @@
10529
10630
  "readOnly": true,
10530
10631
  "x-original-maxLength": 1024,
10531
10632
  "x-reconciled-from-discovery": true,
10532
- "x-reconciled-at": "2026-01-05T18:28:39.193176+00:00"
10633
+ "x-reconciled-at": "2026-01-07T15:52:28.238148+00:00"
10533
10634
  },
10534
10635
  "name": {
10535
10636
  "type": "string",
@@ -10538,6 +10639,8 @@
10538
10639
  "x-displayname": "Name",
10539
10640
  "x-ves-example": "Contactus-route.",
10540
10641
  "x-f5xc-example": "contactus-route",
10642
+ "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.",
10643
+ "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.",
10541
10644
  "minLength": 0,
10542
10645
  "maxLength": 16,
10543
10646
  "x-f5xc-required-for": {
@@ -10548,7 +10651,7 @@
10548
10651
  },
10549
10652
  "x-original-maxLength": 1024,
10550
10653
  "x-reconciled-from-discovery": true,
10551
- "x-reconciled-at": "2026-01-05T18:28:39.193180+00:00"
10654
+ "x-reconciled-at": "2026-01-07T15:52:28.238153+00:00"
10552
10655
  },
10553
10656
  "namespace": {
10554
10657
  "type": "string",
@@ -10557,6 +10660,8 @@
10557
10660
  "x-displayname": "Namespace",
10558
10661
  "x-ves-example": "Ns1",
10559
10662
  "x-f5xc-example": "ns1",
10663
+ "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.",
10664
+ "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.",
10560
10665
  "minLength": 0,
10561
10666
  "maxLength": 6,
10562
10667
  "x-f5xc-required-for": {
@@ -10567,7 +10672,7 @@
10567
10672
  },
10568
10673
  "x-original-maxLength": 1024,
10569
10674
  "x-reconciled-from-discovery": true,
10570
- "x-reconciled-at": "2026-01-05T18:28:39.193184+00:00"
10675
+ "x-reconciled-at": "2026-01-07T15:52:28.238157+00:00"
10571
10676
  },
10572
10677
  "tenant": {
10573
10678
  "type": "string",
@@ -10576,6 +10681,8 @@
10576
10681
  "x-displayname": "Tenant",
10577
10682
  "x-ves-example": "Example-corp.",
10578
10683
  "x-f5xc-example": "example-corp",
10684
+ "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.",
10685
+ "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.",
10579
10686
  "minLength": 0,
10580
10687
  "maxLength": 18,
10581
10688
  "x-f5xc-required-for": {
@@ -10588,7 +10695,7 @@
10588
10695
  "x-field-mutability": "read-only",
10589
10696
  "x-original-maxLength": 1024,
10590
10697
  "x-reconciled-from-discovery": true,
10591
- "x-reconciled-at": "2026-01-05T18:28:39.193189+00:00"
10698
+ "x-reconciled-at": "2026-01-07T15:52:28.238161+00:00"
10592
10699
  },
10593
10700
  "uid": {
10594
10701
  "type": "string",
@@ -10597,6 +10704,8 @@
10597
10704
  "x-displayname": "UID",
10598
10705
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
10599
10706
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
10707
+ "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.",
10708
+ "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.",
10600
10709
  "minLength": 0,
10601
10710
  "maxLength": 36,
10602
10711
  "x-f5xc-required-for": {
@@ -10610,9 +10719,11 @@
10610
10719
  "x-original-maxLength": 1024,
10611
10720
  "format": "uuid",
10612
10721
  "x-reconciled-from-discovery": true,
10613
- "x-reconciled-at": "2026-01-05T18:28:39.193194+00:00"
10722
+ "x-reconciled-at": "2026-01-07T15:52:28.238167+00:00"
10614
10723
  }
10615
10724
  },
10725
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
10726
+ "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...",
10616
10727
  "x-f5xc-minimum-configuration": {
10617
10728
  "description": "Minimum configuration for schemaObjectRefType",
10618
10729
  "required_fields": [
@@ -10642,6 +10753,8 @@
10642
10753
  "title": "Creation_timestamp.",
10643
10754
  "format": "date-time",
10644
10755
  "x-displayname": "Creation Timestamp.",
10756
+ "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.",
10757
+ "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.",
10645
10758
  "minLength": 0,
10646
10759
  "maxLength": 1024,
10647
10760
  "x-f5xc-required-for": {
@@ -10659,6 +10772,8 @@
10659
10772
  "x-displayname": "Creator Class.",
10660
10773
  "x-ves-example": "ver.re1.int.ves.I/O.",
10661
10774
  "x-f5xc-example": "ver.re1.int.F5 XC",
10775
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
10776
+ "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.",
10662
10777
  "minLength": 0,
10663
10778
  "maxLength": 1024,
10664
10779
  "x-f5xc-required-for": {
@@ -10676,6 +10791,8 @@
10676
10791
  "x-displayname": "Creator ID.",
10677
10792
  "x-ves-example": "Ver-instance-1.",
10678
10793
  "x-f5xc-example": "ver-instance-1",
10794
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
10795
+ "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.",
10679
10796
  "minLength": 0,
10680
10797
  "maxLength": 1024,
10681
10798
  "x-f5xc-required-for": {
@@ -10694,6 +10811,8 @@
10694
10811
  "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)",
10695
10812
  "title": "Status_id",
10696
10813
  "x-displayname": "Status ID",
10814
+ "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...",
10815
+ "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).",
10697
10816
  "minLength": 0,
10698
10817
  "maxLength": 1024,
10699
10818
  "x-f5xc-required-for": {
@@ -10711,6 +10830,7 @@
10711
10830
  "x-displayname": "UID",
10712
10831
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
10713
10832
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
10833
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
10714
10834
  "minLength": 0,
10715
10835
  "maxLength": 36,
10716
10836
  "x-f5xc-required-for": {
@@ -10723,13 +10843,14 @@
10723
10843
  "x-original-maxLength": 1024,
10724
10844
  "format": "uuid",
10725
10845
  "x-reconciled-from-discovery": true,
10726
- "x-reconciled-at": "2026-01-05T18:28:39.193208+00:00"
10846
+ "x-reconciled-at": "2026-01-07T15:52:28.238181+00:00"
10727
10847
  },
10728
10848
  "vtrp_id": {
10729
10849
  "type": "string",
10730
10850
  "description": "Origin of this status exchanged by VTRP.",
10731
10851
  "title": "Vtrp_id",
10732
10852
  "x-displayname": "VTRP ID",
10853
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
10733
10854
  "minLength": 0,
10734
10855
  "maxLength": 1024,
10735
10856
  "x-f5xc-required-for": {
@@ -10746,6 +10867,7 @@
10746
10867
  "title": "Vtrp_stale.",
10747
10868
  "format": "boolean",
10748
10869
  "x-displayname": "VTRP Stale.",
10870
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
10749
10871
  "x-f5xc-required-for": {
10750
10872
  "minimum_config": false,
10751
10873
  "create": false,
@@ -10754,6 +10876,7 @@
10754
10876
  }
10755
10877
  }
10756
10878
  },
10879
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
10757
10880
  "x-f5xc-minimum-configuration": {
10758
10881
  "description": "Minimum configuration for schemaStatusMetaType",
10759
10882
  "required_fields": [
@@ -10784,6 +10907,8 @@
10784
10907
  "default": "STATUS_DO_NOT_PUBLISH",
10785
10908
  "x-displayname": "Status Publish Type.",
10786
10909
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
10910
+ "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.",
10911
+ "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.",
10787
10912
  "x-f5xc-minimum-configuration": {
10788
10913
  "description": "Minimum configuration for schemaStatusPublishType",
10789
10914
  "required_fields": [],
@@ -10809,6 +10934,7 @@
10809
10934
  "x-displayname": "Code",
10810
10935
  "x-ves-example": "0",
10811
10936
  "x-f5xc-example": "0",
10937
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
10812
10938
  "minimum": 0,
10813
10939
  "maximum": 2147483647,
10814
10940
  "x-f5xc-required-for": {
@@ -10825,6 +10951,8 @@
10825
10951
  "x-displayname": "Reason",
10826
10952
  "x-ves-example": "Value",
10827
10953
  "x-f5xc-example": "value",
10954
+ "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.",
10955
+ "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.",
10828
10956
  "minLength": 0,
10829
10957
  "maxLength": 43,
10830
10958
  "x-f5xc-required-for": {
@@ -10835,7 +10963,7 @@
10835
10963
  },
10836
10964
  "x-original-maxLength": 1024,
10837
10965
  "x-reconciled-from-discovery": true,
10838
- "x-reconciled-at": "2026-01-05T18:28:39.193218+00:00"
10966
+ "x-reconciled-at": "2026-01-07T15:52:28.238190+00:00"
10839
10967
  },
10840
10968
  "status": {
10841
10969
  "type": "string",
@@ -10844,6 +10972,7 @@
10844
10972
  "x-displayname": "Status",
10845
10973
  "x-ves-example": "Value",
10846
10974
  "x-f5xc-example": "value",
10975
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
10847
10976
  "minLength": 0,
10848
10977
  "maxLength": 17,
10849
10978
  "x-f5xc-required-for": {
@@ -10854,9 +10983,10 @@
10854
10983
  },
10855
10984
  "x-original-maxLength": 1024,
10856
10985
  "x-reconciled-from-discovery": true,
10857
- "x-reconciled-at": "2026-01-05T18:28:39.193222+00:00"
10986
+ "x-reconciled-at": "2026-01-07T15:52:28.238195+00:00"
10858
10987
  }
10859
10988
  },
10989
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
10860
10990
  "x-f5xc-minimum-configuration": {
10861
10991
  "description": "Minimum configuration for schemaStatusType",
10862
10992
  "required_fields": [
@@ -10884,6 +11014,8 @@
10884
11014
  "title": "Creation_timestamp.",
10885
11015
  "format": "date-time",
10886
11016
  "x-displayname": "Creation Timestamp.",
11017
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
11018
+ "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.",
10887
11019
  "minLength": 0,
10888
11020
  "maxLength": 1024,
10889
11021
  "x-f5xc-required-for": {
@@ -10901,6 +11033,7 @@
10901
11033
  "x-displayname": "Creator Class.",
10902
11034
  "x-ves-example": "Prism",
10903
11035
  "x-f5xc-example": "value",
11036
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
10904
11037
  "minLength": 0,
10905
11038
  "maxLength": 1024,
10906
11039
  "x-f5xc-required-for": {
@@ -10918,6 +11051,7 @@
10918
11051
  "x-displayname": "Creator ID.",
10919
11052
  "x-ves-example": "Admin@example-corp.com.",
10920
11053
  "x-f5xc-example": "value",
11054
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
10921
11055
  "minLength": 0,
10922
11056
  "maxLength": 1024,
10923
11057
  "x-f5xc-required-for": {
@@ -10934,6 +11068,8 @@
10934
11068
  "title": "Deletion_timestamp.",
10935
11069
  "format": "date-time",
10936
11070
  "x-displayname": "Deletion Timestamp.",
11071
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
11072
+ "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...",
10937
11073
  "minLength": 0,
10938
11074
  "maxLength": 1024,
10939
11075
  "x-f5xc-required-for": {
@@ -10953,6 +11089,8 @@
10953
11089
  "x-displayname": "Finalizers.",
10954
11090
  "x-ves-example": "Value",
10955
11091
  "x-f5xc-example": "value",
11092
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
11093
+ "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.",
10956
11094
  "x-f5xc-required-for": {
10957
11095
  "minimum_config": false,
10958
11096
  "create": false,
@@ -10970,6 +11108,8 @@
10970
11108
  "x-displayname": "Labels",
10971
11109
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
10972
11110
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
11111
+ "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.",
11112
+ "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).",
10973
11113
  "x-f5xc-required-for": {
10974
11114
  "minimum_config": false,
10975
11115
  "create": false,
@@ -10983,6 +11123,8 @@
10983
11123
  "title": "Modification_timestamp.",
10984
11124
  "format": "date-time",
10985
11125
  "x-displayname": "Modification Timestamp.",
11126
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
11127
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
10986
11128
  "minLength": 0,
10987
11129
  "maxLength": 1024,
10988
11130
  "x-f5xc-required-for": {
@@ -11001,6 +11143,8 @@
11001
11143
  "x-displayname": "Object Index.",
11002
11144
  "x-ves-example": "0",
11003
11145
  "x-f5xc-example": "0",
11146
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
11147
+ "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.",
11004
11148
  "minimum": 0,
11005
11149
  "maximum": 2147483647,
11006
11150
  "x-f5xc-required-for": {
@@ -11021,6 +11165,8 @@
11021
11165
  "x-displayname": "Tenant",
11022
11166
  "x-ves-example": "Example-corp.",
11023
11167
  "x-f5xc-example": "example-corp",
11168
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
11169
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
11024
11170
  "minLength": 0,
11025
11171
  "maxLength": 18,
11026
11172
  "x-f5xc-required-for": {
@@ -11032,7 +11178,7 @@
11032
11178
  "x-field-mutability": "read-only",
11033
11179
  "x-original-maxLength": 1024,
11034
11180
  "x-reconciled-from-discovery": true,
11035
- "x-reconciled-at": "2026-01-05T18:28:39.193241+00:00"
11181
+ "x-reconciled-at": "2026-01-07T15:52:28.238214+00:00"
11036
11182
  },
11037
11183
  "uid": {
11038
11184
  "type": "string",
@@ -11041,6 +11187,8 @@
11041
11187
  "x-displayname": "UID",
11042
11188
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
11043
11189
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
11190
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
11191
+ "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.",
11044
11192
  "minLength": 0,
11045
11193
  "maxLength": 36,
11046
11194
  "x-f5xc-required-for": {
@@ -11053,9 +11201,11 @@
11053
11201
  "x-original-maxLength": 1024,
11054
11202
  "format": "uuid",
11055
11203
  "x-reconciled-from-discovery": true,
11056
- "x-reconciled-at": "2026-01-05T18:28:39.193246+00:00"
11204
+ "x-reconciled-at": "2026-01-07T15:52:28.238219+00:00"
11057
11205
  }
11058
11206
  },
11207
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
11208
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
11059
11209
  "x-f5xc-minimum-configuration": {
11060
11210
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
11061
11211
  "required_fields": [
@@ -11103,7 +11253,7 @@
11103
11253
  },
11104
11254
  "x-original-maxLength": 1024,
11105
11255
  "x-reconciled-from-discovery": true,
11106
- "x-reconciled-at": "2026-01-05T18:28:39.193251+00:00"
11256
+ "x-reconciled-at": "2026-01-07T15:52:28.238225+00:00"
11107
11257
  },
11108
11258
  "name": {
11109
11259
  "type": "string",
@@ -11112,6 +11262,8 @@
11112
11262
  "x-displayname": "Name",
11113
11263
  "x-ves-example": "Contactus-route.",
11114
11264
  "x-f5xc-example": "contactus-route",
11265
+ "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.",
11266
+ "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.",
11115
11267
  "minLength": 0,
11116
11268
  "maxLength": 16,
11117
11269
  "x-f5xc-required-for": {
@@ -11122,7 +11274,7 @@
11122
11274
  },
11123
11275
  "x-original-maxLength": 1024,
11124
11276
  "x-reconciled-from-discovery": true,
11125
- "x-reconciled-at": "2026-01-05T18:28:39.193255+00:00"
11277
+ "x-reconciled-at": "2026-01-07T15:52:28.238229+00:00"
11126
11278
  },
11127
11279
  "namespace": {
11128
11280
  "type": "string",
@@ -11131,6 +11283,8 @@
11131
11283
  "x-displayname": "Namespace",
11132
11284
  "x-ves-example": "Ns1",
11133
11285
  "x-f5xc-example": "ns1",
11286
+ "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.",
11287
+ "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.",
11134
11288
  "minLength": 0,
11135
11289
  "maxLength": 6,
11136
11290
  "x-f5xc-required-for": {
@@ -11141,7 +11295,7 @@
11141
11295
  },
11142
11296
  "x-original-maxLength": 1024,
11143
11297
  "x-reconciled-from-discovery": true,
11144
- "x-reconciled-at": "2026-01-05T18:28:39.193260+00:00"
11298
+ "x-reconciled-at": "2026-01-07T15:52:28.238233+00:00"
11145
11299
  },
11146
11300
  "uid": {
11147
11301
  "type": "string",
@@ -11162,9 +11316,10 @@
11162
11316
  "x-original-maxLength": 1024,
11163
11317
  "format": "uuid",
11164
11318
  "x-reconciled-from-discovery": true,
11165
- "x-reconciled-at": "2026-01-05T18:28:39.193264+00:00"
11319
+ "x-reconciled-at": "2026-01-07T15:52:28.238237+00:00"
11166
11320
  }
11167
11321
  },
11322
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
11168
11323
  "x-f5xc-minimum-configuration": {
11169
11324
  "description": "Minimum configuration for schemaViewRefType",
11170
11325
  "required_fields": [
@@ -11193,6 +11348,8 @@
11193
11348
  "default": "SUBSCRIPTION_PENDING",
11194
11349
  "x-displayname": "Addon Subscription Type.",
11195
11350
  "x-ves-proto-enum": "ves.io.schema.pbac.addon_subscription.AddonSubscriptionState",
11351
+ "x-f5xc-description-short": "Represents the different states of an addon subscription. - SUBSCRIPTION_PENDING: Subscription Pending Indicates that the subscription is pending...",
11352
+ "x-f5xc-description-medium": "Represents the different states of an addon subscription. - SUBSCRIPTION_PENDING: Subscription Pending Indicates that the subscription is pending enablement. - SUBSCRIPTION_ENABLED: Subscription Enabled Indicates that the subscription is currently enabled and active. ...",
11196
11353
  "x-f5xc-minimum-configuration": {
11197
11354
  "description": "Minimum configuration for addon_subscriptionAddonSubscriptionState",
11198
11355
  "required_fields": [],
@@ -11276,6 +11433,7 @@
11276
11433
  "$ref": "#/components/schemas/addon_subscriptionAddonSubscriptionState"
11277
11434
  }
11278
11435
  },
11436
+ "x-f5xc-description-short": "Create a new Addon Subscription with Addon Subscription State.",
11279
11437
  "x-f5xc-minimum-configuration": {
11280
11438
  "description": "Minimum configuration for addon_subscriptionCreateSpecType",
11281
11439
  "required_fields": [
@@ -11303,6 +11461,7 @@
11303
11461
  "title": "Fail_if_referred.",
11304
11462
  "format": "boolean",
11305
11463
  "x-displayname": "Fail-If-Referred.",
11464
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
11306
11465
  "x-f5xc-required-for": {
11307
11466
  "minimum_config": false,
11308
11467
  "create": false,
@@ -11327,7 +11486,7 @@
11327
11486
  },
11328
11487
  "x-original-maxLength": 1024,
11329
11488
  "x-reconciled-from-discovery": true,
11330
- "x-reconciled-at": "2026-01-05T18:28:39.511106+00:00"
11489
+ "x-reconciled-at": "2026-01-07T15:52:28.639195+00:00"
11331
11490
  },
11332
11491
  "namespace": {
11333
11492
  "type": "string",
@@ -11336,6 +11495,7 @@
11336
11495
  "x-displayname": "Namespace",
11337
11496
  "x-ves-example": "Ns1",
11338
11497
  "x-f5xc-example": "ns1",
11498
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
11339
11499
  "minLength": 0,
11340
11500
  "maxLength": 6,
11341
11501
  "x-f5xc-required-for": {
@@ -11346,7 +11506,7 @@
11346
11506
  },
11347
11507
  "x-original-maxLength": 1024,
11348
11508
  "x-reconciled-from-discovery": true,
11349
- "x-reconciled-at": "2026-01-05T18:28:39.511113+00:00"
11509
+ "x-reconciled-at": "2026-01-07T15:52:28.639202+00:00"
11350
11510
  }
11351
11511
  },
11352
11512
  "x-f5xc-minimum-configuration": {
@@ -11381,6 +11541,7 @@
11381
11541
  "$ref": "#/components/schemas/ioschemaObjectRefType"
11382
11542
  },
11383
11543
  "x-displayname": "Deleted Referred Objects.",
11544
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
11384
11545
  "x-f5xc-required-for": {
11385
11546
  "minimum_config": false,
11386
11547
  "create": false,
@@ -11396,6 +11557,7 @@
11396
11557
  "$ref": "#/components/schemas/ioschemaObjectRefType"
11397
11558
  },
11398
11559
  "x-displayname": "Disabled Referred Objects.",
11560
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
11399
11561
  "x-f5xc-required-for": {
11400
11562
  "minimum_config": false,
11401
11563
  "create": false,
@@ -11414,6 +11576,7 @@
11414
11576
  "$ref": "#/components/schemas/ioschemaObjectRefType"
11415
11577
  },
11416
11578
  "x-displayname": "Referring Objects.",
11579
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
11417
11580
  "x-f5xc-required-for": {
11418
11581
  "minimum_config": false,
11419
11582
  "create": false,
@@ -11463,6 +11626,8 @@
11463
11626
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
11464
11627
  ],
11465
11628
  "default": "GET_RSP_FORMAT_DEFAULT",
11629
+ "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...",
11630
+ "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...",
11466
11631
  "x-f5xc-minimum-configuration": {
11467
11632
  "description": "Minimum configuration for addon_subscriptionGetResponseFormatCode",
11468
11633
  "required_fields": [],
@@ -11491,6 +11656,7 @@
11491
11656
  "$ref": "#/components/schemas/addon_subscriptionAddonSubscriptionState"
11492
11657
  }
11493
11658
  },
11659
+ "x-f5xc-description-short": "GET Addon Subsciption reads a given object from storage backend for metadata.namespace.",
11494
11660
  "x-f5xc-minimum-configuration": {
11495
11661
  "description": "Minimum configuration for addon_subscriptionGetSpecType",
11496
11662
  "required_fields": [
@@ -11520,6 +11686,7 @@
11520
11686
  "$ref": "#/components/schemas/schemaErrorType"
11521
11687
  },
11522
11688
  "x-displayname": "Errors",
11689
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
11523
11690
  "x-f5xc-required-for": {
11524
11691
  "minimum_config": false,
11525
11692
  "create": false,
@@ -11535,6 +11702,8 @@
11535
11702
  "$ref": "#/components/schemas/addon_subscriptionListResponseItem"
11536
11703
  },
11537
11704
  "x-displayname": "Items",
11705
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
11706
+ "x-f5xc-description-short": "Items represents the collection in response.",
11538
11707
  "x-f5xc-required-for": {
11539
11708
  "minimum_config": false,
11540
11709
  "create": false,
@@ -11568,6 +11737,8 @@
11568
11737
  "description": "The set of annotations present on this addon_subscription.",
11569
11738
  "title": "Annotations.",
11570
11739
  "x-displayname": "Annotations.",
11740
+ "x-f5xc-example": "{\"key\": \"value\"}",
11741
+ "x-f5xc-description-short": "The set of annotations present on this addon_subscription.",
11571
11742
  "x-f5xc-required-for": {
11572
11743
  "minimum_config": false,
11573
11744
  "create": false,
@@ -11580,6 +11751,7 @@
11580
11751
  "description": "The description set for this addon_subscription.",
11581
11752
  "title": "Description.",
11582
11753
  "x-displayname": "Description.",
11754
+ "x-f5xc-description-short": "The description set for this addon_subscription.",
11583
11755
  "minLength": 0,
11584
11756
  "maxLength": 0,
11585
11757
  "x-f5xc-required-for": {
@@ -11590,7 +11762,7 @@
11590
11762
  },
11591
11763
  "x-original-maxLength": 1024,
11592
11764
  "x-reconciled-from-discovery": true,
11593
- "x-reconciled-at": "2026-01-05T18:28:39.511138+00:00"
11765
+ "x-reconciled-at": "2026-01-07T15:52:28.639227+00:00"
11594
11766
  },
11595
11767
  "disabled": {
11596
11768
  "type": "boolean",
@@ -11598,6 +11770,8 @@
11598
11770
  "title": "Disabled",
11599
11771
  "format": "boolean",
11600
11772
  "x-displayname": "Disabled",
11773
+ "x-f5xc-example": "True",
11774
+ "x-f5xc-description-short": "Value of true indicates addon_subscription is administratively disabled.",
11601
11775
  "x-f5xc-required-for": {
11602
11776
  "minimum_config": false,
11603
11777
  "create": false,
@@ -11613,6 +11787,8 @@
11613
11787
  "description": "The set of labels present on this addon_subscription.",
11614
11788
  "title": "Labels",
11615
11789
  "x-displayname": "Labels",
11790
+ "x-f5xc-example": "{\"key\": \"value\"}",
11791
+ "x-f5xc-description-short": "The set of labels present on this addon_subscription.",
11616
11792
  "x-f5xc-required-for": {
11617
11793
  "minimum_config": false,
11618
11794
  "create": false,
@@ -11640,7 +11816,7 @@
11640
11816
  },
11641
11817
  "x-original-maxLength": 1024,
11642
11818
  "x-reconciled-from-discovery": true,
11643
- "x-reconciled-at": "2026-01-05T18:28:39.511148+00:00"
11819
+ "x-reconciled-at": "2026-01-07T15:52:28.639238+00:00"
11644
11820
  },
11645
11821
  "namespace": {
11646
11822
  "type": "string",
@@ -11659,7 +11835,7 @@
11659
11835
  },
11660
11836
  "x-original-maxLength": 1024,
11661
11837
  "x-reconciled-from-discovery": true,
11662
- "x-reconciled-at": "2026-01-05T18:28:39.511152+00:00"
11838
+ "x-reconciled-at": "2026-01-07T15:52:28.639242+00:00"
11663
11839
  },
11664
11840
  "owner_view": {
11665
11841
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -11685,7 +11861,7 @@
11685
11861
  "x-field-mutability": "read-only",
11686
11862
  "x-original-maxLength": 1024,
11687
11863
  "x-reconciled-from-discovery": true,
11688
- "x-reconciled-at": "2026-01-05T18:28:39.511159+00:00"
11864
+ "x-reconciled-at": "2026-01-07T15:52:28.639249+00:00"
11689
11865
  },
11690
11866
  "uid": {
11691
11867
  "type": "string",
@@ -11694,6 +11870,7 @@
11694
11870
  "x-displayname": "UID",
11695
11871
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
11696
11872
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
11873
+ "x-f5xc-description-short": "The unique uid of this addon_subscription.",
11697
11874
  "minLength": 0,
11698
11875
  "maxLength": 36,
11699
11876
  "x-f5xc-required-for": {
@@ -11706,9 +11883,11 @@
11706
11883
  "x-original-maxLength": 1024,
11707
11884
  "format": "uuid",
11708
11885
  "x-reconciled-from-discovery": true,
11709
- "x-reconciled-at": "2026-01-05T18:28:39.511165+00:00"
11886
+ "x-reconciled-at": "2026-01-07T15:52:28.639255+00:00"
11710
11887
  }
11711
11888
  },
11889
+ "x-f5xc-description-short": "By default a summary of addon_subscription is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
11890
+ "x-f5xc-description-medium": "By default a summary of addon_subscription is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
11712
11891
  "x-f5xc-minimum-configuration": {
11713
11892
  "description": "Minimum configuration for addon_subscriptionListResponseItem",
11714
11893
  "required_fields": [
@@ -11747,6 +11926,7 @@
11747
11926
  "$ref": "#/components/schemas/addon_subscriptionSupportTicketId"
11748
11927
  }
11749
11928
  },
11929
+ "x-f5xc-description-short": "NotificationPreference preference for receiving addon subscription notifications.",
11750
11930
  "x-f5xc-minimum-configuration": {
11751
11931
  "description": "Minimum configuration for addon_subscriptionNotificationPreference",
11752
11932
  "required_fields": [
@@ -11818,6 +11998,7 @@
11818
11998
  "$ref": "#/components/schemas/addon_subscriptionAddonSubscriptionState"
11819
11999
  }
11820
12000
  },
12001
+ "x-f5xc-description-short": "Replace a given Addon Subscription with with Addon Subscription State.",
11821
12002
  "x-f5xc-minimum-configuration": {
11822
12003
  "description": "Minimum configuration for addon_subscriptionReplaceSpecType",
11823
12004
  "required_fields": [
@@ -11845,6 +12026,7 @@
11845
12026
  "description": "Subscription_ticket_id associated with the Addon Subscription subscription.",
11846
12027
  "title": "SubscriptionTicketId.",
11847
12028
  "x-displayname": "Subscription Ticket ID.",
12029
+ "x-f5xc-description-short": "Subscription_ticket_id associated with the Addon Subscription subscription.",
11848
12030
  "minLength": 0,
11849
12031
  "maxLength": 1024,
11850
12032
  "x-f5xc-required-for": {
@@ -11860,6 +12042,7 @@
11860
12042
  "description": "Unsubscription_ticket_id associated with the Addon Subscription unsubscription.",
11861
12043
  "title": "UnsubscriptionTicketId.",
11862
12044
  "x-displayname": "Unsubscription Ticket ID.",
12045
+ "x-f5xc-description-short": "Unsubscription_ticket_id associated with the Addon Subscription unsubscription.",
11863
12046
  "minLength": 0,
11864
12047
  "maxLength": 1024,
11865
12048
  "x-f5xc-required-for": {
@@ -11871,6 +12054,7 @@
11871
12054
  "x-field-mutability": "read-only"
11872
12055
  }
11873
12056
  },
12057
+ "x-f5xc-description-short": "SupportTicketId gives the information about ticket created for managed addon subscription.",
11874
12058
  "x-f5xc-minimum-configuration": {
11875
12059
  "description": "Minimum configuration for addon_subscriptionSupportTicketId",
11876
12060
  "required_fields": [
@@ -11898,6 +12082,8 @@
11898
12082
  "x-displayname": "Kind",
11899
12083
  "x-ves-example": "Virtual_site.",
11900
12084
  "x-f5xc-example": "virtual_site",
12085
+ "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\")",
12086
+ "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\").",
11901
12087
  "minLength": 0,
11902
12088
  "maxLength": 14,
11903
12089
  "x-f5xc-required-for": {
@@ -11909,7 +12095,7 @@
11909
12095
  "readOnly": true,
11910
12096
  "x-original-maxLength": 1024,
11911
12097
  "x-reconciled-from-discovery": true,
11912
- "x-reconciled-at": "2026-01-05T18:28:39.511183+00:00"
12098
+ "x-reconciled-at": "2026-01-07T15:52:28.639273+00:00"
11913
12099
  },
11914
12100
  "name": {
11915
12101
  "type": "string",
@@ -11918,6 +12104,8 @@
11918
12104
  "x-displayname": "Name",
11919
12105
  "x-ves-example": "Contactus-route.",
11920
12106
  "x-f5xc-example": "contactus-route",
12107
+ "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.",
12108
+ "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.",
11921
12109
  "minLength": 0,
11922
12110
  "maxLength": 16,
11923
12111
  "x-f5xc-required-for": {
@@ -11928,7 +12116,7 @@
11928
12116
  },
11929
12117
  "x-original-maxLength": 1024,
11930
12118
  "x-reconciled-from-discovery": true,
11931
- "x-reconciled-at": "2026-01-05T18:28:39.511187+00:00"
12119
+ "x-reconciled-at": "2026-01-07T15:52:28.639278+00:00"
11932
12120
  },
11933
12121
  "namespace": {
11934
12122
  "type": "string",
@@ -11937,6 +12125,8 @@
11937
12125
  "x-displayname": "Namespace",
11938
12126
  "x-ves-example": "Ns1",
11939
12127
  "x-f5xc-example": "ns1",
12128
+ "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.",
12129
+ "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.",
11940
12130
  "minLength": 0,
11941
12131
  "maxLength": 6,
11942
12132
  "x-f5xc-required-for": {
@@ -11947,7 +12137,7 @@
11947
12137
  },
11948
12138
  "x-original-maxLength": 1024,
11949
12139
  "x-reconciled-from-discovery": true,
11950
- "x-reconciled-at": "2026-01-05T18:28:39.511191+00:00"
12140
+ "x-reconciled-at": "2026-01-07T15:52:28.639282+00:00"
11951
12141
  },
11952
12142
  "tenant": {
11953
12143
  "type": "string",
@@ -11956,6 +12146,8 @@
11956
12146
  "x-displayname": "Tenant",
11957
12147
  "x-ves-example": "Example-corp.",
11958
12148
  "x-f5xc-example": "example-corp",
12149
+ "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.",
12150
+ "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.",
11959
12151
  "minLength": 0,
11960
12152
  "maxLength": 18,
11961
12153
  "x-f5xc-required-for": {
@@ -11968,7 +12160,7 @@
11968
12160
  "x-field-mutability": "read-only",
11969
12161
  "x-original-maxLength": 1024,
11970
12162
  "x-reconciled-from-discovery": true,
11971
- "x-reconciled-at": "2026-01-05T18:28:39.511195+00:00"
12163
+ "x-reconciled-at": "2026-01-07T15:52:28.639286+00:00"
11972
12164
  },
11973
12165
  "uid": {
11974
12166
  "type": "string",
@@ -11977,6 +12169,8 @@
11977
12169
  "x-displayname": "UID",
11978
12170
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
11979
12171
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
12172
+ "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.",
12173
+ "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.",
11980
12174
  "minLength": 0,
11981
12175
  "maxLength": 36,
11982
12176
  "x-f5xc-required-for": {
@@ -11990,9 +12184,11 @@
11990
12184
  "x-original-maxLength": 1024,
11991
12185
  "format": "uuid",
11992
12186
  "x-reconciled-from-discovery": true,
11993
- "x-reconciled-at": "2026-01-05T18:28:39.511201+00:00"
12187
+ "x-reconciled-at": "2026-01-07T15:52:28.639292+00:00"
11994
12188
  }
11995
12189
  },
12190
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
12191
+ "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...",
11996
12192
  "x-f5xc-minimum-configuration": {
11997
12193
  "description": "Minimum configuration for ioschemaObjectRefType",
11998
12194
  "required_fields": [
@@ -12034,6 +12230,8 @@
12034
12230
  "ves.io.schema.rules.map.values.string.max_len": "1024",
12035
12231
  "ves.io.schema.rules.map.values.string.min_len": "1"
12036
12232
  },
12233
+ "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.",
12234
+ "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.",
12037
12235
  "x-f5xc-required-for": {
12038
12236
  "minimum_config": false,
12039
12237
  "create": false,
@@ -12055,6 +12253,7 @@
12055
12253
  "x-validation-rules": {
12056
12254
  "ves.io.schema.rules.string.max_bytes": "1200"
12057
12255
  },
12256
+ "x-f5xc-description-short": "Human readable description for the object.",
12058
12257
  "minLength": 0,
12059
12258
  "x-f5xc-required-for": {
12060
12259
  "minimum_config": false,
@@ -12064,7 +12263,7 @@
12064
12263
  },
12065
12264
  "x-original-maxLength": 1200,
12066
12265
  "x-reconciled-from-discovery": true,
12067
- "x-reconciled-at": "2026-01-05T18:28:39.511229+00:00"
12266
+ "x-reconciled-at": "2026-01-07T15:52:28.639320+00:00"
12068
12267
  },
12069
12268
  "disable": {
12070
12269
  "type": "boolean",
@@ -12073,6 +12272,7 @@
12073
12272
  "format": "boolean",
12074
12273
  "x-displayname": "Disable",
12075
12274
  "x-f5xc-example": "true",
12275
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
12076
12276
  "x-f5xc-required-for": {
12077
12277
  "minimum_config": false,
12078
12278
  "create": false,
@@ -12086,6 +12286,8 @@
12086
12286
  "title": "Labels",
12087
12287
  "x-displayname": "Labels",
12088
12288
  "x-f5xc-example": "value",
12289
+ "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.",
12290
+ "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.",
12089
12291
  "x-f5xc-required-for": {
12090
12292
  "minimum_config": false,
12091
12293
  "create": false,
@@ -12107,6 +12309,8 @@
12107
12309
  "x-validation-rules": {
12108
12310
  "ves.io.schema.rules.message.required": "true"
12109
12311
  },
12312
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
12313
+ "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.",
12110
12314
  "minLength": 0,
12111
12315
  "maxLength": 16,
12112
12316
  "x-f5xc-required-for": {
@@ -12117,7 +12321,7 @@
12117
12321
  },
12118
12322
  "x-original-maxLength": 1024,
12119
12323
  "x-reconciled-from-discovery": true,
12120
- "x-reconciled-at": "2026-01-05T18:28:39.511237+00:00"
12324
+ "x-reconciled-at": "2026-01-07T15:52:28.639327+00:00"
12121
12325
  },
12122
12326
  "namespace": {
12123
12327
  "type": "string",
@@ -12126,6 +12330,8 @@
12126
12330
  "x-displayname": "Namespace",
12127
12331
  "x-ves-example": "Staging",
12128
12332
  "x-f5xc-example": "staging",
12333
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
12334
+ "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 \"\".",
12129
12335
  "minLength": 0,
12130
12336
  "maxLength": 6,
12131
12337
  "x-f5xc-required-for": {
@@ -12136,9 +12342,10 @@
12136
12342
  },
12137
12343
  "x-original-maxLength": 1024,
12138
12344
  "x-reconciled-from-discovery": true,
12139
- "x-reconciled-at": "2026-01-05T18:28:39.511241+00:00"
12345
+ "x-reconciled-at": "2026-01-07T15:52:28.639331+00:00"
12140
12346
  }
12141
12347
  },
12348
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
12142
12349
  "x-f5xc-minimum-configuration": {
12143
12350
  "description": "Minimum configuration for schemaObjectCreateMetaType",
12144
12351
  "required_fields": [
@@ -12182,6 +12389,8 @@
12182
12389
  "ves.io.schema.rules.map.values.string.max_len": "1024",
12183
12390
  "ves.io.schema.rules.map.values.string.min_len": "1"
12184
12391
  },
12392
+ "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.",
12393
+ "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.",
12185
12394
  "x-f5xc-required-for": {
12186
12395
  "minimum_config": false,
12187
12396
  "create": false,
@@ -12203,6 +12412,7 @@
12203
12412
  "x-validation-rules": {
12204
12413
  "ves.io.schema.rules.string.max_bytes": "1200"
12205
12414
  },
12415
+ "x-f5xc-description-short": "Human readable description for the object.",
12206
12416
  "minLength": 0,
12207
12417
  "x-f5xc-required-for": {
12208
12418
  "minimum_config": false,
@@ -12212,7 +12422,7 @@
12212
12422
  },
12213
12423
  "x-original-maxLength": 1200,
12214
12424
  "x-reconciled-from-discovery": true,
12215
- "x-reconciled-at": "2026-01-05T18:28:39.511266+00:00"
12425
+ "x-reconciled-at": "2026-01-07T15:52:28.639358+00:00"
12216
12426
  },
12217
12427
  "disable": {
12218
12428
  "type": "boolean",
@@ -12221,6 +12431,7 @@
12221
12431
  "format": "boolean",
12222
12432
  "x-displayname": "Disable",
12223
12433
  "x-f5xc-example": "true",
12434
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
12224
12435
  "x-f5xc-required-for": {
12225
12436
  "minimum_config": false,
12226
12437
  "create": false,
@@ -12235,6 +12446,8 @@
12235
12446
  "x-displayname": "Labels",
12236
12447
  "x-ves-example": "Value",
12237
12448
  "x-f5xc-example": "value",
12449
+ "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.",
12450
+ "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.",
12238
12451
  "x-f5xc-required-for": {
12239
12452
  "minimum_config": false,
12240
12453
  "create": false,
@@ -12255,6 +12468,8 @@
12255
12468
  "x-validation-rules": {
12256
12469
  "ves.io.schema.rules.message.required": "true"
12257
12470
  },
12471
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
12472
+ "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.",
12258
12473
  "minLength": 0,
12259
12474
  "maxLength": 16,
12260
12475
  "x-f5xc-required-for": {
@@ -12265,7 +12480,7 @@
12265
12480
  },
12266
12481
  "x-original-maxLength": 1024,
12267
12482
  "x-reconciled-from-discovery": true,
12268
- "x-reconciled-at": "2026-01-05T18:28:39.511273+00:00"
12483
+ "x-reconciled-at": "2026-01-07T15:52:28.639365+00:00"
12269
12484
  },
12270
12485
  "namespace": {
12271
12486
  "type": "string",
@@ -12274,6 +12489,8 @@
12274
12489
  "x-displayname": "Namespace",
12275
12490
  "x-ves-example": "Staging",
12276
12491
  "x-f5xc-example": "staging",
12492
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
12493
+ "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 \"\".",
12277
12494
  "minLength": 0,
12278
12495
  "maxLength": 6,
12279
12496
  "x-f5xc-required-for": {
@@ -12284,9 +12501,10 @@
12284
12501
  },
12285
12502
  "x-original-maxLength": 1024,
12286
12503
  "x-reconciled-from-discovery": true,
12287
- "x-reconciled-at": "2026-01-05T18:28:39.511277+00:00"
12504
+ "x-reconciled-at": "2026-01-07T15:52:28.639369+00:00"
12288
12505
  }
12289
12506
  },
12507
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
12290
12508
  "x-f5xc-minimum-configuration": {
12291
12509
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
12292
12510
  "required_fields": [
@@ -12331,6 +12549,8 @@
12331
12549
  "ves.io.schema.rules.string.max_bytes": "128",
12332
12550
  "ves.io.schema.rules.string.min_bytes": "1"
12333
12551
  },
12552
+ "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.",
12553
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name. Required: YES.",
12334
12554
  "x-f5xc-required-for": {
12335
12555
  "minimum_config": false,
12336
12556
  "create": false,
@@ -12339,7 +12559,7 @@
12339
12559
  },
12340
12560
  "x-original-maxLength": 128,
12341
12561
  "x-reconciled-from-discovery": true,
12342
- "x-reconciled-at": "2026-01-05T18:28:39.511336+00:00"
12562
+ "x-reconciled-at": "2026-01-07T15:52:28.639425+00:00"
12343
12563
  },
12344
12564
  "namespace": {
12345
12565
  "type": "string",
@@ -12355,6 +12575,8 @@
12355
12575
  "x-validation-rules": {
12356
12576
  "ves.io.schema.rules.string.max_bytes": "64"
12357
12577
  },
12578
+ "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.",
12579
+ "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.",
12358
12580
  "minLength": 0,
12359
12581
  "x-f5xc-required-for": {
12360
12582
  "minimum_config": false,
@@ -12364,7 +12586,7 @@
12364
12586
  },
12365
12587
  "x-original-maxLength": 64,
12366
12588
  "x-reconciled-from-discovery": true,
12367
- "x-reconciled-at": "2026-01-05T18:28:39.511340+00:00"
12589
+ "x-reconciled-at": "2026-01-07T15:52:28.639429+00:00"
12368
12590
  },
12369
12591
  "tenant": {
12370
12592
  "type": "string",
@@ -12380,6 +12602,8 @@
12380
12602
  "x-validation-rules": {
12381
12603
  "ves.io.schema.rules.string.max_bytes": "64"
12382
12604
  },
12605
+ "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.",
12606
+ "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.",
12383
12607
  "minLength": 0,
12384
12608
  "x-f5xc-required-for": {
12385
12609
  "minimum_config": false,
@@ -12391,9 +12615,11 @@
12391
12615
  "x-field-mutability": "read-only",
12392
12616
  "x-original-maxLength": 64,
12393
12617
  "x-reconciled-from-discovery": true,
12394
- "x-reconciled-at": "2026-01-05T18:28:39.511345+00:00"
12618
+ "x-reconciled-at": "2026-01-07T15:52:28.639433+00:00"
12395
12619
  }
12396
12620
  },
12621
+ "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
12622
+ "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.",
12397
12623
  "x-f5xc-minimum-configuration": {
12398
12624
  "description": "Minimum configuration for schemaviewsObjectRefType",
12399
12625
  "required_fields": [
@@ -12497,6 +12723,7 @@
12497
12723
  "ves.io.schema.rules.uint32.gte": "1",
12498
12724
  "ves.io.schema.rules.uint32.lte": "65535"
12499
12725
  },
12726
+ "x-f5xc-description-short": "Port of the Central Manager instance to connect to Required: YES.",
12500
12727
  "minimum": 1,
12501
12728
  "maximum": 65535,
12502
12729
  "x-f5xc-required-for": {
@@ -12525,6 +12752,7 @@
12525
12752
  "ves.io.schema.rules.string.max_len": "128",
12526
12753
  "ves.io.schema.rules.string.min_len": "4"
12527
12754
  },
12755
+ "x-f5xc-description-short": "Username for the Central Manager instance Required: YES.",
12528
12756
  "x-f5xc-required-for": {
12529
12757
  "minimum_config": false,
12530
12758
  "create": false,
@@ -12533,6 +12761,7 @@
12533
12761
  }
12534
12762
  }
12535
12763
  },
12764
+ "x-f5xc-description-short": "Create App type will create the configuration in namespace metadata.namespace.",
12536
12765
  "x-f5xc-minimum-configuration": {
12537
12766
  "description": "Minimum configuration for cminstanceCreateSpecType",
12538
12767
  "required_fields": [
@@ -12562,6 +12791,7 @@
12562
12791
  "title": "Fail_if_referred.",
12563
12792
  "format": "boolean",
12564
12793
  "x-displayname": "Fail-If-Referred.",
12794
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
12565
12795
  "x-f5xc-required-for": {
12566
12796
  "minimum_config": false,
12567
12797
  "create": false,
@@ -12586,7 +12816,7 @@
12586
12816
  },
12587
12817
  "x-original-maxLength": 1024,
12588
12818
  "x-reconciled-from-discovery": true,
12589
- "x-reconciled-at": "2026-01-05T18:28:53.997599+00:00"
12819
+ "x-reconciled-at": "2026-01-07T15:52:46.877901+00:00"
12590
12820
  },
12591
12821
  "namespace": {
12592
12822
  "type": "string",
@@ -12595,6 +12825,7 @@
12595
12825
  "x-displayname": "Namespace",
12596
12826
  "x-ves-example": "Ns1",
12597
12827
  "x-f5xc-example": "ns1",
12828
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
12598
12829
  "minLength": 0,
12599
12830
  "maxLength": 6,
12600
12831
  "x-f5xc-required-for": {
@@ -12605,7 +12836,7 @@
12605
12836
  },
12606
12837
  "x-original-maxLength": 1024,
12607
12838
  "x-reconciled-from-discovery": true,
12608
- "x-reconciled-at": "2026-01-05T18:28:53.997606+00:00"
12839
+ "x-reconciled-at": "2026-01-07T15:52:46.877908+00:00"
12609
12840
  }
12610
12841
  },
12611
12842
  "x-f5xc-minimum-configuration": {
@@ -12640,6 +12871,7 @@
12640
12871
  "$ref": "#/components/schemas/schemaObjectRefType"
12641
12872
  },
12642
12873
  "x-displayname": "Deleted Referred Objects.",
12874
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
12643
12875
  "x-f5xc-required-for": {
12644
12876
  "minimum_config": false,
12645
12877
  "create": false,
@@ -12655,6 +12887,7 @@
12655
12887
  "$ref": "#/components/schemas/schemaObjectRefType"
12656
12888
  },
12657
12889
  "x-displayname": "Disabled Referred Objects.",
12890
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
12658
12891
  "x-f5xc-required-for": {
12659
12892
  "minimum_config": false,
12660
12893
  "create": false,
@@ -12673,6 +12906,7 @@
12673
12906
  "$ref": "#/components/schemas/schemaObjectRefType"
12674
12907
  },
12675
12908
  "x-displayname": "Referring Objects.",
12909
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
12676
12910
  "x-f5xc-required-for": {
12677
12911
  "minimum_config": false,
12678
12912
  "create": false,
@@ -12694,6 +12928,8 @@
12694
12928
  "$ref": "#/components/schemas/cminstanceStatusObject"
12695
12929
  },
12696
12930
  "x-displayname": "Status",
12931
+ "x-f5xc-example": "active",
12932
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
12697
12933
  "x-f5xc-required-for": {
12698
12934
  "minimum_config": false,
12699
12935
  "create": false,
@@ -12703,7 +12939,7 @@
12703
12939
  "maxLength": 17,
12704
12940
  "minLength": 17,
12705
12941
  "x-reconciled-from-discovery": true,
12706
- "x-reconciled-at": "2026-01-05T18:28:53.997623+00:00"
12942
+ "x-reconciled-at": "2026-01-07T15:52:46.877924+00:00"
12707
12943
  },
12708
12944
  "system_metadata": {
12709
12945
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -12743,6 +12979,8 @@
12743
12979
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
12744
12980
  ],
12745
12981
  "default": "GET_RSP_FORMAT_DEFAULT",
12982
+ "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...",
12983
+ "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...",
12746
12984
  "x-f5xc-minimum-configuration": {
12747
12985
  "description": "Minimum configuration for cminstanceGetResponseFormatCode",
12748
12986
  "required_fields": [],
@@ -12787,6 +13025,7 @@
12787
13025
  "ves.io.schema.rules.uint32.gte": "1",
12788
13026
  "ves.io.schema.rules.uint32.lte": "65535"
12789
13027
  },
13028
+ "x-f5xc-description-short": "Port of the Central Manager instance to connect to Required: YES.",
12790
13029
  "minimum": 1,
12791
13030
  "maximum": 65535,
12792
13031
  "x-f5xc-required-for": {
@@ -12815,6 +13054,7 @@
12815
13054
  "ves.io.schema.rules.string.max_len": "128",
12816
13055
  "ves.io.schema.rules.string.min_len": "4"
12817
13056
  },
13057
+ "x-f5xc-description-short": "Username for the Central Manager instance Required: YES.",
12818
13058
  "x-f5xc-required-for": {
12819
13059
  "minimum_config": false,
12820
13060
  "create": false,
@@ -12823,6 +13063,7 @@
12823
13063
  }
12824
13064
  }
12825
13065
  },
13066
+ "x-f5xc-description-short": "GET CMInstance will read the configuration from namespace metadata.namespace.",
12826
13067
  "x-f5xc-minimum-configuration": {
12827
13068
  "description": "Minimum configuration for cminstanceGetSpecType",
12828
13069
  "required_fields": [
@@ -12854,6 +13095,7 @@
12854
13095
  "$ref": "#/components/schemas/schemaErrorType"
12855
13096
  },
12856
13097
  "x-displayname": "Errors",
13098
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
12857
13099
  "x-f5xc-required-for": {
12858
13100
  "minimum_config": false,
12859
13101
  "create": false,
@@ -12869,6 +13111,8 @@
12869
13111
  "$ref": "#/components/schemas/cminstanceListResponseItem"
12870
13112
  },
12871
13113
  "x-displayname": "Items",
13114
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
13115
+ "x-f5xc-description-short": "Items represents the collection in response.",
12872
13116
  "x-f5xc-required-for": {
12873
13117
  "minimum_config": false,
12874
13118
  "create": false,
@@ -12902,6 +13146,8 @@
12902
13146
  "description": "The set of annotations present on this cminstance.",
12903
13147
  "title": "Annotations.",
12904
13148
  "x-displayname": "Annotations.",
13149
+ "x-f5xc-example": "{\"key\": \"value\"}",
13150
+ "x-f5xc-description-short": "The set of annotations present on this cminstance.",
12905
13151
  "x-f5xc-required-for": {
12906
13152
  "minimum_config": false,
12907
13153
  "create": false,
@@ -12914,6 +13160,7 @@
12914
13160
  "description": "The description set for this cminstance.",
12915
13161
  "title": "Description.",
12916
13162
  "x-displayname": "Description.",
13163
+ "x-f5xc-description-short": "The description set for this cminstance.",
12917
13164
  "minLength": 0,
12918
13165
  "maxLength": 0,
12919
13166
  "x-f5xc-required-for": {
@@ -12924,7 +13171,7 @@
12924
13171
  },
12925
13172
  "x-original-maxLength": 1024,
12926
13173
  "x-reconciled-from-discovery": true,
12927
- "x-reconciled-at": "2026-01-05T18:28:53.997643+00:00"
13174
+ "x-reconciled-at": "2026-01-07T15:52:46.877944+00:00"
12928
13175
  },
12929
13176
  "disabled": {
12930
13177
  "type": "boolean",
@@ -12932,6 +13179,8 @@
12932
13179
  "title": "Disabled",
12933
13180
  "format": "boolean",
12934
13181
  "x-displayname": "Disabled",
13182
+ "x-f5xc-example": "True",
13183
+ "x-f5xc-description-short": "Value of true indicates cminstance is administratively disabled.",
12935
13184
  "x-f5xc-required-for": {
12936
13185
  "minimum_config": false,
12937
13186
  "create": false,
@@ -12947,6 +13196,8 @@
12947
13196
  "description": "The set of labels present on this cminstance.",
12948
13197
  "title": "Labels",
12949
13198
  "x-displayname": "Labels",
13199
+ "x-f5xc-example": "{\"key\": \"value\"}",
13200
+ "x-f5xc-description-short": "The set of labels present on this cminstance.",
12950
13201
  "x-f5xc-required-for": {
12951
13202
  "minimum_config": false,
12952
13203
  "create": false,
@@ -12974,7 +13225,7 @@
12974
13225
  },
12975
13226
  "x-original-maxLength": 1024,
12976
13227
  "x-reconciled-from-discovery": true,
12977
- "x-reconciled-at": "2026-01-05T18:28:53.997655+00:00"
13228
+ "x-reconciled-at": "2026-01-07T15:52:46.877954+00:00"
12978
13229
  },
12979
13230
  "namespace": {
12980
13231
  "type": "string",
@@ -12993,7 +13244,7 @@
12993
13244
  },
12994
13245
  "x-original-maxLength": 1024,
12995
13246
  "x-reconciled-from-discovery": true,
12996
- "x-reconciled-at": "2026-01-05T18:28:53.997659+00:00"
13247
+ "x-reconciled-at": "2026-01-07T15:52:46.877958+00:00"
12997
13248
  },
12998
13249
  "owner_view": {
12999
13250
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -13006,6 +13257,7 @@
13006
13257
  "$ref": "#/components/schemas/cminstanceStatusObject"
13007
13258
  },
13008
13259
  "x-displayname": "Status",
13260
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
13009
13261
  "x-f5xc-required-for": {
13010
13262
  "minimum_config": false,
13011
13263
  "create": false,
@@ -13034,7 +13286,7 @@
13034
13286
  "x-field-mutability": "read-only",
13035
13287
  "x-original-maxLength": 1024,
13036
13288
  "x-reconciled-from-discovery": true,
13037
- "x-reconciled-at": "2026-01-05T18:28:53.997667+00:00"
13289
+ "x-reconciled-at": "2026-01-07T15:52:46.877966+00:00"
13038
13290
  },
13039
13291
  "uid": {
13040
13292
  "type": "string",
@@ -13055,9 +13307,11 @@
13055
13307
  "x-original-maxLength": 1024,
13056
13308
  "format": "uuid",
13057
13309
  "x-reconciled-from-discovery": true,
13058
- "x-reconciled-at": "2026-01-05T18:28:53.997673+00:00"
13310
+ "x-reconciled-at": "2026-01-07T15:52:46.877972+00:00"
13059
13311
  }
13060
13312
  },
13313
+ "x-f5xc-description-short": "By default a summary of cminstance is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
13314
+ "x-f5xc-description-medium": "By default a summary of cminstance is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
13061
13315
  "x-f5xc-minimum-configuration": {
13062
13316
  "description": "Minimum configuration for cminstanceListResponseItem",
13063
13317
  "required_fields": [
@@ -13156,6 +13410,7 @@
13156
13410
  "ves.io.schema.rules.uint32.gte": "1",
13157
13411
  "ves.io.schema.rules.uint32.lte": "65535"
13158
13412
  },
13413
+ "x-f5xc-description-short": "Port of the Central Manager instance to connect to Required: YES.",
13159
13414
  "minimum": 1,
13160
13415
  "maximum": 65535,
13161
13416
  "x-f5xc-required-for": {
@@ -13184,6 +13439,7 @@
13184
13439
  "ves.io.schema.rules.string.max_len": "128",
13185
13440
  "ves.io.schema.rules.string.min_len": "4"
13186
13441
  },
13442
+ "x-f5xc-description-short": "Username for the Central Manager instance Required: YES.",
13187
13443
  "x-f5xc-required-for": {
13188
13444
  "minimum_config": false,
13189
13445
  "create": false,
@@ -13192,6 +13448,8 @@
13192
13448
  }
13193
13449
  }
13194
13450
  },
13451
+ "x-f5xc-description-short": "Update the configuration by replacing the existing spec with the provided one.",
13452
+ "x-f5xc-description-medium": "Update the configuration by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
13195
13453
  "x-f5xc-minimum-configuration": {
13196
13454
  "description": "Minimum configuration for cminstanceReplaceSpecType",
13197
13455
  "required_fields": [
@@ -13249,6 +13507,7 @@
13249
13507
  }
13250
13508
  }
13251
13509
  },
13510
+ "x-f5xc-description-short": "Most recently observed status of object.",
13252
13511
  "x-f5xc-minimum-configuration": {
13253
13512
  "description": "Minimum configuration for cminstanceStatusObject",
13254
13513
  "required_fields": [
@@ -13278,6 +13537,8 @@
13278
13537
  "x-displayname": "Decryption Provider.",
13279
13538
  "x-ves-example": "Value",
13280
13539
  "x-f5xc-example": "value",
13540
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
13541
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
13281
13542
  "minLength": 0,
13282
13543
  "maxLength": 1024,
13283
13544
  "x-f5xc-required-for": {
@@ -13303,6 +13564,8 @@
13303
13564
  "ves.io.schema.rules.message.required": "true",
13304
13565
  "ves.io.schema.rules.string.uri_ref": "true"
13305
13566
  },
13567
+ "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.",
13568
+ "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.",
13306
13569
  "minLength": 0,
13307
13570
  "maxLength": 4,
13308
13571
  "x-f5xc-required-for": {
@@ -13313,7 +13576,7 @@
13313
13576
  },
13314
13577
  "x-original-maxLength": 1024,
13315
13578
  "x-reconciled-from-discovery": true,
13316
- "x-reconciled-at": "2026-01-05T18:28:53.997702+00:00"
13579
+ "x-reconciled-at": "2026-01-07T15:52:46.878000+00:00"
13317
13580
  },
13318
13581
  "store_provider": {
13319
13582
  "type": "string",
@@ -13322,6 +13585,8 @@
13322
13585
  "x-displayname": "Store Provider.",
13323
13586
  "x-ves-example": "Value",
13324
13587
  "x-f5xc-example": "value",
13588
+ "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...",
13589
+ "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:///.",
13325
13590
  "minLength": 0,
13326
13591
  "maxLength": 1024,
13327
13592
  "x-f5xc-required-for": {
@@ -13332,6 +13597,7 @@
13332
13597
  }
13333
13598
  }
13334
13599
  },
13600
+ "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
13335
13601
  "x-f5xc-minimum-configuration": {
13336
13602
  "description": "Minimum configuration for schemaBlindfoldSecretInfoType",
13337
13603
  "required_fields": [
@@ -13361,6 +13627,8 @@
13361
13627
  "x-displayname": "Provider",
13362
13628
  "x-ves-example": "Box-provider.",
13363
13629
  "x-f5xc-example": "box-provider",
13630
+ "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...",
13631
+ "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:///.",
13364
13632
  "minLength": 0,
13365
13633
  "maxLength": 8,
13366
13634
  "x-f5xc-required-for": {
@@ -13371,7 +13639,7 @@
13371
13639
  },
13372
13640
  "x-original-maxLength": 1024,
13373
13641
  "x-reconciled-from-discovery": true,
13374
- "x-reconciled-at": "2026-01-05T18:28:53.997709+00:00"
13642
+ "x-reconciled-at": "2026-01-07T15:52:46.878006+00:00"
13375
13643
  },
13376
13644
  "url": {
13377
13645
  "type": "string",
@@ -13392,6 +13660,8 @@
13392
13660
  "ves.io.schema.rules.string.max_bytes": "131072",
13393
13661
  "ves.io.schema.rules.string.uri_ref": "true"
13394
13662
  },
13663
+ "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
13664
+ "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.",
13395
13665
  "format": "uri",
13396
13666
  "minLength": 0,
13397
13667
  "x-f5xc-required-for": {
@@ -13402,6 +13672,7 @@
13402
13672
  }
13403
13673
  }
13404
13674
  },
13675
+ "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
13405
13676
  "x-f5xc-minimum-configuration": {
13406
13677
  "description": "Minimum configuration for schemaClearSecretInfoType",
13407
13678
  "required_fields": [
@@ -13435,6 +13706,7 @@
13435
13706
  "x-validation-rules": {
13436
13707
  "ves.io.schema.rules.string.ipv4": "true"
13437
13708
  },
13709
+ "x-f5xc-description-short": "IPv4 Address in string form with dot-decimal notation.",
13438
13710
  "minLength": 0,
13439
13711
  "maxLength": 1024,
13440
13712
  "x-f5xc-required-for": {
@@ -13466,6 +13738,8 @@
13466
13738
  "EncodingBase64"
13467
13739
  ],
13468
13740
  "default": "EncodingNone",
13741
+ "x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
13742
+ "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.",
13469
13743
  "x-f5xc-minimum-configuration": {
13470
13744
  "description": "Minimum configuration for schemaSecretEncodingType",
13471
13745
  "required_fields": [],
@@ -13491,6 +13765,7 @@
13491
13765
  "$ref": "#/components/schemas/schemaClearSecretInfoType"
13492
13766
  }
13493
13767
  },
13768
+ "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
13494
13769
  "x-f5xc-minimum-configuration": {
13495
13770
  "description": "Minimum configuration for schemaSecretType",
13496
13771
  "required_fields": [
@@ -13514,6 +13789,8 @@
13514
13789
  "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.",
13515
13790
  "title": "Key",
13516
13791
  "x-f5xc-example": "key_pem",
13792
+ "x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
13793
+ "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.",
13517
13794
  "minLength": 0,
13518
13795
  "maxLength": 16,
13519
13796
  "x-f5xc-required-for": {
@@ -13524,13 +13801,14 @@
13524
13801
  },
13525
13802
  "x-original-maxLength": 1024,
13526
13803
  "x-reconciled-from-discovery": true,
13527
- "x-reconciled-at": "2026-01-05T18:28:53.997888+00:00"
13804
+ "x-reconciled-at": "2026-01-07T15:52:46.878178+00:00"
13528
13805
  },
13529
13806
  "location": {
13530
13807
  "type": "string",
13531
13808
  "description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
13532
13809
  "title": "Location",
13533
13810
  "x-f5xc-example": "v1/data/vhost_key",
13811
+ "x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
13534
13812
  "minLength": 0,
13535
13813
  "maxLength": 4,
13536
13814
  "x-f5xc-required-for": {
@@ -13541,13 +13819,15 @@
13541
13819
  },
13542
13820
  "x-original-maxLength": 1024,
13543
13821
  "x-reconciled-from-discovery": true,
13544
- "x-reconciled-at": "2026-01-05T18:28:53.997893+00:00"
13822
+ "x-reconciled-at": "2026-01-07T15:52:46.878182+00:00"
13545
13823
  },
13546
13824
  "provider": {
13547
13825
  "type": "string",
13548
13826
  "description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
13549
13827
  "title": "Provider",
13550
13828
  "x-f5xc-example": "vault-vh-provider",
13829
+ "x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
13830
+ "x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
13551
13831
  "minLength": 0,
13552
13832
  "maxLength": 8,
13553
13833
  "x-f5xc-required-for": {
@@ -13558,7 +13838,7 @@
13558
13838
  },
13559
13839
  "x-original-maxLength": 1024,
13560
13840
  "x-reconciled-from-discovery": true,
13561
- "x-reconciled-at": "2026-01-05T18:28:53.997897+00:00"
13841
+ "x-reconciled-at": "2026-01-07T15:52:46.878186+00:00"
13562
13842
  },
13563
13843
  "secret_encoding": {
13564
13844
  "$ref": "#/components/schemas/schemaSecretEncodingType"
@@ -13569,6 +13849,8 @@
13569
13849
  "title": "Version",
13570
13850
  "format": "int64",
13571
13851
  "x-f5xc-example": "1",
13852
+ "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.",
13853
+ "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.",
13572
13854
  "minimum": 0,
13573
13855
  "maximum": 2147483647,
13574
13856
  "x-f5xc-required-for": {
@@ -13580,9 +13862,11 @@
13580
13862
  "maxLength": 1,
13581
13863
  "minLength": 1,
13582
13864
  "x-reconciled-from-discovery": true,
13583
- "x-reconciled-at": "2026-01-05T18:28:53.997904+00:00"
13865
+ "x-reconciled-at": "2026-01-07T15:52:46.878193+00:00"
13584
13866
  }
13585
13867
  },
13868
+ "x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
13869
+ "x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
13586
13870
  "x-f5xc-minimum-configuration": {
13587
13871
  "description": "Minimum configuration for schemaVaultSecretInfoType",
13588
13872
  "required_fields": [
@@ -13609,6 +13893,7 @@
13609
13893
  "description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
13610
13894
  "title": "Name",
13611
13895
  "x-f5xc-example": "ChargeBack-API-Key",
13896
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
13612
13897
  "minLength": 0,
13613
13898
  "maxLength": 16,
13614
13899
  "x-f5xc-required-for": {
@@ -13619,9 +13904,10 @@
13619
13904
  },
13620
13905
  "x-original-maxLength": 1024,
13621
13906
  "x-reconciled-from-discovery": true,
13622
- "x-reconciled-at": "2026-01-05T18:28:53.997929+00:00"
13907
+ "x-reconciled-at": "2026-01-07T15:52:46.878217+00:00"
13623
13908
  }
13624
13909
  },
13910
+ "x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
13625
13911
  "x-f5xc-minimum-configuration": {
13626
13912
  "description": "Minimum configuration for schemaWingmanSecretInfoType",
13627
13913
  "required_fields": [
@@ -13638,6 +13924,7 @@
13638
13924
  "type": "object",
13639
13925
  "description": "X-displayName: \"Direct Connection Type\"\nExternal Connector with direct connection.",
13640
13926
  "title": "Direct Connection Type.",
13927
+ "x-f5xc-description-short": "X-displayName: \"Direct Connection Type\" External Connector with direct connection.",
13641
13928
  "x-f5xc-minimum-configuration": {
13642
13929
  "description": "Minimum configuration for external_connectorConnectionTypeDirect",
13643
13930
  "required_fields": [],
@@ -13657,6 +13944,7 @@
13657
13944
  "$ref": "#/components/schemas/external_connectorGRETunnelParameters"
13658
13945
  }
13659
13946
  },
13947
+ "x-f5xc-description-short": "X-displayName: \"GRE\" External Connector with GRE tunnel.",
13660
13948
  "x-f5xc-minimum-configuration": {
13661
13949
  "description": "Minimum configuration for external_connectorConnectionTypeGRE",
13662
13950
  "required_fields": [
@@ -13767,6 +14055,7 @@
13767
14055
  "$ref": "#/components/schemas/external_connectorConnectionTypeIPSec"
13768
14056
  }
13769
14057
  },
14058
+ "x-f5xc-description-short": "Shape of the external_connector configuration specification.",
13770
14059
  "x-f5xc-minimum-configuration": {
13771
14060
  "description": "Minimum configuration for external_connectorCreateSpecType",
13772
14061
  "required_fields": [
@@ -13793,6 +14082,7 @@
13793
14082
  "title": "Fail_if_referred.",
13794
14083
  "format": "boolean",
13795
14084
  "x-displayname": "Fail-If-Referred.",
14085
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
13796
14086
  "x-f5xc-required-for": {
13797
14087
  "minimum_config": false,
13798
14088
  "create": false,
@@ -13817,7 +14107,7 @@
13817
14107
  },
13818
14108
  "x-original-maxLength": 1024,
13819
14109
  "x-reconciled-from-discovery": true,
13820
- "x-reconciled-at": "2026-01-05T18:29:17.720991+00:00"
14110
+ "x-reconciled-at": "2026-01-07T15:53:16.687028+00:00"
13821
14111
  },
13822
14112
  "namespace": {
13823
14113
  "type": "string",
@@ -13826,6 +14116,7 @@
13826
14116
  "x-displayname": "Namespace",
13827
14117
  "x-ves-example": "Ns1",
13828
14118
  "x-f5xc-example": "ns1",
14119
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
13829
14120
  "minLength": 0,
13830
14121
  "maxLength": 6,
13831
14122
  "x-f5xc-required-for": {
@@ -13836,7 +14127,7 @@
13836
14127
  },
13837
14128
  "x-original-maxLength": 1024,
13838
14129
  "x-reconciled-from-discovery": true,
13839
- "x-reconciled-at": "2026-01-05T18:29:17.720999+00:00"
14130
+ "x-reconciled-at": "2026-01-07T15:53:16.687035+00:00"
13840
14131
  }
13841
14132
  },
13842
14133
  "x-f5xc-minimum-configuration": {
@@ -13861,7 +14152,7 @@
13861
14152
  "properties": {
13862
14153
  "timeout": {
13863
14154
  "type": "integer",
13864
- "description": "",
14155
+ "description": "Operation timeout duration",
13865
14156
  "title": "Keepalive Timer.",
13866
14157
  "format": "int64",
13867
14158
  "x-displayname": "Keepalive Timer.",
@@ -13873,6 +14164,7 @@
13873
14164
  "ves.io.schema.rules.uint32.gte": "1",
13874
14165
  "ves.io.schema.rules.uint32.lte": "5"
13875
14166
  },
14167
+ "x-f5xc-example": "30s",
13876
14168
  "minimum": 0,
13877
14169
  "maximum": 2147483647,
13878
14170
  "x-f5xc-required-for": {
@@ -13919,6 +14211,8 @@
13919
14211
  "items": {
13920
14212
  "$ref": "#/components/schemas/external_connectorTunnelEndpoint"
13921
14213
  },
14214
+ "x-f5xc-description-short": "X-displayName: \"Tunnel Endpoint\" x-required Configure tunnel parameters, source, destination, IP addresses.",
14215
+ "x-f5xc-description-medium": "X-displayName: \"Tunnel Endpoint\" x-required Configure tunnel parameters, source, destination, IP addresses.",
13922
14216
  "x-f5xc-required-for": {
13923
14217
  "minimum_config": false,
13924
14218
  "create": false,
@@ -13931,6 +14225,7 @@
13931
14225
  "description": "X-displayName: \"Tunnel MTU\"\nConfigure MTU for the GRE tunnel interface.",
13932
14226
  "title": "Tunnel MTU.",
13933
14227
  "format": "int64",
14228
+ "x-f5xc-description-short": "X-displayName: \"Tunnel MTU\" Configure MTU for the GRE tunnel interface.",
13934
14229
  "minimum": 0,
13935
14230
  "maximum": 2147483647,
13936
14231
  "x-f5xc-required-for": {
@@ -13941,6 +14236,8 @@
13941
14236
  }
13942
14237
  }
13943
14238
  },
14239
+ "x-f5xc-description-short": "X-displayName: \"GRE Tunnel Parameters\" GRE configuration parameters required for GRE Connection type.",
14240
+ "x-f5xc-description-medium": "X-displayName: \"GRE Tunnel Parameters\" GRE configuration parameters required for GRE Connection type.",
13944
14241
  "x-f5xc-minimum-configuration": {
13945
14242
  "description": "Minimum configuration for external_connectorGRETunnelParameters",
13946
14243
  "required_fields": [
@@ -13976,6 +14273,7 @@
13976
14273
  "$ref": "#/components/schemas/ioschemaObjectRefType"
13977
14274
  },
13978
14275
  "x-displayname": "Deleted Referred Objects.",
14276
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13979
14277
  "x-f5xc-required-for": {
13980
14278
  "minimum_config": false,
13981
14279
  "create": false,
@@ -13991,6 +14289,7 @@
13991
14289
  "$ref": "#/components/schemas/ioschemaObjectRefType"
13992
14290
  },
13993
14291
  "x-displayname": "Disabled Referred Objects.",
14292
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
13994
14293
  "x-f5xc-required-for": {
13995
14294
  "minimum_config": false,
13996
14295
  "create": false,
@@ -14009,6 +14308,7 @@
14009
14308
  "$ref": "#/components/schemas/ioschemaObjectRefType"
14010
14309
  },
14011
14310
  "x-displayname": "Referring Objects.",
14311
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
14012
14312
  "x-f5xc-required-for": {
14013
14313
  "minimum_config": false,
14014
14314
  "create": false,
@@ -14030,6 +14330,8 @@
14030
14330
  "$ref": "#/components/schemas/external_connectorStatusObject"
14031
14331
  },
14032
14332
  "x-displayname": "Status",
14333
+ "x-f5xc-example": "active",
14334
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
14033
14335
  "x-f5xc-required-for": {
14034
14336
  "minimum_config": false,
14035
14337
  "create": false,
@@ -14039,7 +14341,7 @@
14039
14341
  "maxLength": 17,
14040
14342
  "minLength": 17,
14041
14343
  "x-reconciled-from-discovery": true,
14042
- "x-reconciled-at": "2026-01-05T18:29:17.721025+00:00"
14344
+ "x-reconciled-at": "2026-01-07T15:53:16.687061+00:00"
14043
14345
  },
14044
14346
  "system_metadata": {
14045
14347
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -14079,6 +14381,8 @@
14079
14381
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
14080
14382
  ],
14081
14383
  "default": "GET_RSP_FORMAT_DEFAULT",
14384
+ "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...",
14385
+ "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...",
14082
14386
  "x-f5xc-minimum-configuration": {
14083
14387
  "description": "Minimum configuration for external_connectorGetResponseFormatCode",
14084
14388
  "required_fields": [],
@@ -14105,6 +14409,7 @@
14105
14409
  "$ref": "#/components/schemas/external_connectorConnectionTypeIPSec"
14106
14410
  }
14107
14411
  },
14412
+ "x-f5xc-description-short": "Shape of the external_connector configuration specification.",
14108
14413
  "x-f5xc-minimum-configuration": {
14109
14414
  "description": "Minimum configuration for external_connectorGetSpecType",
14110
14415
  "required_fields": [
@@ -14152,6 +14457,8 @@
14152
14457
  "description": "Exclusive with [rm_ip_address use_default_remote_ike_id]\nConfigure an hostname Remote IKE ID.",
14153
14458
  "title": "Hostname",
14154
14459
  "x-displayname": "Hostname",
14460
+ "x-f5xc-example": "example-resource",
14461
+ "x-f5xc-description-short": "Exclusive with [rm_ip_address use_default_remote_ike_id] Configure an hostname Remote IKE ID.",
14155
14462
  "minLength": 0,
14156
14463
  "maxLength": 1024,
14157
14464
  "x-f5xc-required-for": {
@@ -14171,6 +14478,7 @@
14171
14478
  "$ref": "#/components/schemas/ioschemaEmpty"
14172
14479
  }
14173
14480
  },
14481
+ "x-f5xc-description-short": "IKE configuration parameters required for IPsec Connection type.",
14174
14482
  "x-f5xc-minimum-configuration": {
14175
14483
  "description": "Minimum configuration for external_connectorIkeParameters",
14176
14484
  "required_fields": [
@@ -14207,6 +14515,7 @@
14207
14515
  "$ref": "#/components/schemas/schemaErrorType"
14208
14516
  },
14209
14517
  "x-displayname": "Errors",
14518
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
14210
14519
  "x-f5xc-required-for": {
14211
14520
  "minimum_config": false,
14212
14521
  "create": false,
@@ -14222,6 +14531,8 @@
14222
14531
  "$ref": "#/components/schemas/external_connectorListResponseItem"
14223
14532
  },
14224
14533
  "x-displayname": "Items",
14534
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
14535
+ "x-f5xc-description-short": "Items represents the collection in response.",
14225
14536
  "x-f5xc-required-for": {
14226
14537
  "minimum_config": false,
14227
14538
  "create": false,
@@ -14255,6 +14566,8 @@
14255
14566
  "description": "The set of annotations present on this external_connector.",
14256
14567
  "title": "Annotations.",
14257
14568
  "x-displayname": "Annotations.",
14569
+ "x-f5xc-example": "{\"key\": \"value\"}",
14570
+ "x-f5xc-description-short": "The set of annotations present on this external_connector.",
14258
14571
  "x-f5xc-required-for": {
14259
14572
  "minimum_config": false,
14260
14573
  "create": false,
@@ -14267,6 +14580,7 @@
14267
14580
  "description": "The description set for this external_connector.",
14268
14581
  "title": "Description.",
14269
14582
  "x-displayname": "Description.",
14583
+ "x-f5xc-description-short": "The description set for this external_connector.",
14270
14584
  "minLength": 0,
14271
14585
  "maxLength": 0,
14272
14586
  "x-f5xc-required-for": {
@@ -14277,7 +14591,7 @@
14277
14591
  },
14278
14592
  "x-original-maxLength": 1024,
14279
14593
  "x-reconciled-from-discovery": true,
14280
- "x-reconciled-at": "2026-01-05T18:29:17.721064+00:00"
14594
+ "x-reconciled-at": "2026-01-07T15:53:16.687088+00:00"
14281
14595
  },
14282
14596
  "disabled": {
14283
14597
  "type": "boolean",
@@ -14285,6 +14599,8 @@
14285
14599
  "title": "Disabled",
14286
14600
  "format": "boolean",
14287
14601
  "x-displayname": "Disabled",
14602
+ "x-f5xc-example": "True",
14603
+ "x-f5xc-description-short": "Value of true indicates external_connector is administratively disabled.",
14288
14604
  "x-f5xc-required-for": {
14289
14605
  "minimum_config": false,
14290
14606
  "create": false,
@@ -14300,6 +14616,8 @@
14300
14616
  "description": "The set of labels present on this external_connector.",
14301
14617
  "title": "Labels",
14302
14618
  "x-displayname": "Labels",
14619
+ "x-f5xc-example": "{\"key\": \"value\"}",
14620
+ "x-f5xc-description-short": "The set of labels present on this external_connector.",
14303
14621
  "x-f5xc-required-for": {
14304
14622
  "minimum_config": false,
14305
14623
  "create": false,
@@ -14327,7 +14645,7 @@
14327
14645
  },
14328
14646
  "x-original-maxLength": 1024,
14329
14647
  "x-reconciled-from-discovery": true,
14330
- "x-reconciled-at": "2026-01-05T18:29:17.721075+00:00"
14648
+ "x-reconciled-at": "2026-01-07T15:53:16.687098+00:00"
14331
14649
  },
14332
14650
  "namespace": {
14333
14651
  "type": "string",
@@ -14346,7 +14664,7 @@
14346
14664
  },
14347
14665
  "x-original-maxLength": 1024,
14348
14666
  "x-reconciled-from-discovery": true,
14349
- "x-reconciled-at": "2026-01-05T18:29:17.721079+00:00"
14667
+ "x-reconciled-at": "2026-01-07T15:53:16.687102+00:00"
14350
14668
  },
14351
14669
  "owner_view": {
14352
14670
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -14359,6 +14677,7 @@
14359
14677
  "$ref": "#/components/schemas/external_connectorStatusObject"
14360
14678
  },
14361
14679
  "x-displayname": "Status",
14680
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
14362
14681
  "x-f5xc-required-for": {
14363
14682
  "minimum_config": false,
14364
14683
  "create": false,
@@ -14387,7 +14706,7 @@
14387
14706
  "x-field-mutability": "read-only",
14388
14707
  "x-original-maxLength": 1024,
14389
14708
  "x-reconciled-from-discovery": true,
14390
- "x-reconciled-at": "2026-01-05T18:29:17.721087+00:00"
14709
+ "x-reconciled-at": "2026-01-07T15:53:16.687110+00:00"
14391
14710
  },
14392
14711
  "uid": {
14393
14712
  "type": "string",
@@ -14396,6 +14715,7 @@
14396
14715
  "x-displayname": "UID",
14397
14716
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
14398
14717
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
14718
+ "x-f5xc-description-short": "The unique uid of this external_connector.",
14399
14719
  "minLength": 0,
14400
14720
  "maxLength": 36,
14401
14721
  "x-f5xc-required-for": {
@@ -14408,9 +14728,11 @@
14408
14728
  "x-original-maxLength": 1024,
14409
14729
  "format": "uuid",
14410
14730
  "x-reconciled-from-discovery": true,
14411
- "x-reconciled-at": "2026-01-05T18:29:17.721093+00:00"
14731
+ "x-reconciled-at": "2026-01-07T15:53:16.687116+00:00"
14412
14732
  }
14413
14733
  },
14734
+ "x-f5xc-description-short": "By default a summary of external_connector is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
14735
+ "x-f5xc-description-medium": "By default a summary of external_connector is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
14414
14736
  "x-f5xc-minimum-configuration": {
14415
14737
  "description": "Minimum configuration for external_connectorListResponseItem",
14416
14738
  "required_fields": [
@@ -14491,6 +14813,7 @@
14491
14813
  "$ref": "#/components/schemas/external_connectorConnectionTypeIPSec"
14492
14814
  }
14493
14815
  },
14816
+ "x-f5xc-description-short": "Shape of the external_connector configuration specification.",
14494
14817
  "x-f5xc-minimum-configuration": {
14495
14818
  "description": "Minimum configuration for external_connectorReplaceSpecType",
14496
14819
  "required_fields": [
@@ -14519,6 +14842,7 @@
14519
14842
  "$ref": "#/components/schemas/schemaConditionType"
14520
14843
  },
14521
14844
  "x-displayname": "Conditions.",
14845
+ "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.",
14522
14846
  "x-f5xc-required-for": {
14523
14847
  "minimum_config": false,
14524
14848
  "create": false,
@@ -14545,6 +14869,7 @@
14545
14869
  }
14546
14870
  }
14547
14871
  },
14872
+ "x-f5xc-description-short": "Most recently observed status of object.",
14548
14873
  "x-f5xc-minimum-configuration": {
14549
14874
  "description": "Minimum configuration for external_connectorStatusObject",
14550
14875
  "required_fields": [
@@ -14579,6 +14904,7 @@
14579
14904
  "x-validation-rules": {
14580
14905
  "ves.io.schema.rules.message.required": "true"
14581
14906
  },
14907
+ "x-f5xc-description-short": "For the chosen node, specify the interface that will be the tunnel source. Required: YES.",
14582
14908
  "minLength": 0,
14583
14909
  "maxLength": 1024,
14584
14910
  "x-f5xc-required-for": {
@@ -14604,6 +14930,8 @@
14604
14930
  "ves.io.schema.rules.message.required": "true",
14605
14931
  "ves.io.schema.rules.string.ipv4_prefix": "true"
14606
14932
  },
14933
+ "x-f5xc-description-short": "For a particular tunnel on a node, specify the local tunnel IP Address i.e.",
14934
+ "x-f5xc-description-medium": "For a particular tunnel on a node, specify the local tunnel IP Address i.e. The IP address of the tunnel on the CE node itself and a subnet prefix length Required: YES.",
14607
14935
  "minLength": 0,
14608
14936
  "maxLength": 1024,
14609
14937
  "x-f5xc-required-for": {
@@ -14625,6 +14953,8 @@
14625
14953
  "x-validation-rules": {
14626
14954
  "ves.io.schema.rules.message.required": "true"
14627
14955
  },
14956
+ "x-f5xc-description-short": "CE site is composed of multiple nodes. Choose a node that will be part of this external connection.",
14957
+ "x-f5xc-description-medium": "CE site is composed of multiple nodes. Choose a node that will be part of this external connection. Required: YES.",
14628
14958
  "minLength": 0,
14629
14959
  "maxLength": 1024,
14630
14960
  "x-f5xc-required-for": {
@@ -14650,6 +14980,8 @@
14650
14980
  "ves.io.schema.rules.message.required": "true",
14651
14981
  "ves.io.schema.rules.string.ipv4_prefix": "true"
14652
14982
  },
14983
+ "x-f5xc-description-short": "For a particular tunnel on a node, specify the remote tunnel IP Address i.e.",
14984
+ "x-f5xc-description-medium": "For a particular tunnel on a node, specify the remote tunnel IP Address i.e. The IP address of the tunnel on the remote gateway and a subnet prefix length Required: YES.",
14653
14985
  "minLength": 0,
14654
14986
  "maxLength": 1024,
14655
14987
  "x-f5xc-required-for": {
@@ -14660,6 +14992,7 @@
14660
14992
  }
14661
14993
  }
14662
14994
  },
14995
+ "x-f5xc-description-short": "Configure tunnel endpoints, local and remote IP addresses.",
14663
14996
  "x-f5xc-minimum-configuration": {
14664
14997
  "description": "Minimum configuration for external_connectorTunnelEndpoint",
14665
14998
  "required_fields": [
@@ -14698,6 +15031,8 @@
14698
15031
  "x-validation-rules": {
14699
15032
  "ves.io.schema.rules.message.required": "true"
14700
15033
  },
15034
+ "x-f5xc-description-short": "The IKE pre-shared key (PSK) is required to ensure the IKE peers can authenticate one another within IKE phase 1 negotiation.",
15035
+ "x-f5xc-description-medium": "The IKE pre-shared key (PSK) is required to ensure the IKE peers can authenticate one another within IKE phase 1 negotiation. Required: YES.",
14701
15036
  "minLength": 0,
14702
15037
  "maxLength": 1024,
14703
15038
  "x-f5xc-required-for": {
@@ -14737,6 +15072,7 @@
14737
15072
  "ves.io.schema.rules.repeated.max_items": "4",
14738
15073
  "ves.io.schema.rules.repeated.min_items": "1"
14739
15074
  },
15075
+ "x-f5xc-description-short": "Configure tunnel parameters, local and remote IP addresses Required: YES.",
14740
15076
  "x-f5xc-required-for": {
14741
15077
  "minimum_config": false,
14742
15078
  "create": false,
@@ -14761,6 +15097,8 @@
14761
15097
  "ves.io.schema.rules.uint32.gte": "512",
14762
15098
  "ves.io.schema.rules.uint32.lte": "1370"
14763
15099
  },
15100
+ "x-f5xc-description-short": "The tunnel MTU defines the maximum size of the packet that can be sent through the tunnel without needing to be fragmented Required: YES.",
15101
+ "x-f5xc-description-medium": "The tunnel MTU defines the maximum size of the packet that can be sent through the tunnel without needing to be fragmented Required: YES.",
14764
15102
  "minimum": 0,
14765
15103
  "maximum": 2147483647,
14766
15104
  "x-f5xc-required-for": {
@@ -14771,6 +15109,8 @@
14771
15109
  }
14772
15110
  }
14773
15111
  },
15112
+ "x-f5xc-description-short": "In this section, we will configure the tunnel parameters, source, destination, IP addresses, and segment.",
15113
+ "x-f5xc-description-medium": "In this section, we will configure the tunnel parameters, source, destination, IP addresses, and segment.",
14774
15114
  "x-f5xc-minimum-configuration": {
14775
15115
  "description": "Minimum configuration for external_connectorTunnelParameters",
14776
15116
  "required_fields": [
@@ -14805,6 +15145,7 @@
14805
15145
  "$ref": "#/components/schemas/schemaIpv6AddressType"
14806
15146
  }
14807
15147
  },
15148
+ "x-f5xc-description-short": "IP Address used to specify an IPv4 or IPv6 address.",
14808
15149
  "x-f5xc-minimum-configuration": {
14809
15150
  "description": "Minimum configuration for schemaIpAddressType",
14810
15151
  "required_fields": [
@@ -14838,6 +15179,7 @@
14838
15179
  "x-validation-rules": {
14839
15180
  "ves.io.schema.rules.string.ipv6": "true"
14840
15181
  },
15182
+ "x-f5xc-description-medium": "IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':' The address can be compacted by suppressing zeros e.g. '2001:db8:0:0:0:0:2:1' becomes '2001:db8::2:1' or '2001:db8:0:0:0:2:0:0' becomes '2001:db8::2::'.",
14841
15183
  "minLength": 0,
14842
15184
  "maxLength": 1024,
14843
15185
  "x-f5xc-required-for": {
@@ -14848,6 +15190,7 @@
14848
15190
  }
14849
15191
  }
14850
15192
  },
15193
+ "x-f5xc-description-short": "IPv6 Address specified as hexadecimal numbers separated by ':'.",
14851
15194
  "x-f5xc-minimum-configuration": {
14852
15195
  "description": "Minimum configuration for schemaIpv6AddressType",
14853
15196
  "required_fields": [
@@ -14885,6 +15228,7 @@
14885
15228
  "ves.io.schema.rules.message.required": "true",
14886
15229
  "ves.io.schema.rules.repeated.max_items": "1"
14887
15230
  },
15231
+ "x-f5xc-description-short": "Reference to Segment Object Required: YES.",
14888
15232
  "x-f5xc-required-for": {
14889
15233
  "minimum_config": false,
14890
15234
  "create": false,
@@ -14920,6 +15264,7 @@
14920
15264
  "$ref": "#/components/schemas/schemaObjectRefType"
14921
15265
  },
14922
15266
  "x-displayname": "Deleted Referred Objects.",
15267
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
14923
15268
  "x-f5xc-required-for": {
14924
15269
  "minimum_config": false,
14925
15270
  "create": false,
@@ -14935,6 +15280,7 @@
14935
15280
  "$ref": "#/components/schemas/schemaObjectRefType"
14936
15281
  },
14937
15282
  "x-displayname": "Disabled Referred Objects.",
15283
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
14938
15284
  "x-f5xc-required-for": {
14939
15285
  "minimum_config": false,
14940
15286
  "create": false,
@@ -14953,6 +15299,7 @@
14953
15299
  "$ref": "#/components/schemas/schemaObjectRefType"
14954
15300
  },
14955
15301
  "x-displayname": "Referring Objects.",
15302
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
14956
15303
  "x-f5xc-required-for": {
14957
15304
  "minimum_config": false,
14958
15305
  "create": false,
@@ -14971,6 +15318,8 @@
14971
15318
  "$ref": "#/components/schemas/navigation_tileStatusObject"
14972
15319
  },
14973
15320
  "x-displayname": "Status",
15321
+ "x-f5xc-example": "active",
15322
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
14974
15323
  "x-f5xc-required-for": {
14975
15324
  "minimum_config": false,
14976
15325
  "create": false,
@@ -14980,7 +15329,7 @@
14980
15329
  "maxLength": 17,
14981
15330
  "minLength": 17,
14982
15331
  "x-reconciled-from-discovery": true,
14983
- "x-reconciled-at": "2026-01-05T18:29:38.110555+00:00"
15332
+ "x-reconciled-at": "2026-01-07T15:53:43.088915+00:00"
14984
15333
  },
14985
15334
  "system_metadata": {
14986
15335
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -15016,6 +15365,8 @@
15016
15365
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
15017
15366
  ],
15018
15367
  "default": "GET_RSP_FORMAT_DEFAULT",
15368
+ "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...",
15369
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\" Response should be in...",
15019
15370
  "x-f5xc-minimum-configuration": {
15020
15371
  "description": "Minimum configuration for navigation_tileGetResponseFormatCode",
15021
15372
  "required_fields": [],
@@ -15050,6 +15401,7 @@
15050
15401
  "ves.io.schema.rules.repeated.max_items": "64",
15051
15402
  "ves.io.schema.rules.repeated.unique": "true"
15052
15403
  },
15404
+ "x-f5xc-description-short": "List of addon services linked to this navigation tile.",
15053
15405
  "x-f5xc-required-for": {
15054
15406
  "minimum_config": false,
15055
15407
  "create": false,
@@ -15068,6 +15420,8 @@
15068
15420
  "x-validation-rules": {
15069
15421
  "ves.io.schema.rules.string.max_len": "256"
15070
15422
  },
15423
+ "x-f5xc-description-short": "Default addon service landing page. Used as primary when multiple addon services are present.",
15424
+ "x-f5xc-description-medium": "Default addon service landing page. Used as primary when multiple addon services are present. Value should match the name of the addon service config object.",
15071
15425
  "minLength": 0,
15072
15426
  "x-f5xc-required-for": {
15073
15427
  "minimum_config": false,
@@ -15091,6 +15445,7 @@
15091
15445
  "ves.io.schema.rules.string.max_len": "512"
15092
15446
  },
15093
15447
  "x-f5xc-example": "example-resource",
15448
+ "x-f5xc-description-short": "User friendly name for display purpose. Required: YES.",
15094
15449
  "minLength": 0,
15095
15450
  "x-f5xc-required-for": {
15096
15451
  "minimum_config": false,
@@ -15104,6 +15459,7 @@
15104
15459
  "description": "Management flag is used to indicate that this tile is used for management purposes.",
15105
15460
  "format": "boolean",
15106
15461
  "x-displayname": "Management.",
15462
+ "x-f5xc-description-short": "Management flag is used to indicate that this tile is used for management purposes.",
15107
15463
  "x-f5xc-required-for": {
15108
15464
  "minimum_config": false,
15109
15465
  "create": false,
@@ -15127,6 +15483,7 @@
15127
15483
  "ves.io.schema.rules.repeated.max_items": "64",
15128
15484
  "ves.io.schema.rules.repeated.unique": "true"
15129
15485
  },
15486
+ "x-f5xc-description-short": "List of addon services required for this navigation tile to function.",
15130
15487
  "x-f5xc-required-for": {
15131
15488
  "minimum_config": false,
15132
15489
  "create": false,
@@ -15150,6 +15507,7 @@
15150
15507
  "ves.io.schema.rules.repeated.max_items": "32",
15151
15508
  "ves.io.schema.rules.repeated.unique": "true"
15152
15509
  },
15510
+ "x-f5xc-description-short": "List of pre-defined roles associated to this tile.",
15153
15511
  "x-f5xc-required-for": {
15154
15512
  "minimum_config": false,
15155
15513
  "create": false,
@@ -15164,6 +15522,8 @@
15164
15522
  "$ref": "#/components/schemas/schemaFeatureTag"
15165
15523
  },
15166
15524
  "x-displayname": "Tags",
15525
+ "x-f5xc-example": "{\"key\": \"value\"}",
15526
+ "x-f5xc-description-short": "Tag of the addon (new, basic level etc). Some tags may be combined e.g.",
15167
15527
  "x-f5xc-required-for": {
15168
15528
  "minimum_config": false,
15169
15529
  "create": false,
@@ -15172,6 +15532,7 @@
15172
15532
  }
15173
15533
  }
15174
15534
  },
15535
+ "x-f5xc-description-short": "GET navigation_tile reads a given object from storage backend for metadata.namespace.",
15175
15536
  "x-f5xc-minimum-configuration": {
15176
15537
  "description": "Minimum configuration for navigation_tileGetSpecType",
15177
15538
  "required_fields": [
@@ -15205,6 +15566,7 @@
15205
15566
  "$ref": "#/components/schemas/schemaErrorType"
15206
15567
  },
15207
15568
  "x-displayname": "Errors",
15569
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
15208
15570
  "x-f5xc-required-for": {
15209
15571
  "minimum_config": false,
15210
15572
  "create": false,
@@ -15220,6 +15582,8 @@
15220
15582
  "$ref": "#/components/schemas/navigation_tileListResponseItem"
15221
15583
  },
15222
15584
  "x-displayname": "Items",
15585
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
15586
+ "x-f5xc-description-short": "Items represents the collection in response.",
15223
15587
  "x-f5xc-required-for": {
15224
15588
  "minimum_config": false,
15225
15589
  "create": false,
@@ -15253,6 +15617,8 @@
15253
15617
  "description": "The set of annotations present on this navigation_tile.",
15254
15618
  "title": "Annotations.",
15255
15619
  "x-displayname": "Annotations.",
15620
+ "x-f5xc-example": "{\"key\": \"value\"}",
15621
+ "x-f5xc-description-short": "The set of annotations present on this navigation_tile.",
15256
15622
  "x-f5xc-required-for": {
15257
15623
  "minimum_config": false,
15258
15624
  "create": false,
@@ -15265,6 +15631,7 @@
15265
15631
  "description": "The description set for this navigation_tile.",
15266
15632
  "title": "Description.",
15267
15633
  "x-displayname": "Description.",
15634
+ "x-f5xc-description-short": "The description set for this navigation_tile.",
15268
15635
  "minLength": 0,
15269
15636
  "maxLength": 0,
15270
15637
  "x-f5xc-required-for": {
@@ -15275,7 +15642,7 @@
15275
15642
  },
15276
15643
  "x-original-maxLength": 1024,
15277
15644
  "x-reconciled-from-discovery": true,
15278
- "x-reconciled-at": "2026-01-05T18:29:38.110581+00:00"
15645
+ "x-reconciled-at": "2026-01-07T15:53:43.088942+00:00"
15279
15646
  },
15280
15647
  "disabled": {
15281
15648
  "type": "boolean",
@@ -15283,6 +15650,8 @@
15283
15650
  "title": "Disabled",
15284
15651
  "format": "boolean",
15285
15652
  "x-displayname": "Disabled",
15653
+ "x-f5xc-example": "True",
15654
+ "x-f5xc-description-short": "Value of true indicates navigation_tile is administratively disabled.",
15286
15655
  "x-f5xc-required-for": {
15287
15656
  "minimum_config": false,
15288
15657
  "create": false,
@@ -15298,6 +15667,8 @@
15298
15667
  "description": "The set of labels present on this navigation_tile.",
15299
15668
  "title": "Labels",
15300
15669
  "x-displayname": "Labels",
15670
+ "x-f5xc-example": "{\"key\": \"value\"}",
15671
+ "x-f5xc-description-short": "The set of labels present on this navigation_tile.",
15301
15672
  "x-f5xc-required-for": {
15302
15673
  "minimum_config": false,
15303
15674
  "create": false,
@@ -15325,7 +15696,7 @@
15325
15696
  },
15326
15697
  "x-original-maxLength": 1024,
15327
15698
  "x-reconciled-from-discovery": true,
15328
- "x-reconciled-at": "2026-01-05T18:29:38.110593+00:00"
15699
+ "x-reconciled-at": "2026-01-07T15:53:43.088953+00:00"
15329
15700
  },
15330
15701
  "namespace": {
15331
15702
  "type": "string",
@@ -15344,7 +15715,7 @@
15344
15715
  },
15345
15716
  "x-original-maxLength": 1024,
15346
15717
  "x-reconciled-from-discovery": true,
15347
- "x-reconciled-at": "2026-01-05T18:29:38.110598+00:00"
15718
+ "x-reconciled-at": "2026-01-07T15:53:43.088959+00:00"
15348
15719
  },
15349
15720
  "owner_view": {
15350
15721
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -15357,6 +15728,7 @@
15357
15728
  "$ref": "#/components/schemas/navigation_tileStatusObject"
15358
15729
  },
15359
15730
  "x-displayname": "Status",
15731
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
15360
15732
  "x-f5xc-required-for": {
15361
15733
  "minimum_config": false,
15362
15734
  "create": false,
@@ -15385,7 +15757,7 @@
15385
15757
  "x-field-mutability": "read-only",
15386
15758
  "x-original-maxLength": 1024,
15387
15759
  "x-reconciled-from-discovery": true,
15388
- "x-reconciled-at": "2026-01-05T18:29:38.110606+00:00"
15760
+ "x-reconciled-at": "2026-01-07T15:53:43.088967+00:00"
15389
15761
  },
15390
15762
  "uid": {
15391
15763
  "type": "string",
@@ -15406,9 +15778,11 @@
15406
15778
  "x-original-maxLength": 1024,
15407
15779
  "format": "uuid",
15408
15780
  "x-reconciled-from-discovery": true,
15409
- "x-reconciled-at": "2026-01-05T18:29:38.110612+00:00"
15781
+ "x-reconciled-at": "2026-01-07T15:53:43.088973+00:00"
15410
15782
  }
15411
15783
  },
15784
+ "x-f5xc-description-short": "By default a summary of navigation_tile is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
15785
+ "x-f5xc-description-medium": "By default a summary of navigation_tile is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
15412
15786
  "x-f5xc-minimum-configuration": {
15413
15787
  "description": "Minimum configuration for navigation_tileListResponseItem",
15414
15788
  "required_fields": [
@@ -15474,6 +15848,7 @@
15474
15848
  }
15475
15849
  }
15476
15850
  },
15851
+ "x-f5xc-description-short": "Most recently observed status of object.",
15477
15852
  "x-f5xc-minimum-configuration": {
15478
15853
  "description": "Minimum configuration for navigation_tileStatusObject",
15479
15854
  "required_fields": [
@@ -15577,6 +15952,7 @@
15577
15952
  }
15578
15953
  }
15579
15954
  },
15955
+ "x-f5xc-description-short": "Request to register F5XC AWS marketplace product for F5XC service.",
15580
15956
  "x-f5xc-minimum-configuration": {
15581
15957
  "description": "Minimum configuration for aws_accountRegistrationRequest",
15582
15958
  "required_fields": [
@@ -15603,6 +15979,7 @@
15603
15979
  "x-displayname": "Redirect URL.",
15604
15980
  "x-ves-example": "Redirect_url: https://console.ves.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioio/login/start.",
15605
15981
  "x-f5xc-example": "redirect_urlhttps://console.ves.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioioioio/login/start",
15982
+ "x-f5xc-description-short": "Registration redirect URL for redirecting the AWS customer to login/registration page.",
15606
15983
  "minLength": 0,
15607
15984
  "maxLength": 1024,
15608
15985
  "x-f5xc-required-for": {
@@ -15613,6 +15990,7 @@
15613
15990
  }
15614
15991
  }
15615
15992
  },
15993
+ "x-f5xc-description-short": "Response to register F5XC AWS marketplace product.",
15616
15994
  "x-f5xc-minimum-configuration": {
15617
15995
  "description": "Minimum configuration for aws_accountRegistrationResponse",
15618
15996
  "required_fields": [
@@ -15674,7 +16052,7 @@
15674
16052
  },
15675
16053
  "format": "hostname",
15676
16054
  "x-reconciled-from-discovery": true,
15677
- "x-reconciled-at": "2026-01-05T18:29:40.674724+00:00"
16055
+ "x-reconciled-at": "2026-01-07T15:53:46.489795+00:00"
15678
16056
  },
15679
16057
  "locale": {
15680
16058
  "type": "string",
@@ -15785,7 +16163,7 @@
15785
16163
  },
15786
16164
  "x-original-maxLength": 256,
15787
16165
  "x-reconciled-from-discovery": true,
15788
- "x-reconciled-at": "2026-01-05T18:29:40.674738+00:00"
16166
+ "x-reconciled-at": "2026-01-07T15:53:46.489810+00:00"
15789
16167
  }
15790
16168
  },
15791
16169
  "x-f5xc-minimum-configuration": {
@@ -15879,6 +16257,7 @@
15879
16257
  "x-displayname": "County",
15880
16258
  "x-ves-example": "Santa Clara.",
15881
16259
  "x-f5xc-example": "Santa Clara",
16260
+ "x-f5xc-description-short": "County (optional, for countries where they have counties).",
15882
16261
  "minLength": 0,
15883
16262
  "maxLength": 1024,
15884
16263
  "x-f5xc-required-for": {
@@ -15911,6 +16290,7 @@
15911
16290
  "x-displayname": "State",
15912
16291
  "x-ves-example": "California.",
15913
16292
  "x-f5xc-example": "California",
16293
+ "x-f5xc-description-short": "State (optional, for countries where they have states).",
15914
16294
  "minLength": 0,
15915
16295
  "maxLength": 1024,
15916
16296
  "x-f5xc-required-for": {
@@ -15927,6 +16307,7 @@
15927
16307
  "x-displayname": "State Code.",
15928
16308
  "x-ves-example": "CA",
15929
16309
  "x-f5xc-example": "CA",
16310
+ "x-f5xc-description-short": "State code (optional, for countries where they have states).",
15930
16311
  "minLength": 0,
15931
16312
  "maxLength": 1024,
15932
16313
  "x-f5xc-required-for": {
@@ -15953,6 +16334,8 @@
15953
16334
  }
15954
16335
  }
15955
16336
  },
16337
+ "x-f5xc-description-short": "Instance of one single contact that can be used to communicate with customers.",
16338
+ "x-f5xc-description-medium": "Instance of one single contact that can be used to communicate with customers. Depending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
15956
16339
  "x-f5xc-minimum-configuration": {
15957
16340
  "description": "Minimum configuration for signupContactMeta",
15958
16341
  "required_fields": [
@@ -16100,6 +16483,7 @@
16100
16483
  "$ref": "#/components/schemas/schemaObjectRefType"
16101
16484
  },
16102
16485
  "x-displayname": "Deleted Referred Objects.",
16486
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
16103
16487
  "x-f5xc-required-for": {
16104
16488
  "minimum_config": false,
16105
16489
  "create": false,
@@ -16115,6 +16499,7 @@
16115
16499
  "$ref": "#/components/schemas/schemaObjectRefType"
16116
16500
  },
16117
16501
  "x-displayname": "Disabled Referred Objects.",
16502
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
16118
16503
  "x-f5xc-required-for": {
16119
16504
  "minimum_config": false,
16120
16505
  "create": false,
@@ -16133,6 +16518,7 @@
16133
16518
  "$ref": "#/components/schemas/schemaObjectRefType"
16134
16519
  },
16135
16520
  "x-displayname": "Referring Objects.",
16521
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
16136
16522
  "x-f5xc-required-for": {
16137
16523
  "minimum_config": false,
16138
16524
  "create": false,
@@ -16151,6 +16537,8 @@
16151
16537
  "$ref": "#/components/schemas/planStatusObject"
16152
16538
  },
16153
16539
  "x-displayname": "Status",
16540
+ "x-f5xc-example": "active",
16541
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
16154
16542
  "x-f5xc-required-for": {
16155
16543
  "minimum_config": false,
16156
16544
  "create": false,
@@ -16160,7 +16548,7 @@
16160
16548
  "maxLength": 17,
16161
16549
  "minLength": 17,
16162
16550
  "x-reconciled-from-discovery": true,
16163
- "x-reconciled-at": "2026-01-05T18:29:41.768824+00:00"
16551
+ "x-reconciled-at": "2026-01-07T15:53:47.954445+00:00"
16164
16552
  },
16165
16553
  "system_metadata": {
16166
16554
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -16196,6 +16584,8 @@
16196
16584
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
16197
16585
  ],
16198
16586
  "default": "GET_RSP_FORMAT_DEFAULT",
16587
+ "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...",
16588
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\" Response should be in...",
16199
16589
  "x-f5xc-minimum-configuration": {
16200
16590
  "description": "Minimum configuration for planGetResponseFormatCode",
16201
16591
  "required_fields": [],
@@ -16230,6 +16620,7 @@
16230
16620
  "ves.io.schema.rules.repeated.max_items": "32",
16231
16621
  "ves.io.schema.rules.repeated.unique": "true"
16232
16622
  },
16623
+ "x-f5xc-description-short": "List of pre-defined addon services that can be subscribed part this plan.",
16233
16624
  "x-f5xc-required-for": {
16234
16625
  "minimum_config": false,
16235
16626
  "create": false,
@@ -16252,6 +16643,7 @@
16252
16643
  "ves.io.schema.rules.string.max_len": "512"
16253
16644
  },
16254
16645
  "x-f5xc-example": "example-resource",
16646
+ "x-f5xc-description-short": "User friendly name for display purpose. Required: YES.",
16255
16647
  "minLength": 0,
16256
16648
  "x-f5xc-required-for": {
16257
16649
  "minimum_config": false,
@@ -16276,6 +16668,8 @@
16276
16668
  "ves.io.schema.rules.repeated.max_items": "32",
16277
16669
  "ves.io.schema.rules.repeated.unique": "true"
16278
16670
  },
16671
+ "x-f5xc-description-short": "List of pre-defined addon services that are by default included part this plan. Tenant will be auto subscribed to all the addon services in this list.",
16672
+ "x-f5xc-description-medium": "List of pre-defined addon services that are by default included part this plan. Tenant will be auto subscribed to all the addon services in this list.",
16279
16673
  "x-f5xc-required-for": {
16280
16674
  "minimum_config": false,
16281
16675
  "create": false,
@@ -16284,6 +16678,7 @@
16284
16678
  }
16285
16679
  }
16286
16680
  },
16681
+ "x-f5xc-description-short": "GET plan reads a given object from storage backend for metadata.namespace.",
16287
16682
  "x-f5xc-minimum-configuration": {
16288
16683
  "description": "Minimum configuration for planGetSpecType",
16289
16684
  "required_fields": [
@@ -16313,6 +16708,7 @@
16313
16708
  "$ref": "#/components/schemas/schemaErrorType"
16314
16709
  },
16315
16710
  "x-displayname": "Errors",
16711
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
16316
16712
  "x-f5xc-required-for": {
16317
16713
  "minimum_config": false,
16318
16714
  "create": false,
@@ -16328,6 +16724,8 @@
16328
16724
  "$ref": "#/components/schemas/planListResponseItem"
16329
16725
  },
16330
16726
  "x-displayname": "Items",
16727
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
16728
+ "x-f5xc-description-short": "Items represents the collection in response.",
16331
16729
  "x-f5xc-required-for": {
16332
16730
  "minimum_config": false,
16333
16731
  "create": false,
@@ -16361,6 +16759,8 @@
16361
16759
  "description": "The set of annotations present on this plan.",
16362
16760
  "title": "Annotations.",
16363
16761
  "x-displayname": "Annotations.",
16762
+ "x-f5xc-example": "{\"key\": \"value\"}",
16763
+ "x-f5xc-description-short": "The set of annotations present on this plan.",
16364
16764
  "x-f5xc-required-for": {
16365
16765
  "minimum_config": false,
16366
16766
  "create": false,
@@ -16383,7 +16783,7 @@
16383
16783
  },
16384
16784
  "x-original-maxLength": 1024,
16385
16785
  "x-reconciled-from-discovery": true,
16386
- "x-reconciled-at": "2026-01-05T18:29:41.768844+00:00"
16786
+ "x-reconciled-at": "2026-01-07T15:53:47.954466+00:00"
16387
16787
  },
16388
16788
  "disabled": {
16389
16789
  "type": "boolean",
@@ -16391,6 +16791,8 @@
16391
16791
  "title": "Disabled",
16392
16792
  "format": "boolean",
16393
16793
  "x-displayname": "Disabled",
16794
+ "x-f5xc-example": "True",
16795
+ "x-f5xc-description-short": "Value of true indicates plan is administratively disabled.",
16394
16796
  "x-f5xc-required-for": {
16395
16797
  "minimum_config": false,
16396
16798
  "create": false,
@@ -16406,6 +16808,7 @@
16406
16808
  "description": "The set of labels present on this plan.",
16407
16809
  "title": "Labels",
16408
16810
  "x-displayname": "Labels",
16811
+ "x-f5xc-example": "{\"key\": \"value\"}",
16409
16812
  "x-f5xc-required-for": {
16410
16813
  "minimum_config": false,
16411
16814
  "create": false,
@@ -16433,7 +16836,7 @@
16433
16836
  },
16434
16837
  "x-original-maxLength": 1024,
16435
16838
  "x-reconciled-from-discovery": true,
16436
- "x-reconciled-at": "2026-01-05T18:29:41.768855+00:00"
16839
+ "x-reconciled-at": "2026-01-07T15:53:47.954477+00:00"
16437
16840
  },
16438
16841
  "namespace": {
16439
16842
  "type": "string",
@@ -16452,7 +16855,7 @@
16452
16855
  },
16453
16856
  "x-original-maxLength": 1024,
16454
16857
  "x-reconciled-from-discovery": true,
16455
- "x-reconciled-at": "2026-01-05T18:29:41.768860+00:00"
16858
+ "x-reconciled-at": "2026-01-07T15:53:47.954482+00:00"
16456
16859
  },
16457
16860
  "owner_view": {
16458
16861
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -16465,6 +16868,7 @@
16465
16868
  "$ref": "#/components/schemas/planStatusObject"
16466
16869
  },
16467
16870
  "x-displayname": "Status",
16871
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
16468
16872
  "x-f5xc-required-for": {
16469
16873
  "minimum_config": false,
16470
16874
  "create": false,
@@ -16493,7 +16897,7 @@
16493
16897
  "x-field-mutability": "read-only",
16494
16898
  "x-original-maxLength": 1024,
16495
16899
  "x-reconciled-from-discovery": true,
16496
- "x-reconciled-at": "2026-01-05T18:29:41.768868+00:00"
16900
+ "x-reconciled-at": "2026-01-07T15:53:47.954491+00:00"
16497
16901
  },
16498
16902
  "uid": {
16499
16903
  "type": "string",
@@ -16514,9 +16918,11 @@
16514
16918
  "x-original-maxLength": 1024,
16515
16919
  "format": "uuid",
16516
16920
  "x-reconciled-from-discovery": true,
16517
- "x-reconciled-at": "2026-01-05T18:29:41.768874+00:00"
16921
+ "x-reconciled-at": "2026-01-07T15:53:47.954497+00:00"
16518
16922
  }
16519
16923
  },
16924
+ "x-f5xc-description-short": "By default a summary of plan is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
16925
+ "x-f5xc-description-medium": "By default a summary of plan is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
16520
16926
  "x-f5xc-minimum-configuration": {
16521
16927
  "description": "Minimum configuration for planListResponseItem",
16522
16928
  "required_fields": [
@@ -16582,6 +16988,7 @@
16582
16988
  }
16583
16989
  }
16584
16990
  },
16991
+ "x-f5xc-description-short": "Most recently observed status of object.",
16585
16992
  "x-f5xc-minimum-configuration": {
16586
16993
  "description": "Minimum configuration for planStatusObject",
16587
16994
  "required_fields": [
@@ -16607,6 +17014,7 @@
16607
17014
  "title": "API endpoint path.",
16608
17015
  "x-f5xc-example": "/endpoint1",
16609
17016
  "x-required": true,
17017
+ "x-f5xc-description-short": "X-displayName: \"API Endpoint\" The rule is applied only for the specified API endpoints.",
16610
17018
  "minLength": 0,
16611
17019
  "maxLength": 1024,
16612
17020
  "x-f5xc-required-for": {
@@ -16624,6 +17032,7 @@
16624
17032
  "$ref": "#/components/schemas/schemaHttpMethod"
16625
17033
  },
16626
17034
  "x-f5xc-example": "['GET', 'POST', 'DELETE']",
17035
+ "x-f5xc-description-short": "X-displayName: \"Methods\" List of methods values to match against. X-required.",
16627
17036
  "x-f5xc-required-for": {
16628
17037
  "minimum_config": false,
16629
17038
  "create": false,
@@ -16633,6 +17042,7 @@
16633
17042
  }
16634
17043
  },
16635
17044
  "x-required": true,
17045
+ "x-f5xc-description-short": "X-displayName: \"API Endpoint\" The rule is applied only for the specified API endpoints.",
16636
17046
  "x-f5xc-minimum-configuration": {
16637
17047
  "description": "Minimum configuration for app_typeAPIEndpoint",
16638
17048
  "required_fields": [
@@ -16656,6 +17066,7 @@
16656
17066
  "description": "X-displayName: \"Name\"\nx-required\nBuilt-in rule for sensitive data detection.",
16657
17067
  "title": "Name",
16658
17068
  "x-f5xc-example": "[EMAIL, CC]",
17069
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Built-in rule for sensitive data detection.",
16659
17070
  "minLength": 0,
16660
17071
  "maxLength": 16,
16661
17072
  "x-f5xc-required-for": {
@@ -16666,10 +17077,11 @@
16666
17077
  },
16667
17078
  "x-original-maxLength": 1024,
16668
17079
  "x-reconciled-from-discovery": true,
16669
- "x-reconciled-at": "2026-01-05T18:30:03.893056+00:00"
17080
+ "x-reconciled-at": "2026-01-07T15:54:15.401983+00:00"
16670
17081
  }
16671
17082
  },
16672
17083
  "x-f5xc-example": "[EMAIL, CC]",
17084
+ "x-f5xc-description-short": "X-displayName: \"Built-In Sensitive Data Type\" Message wrapper for built-in sensitive data type.",
16673
17085
  "x-f5xc-minimum-configuration": {
16674
17086
  "description": "Minimum configuration for app_typeBuiltInSensitiveDataType",
16675
17087
  "required_fields": [
@@ -16710,6 +17122,8 @@
16710
17122
  "description": "X-displayName: \"API Group\"\nThe rule is applied on the APIs that belong to specified api_group.\nAPI groups derived from API Definition swaggers.\nFor example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers.\nCustom groups can be created if user tags paths or operations with \"x-F5 Distributed Cloud-API-group\" extensions inside swaggers.",
16711
17123
  "title": "Api_group",
16712
17124
  "x-f5xc-example": "oas-all-operations",
17125
+ "x-f5xc-description-short": "X-displayName: \"API Group\" The rule is applied on the APIs that belong to specified api_group.",
17126
+ "x-f5xc-description-medium": "X-displayName: \"API Group\" The rule is applied on the APIs that belong to specified api_group. API groups derived from API Definition swaggers. For example oas-all-operations including all paths and methods from the swaggers, oas-base-URLs covering all requests under base-paths from the swaggers.",
16713
17127
  "minLength": 0,
16714
17128
  "maxLength": 1024,
16715
17129
  "x-f5xc-required-for": {
@@ -16724,6 +17138,8 @@
16724
17138
  "description": "X-displayName: \"Base Path\"\nThe rule is applied only for the requests matching the specified base path.",
16725
17139
  "title": "Base path",
16726
17140
  "x-f5xc-example": "/v1",
17141
+ "x-f5xc-description-short": "X-displayName: \"Base Path\" The rule is applied only for the requests matching the specified base path.",
17142
+ "x-f5xc-description-medium": "X-displayName: \"Base Path\" The rule is applied only for the requests matching the specified base path.",
16727
17143
  "minLength": 0,
16728
17144
  "maxLength": 1024,
16729
17145
  "x-f5xc-required-for": {
@@ -16747,6 +17163,7 @@
16747
17163
  "description": "X-displayName: \"Specific Domain\"\nThe rule will apply for a specific domain.\nFor example: api.example.com.",
16748
17164
  "title": "Domain",
16749
17165
  "x-f5xc-example": "api.example.com",
17166
+ "x-f5xc-description-short": "X-displayName: \"Specific Domain\" The rule will apply for a specific domain. For",
16750
17167
  "minLength": 0,
16751
17168
  "maxLength": 1024,
16752
17169
  "x-f5xc-required-for": {
@@ -16760,6 +17177,8 @@
16760
17177
  "$ref": "#/components/schemas/app_typeValuePattern"
16761
17178
  }
16762
17179
  },
17180
+ "x-f5xc-description-short": "X-displayName: \"Custom Data Detection Config\" The custom data detection config specifies targets, scopes & the pattern to be detected.",
17181
+ "x-f5xc-description-medium": "X-displayName: \"Custom Data Detection Config\" The custom data detection config specifies targets, scopes & the pattern to be detected.",
16763
17182
  "x-f5xc-minimum-configuration": {
16764
17183
  "description": "Minimum configuration for app_typeCustomDataDetectionConfig",
16765
17184
  "required_fields": [
@@ -16796,6 +17215,7 @@
16796
17215
  "items": {
16797
17216
  "$ref": "#/components/schemas/schemaHttpSections"
16798
17217
  },
17218
+ "x-f5xc-description-short": "X-displayName: \"Custom Sections\" x-required Request & Response Sections.",
16799
17219
  "x-f5xc-required-for": {
16800
17220
  "minimum_config": false,
16801
17221
  "create": false,
@@ -16804,6 +17224,7 @@
16804
17224
  }
16805
17225
  }
16806
17226
  },
17227
+ "x-f5xc-description-short": "X-displayName: \"Custom Sections\" Request & Response Sections.",
16807
17228
  "x-f5xc-minimum-configuration": {
16808
17229
  "description": "Minimum configuration for app_typeCustomSections",
16809
17230
  "required_fields": [
@@ -16831,6 +17252,7 @@
16831
17252
  "$ref": "#/components/schemas/app_typeCustomSensitiveDataType"
16832
17253
  }
16833
17254
  },
17255
+ "x-f5xc-description-short": "X-displayName: \"Custom Sensitive Data Detection Rule\" Custom Sensitive Data Rule Definition.",
16834
17256
  "x-f5xc-minimum-configuration": {
16835
17257
  "description": "Minimum configuration for app_typeCustomSensitiveDataDetectionRule",
16836
17258
  "required_fields": [
@@ -16856,6 +17278,7 @@
16856
17278
  "title": "Sensitive data type.",
16857
17279
  "x-f5xc-example": "EMAIL",
16858
17280
  "x-required": true,
17281
+ "x-f5xc-description-short": "X-displayName: \"Type\" The request is labeled as specified sensitive data type.",
16859
17282
  "minLength": 0,
16860
17283
  "maxLength": 1024,
16861
17284
  "x-f5xc-required-for": {
@@ -16866,6 +17289,8 @@
16866
17289
  }
16867
17290
  }
16868
17291
  },
17292
+ "x-f5xc-description-short": "X-displayName: \"Custom Sensitive Data Type\" The type/category of the sensitive data this rule detects.",
17293
+ "x-f5xc-description-medium": "X-displayName: \"Custom Sensitive Data Type\" The type/category of the sensitive data this rule detects. E.g. Email, Credit Card etc.",
16869
17294
  "x-f5xc-minimum-configuration": {
16870
17295
  "description": "Minimum configuration for app_typeCustomSensitiveDataType",
16871
17296
  "required_fields": [
@@ -16901,6 +17326,7 @@
16901
17326
  "ves.io.schema.rules.uint32.gte": "1",
16902
17327
  "ves.io.schema.rules.uint32.lte": "7"
16903
17328
  },
17329
+ "x-f5xc-description-short": "Inactive discovered API will be deleted after configured duration.",
16904
17330
  "minimum": 0,
16905
17331
  "maximum": 2147483647,
16906
17332
  "x-f5xc-required-for": {
@@ -16934,6 +17360,7 @@
16934
17360
  "description": "X-displayName: \"Exact Value\"\nSearch for values with exact match.",
16935
17361
  "title": "Exact value.",
16936
17362
  "x-f5xc-example": "x-volt-header",
17363
+ "x-f5xc-description-short": "X-displayName: \"Exact Value\" Search for values with exact match.",
16937
17364
  "minLength": 0,
16938
17365
  "maxLength": 1024,
16939
17366
  "x-f5xc-required-for": {
@@ -16948,6 +17375,7 @@
16948
17375
  "description": "X-displayName: \"Regex Value\"\nSearch for values matching this regular expression.",
16949
17376
  "title": "Regex value.",
16950
17377
  "x-f5xc-example": "'^new.*$', 'san f.*', '.* del .*'",
17378
+ "x-f5xc-description-short": "X-displayName: \"Regex Value\" Search for values matching this regular expression.",
16951
17379
  "minLength": 0,
16952
17380
  "maxLength": 1024,
16953
17381
  "x-f5xc-required-for": {
@@ -16958,6 +17386,7 @@
16958
17386
  }
16959
17387
  }
16960
17388
  },
17389
+ "x-f5xc-description-short": "X-displayName: \"Key Pattern\" Pattern to detect. Could be exact match or regex match.",
16961
17390
  "x-f5xc-minimum-configuration": {
16962
17391
  "description": "Minimum configuration for app_typeKeyPattern",
16963
17392
  "required_fields": [
@@ -16983,6 +17412,8 @@
16983
17412
  "$ref": "#/components/schemas/app_typeValuePattern"
16984
17413
  }
16985
17414
  },
17415
+ "x-f5xc-description-short": "X-displayName: \"Key & Value Pattern\" Search for specific key & value patterns in the specified sections.",
17416
+ "x-f5xc-description-medium": "X-displayName: \"Key & Value Pattern\" Search for specific key & value patterns in the specified sections.",
16986
17417
  "x-f5xc-minimum-configuration": {
16987
17418
  "description": "Minimum configuration for app_typeKeyValuePattern",
16988
17419
  "required_fields": [
@@ -17008,6 +17439,9 @@
17008
17439
  "items": {
17009
17440
  "$ref": "#/components/schemas/app_typeCustomSensitiveDataDetectionRule"
17010
17441
  },
17442
+ "x-f5xc-example": "{\"key\": \"value\"}",
17443
+ "x-f5xc-description-short": "X-displayName: \"Defined Custom Sensitive Data Types\" Rules to detect custom sensitive data in requests and/or responses sections.",
17444
+ "x-f5xc-description-medium": "X-displayName: \"Defined Custom Sensitive Data Types\" Rules to detect custom sensitive data in requests and/or responses sections.",
17011
17445
  "x-f5xc-required-for": {
17012
17446
  "minimum_config": false,
17013
17447
  "create": false,
@@ -17023,6 +17457,8 @@
17023
17457
  "$ref": "#/components/schemas/app_typeBuiltInSensitiveDataType"
17024
17458
  },
17025
17459
  "x-f5xc-example": "[EMAIL, CC]",
17460
+ "x-f5xc-description-short": "X-displayName: \"Disabled Built-In Sensitive Data Types\" List of disabled built-in sensitive data detection rules.",
17461
+ "x-f5xc-description-medium": "X-displayName: \"Disabled Built-In Sensitive Data Types\" List of disabled built-in sensitive data detection rules.",
17026
17462
  "x-f5xc-required-for": {
17027
17463
  "minimum_config": false,
17028
17464
  "create": false,
@@ -17031,6 +17467,8 @@
17031
17467
  }
17032
17468
  }
17033
17469
  },
17470
+ "x-f5xc-description-short": "X-displayName: \"Sensitive Data Detection Rules\" Rules to manage/configure sensitive data detection in requests and/or response sections.",
17471
+ "x-f5xc-description-medium": "X-displayName: \"Sensitive Data Detection Rules\" Rules to manage/configure sensitive data detection in requests and/or response sections.",
17034
17472
  "x-f5xc-minimum-configuration": {
17035
17473
  "description": "Minimum configuration for app_typeSensitiveDataDetectionRules",
17036
17474
  "required_fields": [
@@ -17054,6 +17492,7 @@
17054
17492
  "description": "X-displayName: \"Exact Value\"\nPattern value to be detected.",
17055
17493
  "title": "Exact value.",
17056
17494
  "x-f5xc-example": "x-volt-header",
17495
+ "x-f5xc-description-short": "X-displayName: \"Exact Value\" Pattern value to be detected.",
17057
17496
  "minLength": 0,
17058
17497
  "maxLength": 1024,
17059
17498
  "x-f5xc-required-for": {
@@ -17068,6 +17507,7 @@
17068
17507
  "description": "X-displayName: \"Regex Value\"\nRegular expression for this pattern.",
17069
17508
  "title": "Regex value.",
17070
17509
  "x-f5xc-example": "'^new.*$', 'san f.*', '.* del .*'",
17510
+ "x-f5xc-description-short": "X-displayName: \"Regex Value\" Regular expression for this pattern.",
17071
17511
  "minLength": 0,
17072
17512
  "maxLength": 1024,
17073
17513
  "x-f5xc-required-for": {
@@ -17078,6 +17518,7 @@
17078
17518
  }
17079
17519
  }
17080
17520
  },
17521
+ "x-f5xc-description-short": "X-displayName: \"Value Pattern\" Pattern to detect. Could be exact match or regex match.",
17081
17522
  "x-f5xc-minimum-configuration": {
17082
17523
  "description": "Minimum configuration for app_typeValuePattern",
17083
17524
  "required_fields": [
@@ -17104,6 +17545,7 @@
17104
17545
  "type": "string"
17105
17546
  },
17106
17547
  "x-displayname": "API Protection Configured.",
17548
+ "description": "API version or group",
17107
17549
  "x-f5xc-required-for": {
17108
17550
  "minimum_config": false,
17109
17551
  "create": false,
@@ -17118,6 +17560,8 @@
17118
17560
  "type": "string"
17119
17561
  },
17120
17562
  "x-displayname": "App Firewall Configured.",
17563
+ "description": "Configuration parameter for app firewall",
17564
+ "x-f5xc-description-short": "Configuration parameter for app firewall.",
17121
17565
  "x-f5xc-required-for": {
17122
17566
  "minimum_config": false,
17123
17567
  "create": false,
@@ -17132,6 +17576,8 @@
17132
17576
  "type": "string"
17133
17577
  },
17134
17578
  "x-displayname": "List of Load Balancers Where App Firewall is Configured Per Route.",
17579
+ "description": "Configuration parameter for app firewall per route",
17580
+ "x-f5xc-description-short": "Configuration parameter for app firewall per route.",
17135
17581
  "x-f5xc-required-for": {
17136
17582
  "minimum_config": false,
17137
17583
  "create": false,
@@ -17146,6 +17592,8 @@
17146
17592
  "type": "string"
17147
17593
  },
17148
17594
  "x-displayname": "Bot Defense Configured.",
17595
+ "description": "Configuration parameter for bot defense",
17596
+ "x-f5xc-description-short": "Configuration parameter for bot defense.",
17149
17597
  "x-f5xc-required-for": {
17150
17598
  "minimum_config": false,
17151
17599
  "create": false,
@@ -17160,6 +17608,8 @@
17160
17608
  "type": "string"
17161
17609
  },
17162
17610
  "x-displayname": "DDoS Detection Configured.",
17611
+ "description": "Configuration parameter for ddos detection",
17612
+ "x-f5xc-description-short": "Configuration parameter for ddos detection.",
17163
17613
  "x-f5xc-required-for": {
17164
17614
  "minimum_config": false,
17165
17615
  "create": false,
@@ -17174,6 +17624,8 @@
17174
17624
  "type": "string"
17175
17625
  },
17176
17626
  "x-displayname": "List of Load Balancers Secured.",
17627
+ "description": "Protection or security configuration",
17628
+ "x-f5xc-example": "{\"key\": \"value\"}",
17177
17629
  "x-f5xc-required-for": {
17178
17630
  "minimum_config": false,
17179
17631
  "create": false,
@@ -17243,6 +17695,7 @@
17243
17695
  "$ref": "#/components/schemas/ioschemaEmpty"
17244
17696
  }
17245
17697
  },
17698
+ "x-f5xc-description-short": "Settings for API specification (API definition, OpenAPI validation, etc.).",
17246
17699
  "x-f5xc-minimum-configuration": {
17247
17700
  "description": "Minimum configuration for common_wafAPISpecificationSettings",
17248
17701
  "required_fields": [
@@ -17283,6 +17736,7 @@
17283
17736
  "ves.io.schema.rules.message.required": "true",
17284
17737
  "ves.io.schema.rules.string.max_len": "256"
17285
17738
  },
17739
+ "x-f5xc-description-short": "Code repository which contain API endpoints Required: YES.",
17286
17740
  "x-f5xc-required-for": {
17287
17741
  "minimum_config": false,
17288
17742
  "create": false,
@@ -17291,6 +17745,7 @@
17291
17745
  }
17292
17746
  }
17293
17747
  },
17748
+ "x-f5xc-description-short": "Select which API repositories represent the LB applications.",
17294
17749
  "x-f5xc-minimum-configuration": {
17295
17750
  "description": "Minimum configuration for common_wafApiCodeRepos",
17296
17751
  "required_fields": [
@@ -17355,6 +17810,8 @@
17355
17810
  "ves.io.schema.rules.message.required": "true",
17356
17811
  "ves.io.schema.rules.repeated.max_items": "32"
17357
17812
  },
17813
+ "x-f5xc-description-short": "Enter domains and their credentials to allow authenticated API crawling.",
17814
+ "x-f5xc-description-medium": "Enter domains and their credentials to allow authenticated API crawling. You can only include domains you own that are associated with this Load Balancer. Required: YES.",
17358
17815
  "x-f5xc-required-for": {
17359
17816
  "minimum_config": false,
17360
17817
  "create": false,
@@ -17478,6 +17935,7 @@
17478
17935
  "$ref": "#/components/schemas/ioschemaEmpty"
17479
17936
  }
17480
17937
  },
17938
+ "x-f5xc-description-short": "Specifies the settings used for API discovery.",
17481
17939
  "x-f5xc-minimum-configuration": {
17482
17940
  "description": "Minimum configuration for common_wafApiDiscoverySetting",
17483
17941
  "required_fields": [
@@ -17630,6 +18088,7 @@
17630
18088
  "ves.io.schema.rules.repeated.max_items": "15",
17631
18089
  "ves.io.schema.rules.repeated.unique_metadata_name": "true"
17632
18090
  },
18091
+ "x-f5xc-example": "{\"key\": \"value\"}",
17633
18092
  "x-f5xc-required-for": {
17634
18093
  "minimum_config": false,
17635
18094
  "create": false,
@@ -17674,6 +18133,8 @@
17674
18133
  "ves.io.schema.rules.string.max_len": "256",
17675
18134
  "ves.io.schema.rules.string.vh_domain": "true"
17676
18135
  },
18136
+ "x-f5xc-example": "example.com",
18137
+ "x-f5xc-description-short": "Select the domain to execute API Crawling with given credentials. Required: YES.",
17677
18138
  "minLength": 0,
17678
18139
  "x-f5xc-required-for": {
17679
18140
  "minimum_config": false,
@@ -17684,7 +18145,7 @@
17684
18145
  "x-original-maxLength": 256,
17685
18146
  "format": "hostname",
17686
18147
  "x-reconciled-from-discovery": true,
17687
- "x-reconciled-at": "2026-01-05T18:30:03.893146+00:00"
18148
+ "x-reconciled-at": "2026-01-07T15:54:15.402074+00:00"
17688
18149
  },
17689
18150
  "simple_login": {
17690
18151
  "$ref": "#/components/schemas/common_wafSimpleLogin"
@@ -17738,6 +18199,7 @@
17738
18199
  "x-validation-rules": {
17739
18200
  "ves.io.schema.rules.string.max_len": "128"
17740
18201
  },
18202
+ "x-f5xc-description-short": "Exclusive with [api_endpoint base_path] The API group which this validation applies to.",
17741
18203
  "minLength": 0,
17742
18204
  "x-f5xc-required-for": {
17743
18205
  "minimum_config": false,
@@ -17762,6 +18224,7 @@
17762
18224
  "ves.io.schema.rules.string.http_path": "true",
17763
18225
  "ves.io.schema.rules.string.max_len": "128"
17764
18226
  },
18227
+ "x-f5xc-description-short": "Exclusive with [api_endpoint api_group] The base path which this validation applies to.",
17765
18228
  "minLength": 0,
17766
18229
  "x-f5xc-required-for": {
17767
18230
  "minimum_config": false,
@@ -17774,6 +18237,7 @@
17774
18237
  "$ref": "#/components/schemas/schemaMessageMetaType"
17775
18238
  }
17776
18239
  },
18240
+ "x-f5xc-description-short": "Fall Through Rule for a specific endpoint, base-path, or API group.",
17777
18241
  "x-f5xc-minimum-configuration": {
17778
18242
  "description": "Minimum configuration for common_wafFallThroughRule",
17779
18243
  "required_fields": [
@@ -17808,6 +18272,8 @@
17808
18272
  }
17809
18273
  },
17810
18274
  "x-required": true,
18275
+ "x-f5xc-description-short": "Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a.",
18276
+ "x-f5xc-description-medium": "Determine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. Swagger) or doesn't have a specific rule in custom rules).",
17811
18277
  "x-f5xc-minimum-configuration": {
17812
18278
  "description": "Minimum configuration for common_wafOpenApiFallThroughMode",
17813
18279
  "required_fields": [
@@ -17876,6 +18342,8 @@
17876
18342
  "$ref": "#/components/schemas/ioschemaEmpty"
17877
18343
  }
17878
18344
  },
18345
+ "x-f5xc-description-short": "OpenAPI specification validation settings relevant for \"API Inventory\" enforcement and for \"Custom list\" enforcement.",
18346
+ "x-f5xc-description-medium": "OpenAPI specification validation settings relevant for \"API Inventory\" enforcement and for \"Custom list\" enforcement.",
17879
18347
  "x-f5xc-minimum-configuration": {
17880
18348
  "description": "Minimum configuration for common_wafOpenApiValidationCommonSettings",
17881
18349
  "required_fields": [
@@ -17914,6 +18382,8 @@
17914
18382
  }
17915
18383
  },
17916
18384
  "x-required": true,
18385
+ "x-f5xc-description-short": "Validation mode of OpenAPI specification.",
18386
+ "x-f5xc-description-medium": "Validation mode of OpenAPI specification. When a validation mismatch occurs on a request to one of the endpoints listed on the OpenAPI specification file (a.k.a. Swagger).",
17917
18387
  "x-f5xc-minimum-configuration": {
17918
18388
  "description": "Minimum configuration for common_wafOpenApiValidationMode",
17919
18389
  "required_fields": [
@@ -17967,6 +18437,8 @@
17967
18437
  "ves.io.schema.rules.repeated.min_items": "1",
17968
18438
  "ves.io.schema.rules.repeated.unique": "true"
17969
18439
  },
18440
+ "x-f5xc-description-short": "List of properties of the request to validate according to the OpenAPI specification file (a.k.a.",
18441
+ "x-f5xc-description-medium": "List of properties of the request to validate according to the OpenAPI specification file (a.k.a. Swagger) Required: YES.",
17970
18442
  "x-f5xc-required-for": {
17971
18443
  "minimum_config": false,
17972
18444
  "create": false,
@@ -18027,6 +18499,8 @@
18027
18499
  "ves.io.schema.rules.repeated.min_items": "1",
18028
18500
  "ves.io.schema.rules.repeated.unique": "true"
18029
18501
  },
18502
+ "x-f5xc-description-short": "List of properties of the response to validate according to the OpenAPI specification file (a.k.a.",
18503
+ "x-f5xc-description-medium": "List of properties of the response to validate according to the OpenAPI specification file (a.k.a. Swagger) Required: YES.",
18030
18504
  "x-f5xc-required-for": {
18031
18505
  "minimum_config": false,
18032
18506
  "create": false,
@@ -18078,6 +18552,7 @@
18078
18552
  "x-validation-rules": {
18079
18553
  "ves.io.schema.rules.string.max_len": "128"
18080
18554
  },
18555
+ "x-f5xc-description-short": "Exclusive with [api_endpoint base_path] The API group which this validation applies to.",
18081
18556
  "minLength": 0,
18082
18557
  "x-f5xc-required-for": {
18083
18558
  "minimum_config": false,
@@ -18102,6 +18577,7 @@
18102
18577
  "ves.io.schema.rules.string.http_path": "true",
18103
18578
  "ves.io.schema.rules.string.max_len": "128"
18104
18579
  },
18580
+ "x-f5xc-description-short": "Exclusive with [api_endpoint api_group] The base path which this validation applies to.",
18105
18581
  "minLength": 0,
18106
18582
  "x-f5xc-required-for": {
18107
18583
  "minimum_config": false,
@@ -18127,6 +18603,7 @@
18127
18603
  "ves.io.schema.rules.string.max_len": "128",
18128
18604
  "ves.io.schema.rules.string.vh_domain": "true"
18129
18605
  },
18606
+ "x-f5xc-description-short": "Exclusive with [any_domain] The rule will apply for a specific domain.",
18130
18607
  "minLength": 0,
18131
18608
  "x-f5xc-required-for": {
18132
18609
  "minimum_config": false,
@@ -18139,6 +18616,7 @@
18139
18616
  "$ref": "#/components/schemas/common_wafOpenApiValidationMode"
18140
18617
  }
18141
18618
  },
18619
+ "x-f5xc-description-short": "OpenAPI Validation Rule for a specific endpoint, base-path, or API group.",
18142
18620
  "x-f5xc-minimum-configuration": {
18143
18621
  "description": "Minimum configuration for common_wafOpenApiValidationRule",
18144
18622
  "required_fields": [
@@ -18178,6 +18656,7 @@
18178
18656
  "x-validation-rules": {
18179
18657
  "ves.io.schema.rules.string.max_len": "64"
18180
18658
  },
18659
+ "x-f5xc-description-short": "Enter the username to assign credentials for the selected domain to crawl.",
18181
18660
  "minLength": 0,
18182
18661
  "x-f5xc-required-for": {
18183
18662
  "minimum_config": false,
@@ -18231,6 +18710,7 @@
18231
18710
  "ves.io.schema.rules.repeated.max_items": "15",
18232
18711
  "ves.io.schema.rules.repeated.unique_metadata_name": "true"
18233
18712
  },
18713
+ "x-f5xc-example": "{\"key\": \"value\"}",
18234
18714
  "x-f5xc-required-for": {
18235
18715
  "minimum_config": false,
18236
18716
  "create": false,
@@ -18242,6 +18722,8 @@
18242
18722
  "$ref": "#/components/schemas/common_wafOpenApiValidationCommonSettings"
18243
18723
  }
18244
18724
  },
18725
+ "x-f5xc-description-short": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes.",
18726
+ "x-f5xc-description-medium": "Define API groups, base paths, or API endpoints and their OpenAPI validation modes. Any other API-endpoint not listed will act according to \"Fall Through Mode\".",
18245
18727
  "x-f5xc-minimum-configuration": {
18246
18728
  "description": "Minimum configuration for common_wafValidateApiBySpecRule",
18247
18729
  "required_fields": [
@@ -18291,6 +18773,7 @@
18291
18773
  "$ref": "#/components/schemas/ioschemaEmpty"
18292
18774
  }
18293
18775
  },
18776
+ "x-f5xc-description-short": "X-displayName: \"Validation Settings For Headers\" Custom settings for headers validation.",
18294
18777
  "x-f5xc-minimum-configuration": {
18295
18778
  "description": "Minimum configuration for common_wafValidationSettingForHeaders",
18296
18779
  "required_fields": [
@@ -18319,6 +18802,7 @@
18319
18802
  "$ref": "#/components/schemas/ioschemaEmpty"
18320
18803
  }
18321
18804
  },
18805
+ "x-f5xc-description-short": "Custom settings for query parameters validation.",
18322
18806
  "x-f5xc-minimum-configuration": {
18323
18807
  "description": "Minimum configuration for common_wafValidationSettingForQueryParameters",
18324
18808
  "required_fields": [
@@ -18352,6 +18836,7 @@
18352
18836
  "default": "ANY",
18353
18837
  "x-displayname": "HTTP Method.",
18354
18838
  "x-ves-proto-enum": "ves.io.schema.HttpMethod",
18839
+ "x-f5xc-description-short": "Specifies the HTTP method used to access a resource. Any HTTP Method.",
18355
18840
  "x-f5xc-minimum-configuration": {
18356
18841
  "description": "Minimum configuration for schemaHttpMethod",
18357
18842
  "required_fields": [],
@@ -18375,6 +18860,8 @@
18375
18860
  "HTTP_SECTION_RSP_BODY"
18376
18861
  ],
18377
18862
  "default": "HTTP_SECTION_NONE",
18863
+ "x-f5xc-description-short": "X-displayName: \"HTTP Sections\" Request & Response Sections. - HTTP_SECTION_NONE: None ALL_SECTIONS x-displayName: \"None\" ...",
18864
+ "x-f5xc-description-medium": "X-displayName: \"HTTP Sections\" Request & Response Sections. - HTTP_SECTION_NONE: None ALL_SECTIONS x-displayName: \"None\" - HTTP_SECTION_QUERY_PARAMS: QUERY_PARAMS x-displayName: \"Request Query Params\" - HTTP_SECTION_REQ_HEADERS: REQ_HEADERS x-displayName: \"Request Headers\" ...",
18378
18865
  "x-f5xc-minimum-configuration": {
18379
18866
  "description": "Minimum configuration for schemaHttpSections",
18380
18867
  "required_fields": [],
@@ -18415,7 +18902,7 @@
18415
18902
  },
18416
18903
  "x-original-maxLength": 256,
18417
18904
  "x-reconciled-from-discovery": true,
18418
- "x-reconciled-at": "2026-01-05T18:30:03.893285+00:00"
18905
+ "x-reconciled-at": "2026-01-07T15:54:15.402218+00:00"
18419
18906
  },
18420
18907
  "name": {
18421
18908
  "type": "string",
@@ -18436,6 +18923,7 @@
18436
18923
  "ves.io.schema.rules.string.min_len": "1",
18437
18924
  "ves.io.schema.rules.string.ves_object_name": "true"
18438
18925
  },
18926
+ "x-f5xc-description-short": "Name of the message. The value of name has to follow DNS-1035 format.",
18439
18927
  "maxLength": 16,
18440
18928
  "x-f5xc-required-for": {
18441
18929
  "minimum_config": false,
@@ -18445,9 +18933,11 @@
18445
18933
  },
18446
18934
  "x-original-maxLength": 1024,
18447
18935
  "x-reconciled-from-discovery": true,
18448
- "x-reconciled-at": "2026-01-05T18:30:03.893290+00:00"
18936
+ "x-reconciled-at": "2026-01-07T15:54:15.402222+00:00"
18449
18937
  }
18450
18938
  },
18939
+ "x-f5xc-description-short": "MessageMetaType is metadata (common attributes) of a message that only certain messages have.",
18940
+ "x-f5xc-description-medium": "MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create...",
18451
18941
  "x-f5xc-minimum-configuration": {
18452
18942
  "description": "Minimum configuration for schemaMessageMetaType",
18453
18943
  "required_fields": [
@@ -18478,6 +18968,8 @@
18478
18968
  "default": "PROPERTY_QUERY_PARAMETERS",
18479
18969
  "x-displayname": "OpenAPI Validation Properties.",
18480
18970
  "x-ves-proto-enum": "ves.io.schema.OpenApiValidationProperties",
18971
+ "x-f5xc-description-short": "List of required properties to validate against the OpenAPI spec Validate that all query parameters are according to the OpenAPI specification...",
18972
+ "x-f5xc-description-medium": "List of required properties to validate against the OpenAPI spec Validate that all query parameters are according to the OpenAPI specification Validate that all path parameters are according to the OpenAPI specification Validate that the content type of the request is according to the OpenAPI...",
18481
18973
  "x-f5xc-minimum-configuration": {
18482
18974
  "description": "Minimum configuration for schemaOpenApiValidationProperties",
18483
18975
  "required_fields": [],
@@ -18500,6 +18992,8 @@
18500
18992
  "title": "Token",
18501
18993
  "format": "byte",
18502
18994
  "x-displayname": "Token",
18995
+ "description": "Authentication or access token",
18996
+ "x-f5xc-example": "[REDACTED_API_TOKEN]",
18503
18997
  "minLength": 0,
18504
18998
  "maxLength": 1024,
18505
18999
  "x-f5xc-required-for": {
@@ -18510,6 +19004,8 @@
18510
19004
  }
18511
19005
  }
18512
19006
  },
19007
+ "x-f5xc-description-short": "Response to the Generate Token Request token - a base64 encoding of AuthToken struct will be used in accesslog request header.",
19008
+ "x-f5xc-description-medium": "Response to the Generate Token Request token - a base64 encoding of AuthToken struct will be used in accesslog request header.",
18513
19009
  "x-f5xc-minimum-configuration": {
18514
19010
  "description": "Minimum configuration for third_party_applicationGenerateTokenResponse",
18515
19011
  "required_fields": [
@@ -18537,6 +19033,7 @@
18537
19033
  "$ref": "#/components/schemas/ioschemaObjectRefType"
18538
19034
  },
18539
19035
  "x-displayname": "Deleted Referred Objects.",
19036
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
18540
19037
  "x-f5xc-required-for": {
18541
19038
  "minimum_config": false,
18542
19039
  "create": false,
@@ -18552,6 +19049,7 @@
18552
19049
  "$ref": "#/components/schemas/ioschemaObjectRefType"
18553
19050
  },
18554
19051
  "x-displayname": "Disabled Referred Objects.",
19052
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
18555
19053
  "x-f5xc-required-for": {
18556
19054
  "minimum_config": false,
18557
19055
  "create": false,
@@ -18570,6 +19068,7 @@
18570
19068
  "$ref": "#/components/schemas/ioschemaObjectRefType"
18571
19069
  },
18572
19070
  "x-displayname": "Referring Objects.",
19071
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
18573
19072
  "x-f5xc-required-for": {
18574
19073
  "minimum_config": false,
18575
19074
  "create": false,
@@ -18591,6 +19090,8 @@
18591
19090
  "$ref": "#/components/schemas/third_party_applicationStatusObject"
18592
19091
  },
18593
19092
  "x-displayname": "Status",
19093
+ "x-f5xc-example": "active",
19094
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
18594
19095
  "x-f5xc-required-for": {
18595
19096
  "minimum_config": false,
18596
19097
  "create": false,
@@ -18600,7 +19101,7 @@
18600
19101
  "maxLength": 17,
18601
19102
  "minLength": 17,
18602
19103
  "x-reconciled-from-discovery": true,
18603
- "x-reconciled-at": "2026-01-05T18:30:03.893450+00:00"
19104
+ "x-reconciled-at": "2026-01-07T15:54:15.402392+00:00"
18604
19105
  },
18605
19106
  "system_metadata": {
18606
19107
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -18638,6 +19139,8 @@
18638
19139
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
18639
19140
  ],
18640
19141
  "default": "GET_RSP_FORMAT_DEFAULT",
19142
+ "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...",
19143
+ "x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\" Response should...",
18641
19144
  "x-f5xc-minimum-configuration": {
18642
19145
  "description": "Minimum configuration for third_party_applicationGetResponseFormatCode",
18643
19146
  "required_fields": [],
@@ -18673,6 +19176,7 @@
18673
19176
  "x-validation-rules": {
18674
19177
  "ves.io.schema.rules.message.required": "true"
18675
19178
  },
19179
+ "x-f5xc-description-short": "Namespace of the Third Party Application for current request Required: YES.",
18676
19180
  "minLength": 0,
18677
19181
  "maxLength": 6,
18678
19182
  "x-f5xc-required-for": {
@@ -18683,12 +19187,13 @@
18683
19187
  },
18684
19188
  "x-original-maxLength": 1024,
18685
19189
  "x-reconciled-from-discovery": true,
18686
- "x-reconciled-at": "2026-01-05T18:30:03.893458+00:00"
19190
+ "x-reconciled-at": "2026-01-07T15:54:15.402400+00:00"
18687
19191
  },
18688
19192
  "third_party_applications_list": {
18689
19193
  "$ref": "#/components/schemas/third_party_applicationThirdPartyApplicationList"
18690
19194
  }
18691
19195
  },
19196
+ "x-f5xc-description-short": "Request of GET Security Config Spec API.",
18692
19197
  "x-f5xc-minimum-configuration": {
18693
19198
  "description": "Minimum configuration for third_party_applicationGetSecurityConfigReq",
18694
19199
  "required_fields": [
@@ -18718,6 +19223,7 @@
18718
19223
  "$ref": "#/components/schemas/schemaErrorType"
18719
19224
  },
18720
19225
  "x-displayname": "Errors",
19226
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
18721
19227
  "x-f5xc-required-for": {
18722
19228
  "minimum_config": false,
18723
19229
  "create": false,
@@ -18733,6 +19239,8 @@
18733
19239
  "$ref": "#/components/schemas/third_party_applicationListResponseItem"
18734
19240
  },
18735
19241
  "x-displayname": "Items",
19242
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
19243
+ "x-f5xc-description-short": "Items represents the collection in response.",
18736
19244
  "x-f5xc-required-for": {
18737
19245
  "minimum_config": false,
18738
19246
  "create": false,
@@ -18766,6 +19274,8 @@
18766
19274
  "description": "The set of annotations present on this third_party_application.",
18767
19275
  "title": "Annotations.",
18768
19276
  "x-displayname": "Annotations.",
19277
+ "x-f5xc-example": "{\"key\": \"value\"}",
19278
+ "x-f5xc-description-short": "The set of annotations present on this third_party_application.",
18769
19279
  "x-f5xc-required-for": {
18770
19280
  "minimum_config": false,
18771
19281
  "create": false,
@@ -18778,6 +19288,7 @@
18778
19288
  "description": "The description set for this third_party_application.",
18779
19289
  "title": "Description.",
18780
19290
  "x-displayname": "Description.",
19291
+ "x-f5xc-description-short": "The description set for this third_party_application.",
18781
19292
  "minLength": 0,
18782
19293
  "maxLength": 0,
18783
19294
  "x-f5xc-required-for": {
@@ -18788,7 +19299,7 @@
18788
19299
  },
18789
19300
  "x-original-maxLength": 1024,
18790
19301
  "x-reconciled-from-discovery": true,
18791
- "x-reconciled-at": "2026-01-05T18:30:03.893469+00:00"
19302
+ "x-reconciled-at": "2026-01-07T15:54:15.402411+00:00"
18792
19303
  },
18793
19304
  "disabled": {
18794
19305
  "type": "boolean",
@@ -18796,6 +19307,8 @@
18796
19307
  "title": "Disabled",
18797
19308
  "format": "boolean",
18798
19309
  "x-displayname": "Disabled",
19310
+ "x-f5xc-example": "True",
19311
+ "x-f5xc-description-short": "Value of true indicates third_party_application is administratively disabled.",
18799
19312
  "x-f5xc-required-for": {
18800
19313
  "minimum_config": false,
18801
19314
  "create": false,
@@ -18811,6 +19324,8 @@
18811
19324
  "description": "The set of labels present on this third_party_application.",
18812
19325
  "title": "Labels",
18813
19326
  "x-displayname": "Labels",
19327
+ "x-f5xc-example": "{\"key\": \"value\"}",
19328
+ "x-f5xc-description-short": "The set of labels present on this third_party_application.",
18814
19329
  "x-f5xc-required-for": {
18815
19330
  "minimum_config": false,
18816
19331
  "create": false,
@@ -18828,6 +19343,7 @@
18828
19343
  "x-displayname": "Name",
18829
19344
  "x-ves-example": "Name",
18830
19345
  "x-f5xc-example": "name",
19346
+ "x-f5xc-description-short": "The name of this third_party_application.",
18831
19347
  "minLength": 0,
18832
19348
  "maxLength": 16,
18833
19349
  "x-f5xc-required-for": {
@@ -18838,7 +19354,7 @@
18838
19354
  },
18839
19355
  "x-original-maxLength": 1024,
18840
19356
  "x-reconciled-from-discovery": true,
18841
- "x-reconciled-at": "2026-01-05T18:30:03.893479+00:00"
19357
+ "x-reconciled-at": "2026-01-07T15:54:15.402421+00:00"
18842
19358
  },
18843
19359
  "namespace": {
18844
19360
  "type": "string",
@@ -18857,7 +19373,7 @@
18857
19373
  },
18858
19374
  "x-original-maxLength": 1024,
18859
19375
  "x-reconciled-from-discovery": true,
18860
- "x-reconciled-at": "2026-01-05T18:30:03.893483+00:00"
19376
+ "x-reconciled-at": "2026-01-07T15:54:15.402425+00:00"
18861
19377
  },
18862
19378
  "owner_view": {
18863
19379
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -18870,6 +19386,7 @@
18870
19386
  "$ref": "#/components/schemas/third_party_applicationStatusObject"
18871
19387
  },
18872
19388
  "x-displayname": "Status",
19389
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
18873
19390
  "x-f5xc-required-for": {
18874
19391
  "minimum_config": false,
18875
19392
  "create": false,
@@ -18898,7 +19415,7 @@
18898
19415
  "x-field-mutability": "read-only",
18899
19416
  "x-original-maxLength": 1024,
18900
19417
  "x-reconciled-from-discovery": true,
18901
- "x-reconciled-at": "2026-01-05T18:30:03.893491+00:00"
19418
+ "x-reconciled-at": "2026-01-07T15:54:15.402433+00:00"
18902
19419
  },
18903
19420
  "uid": {
18904
19421
  "type": "string",
@@ -18907,6 +19424,7 @@
18907
19424
  "x-displayname": "UID",
18908
19425
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
18909
19426
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
19427
+ "x-f5xc-description-short": "The unique uid of this third_party_application.",
18910
19428
  "minLength": 0,
18911
19429
  "maxLength": 36,
18912
19430
  "x-f5xc-required-for": {
@@ -18919,9 +19437,11 @@
18919
19437
  "x-original-maxLength": 1024,
18920
19438
  "format": "uuid",
18921
19439
  "x-reconciled-from-discovery": true,
18922
- "x-reconciled-at": "2026-01-05T18:30:03.893496+00:00"
19440
+ "x-reconciled-at": "2026-01-07T15:54:15.402438+00:00"
18923
19441
  }
18924
19442
  },
19443
+ "x-f5xc-description-short": "By default a summary of third_party_application is returned in 'List'.",
19444
+ "x-f5xc-description-medium": "By default a summary of third_party_application is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
18925
19445
  "x-f5xc-minimum-configuration": {
18926
19446
  "description": "Minimum configuration for third_party_applicationListResponseItem",
18927
19447
  "required_fields": [
@@ -19001,6 +19521,7 @@
19001
19521
  "$ref": "#/components/schemas/schemaConditionType"
19002
19522
  },
19003
19523
  "x-displayname": "Conditions.",
19524
+ "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.",
19004
19525
  "x-f5xc-required-for": {
19005
19526
  "minimum_config": false,
19006
19527
  "create": false,
@@ -19019,6 +19540,7 @@
19019
19540
  "$ref": "#/components/schemas/ioschemaObjectRefType"
19020
19541
  },
19021
19542
  "x-displayname": "Config Object.",
19543
+ "x-f5xc-description-short": "Third Party Application virtual_server view object direct reference.",
19022
19544
  "x-f5xc-required-for": {
19023
19545
  "minimum_config": false,
19024
19546
  "create": false,
@@ -19027,6 +19549,7 @@
19027
19549
  }
19028
19550
  }
19029
19551
  },
19552
+ "x-f5xc-description-short": "Most recently observed status of object.",
19030
19553
  "x-f5xc-minimum-configuration": {
19031
19554
  "description": "Minimum configuration for third_party_applicationStatusObject",
19032
19555
  "required_fields": [
@@ -19128,6 +19651,7 @@
19128
19651
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
19129
19652
  }
19130
19653
  },
19654
+ "x-f5xc-description-short": "Shape of the Third Party Application specification.",
19131
19655
  "x-f5xc-minimum-configuration": {
19132
19656
  "description": "Minimum configuration for viewsthird_party_applicationGetSpecType",
19133
19657
  "required_fields": [
@@ -19178,6 +19702,7 @@
19178
19702
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
19179
19703
  }
19180
19704
  },
19705
+ "x-f5xc-description-short": "Shape of the Third Party Application specification.",
19181
19706
  "x-f5xc-minimum-configuration": {
19182
19707
  "description": "Minimum configuration for viewsthird_party_applicationReplaceSpecType",
19183
19708
  "required_fields": [
@@ -19205,6 +19730,7 @@
19205
19730
  "type": "object",
19206
19731
  "description": "X-displayName: \"Allocated Numbers\"\nAllocated Numbers.",
19207
19732
  "title": "AllocatedNumbers.",
19733
+ "x-f5xc-description-short": "X-displayName: \"Allocated Numbers\" Allocated Numbers.",
19208
19734
  "x-f5xc-required-for": {
19209
19735
  "minimum_config": false,
19210
19736
  "create": false,
@@ -19213,6 +19739,7 @@
19213
19739
  }
19214
19740
  }
19215
19741
  },
19742
+ "x-f5xc-description-short": "X-displayName: \"Allocated Numbers\" Allocated Numbers.",
19216
19743
  "x-f5xc-minimum-configuration": {
19217
19744
  "description": "Minimum configuration for view_internalAllocatedNumbers",
19218
19745
  "required_fields": [
@@ -19260,6 +19787,7 @@
19260
19787
  "description": "Allocation Map keeps track of all allocations for this view. The key is the allocator name.",
19261
19788
  "title": "Allocation Map.",
19262
19789
  "x-displayname": "Allocation Map.",
19790
+ "x-f5xc-description-short": "Allocation Map keeps track of all allocations for this view. The key is the allocator name.",
19263
19791
  "x-f5xc-required-for": {
19264
19792
  "minimum_config": false,
19265
19793
  "create": false,
@@ -19286,6 +19814,7 @@
19286
19814
  "$ref": "#/components/schemas/schemaViewRefType"
19287
19815
  }
19288
19816
  },
19817
+ "x-f5xc-description-short": "Shape of the view internal specification.",
19289
19818
  "x-f5xc-minimum-configuration": {
19290
19819
  "description": "Minimum configuration for view_internalGlobalSpecType",
19291
19820
  "required_fields": [
@@ -19375,6 +19904,8 @@
19375
19904
  "title": "Modification_timestamp.",
19376
19905
  "format": "date-time",
19377
19906
  "x-displayname": "Modification Timestamp.",
19907
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
19908
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
19378
19909
  "minLength": 0,
19379
19910
  "maxLength": 1024,
19380
19911
  "x-f5xc-required-for": {
@@ -19408,6 +19939,7 @@
19408
19939
  "x-displayname": "Terraform Output.",
19409
19940
  "x-ves-example": "Value",
19410
19941
  "x-f5xc-example": "value",
19942
+ "x-f5xc-description-short": "The value of an \"output\" variable from the terraform state file.",
19411
19943
  "minLength": 0,
19412
19944
  "maxLength": 1024,
19413
19945
  "x-f5xc-required-for": {
@@ -19488,6 +20020,7 @@
19488
20020
  "x-displayname": "Namespace",
19489
20021
  "x-ves-example": "Value",
19490
20022
  "x-f5xc-example": "value",
20023
+ "x-f5xc-description-short": "Namespace for the label to be retrieved.",
19491
20024
  "minLength": 0,
19492
20025
  "maxLength": 6,
19493
20026
  "x-f5xc-required-for": {
@@ -19498,7 +20031,7 @@
19498
20031
  },
19499
20032
  "x-original-maxLength": 1024,
19500
20033
  "x-reconciled-from-discovery": true,
19501
- "x-reconciled-at": "2026-01-05T18:30:09.526308+00:00"
20034
+ "x-reconciled-at": "2026-01-07T15:54:22.708067+00:00"
19502
20035
  },
19503
20036
  "view_kind": {
19504
20037
  "type": "string",
@@ -19507,6 +20040,7 @@
19507
20040
  "x-displayname": "Kind of View.",
19508
20041
  "x-ves-example": "Value",
19509
20042
  "x-f5xc-example": "value",
20043
+ "x-f5xc-description-short": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
19510
20044
  "minLength": 0,
19511
20045
  "maxLength": 1024,
19512
20046
  "x-f5xc-required-for": {
@@ -19523,6 +20057,7 @@
19523
20057
  "x-displayname": "Name of view.",
19524
20058
  "x-ves-example": "Value",
19525
20059
  "x-f5xc-example": "value",
20060
+ "x-f5xc-description-short": "Name of the view for which terraform parameters are requested.",
19526
20061
  "minLength": 0,
19527
20062
  "maxLength": 1024,
19528
20063
  "x-f5xc-required-for": {
@@ -19687,6 +20222,8 @@
19687
20222
  "title": "Modification_timestamp.",
19688
20223
  "format": "date-time",
19689
20224
  "x-displayname": "Modification Timestamp.",
20225
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
20226
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this status was last modified.",
19690
20227
  "minLength": 0,
19691
20228
  "maxLength": 1024,
19692
20229
  "x-f5xc-required-for": {
@@ -19723,6 +20260,7 @@
19723
20260
  "x-displayname": "Terraform Plan Output.",
19724
20261
  "x-ves-example": "Value",
19725
20262
  "x-f5xc-example": "value",
20263
+ "x-f5xc-description-medium": "Terraform \"plan\" command output. Terraform performs a refresh, unless explicitly disabled, and then determines what actions are necessary to achieve the desired state specified in the configuration files.",
19726
20264
  "minLength": 0,
19727
20265
  "maxLength": 1024,
19728
20266
  "x-f5xc-required-for": {
@@ -19781,6 +20319,8 @@
19781
20319
  "default": "APPLY",
19782
20320
  "x-displayname": "Terraform action to be performed.",
19783
20321
  "x-ves-proto-enum": "ves.io.schema.views.terraform_parameters.RunAction",
20322
+ "x-f5xc-description-short": "Terraform action to be performed for a given view e.g.",
20323
+ "x-f5xc-description-medium": "Terraform action to be performed for a given view e.g. Plan, apply Apply action used to apply the changes required to reach the desired state of the configuration Plan action is a convenient way to check whether the execution plan for a set of changes matches your expectations without making any...",
19784
20324
  "x-f5xc-minimum-configuration": {
19785
20325
  "description": "Minimum configuration for terraform_parametersRunAction",
19786
20326
  "required_fields": [],
@@ -19808,6 +20348,7 @@
19808
20348
  "x-displayname": "Namespace",
19809
20349
  "x-ves-example": "Value",
19810
20350
  "x-f5xc-example": "value",
20351
+ "x-f5xc-description-short": "Namespace for the label to be retrieved.",
19811
20352
  "minLength": 0,
19812
20353
  "maxLength": 6,
19813
20354
  "x-f5xc-required-for": {
@@ -19818,7 +20359,7 @@
19818
20359
  },
19819
20360
  "x-original-maxLength": 1024,
19820
20361
  "x-reconciled-from-discovery": true,
19821
- "x-reconciled-at": "2026-01-05T18:30:09.526331+00:00"
20362
+ "x-reconciled-at": "2026-01-07T15:54:22.708089+00:00"
19822
20363
  },
19823
20364
  "view_kind": {
19824
20365
  "type": "string",
@@ -19827,6 +20368,7 @@
19827
20368
  "x-displayname": "Kind of View.",
19828
20369
  "x-ves-example": "Value",
19829
20370
  "x-f5xc-example": "value",
20371
+ "x-f5xc-description-short": "Kind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
19830
20372
  "minLength": 0,
19831
20373
  "maxLength": 1024,
19832
20374
  "x-f5xc-required-for": {
@@ -19843,6 +20385,7 @@
19843
20385
  "x-displayname": "Name of view.",
19844
20386
  "x-ves-example": "Value",
19845
20387
  "x-f5xc-example": "value",
20388
+ "x-f5xc-description-short": "Name of the view for which terraform parameters are requested.",
19846
20389
  "minLength": 0,
19847
20390
  "maxLength": 1024,
19848
20391
  "x-f5xc-required-for": {
@@ -19853,6 +20396,7 @@
19853
20396
  }
19854
20397
  }
19855
20398
  },
20399
+ "x-f5xc-description-short": "Perform terraform actions for a given view. Supported actions are apply and plan.",
19856
20400
  "x-f5xc-minimum-configuration": {
19857
20401
  "description": "Minimum configuration for terraform_parametersRunRequest",
19858
20402
  "required_fields": [
@@ -19902,6 +20446,7 @@
19902
20446
  "$ref": "#/components/schemas/schemaConditionType"
19903
20447
  },
19904
20448
  "x-displayname": "Conditions.",
20449
+ "x-f5xc-description-short": "Conditions reported by various components of the system.",
19905
20450
  "x-f5xc-required-for": {
19906
20451
  "minimum_config": false,
19907
20452
  "create": false,
@@ -19920,6 +20465,7 @@
19920
20465
  "$ref": "#/components/schemas/ioschemaObjectRefType"
19921
20466
  },
19922
20467
  "x-displayname": "Config Object.",
20468
+ "x-f5xc-description-short": "View terraform parameters object reference for which this status object is generated.",
19923
20469
  "x-f5xc-required-for": {
19924
20470
  "minimum_config": false,
19925
20471
  "create": false,
@@ -19931,6 +20477,7 @@
19931
20477
  "$ref": "#/components/schemas/terraform_parametersPlanStatus"
19932
20478
  }
19933
20479
  },
20480
+ "x-f5xc-description-short": "View terraform parameters status object.",
19934
20481
  "x-f5xc-minimum-configuration": {
19935
20482
  "description": "Minimum configuration for terraform_parametersStatusObject",
19936
20483
  "required_fields": [
@@ -19957,6 +20504,8 @@
19957
20504
  "UPGRADE_NOT_REQUIRED"
19958
20505
  ],
19959
20506
  "default": "UPGRADE_SUCCESSFUL",
20507
+ "x-f5xc-description-short": "X-displayName: \"Upgrade State\" Terraform State after version Upgrade - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\" - UPGRADE_ERRORED...",
20508
+ "x-f5xc-description-medium": "X-displayName: \"Upgrade State\" Terraform State after version Upgrade - UPGRADE_SUCCESSFUL: x-displayName: \"Upgrade successful\" - UPGRADE_ERRORED: x-displayName: \"Upgrade errored\" - UPGRADE_NOT_REQUIRED: x-displayName: \"Upgrade not required\".",
19960
20509
  "x-f5xc-minimum-configuration": {
19961
20510
  "description": "Minimum configuration for terraform_parametersUpgradeState",
19962
20511
  "required_fields": [],
@@ -19979,6 +20528,7 @@
19979
20528
  "description": "Container Version used to run the terrafrom.",
19980
20529
  "title": "Container Version.",
19981
20530
  "x-displayname": "Container Version.",
20531
+ "x-f5xc-description-short": "Container Version used to run the terrafrom.",
19982
20532
  "minLength": 0,
19983
20533
  "maxLength": 1024,
19984
20534
  "x-f5xc-required-for": {
@@ -19996,6 +20546,7 @@
19996
20546
  "$ref": "#/components/schemas/ioschemaObjectRefType"
19997
20547
  },
19998
20548
  "x-displayname": "Cloud Credentials.",
20549
+ "x-f5xc-description-short": "Reference to cloud credentials used in the terraform.",
19999
20550
  "x-f5xc-required-for": {
20000
20551
  "minimum_config": false,
20001
20552
  "create": false,
@@ -20019,6 +20570,7 @@
20019
20570
  }
20020
20571
  }
20021
20572
  },
20573
+ "x-f5xc-description-short": "Shape of the view terraform parameters specification.",
20022
20574
  "x-f5xc-minimum-configuration": {
20023
20575
  "description": "Minimum configuration for viewsterraform_parametersGlobalSpecType",
20024
20576
  "required_fields": [
@@ -20047,6 +20599,7 @@
20047
20599
  "x-displayname": "Console URL.",
20048
20600
  "x-ves-example": "Console_url: https://console.ves.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioio/login/start.",
20049
20601
  "x-f5xc-example": "console_urlhttps://console.ves.volterra.ioioioioioioioioioioioioioioioioioioioioioioioioioioioioio/login/start",
20602
+ "x-f5xc-description-short": "URL to the console page, returned if the tenant is already signed up and active.",
20050
20603
  "minLength": 0,
20051
20604
  "maxLength": 1024,
20052
20605
  "x-f5xc-required-for": {
@@ -20061,6 +20614,8 @@
20061
20614
  "description": "The domain associated with the registered ASB message.",
20062
20615
  "title": "Domain",
20063
20616
  "x-displayname": "Domain",
20617
+ "x-f5xc-example": "example.com",
20618
+ "x-f5xc-description-short": "The domain associated with the registered ASB message.",
20064
20619
  "minLength": 0,
20065
20620
  "maxLength": 26,
20066
20621
  "x-f5xc-required-for": {
@@ -20072,7 +20627,7 @@
20072
20627
  "x-original-maxLength": 1024,
20073
20628
  "format": "hostname",
20074
20629
  "x-reconciled-from-discovery": true,
20075
- "x-reconciled-at": "2026-01-05T18:30:14.471571+00:00"
20630
+ "x-reconciled-at": "2026-01-07T15:54:29.067526+00:00"
20076
20631
  },
20077
20632
  "email": {
20078
20633
  "type": "string",
@@ -20080,6 +20635,7 @@
20080
20635
  "title": "Email",
20081
20636
  "x-displayname": "Email",
20082
20637
  "x-f5xc-example": "user@example.com",
20638
+ "x-f5xc-description-short": "The email associated with the registered ASB message.",
20083
20639
  "format": "email",
20084
20640
  "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
20085
20641
  "minLength": 0,
@@ -20098,6 +20654,7 @@
20098
20654
  "x-displayname": "Error Message.",
20099
20655
  "x-ves-example": "Error_message\": \"Your account is already active. Please log in to continue.",
20100
20656
  "x-f5xc-example": "\"error_message\"\"Your account is already active. Please log in to continue.\"",
20657
+ "x-f5xc-description-short": "Error message providing additional details (e.g., tenant already signed up).",
20101
20658
  "minLength": 0,
20102
20659
  "maxLength": 1024,
20103
20660
  "x-f5xc-required-for": {
@@ -20108,6 +20665,7 @@
20108
20665
  }
20109
20666
  }
20110
20667
  },
20668
+ "x-f5xc-description-short": "Response format for returning registration details associated with the ASB message.",
20111
20669
  "x-f5xc-minimum-configuration": {
20112
20670
  "description": "Minimum configuration for xc_saasGetRegistrationDetailsResponse",
20113
20671
  "required_fields": [
@@ -20135,6 +20693,7 @@
20135
20693
  "description": "Message provides additional context regarding the result of the email send operation.",
20136
20694
  "title": "Message",
20137
20695
  "x-displayname": "Message",
20696
+ "x-f5xc-description-short": "Message provides additional context regarding the result of the email send operation.",
20138
20697
  "minLength": 0,
20139
20698
  "maxLength": 1024,
20140
20699
  "x-f5xc-required-for": {
@@ -20150,6 +20709,7 @@
20150
20709
  "title": "Success",
20151
20710
  "format": "boolean",
20152
20711
  "x-displayname": "Success",
20712
+ "x-f5xc-description-short": "Indicates if the email was sent successfully.",
20153
20713
  "x-f5xc-required-for": {
20154
20714
  "minimum_config": false,
20155
20715
  "create": false,
@@ -20158,6 +20718,7 @@
20158
20718
  }
20159
20719
  }
20160
20720
  },
20721
+ "x-f5xc-description-short": "Response to indicate if the email was sent successfully.",
20161
20722
  "x-f5xc-minimum-configuration": {
20162
20723
  "description": "Minimum configuration for xc_saasSendEmailResponse",
20163
20724
  "required_fields": [
@@ -20185,6 +20746,7 @@
20185
20746
  "x-displayname": "Token",
20186
20747
  "x-ves-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7.",
20187
20748
  "x-f5xc-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7",
20749
+ "x-f5xc-description-short": "The token contains the encrypted data, secured using an HMAC key.",
20188
20750
  "minLength": 0,
20189
20751
  "maxLength": 1024,
20190
20752
  "x-f5xc-required-for": {
@@ -20195,6 +20757,7 @@
20195
20757
  }
20196
20758
  }
20197
20759
  },
20760
+ "x-f5xc-description-short": "The request message for SendSignupEmail.",
20198
20761
  "x-f5xc-minimum-configuration": {
20199
20762
  "description": "Minimum configuration for xc_saasSendSignupEmailRequest",
20200
20763
  "required_fields": [
@@ -20232,6 +20795,8 @@
20232
20795
  "ves.io.schema.rules.string.not_in": "[\\\"ves\\\",\\\"F5 Distributed Cloud\\\",\\\"f5\\\"]",
20233
20796
  "ves.io.schema.rules.string.ves_object_name": "true"
20234
20797
  },
20798
+ "x-f5xc-example": "example.com",
20799
+ "x-f5xc-description-short": "The domain associated with the tenant/account.",
20235
20800
  "x-f5xc-required-for": {
20236
20801
  "minimum_config": false,
20237
20802
  "create": false,
@@ -20240,7 +20805,7 @@
20240
20805
  },
20241
20806
  "format": "hostname",
20242
20807
  "x-reconciled-from-discovery": true,
20243
- "x-reconciled-at": "2026-01-05T18:30:14.471589+00:00"
20808
+ "x-reconciled-at": "2026-01-07T15:54:29.067544+00:00"
20244
20809
  },
20245
20810
  "token": {
20246
20811
  "type": "string",
@@ -20248,6 +20813,7 @@
20248
20813
  "title": "Token",
20249
20814
  "x-displayname": "Token",
20250
20815
  "x-f5xc-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7",
20816
+ "x-f5xc-description-short": "The token contains the encrypted data, secured using an HMAC key.",
20251
20817
  "minLength": 0,
20252
20818
  "maxLength": 1024,
20253
20819
  "x-f5xc-required-for": {