@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.
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +179 -1582
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2 -265
- package/dist/version.d.ts +2 -2
- package/dist/version.js +2 -2
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +111 -25
- package/specs/domains/ai_services.json +114 -35
- package/specs/domains/api.json +1082 -177
- package/specs/domains/authentication.json +205 -45
- package/specs/domains/bigip.json +593 -101
- package/specs/domains/billing_and_usage.json +440 -82
- package/specs/domains/blindfold.json +713 -110
- package/specs/domains/bot_and_threat_defense.json +359 -65
- package/specs/domains/cdn.json +2131 -194
- package/specs/domains/ce_management.json +9110 -15844
- package/specs/domains/certificates.json +362 -75
- package/specs/domains/cloud_infrastructure.json +802 -119
- package/specs/domains/container_services.json +613 -95
- package/specs/domains/data_and_privacy_security.json +364 -66
- package/specs/domains/data_intelligence.json +324 -63
- package/specs/domains/ddos.json +766 -159
- package/specs/domains/dns.json +820 -161
- package/specs/domains/managed_kubernetes.json +455 -85
- package/specs/domains/marketplace.json +670 -104
- package/specs/domains/network.json +1620 -238
- package/specs/domains/network_security.json +1401 -191
- package/specs/domains/nginx_one.json +326 -62
- package/specs/domains/object_storage.json +49 -15
- package/specs/domains/observability.json +999 -147
- package/specs/domains/rate_limiting.json +300 -55
- package/specs/domains/secops_and_incident_response.json +189 -36
- package/specs/domains/service_mesh.json +955 -124
- package/specs/domains/shape.json +2150 -397
- package/specs/domains/sites.json +3830 -364
- package/specs/domains/statistics.json +2117 -235
- package/specs/domains/support.json +602 -108
- package/specs/domains/telemetry_and_insights.json +753 -79
- package/specs/domains/tenant_and_identity.json +1874 -308
- package/specs/domains/threat_campaign.json +637 -71
- package/specs/domains/users.json +278 -66
- package/specs/domains/virtual.json +2803 -260
- package/specs/domains/vpm_and_node_management.json +3 -1
- package/specs/domains/waf.json +1125 -148
- package/specs/index.json +24 -24
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Data Intelligence",
|
|
5
5
|
"description": "F5 Distributed Cloud Data Intelligence API specifications",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.19",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -3562,6 +3562,7 @@
|
|
|
3562
3562
|
"title": "Empty",
|
|
3563
3563
|
"x-displayname": "Empty",
|
|
3564
3564
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
3565
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
3565
3566
|
"x-f5xc-minimum-configuration": {
|
|
3566
3567
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
3567
3568
|
"required_fields": [],
|
|
@@ -3586,6 +3587,8 @@
|
|
|
3586
3587
|
"x-displayname": "Kind",
|
|
3587
3588
|
"x-ves-example": "Virtual_site.",
|
|
3588
3589
|
"x-f5xc-example": "virtual_site",
|
|
3590
|
+
"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\")",
|
|
3591
|
+
"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\").",
|
|
3589
3592
|
"minLength": 0,
|
|
3590
3593
|
"maxLength": 14,
|
|
3591
3594
|
"x-f5xc-required-for": {
|
|
@@ -3597,7 +3600,7 @@
|
|
|
3597
3600
|
"readOnly": true,
|
|
3598
3601
|
"x-original-maxLength": 1024,
|
|
3599
3602
|
"x-reconciled-from-discovery": true,
|
|
3600
|
-
"x-reconciled-at": "2026-01-
|
|
3603
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816610+00:00"
|
|
3601
3604
|
},
|
|
3602
3605
|
"name": {
|
|
3603
3606
|
"type": "string",
|
|
@@ -3606,6 +3609,8 @@
|
|
|
3606
3609
|
"x-displayname": "Name",
|
|
3607
3610
|
"x-ves-example": "Contactus-route.",
|
|
3608
3611
|
"x-f5xc-example": "contactus-route",
|
|
3612
|
+
"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.",
|
|
3613
|
+
"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.",
|
|
3609
3614
|
"minLength": 0,
|
|
3610
3615
|
"maxLength": 16,
|
|
3611
3616
|
"x-f5xc-required-for": {
|
|
@@ -3616,7 +3621,7 @@
|
|
|
3616
3621
|
},
|
|
3617
3622
|
"x-original-maxLength": 1024,
|
|
3618
3623
|
"x-reconciled-from-discovery": true,
|
|
3619
|
-
"x-reconciled-at": "2026-01-
|
|
3624
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816617+00:00"
|
|
3620
3625
|
},
|
|
3621
3626
|
"namespace": {
|
|
3622
3627
|
"type": "string",
|
|
@@ -3625,6 +3630,8 @@
|
|
|
3625
3630
|
"x-displayname": "Namespace",
|
|
3626
3631
|
"x-ves-example": "Ns1",
|
|
3627
3632
|
"x-f5xc-example": "ns1",
|
|
3633
|
+
"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.",
|
|
3634
|
+
"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.",
|
|
3628
3635
|
"minLength": 0,
|
|
3629
3636
|
"maxLength": 6,
|
|
3630
3637
|
"x-f5xc-required-for": {
|
|
@@ -3635,7 +3642,7 @@
|
|
|
3635
3642
|
},
|
|
3636
3643
|
"x-original-maxLength": 1024,
|
|
3637
3644
|
"x-reconciled-from-discovery": true,
|
|
3638
|
-
"x-reconciled-at": "2026-01-
|
|
3645
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816622+00:00"
|
|
3639
3646
|
},
|
|
3640
3647
|
"tenant": {
|
|
3641
3648
|
"type": "string",
|
|
@@ -3644,6 +3651,8 @@
|
|
|
3644
3651
|
"x-displayname": "Tenant",
|
|
3645
3652
|
"x-ves-example": "Example-corp.",
|
|
3646
3653
|
"x-f5xc-example": "example-corp",
|
|
3654
|
+
"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.",
|
|
3655
|
+
"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.",
|
|
3647
3656
|
"minLength": 0,
|
|
3648
3657
|
"maxLength": 18,
|
|
3649
3658
|
"x-f5xc-required-for": {
|
|
@@ -3656,7 +3665,7 @@
|
|
|
3656
3665
|
"x-field-mutability": "read-only",
|
|
3657
3666
|
"x-original-maxLength": 1024,
|
|
3658
3667
|
"x-reconciled-from-discovery": true,
|
|
3659
|
-
"x-reconciled-at": "2026-01-
|
|
3668
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816627+00:00"
|
|
3660
3669
|
},
|
|
3661
3670
|
"uid": {
|
|
3662
3671
|
"type": "string",
|
|
@@ -3665,6 +3674,8 @@
|
|
|
3665
3674
|
"x-displayname": "UID",
|
|
3666
3675
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
3667
3676
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
3677
|
+
"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.",
|
|
3678
|
+
"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.",
|
|
3668
3679
|
"minLength": 0,
|
|
3669
3680
|
"maxLength": 36,
|
|
3670
3681
|
"x-f5xc-required-for": {
|
|
@@ -3678,9 +3689,11 @@
|
|
|
3678
3689
|
"x-original-maxLength": 1024,
|
|
3679
3690
|
"format": "uuid",
|
|
3680
3691
|
"x-reconciled-from-discovery": true,
|
|
3681
|
-
"x-reconciled-at": "2026-01-
|
|
3692
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816633+00:00"
|
|
3682
3693
|
}
|
|
3683
3694
|
},
|
|
3695
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
3696
|
+
"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...",
|
|
3684
3697
|
"x-f5xc-minimum-configuration": {
|
|
3685
3698
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
3686
3699
|
"required_fields": [
|
|
@@ -3704,6 +3717,8 @@
|
|
|
3704
3717
|
"type_url": {
|
|
3705
3718
|
"type": "string",
|
|
3706
3719
|
"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.",
|
|
3720
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
3721
|
+
"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 ).",
|
|
3707
3722
|
"minLength": 0,
|
|
3708
3723
|
"maxLength": 1024,
|
|
3709
3724
|
"x-f5xc-required-for": {
|
|
@@ -3727,9 +3742,11 @@
|
|
|
3727
3742
|
},
|
|
3728
3743
|
"x-original-maxLength": 1024,
|
|
3729
3744
|
"x-reconciled-from-discovery": true,
|
|
3730
|
-
"x-reconciled-at": "2026-01-
|
|
3745
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816640+00:00"
|
|
3731
3746
|
}
|
|
3732
3747
|
},
|
|
3748
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
3749
|
+
"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...",
|
|
3733
3750
|
"x-f5xc-minimum-configuration": {
|
|
3734
3751
|
"description": "Minimum configuration for protobufAny",
|
|
3735
3752
|
"required_fields": [
|
|
@@ -3804,6 +3821,7 @@
|
|
|
3804
3821
|
"ves.io.schema.rules.string.min_len": "3",
|
|
3805
3822
|
"ves.io.schema.rules.string.pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$"
|
|
3806
3823
|
},
|
|
3824
|
+
"x-f5xc-description-short": "Container Name is the name of the container into which logs should be stored Required: YES.",
|
|
3807
3825
|
"x-f5xc-required-for": {
|
|
3808
3826
|
"minimum_config": false,
|
|
3809
3827
|
"create": false,
|
|
@@ -3812,6 +3830,7 @@
|
|
|
3812
3830
|
}
|
|
3813
3831
|
}
|
|
3814
3832
|
},
|
|
3833
|
+
"x-f5xc-description-short": "Azure Blob Configuration for Data Delivery.",
|
|
3815
3834
|
"x-f5xc-minimum-configuration": {
|
|
3816
3835
|
"description": "Minimum configuration for receiverAzureBlobConfig",
|
|
3817
3836
|
"required_fields": [
|
|
@@ -3840,6 +3859,8 @@
|
|
|
3840
3859
|
"description": "X-displayName: \"Event Hubs Instance\"\nx-required\nEvent Hubs Instance name into which logs should be stored.",
|
|
3841
3860
|
"title": "Event Hubs Instance.",
|
|
3842
3861
|
"x-f5xc-example": "logs",
|
|
3862
|
+
"x-f5xc-description-short": "X-displayName: \"Event Hubs Instance\" x-required Event Hubs Instance name into which logs should be stored.",
|
|
3863
|
+
"x-f5xc-description-medium": "X-displayName: \"Event Hubs Instance\" x-required Event Hubs Instance name into which logs should be stored.",
|
|
3843
3864
|
"minLength": 0,
|
|
3844
3865
|
"maxLength": 1024,
|
|
3845
3866
|
"x-f5xc-required-for": {
|
|
@@ -3854,6 +3875,8 @@
|
|
|
3854
3875
|
"description": "X-displayName: \"Event Hubs Namespace\"\nx-required\nEvent Hubs Namespace is namespace with instance into which logs should be stored.",
|
|
3855
3876
|
"title": "Event Hubs Namespace.",
|
|
3856
3877
|
"x-f5xc-example": "example-hub",
|
|
3878
|
+
"x-f5xc-description-short": "X-displayName: \"Event Hubs Namespace\" x-required Event Hubs Namespace is namespace with instance into which logs should be stored.",
|
|
3879
|
+
"x-f5xc-description-medium": "X-displayName: \"Event Hubs Namespace\" x-required Event Hubs Namespace is namespace with instance into which logs should be stored.",
|
|
3857
3880
|
"minLength": 0,
|
|
3858
3881
|
"maxLength": 6,
|
|
3859
3882
|
"x-f5xc-required-for": {
|
|
@@ -3864,9 +3887,10 @@
|
|
|
3864
3887
|
},
|
|
3865
3888
|
"x-original-maxLength": 1024,
|
|
3866
3889
|
"x-reconciled-from-discovery": true,
|
|
3867
|
-
"x-reconciled-at": "2026-01-
|
|
3890
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816656+00:00"
|
|
3868
3891
|
}
|
|
3869
3892
|
},
|
|
3893
|
+
"x-f5xc-description-short": "X-displayName: \"Azure Event Hubs Configuration\" Azure Event Hubs Configuration for Data Delivery.",
|
|
3870
3894
|
"x-f5xc-minimum-configuration": {
|
|
3871
3895
|
"description": "Minimum configuration for receiverAzureEventHubsConfig",
|
|
3872
3896
|
"required_fields": [
|
|
@@ -3910,6 +3934,8 @@
|
|
|
3910
3934
|
"ves.io.schema.rules.uint32.gte": "4096",
|
|
3911
3935
|
"ves.io.schema.rules.uint32.lte": "104857600"
|
|
3912
3936
|
},
|
|
3937
|
+
"x-f5xc-description-short": "Exclusive with [max_bytes_disabled] Send batch to endpoint after the batch is equal to or larger than this many bytes.",
|
|
3938
|
+
"x-f5xc-description-medium": "Exclusive with [max_bytes_disabled] Send batch to endpoint after the batch is equal to or larger than this many bytes.",
|
|
3913
3939
|
"minimum": 0,
|
|
3914
3940
|
"maximum": 2147483647,
|
|
3915
3941
|
"x-f5xc-required-for": {
|
|
@@ -3938,6 +3964,8 @@
|
|
|
3938
3964
|
"ves.io.schema.rules.uint32.gte": "32",
|
|
3939
3965
|
"ves.io.schema.rules.uint32.lte": "100000"
|
|
3940
3966
|
},
|
|
3967
|
+
"x-f5xc-description-short": "Exclusive with [max_events_disabled] Send batch to endpoint after this many log messages are in the batch.",
|
|
3968
|
+
"x-f5xc-description-medium": "Exclusive with [max_events_disabled] Send batch to endpoint after this many log messages are in the batch.",
|
|
3941
3969
|
"minimum": 0,
|
|
3942
3970
|
"maximum": 2147483647,
|
|
3943
3971
|
"x-f5xc-required-for": {
|
|
@@ -3964,6 +3992,7 @@
|
|
|
3964
3992
|
"x-validation-rules": {
|
|
3965
3993
|
"ves.io.schema.rules.uint32.ranges": "300-3600"
|
|
3966
3994
|
},
|
|
3995
|
+
"x-f5xc-description-short": "Exclusive with [default_timeout_seconds] Send batch to the endpoint after this many seconds.",
|
|
3967
3996
|
"minLength": 0,
|
|
3968
3997
|
"maxLength": 1024,
|
|
3969
3998
|
"x-f5xc-required-for": {
|
|
@@ -3974,6 +4003,7 @@
|
|
|
3974
4003
|
}
|
|
3975
4004
|
}
|
|
3976
4005
|
},
|
|
4006
|
+
"x-f5xc-description-short": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
|
|
3977
4007
|
"x-f5xc-minimum-configuration": {
|
|
3978
4008
|
"description": "Minimum configuration for receiverBatchOptionType",
|
|
3979
4009
|
"required_fields": [
|
|
@@ -4168,6 +4198,7 @@
|
|
|
4168
4198
|
"x-displayname": "Datadog Endpoint.",
|
|
4169
4199
|
"x-ves-example": "example.com:9000.",
|
|
4170
4200
|
"x-f5xc-example": "example.com:9000",
|
|
4201
|
+
"x-f5xc-description-short": "Exclusive with [site] Datadog Endpoint,.",
|
|
4171
4202
|
"minLength": 0,
|
|
4172
4203
|
"maxLength": 1024,
|
|
4173
4204
|
"x-f5xc-required-for": {
|
|
@@ -4193,6 +4224,7 @@
|
|
|
4193
4224
|
"x-validation-rules": {
|
|
4194
4225
|
"ves.io.schema.rules.string.hostname_or_ip": "true"
|
|
4195
4226
|
},
|
|
4227
|
+
"x-f5xc-description-short": "Exclusive with [endpoint] Datadog Site,.",
|
|
4196
4228
|
"minLength": 0,
|
|
4197
4229
|
"maxLength": 1024,
|
|
4198
4230
|
"x-f5xc-required-for": {
|
|
@@ -4237,6 +4269,7 @@
|
|
|
4237
4269
|
"title": "Fail_if_referred.",
|
|
4238
4270
|
"format": "boolean",
|
|
4239
4271
|
"x-displayname": "Fail-If-Referred.",
|
|
4272
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
4240
4273
|
"x-f5xc-required-for": {
|
|
4241
4274
|
"minimum_config": false,
|
|
4242
4275
|
"create": false,
|
|
@@ -4261,7 +4294,7 @@
|
|
|
4261
4294
|
},
|
|
4262
4295
|
"x-original-maxLength": 1024,
|
|
4263
4296
|
"x-reconciled-from-discovery": true,
|
|
4264
|
-
"x-reconciled-at": "2026-01-
|
|
4297
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816697+00:00"
|
|
4265
4298
|
},
|
|
4266
4299
|
"namespace": {
|
|
4267
4300
|
"type": "string",
|
|
@@ -4270,6 +4303,7 @@
|
|
|
4270
4303
|
"x-displayname": "Namespace",
|
|
4271
4304
|
"x-ves-example": "Ns1",
|
|
4272
4305
|
"x-f5xc-example": "ns1",
|
|
4306
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
4273
4307
|
"minLength": 0,
|
|
4274
4308
|
"maxLength": 6,
|
|
4275
4309
|
"x-f5xc-required-for": {
|
|
@@ -4280,7 +4314,7 @@
|
|
|
4280
4314
|
},
|
|
4281
4315
|
"x-original-maxLength": 1024,
|
|
4282
4316
|
"x-reconciled-from-discovery": true,
|
|
4283
|
-
"x-reconciled-at": "2026-01-
|
|
4317
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816701+00:00"
|
|
4284
4318
|
}
|
|
4285
4319
|
},
|
|
4286
4320
|
"x-f5xc-minimum-configuration": {
|
|
@@ -4343,6 +4377,7 @@
|
|
|
4343
4377
|
"$ref": "#/components/schemas/schemaviewsObjectRefType"
|
|
4344
4378
|
}
|
|
4345
4379
|
},
|
|
4380
|
+
"x-f5xc-description-short": "GCP Bucket Configuration for Global Log Receiver.",
|
|
4346
4381
|
"x-f5xc-minimum-configuration": {
|
|
4347
4382
|
"description": "Minimum configuration for receiverGCPBucketConfig",
|
|
4348
4383
|
"required_fields": [
|
|
@@ -4376,6 +4411,7 @@
|
|
|
4376
4411
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4377
4412
|
},
|
|
4378
4413
|
"x-displayname": "Deleted Referred Objects.",
|
|
4414
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4379
4415
|
"x-f5xc-required-for": {
|
|
4380
4416
|
"minimum_config": false,
|
|
4381
4417
|
"create": false,
|
|
@@ -4391,6 +4427,7 @@
|
|
|
4391
4427
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4392
4428
|
},
|
|
4393
4429
|
"x-displayname": "Disabled Referred Objects.",
|
|
4430
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4394
4431
|
"x-f5xc-required-for": {
|
|
4395
4432
|
"minimum_config": false,
|
|
4396
4433
|
"create": false,
|
|
@@ -4409,6 +4446,7 @@
|
|
|
4409
4446
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4410
4447
|
},
|
|
4411
4448
|
"x-displayname": "Referring Objects.",
|
|
4449
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
4412
4450
|
"x-f5xc-required-for": {
|
|
4413
4451
|
"minimum_config": false,
|
|
4414
4452
|
"create": false,
|
|
@@ -4430,6 +4468,8 @@
|
|
|
4430
4468
|
"$ref": "#/components/schemas/receiverStatusObject"
|
|
4431
4469
|
},
|
|
4432
4470
|
"x-displayname": "Status",
|
|
4471
|
+
"x-f5xc-example": "active",
|
|
4472
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
4433
4473
|
"x-f5xc-required-for": {
|
|
4434
4474
|
"minimum_config": false,
|
|
4435
4475
|
"create": false,
|
|
@@ -4439,7 +4479,7 @@
|
|
|
4439
4479
|
"maxLength": 17,
|
|
4440
4480
|
"minLength": 17,
|
|
4441
4481
|
"x-reconciled-from-discovery": true,
|
|
4442
|
-
"x-reconciled-at": "2026-01-
|
|
4482
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816720+00:00"
|
|
4443
4483
|
},
|
|
4444
4484
|
"system_metadata": {
|
|
4445
4485
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -4479,6 +4519,8 @@
|
|
|
4479
4519
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
4480
4520
|
],
|
|
4481
4521
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
4522
|
+
"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...",
|
|
4523
|
+
"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...",
|
|
4482
4524
|
"x-f5xc-minimum-configuration": {
|
|
4483
4525
|
"description": "Minimum configuration for receiverGetResponseFormatCode",
|
|
4484
4526
|
"required_fields": [],
|
|
@@ -4542,6 +4584,7 @@
|
|
|
4542
4584
|
"ves.io.schema.rules.message.required": "true",
|
|
4543
4585
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Pending\\\"]"
|
|
4544
4586
|
},
|
|
4587
|
+
"x-f5xc-description-short": "Delivery Status i.e Success/ Failed/ Pending Required: YES.",
|
|
4545
4588
|
"minLength": 0,
|
|
4546
4589
|
"maxLength": 1024,
|
|
4547
4590
|
"x-f5xc-required-for": {
|
|
@@ -4558,6 +4601,7 @@
|
|
|
4558
4601
|
"x-displayname": "Frequency",
|
|
4559
4602
|
"x-ves-example": "300",
|
|
4560
4603
|
"x-f5xc-example": "300",
|
|
4604
|
+
"x-f5xc-description-short": "Deliver logs at this frequency. Default is 5 min (300 seconds)",
|
|
4561
4605
|
"minLength": 0,
|
|
4562
4606
|
"maxLength": 1024,
|
|
4563
4607
|
"x-f5xc-required-for": {
|
|
@@ -4580,6 +4624,7 @@
|
|
|
4580
4624
|
"x-displayname": "Last Sent",
|
|
4581
4625
|
"x-ves-example": "2021-09-21:44:34.171543432Z.",
|
|
4582
4626
|
"x-f5xc-example": "2021-09-21:44:34.171543432Z",
|
|
4627
|
+
"x-f5xc-description-short": "The date when logs were last delivered to the customer.",
|
|
4583
4628
|
"minLength": 0,
|
|
4584
4629
|
"maxLength": 1024,
|
|
4585
4630
|
"x-f5xc-required-for": {
|
|
@@ -4604,6 +4649,7 @@
|
|
|
4604
4649
|
"ves.io.schema.rules.message.required": "true",
|
|
4605
4650
|
"ves.io.schema.rules.string.in": "[\\\"Enabled\\\",\\\"Disabled\\\"]"
|
|
4606
4651
|
},
|
|
4652
|
+
"x-f5xc-description-short": "State of the Receiver i.e Enabled/ Disabled Required: YES.",
|
|
4607
4653
|
"minLength": 0,
|
|
4608
4654
|
"maxLength": 1024,
|
|
4609
4655
|
"x-f5xc-required-for": {
|
|
@@ -4685,6 +4731,7 @@
|
|
|
4685
4731
|
"ves.io.schema.rules.message.required": "true",
|
|
4686
4732
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
4687
4733
|
},
|
|
4734
|
+
"x-f5xc-description-short": "HTTP URI is the URI of the HTTP endpoint to send logs to, Required: YES.",
|
|
4688
4735
|
"minLength": 0,
|
|
4689
4736
|
"maxLength": 1024,
|
|
4690
4737
|
"x-f5xc-required-for": {
|
|
@@ -4750,6 +4797,7 @@
|
|
|
4750
4797
|
}
|
|
4751
4798
|
}
|
|
4752
4799
|
},
|
|
4800
|
+
"x-f5xc-description-short": "Authentication parameters to access HTTP Log Receiver Endpoint.",
|
|
4753
4801
|
"x-f5xc-minimum-configuration": {
|
|
4754
4802
|
"description": "Minimum configuration for receiverHttpAuthBasic",
|
|
4755
4803
|
"required_fields": [
|
|
@@ -4778,6 +4826,7 @@
|
|
|
4778
4826
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
4779
4827
|
},
|
|
4780
4828
|
"x-displayname": "Errors",
|
|
4829
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
4781
4830
|
"x-f5xc-required-for": {
|
|
4782
4831
|
"minimum_config": false,
|
|
4783
4832
|
"create": false,
|
|
@@ -4793,6 +4842,8 @@
|
|
|
4793
4842
|
"$ref": "#/components/schemas/receiverListResponseItem"
|
|
4794
4843
|
},
|
|
4795
4844
|
"x-displayname": "Items",
|
|
4845
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
4846
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
4796
4847
|
"x-f5xc-required-for": {
|
|
4797
4848
|
"minimum_config": false,
|
|
4798
4849
|
"create": false,
|
|
@@ -4826,6 +4877,8 @@
|
|
|
4826
4877
|
"description": "The set of annotations present on this receiver.",
|
|
4827
4878
|
"title": "Annotations.",
|
|
4828
4879
|
"x-displayname": "Annotations.",
|
|
4880
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
4881
|
+
"x-f5xc-description-short": "The set of annotations present on this receiver.",
|
|
4829
4882
|
"x-f5xc-required-for": {
|
|
4830
4883
|
"minimum_config": false,
|
|
4831
4884
|
"create": false,
|
|
@@ -4848,7 +4901,7 @@
|
|
|
4848
4901
|
},
|
|
4849
4902
|
"x-original-maxLength": 1024,
|
|
4850
4903
|
"x-reconciled-from-discovery": true,
|
|
4851
|
-
"x-reconciled-at": "2026-01-
|
|
4904
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816758+00:00"
|
|
4852
4905
|
},
|
|
4853
4906
|
"disabled": {
|
|
4854
4907
|
"type": "boolean",
|
|
@@ -4856,6 +4909,8 @@
|
|
|
4856
4909
|
"title": "Disabled",
|
|
4857
4910
|
"format": "boolean",
|
|
4858
4911
|
"x-displayname": "Disabled",
|
|
4912
|
+
"x-f5xc-example": "True",
|
|
4913
|
+
"x-f5xc-description-short": "Value of true indicates receiver is administratively disabled.",
|
|
4859
4914
|
"x-f5xc-required-for": {
|
|
4860
4915
|
"minimum_config": false,
|
|
4861
4916
|
"create": false,
|
|
@@ -4871,6 +4926,8 @@
|
|
|
4871
4926
|
"description": "The set of labels present on this receiver.",
|
|
4872
4927
|
"title": "Labels",
|
|
4873
4928
|
"x-displayname": "Labels",
|
|
4929
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
4930
|
+
"x-f5xc-description-short": "The set of labels present on this receiver.",
|
|
4874
4931
|
"x-f5xc-required-for": {
|
|
4875
4932
|
"minimum_config": false,
|
|
4876
4933
|
"create": false,
|
|
@@ -4898,7 +4955,7 @@
|
|
|
4898
4955
|
},
|
|
4899
4956
|
"x-original-maxLength": 1024,
|
|
4900
4957
|
"x-reconciled-from-discovery": true,
|
|
4901
|
-
"x-reconciled-at": "2026-01-
|
|
4958
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816768+00:00"
|
|
4902
4959
|
},
|
|
4903
4960
|
"namespace": {
|
|
4904
4961
|
"type": "string",
|
|
@@ -4917,7 +4974,7 @@
|
|
|
4917
4974
|
},
|
|
4918
4975
|
"x-original-maxLength": 1024,
|
|
4919
4976
|
"x-reconciled-from-discovery": true,
|
|
4920
|
-
"x-reconciled-at": "2026-01-
|
|
4977
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816772+00:00"
|
|
4921
4978
|
},
|
|
4922
4979
|
"owner_view": {
|
|
4923
4980
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -4930,6 +4987,7 @@
|
|
|
4930
4987
|
"$ref": "#/components/schemas/receiverStatusObject"
|
|
4931
4988
|
},
|
|
4932
4989
|
"x-displayname": "Status",
|
|
4990
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
4933
4991
|
"x-f5xc-required-for": {
|
|
4934
4992
|
"minimum_config": false,
|
|
4935
4993
|
"create": false,
|
|
@@ -4958,7 +5016,7 @@
|
|
|
4958
5016
|
"x-field-mutability": "read-only",
|
|
4959
5017
|
"x-original-maxLength": 1024,
|
|
4960
5018
|
"x-reconciled-from-discovery": true,
|
|
4961
|
-
"x-reconciled-at": "2026-01-
|
|
5019
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816779+00:00"
|
|
4962
5020
|
},
|
|
4963
5021
|
"uid": {
|
|
4964
5022
|
"type": "string",
|
|
@@ -4979,9 +5037,11 @@
|
|
|
4979
5037
|
"x-original-maxLength": 1024,
|
|
4980
5038
|
"format": "uuid",
|
|
4981
5039
|
"x-reconciled-from-discovery": true,
|
|
4982
|
-
"x-reconciled-at": "2026-01-
|
|
5040
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816785+00:00"
|
|
4983
5041
|
}
|
|
4984
5042
|
},
|
|
5043
|
+
"x-f5xc-description-short": "By default a summary of receiver is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
5044
|
+
"x-f5xc-description-medium": "By default a summary of receiver is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
4985
5045
|
"x-f5xc-minimum-configuration": {
|
|
4986
5046
|
"description": "Minimum configuration for receiverListResponseItem",
|
|
4987
5047
|
"required_fields": [
|
|
@@ -5097,6 +5157,7 @@
|
|
|
5097
5157
|
"$ref": "#/components/schemas/receiverSplunkConfig"
|
|
5098
5158
|
}
|
|
5099
5159
|
},
|
|
5160
|
+
"x-f5xc-description-short": "Replaces the content of an Data Delivery object.",
|
|
5100
5161
|
"x-f5xc-minimum-configuration": {
|
|
5101
5162
|
"description": "Minimum configuration for receiverReplaceSpecType",
|
|
5102
5163
|
"required_fields": [
|
|
@@ -5230,6 +5291,7 @@
|
|
|
5230
5291
|
"x-validation-rules": {
|
|
5231
5292
|
"ves.io.schema.rules.message.required": "true"
|
|
5232
5293
|
},
|
|
5294
|
+
"x-f5xc-description-short": "Splunk HEC Logs Endpoint, Required: YES.",
|
|
5233
5295
|
"minLength": 0,
|
|
5234
5296
|
"maxLength": 1024,
|
|
5235
5297
|
"x-f5xc-required-for": {
|
|
@@ -5249,6 +5311,7 @@
|
|
|
5249
5311
|
"$ref": "#/components/schemas/receiverTLSConfigType"
|
|
5250
5312
|
}
|
|
5251
5313
|
},
|
|
5314
|
+
"x-f5xc-description-short": "Configuration for Splunk HEC Logs endpoint.",
|
|
5252
5315
|
"x-f5xc-minimum-configuration": {
|
|
5253
5316
|
"description": "Minimum configuration for receiverSplunkConfig",
|
|
5254
5317
|
"required_fields": [
|
|
@@ -5307,6 +5370,7 @@
|
|
|
5307
5370
|
}
|
|
5308
5371
|
}
|
|
5309
5372
|
},
|
|
5373
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
5310
5374
|
"x-f5xc-minimum-configuration": {
|
|
5311
5375
|
"description": "Minimum configuration for receiverStatusObject",
|
|
5312
5376
|
"required_fields": [
|
|
@@ -5343,6 +5407,7 @@
|
|
|
5343
5407
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
5344
5408
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
5345
5409
|
},
|
|
5410
|
+
"x-f5xc-description-short": "Client certificate is PEM-encoded certificate or certificate-chain.",
|
|
5346
5411
|
"minLength": 0,
|
|
5347
5412
|
"x-f5xc-required-for": {
|
|
5348
5413
|
"minimum_config": false,
|
|
@@ -5355,6 +5420,7 @@
|
|
|
5355
5420
|
"$ref": "#/components/schemas/schemaSecretType"
|
|
5356
5421
|
}
|
|
5357
5422
|
},
|
|
5423
|
+
"x-f5xc-description-short": "MTLS Client config allows configuration of mTLS client OPTIONS.",
|
|
5358
5424
|
"x-f5xc-minimum-configuration": {
|
|
5359
5425
|
"description": "Minimum configuration for receiverTLSClientConfigType",
|
|
5360
5426
|
"required_fields": [
|
|
@@ -5414,6 +5480,8 @@
|
|
|
5414
5480
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
5415
5481
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
5416
5482
|
},
|
|
5483
|
+
"x-f5xc-description-short": "Exclusive with [no_ca] The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers.",
|
|
5484
|
+
"x-f5xc-description-medium": "Exclusive with [no_ca] The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers.",
|
|
5417
5485
|
"minLength": 0,
|
|
5418
5486
|
"x-f5xc-required-for": {
|
|
5419
5487
|
"minimum_config": false,
|
|
@@ -5423,6 +5491,7 @@
|
|
|
5423
5491
|
}
|
|
5424
5492
|
}
|
|
5425
5493
|
},
|
|
5494
|
+
"x-f5xc-description-short": "TLS Parameters for client connection to the endpoint.",
|
|
5426
5495
|
"x-f5xc-minimum-configuration": {
|
|
5427
5496
|
"description": "Minimum configuration for receiverTLSConfigType",
|
|
5428
5497
|
"required_fields": [
|
|
@@ -5457,6 +5526,8 @@
|
|
|
5457
5526
|
"x-displayname": "Decryption Provider.",
|
|
5458
5527
|
"x-ves-example": "Value",
|
|
5459
5528
|
"x-f5xc-example": "value",
|
|
5529
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
5530
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
5460
5531
|
"minLength": 0,
|
|
5461
5532
|
"maxLength": 1024,
|
|
5462
5533
|
"x-f5xc-required-for": {
|
|
@@ -5482,6 +5553,8 @@
|
|
|
5482
5553
|
"ves.io.schema.rules.message.required": "true",
|
|
5483
5554
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
5484
5555
|
},
|
|
5556
|
+
"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.",
|
|
5557
|
+
"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.",
|
|
5485
5558
|
"minLength": 0,
|
|
5486
5559
|
"maxLength": 4,
|
|
5487
5560
|
"x-f5xc-required-for": {
|
|
@@ -5492,7 +5565,7 @@
|
|
|
5492
5565
|
},
|
|
5493
5566
|
"x-original-maxLength": 1024,
|
|
5494
5567
|
"x-reconciled-from-discovery": true,
|
|
5495
|
-
"x-reconciled-at": "2026-01-
|
|
5568
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816832+00:00"
|
|
5496
5569
|
},
|
|
5497
5570
|
"store_provider": {
|
|
5498
5571
|
"type": "string",
|
|
@@ -5501,6 +5574,8 @@
|
|
|
5501
5574
|
"x-displayname": "Store Provider.",
|
|
5502
5575
|
"x-ves-example": "Value",
|
|
5503
5576
|
"x-f5xc-example": "value",
|
|
5577
|
+
"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...",
|
|
5578
|
+
"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:///.",
|
|
5504
5579
|
"minLength": 0,
|
|
5505
5580
|
"maxLength": 1024,
|
|
5506
5581
|
"x-f5xc-required-for": {
|
|
@@ -5511,6 +5586,7 @@
|
|
|
5511
5586
|
}
|
|
5512
5587
|
}
|
|
5513
5588
|
},
|
|
5589
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
5514
5590
|
"x-f5xc-minimum-configuration": {
|
|
5515
5591
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
5516
5592
|
"required_fields": [
|
|
@@ -5540,6 +5616,8 @@
|
|
|
5540
5616
|
"x-displayname": "Provider",
|
|
5541
5617
|
"x-ves-example": "Box-provider.",
|
|
5542
5618
|
"x-f5xc-example": "box-provider",
|
|
5619
|
+
"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...",
|
|
5620
|
+
"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:///.",
|
|
5543
5621
|
"minLength": 0,
|
|
5544
5622
|
"maxLength": 8,
|
|
5545
5623
|
"x-f5xc-required-for": {
|
|
@@ -5550,7 +5628,7 @@
|
|
|
5550
5628
|
},
|
|
5551
5629
|
"x-original-maxLength": 1024,
|
|
5552
5630
|
"x-reconciled-from-discovery": true,
|
|
5553
|
-
"x-reconciled-at": "2026-01-
|
|
5631
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816838+00:00"
|
|
5554
5632
|
},
|
|
5555
5633
|
"url": {
|
|
5556
5634
|
"type": "string",
|
|
@@ -5571,6 +5649,8 @@
|
|
|
5571
5649
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
5572
5650
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
5573
5651
|
},
|
|
5652
|
+
"x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
|
|
5653
|
+
"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.",
|
|
5574
5654
|
"format": "uri",
|
|
5575
5655
|
"minLength": 0,
|
|
5576
5656
|
"x-f5xc-required-for": {
|
|
@@ -5581,6 +5661,7 @@
|
|
|
5581
5661
|
}
|
|
5582
5662
|
}
|
|
5583
5663
|
},
|
|
5664
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
5584
5665
|
"x-f5xc-minimum-configuration": {
|
|
5585
5666
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
5586
5667
|
"required_fields": [
|
|
@@ -5606,6 +5687,8 @@
|
|
|
5606
5687
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
5607
5688
|
"title": "Hostname",
|
|
5608
5689
|
"x-displayname": "Hostname",
|
|
5690
|
+
"x-f5xc-example": "example-resource",
|
|
5691
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
5609
5692
|
"minLength": 0,
|
|
5610
5693
|
"maxLength": 1024,
|
|
5611
5694
|
"x-f5xc-required-for": {
|
|
@@ -5637,6 +5720,8 @@
|
|
|
5637
5720
|
"x-displayname": "Reason",
|
|
5638
5721
|
"x-ves-example": "Value",
|
|
5639
5722
|
"x-f5xc-example": "value",
|
|
5723
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
5724
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
5640
5725
|
"minLength": 0,
|
|
5641
5726
|
"maxLength": 43,
|
|
5642
5727
|
"x-f5xc-required-for": {
|
|
@@ -5647,13 +5732,15 @@
|
|
|
5647
5732
|
},
|
|
5648
5733
|
"x-original-maxLength": 1024,
|
|
5649
5734
|
"x-reconciled-from-discovery": true,
|
|
5650
|
-
"x-reconciled-at": "2026-01-
|
|
5735
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816847+00:00"
|
|
5651
5736
|
},
|
|
5652
5737
|
"service_name": {
|
|
5653
5738
|
"type": "string",
|
|
5654
5739
|
"description": "Name of the service that sent the status.",
|
|
5655
5740
|
"title": "Service name.",
|
|
5656
5741
|
"x-displayname": "Service Name.",
|
|
5742
|
+
"x-f5xc-example": "example-resource",
|
|
5743
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
5657
5744
|
"minLength": 0,
|
|
5658
5745
|
"maxLength": 1024,
|
|
5659
5746
|
"x-f5xc-required-for": {
|
|
@@ -5676,6 +5763,8 @@
|
|
|
5676
5763
|
"x-validation-rules": {
|
|
5677
5764
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
5678
5765
|
},
|
|
5766
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
5767
|
+
"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...",
|
|
5679
5768
|
"minLength": 0,
|
|
5680
5769
|
"maxLength": 17,
|
|
5681
5770
|
"x-f5xc-required-for": {
|
|
@@ -5686,7 +5775,7 @@
|
|
|
5686
5775
|
},
|
|
5687
5776
|
"x-original-maxLength": 1024,
|
|
5688
5777
|
"x-reconciled-from-discovery": true,
|
|
5689
|
-
"x-reconciled-at": "2026-01-
|
|
5778
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816853+00:00"
|
|
5690
5779
|
},
|
|
5691
5780
|
"type": {
|
|
5692
5781
|
"type": "string",
|
|
@@ -5701,6 +5790,8 @@
|
|
|
5701
5790
|
"x-validation-rules": {
|
|
5702
5791
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
5703
5792
|
},
|
|
5793
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
5794
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
5704
5795
|
"minLength": 0,
|
|
5705
5796
|
"maxLength": 1024,
|
|
5706
5797
|
"x-f5xc-required-for": {
|
|
@@ -5711,6 +5802,8 @@
|
|
|
5711
5802
|
}
|
|
5712
5803
|
}
|
|
5713
5804
|
},
|
|
5805
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
5806
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
5714
5807
|
"x-f5xc-minimum-configuration": {
|
|
5715
5808
|
"description": "Minimum configuration for schemaConditionType",
|
|
5716
5809
|
"required_fields": [
|
|
@@ -5746,6 +5839,8 @@
|
|
|
5746
5839
|
"default": "EOK",
|
|
5747
5840
|
"x-displayname": "Error Code.",
|
|
5748
5841
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
5842
|
+
"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...",
|
|
5843
|
+
"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...",
|
|
5749
5844
|
"x-f5xc-minimum-configuration": {
|
|
5750
5845
|
"description": "Minimum configuration for schemaErrorCode",
|
|
5751
5846
|
"required_fields": [],
|
|
@@ -5786,6 +5881,7 @@
|
|
|
5786
5881
|
}
|
|
5787
5882
|
}
|
|
5788
5883
|
},
|
|
5884
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
5789
5885
|
"x-f5xc-minimum-configuration": {
|
|
5790
5886
|
"description": "Minimum configuration for schemaErrorType",
|
|
5791
5887
|
"required_fields": [
|
|
@@ -5813,6 +5909,7 @@
|
|
|
5813
5909
|
"title": "Name",
|
|
5814
5910
|
"x-displayname": "Name",
|
|
5815
5911
|
"x-f5xc-example": "example-resource",
|
|
5912
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
5816
5913
|
"minLength": 0,
|
|
5817
5914
|
"maxLength": 16,
|
|
5818
5915
|
"x-f5xc-required-for": {
|
|
@@ -5823,9 +5920,10 @@
|
|
|
5823
5920
|
},
|
|
5824
5921
|
"x-original-maxLength": 1024,
|
|
5825
5922
|
"x-reconciled-from-discovery": true,
|
|
5826
|
-
"x-reconciled-at": "2026-01-
|
|
5923
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816863+00:00"
|
|
5827
5924
|
}
|
|
5828
5925
|
},
|
|
5926
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
5829
5927
|
"x-f5xc-minimum-configuration": {
|
|
5830
5928
|
"description": "Minimum configuration for schemaInitializerType",
|
|
5831
5929
|
"required_fields": [
|
|
@@ -5853,6 +5951,8 @@
|
|
|
5853
5951
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
5854
5952
|
},
|
|
5855
5953
|
"x-displayname": "Pending",
|
|
5954
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
5955
|
+
"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.",
|
|
5856
5956
|
"x-f5xc-required-for": {
|
|
5857
5957
|
"minimum_config": false,
|
|
5858
5958
|
"create": false,
|
|
@@ -5864,6 +5964,7 @@
|
|
|
5864
5964
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
5865
5965
|
}
|
|
5866
5966
|
},
|
|
5967
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
5867
5968
|
"x-f5xc-minimum-configuration": {
|
|
5868
5969
|
"description": "Minimum configuration for schemaInitializersType",
|
|
5869
5970
|
"required_fields": [
|
|
@@ -5902,6 +6003,8 @@
|
|
|
5902
6003
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
5903
6004
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
5904
6005
|
},
|
|
6006
|
+
"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.",
|
|
6007
|
+
"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.",
|
|
5905
6008
|
"x-f5xc-required-for": {
|
|
5906
6009
|
"minimum_config": false,
|
|
5907
6010
|
"create": false,
|
|
@@ -5923,6 +6026,7 @@
|
|
|
5923
6026
|
"x-validation-rules": {
|
|
5924
6027
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
5925
6028
|
},
|
|
6029
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
5926
6030
|
"minLength": 0,
|
|
5927
6031
|
"x-f5xc-required-for": {
|
|
5928
6032
|
"minimum_config": false,
|
|
@@ -5932,7 +6036,7 @@
|
|
|
5932
6036
|
},
|
|
5933
6037
|
"x-original-maxLength": 1200,
|
|
5934
6038
|
"x-reconciled-from-discovery": true,
|
|
5935
|
-
"x-reconciled-at": "2026-01-
|
|
6039
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816873+00:00"
|
|
5936
6040
|
},
|
|
5937
6041
|
"disable": {
|
|
5938
6042
|
"type": "boolean",
|
|
@@ -5941,6 +6045,7 @@
|
|
|
5941
6045
|
"format": "boolean",
|
|
5942
6046
|
"x-displayname": "Disable",
|
|
5943
6047
|
"x-f5xc-example": "true",
|
|
6048
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
5944
6049
|
"x-f5xc-required-for": {
|
|
5945
6050
|
"minimum_config": false,
|
|
5946
6051
|
"create": false,
|
|
@@ -5954,6 +6059,8 @@
|
|
|
5954
6059
|
"title": "Labels",
|
|
5955
6060
|
"x-displayname": "Labels",
|
|
5956
6061
|
"x-f5xc-example": "value",
|
|
6062
|
+
"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.",
|
|
6063
|
+
"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.",
|
|
5957
6064
|
"x-f5xc-required-for": {
|
|
5958
6065
|
"minimum_config": false,
|
|
5959
6066
|
"create": false,
|
|
@@ -5975,6 +6082,8 @@
|
|
|
5975
6082
|
"x-validation-rules": {
|
|
5976
6083
|
"ves.io.schema.rules.message.required": "true"
|
|
5977
6084
|
},
|
|
6085
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6086
|
+
"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.",
|
|
5978
6087
|
"minLength": 0,
|
|
5979
6088
|
"maxLength": 16,
|
|
5980
6089
|
"x-f5xc-required-for": {
|
|
@@ -5985,7 +6094,7 @@
|
|
|
5985
6094
|
},
|
|
5986
6095
|
"x-original-maxLength": 1024,
|
|
5987
6096
|
"x-reconciled-from-discovery": true,
|
|
5988
|
-
"x-reconciled-at": "2026-01-
|
|
6097
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816880+00:00"
|
|
5989
6098
|
},
|
|
5990
6099
|
"namespace": {
|
|
5991
6100
|
"type": "string",
|
|
@@ -5994,6 +6103,8 @@
|
|
|
5994
6103
|
"x-displayname": "Namespace",
|
|
5995
6104
|
"x-ves-example": "Staging",
|
|
5996
6105
|
"x-f5xc-example": "staging",
|
|
6106
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6107
|
+
"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 \"\".",
|
|
5997
6108
|
"minLength": 0,
|
|
5998
6109
|
"maxLength": 6,
|
|
5999
6110
|
"x-f5xc-required-for": {
|
|
@@ -6004,9 +6115,10 @@
|
|
|
6004
6115
|
},
|
|
6005
6116
|
"x-original-maxLength": 1024,
|
|
6006
6117
|
"x-reconciled-from-discovery": true,
|
|
6007
|
-
"x-reconciled-at": "2026-01-
|
|
6118
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816884+00:00"
|
|
6008
6119
|
}
|
|
6009
6120
|
},
|
|
6121
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
6010
6122
|
"x-f5xc-minimum-configuration": {
|
|
6011
6123
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
6012
6124
|
"required_fields": [
|
|
@@ -6050,6 +6162,8 @@
|
|
|
6050
6162
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6051
6163
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6052
6164
|
},
|
|
6165
|
+
"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.",
|
|
6166
|
+
"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.",
|
|
6053
6167
|
"x-f5xc-required-for": {
|
|
6054
6168
|
"minimum_config": false,
|
|
6055
6169
|
"create": false,
|
|
@@ -6071,6 +6185,7 @@
|
|
|
6071
6185
|
"x-validation-rules": {
|
|
6072
6186
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6073
6187
|
},
|
|
6188
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
6074
6189
|
"minLength": 0,
|
|
6075
6190
|
"x-f5xc-required-for": {
|
|
6076
6191
|
"minimum_config": false,
|
|
@@ -6080,7 +6195,7 @@
|
|
|
6080
6195
|
},
|
|
6081
6196
|
"x-original-maxLength": 1200,
|
|
6082
6197
|
"x-reconciled-from-discovery": true,
|
|
6083
|
-
"x-reconciled-at": "2026-01-
|
|
6198
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816891+00:00"
|
|
6084
6199
|
},
|
|
6085
6200
|
"disable": {
|
|
6086
6201
|
"type": "boolean",
|
|
@@ -6090,6 +6205,7 @@
|
|
|
6090
6205
|
"x-displayname": "Disable",
|
|
6091
6206
|
"x-ves-example": "True",
|
|
6092
6207
|
"x-f5xc-example": "true",
|
|
6208
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
6093
6209
|
"x-f5xc-required-for": {
|
|
6094
6210
|
"minimum_config": false,
|
|
6095
6211
|
"create": false,
|
|
@@ -6104,6 +6220,8 @@
|
|
|
6104
6220
|
"x-displayname": "Labels",
|
|
6105
6221
|
"x-ves-example": "Value",
|
|
6106
6222
|
"x-f5xc-example": "value",
|
|
6223
|
+
"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.",
|
|
6224
|
+
"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
6225
|
"x-f5xc-required-for": {
|
|
6108
6226
|
"minimum_config": false,
|
|
6109
6227
|
"create": false,
|
|
@@ -6125,6 +6243,8 @@
|
|
|
6125
6243
|
"x-validation-rules": {
|
|
6126
6244
|
"ves.io.schema.rules.message.required": "true"
|
|
6127
6245
|
},
|
|
6246
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6247
|
+
"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
6248
|
"minLength": 0,
|
|
6129
6249
|
"maxLength": 16,
|
|
6130
6250
|
"x-f5xc-required-for": {
|
|
@@ -6135,7 +6255,7 @@
|
|
|
6135
6255
|
},
|
|
6136
6256
|
"x-original-maxLength": 1024,
|
|
6137
6257
|
"x-reconciled-from-discovery": true,
|
|
6138
|
-
"x-reconciled-at": "2026-01-
|
|
6258
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816898+00:00"
|
|
6139
6259
|
},
|
|
6140
6260
|
"namespace": {
|
|
6141
6261
|
"type": "string",
|
|
@@ -6144,6 +6264,8 @@
|
|
|
6144
6264
|
"x-displayname": "Namespace",
|
|
6145
6265
|
"x-ves-example": "Staging",
|
|
6146
6266
|
"x-f5xc-example": "staging",
|
|
6267
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6268
|
+
"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
6269
|
"minLength": 0,
|
|
6148
6270
|
"maxLength": 6,
|
|
6149
6271
|
"x-f5xc-required-for": {
|
|
@@ -6154,9 +6276,10 @@
|
|
|
6154
6276
|
},
|
|
6155
6277
|
"x-original-maxLength": 1024,
|
|
6156
6278
|
"x-reconciled-from-discovery": true,
|
|
6157
|
-
"x-reconciled-at": "2026-01-
|
|
6279
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816902+00:00"
|
|
6158
6280
|
}
|
|
6159
6281
|
},
|
|
6282
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
6160
6283
|
"x-f5xc-minimum-configuration": {
|
|
6161
6284
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
6162
6285
|
"required_fields": [
|
|
@@ -6200,6 +6323,8 @@
|
|
|
6200
6323
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6201
6324
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6202
6325
|
},
|
|
6326
|
+
"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.",
|
|
6327
|
+
"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
6328
|
"x-f5xc-required-for": {
|
|
6204
6329
|
"minimum_config": false,
|
|
6205
6330
|
"create": false,
|
|
@@ -6221,6 +6346,7 @@
|
|
|
6221
6346
|
"x-validation-rules": {
|
|
6222
6347
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6223
6348
|
},
|
|
6349
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
6224
6350
|
"minLength": 0,
|
|
6225
6351
|
"x-f5xc-required-for": {
|
|
6226
6352
|
"minimum_config": false,
|
|
@@ -6230,7 +6356,7 @@
|
|
|
6230
6356
|
},
|
|
6231
6357
|
"x-original-maxLength": 1200,
|
|
6232
6358
|
"x-reconciled-from-discovery": true,
|
|
6233
|
-
"x-reconciled-at": "2026-01-
|
|
6359
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816908+00:00"
|
|
6234
6360
|
},
|
|
6235
6361
|
"disable": {
|
|
6236
6362
|
"type": "boolean",
|
|
@@ -6239,6 +6365,7 @@
|
|
|
6239
6365
|
"format": "boolean",
|
|
6240
6366
|
"x-displayname": "Disable",
|
|
6241
6367
|
"x-f5xc-example": "true",
|
|
6368
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
6242
6369
|
"x-f5xc-required-for": {
|
|
6243
6370
|
"minimum_config": false,
|
|
6244
6371
|
"create": false,
|
|
@@ -6253,6 +6380,8 @@
|
|
|
6253
6380
|
"x-displayname": "Labels",
|
|
6254
6381
|
"x-ves-example": "Value",
|
|
6255
6382
|
"x-f5xc-example": "value",
|
|
6383
|
+
"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.",
|
|
6384
|
+
"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.",
|
|
6256
6385
|
"x-f5xc-required-for": {
|
|
6257
6386
|
"minimum_config": false,
|
|
6258
6387
|
"create": false,
|
|
@@ -6273,6 +6402,8 @@
|
|
|
6273
6402
|
"x-validation-rules": {
|
|
6274
6403
|
"ves.io.schema.rules.message.required": "true"
|
|
6275
6404
|
},
|
|
6405
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6406
|
+
"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.",
|
|
6276
6407
|
"minLength": 0,
|
|
6277
6408
|
"maxLength": 16,
|
|
6278
6409
|
"x-f5xc-required-for": {
|
|
@@ -6283,7 +6414,7 @@
|
|
|
6283
6414
|
},
|
|
6284
6415
|
"x-original-maxLength": 1024,
|
|
6285
6416
|
"x-reconciled-from-discovery": true,
|
|
6286
|
-
"x-reconciled-at": "2026-01-
|
|
6417
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816915+00:00"
|
|
6287
6418
|
},
|
|
6288
6419
|
"namespace": {
|
|
6289
6420
|
"type": "string",
|
|
@@ -6292,6 +6423,8 @@
|
|
|
6292
6423
|
"x-displayname": "Namespace",
|
|
6293
6424
|
"x-ves-example": "Staging",
|
|
6294
6425
|
"x-f5xc-example": "staging",
|
|
6426
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6427
|
+
"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 \"\".",
|
|
6295
6428
|
"minLength": 0,
|
|
6296
6429
|
"maxLength": 6,
|
|
6297
6430
|
"x-f5xc-required-for": {
|
|
@@ -6302,9 +6435,10 @@
|
|
|
6302
6435
|
},
|
|
6303
6436
|
"x-original-maxLength": 1024,
|
|
6304
6437
|
"x-reconciled-from-discovery": true,
|
|
6305
|
-
"x-reconciled-at": "2026-01-
|
|
6438
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816919+00:00"
|
|
6306
6439
|
}
|
|
6307
6440
|
},
|
|
6441
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
6308
6442
|
"x-f5xc-minimum-configuration": {
|
|
6309
6443
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
6310
6444
|
"required_fields": [
|
|
@@ -6331,6 +6465,8 @@
|
|
|
6331
6465
|
"EncodingBase64"
|
|
6332
6466
|
],
|
|
6333
6467
|
"default": "EncodingNone",
|
|
6468
|
+
"x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
|
|
6469
|
+
"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.",
|
|
6334
6470
|
"x-f5xc-minimum-configuration": {
|
|
6335
6471
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
6336
6472
|
"required_fields": [],
|
|
@@ -6356,6 +6492,7 @@
|
|
|
6356
6492
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
6357
6493
|
}
|
|
6358
6494
|
},
|
|
6495
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
6359
6496
|
"x-f5xc-minimum-configuration": {
|
|
6360
6497
|
"description": "Minimum configuration for schemaSecretType",
|
|
6361
6498
|
"required_fields": [
|
|
@@ -6382,6 +6519,8 @@
|
|
|
6382
6519
|
"title": "Creation_timestamp.",
|
|
6383
6520
|
"format": "date-time",
|
|
6384
6521
|
"x-displayname": "Creation Timestamp.",
|
|
6522
|
+
"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.",
|
|
6523
|
+
"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.",
|
|
6385
6524
|
"minLength": 0,
|
|
6386
6525
|
"maxLength": 1024,
|
|
6387
6526
|
"x-f5xc-required-for": {
|
|
@@ -6399,6 +6538,8 @@
|
|
|
6399
6538
|
"x-displayname": "Creator Class.",
|
|
6400
6539
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
6401
6540
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
6541
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
6542
|
+
"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.",
|
|
6402
6543
|
"minLength": 0,
|
|
6403
6544
|
"maxLength": 1024,
|
|
6404
6545
|
"x-f5xc-required-for": {
|
|
@@ -6416,6 +6557,8 @@
|
|
|
6416
6557
|
"x-displayname": "Creator ID.",
|
|
6417
6558
|
"x-ves-example": "Ver-instance-1.",
|
|
6418
6559
|
"x-f5xc-example": "ver-instance-1",
|
|
6560
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
6561
|
+
"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.",
|
|
6419
6562
|
"minLength": 0,
|
|
6420
6563
|
"maxLength": 1024,
|
|
6421
6564
|
"x-f5xc-required-for": {
|
|
@@ -6434,6 +6577,8 @@
|
|
|
6434
6577
|
"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)",
|
|
6435
6578
|
"title": "Status_id",
|
|
6436
6579
|
"x-displayname": "Status ID",
|
|
6580
|
+
"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...",
|
|
6581
|
+
"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).",
|
|
6437
6582
|
"minLength": 0,
|
|
6438
6583
|
"maxLength": 1024,
|
|
6439
6584
|
"x-f5xc-required-for": {
|
|
@@ -6451,6 +6596,7 @@
|
|
|
6451
6596
|
"x-displayname": "UID",
|
|
6452
6597
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6453
6598
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6599
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
6454
6600
|
"minLength": 0,
|
|
6455
6601
|
"maxLength": 36,
|
|
6456
6602
|
"x-f5xc-required-for": {
|
|
@@ -6463,13 +6609,14 @@
|
|
|
6463
6609
|
"x-original-maxLength": 1024,
|
|
6464
6610
|
"format": "uuid",
|
|
6465
6611
|
"x-reconciled-from-discovery": true,
|
|
6466
|
-
"x-reconciled-at": "2026-01-
|
|
6612
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816934+00:00"
|
|
6467
6613
|
},
|
|
6468
6614
|
"vtrp_id": {
|
|
6469
6615
|
"type": "string",
|
|
6470
6616
|
"description": "Origin of this status exchanged by VTRP.",
|
|
6471
6617
|
"title": "Vtrp_id",
|
|
6472
6618
|
"x-displayname": "VTRP ID",
|
|
6619
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
6473
6620
|
"minLength": 0,
|
|
6474
6621
|
"maxLength": 1024,
|
|
6475
6622
|
"x-f5xc-required-for": {
|
|
@@ -6486,6 +6633,7 @@
|
|
|
6486
6633
|
"title": "Vtrp_stale.",
|
|
6487
6634
|
"format": "boolean",
|
|
6488
6635
|
"x-displayname": "VTRP Stale.",
|
|
6636
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
6489
6637
|
"x-f5xc-required-for": {
|
|
6490
6638
|
"minimum_config": false,
|
|
6491
6639
|
"create": false,
|
|
@@ -6494,6 +6642,7 @@
|
|
|
6494
6642
|
}
|
|
6495
6643
|
}
|
|
6496
6644
|
},
|
|
6645
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
6497
6646
|
"x-f5xc-minimum-configuration": {
|
|
6498
6647
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
6499
6648
|
"required_fields": [
|
|
@@ -6524,6 +6673,8 @@
|
|
|
6524
6673
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
6525
6674
|
"x-displayname": "Status Publish Type.",
|
|
6526
6675
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
6676
|
+
"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.",
|
|
6677
|
+
"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.",
|
|
6527
6678
|
"x-f5xc-minimum-configuration": {
|
|
6528
6679
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
6529
6680
|
"required_fields": [],
|
|
@@ -6549,6 +6700,7 @@
|
|
|
6549
6700
|
"x-displayname": "Code",
|
|
6550
6701
|
"x-ves-example": "0",
|
|
6551
6702
|
"x-f5xc-example": "0",
|
|
6703
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
6552
6704
|
"minimum": 0,
|
|
6553
6705
|
"maximum": 2147483647,
|
|
6554
6706
|
"x-f5xc-required-for": {
|
|
@@ -6565,6 +6717,8 @@
|
|
|
6565
6717
|
"x-displayname": "Reason",
|
|
6566
6718
|
"x-ves-example": "Value",
|
|
6567
6719
|
"x-f5xc-example": "value",
|
|
6720
|
+
"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.",
|
|
6721
|
+
"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.",
|
|
6568
6722
|
"minLength": 0,
|
|
6569
6723
|
"maxLength": 43,
|
|
6570
6724
|
"x-f5xc-required-for": {
|
|
@@ -6575,7 +6729,7 @@
|
|
|
6575
6729
|
},
|
|
6576
6730
|
"x-original-maxLength": 1024,
|
|
6577
6731
|
"x-reconciled-from-discovery": true,
|
|
6578
|
-
"x-reconciled-at": "2026-01-
|
|
6732
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816943+00:00"
|
|
6579
6733
|
},
|
|
6580
6734
|
"status": {
|
|
6581
6735
|
"type": "string",
|
|
@@ -6584,6 +6738,7 @@
|
|
|
6584
6738
|
"x-displayname": "Status",
|
|
6585
6739
|
"x-ves-example": "Value",
|
|
6586
6740
|
"x-f5xc-example": "value",
|
|
6741
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
6587
6742
|
"minLength": 0,
|
|
6588
6743
|
"maxLength": 17,
|
|
6589
6744
|
"x-f5xc-required-for": {
|
|
@@ -6594,9 +6749,10 @@
|
|
|
6594
6749
|
},
|
|
6595
6750
|
"x-original-maxLength": 1024,
|
|
6596
6751
|
"x-reconciled-from-discovery": true,
|
|
6597
|
-
"x-reconciled-at": "2026-01-
|
|
6752
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816947+00:00"
|
|
6598
6753
|
}
|
|
6599
6754
|
},
|
|
6755
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
6600
6756
|
"x-f5xc-minimum-configuration": {
|
|
6601
6757
|
"description": "Minimum configuration for schemaStatusType",
|
|
6602
6758
|
"required_fields": [
|
|
@@ -6624,6 +6780,8 @@
|
|
|
6624
6780
|
"title": "Creation_timestamp.",
|
|
6625
6781
|
"format": "date-time",
|
|
6626
6782
|
"x-displayname": "Creation Timestamp.",
|
|
6783
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
6784
|
+
"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.",
|
|
6627
6785
|
"minLength": 0,
|
|
6628
6786
|
"maxLength": 1024,
|
|
6629
6787
|
"x-f5xc-required-for": {
|
|
@@ -6641,6 +6799,7 @@
|
|
|
6641
6799
|
"x-displayname": "Creator Class.",
|
|
6642
6800
|
"x-ves-example": "Prism",
|
|
6643
6801
|
"x-f5xc-example": "value",
|
|
6802
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
6644
6803
|
"minLength": 0,
|
|
6645
6804
|
"maxLength": 1024,
|
|
6646
6805
|
"x-f5xc-required-for": {
|
|
@@ -6658,6 +6817,7 @@
|
|
|
6658
6817
|
"x-displayname": "Creator ID.",
|
|
6659
6818
|
"x-ves-example": "Admin@example-corp.com.",
|
|
6660
6819
|
"x-f5xc-example": "value",
|
|
6820
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
6661
6821
|
"minLength": 0,
|
|
6662
6822
|
"maxLength": 1024,
|
|
6663
6823
|
"x-f5xc-required-for": {
|
|
@@ -6674,6 +6834,8 @@
|
|
|
6674
6834
|
"title": "Deletion_timestamp.",
|
|
6675
6835
|
"format": "date-time",
|
|
6676
6836
|
"x-displayname": "Deletion Timestamp.",
|
|
6837
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
6838
|
+
"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...",
|
|
6677
6839
|
"minLength": 0,
|
|
6678
6840
|
"maxLength": 1024,
|
|
6679
6841
|
"x-f5xc-required-for": {
|
|
@@ -6693,6 +6855,8 @@
|
|
|
6693
6855
|
"x-displayname": "Finalizers.",
|
|
6694
6856
|
"x-ves-example": "Value",
|
|
6695
6857
|
"x-f5xc-example": "value",
|
|
6858
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
6859
|
+
"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.",
|
|
6696
6860
|
"x-f5xc-required-for": {
|
|
6697
6861
|
"minimum_config": false,
|
|
6698
6862
|
"create": false,
|
|
@@ -6710,6 +6874,8 @@
|
|
|
6710
6874
|
"x-displayname": "Labels",
|
|
6711
6875
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
6712
6876
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
6877
|
+
"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.",
|
|
6878
|
+
"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).",
|
|
6713
6879
|
"x-f5xc-required-for": {
|
|
6714
6880
|
"minimum_config": false,
|
|
6715
6881
|
"create": false,
|
|
@@ -6723,6 +6889,8 @@
|
|
|
6723
6889
|
"title": "Modification_timestamp.",
|
|
6724
6890
|
"format": "date-time",
|
|
6725
6891
|
"x-displayname": "Modification Timestamp.",
|
|
6892
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
6893
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
6726
6894
|
"minLength": 0,
|
|
6727
6895
|
"maxLength": 1024,
|
|
6728
6896
|
"x-f5xc-required-for": {
|
|
@@ -6741,6 +6909,8 @@
|
|
|
6741
6909
|
"x-displayname": "Object Index.",
|
|
6742
6910
|
"x-ves-example": "0",
|
|
6743
6911
|
"x-f5xc-example": "0",
|
|
6912
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
6913
|
+
"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.",
|
|
6744
6914
|
"minimum": 0,
|
|
6745
6915
|
"maximum": 2147483647,
|
|
6746
6916
|
"x-f5xc-required-for": {
|
|
@@ -6761,6 +6931,8 @@
|
|
|
6761
6931
|
"x-displayname": "Tenant",
|
|
6762
6932
|
"x-ves-example": "Example-corp.",
|
|
6763
6933
|
"x-f5xc-example": "example-corp",
|
|
6934
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
6935
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
6764
6936
|
"minLength": 0,
|
|
6765
6937
|
"maxLength": 18,
|
|
6766
6938
|
"x-f5xc-required-for": {
|
|
@@ -6772,7 +6944,7 @@
|
|
|
6772
6944
|
"x-field-mutability": "read-only",
|
|
6773
6945
|
"x-original-maxLength": 1024,
|
|
6774
6946
|
"x-reconciled-from-discovery": true,
|
|
6775
|
-
"x-reconciled-at": "2026-01-
|
|
6947
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816966+00:00"
|
|
6776
6948
|
},
|
|
6777
6949
|
"uid": {
|
|
6778
6950
|
"type": "string",
|
|
@@ -6781,6 +6953,8 @@
|
|
|
6781
6953
|
"x-displayname": "UID",
|
|
6782
6954
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6783
6955
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6956
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
6957
|
+
"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.",
|
|
6784
6958
|
"minLength": 0,
|
|
6785
6959
|
"maxLength": 36,
|
|
6786
6960
|
"x-f5xc-required-for": {
|
|
@@ -6793,9 +6967,11 @@
|
|
|
6793
6967
|
"x-original-maxLength": 1024,
|
|
6794
6968
|
"format": "uuid",
|
|
6795
6969
|
"x-reconciled-from-discovery": true,
|
|
6796
|
-
"x-reconciled-at": "2026-01-
|
|
6970
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816970+00:00"
|
|
6797
6971
|
}
|
|
6798
6972
|
},
|
|
6973
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
6974
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
6799
6975
|
"x-f5xc-minimum-configuration": {
|
|
6800
6976
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
6801
6977
|
"required_fields": [
|
|
@@ -6829,6 +7005,8 @@
|
|
|
6829
7005
|
"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.",
|
|
6830
7006
|
"title": "Key",
|
|
6831
7007
|
"x-f5xc-example": "key_pem",
|
|
7008
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
|
|
7009
|
+
"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.",
|
|
6832
7010
|
"minLength": 0,
|
|
6833
7011
|
"maxLength": 16,
|
|
6834
7012
|
"x-f5xc-required-for": {
|
|
@@ -6839,13 +7017,14 @@
|
|
|
6839
7017
|
},
|
|
6840
7018
|
"x-original-maxLength": 1024,
|
|
6841
7019
|
"x-reconciled-from-discovery": true,
|
|
6842
|
-
"x-reconciled-at": "2026-01-
|
|
7020
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816975+00:00"
|
|
6843
7021
|
},
|
|
6844
7022
|
"location": {
|
|
6845
7023
|
"type": "string",
|
|
6846
7024
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
6847
7025
|
"title": "Location",
|
|
6848
7026
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
7027
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
6849
7028
|
"minLength": 0,
|
|
6850
7029
|
"maxLength": 4,
|
|
6851
7030
|
"x-f5xc-required-for": {
|
|
@@ -6856,13 +7035,15 @@
|
|
|
6856
7035
|
},
|
|
6857
7036
|
"x-original-maxLength": 1024,
|
|
6858
7037
|
"x-reconciled-from-discovery": true,
|
|
6859
|
-
"x-reconciled-at": "2026-01-
|
|
7038
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816980+00:00"
|
|
6860
7039
|
},
|
|
6861
7040
|
"provider": {
|
|
6862
7041
|
"type": "string",
|
|
6863
7042
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
6864
7043
|
"title": "Provider",
|
|
6865
7044
|
"x-f5xc-example": "vault-vh-provider",
|
|
7045
|
+
"x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
7046
|
+
"x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
6866
7047
|
"minLength": 0,
|
|
6867
7048
|
"maxLength": 8,
|
|
6868
7049
|
"x-f5xc-required-for": {
|
|
@@ -6873,7 +7054,7 @@
|
|
|
6873
7054
|
},
|
|
6874
7055
|
"x-original-maxLength": 1024,
|
|
6875
7056
|
"x-reconciled-from-discovery": true,
|
|
6876
|
-
"x-reconciled-at": "2026-01-
|
|
7057
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816984+00:00"
|
|
6877
7058
|
},
|
|
6878
7059
|
"secret_encoding": {
|
|
6879
7060
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -6884,6 +7065,8 @@
|
|
|
6884
7065
|
"title": "Version",
|
|
6885
7066
|
"format": "int64",
|
|
6886
7067
|
"x-f5xc-example": "1",
|
|
7068
|
+
"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.",
|
|
7069
|
+
"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.",
|
|
6887
7070
|
"minimum": 0,
|
|
6888
7071
|
"maximum": 2147483647,
|
|
6889
7072
|
"x-f5xc-required-for": {
|
|
@@ -6895,9 +7078,11 @@
|
|
|
6895
7078
|
"maxLength": 1,
|
|
6896
7079
|
"minLength": 1,
|
|
6897
7080
|
"x-reconciled-from-discovery": true,
|
|
6898
|
-
"x-reconciled-at": "2026-01-
|
|
7081
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816990+00:00"
|
|
6899
7082
|
}
|
|
6900
7083
|
},
|
|
7084
|
+
"x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
7085
|
+
"x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
6901
7086
|
"x-f5xc-minimum-configuration": {
|
|
6902
7087
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
6903
7088
|
"required_fields": [
|
|
@@ -6938,7 +7123,7 @@
|
|
|
6938
7123
|
},
|
|
6939
7124
|
"x-original-maxLength": 1024,
|
|
6940
7125
|
"x-reconciled-from-discovery": true,
|
|
6941
|
-
"x-reconciled-at": "2026-01-
|
|
7126
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816995+00:00"
|
|
6942
7127
|
},
|
|
6943
7128
|
"name": {
|
|
6944
7129
|
"type": "string",
|
|
@@ -6947,6 +7132,8 @@
|
|
|
6947
7132
|
"x-displayname": "Name",
|
|
6948
7133
|
"x-ves-example": "Contactus-route.",
|
|
6949
7134
|
"x-f5xc-example": "contactus-route",
|
|
7135
|
+
"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.",
|
|
7136
|
+
"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.",
|
|
6950
7137
|
"minLength": 0,
|
|
6951
7138
|
"maxLength": 16,
|
|
6952
7139
|
"x-f5xc-required-for": {
|
|
@@ -6957,7 +7144,7 @@
|
|
|
6957
7144
|
},
|
|
6958
7145
|
"x-original-maxLength": 1024,
|
|
6959
7146
|
"x-reconciled-from-discovery": true,
|
|
6960
|
-
"x-reconciled-at": "2026-01-
|
|
7147
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816999+00:00"
|
|
6961
7148
|
},
|
|
6962
7149
|
"namespace": {
|
|
6963
7150
|
"type": "string",
|
|
@@ -6966,6 +7153,8 @@
|
|
|
6966
7153
|
"x-displayname": "Namespace",
|
|
6967
7154
|
"x-ves-example": "Ns1",
|
|
6968
7155
|
"x-f5xc-example": "ns1",
|
|
7156
|
+
"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.",
|
|
7157
|
+
"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.",
|
|
6969
7158
|
"minLength": 0,
|
|
6970
7159
|
"maxLength": 6,
|
|
6971
7160
|
"x-f5xc-required-for": {
|
|
@@ -6976,7 +7165,7 @@
|
|
|
6976
7165
|
},
|
|
6977
7166
|
"x-original-maxLength": 1024,
|
|
6978
7167
|
"x-reconciled-from-discovery": true,
|
|
6979
|
-
"x-reconciled-at": "2026-01-
|
|
7168
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817003+00:00"
|
|
6980
7169
|
},
|
|
6981
7170
|
"uid": {
|
|
6982
7171
|
"type": "string",
|
|
@@ -6997,9 +7186,10 @@
|
|
|
6997
7186
|
"x-original-maxLength": 1024,
|
|
6998
7187
|
"format": "uuid",
|
|
6999
7188
|
"x-reconciled-from-discovery": true,
|
|
7000
|
-
"x-reconciled-at": "2026-01-
|
|
7189
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817008+00:00"
|
|
7001
7190
|
}
|
|
7002
7191
|
},
|
|
7192
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
7003
7193
|
"x-f5xc-minimum-configuration": {
|
|
7004
7194
|
"description": "Minimum configuration for schemaViewRefType",
|
|
7005
7195
|
"required_fields": [
|
|
@@ -7025,6 +7215,7 @@
|
|
|
7025
7215
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
7026
7216
|
"title": "Name",
|
|
7027
7217
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
7218
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
7028
7219
|
"minLength": 0,
|
|
7029
7220
|
"maxLength": 16,
|
|
7030
7221
|
"x-f5xc-required-for": {
|
|
@@ -7035,9 +7226,10 @@
|
|
|
7035
7226
|
},
|
|
7036
7227
|
"x-original-maxLength": 1024,
|
|
7037
7228
|
"x-reconciled-from-discovery": true,
|
|
7038
|
-
"x-reconciled-at": "2026-01-
|
|
7229
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817012+00:00"
|
|
7039
7230
|
}
|
|
7040
7231
|
},
|
|
7232
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
7041
7233
|
"x-f5xc-minimum-configuration": {
|
|
7042
7234
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
7043
7235
|
"required_fields": [
|
|
@@ -7077,6 +7269,8 @@
|
|
|
7077
7269
|
"ves.io.schema.rules.string.max_bytes": "128",
|
|
7078
7270
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
7079
7271
|
},
|
|
7272
|
+
"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.",
|
|
7273
|
+
"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.",
|
|
7080
7274
|
"x-f5xc-required-for": {
|
|
7081
7275
|
"minimum_config": false,
|
|
7082
7276
|
"create": false,
|
|
@@ -7085,7 +7279,7 @@
|
|
|
7085
7279
|
},
|
|
7086
7280
|
"x-original-maxLength": 128,
|
|
7087
7281
|
"x-reconciled-from-discovery": true,
|
|
7088
|
-
"x-reconciled-at": "2026-01-
|
|
7282
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817018+00:00"
|
|
7089
7283
|
},
|
|
7090
7284
|
"namespace": {
|
|
7091
7285
|
"type": "string",
|
|
@@ -7101,6 +7295,8 @@
|
|
|
7101
7295
|
"x-validation-rules": {
|
|
7102
7296
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
7103
7297
|
},
|
|
7298
|
+
"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.",
|
|
7299
|
+
"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.",
|
|
7104
7300
|
"minLength": 0,
|
|
7105
7301
|
"x-f5xc-required-for": {
|
|
7106
7302
|
"minimum_config": false,
|
|
@@ -7110,7 +7306,7 @@
|
|
|
7110
7306
|
},
|
|
7111
7307
|
"x-original-maxLength": 64,
|
|
7112
7308
|
"x-reconciled-from-discovery": true,
|
|
7113
|
-
"x-reconciled-at": "2026-01-
|
|
7309
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817022+00:00"
|
|
7114
7310
|
},
|
|
7115
7311
|
"tenant": {
|
|
7116
7312
|
"type": "string",
|
|
@@ -7126,6 +7322,8 @@
|
|
|
7126
7322
|
"x-validation-rules": {
|
|
7127
7323
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
7128
7324
|
},
|
|
7325
|
+
"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.",
|
|
7326
|
+
"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.",
|
|
7129
7327
|
"minLength": 0,
|
|
7130
7328
|
"x-f5xc-required-for": {
|
|
7131
7329
|
"minimum_config": false,
|
|
@@ -7137,9 +7335,11 @@
|
|
|
7137
7335
|
"x-field-mutability": "read-only",
|
|
7138
7336
|
"x-original-maxLength": 64,
|
|
7139
7337
|
"x-reconciled-from-discovery": true,
|
|
7140
|
-
"x-reconciled-at": "2026-01-
|
|
7338
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817027+00:00"
|
|
7141
7339
|
}
|
|
7142
7340
|
},
|
|
7341
|
+
"x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
|
|
7342
|
+
"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.",
|
|
7143
7343
|
"x-f5xc-minimum-configuration": {
|
|
7144
7344
|
"description": "Minimum configuration for schemaviewsObjectRefType",
|
|
7145
7345
|
"required_fields": [
|
|
@@ -7192,7 +7392,7 @@
|
|
|
7192
7392
|
"maxLength": 15,
|
|
7193
7393
|
"minLength": 3,
|
|
7194
7394
|
"x-reconciled-from-discovery": true,
|
|
7195
|
-
"x-reconciled-at": "2026-01-
|
|
7395
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180244+00:00"
|
|
7196
7396
|
}
|
|
7197
7397
|
},
|
|
7198
7398
|
"x-f5xc-minimum-configuration": {
|
|
@@ -7230,7 +7430,7 @@
|
|
|
7230
7430
|
},
|
|
7231
7431
|
"x-original-maxLength": 1024,
|
|
7232
7432
|
"x-reconciled-from-discovery": true,
|
|
7233
|
-
"x-reconciled-at": "2026-01-
|
|
7433
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180252+00:00"
|
|
7234
7434
|
},
|
|
7235
7435
|
"id": {
|
|
7236
7436
|
"type": "string",
|
|
@@ -7267,7 +7467,7 @@
|
|
|
7267
7467
|
},
|
|
7268
7468
|
"x-original-maxLength": 1024,
|
|
7269
7469
|
"x-reconciled-from-discovery": true,
|
|
7270
|
-
"x-reconciled-at": "2026-01-
|
|
7470
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180260+00:00"
|
|
7271
7471
|
},
|
|
7272
7472
|
"status": {
|
|
7273
7473
|
"type": "string",
|
|
@@ -7276,6 +7476,7 @@
|
|
|
7276
7476
|
"x-displayname": "Status",
|
|
7277
7477
|
"x-ves-example": "Subscribed.",
|
|
7278
7478
|
"x-f5xc-example": "subscribed",
|
|
7479
|
+
"x-f5xc-description-short": "Information to suggest if the dataset is currently subscribed by the tenant.",
|
|
7279
7480
|
"minLength": 0,
|
|
7280
7481
|
"maxLength": 17,
|
|
7281
7482
|
"x-f5xc-required-for": {
|
|
@@ -7286,7 +7487,7 @@
|
|
|
7286
7487
|
},
|
|
7287
7488
|
"x-original-maxLength": 1024,
|
|
7288
7489
|
"x-reconciled-from-discovery": true,
|
|
7289
|
-
"x-reconciled-at": "2026-01-
|
|
7490
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180265+00:00"
|
|
7290
7491
|
}
|
|
7291
7492
|
},
|
|
7292
7493
|
"x-f5xc-minimum-configuration": {
|
|
@@ -7333,6 +7534,7 @@
|
|
|
7333
7534
|
"title": "EventsCount.",
|
|
7334
7535
|
"format": "int64",
|
|
7335
7536
|
"x-displayname": "Events Count.",
|
|
7537
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7336
7538
|
"minimum": 0,
|
|
7337
7539
|
"maximum": 2147483647,
|
|
7338
7540
|
"x-f5xc-required-for": {
|
|
@@ -7348,6 +7550,7 @@
|
|
|
7348
7550
|
"title": "EventsPercentage.",
|
|
7349
7551
|
"format": "double",
|
|
7350
7552
|
"x-displayname": "Events Percentage.",
|
|
7553
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7351
7554
|
"x-f5xc-required-for": {
|
|
7352
7555
|
"minimum_config": false,
|
|
7353
7556
|
"create": false,
|
|
@@ -7372,9 +7575,10 @@
|
|
|
7372
7575
|
},
|
|
7373
7576
|
"x-original-maxLength": 1024,
|
|
7374
7577
|
"x-reconciled-from-discovery": true,
|
|
7375
|
-
"x-reconciled-at": "2026-01-
|
|
7578
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180274+00:00"
|
|
7376
7579
|
}
|
|
7377
7580
|
},
|
|
7581
|
+
"x-f5xc-description-short": "Message object representing events reason.",
|
|
7378
7582
|
"x-f5xc-minimum-configuration": {
|
|
7379
7583
|
"description": "Minimum configuration for data_deliveryEventsReason",
|
|
7380
7584
|
"required_fields": [
|
|
@@ -7399,7 +7603,7 @@
|
|
|
7399
7603
|
"properties": {
|
|
7400
7604
|
"data_format": {
|
|
7401
7605
|
"type": "string",
|
|
7402
|
-
"description": "",
|
|
7606
|
+
"description": "Data or content configuration",
|
|
7403
7607
|
"title": "Data format.",
|
|
7404
7608
|
"x-displayname": "Data format.",
|
|
7405
7609
|
"x-ves-example": "String",
|
|
@@ -7428,13 +7632,14 @@
|
|
|
7428
7632
|
},
|
|
7429
7633
|
"x-original-maxLength": 1024,
|
|
7430
7634
|
"x-reconciled-from-discovery": true,
|
|
7431
|
-
"x-reconciled-at": "2026-01-
|
|
7635
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180281+00:00"
|
|
7432
7636
|
},
|
|
7433
7637
|
"feature_name": {
|
|
7434
7638
|
"type": "string",
|
|
7435
7639
|
"description": "Name of the feature.",
|
|
7436
7640
|
"title": "Feature name.",
|
|
7437
7641
|
"x-displayname": "Feature Name.",
|
|
7642
|
+
"x-f5xc-example": "example-resource",
|
|
7438
7643
|
"minLength": 0,
|
|
7439
7644
|
"maxLength": 1024,
|
|
7440
7645
|
"x-f5xc-required-for": {
|
|
@@ -7450,6 +7655,7 @@
|
|
|
7450
7655
|
"title": "IsNewField.",
|
|
7451
7656
|
"format": "boolean",
|
|
7452
7657
|
"x-displayname": "IsNewField.",
|
|
7658
|
+
"x-f5xc-description-short": "Information to suggest if this is existing or new feature in dataset.",
|
|
7453
7659
|
"x-f5xc-required-for": {
|
|
7454
7660
|
"minimum_config": false,
|
|
7455
7661
|
"create": false,
|
|
@@ -7462,6 +7668,7 @@
|
|
|
7462
7668
|
"description": "Additional notes about the dataset feature.",
|
|
7463
7669
|
"title": "Notes",
|
|
7464
7670
|
"x-displayname": "Notes",
|
|
7671
|
+
"x-f5xc-description-short": "Additional notes about the dataset feature.",
|
|
7465
7672
|
"minLength": 0,
|
|
7466
7673
|
"maxLength": 1024,
|
|
7467
7674
|
"x-f5xc-required-for": {
|
|
@@ -7477,6 +7684,7 @@
|
|
|
7477
7684
|
"title": "Required",
|
|
7478
7685
|
"format": "boolean",
|
|
7479
7686
|
"x-displayname": "Required",
|
|
7687
|
+
"x-f5xc-example": "True",
|
|
7480
7688
|
"x-f5xc-required-for": {
|
|
7481
7689
|
"minimum_config": false,
|
|
7482
7690
|
"create": false,
|
|
@@ -7485,6 +7693,7 @@
|
|
|
7485
7693
|
}
|
|
7486
7694
|
}
|
|
7487
7695
|
},
|
|
7696
|
+
"x-f5xc-description-short": "Definition of feature which is unit of dataset.",
|
|
7488
7697
|
"x-f5xc-minimum-configuration": {
|
|
7489
7698
|
"description": "Minimum configuration for data_deliveryFeature",
|
|
7490
7699
|
"required_fields": [
|
|
@@ -7540,6 +7749,7 @@
|
|
|
7540
7749
|
}
|
|
7541
7750
|
}
|
|
7542
7751
|
},
|
|
7752
|
+
"x-f5xc-description-short": "Message representing flow label information.",
|
|
7543
7753
|
"x-f5xc-minimum-configuration": {
|
|
7544
7754
|
"description": "Minimum configuration for data_deliveryFlowLabel",
|
|
7545
7755
|
"required_fields": [
|
|
@@ -7568,6 +7778,7 @@
|
|
|
7568
7778
|
"$ref": "#/components/schemas/data_deliveryFeature"
|
|
7569
7779
|
},
|
|
7570
7780
|
"x-displayname": "Feature List.",
|
|
7781
|
+
"x-f5xc-example": "True",
|
|
7571
7782
|
"x-f5xc-required-for": {
|
|
7572
7783
|
"minimum_config": false,
|
|
7573
7784
|
"create": false,
|
|
@@ -7576,6 +7787,7 @@
|
|
|
7576
7787
|
}
|
|
7577
7788
|
}
|
|
7578
7789
|
},
|
|
7790
|
+
"x-f5xc-description-short": "Dataset feature fetched by data dictionary API.",
|
|
7579
7791
|
"x-f5xc-minimum-configuration": {
|
|
7580
7792
|
"description": "Minimum configuration for data_deliveryGetDataDictionaryResponse",
|
|
7581
7793
|
"required_fields": [
|
|
@@ -7600,6 +7812,8 @@
|
|
|
7600
7812
|
"items": {
|
|
7601
7813
|
"type": "string"
|
|
7602
7814
|
},
|
|
7815
|
+
"description": "Data or content configuration",
|
|
7816
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7603
7817
|
"x-f5xc-required-for": {
|
|
7604
7818
|
"minimum_config": false,
|
|
7605
7819
|
"create": false,
|
|
@@ -7609,6 +7823,7 @@
|
|
|
7609
7823
|
}
|
|
7610
7824
|
},
|
|
7611
7825
|
"x-f5xc-example": "DI Advanced",
|
|
7826
|
+
"x-f5xc-description-short": "List of Data Sets eligible for the tenant.",
|
|
7612
7827
|
"x-f5xc-minimum-configuration": {
|
|
7613
7828
|
"description": "Minimum configuration for data_deliveryGetDataSetsResponse",
|
|
7614
7829
|
"required_fields": [
|
|
@@ -7635,6 +7850,7 @@
|
|
|
7635
7850
|
"x-displayname": "Granularity.",
|
|
7636
7851
|
"x-ves-example": "5m",
|
|
7637
7852
|
"x-f5xc-example": "5m",
|
|
7853
|
+
"x-f5xc-description-short": "Granularity of the data points (\"1m\", \"5m\", etc.).",
|
|
7638
7854
|
"minLength": 0,
|
|
7639
7855
|
"maxLength": 1024,
|
|
7640
7856
|
"x-f5xc-required-for": {
|
|
@@ -7660,6 +7876,7 @@
|
|
|
7660
7876
|
}
|
|
7661
7877
|
}
|
|
7662
7878
|
},
|
|
7879
|
+
"x-f5xc-description-short": "Message object representing line chart data.",
|
|
7663
7880
|
"x-f5xc-minimum-configuration": {
|
|
7664
7881
|
"description": "Minimum configuration for data_deliveryLineChartData",
|
|
7665
7882
|
"required_fields": [
|
|
@@ -7688,6 +7905,7 @@
|
|
|
7688
7905
|
"$ref": "#/components/schemas/data_deliveryDataSet"
|
|
7689
7906
|
},
|
|
7690
7907
|
"x-displayname": "DataSet List.",
|
|
7908
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7691
7909
|
"x-f5xc-required-for": {
|
|
7692
7910
|
"minimum_config": false,
|
|
7693
7911
|
"create": false,
|
|
@@ -7785,6 +8003,7 @@
|
|
|
7785
8003
|
"x-displayname": "Granularity.",
|
|
7786
8004
|
"x-ves-example": "5m",
|
|
7787
8005
|
"x-f5xc-example": "5m",
|
|
8006
|
+
"x-f5xc-description-short": "Granularity of the data points (\"1m\", \"5m\", etc.).",
|
|
7788
8007
|
"minLength": 0,
|
|
7789
8008
|
"maxLength": 1024,
|
|
7790
8009
|
"x-f5xc-required-for": {
|
|
@@ -7801,6 +8020,7 @@
|
|
|
7801
8020
|
"x-displayname": "Namespace",
|
|
7802
8021
|
"x-ves-example": "Foobar",
|
|
7803
8022
|
"x-f5xc-example": "foobar",
|
|
8023
|
+
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
|
|
7804
8024
|
"minLength": 0,
|
|
7805
8025
|
"maxLength": 6,
|
|
7806
8026
|
"x-f5xc-required-for": {
|
|
@@ -7811,7 +8031,7 @@
|
|
|
7811
8031
|
},
|
|
7812
8032
|
"x-original-maxLength": 1024,
|
|
7813
8033
|
"x-reconciled-from-discovery": true,
|
|
7814
|
-
"x-reconciled-at": "2026-01-
|
|
8034
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180309+00:00"
|
|
7815
8035
|
},
|
|
7816
8036
|
"platform": {
|
|
7817
8037
|
"type": "string",
|
|
@@ -7820,6 +8040,7 @@
|
|
|
7820
8040
|
"x-displayname": "Platform",
|
|
7821
8041
|
"x-ves-example": "Mobile",
|
|
7822
8042
|
"x-f5xc-example": "mobile",
|
|
8043
|
+
"x-f5xc-description-short": "Platform criteria for filtering the data.",
|
|
7823
8044
|
"minLength": 0,
|
|
7824
8045
|
"maxLength": 1024,
|
|
7825
8046
|
"x-f5xc-required-for": {
|
|
@@ -7862,6 +8083,7 @@
|
|
|
7862
8083
|
}
|
|
7863
8084
|
}
|
|
7864
8085
|
},
|
|
8086
|
+
"x-f5xc-description-short": "Request object to GET executive summary of DI premium customer.",
|
|
7865
8087
|
"x-f5xc-minimum-configuration": {
|
|
7866
8088
|
"description": "Minimum configuration for data_deliveryLoadExecutiveSummaryRequest",
|
|
7867
8089
|
"required_fields": [
|
|
@@ -7897,6 +8119,7 @@
|
|
|
7897
8119
|
"x-displayname": "Events Reason.",
|
|
7898
8120
|
"x-ves-example": "High attempt value , high success volume.",
|
|
7899
8121
|
"x-f5xc-example": "high attempt value , high success volume",
|
|
8122
|
+
"x-f5xc-description-short": "Message representing the transaction data.",
|
|
7900
8123
|
"x-f5xc-required-for": {
|
|
7901
8124
|
"minimum_config": false,
|
|
7902
8125
|
"create": false,
|
|
@@ -7911,6 +8134,7 @@
|
|
|
7911
8134
|
"$ref": "#/components/schemas/data_deliverySummaryPanel"
|
|
7912
8135
|
}
|
|
7913
8136
|
},
|
|
8137
|
+
"x-f5xc-description-short": "Response object to GET executive summary of DI premium customer.",
|
|
7914
8138
|
"x-f5xc-minimum-configuration": {
|
|
7915
8139
|
"description": "Minimum configuration for data_deliveryLoadExecutiveSummaryResponse",
|
|
7916
8140
|
"required_fields": [
|
|
@@ -7940,6 +8164,7 @@
|
|
|
7940
8164
|
"$ref": "#/components/schemas/data_deliveryDataPoint"
|
|
7941
8165
|
},
|
|
7942
8166
|
"x-displayname": "Data Point.",
|
|
8167
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7943
8168
|
"x-f5xc-required-for": {
|
|
7944
8169
|
"minimum_config": false,
|
|
7945
8170
|
"create": false,
|
|
@@ -7954,6 +8179,7 @@
|
|
|
7954
8179
|
"x-displayname": "Name",
|
|
7955
8180
|
"x-ves-example": "Bot",
|
|
7956
8181
|
"x-f5xc-example": "bot",
|
|
8182
|
+
"x-f5xc-description-short": "Name of the series (\"typical\", \"bot\", \"anomalous\").",
|
|
7957
8183
|
"minLength": 0,
|
|
7958
8184
|
"maxLength": 16,
|
|
7959
8185
|
"x-f5xc-required-for": {
|
|
@@ -7964,7 +8190,7 @@
|
|
|
7964
8190
|
},
|
|
7965
8191
|
"x-original-maxLength": 1024,
|
|
7966
8192
|
"x-reconciled-from-discovery": true,
|
|
7967
|
-
"x-reconciled-at": "2026-01-
|
|
8193
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180323+00:00"
|
|
7968
8194
|
}
|
|
7969
8195
|
},
|
|
7970
8196
|
"x-f5xc-minimum-configuration": {
|
|
@@ -7993,6 +8219,7 @@
|
|
|
7993
8219
|
"title": "AnomalousDevices.",
|
|
7994
8220
|
"format": "int64",
|
|
7995
8221
|
"x-displayname": "Anomalous Devices.",
|
|
8222
|
+
"x-f5xc-description-short": "Number of devices identified as anomalous.",
|
|
7996
8223
|
"minimum": 0,
|
|
7997
8224
|
"maximum": 2147483647,
|
|
7998
8225
|
"x-f5xc-required-for": {
|
|
@@ -8008,6 +8235,7 @@
|
|
|
8008
8235
|
"title": "AnomalousDevicesPercentage.",
|
|
8009
8236
|
"format": "double",
|
|
8010
8237
|
"x-displayname": "Anomalous Devices Percentage.",
|
|
8238
|
+
"x-f5xc-description-short": "Percentage of anomalous devices over total evaluated devices.",
|
|
8011
8239
|
"x-f5xc-required-for": {
|
|
8012
8240
|
"minimum_config": false,
|
|
8013
8241
|
"create": false,
|
|
@@ -8047,6 +8275,7 @@
|
|
|
8047
8275
|
"title": "AnomalousPercentage.",
|
|
8048
8276
|
"format": "double",
|
|
8049
8277
|
"x-displayname": "Anomalous Percentage.",
|
|
8278
|
+
"x-f5xc-description-short": "Percentage of anomalous transactions over total evaluated transactions.",
|
|
8050
8279
|
"x-f5xc-required-for": {
|
|
8051
8280
|
"minimum_config": false,
|
|
8052
8281
|
"create": false,
|
|
@@ -8060,6 +8289,7 @@
|
|
|
8060
8289
|
"title": "AnomalousTransactions.",
|
|
8061
8290
|
"format": "int64",
|
|
8062
8291
|
"x-displayname": "Anomalous Transactions.",
|
|
8292
|
+
"x-f5xc-description-short": "Number of transactions identified as anomalous.",
|
|
8063
8293
|
"minimum": 0,
|
|
8064
8294
|
"maximum": 2147483647,
|
|
8065
8295
|
"x-f5xc-required-for": {
|
|
@@ -8075,6 +8305,7 @@
|
|
|
8075
8305
|
"title": "BotPercentage.",
|
|
8076
8306
|
"format": "double",
|
|
8077
8307
|
"x-displayname": "Bot Percentage.",
|
|
8308
|
+
"x-f5xc-description-short": "Percentage of bot transactions over total evaluated transactions.",
|
|
8078
8309
|
"x-f5xc-required-for": {
|
|
8079
8310
|
"minimum_config": false,
|
|
8080
8311
|
"create": false,
|
|
@@ -8088,6 +8319,7 @@
|
|
|
8088
8319
|
"title": "BotTransactions.",
|
|
8089
8320
|
"format": "int64",
|
|
8090
8321
|
"x-displayname": "Bot Transactions.",
|
|
8322
|
+
"x-f5xc-description-short": "Number of transactions identified as bots.",
|
|
8091
8323
|
"minimum": 0,
|
|
8092
8324
|
"maximum": 2147483647,
|
|
8093
8325
|
"x-f5xc-required-for": {
|
|
@@ -8128,6 +8360,7 @@
|
|
|
8128
8360
|
}
|
|
8129
8361
|
}
|
|
8130
8362
|
},
|
|
8363
|
+
"x-f5xc-description-short": "Message object representing summary panel.",
|
|
8131
8364
|
"x-f5xc-minimum-configuration": {
|
|
8132
8365
|
"description": "Minimum configuration for data_deliverySummaryPanel",
|
|
8133
8366
|
"required_fields": [
|
|
@@ -8194,6 +8427,7 @@
|
|
|
8194
8427
|
"x-validation-rules": {
|
|
8195
8428
|
"ves.io.schema.rules.message.required": "true"
|
|
8196
8429
|
},
|
|
8430
|
+
"x-f5xc-description-short": "Namespace in which the receiver is configured Required: YES.",
|
|
8197
8431
|
"minLength": 0,
|
|
8198
8432
|
"maxLength": 6,
|
|
8199
8433
|
"x-f5xc-required-for": {
|
|
@@ -8204,9 +8438,10 @@
|
|
|
8204
8438
|
},
|
|
8205
8439
|
"x-original-maxLength": 1024,
|
|
8206
8440
|
"x-reconciled-from-discovery": true,
|
|
8207
|
-
"x-reconciled-at": "2026-01-
|
|
8441
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180343+00:00"
|
|
8208
8442
|
}
|
|
8209
8443
|
},
|
|
8444
|
+
"x-f5xc-description-short": "Request to test receiver & destination sink.",
|
|
8210
8445
|
"x-f5xc-minimum-configuration": {
|
|
8211
8446
|
"description": "Minimum configuration for data_deliveryTestReceiverRequest",
|
|
8212
8447
|
"required_fields": [
|
|
@@ -8234,6 +8469,7 @@
|
|
|
8234
8469
|
"x-displayname": "Message",
|
|
8235
8470
|
"x-ves-example": "Credentials invalid.",
|
|
8236
8471
|
"x-f5xc-example": "Credentials invalid",
|
|
8472
|
+
"x-f5xc-description-short": "The error string if the status is failed.",
|
|
8237
8473
|
"minLength": 0,
|
|
8238
8474
|
"maxLength": 1024,
|
|
8239
8475
|
"x-f5xc-required-for": {
|
|
@@ -8247,6 +8483,8 @@
|
|
|
8247
8483
|
"$ref": "#/components/schemas/data_deliveryTestReceiverStatusType"
|
|
8248
8484
|
}
|
|
8249
8485
|
},
|
|
8486
|
+
"x-f5xc-description-short": "Response for the Receiver test request; empty because the only returned information is error message.",
|
|
8487
|
+
"x-f5xc-description-medium": "Response for the Receiver test request; empty because the only returned information is error message.",
|
|
8250
8488
|
"x-f5xc-minimum-configuration": {
|
|
8251
8489
|
"description": "Minimum configuration for data_deliveryTestReceiverResponse",
|
|
8252
8490
|
"required_fields": [
|
|
@@ -8271,6 +8509,8 @@
|
|
|
8271
8509
|
"default": "SUCCESS",
|
|
8272
8510
|
"x-displayname": "Test Receiver Status Type.",
|
|
8273
8511
|
"x-ves-proto-enum": "ves.io.schema.shape.data_delivery.TestReceiverStatusType",
|
|
8512
|
+
"x-f5xc-description-short": "Test Receiver connection status The receiver credentials & settings has been tested and the connection has been validated There is error when...",
|
|
8513
|
+
"x-f5xc-description-medium": "Test Receiver connection status The receiver credentials & settings has been tested and the connection has been validated There is error when trying to test the connection for destination sink with given credentials.",
|
|
8274
8514
|
"x-f5xc-minimum-configuration": {
|
|
8275
8515
|
"description": "Minimum configuration for data_deliveryTestReceiverStatusType",
|
|
8276
8516
|
"required_fields": [],
|
|
@@ -8319,6 +8559,7 @@
|
|
|
8319
8559
|
"x-displayname": "Namespace",
|
|
8320
8560
|
"x-ves-example": "Foobar",
|
|
8321
8561
|
"x-f5xc-example": "foobar",
|
|
8562
|
+
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
|
|
8322
8563
|
"minLength": 0,
|
|
8323
8564
|
"maxLength": 6,
|
|
8324
8565
|
"x-f5xc-required-for": {
|
|
@@ -8329,7 +8570,7 @@
|
|
|
8329
8570
|
},
|
|
8330
8571
|
"x-original-maxLength": 1024,
|
|
8331
8572
|
"x-reconciled-from-discovery": true,
|
|
8332
|
-
"x-reconciled-at": "2026-01-
|
|
8573
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180353+00:00"
|
|
8333
8574
|
},
|
|
8334
8575
|
"type": {
|
|
8335
8576
|
"$ref": "#/components/schemas/shapedata_deliveryStatusType"
|
|
@@ -8381,6 +8622,7 @@
|
|
|
8381
8622
|
"x-displayname": "Receiver Name.",
|
|
8382
8623
|
"x-ves-example": "Splunk-cloud-receiver.",
|
|
8383
8624
|
"x-f5xc-example": "splunk-cloud-receiver",
|
|
8625
|
+
"x-f5xc-description-short": "Name of the receiver configured by the customer.",
|
|
8384
8626
|
"minLength": 0,
|
|
8385
8627
|
"maxLength": 1024,
|
|
8386
8628
|
"x-f5xc-required-for": {
|
|
@@ -8397,6 +8639,7 @@
|
|
|
8397
8639
|
"x-displayname": "Status",
|
|
8398
8640
|
"x-ves-example": "Not_modified.",
|
|
8399
8641
|
"x-f5xc-example": "not_modified",
|
|
8642
|
+
"x-f5xc-description-short": "Values: not_modified , success Status about receiver status modification.",
|
|
8400
8643
|
"minLength": 0,
|
|
8401
8644
|
"maxLength": 17,
|
|
8402
8645
|
"x-f5xc-required-for": {
|
|
@@ -8407,9 +8650,10 @@
|
|
|
8407
8650
|
},
|
|
8408
8651
|
"x-original-maxLength": 1024,
|
|
8409
8652
|
"x-reconciled-from-discovery": true,
|
|
8410
|
-
"x-reconciled-at": "2026-01-
|
|
8653
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180361+00:00"
|
|
8411
8654
|
}
|
|
8412
8655
|
},
|
|
8656
|
+
"x-f5xc-description-short": "Payload about status of receiver status result.",
|
|
8413
8657
|
"x-f5xc-minimum-configuration": {
|
|
8414
8658
|
"description": "Minimum configuration for data_deliveryUpdateReceiverStatusResponse",
|
|
8415
8659
|
"required_fields": [
|
|
@@ -8445,6 +8689,7 @@
|
|
|
8445
8689
|
"x-validation-rules": {
|
|
8446
8690
|
"ves.io.schema.rules.string.max_len": "1024"
|
|
8447
8691
|
},
|
|
8692
|
+
"x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.",
|
|
8448
8693
|
"minLength": 0,
|
|
8449
8694
|
"x-f5xc-required-for": {
|
|
8450
8695
|
"minimum_config": false,
|
|
@@ -8467,6 +8712,8 @@
|
|
|
8467
8712
|
"x-validation-rules": {
|
|
8468
8713
|
"ves.io.schema.rules.string.max_len": "256"
|
|
8469
8714
|
},
|
|
8715
|
+
"x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
|
|
8716
|
+
"x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.",
|
|
8470
8717
|
"minLength": 0,
|
|
8471
8718
|
"x-f5xc-required-for": {
|
|
8472
8719
|
"minimum_config": false,
|
|
@@ -8482,6 +8729,7 @@
|
|
|
8482
8729
|
"x-displayname": "Namespace",
|
|
8483
8730
|
"x-ves-example": "Foobar",
|
|
8484
8731
|
"x-f5xc-example": "foobar",
|
|
8732
|
+
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
|
|
8485
8733
|
"minLength": 0,
|
|
8486
8734
|
"maxLength": 6,
|
|
8487
8735
|
"x-f5xc-required-for": {
|
|
@@ -8492,7 +8740,7 @@
|
|
|
8492
8740
|
},
|
|
8493
8741
|
"x-original-maxLength": 1024,
|
|
8494
8742
|
"x-reconciled-from-discovery": true,
|
|
8495
|
-
"x-reconciled-at": "2026-01-
|
|
8743
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180369+00:00"
|
|
8496
8744
|
},
|
|
8497
8745
|
"request_body": {
|
|
8498
8746
|
"$ref": "#/components/schemas/protobufAny"
|
|
@@ -8528,6 +8776,7 @@
|
|
|
8528
8776
|
"$ref": "#/components/schemas/namespaceSuggestedItem"
|
|
8529
8777
|
},
|
|
8530
8778
|
"x-displayname": "Suggested Items.",
|
|
8779
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
8531
8780
|
"x-f5xc-required-for": {
|
|
8532
8781
|
"minimum_config": false,
|
|
8533
8782
|
"create": false,
|
|
@@ -8561,6 +8810,7 @@
|
|
|
8561
8810
|
"description": "Optional description for the suggested value.",
|
|
8562
8811
|
"title": "Description.",
|
|
8563
8812
|
"x-displayname": "Description.",
|
|
8813
|
+
"x-f5xc-description-short": "Optional description for the suggested value.",
|
|
8564
8814
|
"minLength": 0,
|
|
8565
8815
|
"maxLength": 0,
|
|
8566
8816
|
"x-f5xc-required-for": {
|
|
@@ -8571,7 +8821,7 @@
|
|
|
8571
8821
|
},
|
|
8572
8822
|
"x-original-maxLength": 1024,
|
|
8573
8823
|
"x-reconciled-from-discovery": true,
|
|
8574
|
-
"x-reconciled-at": "2026-01-
|
|
8824
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180377+00:00"
|
|
8575
8825
|
},
|
|
8576
8826
|
"ref_value": {
|
|
8577
8827
|
"$ref": "#/components/schemas/schemaviewsObjectRefType"
|
|
@@ -8595,6 +8845,9 @@
|
|
|
8595
8845
|
"description": "Optional title to be displayed instead of the actual value.\nUsed when pure value doesn't contain all the needed information to be displayed,\nor when display titles should be customized.",
|
|
8596
8846
|
"title": "Title",
|
|
8597
8847
|
"x-displayname": "Title",
|
|
8848
|
+
"x-f5xc-example": "example-resource",
|
|
8849
|
+
"x-f5xc-description-short": "Optional title to be displayed instead of the actual value.",
|
|
8850
|
+
"x-f5xc-description-medium": "Optional title to be displayed instead of the actual value. Used when pure value doesn't contain all the needed information to be displayed, or when display titles should be customized.",
|
|
8598
8851
|
"minLength": 0,
|
|
8599
8852
|
"maxLength": 6,
|
|
8600
8853
|
"x-f5xc-required-for": {
|
|
@@ -8605,13 +8858,14 @@
|
|
|
8605
8858
|
},
|
|
8606
8859
|
"x-original-maxLength": 1024,
|
|
8607
8860
|
"x-reconciled-from-discovery": true,
|
|
8608
|
-
"x-reconciled-at": "2026-01-
|
|
8861
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180383+00:00"
|
|
8609
8862
|
},
|
|
8610
8863
|
"value": {
|
|
8611
8864
|
"type": "string",
|
|
8612
8865
|
"description": "Suggested value for the field.\nShould use value_choice.str_value instead.",
|
|
8613
8866
|
"title": "Value",
|
|
8614
8867
|
"x-displayname": "Value",
|
|
8868
|
+
"x-f5xc-description-short": "Suggested value for the field. Should use value_choice.str_value instead.",
|
|
8615
8869
|
"minLength": 0,
|
|
8616
8870
|
"maxLength": 15,
|
|
8617
8871
|
"x-f5xc-required-for": {
|
|
@@ -8622,9 +8876,10 @@
|
|
|
8622
8876
|
},
|
|
8623
8877
|
"x-original-maxLength": 1024,
|
|
8624
8878
|
"x-reconciled-from-discovery": true,
|
|
8625
|
-
"x-reconciled-at": "2026-01-
|
|
8879
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180388+00:00"
|
|
8626
8880
|
}
|
|
8627
8881
|
},
|
|
8882
|
+
"x-f5xc-description-short": "Tuple with a suggested value and it's description.",
|
|
8628
8883
|
"x-f5xc-minimum-configuration": {
|
|
8629
8884
|
"description": "Minimum configuration for namespaceSuggestedItem",
|
|
8630
8885
|
"required_fields": [
|
|
@@ -8647,6 +8902,7 @@
|
|
|
8647
8902
|
"title": "Empty",
|
|
8648
8903
|
"x-displayname": "Empty",
|
|
8649
8904
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
8905
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
8650
8906
|
"x-f5xc-minimum-configuration": {
|
|
8651
8907
|
"description": "Minimum configuration for schemaEmpty",
|
|
8652
8908
|
"required_fields": [],
|
|
@@ -8668,6 +8924,7 @@
|
|
|
8668
8924
|
"default": "DISABLE",
|
|
8669
8925
|
"x-displayname": "Status type.",
|
|
8670
8926
|
"x-ves-proto-enum": "ves.io.schema.shape.data_delivery.StatusType",
|
|
8927
|
+
"x-f5xc-description-short": "Type of Status - DISABLE: DISABLE Disable Receiver - ENABLE: ENABLE Enable Receiver.",
|
|
8671
8928
|
"x-f5xc-minimum-configuration": {
|
|
8672
8929
|
"description": "Minimum configuration for shapedata_deliveryStatusType",
|
|
8673
8930
|
"required_fields": [],
|
|
@@ -8684,6 +8941,7 @@
|
|
|
8684
8941
|
"title": "SubscribeRequest.",
|
|
8685
8942
|
"x-displayname": "Subscribe Request.",
|
|
8686
8943
|
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.SubscribeRequest",
|
|
8944
|
+
"x-f5xc-description-short": "Request of subscribe to Data-Intelligence.",
|
|
8687
8945
|
"x-f5xc-minimum-configuration": {
|
|
8688
8946
|
"description": "Minimum configuration for subscriptionSubscribeRequest",
|
|
8689
8947
|
"required_fields": [],
|
|
@@ -8700,6 +8958,7 @@
|
|
|
8700
8958
|
"title": "SubscribeResponse.",
|
|
8701
8959
|
"x-displayname": "Subscribe Response.",
|
|
8702
8960
|
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.SubscribeResponse",
|
|
8961
|
+
"x-f5xc-description-short": "Response of subscribe to Data-Intelligence.",
|
|
8703
8962
|
"x-f5xc-minimum-configuration": {
|
|
8704
8963
|
"description": "Minimum configuration for subscriptionSubscribeResponse",
|
|
8705
8964
|
"required_fields": [],
|
|
@@ -8716,6 +8975,7 @@
|
|
|
8716
8975
|
"title": "UnsubscribeRequest.",
|
|
8717
8976
|
"x-displayname": "Unsubscribe Request.",
|
|
8718
8977
|
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.UnsubscribeRequest",
|
|
8978
|
+
"x-f5xc-description-short": "Request of unsubscribe to Data-Intelligence.",
|
|
8719
8979
|
"x-f5xc-minimum-configuration": {
|
|
8720
8980
|
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
|
|
8721
8981
|
"required_fields": [],
|
|
@@ -8732,6 +8992,7 @@
|
|
|
8732
8992
|
"title": "UnsubscribeResponse.",
|
|
8733
8993
|
"x-displayname": "Unsubscribe Response.",
|
|
8734
8994
|
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.UnsubscribeResponse",
|
|
8995
|
+
"x-f5xc-description-short": "Response of unsubscribe to Data-Intelligence.",
|
|
8735
8996
|
"x-f5xc-minimum-configuration": {
|
|
8736
8997
|
"description": "Minimum configuration for subscriptionUnsubscribeResponse",
|
|
8737
8998
|
"required_fields": [],
|