@robinmordasiewicz/f5xc-api-mcp 2.0.10-2601051503 → 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/CHANGELOG.md +25 -14
- package/README.md +9 -5
- package/dist/generator/domain-metadata.d.ts +1 -3
- package/dist/generator/domain-metadata.d.ts.map +1 -1
- package/dist/generator/domain-metadata.js +0 -20
- package/dist/generator/domain-metadata.js.map +1 -1
- package/dist/generator/naming/acronyms.d.ts +1 -1
- package/dist/generator/naming/acronyms.js +1 -1
- 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 +176 -26
- package/specs/domains/ai_services.json +242 -36
- package/specs/domains/api.json +1507 -183
- package/specs/domains/authentication.json +358 -46
- package/specs/domains/bigip.json +825 -105
- package/specs/domains/billing_and_usage.json +666 -83
- package/specs/domains/blindfold.json +988 -111
- package/specs/domains/bot_and_threat_defense.json +550 -66
- package/specs/domains/cdn.json +2431 -198
- package/specs/domains/ce_management.json +9272 -15726
- package/specs/domains/certificates.json +540 -78
- package/specs/domains/cloud_infrastructure.json +1102 -122
- package/specs/domains/container_services.json +782 -99
- package/specs/domains/data_and_privacy_security.json +508 -68
- package/specs/domains/data_intelligence.json +487 -64
- package/specs/domains/ddos.json +1302 -161
- package/specs/domains/dns.json +1286 -162
- package/specs/domains/managed_kubernetes.json +687 -89
- package/specs/domains/marketplace.json +994 -105
- package/specs/domains/network.json +2340 -239
- package/specs/domains/network_security.json +1963 -192
- package/specs/domains/nginx_one.json +475 -63
- package/specs/domains/object_storage.json +163 -16
- package/specs/domains/observability.json +1519 -148
- package/specs/domains/rate_limiting.json +456 -56
- package/specs/domains/secops_and_incident_response.json +275 -37
- package/specs/domains/service_mesh.json +1320 -128
- package/specs/domains/shape.json +4196 -398
- package/specs/domains/sites.json +5053 -405
- package/specs/domains/statistics.json +2784 -236
- package/specs/domains/support.json +1038 -109
- package/specs/domains/telemetry_and_insights.json +993 -80
- package/specs/domains/tenant_and_identity.json +3487 -313
- package/specs/domains/threat_campaign.json +695 -72
- package/specs/domains/users.json +437 -72
- package/specs/domains/virtual.json +3716 -261
- package/specs/domains/vpm_and_node_management.json +61 -2
- package/specs/domains/waf.json +1551 -149
- package/specs/index.json +121 -26
|
@@ -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"
|
|
@@ -12,7 +12,57 @@
|
|
|
12
12
|
"name": "Proprietary",
|
|
13
13
|
"url": "https://www.f5.com/company/policies/eula"
|
|
14
14
|
},
|
|
15
|
-
"x-f5xc-cli-domain": "data_intelligence"
|
|
15
|
+
"x-f5xc-cli-domain": "data_intelligence",
|
|
16
|
+
"x-f5xc-best-practices": {
|
|
17
|
+
"common_errors": [
|
|
18
|
+
{
|
|
19
|
+
"code": 400,
|
|
20
|
+
"message": "Invalid request body",
|
|
21
|
+
"resolution": "Validate JSON structure and required fields before submission",
|
|
22
|
+
"prevention": "Use schema validation from OpenAPI spec"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"code": 401,
|
|
26
|
+
"message": "Authentication failed",
|
|
27
|
+
"resolution": "Verify API token is valid and not expired",
|
|
28
|
+
"prevention": "Use environment variables for token management"
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"code": 403,
|
|
32
|
+
"message": "Permission denied",
|
|
33
|
+
"resolution": "Check user role and namespace permissions",
|
|
34
|
+
"prevention": "Verify RBAC policies before operations"
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"code": 404,
|
|
38
|
+
"message": "Resource not found",
|
|
39
|
+
"resolution": "Verify resource name and namespace exist",
|
|
40
|
+
"prevention": "List resources before attempting operations"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"code": 409,
|
|
44
|
+
"message": "Resource already exists",
|
|
45
|
+
"resolution": "Use unique name or delete existing resource",
|
|
46
|
+
"prevention": "Check existence before creation"
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"code": 429,
|
|
50
|
+
"message": "Rate limit exceeded",
|
|
51
|
+
"resolution": "Implement exponential backoff and retry logic",
|
|
52
|
+
"prevention": "Batch operations and add delays between requests"
|
|
53
|
+
}
|
|
54
|
+
],
|
|
55
|
+
"security_notes": [
|
|
56
|
+
"Always use HTTPS for all API communications",
|
|
57
|
+
"Store API tokens securely, never in source code",
|
|
58
|
+
"Rotate API tokens regularly following security policies"
|
|
59
|
+
],
|
|
60
|
+
"performance_tips": [
|
|
61
|
+
"Use pagination for large result sets",
|
|
62
|
+
"Batch related operations when possible",
|
|
63
|
+
"Cache read-only responses appropriately"
|
|
64
|
+
]
|
|
65
|
+
}
|
|
16
66
|
},
|
|
17
67
|
"servers": [
|
|
18
68
|
{
|
|
@@ -275,6 +325,13 @@
|
|
|
275
325
|
"latency": "low",
|
|
276
326
|
"resource_usage": "low"
|
|
277
327
|
}
|
|
328
|
+
},
|
|
329
|
+
"x-f5xc-discovered-response-time": {
|
|
330
|
+
"p50_ms": 1000,
|
|
331
|
+
"p95_ms": 3000,
|
|
332
|
+
"p99_ms": 8000,
|
|
333
|
+
"sample_count": 0,
|
|
334
|
+
"source": "estimate"
|
|
278
335
|
}
|
|
279
336
|
},
|
|
280
337
|
"x-displayname": "Data Delivery.",
|
|
@@ -497,6 +554,13 @@
|
|
|
497
554
|
"latency": "low",
|
|
498
555
|
"resource_usage": "low"
|
|
499
556
|
}
|
|
557
|
+
},
|
|
558
|
+
"x-f5xc-discovered-response-time": {
|
|
559
|
+
"p50_ms": 800,
|
|
560
|
+
"p95_ms": 2500,
|
|
561
|
+
"p99_ms": 6000,
|
|
562
|
+
"sample_count": 0,
|
|
563
|
+
"source": "estimate"
|
|
500
564
|
}
|
|
501
565
|
},
|
|
502
566
|
"x-displayname": "Data Delivery.",
|
|
@@ -724,6 +788,13 @@
|
|
|
724
788
|
"latency": "moderate",
|
|
725
789
|
"resource_usage": "moderate"
|
|
726
790
|
}
|
|
791
|
+
},
|
|
792
|
+
"x-f5xc-discovered-response-time": {
|
|
793
|
+
"p50_ms": 200,
|
|
794
|
+
"p95_ms": 800,
|
|
795
|
+
"p99_ms": 2000,
|
|
796
|
+
"sample_count": 0,
|
|
797
|
+
"source": "estimate"
|
|
727
798
|
}
|
|
728
799
|
},
|
|
729
800
|
"x-displayname": "Data Delivery.",
|
|
@@ -945,6 +1016,13 @@
|
|
|
945
1016
|
"latency": "low",
|
|
946
1017
|
"resource_usage": "low"
|
|
947
1018
|
}
|
|
1019
|
+
},
|
|
1020
|
+
"x-f5xc-discovered-response-time": {
|
|
1021
|
+
"p50_ms": 200,
|
|
1022
|
+
"p95_ms": 800,
|
|
1023
|
+
"p99_ms": 2000,
|
|
1024
|
+
"sample_count": 0,
|
|
1025
|
+
"source": "estimate"
|
|
948
1026
|
}
|
|
949
1027
|
},
|
|
950
1028
|
"delete": {
|
|
@@ -1164,6 +1242,13 @@
|
|
|
1164
1242
|
"latency": "high",
|
|
1165
1243
|
"resource_usage": "moderate"
|
|
1166
1244
|
}
|
|
1245
|
+
},
|
|
1246
|
+
"x-f5xc-discovered-response-time": {
|
|
1247
|
+
"p50_ms": 500,
|
|
1248
|
+
"p95_ms": 1500,
|
|
1249
|
+
"p99_ms": 4000,
|
|
1250
|
+
"sample_count": 0,
|
|
1251
|
+
"source": "estimate"
|
|
1167
1252
|
}
|
|
1168
1253
|
},
|
|
1169
1254
|
"x-displayname": "Data Delivery.",
|
|
@@ -1334,6 +1419,13 @@
|
|
|
1334
1419
|
"latency": "moderate",
|
|
1335
1420
|
"resource_usage": "moderate"
|
|
1336
1421
|
}
|
|
1422
|
+
},
|
|
1423
|
+
"x-f5xc-discovered-response-time": {
|
|
1424
|
+
"p50_ms": 200,
|
|
1425
|
+
"p95_ms": 800,
|
|
1426
|
+
"p99_ms": 2000,
|
|
1427
|
+
"sample_count": 0,
|
|
1428
|
+
"source": "estimate"
|
|
1337
1429
|
}
|
|
1338
1430
|
},
|
|
1339
1431
|
"x-displayname": "Data Delivery APIs.",
|
|
@@ -1522,6 +1614,13 @@
|
|
|
1522
1614
|
"latency": "low",
|
|
1523
1615
|
"resource_usage": "low"
|
|
1524
1616
|
}
|
|
1617
|
+
},
|
|
1618
|
+
"x-f5xc-discovered-response-time": {
|
|
1619
|
+
"p50_ms": 200,
|
|
1620
|
+
"p95_ms": 800,
|
|
1621
|
+
"p99_ms": 2000,
|
|
1622
|
+
"sample_count": 0,
|
|
1623
|
+
"source": "estimate"
|
|
1525
1624
|
}
|
|
1526
1625
|
},
|
|
1527
1626
|
"x-displayname": "Data Delivery APIs.",
|
|
@@ -1721,6 +1820,13 @@
|
|
|
1721
1820
|
"latency": "low",
|
|
1722
1821
|
"resource_usage": "low"
|
|
1723
1822
|
}
|
|
1823
|
+
},
|
|
1824
|
+
"x-f5xc-discovered-response-time": {
|
|
1825
|
+
"p50_ms": 1000,
|
|
1826
|
+
"p95_ms": 3000,
|
|
1827
|
+
"p99_ms": 8000,
|
|
1828
|
+
"sample_count": 0,
|
|
1829
|
+
"source": "estimate"
|
|
1724
1830
|
}
|
|
1725
1831
|
},
|
|
1726
1832
|
"x-displayname": "Data Delivery APIs.",
|
|
@@ -1909,6 +2015,13 @@
|
|
|
1909
2015
|
"latency": "moderate",
|
|
1910
2016
|
"resource_usage": "moderate"
|
|
1911
2017
|
}
|
|
2018
|
+
},
|
|
2019
|
+
"x-f5xc-discovered-response-time": {
|
|
2020
|
+
"p50_ms": 200,
|
|
2021
|
+
"p95_ms": 800,
|
|
2022
|
+
"p99_ms": 2000,
|
|
2023
|
+
"sample_count": 0,
|
|
2024
|
+
"source": "estimate"
|
|
1912
2025
|
}
|
|
1913
2026
|
},
|
|
1914
2027
|
"x-displayname": "Data Delivery APIs.",
|
|
@@ -2097,6 +2210,13 @@
|
|
|
2097
2210
|
"latency": "moderate",
|
|
2098
2211
|
"resource_usage": "moderate"
|
|
2099
2212
|
}
|
|
2213
|
+
},
|
|
2214
|
+
"x-f5xc-discovered-response-time": {
|
|
2215
|
+
"p50_ms": 200,
|
|
2216
|
+
"p95_ms": 800,
|
|
2217
|
+
"p99_ms": 2000,
|
|
2218
|
+
"sample_count": 0,
|
|
2219
|
+
"source": "estimate"
|
|
2100
2220
|
}
|
|
2101
2221
|
},
|
|
2102
2222
|
"x-displayname": "Data Delivery APIs.",
|
|
@@ -2311,6 +2431,13 @@
|
|
|
2311
2431
|
"latency": "low",
|
|
2312
2432
|
"resource_usage": "low"
|
|
2313
2433
|
}
|
|
2434
|
+
},
|
|
2435
|
+
"x-f5xc-discovered-response-time": {
|
|
2436
|
+
"p50_ms": 1000,
|
|
2437
|
+
"p95_ms": 3000,
|
|
2438
|
+
"p99_ms": 8000,
|
|
2439
|
+
"sample_count": 0,
|
|
2440
|
+
"source": "estimate"
|
|
2314
2441
|
}
|
|
2315
2442
|
},
|
|
2316
2443
|
"x-displayname": "Data Delivery APIs.",
|
|
@@ -2538,6 +2665,13 @@
|
|
|
2538
2665
|
"latency": "low",
|
|
2539
2666
|
"resource_usage": "low"
|
|
2540
2667
|
}
|
|
2668
|
+
},
|
|
2669
|
+
"x-f5xc-discovered-response-time": {
|
|
2670
|
+
"p50_ms": 1000,
|
|
2671
|
+
"p95_ms": 3000,
|
|
2672
|
+
"p99_ms": 8000,
|
|
2673
|
+
"sample_count": 0,
|
|
2674
|
+
"source": "estimate"
|
|
2541
2675
|
}
|
|
2542
2676
|
},
|
|
2543
2677
|
"x-displayname": "Data Delivery APIs.",
|
|
@@ -2765,6 +2899,13 @@
|
|
|
2765
2899
|
"latency": "low",
|
|
2766
2900
|
"resource_usage": "low"
|
|
2767
2901
|
}
|
|
2902
|
+
},
|
|
2903
|
+
"x-f5xc-discovered-response-time": {
|
|
2904
|
+
"p50_ms": 1000,
|
|
2905
|
+
"p95_ms": 3000,
|
|
2906
|
+
"p99_ms": 8000,
|
|
2907
|
+
"sample_count": 0,
|
|
2908
|
+
"source": "estimate"
|
|
2768
2909
|
}
|
|
2769
2910
|
},
|
|
2770
2911
|
"x-displayname": "Data Delivery APIs.",
|
|
@@ -2979,6 +3120,13 @@
|
|
|
2979
3120
|
"latency": "low",
|
|
2980
3121
|
"resource_usage": "low"
|
|
2981
3122
|
}
|
|
3123
|
+
},
|
|
3124
|
+
"x-f5xc-discovered-response-time": {
|
|
3125
|
+
"p50_ms": 1000,
|
|
3126
|
+
"p95_ms": 3000,
|
|
3127
|
+
"p99_ms": 8000,
|
|
3128
|
+
"sample_count": 0,
|
|
3129
|
+
"source": "estimate"
|
|
2982
3130
|
}
|
|
2983
3131
|
},
|
|
2984
3132
|
"x-displayname": "Data Delivery APIs.",
|
|
@@ -3178,6 +3326,13 @@
|
|
|
3178
3326
|
"latency": "low",
|
|
3179
3327
|
"resource_usage": "low"
|
|
3180
3328
|
}
|
|
3329
|
+
},
|
|
3330
|
+
"x-f5xc-discovered-response-time": {
|
|
3331
|
+
"p50_ms": 1000,
|
|
3332
|
+
"p95_ms": 3000,
|
|
3333
|
+
"p99_ms": 8000,
|
|
3334
|
+
"sample_count": 0,
|
|
3335
|
+
"source": "estimate"
|
|
3181
3336
|
}
|
|
3182
3337
|
},
|
|
3183
3338
|
"x-displayname": "Data Intelligence Subscription API.",
|
|
@@ -3377,6 +3532,13 @@
|
|
|
3377
3532
|
"latency": "low",
|
|
3378
3533
|
"resource_usage": "low"
|
|
3379
3534
|
}
|
|
3535
|
+
},
|
|
3536
|
+
"x-f5xc-discovered-response-time": {
|
|
3537
|
+
"p50_ms": 1000,
|
|
3538
|
+
"p95_ms": 3000,
|
|
3539
|
+
"p99_ms": 8000,
|
|
3540
|
+
"sample_count": 0,
|
|
3541
|
+
"source": "estimate"
|
|
3380
3542
|
}
|
|
3381
3543
|
},
|
|
3382
3544
|
"x-displayname": "Data Intelligence Subscription API.",
|
|
@@ -3400,6 +3562,7 @@
|
|
|
3400
3562
|
"title": "Empty",
|
|
3401
3563
|
"x-displayname": "Empty",
|
|
3402
3564
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
3565
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
3403
3566
|
"x-f5xc-minimum-configuration": {
|
|
3404
3567
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
3405
3568
|
"required_fields": [],
|
|
@@ -3424,6 +3587,8 @@
|
|
|
3424
3587
|
"x-displayname": "Kind",
|
|
3425
3588
|
"x-ves-example": "Virtual_site.",
|
|
3426
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\").",
|
|
3427
3592
|
"minLength": 0,
|
|
3428
3593
|
"maxLength": 14,
|
|
3429
3594
|
"x-f5xc-required-for": {
|
|
@@ -3435,7 +3600,7 @@
|
|
|
3435
3600
|
"readOnly": true,
|
|
3436
3601
|
"x-original-maxLength": 1024,
|
|
3437
3602
|
"x-reconciled-from-discovery": true,
|
|
3438
|
-
"x-reconciled-at": "2026-01-
|
|
3603
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816610+00:00"
|
|
3439
3604
|
},
|
|
3440
3605
|
"name": {
|
|
3441
3606
|
"type": "string",
|
|
@@ -3444,6 +3609,8 @@
|
|
|
3444
3609
|
"x-displayname": "Name",
|
|
3445
3610
|
"x-ves-example": "Contactus-route.",
|
|
3446
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.",
|
|
3447
3614
|
"minLength": 0,
|
|
3448
3615
|
"maxLength": 16,
|
|
3449
3616
|
"x-f5xc-required-for": {
|
|
@@ -3454,7 +3621,7 @@
|
|
|
3454
3621
|
},
|
|
3455
3622
|
"x-original-maxLength": 1024,
|
|
3456
3623
|
"x-reconciled-from-discovery": true,
|
|
3457
|
-
"x-reconciled-at": "2026-01-
|
|
3624
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816617+00:00"
|
|
3458
3625
|
},
|
|
3459
3626
|
"namespace": {
|
|
3460
3627
|
"type": "string",
|
|
@@ -3463,6 +3630,8 @@
|
|
|
3463
3630
|
"x-displayname": "Namespace",
|
|
3464
3631
|
"x-ves-example": "Ns1",
|
|
3465
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.",
|
|
3466
3635
|
"minLength": 0,
|
|
3467
3636
|
"maxLength": 6,
|
|
3468
3637
|
"x-f5xc-required-for": {
|
|
@@ -3473,7 +3642,7 @@
|
|
|
3473
3642
|
},
|
|
3474
3643
|
"x-original-maxLength": 1024,
|
|
3475
3644
|
"x-reconciled-from-discovery": true,
|
|
3476
|
-
"x-reconciled-at": "2026-01-
|
|
3645
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816622+00:00"
|
|
3477
3646
|
},
|
|
3478
3647
|
"tenant": {
|
|
3479
3648
|
"type": "string",
|
|
@@ -3482,6 +3651,8 @@
|
|
|
3482
3651
|
"x-displayname": "Tenant",
|
|
3483
3652
|
"x-ves-example": "Example-corp.",
|
|
3484
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.",
|
|
3485
3656
|
"minLength": 0,
|
|
3486
3657
|
"maxLength": 18,
|
|
3487
3658
|
"x-f5xc-required-for": {
|
|
@@ -3494,7 +3665,7 @@
|
|
|
3494
3665
|
"x-field-mutability": "read-only",
|
|
3495
3666
|
"x-original-maxLength": 1024,
|
|
3496
3667
|
"x-reconciled-from-discovery": true,
|
|
3497
|
-
"x-reconciled-at": "2026-01-
|
|
3668
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816627+00:00"
|
|
3498
3669
|
},
|
|
3499
3670
|
"uid": {
|
|
3500
3671
|
"type": "string",
|
|
@@ -3503,6 +3674,8 @@
|
|
|
3503
3674
|
"x-displayname": "UID",
|
|
3504
3675
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
3505
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.",
|
|
3506
3679
|
"minLength": 0,
|
|
3507
3680
|
"maxLength": 36,
|
|
3508
3681
|
"x-f5xc-required-for": {
|
|
@@ -3516,9 +3689,11 @@
|
|
|
3516
3689
|
"x-original-maxLength": 1024,
|
|
3517
3690
|
"format": "uuid",
|
|
3518
3691
|
"x-reconciled-from-discovery": true,
|
|
3519
|
-
"x-reconciled-at": "2026-01-
|
|
3692
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816633+00:00"
|
|
3520
3693
|
}
|
|
3521
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...",
|
|
3522
3697
|
"x-f5xc-minimum-configuration": {
|
|
3523
3698
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
3524
3699
|
"required_fields": [
|
|
@@ -3542,6 +3717,8 @@
|
|
|
3542
3717
|
"type_url": {
|
|
3543
3718
|
"type": "string",
|
|
3544
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 ).",
|
|
3545
3722
|
"minLength": 0,
|
|
3546
3723
|
"maxLength": 1024,
|
|
3547
3724
|
"x-f5xc-required-for": {
|
|
@@ -3565,9 +3742,11 @@
|
|
|
3565
3742
|
},
|
|
3566
3743
|
"x-original-maxLength": 1024,
|
|
3567
3744
|
"x-reconciled-from-discovery": true,
|
|
3568
|
-
"x-reconciled-at": "2026-01-
|
|
3745
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816640+00:00"
|
|
3569
3746
|
}
|
|
3570
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...",
|
|
3571
3750
|
"x-f5xc-minimum-configuration": {
|
|
3572
3751
|
"description": "Minimum configuration for protobufAny",
|
|
3573
3752
|
"required_fields": [
|
|
@@ -3642,6 +3821,7 @@
|
|
|
3642
3821
|
"ves.io.schema.rules.string.min_len": "3",
|
|
3643
3822
|
"ves.io.schema.rules.string.pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$"
|
|
3644
3823
|
},
|
|
3824
|
+
"x-f5xc-description-short": "Container Name is the name of the container into which logs should be stored Required: YES.",
|
|
3645
3825
|
"x-f5xc-required-for": {
|
|
3646
3826
|
"minimum_config": false,
|
|
3647
3827
|
"create": false,
|
|
@@ -3650,6 +3830,7 @@
|
|
|
3650
3830
|
}
|
|
3651
3831
|
}
|
|
3652
3832
|
},
|
|
3833
|
+
"x-f5xc-description-short": "Azure Blob Configuration for Data Delivery.",
|
|
3653
3834
|
"x-f5xc-minimum-configuration": {
|
|
3654
3835
|
"description": "Minimum configuration for receiverAzureBlobConfig",
|
|
3655
3836
|
"required_fields": [
|
|
@@ -3678,6 +3859,8 @@
|
|
|
3678
3859
|
"description": "X-displayName: \"Event Hubs Instance\"\nx-required\nEvent Hubs Instance name into which logs should be stored.",
|
|
3679
3860
|
"title": "Event Hubs Instance.",
|
|
3680
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.",
|
|
3681
3864
|
"minLength": 0,
|
|
3682
3865
|
"maxLength": 1024,
|
|
3683
3866
|
"x-f5xc-required-for": {
|
|
@@ -3692,6 +3875,8 @@
|
|
|
3692
3875
|
"description": "X-displayName: \"Event Hubs Namespace\"\nx-required\nEvent Hubs Namespace is namespace with instance into which logs should be stored.",
|
|
3693
3876
|
"title": "Event Hubs Namespace.",
|
|
3694
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.",
|
|
3695
3880
|
"minLength": 0,
|
|
3696
3881
|
"maxLength": 6,
|
|
3697
3882
|
"x-f5xc-required-for": {
|
|
@@ -3702,9 +3887,10 @@
|
|
|
3702
3887
|
},
|
|
3703
3888
|
"x-original-maxLength": 1024,
|
|
3704
3889
|
"x-reconciled-from-discovery": true,
|
|
3705
|
-
"x-reconciled-at": "2026-01-
|
|
3890
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816656+00:00"
|
|
3706
3891
|
}
|
|
3707
3892
|
},
|
|
3893
|
+
"x-f5xc-description-short": "X-displayName: \"Azure Event Hubs Configuration\" Azure Event Hubs Configuration for Data Delivery.",
|
|
3708
3894
|
"x-f5xc-minimum-configuration": {
|
|
3709
3895
|
"description": "Minimum configuration for receiverAzureEventHubsConfig",
|
|
3710
3896
|
"required_fields": [
|
|
@@ -3748,6 +3934,8 @@
|
|
|
3748
3934
|
"ves.io.schema.rules.uint32.gte": "4096",
|
|
3749
3935
|
"ves.io.schema.rules.uint32.lte": "104857600"
|
|
3750
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.",
|
|
3751
3939
|
"minimum": 0,
|
|
3752
3940
|
"maximum": 2147483647,
|
|
3753
3941
|
"x-f5xc-required-for": {
|
|
@@ -3776,6 +3964,8 @@
|
|
|
3776
3964
|
"ves.io.schema.rules.uint32.gte": "32",
|
|
3777
3965
|
"ves.io.schema.rules.uint32.lte": "100000"
|
|
3778
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.",
|
|
3779
3969
|
"minimum": 0,
|
|
3780
3970
|
"maximum": 2147483647,
|
|
3781
3971
|
"x-f5xc-required-for": {
|
|
@@ -3802,6 +3992,7 @@
|
|
|
3802
3992
|
"x-validation-rules": {
|
|
3803
3993
|
"ves.io.schema.rules.uint32.ranges": "300-3600"
|
|
3804
3994
|
},
|
|
3995
|
+
"x-f5xc-description-short": "Exclusive with [default_timeout_seconds] Send batch to the endpoint after this many seconds.",
|
|
3805
3996
|
"minLength": 0,
|
|
3806
3997
|
"maxLength": 1024,
|
|
3807
3998
|
"x-f5xc-required-for": {
|
|
@@ -3812,6 +4003,7 @@
|
|
|
3812
4003
|
}
|
|
3813
4004
|
}
|
|
3814
4005
|
},
|
|
4006
|
+
"x-f5xc-description-short": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.",
|
|
3815
4007
|
"x-f5xc-minimum-configuration": {
|
|
3816
4008
|
"description": "Minimum configuration for receiverBatchOptionType",
|
|
3817
4009
|
"required_fields": [
|
|
@@ -4006,6 +4198,7 @@
|
|
|
4006
4198
|
"x-displayname": "Datadog Endpoint.",
|
|
4007
4199
|
"x-ves-example": "example.com:9000.",
|
|
4008
4200
|
"x-f5xc-example": "example.com:9000",
|
|
4201
|
+
"x-f5xc-description-short": "Exclusive with [site] Datadog Endpoint,.",
|
|
4009
4202
|
"minLength": 0,
|
|
4010
4203
|
"maxLength": 1024,
|
|
4011
4204
|
"x-f5xc-required-for": {
|
|
@@ -4031,6 +4224,7 @@
|
|
|
4031
4224
|
"x-validation-rules": {
|
|
4032
4225
|
"ves.io.schema.rules.string.hostname_or_ip": "true"
|
|
4033
4226
|
},
|
|
4227
|
+
"x-f5xc-description-short": "Exclusive with [endpoint] Datadog Site,.",
|
|
4034
4228
|
"minLength": 0,
|
|
4035
4229
|
"maxLength": 1024,
|
|
4036
4230
|
"x-f5xc-required-for": {
|
|
@@ -4075,6 +4269,7 @@
|
|
|
4075
4269
|
"title": "Fail_if_referred.",
|
|
4076
4270
|
"format": "boolean",
|
|
4077
4271
|
"x-displayname": "Fail-If-Referred.",
|
|
4272
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
4078
4273
|
"x-f5xc-required-for": {
|
|
4079
4274
|
"minimum_config": false,
|
|
4080
4275
|
"create": false,
|
|
@@ -4099,7 +4294,7 @@
|
|
|
4099
4294
|
},
|
|
4100
4295
|
"x-original-maxLength": 1024,
|
|
4101
4296
|
"x-reconciled-from-discovery": true,
|
|
4102
|
-
"x-reconciled-at": "2026-01-
|
|
4297
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816697+00:00"
|
|
4103
4298
|
},
|
|
4104
4299
|
"namespace": {
|
|
4105
4300
|
"type": "string",
|
|
@@ -4108,6 +4303,7 @@
|
|
|
4108
4303
|
"x-displayname": "Namespace",
|
|
4109
4304
|
"x-ves-example": "Ns1",
|
|
4110
4305
|
"x-f5xc-example": "ns1",
|
|
4306
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
4111
4307
|
"minLength": 0,
|
|
4112
4308
|
"maxLength": 6,
|
|
4113
4309
|
"x-f5xc-required-for": {
|
|
@@ -4118,7 +4314,7 @@
|
|
|
4118
4314
|
},
|
|
4119
4315
|
"x-original-maxLength": 1024,
|
|
4120
4316
|
"x-reconciled-from-discovery": true,
|
|
4121
|
-
"x-reconciled-at": "2026-01-
|
|
4317
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816701+00:00"
|
|
4122
4318
|
}
|
|
4123
4319
|
},
|
|
4124
4320
|
"x-f5xc-minimum-configuration": {
|
|
@@ -4181,6 +4377,7 @@
|
|
|
4181
4377
|
"$ref": "#/components/schemas/schemaviewsObjectRefType"
|
|
4182
4378
|
}
|
|
4183
4379
|
},
|
|
4380
|
+
"x-f5xc-description-short": "GCP Bucket Configuration for Global Log Receiver.",
|
|
4184
4381
|
"x-f5xc-minimum-configuration": {
|
|
4185
4382
|
"description": "Minimum configuration for receiverGCPBucketConfig",
|
|
4186
4383
|
"required_fields": [
|
|
@@ -4214,6 +4411,7 @@
|
|
|
4214
4411
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4215
4412
|
},
|
|
4216
4413
|
"x-displayname": "Deleted Referred Objects.",
|
|
4414
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4217
4415
|
"x-f5xc-required-for": {
|
|
4218
4416
|
"minimum_config": false,
|
|
4219
4417
|
"create": false,
|
|
@@ -4229,6 +4427,7 @@
|
|
|
4229
4427
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4230
4428
|
},
|
|
4231
4429
|
"x-displayname": "Disabled Referred Objects.",
|
|
4430
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4232
4431
|
"x-f5xc-required-for": {
|
|
4233
4432
|
"minimum_config": false,
|
|
4234
4433
|
"create": false,
|
|
@@ -4247,6 +4446,7 @@
|
|
|
4247
4446
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4248
4447
|
},
|
|
4249
4448
|
"x-displayname": "Referring Objects.",
|
|
4449
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
4250
4450
|
"x-f5xc-required-for": {
|
|
4251
4451
|
"minimum_config": false,
|
|
4252
4452
|
"create": false,
|
|
@@ -4268,6 +4468,8 @@
|
|
|
4268
4468
|
"$ref": "#/components/schemas/receiverStatusObject"
|
|
4269
4469
|
},
|
|
4270
4470
|
"x-displayname": "Status",
|
|
4471
|
+
"x-f5xc-example": "active",
|
|
4472
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
4271
4473
|
"x-f5xc-required-for": {
|
|
4272
4474
|
"minimum_config": false,
|
|
4273
4475
|
"create": false,
|
|
@@ -4277,7 +4479,7 @@
|
|
|
4277
4479
|
"maxLength": 17,
|
|
4278
4480
|
"minLength": 17,
|
|
4279
4481
|
"x-reconciled-from-discovery": true,
|
|
4280
|
-
"x-reconciled-at": "2026-01-
|
|
4482
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816720+00:00"
|
|
4281
4483
|
},
|
|
4282
4484
|
"system_metadata": {
|
|
4283
4485
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -4317,6 +4519,8 @@
|
|
|
4317
4519
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
4318
4520
|
],
|
|
4319
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...",
|
|
4320
4524
|
"x-f5xc-minimum-configuration": {
|
|
4321
4525
|
"description": "Minimum configuration for receiverGetResponseFormatCode",
|
|
4322
4526
|
"required_fields": [],
|
|
@@ -4380,6 +4584,7 @@
|
|
|
4380
4584
|
"ves.io.schema.rules.message.required": "true",
|
|
4381
4585
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Pending\\\"]"
|
|
4382
4586
|
},
|
|
4587
|
+
"x-f5xc-description-short": "Delivery Status i.e Success/ Failed/ Pending Required: YES.",
|
|
4383
4588
|
"minLength": 0,
|
|
4384
4589
|
"maxLength": 1024,
|
|
4385
4590
|
"x-f5xc-required-for": {
|
|
@@ -4396,6 +4601,7 @@
|
|
|
4396
4601
|
"x-displayname": "Frequency",
|
|
4397
4602
|
"x-ves-example": "300",
|
|
4398
4603
|
"x-f5xc-example": "300",
|
|
4604
|
+
"x-f5xc-description-short": "Deliver logs at this frequency. Default is 5 min (300 seconds)",
|
|
4399
4605
|
"minLength": 0,
|
|
4400
4606
|
"maxLength": 1024,
|
|
4401
4607
|
"x-f5xc-required-for": {
|
|
@@ -4418,6 +4624,7 @@
|
|
|
4418
4624
|
"x-displayname": "Last Sent",
|
|
4419
4625
|
"x-ves-example": "2021-09-21:44:34.171543432Z.",
|
|
4420
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.",
|
|
4421
4628
|
"minLength": 0,
|
|
4422
4629
|
"maxLength": 1024,
|
|
4423
4630
|
"x-f5xc-required-for": {
|
|
@@ -4442,6 +4649,7 @@
|
|
|
4442
4649
|
"ves.io.schema.rules.message.required": "true",
|
|
4443
4650
|
"ves.io.schema.rules.string.in": "[\\\"Enabled\\\",\\\"Disabled\\\"]"
|
|
4444
4651
|
},
|
|
4652
|
+
"x-f5xc-description-short": "State of the Receiver i.e Enabled/ Disabled Required: YES.",
|
|
4445
4653
|
"minLength": 0,
|
|
4446
4654
|
"maxLength": 1024,
|
|
4447
4655
|
"x-f5xc-required-for": {
|
|
@@ -4523,6 +4731,7 @@
|
|
|
4523
4731
|
"ves.io.schema.rules.message.required": "true",
|
|
4524
4732
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
4525
4733
|
},
|
|
4734
|
+
"x-f5xc-description-short": "HTTP URI is the URI of the HTTP endpoint to send logs to, Required: YES.",
|
|
4526
4735
|
"minLength": 0,
|
|
4527
4736
|
"maxLength": 1024,
|
|
4528
4737
|
"x-f5xc-required-for": {
|
|
@@ -4588,6 +4797,7 @@
|
|
|
4588
4797
|
}
|
|
4589
4798
|
}
|
|
4590
4799
|
},
|
|
4800
|
+
"x-f5xc-description-short": "Authentication parameters to access HTTP Log Receiver Endpoint.",
|
|
4591
4801
|
"x-f5xc-minimum-configuration": {
|
|
4592
4802
|
"description": "Minimum configuration for receiverHttpAuthBasic",
|
|
4593
4803
|
"required_fields": [
|
|
@@ -4616,6 +4826,7 @@
|
|
|
4616
4826
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
4617
4827
|
},
|
|
4618
4828
|
"x-displayname": "Errors",
|
|
4829
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
4619
4830
|
"x-f5xc-required-for": {
|
|
4620
4831
|
"minimum_config": false,
|
|
4621
4832
|
"create": false,
|
|
@@ -4631,6 +4842,8 @@
|
|
|
4631
4842
|
"$ref": "#/components/schemas/receiverListResponseItem"
|
|
4632
4843
|
},
|
|
4633
4844
|
"x-displayname": "Items",
|
|
4845
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
4846
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
4634
4847
|
"x-f5xc-required-for": {
|
|
4635
4848
|
"minimum_config": false,
|
|
4636
4849
|
"create": false,
|
|
@@ -4664,6 +4877,8 @@
|
|
|
4664
4877
|
"description": "The set of annotations present on this receiver.",
|
|
4665
4878
|
"title": "Annotations.",
|
|
4666
4879
|
"x-displayname": "Annotations.",
|
|
4880
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
4881
|
+
"x-f5xc-description-short": "The set of annotations present on this receiver.",
|
|
4667
4882
|
"x-f5xc-required-for": {
|
|
4668
4883
|
"minimum_config": false,
|
|
4669
4884
|
"create": false,
|
|
@@ -4686,7 +4901,7 @@
|
|
|
4686
4901
|
},
|
|
4687
4902
|
"x-original-maxLength": 1024,
|
|
4688
4903
|
"x-reconciled-from-discovery": true,
|
|
4689
|
-
"x-reconciled-at": "2026-01-
|
|
4904
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816758+00:00"
|
|
4690
4905
|
},
|
|
4691
4906
|
"disabled": {
|
|
4692
4907
|
"type": "boolean",
|
|
@@ -4694,6 +4909,8 @@
|
|
|
4694
4909
|
"title": "Disabled",
|
|
4695
4910
|
"format": "boolean",
|
|
4696
4911
|
"x-displayname": "Disabled",
|
|
4912
|
+
"x-f5xc-example": "True",
|
|
4913
|
+
"x-f5xc-description-short": "Value of true indicates receiver is administratively disabled.",
|
|
4697
4914
|
"x-f5xc-required-for": {
|
|
4698
4915
|
"minimum_config": false,
|
|
4699
4916
|
"create": false,
|
|
@@ -4709,6 +4926,8 @@
|
|
|
4709
4926
|
"description": "The set of labels present on this receiver.",
|
|
4710
4927
|
"title": "Labels",
|
|
4711
4928
|
"x-displayname": "Labels",
|
|
4929
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
4930
|
+
"x-f5xc-description-short": "The set of labels present on this receiver.",
|
|
4712
4931
|
"x-f5xc-required-for": {
|
|
4713
4932
|
"minimum_config": false,
|
|
4714
4933
|
"create": false,
|
|
@@ -4736,7 +4955,7 @@
|
|
|
4736
4955
|
},
|
|
4737
4956
|
"x-original-maxLength": 1024,
|
|
4738
4957
|
"x-reconciled-from-discovery": true,
|
|
4739
|
-
"x-reconciled-at": "2026-01-
|
|
4958
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816768+00:00"
|
|
4740
4959
|
},
|
|
4741
4960
|
"namespace": {
|
|
4742
4961
|
"type": "string",
|
|
@@ -4755,7 +4974,7 @@
|
|
|
4755
4974
|
},
|
|
4756
4975
|
"x-original-maxLength": 1024,
|
|
4757
4976
|
"x-reconciled-from-discovery": true,
|
|
4758
|
-
"x-reconciled-at": "2026-01-
|
|
4977
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816772+00:00"
|
|
4759
4978
|
},
|
|
4760
4979
|
"owner_view": {
|
|
4761
4980
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -4768,6 +4987,7 @@
|
|
|
4768
4987
|
"$ref": "#/components/schemas/receiverStatusObject"
|
|
4769
4988
|
},
|
|
4770
4989
|
"x-displayname": "Status",
|
|
4990
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
4771
4991
|
"x-f5xc-required-for": {
|
|
4772
4992
|
"minimum_config": false,
|
|
4773
4993
|
"create": false,
|
|
@@ -4796,7 +5016,7 @@
|
|
|
4796
5016
|
"x-field-mutability": "read-only",
|
|
4797
5017
|
"x-original-maxLength": 1024,
|
|
4798
5018
|
"x-reconciled-from-discovery": true,
|
|
4799
|
-
"x-reconciled-at": "2026-01-
|
|
5019
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816779+00:00"
|
|
4800
5020
|
},
|
|
4801
5021
|
"uid": {
|
|
4802
5022
|
"type": "string",
|
|
@@ -4817,9 +5037,11 @@
|
|
|
4817
5037
|
"x-original-maxLength": 1024,
|
|
4818
5038
|
"format": "uuid",
|
|
4819
5039
|
"x-reconciled-from-discovery": true,
|
|
4820
|
-
"x-reconciled-at": "2026-01-
|
|
5040
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816785+00:00"
|
|
4821
5041
|
}
|
|
4822
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.",
|
|
4823
5045
|
"x-f5xc-minimum-configuration": {
|
|
4824
5046
|
"description": "Minimum configuration for receiverListResponseItem",
|
|
4825
5047
|
"required_fields": [
|
|
@@ -4935,6 +5157,7 @@
|
|
|
4935
5157
|
"$ref": "#/components/schemas/receiverSplunkConfig"
|
|
4936
5158
|
}
|
|
4937
5159
|
},
|
|
5160
|
+
"x-f5xc-description-short": "Replaces the content of an Data Delivery object.",
|
|
4938
5161
|
"x-f5xc-minimum-configuration": {
|
|
4939
5162
|
"description": "Minimum configuration for receiverReplaceSpecType",
|
|
4940
5163
|
"required_fields": [
|
|
@@ -5068,6 +5291,7 @@
|
|
|
5068
5291
|
"x-validation-rules": {
|
|
5069
5292
|
"ves.io.schema.rules.message.required": "true"
|
|
5070
5293
|
},
|
|
5294
|
+
"x-f5xc-description-short": "Splunk HEC Logs Endpoint, Required: YES.",
|
|
5071
5295
|
"minLength": 0,
|
|
5072
5296
|
"maxLength": 1024,
|
|
5073
5297
|
"x-f5xc-required-for": {
|
|
@@ -5087,6 +5311,7 @@
|
|
|
5087
5311
|
"$ref": "#/components/schemas/receiverTLSConfigType"
|
|
5088
5312
|
}
|
|
5089
5313
|
},
|
|
5314
|
+
"x-f5xc-description-short": "Configuration for Splunk HEC Logs endpoint.",
|
|
5090
5315
|
"x-f5xc-minimum-configuration": {
|
|
5091
5316
|
"description": "Minimum configuration for receiverSplunkConfig",
|
|
5092
5317
|
"required_fields": [
|
|
@@ -5145,6 +5370,7 @@
|
|
|
5145
5370
|
}
|
|
5146
5371
|
}
|
|
5147
5372
|
},
|
|
5373
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
5148
5374
|
"x-f5xc-minimum-configuration": {
|
|
5149
5375
|
"description": "Minimum configuration for receiverStatusObject",
|
|
5150
5376
|
"required_fields": [
|
|
@@ -5181,6 +5407,7 @@
|
|
|
5181
5407
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
5182
5408
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
5183
5409
|
},
|
|
5410
|
+
"x-f5xc-description-short": "Client certificate is PEM-encoded certificate or certificate-chain.",
|
|
5184
5411
|
"minLength": 0,
|
|
5185
5412
|
"x-f5xc-required-for": {
|
|
5186
5413
|
"minimum_config": false,
|
|
@@ -5193,6 +5420,7 @@
|
|
|
5193
5420
|
"$ref": "#/components/schemas/schemaSecretType"
|
|
5194
5421
|
}
|
|
5195
5422
|
},
|
|
5423
|
+
"x-f5xc-description-short": "MTLS Client config allows configuration of mTLS client OPTIONS.",
|
|
5196
5424
|
"x-f5xc-minimum-configuration": {
|
|
5197
5425
|
"description": "Minimum configuration for receiverTLSClientConfigType",
|
|
5198
5426
|
"required_fields": [
|
|
@@ -5252,6 +5480,8 @@
|
|
|
5252
5480
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
5253
5481
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
5254
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.",
|
|
5255
5485
|
"minLength": 0,
|
|
5256
5486
|
"x-f5xc-required-for": {
|
|
5257
5487
|
"minimum_config": false,
|
|
@@ -5261,6 +5491,7 @@
|
|
|
5261
5491
|
}
|
|
5262
5492
|
}
|
|
5263
5493
|
},
|
|
5494
|
+
"x-f5xc-description-short": "TLS Parameters for client connection to the endpoint.",
|
|
5264
5495
|
"x-f5xc-minimum-configuration": {
|
|
5265
5496
|
"description": "Minimum configuration for receiverTLSConfigType",
|
|
5266
5497
|
"required_fields": [
|
|
@@ -5295,6 +5526,8 @@
|
|
|
5295
5526
|
"x-displayname": "Decryption Provider.",
|
|
5296
5527
|
"x-ves-example": "Value",
|
|
5297
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.",
|
|
5298
5531
|
"minLength": 0,
|
|
5299
5532
|
"maxLength": 1024,
|
|
5300
5533
|
"x-f5xc-required-for": {
|
|
@@ -5320,6 +5553,8 @@
|
|
|
5320
5553
|
"ves.io.schema.rules.message.required": "true",
|
|
5321
5554
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
5322
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.",
|
|
5323
5558
|
"minLength": 0,
|
|
5324
5559
|
"maxLength": 4,
|
|
5325
5560
|
"x-f5xc-required-for": {
|
|
@@ -5330,7 +5565,7 @@
|
|
|
5330
5565
|
},
|
|
5331
5566
|
"x-original-maxLength": 1024,
|
|
5332
5567
|
"x-reconciled-from-discovery": true,
|
|
5333
|
-
"x-reconciled-at": "2026-01-
|
|
5568
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816832+00:00"
|
|
5334
5569
|
},
|
|
5335
5570
|
"store_provider": {
|
|
5336
5571
|
"type": "string",
|
|
@@ -5339,6 +5574,8 @@
|
|
|
5339
5574
|
"x-displayname": "Store Provider.",
|
|
5340
5575
|
"x-ves-example": "Value",
|
|
5341
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:///.",
|
|
5342
5579
|
"minLength": 0,
|
|
5343
5580
|
"maxLength": 1024,
|
|
5344
5581
|
"x-f5xc-required-for": {
|
|
@@ -5349,6 +5586,7 @@
|
|
|
5349
5586
|
}
|
|
5350
5587
|
}
|
|
5351
5588
|
},
|
|
5589
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
5352
5590
|
"x-f5xc-minimum-configuration": {
|
|
5353
5591
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
5354
5592
|
"required_fields": [
|
|
@@ -5378,6 +5616,8 @@
|
|
|
5378
5616
|
"x-displayname": "Provider",
|
|
5379
5617
|
"x-ves-example": "Box-provider.",
|
|
5380
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:///.",
|
|
5381
5621
|
"minLength": 0,
|
|
5382
5622
|
"maxLength": 8,
|
|
5383
5623
|
"x-f5xc-required-for": {
|
|
@@ -5388,7 +5628,7 @@
|
|
|
5388
5628
|
},
|
|
5389
5629
|
"x-original-maxLength": 1024,
|
|
5390
5630
|
"x-reconciled-from-discovery": true,
|
|
5391
|
-
"x-reconciled-at": "2026-01-
|
|
5631
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816838+00:00"
|
|
5392
5632
|
},
|
|
5393
5633
|
"url": {
|
|
5394
5634
|
"type": "string",
|
|
@@ -5409,6 +5649,8 @@
|
|
|
5409
5649
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
5410
5650
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
5411
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.",
|
|
5412
5654
|
"format": "uri",
|
|
5413
5655
|
"minLength": 0,
|
|
5414
5656
|
"x-f5xc-required-for": {
|
|
@@ -5419,6 +5661,7 @@
|
|
|
5419
5661
|
}
|
|
5420
5662
|
}
|
|
5421
5663
|
},
|
|
5664
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
5422
5665
|
"x-f5xc-minimum-configuration": {
|
|
5423
5666
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
5424
5667
|
"required_fields": [
|
|
@@ -5444,6 +5687,8 @@
|
|
|
5444
5687
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
5445
5688
|
"title": "Hostname",
|
|
5446
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.",
|
|
5447
5692
|
"minLength": 0,
|
|
5448
5693
|
"maxLength": 1024,
|
|
5449
5694
|
"x-f5xc-required-for": {
|
|
@@ -5475,6 +5720,8 @@
|
|
|
5475
5720
|
"x-displayname": "Reason",
|
|
5476
5721
|
"x-ves-example": "Value",
|
|
5477
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.",
|
|
5478
5725
|
"minLength": 0,
|
|
5479
5726
|
"maxLength": 43,
|
|
5480
5727
|
"x-f5xc-required-for": {
|
|
@@ -5485,13 +5732,15 @@
|
|
|
5485
5732
|
},
|
|
5486
5733
|
"x-original-maxLength": 1024,
|
|
5487
5734
|
"x-reconciled-from-discovery": true,
|
|
5488
|
-
"x-reconciled-at": "2026-01-
|
|
5735
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816847+00:00"
|
|
5489
5736
|
},
|
|
5490
5737
|
"service_name": {
|
|
5491
5738
|
"type": "string",
|
|
5492
5739
|
"description": "Name of the service that sent the status.",
|
|
5493
5740
|
"title": "Service name.",
|
|
5494
5741
|
"x-displayname": "Service Name.",
|
|
5742
|
+
"x-f5xc-example": "example-resource",
|
|
5743
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
5495
5744
|
"minLength": 0,
|
|
5496
5745
|
"maxLength": 1024,
|
|
5497
5746
|
"x-f5xc-required-for": {
|
|
@@ -5514,6 +5763,8 @@
|
|
|
5514
5763
|
"x-validation-rules": {
|
|
5515
5764
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
5516
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...",
|
|
5517
5768
|
"minLength": 0,
|
|
5518
5769
|
"maxLength": 17,
|
|
5519
5770
|
"x-f5xc-required-for": {
|
|
@@ -5524,7 +5775,7 @@
|
|
|
5524
5775
|
},
|
|
5525
5776
|
"x-original-maxLength": 1024,
|
|
5526
5777
|
"x-reconciled-from-discovery": true,
|
|
5527
|
-
"x-reconciled-at": "2026-01-
|
|
5778
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816853+00:00"
|
|
5528
5779
|
},
|
|
5529
5780
|
"type": {
|
|
5530
5781
|
"type": "string",
|
|
@@ -5539,6 +5790,8 @@
|
|
|
5539
5790
|
"x-validation-rules": {
|
|
5540
5791
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
5541
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.",
|
|
5542
5795
|
"minLength": 0,
|
|
5543
5796
|
"maxLength": 1024,
|
|
5544
5797
|
"x-f5xc-required-for": {
|
|
@@ -5549,6 +5802,8 @@
|
|
|
5549
5802
|
}
|
|
5550
5803
|
}
|
|
5551
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.",
|
|
5552
5807
|
"x-f5xc-minimum-configuration": {
|
|
5553
5808
|
"description": "Minimum configuration for schemaConditionType",
|
|
5554
5809
|
"required_fields": [
|
|
@@ -5584,6 +5839,8 @@
|
|
|
5584
5839
|
"default": "EOK",
|
|
5585
5840
|
"x-displayname": "Error Code.",
|
|
5586
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...",
|
|
5587
5844
|
"x-f5xc-minimum-configuration": {
|
|
5588
5845
|
"description": "Minimum configuration for schemaErrorCode",
|
|
5589
5846
|
"required_fields": [],
|
|
@@ -5624,6 +5881,7 @@
|
|
|
5624
5881
|
}
|
|
5625
5882
|
}
|
|
5626
5883
|
},
|
|
5884
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
5627
5885
|
"x-f5xc-minimum-configuration": {
|
|
5628
5886
|
"description": "Minimum configuration for schemaErrorType",
|
|
5629
5887
|
"required_fields": [
|
|
@@ -5651,6 +5909,7 @@
|
|
|
5651
5909
|
"title": "Name",
|
|
5652
5910
|
"x-displayname": "Name",
|
|
5653
5911
|
"x-f5xc-example": "example-resource",
|
|
5912
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
5654
5913
|
"minLength": 0,
|
|
5655
5914
|
"maxLength": 16,
|
|
5656
5915
|
"x-f5xc-required-for": {
|
|
@@ -5661,9 +5920,10 @@
|
|
|
5661
5920
|
},
|
|
5662
5921
|
"x-original-maxLength": 1024,
|
|
5663
5922
|
"x-reconciled-from-discovery": true,
|
|
5664
|
-
"x-reconciled-at": "2026-01-
|
|
5923
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816863+00:00"
|
|
5665
5924
|
}
|
|
5666
5925
|
},
|
|
5926
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
5667
5927
|
"x-f5xc-minimum-configuration": {
|
|
5668
5928
|
"description": "Minimum configuration for schemaInitializerType",
|
|
5669
5929
|
"required_fields": [
|
|
@@ -5691,6 +5951,8 @@
|
|
|
5691
5951
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
5692
5952
|
},
|
|
5693
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.",
|
|
5694
5956
|
"x-f5xc-required-for": {
|
|
5695
5957
|
"minimum_config": false,
|
|
5696
5958
|
"create": false,
|
|
@@ -5702,6 +5964,7 @@
|
|
|
5702
5964
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
5703
5965
|
}
|
|
5704
5966
|
},
|
|
5967
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
5705
5968
|
"x-f5xc-minimum-configuration": {
|
|
5706
5969
|
"description": "Minimum configuration for schemaInitializersType",
|
|
5707
5970
|
"required_fields": [
|
|
@@ -5740,6 +6003,8 @@
|
|
|
5740
6003
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
5741
6004
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
5742
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.",
|
|
5743
6008
|
"x-f5xc-required-for": {
|
|
5744
6009
|
"minimum_config": false,
|
|
5745
6010
|
"create": false,
|
|
@@ -5761,6 +6026,7 @@
|
|
|
5761
6026
|
"x-validation-rules": {
|
|
5762
6027
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
5763
6028
|
},
|
|
6029
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
5764
6030
|
"minLength": 0,
|
|
5765
6031
|
"x-f5xc-required-for": {
|
|
5766
6032
|
"minimum_config": false,
|
|
@@ -5770,7 +6036,7 @@
|
|
|
5770
6036
|
},
|
|
5771
6037
|
"x-original-maxLength": 1200,
|
|
5772
6038
|
"x-reconciled-from-discovery": true,
|
|
5773
|
-
"x-reconciled-at": "2026-01-
|
|
6039
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816873+00:00"
|
|
5774
6040
|
},
|
|
5775
6041
|
"disable": {
|
|
5776
6042
|
"type": "boolean",
|
|
@@ -5779,6 +6045,7 @@
|
|
|
5779
6045
|
"format": "boolean",
|
|
5780
6046
|
"x-displayname": "Disable",
|
|
5781
6047
|
"x-f5xc-example": "true",
|
|
6048
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
5782
6049
|
"x-f5xc-required-for": {
|
|
5783
6050
|
"minimum_config": false,
|
|
5784
6051
|
"create": false,
|
|
@@ -5792,6 +6059,8 @@
|
|
|
5792
6059
|
"title": "Labels",
|
|
5793
6060
|
"x-displayname": "Labels",
|
|
5794
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.",
|
|
5795
6064
|
"x-f5xc-required-for": {
|
|
5796
6065
|
"minimum_config": false,
|
|
5797
6066
|
"create": false,
|
|
@@ -5813,6 +6082,8 @@
|
|
|
5813
6082
|
"x-validation-rules": {
|
|
5814
6083
|
"ves.io.schema.rules.message.required": "true"
|
|
5815
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.",
|
|
5816
6087
|
"minLength": 0,
|
|
5817
6088
|
"maxLength": 16,
|
|
5818
6089
|
"x-f5xc-required-for": {
|
|
@@ -5823,7 +6094,7 @@
|
|
|
5823
6094
|
},
|
|
5824
6095
|
"x-original-maxLength": 1024,
|
|
5825
6096
|
"x-reconciled-from-discovery": true,
|
|
5826
|
-
"x-reconciled-at": "2026-01-
|
|
6097
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816880+00:00"
|
|
5827
6098
|
},
|
|
5828
6099
|
"namespace": {
|
|
5829
6100
|
"type": "string",
|
|
@@ -5832,6 +6103,8 @@
|
|
|
5832
6103
|
"x-displayname": "Namespace",
|
|
5833
6104
|
"x-ves-example": "Staging",
|
|
5834
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 \"\".",
|
|
5835
6108
|
"minLength": 0,
|
|
5836
6109
|
"maxLength": 6,
|
|
5837
6110
|
"x-f5xc-required-for": {
|
|
@@ -5842,9 +6115,10 @@
|
|
|
5842
6115
|
},
|
|
5843
6116
|
"x-original-maxLength": 1024,
|
|
5844
6117
|
"x-reconciled-from-discovery": true,
|
|
5845
|
-
"x-reconciled-at": "2026-01-
|
|
6118
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816884+00:00"
|
|
5846
6119
|
}
|
|
5847
6120
|
},
|
|
6121
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
5848
6122
|
"x-f5xc-minimum-configuration": {
|
|
5849
6123
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
5850
6124
|
"required_fields": [
|
|
@@ -5888,6 +6162,8 @@
|
|
|
5888
6162
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
5889
6163
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
5890
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.",
|
|
5891
6167
|
"x-f5xc-required-for": {
|
|
5892
6168
|
"minimum_config": false,
|
|
5893
6169
|
"create": false,
|
|
@@ -5909,6 +6185,7 @@
|
|
|
5909
6185
|
"x-validation-rules": {
|
|
5910
6186
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
5911
6187
|
},
|
|
6188
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
5912
6189
|
"minLength": 0,
|
|
5913
6190
|
"x-f5xc-required-for": {
|
|
5914
6191
|
"minimum_config": false,
|
|
@@ -5918,7 +6195,7 @@
|
|
|
5918
6195
|
},
|
|
5919
6196
|
"x-original-maxLength": 1200,
|
|
5920
6197
|
"x-reconciled-from-discovery": true,
|
|
5921
|
-
"x-reconciled-at": "2026-01-
|
|
6198
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816891+00:00"
|
|
5922
6199
|
},
|
|
5923
6200
|
"disable": {
|
|
5924
6201
|
"type": "boolean",
|
|
@@ -5928,6 +6205,7 @@
|
|
|
5928
6205
|
"x-displayname": "Disable",
|
|
5929
6206
|
"x-ves-example": "True",
|
|
5930
6207
|
"x-f5xc-example": "true",
|
|
6208
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
5931
6209
|
"x-f5xc-required-for": {
|
|
5932
6210
|
"minimum_config": false,
|
|
5933
6211
|
"create": false,
|
|
@@ -5942,6 +6220,8 @@
|
|
|
5942
6220
|
"x-displayname": "Labels",
|
|
5943
6221
|
"x-ves-example": "Value",
|
|
5944
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.",
|
|
5945
6225
|
"x-f5xc-required-for": {
|
|
5946
6226
|
"minimum_config": false,
|
|
5947
6227
|
"create": false,
|
|
@@ -5963,6 +6243,8 @@
|
|
|
5963
6243
|
"x-validation-rules": {
|
|
5964
6244
|
"ves.io.schema.rules.message.required": "true"
|
|
5965
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.",
|
|
5966
6248
|
"minLength": 0,
|
|
5967
6249
|
"maxLength": 16,
|
|
5968
6250
|
"x-f5xc-required-for": {
|
|
@@ -5973,7 +6255,7 @@
|
|
|
5973
6255
|
},
|
|
5974
6256
|
"x-original-maxLength": 1024,
|
|
5975
6257
|
"x-reconciled-from-discovery": true,
|
|
5976
|
-
"x-reconciled-at": "2026-01-
|
|
6258
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816898+00:00"
|
|
5977
6259
|
},
|
|
5978
6260
|
"namespace": {
|
|
5979
6261
|
"type": "string",
|
|
@@ -5982,6 +6264,8 @@
|
|
|
5982
6264
|
"x-displayname": "Namespace",
|
|
5983
6265
|
"x-ves-example": "Staging",
|
|
5984
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 \"\".",
|
|
5985
6269
|
"minLength": 0,
|
|
5986
6270
|
"maxLength": 6,
|
|
5987
6271
|
"x-f5xc-required-for": {
|
|
@@ -5992,9 +6276,10 @@
|
|
|
5992
6276
|
},
|
|
5993
6277
|
"x-original-maxLength": 1024,
|
|
5994
6278
|
"x-reconciled-from-discovery": true,
|
|
5995
|
-
"x-reconciled-at": "2026-01-
|
|
6279
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816902+00:00"
|
|
5996
6280
|
}
|
|
5997
6281
|
},
|
|
6282
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
5998
6283
|
"x-f5xc-minimum-configuration": {
|
|
5999
6284
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
6000
6285
|
"required_fields": [
|
|
@@ -6038,6 +6323,8 @@
|
|
|
6038
6323
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6039
6324
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6040
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.",
|
|
6041
6328
|
"x-f5xc-required-for": {
|
|
6042
6329
|
"minimum_config": false,
|
|
6043
6330
|
"create": false,
|
|
@@ -6059,6 +6346,7 @@
|
|
|
6059
6346
|
"x-validation-rules": {
|
|
6060
6347
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6061
6348
|
},
|
|
6349
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
6062
6350
|
"minLength": 0,
|
|
6063
6351
|
"x-f5xc-required-for": {
|
|
6064
6352
|
"minimum_config": false,
|
|
@@ -6068,7 +6356,7 @@
|
|
|
6068
6356
|
},
|
|
6069
6357
|
"x-original-maxLength": 1200,
|
|
6070
6358
|
"x-reconciled-from-discovery": true,
|
|
6071
|
-
"x-reconciled-at": "2026-01-
|
|
6359
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816908+00:00"
|
|
6072
6360
|
},
|
|
6073
6361
|
"disable": {
|
|
6074
6362
|
"type": "boolean",
|
|
@@ -6077,6 +6365,7 @@
|
|
|
6077
6365
|
"format": "boolean",
|
|
6078
6366
|
"x-displayname": "Disable",
|
|
6079
6367
|
"x-f5xc-example": "true",
|
|
6368
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
6080
6369
|
"x-f5xc-required-for": {
|
|
6081
6370
|
"minimum_config": false,
|
|
6082
6371
|
"create": false,
|
|
@@ -6091,6 +6380,8 @@
|
|
|
6091
6380
|
"x-displayname": "Labels",
|
|
6092
6381
|
"x-ves-example": "Value",
|
|
6093
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.",
|
|
6094
6385
|
"x-f5xc-required-for": {
|
|
6095
6386
|
"minimum_config": false,
|
|
6096
6387
|
"create": false,
|
|
@@ -6111,6 +6402,8 @@
|
|
|
6111
6402
|
"x-validation-rules": {
|
|
6112
6403
|
"ves.io.schema.rules.message.required": "true"
|
|
6113
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.",
|
|
6114
6407
|
"minLength": 0,
|
|
6115
6408
|
"maxLength": 16,
|
|
6116
6409
|
"x-f5xc-required-for": {
|
|
@@ -6121,7 +6414,7 @@
|
|
|
6121
6414
|
},
|
|
6122
6415
|
"x-original-maxLength": 1024,
|
|
6123
6416
|
"x-reconciled-from-discovery": true,
|
|
6124
|
-
"x-reconciled-at": "2026-01-
|
|
6417
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816915+00:00"
|
|
6125
6418
|
},
|
|
6126
6419
|
"namespace": {
|
|
6127
6420
|
"type": "string",
|
|
@@ -6130,6 +6423,8 @@
|
|
|
6130
6423
|
"x-displayname": "Namespace",
|
|
6131
6424
|
"x-ves-example": "Staging",
|
|
6132
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 \"\".",
|
|
6133
6428
|
"minLength": 0,
|
|
6134
6429
|
"maxLength": 6,
|
|
6135
6430
|
"x-f5xc-required-for": {
|
|
@@ -6140,9 +6435,10 @@
|
|
|
6140
6435
|
},
|
|
6141
6436
|
"x-original-maxLength": 1024,
|
|
6142
6437
|
"x-reconciled-from-discovery": true,
|
|
6143
|
-
"x-reconciled-at": "2026-01-
|
|
6438
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816919+00:00"
|
|
6144
6439
|
}
|
|
6145
6440
|
},
|
|
6441
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
6146
6442
|
"x-f5xc-minimum-configuration": {
|
|
6147
6443
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
6148
6444
|
"required_fields": [
|
|
@@ -6169,6 +6465,8 @@
|
|
|
6169
6465
|
"EncodingBase64"
|
|
6170
6466
|
],
|
|
6171
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.",
|
|
6172
6470
|
"x-f5xc-minimum-configuration": {
|
|
6173
6471
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
6174
6472
|
"required_fields": [],
|
|
@@ -6194,6 +6492,7 @@
|
|
|
6194
6492
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
6195
6493
|
}
|
|
6196
6494
|
},
|
|
6495
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
6197
6496
|
"x-f5xc-minimum-configuration": {
|
|
6198
6497
|
"description": "Minimum configuration for schemaSecretType",
|
|
6199
6498
|
"required_fields": [
|
|
@@ -6220,6 +6519,8 @@
|
|
|
6220
6519
|
"title": "Creation_timestamp.",
|
|
6221
6520
|
"format": "date-time",
|
|
6222
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.",
|
|
6223
6524
|
"minLength": 0,
|
|
6224
6525
|
"maxLength": 1024,
|
|
6225
6526
|
"x-f5xc-required-for": {
|
|
@@ -6237,6 +6538,8 @@
|
|
|
6237
6538
|
"x-displayname": "Creator Class.",
|
|
6238
6539
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
6239
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.",
|
|
6240
6543
|
"minLength": 0,
|
|
6241
6544
|
"maxLength": 1024,
|
|
6242
6545
|
"x-f5xc-required-for": {
|
|
@@ -6254,6 +6557,8 @@
|
|
|
6254
6557
|
"x-displayname": "Creator ID.",
|
|
6255
6558
|
"x-ves-example": "Ver-instance-1.",
|
|
6256
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.",
|
|
6257
6562
|
"minLength": 0,
|
|
6258
6563
|
"maxLength": 1024,
|
|
6259
6564
|
"x-f5xc-required-for": {
|
|
@@ -6272,6 +6577,8 @@
|
|
|
6272
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)",
|
|
6273
6578
|
"title": "Status_id",
|
|
6274
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).",
|
|
6275
6582
|
"minLength": 0,
|
|
6276
6583
|
"maxLength": 1024,
|
|
6277
6584
|
"x-f5xc-required-for": {
|
|
@@ -6289,6 +6596,7 @@
|
|
|
6289
6596
|
"x-displayname": "UID",
|
|
6290
6597
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6291
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.",
|
|
6292
6600
|
"minLength": 0,
|
|
6293
6601
|
"maxLength": 36,
|
|
6294
6602
|
"x-f5xc-required-for": {
|
|
@@ -6301,13 +6609,14 @@
|
|
|
6301
6609
|
"x-original-maxLength": 1024,
|
|
6302
6610
|
"format": "uuid",
|
|
6303
6611
|
"x-reconciled-from-discovery": true,
|
|
6304
|
-
"x-reconciled-at": "2026-01-
|
|
6612
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816934+00:00"
|
|
6305
6613
|
},
|
|
6306
6614
|
"vtrp_id": {
|
|
6307
6615
|
"type": "string",
|
|
6308
6616
|
"description": "Origin of this status exchanged by VTRP.",
|
|
6309
6617
|
"title": "Vtrp_id",
|
|
6310
6618
|
"x-displayname": "VTRP ID",
|
|
6619
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
6311
6620
|
"minLength": 0,
|
|
6312
6621
|
"maxLength": 1024,
|
|
6313
6622
|
"x-f5xc-required-for": {
|
|
@@ -6324,6 +6633,7 @@
|
|
|
6324
6633
|
"title": "Vtrp_stale.",
|
|
6325
6634
|
"format": "boolean",
|
|
6326
6635
|
"x-displayname": "VTRP Stale.",
|
|
6636
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
6327
6637
|
"x-f5xc-required-for": {
|
|
6328
6638
|
"minimum_config": false,
|
|
6329
6639
|
"create": false,
|
|
@@ -6332,6 +6642,7 @@
|
|
|
6332
6642
|
}
|
|
6333
6643
|
}
|
|
6334
6644
|
},
|
|
6645
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
6335
6646
|
"x-f5xc-minimum-configuration": {
|
|
6336
6647
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
6337
6648
|
"required_fields": [
|
|
@@ -6362,6 +6673,8 @@
|
|
|
6362
6673
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
6363
6674
|
"x-displayname": "Status Publish Type.",
|
|
6364
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.",
|
|
6365
6678
|
"x-f5xc-minimum-configuration": {
|
|
6366
6679
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
6367
6680
|
"required_fields": [],
|
|
@@ -6387,6 +6700,7 @@
|
|
|
6387
6700
|
"x-displayname": "Code",
|
|
6388
6701
|
"x-ves-example": "0",
|
|
6389
6702
|
"x-f5xc-example": "0",
|
|
6703
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
6390
6704
|
"minimum": 0,
|
|
6391
6705
|
"maximum": 2147483647,
|
|
6392
6706
|
"x-f5xc-required-for": {
|
|
@@ -6403,6 +6717,8 @@
|
|
|
6403
6717
|
"x-displayname": "Reason",
|
|
6404
6718
|
"x-ves-example": "Value",
|
|
6405
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.",
|
|
6406
6722
|
"minLength": 0,
|
|
6407
6723
|
"maxLength": 43,
|
|
6408
6724
|
"x-f5xc-required-for": {
|
|
@@ -6413,7 +6729,7 @@
|
|
|
6413
6729
|
},
|
|
6414
6730
|
"x-original-maxLength": 1024,
|
|
6415
6731
|
"x-reconciled-from-discovery": true,
|
|
6416
|
-
"x-reconciled-at": "2026-01-
|
|
6732
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816943+00:00"
|
|
6417
6733
|
},
|
|
6418
6734
|
"status": {
|
|
6419
6735
|
"type": "string",
|
|
@@ -6422,6 +6738,7 @@
|
|
|
6422
6738
|
"x-displayname": "Status",
|
|
6423
6739
|
"x-ves-example": "Value",
|
|
6424
6740
|
"x-f5xc-example": "value",
|
|
6741
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
6425
6742
|
"minLength": 0,
|
|
6426
6743
|
"maxLength": 17,
|
|
6427
6744
|
"x-f5xc-required-for": {
|
|
@@ -6432,9 +6749,10 @@
|
|
|
6432
6749
|
},
|
|
6433
6750
|
"x-original-maxLength": 1024,
|
|
6434
6751
|
"x-reconciled-from-discovery": true,
|
|
6435
|
-
"x-reconciled-at": "2026-01-
|
|
6752
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816947+00:00"
|
|
6436
6753
|
}
|
|
6437
6754
|
},
|
|
6755
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
6438
6756
|
"x-f5xc-minimum-configuration": {
|
|
6439
6757
|
"description": "Minimum configuration for schemaStatusType",
|
|
6440
6758
|
"required_fields": [
|
|
@@ -6462,6 +6780,8 @@
|
|
|
6462
6780
|
"title": "Creation_timestamp.",
|
|
6463
6781
|
"format": "date-time",
|
|
6464
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.",
|
|
6465
6785
|
"minLength": 0,
|
|
6466
6786
|
"maxLength": 1024,
|
|
6467
6787
|
"x-f5xc-required-for": {
|
|
@@ -6479,6 +6799,7 @@
|
|
|
6479
6799
|
"x-displayname": "Creator Class.",
|
|
6480
6800
|
"x-ves-example": "Prism",
|
|
6481
6801
|
"x-f5xc-example": "value",
|
|
6802
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
6482
6803
|
"minLength": 0,
|
|
6483
6804
|
"maxLength": 1024,
|
|
6484
6805
|
"x-f5xc-required-for": {
|
|
@@ -6496,6 +6817,7 @@
|
|
|
6496
6817
|
"x-displayname": "Creator ID.",
|
|
6497
6818
|
"x-ves-example": "Admin@example-corp.com.",
|
|
6498
6819
|
"x-f5xc-example": "value",
|
|
6820
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
6499
6821
|
"minLength": 0,
|
|
6500
6822
|
"maxLength": 1024,
|
|
6501
6823
|
"x-f5xc-required-for": {
|
|
@@ -6512,6 +6834,8 @@
|
|
|
6512
6834
|
"title": "Deletion_timestamp.",
|
|
6513
6835
|
"format": "date-time",
|
|
6514
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...",
|
|
6515
6839
|
"minLength": 0,
|
|
6516
6840
|
"maxLength": 1024,
|
|
6517
6841
|
"x-f5xc-required-for": {
|
|
@@ -6531,6 +6855,8 @@
|
|
|
6531
6855
|
"x-displayname": "Finalizers.",
|
|
6532
6856
|
"x-ves-example": "Value",
|
|
6533
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.",
|
|
6534
6860
|
"x-f5xc-required-for": {
|
|
6535
6861
|
"minimum_config": false,
|
|
6536
6862
|
"create": false,
|
|
@@ -6548,6 +6874,8 @@
|
|
|
6548
6874
|
"x-displayname": "Labels",
|
|
6549
6875
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
6550
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).",
|
|
6551
6879
|
"x-f5xc-required-for": {
|
|
6552
6880
|
"minimum_config": false,
|
|
6553
6881
|
"create": false,
|
|
@@ -6561,6 +6889,8 @@
|
|
|
6561
6889
|
"title": "Modification_timestamp.",
|
|
6562
6890
|
"format": "date-time",
|
|
6563
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.",
|
|
6564
6894
|
"minLength": 0,
|
|
6565
6895
|
"maxLength": 1024,
|
|
6566
6896
|
"x-f5xc-required-for": {
|
|
@@ -6579,6 +6909,8 @@
|
|
|
6579
6909
|
"x-displayname": "Object Index.",
|
|
6580
6910
|
"x-ves-example": "0",
|
|
6581
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.",
|
|
6582
6914
|
"minimum": 0,
|
|
6583
6915
|
"maximum": 2147483647,
|
|
6584
6916
|
"x-f5xc-required-for": {
|
|
@@ -6599,6 +6931,8 @@
|
|
|
6599
6931
|
"x-displayname": "Tenant",
|
|
6600
6932
|
"x-ves-example": "Example-corp.",
|
|
6601
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.",
|
|
6602
6936
|
"minLength": 0,
|
|
6603
6937
|
"maxLength": 18,
|
|
6604
6938
|
"x-f5xc-required-for": {
|
|
@@ -6610,7 +6944,7 @@
|
|
|
6610
6944
|
"x-field-mutability": "read-only",
|
|
6611
6945
|
"x-original-maxLength": 1024,
|
|
6612
6946
|
"x-reconciled-from-discovery": true,
|
|
6613
|
-
"x-reconciled-at": "2026-01-
|
|
6947
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816966+00:00"
|
|
6614
6948
|
},
|
|
6615
6949
|
"uid": {
|
|
6616
6950
|
"type": "string",
|
|
@@ -6619,6 +6953,8 @@
|
|
|
6619
6953
|
"x-displayname": "UID",
|
|
6620
6954
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6621
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.",
|
|
6622
6958
|
"minLength": 0,
|
|
6623
6959
|
"maxLength": 36,
|
|
6624
6960
|
"x-f5xc-required-for": {
|
|
@@ -6631,9 +6967,11 @@
|
|
|
6631
6967
|
"x-original-maxLength": 1024,
|
|
6632
6968
|
"format": "uuid",
|
|
6633
6969
|
"x-reconciled-from-discovery": true,
|
|
6634
|
-
"x-reconciled-at": "2026-01-
|
|
6970
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816970+00:00"
|
|
6635
6971
|
}
|
|
6636
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.",
|
|
6637
6975
|
"x-f5xc-minimum-configuration": {
|
|
6638
6976
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
6639
6977
|
"required_fields": [
|
|
@@ -6667,6 +7005,8 @@
|
|
|
6667
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.",
|
|
6668
7006
|
"title": "Key",
|
|
6669
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.",
|
|
6670
7010
|
"minLength": 0,
|
|
6671
7011
|
"maxLength": 16,
|
|
6672
7012
|
"x-f5xc-required-for": {
|
|
@@ -6677,13 +7017,14 @@
|
|
|
6677
7017
|
},
|
|
6678
7018
|
"x-original-maxLength": 1024,
|
|
6679
7019
|
"x-reconciled-from-discovery": true,
|
|
6680
|
-
"x-reconciled-at": "2026-01-
|
|
7020
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816975+00:00"
|
|
6681
7021
|
},
|
|
6682
7022
|
"location": {
|
|
6683
7023
|
"type": "string",
|
|
6684
7024
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
6685
7025
|
"title": "Location",
|
|
6686
7026
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
7027
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
6687
7028
|
"minLength": 0,
|
|
6688
7029
|
"maxLength": 4,
|
|
6689
7030
|
"x-f5xc-required-for": {
|
|
@@ -6694,13 +7035,15 @@
|
|
|
6694
7035
|
},
|
|
6695
7036
|
"x-original-maxLength": 1024,
|
|
6696
7037
|
"x-reconciled-from-discovery": true,
|
|
6697
|
-
"x-reconciled-at": "2026-01-
|
|
7038
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816980+00:00"
|
|
6698
7039
|
},
|
|
6699
7040
|
"provider": {
|
|
6700
7041
|
"type": "string",
|
|
6701
7042
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
6702
7043
|
"title": "Provider",
|
|
6703
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.",
|
|
6704
7047
|
"minLength": 0,
|
|
6705
7048
|
"maxLength": 8,
|
|
6706
7049
|
"x-f5xc-required-for": {
|
|
@@ -6711,7 +7054,7 @@
|
|
|
6711
7054
|
},
|
|
6712
7055
|
"x-original-maxLength": 1024,
|
|
6713
7056
|
"x-reconciled-from-discovery": true,
|
|
6714
|
-
"x-reconciled-at": "2026-01-
|
|
7057
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816984+00:00"
|
|
6715
7058
|
},
|
|
6716
7059
|
"secret_encoding": {
|
|
6717
7060
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -6722,6 +7065,8 @@
|
|
|
6722
7065
|
"title": "Version",
|
|
6723
7066
|
"format": "int64",
|
|
6724
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.",
|
|
6725
7070
|
"minimum": 0,
|
|
6726
7071
|
"maximum": 2147483647,
|
|
6727
7072
|
"x-f5xc-required-for": {
|
|
@@ -6733,9 +7078,11 @@
|
|
|
6733
7078
|
"maxLength": 1,
|
|
6734
7079
|
"minLength": 1,
|
|
6735
7080
|
"x-reconciled-from-discovery": true,
|
|
6736
|
-
"x-reconciled-at": "2026-01-
|
|
7081
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816990+00:00"
|
|
6737
7082
|
}
|
|
6738
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.",
|
|
6739
7086
|
"x-f5xc-minimum-configuration": {
|
|
6740
7087
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
6741
7088
|
"required_fields": [
|
|
@@ -6776,7 +7123,7 @@
|
|
|
6776
7123
|
},
|
|
6777
7124
|
"x-original-maxLength": 1024,
|
|
6778
7125
|
"x-reconciled-from-discovery": true,
|
|
6779
|
-
"x-reconciled-at": "2026-01-
|
|
7126
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816995+00:00"
|
|
6780
7127
|
},
|
|
6781
7128
|
"name": {
|
|
6782
7129
|
"type": "string",
|
|
@@ -6785,6 +7132,8 @@
|
|
|
6785
7132
|
"x-displayname": "Name",
|
|
6786
7133
|
"x-ves-example": "Contactus-route.",
|
|
6787
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.",
|
|
6788
7137
|
"minLength": 0,
|
|
6789
7138
|
"maxLength": 16,
|
|
6790
7139
|
"x-f5xc-required-for": {
|
|
@@ -6795,7 +7144,7 @@
|
|
|
6795
7144
|
},
|
|
6796
7145
|
"x-original-maxLength": 1024,
|
|
6797
7146
|
"x-reconciled-from-discovery": true,
|
|
6798
|
-
"x-reconciled-at": "2026-01-
|
|
7147
|
+
"x-reconciled-at": "2026-01-07T15:28:30.816999+00:00"
|
|
6799
7148
|
},
|
|
6800
7149
|
"namespace": {
|
|
6801
7150
|
"type": "string",
|
|
@@ -6804,6 +7153,8 @@
|
|
|
6804
7153
|
"x-displayname": "Namespace",
|
|
6805
7154
|
"x-ves-example": "Ns1",
|
|
6806
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.",
|
|
6807
7158
|
"minLength": 0,
|
|
6808
7159
|
"maxLength": 6,
|
|
6809
7160
|
"x-f5xc-required-for": {
|
|
@@ -6814,7 +7165,7 @@
|
|
|
6814
7165
|
},
|
|
6815
7166
|
"x-original-maxLength": 1024,
|
|
6816
7167
|
"x-reconciled-from-discovery": true,
|
|
6817
|
-
"x-reconciled-at": "2026-01-
|
|
7168
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817003+00:00"
|
|
6818
7169
|
},
|
|
6819
7170
|
"uid": {
|
|
6820
7171
|
"type": "string",
|
|
@@ -6835,9 +7186,10 @@
|
|
|
6835
7186
|
"x-original-maxLength": 1024,
|
|
6836
7187
|
"format": "uuid",
|
|
6837
7188
|
"x-reconciled-from-discovery": true,
|
|
6838
|
-
"x-reconciled-at": "2026-01-
|
|
7189
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817008+00:00"
|
|
6839
7190
|
}
|
|
6840
7191
|
},
|
|
7192
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
6841
7193
|
"x-f5xc-minimum-configuration": {
|
|
6842
7194
|
"description": "Minimum configuration for schemaViewRefType",
|
|
6843
7195
|
"required_fields": [
|
|
@@ -6863,6 +7215,7 @@
|
|
|
6863
7215
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
6864
7216
|
"title": "Name",
|
|
6865
7217
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
7218
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
6866
7219
|
"minLength": 0,
|
|
6867
7220
|
"maxLength": 16,
|
|
6868
7221
|
"x-f5xc-required-for": {
|
|
@@ -6873,9 +7226,10 @@
|
|
|
6873
7226
|
},
|
|
6874
7227
|
"x-original-maxLength": 1024,
|
|
6875
7228
|
"x-reconciled-from-discovery": true,
|
|
6876
|
-
"x-reconciled-at": "2026-01-
|
|
7229
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817012+00:00"
|
|
6877
7230
|
}
|
|
6878
7231
|
},
|
|
7232
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
6879
7233
|
"x-f5xc-minimum-configuration": {
|
|
6880
7234
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
6881
7235
|
"required_fields": [
|
|
@@ -6915,6 +7269,8 @@
|
|
|
6915
7269
|
"ves.io.schema.rules.string.max_bytes": "128",
|
|
6916
7270
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
6917
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.",
|
|
6918
7274
|
"x-f5xc-required-for": {
|
|
6919
7275
|
"minimum_config": false,
|
|
6920
7276
|
"create": false,
|
|
@@ -6923,7 +7279,7 @@
|
|
|
6923
7279
|
},
|
|
6924
7280
|
"x-original-maxLength": 128,
|
|
6925
7281
|
"x-reconciled-from-discovery": true,
|
|
6926
|
-
"x-reconciled-at": "2026-01-
|
|
7282
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817018+00:00"
|
|
6927
7283
|
},
|
|
6928
7284
|
"namespace": {
|
|
6929
7285
|
"type": "string",
|
|
@@ -6939,6 +7295,8 @@
|
|
|
6939
7295
|
"x-validation-rules": {
|
|
6940
7296
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
6941
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.",
|
|
6942
7300
|
"minLength": 0,
|
|
6943
7301
|
"x-f5xc-required-for": {
|
|
6944
7302
|
"minimum_config": false,
|
|
@@ -6948,7 +7306,7 @@
|
|
|
6948
7306
|
},
|
|
6949
7307
|
"x-original-maxLength": 64,
|
|
6950
7308
|
"x-reconciled-from-discovery": true,
|
|
6951
|
-
"x-reconciled-at": "2026-01-
|
|
7309
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817022+00:00"
|
|
6952
7310
|
},
|
|
6953
7311
|
"tenant": {
|
|
6954
7312
|
"type": "string",
|
|
@@ -6964,6 +7322,8 @@
|
|
|
6964
7322
|
"x-validation-rules": {
|
|
6965
7323
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
6966
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.",
|
|
6967
7327
|
"minLength": 0,
|
|
6968
7328
|
"x-f5xc-required-for": {
|
|
6969
7329
|
"minimum_config": false,
|
|
@@ -6975,9 +7335,11 @@
|
|
|
6975
7335
|
"x-field-mutability": "read-only",
|
|
6976
7336
|
"x-original-maxLength": 64,
|
|
6977
7337
|
"x-reconciled-from-discovery": true,
|
|
6978
|
-
"x-reconciled-at": "2026-01-
|
|
7338
|
+
"x-reconciled-at": "2026-01-07T15:28:30.817027+00:00"
|
|
6979
7339
|
}
|
|
6980
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.",
|
|
6981
7343
|
"x-f5xc-minimum-configuration": {
|
|
6982
7344
|
"description": "Minimum configuration for schemaviewsObjectRefType",
|
|
6983
7345
|
"required_fields": [
|
|
@@ -7030,7 +7392,7 @@
|
|
|
7030
7392
|
"maxLength": 15,
|
|
7031
7393
|
"minLength": 3,
|
|
7032
7394
|
"x-reconciled-from-discovery": true,
|
|
7033
|
-
"x-reconciled-at": "2026-01-
|
|
7395
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180244+00:00"
|
|
7034
7396
|
}
|
|
7035
7397
|
},
|
|
7036
7398
|
"x-f5xc-minimum-configuration": {
|
|
@@ -7068,7 +7430,7 @@
|
|
|
7068
7430
|
},
|
|
7069
7431
|
"x-original-maxLength": 1024,
|
|
7070
7432
|
"x-reconciled-from-discovery": true,
|
|
7071
|
-
"x-reconciled-at": "2026-01-
|
|
7433
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180252+00:00"
|
|
7072
7434
|
},
|
|
7073
7435
|
"id": {
|
|
7074
7436
|
"type": "string",
|
|
@@ -7105,7 +7467,7 @@
|
|
|
7105
7467
|
},
|
|
7106
7468
|
"x-original-maxLength": 1024,
|
|
7107
7469
|
"x-reconciled-from-discovery": true,
|
|
7108
|
-
"x-reconciled-at": "2026-01-
|
|
7470
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180260+00:00"
|
|
7109
7471
|
},
|
|
7110
7472
|
"status": {
|
|
7111
7473
|
"type": "string",
|
|
@@ -7114,6 +7476,7 @@
|
|
|
7114
7476
|
"x-displayname": "Status",
|
|
7115
7477
|
"x-ves-example": "Subscribed.",
|
|
7116
7478
|
"x-f5xc-example": "subscribed",
|
|
7479
|
+
"x-f5xc-description-short": "Information to suggest if the dataset is currently subscribed by the tenant.",
|
|
7117
7480
|
"minLength": 0,
|
|
7118
7481
|
"maxLength": 17,
|
|
7119
7482
|
"x-f5xc-required-for": {
|
|
@@ -7124,7 +7487,7 @@
|
|
|
7124
7487
|
},
|
|
7125
7488
|
"x-original-maxLength": 1024,
|
|
7126
7489
|
"x-reconciled-from-discovery": true,
|
|
7127
|
-
"x-reconciled-at": "2026-01-
|
|
7490
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180265+00:00"
|
|
7128
7491
|
}
|
|
7129
7492
|
},
|
|
7130
7493
|
"x-f5xc-minimum-configuration": {
|
|
@@ -7171,6 +7534,7 @@
|
|
|
7171
7534
|
"title": "EventsCount.",
|
|
7172
7535
|
"format": "int64",
|
|
7173
7536
|
"x-displayname": "Events Count.",
|
|
7537
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7174
7538
|
"minimum": 0,
|
|
7175
7539
|
"maximum": 2147483647,
|
|
7176
7540
|
"x-f5xc-required-for": {
|
|
@@ -7186,6 +7550,7 @@
|
|
|
7186
7550
|
"title": "EventsPercentage.",
|
|
7187
7551
|
"format": "double",
|
|
7188
7552
|
"x-displayname": "Events Percentage.",
|
|
7553
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7189
7554
|
"x-f5xc-required-for": {
|
|
7190
7555
|
"minimum_config": false,
|
|
7191
7556
|
"create": false,
|
|
@@ -7210,9 +7575,10 @@
|
|
|
7210
7575
|
},
|
|
7211
7576
|
"x-original-maxLength": 1024,
|
|
7212
7577
|
"x-reconciled-from-discovery": true,
|
|
7213
|
-
"x-reconciled-at": "2026-01-
|
|
7578
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180274+00:00"
|
|
7214
7579
|
}
|
|
7215
7580
|
},
|
|
7581
|
+
"x-f5xc-description-short": "Message object representing events reason.",
|
|
7216
7582
|
"x-f5xc-minimum-configuration": {
|
|
7217
7583
|
"description": "Minimum configuration for data_deliveryEventsReason",
|
|
7218
7584
|
"required_fields": [
|
|
@@ -7237,7 +7603,7 @@
|
|
|
7237
7603
|
"properties": {
|
|
7238
7604
|
"data_format": {
|
|
7239
7605
|
"type": "string",
|
|
7240
|
-
"description": "",
|
|
7606
|
+
"description": "Data or content configuration",
|
|
7241
7607
|
"title": "Data format.",
|
|
7242
7608
|
"x-displayname": "Data format.",
|
|
7243
7609
|
"x-ves-example": "String",
|
|
@@ -7266,13 +7632,14 @@
|
|
|
7266
7632
|
},
|
|
7267
7633
|
"x-original-maxLength": 1024,
|
|
7268
7634
|
"x-reconciled-from-discovery": true,
|
|
7269
|
-
"x-reconciled-at": "2026-01-
|
|
7635
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180281+00:00"
|
|
7270
7636
|
},
|
|
7271
7637
|
"feature_name": {
|
|
7272
7638
|
"type": "string",
|
|
7273
7639
|
"description": "Name of the feature.",
|
|
7274
7640
|
"title": "Feature name.",
|
|
7275
7641
|
"x-displayname": "Feature Name.",
|
|
7642
|
+
"x-f5xc-example": "example-resource",
|
|
7276
7643
|
"minLength": 0,
|
|
7277
7644
|
"maxLength": 1024,
|
|
7278
7645
|
"x-f5xc-required-for": {
|
|
@@ -7288,6 +7655,7 @@
|
|
|
7288
7655
|
"title": "IsNewField.",
|
|
7289
7656
|
"format": "boolean",
|
|
7290
7657
|
"x-displayname": "IsNewField.",
|
|
7658
|
+
"x-f5xc-description-short": "Information to suggest if this is existing or new feature in dataset.",
|
|
7291
7659
|
"x-f5xc-required-for": {
|
|
7292
7660
|
"minimum_config": false,
|
|
7293
7661
|
"create": false,
|
|
@@ -7300,6 +7668,7 @@
|
|
|
7300
7668
|
"description": "Additional notes about the dataset feature.",
|
|
7301
7669
|
"title": "Notes",
|
|
7302
7670
|
"x-displayname": "Notes",
|
|
7671
|
+
"x-f5xc-description-short": "Additional notes about the dataset feature.",
|
|
7303
7672
|
"minLength": 0,
|
|
7304
7673
|
"maxLength": 1024,
|
|
7305
7674
|
"x-f5xc-required-for": {
|
|
@@ -7315,6 +7684,7 @@
|
|
|
7315
7684
|
"title": "Required",
|
|
7316
7685
|
"format": "boolean",
|
|
7317
7686
|
"x-displayname": "Required",
|
|
7687
|
+
"x-f5xc-example": "True",
|
|
7318
7688
|
"x-f5xc-required-for": {
|
|
7319
7689
|
"minimum_config": false,
|
|
7320
7690
|
"create": false,
|
|
@@ -7323,6 +7693,7 @@
|
|
|
7323
7693
|
}
|
|
7324
7694
|
}
|
|
7325
7695
|
},
|
|
7696
|
+
"x-f5xc-description-short": "Definition of feature which is unit of dataset.",
|
|
7326
7697
|
"x-f5xc-minimum-configuration": {
|
|
7327
7698
|
"description": "Minimum configuration for data_deliveryFeature",
|
|
7328
7699
|
"required_fields": [
|
|
@@ -7378,6 +7749,7 @@
|
|
|
7378
7749
|
}
|
|
7379
7750
|
}
|
|
7380
7751
|
},
|
|
7752
|
+
"x-f5xc-description-short": "Message representing flow label information.",
|
|
7381
7753
|
"x-f5xc-minimum-configuration": {
|
|
7382
7754
|
"description": "Minimum configuration for data_deliveryFlowLabel",
|
|
7383
7755
|
"required_fields": [
|
|
@@ -7406,6 +7778,7 @@
|
|
|
7406
7778
|
"$ref": "#/components/schemas/data_deliveryFeature"
|
|
7407
7779
|
},
|
|
7408
7780
|
"x-displayname": "Feature List.",
|
|
7781
|
+
"x-f5xc-example": "True",
|
|
7409
7782
|
"x-f5xc-required-for": {
|
|
7410
7783
|
"minimum_config": false,
|
|
7411
7784
|
"create": false,
|
|
@@ -7414,6 +7787,7 @@
|
|
|
7414
7787
|
}
|
|
7415
7788
|
}
|
|
7416
7789
|
},
|
|
7790
|
+
"x-f5xc-description-short": "Dataset feature fetched by data dictionary API.",
|
|
7417
7791
|
"x-f5xc-minimum-configuration": {
|
|
7418
7792
|
"description": "Minimum configuration for data_deliveryGetDataDictionaryResponse",
|
|
7419
7793
|
"required_fields": [
|
|
@@ -7438,6 +7812,8 @@
|
|
|
7438
7812
|
"items": {
|
|
7439
7813
|
"type": "string"
|
|
7440
7814
|
},
|
|
7815
|
+
"description": "Data or content configuration",
|
|
7816
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7441
7817
|
"x-f5xc-required-for": {
|
|
7442
7818
|
"minimum_config": false,
|
|
7443
7819
|
"create": false,
|
|
@@ -7447,6 +7823,7 @@
|
|
|
7447
7823
|
}
|
|
7448
7824
|
},
|
|
7449
7825
|
"x-f5xc-example": "DI Advanced",
|
|
7826
|
+
"x-f5xc-description-short": "List of Data Sets eligible for the tenant.",
|
|
7450
7827
|
"x-f5xc-minimum-configuration": {
|
|
7451
7828
|
"description": "Minimum configuration for data_deliveryGetDataSetsResponse",
|
|
7452
7829
|
"required_fields": [
|
|
@@ -7473,6 +7850,7 @@
|
|
|
7473
7850
|
"x-displayname": "Granularity.",
|
|
7474
7851
|
"x-ves-example": "5m",
|
|
7475
7852
|
"x-f5xc-example": "5m",
|
|
7853
|
+
"x-f5xc-description-short": "Granularity of the data points (\"1m\", \"5m\", etc.).",
|
|
7476
7854
|
"minLength": 0,
|
|
7477
7855
|
"maxLength": 1024,
|
|
7478
7856
|
"x-f5xc-required-for": {
|
|
@@ -7498,6 +7876,7 @@
|
|
|
7498
7876
|
}
|
|
7499
7877
|
}
|
|
7500
7878
|
},
|
|
7879
|
+
"x-f5xc-description-short": "Message object representing line chart data.",
|
|
7501
7880
|
"x-f5xc-minimum-configuration": {
|
|
7502
7881
|
"description": "Minimum configuration for data_deliveryLineChartData",
|
|
7503
7882
|
"required_fields": [
|
|
@@ -7526,6 +7905,7 @@
|
|
|
7526
7905
|
"$ref": "#/components/schemas/data_deliveryDataSet"
|
|
7527
7906
|
},
|
|
7528
7907
|
"x-displayname": "DataSet List.",
|
|
7908
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7529
7909
|
"x-f5xc-required-for": {
|
|
7530
7910
|
"minimum_config": false,
|
|
7531
7911
|
"create": false,
|
|
@@ -7623,6 +8003,7 @@
|
|
|
7623
8003
|
"x-displayname": "Granularity.",
|
|
7624
8004
|
"x-ves-example": "5m",
|
|
7625
8005
|
"x-f5xc-example": "5m",
|
|
8006
|
+
"x-f5xc-description-short": "Granularity of the data points (\"1m\", \"5m\", etc.).",
|
|
7626
8007
|
"minLength": 0,
|
|
7627
8008
|
"maxLength": 1024,
|
|
7628
8009
|
"x-f5xc-required-for": {
|
|
@@ -7639,6 +8020,7 @@
|
|
|
7639
8020
|
"x-displayname": "Namespace",
|
|
7640
8021
|
"x-ves-example": "Foobar",
|
|
7641
8022
|
"x-f5xc-example": "foobar",
|
|
8023
|
+
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
|
|
7642
8024
|
"minLength": 0,
|
|
7643
8025
|
"maxLength": 6,
|
|
7644
8026
|
"x-f5xc-required-for": {
|
|
@@ -7649,7 +8031,7 @@
|
|
|
7649
8031
|
},
|
|
7650
8032
|
"x-original-maxLength": 1024,
|
|
7651
8033
|
"x-reconciled-from-discovery": true,
|
|
7652
|
-
"x-reconciled-at": "2026-01-
|
|
8034
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180309+00:00"
|
|
7653
8035
|
},
|
|
7654
8036
|
"platform": {
|
|
7655
8037
|
"type": "string",
|
|
@@ -7658,6 +8040,7 @@
|
|
|
7658
8040
|
"x-displayname": "Platform",
|
|
7659
8041
|
"x-ves-example": "Mobile",
|
|
7660
8042
|
"x-f5xc-example": "mobile",
|
|
8043
|
+
"x-f5xc-description-short": "Platform criteria for filtering the data.",
|
|
7661
8044
|
"minLength": 0,
|
|
7662
8045
|
"maxLength": 1024,
|
|
7663
8046
|
"x-f5xc-required-for": {
|
|
@@ -7700,6 +8083,7 @@
|
|
|
7700
8083
|
}
|
|
7701
8084
|
}
|
|
7702
8085
|
},
|
|
8086
|
+
"x-f5xc-description-short": "Request object to GET executive summary of DI premium customer.",
|
|
7703
8087
|
"x-f5xc-minimum-configuration": {
|
|
7704
8088
|
"description": "Minimum configuration for data_deliveryLoadExecutiveSummaryRequest",
|
|
7705
8089
|
"required_fields": [
|
|
@@ -7735,6 +8119,7 @@
|
|
|
7735
8119
|
"x-displayname": "Events Reason.",
|
|
7736
8120
|
"x-ves-example": "High attempt value , high success volume.",
|
|
7737
8121
|
"x-f5xc-example": "high attempt value , high success volume",
|
|
8122
|
+
"x-f5xc-description-short": "Message representing the transaction data.",
|
|
7738
8123
|
"x-f5xc-required-for": {
|
|
7739
8124
|
"minimum_config": false,
|
|
7740
8125
|
"create": false,
|
|
@@ -7749,6 +8134,7 @@
|
|
|
7749
8134
|
"$ref": "#/components/schemas/data_deliverySummaryPanel"
|
|
7750
8135
|
}
|
|
7751
8136
|
},
|
|
8137
|
+
"x-f5xc-description-short": "Response object to GET executive summary of DI premium customer.",
|
|
7752
8138
|
"x-f5xc-minimum-configuration": {
|
|
7753
8139
|
"description": "Minimum configuration for data_deliveryLoadExecutiveSummaryResponse",
|
|
7754
8140
|
"required_fields": [
|
|
@@ -7778,6 +8164,7 @@
|
|
|
7778
8164
|
"$ref": "#/components/schemas/data_deliveryDataPoint"
|
|
7779
8165
|
},
|
|
7780
8166
|
"x-displayname": "Data Point.",
|
|
8167
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7781
8168
|
"x-f5xc-required-for": {
|
|
7782
8169
|
"minimum_config": false,
|
|
7783
8170
|
"create": false,
|
|
@@ -7792,6 +8179,7 @@
|
|
|
7792
8179
|
"x-displayname": "Name",
|
|
7793
8180
|
"x-ves-example": "Bot",
|
|
7794
8181
|
"x-f5xc-example": "bot",
|
|
8182
|
+
"x-f5xc-description-short": "Name of the series (\"typical\", \"bot\", \"anomalous\").",
|
|
7795
8183
|
"minLength": 0,
|
|
7796
8184
|
"maxLength": 16,
|
|
7797
8185
|
"x-f5xc-required-for": {
|
|
@@ -7802,7 +8190,7 @@
|
|
|
7802
8190
|
},
|
|
7803
8191
|
"x-original-maxLength": 1024,
|
|
7804
8192
|
"x-reconciled-from-discovery": true,
|
|
7805
|
-
"x-reconciled-at": "2026-01-
|
|
8193
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180323+00:00"
|
|
7806
8194
|
}
|
|
7807
8195
|
},
|
|
7808
8196
|
"x-f5xc-minimum-configuration": {
|
|
@@ -7831,6 +8219,7 @@
|
|
|
7831
8219
|
"title": "AnomalousDevices.",
|
|
7832
8220
|
"format": "int64",
|
|
7833
8221
|
"x-displayname": "Anomalous Devices.",
|
|
8222
|
+
"x-f5xc-description-short": "Number of devices identified as anomalous.",
|
|
7834
8223
|
"minimum": 0,
|
|
7835
8224
|
"maximum": 2147483647,
|
|
7836
8225
|
"x-f5xc-required-for": {
|
|
@@ -7846,6 +8235,7 @@
|
|
|
7846
8235
|
"title": "AnomalousDevicesPercentage.",
|
|
7847
8236
|
"format": "double",
|
|
7848
8237
|
"x-displayname": "Anomalous Devices Percentage.",
|
|
8238
|
+
"x-f5xc-description-short": "Percentage of anomalous devices over total evaluated devices.",
|
|
7849
8239
|
"x-f5xc-required-for": {
|
|
7850
8240
|
"minimum_config": false,
|
|
7851
8241
|
"create": false,
|
|
@@ -7885,6 +8275,7 @@
|
|
|
7885
8275
|
"title": "AnomalousPercentage.",
|
|
7886
8276
|
"format": "double",
|
|
7887
8277
|
"x-displayname": "Anomalous Percentage.",
|
|
8278
|
+
"x-f5xc-description-short": "Percentage of anomalous transactions over total evaluated transactions.",
|
|
7888
8279
|
"x-f5xc-required-for": {
|
|
7889
8280
|
"minimum_config": false,
|
|
7890
8281
|
"create": false,
|
|
@@ -7898,6 +8289,7 @@
|
|
|
7898
8289
|
"title": "AnomalousTransactions.",
|
|
7899
8290
|
"format": "int64",
|
|
7900
8291
|
"x-displayname": "Anomalous Transactions.",
|
|
8292
|
+
"x-f5xc-description-short": "Number of transactions identified as anomalous.",
|
|
7901
8293
|
"minimum": 0,
|
|
7902
8294
|
"maximum": 2147483647,
|
|
7903
8295
|
"x-f5xc-required-for": {
|
|
@@ -7913,6 +8305,7 @@
|
|
|
7913
8305
|
"title": "BotPercentage.",
|
|
7914
8306
|
"format": "double",
|
|
7915
8307
|
"x-displayname": "Bot Percentage.",
|
|
8308
|
+
"x-f5xc-description-short": "Percentage of bot transactions over total evaluated transactions.",
|
|
7916
8309
|
"x-f5xc-required-for": {
|
|
7917
8310
|
"minimum_config": false,
|
|
7918
8311
|
"create": false,
|
|
@@ -7926,6 +8319,7 @@
|
|
|
7926
8319
|
"title": "BotTransactions.",
|
|
7927
8320
|
"format": "int64",
|
|
7928
8321
|
"x-displayname": "Bot Transactions.",
|
|
8322
|
+
"x-f5xc-description-short": "Number of transactions identified as bots.",
|
|
7929
8323
|
"minimum": 0,
|
|
7930
8324
|
"maximum": 2147483647,
|
|
7931
8325
|
"x-f5xc-required-for": {
|
|
@@ -7966,6 +8360,7 @@
|
|
|
7966
8360
|
}
|
|
7967
8361
|
}
|
|
7968
8362
|
},
|
|
8363
|
+
"x-f5xc-description-short": "Message object representing summary panel.",
|
|
7969
8364
|
"x-f5xc-minimum-configuration": {
|
|
7970
8365
|
"description": "Minimum configuration for data_deliverySummaryPanel",
|
|
7971
8366
|
"required_fields": [
|
|
@@ -8032,6 +8427,7 @@
|
|
|
8032
8427
|
"x-validation-rules": {
|
|
8033
8428
|
"ves.io.schema.rules.message.required": "true"
|
|
8034
8429
|
},
|
|
8430
|
+
"x-f5xc-description-short": "Namespace in which the receiver is configured Required: YES.",
|
|
8035
8431
|
"minLength": 0,
|
|
8036
8432
|
"maxLength": 6,
|
|
8037
8433
|
"x-f5xc-required-for": {
|
|
@@ -8042,9 +8438,10 @@
|
|
|
8042
8438
|
},
|
|
8043
8439
|
"x-original-maxLength": 1024,
|
|
8044
8440
|
"x-reconciled-from-discovery": true,
|
|
8045
|
-
"x-reconciled-at": "2026-01-
|
|
8441
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180343+00:00"
|
|
8046
8442
|
}
|
|
8047
8443
|
},
|
|
8444
|
+
"x-f5xc-description-short": "Request to test receiver & destination sink.",
|
|
8048
8445
|
"x-f5xc-minimum-configuration": {
|
|
8049
8446
|
"description": "Minimum configuration for data_deliveryTestReceiverRequest",
|
|
8050
8447
|
"required_fields": [
|
|
@@ -8072,6 +8469,7 @@
|
|
|
8072
8469
|
"x-displayname": "Message",
|
|
8073
8470
|
"x-ves-example": "Credentials invalid.",
|
|
8074
8471
|
"x-f5xc-example": "Credentials invalid",
|
|
8472
|
+
"x-f5xc-description-short": "The error string if the status is failed.",
|
|
8075
8473
|
"minLength": 0,
|
|
8076
8474
|
"maxLength": 1024,
|
|
8077
8475
|
"x-f5xc-required-for": {
|
|
@@ -8085,6 +8483,8 @@
|
|
|
8085
8483
|
"$ref": "#/components/schemas/data_deliveryTestReceiverStatusType"
|
|
8086
8484
|
}
|
|
8087
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.",
|
|
8088
8488
|
"x-f5xc-minimum-configuration": {
|
|
8089
8489
|
"description": "Minimum configuration for data_deliveryTestReceiverResponse",
|
|
8090
8490
|
"required_fields": [
|
|
@@ -8109,6 +8509,8 @@
|
|
|
8109
8509
|
"default": "SUCCESS",
|
|
8110
8510
|
"x-displayname": "Test Receiver Status Type.",
|
|
8111
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.",
|
|
8112
8514
|
"x-f5xc-minimum-configuration": {
|
|
8113
8515
|
"description": "Minimum configuration for data_deliveryTestReceiverStatusType",
|
|
8114
8516
|
"required_fields": [],
|
|
@@ -8157,6 +8559,7 @@
|
|
|
8157
8559
|
"x-displayname": "Namespace",
|
|
8158
8560
|
"x-ves-example": "Foobar",
|
|
8159
8561
|
"x-f5xc-example": "foobar",
|
|
8562
|
+
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
|
|
8160
8563
|
"minLength": 0,
|
|
8161
8564
|
"maxLength": 6,
|
|
8162
8565
|
"x-f5xc-required-for": {
|
|
@@ -8167,7 +8570,7 @@
|
|
|
8167
8570
|
},
|
|
8168
8571
|
"x-original-maxLength": 1024,
|
|
8169
8572
|
"x-reconciled-from-discovery": true,
|
|
8170
|
-
"x-reconciled-at": "2026-01-
|
|
8573
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180353+00:00"
|
|
8171
8574
|
},
|
|
8172
8575
|
"type": {
|
|
8173
8576
|
"$ref": "#/components/schemas/shapedata_deliveryStatusType"
|
|
@@ -8219,6 +8622,7 @@
|
|
|
8219
8622
|
"x-displayname": "Receiver Name.",
|
|
8220
8623
|
"x-ves-example": "Splunk-cloud-receiver.",
|
|
8221
8624
|
"x-f5xc-example": "splunk-cloud-receiver",
|
|
8625
|
+
"x-f5xc-description-short": "Name of the receiver configured by the customer.",
|
|
8222
8626
|
"minLength": 0,
|
|
8223
8627
|
"maxLength": 1024,
|
|
8224
8628
|
"x-f5xc-required-for": {
|
|
@@ -8235,6 +8639,7 @@
|
|
|
8235
8639
|
"x-displayname": "Status",
|
|
8236
8640
|
"x-ves-example": "Not_modified.",
|
|
8237
8641
|
"x-f5xc-example": "not_modified",
|
|
8642
|
+
"x-f5xc-description-short": "Values: not_modified , success Status about receiver status modification.",
|
|
8238
8643
|
"minLength": 0,
|
|
8239
8644
|
"maxLength": 17,
|
|
8240
8645
|
"x-f5xc-required-for": {
|
|
@@ -8245,9 +8650,10 @@
|
|
|
8245
8650
|
},
|
|
8246
8651
|
"x-original-maxLength": 1024,
|
|
8247
8652
|
"x-reconciled-from-discovery": true,
|
|
8248
|
-
"x-reconciled-at": "2026-01-
|
|
8653
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180361+00:00"
|
|
8249
8654
|
}
|
|
8250
8655
|
},
|
|
8656
|
+
"x-f5xc-description-short": "Payload about status of receiver status result.",
|
|
8251
8657
|
"x-f5xc-minimum-configuration": {
|
|
8252
8658
|
"description": "Minimum configuration for data_deliveryUpdateReceiverStatusResponse",
|
|
8253
8659
|
"required_fields": [
|
|
@@ -8283,6 +8689,7 @@
|
|
|
8283
8689
|
"x-validation-rules": {
|
|
8284
8690
|
"ves.io.schema.rules.string.max_len": "1024"
|
|
8285
8691
|
},
|
|
8692
|
+
"x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.",
|
|
8286
8693
|
"minLength": 0,
|
|
8287
8694
|
"x-f5xc-required-for": {
|
|
8288
8695
|
"minimum_config": false,
|
|
@@ -8305,6 +8712,8 @@
|
|
|
8305
8712
|
"x-validation-rules": {
|
|
8306
8713
|
"ves.io.schema.rules.string.max_len": "256"
|
|
8307
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.",
|
|
8308
8717
|
"minLength": 0,
|
|
8309
8718
|
"x-f5xc-required-for": {
|
|
8310
8719
|
"minimum_config": false,
|
|
@@ -8320,6 +8729,7 @@
|
|
|
8320
8729
|
"x-displayname": "Namespace",
|
|
8321
8730
|
"x-ves-example": "Foobar",
|
|
8322
8731
|
"x-f5xc-example": "foobar",
|
|
8732
|
+
"x-f5xc-description-short": "Namespace in which the suggestions are scoped.",
|
|
8323
8733
|
"minLength": 0,
|
|
8324
8734
|
"maxLength": 6,
|
|
8325
8735
|
"x-f5xc-required-for": {
|
|
@@ -8330,7 +8740,7 @@
|
|
|
8330
8740
|
},
|
|
8331
8741
|
"x-original-maxLength": 1024,
|
|
8332
8742
|
"x-reconciled-from-discovery": true,
|
|
8333
|
-
"x-reconciled-at": "2026-01-
|
|
8743
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180369+00:00"
|
|
8334
8744
|
},
|
|
8335
8745
|
"request_body": {
|
|
8336
8746
|
"$ref": "#/components/schemas/protobufAny"
|
|
@@ -8366,6 +8776,7 @@
|
|
|
8366
8776
|
"$ref": "#/components/schemas/namespaceSuggestedItem"
|
|
8367
8777
|
},
|
|
8368
8778
|
"x-displayname": "Suggested Items.",
|
|
8779
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
8369
8780
|
"x-f5xc-required-for": {
|
|
8370
8781
|
"minimum_config": false,
|
|
8371
8782
|
"create": false,
|
|
@@ -8399,6 +8810,7 @@
|
|
|
8399
8810
|
"description": "Optional description for the suggested value.",
|
|
8400
8811
|
"title": "Description.",
|
|
8401
8812
|
"x-displayname": "Description.",
|
|
8813
|
+
"x-f5xc-description-short": "Optional description for the suggested value.",
|
|
8402
8814
|
"minLength": 0,
|
|
8403
8815
|
"maxLength": 0,
|
|
8404
8816
|
"x-f5xc-required-for": {
|
|
@@ -8409,7 +8821,7 @@
|
|
|
8409
8821
|
},
|
|
8410
8822
|
"x-original-maxLength": 1024,
|
|
8411
8823
|
"x-reconciled-from-discovery": true,
|
|
8412
|
-
"x-reconciled-at": "2026-01-
|
|
8824
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180377+00:00"
|
|
8413
8825
|
},
|
|
8414
8826
|
"ref_value": {
|
|
8415
8827
|
"$ref": "#/components/schemas/schemaviewsObjectRefType"
|
|
@@ -8433,6 +8845,9 @@
|
|
|
8433
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.",
|
|
8434
8846
|
"title": "Title",
|
|
8435
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.",
|
|
8436
8851
|
"minLength": 0,
|
|
8437
8852
|
"maxLength": 6,
|
|
8438
8853
|
"x-f5xc-required-for": {
|
|
@@ -8443,13 +8858,14 @@
|
|
|
8443
8858
|
},
|
|
8444
8859
|
"x-original-maxLength": 1024,
|
|
8445
8860
|
"x-reconciled-from-discovery": true,
|
|
8446
|
-
"x-reconciled-at": "2026-01-
|
|
8861
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180383+00:00"
|
|
8447
8862
|
},
|
|
8448
8863
|
"value": {
|
|
8449
8864
|
"type": "string",
|
|
8450
8865
|
"description": "Suggested value for the field.\nShould use value_choice.str_value instead.",
|
|
8451
8866
|
"title": "Value",
|
|
8452
8867
|
"x-displayname": "Value",
|
|
8868
|
+
"x-f5xc-description-short": "Suggested value for the field. Should use value_choice.str_value instead.",
|
|
8453
8869
|
"minLength": 0,
|
|
8454
8870
|
"maxLength": 15,
|
|
8455
8871
|
"x-f5xc-required-for": {
|
|
@@ -8460,9 +8876,10 @@
|
|
|
8460
8876
|
},
|
|
8461
8877
|
"x-original-maxLength": 1024,
|
|
8462
8878
|
"x-reconciled-from-discovery": true,
|
|
8463
|
-
"x-reconciled-at": "2026-01-
|
|
8879
|
+
"x-reconciled-at": "2026-01-07T15:28:31.180388+00:00"
|
|
8464
8880
|
}
|
|
8465
8881
|
},
|
|
8882
|
+
"x-f5xc-description-short": "Tuple with a suggested value and it's description.",
|
|
8466
8883
|
"x-f5xc-minimum-configuration": {
|
|
8467
8884
|
"description": "Minimum configuration for namespaceSuggestedItem",
|
|
8468
8885
|
"required_fields": [
|
|
@@ -8485,6 +8902,7 @@
|
|
|
8485
8902
|
"title": "Empty",
|
|
8486
8903
|
"x-displayname": "Empty",
|
|
8487
8904
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
8905
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
8488
8906
|
"x-f5xc-minimum-configuration": {
|
|
8489
8907
|
"description": "Minimum configuration for schemaEmpty",
|
|
8490
8908
|
"required_fields": [],
|
|
@@ -8506,6 +8924,7 @@
|
|
|
8506
8924
|
"default": "DISABLE",
|
|
8507
8925
|
"x-displayname": "Status type.",
|
|
8508
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.",
|
|
8509
8928
|
"x-f5xc-minimum-configuration": {
|
|
8510
8929
|
"description": "Minimum configuration for shapedata_deliveryStatusType",
|
|
8511
8930
|
"required_fields": [],
|
|
@@ -8522,6 +8941,7 @@
|
|
|
8522
8941
|
"title": "SubscribeRequest.",
|
|
8523
8942
|
"x-displayname": "Subscribe Request.",
|
|
8524
8943
|
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.SubscribeRequest",
|
|
8944
|
+
"x-f5xc-description-short": "Request of subscribe to Data-Intelligence.",
|
|
8525
8945
|
"x-f5xc-minimum-configuration": {
|
|
8526
8946
|
"description": "Minimum configuration for subscriptionSubscribeRequest",
|
|
8527
8947
|
"required_fields": [],
|
|
@@ -8538,6 +8958,7 @@
|
|
|
8538
8958
|
"title": "SubscribeResponse.",
|
|
8539
8959
|
"x-displayname": "Subscribe Response.",
|
|
8540
8960
|
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.SubscribeResponse",
|
|
8961
|
+
"x-f5xc-description-short": "Response of subscribe to Data-Intelligence.",
|
|
8541
8962
|
"x-f5xc-minimum-configuration": {
|
|
8542
8963
|
"description": "Minimum configuration for subscriptionSubscribeResponse",
|
|
8543
8964
|
"required_fields": [],
|
|
@@ -8554,6 +8975,7 @@
|
|
|
8554
8975
|
"title": "UnsubscribeRequest.",
|
|
8555
8976
|
"x-displayname": "Unsubscribe Request.",
|
|
8556
8977
|
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.UnsubscribeRequest",
|
|
8978
|
+
"x-f5xc-description-short": "Request of unsubscribe to Data-Intelligence.",
|
|
8557
8979
|
"x-f5xc-minimum-configuration": {
|
|
8558
8980
|
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
|
|
8559
8981
|
"required_fields": [],
|
|
@@ -8570,6 +8992,7 @@
|
|
|
8570
8992
|
"title": "UnsubscribeResponse.",
|
|
8571
8993
|
"x-displayname": "Unsubscribe Response.",
|
|
8572
8994
|
"x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.UnsubscribeResponse",
|
|
8995
|
+
"x-f5xc-description-short": "Response of unsubscribe to Data-Intelligence.",
|
|
8573
8996
|
"x-f5xc-minimum-configuration": {
|
|
8574
8997
|
"description": "Minimum configuration for subscriptionUnsubscribeResponse",
|
|
8575
8998
|
"required_fields": [],
|