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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  2. package/dist/tools/generated/ce_management/index.js +179 -1582
  3. package/dist/tools/generated/ce_management/index.js.map +1 -1
  4. package/dist/tools/generated/dependency-graph.json +2 -265
  5. package/dist/version.d.ts +2 -2
  6. package/dist/version.js +2 -2
  7. package/manifest.json +1 -1
  8. package/package.json +1 -1
  9. package/specs/domains/admin_console_and_ui.json +111 -25
  10. package/specs/domains/ai_services.json +114 -35
  11. package/specs/domains/api.json +1082 -177
  12. package/specs/domains/authentication.json +205 -45
  13. package/specs/domains/bigip.json +593 -101
  14. package/specs/domains/billing_and_usage.json +440 -82
  15. package/specs/domains/blindfold.json +713 -110
  16. package/specs/domains/bot_and_threat_defense.json +359 -65
  17. package/specs/domains/cdn.json +2131 -194
  18. package/specs/domains/ce_management.json +9110 -15844
  19. package/specs/domains/certificates.json +362 -75
  20. package/specs/domains/cloud_infrastructure.json +802 -119
  21. package/specs/domains/container_services.json +613 -95
  22. package/specs/domains/data_and_privacy_security.json +364 -66
  23. package/specs/domains/data_intelligence.json +324 -63
  24. package/specs/domains/ddos.json +766 -159
  25. package/specs/domains/dns.json +820 -161
  26. package/specs/domains/managed_kubernetes.json +455 -85
  27. package/specs/domains/marketplace.json +670 -104
  28. package/specs/domains/network.json +1620 -238
  29. package/specs/domains/network_security.json +1401 -191
  30. package/specs/domains/nginx_one.json +326 -62
  31. package/specs/domains/object_storage.json +49 -15
  32. package/specs/domains/observability.json +999 -147
  33. package/specs/domains/rate_limiting.json +300 -55
  34. package/specs/domains/secops_and_incident_response.json +189 -36
  35. package/specs/domains/service_mesh.json +955 -124
  36. package/specs/domains/shape.json +2150 -397
  37. package/specs/domains/sites.json +3830 -364
  38. package/specs/domains/statistics.json +2117 -235
  39. package/specs/domains/support.json +602 -108
  40. package/specs/domains/telemetry_and_insights.json +753 -79
  41. package/specs/domains/tenant_and_identity.json +1874 -308
  42. package/specs/domains/threat_campaign.json +637 -71
  43. package/specs/domains/users.json +278 -66
  44. package/specs/domains/virtual.json +2803 -260
  45. package/specs/domains/vpm_and_node_management.json +3 -1
  46. package/specs/domains/waf.json +1125 -148
  47. package/specs/index.json +24 -24
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Certificates",
5
5
  "description": "X.509 certificate chains with intermediate and root CA support. Trusted CA list bundles for client authentication and mTLS validation. CRL distribution points and OCSP stapling configuration. Certificate manifests link credentials to load balancers and gateways. Automatic expiration tracking and renewal notifications.",
6
- "version": "2.0.13",
6
+ "version": "2.0.19",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -4788,6 +4788,7 @@
4788
4788
  "ves.io.schema.rules.string.hostname_or_ip": "true",
4789
4789
  "ves.io.schema.rules.string.max_len": "255"
4790
4790
  },
4791
+ "x-f5xc-description-short": "CRL server address or hostname Required: YES.",
4791
4792
  "minLength": 0,
4792
4793
  "x-f5xc-required-for": {
4793
4794
  "minimum_config": false,
@@ -4874,6 +4875,7 @@
4874
4875
  "title": "Fail_if_referred.",
4875
4876
  "format": "boolean",
4876
4877
  "x-displayname": "Fail-If-Referred.",
4878
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
4877
4879
  "x-f5xc-required-for": {
4878
4880
  "minimum_config": false,
4879
4881
  "create": false,
@@ -4898,7 +4900,7 @@
4898
4900
  },
4899
4901
  "x-original-maxLength": 1024,
4900
4902
  "x-reconciled-from-discovery": true,
4901
- "x-reconciled-at": "2026-01-05T18:28:53.286167+00:00"
4903
+ "x-reconciled-at": "2026-01-07T15:28:05.070682+00:00"
4902
4904
  },
4903
4905
  "namespace": {
4904
4906
  "type": "string",
@@ -4907,6 +4909,7 @@
4907
4909
  "x-displayname": "Namespace",
4908
4910
  "x-ves-example": "Ns1",
4909
4911
  "x-f5xc-example": "ns1",
4912
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
4910
4913
  "minLength": 0,
4911
4914
  "maxLength": 6,
4912
4915
  "x-f5xc-required-for": {
@@ -4917,7 +4920,7 @@
4917
4920
  },
4918
4921
  "x-original-maxLength": 1024,
4919
4922
  "x-reconciled-from-discovery": true,
4920
- "x-reconciled-at": "2026-01-05T18:28:53.286174+00:00"
4923
+ "x-reconciled-at": "2026-01-07T15:28:05.070689+00:00"
4921
4924
  }
4922
4925
  },
4923
4926
  "x-f5xc-minimum-configuration": {
@@ -4952,6 +4955,7 @@
4952
4955
  "$ref": "#/components/schemas/schemaObjectRefType"
4953
4956
  },
4954
4957
  "x-displayname": "Deleted Referred Objects.",
4958
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
4955
4959
  "x-f5xc-required-for": {
4956
4960
  "minimum_config": false,
4957
4961
  "create": false,
@@ -4967,6 +4971,7 @@
4967
4971
  "$ref": "#/components/schemas/schemaObjectRefType"
4968
4972
  },
4969
4973
  "x-displayname": "Disabled Referred Objects.",
4974
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
4970
4975
  "x-f5xc-required-for": {
4971
4976
  "minimum_config": false,
4972
4977
  "create": false,
@@ -4985,6 +4990,7 @@
4985
4990
  "$ref": "#/components/schemas/schemaObjectRefType"
4986
4991
  },
4987
4992
  "x-displayname": "Referring Objects.",
4993
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
4988
4994
  "x-f5xc-required-for": {
4989
4995
  "minimum_config": false,
4990
4996
  "create": false,
@@ -5006,6 +5012,8 @@
5006
5012
  "$ref": "#/components/schemas/crlStatusObject"
5007
5013
  },
5008
5014
  "x-displayname": "Status",
5015
+ "x-f5xc-example": "active",
5016
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5009
5017
  "x-f5xc-required-for": {
5010
5018
  "minimum_config": false,
5011
5019
  "create": false,
@@ -5015,7 +5023,7 @@
5015
5023
  "maxLength": 17,
5016
5024
  "minLength": 17,
5017
5025
  "x-reconciled-from-discovery": true,
5018
- "x-reconciled-at": "2026-01-05T18:28:53.286190+00:00"
5026
+ "x-reconciled-at": "2026-01-07T15:28:05.070706+00:00"
5019
5027
  },
5020
5028
  "system_metadata": {
5021
5029
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -5055,6 +5063,8 @@
5055
5063
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
5056
5064
  ],
5057
5065
  "default": "GET_RSP_FORMAT_DEFAULT",
5066
+ "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...",
5067
+ "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...",
5058
5068
  "x-f5xc-minimum-configuration": {
5059
5069
  "description": "Minimum configuration for crlGetResponseFormatCode",
5060
5070
  "required_fields": [],
@@ -5118,6 +5128,7 @@
5118
5128
  "ves.io.schema.rules.string.hostname_or_ip": "true",
5119
5129
  "ves.io.schema.rules.string.max_len": "255"
5120
5130
  },
5131
+ "x-f5xc-description-short": "CRL server address or hostname Required: YES.",
5121
5132
  "minLength": 0,
5122
5133
  "x-f5xc-required-for": {
5123
5134
  "minimum_config": false,
@@ -5249,6 +5260,7 @@
5249
5260
  "$ref": "#/components/schemas/schemaErrorType"
5250
5261
  },
5251
5262
  "x-displayname": "Errors",
5263
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
5252
5264
  "x-f5xc-required-for": {
5253
5265
  "minimum_config": false,
5254
5266
  "create": false,
@@ -5264,6 +5276,8 @@
5264
5276
  "$ref": "#/components/schemas/crlListResponseItem"
5265
5277
  },
5266
5278
  "x-displayname": "Items",
5279
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
5280
+ "x-f5xc-description-short": "Items represents the collection in response.",
5267
5281
  "x-f5xc-required-for": {
5268
5282
  "minimum_config": false,
5269
5283
  "create": false,
@@ -5297,6 +5311,8 @@
5297
5311
  "description": "The set of annotations present on this CRL.",
5298
5312
  "title": "Annotations.",
5299
5313
  "x-displayname": "Annotations.",
5314
+ "x-f5xc-example": "{\"key\": \"value\"}",
5315
+ "x-f5xc-description-short": "The set of annotations present on this CRL.",
5300
5316
  "x-f5xc-required-for": {
5301
5317
  "minimum_config": false,
5302
5318
  "create": false,
@@ -5319,7 +5335,7 @@
5319
5335
  },
5320
5336
  "x-original-maxLength": 1024,
5321
5337
  "x-reconciled-from-discovery": true,
5322
- "x-reconciled-at": "2026-01-05T18:28:53.286213+00:00"
5338
+ "x-reconciled-at": "2026-01-07T15:28:05.070728+00:00"
5323
5339
  },
5324
5340
  "disabled": {
5325
5341
  "type": "boolean",
@@ -5327,6 +5343,8 @@
5327
5343
  "title": "Disabled",
5328
5344
  "format": "boolean",
5329
5345
  "x-displayname": "Disabled",
5346
+ "x-f5xc-example": "True",
5347
+ "x-f5xc-description-short": "Value of true indicates CRL is administratively disabled.",
5330
5348
  "x-f5xc-required-for": {
5331
5349
  "minimum_config": false,
5332
5350
  "create": false,
@@ -5342,6 +5360,7 @@
5342
5360
  "description": "The set of labels present on this CRL.",
5343
5361
  "title": "Labels",
5344
5362
  "x-displayname": "Labels",
5363
+ "x-f5xc-example": "{\"key\": \"value\"}",
5345
5364
  "x-f5xc-required-for": {
5346
5365
  "minimum_config": false,
5347
5366
  "create": false,
@@ -5369,7 +5388,7 @@
5369
5388
  },
5370
5389
  "x-original-maxLength": 1024,
5371
5390
  "x-reconciled-from-discovery": true,
5372
- "x-reconciled-at": "2026-01-05T18:28:53.286223+00:00"
5391
+ "x-reconciled-at": "2026-01-07T15:28:05.070739+00:00"
5373
5392
  },
5374
5393
  "namespace": {
5375
5394
  "type": "string",
@@ -5388,7 +5407,7 @@
5388
5407
  },
5389
5408
  "x-original-maxLength": 1024,
5390
5409
  "x-reconciled-from-discovery": true,
5391
- "x-reconciled-at": "2026-01-05T18:28:53.286228+00:00"
5410
+ "x-reconciled-at": "2026-01-07T15:28:05.070744+00:00"
5392
5411
  },
5393
5412
  "owner_view": {
5394
5413
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -5401,6 +5420,7 @@
5401
5420
  "$ref": "#/components/schemas/crlStatusObject"
5402
5421
  },
5403
5422
  "x-displayname": "Status",
5423
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5404
5424
  "x-f5xc-required-for": {
5405
5425
  "minimum_config": false,
5406
5426
  "create": false,
@@ -5429,7 +5449,7 @@
5429
5449
  "x-field-mutability": "read-only",
5430
5450
  "x-original-maxLength": 1024,
5431
5451
  "x-reconciled-from-discovery": true,
5432
- "x-reconciled-at": "2026-01-05T18:28:53.286235+00:00"
5452
+ "x-reconciled-at": "2026-01-07T15:28:05.070752+00:00"
5433
5453
  },
5434
5454
  "uid": {
5435
5455
  "type": "string",
@@ -5450,9 +5470,11 @@
5450
5470
  "x-original-maxLength": 1024,
5451
5471
  "format": "uuid",
5452
5472
  "x-reconciled-from-discovery": true,
5453
- "x-reconciled-at": "2026-01-05T18:28:53.286241+00:00"
5473
+ "x-reconciled-at": "2026-01-07T15:28:05.070757+00:00"
5454
5474
  }
5455
5475
  },
5476
+ "x-f5xc-description-short": "By default a summary of CRL is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
5477
+ "x-f5xc-description-medium": "By default a summary of CRL is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
5456
5478
  "x-f5xc-minimum-configuration": {
5457
5479
  "description": "Minimum configuration for crlListResponseItem",
5458
5480
  "required_fields": [
@@ -5570,6 +5592,7 @@
5570
5592
  "ves.io.schema.rules.string.hostname_or_ip": "true",
5571
5593
  "ves.io.schema.rules.string.max_len": "255"
5572
5594
  },
5595
+ "x-f5xc-description-short": "CRL server address or hostname Required: YES.",
5573
5596
  "minLength": 0,
5574
5597
  "x-f5xc-required-for": {
5575
5598
  "minimum_config": false,
@@ -5684,6 +5707,7 @@
5684
5707
  }
5685
5708
  }
5686
5709
  },
5710
+ "x-f5xc-description-short": "Most recently observed status of object.",
5687
5711
  "x-f5xc-minimum-configuration": {
5688
5712
  "description": "Minimum configuration for crlStatusObject",
5689
5713
  "required_fields": [
@@ -5705,6 +5729,8 @@
5705
5729
  "type_url": {
5706
5730
  "type": "string",
5707
5731
  "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.",
5732
+ "x-f5xc-description-short": "URL identifying the protocol buffer message type.",
5733
+ "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 ).",
5708
5734
  "minLength": 0,
5709
5735
  "maxLength": 1024,
5710
5736
  "x-f5xc-required-for": {
@@ -5728,9 +5754,11 @@
5728
5754
  },
5729
5755
  "x-original-maxLength": 1024,
5730
5756
  "x-reconciled-from-discovery": true,
5731
- "x-reconciled-at": "2026-01-05T18:28:53.286264+00:00"
5757
+ "x-reconciled-at": "2026-01-07T15:28:05.070780+00:00"
5732
5758
  }
5733
5759
  },
5760
+ "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
5761
+ "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...",
5734
5762
  "x-f5xc-minimum-configuration": {
5735
5763
  "description": "Minimum configuration for protobufAny",
5736
5764
  "required_fields": [
@@ -5756,6 +5784,8 @@
5756
5784
  "description": "Hostname of the instance of the site that sent the status.",
5757
5785
  "title": "Hostname",
5758
5786
  "x-displayname": "Hostname",
5787
+ "x-f5xc-example": "example-resource",
5788
+ "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
5759
5789
  "minLength": 0,
5760
5790
  "maxLength": 1024,
5761
5791
  "x-f5xc-required-for": {
@@ -5787,6 +5817,8 @@
5787
5817
  "x-displayname": "Reason",
5788
5818
  "x-ves-example": "Value",
5789
5819
  "x-f5xc-example": "value",
5820
+ "x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
5821
+ "x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
5790
5822
  "minLength": 0,
5791
5823
  "maxLength": 43,
5792
5824
  "x-f5xc-required-for": {
@@ -5797,13 +5829,15 @@
5797
5829
  },
5798
5830
  "x-original-maxLength": 1024,
5799
5831
  "x-reconciled-from-discovery": true,
5800
- "x-reconciled-at": "2026-01-05T18:28:53.286272+00:00"
5832
+ "x-reconciled-at": "2026-01-07T15:28:05.070788+00:00"
5801
5833
  },
5802
5834
  "service_name": {
5803
5835
  "type": "string",
5804
5836
  "description": "Name of the service that sent the status.",
5805
5837
  "title": "Service name.",
5806
5838
  "x-displayname": "Service Name.",
5839
+ "x-f5xc-example": "example-resource",
5840
+ "x-f5xc-description-short": "Name of the service that sent the status.",
5807
5841
  "minLength": 0,
5808
5842
  "maxLength": 1024,
5809
5843
  "x-f5xc-required-for": {
@@ -5826,6 +5860,8 @@
5826
5860
  "x-validation-rules": {
5827
5861
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
5828
5862
  },
5863
+ "x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
5864
+ "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...",
5829
5865
  "minLength": 0,
5830
5866
  "maxLength": 17,
5831
5867
  "x-f5xc-required-for": {
@@ -5836,7 +5872,7 @@
5836
5872
  },
5837
5873
  "x-original-maxLength": 1024,
5838
5874
  "x-reconciled-from-discovery": true,
5839
- "x-reconciled-at": "2026-01-05T18:28:53.286278+00:00"
5875
+ "x-reconciled-at": "2026-01-07T15:28:05.070794+00:00"
5840
5876
  },
5841
5877
  "type": {
5842
5878
  "type": "string",
@@ -5851,6 +5887,8 @@
5851
5887
  "x-validation-rules": {
5852
5888
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
5853
5889
  },
5890
+ "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
5891
+ "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
5854
5892
  "minLength": 0,
5855
5893
  "maxLength": 1024,
5856
5894
  "x-f5xc-required-for": {
@@ -5861,6 +5899,8 @@
5861
5899
  }
5862
5900
  }
5863
5901
  },
5902
+ "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
5903
+ "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
5864
5904
  "x-f5xc-minimum-configuration": {
5865
5905
  "description": "Minimum configuration for schemaConditionType",
5866
5906
  "required_fields": [
@@ -5896,6 +5936,8 @@
5896
5936
  "default": "EOK",
5897
5937
  "x-displayname": "Error Code.",
5898
5938
  "x-ves-proto-enum": "ves.io.schema.ErrorCode",
5939
+ "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...",
5940
+ "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...",
5899
5941
  "x-f5xc-minimum-configuration": {
5900
5942
  "description": "Minimum configuration for schemaErrorCode",
5901
5943
  "required_fields": [],
@@ -5936,6 +5978,7 @@
5936
5978
  }
5937
5979
  }
5938
5980
  },
5981
+ "x-f5xc-description-short": "Information about a error in API operation.",
5939
5982
  "x-f5xc-minimum-configuration": {
5940
5983
  "description": "Minimum configuration for schemaErrorType",
5941
5984
  "required_fields": [
@@ -5963,6 +6006,7 @@
5963
6006
  "title": "Name",
5964
6007
  "x-displayname": "Name",
5965
6008
  "x-f5xc-example": "example-resource",
6009
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
5966
6010
  "minLength": 0,
5967
6011
  "maxLength": 16,
5968
6012
  "x-f5xc-required-for": {
@@ -5973,9 +6017,10 @@
5973
6017
  },
5974
6018
  "x-original-maxLength": 1024,
5975
6019
  "x-reconciled-from-discovery": true,
5976
- "x-reconciled-at": "2026-01-05T18:28:53.286290+00:00"
6020
+ "x-reconciled-at": "2026-01-07T15:28:05.070806+00:00"
5977
6021
  }
5978
6022
  },
6023
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
5979
6024
  "x-f5xc-minimum-configuration": {
5980
6025
  "description": "Minimum configuration for schemaInitializerType",
5981
6026
  "required_fields": [
@@ -6003,6 +6048,8 @@
6003
6048
  "$ref": "#/components/schemas/schemaInitializerType"
6004
6049
  },
6005
6050
  "x-displayname": "Pending",
6051
+ "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
6052
+ "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.",
6006
6053
  "x-f5xc-required-for": {
6007
6054
  "minimum_config": false,
6008
6055
  "create": false,
@@ -6014,6 +6061,7 @@
6014
6061
  "$ref": "#/components/schemas/schemaStatusType"
6015
6062
  }
6016
6063
  },
6064
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
6017
6065
  "x-f5xc-minimum-configuration": {
6018
6066
  "description": "Minimum configuration for schemaInitializersType",
6019
6067
  "required_fields": [
@@ -6052,6 +6100,8 @@
6052
6100
  "ves.io.schema.rules.map.values.string.max_len": "1024",
6053
6101
  "ves.io.schema.rules.map.values.string.min_len": "1"
6054
6102
  },
6103
+ "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.",
6104
+ "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.",
6055
6105
  "x-f5xc-required-for": {
6056
6106
  "minimum_config": false,
6057
6107
  "create": false,
@@ -6073,6 +6123,7 @@
6073
6123
  "x-validation-rules": {
6074
6124
  "ves.io.schema.rules.string.max_bytes": "1200"
6075
6125
  },
6126
+ "x-f5xc-description-short": "Human readable description for the object.",
6076
6127
  "minLength": 0,
6077
6128
  "x-f5xc-required-for": {
6078
6129
  "minimum_config": false,
@@ -6082,7 +6133,7 @@
6082
6133
  },
6083
6134
  "x-original-maxLength": 1200,
6084
6135
  "x-reconciled-from-discovery": true,
6085
- "x-reconciled-at": "2026-01-05T18:28:53.286299+00:00"
6136
+ "x-reconciled-at": "2026-01-07T15:28:05.070816+00:00"
6086
6137
  },
6087
6138
  "disable": {
6088
6139
  "type": "boolean",
@@ -6091,6 +6142,7 @@
6091
6142
  "format": "boolean",
6092
6143
  "x-displayname": "Disable",
6093
6144
  "x-f5xc-example": "true",
6145
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
6094
6146
  "x-f5xc-required-for": {
6095
6147
  "minimum_config": false,
6096
6148
  "create": false,
@@ -6104,6 +6156,8 @@
6104
6156
  "title": "Labels",
6105
6157
  "x-displayname": "Labels",
6106
6158
  "x-f5xc-example": "value",
6159
+ "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.",
6160
+ "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.",
6107
6161
  "x-f5xc-required-for": {
6108
6162
  "minimum_config": false,
6109
6163
  "create": false,
@@ -6125,6 +6179,8 @@
6125
6179
  "x-validation-rules": {
6126
6180
  "ves.io.schema.rules.message.required": "true"
6127
6181
  },
6182
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
6183
+ "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.",
6128
6184
  "minLength": 0,
6129
6185
  "maxLength": 16,
6130
6186
  "x-f5xc-required-for": {
@@ -6135,7 +6191,7 @@
6135
6191
  },
6136
6192
  "x-original-maxLength": 1024,
6137
6193
  "x-reconciled-from-discovery": true,
6138
- "x-reconciled-at": "2026-01-05T18:28:53.286307+00:00"
6194
+ "x-reconciled-at": "2026-01-07T15:28:05.070823+00:00"
6139
6195
  },
6140
6196
  "namespace": {
6141
6197
  "type": "string",
@@ -6144,6 +6200,8 @@
6144
6200
  "x-displayname": "Namespace",
6145
6201
  "x-ves-example": "Staging",
6146
6202
  "x-f5xc-example": "staging",
6203
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
6204
+ "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 \"\".",
6147
6205
  "minLength": 0,
6148
6206
  "maxLength": 6,
6149
6207
  "x-f5xc-required-for": {
@@ -6154,9 +6212,10 @@
6154
6212
  },
6155
6213
  "x-original-maxLength": 1024,
6156
6214
  "x-reconciled-from-discovery": true,
6157
- "x-reconciled-at": "2026-01-05T18:28:53.286311+00:00"
6215
+ "x-reconciled-at": "2026-01-07T15:28:05.070827+00:00"
6158
6216
  }
6159
6217
  },
6218
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
6160
6219
  "x-f5xc-minimum-configuration": {
6161
6220
  "description": "Minimum configuration for schemaObjectCreateMetaType",
6162
6221
  "required_fields": [
@@ -6200,6 +6259,8 @@
6200
6259
  "ves.io.schema.rules.map.values.string.max_len": "1024",
6201
6260
  "ves.io.schema.rules.map.values.string.min_len": "1"
6202
6261
  },
6262
+ "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.",
6263
+ "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.",
6203
6264
  "x-f5xc-required-for": {
6204
6265
  "minimum_config": false,
6205
6266
  "create": false,
@@ -6221,6 +6282,7 @@
6221
6282
  "x-validation-rules": {
6222
6283
  "ves.io.schema.rules.string.max_bytes": "1200"
6223
6284
  },
6285
+ "x-f5xc-description-short": "Human readable description for the object.",
6224
6286
  "minLength": 0,
6225
6287
  "x-f5xc-required-for": {
6226
6288
  "minimum_config": false,
@@ -6230,7 +6292,7 @@
6230
6292
  },
6231
6293
  "x-original-maxLength": 1200,
6232
6294
  "x-reconciled-from-discovery": true,
6233
- "x-reconciled-at": "2026-01-05T18:28:53.286317+00:00"
6295
+ "x-reconciled-at": "2026-01-07T15:28:05.070834+00:00"
6234
6296
  },
6235
6297
  "disable": {
6236
6298
  "type": "boolean",
@@ -6240,6 +6302,7 @@
6240
6302
  "x-displayname": "Disable",
6241
6303
  "x-ves-example": "True",
6242
6304
  "x-f5xc-example": "true",
6305
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
6243
6306
  "x-f5xc-required-for": {
6244
6307
  "minimum_config": false,
6245
6308
  "create": false,
@@ -6254,6 +6317,8 @@
6254
6317
  "x-displayname": "Labels",
6255
6318
  "x-ves-example": "Value",
6256
6319
  "x-f5xc-example": "value",
6320
+ "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.",
6321
+ "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.",
6257
6322
  "x-f5xc-required-for": {
6258
6323
  "minimum_config": false,
6259
6324
  "create": false,
@@ -6275,6 +6340,8 @@
6275
6340
  "x-validation-rules": {
6276
6341
  "ves.io.schema.rules.message.required": "true"
6277
6342
  },
6343
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
6344
+ "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.",
6278
6345
  "minLength": 0,
6279
6346
  "maxLength": 16,
6280
6347
  "x-f5xc-required-for": {
@@ -6285,7 +6352,7 @@
6285
6352
  },
6286
6353
  "x-original-maxLength": 1024,
6287
6354
  "x-reconciled-from-discovery": true,
6288
- "x-reconciled-at": "2026-01-05T18:28:53.286325+00:00"
6355
+ "x-reconciled-at": "2026-01-07T15:28:05.070841+00:00"
6289
6356
  },
6290
6357
  "namespace": {
6291
6358
  "type": "string",
@@ -6294,6 +6361,8 @@
6294
6361
  "x-displayname": "Namespace",
6295
6362
  "x-ves-example": "Staging",
6296
6363
  "x-f5xc-example": "staging",
6364
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
6365
+ "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 \"\".",
6297
6366
  "minLength": 0,
6298
6367
  "maxLength": 6,
6299
6368
  "x-f5xc-required-for": {
@@ -6304,9 +6373,10 @@
6304
6373
  },
6305
6374
  "x-original-maxLength": 1024,
6306
6375
  "x-reconciled-from-discovery": true,
6307
- "x-reconciled-at": "2026-01-05T18:28:53.286329+00:00"
6376
+ "x-reconciled-at": "2026-01-07T15:28:05.070845+00:00"
6308
6377
  }
6309
6378
  },
6379
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
6310
6380
  "x-f5xc-minimum-configuration": {
6311
6381
  "description": "Minimum configuration for schemaObjectGetMetaType",
6312
6382
  "required_fields": [
@@ -6338,6 +6408,8 @@
6338
6408
  "x-displayname": "Kind",
6339
6409
  "x-ves-example": "Virtual_site.",
6340
6410
  "x-f5xc-example": "virtual_site",
6411
+ "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\")",
6412
+ "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\").",
6341
6413
  "minLength": 0,
6342
6414
  "maxLength": 14,
6343
6415
  "x-f5xc-required-for": {
@@ -6349,7 +6421,7 @@
6349
6421
  "readOnly": true,
6350
6422
  "x-original-maxLength": 1024,
6351
6423
  "x-reconciled-from-discovery": true,
6352
- "x-reconciled-at": "2026-01-05T18:28:53.286334+00:00"
6424
+ "x-reconciled-at": "2026-01-07T15:28:05.070849+00:00"
6353
6425
  },
6354
6426
  "name": {
6355
6427
  "type": "string",
@@ -6358,6 +6430,8 @@
6358
6430
  "x-displayname": "Name",
6359
6431
  "x-ves-example": "Contactus-route.",
6360
6432
  "x-f5xc-example": "contactus-route",
6433
+ "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.",
6434
+ "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.",
6361
6435
  "minLength": 0,
6362
6436
  "maxLength": 16,
6363
6437
  "x-f5xc-required-for": {
@@ -6368,7 +6442,7 @@
6368
6442
  },
6369
6443
  "x-original-maxLength": 1024,
6370
6444
  "x-reconciled-from-discovery": true,
6371
- "x-reconciled-at": "2026-01-05T18:28:53.286338+00:00"
6445
+ "x-reconciled-at": "2026-01-07T15:28:05.070853+00:00"
6372
6446
  },
6373
6447
  "namespace": {
6374
6448
  "type": "string",
@@ -6377,6 +6451,8 @@
6377
6451
  "x-displayname": "Namespace",
6378
6452
  "x-ves-example": "Ns1",
6379
6453
  "x-f5xc-example": "ns1",
6454
+ "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.",
6455
+ "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.",
6380
6456
  "minLength": 0,
6381
6457
  "maxLength": 6,
6382
6458
  "x-f5xc-required-for": {
@@ -6387,7 +6463,7 @@
6387
6463
  },
6388
6464
  "x-original-maxLength": 1024,
6389
6465
  "x-reconciled-from-discovery": true,
6390
- "x-reconciled-at": "2026-01-05T18:28:53.286342+00:00"
6466
+ "x-reconciled-at": "2026-01-07T15:28:05.070857+00:00"
6391
6467
  },
6392
6468
  "tenant": {
6393
6469
  "type": "string",
@@ -6396,6 +6472,8 @@
6396
6472
  "x-displayname": "Tenant",
6397
6473
  "x-ves-example": "Example-corp.",
6398
6474
  "x-f5xc-example": "example-corp",
6475
+ "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.",
6476
+ "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.",
6399
6477
  "minLength": 0,
6400
6478
  "maxLength": 18,
6401
6479
  "x-f5xc-required-for": {
@@ -6408,7 +6486,7 @@
6408
6486
  "x-field-mutability": "read-only",
6409
6487
  "x-original-maxLength": 1024,
6410
6488
  "x-reconciled-from-discovery": true,
6411
- "x-reconciled-at": "2026-01-05T18:28:53.286346+00:00"
6489
+ "x-reconciled-at": "2026-01-07T15:28:05.070861+00:00"
6412
6490
  },
6413
6491
  "uid": {
6414
6492
  "type": "string",
@@ -6417,6 +6495,8 @@
6417
6495
  "x-displayname": "UID",
6418
6496
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
6419
6497
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
6498
+ "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.",
6499
+ "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.",
6420
6500
  "minLength": 0,
6421
6501
  "maxLength": 36,
6422
6502
  "x-f5xc-required-for": {
@@ -6430,9 +6510,11 @@
6430
6510
  "x-original-maxLength": 1024,
6431
6511
  "format": "uuid",
6432
6512
  "x-reconciled-from-discovery": true,
6433
- "x-reconciled-at": "2026-01-05T18:28:53.286352+00:00"
6513
+ "x-reconciled-at": "2026-01-07T15:28:05.070866+00:00"
6434
6514
  }
6435
6515
  },
6516
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
6517
+ "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...",
6436
6518
  "x-f5xc-minimum-configuration": {
6437
6519
  "description": "Minimum configuration for schemaObjectRefType",
6438
6520
  "required_fields": [
@@ -6475,6 +6557,8 @@
6475
6557
  "ves.io.schema.rules.map.values.string.max_len": "1024",
6476
6558
  "ves.io.schema.rules.map.values.string.min_len": "1"
6477
6559
  },
6560
+ "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.",
6561
+ "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.",
6478
6562
  "x-f5xc-required-for": {
6479
6563
  "minimum_config": false,
6480
6564
  "create": false,
@@ -6496,6 +6580,7 @@
6496
6580
  "x-validation-rules": {
6497
6581
  "ves.io.schema.rules.string.max_bytes": "1200"
6498
6582
  },
6583
+ "x-f5xc-description-short": "Human readable description for the object.",
6499
6584
  "minLength": 0,
6500
6585
  "x-f5xc-required-for": {
6501
6586
  "minimum_config": false,
@@ -6505,7 +6590,7 @@
6505
6590
  },
6506
6591
  "x-original-maxLength": 1200,
6507
6592
  "x-reconciled-from-discovery": true,
6508
- "x-reconciled-at": "2026-01-05T18:28:53.286359+00:00"
6593
+ "x-reconciled-at": "2026-01-07T15:28:05.070873+00:00"
6509
6594
  },
6510
6595
  "disable": {
6511
6596
  "type": "boolean",
@@ -6514,6 +6599,7 @@
6514
6599
  "format": "boolean",
6515
6600
  "x-displayname": "Disable",
6516
6601
  "x-f5xc-example": "true",
6602
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
6517
6603
  "x-f5xc-required-for": {
6518
6604
  "minimum_config": false,
6519
6605
  "create": false,
@@ -6528,6 +6614,8 @@
6528
6614
  "x-displayname": "Labels",
6529
6615
  "x-ves-example": "Value",
6530
6616
  "x-f5xc-example": "value",
6617
+ "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.",
6618
+ "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.",
6531
6619
  "x-f5xc-required-for": {
6532
6620
  "minimum_config": false,
6533
6621
  "create": false,
@@ -6548,6 +6636,8 @@
6548
6636
  "x-validation-rules": {
6549
6637
  "ves.io.schema.rules.message.required": "true"
6550
6638
  },
6639
+ "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
6640
+ "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.",
6551
6641
  "minLength": 0,
6552
6642
  "maxLength": 16,
6553
6643
  "x-f5xc-required-for": {
@@ -6558,7 +6648,7 @@
6558
6648
  },
6559
6649
  "x-original-maxLength": 1024,
6560
6650
  "x-reconciled-from-discovery": true,
6561
- "x-reconciled-at": "2026-01-05T18:28:53.286366+00:00"
6651
+ "x-reconciled-at": "2026-01-07T15:28:05.070880+00:00"
6562
6652
  },
6563
6653
  "namespace": {
6564
6654
  "type": "string",
@@ -6567,6 +6657,8 @@
6567
6657
  "x-displayname": "Namespace",
6568
6658
  "x-ves-example": "Staging",
6569
6659
  "x-f5xc-example": "staging",
6660
+ "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
6661
+ "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 \"\".",
6570
6662
  "minLength": 0,
6571
6663
  "maxLength": 6,
6572
6664
  "x-f5xc-required-for": {
@@ -6577,9 +6669,10 @@
6577
6669
  },
6578
6670
  "x-original-maxLength": 1024,
6579
6671
  "x-reconciled-from-discovery": true,
6580
- "x-reconciled-at": "2026-01-05T18:28:53.286371+00:00"
6672
+ "x-reconciled-at": "2026-01-07T15:28:05.070884+00:00"
6581
6673
  }
6582
6674
  },
6675
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
6583
6676
  "x-f5xc-minimum-configuration": {
6584
6677
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
6585
6678
  "required_fields": [
@@ -6610,6 +6703,8 @@
6610
6703
  "title": "Creation_timestamp.",
6611
6704
  "format": "date-time",
6612
6705
  "x-displayname": "Creation Timestamp.",
6706
+ "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.",
6707
+ "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.",
6613
6708
  "minLength": 0,
6614
6709
  "maxLength": 1024,
6615
6710
  "x-f5xc-required-for": {
@@ -6627,6 +6722,8 @@
6627
6722
  "x-displayname": "Creator Class.",
6628
6723
  "x-ves-example": "ver.re1.int.ves.I/O.",
6629
6724
  "x-f5xc-example": "ver.re1.int.F5 XC",
6725
+ "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
6726
+ "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.",
6630
6727
  "minLength": 0,
6631
6728
  "maxLength": 1024,
6632
6729
  "x-f5xc-required-for": {
@@ -6644,6 +6741,8 @@
6644
6741
  "x-displayname": "Creator ID.",
6645
6742
  "x-ves-example": "Ver-instance-1.",
6646
6743
  "x-f5xc-example": "ver-instance-1",
6744
+ "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
6745
+ "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.",
6647
6746
  "minLength": 0,
6648
6747
  "maxLength": 1024,
6649
6748
  "x-f5xc-required-for": {
@@ -6662,6 +6761,8 @@
6662
6761
  "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)",
6663
6762
  "title": "Status_id",
6664
6763
  "x-displayname": "Status ID",
6764
+ "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...",
6765
+ "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).",
6665
6766
  "minLength": 0,
6666
6767
  "maxLength": 1024,
6667
6768
  "x-f5xc-required-for": {
@@ -6679,6 +6780,7 @@
6679
6780
  "x-displayname": "UID",
6680
6781
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
6681
6782
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
6783
+ "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
6682
6784
  "minLength": 0,
6683
6785
  "maxLength": 36,
6684
6786
  "x-f5xc-required-for": {
@@ -6691,13 +6793,14 @@
6691
6793
  "x-original-maxLength": 1024,
6692
6794
  "format": "uuid",
6693
6795
  "x-reconciled-from-discovery": true,
6694
- "x-reconciled-at": "2026-01-05T18:28:53.286384+00:00"
6796
+ "x-reconciled-at": "2026-01-07T15:28:05.070896+00:00"
6695
6797
  },
6696
6798
  "vtrp_id": {
6697
6799
  "type": "string",
6698
6800
  "description": "Origin of this status exchanged by VTRP.",
6699
6801
  "title": "Vtrp_id",
6700
6802
  "x-displayname": "VTRP ID",
6803
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
6701
6804
  "minLength": 0,
6702
6805
  "maxLength": 1024,
6703
6806
  "x-f5xc-required-for": {
@@ -6714,6 +6817,7 @@
6714
6817
  "title": "Vtrp_stale.",
6715
6818
  "format": "boolean",
6716
6819
  "x-displayname": "VTRP Stale.",
6820
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
6717
6821
  "x-f5xc-required-for": {
6718
6822
  "minimum_config": false,
6719
6823
  "create": false,
@@ -6722,6 +6826,7 @@
6722
6826
  }
6723
6827
  }
6724
6828
  },
6829
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
6725
6830
  "x-f5xc-minimum-configuration": {
6726
6831
  "description": "Minimum configuration for schemaStatusMetaType",
6727
6832
  "required_fields": [
@@ -6752,6 +6857,8 @@
6752
6857
  "default": "STATUS_DO_NOT_PUBLISH",
6753
6858
  "x-displayname": "Status Publish Type.",
6754
6859
  "x-ves-proto-enum": "ves.io.schema.StatusPublishType",
6860
+ "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.",
6861
+ "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.",
6755
6862
  "x-f5xc-minimum-configuration": {
6756
6863
  "description": "Minimum configuration for schemaStatusPublishType",
6757
6864
  "required_fields": [],
@@ -6777,6 +6884,7 @@
6777
6884
  "x-displayname": "Code",
6778
6885
  "x-ves-example": "0",
6779
6886
  "x-f5xc-example": "0",
6887
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
6780
6888
  "minimum": 0,
6781
6889
  "maximum": 2147483647,
6782
6890
  "x-f5xc-required-for": {
@@ -6793,6 +6901,8 @@
6793
6901
  "x-displayname": "Reason",
6794
6902
  "x-ves-example": "Value",
6795
6903
  "x-f5xc-example": "value",
6904
+ "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.",
6905
+ "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.",
6796
6906
  "minLength": 0,
6797
6907
  "maxLength": 43,
6798
6908
  "x-f5xc-required-for": {
@@ -6803,7 +6913,7 @@
6803
6913
  },
6804
6914
  "x-original-maxLength": 1024,
6805
6915
  "x-reconciled-from-discovery": true,
6806
- "x-reconciled-at": "2026-01-05T18:28:53.286393+00:00"
6916
+ "x-reconciled-at": "2026-01-07T15:28:05.070905+00:00"
6807
6917
  },
6808
6918
  "status": {
6809
6919
  "type": "string",
@@ -6812,6 +6922,7 @@
6812
6922
  "x-displayname": "Status",
6813
6923
  "x-ves-example": "Value",
6814
6924
  "x-f5xc-example": "value",
6925
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
6815
6926
  "minLength": 0,
6816
6927
  "maxLength": 17,
6817
6928
  "x-f5xc-required-for": {
@@ -6822,9 +6933,10 @@
6822
6933
  },
6823
6934
  "x-original-maxLength": 1024,
6824
6935
  "x-reconciled-from-discovery": true,
6825
- "x-reconciled-at": "2026-01-05T18:28:53.286397+00:00"
6936
+ "x-reconciled-at": "2026-01-07T15:28:05.070909+00:00"
6826
6937
  }
6827
6938
  },
6939
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
6828
6940
  "x-f5xc-minimum-configuration": {
6829
6941
  "description": "Minimum configuration for schemaStatusType",
6830
6942
  "required_fields": [
@@ -6852,6 +6964,8 @@
6852
6964
  "title": "Creation_timestamp.",
6853
6965
  "format": "date-time",
6854
6966
  "x-displayname": "Creation Timestamp.",
6967
+ "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
6968
+ "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.",
6855
6969
  "minLength": 0,
6856
6970
  "maxLength": 1024,
6857
6971
  "x-f5xc-required-for": {
@@ -6869,6 +6983,7 @@
6869
6983
  "x-displayname": "Creator Class.",
6870
6984
  "x-ves-example": "Prism",
6871
6985
  "x-f5xc-example": "value",
6986
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
6872
6987
  "minLength": 0,
6873
6988
  "maxLength": 1024,
6874
6989
  "x-f5xc-required-for": {
@@ -6886,6 +7001,7 @@
6886
7001
  "x-displayname": "Creator ID.",
6887
7002
  "x-ves-example": "Admin@example-corp.com.",
6888
7003
  "x-f5xc-example": "value",
7004
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
6889
7005
  "minLength": 0,
6890
7006
  "maxLength": 1024,
6891
7007
  "x-f5xc-required-for": {
@@ -6902,6 +7018,8 @@
6902
7018
  "title": "Deletion_timestamp.",
6903
7019
  "format": "date-time",
6904
7020
  "x-displayname": "Deletion Timestamp.",
7021
+ "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
7022
+ "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...",
6905
7023
  "minLength": 0,
6906
7024
  "maxLength": 1024,
6907
7025
  "x-f5xc-required-for": {
@@ -6921,6 +7039,8 @@
6921
7039
  "x-displayname": "Finalizers.",
6922
7040
  "x-ves-example": "Value",
6923
7041
  "x-f5xc-example": "value",
7042
+ "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
7043
+ "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.",
6924
7044
  "x-f5xc-required-for": {
6925
7045
  "minimum_config": false,
6926
7046
  "create": false,
@@ -6938,6 +7058,8 @@
6938
7058
  "x-displayname": "Labels",
6939
7059
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
6940
7060
  "x-f5xc-example": "'F5 XC/soft-deleted''true'",
7061
+ "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.",
7062
+ "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).",
6941
7063
  "x-f5xc-required-for": {
6942
7064
  "minimum_config": false,
6943
7065
  "create": false,
@@ -6951,6 +7073,8 @@
6951
7073
  "title": "Modification_timestamp.",
6952
7074
  "format": "date-time",
6953
7075
  "x-displayname": "Modification Timestamp.",
7076
+ "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
7077
+ "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
6954
7078
  "minLength": 0,
6955
7079
  "maxLength": 1024,
6956
7080
  "x-f5xc-required-for": {
@@ -6969,6 +7093,8 @@
6969
7093
  "x-displayname": "Object Index.",
6970
7094
  "x-ves-example": "0",
6971
7095
  "x-f5xc-example": "0",
7096
+ "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
7097
+ "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.",
6972
7098
  "minimum": 0,
6973
7099
  "maximum": 2147483647,
6974
7100
  "x-f5xc-required-for": {
@@ -6989,6 +7115,8 @@
6989
7115
  "x-displayname": "Tenant",
6990
7116
  "x-ves-example": "Example-corp.",
6991
7117
  "x-f5xc-example": "example-corp",
7118
+ "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
7119
+ "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
6992
7120
  "minLength": 0,
6993
7121
  "maxLength": 18,
6994
7122
  "x-f5xc-required-for": {
@@ -7000,7 +7128,7 @@
7000
7128
  "x-field-mutability": "read-only",
7001
7129
  "x-original-maxLength": 1024,
7002
7130
  "x-reconciled-from-discovery": true,
7003
- "x-reconciled-at": "2026-01-05T18:28:53.286416+00:00"
7131
+ "x-reconciled-at": "2026-01-07T15:28:05.070928+00:00"
7004
7132
  },
7005
7133
  "uid": {
7006
7134
  "type": "string",
@@ -7009,6 +7137,8 @@
7009
7137
  "x-displayname": "UID",
7010
7138
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
7011
7139
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
7140
+ "x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
7141
+ "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.",
7012
7142
  "minLength": 0,
7013
7143
  "maxLength": 36,
7014
7144
  "x-f5xc-required-for": {
@@ -7021,9 +7151,11 @@
7021
7151
  "x-original-maxLength": 1024,
7022
7152
  "format": "uuid",
7023
7153
  "x-reconciled-from-discovery": true,
7024
- "x-reconciled-at": "2026-01-05T18:28:53.286421+00:00"
7154
+ "x-reconciled-at": "2026-01-07T15:28:05.070932+00:00"
7025
7155
  }
7026
7156
  },
7157
+ "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
7158
+ "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
7027
7159
  "x-f5xc-minimum-configuration": {
7028
7160
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
7029
7161
  "required_fields": [
@@ -7071,7 +7203,7 @@
7071
7203
  },
7072
7204
  "x-original-maxLength": 1024,
7073
7205
  "x-reconciled-from-discovery": true,
7074
- "x-reconciled-at": "2026-01-05T18:28:53.286426+00:00"
7206
+ "x-reconciled-at": "2026-01-07T15:28:05.070937+00:00"
7075
7207
  },
7076
7208
  "name": {
7077
7209
  "type": "string",
@@ -7080,6 +7212,8 @@
7080
7212
  "x-displayname": "Name",
7081
7213
  "x-ves-example": "Contactus-route.",
7082
7214
  "x-f5xc-example": "contactus-route",
7215
+ "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.",
7216
+ "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.",
7083
7217
  "minLength": 0,
7084
7218
  "maxLength": 16,
7085
7219
  "x-f5xc-required-for": {
@@ -7090,7 +7224,7 @@
7090
7224
  },
7091
7225
  "x-original-maxLength": 1024,
7092
7226
  "x-reconciled-from-discovery": true,
7093
- "x-reconciled-at": "2026-01-05T18:28:53.286430+00:00"
7227
+ "x-reconciled-at": "2026-01-07T15:28:05.070941+00:00"
7094
7228
  },
7095
7229
  "namespace": {
7096
7230
  "type": "string",
@@ -7099,6 +7233,8 @@
7099
7233
  "x-displayname": "Namespace",
7100
7234
  "x-ves-example": "Ns1",
7101
7235
  "x-f5xc-example": "ns1",
7236
+ "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.",
7237
+ "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.",
7102
7238
  "minLength": 0,
7103
7239
  "maxLength": 6,
7104
7240
  "x-f5xc-required-for": {
@@ -7109,7 +7245,7 @@
7109
7245
  },
7110
7246
  "x-original-maxLength": 1024,
7111
7247
  "x-reconciled-from-discovery": true,
7112
- "x-reconciled-at": "2026-01-05T18:28:53.286434+00:00"
7248
+ "x-reconciled-at": "2026-01-07T15:28:05.070945+00:00"
7113
7249
  },
7114
7250
  "uid": {
7115
7251
  "type": "string",
@@ -7130,9 +7266,10 @@
7130
7266
  "x-original-maxLength": 1024,
7131
7267
  "format": "uuid",
7132
7268
  "x-reconciled-from-discovery": true,
7133
- "x-reconciled-at": "2026-01-05T18:28:53.286440+00:00"
7269
+ "x-reconciled-at": "2026-01-07T15:28:05.070950+00:00"
7134
7270
  }
7135
7271
  },
7272
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
7136
7273
  "x-f5xc-minimum-configuration": {
7137
7274
  "description": "Minimum configuration for schemaViewRefType",
7138
7275
  "required_fields": [
@@ -7235,6 +7372,8 @@
7235
7372
  "ves.io.schema.rules.string.max_bytes": "131072",
7236
7373
  "ves.io.schema.rules.string.min_bytes": "1"
7237
7374
  },
7375
+ "x-f5xc-description-short": "Certificate. Certificate or certificate chain in PEM format including the PEM headers.",
7376
+ "x-f5xc-description-medium": "Certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
7238
7377
  "x-f5xc-required-for": {
7239
7378
  "minimum_config": false,
7240
7379
  "create": false,
@@ -7285,6 +7424,7 @@
7285
7424
  "title": "Fail_if_referred.",
7286
7425
  "format": "boolean",
7287
7426
  "x-displayname": "Fail-If-Referred.",
7427
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
7288
7428
  "x-f5xc-required-for": {
7289
7429
  "minimum_config": false,
7290
7430
  "create": false,
@@ -7309,7 +7449,7 @@
7309
7449
  },
7310
7450
  "x-original-maxLength": 1024,
7311
7451
  "x-reconciled-from-discovery": true,
7312
- "x-reconciled-at": "2026-01-05T18:28:54.352776+00:00"
7452
+ "x-reconciled-at": "2026-01-07T15:28:06.469581+00:00"
7313
7453
  },
7314
7454
  "namespace": {
7315
7455
  "type": "string",
@@ -7318,6 +7458,7 @@
7318
7458
  "x-displayname": "Namespace",
7319
7459
  "x-ves-example": "Ns1",
7320
7460
  "x-f5xc-example": "ns1",
7461
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
7321
7462
  "minLength": 0,
7322
7463
  "maxLength": 6,
7323
7464
  "x-f5xc-required-for": {
@@ -7328,7 +7469,7 @@
7328
7469
  },
7329
7470
  "x-original-maxLength": 1024,
7330
7471
  "x-reconciled-from-discovery": true,
7331
- "x-reconciled-at": "2026-01-05T18:28:54.352783+00:00"
7472
+ "x-reconciled-at": "2026-01-07T15:28:06.469587+00:00"
7332
7473
  }
7333
7474
  },
7334
7475
  "x-f5xc-minimum-configuration": {
@@ -7363,6 +7504,7 @@
7363
7504
  "$ref": "#/components/schemas/ioschemaObjectRefType"
7364
7505
  },
7365
7506
  "x-displayname": "Deleted Referred Objects.",
7507
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
7366
7508
  "x-f5xc-required-for": {
7367
7509
  "minimum_config": false,
7368
7510
  "create": false,
@@ -7378,6 +7520,7 @@
7378
7520
  "$ref": "#/components/schemas/ioschemaObjectRefType"
7379
7521
  },
7380
7522
  "x-displayname": "Disabled Referred Objects.",
7523
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
7381
7524
  "x-f5xc-required-for": {
7382
7525
  "minimum_config": false,
7383
7526
  "create": false,
@@ -7396,6 +7539,7 @@
7396
7539
  "$ref": "#/components/schemas/ioschemaObjectRefType"
7397
7540
  },
7398
7541
  "x-displayname": "Referring Objects.",
7542
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
7399
7543
  "x-f5xc-required-for": {
7400
7544
  "minimum_config": false,
7401
7545
  "create": false,
@@ -7417,6 +7561,8 @@
7417
7561
  "$ref": "#/components/schemas/certificateStatusObject"
7418
7562
  },
7419
7563
  "x-displayname": "Status",
7564
+ "x-f5xc-example": "active",
7565
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
7420
7566
  "x-f5xc-required-for": {
7421
7567
  "minimum_config": false,
7422
7568
  "create": false,
@@ -7426,7 +7572,7 @@
7426
7572
  "maxLength": 17,
7427
7573
  "minLength": 17,
7428
7574
  "x-reconciled-from-discovery": true,
7429
- "x-reconciled-at": "2026-01-05T18:28:54.352799+00:00"
7575
+ "x-reconciled-at": "2026-01-07T15:28:06.469602+00:00"
7430
7576
  },
7431
7577
  "system_metadata": {
7432
7578
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -7466,6 +7612,8 @@
7466
7612
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
7467
7613
  ],
7468
7614
  "default": "GET_RSP_FORMAT_DEFAULT",
7615
+ "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...",
7616
+ "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...",
7469
7617
  "x-f5xc-minimum-configuration": {
7470
7618
  "description": "Minimum configuration for certificateGetResponseFormatCode",
7471
7619
  "required_fields": [],
@@ -7508,6 +7656,8 @@
7508
7656
  "ves.io.schema.rules.string.max_bytes": "131072",
7509
7657
  "ves.io.schema.rules.string.min_bytes": "1"
7510
7658
  },
7659
+ "x-f5xc-description-short": "Certificate. Certificate or certificate chain in PEM format including the PEM headers.",
7660
+ "x-f5xc-description-medium": "Certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
7511
7661
  "x-f5xc-required-for": {
7512
7662
  "minimum_config": false,
7513
7663
  "create": false,
@@ -7528,6 +7678,7 @@
7528
7678
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
7529
7679
  },
7530
7680
  "x-displayname": "HTTP Loadbalancers.",
7681
+ "x-f5xc-description-short": "HTTP Loadbalancers using this certificate.",
7531
7682
  "x-f5xc-required-for": {
7532
7683
  "minimum_config": false,
7533
7684
  "create": false,
@@ -7559,6 +7710,7 @@
7559
7710
  "$ref": "#/components/schemas/schemaviewsObjectRefType"
7560
7711
  },
7561
7712
  "x-displayname": "TCP Loadbalancers.",
7713
+ "x-f5xc-description-short": "TCP Loadbalancers using this certificate.",
7562
7714
  "x-f5xc-required-for": {
7563
7715
  "minimum_config": false,
7564
7716
  "create": false,
@@ -7605,6 +7757,7 @@
7605
7757
  "$ref": "#/components/schemas/schemaErrorType"
7606
7758
  },
7607
7759
  "x-displayname": "Errors",
7760
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
7608
7761
  "x-f5xc-required-for": {
7609
7762
  "minimum_config": false,
7610
7763
  "create": false,
@@ -7620,6 +7773,8 @@
7620
7773
  "$ref": "#/components/schemas/certificateListResponseItem"
7621
7774
  },
7622
7775
  "x-displayname": "Items",
7776
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
7777
+ "x-f5xc-description-short": "Items represents the collection in response.",
7623
7778
  "x-f5xc-required-for": {
7624
7779
  "minimum_config": false,
7625
7780
  "create": false,
@@ -7653,6 +7808,8 @@
7653
7808
  "description": "The set of annotations present on this certificate.",
7654
7809
  "title": "Annotations.",
7655
7810
  "x-displayname": "Annotations.",
7811
+ "x-f5xc-example": "{\"key\": \"value\"}",
7812
+ "x-f5xc-description-short": "The set of annotations present on this certificate.",
7656
7813
  "x-f5xc-required-for": {
7657
7814
  "minimum_config": false,
7658
7815
  "create": false,
@@ -7665,6 +7822,7 @@
7665
7822
  "description": "The description set for this certificate.",
7666
7823
  "title": "Description.",
7667
7824
  "x-displayname": "Description.",
7825
+ "x-f5xc-description-short": "The description set for this certificate.",
7668
7826
  "minLength": 0,
7669
7827
  "maxLength": 0,
7670
7828
  "x-f5xc-required-for": {
@@ -7675,7 +7833,7 @@
7675
7833
  },
7676
7834
  "x-original-maxLength": 1024,
7677
7835
  "x-reconciled-from-discovery": true,
7678
- "x-reconciled-at": "2026-01-05T18:28:54.352823+00:00"
7836
+ "x-reconciled-at": "2026-01-07T15:28:06.469627+00:00"
7679
7837
  },
7680
7838
  "disabled": {
7681
7839
  "type": "boolean",
@@ -7683,6 +7841,8 @@
7683
7841
  "title": "Disabled",
7684
7842
  "format": "boolean",
7685
7843
  "x-displayname": "Disabled",
7844
+ "x-f5xc-example": "True",
7845
+ "x-f5xc-description-short": "Value of true indicates certificate is administratively disabled.",
7686
7846
  "x-f5xc-required-for": {
7687
7847
  "minimum_config": false,
7688
7848
  "create": false,
@@ -7698,6 +7858,8 @@
7698
7858
  "description": "The set of labels present on this certificate.",
7699
7859
  "title": "Labels",
7700
7860
  "x-displayname": "Labels",
7861
+ "x-f5xc-example": "{\"key\": \"value\"}",
7862
+ "x-f5xc-description-short": "The set of labels present on this certificate.",
7701
7863
  "x-f5xc-required-for": {
7702
7864
  "minimum_config": false,
7703
7865
  "create": false,
@@ -7725,7 +7887,7 @@
7725
7887
  },
7726
7888
  "x-original-maxLength": 1024,
7727
7889
  "x-reconciled-from-discovery": true,
7728
- "x-reconciled-at": "2026-01-05T18:28:54.352834+00:00"
7890
+ "x-reconciled-at": "2026-01-07T15:28:06.469638+00:00"
7729
7891
  },
7730
7892
  "namespace": {
7731
7893
  "type": "string",
@@ -7744,7 +7906,7 @@
7744
7906
  },
7745
7907
  "x-original-maxLength": 1024,
7746
7908
  "x-reconciled-from-discovery": true,
7747
- "x-reconciled-at": "2026-01-05T18:28:54.352838+00:00"
7909
+ "x-reconciled-at": "2026-01-07T15:28:06.469642+00:00"
7748
7910
  },
7749
7911
  "owner_view": {
7750
7912
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -7757,6 +7919,7 @@
7757
7919
  "$ref": "#/components/schemas/certificateStatusObject"
7758
7920
  },
7759
7921
  "x-displayname": "Status",
7922
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
7760
7923
  "x-f5xc-required-for": {
7761
7924
  "minimum_config": false,
7762
7925
  "create": false,
@@ -7785,7 +7948,7 @@
7785
7948
  "x-field-mutability": "read-only",
7786
7949
  "x-original-maxLength": 1024,
7787
7950
  "x-reconciled-from-discovery": true,
7788
- "x-reconciled-at": "2026-01-05T18:28:54.352846+00:00"
7951
+ "x-reconciled-at": "2026-01-07T15:28:06.469650+00:00"
7789
7952
  },
7790
7953
  "uid": {
7791
7954
  "type": "string",
@@ -7806,9 +7969,11 @@
7806
7969
  "x-original-maxLength": 1024,
7807
7970
  "format": "uuid",
7808
7971
  "x-reconciled-from-discovery": true,
7809
- "x-reconciled-at": "2026-01-05T18:28:54.352852+00:00"
7972
+ "x-reconciled-at": "2026-01-07T15:28:06.469656+00:00"
7810
7973
  }
7811
7974
  },
7975
+ "x-f5xc-description-short": "By default a summary of certificate is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
7976
+ "x-f5xc-description-medium": "By default a summary of certificate is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
7812
7977
  "x-f5xc-minimum-configuration": {
7813
7978
  "description": "Minimum configuration for certificateListResponseItem",
7814
7979
  "required_fields": [
@@ -7905,6 +8070,8 @@
7905
8070
  "ves.io.schema.rules.string.max_bytes": "131072",
7906
8071
  "ves.io.schema.rules.string.min_bytes": "1"
7907
8072
  },
8073
+ "x-f5xc-description-short": "Certificate. Certificate or certificate chain in PEM format including the PEM headers.",
8074
+ "x-f5xc-description-medium": "Certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
7908
8075
  "x-f5xc-required-for": {
7909
8076
  "minimum_config": false,
7910
8077
  "create": false,
@@ -7957,6 +8124,7 @@
7957
8124
  "$ref": "#/components/schemas/schemaConditionType"
7958
8125
  },
7959
8126
  "x-displayname": "Conditions.",
8127
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
7960
8128
  "x-f5xc-required-for": {
7961
8129
  "minimum_config": false,
7962
8130
  "create": false,
@@ -7983,6 +8151,7 @@
7983
8151
  }
7984
8152
  }
7985
8153
  },
8154
+ "x-f5xc-description-short": "Most recently observed status of object.",
7986
8155
  "x-f5xc-minimum-configuration": {
7987
8156
  "description": "Minimum configuration for certificateStatusObject",
7988
8157
  "required_fields": [
@@ -8003,6 +8172,7 @@
8003
8172
  "title": "Empty",
8004
8173
  "x-displayname": "Empty",
8005
8174
  "x-ves-proto-message": "ves.io.schema.Empty",
8175
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
8006
8176
  "x-f5xc-minimum-configuration": {
8007
8177
  "description": "Minimum configuration for ioschemaEmpty",
8008
8178
  "required_fields": [],
@@ -8027,6 +8197,8 @@
8027
8197
  "x-displayname": "Kind",
8028
8198
  "x-ves-example": "Virtual_site.",
8029
8199
  "x-f5xc-example": "virtual_site",
8200
+ "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\")",
8201
+ "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\").",
8030
8202
  "minLength": 0,
8031
8203
  "maxLength": 14,
8032
8204
  "x-f5xc-required-for": {
@@ -8038,7 +8210,7 @@
8038
8210
  "readOnly": true,
8039
8211
  "x-original-maxLength": 1024,
8040
8212
  "x-reconciled-from-discovery": true,
8041
- "x-reconciled-at": "2026-01-05T18:28:54.352873+00:00"
8213
+ "x-reconciled-at": "2026-01-07T15:28:06.469677+00:00"
8042
8214
  },
8043
8215
  "name": {
8044
8216
  "type": "string",
@@ -8047,6 +8219,8 @@
8047
8219
  "x-displayname": "Name",
8048
8220
  "x-ves-example": "Contactus-route.",
8049
8221
  "x-f5xc-example": "contactus-route",
8222
+ "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.",
8223
+ "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.",
8050
8224
  "minLength": 0,
8051
8225
  "maxLength": 16,
8052
8226
  "x-f5xc-required-for": {
@@ -8057,7 +8231,7 @@
8057
8231
  },
8058
8232
  "x-original-maxLength": 1024,
8059
8233
  "x-reconciled-from-discovery": true,
8060
- "x-reconciled-at": "2026-01-05T18:28:54.352877+00:00"
8234
+ "x-reconciled-at": "2026-01-07T15:28:06.469682+00:00"
8061
8235
  },
8062
8236
  "namespace": {
8063
8237
  "type": "string",
@@ -8066,6 +8240,8 @@
8066
8240
  "x-displayname": "Namespace",
8067
8241
  "x-ves-example": "Ns1",
8068
8242
  "x-f5xc-example": "ns1",
8243
+ "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.",
8244
+ "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.",
8069
8245
  "minLength": 0,
8070
8246
  "maxLength": 6,
8071
8247
  "x-f5xc-required-for": {
@@ -8076,7 +8252,7 @@
8076
8252
  },
8077
8253
  "x-original-maxLength": 1024,
8078
8254
  "x-reconciled-from-discovery": true,
8079
- "x-reconciled-at": "2026-01-05T18:28:54.352881+00:00"
8255
+ "x-reconciled-at": "2026-01-07T15:28:06.469686+00:00"
8080
8256
  },
8081
8257
  "tenant": {
8082
8258
  "type": "string",
@@ -8085,6 +8261,8 @@
8085
8261
  "x-displayname": "Tenant",
8086
8262
  "x-ves-example": "Example-corp.",
8087
8263
  "x-f5xc-example": "example-corp",
8264
+ "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.",
8265
+ "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.",
8088
8266
  "minLength": 0,
8089
8267
  "maxLength": 18,
8090
8268
  "x-f5xc-required-for": {
@@ -8097,7 +8275,7 @@
8097
8275
  "x-field-mutability": "read-only",
8098
8276
  "x-original-maxLength": 1024,
8099
8277
  "x-reconciled-from-discovery": true,
8100
- "x-reconciled-at": "2026-01-05T18:28:54.352885+00:00"
8278
+ "x-reconciled-at": "2026-01-07T15:28:06.469690+00:00"
8101
8279
  },
8102
8280
  "uid": {
8103
8281
  "type": "string",
@@ -8106,6 +8284,8 @@
8106
8284
  "x-displayname": "UID",
8107
8285
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
8108
8286
  "x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
8287
+ "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.",
8288
+ "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.",
8109
8289
  "minLength": 0,
8110
8290
  "maxLength": 36,
8111
8291
  "x-f5xc-required-for": {
@@ -8119,9 +8299,11 @@
8119
8299
  "x-original-maxLength": 1024,
8120
8300
  "format": "uuid",
8121
8301
  "x-reconciled-from-discovery": true,
8122
- "x-reconciled-at": "2026-01-05T18:28:54.352890+00:00"
8302
+ "x-reconciled-at": "2026-01-07T15:28:06.469695+00:00"
8123
8303
  }
8124
8304
  },
8305
+ "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
8306
+ "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...",
8125
8307
  "x-f5xc-minimum-configuration": {
8126
8308
  "description": "Minimum configuration for ioschemaObjectRefType",
8127
8309
  "required_fields": [
@@ -8153,6 +8335,8 @@
8153
8335
  "x-displayname": "Decryption Provider.",
8154
8336
  "x-ves-example": "Value",
8155
8337
  "x-f5xc-example": "value",
8338
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
8339
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
8156
8340
  "minLength": 0,
8157
8341
  "maxLength": 1024,
8158
8342
  "x-f5xc-required-for": {
@@ -8178,6 +8362,8 @@
8178
8362
  "ves.io.schema.rules.message.required": "true",
8179
8363
  "ves.io.schema.rules.string.uri_ref": "true"
8180
8364
  },
8365
+ "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
8366
+ "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
8181
8367
  "minLength": 0,
8182
8368
  "maxLength": 4,
8183
8369
  "x-f5xc-required-for": {
@@ -8188,7 +8374,7 @@
8188
8374
  },
8189
8375
  "x-original-maxLength": 1024,
8190
8376
  "x-reconciled-from-discovery": true,
8191
- "x-reconciled-at": "2026-01-05T18:28:54.352903+00:00"
8377
+ "x-reconciled-at": "2026-01-07T15:28:06.469710+00:00"
8192
8378
  },
8193
8379
  "store_provider": {
8194
8380
  "type": "string",
@@ -8197,6 +8383,8 @@
8197
8383
  "x-displayname": "Store Provider.",
8198
8384
  "x-ves-example": "Value",
8199
8385
  "x-f5xc-example": "value",
8386
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
8387
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
8200
8388
  "minLength": 0,
8201
8389
  "maxLength": 1024,
8202
8390
  "x-f5xc-required-for": {
@@ -8207,6 +8395,7 @@
8207
8395
  }
8208
8396
  }
8209
8397
  },
8398
+ "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
8210
8399
  "x-f5xc-minimum-configuration": {
8211
8400
  "description": "Minimum configuration for schemaBlindfoldSecretInfoType",
8212
8401
  "required_fields": [
@@ -8233,6 +8422,7 @@
8233
8422
  "description": "Common Name (CN) of this certificate.",
8234
8423
  "title": "Common Name.",
8235
8424
  "x-displayname": "Common Name.",
8425
+ "x-f5xc-example": "example-resource",
8236
8426
  "minLength": 0,
8237
8427
  "maxLength": 1024,
8238
8428
  "x-f5xc-required-for": {
@@ -8290,6 +8480,7 @@
8290
8480
  "description": "Public Key Algorithm of this certificate.",
8291
8481
  "title": "Public Key Algorithm.",
8292
8482
  "x-displayname": "Public Key Algorithm.",
8483
+ "x-f5xc-description-short": "Public Key Algorithm of this certificate.",
8293
8484
  "minLength": 0,
8294
8485
  "maxLength": 1024,
8295
8486
  "x-f5xc-required-for": {
@@ -8307,6 +8498,8 @@
8307
8498
  "type": "string"
8308
8499
  },
8309
8500
  "x-displayname": "SANs",
8501
+ "x-f5xc-example": "example-resource",
8502
+ "x-f5xc-description-short": "Subject Alternative Names of this certificate.",
8310
8503
  "x-f5xc-required-for": {
8311
8504
  "minimum_config": false,
8312
8505
  "create": false,
@@ -8347,6 +8540,8 @@
8347
8540
  "x-displayname": "Provider",
8348
8541
  "x-ves-example": "Box-provider.",
8349
8542
  "x-f5xc-example": "box-provider",
8543
+ "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
8544
+ "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
8350
8545
  "minLength": 0,
8351
8546
  "maxLength": 8,
8352
8547
  "x-f5xc-required-for": {
@@ -8357,7 +8552,7 @@
8357
8552
  },
8358
8553
  "x-original-maxLength": 1024,
8359
8554
  "x-reconciled-from-discovery": true,
8360
- "x-reconciled-at": "2026-01-05T18:28:54.352918+00:00"
8555
+ "x-reconciled-at": "2026-01-07T15:28:06.469725+00:00"
8361
8556
  },
8362
8557
  "url": {
8363
8558
  "type": "string",
@@ -8378,6 +8573,8 @@
8378
8573
  "ves.io.schema.rules.string.max_bytes": "131072",
8379
8574
  "ves.io.schema.rules.string.uri_ref": "true"
8380
8575
  },
8576
+ "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
8577
+ "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
8381
8578
  "format": "uri",
8382
8579
  "minLength": 0,
8383
8580
  "x-f5xc-required-for": {
@@ -8388,6 +8585,7 @@
8388
8585
  }
8389
8586
  }
8390
8587
  },
8588
+ "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
8391
8589
  "x-f5xc-minimum-configuration": {
8392
8590
  "description": "Minimum configuration for schemaClearSecretInfoType",
8393
8591
  "required_fields": [
@@ -8413,6 +8611,8 @@
8413
8611
  "default": "INVALID_HASH_ALGORITHM",
8414
8612
  "x-displayname": "Hash Algorithm.",
8415
8613
  "x-ves-proto-enum": "ves.io.schema.HashAlgorithm",
8614
+ "x-f5xc-description-short": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
8615
+ "x-f5xc-description-medium": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
8416
8616
  "x-f5xc-minimum-configuration": {
8417
8617
  "description": "Minimum configuration for schemaHashAlgorithm",
8418
8618
  "required_fields": [],
@@ -8453,6 +8653,7 @@
8453
8653
  "ves.io.schema.rules.repeated.min_items": "1",
8454
8654
  "ves.io.schema.rules.repeated.unique": "true"
8455
8655
  },
8656
+ "x-f5xc-description-short": "Ordered list of hash algorithms to be used. Required: YES.",
8456
8657
  "x-f5xc-required-for": {
8457
8658
  "minimum_config": false,
8458
8659
  "create": false,
@@ -8461,6 +8662,7 @@
8461
8662
  }
8462
8663
  }
8463
8664
  },
8665
+ "x-f5xc-description-short": "Specifies the hash algorithms to be used.",
8464
8666
  "x-f5xc-minimum-configuration": {
8465
8667
  "description": "Minimum configuration for schemaHashAlgorithms",
8466
8668
  "required_fields": [
@@ -8482,6 +8684,8 @@
8482
8684
  "EncodingBase64"
8483
8685
  ],
8484
8686
  "default": "EncodingNone",
8687
+ "x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
8688
+ "x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
8485
8689
  "x-f5xc-minimum-configuration": {
8486
8690
  "description": "Minimum configuration for schemaSecretEncodingType",
8487
8691
  "required_fields": [],
@@ -8507,6 +8711,7 @@
8507
8711
  "$ref": "#/components/schemas/schemaClearSecretInfoType"
8508
8712
  }
8509
8713
  },
8714
+ "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
8510
8715
  "x-f5xc-minimum-configuration": {
8511
8716
  "description": "Minimum configuration for schemaSecretType",
8512
8717
  "required_fields": [
@@ -8530,6 +8735,8 @@
8530
8735
  "description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
8531
8736
  "title": "Key",
8532
8737
  "x-f5xc-example": "key_pem",
8738
+ "x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
8739
+ "x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
8533
8740
  "minLength": 0,
8534
8741
  "maxLength": 16,
8535
8742
  "x-f5xc-required-for": {
@@ -8540,13 +8747,14 @@
8540
8747
  },
8541
8748
  "x-original-maxLength": 1024,
8542
8749
  "x-reconciled-from-discovery": true,
8543
- "x-reconciled-at": "2026-01-05T18:28:54.353078+00:00"
8750
+ "x-reconciled-at": "2026-01-07T15:28:06.469868+00:00"
8544
8751
  },
8545
8752
  "location": {
8546
8753
  "type": "string",
8547
8754
  "description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
8548
8755
  "title": "Location",
8549
8756
  "x-f5xc-example": "v1/data/vhost_key",
8757
+ "x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
8550
8758
  "minLength": 0,
8551
8759
  "maxLength": 4,
8552
8760
  "x-f5xc-required-for": {
@@ -8557,13 +8765,15 @@
8557
8765
  },
8558
8766
  "x-original-maxLength": 1024,
8559
8767
  "x-reconciled-from-discovery": true,
8560
- "x-reconciled-at": "2026-01-05T18:28:54.353082+00:00"
8768
+ "x-reconciled-at": "2026-01-07T15:28:06.469872+00:00"
8561
8769
  },
8562
8770
  "provider": {
8563
8771
  "type": "string",
8564
8772
  "description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
8565
8773
  "title": "Provider",
8566
8774
  "x-f5xc-example": "vault-vh-provider",
8775
+ "x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
8776
+ "x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
8567
8777
  "minLength": 0,
8568
8778
  "maxLength": 8,
8569
8779
  "x-f5xc-required-for": {
@@ -8574,7 +8784,7 @@
8574
8784
  },
8575
8785
  "x-original-maxLength": 1024,
8576
8786
  "x-reconciled-from-discovery": true,
8577
- "x-reconciled-at": "2026-01-05T18:28:54.353086+00:00"
8787
+ "x-reconciled-at": "2026-01-07T15:28:06.469876+00:00"
8578
8788
  },
8579
8789
  "secret_encoding": {
8580
8790
  "$ref": "#/components/schemas/schemaSecretEncodingType"
@@ -8585,6 +8795,8 @@
8585
8795
  "title": "Version",
8586
8796
  "format": "int64",
8587
8797
  "x-f5xc-example": "1",
8798
+ "x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
8799
+ "x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
8588
8800
  "minimum": 0,
8589
8801
  "maximum": 2147483647,
8590
8802
  "x-f5xc-required-for": {
@@ -8596,9 +8808,11 @@
8596
8808
  "maxLength": 1,
8597
8809
  "minLength": 1,
8598
8810
  "x-reconciled-from-discovery": true,
8599
- "x-reconciled-at": "2026-01-05T18:28:54.353093+00:00"
8811
+ "x-reconciled-at": "2026-01-07T15:28:06.469882+00:00"
8600
8812
  }
8601
8813
  },
8814
+ "x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
8815
+ "x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
8602
8816
  "x-f5xc-minimum-configuration": {
8603
8817
  "description": "Minimum configuration for schemaVaultSecretInfoType",
8604
8818
  "required_fields": [
@@ -8625,6 +8839,7 @@
8625
8839
  "description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
8626
8840
  "title": "Name",
8627
8841
  "x-f5xc-example": "ChargeBack-API-Key",
8842
+ "x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
8628
8843
  "minLength": 0,
8629
8844
  "maxLength": 16,
8630
8845
  "x-f5xc-required-for": {
@@ -8635,9 +8850,10 @@
8635
8850
  },
8636
8851
  "x-original-maxLength": 1024,
8637
8852
  "x-reconciled-from-discovery": true,
8638
- "x-reconciled-at": "2026-01-05T18:28:54.353117+00:00"
8853
+ "x-reconciled-at": "2026-01-07T15:28:06.469905+00:00"
8639
8854
  }
8640
8855
  },
8856
+ "x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
8641
8857
  "x-f5xc-minimum-configuration": {
8642
8858
  "description": "Minimum configuration for schemaWingmanSecretInfoType",
8643
8859
  "required_fields": [
@@ -8677,6 +8893,8 @@
8677
8893
  "ves.io.schema.rules.string.max_bytes": "128",
8678
8894
  "ves.io.schema.rules.string.min_bytes": "1"
8679
8895
  },
8896
+ "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.",
8897
+ "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name. Required: YES.",
8680
8898
  "x-f5xc-required-for": {
8681
8899
  "minimum_config": false,
8682
8900
  "create": false,
@@ -8685,7 +8903,7 @@
8685
8903
  },
8686
8904
  "x-original-maxLength": 128,
8687
8905
  "x-reconciled-from-discovery": true,
8688
- "x-reconciled-at": "2026-01-05T18:28:54.353122+00:00"
8906
+ "x-reconciled-at": "2026-01-07T15:28:06.469910+00:00"
8689
8907
  },
8690
8908
  "namespace": {
8691
8909
  "type": "string",
@@ -8701,6 +8919,8 @@
8701
8919
  "x-validation-rules": {
8702
8920
  "ves.io.schema.rules.string.max_bytes": "64"
8703
8921
  },
8922
+ "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.",
8923
+ "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.",
8704
8924
  "minLength": 0,
8705
8925
  "x-f5xc-required-for": {
8706
8926
  "minimum_config": false,
@@ -8710,7 +8930,7 @@
8710
8930
  },
8711
8931
  "x-original-maxLength": 64,
8712
8932
  "x-reconciled-from-discovery": true,
8713
- "x-reconciled-at": "2026-01-05T18:28:54.353126+00:00"
8933
+ "x-reconciled-at": "2026-01-07T15:28:06.469915+00:00"
8714
8934
  },
8715
8935
  "tenant": {
8716
8936
  "type": "string",
@@ -8726,6 +8946,8 @@
8726
8946
  "x-validation-rules": {
8727
8947
  "ves.io.schema.rules.string.max_bytes": "64"
8728
8948
  },
8949
+ "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.",
8950
+ "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.",
8729
8951
  "minLength": 0,
8730
8952
  "x-f5xc-required-for": {
8731
8953
  "minimum_config": false,
@@ -8737,9 +8959,11 @@
8737
8959
  "x-field-mutability": "read-only",
8738
8960
  "x-original-maxLength": 64,
8739
8961
  "x-reconciled-from-discovery": true,
8740
- "x-reconciled-at": "2026-01-05T18:28:54.353130+00:00"
8962
+ "x-reconciled-at": "2026-01-07T15:28:06.469919+00:00"
8741
8963
  }
8742
8964
  },
8965
+ "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
8966
+ "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.",
8743
8967
  "x-f5xc-minimum-configuration": {
8744
8968
  "description": "Minimum configuration for schemaviewsObjectRefType",
8745
8969
  "required_fields": [
@@ -8837,6 +9061,8 @@
8837
9061
  "ves.io.schema.rules.string.max_bytes": "131072",
8838
9062
  "ves.io.schema.rules.string.min_bytes": "1"
8839
9063
  },
9064
+ "x-f5xc-description-short": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers.",
9065
+ "x-f5xc-description-medium": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers. Required: YES.",
8840
9066
  "x-f5xc-required-for": {
8841
9067
  "minimum_config": false,
8842
9068
  "create": false,
@@ -8845,6 +9071,7 @@
8845
9071
  }
8846
9072
  }
8847
9073
  },
9074
+ "x-f5xc-description-short": "Shape of the Certificate Chain specification.",
8848
9075
  "x-f5xc-minimum-configuration": {
8849
9076
  "description": "Minimum configuration for certificate_chainCreateSpecType",
8850
9077
  "required_fields": [
@@ -8870,6 +9097,7 @@
8870
9097
  "title": "Fail_if_referred.",
8871
9098
  "format": "boolean",
8872
9099
  "x-displayname": "Fail-If-Referred.",
9100
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
8873
9101
  "x-f5xc-required-for": {
8874
9102
  "minimum_config": false,
8875
9103
  "create": false,
@@ -8894,7 +9122,7 @@
8894
9122
  },
8895
9123
  "x-original-maxLength": 1024,
8896
9124
  "x-reconciled-from-discovery": true,
8897
- "x-reconciled-at": "2026-01-05T18:28:54.678462+00:00"
9125
+ "x-reconciled-at": "2026-01-07T15:28:06.882539+00:00"
8898
9126
  },
8899
9127
  "namespace": {
8900
9128
  "type": "string",
@@ -8903,6 +9131,7 @@
8903
9131
  "x-displayname": "Namespace",
8904
9132
  "x-ves-example": "Ns1",
8905
9133
  "x-f5xc-example": "ns1",
9134
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
8906
9135
  "minLength": 0,
8907
9136
  "maxLength": 6,
8908
9137
  "x-f5xc-required-for": {
@@ -8913,7 +9142,7 @@
8913
9142
  },
8914
9143
  "x-original-maxLength": 1024,
8915
9144
  "x-reconciled-from-discovery": true,
8916
- "x-reconciled-at": "2026-01-05T18:28:54.678469+00:00"
9145
+ "x-reconciled-at": "2026-01-07T15:28:06.882546+00:00"
8917
9146
  }
8918
9147
  },
8919
9148
  "x-f5xc-minimum-configuration": {
@@ -8948,6 +9177,7 @@
8948
9177
  "$ref": "#/components/schemas/schemaObjectRefType"
8949
9178
  },
8950
9179
  "x-displayname": "Deleted Referred Objects.",
9180
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
8951
9181
  "x-f5xc-required-for": {
8952
9182
  "minimum_config": false,
8953
9183
  "create": false,
@@ -8963,6 +9193,7 @@
8963
9193
  "$ref": "#/components/schemas/schemaObjectRefType"
8964
9194
  },
8965
9195
  "x-displayname": "Disabled Referred Objects.",
9196
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
8966
9197
  "x-f5xc-required-for": {
8967
9198
  "minimum_config": false,
8968
9199
  "create": false,
@@ -8981,6 +9212,7 @@
8981
9212
  "$ref": "#/components/schemas/schemaObjectRefType"
8982
9213
  },
8983
9214
  "x-displayname": "Referring Objects.",
9215
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
8984
9216
  "x-f5xc-required-for": {
8985
9217
  "minimum_config": false,
8986
9218
  "create": false,
@@ -9002,6 +9234,8 @@
9002
9234
  "$ref": "#/components/schemas/certificate_chainStatusObject"
9003
9235
  },
9004
9236
  "x-displayname": "Status",
9237
+ "x-f5xc-example": "active",
9238
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
9005
9239
  "x-f5xc-required-for": {
9006
9240
  "minimum_config": false,
9007
9241
  "create": false,
@@ -9011,7 +9245,7 @@
9011
9245
  "maxLength": 17,
9012
9246
  "minLength": 17,
9013
9247
  "x-reconciled-from-discovery": true,
9014
- "x-reconciled-at": "2026-01-05T18:28:54.678485+00:00"
9248
+ "x-reconciled-at": "2026-01-07T15:28:06.882562+00:00"
9015
9249
  },
9016
9250
  "system_metadata": {
9017
9251
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -9051,6 +9285,8 @@
9051
9285
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
9052
9286
  ],
9053
9287
  "default": "GET_RSP_FORMAT_DEFAULT",
9288
+ "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...",
9289
+ "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...",
9054
9290
  "x-f5xc-minimum-configuration": {
9055
9291
  "description": "Minimum configuration for certificate_chainGetResponseFormatCode",
9056
9292
  "required_fields": [],
@@ -9089,6 +9325,8 @@
9089
9325
  "ves.io.schema.rules.string.max_bytes": "131072",
9090
9326
  "ves.io.schema.rules.string.min_bytes": "1"
9091
9327
  },
9328
+ "x-f5xc-description-short": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers.",
9329
+ "x-f5xc-description-medium": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers. Required: YES.",
9092
9330
  "x-f5xc-required-for": {
9093
9331
  "minimum_config": false,
9094
9332
  "create": false,
@@ -9111,6 +9349,7 @@
9111
9349
  }
9112
9350
  }
9113
9351
  },
9352
+ "x-f5xc-description-short": "Shape of the Certificate Chain specification.",
9114
9353
  "x-f5xc-minimum-configuration": {
9115
9354
  "description": "Minimum configuration for certificate_chainGetSpecType",
9116
9355
  "required_fields": [
@@ -9139,6 +9378,7 @@
9139
9378
  "$ref": "#/components/schemas/schemaErrorType"
9140
9379
  },
9141
9380
  "x-displayname": "Errors",
9381
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
9142
9382
  "x-f5xc-required-for": {
9143
9383
  "minimum_config": false,
9144
9384
  "create": false,
@@ -9154,6 +9394,8 @@
9154
9394
  "$ref": "#/components/schemas/certificate_chainListResponseItem"
9155
9395
  },
9156
9396
  "x-displayname": "Items",
9397
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
9398
+ "x-f5xc-description-short": "Items represents the collection in response.",
9157
9399
  "x-f5xc-required-for": {
9158
9400
  "minimum_config": false,
9159
9401
  "create": false,
@@ -9187,6 +9429,8 @@
9187
9429
  "description": "The set of annotations present on this certificate_chain.",
9188
9430
  "title": "Annotations.",
9189
9431
  "x-displayname": "Annotations.",
9432
+ "x-f5xc-example": "{\"key\": \"value\"}",
9433
+ "x-f5xc-description-short": "The set of annotations present on this certificate_chain.",
9190
9434
  "x-f5xc-required-for": {
9191
9435
  "minimum_config": false,
9192
9436
  "create": false,
@@ -9199,6 +9443,7 @@
9199
9443
  "description": "The description set for this certificate_chain.",
9200
9444
  "title": "Description.",
9201
9445
  "x-displayname": "Description.",
9446
+ "x-f5xc-description-short": "The description set for this certificate_chain.",
9202
9447
  "minLength": 0,
9203
9448
  "maxLength": 0,
9204
9449
  "x-f5xc-required-for": {
@@ -9209,7 +9454,7 @@
9209
9454
  },
9210
9455
  "x-original-maxLength": 1024,
9211
9456
  "x-reconciled-from-discovery": true,
9212
- "x-reconciled-at": "2026-01-05T18:28:54.678501+00:00"
9457
+ "x-reconciled-at": "2026-01-07T15:28:06.882579+00:00"
9213
9458
  },
9214
9459
  "disabled": {
9215
9460
  "type": "boolean",
@@ -9217,6 +9462,8 @@
9217
9462
  "title": "Disabled",
9218
9463
  "format": "boolean",
9219
9464
  "x-displayname": "Disabled",
9465
+ "x-f5xc-example": "True",
9466
+ "x-f5xc-description-short": "Value of true indicates certificate_chain is administratively disabled.",
9220
9467
  "x-f5xc-required-for": {
9221
9468
  "minimum_config": false,
9222
9469
  "create": false,
@@ -9232,6 +9479,8 @@
9232
9479
  "description": "The set of labels present on this certificate_chain.",
9233
9480
  "title": "Labels",
9234
9481
  "x-displayname": "Labels",
9482
+ "x-f5xc-example": "{\"key\": \"value\"}",
9483
+ "x-f5xc-description-short": "The set of labels present on this certificate_chain.",
9235
9484
  "x-f5xc-required-for": {
9236
9485
  "minimum_config": false,
9237
9486
  "create": false,
@@ -9259,7 +9508,7 @@
9259
9508
  },
9260
9509
  "x-original-maxLength": 1024,
9261
9510
  "x-reconciled-from-discovery": true,
9262
- "x-reconciled-at": "2026-01-05T18:28:54.678511+00:00"
9511
+ "x-reconciled-at": "2026-01-07T15:28:06.882589+00:00"
9263
9512
  },
9264
9513
  "namespace": {
9265
9514
  "type": "string",
@@ -9278,7 +9527,7 @@
9278
9527
  },
9279
9528
  "x-original-maxLength": 1024,
9280
9529
  "x-reconciled-from-discovery": true,
9281
- "x-reconciled-at": "2026-01-05T18:28:54.678516+00:00"
9530
+ "x-reconciled-at": "2026-01-07T15:28:06.882594+00:00"
9282
9531
  },
9283
9532
  "owner_view": {
9284
9533
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -9291,6 +9540,7 @@
9291
9540
  "$ref": "#/components/schemas/certificate_chainStatusObject"
9292
9541
  },
9293
9542
  "x-displayname": "Status",
9543
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
9294
9544
  "x-f5xc-required-for": {
9295
9545
  "minimum_config": false,
9296
9546
  "create": false,
@@ -9319,7 +9569,7 @@
9319
9569
  "x-field-mutability": "read-only",
9320
9570
  "x-original-maxLength": 1024,
9321
9571
  "x-reconciled-from-discovery": true,
9322
- "x-reconciled-at": "2026-01-05T18:28:54.678523+00:00"
9572
+ "x-reconciled-at": "2026-01-07T15:28:06.882602+00:00"
9323
9573
  },
9324
9574
  "uid": {
9325
9575
  "type": "string",
@@ -9328,6 +9578,7 @@
9328
9578
  "x-displayname": "UID",
9329
9579
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
9330
9580
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
9581
+ "x-f5xc-description-short": "The unique uid of this certificate_chain.",
9331
9582
  "minLength": 0,
9332
9583
  "maxLength": 36,
9333
9584
  "x-f5xc-required-for": {
@@ -9340,9 +9591,11 @@
9340
9591
  "x-original-maxLength": 1024,
9341
9592
  "format": "uuid",
9342
9593
  "x-reconciled-from-discovery": true,
9343
- "x-reconciled-at": "2026-01-05T18:28:54.678529+00:00"
9594
+ "x-reconciled-at": "2026-01-07T15:28:06.882608+00:00"
9344
9595
  }
9345
9596
  },
9597
+ "x-f5xc-description-short": "By default a summary of certificate_chain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
9598
+ "x-f5xc-description-medium": "By default a summary of certificate_chain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
9346
9599
  "x-f5xc-minimum-configuration": {
9347
9600
  "description": "Minimum configuration for certificate_chainListResponseItem",
9348
9601
  "required_fields": [
@@ -9413,6 +9666,7 @@
9413
9666
  "title": "Replace Certificate Chain.",
9414
9667
  "x-displayname": "Replace Certificate Chain.",
9415
9668
  "x-ves-proto-message": "ves.io.schema.certificate_chain.ReplaceSpecType",
9669
+ "x-f5xc-description-short": "Shape of the Certificate Chain specification.",
9416
9670
  "x-f5xc-minimum-configuration": {
9417
9671
  "description": "Minimum configuration for certificate_chainReplaceSpecType",
9418
9672
  "required_fields": [],
@@ -9438,6 +9692,7 @@
9438
9692
  "$ref": "#/components/schemas/schemaConditionType"
9439
9693
  },
9440
9694
  "x-displayname": "Conditions.",
9695
+ "x-f5xc-description-short": "Conditions reported by various component of the system.",
9441
9696
  "x-f5xc-required-for": {
9442
9697
  "minimum_config": false,
9443
9698
  "create": false,
@@ -9464,6 +9719,7 @@
9464
9719
  }
9465
9720
  }
9466
9721
  },
9722
+ "x-f5xc-description-short": "Most recently observed status of object.",
9467
9723
  "x-f5xc-minimum-configuration": {
9468
9724
  "description": "Minimum configuration for certificate_chainStatusObject",
9469
9725
  "required_fields": [
@@ -9555,6 +9811,7 @@
9555
9811
  "ves.io.schema.rules.string.max_len": "512000",
9556
9812
  "ves.io.schema.rules.string.truststore_url": "true"
9557
9813
  },
9814
+ "x-f5xc-description-short": "Trusted CA certificates for validating certificates.",
9558
9815
  "minLength": 0,
9559
9816
  "x-f5xc-required-for": {
9560
9817
  "minimum_config": false,
@@ -9564,6 +9821,7 @@
9564
9821
  }
9565
9822
  }
9566
9823
  },
9824
+ "x-f5xc-description-short": "Shape of the Root CA Certificate specification.",
9567
9825
  "x-f5xc-minimum-configuration": {
9568
9826
  "description": "Minimum configuration for trusted_ca_listCreateSpecType",
9569
9827
  "required_fields": [
@@ -9589,6 +9847,7 @@
9589
9847
  "title": "Fail_if_referred.",
9590
9848
  "format": "boolean",
9591
9849
  "x-displayname": "Fail-If-Referred.",
9850
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
9592
9851
  "x-f5xc-required-for": {
9593
9852
  "minimum_config": false,
9594
9853
  "create": false,
@@ -9613,7 +9872,7 @@
9613
9872
  },
9614
9873
  "x-original-maxLength": 1024,
9615
9874
  "x-reconciled-from-discovery": true,
9616
- "x-reconciled-at": "2026-01-05T18:29:47.711173+00:00"
9875
+ "x-reconciled-at": "2026-01-07T15:29:13.450761+00:00"
9617
9876
  },
9618
9877
  "namespace": {
9619
9878
  "type": "string",
@@ -9622,6 +9881,7 @@
9622
9881
  "x-displayname": "Namespace",
9623
9882
  "x-ves-example": "Ns1",
9624
9883
  "x-f5xc-example": "ns1",
9884
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
9625
9885
  "minLength": 0,
9626
9886
  "maxLength": 6,
9627
9887
  "x-f5xc-required-for": {
@@ -9632,7 +9892,7 @@
9632
9892
  },
9633
9893
  "x-original-maxLength": 1024,
9634
9894
  "x-reconciled-from-discovery": true,
9635
- "x-reconciled-at": "2026-01-05T18:29:47.711178+00:00"
9895
+ "x-reconciled-at": "2026-01-07T15:29:13.450765+00:00"
9636
9896
  }
9637
9897
  },
9638
9898
  "x-f5xc-minimum-configuration": {
@@ -9667,6 +9927,7 @@
9667
9927
  "$ref": "#/components/schemas/schemaObjectRefType"
9668
9928
  },
9669
9929
  "x-displayname": "Deleted Referred Objects.",
9930
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
9670
9931
  "x-f5xc-required-for": {
9671
9932
  "minimum_config": false,
9672
9933
  "create": false,
@@ -9682,6 +9943,7 @@
9682
9943
  "$ref": "#/components/schemas/schemaObjectRefType"
9683
9944
  },
9684
9945
  "x-displayname": "Disabled Referred Objects.",
9946
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
9685
9947
  "x-f5xc-required-for": {
9686
9948
  "minimum_config": false,
9687
9949
  "create": false,
@@ -9700,6 +9962,7 @@
9700
9962
  "$ref": "#/components/schemas/schemaObjectRefType"
9701
9963
  },
9702
9964
  "x-displayname": "Referring Objects.",
9965
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
9703
9966
  "x-f5xc-required-for": {
9704
9967
  "minimum_config": false,
9705
9968
  "create": false,
@@ -9721,6 +9984,8 @@
9721
9984
  "$ref": "#/components/schemas/trusted_ca_listStatusObject"
9722
9985
  },
9723
9986
  "x-displayname": "Status",
9987
+ "x-f5xc-example": "active",
9988
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
9724
9989
  "x-f5xc-required-for": {
9725
9990
  "minimum_config": false,
9726
9991
  "create": false,
@@ -9730,7 +9995,7 @@
9730
9995
  "maxLength": 17,
9731
9996
  "minLength": 17,
9732
9997
  "x-reconciled-from-discovery": true,
9733
- "x-reconciled-at": "2026-01-05T18:29:47.711192+00:00"
9998
+ "x-reconciled-at": "2026-01-07T15:29:13.450779+00:00"
9734
9999
  },
9735
10000
  "system_metadata": {
9736
10001
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -9770,6 +10035,8 @@
9770
10035
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
9771
10036
  ],
9772
10037
  "default": "GET_RSP_FORMAT_DEFAULT",
10038
+ "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...",
10039
+ "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...",
9773
10040
  "x-f5xc-minimum-configuration": {
9774
10041
  "description": "Minimum configuration for trusted_ca_listGetResponseFormatCode",
9775
10042
  "required_fields": [],
@@ -9794,6 +10061,7 @@
9794
10061
  "$ref": "#/components/schemas/schemaCertInfoType"
9795
10062
  },
9796
10063
  "x-displayname": "Trusted CA Certificates Information.",
10064
+ "x-f5xc-description-short": "Information about Trusted CA certificates.",
9797
10065
  "x-f5xc-required-for": {
9798
10066
  "minimum_config": false,
9799
10067
  "create": false,
@@ -9816,6 +10084,7 @@
9816
10084
  "ves.io.schema.rules.string.max_len": "512000",
9817
10085
  "ves.io.schema.rules.string.truststore_url": "true"
9818
10086
  },
10087
+ "x-f5xc-description-short": "Trusted CA certificates for validating certificates.",
9819
10088
  "minLength": 0,
9820
10089
  "x-f5xc-required-for": {
9821
10090
  "minimum_config": false,
@@ -9825,6 +10094,7 @@
9825
10094
  }
9826
10095
  }
9827
10096
  },
10097
+ "x-f5xc-description-short": "Shape of the Root CA Certificate specification.",
9828
10098
  "x-f5xc-minimum-configuration": {
9829
10099
  "description": "Minimum configuration for trusted_ca_listGetSpecType",
9830
10100
  "required_fields": [
@@ -9853,6 +10123,7 @@
9853
10123
  "$ref": "#/components/schemas/schemaErrorType"
9854
10124
  },
9855
10125
  "x-displayname": "Errors",
10126
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
9856
10127
  "x-f5xc-required-for": {
9857
10128
  "minimum_config": false,
9858
10129
  "create": false,
@@ -9868,6 +10139,8 @@
9868
10139
  "$ref": "#/components/schemas/trusted_ca_listListResponseItem"
9869
10140
  },
9870
10141
  "x-displayname": "Items",
10142
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
10143
+ "x-f5xc-description-short": "Items represents the collection in response.",
9871
10144
  "x-f5xc-required-for": {
9872
10145
  "minimum_config": false,
9873
10146
  "create": false,
@@ -9901,6 +10174,8 @@
9901
10174
  "description": "The set of annotations present on this trusted_ca_list.",
9902
10175
  "title": "Annotations.",
9903
10176
  "x-displayname": "Annotations.",
10177
+ "x-f5xc-example": "{\"key\": \"value\"}",
10178
+ "x-f5xc-description-short": "The set of annotations present on this trusted_ca_list.",
9904
10179
  "x-f5xc-required-for": {
9905
10180
  "minimum_config": false,
9906
10181
  "create": false,
@@ -9913,6 +10188,7 @@
9913
10188
  "description": "The description set for this trusted_ca_list.",
9914
10189
  "title": "Description.",
9915
10190
  "x-displayname": "Description.",
10191
+ "x-f5xc-description-short": "The description set for this trusted_ca_list.",
9916
10192
  "minLength": 0,
9917
10193
  "maxLength": 0,
9918
10194
  "x-f5xc-required-for": {
@@ -9923,7 +10199,7 @@
9923
10199
  },
9924
10200
  "x-original-maxLength": 1024,
9925
10201
  "x-reconciled-from-discovery": true,
9926
- "x-reconciled-at": "2026-01-05T18:29:47.711207+00:00"
10202
+ "x-reconciled-at": "2026-01-07T15:29:13.450794+00:00"
9927
10203
  },
9928
10204
  "disabled": {
9929
10205
  "type": "boolean",
@@ -9931,6 +10207,8 @@
9931
10207
  "title": "Disabled",
9932
10208
  "format": "boolean",
9933
10209
  "x-displayname": "Disabled",
10210
+ "x-f5xc-example": "True",
10211
+ "x-f5xc-description-short": "Value of true indicates trusted_ca_list is administratively disabled.",
9934
10212
  "x-f5xc-required-for": {
9935
10213
  "minimum_config": false,
9936
10214
  "create": false,
@@ -9946,6 +10224,8 @@
9946
10224
  "description": "The set of labels present on this trusted_ca_list.",
9947
10225
  "title": "Labels",
9948
10226
  "x-displayname": "Labels",
10227
+ "x-f5xc-example": "{\"key\": \"value\"}",
10228
+ "x-f5xc-description-short": "The set of labels present on this trusted_ca_list.",
9949
10229
  "x-f5xc-required-for": {
9950
10230
  "minimum_config": false,
9951
10231
  "create": false,
@@ -9973,7 +10253,7 @@
9973
10253
  },
9974
10254
  "x-original-maxLength": 1024,
9975
10255
  "x-reconciled-from-discovery": true,
9976
- "x-reconciled-at": "2026-01-05T18:29:47.711217+00:00"
10256
+ "x-reconciled-at": "2026-01-07T15:29:13.450803+00:00"
9977
10257
  },
9978
10258
  "namespace": {
9979
10259
  "type": "string",
@@ -9992,7 +10272,7 @@
9992
10272
  },
9993
10273
  "x-original-maxLength": 1024,
9994
10274
  "x-reconciled-from-discovery": true,
9995
- "x-reconciled-at": "2026-01-05T18:29:47.711221+00:00"
10275
+ "x-reconciled-at": "2026-01-07T15:29:13.450808+00:00"
9996
10276
  },
9997
10277
  "owner_view": {
9998
10278
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -10005,6 +10285,7 @@
10005
10285
  "$ref": "#/components/schemas/trusted_ca_listStatusObject"
10006
10286
  },
10007
10287
  "x-displayname": "Status",
10288
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
10008
10289
  "x-f5xc-required-for": {
10009
10290
  "minimum_config": false,
10010
10291
  "create": false,
@@ -10033,7 +10314,7 @@
10033
10314
  "x-field-mutability": "read-only",
10034
10315
  "x-original-maxLength": 1024,
10035
10316
  "x-reconciled-from-discovery": true,
10036
- "x-reconciled-at": "2026-01-05T18:29:47.711229+00:00"
10317
+ "x-reconciled-at": "2026-01-07T15:29:13.450815+00:00"
10037
10318
  },
10038
10319
  "uid": {
10039
10320
  "type": "string",
@@ -10054,9 +10335,11 @@
10054
10335
  "x-original-maxLength": 1024,
10055
10336
  "format": "uuid",
10056
10337
  "x-reconciled-from-discovery": true,
10057
- "x-reconciled-at": "2026-01-05T18:29:47.711234+00:00"
10338
+ "x-reconciled-at": "2026-01-07T15:29:13.450820+00:00"
10058
10339
  }
10059
10340
  },
10341
+ "x-f5xc-description-short": "By default a summary of trusted_ca_list is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
10342
+ "x-f5xc-description-medium": "By default a summary of trusted_ca_list is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
10060
10343
  "x-f5xc-minimum-configuration": {
10061
10344
  "description": "Minimum configuration for trusted_ca_listListResponseItem",
10062
10345
  "required_fields": [
@@ -10143,6 +10426,7 @@
10143
10426
  "ves.io.schema.rules.string.max_len": "512000",
10144
10427
  "ves.io.schema.rules.string.truststore_url": "true"
10145
10428
  },
10429
+ "x-f5xc-description-short": "Trusted CA certificates for validating certificates.",
10146
10430
  "minLength": 0,
10147
10431
  "x-f5xc-required-for": {
10148
10432
  "minimum_config": false,
@@ -10152,6 +10436,7 @@
10152
10436
  }
10153
10437
  }
10154
10438
  },
10439
+ "x-f5xc-description-short": "Shape of the Root CA Certificate specification.",
10155
10440
  "x-f5xc-minimum-configuration": {
10156
10441
  "description": "Minimum configuration for trusted_ca_listReplaceSpecType",
10157
10442
  "required_fields": [
@@ -10179,6 +10464,7 @@
10179
10464
  "$ref": "#/components/schemas/schemaConditionType"
10180
10465
  },
10181
10466
  "x-displayname": "Conditions.",
10467
+ "x-f5xc-description-short": "Conditions reported by various components of the system.",
10182
10468
  "x-f5xc-required-for": {
10183
10469
  "minimum_config": false,
10184
10470
  "create": false,
@@ -10205,6 +10491,7 @@
10205
10491
  }
10206
10492
  }
10207
10493
  },
10494
+ "x-f5xc-description-short": "Most recently observed status of object.",
10208
10495
  "x-f5xc-minimum-configuration": {
10209
10496
  "description": "Minimum configuration for trusted_ca_listStatusObject",
10210
10497
  "required_fields": [