@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": "Billing And Usage",
5
5
  "description": "Subscription lifecycle with plan transitions and billing states. Payment method hierarchies supporting primary and secondary configurations. Invoice generation with PDF downloads and custom listing. Resource quotas per namespace with limit definitions and consumption metrics. Contact types for billing notifications and tenant deletion 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"
@@ -5492,6 +5492,7 @@
5492
5492
  "title": "PDF",
5493
5493
  "format": "byte",
5494
5494
  "x-displayname": "PDF",
5495
+ "x-f5xc-description-short": "Base 64 encoded invoice as a PDF document.",
5495
5496
  "minLength": 0,
5496
5497
  "maxLength": 1024,
5497
5498
  "x-f5xc-required-for": {
@@ -5530,6 +5531,8 @@
5530
5531
  "default": "STATUS_UNKNOWN",
5531
5532
  "x-displayname": "Invoice status.",
5532
5533
  "x-ves-proto-enum": "ves.io.schema.usage.invoice.InvoiceStatus",
5534
+ "x-f5xc-description-short": "Invoice status Unknown, undefined status Invoice is just issued Invoice is pending, also known as running invoice Invoice is paid Invoice is...",
5535
+ "x-f5xc-description-medium": "Invoice status Unknown, undefined status Invoice is just issued Invoice is pending, also known as running invoice Invoice is paid Invoice is refunded Cancelled invoice (before being due) Set when current date is past due date, clears when the invoice gets paid.",
5533
5536
  "x-f5xc-minimum-configuration": {
5534
5537
  "description": "Minimum configuration for invoiceInvoiceStatus",
5535
5538
  "required_fields": [],
@@ -5553,6 +5556,9 @@
5553
5556
  "title": "Invoice active flag.",
5554
5557
  "format": "boolean",
5555
5558
  "x-displayname": "Active",
5559
+ "x-f5xc-example": "True",
5560
+ "x-f5xc-description-short": "Indicate whether an invoice is active or not. Active invoices are not finalised and their value can change.",
5561
+ "x-f5xc-description-medium": "Indicate whether an invoice is active or not. Active invoices are not finalised and their value can change. Inactive invoices are final and their value cannot change.",
5556
5562
  "x-f5xc-required-for": {
5557
5563
  "minimum_config": false,
5558
5564
  "create": false,
@@ -5610,7 +5616,7 @@
5610
5616
  },
5611
5617
  "x-original-maxLength": 1024,
5612
5618
  "x-reconciled-from-discovery": true,
5613
- "x-reconciled-at": "2026-01-05T18:29:29.116082+00:00"
5619
+ "x-reconciled-at": "2026-01-07T15:53:31.485301+00:00"
5614
5620
  },
5615
5621
  "period_end": {
5616
5622
  "type": "string",
@@ -5683,6 +5689,7 @@
5683
5689
  "$ref": "#/components/schemas/invoiceInvoiceType"
5684
5690
  },
5685
5691
  "x-displayname": "Invoices",
5692
+ "x-f5xc-description-short": "List of invoices as per customer request.",
5686
5693
  "x-f5xc-required-for": {
5687
5694
  "minimum_config": false,
5688
5695
  "create": false,
@@ -5715,6 +5722,8 @@
5715
5722
  "default": "MAILING",
5716
5723
  "x-displayname": "Contact Type.",
5717
5724
  "x-ves-proto-enum": "ves.io.schema.contact.ContactType",
5725
+ "x-f5xc-description-short": "Determines the contact type Indicates snail mail address (used for correspondence) Indicates billing address (this address will appear on...",
5726
+ "x-f5xc-description-medium": "Determines the contact type Indicates snail mail address (used for correspondence) Indicates billing address (this address will appear on invoices) Indicates contact used for a payment method (this address is used when charging a payment method).",
5718
5727
  "x-f5xc-minimum-configuration": {
5719
5728
  "description": "Minimum configuration for contactContactType",
5720
5729
  "required_fields": [],
@@ -5734,7 +5743,7 @@
5734
5743
  "properties": {
5735
5744
  "address1": {
5736
5745
  "type": "string",
5737
- "description": "",
5746
+ "description": "Network address or location",
5738
5747
  "title": "Address1",
5739
5748
  "x-displayname": "Address Line 1.",
5740
5749
  "x-ves-example": "1234 Main road.",
@@ -5750,7 +5759,7 @@
5750
5759
  },
5751
5760
  "address2": {
5752
5761
  "type": "string",
5753
- "description": "",
5762
+ "description": "Network address or location",
5754
5763
  "title": "Address2",
5755
5764
  "x-displayname": "Address Line 2.",
5756
5765
  "x-ves-example": "P.O BOX 56.",
@@ -5766,7 +5775,7 @@
5766
5775
  },
5767
5776
  "city": {
5768
5777
  "type": "string",
5769
- "description": "",
5778
+ "description": "Configuration parameter for city",
5770
5779
  "title": "City",
5771
5780
  "x-displayname": "City",
5772
5781
  "x-ves-example": "Sunnyvale",
@@ -5785,7 +5794,7 @@
5785
5794
  },
5786
5795
  "country": {
5787
5796
  "type": "string",
5788
- "description": "",
5797
+ "description": "Configuration parameter for country",
5789
5798
  "title": "Country",
5790
5799
  "x-displayname": "Country",
5791
5800
  "x-ves-example": "US",
@@ -5801,7 +5810,7 @@
5801
5810
  },
5802
5811
  "county": {
5803
5812
  "type": "string",
5804
- "description": "",
5813
+ "description": "Configuration parameter for county",
5805
5814
  "title": "County",
5806
5815
  "x-displayname": "County",
5807
5816
  "x-ves-example": "Santa Clara.",
@@ -5817,11 +5826,12 @@
5817
5826
  },
5818
5827
  "phone_number": {
5819
5828
  "type": "string",
5820
- "description": "",
5829
+ "description": "Configuration parameter for phone number",
5821
5830
  "title": "Phone_number.",
5822
5831
  "x-displayname": "Phone Number.",
5823
5832
  "x-ves-example": "+11234567890.",
5824
5833
  "x-f5xc-example": "+11234567890",
5834
+ "x-f5xc-description-short": "Configuration parameter for phone number.",
5825
5835
  "minLength": 0,
5826
5836
  "maxLength": 1024,
5827
5837
  "x-f5xc-required-for": {
@@ -5833,7 +5843,7 @@
5833
5843
  },
5834
5844
  "state": {
5835
5845
  "type": "string",
5836
- "description": "",
5846
+ "description": "Current state of the resource",
5837
5847
  "title": "State",
5838
5848
  "x-displayname": "State",
5839
5849
  "x-ves-example": "California.",
@@ -5849,7 +5859,7 @@
5849
5859
  },
5850
5860
  "state_code": {
5851
5861
  "type": "string",
5852
- "description": "",
5862
+ "description": "Configuration parameter for state code",
5853
5863
  "title": "State code.",
5854
5864
  "x-displayname": "State Code.",
5855
5865
  "x-ves-example": "CA",
@@ -5865,7 +5875,7 @@
5865
5875
  },
5866
5876
  "zip_code": {
5867
5877
  "type": "string",
5868
- "description": "",
5878
+ "description": "IP address configuration",
5869
5879
  "title": "Zip_code",
5870
5880
  "x-displayname": "ZIP code",
5871
5881
  "x-ves-example": "95054",
@@ -5880,6 +5890,8 @@
5880
5890
  }
5881
5891
  }
5882
5892
  },
5893
+ "x-f5xc-description-short": "Instance of one single contact that can be used to communicate with customers.",
5894
+ "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.",
5883
5895
  "x-f5xc-minimum-configuration": {
5884
5896
  "description": "Minimum configuration for contactGlobalSpecType",
5885
5897
  "required_fields": [
@@ -5918,6 +5930,8 @@
5918
5930
  "x-displayname": "Namespace",
5919
5931
  "x-ves-example": "System",
5920
5932
  "x-f5xc-example": "system",
5933
+ "x-f5xc-description-short": "Namespace specifies the namespace in which the payment method will be created. If not provided, the default 'system' namespace will be used.",
5934
+ "x-f5xc-description-medium": "Namespace specifies the namespace in which the payment method will be created. If not provided, the default 'system' namespace will be used.",
5921
5935
  "minLength": 0,
5922
5936
  "maxLength": 6,
5923
5937
  "x-f5xc-required-for": {
@@ -5928,7 +5942,7 @@
5928
5942
  },
5929
5943
  "x-original-maxLength": 1024,
5930
5944
  "x-reconciled-from-discovery": true,
5931
- "x-reconciled-at": "2026-01-05T18:29:41.315998+00:00"
5945
+ "x-reconciled-at": "2026-01-07T15:53:47.329038+00:00"
5932
5946
  },
5933
5947
  "role": {
5934
5948
  "$ref": "#/components/schemas/payment_methodPaymentMethodRole"
@@ -5940,6 +5954,8 @@
5940
5954
  "x-displayname": "Token",
5941
5955
  "x-ves-example": "Tok-123456.",
5942
5956
  "x-f5xc-example": "tok-123456",
5957
+ "x-f5xc-description-short": "Token associated with this payment method. This token needs to be obtained from a designated payment method provider e.g.",
5958
+ "x-f5xc-description-medium": "Token associated with this payment method. This token needs to be obtained from a designated payment method provider e.g. Stripe.",
5943
5959
  "minLength": 0,
5944
5960
  "maxLength": 1024,
5945
5961
  "x-f5xc-required-for": {
@@ -5976,6 +5992,7 @@
5976
5992
  "x-displayname": "Name",
5977
5993
  "x-ves-example": "Payment-method-1.",
5978
5994
  "x-f5xc-example": "payment-method-1",
5995
+ "x-f5xc-description-short": "Name of the newly created payment method object.",
5979
5996
  "minLength": 0,
5980
5997
  "maxLength": 16,
5981
5998
  "x-f5xc-required-for": {
@@ -5986,7 +6003,7 @@
5986
6003
  },
5987
6004
  "x-original-maxLength": 1024,
5988
6005
  "x-reconciled-from-discovery": true,
5989
- "x-reconciled-at": "2026-01-05T18:29:41.316008+00:00"
6006
+ "x-reconciled-at": "2026-01-07T15:53:47.329049+00:00"
5990
6007
  }
5991
6008
  },
5992
6009
  "x-f5xc-minimum-configuration": {
@@ -6015,6 +6032,7 @@
6015
6032
  "x-displayname": "Name",
6016
6033
  "x-ves-example": "Payment-method-1.",
6017
6034
  "x-f5xc-example": "payment-method-1",
6035
+ "x-f5xc-description-short": "The name of the payment method object to be made primary.",
6018
6036
  "minLength": 0,
6019
6037
  "maxLength": 16,
6020
6038
  "x-f5xc-required-for": {
@@ -6025,7 +6043,7 @@
6025
6043
  },
6026
6044
  "x-original-maxLength": 1024,
6027
6045
  "x-reconciled-from-discovery": true,
6028
- "x-reconciled-at": "2026-01-05T18:29:41.316014+00:00"
6046
+ "x-reconciled-at": "2026-01-07T15:53:47.329054+00:00"
6029
6047
  },
6030
6048
  "namespace": {
6031
6049
  "type": "string",
@@ -6034,6 +6052,7 @@
6034
6052
  "x-displayname": "Namespace",
6035
6053
  "x-ves-example": "System",
6036
6054
  "x-f5xc-example": "system",
6055
+ "x-f5xc-description-short": "The namespace in which the payment method object is present.",
6037
6056
  "minLength": 0,
6038
6057
  "maxLength": 6,
6039
6058
  "x-f5xc-required-for": {
@@ -6044,9 +6063,10 @@
6044
6063
  },
6045
6064
  "x-original-maxLength": 1024,
6046
6065
  "x-reconciled-from-discovery": true,
6047
- "x-reconciled-at": "2026-01-05T18:29:41.316018+00:00"
6066
+ "x-reconciled-at": "2026-01-07T15:53:47.329059+00:00"
6048
6067
  }
6049
6068
  },
6069
+ "x-f5xc-description-short": "Changes a payment method role to primary.",
6050
6070
  "x-f5xc-minimum-configuration": {
6051
6071
  "description": "Minimum configuration for payment_methodPaymentMethodPrimaryReq",
6052
6072
  "required_fields": [
@@ -6073,6 +6093,8 @@
6073
6093
  "default": "PAYMENT_METHOD_ROLE_UNKNOWN",
6074
6094
  "x-displayname": "Payment method role.",
6075
6095
  "x-ves-proto-enum": "ves.io.schema.billing.payment_method.PaymentMethodRole",
6096
+ "x-f5xc-description-short": "Defines if a payment method is used as a primary or backup source of fund. Unknown payment method role Primary payment method role.",
6097
+ "x-f5xc-description-medium": "Defines if a payment method is used as a primary or backup source of fund. Unknown payment method role Primary payment method role. Always used when attempting to charge for F5 Distributed Cloud's services.",
6076
6098
  "x-f5xc-minimum-configuration": {
6077
6099
  "description": "Minimum configuration for payment_methodPaymentMethodRole",
6078
6100
  "required_fields": [],
@@ -6097,6 +6119,7 @@
6097
6119
  "x-displayname": "Name",
6098
6120
  "x-ves-example": "Payment-method-1.",
6099
6121
  "x-f5xc-example": "payment-method-1",
6122
+ "x-f5xc-description-short": "The name of the payment method object to be updated.",
6100
6123
  "minLength": 0,
6101
6124
  "maxLength": 16,
6102
6125
  "x-f5xc-required-for": {
@@ -6107,7 +6130,7 @@
6107
6130
  },
6108
6131
  "x-original-maxLength": 1024,
6109
6132
  "x-reconciled-from-discovery": true,
6110
- "x-reconciled-at": "2026-01-05T18:29:41.316024+00:00"
6133
+ "x-reconciled-at": "2026-01-07T15:53:47.329064+00:00"
6111
6134
  },
6112
6135
  "namespace": {
6113
6136
  "type": "string",
@@ -6116,6 +6139,7 @@
6116
6139
  "x-displayname": "Namespace",
6117
6140
  "x-ves-example": "System",
6118
6141
  "x-f5xc-example": "system",
6142
+ "x-f5xc-description-short": "The namespace in which the payment method object is present.",
6119
6143
  "minLength": 0,
6120
6144
  "maxLength": 6,
6121
6145
  "x-f5xc-required-for": {
@@ -6126,9 +6150,10 @@
6126
6150
  },
6127
6151
  "x-original-maxLength": 1024,
6128
6152
  "x-reconciled-from-discovery": true,
6129
- "x-reconciled-at": "2026-01-05T18:29:41.316028+00:00"
6153
+ "x-reconciled-at": "2026-01-07T15:53:47.329068+00:00"
6130
6154
  }
6131
6155
  },
6156
+ "x-f5xc-description-short": "Changes a payment method role (from/to primary or backup).",
6132
6157
  "x-f5xc-minimum-configuration": {
6133
6158
  "description": "Minimum configuration for payment_methodPaymentMethodRoleSwapReq",
6134
6159
  "required_fields": [
@@ -6156,6 +6181,7 @@
6156
6181
  "x-displayname": "Name",
6157
6182
  "x-ves-example": "Payment-method-1.",
6158
6183
  "x-f5xc-example": "payment-method-1",
6184
+ "x-f5xc-description-short": "The name of the payment method object to be made secondary.",
6159
6185
  "minLength": 0,
6160
6186
  "maxLength": 16,
6161
6187
  "x-f5xc-required-for": {
@@ -6166,7 +6192,7 @@
6166
6192
  },
6167
6193
  "x-original-maxLength": 1024,
6168
6194
  "x-reconciled-from-discovery": true,
6169
- "x-reconciled-at": "2026-01-05T18:29:41.316044+00:00"
6195
+ "x-reconciled-at": "2026-01-07T15:53:47.329072+00:00"
6170
6196
  },
6171
6197
  "namespace": {
6172
6198
  "type": "string",
@@ -6175,6 +6201,7 @@
6175
6201
  "x-displayname": "Namespace",
6176
6202
  "x-ves-example": "System",
6177
6203
  "x-f5xc-example": "system",
6204
+ "x-f5xc-description-short": "The namespace in which the payment method object is present.",
6178
6205
  "minLength": 0,
6179
6206
  "maxLength": 6,
6180
6207
  "x-f5xc-required-for": {
@@ -6185,9 +6212,10 @@
6185
6212
  },
6186
6213
  "x-original-maxLength": 1024,
6187
6214
  "x-reconciled-from-discovery": true,
6188
- "x-reconciled-at": "2026-01-05T18:29:41.316049+00:00"
6215
+ "x-reconciled-at": "2026-01-07T15:53:47.329076+00:00"
6189
6216
  }
6190
6217
  },
6218
+ "x-f5xc-description-short": "Changes a payment method role to secondary.",
6191
6219
  "x-f5xc-minimum-configuration": {
6192
6220
  "description": "Minimum configuration for payment_methodPaymentMethodSecondaryReq",
6193
6221
  "required_fields": [
@@ -6212,6 +6240,7 @@
6212
6240
  "$ref": "#/components/schemas/plan_transitionState"
6213
6241
  }
6214
6242
  },
6243
+ "x-f5xc-description-short": "Request body of GetPlanTransition custom API.",
6215
6244
  "x-f5xc-minimum-configuration": {
6216
6245
  "description": "Minimum configuration for plan_transitionGetPlanTransitionRsp",
6217
6246
  "required_fields": [
@@ -6238,6 +6267,7 @@
6238
6267
  "x-displayname": "Namespace",
6239
6268
  "x-ves-example": "System",
6240
6269
  "x-f5xc-example": "system",
6270
+ "x-f5xc-description-short": "Namespace is not used, all requests are stored under system namespace.",
6241
6271
  "minLength": 0,
6242
6272
  "maxLength": 6,
6243
6273
  "x-f5xc-required-for": {
@@ -6248,7 +6278,7 @@
6248
6278
  },
6249
6279
  "x-original-maxLength": 1024,
6250
6280
  "x-reconciled-from-discovery": true,
6251
- "x-reconciled-at": "2026-01-05T18:29:41.962151+00:00"
6281
+ "x-reconciled-at": "2026-01-07T15:53:48.227684+00:00"
6252
6282
  },
6253
6283
  "new_plan": {
6254
6284
  "type": "string",
@@ -6257,6 +6287,7 @@
6257
6287
  "x-displayname": "New Plan",
6258
6288
  "x-ves-example": "Plan-1",
6259
6289
  "x-f5xc-example": "plan-1",
6290
+ "x-f5xc-description-short": "New plan template name tenant want to move to.",
6260
6291
  "minLength": 0,
6261
6292
  "maxLength": 1024,
6262
6293
  "x-f5xc-required-for": {
@@ -6270,6 +6301,7 @@
6270
6301
  "$ref": "#/components/schemas/plan_transitionTransitionPayload"
6271
6302
  }
6272
6303
  },
6304
+ "x-f5xc-description-short": "Request body of InitiatePlanTransition custom API.",
6273
6305
  "x-f5xc-minimum-configuration": {
6274
6306
  "description": "Minimum configuration for plan_transitionInitiatePlanTransitionReq",
6275
6307
  "required_fields": [
@@ -6298,6 +6330,7 @@
6298
6330
  "x-displayname": "ID",
6299
6331
  "x-ves-example": "Dec2417d-adb1-4fcc-8dcd-529b1d31a652.",
6300
6332
  "x-f5xc-example": "dec2417d-adb1-4fcc-8dcd-529b1d31a652",
6333
+ "x-f5xc-description-short": "ID of the newly created plan transition request.",
6301
6334
  "minimum": 1,
6302
6335
  "maximum": 4094,
6303
6336
  "minLength": 0,
@@ -6315,6 +6348,8 @@
6315
6348
  "title": "Requires_manual_approval.",
6316
6349
  "format": "boolean",
6317
6350
  "x-displayname": "Requires_manual_approval.",
6351
+ "x-f5xc-example": "{\"key\": \"value\"}",
6352
+ "x-f5xc-description-short": "Flag to specify whether the request requires manual approval.",
6318
6353
  "x-f5xc-required-for": {
6319
6354
  "minimum_config": false,
6320
6355
  "create": false,
@@ -6323,6 +6358,7 @@
6323
6358
  }
6324
6359
  }
6325
6360
  },
6361
+ "x-f5xc-description-short": "Response body of InitiatePlanTransition custom API.",
6326
6362
  "x-f5xc-minimum-configuration": {
6327
6363
  "description": "Minimum configuration for plan_transitionInitiatePlanTransitionRsp",
6328
6364
  "required_fields": [
@@ -6350,6 +6386,8 @@
6350
6386
  "default": "STATE_UNSPECIFIED",
6351
6387
  "x-displayname": "State",
6352
6388
  "x-ves-proto-enum": "ves.io.schema.billing.plan_transition.State",
6389
+ "x-f5xc-description-short": "State of the plan transition FSM - STATE_UNSPECIFIED: Zero value for this state.",
6390
+ "x-f5xc-description-medium": "State of the plan transition FSM - STATE_UNSPECIFIED: Zero value for this state. Should be considered as an invalid state. User has to always explicitly specify which other state should be. - STATE_CREATING: Initial state after plan transition object creation. - STATE_FAILED: Some step(-s)...",
6353
6391
  "x-f5xc-minimum-configuration": {
6354
6392
  "description": "Minimum configuration for plan_transitionState",
6355
6393
  "required_fields": [],
@@ -6377,6 +6415,8 @@
6377
6415
  "x-displayname": "Billing provider account ID.",
6378
6416
  "x-ves-example": "F68bb6f4-b279-403b-b5e8-59dd6fcf73f0.",
6379
6417
  "x-f5xc-example": "f68bb6f4-b279-403b-b5e8-59dd6fcf73f0",
6418
+ "x-f5xc-description-short": "ID of the billing provider account created to verify the billing info provided with this object.",
6419
+ "x-f5xc-description-medium": "ID of the billing provider account created to verify the billing info provided with this object. The ID is then used to ensure no more duplicate billing account is created.",
6380
6420
  "minLength": 0,
6381
6421
  "maxLength": 1024,
6382
6422
  "x-f5xc-required-for": {
@@ -6393,6 +6433,7 @@
6393
6433
  "title": "Create_support_ticket.",
6394
6434
  "format": "boolean",
6395
6435
  "x-displayname": "Create Support Ticket.",
6436
+ "x-f5xc-description-short": "If set to true, a support ticket will be created to provide the plan transition request.",
6396
6437
  "x-f5xc-required-for": {
6397
6438
  "minimum_config": false,
6398
6439
  "create": false,
@@ -6407,6 +6448,7 @@
6407
6448
  "x-displayname": "Feedback",
6408
6449
  "x-ves-example": "Customer given feedback.",
6409
6450
  "x-f5xc-example": "customer given feedback",
6451
+ "x-f5xc-description-short": "Feedback from the customer related to reason of account deletion.",
6410
6452
  "minLength": 0,
6411
6453
  "maxLength": 1024,
6412
6454
  "x-f5xc-required-for": {
@@ -6437,7 +6479,7 @@
6437
6479
  "x-original-maxLength": 1024,
6438
6480
  "format": "hostname",
6439
6481
  "x-reconciled-from-discovery": true,
6440
- "x-reconciled-at": "2026-01-05T18:29:41.962174+00:00"
6482
+ "x-reconciled-at": "2026-01-07T15:53:48.227708+00:00"
6441
6483
  },
6442
6484
  "payment_address": {
6443
6485
  "$ref": "#/components/schemas/schemacontactGlobalSpecType"
@@ -6449,6 +6491,7 @@
6449
6491
  "x-displayname": "Payment Provider Token.",
6450
6492
  "x-ves-example": "Tok-123456.",
6451
6493
  "x-f5xc-example": "tok-123456",
6494
+ "x-f5xc-description-short": "Payment provider token (for credit card details).",
6452
6495
  "minLength": 0,
6453
6496
  "maxLength": 1024,
6454
6497
  "x-f5xc-required-for": {
@@ -6468,6 +6511,7 @@
6468
6511
  "x-displayname": "Subscribe Addon Services.",
6469
6512
  "x-ves-example": "['service1','service2']",
6470
6513
  "x-f5xc-example": "['service1','service2']",
6514
+ "x-f5xc-description-short": "List of addon services that needs to be subscribed/enabled part of this plan transition.",
6471
6515
  "x-f5xc-required-for": {
6472
6516
  "minimum_config": false,
6473
6517
  "create": false,
@@ -6482,6 +6526,7 @@
6482
6526
  "x-displayname": "Support Ticket Additional Info.",
6483
6527
  "x-ves-example": "User comment.",
6484
6528
  "x-f5xc-example": "user comment",
6529
+ "x-f5xc-description-short": "Additional information user want to record part of the support ticket.",
6485
6530
  "minLength": 0,
6486
6531
  "maxLength": 1024,
6487
6532
  "x-f5xc-required-for": {
@@ -6498,6 +6543,7 @@
6498
6543
  "x-displayname": "Third party subscription ID.",
6499
6544
  "x-ves-example": "E265802e-9dfa-4632-8c0b-cc2596e5599e.",
6500
6545
  "x-f5xc-example": "e265802e-9dfa-4632-8c0b-cc2596e5599e",
6546
+ "x-f5xc-description-short": "ID of the third party subscription ID created.",
6501
6547
  "minLength": 0,
6502
6548
  "maxLength": 1024,
6503
6549
  "x-f5xc-required-for": {
@@ -6518,6 +6564,7 @@
6518
6564
  "x-displayname": "Unsubscribe Addon Services.",
6519
6565
  "x-ves-example": "['service3','service4']",
6520
6566
  "x-f5xc-example": "['service3','service4']",
6567
+ "x-f5xc-description-short": "List of addon services that needs to be unsubscribed/removed part of this plan transition.",
6521
6568
  "x-f5xc-required-for": {
6522
6569
  "minimum_config": false,
6523
6570
  "create": false,
@@ -6526,6 +6573,7 @@
6526
6573
  }
6527
6574
  }
6528
6575
  },
6576
+ "x-f5xc-description-short": "Payload which is required to execute transition from the current tenant's plan to a given new_plan.",
6529
6577
  "x-f5xc-minimum-configuration": {
6530
6578
  "description": "Minimum configuration for plan_transitionTransitionPayload",
6531
6579
  "required_fields": [
@@ -6558,7 +6606,7 @@
6558
6606
  "properties": {
6559
6607
  "address1": {
6560
6608
  "type": "string",
6561
- "description": "",
6609
+ "description": "Network address or location",
6562
6610
  "title": "Address1",
6563
6611
  "x-displayname": "Address Line 1.",
6564
6612
  "x-ves-example": "1234 Main road.",
@@ -6574,7 +6622,7 @@
6574
6622
  },
6575
6623
  "address2": {
6576
6624
  "type": "string",
6577
- "description": "",
6625
+ "description": "Network address or location",
6578
6626
  "title": "Address2",
6579
6627
  "x-displayname": "Address Line 2.",
6580
6628
  "x-ves-example": "P.O BOX 56.",
@@ -6590,7 +6638,7 @@
6590
6638
  },
6591
6639
  "city": {
6592
6640
  "type": "string",
6593
- "description": "",
6641
+ "description": "Configuration parameter for city",
6594
6642
  "title": "City",
6595
6643
  "x-displayname": "City",
6596
6644
  "x-ves-example": "Sunnyvale",
@@ -6609,7 +6657,7 @@
6609
6657
  },
6610
6658
  "country": {
6611
6659
  "type": "string",
6612
- "description": "",
6660
+ "description": "Configuration parameter for country",
6613
6661
  "title": "Country",
6614
6662
  "x-displayname": "Country",
6615
6663
  "x-ves-example": "US",
@@ -6625,7 +6673,7 @@
6625
6673
  },
6626
6674
  "county": {
6627
6675
  "type": "string",
6628
- "description": "",
6676
+ "description": "Configuration parameter for county",
6629
6677
  "title": "County",
6630
6678
  "x-displayname": "County",
6631
6679
  "x-ves-example": "Santa Clara.",
@@ -6641,11 +6689,12 @@
6641
6689
  },
6642
6690
  "phone_number": {
6643
6691
  "type": "string",
6644
- "description": "",
6692
+ "description": "Configuration parameter for phone number",
6645
6693
  "title": "Phone_number.",
6646
6694
  "x-displayname": "Phone Number.",
6647
6695
  "x-ves-example": "+11234567890.",
6648
6696
  "x-f5xc-example": "+11234567890",
6697
+ "x-f5xc-description-short": "Configuration parameter for phone number.",
6649
6698
  "minLength": 0,
6650
6699
  "maxLength": 1024,
6651
6700
  "x-f5xc-required-for": {
@@ -6657,7 +6706,7 @@
6657
6706
  },
6658
6707
  "state": {
6659
6708
  "type": "string",
6660
- "description": "",
6709
+ "description": "Current state of the resource",
6661
6710
  "title": "State",
6662
6711
  "x-displayname": "State",
6663
6712
  "x-ves-example": "California.",
@@ -6673,7 +6722,7 @@
6673
6722
  },
6674
6723
  "state_code": {
6675
6724
  "type": "string",
6676
- "description": "",
6725
+ "description": "Configuration parameter for state code",
6677
6726
  "title": "State code.",
6678
6727
  "x-displayname": "State Code.",
6679
6728
  "x-ves-example": "CA",
@@ -6689,7 +6738,7 @@
6689
6738
  },
6690
6739
  "zip_code": {
6691
6740
  "type": "string",
6692
- "description": "",
6741
+ "description": "IP address configuration",
6693
6742
  "title": "Zip_code",
6694
6743
  "x-displayname": "ZIP code",
6695
6744
  "x-ves-example": "95054",
@@ -6704,6 +6753,8 @@
6704
6753
  }
6705
6754
  }
6706
6755
  },
6756
+ "x-f5xc-description-short": "Instance of one single contact that can be used to communicate with customers.",
6757
+ "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.",
6707
6758
  "x-f5xc-minimum-configuration": {
6708
6759
  "description": "Minimum configuration for schemacontactGlobalSpecType",
6709
6760
  "required_fields": [
@@ -6739,6 +6790,8 @@
6739
6790
  "default": "REASON_UNKNOWN",
6740
6791
  "x-displayname": "DeletionReason.",
6741
6792
  "x-ves-proto-enum": "ves.io.schema.tenant.DeletionReason",
6793
+ "x-f5xc-description-short": "List of available reason for account deletion. - REASON_UNKNOWN: Unknown reason Unknown reason - REASON_SWITCH_TO_FREE_PLAN: Switch to free plan...",
6794
+ "x-f5xc-description-medium": "List of available reason for account deletion. - REASON_UNKNOWN: Unknown reason Unknown reason - REASON_SWITCH_TO_FREE_PLAN: Switch to free plan Switch to free plan - REASON_NO_LONGER_NEEDED: No longer needed No longer needed - REASON_NOT_JUSTIFY_COSTS: Too expensive Too expensive ...",
6742
6795
  "x-f5xc-minimum-configuration": {
6743
6796
  "description": "Minimum configuration for tenantDeletionReason",
6744
6797
  "required_fields": [],
@@ -6756,6 +6809,8 @@
6756
6809
  "type_url": {
6757
6810
  "type": "string",
6758
6811
  "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.",
6812
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
6813
+ "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 ).",
6759
6814
  "minLength": 0,
6760
6815
  "maxLength": 1024,
6761
6816
  "x-f5xc-required-for": {
@@ -6779,9 +6834,11 @@
6779
6834
  },
6780
6835
  "x-original-maxLength": 1024,
6781
6836
  "x-reconciled-from-discovery": true,
6782
- "x-reconciled-at": "2026-01-05T18:29:44.667988+00:00"
6837
+ "x-reconciled-at": "2026-01-07T15:53:51.663940+00:00"
6783
6838
  }
6784
6839
  },
6840
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
6841
+ "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...",
6785
6842
  "x-f5xc-minimum-configuration": {
6786
6843
  "description": "Minimum configuration for protobufAny",
6787
6844
  "required_fields": [
@@ -6863,6 +6920,7 @@
6863
6920
  "title": "Fail_if_referred.",
6864
6921
  "format": "boolean",
6865
6922
  "x-displayname": "Fail-If-Referred.",
6923
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
6866
6924
  "x-f5xc-required-for": {
6867
6925
  "minimum_config": false,
6868
6926
  "create": false,
@@ -6887,7 +6945,7 @@
6887
6945
  },
6888
6946
  "x-original-maxLength": 1024,
6889
6947
  "x-reconciled-from-discovery": true,
6890
- "x-reconciled-at": "2026-01-05T18:29:44.668005+00:00"
6948
+ "x-reconciled-at": "2026-01-07T15:53:51.663957+00:00"
6891
6949
  },
6892
6950
  "namespace": {
6893
6951
  "type": "string",
@@ -6896,6 +6954,7 @@
6896
6954
  "x-displayname": "Namespace",
6897
6955
  "x-ves-example": "Ns1",
6898
6956
  "x-f5xc-example": "ns1",
6957
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
6899
6958
  "minLength": 0,
6900
6959
  "maxLength": 6,
6901
6960
  "x-f5xc-required-for": {
@@ -6906,7 +6965,7 @@
6906
6965
  },
6907
6966
  "x-original-maxLength": 1024,
6908
6967
  "x-reconciled-from-discovery": true,
6909
- "x-reconciled-at": "2026-01-05T18:29:44.668010+00:00"
6968
+ "x-reconciled-at": "2026-01-07T15:53:51.663963+00:00"
6910
6969
  }
6911
6970
  },
6912
6971
  "x-f5xc-minimum-configuration": {
@@ -6934,6 +6993,7 @@
6934
6993
  "title": "Maximum",
6935
6994
  "format": "double",
6936
6995
  "x-f5xc-example": "100",
6996
+ "x-f5xc-description-short": "X-displayName: \"Maximum\" The maximum value.",
6937
6997
  "x-f5xc-required-for": {
6938
6998
  "minimum_config": false,
6939
6999
  "create": false,
@@ -6942,6 +7002,8 @@
6942
7002
  }
6943
7003
  }
6944
7004
  },
7005
+ "x-f5xc-description-short": "X-displayName: \"Limit (float)\" FloatLimitType defines a float quota value that should not be exceeded.",
7006
+ "x-f5xc-description-medium": "X-displayName: \"Limit (float)\" FloatLimitType defines a float quota value that should not be exceeded. Useful for items that have quotas in fractions.",
6945
7007
  "x-f5xc-minimum-configuration": {
6946
7008
  "description": "Minimum configuration for quotaFloatLimitType",
6947
7009
  "required_fields": [
@@ -6990,6 +7052,7 @@
6990
7052
  "description": "FloatQuotaUsage object.\nDeprecated by 'resources'",
6991
7053
  "title": "FloatQuotaUsage object.",
6992
7054
  "x-displayname": "Float Quota Usage.",
7055
+ "x-f5xc-description-short": "FloatQuotaUsage object. Deprecated by 'resources'",
6993
7056
  "x-f5xc-required-for": {
6994
7057
  "minimum_config": false,
6995
7058
  "create": false,
@@ -7014,6 +7077,7 @@
7014
7077
  "description": "QuotaUsage object.\nDeprecated by 'objects'",
7015
7078
  "title": "QuotaUsage object.",
7016
7079
  "x-displayname": "Qouta Usage.",
7080
+ "x-f5xc-description-short": "QuotaUsage object. Deprecated by 'objects'",
7017
7081
  "x-f5xc-required-for": {
7018
7082
  "minimum_config": false,
7019
7083
  "create": false,
@@ -7026,6 +7090,7 @@
7026
7090
  "description": "Configured limits for resources if relevant.",
7027
7091
  "title": "Resources",
7028
7092
  "x-displayname": "Resource limits.",
7093
+ "x-f5xc-description-short": "Configured limits for resources if relevant.",
7029
7094
  "x-f5xc-required-for": {
7030
7095
  "minimum_config": false,
7031
7096
  "create": false,
@@ -7034,6 +7099,7 @@
7034
7099
  }
7035
7100
  }
7036
7101
  },
7102
+ "x-f5xc-description-short": "Map of quotas that are assigned for the current tenant and namespace.",
7037
7103
  "x-f5xc-minimum-configuration": {
7038
7104
  "description": "Minimum configuration for quotaGetQuotaLimitsResponse",
7039
7105
  "required_fields": [
@@ -7069,6 +7135,7 @@
7069
7135
  "$ref": "#/components/schemas/schemaObjectRefType"
7070
7136
  },
7071
7137
  "x-displayname": "Deleted Referred Objects.",
7138
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
7072
7139
  "x-f5xc-required-for": {
7073
7140
  "minimum_config": false,
7074
7141
  "create": false,
@@ -7084,6 +7151,7 @@
7084
7151
  "$ref": "#/components/schemas/schemaObjectRefType"
7085
7152
  },
7086
7153
  "x-displayname": "Disabled Referred Objects.",
7154
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
7087
7155
  "x-f5xc-required-for": {
7088
7156
  "minimum_config": false,
7089
7157
  "create": false,
@@ -7102,6 +7170,7 @@
7102
7170
  "$ref": "#/components/schemas/schemaObjectRefType"
7103
7171
  },
7104
7172
  "x-displayname": "Referring Objects.",
7173
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
7105
7174
  "x-f5xc-required-for": {
7106
7175
  "minimum_config": false,
7107
7176
  "create": false,
@@ -7123,6 +7192,8 @@
7123
7192
  "$ref": "#/components/schemas/quotaStatusObject"
7124
7193
  },
7125
7194
  "x-displayname": "Status",
7195
+ "x-f5xc-example": "active",
7196
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
7126
7197
  "x-f5xc-required-for": {
7127
7198
  "minimum_config": false,
7128
7199
  "create": false,
@@ -7132,7 +7203,7 @@
7132
7203
  "maxLength": 17,
7133
7204
  "minLength": 17,
7134
7205
  "x-reconciled-from-discovery": true,
7135
- "x-reconciled-at": "2026-01-05T18:29:44.668048+00:00"
7206
+ "x-reconciled-at": "2026-01-07T15:53:51.663992+00:00"
7136
7207
  },
7137
7208
  "system_metadata": {
7138
7209
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -7172,6 +7243,8 @@
7172
7243
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
7173
7244
  ],
7174
7245
  "default": "GET_RSP_FORMAT_DEFAULT",
7246
+ "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...",
7247
+ "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...",
7175
7248
  "x-f5xc-minimum-configuration": {
7176
7249
  "description": "Minimum configuration for quotaGetResponseFormatCode",
7177
7250
  "required_fields": [],
@@ -7218,6 +7291,7 @@
7218
7291
  "description": "UsageDataInFloat object.\nDeprecated by 'resources'",
7219
7292
  "title": "UsageDataInFloat object.",
7220
7293
  "x-displayname": "Usage Data in float.",
7294
+ "x-f5xc-description-short": "UsageDataInFloat object. Deprecated by 'resources'",
7221
7295
  "x-f5xc-required-for": {
7222
7296
  "minimum_config": false,
7223
7297
  "create": false,
@@ -7230,6 +7304,7 @@
7230
7304
  "description": "Configured limits for object instances and current usage.",
7231
7305
  "title": "Objects",
7232
7306
  "x-displayname": "Object limits and usage.",
7307
+ "x-f5xc-description-short": "Configured limits for object instances and current usage.",
7233
7308
  "x-f5xc-required-for": {
7234
7309
  "minimum_config": false,
7235
7310
  "create": false,
@@ -7242,6 +7317,7 @@
7242
7317
  "description": "UsageData object.\nDeprecated by 'objects'",
7243
7318
  "title": "UsageData object.",
7244
7319
  "x-displayname": "Usage Data.",
7320
+ "x-f5xc-description-short": "UsageData object. Deprecated by 'objects'",
7245
7321
  "x-f5xc-required-for": {
7246
7322
  "minimum_config": false,
7247
7323
  "create": false,
@@ -7254,6 +7330,7 @@
7254
7330
  "description": "Configured limits for resources and current usage if relevant.",
7255
7331
  "title": "Resources",
7256
7332
  "x-displayname": "Resource limits and usage.",
7333
+ "x-f5xc-description-short": "Configured limits for resources and current usage if relevant.",
7257
7334
  "x-f5xc-required-for": {
7258
7335
  "minimum_config": false,
7259
7336
  "create": false,
@@ -7263,6 +7340,8 @@
7263
7340
  }
7264
7341
  },
7265
7342
  "x-f5xc-example": "{",
7343
+ "x-f5xc-description-short": "User\": {limit: {maximum: 10}, usage: {number: 8}}, \"virtual_host\":{limit: {maximum: 12}, usage: {number: 6}}, \"domain\": {limit: {maximum: 7}...",
7344
+ "x-f5xc-description-medium": "User\": {limit: {maximum: 10}, usage: {number: 8}}, \"virtual_host\":{limit: {maximum: 12}, usage: {number: 6}}, \"domain\": {limit: {maximum: 7}, usage: {number: 5}}}\" Map of quotas that are assigned for the current tenant and namespace.",
7266
7345
  "x-f5xc-minimum-configuration": {
7267
7346
  "description": "Minimum configuration for quotaGetResponseType",
7268
7347
  "required_fields": [
@@ -7291,6 +7370,7 @@
7291
7370
  "title": "Maximum",
7292
7371
  "format": "int32",
7293
7372
  "x-f5xc-example": "100",
7373
+ "x-f5xc-description-short": "X-displayName: \"Maximum\" The maximum value for the object kind.",
7294
7374
  "minimum": 0,
7295
7375
  "maximum": 2147483647,
7296
7376
  "x-f5xc-required-for": {
@@ -7301,6 +7381,8 @@
7301
7381
  }
7302
7382
  }
7303
7383
  },
7384
+ "x-f5xc-description-short": "X-displayName: \"Limit\" LimitType defines a quota value for a specific object kind that should not be exceeded.",
7385
+ "x-f5xc-description-medium": "X-displayName: \"Limit\" LimitType defines a quota value for a specific object kind that should not be exceeded.",
7304
7386
  "x-f5xc-minimum-configuration": {
7305
7387
  "description": "Minimum configuration for quotaLimitType",
7306
7388
  "required_fields": [
@@ -7328,6 +7410,7 @@
7328
7410
  "$ref": "#/components/schemas/schemaErrorType"
7329
7411
  },
7330
7412
  "x-displayname": "Errors",
7413
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
7331
7414
  "x-f5xc-required-for": {
7332
7415
  "minimum_config": false,
7333
7416
  "create": false,
@@ -7343,6 +7426,8 @@
7343
7426
  "$ref": "#/components/schemas/quotaListResponseItem"
7344
7427
  },
7345
7428
  "x-displayname": "Items",
7429
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
7430
+ "x-f5xc-description-short": "Items represents the collection in response.",
7346
7431
  "x-f5xc-required-for": {
7347
7432
  "minimum_config": false,
7348
7433
  "create": false,
@@ -7376,6 +7461,8 @@
7376
7461
  "description": "The set of annotations present on this quota.",
7377
7462
  "title": "Annotations.",
7378
7463
  "x-displayname": "Annotations.",
7464
+ "x-f5xc-example": "{\"key\": \"value\"}",
7465
+ "x-f5xc-description-short": "The set of annotations present on this quota.",
7379
7466
  "x-f5xc-required-for": {
7380
7467
  "minimum_config": false,
7381
7468
  "create": false,
@@ -7398,7 +7485,7 @@
7398
7485
  },
7399
7486
  "x-original-maxLength": 1024,
7400
7487
  "x-reconciled-from-discovery": true,
7401
- "x-reconciled-at": "2026-01-05T18:29:44.668073+00:00"
7488
+ "x-reconciled-at": "2026-01-07T15:53:51.664020+00:00"
7402
7489
  },
7403
7490
  "disabled": {
7404
7491
  "type": "boolean",
@@ -7406,6 +7493,8 @@
7406
7493
  "title": "Disabled",
7407
7494
  "format": "boolean",
7408
7495
  "x-displayname": "Disabled",
7496
+ "x-f5xc-example": "True",
7497
+ "x-f5xc-description-short": "Value of true indicates quota is administratively disabled.",
7409
7498
  "x-f5xc-required-for": {
7410
7499
  "minimum_config": false,
7411
7500
  "create": false,
@@ -7421,6 +7510,8 @@
7421
7510
  "description": "The set of labels present on this quota.",
7422
7511
  "title": "Labels",
7423
7512
  "x-displayname": "Labels",
7513
+ "x-f5xc-example": "{\"key\": \"value\"}",
7514
+ "x-f5xc-description-short": "The set of labels present on this quota.",
7424
7515
  "x-f5xc-required-for": {
7425
7516
  "minimum_config": false,
7426
7517
  "create": false,
@@ -7448,7 +7539,7 @@
7448
7539
  },
7449
7540
  "x-original-maxLength": 1024,
7450
7541
  "x-reconciled-from-discovery": true,
7451
- "x-reconciled-at": "2026-01-05T18:29:44.668083+00:00"
7542
+ "x-reconciled-at": "2026-01-07T15:53:51.664030+00:00"
7452
7543
  },
7453
7544
  "namespace": {
7454
7545
  "type": "string",
@@ -7467,7 +7558,7 @@
7467
7558
  },
7468
7559
  "x-original-maxLength": 1024,
7469
7560
  "x-reconciled-from-discovery": true,
7470
- "x-reconciled-at": "2026-01-05T18:29:44.668087+00:00"
7561
+ "x-reconciled-at": "2026-01-07T15:53:51.664035+00:00"
7471
7562
  },
7472
7563
  "owner_view": {
7473
7564
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -7480,6 +7571,7 @@
7480
7571
  "$ref": "#/components/schemas/quotaStatusObject"
7481
7572
  },
7482
7573
  "x-displayname": "Status",
7574
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
7483
7575
  "x-f5xc-required-for": {
7484
7576
  "minimum_config": false,
7485
7577
  "create": false,
@@ -7508,7 +7600,7 @@
7508
7600
  "x-field-mutability": "read-only",
7509
7601
  "x-original-maxLength": 1024,
7510
7602
  "x-reconciled-from-discovery": true,
7511
- "x-reconciled-at": "2026-01-05T18:29:44.668095+00:00"
7603
+ "x-reconciled-at": "2026-01-07T15:53:51.664042+00:00"
7512
7604
  },
7513
7605
  "uid": {
7514
7606
  "type": "string",
@@ -7529,9 +7621,11 @@
7529
7621
  "x-original-maxLength": 1024,
7530
7622
  "format": "uuid",
7531
7623
  "x-reconciled-from-discovery": true,
7532
- "x-reconciled-at": "2026-01-05T18:29:44.668101+00:00"
7624
+ "x-reconciled-at": "2026-01-07T15:53:51.664048+00:00"
7533
7625
  }
7534
7626
  },
7627
+ "x-f5xc-description-short": "By default a summary of quota is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
7628
+ "x-f5xc-description-medium": "By default a summary of quota is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
7535
7629
  "x-f5xc-minimum-configuration": {
7536
7630
  "description": "Minimum configuration for quotaListResponseItem",
7537
7631
  "required_fields": [
@@ -7565,6 +7659,7 @@
7565
7659
  "type": "string",
7566
7660
  "description": "X-displayName: \"Description\"\nDescription about the field.",
7567
7661
  "title": "Description.",
7662
+ "x-f5xc-description-short": "X-displayName: \"Description\" Description about the field.",
7568
7663
  "minLength": 0,
7569
7664
  "maxLength": 0,
7570
7665
  "x-f5xc-required-for": {
@@ -7575,13 +7670,14 @@
7575
7670
  },
7576
7671
  "x-original-maxLength": 1024,
7577
7672
  "x-reconciled-from-discovery": true,
7578
- "x-reconciled-at": "2026-01-05T18:29:44.668106+00:00"
7673
+ "x-reconciled-at": "2026-01-07T15:53:51.664054+00:00"
7579
7674
  },
7580
7675
  "display_name": {
7581
7676
  "type": "string",
7582
7677
  "description": "X-displayName: \"Display Name\"\nThis field represents the display name.",
7583
7678
  "title": "Display_name.",
7584
7679
  "x-f5xc-example": "example-resource",
7680
+ "x-f5xc-description-short": "X-displayName: \"Display Name\" This field represents the display name.",
7585
7681
  "minLength": 0,
7586
7682
  "maxLength": 1024,
7587
7683
  "x-f5xc-required-for": {
@@ -7595,6 +7691,7 @@
7595
7691
  "$ref": "#/components/schemas/quotaLimitType"
7596
7692
  }
7597
7693
  },
7694
+ "x-f5xc-description-short": "X-displayName: \"Quota Limits\" QuotaLimits stores limit in integer.",
7598
7695
  "x-f5xc-minimum-configuration": {
7599
7696
  "description": "Minimum configuration for quotaQuotaLimits",
7600
7697
  "required_fields": [
@@ -7621,6 +7718,7 @@
7621
7718
  "type": "string",
7622
7719
  "description": "X-displayName: \"Description\"\nThe description of quota item.",
7623
7720
  "title": "Description.",
7721
+ "x-f5xc-description-short": "X-displayName: \"Description\" The description of quota item.",
7624
7722
  "minLength": 0,
7625
7723
  "maxLength": 0,
7626
7724
  "x-f5xc-required-for": {
@@ -7631,13 +7729,14 @@
7631
7729
  },
7632
7730
  "x-original-maxLength": 1024,
7633
7731
  "x-reconciled-from-discovery": true,
7634
- "x-reconciled-at": "2026-01-05T18:29:44.668114+00:00"
7732
+ "x-reconciled-at": "2026-01-07T15:53:51.664063+00:00"
7635
7733
  },
7636
7734
  "display_name": {
7637
7735
  "type": "string",
7638
7736
  "description": "X-displayName: \"Name\"\nThe name of quota item.",
7639
7737
  "title": "Display_name.",
7640
7738
  "x-f5xc-example": "example-resource",
7739
+ "x-f5xc-description-short": "X-displayName: \"Name\" The name of quota item.",
7641
7740
  "minLength": 0,
7642
7741
  "maxLength": 1024,
7643
7742
  "x-f5xc-required-for": {
@@ -7651,6 +7750,7 @@
7651
7750
  "$ref": "#/components/schemas/quotaFloatLimitType"
7652
7751
  }
7653
7752
  },
7753
+ "x-f5xc-description-short": "X-displayName: \"Quota Limits Item Type\" Holds the configured limits information.",
7654
7754
  "x-f5xc-minimum-configuration": {
7655
7755
  "description": "Minimum configuration for quotaQuotaLimitsItemType",
7656
7756
  "required_fields": [
@@ -7673,6 +7773,7 @@
7673
7773
  "properties": {
7674
7774
  "description": {
7675
7775
  "type": "string",
7776
+ "description": "Human-readable description text",
7676
7777
  "minLength": 0,
7677
7778
  "maxLength": 0,
7678
7779
  "x-f5xc-required-for": {
@@ -7683,11 +7784,11 @@
7683
7784
  },
7684
7785
  "x-original-maxLength": 1024,
7685
7786
  "x-reconciled-from-discovery": true,
7686
- "x-reconciled-at": "2026-01-05T18:29:44.668122+00:00"
7787
+ "x-reconciled-at": "2026-01-07T15:53:51.664071+00:00"
7687
7788
  },
7688
7789
  "display_name": {
7689
7790
  "type": "string",
7690
- "description": "Display name for user interfaces",
7791
+ "description": "Human-readable name for the resource",
7691
7792
  "x-f5xc-example": "example-resource",
7692
7793
  "minLength": 0,
7693
7794
  "maxLength": 1024,
@@ -7705,6 +7806,7 @@
7705
7806
  "$ref": "#/components/schemas/usageUsageType"
7706
7807
  }
7707
7808
  },
7809
+ "x-f5xc-description-short": "X-displayName: \"Quota usage\" QuotaUsage stores limit and usage in integer.",
7708
7810
  "x-f5xc-minimum-configuration": {
7709
7811
  "description": "Minimum configuration for quotaQuotaUsage",
7710
7812
  "required_fields": [
@@ -7732,6 +7834,7 @@
7732
7834
  "type": "string",
7733
7835
  "description": "X-displayName: \"Description\"\nThe description of quota item.",
7734
7836
  "title": "Description.",
7837
+ "x-f5xc-description-short": "X-displayName: \"Description\" The description of quota item.",
7735
7838
  "minLength": 0,
7736
7839
  "maxLength": 0,
7737
7840
  "x-f5xc-required-for": {
@@ -7742,13 +7845,14 @@
7742
7845
  },
7743
7846
  "x-original-maxLength": 1024,
7744
7847
  "x-reconciled-from-discovery": true,
7745
- "x-reconciled-at": "2026-01-05T18:29:44.668131+00:00"
7848
+ "x-reconciled-at": "2026-01-07T15:53:51.664081+00:00"
7746
7849
  },
7747
7850
  "display_name": {
7748
7851
  "type": "string",
7749
7852
  "description": "X-displayName: \"Name\"\nThe name of quota item.",
7750
7853
  "title": "Display_name.",
7751
7854
  "x-f5xc-example": "example-resource",
7855
+ "x-f5xc-description-short": "X-displayName: \"Name\" The name of quota item.",
7752
7856
  "minLength": 0,
7753
7857
  "maxLength": 1024,
7754
7858
  "x-f5xc-required-for": {
@@ -7765,6 +7869,7 @@
7765
7869
  "$ref": "#/components/schemas/usageFloatUsageType"
7766
7870
  }
7767
7871
  },
7872
+ "x-f5xc-description-short": "X-displayName: \"Quota and Usage\" Holds the configured limits and any usage information.",
7768
7873
  "x-f5xc-minimum-configuration": {
7769
7874
  "description": "Minimum configuration for quotaQuotaUsageItemType",
7770
7875
  "required_fields": [
@@ -7792,6 +7897,7 @@
7792
7897
  "title": "Burst",
7793
7898
  "format": "int32",
7794
7899
  "x-f5xc-example": "100",
7900
+ "x-f5xc-description-short": "X-displayName: \"Burst\" The burst which is to be allowed per quanta.",
7795
7901
  "minimum": 0,
7796
7902
  "maximum": 2147483647,
7797
7903
  "x-f5xc-required-for": {
@@ -7807,6 +7913,7 @@
7807
7913
  "title": "Rate",
7808
7914
  "format": "int32",
7809
7915
  "x-f5xc-example": "100",
7916
+ "x-f5xc-description-short": "X-displayName: \"Rate\" The sustained rate which is to be allowed per quanta.",
7810
7917
  "minimum": 0,
7811
7918
  "maximum": 2147483647,
7812
7919
  "x-f5xc-required-for": {
@@ -7821,6 +7928,7 @@
7821
7928
  "description": "X-displayName: \"Unit\"\nThe unit for the quanta.",
7822
7929
  "title": "Unit",
7823
7930
  "x-f5xc-example": "per-second",
7931
+ "x-f5xc-description-short": "X-displayName: \"Unit\" The unit for the quanta.",
7824
7932
  "minLength": 0,
7825
7933
  "maxLength": 1024,
7826
7934
  "x-f5xc-required-for": {
@@ -7831,6 +7939,8 @@
7831
7939
  }
7832
7940
  }
7833
7941
  },
7942
+ "x-f5xc-description-short": "X-displayName: \"Rate Limit\" RateLimitType defines a rate quota value for a specific object kind that should not be exceeded in terms access per...",
7943
+ "x-f5xc-description-medium": "X-displayName: \"Rate Limit\" RateLimitType defines a rate quota value for a specific object kind that should not be exceeded in terms access per time unit.",
7834
7944
  "x-f5xc-minimum-configuration": {
7835
7945
  "description": "Minimum configuration for quotaRateLimitType",
7836
7946
  "required_fields": [
@@ -7899,6 +8009,7 @@
7899
8009
  "$ref": "#/components/schemas/schemaConditionType"
7900
8010
  },
7901
8011
  "x-displayname": "Conditions.",
8012
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
7902
8013
  "x-f5xc-required-for": {
7903
8014
  "minimum_config": false,
7904
8015
  "create": false,
@@ -7951,6 +8062,8 @@
7951
8062
  "description": "Hostname of the instance of the site that sent the status.",
7952
8063
  "title": "Hostname",
7953
8064
  "x-displayname": "Hostname",
8065
+ "x-f5xc-example": "example-resource",
8066
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
7954
8067
  "minLength": 0,
7955
8068
  "maxLength": 1024,
7956
8069
  "x-f5xc-required-for": {
@@ -7982,6 +8095,8 @@
7982
8095
  "x-displayname": "Reason",
7983
8096
  "x-ves-example": "Value",
7984
8097
  "x-f5xc-example": "value",
8098
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
8099
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
7985
8100
  "minLength": 0,
7986
8101
  "maxLength": 43,
7987
8102
  "x-f5xc-required-for": {
@@ -7992,13 +8107,15 @@
7992
8107
  },
7993
8108
  "x-original-maxLength": 1024,
7994
8109
  "x-reconciled-from-discovery": true,
7995
- "x-reconciled-at": "2026-01-05T18:29:44.668154+00:00"
8110
+ "x-reconciled-at": "2026-01-07T15:53:51.664104+00:00"
7996
8111
  },
7997
8112
  "service_name": {
7998
8113
  "type": "string",
7999
8114
  "description": "Name of the service that sent the status.",
8000
8115
  "title": "Service name.",
8001
8116
  "x-displayname": "Service Name.",
8117
+ "x-f5xc-example": "example-resource",
8118
+ "x-f5xc-description-short": "Name of the service that sent the status.",
8002
8119
  "minLength": 0,
8003
8120
  "maxLength": 1024,
8004
8121
  "x-f5xc-required-for": {
@@ -8021,6 +8138,8 @@
8021
8138
  "x-validation-rules": {
8022
8139
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
8023
8140
  },
8141
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
8142
+ "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...",
8024
8143
  "minLength": 0,
8025
8144
  "maxLength": 17,
8026
8145
  "x-f5xc-required-for": {
@@ -8031,7 +8150,7 @@
8031
8150
  },
8032
8151
  "x-original-maxLength": 1024,
8033
8152
  "x-reconciled-from-discovery": true,
8034
- "x-reconciled-at": "2026-01-05T18:29:44.668160+00:00"
8153
+ "x-reconciled-at": "2026-01-07T15:53:51.664110+00:00"
8035
8154
  },
8036
8155
  "type": {
8037
8156
  "type": "string",
@@ -8046,6 +8165,8 @@
8046
8165
  "x-validation-rules": {
8047
8166
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
8048
8167
  },
8168
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
8169
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
8049
8170
  "minLength": 0,
8050
8171
  "maxLength": 1024,
8051
8172
  "x-f5xc-required-for": {
@@ -8056,6 +8177,8 @@
8056
8177
  }
8057
8178
  }
8058
8179
  },
8180
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
8181
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
8059
8182
  "x-f5xc-minimum-configuration": {
8060
8183
  "description": "Minimum configuration for schemaConditionType",
8061
8184
  "required_fields": [
@@ -8091,6 +8214,8 @@
8091
8214
  "default": "EOK",
8092
8215
  "x-displayname": "Error Code.",
8093
8216
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
8217
+ "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...",
8218
+ "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...",
8094
8219
  "x-f5xc-minimum-configuration": {
8095
8220
  "description": "Minimum configuration for schemaErrorCode",
8096
8221
  "required_fields": [],
@@ -8131,6 +8256,7 @@
8131
8256
  }
8132
8257
  }
8133
8258
  },
8259
+ "x-f5xc-description-short": "Information about a error in API operation.",
8134
8260
  "x-f5xc-minimum-configuration": {
8135
8261
  "description": "Minimum configuration for schemaErrorType",
8136
8262
  "required_fields": [
@@ -8158,6 +8284,7 @@
8158
8284
  "title": "Name",
8159
8285
  "x-displayname": "Name",
8160
8286
  "x-f5xc-example": "example-resource",
8287
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
8161
8288
  "minLength": 0,
8162
8289
  "maxLength": 16,
8163
8290
  "x-f5xc-required-for": {
@@ -8168,9 +8295,10 @@
8168
8295
  },
8169
8296
  "x-original-maxLength": 1024,
8170
8297
  "x-reconciled-from-discovery": true,
8171
- "x-reconciled-at": "2026-01-05T18:29:44.668171+00:00"
8298
+ "x-reconciled-at": "2026-01-07T15:53:51.664123+00:00"
8172
8299
  }
8173
8300
  },
8301
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
8174
8302
  "x-f5xc-minimum-configuration": {
8175
8303
  "description": "Minimum configuration for schemaInitializerType",
8176
8304
  "required_fields": [
@@ -8198,6 +8326,8 @@
8198
8326
  "$ref": "#/components/schemas/schemaInitializerType"
8199
8327
  },
8200
8328
  "x-displayname": "Pending",
8329
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
8330
+ "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.",
8201
8331
  "x-f5xc-required-for": {
8202
8332
  "minimum_config": false,
8203
8333
  "create": false,
@@ -8209,6 +8339,7 @@
8209
8339
  "$ref": "#/components/schemas/schemaStatusType"
8210
8340
  }
8211
8341
  },
8342
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
8212
8343
  "x-f5xc-minimum-configuration": {
8213
8344
  "description": "Minimum configuration for schemaInitializersType",
8214
8345
  "required_fields": [
@@ -8247,6 +8378,8 @@
8247
8378
  "ves.io.schema.rules.map.values.string.max_len": "1024",
8248
8379
  "ves.io.schema.rules.map.values.string.min_len": "1"
8249
8380
  },
8381
+ "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.",
8382
+ "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.",
8250
8383
  "x-f5xc-required-for": {
8251
8384
  "minimum_config": false,
8252
8385
  "create": false,
@@ -8268,6 +8401,7 @@
8268
8401
  "x-validation-rules": {
8269
8402
  "ves.io.schema.rules.string.max_bytes": "1200"
8270
8403
  },
8404
+ "x-f5xc-description-short": "Human readable description for the object.",
8271
8405
  "minLength": 0,
8272
8406
  "x-f5xc-required-for": {
8273
8407
  "minimum_config": false,
@@ -8277,7 +8411,7 @@
8277
8411
  },
8278
8412
  "x-original-maxLength": 1200,
8279
8413
  "x-reconciled-from-discovery": true,
8280
- "x-reconciled-at": "2026-01-05T18:29:44.668180+00:00"
8414
+ "x-reconciled-at": "2026-01-07T15:53:51.664133+00:00"
8281
8415
  },
8282
8416
  "disable": {
8283
8417
  "type": "boolean",
@@ -8286,6 +8420,7 @@
8286
8420
  "format": "boolean",
8287
8421
  "x-displayname": "Disable",
8288
8422
  "x-f5xc-example": "true",
8423
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
8289
8424
  "x-f5xc-required-for": {
8290
8425
  "minimum_config": false,
8291
8426
  "create": false,
@@ -8299,6 +8434,8 @@
8299
8434
  "title": "Labels",
8300
8435
  "x-displayname": "Labels",
8301
8436
  "x-f5xc-example": "value",
8437
+ "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.",
8438
+ "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.",
8302
8439
  "x-f5xc-required-for": {
8303
8440
  "minimum_config": false,
8304
8441
  "create": false,
@@ -8320,6 +8457,8 @@
8320
8457
  "x-validation-rules": {
8321
8458
  "ves.io.schema.rules.message.required": "true"
8322
8459
  },
8460
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
8461
+ "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.",
8323
8462
  "minLength": 0,
8324
8463
  "maxLength": 16,
8325
8464
  "x-f5xc-required-for": {
@@ -8330,7 +8469,7 @@
8330
8469
  },
8331
8470
  "x-original-maxLength": 1024,
8332
8471
  "x-reconciled-from-discovery": true,
8333
- "x-reconciled-at": "2026-01-05T18:29:44.668188+00:00"
8472
+ "x-reconciled-at": "2026-01-07T15:53:51.664141+00:00"
8334
8473
  },
8335
8474
  "namespace": {
8336
8475
  "type": "string",
@@ -8339,6 +8478,8 @@
8339
8478
  "x-displayname": "Namespace",
8340
8479
  "x-ves-example": "Staging",
8341
8480
  "x-f5xc-example": "staging",
8481
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
8482
+ "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 \"\".",
8342
8483
  "minLength": 0,
8343
8484
  "maxLength": 6,
8344
8485
  "x-f5xc-required-for": {
@@ -8349,9 +8490,10 @@
8349
8490
  },
8350
8491
  "x-original-maxLength": 1024,
8351
8492
  "x-reconciled-from-discovery": true,
8352
- "x-reconciled-at": "2026-01-05T18:29:44.668192+00:00"
8493
+ "x-reconciled-at": "2026-01-07T15:53:51.664145+00:00"
8353
8494
  }
8354
8495
  },
8496
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
8355
8497
  "x-f5xc-minimum-configuration": {
8356
8498
  "description": "Minimum configuration for schemaObjectCreateMetaType",
8357
8499
  "required_fields": [
@@ -8395,6 +8537,8 @@
8395
8537
  "ves.io.schema.rules.map.values.string.max_len": "1024",
8396
8538
  "ves.io.schema.rules.map.values.string.min_len": "1"
8397
8539
  },
8540
+ "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.",
8541
+ "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.",
8398
8542
  "x-f5xc-required-for": {
8399
8543
  "minimum_config": false,
8400
8544
  "create": false,
@@ -8416,6 +8560,7 @@
8416
8560
  "x-validation-rules": {
8417
8561
  "ves.io.schema.rules.string.max_bytes": "1200"
8418
8562
  },
8563
+ "x-f5xc-description-short": "Human readable description for the object.",
8419
8564
  "minLength": 0,
8420
8565
  "x-f5xc-required-for": {
8421
8566
  "minimum_config": false,
@@ -8425,7 +8570,7 @@
8425
8570
  },
8426
8571
  "x-original-maxLength": 1200,
8427
8572
  "x-reconciled-from-discovery": true,
8428
- "x-reconciled-at": "2026-01-05T18:29:44.668198+00:00"
8573
+ "x-reconciled-at": "2026-01-07T15:53:51.664152+00:00"
8429
8574
  },
8430
8575
  "disable": {
8431
8576
  "type": "boolean",
@@ -8435,6 +8580,7 @@
8435
8580
  "x-displayname": "Disable",
8436
8581
  "x-ves-example": "True",
8437
8582
  "x-f5xc-example": "true",
8583
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
8438
8584
  "x-f5xc-required-for": {
8439
8585
  "minimum_config": false,
8440
8586
  "create": false,
@@ -8449,6 +8595,8 @@
8449
8595
  "x-displayname": "Labels",
8450
8596
  "x-ves-example": "Value",
8451
8597
  "x-f5xc-example": "value",
8598
+ "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.",
8599
+ "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.",
8452
8600
  "x-f5xc-required-for": {
8453
8601
  "minimum_config": false,
8454
8602
  "create": false,
@@ -8470,6 +8618,8 @@
8470
8618
  "x-validation-rules": {
8471
8619
  "ves.io.schema.rules.message.required": "true"
8472
8620
  },
8621
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
8622
+ "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.",
8473
8623
  "minLength": 0,
8474
8624
  "maxLength": 16,
8475
8625
  "x-f5xc-required-for": {
@@ -8480,7 +8630,7 @@
8480
8630
  },
8481
8631
  "x-original-maxLength": 1024,
8482
8632
  "x-reconciled-from-discovery": true,
8483
- "x-reconciled-at": "2026-01-05T18:29:44.668205+00:00"
8633
+ "x-reconciled-at": "2026-01-07T15:53:51.664159+00:00"
8484
8634
  },
8485
8635
  "namespace": {
8486
8636
  "type": "string",
@@ -8489,6 +8639,8 @@
8489
8639
  "x-displayname": "Namespace",
8490
8640
  "x-ves-example": "Staging",
8491
8641
  "x-f5xc-example": "staging",
8642
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
8643
+ "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 \"\".",
8492
8644
  "minLength": 0,
8493
8645
  "maxLength": 6,
8494
8646
  "x-f5xc-required-for": {
@@ -8499,9 +8651,10 @@
8499
8651
  },
8500
8652
  "x-original-maxLength": 1024,
8501
8653
  "x-reconciled-from-discovery": true,
8502
- "x-reconciled-at": "2026-01-05T18:29:44.668209+00:00"
8654
+ "x-reconciled-at": "2026-01-07T15:53:51.664164+00:00"
8503
8655
  }
8504
8656
  },
8657
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
8505
8658
  "x-f5xc-minimum-configuration": {
8506
8659
  "description": "Minimum configuration for schemaObjectGetMetaType",
8507
8660
  "required_fields": [
@@ -8533,6 +8686,8 @@
8533
8686
  "x-displayname": "Kind",
8534
8687
  "x-ves-example": "Virtual_site.",
8535
8688
  "x-f5xc-example": "virtual_site",
8689
+ "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\")",
8690
+ "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\").",
8536
8691
  "minLength": 0,
8537
8692
  "maxLength": 14,
8538
8693
  "x-f5xc-required-for": {
@@ -8544,7 +8699,7 @@
8544
8699
  "readOnly": true,
8545
8700
  "x-original-maxLength": 1024,
8546
8701
  "x-reconciled-from-discovery": true,
8547
- "x-reconciled-at": "2026-01-05T18:29:44.668214+00:00"
8702
+ "x-reconciled-at": "2026-01-07T15:53:51.664168+00:00"
8548
8703
  },
8549
8704
  "name": {
8550
8705
  "type": "string",
@@ -8553,6 +8708,8 @@
8553
8708
  "x-displayname": "Name",
8554
8709
  "x-ves-example": "Contactus-route.",
8555
8710
  "x-f5xc-example": "contactus-route",
8711
+ "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.",
8712
+ "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.",
8556
8713
  "minLength": 0,
8557
8714
  "maxLength": 16,
8558
8715
  "x-f5xc-required-for": {
@@ -8563,7 +8720,7 @@
8563
8720
  },
8564
8721
  "x-original-maxLength": 1024,
8565
8722
  "x-reconciled-from-discovery": true,
8566
- "x-reconciled-at": "2026-01-05T18:29:44.668218+00:00"
8723
+ "x-reconciled-at": "2026-01-07T15:53:51.664172+00:00"
8567
8724
  },
8568
8725
  "namespace": {
8569
8726
  "type": "string",
@@ -8572,6 +8729,8 @@
8572
8729
  "x-displayname": "Namespace",
8573
8730
  "x-ves-example": "Ns1",
8574
8731
  "x-f5xc-example": "ns1",
8732
+ "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.",
8733
+ "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.",
8575
8734
  "minLength": 0,
8576
8735
  "maxLength": 6,
8577
8736
  "x-f5xc-required-for": {
@@ -8582,7 +8741,7 @@
8582
8741
  },
8583
8742
  "x-original-maxLength": 1024,
8584
8743
  "x-reconciled-from-discovery": true,
8585
- "x-reconciled-at": "2026-01-05T18:29:44.668222+00:00"
8744
+ "x-reconciled-at": "2026-01-07T15:53:51.664176+00:00"
8586
8745
  },
8587
8746
  "tenant": {
8588
8747
  "type": "string",
@@ -8591,6 +8750,8 @@
8591
8750
  "x-displayname": "Tenant",
8592
8751
  "x-ves-example": "Example-corp.",
8593
8752
  "x-f5xc-example": "example-corp",
8753
+ "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.",
8754
+ "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.",
8594
8755
  "minLength": 0,
8595
8756
  "maxLength": 18,
8596
8757
  "x-f5xc-required-for": {
@@ -8603,7 +8764,7 @@
8603
8764
  "x-field-mutability": "read-only",
8604
8765
  "x-original-maxLength": 1024,
8605
8766
  "x-reconciled-from-discovery": true,
8606
- "x-reconciled-at": "2026-01-05T18:29:44.668226+00:00"
8767
+ "x-reconciled-at": "2026-01-07T15:53:51.664180+00:00"
8607
8768
  },
8608
8769
  "uid": {
8609
8770
  "type": "string",
@@ -8612,6 +8773,8 @@
8612
8773
  "x-displayname": "UID",
8613
8774
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
8614
8775
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
8776
+ "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.",
8777
+ "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.",
8615
8778
  "minLength": 0,
8616
8779
  "maxLength": 36,
8617
8780
  "x-f5xc-required-for": {
@@ -8625,9 +8788,11 @@
8625
8788
  "x-original-maxLength": 1024,
8626
8789
  "format": "uuid",
8627
8790
  "x-reconciled-from-discovery": true,
8628
- "x-reconciled-at": "2026-01-05T18:29:44.668231+00:00"
8791
+ "x-reconciled-at": "2026-01-07T15:53:51.664186+00:00"
8629
8792
  }
8630
8793
  },
8794
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
8795
+ "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...",
8631
8796
  "x-f5xc-minimum-configuration": {
8632
8797
  "description": "Minimum configuration for schemaObjectRefType",
8633
8798
  "required_fields": [
@@ -8670,6 +8835,8 @@
8670
8835
  "ves.io.schema.rules.map.values.string.max_len": "1024",
8671
8836
  "ves.io.schema.rules.map.values.string.min_len": "1"
8672
8837
  },
8838
+ "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.",
8839
+ "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.",
8673
8840
  "x-f5xc-required-for": {
8674
8841
  "minimum_config": false,
8675
8842
  "create": false,
@@ -8691,6 +8858,7 @@
8691
8858
  "x-validation-rules": {
8692
8859
  "ves.io.schema.rules.string.max_bytes": "1200"
8693
8860
  },
8861
+ "x-f5xc-description-short": "Human readable description for the object.",
8694
8862
  "minLength": 0,
8695
8863
  "x-f5xc-required-for": {
8696
8864
  "minimum_config": false,
@@ -8700,7 +8868,7 @@
8700
8868
  },
8701
8869
  "x-original-maxLength": 1200,
8702
8870
  "x-reconciled-from-discovery": true,
8703
- "x-reconciled-at": "2026-01-05T18:29:44.668238+00:00"
8871
+ "x-reconciled-at": "2026-01-07T15:53:51.664193+00:00"
8704
8872
  },
8705
8873
  "disable": {
8706
8874
  "type": "boolean",
@@ -8709,6 +8877,7 @@
8709
8877
  "format": "boolean",
8710
8878
  "x-displayname": "Disable",
8711
8879
  "x-f5xc-example": "true",
8880
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
8712
8881
  "x-f5xc-required-for": {
8713
8882
  "minimum_config": false,
8714
8883
  "create": false,
@@ -8723,6 +8892,8 @@
8723
8892
  "x-displayname": "Labels",
8724
8893
  "x-ves-example": "Value",
8725
8894
  "x-f5xc-example": "value",
8895
+ "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.",
8896
+ "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.",
8726
8897
  "x-f5xc-required-for": {
8727
8898
  "minimum_config": false,
8728
8899
  "create": false,
@@ -8743,6 +8914,8 @@
8743
8914
  "x-validation-rules": {
8744
8915
  "ves.io.schema.rules.message.required": "true"
8745
8916
  },
8917
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
8918
+ "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.",
8746
8919
  "minLength": 0,
8747
8920
  "maxLength": 16,
8748
8921
  "x-f5xc-required-for": {
@@ -8753,7 +8926,7 @@
8753
8926
  },
8754
8927
  "x-original-maxLength": 1024,
8755
8928
  "x-reconciled-from-discovery": true,
8756
- "x-reconciled-at": "2026-01-05T18:29:44.668245+00:00"
8929
+ "x-reconciled-at": "2026-01-07T15:53:51.664201+00:00"
8757
8930
  },
8758
8931
  "namespace": {
8759
8932
  "type": "string",
@@ -8762,6 +8935,8 @@
8762
8935
  "x-displayname": "Namespace",
8763
8936
  "x-ves-example": "Staging",
8764
8937
  "x-f5xc-example": "staging",
8938
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
8939
+ "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 \"\".",
8765
8940
  "minLength": 0,
8766
8941
  "maxLength": 6,
8767
8942
  "x-f5xc-required-for": {
@@ -8772,9 +8947,10 @@
8772
8947
  },
8773
8948
  "x-original-maxLength": 1024,
8774
8949
  "x-reconciled-from-discovery": true,
8775
- "x-reconciled-at": "2026-01-05T18:29:44.668249+00:00"
8950
+ "x-reconciled-at": "2026-01-07T15:53:51.664205+00:00"
8776
8951
  }
8777
8952
  },
8953
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
8778
8954
  "x-f5xc-minimum-configuration": {
8779
8955
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
8780
8956
  "required_fields": [
@@ -8805,6 +8981,8 @@
8805
8981
  "title": "Creation_timestamp.",
8806
8982
  "format": "date-time",
8807
8983
  "x-displayname": "Creation Timestamp.",
8984
+ "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.",
8985
+ "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.",
8808
8986
  "minLength": 0,
8809
8987
  "maxLength": 1024,
8810
8988
  "x-f5xc-required-for": {
@@ -8822,6 +9000,8 @@
8822
9000
  "x-displayname": "Creator Class.",
8823
9001
  "x-ves-example": "ver.re1.int.ves.I/O.",
8824
9002
  "x-f5xc-example": "ver.re1.int.F5 XC",
9003
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
9004
+ "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.",
8825
9005
  "minLength": 0,
8826
9006
  "maxLength": 1024,
8827
9007
  "x-f5xc-required-for": {
@@ -8839,6 +9019,8 @@
8839
9019
  "x-displayname": "Creator ID.",
8840
9020
  "x-ves-example": "Ver-instance-1.",
8841
9021
  "x-f5xc-example": "ver-instance-1",
9022
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
9023
+ "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.",
8842
9024
  "minLength": 0,
8843
9025
  "maxLength": 1024,
8844
9026
  "x-f5xc-required-for": {
@@ -8857,6 +9039,8 @@
8857
9039
  "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)",
8858
9040
  "title": "Status_id",
8859
9041
  "x-displayname": "Status ID",
9042
+ "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...",
9043
+ "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).",
8860
9044
  "minLength": 0,
8861
9045
  "maxLength": 1024,
8862
9046
  "x-f5xc-required-for": {
@@ -8874,6 +9058,7 @@
8874
9058
  "x-displayname": "UID",
8875
9059
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
8876
9060
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
9061
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
8877
9062
  "minLength": 0,
8878
9063
  "maxLength": 36,
8879
9064
  "x-f5xc-required-for": {
@@ -8886,13 +9071,14 @@
8886
9071
  "x-original-maxLength": 1024,
8887
9072
  "format": "uuid",
8888
9073
  "x-reconciled-from-discovery": true,
8889
- "x-reconciled-at": "2026-01-05T18:29:44.668261+00:00"
9074
+ "x-reconciled-at": "2026-01-07T15:53:51.664218+00:00"
8890
9075
  },
8891
9076
  "vtrp_id": {
8892
9077
  "type": "string",
8893
9078
  "description": "Origin of this status exchanged by VTRP.",
8894
9079
  "title": "Vtrp_id",
8895
9080
  "x-displayname": "VTRP ID",
9081
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
8896
9082
  "minLength": 0,
8897
9083
  "maxLength": 1024,
8898
9084
  "x-f5xc-required-for": {
@@ -8909,6 +9095,7 @@
8909
9095
  "title": "Vtrp_stale.",
8910
9096
  "format": "boolean",
8911
9097
  "x-displayname": "VTRP Stale.",
9098
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
8912
9099
  "x-f5xc-required-for": {
8913
9100
  "minimum_config": false,
8914
9101
  "create": false,
@@ -8917,6 +9104,7 @@
8917
9104
  }
8918
9105
  }
8919
9106
  },
9107
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
8920
9108
  "x-f5xc-minimum-configuration": {
8921
9109
  "description": "Minimum configuration for schemaStatusMetaType",
8922
9110
  "required_fields": [
@@ -8947,6 +9135,8 @@
8947
9135
  "default": "STATUS_DO_NOT_PUBLISH",
8948
9136
  "x-displayname": "Status Publish Type.",
8949
9137
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
9138
+ "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.",
9139
+ "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.",
8950
9140
  "x-f5xc-minimum-configuration": {
8951
9141
  "description": "Minimum configuration for schemaStatusPublishType",
8952
9142
  "required_fields": [],
@@ -8972,6 +9162,7 @@
8972
9162
  "x-displayname": "Code",
8973
9163
  "x-ves-example": "0",
8974
9164
  "x-f5xc-example": "0",
9165
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
8975
9166
  "minimum": 0,
8976
9167
  "maximum": 2147483647,
8977
9168
  "x-f5xc-required-for": {
@@ -8988,6 +9179,8 @@
8988
9179
  "x-displayname": "Reason",
8989
9180
  "x-ves-example": "Value",
8990
9181
  "x-f5xc-example": "value",
9182
+ "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.",
9183
+ "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.",
8991
9184
  "minLength": 0,
8992
9185
  "maxLength": 43,
8993
9186
  "x-f5xc-required-for": {
@@ -8998,7 +9191,7 @@
8998
9191
  },
8999
9192
  "x-original-maxLength": 1024,
9000
9193
  "x-reconciled-from-discovery": true,
9001
- "x-reconciled-at": "2026-01-05T18:29:44.668271+00:00"
9194
+ "x-reconciled-at": "2026-01-07T15:53:51.664228+00:00"
9002
9195
  },
9003
9196
  "status": {
9004
9197
  "type": "string",
@@ -9007,6 +9200,7 @@
9007
9200
  "x-displayname": "Status",
9008
9201
  "x-ves-example": "Value",
9009
9202
  "x-f5xc-example": "value",
9203
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
9010
9204
  "minLength": 0,
9011
9205
  "maxLength": 17,
9012
9206
  "x-f5xc-required-for": {
@@ -9017,9 +9211,10 @@
9017
9211
  },
9018
9212
  "x-original-maxLength": 1024,
9019
9213
  "x-reconciled-from-discovery": true,
9020
- "x-reconciled-at": "2026-01-05T18:29:44.668275+00:00"
9214
+ "x-reconciled-at": "2026-01-07T15:53:51.664232+00:00"
9021
9215
  }
9022
9216
  },
9217
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
9023
9218
  "x-f5xc-minimum-configuration": {
9024
9219
  "description": "Minimum configuration for schemaStatusType",
9025
9220
  "required_fields": [
@@ -9047,6 +9242,8 @@
9047
9242
  "title": "Creation_timestamp.",
9048
9243
  "format": "date-time",
9049
9244
  "x-displayname": "Creation Timestamp.",
9245
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
9246
+ "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.",
9050
9247
  "minLength": 0,
9051
9248
  "maxLength": 1024,
9052
9249
  "x-f5xc-required-for": {
@@ -9064,6 +9261,7 @@
9064
9261
  "x-displayname": "Creator Class.",
9065
9262
  "x-ves-example": "Prism",
9066
9263
  "x-f5xc-example": "value",
9264
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
9067
9265
  "minLength": 0,
9068
9266
  "maxLength": 1024,
9069
9267
  "x-f5xc-required-for": {
@@ -9081,6 +9279,7 @@
9081
9279
  "x-displayname": "Creator ID.",
9082
9280
  "x-ves-example": "Admin@example-corp.com.",
9083
9281
  "x-f5xc-example": "value",
9282
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
9084
9283
  "minLength": 0,
9085
9284
  "maxLength": 1024,
9086
9285
  "x-f5xc-required-for": {
@@ -9097,6 +9296,8 @@
9097
9296
  "title": "Deletion_timestamp.",
9098
9297
  "format": "date-time",
9099
9298
  "x-displayname": "Deletion Timestamp.",
9299
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
9300
+ "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...",
9100
9301
  "minLength": 0,
9101
9302
  "maxLength": 1024,
9102
9303
  "x-f5xc-required-for": {
@@ -9116,6 +9317,8 @@
9116
9317
  "x-displayname": "Finalizers.",
9117
9318
  "x-ves-example": "Value",
9118
9319
  "x-f5xc-example": "value",
9320
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
9321
+ "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.",
9119
9322
  "x-f5xc-required-for": {
9120
9323
  "minimum_config": false,
9121
9324
  "create": false,
@@ -9133,6 +9336,8 @@
9133
9336
  "x-displayname": "Labels",
9134
9337
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
9135
9338
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
9339
+ "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.",
9340
+ "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).",
9136
9341
  "x-f5xc-required-for": {
9137
9342
  "minimum_config": false,
9138
9343
  "create": false,
@@ -9146,6 +9351,8 @@
9146
9351
  "title": "Modification_timestamp.",
9147
9352
  "format": "date-time",
9148
9353
  "x-displayname": "Modification Timestamp.",
9354
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
9355
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
9149
9356
  "minLength": 0,
9150
9357
  "maxLength": 1024,
9151
9358
  "x-f5xc-required-for": {
@@ -9164,6 +9371,8 @@
9164
9371
  "x-displayname": "Object Index.",
9165
9372
  "x-ves-example": "0",
9166
9373
  "x-f5xc-example": "0",
9374
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
9375
+ "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.",
9167
9376
  "minimum": 0,
9168
9377
  "maximum": 2147483647,
9169
9378
  "x-f5xc-required-for": {
@@ -9184,6 +9393,8 @@
9184
9393
  "x-displayname": "Tenant",
9185
9394
  "x-ves-example": "Example-corp.",
9186
9395
  "x-f5xc-example": "example-corp",
9396
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
9397
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
9187
9398
  "minLength": 0,
9188
9399
  "maxLength": 18,
9189
9400
  "x-f5xc-required-for": {
@@ -9195,7 +9406,7 @@
9195
9406
  "x-field-mutability": "read-only",
9196
9407
  "x-original-maxLength": 1024,
9197
9408
  "x-reconciled-from-discovery": true,
9198
- "x-reconciled-at": "2026-01-05T18:29:44.668294+00:00"
9409
+ "x-reconciled-at": "2026-01-07T15:53:51.664251+00:00"
9199
9410
  },
9200
9411
  "uid": {
9201
9412
  "type": "string",
@@ -9204,6 +9415,8 @@
9204
9415
  "x-displayname": "UID",
9205
9416
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
9206
9417
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
9418
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
9419
+ "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.",
9207
9420
  "minLength": 0,
9208
9421
  "maxLength": 36,
9209
9422
  "x-f5xc-required-for": {
@@ -9216,9 +9429,11 @@
9216
9429
  "x-original-maxLength": 1024,
9217
9430
  "format": "uuid",
9218
9431
  "x-reconciled-from-discovery": true,
9219
- "x-reconciled-at": "2026-01-05T18:29:44.668298+00:00"
9432
+ "x-reconciled-at": "2026-01-07T15:53:51.664256+00:00"
9220
9433
  }
9221
9434
  },
9435
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
9436
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
9222
9437
  "x-f5xc-minimum-configuration": {
9223
9438
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
9224
9439
  "required_fields": [
@@ -9266,7 +9481,7 @@
9266
9481
  },
9267
9482
  "x-original-maxLength": 1024,
9268
9483
  "x-reconciled-from-discovery": true,
9269
- "x-reconciled-at": "2026-01-05T18:29:44.668303+00:00"
9484
+ "x-reconciled-at": "2026-01-07T15:53:51.664262+00:00"
9270
9485
  },
9271
9486
  "name": {
9272
9487
  "type": "string",
@@ -9275,6 +9490,8 @@
9275
9490
  "x-displayname": "Name",
9276
9491
  "x-ves-example": "Contactus-route.",
9277
9492
  "x-f5xc-example": "contactus-route",
9493
+ "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.",
9494
+ "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.",
9278
9495
  "minLength": 0,
9279
9496
  "maxLength": 16,
9280
9497
  "x-f5xc-required-for": {
@@ -9285,7 +9502,7 @@
9285
9502
  },
9286
9503
  "x-original-maxLength": 1024,
9287
9504
  "x-reconciled-from-discovery": true,
9288
- "x-reconciled-at": "2026-01-05T18:29:44.668307+00:00"
9505
+ "x-reconciled-at": "2026-01-07T15:53:51.664266+00:00"
9289
9506
  },
9290
9507
  "namespace": {
9291
9508
  "type": "string",
@@ -9294,6 +9511,8 @@
9294
9511
  "x-displayname": "Namespace",
9295
9512
  "x-ves-example": "Ns1",
9296
9513
  "x-f5xc-example": "ns1",
9514
+ "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.",
9515
+ "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.",
9297
9516
  "minLength": 0,
9298
9517
  "maxLength": 6,
9299
9518
  "x-f5xc-required-for": {
@@ -9304,7 +9523,7 @@
9304
9523
  },
9305
9524
  "x-original-maxLength": 1024,
9306
9525
  "x-reconciled-from-discovery": true,
9307
- "x-reconciled-at": "2026-01-05T18:29:44.668311+00:00"
9526
+ "x-reconciled-at": "2026-01-07T15:53:51.664270+00:00"
9308
9527
  },
9309
9528
  "uid": {
9310
9529
  "type": "string",
@@ -9325,9 +9544,10 @@
9325
9544
  "x-original-maxLength": 1024,
9326
9545
  "format": "uuid",
9327
9546
  "x-reconciled-from-discovery": true,
9328
- "x-reconciled-at": "2026-01-05T18:29:44.668316+00:00"
9547
+ "x-reconciled-at": "2026-01-07T15:53:51.664275+00:00"
9329
9548
  }
9330
9549
  },
9550
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
9331
9551
  "x-f5xc-minimum-configuration": {
9332
9552
  "description": "Minimum configuration for schemaViewRefType",
9333
9553
  "required_fields": [
@@ -9364,6 +9584,8 @@
9364
9584
  "ves.io.schema.rules.map.keys.string.min_len": "1",
9365
9585
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
9366
9586
  },
9587
+ "x-f5xc-description-short": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g...",
9588
+ "x-f5xc-description-medium": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
9367
9589
  "x-f5xc-required-for": {
9368
9590
  "minimum_config": false,
9369
9591
  "create": false,
@@ -9385,6 +9607,8 @@
9385
9607
  "ves.io.schema.rules.map.keys.string.min_len": "1",
9386
9608
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
9387
9609
  },
9610
+ "x-f5xc-description-short": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object...",
9611
+ "x-f5xc-description-medium": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object kind e.g. \"virtual_host\".",
9388
9612
  "x-f5xc-required-for": {
9389
9613
  "minimum_config": false,
9390
9614
  "create": false,
@@ -9406,6 +9630,8 @@
9406
9630
  "ves.io.schema.rules.map.keys.string.min_len": "1",
9407
9631
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
9408
9632
  },
9633
+ "x-f5xc-description-short": "Resource Limits define maximum value of resources in the appropriate units that can be present.",
9634
+ "x-f5xc-description-medium": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of the resource limits is the resource name.",
9409
9635
  "x-f5xc-required-for": {
9410
9636
  "minimum_config": false,
9411
9637
  "create": false,
@@ -9414,6 +9640,7 @@
9414
9640
  }
9415
9641
  }
9416
9642
  },
9643
+ "x-f5xc-description-short": "Create quota creates a given object from storage backend for metadata.namespace.",
9417
9644
  "x-f5xc-minimum-configuration": {
9418
9645
  "description": "Minimum configuration for schemaquotaCreateSpecType",
9419
9646
  "required_fields": [
@@ -9449,6 +9676,8 @@
9449
9676
  "ves.io.schema.rules.map.keys.string.min_len": "1",
9450
9677
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
9451
9678
  },
9679
+ "x-f5xc-description-short": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g...",
9680
+ "x-f5xc-description-medium": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
9452
9681
  "x-f5xc-required-for": {
9453
9682
  "minimum_config": false,
9454
9683
  "create": false,
@@ -9470,6 +9699,8 @@
9470
9699
  "ves.io.schema.rules.map.keys.string.min_len": "1",
9471
9700
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
9472
9701
  },
9702
+ "x-f5xc-description-short": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object...",
9703
+ "x-f5xc-description-medium": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object kind e.g. \"virtual_host\".",
9473
9704
  "x-f5xc-required-for": {
9474
9705
  "minimum_config": false,
9475
9706
  "create": false,
@@ -9491,6 +9722,8 @@
9491
9722
  "ves.io.schema.rules.map.keys.string.min_len": "1",
9492
9723
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
9493
9724
  },
9725
+ "x-f5xc-description-short": "Resource Limits define maximum value of resources in the appropriate units that can be present.",
9726
+ "x-f5xc-description-medium": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of the resource limits is the resource name.",
9494
9727
  "x-f5xc-required-for": {
9495
9728
  "minimum_config": false,
9496
9729
  "create": false,
@@ -9499,6 +9732,7 @@
9499
9732
  }
9500
9733
  }
9501
9734
  },
9735
+ "x-f5xc-description-short": "GET quota reads a given object from storage backend for metadata.namespace.",
9502
9736
  "x-f5xc-minimum-configuration": {
9503
9737
  "description": "Minimum configuration for schemaquotaGetSpecType",
9504
9738
  "required_fields": [
@@ -9534,6 +9768,8 @@
9534
9768
  "ves.io.schema.rules.map.keys.string.min_len": "1",
9535
9769
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
9536
9770
  },
9771
+ "x-f5xc-description-short": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g...",
9772
+ "x-f5xc-description-medium": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
9537
9773
  "x-f5xc-required-for": {
9538
9774
  "minimum_config": false,
9539
9775
  "create": false,
@@ -9555,6 +9791,8 @@
9555
9791
  "ves.io.schema.rules.map.keys.string.min_len": "1",
9556
9792
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
9557
9793
  },
9794
+ "x-f5xc-description-short": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object...",
9795
+ "x-f5xc-description-medium": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object kind e.g. \"virtual_host\".",
9558
9796
  "x-f5xc-required-for": {
9559
9797
  "minimum_config": false,
9560
9798
  "create": false,
@@ -9576,6 +9814,8 @@
9576
9814
  "ves.io.schema.rules.map.keys.string.min_len": "1",
9577
9815
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
9578
9816
  },
9817
+ "x-f5xc-description-short": "Resource Limits define maximum value of resources in the appropriate units that can be present.",
9818
+ "x-f5xc-description-medium": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of the resource limits is the resource name.",
9579
9819
  "x-f5xc-required-for": {
9580
9820
  "minimum_config": false,
9581
9821
  "create": false,
@@ -9584,6 +9824,7 @@
9584
9824
  }
9585
9825
  }
9586
9826
  },
9827
+ "x-f5xc-description-short": "Replace quota updates a given object from storage backend for metadata.namespace.",
9587
9828
  "x-f5xc-minimum-configuration": {
9588
9829
  "description": "Minimum configuration for schemaquotaReplaceSpecType",
9589
9830
  "required_fields": [
@@ -9608,6 +9849,7 @@
9608
9849
  "description": "X-displayName: \"Current\"\nThe in-use value.",
9609
9850
  "title": "Current",
9610
9851
  "format": "double",
9852
+ "x-f5xc-description-short": "X-displayName: \"Current\" The in-use value.",
9611
9853
  "x-f5xc-required-for": {
9612
9854
  "minimum_config": false,
9613
9855
  "create": false,
@@ -9616,6 +9858,8 @@
9616
9858
  }
9617
9859
  }
9618
9860
  },
9861
+ "x-f5xc-description-short": "X-displayName: \"Usage (float)\" FloatUsageType defines the usage in float. Useful to report usage for items that have limits in fractions.",
9862
+ "x-f5xc-description-medium": "X-displayName: \"Usage (float)\" FloatUsageType defines the usage in float. Useful to report usage for items that have limits in fractions.",
9619
9863
  "x-f5xc-minimum-configuration": {
9620
9864
  "description": "Minimum configuration for usageFloatUsageType",
9621
9865
  "required_fields": [
@@ -9638,6 +9882,7 @@
9638
9882
  "description": "X-displayName: \"Current\"\nThe in-use value for the object kind.",
9639
9883
  "title": "Current",
9640
9884
  "format": "int32",
9885
+ "x-f5xc-description-short": "X-displayName: \"Current\" The in-use value for the object kind.",
9641
9886
  "minimum": 0,
9642
9887
  "maximum": 2147483647,
9643
9888
  "x-f5xc-required-for": {
@@ -9648,6 +9893,8 @@
9648
9893
  }
9649
9894
  }
9650
9895
  },
9896
+ "x-f5xc-description-short": "X-displayName: \"Usage\" UsageType defines the number of objects of a specific object kind that are currently in use.",
9897
+ "x-f5xc-description-medium": "X-displayName: \"Usage\" UsageType defines the number of objects of a specific object kind that are currently in use.",
9651
9898
  "x-f5xc-minimum-configuration": {
9652
9899
  "description": "Minimum configuration for usageUsageType",
9653
9900
  "required_fields": [
@@ -9672,6 +9919,7 @@
9672
9919
  "items": {
9673
9920
  "$ref": "#/components/schemas/subscriptionSubscriptionType"
9674
9921
  },
9922
+ "description": "IP address configuration",
9675
9923
  "x-f5xc-required-for": {
9676
9924
  "minimum_config": false,
9677
9925
  "create": false,
@@ -9680,6 +9928,7 @@
9680
9928
  }
9681
9929
  }
9682
9930
  },
9931
+ "x-f5xc-description-short": "Response to call to GET list of tenant subscriptions.",
9683
9932
  "x-f5xc-minimum-configuration": {
9684
9933
  "description": "Minimum configuration for subscriptionListSubscriptionsRsp",
9685
9934
  "required_fields": [
@@ -9722,6 +9971,7 @@
9722
9971
  "x-displayname": "End date",
9723
9972
  "x-ves-example": "2020-05-20T12:32:51.341959216Z.",
9724
9973
  "x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
9974
+ "x-f5xc-description-short": "Kast day of the last billing_period in external provider.",
9725
9975
  "minLength": 0,
9726
9976
  "maxLength": 1024,
9727
9977
  "x-f5xc-required-for": {
@@ -9739,6 +9989,7 @@
9739
9989
  "x-displayname": "Internal end date.",
9740
9990
  "x-ves-example": "2020-05-20T12:32:51.341959216Z.",
9741
9991
  "x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
9992
+ "x-f5xc-description-short": "Internal end date that serves as source of truth.",
9742
9993
  "minLength": 0,
9743
9994
  "maxLength": 1024,
9744
9995
  "x-f5xc-required-for": {
@@ -9756,6 +10007,7 @@
9756
10007
  "x-displayname": "Internal start date.",
9757
10008
  "x-ves-example": "2020-05-20T12:32:51.341959216Z.",
9758
10009
  "x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
10010
+ "x-f5xc-description-short": "Internal start date that serves as source of truth.",
9759
10011
  "minLength": 0,
9760
10012
  "maxLength": 1024,
9761
10013
  "x-f5xc-required-for": {
@@ -9773,6 +10025,7 @@
9773
10025
  "type": "string"
9774
10026
  },
9775
10027
  "x-displayname": "Invoices",
10028
+ "x-f5xc-description-short": "Link to all of the invoices for this period.",
9776
10029
  "x-f5xc-required-for": {
9777
10030
  "minimum_config": false,
9778
10031
  "create": false,
@@ -9803,6 +10056,7 @@
9803
10056
  "x-displayname": "Start date.",
9804
10057
  "x-ves-example": "2020-05-20T12:32:51.341959216Z.",
9805
10058
  "x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
10059
+ "x-f5xc-description-short": "The first day of the last billing_period in external provider.",
9806
10060
  "minLength": 0,
9807
10061
  "maxLength": 1024,
9808
10062
  "x-f5xc-required-for": {
@@ -9818,6 +10072,7 @@
9818
10072
  "title": "Trial",
9819
10073
  "format": "boolean",
9820
10074
  "x-displayname": "Trial",
10075
+ "x-f5xc-description-short": "Flag shows if this billing time frame is part of trial period.",
9821
10076
  "x-f5xc-required-for": {
9822
10077
  "minimum_config": false,
9823
10078
  "create": false,
@@ -9844,9 +10099,10 @@
9844
10099
  "x-original-maxLength": 1024,
9845
10100
  "format": "uuid",
9846
10101
  "x-reconciled-from-discovery": true,
9847
- "x-reconciled-at": "2026-01-05T18:29:59.898511+00:00"
10102
+ "x-reconciled-at": "2026-01-07T15:54:10.181112+00:00"
9848
10103
  }
9849
10104
  },
10105
+ "x-f5xc-description-short": "Response to call to GET list of tenant subscriptions.",
9850
10106
  "x-f5xc-minimum-configuration": {
9851
10107
  "description": "Minimum configuration for subscriptionPeriod",
9852
10108
  "required_fields": [
@@ -9882,6 +10138,7 @@
9882
10138
  "x-displayname": "Cancellation date.",
9883
10139
  "x-ves-example": "2020-04-20T12:32:51.341959216Z.",
9884
10140
  "x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
10141
+ "x-f5xc-description-short": "Date when subscription become cancelled.",
9885
10142
  "minLength": 0,
9886
10143
  "maxLength": 1024,
9887
10144
  "x-f5xc-required-for": {
@@ -9897,6 +10154,7 @@
9897
10154
  "title": "Cancelled",
9898
10155
  "format": "boolean",
9899
10156
  "x-displayname": "Cancelled",
10157
+ "x-f5xc-description-short": "Flag shows if this subscription is already cancelled.",
9900
10158
  "x-f5xc-required-for": {
9901
10159
  "minimum_config": false,
9902
10160
  "create": false,
@@ -9910,6 +10168,7 @@
9910
10168
  "title": "Current",
9911
10169
  "format": "boolean",
9912
10170
  "x-displayname": "Current",
10171
+ "x-f5xc-description-short": "Flag shows if this subscription is currently active.",
9913
10172
  "x-f5xc-required-for": {
9914
10173
  "minimum_config": false,
9915
10174
  "create": false,
@@ -9925,6 +10184,7 @@
9925
10184
  "x-displayname": "Billing period end date.",
9926
10185
  "x-ves-example": "2020-05-20T12:32:51.341959216Z.",
9927
10186
  "x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
10187
+ "x-f5xc-description-short": "The last day of the last billing_period.",
9928
10188
  "minLength": 0,
9929
10189
  "maxLength": 1024,
9930
10190
  "x-f5xc-required-for": {
@@ -9942,6 +10202,7 @@
9942
10202
  "x-displayname": "Billing period start date.",
9943
10203
  "x-ves-example": "2020-04-20T12:32:51.341959216Z.",
9944
10204
  "x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
10205
+ "x-f5xc-description-short": "The first day of the last billing_period.",
9945
10206
  "minLength": 0,
9946
10207
  "maxLength": 1024,
9947
10208
  "x-f5xc-required-for": {
@@ -9958,6 +10219,8 @@
9958
10219
  "x-displayname": "Name",
9959
10220
  "x-ves-example": "Sub-name-2e170678-4f50-4336-8af9-5413e9bdf250.",
9960
10221
  "x-f5xc-example": "sub-name-2e170678-4f50-4336-8af9-5413e9bdf250",
10222
+ "x-f5xc-description-short": "Name of the subscription (internal name, not human readable), a subscription has no human readable name.",
10223
+ "x-f5xc-description-medium": "Name of the subscription (internal name, not human readable), a subscription has no human readable name.",
9961
10224
  "minLength": 0,
9962
10225
  "maxLength": 16,
9963
10226
  "x-f5xc-required-for": {
@@ -9968,7 +10231,7 @@
9968
10231
  },
9969
10232
  "x-original-maxLength": 1024,
9970
10233
  "x-reconciled-from-discovery": true,
9971
- "x-reconciled-at": "2026-01-05T18:29:59.898526+00:00"
10234
+ "x-reconciled-at": "2026-01-07T15:54:10.181127+00:00"
9972
10235
  },
9973
10236
  "plan_name": {
9974
10237
  "type": "string",
@@ -10035,6 +10298,7 @@
10035
10298
  }
10036
10299
  }
10037
10300
  },
10301
+ "x-f5xc-description-short": "Tenant subscription to the services record.",
10038
10302
  "x-f5xc-minimum-configuration": {
10039
10303
  "description": "Minimum configuration for subscriptionSubscriptionType",
10040
10304
  "required_fields": [
@@ -10062,6 +10326,7 @@
10062
10326
  "title": "Empty",
10063
10327
  "x-displayname": "Empty",
10064
10328
  "x-ves-proto-message": "ves.io.schema.Empty",
10329
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
10065
10330
  "x-f5xc-minimum-configuration": {
10066
10331
  "description": "Minimum configuration for schemaEmpty",
10067
10332
  "required_fields": [],
@@ -10120,6 +10385,7 @@
10120
10385
  "$ref": "#/components/schemas/schemaEmpty"
10121
10386
  }
10122
10387
  },
10388
+ "x-f5xc-description-short": "Request to subscribe to one of addon services.",
10123
10389
  "x-f5xc-minimum-configuration": {
10124
10390
  "description": "Minimum configuration for subscriptionSubscribeRequest",
10125
10391
  "required_fields": [
@@ -10208,6 +10474,7 @@
10208
10474
  "$ref": "#/components/schemas/schemaEmpty"
10209
10475
  }
10210
10476
  },
10477
+ "x-f5xc-description-short": "Request to unsubscribe to one of addon services.",
10211
10478
  "x-f5xc-minimum-configuration": {
10212
10479
  "description": "Minimum configuration for subscriptionUnsubscribeRequest",
10213
10480
  "required_fields": [
@@ -10261,6 +10528,8 @@
10261
10528
  "default": "STATUS_UNKNOWN",
10262
10529
  "x-displayname": "Status type.",
10263
10530
  "x-ves-proto-enum": "ves.io.schema.usage.StatusType",
10531
+ "x-f5xc-description-short": "All possible usage line statuses - STATUS_UNKNOWN: No value defined - STATUS_NO_DATA: No data - STATUS_NOT_MEASURED: No measured - STATUS_ACTIVE...",
10532
+ "x-f5xc-description-medium": "All possible usage line statuses - STATUS_UNKNOWN: No value defined - STATUS_NO_DATA: No data - STATUS_NOT_MEASURED: No measured - STATUS_ACTIVE: Active.",
10264
10533
  "x-f5xc-minimum-configuration": {
10265
10534
  "description": "Minimum configuration for schemausageStatusType",
10266
10535
  "required_fields": [],
@@ -10334,6 +10603,7 @@
10334
10603
  "title": "Fixed",
10335
10604
  "format": "boolean",
10336
10605
  "x-displayname": "Fixes",
10606
+ "x-f5xc-description-short": "Means that this data came not from usage (reserved flag for support/discount/onboarding fees).",
10337
10607
  "x-f5xc-required-for": {
10338
10608
  "minimum_config": false,
10339
10609
  "create": false,
@@ -10351,6 +10621,8 @@
10351
10621
  "x-displayname": "Metric labels.",
10352
10622
  "x-ves-example": "['container-usage-large', 'container-usage-medium']",
10353
10623
  "x-f5xc-example": "['container-usage-large', 'container-usage-medium']",
10624
+ "x-f5xc-description-short": "ID of the corresponding aggregated_usage metric labels from which this calculated usage item is assembled.",
10625
+ "x-f5xc-description-medium": "ID of the corresponding aggregated_usage metric labels from which this calculated usage item is assembled.",
10354
10626
  "x-f5xc-required-for": {
10355
10627
  "minimum_config": false,
10356
10628
  "create": false,
@@ -10380,6 +10652,8 @@
10380
10652
  "format": "int64",
10381
10653
  "x-displayname": "Quantity billable.",
10382
10654
  "x-f5xc-example": "115",
10655
+ "x-f5xc-description-short": "Quantity which is used to calculate the amount.",
10656
+ "x-f5xc-description-medium": "Quantity which is used to calculate the amount. Rounded from quantity as the following: * after converting quantity from unit_code to unit_code of this addon_id, if the value < 1, then quantity_billable is rounded to 1 * after converting quantity from unit_code to unit_code of this addon_id, if...",
10383
10657
  "minLength": 0,
10384
10658
  "maxLength": 1024,
10385
10659
  "x-f5xc-required-for": {
@@ -10431,6 +10705,7 @@
10431
10705
  "title": "Unit name billable.",
10432
10706
  "x-displayname": "Unit name billable.",
10433
10707
  "x-f5xc-example": "GB",
10708
+ "x-f5xc-description-short": "Unit name a quantity_billable is provided in.",
10434
10709
  "minLength": 0,
10435
10710
  "maxLength": 1024,
10436
10711
  "x-f5xc-required-for": {
@@ -10457,6 +10732,7 @@
10457
10732
  }
10458
10733
  }
10459
10734
  },
10735
+ "x-f5xc-description-short": "One line of usage, including pricing details.",
10460
10736
  "x-f5xc-minimum-configuration": {
10461
10737
  "description": "Minimum configuration for usageCalculatedUsageItem",
10462
10738
  "required_fields": [
@@ -10502,6 +10778,8 @@
10502
10778
  "x-validation-rules": {
10503
10779
  "ves.io.schema.rules.message.required": "true"
10504
10780
  },
10781
+ "x-f5xc-description-short": "[x-required] If discount_type is fixed_amount, discount_amount is in cents If discount_type is percentage, discount_amount is in percentages of...",
10782
+ "x-f5xc-description-medium": "[x-required] If discount_type is fixed_amount, discount_amount is in cents If discount_type is percentage, discount_amount is in percentages of 0.01% precision (12.35% equals to 1235).",
10505
10783
  "minimum": 0,
10506
10784
  "maximum": 2147483647,
10507
10785
  "x-f5xc-required-for": {
@@ -10531,9 +10809,10 @@
10531
10809
  },
10532
10810
  "x-original-maxLength": 1024,
10533
10811
  "x-reconciled-from-discovery": true,
10534
- "x-reconciled-at": "2026-01-05T18:30:07.440022+00:00"
10812
+ "x-reconciled-at": "2026-01-07T15:54:20.012726+00:00"
10535
10813
  }
10536
10814
  },
10815
+ "x-f5xc-description-short": "Coupon details, discount type, amount and name.",
10537
10816
  "x-f5xc-minimum-configuration": {
10538
10817
  "description": "Minimum configuration for usageCoupon",
10539
10818
  "required_fields": [
@@ -10560,6 +10839,8 @@
10560
10839
  "default": "DISCOUNT_TYPE_UNKNOWN",
10561
10840
  "x-displayname": "Discount type.",
10562
10841
  "x-ves-proto-enum": "ves.io.schema.usage.DiscountType",
10842
+ "x-f5xc-description-short": "Indicates what type of discount is applied for a coupon: fixed price or percentage.",
10843
+ "x-f5xc-description-medium": "Indicates what type of discount is applied for a coupon: fixed price or percentage. Unknown The specified amount will be given as discount. The specified percentage will be given as discount.",
10563
10844
  "x-f5xc-minimum-configuration": {
10564
10845
  "description": "Minimum configuration for usageDiscountType",
10565
10846
  "required_fields": [],
@@ -10584,6 +10865,7 @@
10584
10865
  "x-displayname": "Container",
10585
10866
  "x-ves-example": "Pa4-deployment1-abcd12.",
10586
10867
  "x-f5xc-example": "pa4-deployment1-abcd12",
10868
+ "x-f5xc-description-short": "Container name if this item correspond to the container usage. Otherwise it's empty.",
10587
10869
  "minLength": 0,
10588
10870
  "maxLength": 1024,
10589
10871
  "x-f5xc-required-for": {
@@ -10607,6 +10889,7 @@
10607
10889
  "x-validation-rules": {
10608
10890
  "ves.io.schema.rules.message.required": "true"
10609
10891
  },
10892
+ "x-f5xc-description-short": "[x-required] Deployment name if this item correspond to the container usage. Otherwise it's empty.",
10610
10893
  "minLength": 0,
10611
10894
  "maxLength": 1024,
10612
10895
  "x-f5xc-required-for": {
@@ -10682,6 +10965,7 @@
10682
10965
  }
10683
10966
  }
10684
10967
  },
10968
+ "x-f5xc-description-short": "One line of usage by an hour. One hour as the least resolution.",
10685
10969
  "x-f5xc-minimum-configuration": {
10686
10970
  "description": "Minimum configuration for usageHourlyItem",
10687
10971
  "required_fields": [
@@ -10714,6 +10998,7 @@
10714
10998
  "x-displayname": "From",
10715
10999
  "x-ves-example": "2020-04-20T12:32:51.341959216Z.",
10716
11000
  "x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
11001
+ "x-f5xc-description-short": "Indicates the \"from\" part of the request.",
10717
11002
  "minLength": 0,
10718
11003
  "maxLength": 1024,
10719
11004
  "x-f5xc-required-for": {
@@ -10740,7 +11025,7 @@
10740
11025
  },
10741
11026
  "x-original-maxLength": 1024,
10742
11027
  "x-reconciled-from-discovery": true,
10743
- "x-reconciled-at": "2026-01-05T18:30:07.440051+00:00"
11028
+ "x-reconciled-at": "2026-01-07T15:54:20.012745+00:00"
10744
11029
  },
10745
11030
  "to": {
10746
11031
  "type": "string",
@@ -10760,6 +11045,7 @@
10760
11045
  }
10761
11046
  }
10762
11047
  },
11048
+ "x-f5xc-description-short": "Request message to GET current usage details.",
10763
11049
  "x-f5xc-minimum-configuration": {
10764
11050
  "description": "Minimum configuration for usageListCurrentUsageReq",
10765
11051
  "required_fields": [
@@ -10838,6 +11124,7 @@
10838
11124
  "$ref": "#/components/schemas/usageCalculatedUsageItem"
10839
11125
  },
10840
11126
  "x-displayname": "Usage items.",
11127
+ "x-f5xc-description-short": "Collection of usage items, lines of response.",
10841
11128
  "x-f5xc-required-for": {
10842
11129
  "minimum_config": false,
10843
11130
  "create": false,
@@ -10846,6 +11133,7 @@
10846
11133
  }
10847
11134
  }
10848
11135
  },
11136
+ "x-f5xc-description-short": "Response message to GET current usage details.",
10849
11137
  "x-f5xc-minimum-configuration": {
10850
11138
  "description": "Minimum configuration for usageListCurrentUsageResp",
10851
11139
  "required_fields": [
@@ -10885,7 +11173,7 @@
10885
11173
  },
10886
11174
  "x-original-maxLength": 1024,
10887
11175
  "x-reconciled-from-discovery": true,
10888
- "x-reconciled-at": "2026-01-05T18:30:07.440064+00:00"
11176
+ "x-reconciled-at": "2026-01-07T15:54:20.012759+00:00"
10889
11177
  },
10890
11178
  "query": {
10891
11179
  "type": "string",
@@ -10894,6 +11182,7 @@
10894
11182
  "x-displayname": "Query",
10895
11183
  "x-ves-example": "{'MetricLabel':'label'}",
10896
11184
  "x-f5xc-example": "{'MetricLabel':'label'}",
11185
+ "x-f5xc-description-short": "Encoded query which is passed as is to barracute daemon.",
10897
11186
  "minLength": 0,
10898
11187
  "maxLength": 1024,
10899
11188
  "x-f5xc-required-for": {
@@ -10904,6 +11193,7 @@
10904
11193
  }
10905
11194
  }
10906
11195
  },
11196
+ "x-f5xc-description-short": "Request body for ListHourlyUsageDetails rpc method.",
10907
11197
  "x-f5xc-minimum-configuration": {
10908
11198
  "description": "Minimum configuration for usageListHourlyUsageDetailsReq",
10909
11199
  "required_fields": [
@@ -10932,6 +11222,7 @@
10932
11222
  "$ref": "#/components/schemas/usageHourlyItem"
10933
11223
  },
10934
11224
  "x-displayname": "Usage items.",
11225
+ "x-f5xc-description-short": "Array of usage by hour in the period from the query.",
10935
11226
  "x-f5xc-required-for": {
10936
11227
  "minimum_config": false,
10937
11228
  "create": false,
@@ -10940,6 +11231,7 @@
10940
11231
  }
10941
11232
  }
10942
11233
  },
11234
+ "x-f5xc-description-short": "Response body for ListHourlyUsageDetails rpc method.",
10943
11235
  "x-f5xc-minimum-configuration": {
10944
11236
  "description": "Minimum configuration for usageListHourlyUsageDetailsResp",
10945
11237
  "required_fields": [
@@ -10976,9 +11268,10 @@
10976
11268
  },
10977
11269
  "x-original-maxLength": 1024,
10978
11270
  "x-reconciled-from-discovery": true,
10979
- "x-reconciled-at": "2026-01-05T18:30:07.440073+00:00"
11271
+ "x-reconciled-at": "2026-01-07T15:54:20.012767+00:00"
10980
11272
  }
10981
11273
  },
11274
+ "x-f5xc-description-short": "Request message to GET mon thly usage details.",
10982
11275
  "x-f5xc-minimum-configuration": {
10983
11276
  "description": "Minimum configuration for usageListMonthlyUsageReq",
10984
11277
  "required_fields": [
@@ -11006,6 +11299,7 @@
11006
11299
  "$ref": "#/components/schemas/usageMonthlyUsageType"
11007
11300
  },
11008
11301
  "x-displayname": "Usage items.",
11302
+ "x-f5xc-description-short": "Collection of usage items, lines of response.",
11009
11303
  "x-f5xc-required-for": {
11010
11304
  "minimum_config": false,
11011
11305
  "create": false,
@@ -11014,6 +11308,7 @@
11014
11308
  }
11015
11309
  }
11016
11310
  },
11311
+ "x-f5xc-description-short": "Response message to GET monthly usage details.",
11017
11312
  "x-f5xc-minimum-configuration": {
11018
11313
  "description": "Minimum configuration for usageListMonthlyUsageResp",
11019
11314
  "required_fields": [
@@ -11041,6 +11336,7 @@
11041
11336
  "x-displayname": "From",
11042
11337
  "x-ves-example": "2020-04-20T12:32:51.341959216Z.",
11043
11338
  "x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
11339
+ "x-f5xc-description-short": "Indicates the \"from\" part of the request.",
11044
11340
  "minLength": 0,
11045
11341
  "maxLength": 1024,
11046
11342
  "x-f5xc-required-for": {
@@ -11067,7 +11363,7 @@
11067
11363
  },
11068
11364
  "x-original-maxLength": 1024,
11069
11365
  "x-reconciled-from-discovery": true,
11070
- "x-reconciled-at": "2026-01-05T18:30:07.440081+00:00"
11366
+ "x-reconciled-at": "2026-01-07T15:54:20.012775+00:00"
11071
11367
  },
11072
11368
  "to": {
11073
11369
  "type": "string",
@@ -11116,6 +11412,7 @@
11116
11412
  "$ref": "#/components/schemas/usageUsageItem"
11117
11413
  },
11118
11414
  "x-displayname": "Usage items.",
11415
+ "x-f5xc-description-short": "Collection of usage items, lines of response.",
11119
11416
  "x-f5xc-required-for": {
11120
11417
  "minimum_config": false,
11121
11418
  "create": false,
@@ -11211,6 +11508,7 @@
11211
11508
  }
11212
11509
  }
11213
11510
  },
11511
+ "x-f5xc-description-short": "One line of usage, including pricing details.",
11214
11512
  "x-f5xc-minimum-configuration": {
11215
11513
  "description": "Minimum configuration for usageMonthlyUsageType",
11216
11514
  "required_fields": [
@@ -11258,6 +11556,8 @@
11258
11556
  "$ref": "#/components/schemas/usageHourlyItem"
11259
11557
  },
11260
11558
  "x-displayname": "Hourly breakdown.",
11559
+ "x-f5xc-description-short": "Array of HourlyItem with usage per hour.",
11560
+ "x-f5xc-description-medium": "Array of HourlyItem with usage per hour. The sum of these items will result into the parent's object Deprecated: use /hourly_usage_details along with hourly_breakdown_query.",
11261
11561
  "x-f5xc-required-for": {
11262
11562
  "minimum_config": false,
11263
11563
  "create": false,
@@ -11279,6 +11579,8 @@
11279
11579
  "x-validation-rules": {
11280
11580
  "ves.io.schema.rules.message.required": "true"
11281
11581
  },
11582
+ "x-f5xc-description-short": "[x-required] A base64 encoded JSON which should be passed as is to /hourly_usage_details to GET hourly items for this aggregated usage.",
11583
+ "x-f5xc-description-medium": "[x-required] A base64 encoded JSON which should be passed as is to /hourly_usage_details to GET hourly items for this aggregated usage.",
11282
11584
  "minLength": 0,
11283
11585
  "maxLength": 1024,
11284
11586
  "x-f5xc-required-for": {
@@ -11300,6 +11602,7 @@
11300
11602
  "x-validation-rules": {
11301
11603
  "ves.io.schema.rules.message.required": "true"
11302
11604
  },
11605
+ "x-f5xc-description-medium": "[x-required] ID of the usage type. As Usage type is shown for user and is a subject of frequent changes, this metric_label should be static and should be usage for mapping between calculated usage and aggregated_usage.",
11303
11606
  "minLength": 0,
11304
11607
  "maxLength": 1024,
11305
11608
  "x-f5xc-required-for": {
@@ -11326,7 +11629,7 @@
11326
11629
  },
11327
11630
  "x-original-maxLength": 1024,
11328
11631
  "x-reconciled-from-discovery": true,
11329
- "x-reconciled-at": "2026-01-05T18:30:07.440100+00:00"
11632
+ "x-reconciled-at": "2026-01-07T15:54:20.012794+00:00"
11330
11633
  },
11331
11634
  "object_name": {
11332
11635
  "type": "string",
@@ -11335,6 +11638,7 @@
11335
11638
  "x-displayname": "Object name.",
11336
11639
  "x-ves-example": "Pa4-resource1.",
11337
11640
  "x-f5xc-example": "pa4-resource1",
11641
+ "x-f5xc-description-short": "Name of the object where the usage occurred.",
11338
11642
  "minLength": 0,
11339
11643
  "maxLength": 1024,
11340
11644
  "x-f5xc-required-for": {
@@ -11409,6 +11713,7 @@
11409
11713
  }
11410
11714
  }
11411
11715
  },
11716
+ "x-f5xc-description-short": "Usage item represents a line in a usage report, including quantity and resource incurring usage.",
11412
11717
  "x-f5xc-minimum-configuration": {
11413
11718
  "description": "Minimum configuration for usageUsageItem",
11414
11719
  "required_fields": [
@@ -11470,7 +11775,7 @@
11470
11775
  },
11471
11776
  "x-original-maxLength": 1024,
11472
11777
  "x-reconciled-from-discovery": true,
11473
- "x-reconciled-at": "2026-01-05T18:30:07.654743+00:00"
11778
+ "x-reconciled-at": "2026-01-07T15:54:20.309732+00:00"
11474
11779
  }
11475
11780
  },
11476
11781
  "x-f5xc-minimum-configuration": {
@@ -11552,6 +11857,7 @@
11552
11857
  "$ref": "#/components/schemas/planPlanInternal"
11553
11858
  },
11554
11859
  "x-displayname": "Plans",
11860
+ "x-f5xc-description-short": "Collection of currently publicly available plans.",
11555
11861
  "x-f5xc-required-for": {
11556
11862
  "minimum_config": false,
11557
11863
  "create": false,
@@ -11587,6 +11893,8 @@
11587
11893
  "default": "PERIOD_UNKNOWN",
11588
11894
  "x-displayname": "Period type.",
11589
11895
  "x-ves-proto-enum": "ves.io.schema.usage.plan.PeriodUnitType",
11896
+ "x-f5xc-description-short": "Temporal period type - PERIOD_UNKNOWN: unknown, undefined period of time - PERIOD_DAY: Day - PERIOD_WEEK: Week - PERIOD_MONTH: Month ...",
11897
+ "x-f5xc-description-medium": "Temporal period type - PERIOD_UNKNOWN: unknown, undefined period of time - PERIOD_DAY: Day - PERIOD_WEEK: Week - PERIOD_MONTH: Month - PERIOD_YEAR: Year.",
11590
11898
  "x-f5xc-minimum-configuration": {
11591
11899
  "description": "Minimum configuration for planPeriodUnitType",
11592
11900
  "required_fields": [],
@@ -11611,6 +11919,7 @@
11611
11919
  "$ref": "#/components/schemas/planAddonServiceDetails"
11612
11920
  },
11613
11921
  "x-displayname": "Allowed Addon Services.",
11922
+ "x-f5xc-description-short": "List of addon services that can be subscribed part of current plan.",
11614
11923
  "x-f5xc-required-for": {
11615
11924
  "minimum_config": false,
11616
11925
  "create": false,
@@ -11624,6 +11933,7 @@
11624
11933
  "title": "Billing disabled.",
11625
11934
  "format": "boolean",
11626
11935
  "x-displayname": "Billing disabled.",
11936
+ "x-f5xc-description-short": "If true then there's no automatic billing.",
11627
11937
  "x-f5xc-required-for": {
11628
11938
  "minimum_config": false,
11629
11939
  "create": false,
@@ -11637,6 +11947,7 @@
11637
11947
  "title": "Current",
11638
11948
  "format": "boolean",
11639
11949
  "x-displayname": "Current",
11950
+ "x-f5xc-description-short": "True if plan is active. Note that customers are only allowed to current plans.",
11640
11951
  "x-f5xc-required-for": {
11641
11952
  "minimum_config": false,
11642
11953
  "create": false,
@@ -11654,6 +11965,7 @@
11654
11965
  "x-displayname": "Description.",
11655
11966
  "x-ves-example": "###Free plan, includes x y z *Free item 1 *Free item 2 ##Self-support only.",
11656
11967
  "x-f5xc-example": "###Free plan, includes x y z *Free item 1 *Free item 2 ##Self-support only",
11968
+ "x-f5xc-description-short": "Description of the plan as mark-down text.",
11657
11969
  "minLength": 0,
11658
11970
  "maxLength": 0,
11659
11971
  "x-f5xc-required-for": {
@@ -11664,7 +11976,7 @@
11664
11976
  },
11665
11977
  "x-original-maxLength": 1024,
11666
11978
  "x-reconciled-from-discovery": true,
11667
- "x-reconciled-at": "2026-01-05T18:30:07.654763+00:00"
11979
+ "x-reconciled-at": "2026-01-07T15:54:20.309752+00:00"
11668
11980
  },
11669
11981
  "flat_price": {
11670
11982
  "type": "integer",
@@ -11690,6 +12002,7 @@
11690
12002
  "$ref": "#/components/schemas/planAddonServiceDetails"
11691
12003
  },
11692
12004
  "x-displayname": "Included Addon Services.",
12005
+ "x-f5xc-description-short": "List of addon services that are available part of current plan.",
11693
12006
  "x-f5xc-required-for": {
11694
12007
  "minimum_config": false,
11695
12008
  "create": false,
@@ -11704,6 +12017,7 @@
11704
12017
  "x-displayname": "Name",
11705
12018
  "x-ves-example": "Free-p25-v2.",
11706
12019
  "x-f5xc-example": "free-p25-v2",
12020
+ "x-f5xc-description-short": "Name of the plan, the name is not guaranteed to be human readable.",
11707
12021
  "minLength": 0,
11708
12022
  "maxLength": 16,
11709
12023
  "x-f5xc-required-for": {
@@ -11714,7 +12028,7 @@
11714
12028
  },
11715
12029
  "x-original-maxLength": 1024,
11716
12030
  "x-reconciled-from-discovery": true,
11717
- "x-reconciled-at": "2026-01-05T18:30:07.654770+00:00"
12031
+ "x-reconciled-at": "2026-01-07T15:54:20.309761+00:00"
11718
12032
  },
11719
12033
  "renewal_period_unit": {
11720
12034
  "$ref": "#/components/schemas/planPeriodUnitType"
@@ -11729,6 +12043,7 @@
11729
12043
  "x-displayname": "Sub-title",
11730
12044
  "x-ves-example": "Our free plan.",
11731
12045
  "x-f5xc-example": "Our free plan",
12046
+ "x-f5xc-description-short": "Optional second line of the title of the plan, human readable.",
11732
12047
  "minLength": 0,
11733
12048
  "maxLength": 1024,
11734
12049
  "x-f5xc-required-for": {
@@ -11758,7 +12073,7 @@
11758
12073
  },
11759
12074
  "x-original-maxLength": 1024,
11760
12075
  "x-reconciled-from-discovery": true,
11761
- "x-reconciled-at": "2026-01-05T18:30:07.654780+00:00"
12076
+ "x-reconciled-at": "2026-01-07T15:54:20.309770+00:00"
11762
12077
  },
11763
12078
  "transition_flow": {
11764
12079
  "$ref": "#/components/schemas/planUsagePlanTransitionFlow"
@@ -11771,6 +12086,8 @@
11771
12086
  "x-displayname": "Trial period.",
11772
12087
  "x-ves-example": "3",
11773
12088
  "x-f5xc-example": "3",
12089
+ "x-f5xc-description-short": "Trial period associated with this plan. Different pricing conditions are in place during the trial period - flat fee my not apply, or similar.",
12090
+ "x-f5xc-description-medium": "Trial period associated with this plan. Different pricing conditions are in place during the trial period - flat fee my not apply, or similar.",
11774
12091
  "minimum": 0,
11775
12092
  "maximum": 2147483647,
11776
12093
  "x-f5xc-required-for": {
@@ -11787,6 +12104,7 @@
11787
12104
  "$ref": "#/components/schemas/schemaPlanType"
11788
12105
  }
11789
12106
  },
12107
+ "x-f5xc-description-short": "Structure that holds all data needed to choose usage plan.",
11790
12108
  "x-f5xc-minimum-configuration": {
11791
12109
  "description": "Minimum configuration for planPlanInternal",
11792
12110
  "required_fields": [
@@ -11827,6 +12145,8 @@
11827
12145
  "default": "STATE_UNSPECIFIED",
11828
12146
  "x-displayname": "PlanTransitionState.",
11829
12147
  "x-ves-proto-enum": "ves.io.schema.usage.plan.PlanState",
12148
+ "x-f5xc-description-short": "State of the - STATE_UNSPECIFIED: zero value - STATE_READY: the plan is in default state - STATE_TRANSITION_PENDING: the plan is in the state of...",
12149
+ "x-f5xc-description-medium": "State of the - STATE_UNSPECIFIED: zero value - STATE_READY: the plan is in default state - STATE_TRANSITION_PENDING: the plan is in the state of plan transitioning. If the plan has current flag equals to true and in TRANSITION_PENDING then tenant moves to another plan which is in state...",
11830
12150
  "x-f5xc-minimum-configuration": {
11831
12151
  "description": "Minimum configuration for planPlanState",
11832
12152
  "required_fields": [],
@@ -11850,6 +12170,8 @@
11850
12170
  "default": "TRANSITION_METHOD_UNSPECIFIED",
11851
12171
  "x-displayname": "PlanTransitionMethod.",
11852
12172
  "x-ves-proto-enum": "ves.io.schema.usage.plan.PlanTransitionMethod",
12173
+ "x-f5xc-description-short": "Transitioning method which UI should show to the customer to properly execute the transition between - TRANSITION_METHOD_UNSPECIFIED: Zero value ...",
12174
+ "x-f5xc-description-medium": "Transitioning method which UI should show to the customer to properly execute the transition between - TRANSITION_METHOD_UNSPECIFIED: Zero value - TRANSITION_METHOD_SUPPORT: The transition should be done via a support request, the current behaviour for any transition - TRANSITION_METHOD_WIZARD...",
11853
12175
  "x-f5xc-minimum-configuration": {
11854
12176
  "description": "Minimum configuration for planPlanTransitionMethod",
11855
12177
  "required_fields": [],
@@ -11873,6 +12195,8 @@
11873
12195
  "default": "TRANSITION_REQUIRED_FIELD_UNSPECIFIED",
11874
12196
  "x-displayname": "PlanTransitionRequiredField.",
11875
12197
  "x-ves-proto-enum": "ves.io.schema.usage.plan.PlanTransitionRequiredField",
12198
+ "x-f5xc-description-short": "Fields which UI should provide to the backend to properly execute the transition between plans - TRANSITION_REQUIRED_FIELD_UNSPECIFIED: Zero value...",
12199
+ "x-f5xc-description-medium": "Fields which UI should provide to the backend to properly execute the transition between plans - TRANSITION_REQUIRED_FIELD_UNSPECIFIED: Zero value - TRANSITION_REQUIRED_FIELD_PAYMENT_TOKEN: Stripe token after user enters CC info and we submit it to stripe - TRANSITION_REQUIRED_FIELD_DOMAIN...",
11876
12200
  "x-f5xc-minimum-configuration": {
11877
12201
  "description": "Minimum configuration for planPlanTransitionRequiredField",
11878
12202
  "required_fields": [],
@@ -11901,6 +12225,7 @@
11901
12225
  "$ref": "#/components/schemas/planPlanTransitionRequiredField"
11902
12226
  },
11903
12227
  "x-displayname": "Required fields.",
12228
+ "x-f5xc-description-short": "Mandatory information to migrate onto this plan.",
11904
12229
  "x-f5xc-required-for": {
11905
12230
  "minimum_config": false,
11906
12231
  "create": false,
@@ -11914,6 +12239,8 @@
11914
12239
  "title": "Manual approval.",
11915
12240
  "format": "boolean",
11916
12241
  "x-displayname": "Manual approval.",
12242
+ "x-f5xc-example": "{\"key\": \"value\"}",
12243
+ "x-f5xc-description-short": "If true then any migration onto this plan must be approved by the billing department.",
11917
12244
  "x-f5xc-required-for": {
11918
12245
  "minimum_config": false,
11919
12246
  "create": false,
@@ -11922,6 +12249,7 @@
11922
12249
  }
11923
12250
  }
11924
12251
  },
12252
+ "x-f5xc-description-short": "Details for transition flow. Is used as part of UsagePlanInternal.",
11925
12253
  "x-f5xc-minimum-configuration": {
11926
12254
  "description": "Minimum configuration for planUsagePlanTransitionFlow",
11927
12255
  "required_fields": [
@@ -11956,6 +12284,7 @@
11956
12284
  }
11957
12285
  }
11958
12286
  },
12287
+ "x-f5xc-description-short": "X-displayName: \"Hours\" Input Duration Hours.",
11959
12288
  "x-f5xc-minimum-configuration": {
11960
12289
  "description": "Minimum configuration for rate_limiterInputHours",
11961
12290
  "required_fields": [
@@ -11988,6 +12317,7 @@
11988
12317
  }
11989
12318
  }
11990
12319
  },
12320
+ "x-f5xc-description-short": "X-displayName: \"Minutes\" Input Duration Minutes.",
11991
12321
  "x-f5xc-minimum-configuration": {
11992
12322
  "description": "Minimum configuration for rate_limiterInputMinutes",
11993
12323
  "required_fields": [
@@ -12020,6 +12350,7 @@
12020
12350
  }
12021
12351
  }
12022
12352
  },
12353
+ "x-f5xc-description-short": "X-displayName: \"Seconds\" Input Duration Seconds.",
12023
12354
  "x-f5xc-minimum-configuration": {
12024
12355
  "description": "Minimum configuration for rate_limiterInputSeconds",
12025
12356
  "required_fields": [
@@ -12036,6 +12367,8 @@
12036
12367
  "type": "object",
12037
12368
  "description": "X-displayName: \"Leaky Bucket Rate Limiter\"\nLeaky-Bucket is the default rate limiter algorithm for F5.",
12038
12369
  "title": "LeakyBucketRateLimiter.",
12370
+ "x-f5xc-description-short": "X-displayName: \"Leaky Bucket Rate Limiter\" Leaky-Bucket is the default rate limiter algorithm for F5.",
12371
+ "x-f5xc-description-medium": "X-displayName: \"Leaky Bucket Rate Limiter\" Leaky-Bucket is the default rate limiter algorithm for F5.",
12039
12372
  "x-f5xc-minimum-configuration": {
12040
12373
  "description": "Minimum configuration for rate_limiterLeakyBucketRateLimiter",
12041
12374
  "required_fields": [],
@@ -12061,6 +12394,8 @@
12061
12394
  "$ref": "#/components/schemas/rate_limiterInputSeconds"
12062
12395
  }
12063
12396
  },
12397
+ "x-f5xc-description-short": "X-displayName: \"Rate Limit Block Action\" Action where a user is blocked from making further requests after exceeding rate limit threshold.",
12398
+ "x-f5xc-description-medium": "X-displayName: \"Rate Limit Block Action\" Action where a user is blocked from making further requests after exceeding rate limit threshold.",
12064
12399
  "x-f5xc-minimum-configuration": {
12065
12400
  "description": "Minimum configuration for rate_limiterRateLimitBlockAction",
12066
12401
  "required_fields": [
@@ -12086,6 +12421,8 @@
12086
12421
  "DAY"
12087
12422
  ],
12088
12423
  "default": "SECOND",
12424
+ "x-f5xc-description-short": "X-displayName: \"Rate Limit Period Unit\" Unit for the period per which the rate limit is applied. - SECOND: Second x-displayName: \"Seconds\" Rate...",
12425
+ "x-f5xc-description-medium": "X-displayName: \"Rate Limit Period Unit\" Unit for the period per which the rate limit is applied. - SECOND: Second x-displayName: \"Seconds\" Rate limit period unit is seconds - MINUTE: Minute x-displayName: \"Minutes\" Rate limit period unit is minutes - HOUR: Hour x-displayName: \"Hours\" Rate limit...",
12089
12426
  "x-f5xc-minimum-configuration": {
12090
12427
  "description": "Minimum configuration for rate_limiterRateLimitPeriodUnit",
12091
12428
  "required_fields": [],
@@ -12110,6 +12447,8 @@
12110
12447
  "title": "Burst_multiplier.",
12111
12448
  "format": "int64",
12112
12449
  "x-f5xc-example": "1",
12450
+ "x-f5xc-description-short": "X-displayName: \"Burst Multiplier\" The maximum burst of requests to accommodate, expressed as a multiple of the rate.",
12451
+ "x-f5xc-description-medium": "X-displayName: \"Burst Multiplier\" The maximum burst of requests to accommodate, expressed as a multiple of the rate.",
12113
12452
  "minimum": 0,
12114
12453
  "maximum": 2147483647,
12115
12454
  "x-f5xc-required-for": {
@@ -12131,6 +12470,7 @@
12131
12470
  "title": "Period_multiplier.",
12132
12471
  "format": "int64",
12133
12472
  "x-f5xc-example": "1",
12473
+ "x-f5xc-description-short": "X-displayName: \"Periods\" This setting, combined with Per Period units, provides a duration.",
12134
12474
  "minimum": 0,
12135
12475
  "maximum": 2147483647,
12136
12476
  "x-f5xc-required-for": {
@@ -12149,6 +12489,8 @@
12149
12489
  "title": "Total_number.",
12150
12490
  "format": "int64",
12151
12491
  "x-f5xc-example": "1",
12492
+ "x-f5xc-description-short": "X-displayName: \"Number Of Requests\" x-required The total number of allowed requests per rate-limiting period.",
12493
+ "x-f5xc-description-medium": "X-displayName: \"Number Of Requests\" x-required The total number of allowed requests per rate-limiting period.",
12152
12494
  "minimum": 0,
12153
12495
  "maximum": 2147483647,
12154
12496
  "x-f5xc-required-for": {
@@ -12162,6 +12504,8 @@
12162
12504
  "$ref": "#/components/schemas/rate_limiterRateLimitPeriodUnit"
12163
12505
  }
12164
12506
  },
12507
+ "x-f5xc-description-short": "X-displayName: \"Rate Limit Value\" A tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
12508
+ "x-f5xc-description-medium": "X-displayName: \"Rate Limit Value\" A tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
12165
12509
  "x-f5xc-minimum-configuration": {
12166
12510
  "description": "Minimum configuration for rate_limiterRateLimitValue",
12167
12511
  "required_fields": [
@@ -12185,6 +12529,8 @@
12185
12529
  "type": "object",
12186
12530
  "description": "X-displayName: \"Token Bucket Rate Limiter\"\nToken-Bucket is a rate limiter algorithm that is stricter with enforcing limits.",
12187
12531
  "title": "TokenBucketRateLimiter.",
12532
+ "x-f5xc-description-short": "X-displayName: \"Token Bucket Rate Limiter\" Token-Bucket is a rate limiter algorithm that is stricter with enforcing limits.",
12533
+ "x-f5xc-description-medium": "X-displayName: \"Token Bucket Rate Limiter\" Token-Bucket is a rate limiter algorithm that is stricter with enforcing limits.",
12188
12534
  "x-f5xc-minimum-configuration": {
12189
12535
  "description": "Minimum configuration for rate_limiterTokenBucketRateLimiter",
12190
12536
  "required_fields": [],
@@ -12209,6 +12555,7 @@
12209
12555
  "default": "FREE",
12210
12556
  "x-displayname": "Plan Type",
12211
12557
  "x-ves-proto-enum": "ves.io.schema.PlanType",
12558
+ "x-f5xc-description-short": "PlanType is the type of billing plan for the customer.",
12212
12559
  "x-f5xc-minimum-configuration": {
12213
12560
  "description": "Minimum configuration for schemaPlanType",
12214
12561
  "required_fields": [],
@@ -12231,6 +12578,8 @@
12231
12578
  "default": "UNKNOWN",
12232
12579
  "x-displayname": "Tenant type.",
12233
12580
  "x-ves-proto-enum": "ves.io.schema.TenantType",
12581
+ "x-f5xc-description-short": "TenantType is the type of the customer UNKNOWN indicates the field not being set FREEMIUM are customer that don't have their domain ENTERPRiISE...",
12582
+ "x-f5xc-description-medium": "TenantType is the type of the customer UNKNOWN indicates the field not being set FREEMIUM are customer that don't have their domain ENTERPRiISE customer have their domain.",
12234
12583
  "x-f5xc-minimum-configuration": {
12235
12584
  "description": "Minimum configuration for schemaTenantType",
12236
12585
  "required_fields": [],
@@ -12263,6 +12612,8 @@
12263
12612
  "ves.io.schema.rules.map.keys.string.min_len": "1",
12264
12613
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
12265
12614
  },
12615
+ "x-f5xc-description-short": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g...",
12616
+ "x-f5xc-description-medium": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
12266
12617
  "x-f5xc-required-for": {
12267
12618
  "minimum_config": false,
12268
12619
  "create": false,
@@ -12285,6 +12636,8 @@
12285
12636
  "ves.io.schema.rules.map.keys.string.min_len": "1",
12286
12637
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
12287
12638
  },
12639
+ "x-f5xc-description-short": "API Gateway Limits defines rate limit value parameters for an API at a service level (prism, sentinel, etc) The key of the apigw_limits map is rpc...",
12640
+ "x-f5xc-description-medium": "API Gateway Limits defines rate limit value parameters for an API at a service level (prism, sentinel, etc) The key of the apigw_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
12288
12641
  "x-f5xc-required-for": {
12289
12642
  "minimum_config": false,
12290
12643
  "create": false,
@@ -12307,6 +12660,8 @@
12307
12660
  "ves.io.schema.rules.map.keys.string.min_len": "1",
12308
12661
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
12309
12662
  },
12663
+ "x-f5xc-description-short": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object...",
12664
+ "x-f5xc-description-medium": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object kind e.g. \"virtual_host\".",
12310
12665
  "x-f5xc-required-for": {
12311
12666
  "minimum_config": false,
12312
12667
  "create": false,
@@ -12329,6 +12684,8 @@
12329
12684
  "ves.io.schema.rules.map.keys.string.min_len": "1",
12330
12685
  "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
12331
12686
  },
12687
+ "x-f5xc-description-short": "Resource Limits define maximum value of resources in the appropriate units that can be present.",
12688
+ "x-f5xc-description-medium": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of the resource limits is the resource name.",
12332
12689
  "x-f5xc-required-for": {
12333
12690
  "minimum_config": false,
12334
12691
  "create": false,
@@ -12337,6 +12694,7 @@
12337
12694
  }
12338
12695
  }
12339
12696
  },
12697
+ "x-f5xc-description-short": "GlobalSpecType defines the shape of the object in database as present in Global Controller.",
12340
12698
  "x-f5xc-minimum-configuration": {
12341
12699
  "description": "Minimum configuration for schemaquotaGlobalSpecType",
12342
12700
  "required_fields": [