@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": "Billing And Usage",
|
|
5
5
|
"description": "Subscription lifecycle with plan transitions and billing states. Payment method hierarchies supporting primary and secondary configurations. Invoice generation with PDF downloads and custom listing. Resource quotas per namespace with limit definitions and consumption metrics. Contact types for billing notifications and tenant deletion workflows.",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.19",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -13,7 +13,57 @@
|
|
|
13
13
|
"url": "https://www.f5.com/company/policies/eula"
|
|
14
14
|
},
|
|
15
15
|
"summary": "Plan transitions, invoicing, and resource consumption. Namespace-level quota limits and usage tracking.",
|
|
16
|
-
"x-f5xc-cli-domain": "billing_and_usage"
|
|
16
|
+
"x-f5xc-cli-domain": "billing_and_usage",
|
|
17
|
+
"x-f5xc-best-practices": {
|
|
18
|
+
"common_errors": [
|
|
19
|
+
{
|
|
20
|
+
"code": 400,
|
|
21
|
+
"message": "Invalid request body",
|
|
22
|
+
"resolution": "Validate JSON structure and required fields before submission",
|
|
23
|
+
"prevention": "Use schema validation from OpenAPI spec"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"code": 401,
|
|
27
|
+
"message": "Authentication failed",
|
|
28
|
+
"resolution": "Verify API token is valid and not expired",
|
|
29
|
+
"prevention": "Use environment variables for token management"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"code": 403,
|
|
33
|
+
"message": "Permission denied",
|
|
34
|
+
"resolution": "Check user role and namespace permissions",
|
|
35
|
+
"prevention": "Verify RBAC policies before operations"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"code": 404,
|
|
39
|
+
"message": "Resource not found",
|
|
40
|
+
"resolution": "Verify resource name and namespace exist",
|
|
41
|
+
"prevention": "List resources before attempting operations"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"code": 409,
|
|
45
|
+
"message": "Resource already exists",
|
|
46
|
+
"resolution": "Use unique name or delete existing resource",
|
|
47
|
+
"prevention": "Check existence before creation"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"code": 429,
|
|
51
|
+
"message": "Rate limit exceeded",
|
|
52
|
+
"resolution": "Implement exponential backoff and retry logic",
|
|
53
|
+
"prevention": "Batch operations and add delays between requests"
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
"security_notes": [
|
|
57
|
+
"Always use HTTPS for all API communications",
|
|
58
|
+
"Store API tokens securely, never in source code",
|
|
59
|
+
"Rotate API tokens regularly following security policies"
|
|
60
|
+
],
|
|
61
|
+
"performance_tips": [
|
|
62
|
+
"Use pagination for large result sets",
|
|
63
|
+
"Batch related operations when possible",
|
|
64
|
+
"Cache read-only responses appropriately"
|
|
65
|
+
]
|
|
66
|
+
}
|
|
17
67
|
},
|
|
18
68
|
"servers": [
|
|
19
69
|
{
|
|
@@ -265,6 +315,13 @@
|
|
|
265
315
|
"latency": "moderate",
|
|
266
316
|
"resource_usage": "moderate"
|
|
267
317
|
}
|
|
318
|
+
},
|
|
319
|
+
"x-f5xc-discovered-response-time": {
|
|
320
|
+
"p50_ms": 200,
|
|
321
|
+
"p95_ms": 800,
|
|
322
|
+
"p99_ms": 2000,
|
|
323
|
+
"sample_count": 0,
|
|
324
|
+
"source": "estimate"
|
|
268
325
|
}
|
|
269
326
|
},
|
|
270
327
|
"x-displayname": "Invoice",
|
|
@@ -465,6 +522,13 @@
|
|
|
465
522
|
"latency": "moderate",
|
|
466
523
|
"resource_usage": "moderate"
|
|
467
524
|
}
|
|
525
|
+
},
|
|
526
|
+
"x-f5xc-discovered-response-time": {
|
|
527
|
+
"p50_ms": 200,
|
|
528
|
+
"p95_ms": 800,
|
|
529
|
+
"p99_ms": 2000,
|
|
530
|
+
"sample_count": 0,
|
|
531
|
+
"source": "estimate"
|
|
468
532
|
}
|
|
469
533
|
},
|
|
470
534
|
"x-displayname": "Invoice",
|
|
@@ -690,6 +754,13 @@
|
|
|
690
754
|
"latency": "low",
|
|
691
755
|
"resource_usage": "low"
|
|
692
756
|
}
|
|
757
|
+
},
|
|
758
|
+
"x-f5xc-discovered-response-time": {
|
|
759
|
+
"p50_ms": 1000,
|
|
760
|
+
"p95_ms": 3000,
|
|
761
|
+
"p99_ms": 8000,
|
|
762
|
+
"sample_count": 0,
|
|
763
|
+
"source": "estimate"
|
|
693
764
|
}
|
|
694
765
|
},
|
|
695
766
|
"x-displayname": "Payment Method.",
|
|
@@ -915,6 +986,13 @@
|
|
|
915
986
|
"latency": "low",
|
|
916
987
|
"resource_usage": "low"
|
|
917
988
|
}
|
|
989
|
+
},
|
|
990
|
+
"x-f5xc-discovered-response-time": {
|
|
991
|
+
"p50_ms": 1000,
|
|
992
|
+
"p95_ms": 3000,
|
|
993
|
+
"p99_ms": 8000,
|
|
994
|
+
"sample_count": 0,
|
|
995
|
+
"source": "estimate"
|
|
918
996
|
}
|
|
919
997
|
},
|
|
920
998
|
"x-displayname": "Payment Method.",
|
|
@@ -1140,6 +1218,13 @@
|
|
|
1140
1218
|
"latency": "low",
|
|
1141
1219
|
"resource_usage": "low"
|
|
1142
1220
|
}
|
|
1221
|
+
},
|
|
1222
|
+
"x-f5xc-discovered-response-time": {
|
|
1223
|
+
"p50_ms": 1000,
|
|
1224
|
+
"p95_ms": 3000,
|
|
1225
|
+
"p99_ms": 8000,
|
|
1226
|
+
"sample_count": 0,
|
|
1227
|
+
"source": "estimate"
|
|
1143
1228
|
}
|
|
1144
1229
|
},
|
|
1145
1230
|
"x-displayname": "Payment Method.",
|
|
@@ -1354,6 +1439,13 @@
|
|
|
1354
1439
|
"latency": "low",
|
|
1355
1440
|
"resource_usage": "low"
|
|
1356
1441
|
}
|
|
1442
|
+
},
|
|
1443
|
+
"x-f5xc-discovered-response-time": {
|
|
1444
|
+
"p50_ms": 1000,
|
|
1445
|
+
"p95_ms": 3000,
|
|
1446
|
+
"p99_ms": 8000,
|
|
1447
|
+
"sample_count": 0,
|
|
1448
|
+
"source": "estimate"
|
|
1357
1449
|
}
|
|
1358
1450
|
},
|
|
1359
1451
|
"x-displayname": "Payment Method.",
|
|
@@ -1568,6 +1660,13 @@
|
|
|
1568
1660
|
"latency": "high",
|
|
1569
1661
|
"resource_usage": "moderate"
|
|
1570
1662
|
}
|
|
1663
|
+
},
|
|
1664
|
+
"x-f5xc-discovered-response-time": {
|
|
1665
|
+
"p50_ms": 500,
|
|
1666
|
+
"p95_ms": 1500,
|
|
1667
|
+
"p99_ms": 4000,
|
|
1668
|
+
"sample_count": 0,
|
|
1669
|
+
"source": "estimate"
|
|
1571
1670
|
}
|
|
1572
1671
|
},
|
|
1573
1672
|
"x-displayname": "Payment Method.",
|
|
@@ -1751,6 +1850,13 @@
|
|
|
1751
1850
|
"latency": "moderate",
|
|
1752
1851
|
"resource_usage": "moderate"
|
|
1753
1852
|
}
|
|
1853
|
+
},
|
|
1854
|
+
"x-f5xc-discovered-response-time": {
|
|
1855
|
+
"p50_ms": 200,
|
|
1856
|
+
"p95_ms": 800,
|
|
1857
|
+
"p99_ms": 2000,
|
|
1858
|
+
"sample_count": 0,
|
|
1859
|
+
"source": "estimate"
|
|
1754
1860
|
}
|
|
1755
1861
|
},
|
|
1756
1862
|
"x-displayname": "Plan transition CustomAPI.",
|
|
@@ -1965,6 +2071,13 @@
|
|
|
1965
2071
|
"latency": "low",
|
|
1966
2072
|
"resource_usage": "low"
|
|
1967
2073
|
}
|
|
2074
|
+
},
|
|
2075
|
+
"x-f5xc-discovered-response-time": {
|
|
2076
|
+
"p50_ms": 1000,
|
|
2077
|
+
"p95_ms": 3000,
|
|
2078
|
+
"p99_ms": 8000,
|
|
2079
|
+
"sample_count": 0,
|
|
2080
|
+
"source": "estimate"
|
|
1968
2081
|
}
|
|
1969
2082
|
},
|
|
1970
2083
|
"x-displayname": "Plan transition CustomAPI.",
|
|
@@ -2179,6 +2292,13 @@
|
|
|
2179
2292
|
"latency": "low",
|
|
2180
2293
|
"resource_usage": "low"
|
|
2181
2294
|
}
|
|
2295
|
+
},
|
|
2296
|
+
"x-f5xc-discovered-response-time": {
|
|
2297
|
+
"p50_ms": 1000,
|
|
2298
|
+
"p95_ms": 3000,
|
|
2299
|
+
"p99_ms": 8000,
|
|
2300
|
+
"sample_count": 0,
|
|
2301
|
+
"source": "estimate"
|
|
2182
2302
|
}
|
|
2183
2303
|
},
|
|
2184
2304
|
"x-displayname": "Quota",
|
|
@@ -2401,6 +2521,13 @@
|
|
|
2401
2521
|
"latency": "low",
|
|
2402
2522
|
"resource_usage": "low"
|
|
2403
2523
|
}
|
|
2524
|
+
},
|
|
2525
|
+
"x-f5xc-discovered-response-time": {
|
|
2526
|
+
"p50_ms": 800,
|
|
2527
|
+
"p95_ms": 2500,
|
|
2528
|
+
"p99_ms": 6000,
|
|
2529
|
+
"sample_count": 0,
|
|
2530
|
+
"source": "estimate"
|
|
2404
2531
|
}
|
|
2405
2532
|
},
|
|
2406
2533
|
"x-displayname": "Quota",
|
|
@@ -2589,6 +2716,13 @@
|
|
|
2589
2716
|
"latency": "moderate",
|
|
2590
2717
|
"resource_usage": "moderate"
|
|
2591
2718
|
}
|
|
2719
|
+
},
|
|
2720
|
+
"x-f5xc-discovered-response-time": {
|
|
2721
|
+
"p50_ms": 200,
|
|
2722
|
+
"p95_ms": 800,
|
|
2723
|
+
"p99_ms": 2000,
|
|
2724
|
+
"sample_count": 0,
|
|
2725
|
+
"source": "estimate"
|
|
2592
2726
|
}
|
|
2593
2727
|
},
|
|
2594
2728
|
"x-displayname": "Quota",
|
|
@@ -2777,6 +2911,13 @@
|
|
|
2777
2911
|
"latency": "moderate",
|
|
2778
2912
|
"resource_usage": "moderate"
|
|
2779
2913
|
}
|
|
2914
|
+
},
|
|
2915
|
+
"x-f5xc-discovered-response-time": {
|
|
2916
|
+
"p50_ms": 200,
|
|
2917
|
+
"p95_ms": 800,
|
|
2918
|
+
"p99_ms": 2000,
|
|
2919
|
+
"sample_count": 0,
|
|
2920
|
+
"source": "estimate"
|
|
2780
2921
|
}
|
|
2781
2922
|
},
|
|
2782
2923
|
"x-displayname": "Quota",
|
|
@@ -3004,6 +3145,13 @@
|
|
|
3004
3145
|
"latency": "moderate",
|
|
3005
3146
|
"resource_usage": "moderate"
|
|
3006
3147
|
}
|
|
3148
|
+
},
|
|
3149
|
+
"x-f5xc-discovered-response-time": {
|
|
3150
|
+
"p50_ms": 200,
|
|
3151
|
+
"p95_ms": 800,
|
|
3152
|
+
"p99_ms": 2000,
|
|
3153
|
+
"sample_count": 0,
|
|
3154
|
+
"source": "estimate"
|
|
3007
3155
|
}
|
|
3008
3156
|
},
|
|
3009
3157
|
"x-displayname": "Quota",
|
|
@@ -3225,6 +3373,13 @@
|
|
|
3225
3373
|
"latency": "low",
|
|
3226
3374
|
"resource_usage": "low"
|
|
3227
3375
|
}
|
|
3376
|
+
},
|
|
3377
|
+
"x-f5xc-discovered-response-time": {
|
|
3378
|
+
"p50_ms": 200,
|
|
3379
|
+
"p95_ms": 800,
|
|
3380
|
+
"p99_ms": 2000,
|
|
3381
|
+
"sample_count": 0,
|
|
3382
|
+
"source": "estimate"
|
|
3228
3383
|
}
|
|
3229
3384
|
},
|
|
3230
3385
|
"delete": {
|
|
@@ -3444,6 +3599,13 @@
|
|
|
3444
3599
|
"latency": "high",
|
|
3445
3600
|
"resource_usage": "moderate"
|
|
3446
3601
|
}
|
|
3602
|
+
},
|
|
3603
|
+
"x-f5xc-discovered-response-time": {
|
|
3604
|
+
"p50_ms": 500,
|
|
3605
|
+
"p95_ms": 1500,
|
|
3606
|
+
"p99_ms": 4000,
|
|
3607
|
+
"sample_count": 0,
|
|
3608
|
+
"source": "estimate"
|
|
3447
3609
|
}
|
|
3448
3610
|
},
|
|
3449
3611
|
"x-displayname": "Quota",
|
|
@@ -3643,6 +3805,13 @@
|
|
|
3643
3805
|
"latency": "moderate",
|
|
3644
3806
|
"resource_usage": "moderate"
|
|
3645
3807
|
}
|
|
3808
|
+
},
|
|
3809
|
+
"x-f5xc-discovered-response-time": {
|
|
3810
|
+
"p50_ms": 200,
|
|
3811
|
+
"p95_ms": 800,
|
|
3812
|
+
"p99_ms": 2000,
|
|
3813
|
+
"sample_count": 0,
|
|
3814
|
+
"source": "estimate"
|
|
3646
3815
|
}
|
|
3647
3816
|
},
|
|
3648
3817
|
"x-displayname": "Subscription.",
|
|
@@ -3842,6 +4011,13 @@
|
|
|
3842
4011
|
"latency": "low",
|
|
3843
4012
|
"resource_usage": "low"
|
|
3844
4013
|
}
|
|
4014
|
+
},
|
|
4015
|
+
"x-f5xc-discovered-response-time": {
|
|
4016
|
+
"p50_ms": 1000,
|
|
4017
|
+
"p95_ms": 3000,
|
|
4018
|
+
"p99_ms": 8000,
|
|
4019
|
+
"sample_count": 0,
|
|
4020
|
+
"source": "estimate"
|
|
3845
4021
|
}
|
|
3846
4022
|
},
|
|
3847
4023
|
"x-displayname": "Subscription API.",
|
|
@@ -4041,6 +4217,13 @@
|
|
|
4041
4217
|
"latency": "low",
|
|
4042
4218
|
"resource_usage": "low"
|
|
4043
4219
|
}
|
|
4220
|
+
},
|
|
4221
|
+
"x-f5xc-discovered-response-time": {
|
|
4222
|
+
"p50_ms": 1000,
|
|
4223
|
+
"p95_ms": 3000,
|
|
4224
|
+
"p99_ms": 8000,
|
|
4225
|
+
"sample_count": 0,
|
|
4226
|
+
"source": "estimate"
|
|
4044
4227
|
}
|
|
4045
4228
|
},
|
|
4046
4229
|
"x-displayname": "Subscription API.",
|
|
@@ -4255,6 +4438,13 @@
|
|
|
4255
4438
|
"latency": "low",
|
|
4256
4439
|
"resource_usage": "low"
|
|
4257
4440
|
}
|
|
4441
|
+
},
|
|
4442
|
+
"x-f5xc-discovered-response-time": {
|
|
4443
|
+
"p50_ms": 1000,
|
|
4444
|
+
"p95_ms": 3000,
|
|
4445
|
+
"p99_ms": 8000,
|
|
4446
|
+
"sample_count": 0,
|
|
4447
|
+
"source": "estimate"
|
|
4258
4448
|
}
|
|
4259
4449
|
},
|
|
4260
4450
|
"x-displayname": "Usage",
|
|
@@ -4469,6 +4659,13 @@
|
|
|
4469
4659
|
"latency": "low",
|
|
4470
4660
|
"resource_usage": "low"
|
|
4471
4661
|
}
|
|
4662
|
+
},
|
|
4663
|
+
"x-f5xc-discovered-response-time": {
|
|
4664
|
+
"p50_ms": 1000,
|
|
4665
|
+
"p95_ms": 3000,
|
|
4666
|
+
"p99_ms": 8000,
|
|
4667
|
+
"sample_count": 0,
|
|
4668
|
+
"source": "estimate"
|
|
4472
4669
|
}
|
|
4473
4670
|
},
|
|
4474
4671
|
"x-displayname": "Usage",
|
|
@@ -4683,6 +4880,13 @@
|
|
|
4683
4880
|
"latency": "low",
|
|
4684
4881
|
"resource_usage": "low"
|
|
4685
4882
|
}
|
|
4883
|
+
},
|
|
4884
|
+
"x-f5xc-discovered-response-time": {
|
|
4885
|
+
"p50_ms": 1000,
|
|
4886
|
+
"p95_ms": 3000,
|
|
4887
|
+
"p99_ms": 8000,
|
|
4888
|
+
"sample_count": 0,
|
|
4889
|
+
"source": "estimate"
|
|
4686
4890
|
}
|
|
4687
4891
|
},
|
|
4688
4892
|
"x-displayname": "Usage",
|
|
@@ -4897,6 +5101,13 @@
|
|
|
4897
5101
|
"latency": "low",
|
|
4898
5102
|
"resource_usage": "low"
|
|
4899
5103
|
}
|
|
5104
|
+
},
|
|
5105
|
+
"x-f5xc-discovered-response-time": {
|
|
5106
|
+
"p50_ms": 1000,
|
|
5107
|
+
"p95_ms": 3000,
|
|
5108
|
+
"p99_ms": 8000,
|
|
5109
|
+
"sample_count": 0,
|
|
5110
|
+
"source": "estimate"
|
|
4900
5111
|
}
|
|
4901
5112
|
},
|
|
4902
5113
|
"x-displayname": "Usage",
|
|
@@ -5067,6 +5278,13 @@
|
|
|
5067
5278
|
"latency": "moderate",
|
|
5068
5279
|
"resource_usage": "moderate"
|
|
5069
5280
|
}
|
|
5281
|
+
},
|
|
5282
|
+
"x-f5xc-discovered-response-time": {
|
|
5283
|
+
"p50_ms": 200,
|
|
5284
|
+
"p95_ms": 800,
|
|
5285
|
+
"p99_ms": 2000,
|
|
5286
|
+
"sample_count": 0,
|
|
5287
|
+
"source": "estimate"
|
|
5070
5288
|
}
|
|
5071
5289
|
},
|
|
5072
5290
|
"x-displayname": "Usage plan.",
|
|
@@ -5237,6 +5455,13 @@
|
|
|
5237
5455
|
"latency": "moderate",
|
|
5238
5456
|
"resource_usage": "moderate"
|
|
5239
5457
|
}
|
|
5458
|
+
},
|
|
5459
|
+
"x-f5xc-discovered-response-time": {
|
|
5460
|
+
"p50_ms": 200,
|
|
5461
|
+
"p95_ms": 800,
|
|
5462
|
+
"p99_ms": 2000,
|
|
5463
|
+
"sample_count": 0,
|
|
5464
|
+
"source": "estimate"
|
|
5240
5465
|
}
|
|
5241
5466
|
},
|
|
5242
5467
|
"x-displayname": "Usage plan.",
|
|
@@ -5267,6 +5492,7 @@
|
|
|
5267
5492
|
"title": "PDF",
|
|
5268
5493
|
"format": "byte",
|
|
5269
5494
|
"x-displayname": "PDF",
|
|
5495
|
+
"x-f5xc-description-short": "Base 64 encoded invoice as a PDF document.",
|
|
5270
5496
|
"minLength": 0,
|
|
5271
5497
|
"maxLength": 1024,
|
|
5272
5498
|
"x-f5xc-required-for": {
|
|
@@ -5305,6 +5531,8 @@
|
|
|
5305
5531
|
"default": "STATUS_UNKNOWN",
|
|
5306
5532
|
"x-displayname": "Invoice status.",
|
|
5307
5533
|
"x-ves-proto-enum": "ves.io.schema.usage.invoice.InvoiceStatus",
|
|
5534
|
+
"x-f5xc-description-short": "Invoice status Unknown, undefined status Invoice is just issued Invoice is pending, also known as running invoice Invoice is paid Invoice is...",
|
|
5535
|
+
"x-f5xc-description-medium": "Invoice status Unknown, undefined status Invoice is just issued Invoice is pending, also known as running invoice Invoice is paid Invoice is refunded Cancelled invoice (before being due) Set when current date is past due date, clears when the invoice gets paid.",
|
|
5308
5536
|
"x-f5xc-minimum-configuration": {
|
|
5309
5537
|
"description": "Minimum configuration for invoiceInvoiceStatus",
|
|
5310
5538
|
"required_fields": [],
|
|
@@ -5328,6 +5556,9 @@
|
|
|
5328
5556
|
"title": "Invoice active flag.",
|
|
5329
5557
|
"format": "boolean",
|
|
5330
5558
|
"x-displayname": "Active",
|
|
5559
|
+
"x-f5xc-example": "True",
|
|
5560
|
+
"x-f5xc-description-short": "Indicate whether an invoice is active or not. Active invoices are not finalised and their value can change.",
|
|
5561
|
+
"x-f5xc-description-medium": "Indicate whether an invoice is active or not. Active invoices are not finalised and their value can change. Inactive invoices are final and their value cannot change.",
|
|
5331
5562
|
"x-f5xc-required-for": {
|
|
5332
5563
|
"minimum_config": false,
|
|
5333
5564
|
"create": false,
|
|
@@ -5385,7 +5616,7 @@
|
|
|
5385
5616
|
},
|
|
5386
5617
|
"x-original-maxLength": 1024,
|
|
5387
5618
|
"x-reconciled-from-discovery": true,
|
|
5388
|
-
"x-reconciled-at": "2026-01-
|
|
5619
|
+
"x-reconciled-at": "2026-01-07T15:28:50.301113+00:00"
|
|
5389
5620
|
},
|
|
5390
5621
|
"period_end": {
|
|
5391
5622
|
"type": "string",
|
|
@@ -5458,6 +5689,7 @@
|
|
|
5458
5689
|
"$ref": "#/components/schemas/invoiceInvoiceType"
|
|
5459
5690
|
},
|
|
5460
5691
|
"x-displayname": "Invoices",
|
|
5692
|
+
"x-f5xc-description-short": "List of invoices as per customer request.",
|
|
5461
5693
|
"x-f5xc-required-for": {
|
|
5462
5694
|
"minimum_config": false,
|
|
5463
5695
|
"create": false,
|
|
@@ -5490,6 +5722,8 @@
|
|
|
5490
5722
|
"default": "MAILING",
|
|
5491
5723
|
"x-displayname": "Contact Type.",
|
|
5492
5724
|
"x-ves-proto-enum": "ves.io.schema.contact.ContactType",
|
|
5725
|
+
"x-f5xc-description-short": "Determines the contact type Indicates snail mail address (used for correspondence) Indicates billing address (this address will appear on...",
|
|
5726
|
+
"x-f5xc-description-medium": "Determines the contact type Indicates snail mail address (used for correspondence) Indicates billing address (this address will appear on invoices) Indicates contact used for a payment method (this address is used when charging a payment method).",
|
|
5493
5727
|
"x-f5xc-minimum-configuration": {
|
|
5494
5728
|
"description": "Minimum configuration for contactContactType",
|
|
5495
5729
|
"required_fields": [],
|
|
@@ -5509,7 +5743,7 @@
|
|
|
5509
5743
|
"properties": {
|
|
5510
5744
|
"address1": {
|
|
5511
5745
|
"type": "string",
|
|
5512
|
-
"description": "",
|
|
5746
|
+
"description": "Network address or location",
|
|
5513
5747
|
"title": "Address1",
|
|
5514
5748
|
"x-displayname": "Address Line 1.",
|
|
5515
5749
|
"x-ves-example": "1234 Main road.",
|
|
@@ -5525,7 +5759,7 @@
|
|
|
5525
5759
|
},
|
|
5526
5760
|
"address2": {
|
|
5527
5761
|
"type": "string",
|
|
5528
|
-
"description": "",
|
|
5762
|
+
"description": "Network address or location",
|
|
5529
5763
|
"title": "Address2",
|
|
5530
5764
|
"x-displayname": "Address Line 2.",
|
|
5531
5765
|
"x-ves-example": "P.O BOX 56.",
|
|
@@ -5541,7 +5775,7 @@
|
|
|
5541
5775
|
},
|
|
5542
5776
|
"city": {
|
|
5543
5777
|
"type": "string",
|
|
5544
|
-
"description": "",
|
|
5778
|
+
"description": "Configuration parameter for city",
|
|
5545
5779
|
"title": "City",
|
|
5546
5780
|
"x-displayname": "City",
|
|
5547
5781
|
"x-ves-example": "Sunnyvale",
|
|
@@ -5560,7 +5794,7 @@
|
|
|
5560
5794
|
},
|
|
5561
5795
|
"country": {
|
|
5562
5796
|
"type": "string",
|
|
5563
|
-
"description": "",
|
|
5797
|
+
"description": "Configuration parameter for country",
|
|
5564
5798
|
"title": "Country",
|
|
5565
5799
|
"x-displayname": "Country",
|
|
5566
5800
|
"x-ves-example": "US",
|
|
@@ -5576,7 +5810,7 @@
|
|
|
5576
5810
|
},
|
|
5577
5811
|
"county": {
|
|
5578
5812
|
"type": "string",
|
|
5579
|
-
"description": "",
|
|
5813
|
+
"description": "Configuration parameter for county",
|
|
5580
5814
|
"title": "County",
|
|
5581
5815
|
"x-displayname": "County",
|
|
5582
5816
|
"x-ves-example": "Santa Clara.",
|
|
@@ -5592,11 +5826,12 @@
|
|
|
5592
5826
|
},
|
|
5593
5827
|
"phone_number": {
|
|
5594
5828
|
"type": "string",
|
|
5595
|
-
"description": "",
|
|
5829
|
+
"description": "Configuration parameter for phone number",
|
|
5596
5830
|
"title": "Phone_number.",
|
|
5597
5831
|
"x-displayname": "Phone Number.",
|
|
5598
5832
|
"x-ves-example": "+11234567890.",
|
|
5599
5833
|
"x-f5xc-example": "+11234567890",
|
|
5834
|
+
"x-f5xc-description-short": "Configuration parameter for phone number.",
|
|
5600
5835
|
"minLength": 0,
|
|
5601
5836
|
"maxLength": 1024,
|
|
5602
5837
|
"x-f5xc-required-for": {
|
|
@@ -5608,7 +5843,7 @@
|
|
|
5608
5843
|
},
|
|
5609
5844
|
"state": {
|
|
5610
5845
|
"type": "string",
|
|
5611
|
-
"description": "",
|
|
5846
|
+
"description": "Current state of the resource",
|
|
5612
5847
|
"title": "State",
|
|
5613
5848
|
"x-displayname": "State",
|
|
5614
5849
|
"x-ves-example": "California.",
|
|
@@ -5624,7 +5859,7 @@
|
|
|
5624
5859
|
},
|
|
5625
5860
|
"state_code": {
|
|
5626
5861
|
"type": "string",
|
|
5627
|
-
"description": "",
|
|
5862
|
+
"description": "Configuration parameter for state code",
|
|
5628
5863
|
"title": "State code.",
|
|
5629
5864
|
"x-displayname": "State Code.",
|
|
5630
5865
|
"x-ves-example": "CA",
|
|
@@ -5640,7 +5875,7 @@
|
|
|
5640
5875
|
},
|
|
5641
5876
|
"zip_code": {
|
|
5642
5877
|
"type": "string",
|
|
5643
|
-
"description": "",
|
|
5878
|
+
"description": "IP address configuration",
|
|
5644
5879
|
"title": "Zip_code",
|
|
5645
5880
|
"x-displayname": "ZIP code",
|
|
5646
5881
|
"x-ves-example": "95054",
|
|
@@ -5655,6 +5890,8 @@
|
|
|
5655
5890
|
}
|
|
5656
5891
|
}
|
|
5657
5892
|
},
|
|
5893
|
+
"x-f5xc-description-short": "Instance of one single contact that can be used to communicate with customers.",
|
|
5894
|
+
"x-f5xc-description-medium": "Instance of one single contact that can be used to communicate with customers. Depending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
|
|
5658
5895
|
"x-f5xc-minimum-configuration": {
|
|
5659
5896
|
"description": "Minimum configuration for contactGlobalSpecType",
|
|
5660
5897
|
"required_fields": [
|
|
@@ -5693,6 +5930,8 @@
|
|
|
5693
5930
|
"x-displayname": "Namespace",
|
|
5694
5931
|
"x-ves-example": "System",
|
|
5695
5932
|
"x-f5xc-example": "system",
|
|
5933
|
+
"x-f5xc-description-short": "Namespace specifies the namespace in which the payment method will be created. If not provided, the default 'system' namespace will be used.",
|
|
5934
|
+
"x-f5xc-description-medium": "Namespace specifies the namespace in which the payment method will be created. If not provided, the default 'system' namespace will be used.",
|
|
5696
5935
|
"minLength": 0,
|
|
5697
5936
|
"maxLength": 6,
|
|
5698
5937
|
"x-f5xc-required-for": {
|
|
@@ -5703,7 +5942,7 @@
|
|
|
5703
5942
|
},
|
|
5704
5943
|
"x-original-maxLength": 1024,
|
|
5705
5944
|
"x-reconciled-from-discovery": true,
|
|
5706
|
-
"x-reconciled-at": "2026-01-
|
|
5945
|
+
"x-reconciled-at": "2026-01-07T15:29:05.997582+00:00"
|
|
5707
5946
|
},
|
|
5708
5947
|
"role": {
|
|
5709
5948
|
"$ref": "#/components/schemas/payment_methodPaymentMethodRole"
|
|
@@ -5715,6 +5954,8 @@
|
|
|
5715
5954
|
"x-displayname": "Token",
|
|
5716
5955
|
"x-ves-example": "Tok-123456.",
|
|
5717
5956
|
"x-f5xc-example": "tok-123456",
|
|
5957
|
+
"x-f5xc-description-short": "Token associated with this payment method. This token needs to be obtained from a designated payment method provider e.g.",
|
|
5958
|
+
"x-f5xc-description-medium": "Token associated with this payment method. This token needs to be obtained from a designated payment method provider e.g. Stripe.",
|
|
5718
5959
|
"minLength": 0,
|
|
5719
5960
|
"maxLength": 1024,
|
|
5720
5961
|
"x-f5xc-required-for": {
|
|
@@ -5751,6 +5992,7 @@
|
|
|
5751
5992
|
"x-displayname": "Name",
|
|
5752
5993
|
"x-ves-example": "Payment-method-1.",
|
|
5753
5994
|
"x-f5xc-example": "payment-method-1",
|
|
5995
|
+
"x-f5xc-description-short": "Name of the newly created payment method object.",
|
|
5754
5996
|
"minLength": 0,
|
|
5755
5997
|
"maxLength": 16,
|
|
5756
5998
|
"x-f5xc-required-for": {
|
|
@@ -5761,7 +6003,7 @@
|
|
|
5761
6003
|
},
|
|
5762
6004
|
"x-original-maxLength": 1024,
|
|
5763
6005
|
"x-reconciled-from-discovery": true,
|
|
5764
|
-
"x-reconciled-at": "2026-01-
|
|
6006
|
+
"x-reconciled-at": "2026-01-07T15:29:05.997592+00:00"
|
|
5765
6007
|
}
|
|
5766
6008
|
},
|
|
5767
6009
|
"x-f5xc-minimum-configuration": {
|
|
@@ -5790,6 +6032,7 @@
|
|
|
5790
6032
|
"x-displayname": "Name",
|
|
5791
6033
|
"x-ves-example": "Payment-method-1.",
|
|
5792
6034
|
"x-f5xc-example": "payment-method-1",
|
|
6035
|
+
"x-f5xc-description-short": "The name of the payment method object to be made primary.",
|
|
5793
6036
|
"minLength": 0,
|
|
5794
6037
|
"maxLength": 16,
|
|
5795
6038
|
"x-f5xc-required-for": {
|
|
@@ -5800,7 +6043,7 @@
|
|
|
5800
6043
|
},
|
|
5801
6044
|
"x-original-maxLength": 1024,
|
|
5802
6045
|
"x-reconciled-from-discovery": true,
|
|
5803
|
-
"x-reconciled-at": "2026-01-
|
|
6046
|
+
"x-reconciled-at": "2026-01-07T15:29:05.997598+00:00"
|
|
5804
6047
|
},
|
|
5805
6048
|
"namespace": {
|
|
5806
6049
|
"type": "string",
|
|
@@ -5809,6 +6052,7 @@
|
|
|
5809
6052
|
"x-displayname": "Namespace",
|
|
5810
6053
|
"x-ves-example": "System",
|
|
5811
6054
|
"x-f5xc-example": "system",
|
|
6055
|
+
"x-f5xc-description-short": "The namespace in which the payment method object is present.",
|
|
5812
6056
|
"minLength": 0,
|
|
5813
6057
|
"maxLength": 6,
|
|
5814
6058
|
"x-f5xc-required-for": {
|
|
@@ -5819,9 +6063,10 @@
|
|
|
5819
6063
|
},
|
|
5820
6064
|
"x-original-maxLength": 1024,
|
|
5821
6065
|
"x-reconciled-from-discovery": true,
|
|
5822
|
-
"x-reconciled-at": "2026-01-
|
|
6066
|
+
"x-reconciled-at": "2026-01-07T15:29:05.997602+00:00"
|
|
5823
6067
|
}
|
|
5824
6068
|
},
|
|
6069
|
+
"x-f5xc-description-short": "Changes a payment method role to primary.",
|
|
5825
6070
|
"x-f5xc-minimum-configuration": {
|
|
5826
6071
|
"description": "Minimum configuration for payment_methodPaymentMethodPrimaryReq",
|
|
5827
6072
|
"required_fields": [
|
|
@@ -5848,6 +6093,8 @@
|
|
|
5848
6093
|
"default": "PAYMENT_METHOD_ROLE_UNKNOWN",
|
|
5849
6094
|
"x-displayname": "Payment method role.",
|
|
5850
6095
|
"x-ves-proto-enum": "ves.io.schema.billing.payment_method.PaymentMethodRole",
|
|
6096
|
+
"x-f5xc-description-short": "Defines if a payment method is used as a primary or backup source of fund. Unknown payment method role Primary payment method role.",
|
|
6097
|
+
"x-f5xc-description-medium": "Defines if a payment method is used as a primary or backup source of fund. Unknown payment method role Primary payment method role. Always used when attempting to charge for F5 Distributed Cloud's services.",
|
|
5851
6098
|
"x-f5xc-minimum-configuration": {
|
|
5852
6099
|
"description": "Minimum configuration for payment_methodPaymentMethodRole",
|
|
5853
6100
|
"required_fields": [],
|
|
@@ -5872,6 +6119,7 @@
|
|
|
5872
6119
|
"x-displayname": "Name",
|
|
5873
6120
|
"x-ves-example": "Payment-method-1.",
|
|
5874
6121
|
"x-f5xc-example": "payment-method-1",
|
|
6122
|
+
"x-f5xc-description-short": "The name of the payment method object to be updated.",
|
|
5875
6123
|
"minLength": 0,
|
|
5876
6124
|
"maxLength": 16,
|
|
5877
6125
|
"x-f5xc-required-for": {
|
|
@@ -5882,7 +6130,7 @@
|
|
|
5882
6130
|
},
|
|
5883
6131
|
"x-original-maxLength": 1024,
|
|
5884
6132
|
"x-reconciled-from-discovery": true,
|
|
5885
|
-
"x-reconciled-at": "2026-01-
|
|
6133
|
+
"x-reconciled-at": "2026-01-07T15:29:05.997607+00:00"
|
|
5886
6134
|
},
|
|
5887
6135
|
"namespace": {
|
|
5888
6136
|
"type": "string",
|
|
@@ -5891,6 +6139,7 @@
|
|
|
5891
6139
|
"x-displayname": "Namespace",
|
|
5892
6140
|
"x-ves-example": "System",
|
|
5893
6141
|
"x-f5xc-example": "system",
|
|
6142
|
+
"x-f5xc-description-short": "The namespace in which the payment method object is present.",
|
|
5894
6143
|
"minLength": 0,
|
|
5895
6144
|
"maxLength": 6,
|
|
5896
6145
|
"x-f5xc-required-for": {
|
|
@@ -5901,9 +6150,10 @@
|
|
|
5901
6150
|
},
|
|
5902
6151
|
"x-original-maxLength": 1024,
|
|
5903
6152
|
"x-reconciled-from-discovery": true,
|
|
5904
|
-
"x-reconciled-at": "2026-01-
|
|
6153
|
+
"x-reconciled-at": "2026-01-07T15:29:05.997611+00:00"
|
|
5905
6154
|
}
|
|
5906
6155
|
},
|
|
6156
|
+
"x-f5xc-description-short": "Changes a payment method role (from/to primary or backup).",
|
|
5907
6157
|
"x-f5xc-minimum-configuration": {
|
|
5908
6158
|
"description": "Minimum configuration for payment_methodPaymentMethodRoleSwapReq",
|
|
5909
6159
|
"required_fields": [
|
|
@@ -5931,6 +6181,7 @@
|
|
|
5931
6181
|
"x-displayname": "Name",
|
|
5932
6182
|
"x-ves-example": "Payment-method-1.",
|
|
5933
6183
|
"x-f5xc-example": "payment-method-1",
|
|
6184
|
+
"x-f5xc-description-short": "The name of the payment method object to be made secondary.",
|
|
5934
6185
|
"minLength": 0,
|
|
5935
6186
|
"maxLength": 16,
|
|
5936
6187
|
"x-f5xc-required-for": {
|
|
@@ -5941,7 +6192,7 @@
|
|
|
5941
6192
|
},
|
|
5942
6193
|
"x-original-maxLength": 1024,
|
|
5943
6194
|
"x-reconciled-from-discovery": true,
|
|
5944
|
-
"x-reconciled-at": "2026-01-
|
|
6195
|
+
"x-reconciled-at": "2026-01-07T15:29:05.997615+00:00"
|
|
5945
6196
|
},
|
|
5946
6197
|
"namespace": {
|
|
5947
6198
|
"type": "string",
|
|
@@ -5950,6 +6201,7 @@
|
|
|
5950
6201
|
"x-displayname": "Namespace",
|
|
5951
6202
|
"x-ves-example": "System",
|
|
5952
6203
|
"x-f5xc-example": "system",
|
|
6204
|
+
"x-f5xc-description-short": "The namespace in which the payment method object is present.",
|
|
5953
6205
|
"minLength": 0,
|
|
5954
6206
|
"maxLength": 6,
|
|
5955
6207
|
"x-f5xc-required-for": {
|
|
@@ -5960,9 +6212,10 @@
|
|
|
5960
6212
|
},
|
|
5961
6213
|
"x-original-maxLength": 1024,
|
|
5962
6214
|
"x-reconciled-from-discovery": true,
|
|
5963
|
-
"x-reconciled-at": "2026-01-
|
|
6215
|
+
"x-reconciled-at": "2026-01-07T15:29:05.997619+00:00"
|
|
5964
6216
|
}
|
|
5965
6217
|
},
|
|
6218
|
+
"x-f5xc-description-short": "Changes a payment method role to secondary.",
|
|
5966
6219
|
"x-f5xc-minimum-configuration": {
|
|
5967
6220
|
"description": "Minimum configuration for payment_methodPaymentMethodSecondaryReq",
|
|
5968
6221
|
"required_fields": [
|
|
@@ -5987,6 +6240,7 @@
|
|
|
5987
6240
|
"$ref": "#/components/schemas/plan_transitionState"
|
|
5988
6241
|
}
|
|
5989
6242
|
},
|
|
6243
|
+
"x-f5xc-description-short": "Request body of GetPlanTransition custom API.",
|
|
5990
6244
|
"x-f5xc-minimum-configuration": {
|
|
5991
6245
|
"description": "Minimum configuration for plan_transitionGetPlanTransitionRsp",
|
|
5992
6246
|
"required_fields": [
|
|
@@ -6013,6 +6267,7 @@
|
|
|
6013
6267
|
"x-displayname": "Namespace",
|
|
6014
6268
|
"x-ves-example": "System",
|
|
6015
6269
|
"x-f5xc-example": "system",
|
|
6270
|
+
"x-f5xc-description-short": "Namespace is not used, all requests are stored under system namespace.",
|
|
6016
6271
|
"minLength": 0,
|
|
6017
6272
|
"maxLength": 6,
|
|
6018
6273
|
"x-f5xc-required-for": {
|
|
@@ -6023,7 +6278,7 @@
|
|
|
6023
6278
|
},
|
|
6024
6279
|
"x-original-maxLength": 1024,
|
|
6025
6280
|
"x-reconciled-from-discovery": true,
|
|
6026
|
-
"x-reconciled-at": "2026-01-
|
|
6281
|
+
"x-reconciled-at": "2026-01-07T15:29:06.880189+00:00"
|
|
6027
6282
|
},
|
|
6028
6283
|
"new_plan": {
|
|
6029
6284
|
"type": "string",
|
|
@@ -6032,6 +6287,7 @@
|
|
|
6032
6287
|
"x-displayname": "New Plan",
|
|
6033
6288
|
"x-ves-example": "Plan-1",
|
|
6034
6289
|
"x-f5xc-example": "plan-1",
|
|
6290
|
+
"x-f5xc-description-short": "New plan template name tenant want to move to.",
|
|
6035
6291
|
"minLength": 0,
|
|
6036
6292
|
"maxLength": 1024,
|
|
6037
6293
|
"x-f5xc-required-for": {
|
|
@@ -6045,6 +6301,7 @@
|
|
|
6045
6301
|
"$ref": "#/components/schemas/plan_transitionTransitionPayload"
|
|
6046
6302
|
}
|
|
6047
6303
|
},
|
|
6304
|
+
"x-f5xc-description-short": "Request body of InitiatePlanTransition custom API.",
|
|
6048
6305
|
"x-f5xc-minimum-configuration": {
|
|
6049
6306
|
"description": "Minimum configuration for plan_transitionInitiatePlanTransitionReq",
|
|
6050
6307
|
"required_fields": [
|
|
@@ -6073,6 +6330,7 @@
|
|
|
6073
6330
|
"x-displayname": "ID",
|
|
6074
6331
|
"x-ves-example": "Dec2417d-adb1-4fcc-8dcd-529b1d31a652.",
|
|
6075
6332
|
"x-f5xc-example": "dec2417d-adb1-4fcc-8dcd-529b1d31a652",
|
|
6333
|
+
"x-f5xc-description-short": "ID of the newly created plan transition request.",
|
|
6076
6334
|
"minimum": 1,
|
|
6077
6335
|
"maximum": 4094,
|
|
6078
6336
|
"minLength": 0,
|
|
@@ -6090,6 +6348,8 @@
|
|
|
6090
6348
|
"title": "Requires_manual_approval.",
|
|
6091
6349
|
"format": "boolean",
|
|
6092
6350
|
"x-displayname": "Requires_manual_approval.",
|
|
6351
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6352
|
+
"x-f5xc-description-short": "Flag to specify whether the request requires manual approval.",
|
|
6093
6353
|
"x-f5xc-required-for": {
|
|
6094
6354
|
"minimum_config": false,
|
|
6095
6355
|
"create": false,
|
|
@@ -6098,6 +6358,7 @@
|
|
|
6098
6358
|
}
|
|
6099
6359
|
}
|
|
6100
6360
|
},
|
|
6361
|
+
"x-f5xc-description-short": "Response body of InitiatePlanTransition custom API.",
|
|
6101
6362
|
"x-f5xc-minimum-configuration": {
|
|
6102
6363
|
"description": "Minimum configuration for plan_transitionInitiatePlanTransitionRsp",
|
|
6103
6364
|
"required_fields": [
|
|
@@ -6125,6 +6386,8 @@
|
|
|
6125
6386
|
"default": "STATE_UNSPECIFIED",
|
|
6126
6387
|
"x-displayname": "State",
|
|
6127
6388
|
"x-ves-proto-enum": "ves.io.schema.billing.plan_transition.State",
|
|
6389
|
+
"x-f5xc-description-short": "State of the plan transition FSM - STATE_UNSPECIFIED: Zero value for this state.",
|
|
6390
|
+
"x-f5xc-description-medium": "State of the plan transition FSM - STATE_UNSPECIFIED: Zero value for this state. Should be considered as an invalid state. User has to always explicitly specify which other state should be. - STATE_CREATING: Initial state after plan transition object creation. - STATE_FAILED: Some step(-s)...",
|
|
6128
6391
|
"x-f5xc-minimum-configuration": {
|
|
6129
6392
|
"description": "Minimum configuration for plan_transitionState",
|
|
6130
6393
|
"required_fields": [],
|
|
@@ -6152,6 +6415,8 @@
|
|
|
6152
6415
|
"x-displayname": "Billing provider account ID.",
|
|
6153
6416
|
"x-ves-example": "F68bb6f4-b279-403b-b5e8-59dd6fcf73f0.",
|
|
6154
6417
|
"x-f5xc-example": "f68bb6f4-b279-403b-b5e8-59dd6fcf73f0",
|
|
6418
|
+
"x-f5xc-description-short": "ID of the billing provider account created to verify the billing info provided with this object.",
|
|
6419
|
+
"x-f5xc-description-medium": "ID of the billing provider account created to verify the billing info provided with this object. The ID is then used to ensure no more duplicate billing account is created.",
|
|
6155
6420
|
"minLength": 0,
|
|
6156
6421
|
"maxLength": 1024,
|
|
6157
6422
|
"x-f5xc-required-for": {
|
|
@@ -6168,6 +6433,7 @@
|
|
|
6168
6433
|
"title": "Create_support_ticket.",
|
|
6169
6434
|
"format": "boolean",
|
|
6170
6435
|
"x-displayname": "Create Support Ticket.",
|
|
6436
|
+
"x-f5xc-description-short": "If set to true, a support ticket will be created to provide the plan transition request.",
|
|
6171
6437
|
"x-f5xc-required-for": {
|
|
6172
6438
|
"minimum_config": false,
|
|
6173
6439
|
"create": false,
|
|
@@ -6182,6 +6448,7 @@
|
|
|
6182
6448
|
"x-displayname": "Feedback",
|
|
6183
6449
|
"x-ves-example": "Customer given feedback.",
|
|
6184
6450
|
"x-f5xc-example": "customer given feedback",
|
|
6451
|
+
"x-f5xc-description-short": "Feedback from the customer related to reason of account deletion.",
|
|
6185
6452
|
"minLength": 0,
|
|
6186
6453
|
"maxLength": 1024,
|
|
6187
6454
|
"x-f5xc-required-for": {
|
|
@@ -6212,7 +6479,7 @@
|
|
|
6212
6479
|
"x-original-maxLength": 1024,
|
|
6213
6480
|
"format": "hostname",
|
|
6214
6481
|
"x-reconciled-from-discovery": true,
|
|
6215
|
-
"x-reconciled-at": "2026-01-
|
|
6482
|
+
"x-reconciled-at": "2026-01-07T15:29:06.880213+00:00"
|
|
6216
6483
|
},
|
|
6217
6484
|
"payment_address": {
|
|
6218
6485
|
"$ref": "#/components/schemas/schemacontactGlobalSpecType"
|
|
@@ -6224,6 +6491,7 @@
|
|
|
6224
6491
|
"x-displayname": "Payment Provider Token.",
|
|
6225
6492
|
"x-ves-example": "Tok-123456.",
|
|
6226
6493
|
"x-f5xc-example": "tok-123456",
|
|
6494
|
+
"x-f5xc-description-short": "Payment provider token (for credit card details).",
|
|
6227
6495
|
"minLength": 0,
|
|
6228
6496
|
"maxLength": 1024,
|
|
6229
6497
|
"x-f5xc-required-for": {
|
|
@@ -6243,6 +6511,7 @@
|
|
|
6243
6511
|
"x-displayname": "Subscribe Addon Services.",
|
|
6244
6512
|
"x-ves-example": "['service1','service2']",
|
|
6245
6513
|
"x-f5xc-example": "['service1','service2']",
|
|
6514
|
+
"x-f5xc-description-short": "List of addon services that needs to be subscribed/enabled part of this plan transition.",
|
|
6246
6515
|
"x-f5xc-required-for": {
|
|
6247
6516
|
"minimum_config": false,
|
|
6248
6517
|
"create": false,
|
|
@@ -6257,6 +6526,7 @@
|
|
|
6257
6526
|
"x-displayname": "Support Ticket Additional Info.",
|
|
6258
6527
|
"x-ves-example": "User comment.",
|
|
6259
6528
|
"x-f5xc-example": "user comment",
|
|
6529
|
+
"x-f5xc-description-short": "Additional information user want to record part of the support ticket.",
|
|
6260
6530
|
"minLength": 0,
|
|
6261
6531
|
"maxLength": 1024,
|
|
6262
6532
|
"x-f5xc-required-for": {
|
|
@@ -6273,6 +6543,7 @@
|
|
|
6273
6543
|
"x-displayname": "Third party subscription ID.",
|
|
6274
6544
|
"x-ves-example": "E265802e-9dfa-4632-8c0b-cc2596e5599e.",
|
|
6275
6545
|
"x-f5xc-example": "e265802e-9dfa-4632-8c0b-cc2596e5599e",
|
|
6546
|
+
"x-f5xc-description-short": "ID of the third party subscription ID created.",
|
|
6276
6547
|
"minLength": 0,
|
|
6277
6548
|
"maxLength": 1024,
|
|
6278
6549
|
"x-f5xc-required-for": {
|
|
@@ -6293,6 +6564,7 @@
|
|
|
6293
6564
|
"x-displayname": "Unsubscribe Addon Services.",
|
|
6294
6565
|
"x-ves-example": "['service3','service4']",
|
|
6295
6566
|
"x-f5xc-example": "['service3','service4']",
|
|
6567
|
+
"x-f5xc-description-short": "List of addon services that needs to be unsubscribed/removed part of this plan transition.",
|
|
6296
6568
|
"x-f5xc-required-for": {
|
|
6297
6569
|
"minimum_config": false,
|
|
6298
6570
|
"create": false,
|
|
@@ -6301,6 +6573,7 @@
|
|
|
6301
6573
|
}
|
|
6302
6574
|
}
|
|
6303
6575
|
},
|
|
6576
|
+
"x-f5xc-description-short": "Payload which is required to execute transition from the current tenant's plan to a given new_plan.",
|
|
6304
6577
|
"x-f5xc-minimum-configuration": {
|
|
6305
6578
|
"description": "Minimum configuration for plan_transitionTransitionPayload",
|
|
6306
6579
|
"required_fields": [
|
|
@@ -6333,7 +6606,7 @@
|
|
|
6333
6606
|
"properties": {
|
|
6334
6607
|
"address1": {
|
|
6335
6608
|
"type": "string",
|
|
6336
|
-
"description": "",
|
|
6609
|
+
"description": "Network address or location",
|
|
6337
6610
|
"title": "Address1",
|
|
6338
6611
|
"x-displayname": "Address Line 1.",
|
|
6339
6612
|
"x-ves-example": "1234 Main road.",
|
|
@@ -6349,7 +6622,7 @@
|
|
|
6349
6622
|
},
|
|
6350
6623
|
"address2": {
|
|
6351
6624
|
"type": "string",
|
|
6352
|
-
"description": "",
|
|
6625
|
+
"description": "Network address or location",
|
|
6353
6626
|
"title": "Address2",
|
|
6354
6627
|
"x-displayname": "Address Line 2.",
|
|
6355
6628
|
"x-ves-example": "P.O BOX 56.",
|
|
@@ -6365,7 +6638,7 @@
|
|
|
6365
6638
|
},
|
|
6366
6639
|
"city": {
|
|
6367
6640
|
"type": "string",
|
|
6368
|
-
"description": "",
|
|
6641
|
+
"description": "Configuration parameter for city",
|
|
6369
6642
|
"title": "City",
|
|
6370
6643
|
"x-displayname": "City",
|
|
6371
6644
|
"x-ves-example": "Sunnyvale",
|
|
@@ -6384,7 +6657,7 @@
|
|
|
6384
6657
|
},
|
|
6385
6658
|
"country": {
|
|
6386
6659
|
"type": "string",
|
|
6387
|
-
"description": "",
|
|
6660
|
+
"description": "Configuration parameter for country",
|
|
6388
6661
|
"title": "Country",
|
|
6389
6662
|
"x-displayname": "Country",
|
|
6390
6663
|
"x-ves-example": "US",
|
|
@@ -6400,7 +6673,7 @@
|
|
|
6400
6673
|
},
|
|
6401
6674
|
"county": {
|
|
6402
6675
|
"type": "string",
|
|
6403
|
-
"description": "",
|
|
6676
|
+
"description": "Configuration parameter for county",
|
|
6404
6677
|
"title": "County",
|
|
6405
6678
|
"x-displayname": "County",
|
|
6406
6679
|
"x-ves-example": "Santa Clara.",
|
|
@@ -6416,11 +6689,12 @@
|
|
|
6416
6689
|
},
|
|
6417
6690
|
"phone_number": {
|
|
6418
6691
|
"type": "string",
|
|
6419
|
-
"description": "",
|
|
6692
|
+
"description": "Configuration parameter for phone number",
|
|
6420
6693
|
"title": "Phone_number.",
|
|
6421
6694
|
"x-displayname": "Phone Number.",
|
|
6422
6695
|
"x-ves-example": "+11234567890.",
|
|
6423
6696
|
"x-f5xc-example": "+11234567890",
|
|
6697
|
+
"x-f5xc-description-short": "Configuration parameter for phone number.",
|
|
6424
6698
|
"minLength": 0,
|
|
6425
6699
|
"maxLength": 1024,
|
|
6426
6700
|
"x-f5xc-required-for": {
|
|
@@ -6432,7 +6706,7 @@
|
|
|
6432
6706
|
},
|
|
6433
6707
|
"state": {
|
|
6434
6708
|
"type": "string",
|
|
6435
|
-
"description": "",
|
|
6709
|
+
"description": "Current state of the resource",
|
|
6436
6710
|
"title": "State",
|
|
6437
6711
|
"x-displayname": "State",
|
|
6438
6712
|
"x-ves-example": "California.",
|
|
@@ -6448,7 +6722,7 @@
|
|
|
6448
6722
|
},
|
|
6449
6723
|
"state_code": {
|
|
6450
6724
|
"type": "string",
|
|
6451
|
-
"description": "",
|
|
6725
|
+
"description": "Configuration parameter for state code",
|
|
6452
6726
|
"title": "State code.",
|
|
6453
6727
|
"x-displayname": "State Code.",
|
|
6454
6728
|
"x-ves-example": "CA",
|
|
@@ -6464,7 +6738,7 @@
|
|
|
6464
6738
|
},
|
|
6465
6739
|
"zip_code": {
|
|
6466
6740
|
"type": "string",
|
|
6467
|
-
"description": "",
|
|
6741
|
+
"description": "IP address configuration",
|
|
6468
6742
|
"title": "Zip_code",
|
|
6469
6743
|
"x-displayname": "ZIP code",
|
|
6470
6744
|
"x-ves-example": "95054",
|
|
@@ -6479,6 +6753,8 @@
|
|
|
6479
6753
|
}
|
|
6480
6754
|
}
|
|
6481
6755
|
},
|
|
6756
|
+
"x-f5xc-description-short": "Instance of one single contact that can be used to communicate with customers.",
|
|
6757
|
+
"x-f5xc-description-medium": "Instance of one single contact that can be used to communicate with customers. Depending on contact type we use these details to send general communication (regular, physical mail) or invoices.",
|
|
6482
6758
|
"x-f5xc-minimum-configuration": {
|
|
6483
6759
|
"description": "Minimum configuration for schemacontactGlobalSpecType",
|
|
6484
6760
|
"required_fields": [
|
|
@@ -6514,6 +6790,8 @@
|
|
|
6514
6790
|
"default": "REASON_UNKNOWN",
|
|
6515
6791
|
"x-displayname": "DeletionReason.",
|
|
6516
6792
|
"x-ves-proto-enum": "ves.io.schema.tenant.DeletionReason",
|
|
6793
|
+
"x-f5xc-description-short": "List of available reason for account deletion. - REASON_UNKNOWN: Unknown reason Unknown reason - REASON_SWITCH_TO_FREE_PLAN: Switch to free plan...",
|
|
6794
|
+
"x-f5xc-description-medium": "List of available reason for account deletion. - REASON_UNKNOWN: Unknown reason Unknown reason - REASON_SWITCH_TO_FREE_PLAN: Switch to free plan Switch to free plan - REASON_NO_LONGER_NEEDED: No longer needed No longer needed - REASON_NOT_JUSTIFY_COSTS: Too expensive Too expensive ...",
|
|
6517
6795
|
"x-f5xc-minimum-configuration": {
|
|
6518
6796
|
"description": "Minimum configuration for tenantDeletionReason",
|
|
6519
6797
|
"required_fields": [],
|
|
@@ -6531,6 +6809,8 @@
|
|
|
6531
6809
|
"type_url": {
|
|
6532
6810
|
"type": "string",
|
|
6533
6811
|
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.",
|
|
6812
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
6813
|
+
"x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).",
|
|
6534
6814
|
"minLength": 0,
|
|
6535
6815
|
"maxLength": 1024,
|
|
6536
6816
|
"x-f5xc-required-for": {
|
|
@@ -6554,9 +6834,11 @@
|
|
|
6554
6834
|
},
|
|
6555
6835
|
"x-original-maxLength": 1024,
|
|
6556
6836
|
"x-reconciled-from-discovery": true,
|
|
6557
|
-
"x-reconciled-at": "2026-01-
|
|
6837
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277844+00:00"
|
|
6558
6838
|
}
|
|
6559
6839
|
},
|
|
6840
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
6841
|
+
"x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...",
|
|
6560
6842
|
"x-f5xc-minimum-configuration": {
|
|
6561
6843
|
"description": "Minimum configuration for protobufAny",
|
|
6562
6844
|
"required_fields": [
|
|
@@ -6638,6 +6920,7 @@
|
|
|
6638
6920
|
"title": "Fail_if_referred.",
|
|
6639
6921
|
"format": "boolean",
|
|
6640
6922
|
"x-displayname": "Fail-If-Referred.",
|
|
6923
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
6641
6924
|
"x-f5xc-required-for": {
|
|
6642
6925
|
"minimum_config": false,
|
|
6643
6926
|
"create": false,
|
|
@@ -6662,7 +6945,7 @@
|
|
|
6662
6945
|
},
|
|
6663
6946
|
"x-original-maxLength": 1024,
|
|
6664
6947
|
"x-reconciled-from-discovery": true,
|
|
6665
|
-
"x-reconciled-at": "2026-01-
|
|
6948
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277861+00:00"
|
|
6666
6949
|
},
|
|
6667
6950
|
"namespace": {
|
|
6668
6951
|
"type": "string",
|
|
@@ -6671,6 +6954,7 @@
|
|
|
6671
6954
|
"x-displayname": "Namespace",
|
|
6672
6955
|
"x-ves-example": "Ns1",
|
|
6673
6956
|
"x-f5xc-example": "ns1",
|
|
6957
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
6674
6958
|
"minLength": 0,
|
|
6675
6959
|
"maxLength": 6,
|
|
6676
6960
|
"x-f5xc-required-for": {
|
|
@@ -6681,7 +6965,7 @@
|
|
|
6681
6965
|
},
|
|
6682
6966
|
"x-original-maxLength": 1024,
|
|
6683
6967
|
"x-reconciled-from-discovery": true,
|
|
6684
|
-
"x-reconciled-at": "2026-01-
|
|
6968
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277866+00:00"
|
|
6685
6969
|
}
|
|
6686
6970
|
},
|
|
6687
6971
|
"x-f5xc-minimum-configuration": {
|
|
@@ -6709,6 +6993,7 @@
|
|
|
6709
6993
|
"title": "Maximum",
|
|
6710
6994
|
"format": "double",
|
|
6711
6995
|
"x-f5xc-example": "100",
|
|
6996
|
+
"x-f5xc-description-short": "X-displayName: \"Maximum\" The maximum value.",
|
|
6712
6997
|
"x-f5xc-required-for": {
|
|
6713
6998
|
"minimum_config": false,
|
|
6714
6999
|
"create": false,
|
|
@@ -6717,6 +7002,8 @@
|
|
|
6717
7002
|
}
|
|
6718
7003
|
}
|
|
6719
7004
|
},
|
|
7005
|
+
"x-f5xc-description-short": "X-displayName: \"Limit (float)\" FloatLimitType defines a float quota value that should not be exceeded.",
|
|
7006
|
+
"x-f5xc-description-medium": "X-displayName: \"Limit (float)\" FloatLimitType defines a float quota value that should not be exceeded. Useful for items that have quotas in fractions.",
|
|
6720
7007
|
"x-f5xc-minimum-configuration": {
|
|
6721
7008
|
"description": "Minimum configuration for quotaFloatLimitType",
|
|
6722
7009
|
"required_fields": [
|
|
@@ -6765,6 +7052,7 @@
|
|
|
6765
7052
|
"description": "FloatQuotaUsage object.\nDeprecated by 'resources'",
|
|
6766
7053
|
"title": "FloatQuotaUsage object.",
|
|
6767
7054
|
"x-displayname": "Float Quota Usage.",
|
|
7055
|
+
"x-f5xc-description-short": "FloatQuotaUsage object. Deprecated by 'resources'",
|
|
6768
7056
|
"x-f5xc-required-for": {
|
|
6769
7057
|
"minimum_config": false,
|
|
6770
7058
|
"create": false,
|
|
@@ -6789,6 +7077,7 @@
|
|
|
6789
7077
|
"description": "QuotaUsage object.\nDeprecated by 'objects'",
|
|
6790
7078
|
"title": "QuotaUsage object.",
|
|
6791
7079
|
"x-displayname": "Qouta Usage.",
|
|
7080
|
+
"x-f5xc-description-short": "QuotaUsage object. Deprecated by 'objects'",
|
|
6792
7081
|
"x-f5xc-required-for": {
|
|
6793
7082
|
"minimum_config": false,
|
|
6794
7083
|
"create": false,
|
|
@@ -6801,6 +7090,7 @@
|
|
|
6801
7090
|
"description": "Configured limits for resources if relevant.",
|
|
6802
7091
|
"title": "Resources",
|
|
6803
7092
|
"x-displayname": "Resource limits.",
|
|
7093
|
+
"x-f5xc-description-short": "Configured limits for resources if relevant.",
|
|
6804
7094
|
"x-f5xc-required-for": {
|
|
6805
7095
|
"minimum_config": false,
|
|
6806
7096
|
"create": false,
|
|
@@ -6809,6 +7099,7 @@
|
|
|
6809
7099
|
}
|
|
6810
7100
|
}
|
|
6811
7101
|
},
|
|
7102
|
+
"x-f5xc-description-short": "Map of quotas that are assigned for the current tenant and namespace.",
|
|
6812
7103
|
"x-f5xc-minimum-configuration": {
|
|
6813
7104
|
"description": "Minimum configuration for quotaGetQuotaLimitsResponse",
|
|
6814
7105
|
"required_fields": [
|
|
@@ -6844,6 +7135,7 @@
|
|
|
6844
7135
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6845
7136
|
},
|
|
6846
7137
|
"x-displayname": "Deleted Referred Objects.",
|
|
7138
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6847
7139
|
"x-f5xc-required-for": {
|
|
6848
7140
|
"minimum_config": false,
|
|
6849
7141
|
"create": false,
|
|
@@ -6859,6 +7151,7 @@
|
|
|
6859
7151
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6860
7152
|
},
|
|
6861
7153
|
"x-displayname": "Disabled Referred Objects.",
|
|
7154
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6862
7155
|
"x-f5xc-required-for": {
|
|
6863
7156
|
"minimum_config": false,
|
|
6864
7157
|
"create": false,
|
|
@@ -6877,6 +7170,7 @@
|
|
|
6877
7170
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6878
7171
|
},
|
|
6879
7172
|
"x-displayname": "Referring Objects.",
|
|
7173
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
6880
7174
|
"x-f5xc-required-for": {
|
|
6881
7175
|
"minimum_config": false,
|
|
6882
7176
|
"create": false,
|
|
@@ -6898,6 +7192,8 @@
|
|
|
6898
7192
|
"$ref": "#/components/schemas/quotaStatusObject"
|
|
6899
7193
|
},
|
|
6900
7194
|
"x-displayname": "Status",
|
|
7195
|
+
"x-f5xc-example": "active",
|
|
7196
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6901
7197
|
"x-f5xc-required-for": {
|
|
6902
7198
|
"minimum_config": false,
|
|
6903
7199
|
"create": false,
|
|
@@ -6907,7 +7203,7 @@
|
|
|
6907
7203
|
"maxLength": 17,
|
|
6908
7204
|
"minLength": 17,
|
|
6909
7205
|
"x-reconciled-from-discovery": true,
|
|
6910
|
-
"x-reconciled-at": "2026-01-
|
|
7206
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277894+00:00"
|
|
6911
7207
|
},
|
|
6912
7208
|
"system_metadata": {
|
|
6913
7209
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -6947,6 +7243,8 @@
|
|
|
6947
7243
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
6948
7244
|
],
|
|
6949
7245
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
7246
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
7247
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
6950
7248
|
"x-f5xc-minimum-configuration": {
|
|
6951
7249
|
"description": "Minimum configuration for quotaGetResponseFormatCode",
|
|
6952
7250
|
"required_fields": [],
|
|
@@ -6993,6 +7291,7 @@
|
|
|
6993
7291
|
"description": "UsageDataInFloat object.\nDeprecated by 'resources'",
|
|
6994
7292
|
"title": "UsageDataInFloat object.",
|
|
6995
7293
|
"x-displayname": "Usage Data in float.",
|
|
7294
|
+
"x-f5xc-description-short": "UsageDataInFloat object. Deprecated by 'resources'",
|
|
6996
7295
|
"x-f5xc-required-for": {
|
|
6997
7296
|
"minimum_config": false,
|
|
6998
7297
|
"create": false,
|
|
@@ -7005,6 +7304,7 @@
|
|
|
7005
7304
|
"description": "Configured limits for object instances and current usage.",
|
|
7006
7305
|
"title": "Objects",
|
|
7007
7306
|
"x-displayname": "Object limits and usage.",
|
|
7307
|
+
"x-f5xc-description-short": "Configured limits for object instances and current usage.",
|
|
7008
7308
|
"x-f5xc-required-for": {
|
|
7009
7309
|
"minimum_config": false,
|
|
7010
7310
|
"create": false,
|
|
@@ -7017,6 +7317,7 @@
|
|
|
7017
7317
|
"description": "UsageData object.\nDeprecated by 'objects'",
|
|
7018
7318
|
"title": "UsageData object.",
|
|
7019
7319
|
"x-displayname": "Usage Data.",
|
|
7320
|
+
"x-f5xc-description-short": "UsageData object. Deprecated by 'objects'",
|
|
7020
7321
|
"x-f5xc-required-for": {
|
|
7021
7322
|
"minimum_config": false,
|
|
7022
7323
|
"create": false,
|
|
@@ -7029,6 +7330,7 @@
|
|
|
7029
7330
|
"description": "Configured limits for resources and current usage if relevant.",
|
|
7030
7331
|
"title": "Resources",
|
|
7031
7332
|
"x-displayname": "Resource limits and usage.",
|
|
7333
|
+
"x-f5xc-description-short": "Configured limits for resources and current usage if relevant.",
|
|
7032
7334
|
"x-f5xc-required-for": {
|
|
7033
7335
|
"minimum_config": false,
|
|
7034
7336
|
"create": false,
|
|
@@ -7038,6 +7340,8 @@
|
|
|
7038
7340
|
}
|
|
7039
7341
|
},
|
|
7040
7342
|
"x-f5xc-example": "{",
|
|
7343
|
+
"x-f5xc-description-short": "User\": {limit: {maximum: 10}, usage: {number: 8}}, \"virtual_host\":{limit: {maximum: 12}, usage: {number: 6}}, \"domain\": {limit: {maximum: 7}...",
|
|
7344
|
+
"x-f5xc-description-medium": "User\": {limit: {maximum: 10}, usage: {number: 8}}, \"virtual_host\":{limit: {maximum: 12}, usage: {number: 6}}, \"domain\": {limit: {maximum: 7}, usage: {number: 5}}}\" Map of quotas that are assigned for the current tenant and namespace.",
|
|
7041
7345
|
"x-f5xc-minimum-configuration": {
|
|
7042
7346
|
"description": "Minimum configuration for quotaGetResponseType",
|
|
7043
7347
|
"required_fields": [
|
|
@@ -7066,6 +7370,7 @@
|
|
|
7066
7370
|
"title": "Maximum",
|
|
7067
7371
|
"format": "int32",
|
|
7068
7372
|
"x-f5xc-example": "100",
|
|
7373
|
+
"x-f5xc-description-short": "X-displayName: \"Maximum\" The maximum value for the object kind.",
|
|
7069
7374
|
"minimum": 0,
|
|
7070
7375
|
"maximum": 2147483647,
|
|
7071
7376
|
"x-f5xc-required-for": {
|
|
@@ -7076,6 +7381,8 @@
|
|
|
7076
7381
|
}
|
|
7077
7382
|
}
|
|
7078
7383
|
},
|
|
7384
|
+
"x-f5xc-description-short": "X-displayName: \"Limit\" LimitType defines a quota value for a specific object kind that should not be exceeded.",
|
|
7385
|
+
"x-f5xc-description-medium": "X-displayName: \"Limit\" LimitType defines a quota value for a specific object kind that should not be exceeded.",
|
|
7079
7386
|
"x-f5xc-minimum-configuration": {
|
|
7080
7387
|
"description": "Minimum configuration for quotaLimitType",
|
|
7081
7388
|
"required_fields": [
|
|
@@ -7103,6 +7410,7 @@
|
|
|
7103
7410
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
7104
7411
|
},
|
|
7105
7412
|
"x-displayname": "Errors",
|
|
7413
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
7106
7414
|
"x-f5xc-required-for": {
|
|
7107
7415
|
"minimum_config": false,
|
|
7108
7416
|
"create": false,
|
|
@@ -7118,6 +7426,8 @@
|
|
|
7118
7426
|
"$ref": "#/components/schemas/quotaListResponseItem"
|
|
7119
7427
|
},
|
|
7120
7428
|
"x-displayname": "Items",
|
|
7429
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
7430
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
7121
7431
|
"x-f5xc-required-for": {
|
|
7122
7432
|
"minimum_config": false,
|
|
7123
7433
|
"create": false,
|
|
@@ -7151,6 +7461,8 @@
|
|
|
7151
7461
|
"description": "The set of annotations present on this quota.",
|
|
7152
7462
|
"title": "Annotations.",
|
|
7153
7463
|
"x-displayname": "Annotations.",
|
|
7464
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7465
|
+
"x-f5xc-description-short": "The set of annotations present on this quota.",
|
|
7154
7466
|
"x-f5xc-required-for": {
|
|
7155
7467
|
"minimum_config": false,
|
|
7156
7468
|
"create": false,
|
|
@@ -7173,7 +7485,7 @@
|
|
|
7173
7485
|
},
|
|
7174
7486
|
"x-original-maxLength": 1024,
|
|
7175
7487
|
"x-reconciled-from-discovery": true,
|
|
7176
|
-
"x-reconciled-at": "2026-01-
|
|
7488
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277917+00:00"
|
|
7177
7489
|
},
|
|
7178
7490
|
"disabled": {
|
|
7179
7491
|
"type": "boolean",
|
|
@@ -7181,6 +7493,8 @@
|
|
|
7181
7493
|
"title": "Disabled",
|
|
7182
7494
|
"format": "boolean",
|
|
7183
7495
|
"x-displayname": "Disabled",
|
|
7496
|
+
"x-f5xc-example": "True",
|
|
7497
|
+
"x-f5xc-description-short": "Value of true indicates quota is administratively disabled.",
|
|
7184
7498
|
"x-f5xc-required-for": {
|
|
7185
7499
|
"minimum_config": false,
|
|
7186
7500
|
"create": false,
|
|
@@ -7196,6 +7510,8 @@
|
|
|
7196
7510
|
"description": "The set of labels present on this quota.",
|
|
7197
7511
|
"title": "Labels",
|
|
7198
7512
|
"x-displayname": "Labels",
|
|
7513
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7514
|
+
"x-f5xc-description-short": "The set of labels present on this quota.",
|
|
7199
7515
|
"x-f5xc-required-for": {
|
|
7200
7516
|
"minimum_config": false,
|
|
7201
7517
|
"create": false,
|
|
@@ -7223,7 +7539,7 @@
|
|
|
7223
7539
|
},
|
|
7224
7540
|
"x-original-maxLength": 1024,
|
|
7225
7541
|
"x-reconciled-from-discovery": true,
|
|
7226
|
-
"x-reconciled-at": "2026-01-
|
|
7542
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277927+00:00"
|
|
7227
7543
|
},
|
|
7228
7544
|
"namespace": {
|
|
7229
7545
|
"type": "string",
|
|
@@ -7242,7 +7558,7 @@
|
|
|
7242
7558
|
},
|
|
7243
7559
|
"x-original-maxLength": 1024,
|
|
7244
7560
|
"x-reconciled-from-discovery": true,
|
|
7245
|
-
"x-reconciled-at": "2026-01-
|
|
7561
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277932+00:00"
|
|
7246
7562
|
},
|
|
7247
7563
|
"owner_view": {
|
|
7248
7564
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -7255,6 +7571,7 @@
|
|
|
7255
7571
|
"$ref": "#/components/schemas/quotaStatusObject"
|
|
7256
7572
|
},
|
|
7257
7573
|
"x-displayname": "Status",
|
|
7574
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
7258
7575
|
"x-f5xc-required-for": {
|
|
7259
7576
|
"minimum_config": false,
|
|
7260
7577
|
"create": false,
|
|
@@ -7283,7 +7600,7 @@
|
|
|
7283
7600
|
"x-field-mutability": "read-only",
|
|
7284
7601
|
"x-original-maxLength": 1024,
|
|
7285
7602
|
"x-reconciled-from-discovery": true,
|
|
7286
|
-
"x-reconciled-at": "2026-01-
|
|
7603
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277940+00:00"
|
|
7287
7604
|
},
|
|
7288
7605
|
"uid": {
|
|
7289
7606
|
"type": "string",
|
|
@@ -7304,9 +7621,11 @@
|
|
|
7304
7621
|
"x-original-maxLength": 1024,
|
|
7305
7622
|
"format": "uuid",
|
|
7306
7623
|
"x-reconciled-from-discovery": true,
|
|
7307
|
-
"x-reconciled-at": "2026-01-
|
|
7624
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277946+00:00"
|
|
7308
7625
|
}
|
|
7309
7626
|
},
|
|
7627
|
+
"x-f5xc-description-short": "By default a summary of quota is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
7628
|
+
"x-f5xc-description-medium": "By default a summary of quota is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
7310
7629
|
"x-f5xc-minimum-configuration": {
|
|
7311
7630
|
"description": "Minimum configuration for quotaListResponseItem",
|
|
7312
7631
|
"required_fields": [
|
|
@@ -7340,6 +7659,7 @@
|
|
|
7340
7659
|
"type": "string",
|
|
7341
7660
|
"description": "X-displayName: \"Description\"\nDescription about the field.",
|
|
7342
7661
|
"title": "Description.",
|
|
7662
|
+
"x-f5xc-description-short": "X-displayName: \"Description\" Description about the field.",
|
|
7343
7663
|
"minLength": 0,
|
|
7344
7664
|
"maxLength": 0,
|
|
7345
7665
|
"x-f5xc-required-for": {
|
|
@@ -7350,13 +7670,14 @@
|
|
|
7350
7670
|
},
|
|
7351
7671
|
"x-original-maxLength": 1024,
|
|
7352
7672
|
"x-reconciled-from-discovery": true,
|
|
7353
|
-
"x-reconciled-at": "2026-01-
|
|
7673
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277952+00:00"
|
|
7354
7674
|
},
|
|
7355
7675
|
"display_name": {
|
|
7356
7676
|
"type": "string",
|
|
7357
7677
|
"description": "X-displayName: \"Display Name\"\nThis field represents the display name.",
|
|
7358
7678
|
"title": "Display_name.",
|
|
7359
7679
|
"x-f5xc-example": "example-resource",
|
|
7680
|
+
"x-f5xc-description-short": "X-displayName: \"Display Name\" This field represents the display name.",
|
|
7360
7681
|
"minLength": 0,
|
|
7361
7682
|
"maxLength": 1024,
|
|
7362
7683
|
"x-f5xc-required-for": {
|
|
@@ -7370,6 +7691,7 @@
|
|
|
7370
7691
|
"$ref": "#/components/schemas/quotaLimitType"
|
|
7371
7692
|
}
|
|
7372
7693
|
},
|
|
7694
|
+
"x-f5xc-description-short": "X-displayName: \"Quota Limits\" QuotaLimits stores limit in integer.",
|
|
7373
7695
|
"x-f5xc-minimum-configuration": {
|
|
7374
7696
|
"description": "Minimum configuration for quotaQuotaLimits",
|
|
7375
7697
|
"required_fields": [
|
|
@@ -7396,6 +7718,7 @@
|
|
|
7396
7718
|
"type": "string",
|
|
7397
7719
|
"description": "X-displayName: \"Description\"\nThe description of quota item.",
|
|
7398
7720
|
"title": "Description.",
|
|
7721
|
+
"x-f5xc-description-short": "X-displayName: \"Description\" The description of quota item.",
|
|
7399
7722
|
"minLength": 0,
|
|
7400
7723
|
"maxLength": 0,
|
|
7401
7724
|
"x-f5xc-required-for": {
|
|
@@ -7406,13 +7729,14 @@
|
|
|
7406
7729
|
},
|
|
7407
7730
|
"x-original-maxLength": 1024,
|
|
7408
7731
|
"x-reconciled-from-discovery": true,
|
|
7409
|
-
"x-reconciled-at": "2026-01-
|
|
7732
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277962+00:00"
|
|
7410
7733
|
},
|
|
7411
7734
|
"display_name": {
|
|
7412
7735
|
"type": "string",
|
|
7413
7736
|
"description": "X-displayName: \"Name\"\nThe name of quota item.",
|
|
7414
7737
|
"title": "Display_name.",
|
|
7415
7738
|
"x-f5xc-example": "example-resource",
|
|
7739
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" The name of quota item.",
|
|
7416
7740
|
"minLength": 0,
|
|
7417
7741
|
"maxLength": 1024,
|
|
7418
7742
|
"x-f5xc-required-for": {
|
|
@@ -7426,6 +7750,7 @@
|
|
|
7426
7750
|
"$ref": "#/components/schemas/quotaFloatLimitType"
|
|
7427
7751
|
}
|
|
7428
7752
|
},
|
|
7753
|
+
"x-f5xc-description-short": "X-displayName: \"Quota Limits Item Type\" Holds the configured limits information.",
|
|
7429
7754
|
"x-f5xc-minimum-configuration": {
|
|
7430
7755
|
"description": "Minimum configuration for quotaQuotaLimitsItemType",
|
|
7431
7756
|
"required_fields": [
|
|
@@ -7448,6 +7773,7 @@
|
|
|
7448
7773
|
"properties": {
|
|
7449
7774
|
"description": {
|
|
7450
7775
|
"type": "string",
|
|
7776
|
+
"description": "Human-readable description text",
|
|
7451
7777
|
"minLength": 0,
|
|
7452
7778
|
"maxLength": 0,
|
|
7453
7779
|
"x-f5xc-required-for": {
|
|
@@ -7458,11 +7784,11 @@
|
|
|
7458
7784
|
},
|
|
7459
7785
|
"x-original-maxLength": 1024,
|
|
7460
7786
|
"x-reconciled-from-discovery": true,
|
|
7461
|
-
"x-reconciled-at": "2026-01-
|
|
7787
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277969+00:00"
|
|
7462
7788
|
},
|
|
7463
7789
|
"display_name": {
|
|
7464
7790
|
"type": "string",
|
|
7465
|
-
"description": "
|
|
7791
|
+
"description": "Human-readable name for the resource",
|
|
7466
7792
|
"x-f5xc-example": "example-resource",
|
|
7467
7793
|
"minLength": 0,
|
|
7468
7794
|
"maxLength": 1024,
|
|
@@ -7480,6 +7806,7 @@
|
|
|
7480
7806
|
"$ref": "#/components/schemas/usageUsageType"
|
|
7481
7807
|
}
|
|
7482
7808
|
},
|
|
7809
|
+
"x-f5xc-description-short": "X-displayName: \"Quota usage\" QuotaUsage stores limit and usage in integer.",
|
|
7483
7810
|
"x-f5xc-minimum-configuration": {
|
|
7484
7811
|
"description": "Minimum configuration for quotaQuotaUsage",
|
|
7485
7812
|
"required_fields": [
|
|
@@ -7507,6 +7834,7 @@
|
|
|
7507
7834
|
"type": "string",
|
|
7508
7835
|
"description": "X-displayName: \"Description\"\nThe description of quota item.",
|
|
7509
7836
|
"title": "Description.",
|
|
7837
|
+
"x-f5xc-description-short": "X-displayName: \"Description\" The description of quota item.",
|
|
7510
7838
|
"minLength": 0,
|
|
7511
7839
|
"maxLength": 0,
|
|
7512
7840
|
"x-f5xc-required-for": {
|
|
@@ -7517,13 +7845,14 @@
|
|
|
7517
7845
|
},
|
|
7518
7846
|
"x-original-maxLength": 1024,
|
|
7519
7847
|
"x-reconciled-from-discovery": true,
|
|
7520
|
-
"x-reconciled-at": "2026-01-
|
|
7848
|
+
"x-reconciled-at": "2026-01-07T15:29:10.277979+00:00"
|
|
7521
7849
|
},
|
|
7522
7850
|
"display_name": {
|
|
7523
7851
|
"type": "string",
|
|
7524
7852
|
"description": "X-displayName: \"Name\"\nThe name of quota item.",
|
|
7525
7853
|
"title": "Display_name.",
|
|
7526
7854
|
"x-f5xc-example": "example-resource",
|
|
7855
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" The name of quota item.",
|
|
7527
7856
|
"minLength": 0,
|
|
7528
7857
|
"maxLength": 1024,
|
|
7529
7858
|
"x-f5xc-required-for": {
|
|
@@ -7540,6 +7869,7 @@
|
|
|
7540
7869
|
"$ref": "#/components/schemas/usageFloatUsageType"
|
|
7541
7870
|
}
|
|
7542
7871
|
},
|
|
7872
|
+
"x-f5xc-description-short": "X-displayName: \"Quota and Usage\" Holds the configured limits and any usage information.",
|
|
7543
7873
|
"x-f5xc-minimum-configuration": {
|
|
7544
7874
|
"description": "Minimum configuration for quotaQuotaUsageItemType",
|
|
7545
7875
|
"required_fields": [
|
|
@@ -7567,6 +7897,7 @@
|
|
|
7567
7897
|
"title": "Burst",
|
|
7568
7898
|
"format": "int32",
|
|
7569
7899
|
"x-f5xc-example": "100",
|
|
7900
|
+
"x-f5xc-description-short": "X-displayName: \"Burst\" The burst which is to be allowed per quanta.",
|
|
7570
7901
|
"minimum": 0,
|
|
7571
7902
|
"maximum": 2147483647,
|
|
7572
7903
|
"x-f5xc-required-for": {
|
|
@@ -7582,6 +7913,7 @@
|
|
|
7582
7913
|
"title": "Rate",
|
|
7583
7914
|
"format": "int32",
|
|
7584
7915
|
"x-f5xc-example": "100",
|
|
7916
|
+
"x-f5xc-description-short": "X-displayName: \"Rate\" The sustained rate which is to be allowed per quanta.",
|
|
7585
7917
|
"minimum": 0,
|
|
7586
7918
|
"maximum": 2147483647,
|
|
7587
7919
|
"x-f5xc-required-for": {
|
|
@@ -7596,6 +7928,7 @@
|
|
|
7596
7928
|
"description": "X-displayName: \"Unit\"\nThe unit for the quanta.",
|
|
7597
7929
|
"title": "Unit",
|
|
7598
7930
|
"x-f5xc-example": "per-second",
|
|
7931
|
+
"x-f5xc-description-short": "X-displayName: \"Unit\" The unit for the quanta.",
|
|
7599
7932
|
"minLength": 0,
|
|
7600
7933
|
"maxLength": 1024,
|
|
7601
7934
|
"x-f5xc-required-for": {
|
|
@@ -7606,6 +7939,8 @@
|
|
|
7606
7939
|
}
|
|
7607
7940
|
}
|
|
7608
7941
|
},
|
|
7942
|
+
"x-f5xc-description-short": "X-displayName: \"Rate Limit\" RateLimitType defines a rate quota value for a specific object kind that should not be exceeded in terms access per...",
|
|
7943
|
+
"x-f5xc-description-medium": "X-displayName: \"Rate Limit\" RateLimitType defines a rate quota value for a specific object kind that should not be exceeded in terms access per time unit.",
|
|
7609
7944
|
"x-f5xc-minimum-configuration": {
|
|
7610
7945
|
"description": "Minimum configuration for quotaRateLimitType",
|
|
7611
7946
|
"required_fields": [
|
|
@@ -7674,6 +8009,7 @@
|
|
|
7674
8009
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
7675
8010
|
},
|
|
7676
8011
|
"x-displayname": "Conditions.",
|
|
8012
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
7677
8013
|
"x-f5xc-required-for": {
|
|
7678
8014
|
"minimum_config": false,
|
|
7679
8015
|
"create": false,
|
|
@@ -7726,6 +8062,8 @@
|
|
|
7726
8062
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
7727
8063
|
"title": "Hostname",
|
|
7728
8064
|
"x-displayname": "Hostname",
|
|
8065
|
+
"x-f5xc-example": "example-resource",
|
|
8066
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
7729
8067
|
"minLength": 0,
|
|
7730
8068
|
"maxLength": 1024,
|
|
7731
8069
|
"x-f5xc-required-for": {
|
|
@@ -7757,6 +8095,8 @@
|
|
|
7757
8095
|
"x-displayname": "Reason",
|
|
7758
8096
|
"x-ves-example": "Value",
|
|
7759
8097
|
"x-f5xc-example": "value",
|
|
8098
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
8099
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
7760
8100
|
"minLength": 0,
|
|
7761
8101
|
"maxLength": 43,
|
|
7762
8102
|
"x-f5xc-required-for": {
|
|
@@ -7767,13 +8107,15 @@
|
|
|
7767
8107
|
},
|
|
7768
8108
|
"x-original-maxLength": 1024,
|
|
7769
8109
|
"x-reconciled-from-discovery": true,
|
|
7770
|
-
"x-reconciled-at": "2026-01-
|
|
8110
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278003+00:00"
|
|
7771
8111
|
},
|
|
7772
8112
|
"service_name": {
|
|
7773
8113
|
"type": "string",
|
|
7774
8114
|
"description": "Name of the service that sent the status.",
|
|
7775
8115
|
"title": "Service name.",
|
|
7776
8116
|
"x-displayname": "Service Name.",
|
|
8117
|
+
"x-f5xc-example": "example-resource",
|
|
8118
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
7777
8119
|
"minLength": 0,
|
|
7778
8120
|
"maxLength": 1024,
|
|
7779
8121
|
"x-f5xc-required-for": {
|
|
@@ -7796,6 +8138,8 @@
|
|
|
7796
8138
|
"x-validation-rules": {
|
|
7797
8139
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
7798
8140
|
},
|
|
8141
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
8142
|
+
"x-f5xc-description-medium": "Status of the condition \"Success\" Validtion has succeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...",
|
|
7799
8143
|
"minLength": 0,
|
|
7800
8144
|
"maxLength": 17,
|
|
7801
8145
|
"x-f5xc-required-for": {
|
|
@@ -7806,7 +8150,7 @@
|
|
|
7806
8150
|
},
|
|
7807
8151
|
"x-original-maxLength": 1024,
|
|
7808
8152
|
"x-reconciled-from-discovery": true,
|
|
7809
|
-
"x-reconciled-at": "2026-01-
|
|
8153
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278008+00:00"
|
|
7810
8154
|
},
|
|
7811
8155
|
"type": {
|
|
7812
8156
|
"type": "string",
|
|
@@ -7821,6 +8165,8 @@
|
|
|
7821
8165
|
"x-validation-rules": {
|
|
7822
8166
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
7823
8167
|
},
|
|
8168
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
8169
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
7824
8170
|
"minLength": 0,
|
|
7825
8171
|
"maxLength": 1024,
|
|
7826
8172
|
"x-f5xc-required-for": {
|
|
@@ -7831,6 +8177,8 @@
|
|
|
7831
8177
|
}
|
|
7832
8178
|
}
|
|
7833
8179
|
},
|
|
8180
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
8181
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
7834
8182
|
"x-f5xc-minimum-configuration": {
|
|
7835
8183
|
"description": "Minimum configuration for schemaConditionType",
|
|
7836
8184
|
"required_fields": [
|
|
@@ -7866,6 +8214,8 @@
|
|
|
7866
8214
|
"default": "EOK",
|
|
7867
8215
|
"x-displayname": "Error Code.",
|
|
7868
8216
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
8217
|
+
"x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...",
|
|
8218
|
+
"x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...",
|
|
7869
8219
|
"x-f5xc-minimum-configuration": {
|
|
7870
8220
|
"description": "Minimum configuration for schemaErrorCode",
|
|
7871
8221
|
"required_fields": [],
|
|
@@ -7906,6 +8256,7 @@
|
|
|
7906
8256
|
}
|
|
7907
8257
|
}
|
|
7908
8258
|
},
|
|
8259
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
7909
8260
|
"x-f5xc-minimum-configuration": {
|
|
7910
8261
|
"description": "Minimum configuration for schemaErrorType",
|
|
7911
8262
|
"required_fields": [
|
|
@@ -7933,6 +8284,7 @@
|
|
|
7933
8284
|
"title": "Name",
|
|
7934
8285
|
"x-displayname": "Name",
|
|
7935
8286
|
"x-f5xc-example": "example-resource",
|
|
8287
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
7936
8288
|
"minLength": 0,
|
|
7937
8289
|
"maxLength": 16,
|
|
7938
8290
|
"x-f5xc-required-for": {
|
|
@@ -7943,9 +8295,10 @@
|
|
|
7943
8295
|
},
|
|
7944
8296
|
"x-original-maxLength": 1024,
|
|
7945
8297
|
"x-reconciled-from-discovery": true,
|
|
7946
|
-
"x-reconciled-at": "2026-01-
|
|
8298
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278019+00:00"
|
|
7947
8299
|
}
|
|
7948
8300
|
},
|
|
8301
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
7949
8302
|
"x-f5xc-minimum-configuration": {
|
|
7950
8303
|
"description": "Minimum configuration for schemaInitializerType",
|
|
7951
8304
|
"required_fields": [
|
|
@@ -7973,6 +8326,8 @@
|
|
|
7973
8326
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
7974
8327
|
},
|
|
7975
8328
|
"x-displayname": "Pending",
|
|
8329
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
8330
|
+
"x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.",
|
|
7976
8331
|
"x-f5xc-required-for": {
|
|
7977
8332
|
"minimum_config": false,
|
|
7978
8333
|
"create": false,
|
|
@@ -7984,6 +8339,7 @@
|
|
|
7984
8339
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
7985
8340
|
}
|
|
7986
8341
|
},
|
|
8342
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
7987
8343
|
"x-f5xc-minimum-configuration": {
|
|
7988
8344
|
"description": "Minimum configuration for schemaInitializersType",
|
|
7989
8345
|
"required_fields": [
|
|
@@ -8022,6 +8378,8 @@
|
|
|
8022
8378
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
8023
8379
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
8024
8380
|
},
|
|
8381
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
8382
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
8025
8383
|
"x-f5xc-required-for": {
|
|
8026
8384
|
"minimum_config": false,
|
|
8027
8385
|
"create": false,
|
|
@@ -8043,6 +8401,7 @@
|
|
|
8043
8401
|
"x-validation-rules": {
|
|
8044
8402
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
8045
8403
|
},
|
|
8404
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
8046
8405
|
"minLength": 0,
|
|
8047
8406
|
"x-f5xc-required-for": {
|
|
8048
8407
|
"minimum_config": false,
|
|
@@ -8052,7 +8411,7 @@
|
|
|
8052
8411
|
},
|
|
8053
8412
|
"x-original-maxLength": 1200,
|
|
8054
8413
|
"x-reconciled-from-discovery": true,
|
|
8055
|
-
"x-reconciled-at": "2026-01-
|
|
8414
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278029+00:00"
|
|
8056
8415
|
},
|
|
8057
8416
|
"disable": {
|
|
8058
8417
|
"type": "boolean",
|
|
@@ -8061,6 +8420,7 @@
|
|
|
8061
8420
|
"format": "boolean",
|
|
8062
8421
|
"x-displayname": "Disable",
|
|
8063
8422
|
"x-f5xc-example": "true",
|
|
8423
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
8064
8424
|
"x-f5xc-required-for": {
|
|
8065
8425
|
"minimum_config": false,
|
|
8066
8426
|
"create": false,
|
|
@@ -8074,6 +8434,8 @@
|
|
|
8074
8434
|
"title": "Labels",
|
|
8075
8435
|
"x-displayname": "Labels",
|
|
8076
8436
|
"x-f5xc-example": "value",
|
|
8437
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
8438
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
8077
8439
|
"x-f5xc-required-for": {
|
|
8078
8440
|
"minimum_config": false,
|
|
8079
8441
|
"create": false,
|
|
@@ -8095,6 +8457,8 @@
|
|
|
8095
8457
|
"x-validation-rules": {
|
|
8096
8458
|
"ves.io.schema.rules.message.required": "true"
|
|
8097
8459
|
},
|
|
8460
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
8461
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
8098
8462
|
"minLength": 0,
|
|
8099
8463
|
"maxLength": 16,
|
|
8100
8464
|
"x-f5xc-required-for": {
|
|
@@ -8105,7 +8469,7 @@
|
|
|
8105
8469
|
},
|
|
8106
8470
|
"x-original-maxLength": 1024,
|
|
8107
8471
|
"x-reconciled-from-discovery": true,
|
|
8108
|
-
"x-reconciled-at": "2026-01-
|
|
8472
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278036+00:00"
|
|
8109
8473
|
},
|
|
8110
8474
|
"namespace": {
|
|
8111
8475
|
"type": "string",
|
|
@@ -8114,6 +8478,8 @@
|
|
|
8114
8478
|
"x-displayname": "Namespace",
|
|
8115
8479
|
"x-ves-example": "Staging",
|
|
8116
8480
|
"x-f5xc-example": "staging",
|
|
8481
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
8482
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
8117
8483
|
"minLength": 0,
|
|
8118
8484
|
"maxLength": 6,
|
|
8119
8485
|
"x-f5xc-required-for": {
|
|
@@ -8124,9 +8490,10 @@
|
|
|
8124
8490
|
},
|
|
8125
8491
|
"x-original-maxLength": 1024,
|
|
8126
8492
|
"x-reconciled-from-discovery": true,
|
|
8127
|
-
"x-reconciled-at": "2026-01-
|
|
8493
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278040+00:00"
|
|
8128
8494
|
}
|
|
8129
8495
|
},
|
|
8496
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
8130
8497
|
"x-f5xc-minimum-configuration": {
|
|
8131
8498
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
8132
8499
|
"required_fields": [
|
|
@@ -8170,6 +8537,8 @@
|
|
|
8170
8537
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
8171
8538
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
8172
8539
|
},
|
|
8540
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
8541
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
8173
8542
|
"x-f5xc-required-for": {
|
|
8174
8543
|
"minimum_config": false,
|
|
8175
8544
|
"create": false,
|
|
@@ -8191,6 +8560,7 @@
|
|
|
8191
8560
|
"x-validation-rules": {
|
|
8192
8561
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
8193
8562
|
},
|
|
8563
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
8194
8564
|
"minLength": 0,
|
|
8195
8565
|
"x-f5xc-required-for": {
|
|
8196
8566
|
"minimum_config": false,
|
|
@@ -8200,7 +8570,7 @@
|
|
|
8200
8570
|
},
|
|
8201
8571
|
"x-original-maxLength": 1200,
|
|
8202
8572
|
"x-reconciled-from-discovery": true,
|
|
8203
|
-
"x-reconciled-at": "2026-01-
|
|
8573
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278047+00:00"
|
|
8204
8574
|
},
|
|
8205
8575
|
"disable": {
|
|
8206
8576
|
"type": "boolean",
|
|
@@ -8210,6 +8580,7 @@
|
|
|
8210
8580
|
"x-displayname": "Disable",
|
|
8211
8581
|
"x-ves-example": "True",
|
|
8212
8582
|
"x-f5xc-example": "true",
|
|
8583
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
8213
8584
|
"x-f5xc-required-for": {
|
|
8214
8585
|
"minimum_config": false,
|
|
8215
8586
|
"create": false,
|
|
@@ -8224,6 +8595,8 @@
|
|
|
8224
8595
|
"x-displayname": "Labels",
|
|
8225
8596
|
"x-ves-example": "Value",
|
|
8226
8597
|
"x-f5xc-example": "value",
|
|
8598
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
8599
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
8227
8600
|
"x-f5xc-required-for": {
|
|
8228
8601
|
"minimum_config": false,
|
|
8229
8602
|
"create": false,
|
|
@@ -8245,6 +8618,8 @@
|
|
|
8245
8618
|
"x-validation-rules": {
|
|
8246
8619
|
"ves.io.schema.rules.message.required": "true"
|
|
8247
8620
|
},
|
|
8621
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
8622
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
8248
8623
|
"minLength": 0,
|
|
8249
8624
|
"maxLength": 16,
|
|
8250
8625
|
"x-f5xc-required-for": {
|
|
@@ -8255,7 +8630,7 @@
|
|
|
8255
8630
|
},
|
|
8256
8631
|
"x-original-maxLength": 1024,
|
|
8257
8632
|
"x-reconciled-from-discovery": true,
|
|
8258
|
-
"x-reconciled-at": "2026-01-
|
|
8633
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278054+00:00"
|
|
8259
8634
|
},
|
|
8260
8635
|
"namespace": {
|
|
8261
8636
|
"type": "string",
|
|
@@ -8264,6 +8639,8 @@
|
|
|
8264
8639
|
"x-displayname": "Namespace",
|
|
8265
8640
|
"x-ves-example": "Staging",
|
|
8266
8641
|
"x-f5xc-example": "staging",
|
|
8642
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
8643
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
8267
8644
|
"minLength": 0,
|
|
8268
8645
|
"maxLength": 6,
|
|
8269
8646
|
"x-f5xc-required-for": {
|
|
@@ -8274,9 +8651,10 @@
|
|
|
8274
8651
|
},
|
|
8275
8652
|
"x-original-maxLength": 1024,
|
|
8276
8653
|
"x-reconciled-from-discovery": true,
|
|
8277
|
-
"x-reconciled-at": "2026-01-
|
|
8654
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278058+00:00"
|
|
8278
8655
|
}
|
|
8279
8656
|
},
|
|
8657
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
8280
8658
|
"x-f5xc-minimum-configuration": {
|
|
8281
8659
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
8282
8660
|
"required_fields": [
|
|
@@ -8308,6 +8686,8 @@
|
|
|
8308
8686
|
"x-displayname": "Kind",
|
|
8309
8687
|
"x-ves-example": "Virtual_site.",
|
|
8310
8688
|
"x-f5xc-example": "virtual_site",
|
|
8689
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
|
|
8690
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
|
|
8311
8691
|
"minLength": 0,
|
|
8312
8692
|
"maxLength": 14,
|
|
8313
8693
|
"x-f5xc-required-for": {
|
|
@@ -8319,7 +8699,7 @@
|
|
|
8319
8699
|
"readOnly": true,
|
|
8320
8700
|
"x-original-maxLength": 1024,
|
|
8321
8701
|
"x-reconciled-from-discovery": true,
|
|
8322
|
-
"x-reconciled-at": "2026-01-
|
|
8702
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278062+00:00"
|
|
8323
8703
|
},
|
|
8324
8704
|
"name": {
|
|
8325
8705
|
"type": "string",
|
|
@@ -8328,6 +8708,8 @@
|
|
|
8328
8708
|
"x-displayname": "Name",
|
|
8329
8709
|
"x-ves-example": "Contactus-route.",
|
|
8330
8710
|
"x-f5xc-example": "contactus-route",
|
|
8711
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
8712
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
8331
8713
|
"minLength": 0,
|
|
8332
8714
|
"maxLength": 16,
|
|
8333
8715
|
"x-f5xc-required-for": {
|
|
@@ -8338,7 +8720,7 @@
|
|
|
8338
8720
|
},
|
|
8339
8721
|
"x-original-maxLength": 1024,
|
|
8340
8722
|
"x-reconciled-from-discovery": true,
|
|
8341
|
-
"x-reconciled-at": "2026-01-
|
|
8723
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278066+00:00"
|
|
8342
8724
|
},
|
|
8343
8725
|
"namespace": {
|
|
8344
8726
|
"type": "string",
|
|
@@ -8347,6 +8729,8 @@
|
|
|
8347
8729
|
"x-displayname": "Namespace",
|
|
8348
8730
|
"x-ves-example": "Ns1",
|
|
8349
8731
|
"x-f5xc-example": "ns1",
|
|
8732
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
8733
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
8350
8734
|
"minLength": 0,
|
|
8351
8735
|
"maxLength": 6,
|
|
8352
8736
|
"x-f5xc-required-for": {
|
|
@@ -8357,7 +8741,7 @@
|
|
|
8357
8741
|
},
|
|
8358
8742
|
"x-original-maxLength": 1024,
|
|
8359
8743
|
"x-reconciled-from-discovery": true,
|
|
8360
|
-
"x-reconciled-at": "2026-01-
|
|
8744
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278071+00:00"
|
|
8361
8745
|
},
|
|
8362
8746
|
"tenant": {
|
|
8363
8747
|
"type": "string",
|
|
@@ -8366,6 +8750,8 @@
|
|
|
8366
8750
|
"x-displayname": "Tenant",
|
|
8367
8751
|
"x-ves-example": "Example-corp.",
|
|
8368
8752
|
"x-f5xc-example": "example-corp",
|
|
8753
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
8754
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
8369
8755
|
"minLength": 0,
|
|
8370
8756
|
"maxLength": 18,
|
|
8371
8757
|
"x-f5xc-required-for": {
|
|
@@ -8378,7 +8764,7 @@
|
|
|
8378
8764
|
"x-field-mutability": "read-only",
|
|
8379
8765
|
"x-original-maxLength": 1024,
|
|
8380
8766
|
"x-reconciled-from-discovery": true,
|
|
8381
|
-
"x-reconciled-at": "2026-01-
|
|
8767
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278075+00:00"
|
|
8382
8768
|
},
|
|
8383
8769
|
"uid": {
|
|
8384
8770
|
"type": "string",
|
|
@@ -8387,6 +8773,8 @@
|
|
|
8387
8773
|
"x-displayname": "UID",
|
|
8388
8774
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
8389
8775
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
8776
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
|
|
8777
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
|
|
8390
8778
|
"minLength": 0,
|
|
8391
8779
|
"maxLength": 36,
|
|
8392
8780
|
"x-f5xc-required-for": {
|
|
@@ -8400,9 +8788,11 @@
|
|
|
8400
8788
|
"x-original-maxLength": 1024,
|
|
8401
8789
|
"format": "uuid",
|
|
8402
8790
|
"x-reconciled-from-discovery": true,
|
|
8403
|
-
"x-reconciled-at": "2026-01-
|
|
8791
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278080+00:00"
|
|
8404
8792
|
}
|
|
8405
8793
|
},
|
|
8794
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
8795
|
+
"x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
|
|
8406
8796
|
"x-f5xc-minimum-configuration": {
|
|
8407
8797
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
8408
8798
|
"required_fields": [
|
|
@@ -8445,6 +8835,8 @@
|
|
|
8445
8835
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
8446
8836
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
8447
8837
|
},
|
|
8838
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
8839
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
8448
8840
|
"x-f5xc-required-for": {
|
|
8449
8841
|
"minimum_config": false,
|
|
8450
8842
|
"create": false,
|
|
@@ -8466,6 +8858,7 @@
|
|
|
8466
8858
|
"x-validation-rules": {
|
|
8467
8859
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
8468
8860
|
},
|
|
8861
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
8469
8862
|
"minLength": 0,
|
|
8470
8863
|
"x-f5xc-required-for": {
|
|
8471
8864
|
"minimum_config": false,
|
|
@@ -8475,7 +8868,7 @@
|
|
|
8475
8868
|
},
|
|
8476
8869
|
"x-original-maxLength": 1200,
|
|
8477
8870
|
"x-reconciled-from-discovery": true,
|
|
8478
|
-
"x-reconciled-at": "2026-01-
|
|
8871
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278087+00:00"
|
|
8479
8872
|
},
|
|
8480
8873
|
"disable": {
|
|
8481
8874
|
"type": "boolean",
|
|
@@ -8484,6 +8877,7 @@
|
|
|
8484
8877
|
"format": "boolean",
|
|
8485
8878
|
"x-displayname": "Disable",
|
|
8486
8879
|
"x-f5xc-example": "true",
|
|
8880
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
8487
8881
|
"x-f5xc-required-for": {
|
|
8488
8882
|
"minimum_config": false,
|
|
8489
8883
|
"create": false,
|
|
@@ -8498,6 +8892,8 @@
|
|
|
8498
8892
|
"x-displayname": "Labels",
|
|
8499
8893
|
"x-ves-example": "Value",
|
|
8500
8894
|
"x-f5xc-example": "value",
|
|
8895
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
8896
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
8501
8897
|
"x-f5xc-required-for": {
|
|
8502
8898
|
"minimum_config": false,
|
|
8503
8899
|
"create": false,
|
|
@@ -8518,6 +8914,8 @@
|
|
|
8518
8914
|
"x-validation-rules": {
|
|
8519
8915
|
"ves.io.schema.rules.message.required": "true"
|
|
8520
8916
|
},
|
|
8917
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
8918
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
8521
8919
|
"minLength": 0,
|
|
8522
8920
|
"maxLength": 16,
|
|
8523
8921
|
"x-f5xc-required-for": {
|
|
@@ -8528,7 +8926,7 @@
|
|
|
8528
8926
|
},
|
|
8529
8927
|
"x-original-maxLength": 1024,
|
|
8530
8928
|
"x-reconciled-from-discovery": true,
|
|
8531
|
-
"x-reconciled-at": "2026-01-
|
|
8929
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278095+00:00"
|
|
8532
8930
|
},
|
|
8533
8931
|
"namespace": {
|
|
8534
8932
|
"type": "string",
|
|
@@ -8537,6 +8935,8 @@
|
|
|
8537
8935
|
"x-displayname": "Namespace",
|
|
8538
8936
|
"x-ves-example": "Staging",
|
|
8539
8937
|
"x-f5xc-example": "staging",
|
|
8938
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
8939
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
8540
8940
|
"minLength": 0,
|
|
8541
8941
|
"maxLength": 6,
|
|
8542
8942
|
"x-f5xc-required-for": {
|
|
@@ -8547,9 +8947,10 @@
|
|
|
8547
8947
|
},
|
|
8548
8948
|
"x-original-maxLength": 1024,
|
|
8549
8949
|
"x-reconciled-from-discovery": true,
|
|
8550
|
-
"x-reconciled-at": "2026-01-
|
|
8950
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278099+00:00"
|
|
8551
8951
|
}
|
|
8552
8952
|
},
|
|
8953
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
8553
8954
|
"x-f5xc-minimum-configuration": {
|
|
8554
8955
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
8555
8956
|
"required_fields": [
|
|
@@ -8580,6 +8981,8 @@
|
|
|
8580
8981
|
"title": "Creation_timestamp.",
|
|
8581
8982
|
"format": "date-time",
|
|
8582
8983
|
"x-displayname": "Creation Timestamp.",
|
|
8984
|
+
"x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
8985
|
+
"x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
8583
8986
|
"minLength": 0,
|
|
8584
8987
|
"maxLength": 1024,
|
|
8585
8988
|
"x-f5xc-required-for": {
|
|
@@ -8597,6 +9000,8 @@
|
|
|
8597
9000
|
"x-displayname": "Creator Class.",
|
|
8598
9001
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
8599
9002
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
9003
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
9004
|
+
"x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.",
|
|
8600
9005
|
"minLength": 0,
|
|
8601
9006
|
"maxLength": 1024,
|
|
8602
9007
|
"x-f5xc-required-for": {
|
|
@@ -8614,6 +9019,8 @@
|
|
|
8614
9019
|
"x-displayname": "Creator ID.",
|
|
8615
9020
|
"x-ves-example": "Ver-instance-1.",
|
|
8616
9021
|
"x-f5xc-example": "ver-instance-1",
|
|
9022
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
9023
|
+
"x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.",
|
|
8617
9024
|
"minLength": 0,
|
|
8618
9025
|
"maxLength": 1024,
|
|
8619
9026
|
"x-f5xc-required-for": {
|
|
@@ -8632,6 +9039,8 @@
|
|
|
8632
9039
|
"description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)",
|
|
8633
9040
|
"title": "Status_id",
|
|
8634
9041
|
"x-displayname": "Status ID",
|
|
9042
|
+
"x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...",
|
|
9043
|
+
"x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).",
|
|
8635
9044
|
"minLength": 0,
|
|
8636
9045
|
"maxLength": 1024,
|
|
8637
9046
|
"x-f5xc-required-for": {
|
|
@@ -8649,6 +9058,7 @@
|
|
|
8649
9058
|
"x-displayname": "UID",
|
|
8650
9059
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
8651
9060
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
9061
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
8652
9062
|
"minLength": 0,
|
|
8653
9063
|
"maxLength": 36,
|
|
8654
9064
|
"x-f5xc-required-for": {
|
|
@@ -8661,13 +9071,14 @@
|
|
|
8661
9071
|
"x-original-maxLength": 1024,
|
|
8662
9072
|
"format": "uuid",
|
|
8663
9073
|
"x-reconciled-from-discovery": true,
|
|
8664
|
-
"x-reconciled-at": "2026-01-
|
|
9074
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278112+00:00"
|
|
8665
9075
|
},
|
|
8666
9076
|
"vtrp_id": {
|
|
8667
9077
|
"type": "string",
|
|
8668
9078
|
"description": "Origin of this status exchanged by VTRP.",
|
|
8669
9079
|
"title": "Vtrp_id",
|
|
8670
9080
|
"x-displayname": "VTRP ID",
|
|
9081
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
8671
9082
|
"minLength": 0,
|
|
8672
9083
|
"maxLength": 1024,
|
|
8673
9084
|
"x-f5xc-required-for": {
|
|
@@ -8684,6 +9095,7 @@
|
|
|
8684
9095
|
"title": "Vtrp_stale.",
|
|
8685
9096
|
"format": "boolean",
|
|
8686
9097
|
"x-displayname": "VTRP Stale.",
|
|
9098
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
8687
9099
|
"x-f5xc-required-for": {
|
|
8688
9100
|
"minimum_config": false,
|
|
8689
9101
|
"create": false,
|
|
@@ -8692,6 +9104,7 @@
|
|
|
8692
9104
|
}
|
|
8693
9105
|
}
|
|
8694
9106
|
},
|
|
9107
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
8695
9108
|
"x-f5xc-minimum-configuration": {
|
|
8696
9109
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
8697
9110
|
"required_fields": [
|
|
@@ -8722,6 +9135,8 @@
|
|
|
8722
9135
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
8723
9136
|
"x-displayname": "Status Publish Type.",
|
|
8724
9137
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
9138
|
+
"x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.",
|
|
9139
|
+
"x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.",
|
|
8725
9140
|
"x-f5xc-minimum-configuration": {
|
|
8726
9141
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
8727
9142
|
"required_fields": [],
|
|
@@ -8747,6 +9162,7 @@
|
|
|
8747
9162
|
"x-displayname": "Code",
|
|
8748
9163
|
"x-ves-example": "0",
|
|
8749
9164
|
"x-f5xc-example": "0",
|
|
9165
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
8750
9166
|
"minimum": 0,
|
|
8751
9167
|
"maximum": 2147483647,
|
|
8752
9168
|
"x-f5xc-required-for": {
|
|
@@ -8763,6 +9179,8 @@
|
|
|
8763
9179
|
"x-displayname": "Reason",
|
|
8764
9180
|
"x-ves-example": "Value",
|
|
8765
9181
|
"x-f5xc-example": "value",
|
|
9182
|
+
"x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
9183
|
+
"x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
8766
9184
|
"minLength": 0,
|
|
8767
9185
|
"maxLength": 43,
|
|
8768
9186
|
"x-f5xc-required-for": {
|
|
@@ -8773,7 +9191,7 @@
|
|
|
8773
9191
|
},
|
|
8774
9192
|
"x-original-maxLength": 1024,
|
|
8775
9193
|
"x-reconciled-from-discovery": true,
|
|
8776
|
-
"x-reconciled-at": "2026-01-
|
|
9194
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278121+00:00"
|
|
8777
9195
|
},
|
|
8778
9196
|
"status": {
|
|
8779
9197
|
"type": "string",
|
|
@@ -8782,6 +9200,7 @@
|
|
|
8782
9200
|
"x-displayname": "Status",
|
|
8783
9201
|
"x-ves-example": "Value",
|
|
8784
9202
|
"x-f5xc-example": "value",
|
|
9203
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
8785
9204
|
"minLength": 0,
|
|
8786
9205
|
"maxLength": 17,
|
|
8787
9206
|
"x-f5xc-required-for": {
|
|
@@ -8792,9 +9211,10 @@
|
|
|
8792
9211
|
},
|
|
8793
9212
|
"x-original-maxLength": 1024,
|
|
8794
9213
|
"x-reconciled-from-discovery": true,
|
|
8795
|
-
"x-reconciled-at": "2026-01-
|
|
9214
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278125+00:00"
|
|
8796
9215
|
}
|
|
8797
9216
|
},
|
|
9217
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
8798
9218
|
"x-f5xc-minimum-configuration": {
|
|
8799
9219
|
"description": "Minimum configuration for schemaStatusType",
|
|
8800
9220
|
"required_fields": [
|
|
@@ -8822,6 +9242,8 @@
|
|
|
8822
9242
|
"title": "Creation_timestamp.",
|
|
8823
9243
|
"format": "date-time",
|
|
8824
9244
|
"x-displayname": "Creation Timestamp.",
|
|
9245
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
9246
|
+
"x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.",
|
|
8825
9247
|
"minLength": 0,
|
|
8826
9248
|
"maxLength": 1024,
|
|
8827
9249
|
"x-f5xc-required-for": {
|
|
@@ -8839,6 +9261,7 @@
|
|
|
8839
9261
|
"x-displayname": "Creator Class.",
|
|
8840
9262
|
"x-ves-example": "Prism",
|
|
8841
9263
|
"x-f5xc-example": "value",
|
|
9264
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
8842
9265
|
"minLength": 0,
|
|
8843
9266
|
"maxLength": 1024,
|
|
8844
9267
|
"x-f5xc-required-for": {
|
|
@@ -8856,6 +9279,7 @@
|
|
|
8856
9279
|
"x-displayname": "Creator ID.",
|
|
8857
9280
|
"x-ves-example": "Admin@example-corp.com.",
|
|
8858
9281
|
"x-f5xc-example": "value",
|
|
9282
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
8859
9283
|
"minLength": 0,
|
|
8860
9284
|
"maxLength": 1024,
|
|
8861
9285
|
"x-f5xc-required-for": {
|
|
@@ -8872,6 +9296,8 @@
|
|
|
8872
9296
|
"title": "Deletion_timestamp.",
|
|
8873
9297
|
"format": "date-time",
|
|
8874
9298
|
"x-displayname": "Deletion Timestamp.",
|
|
9299
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
9300
|
+
"x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...",
|
|
8875
9301
|
"minLength": 0,
|
|
8876
9302
|
"maxLength": 1024,
|
|
8877
9303
|
"x-f5xc-required-for": {
|
|
@@ -8891,6 +9317,8 @@
|
|
|
8891
9317
|
"x-displayname": "Finalizers.",
|
|
8892
9318
|
"x-ves-example": "Value",
|
|
8893
9319
|
"x-f5xc-example": "value",
|
|
9320
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
9321
|
+
"x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.",
|
|
8894
9322
|
"x-f5xc-required-for": {
|
|
8895
9323
|
"minimum_config": false,
|
|
8896
9324
|
"create": false,
|
|
@@ -8908,6 +9336,8 @@
|
|
|
8908
9336
|
"x-displayname": "Labels",
|
|
8909
9337
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
8910
9338
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
9339
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.",
|
|
9340
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).",
|
|
8911
9341
|
"x-f5xc-required-for": {
|
|
8912
9342
|
"minimum_config": false,
|
|
8913
9343
|
"create": false,
|
|
@@ -8921,6 +9351,8 @@
|
|
|
8921
9351
|
"title": "Modification_timestamp.",
|
|
8922
9352
|
"format": "date-time",
|
|
8923
9353
|
"x-displayname": "Modification Timestamp.",
|
|
9354
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
9355
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
8924
9356
|
"minLength": 0,
|
|
8925
9357
|
"maxLength": 1024,
|
|
8926
9358
|
"x-f5xc-required-for": {
|
|
@@ -8939,6 +9371,8 @@
|
|
|
8939
9371
|
"x-displayname": "Object Index.",
|
|
8940
9372
|
"x-ves-example": "0",
|
|
8941
9373
|
"x-f5xc-example": "0",
|
|
9374
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
9375
|
+
"x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.",
|
|
8942
9376
|
"minimum": 0,
|
|
8943
9377
|
"maximum": 2147483647,
|
|
8944
9378
|
"x-f5xc-required-for": {
|
|
@@ -8959,6 +9393,8 @@
|
|
|
8959
9393
|
"x-displayname": "Tenant",
|
|
8960
9394
|
"x-ves-example": "Example-corp.",
|
|
8961
9395
|
"x-f5xc-example": "example-corp",
|
|
9396
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
9397
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
8962
9398
|
"minLength": 0,
|
|
8963
9399
|
"maxLength": 18,
|
|
8964
9400
|
"x-f5xc-required-for": {
|
|
@@ -8970,7 +9406,7 @@
|
|
|
8970
9406
|
"x-field-mutability": "read-only",
|
|
8971
9407
|
"x-original-maxLength": 1024,
|
|
8972
9408
|
"x-reconciled-from-discovery": true,
|
|
8973
|
-
"x-reconciled-at": "2026-01-
|
|
9409
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278143+00:00"
|
|
8974
9410
|
},
|
|
8975
9411
|
"uid": {
|
|
8976
9412
|
"type": "string",
|
|
@@ -8979,6 +9415,8 @@
|
|
|
8979
9415
|
"x-displayname": "UID",
|
|
8980
9416
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
8981
9417
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
9418
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
9419
|
+
"x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.",
|
|
8982
9420
|
"minLength": 0,
|
|
8983
9421
|
"maxLength": 36,
|
|
8984
9422
|
"x-f5xc-required-for": {
|
|
@@ -8991,9 +9429,11 @@
|
|
|
8991
9429
|
"x-original-maxLength": 1024,
|
|
8992
9430
|
"format": "uuid",
|
|
8993
9431
|
"x-reconciled-from-discovery": true,
|
|
8994
|
-
"x-reconciled-at": "2026-01-
|
|
9432
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278148+00:00"
|
|
8995
9433
|
}
|
|
8996
9434
|
},
|
|
9435
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
9436
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
8997
9437
|
"x-f5xc-minimum-configuration": {
|
|
8998
9438
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
8999
9439
|
"required_fields": [
|
|
@@ -9041,7 +9481,7 @@
|
|
|
9041
9481
|
},
|
|
9042
9482
|
"x-original-maxLength": 1024,
|
|
9043
9483
|
"x-reconciled-from-discovery": true,
|
|
9044
|
-
"x-reconciled-at": "2026-01-
|
|
9484
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278152+00:00"
|
|
9045
9485
|
},
|
|
9046
9486
|
"name": {
|
|
9047
9487
|
"type": "string",
|
|
@@ -9050,6 +9490,8 @@
|
|
|
9050
9490
|
"x-displayname": "Name",
|
|
9051
9491
|
"x-ves-example": "Contactus-route.",
|
|
9052
9492
|
"x-f5xc-example": "contactus-route",
|
|
9493
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
9494
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
9053
9495
|
"minLength": 0,
|
|
9054
9496
|
"maxLength": 16,
|
|
9055
9497
|
"x-f5xc-required-for": {
|
|
@@ -9060,7 +9502,7 @@
|
|
|
9060
9502
|
},
|
|
9061
9503
|
"x-original-maxLength": 1024,
|
|
9062
9504
|
"x-reconciled-from-discovery": true,
|
|
9063
|
-
"x-reconciled-at": "2026-01-
|
|
9505
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278156+00:00"
|
|
9064
9506
|
},
|
|
9065
9507
|
"namespace": {
|
|
9066
9508
|
"type": "string",
|
|
@@ -9069,6 +9511,8 @@
|
|
|
9069
9511
|
"x-displayname": "Namespace",
|
|
9070
9512
|
"x-ves-example": "Ns1",
|
|
9071
9513
|
"x-f5xc-example": "ns1",
|
|
9514
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
9515
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
9072
9516
|
"minLength": 0,
|
|
9073
9517
|
"maxLength": 6,
|
|
9074
9518
|
"x-f5xc-required-for": {
|
|
@@ -9079,7 +9523,7 @@
|
|
|
9079
9523
|
},
|
|
9080
9524
|
"x-original-maxLength": 1024,
|
|
9081
9525
|
"x-reconciled-from-discovery": true,
|
|
9082
|
-
"x-reconciled-at": "2026-01-
|
|
9526
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278160+00:00"
|
|
9083
9527
|
},
|
|
9084
9528
|
"uid": {
|
|
9085
9529
|
"type": "string",
|
|
@@ -9100,9 +9544,10 @@
|
|
|
9100
9544
|
"x-original-maxLength": 1024,
|
|
9101
9545
|
"format": "uuid",
|
|
9102
9546
|
"x-reconciled-from-discovery": true,
|
|
9103
|
-
"x-reconciled-at": "2026-01-
|
|
9547
|
+
"x-reconciled-at": "2026-01-07T15:29:10.278165+00:00"
|
|
9104
9548
|
}
|
|
9105
9549
|
},
|
|
9550
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
9106
9551
|
"x-f5xc-minimum-configuration": {
|
|
9107
9552
|
"description": "Minimum configuration for schemaViewRefType",
|
|
9108
9553
|
"required_fields": [
|
|
@@ -9139,6 +9584,8 @@
|
|
|
9139
9584
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
9140
9585
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
9141
9586
|
},
|
|
9587
|
+
"x-f5xc-description-short": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g...",
|
|
9588
|
+
"x-f5xc-description-medium": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
|
|
9142
9589
|
"x-f5xc-required-for": {
|
|
9143
9590
|
"minimum_config": false,
|
|
9144
9591
|
"create": false,
|
|
@@ -9160,6 +9607,8 @@
|
|
|
9160
9607
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
9161
9608
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
9162
9609
|
},
|
|
9610
|
+
"x-f5xc-description-short": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object...",
|
|
9611
|
+
"x-f5xc-description-medium": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object kind e.g. \"virtual_host\".",
|
|
9163
9612
|
"x-f5xc-required-for": {
|
|
9164
9613
|
"minimum_config": false,
|
|
9165
9614
|
"create": false,
|
|
@@ -9181,6 +9630,8 @@
|
|
|
9181
9630
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
9182
9631
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
9183
9632
|
},
|
|
9633
|
+
"x-f5xc-description-short": "Resource Limits define maximum value of resources in the appropriate units that can be present.",
|
|
9634
|
+
"x-f5xc-description-medium": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of the resource limits is the resource name.",
|
|
9184
9635
|
"x-f5xc-required-for": {
|
|
9185
9636
|
"minimum_config": false,
|
|
9186
9637
|
"create": false,
|
|
@@ -9189,6 +9640,7 @@
|
|
|
9189
9640
|
}
|
|
9190
9641
|
}
|
|
9191
9642
|
},
|
|
9643
|
+
"x-f5xc-description-short": "Create quota creates a given object from storage backend for metadata.namespace.",
|
|
9192
9644
|
"x-f5xc-minimum-configuration": {
|
|
9193
9645
|
"description": "Minimum configuration for schemaquotaCreateSpecType",
|
|
9194
9646
|
"required_fields": [
|
|
@@ -9224,6 +9676,8 @@
|
|
|
9224
9676
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
9225
9677
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
9226
9678
|
},
|
|
9679
|
+
"x-f5xc-description-short": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g...",
|
|
9680
|
+
"x-f5xc-description-medium": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
|
|
9227
9681
|
"x-f5xc-required-for": {
|
|
9228
9682
|
"minimum_config": false,
|
|
9229
9683
|
"create": false,
|
|
@@ -9245,6 +9699,8 @@
|
|
|
9245
9699
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
9246
9700
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
9247
9701
|
},
|
|
9702
|
+
"x-f5xc-description-short": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object...",
|
|
9703
|
+
"x-f5xc-description-medium": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object kind e.g. \"virtual_host\".",
|
|
9248
9704
|
"x-f5xc-required-for": {
|
|
9249
9705
|
"minimum_config": false,
|
|
9250
9706
|
"create": false,
|
|
@@ -9266,6 +9722,8 @@
|
|
|
9266
9722
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
9267
9723
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
9268
9724
|
},
|
|
9725
|
+
"x-f5xc-description-short": "Resource Limits define maximum value of resources in the appropriate units that can be present.",
|
|
9726
|
+
"x-f5xc-description-medium": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of the resource limits is the resource name.",
|
|
9269
9727
|
"x-f5xc-required-for": {
|
|
9270
9728
|
"minimum_config": false,
|
|
9271
9729
|
"create": false,
|
|
@@ -9274,6 +9732,7 @@
|
|
|
9274
9732
|
}
|
|
9275
9733
|
}
|
|
9276
9734
|
},
|
|
9735
|
+
"x-f5xc-description-short": "GET quota reads a given object from storage backend for metadata.namespace.",
|
|
9277
9736
|
"x-f5xc-minimum-configuration": {
|
|
9278
9737
|
"description": "Minimum configuration for schemaquotaGetSpecType",
|
|
9279
9738
|
"required_fields": [
|
|
@@ -9309,6 +9768,8 @@
|
|
|
9309
9768
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
9310
9769
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
9311
9770
|
},
|
|
9771
|
+
"x-f5xc-description-short": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g...",
|
|
9772
|
+
"x-f5xc-description-medium": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
|
|
9312
9773
|
"x-f5xc-required-for": {
|
|
9313
9774
|
"minimum_config": false,
|
|
9314
9775
|
"create": false,
|
|
@@ -9330,6 +9791,8 @@
|
|
|
9330
9791
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
9331
9792
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
9332
9793
|
},
|
|
9794
|
+
"x-f5xc-description-short": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object...",
|
|
9795
|
+
"x-f5xc-description-medium": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object kind e.g. \"virtual_host\".",
|
|
9333
9796
|
"x-f5xc-required-for": {
|
|
9334
9797
|
"minimum_config": false,
|
|
9335
9798
|
"create": false,
|
|
@@ -9351,6 +9814,8 @@
|
|
|
9351
9814
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
9352
9815
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
9353
9816
|
},
|
|
9817
|
+
"x-f5xc-description-short": "Resource Limits define maximum value of resources in the appropriate units that can be present.",
|
|
9818
|
+
"x-f5xc-description-medium": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of the resource limits is the resource name.",
|
|
9354
9819
|
"x-f5xc-required-for": {
|
|
9355
9820
|
"minimum_config": false,
|
|
9356
9821
|
"create": false,
|
|
@@ -9359,6 +9824,7 @@
|
|
|
9359
9824
|
}
|
|
9360
9825
|
}
|
|
9361
9826
|
},
|
|
9827
|
+
"x-f5xc-description-short": "Replace quota updates a given object from storage backend for metadata.namespace.",
|
|
9362
9828
|
"x-f5xc-minimum-configuration": {
|
|
9363
9829
|
"description": "Minimum configuration for schemaquotaReplaceSpecType",
|
|
9364
9830
|
"required_fields": [
|
|
@@ -9383,6 +9849,7 @@
|
|
|
9383
9849
|
"description": "X-displayName: \"Current\"\nThe in-use value.",
|
|
9384
9850
|
"title": "Current",
|
|
9385
9851
|
"format": "double",
|
|
9852
|
+
"x-f5xc-description-short": "X-displayName: \"Current\" The in-use value.",
|
|
9386
9853
|
"x-f5xc-required-for": {
|
|
9387
9854
|
"minimum_config": false,
|
|
9388
9855
|
"create": false,
|
|
@@ -9391,6 +9858,8 @@
|
|
|
9391
9858
|
}
|
|
9392
9859
|
}
|
|
9393
9860
|
},
|
|
9861
|
+
"x-f5xc-description-short": "X-displayName: \"Usage (float)\" FloatUsageType defines the usage in float. Useful to report usage for items that have limits in fractions.",
|
|
9862
|
+
"x-f5xc-description-medium": "X-displayName: \"Usage (float)\" FloatUsageType defines the usage in float. Useful to report usage for items that have limits in fractions.",
|
|
9394
9863
|
"x-f5xc-minimum-configuration": {
|
|
9395
9864
|
"description": "Minimum configuration for usageFloatUsageType",
|
|
9396
9865
|
"required_fields": [
|
|
@@ -9413,6 +9882,7 @@
|
|
|
9413
9882
|
"description": "X-displayName: \"Current\"\nThe in-use value for the object kind.",
|
|
9414
9883
|
"title": "Current",
|
|
9415
9884
|
"format": "int32",
|
|
9885
|
+
"x-f5xc-description-short": "X-displayName: \"Current\" The in-use value for the object kind.",
|
|
9416
9886
|
"minimum": 0,
|
|
9417
9887
|
"maximum": 2147483647,
|
|
9418
9888
|
"x-f5xc-required-for": {
|
|
@@ -9423,6 +9893,8 @@
|
|
|
9423
9893
|
}
|
|
9424
9894
|
}
|
|
9425
9895
|
},
|
|
9896
|
+
"x-f5xc-description-short": "X-displayName: \"Usage\" UsageType defines the number of objects of a specific object kind that are currently in use.",
|
|
9897
|
+
"x-f5xc-description-medium": "X-displayName: \"Usage\" UsageType defines the number of objects of a specific object kind that are currently in use.",
|
|
9426
9898
|
"x-f5xc-minimum-configuration": {
|
|
9427
9899
|
"description": "Minimum configuration for usageUsageType",
|
|
9428
9900
|
"required_fields": [
|
|
@@ -9447,6 +9919,7 @@
|
|
|
9447
9919
|
"items": {
|
|
9448
9920
|
"$ref": "#/components/schemas/subscriptionSubscriptionType"
|
|
9449
9921
|
},
|
|
9922
|
+
"description": "IP address configuration",
|
|
9450
9923
|
"x-f5xc-required-for": {
|
|
9451
9924
|
"minimum_config": false,
|
|
9452
9925
|
"create": false,
|
|
@@ -9455,6 +9928,7 @@
|
|
|
9455
9928
|
}
|
|
9456
9929
|
}
|
|
9457
9930
|
},
|
|
9931
|
+
"x-f5xc-description-short": "Response to call to GET list of tenant subscriptions.",
|
|
9458
9932
|
"x-f5xc-minimum-configuration": {
|
|
9459
9933
|
"description": "Minimum configuration for subscriptionListSubscriptionsRsp",
|
|
9460
9934
|
"required_fields": [
|
|
@@ -9497,6 +9971,7 @@
|
|
|
9497
9971
|
"x-displayname": "End date",
|
|
9498
9972
|
"x-ves-example": "2020-05-20T12:32:51.341959216Z.",
|
|
9499
9973
|
"x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
|
|
9974
|
+
"x-f5xc-description-short": "Kast day of the last billing_period in external provider.",
|
|
9500
9975
|
"minLength": 0,
|
|
9501
9976
|
"maxLength": 1024,
|
|
9502
9977
|
"x-f5xc-required-for": {
|
|
@@ -9514,6 +9989,7 @@
|
|
|
9514
9989
|
"x-displayname": "Internal end date.",
|
|
9515
9990
|
"x-ves-example": "2020-05-20T12:32:51.341959216Z.",
|
|
9516
9991
|
"x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
|
|
9992
|
+
"x-f5xc-description-short": "Internal end date that serves as source of truth.",
|
|
9517
9993
|
"minLength": 0,
|
|
9518
9994
|
"maxLength": 1024,
|
|
9519
9995
|
"x-f5xc-required-for": {
|
|
@@ -9531,6 +10007,7 @@
|
|
|
9531
10007
|
"x-displayname": "Internal start date.",
|
|
9532
10008
|
"x-ves-example": "2020-05-20T12:32:51.341959216Z.",
|
|
9533
10009
|
"x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
|
|
10010
|
+
"x-f5xc-description-short": "Internal start date that serves as source of truth.",
|
|
9534
10011
|
"minLength": 0,
|
|
9535
10012
|
"maxLength": 1024,
|
|
9536
10013
|
"x-f5xc-required-for": {
|
|
@@ -9548,6 +10025,7 @@
|
|
|
9548
10025
|
"type": "string"
|
|
9549
10026
|
},
|
|
9550
10027
|
"x-displayname": "Invoices",
|
|
10028
|
+
"x-f5xc-description-short": "Link to all of the invoices for this period.",
|
|
9551
10029
|
"x-f5xc-required-for": {
|
|
9552
10030
|
"minimum_config": false,
|
|
9553
10031
|
"create": false,
|
|
@@ -9578,6 +10056,7 @@
|
|
|
9578
10056
|
"x-displayname": "Start date.",
|
|
9579
10057
|
"x-ves-example": "2020-05-20T12:32:51.341959216Z.",
|
|
9580
10058
|
"x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
|
|
10059
|
+
"x-f5xc-description-short": "The first day of the last billing_period in external provider.",
|
|
9581
10060
|
"minLength": 0,
|
|
9582
10061
|
"maxLength": 1024,
|
|
9583
10062
|
"x-f5xc-required-for": {
|
|
@@ -9593,6 +10072,7 @@
|
|
|
9593
10072
|
"title": "Trial",
|
|
9594
10073
|
"format": "boolean",
|
|
9595
10074
|
"x-displayname": "Trial",
|
|
10075
|
+
"x-f5xc-description-short": "Flag shows if this billing time frame is part of trial period.",
|
|
9596
10076
|
"x-f5xc-required-for": {
|
|
9597
10077
|
"minimum_config": false,
|
|
9598
10078
|
"create": false,
|
|
@@ -9619,9 +10099,10 @@
|
|
|
9619
10099
|
"x-original-maxLength": 1024,
|
|
9620
10100
|
"format": "uuid",
|
|
9621
10101
|
"x-reconciled-from-discovery": true,
|
|
9622
|
-
"x-reconciled-at": "2026-01-
|
|
10102
|
+
"x-reconciled-at": "2026-01-07T15:29:28.533308+00:00"
|
|
9623
10103
|
}
|
|
9624
10104
|
},
|
|
10105
|
+
"x-f5xc-description-short": "Response to call to GET list of tenant subscriptions.",
|
|
9625
10106
|
"x-f5xc-minimum-configuration": {
|
|
9626
10107
|
"description": "Minimum configuration for subscriptionPeriod",
|
|
9627
10108
|
"required_fields": [
|
|
@@ -9657,6 +10138,7 @@
|
|
|
9657
10138
|
"x-displayname": "Cancellation date.",
|
|
9658
10139
|
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
|
|
9659
10140
|
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
|
|
10141
|
+
"x-f5xc-description-short": "Date when subscription become cancelled.",
|
|
9660
10142
|
"minLength": 0,
|
|
9661
10143
|
"maxLength": 1024,
|
|
9662
10144
|
"x-f5xc-required-for": {
|
|
@@ -9672,6 +10154,7 @@
|
|
|
9672
10154
|
"title": "Cancelled",
|
|
9673
10155
|
"format": "boolean",
|
|
9674
10156
|
"x-displayname": "Cancelled",
|
|
10157
|
+
"x-f5xc-description-short": "Flag shows if this subscription is already cancelled.",
|
|
9675
10158
|
"x-f5xc-required-for": {
|
|
9676
10159
|
"minimum_config": false,
|
|
9677
10160
|
"create": false,
|
|
@@ -9685,6 +10168,7 @@
|
|
|
9685
10168
|
"title": "Current",
|
|
9686
10169
|
"format": "boolean",
|
|
9687
10170
|
"x-displayname": "Current",
|
|
10171
|
+
"x-f5xc-description-short": "Flag shows if this subscription is currently active.",
|
|
9688
10172
|
"x-f5xc-required-for": {
|
|
9689
10173
|
"minimum_config": false,
|
|
9690
10174
|
"create": false,
|
|
@@ -9700,6 +10184,7 @@
|
|
|
9700
10184
|
"x-displayname": "Billing period end date.",
|
|
9701
10185
|
"x-ves-example": "2020-05-20T12:32:51.341959216Z.",
|
|
9702
10186
|
"x-f5xc-example": "2020-05-20T12:32:51.341959216Z",
|
|
10187
|
+
"x-f5xc-description-short": "The last day of the last billing_period.",
|
|
9703
10188
|
"minLength": 0,
|
|
9704
10189
|
"maxLength": 1024,
|
|
9705
10190
|
"x-f5xc-required-for": {
|
|
@@ -9717,6 +10202,7 @@
|
|
|
9717
10202
|
"x-displayname": "Billing period start date.",
|
|
9718
10203
|
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
|
|
9719
10204
|
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
|
|
10205
|
+
"x-f5xc-description-short": "The first day of the last billing_period.",
|
|
9720
10206
|
"minLength": 0,
|
|
9721
10207
|
"maxLength": 1024,
|
|
9722
10208
|
"x-f5xc-required-for": {
|
|
@@ -9733,6 +10219,8 @@
|
|
|
9733
10219
|
"x-displayname": "Name",
|
|
9734
10220
|
"x-ves-example": "Sub-name-2e170678-4f50-4336-8af9-5413e9bdf250.",
|
|
9735
10221
|
"x-f5xc-example": "sub-name-2e170678-4f50-4336-8af9-5413e9bdf250",
|
|
10222
|
+
"x-f5xc-description-short": "Name of the subscription (internal name, not human readable), a subscription has no human readable name.",
|
|
10223
|
+
"x-f5xc-description-medium": "Name of the subscription (internal name, not human readable), a subscription has no human readable name.",
|
|
9736
10224
|
"minLength": 0,
|
|
9737
10225
|
"maxLength": 16,
|
|
9738
10226
|
"x-f5xc-required-for": {
|
|
@@ -9743,7 +10231,7 @@
|
|
|
9743
10231
|
},
|
|
9744
10232
|
"x-original-maxLength": 1024,
|
|
9745
10233
|
"x-reconciled-from-discovery": true,
|
|
9746
|
-
"x-reconciled-at": "2026-01-
|
|
10234
|
+
"x-reconciled-at": "2026-01-07T15:29:28.533323+00:00"
|
|
9747
10235
|
},
|
|
9748
10236
|
"plan_name": {
|
|
9749
10237
|
"type": "string",
|
|
@@ -9810,6 +10298,7 @@
|
|
|
9810
10298
|
}
|
|
9811
10299
|
}
|
|
9812
10300
|
},
|
|
10301
|
+
"x-f5xc-description-short": "Tenant subscription to the services record.",
|
|
9813
10302
|
"x-f5xc-minimum-configuration": {
|
|
9814
10303
|
"description": "Minimum configuration for subscriptionSubscriptionType",
|
|
9815
10304
|
"required_fields": [
|
|
@@ -9837,6 +10326,7 @@
|
|
|
9837
10326
|
"title": "Empty",
|
|
9838
10327
|
"x-displayname": "Empty",
|
|
9839
10328
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
10329
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
9840
10330
|
"x-f5xc-minimum-configuration": {
|
|
9841
10331
|
"description": "Minimum configuration for schemaEmpty",
|
|
9842
10332
|
"required_fields": [],
|
|
@@ -9895,6 +10385,7 @@
|
|
|
9895
10385
|
"$ref": "#/components/schemas/schemaEmpty"
|
|
9896
10386
|
}
|
|
9897
10387
|
},
|
|
10388
|
+
"x-f5xc-description-short": "Request to subscribe to one of addon services.",
|
|
9898
10389
|
"x-f5xc-minimum-configuration": {
|
|
9899
10390
|
"description": "Minimum configuration for subscriptionSubscribeRequest",
|
|
9900
10391
|
"required_fields": [
|
|
@@ -9983,6 +10474,7 @@
|
|
|
9983
10474
|
"$ref": "#/components/schemas/schemaEmpty"
|
|
9984
10475
|
}
|
|
9985
10476
|
},
|
|
10477
|
+
"x-f5xc-description-short": "Request to unsubscribe to one of addon services.",
|
|
9986
10478
|
"x-f5xc-minimum-configuration": {
|
|
9987
10479
|
"description": "Minimum configuration for subscriptionUnsubscribeRequest",
|
|
9988
10480
|
"required_fields": [
|
|
@@ -10036,6 +10528,8 @@
|
|
|
10036
10528
|
"default": "STATUS_UNKNOWN",
|
|
10037
10529
|
"x-displayname": "Status type.",
|
|
10038
10530
|
"x-ves-proto-enum": "ves.io.schema.usage.StatusType",
|
|
10531
|
+
"x-f5xc-description-short": "All possible usage line statuses - STATUS_UNKNOWN: No value defined - STATUS_NO_DATA: No data - STATUS_NOT_MEASURED: No measured - STATUS_ACTIVE...",
|
|
10532
|
+
"x-f5xc-description-medium": "All possible usage line statuses - STATUS_UNKNOWN: No value defined - STATUS_NO_DATA: No data - STATUS_NOT_MEASURED: No measured - STATUS_ACTIVE: Active.",
|
|
10039
10533
|
"x-f5xc-minimum-configuration": {
|
|
10040
10534
|
"description": "Minimum configuration for schemausageStatusType",
|
|
10041
10535
|
"required_fields": [],
|
|
@@ -10109,6 +10603,7 @@
|
|
|
10109
10603
|
"title": "Fixed",
|
|
10110
10604
|
"format": "boolean",
|
|
10111
10605
|
"x-displayname": "Fixes",
|
|
10606
|
+
"x-f5xc-description-short": "Means that this data came not from usage (reserved flag for support/discount/onboarding fees).",
|
|
10112
10607
|
"x-f5xc-required-for": {
|
|
10113
10608
|
"minimum_config": false,
|
|
10114
10609
|
"create": false,
|
|
@@ -10126,6 +10621,8 @@
|
|
|
10126
10621
|
"x-displayname": "Metric labels.",
|
|
10127
10622
|
"x-ves-example": "['container-usage-large', 'container-usage-medium']",
|
|
10128
10623
|
"x-f5xc-example": "['container-usage-large', 'container-usage-medium']",
|
|
10624
|
+
"x-f5xc-description-short": "ID of the corresponding aggregated_usage metric labels from which this calculated usage item is assembled.",
|
|
10625
|
+
"x-f5xc-description-medium": "ID of the corresponding aggregated_usage metric labels from which this calculated usage item is assembled.",
|
|
10129
10626
|
"x-f5xc-required-for": {
|
|
10130
10627
|
"minimum_config": false,
|
|
10131
10628
|
"create": false,
|
|
@@ -10155,6 +10652,8 @@
|
|
|
10155
10652
|
"format": "int64",
|
|
10156
10653
|
"x-displayname": "Quantity billable.",
|
|
10157
10654
|
"x-f5xc-example": "115",
|
|
10655
|
+
"x-f5xc-description-short": "Quantity which is used to calculate the amount.",
|
|
10656
|
+
"x-f5xc-description-medium": "Quantity which is used to calculate the amount. Rounded from quantity as the following: * after converting quantity from unit_code to unit_code of this addon_id, if the value < 1, then quantity_billable is rounded to 1 * after converting quantity from unit_code to unit_code of this addon_id, if...",
|
|
10158
10657
|
"minLength": 0,
|
|
10159
10658
|
"maxLength": 1024,
|
|
10160
10659
|
"x-f5xc-required-for": {
|
|
@@ -10206,6 +10705,7 @@
|
|
|
10206
10705
|
"title": "Unit name billable.",
|
|
10207
10706
|
"x-displayname": "Unit name billable.",
|
|
10208
10707
|
"x-f5xc-example": "GB",
|
|
10708
|
+
"x-f5xc-description-short": "Unit name a quantity_billable is provided in.",
|
|
10209
10709
|
"minLength": 0,
|
|
10210
10710
|
"maxLength": 1024,
|
|
10211
10711
|
"x-f5xc-required-for": {
|
|
@@ -10232,6 +10732,7 @@
|
|
|
10232
10732
|
}
|
|
10233
10733
|
}
|
|
10234
10734
|
},
|
|
10735
|
+
"x-f5xc-description-short": "One line of usage, including pricing details.",
|
|
10235
10736
|
"x-f5xc-minimum-configuration": {
|
|
10236
10737
|
"description": "Minimum configuration for usageCalculatedUsageItem",
|
|
10237
10738
|
"required_fields": [
|
|
@@ -10277,6 +10778,8 @@
|
|
|
10277
10778
|
"x-validation-rules": {
|
|
10278
10779
|
"ves.io.schema.rules.message.required": "true"
|
|
10279
10780
|
},
|
|
10781
|
+
"x-f5xc-description-short": "[x-required] If discount_type is fixed_amount, discount_amount is in cents If discount_type is percentage, discount_amount is in percentages of...",
|
|
10782
|
+
"x-f5xc-description-medium": "[x-required] If discount_type is fixed_amount, discount_amount is in cents If discount_type is percentage, discount_amount is in percentages of 0.01% precision (12.35% equals to 1235).",
|
|
10280
10783
|
"minimum": 0,
|
|
10281
10784
|
"maximum": 2147483647,
|
|
10282
10785
|
"x-f5xc-required-for": {
|
|
@@ -10306,9 +10809,10 @@
|
|
|
10306
10809
|
},
|
|
10307
10810
|
"x-original-maxLength": 1024,
|
|
10308
10811
|
"x-reconciled-from-discovery": true,
|
|
10309
|
-
"x-reconciled-at": "2026-01-
|
|
10812
|
+
"x-reconciled-at": "2026-01-07T15:29:38.185936+00:00"
|
|
10310
10813
|
}
|
|
10311
10814
|
},
|
|
10815
|
+
"x-f5xc-description-short": "Coupon details, discount type, amount and name.",
|
|
10312
10816
|
"x-f5xc-minimum-configuration": {
|
|
10313
10817
|
"description": "Minimum configuration for usageCoupon",
|
|
10314
10818
|
"required_fields": [
|
|
@@ -10335,6 +10839,8 @@
|
|
|
10335
10839
|
"default": "DISCOUNT_TYPE_UNKNOWN",
|
|
10336
10840
|
"x-displayname": "Discount type.",
|
|
10337
10841
|
"x-ves-proto-enum": "ves.io.schema.usage.DiscountType",
|
|
10842
|
+
"x-f5xc-description-short": "Indicates what type of discount is applied for a coupon: fixed price or percentage.",
|
|
10843
|
+
"x-f5xc-description-medium": "Indicates what type of discount is applied for a coupon: fixed price or percentage. Unknown The specified amount will be given as discount. The specified percentage will be given as discount.",
|
|
10338
10844
|
"x-f5xc-minimum-configuration": {
|
|
10339
10845
|
"description": "Minimum configuration for usageDiscountType",
|
|
10340
10846
|
"required_fields": [],
|
|
@@ -10359,6 +10865,7 @@
|
|
|
10359
10865
|
"x-displayname": "Container",
|
|
10360
10866
|
"x-ves-example": "Pa4-deployment1-abcd12.",
|
|
10361
10867
|
"x-f5xc-example": "pa4-deployment1-abcd12",
|
|
10868
|
+
"x-f5xc-description-short": "Container name if this item correspond to the container usage. Otherwise it's empty.",
|
|
10362
10869
|
"minLength": 0,
|
|
10363
10870
|
"maxLength": 1024,
|
|
10364
10871
|
"x-f5xc-required-for": {
|
|
@@ -10382,6 +10889,7 @@
|
|
|
10382
10889
|
"x-validation-rules": {
|
|
10383
10890
|
"ves.io.schema.rules.message.required": "true"
|
|
10384
10891
|
},
|
|
10892
|
+
"x-f5xc-description-short": "[x-required] Deployment name if this item correspond to the container usage. Otherwise it's empty.",
|
|
10385
10893
|
"minLength": 0,
|
|
10386
10894
|
"maxLength": 1024,
|
|
10387
10895
|
"x-f5xc-required-for": {
|
|
@@ -10457,6 +10965,7 @@
|
|
|
10457
10965
|
}
|
|
10458
10966
|
}
|
|
10459
10967
|
},
|
|
10968
|
+
"x-f5xc-description-short": "One line of usage by an hour. One hour as the least resolution.",
|
|
10460
10969
|
"x-f5xc-minimum-configuration": {
|
|
10461
10970
|
"description": "Minimum configuration for usageHourlyItem",
|
|
10462
10971
|
"required_fields": [
|
|
@@ -10489,6 +10998,7 @@
|
|
|
10489
10998
|
"x-displayname": "From",
|
|
10490
10999
|
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
|
|
10491
11000
|
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
|
|
11001
|
+
"x-f5xc-description-short": "Indicates the \"from\" part of the request.",
|
|
10492
11002
|
"minLength": 0,
|
|
10493
11003
|
"maxLength": 1024,
|
|
10494
11004
|
"x-f5xc-required-for": {
|
|
@@ -10515,7 +11025,7 @@
|
|
|
10515
11025
|
},
|
|
10516
11026
|
"x-original-maxLength": 1024,
|
|
10517
11027
|
"x-reconciled-from-discovery": true,
|
|
10518
|
-
"x-reconciled-at": "2026-01-
|
|
11028
|
+
"x-reconciled-at": "2026-01-07T15:29:38.185955+00:00"
|
|
10519
11029
|
},
|
|
10520
11030
|
"to": {
|
|
10521
11031
|
"type": "string",
|
|
@@ -10535,6 +11045,7 @@
|
|
|
10535
11045
|
}
|
|
10536
11046
|
}
|
|
10537
11047
|
},
|
|
11048
|
+
"x-f5xc-description-short": "Request message to GET current usage details.",
|
|
10538
11049
|
"x-f5xc-minimum-configuration": {
|
|
10539
11050
|
"description": "Minimum configuration for usageListCurrentUsageReq",
|
|
10540
11051
|
"required_fields": [
|
|
@@ -10613,6 +11124,7 @@
|
|
|
10613
11124
|
"$ref": "#/components/schemas/usageCalculatedUsageItem"
|
|
10614
11125
|
},
|
|
10615
11126
|
"x-displayname": "Usage items.",
|
|
11127
|
+
"x-f5xc-description-short": "Collection of usage items, lines of response.",
|
|
10616
11128
|
"x-f5xc-required-for": {
|
|
10617
11129
|
"minimum_config": false,
|
|
10618
11130
|
"create": false,
|
|
@@ -10621,6 +11133,7 @@
|
|
|
10621
11133
|
}
|
|
10622
11134
|
}
|
|
10623
11135
|
},
|
|
11136
|
+
"x-f5xc-description-short": "Response message to GET current usage details.",
|
|
10624
11137
|
"x-f5xc-minimum-configuration": {
|
|
10625
11138
|
"description": "Minimum configuration for usageListCurrentUsageResp",
|
|
10626
11139
|
"required_fields": [
|
|
@@ -10660,7 +11173,7 @@
|
|
|
10660
11173
|
},
|
|
10661
11174
|
"x-original-maxLength": 1024,
|
|
10662
11175
|
"x-reconciled-from-discovery": true,
|
|
10663
|
-
"x-reconciled-at": "2026-01-
|
|
11176
|
+
"x-reconciled-at": "2026-01-07T15:29:38.185968+00:00"
|
|
10664
11177
|
},
|
|
10665
11178
|
"query": {
|
|
10666
11179
|
"type": "string",
|
|
@@ -10669,6 +11182,7 @@
|
|
|
10669
11182
|
"x-displayname": "Query",
|
|
10670
11183
|
"x-ves-example": "{'MetricLabel':'label'}",
|
|
10671
11184
|
"x-f5xc-example": "{'MetricLabel':'label'}",
|
|
11185
|
+
"x-f5xc-description-short": "Encoded query which is passed as is to barracute daemon.",
|
|
10672
11186
|
"minLength": 0,
|
|
10673
11187
|
"maxLength": 1024,
|
|
10674
11188
|
"x-f5xc-required-for": {
|
|
@@ -10679,6 +11193,7 @@
|
|
|
10679
11193
|
}
|
|
10680
11194
|
}
|
|
10681
11195
|
},
|
|
11196
|
+
"x-f5xc-description-short": "Request body for ListHourlyUsageDetails rpc method.",
|
|
10682
11197
|
"x-f5xc-minimum-configuration": {
|
|
10683
11198
|
"description": "Minimum configuration for usageListHourlyUsageDetailsReq",
|
|
10684
11199
|
"required_fields": [
|
|
@@ -10707,6 +11222,7 @@
|
|
|
10707
11222
|
"$ref": "#/components/schemas/usageHourlyItem"
|
|
10708
11223
|
},
|
|
10709
11224
|
"x-displayname": "Usage items.",
|
|
11225
|
+
"x-f5xc-description-short": "Array of usage by hour in the period from the query.",
|
|
10710
11226
|
"x-f5xc-required-for": {
|
|
10711
11227
|
"minimum_config": false,
|
|
10712
11228
|
"create": false,
|
|
@@ -10715,6 +11231,7 @@
|
|
|
10715
11231
|
}
|
|
10716
11232
|
}
|
|
10717
11233
|
},
|
|
11234
|
+
"x-f5xc-description-short": "Response body for ListHourlyUsageDetails rpc method.",
|
|
10718
11235
|
"x-f5xc-minimum-configuration": {
|
|
10719
11236
|
"description": "Minimum configuration for usageListHourlyUsageDetailsResp",
|
|
10720
11237
|
"required_fields": [
|
|
@@ -10751,9 +11268,10 @@
|
|
|
10751
11268
|
},
|
|
10752
11269
|
"x-original-maxLength": 1024,
|
|
10753
11270
|
"x-reconciled-from-discovery": true,
|
|
10754
|
-
"x-reconciled-at": "2026-01-
|
|
11271
|
+
"x-reconciled-at": "2026-01-07T15:29:38.185976+00:00"
|
|
10755
11272
|
}
|
|
10756
11273
|
},
|
|
11274
|
+
"x-f5xc-description-short": "Request message to GET mon thly usage details.",
|
|
10757
11275
|
"x-f5xc-minimum-configuration": {
|
|
10758
11276
|
"description": "Minimum configuration for usageListMonthlyUsageReq",
|
|
10759
11277
|
"required_fields": [
|
|
@@ -10781,6 +11299,7 @@
|
|
|
10781
11299
|
"$ref": "#/components/schemas/usageMonthlyUsageType"
|
|
10782
11300
|
},
|
|
10783
11301
|
"x-displayname": "Usage items.",
|
|
11302
|
+
"x-f5xc-description-short": "Collection of usage items, lines of response.",
|
|
10784
11303
|
"x-f5xc-required-for": {
|
|
10785
11304
|
"minimum_config": false,
|
|
10786
11305
|
"create": false,
|
|
@@ -10789,6 +11308,7 @@
|
|
|
10789
11308
|
}
|
|
10790
11309
|
}
|
|
10791
11310
|
},
|
|
11311
|
+
"x-f5xc-description-short": "Response message to GET monthly usage details.",
|
|
10792
11312
|
"x-f5xc-minimum-configuration": {
|
|
10793
11313
|
"description": "Minimum configuration for usageListMonthlyUsageResp",
|
|
10794
11314
|
"required_fields": [
|
|
@@ -10816,6 +11336,7 @@
|
|
|
10816
11336
|
"x-displayname": "From",
|
|
10817
11337
|
"x-ves-example": "2020-04-20T12:32:51.341959216Z.",
|
|
10818
11338
|
"x-f5xc-example": "2020-04-20T12:32:51.341959216Z",
|
|
11339
|
+
"x-f5xc-description-short": "Indicates the \"from\" part of the request.",
|
|
10819
11340
|
"minLength": 0,
|
|
10820
11341
|
"maxLength": 1024,
|
|
10821
11342
|
"x-f5xc-required-for": {
|
|
@@ -10842,7 +11363,7 @@
|
|
|
10842
11363
|
},
|
|
10843
11364
|
"x-original-maxLength": 1024,
|
|
10844
11365
|
"x-reconciled-from-discovery": true,
|
|
10845
|
-
"x-reconciled-at": "2026-01-
|
|
11366
|
+
"x-reconciled-at": "2026-01-07T15:29:38.185984+00:00"
|
|
10846
11367
|
},
|
|
10847
11368
|
"to": {
|
|
10848
11369
|
"type": "string",
|
|
@@ -10891,6 +11412,7 @@
|
|
|
10891
11412
|
"$ref": "#/components/schemas/usageUsageItem"
|
|
10892
11413
|
},
|
|
10893
11414
|
"x-displayname": "Usage items.",
|
|
11415
|
+
"x-f5xc-description-short": "Collection of usage items, lines of response.",
|
|
10894
11416
|
"x-f5xc-required-for": {
|
|
10895
11417
|
"minimum_config": false,
|
|
10896
11418
|
"create": false,
|
|
@@ -10986,6 +11508,7 @@
|
|
|
10986
11508
|
}
|
|
10987
11509
|
}
|
|
10988
11510
|
},
|
|
11511
|
+
"x-f5xc-description-short": "One line of usage, including pricing details.",
|
|
10989
11512
|
"x-f5xc-minimum-configuration": {
|
|
10990
11513
|
"description": "Minimum configuration for usageMonthlyUsageType",
|
|
10991
11514
|
"required_fields": [
|
|
@@ -11033,6 +11556,8 @@
|
|
|
11033
11556
|
"$ref": "#/components/schemas/usageHourlyItem"
|
|
11034
11557
|
},
|
|
11035
11558
|
"x-displayname": "Hourly breakdown.",
|
|
11559
|
+
"x-f5xc-description-short": "Array of HourlyItem with usage per hour.",
|
|
11560
|
+
"x-f5xc-description-medium": "Array of HourlyItem with usage per hour. The sum of these items will result into the parent's object Deprecated: use /hourly_usage_details along with hourly_breakdown_query.",
|
|
11036
11561
|
"x-f5xc-required-for": {
|
|
11037
11562
|
"minimum_config": false,
|
|
11038
11563
|
"create": false,
|
|
@@ -11054,6 +11579,8 @@
|
|
|
11054
11579
|
"x-validation-rules": {
|
|
11055
11580
|
"ves.io.schema.rules.message.required": "true"
|
|
11056
11581
|
},
|
|
11582
|
+
"x-f5xc-description-short": "[x-required] A base64 encoded JSON which should be passed as is to /hourly_usage_details to GET hourly items for this aggregated usage.",
|
|
11583
|
+
"x-f5xc-description-medium": "[x-required] A base64 encoded JSON which should be passed as is to /hourly_usage_details to GET hourly items for this aggregated usage.",
|
|
11057
11584
|
"minLength": 0,
|
|
11058
11585
|
"maxLength": 1024,
|
|
11059
11586
|
"x-f5xc-required-for": {
|
|
@@ -11075,6 +11602,7 @@
|
|
|
11075
11602
|
"x-validation-rules": {
|
|
11076
11603
|
"ves.io.schema.rules.message.required": "true"
|
|
11077
11604
|
},
|
|
11605
|
+
"x-f5xc-description-medium": "[x-required] ID of the usage type. As Usage type is shown for user and is a subject of frequent changes, this metric_label should be static and should be usage for mapping between calculated usage and aggregated_usage.",
|
|
11078
11606
|
"minLength": 0,
|
|
11079
11607
|
"maxLength": 1024,
|
|
11080
11608
|
"x-f5xc-required-for": {
|
|
@@ -11101,7 +11629,7 @@
|
|
|
11101
11629
|
},
|
|
11102
11630
|
"x-original-maxLength": 1024,
|
|
11103
11631
|
"x-reconciled-from-discovery": true,
|
|
11104
|
-
"x-reconciled-at": "2026-01-
|
|
11632
|
+
"x-reconciled-at": "2026-01-07T15:29:38.186003+00:00"
|
|
11105
11633
|
},
|
|
11106
11634
|
"object_name": {
|
|
11107
11635
|
"type": "string",
|
|
@@ -11110,6 +11638,7 @@
|
|
|
11110
11638
|
"x-displayname": "Object name.",
|
|
11111
11639
|
"x-ves-example": "Pa4-resource1.",
|
|
11112
11640
|
"x-f5xc-example": "pa4-resource1",
|
|
11641
|
+
"x-f5xc-description-short": "Name of the object where the usage occurred.",
|
|
11113
11642
|
"minLength": 0,
|
|
11114
11643
|
"maxLength": 1024,
|
|
11115
11644
|
"x-f5xc-required-for": {
|
|
@@ -11184,6 +11713,7 @@
|
|
|
11184
11713
|
}
|
|
11185
11714
|
}
|
|
11186
11715
|
},
|
|
11716
|
+
"x-f5xc-description-short": "Usage item represents a line in a usage report, including quantity and resource incurring usage.",
|
|
11187
11717
|
"x-f5xc-minimum-configuration": {
|
|
11188
11718
|
"description": "Minimum configuration for usageUsageItem",
|
|
11189
11719
|
"required_fields": [
|
|
@@ -11245,7 +11775,7 @@
|
|
|
11245
11775
|
},
|
|
11246
11776
|
"x-original-maxLength": 1024,
|
|
11247
11777
|
"x-reconciled-from-discovery": true,
|
|
11248
|
-
"x-reconciled-at": "2026-01-
|
|
11778
|
+
"x-reconciled-at": "2026-01-07T15:29:38.477792+00:00"
|
|
11249
11779
|
}
|
|
11250
11780
|
},
|
|
11251
11781
|
"x-f5xc-minimum-configuration": {
|
|
@@ -11327,6 +11857,7 @@
|
|
|
11327
11857
|
"$ref": "#/components/schemas/planPlanInternal"
|
|
11328
11858
|
},
|
|
11329
11859
|
"x-displayname": "Plans",
|
|
11860
|
+
"x-f5xc-description-short": "Collection of currently publicly available plans.",
|
|
11330
11861
|
"x-f5xc-required-for": {
|
|
11331
11862
|
"minimum_config": false,
|
|
11332
11863
|
"create": false,
|
|
@@ -11362,6 +11893,8 @@
|
|
|
11362
11893
|
"default": "PERIOD_UNKNOWN",
|
|
11363
11894
|
"x-displayname": "Period type.",
|
|
11364
11895
|
"x-ves-proto-enum": "ves.io.schema.usage.plan.PeriodUnitType",
|
|
11896
|
+
"x-f5xc-description-short": "Temporal period type - PERIOD_UNKNOWN: unknown, undefined period of time - PERIOD_DAY: Day - PERIOD_WEEK: Week - PERIOD_MONTH: Month ...",
|
|
11897
|
+
"x-f5xc-description-medium": "Temporal period type - PERIOD_UNKNOWN: unknown, undefined period of time - PERIOD_DAY: Day - PERIOD_WEEK: Week - PERIOD_MONTH: Month - PERIOD_YEAR: Year.",
|
|
11365
11898
|
"x-f5xc-minimum-configuration": {
|
|
11366
11899
|
"description": "Minimum configuration for planPeriodUnitType",
|
|
11367
11900
|
"required_fields": [],
|
|
@@ -11386,6 +11919,7 @@
|
|
|
11386
11919
|
"$ref": "#/components/schemas/planAddonServiceDetails"
|
|
11387
11920
|
},
|
|
11388
11921
|
"x-displayname": "Allowed Addon Services.",
|
|
11922
|
+
"x-f5xc-description-short": "List of addon services that can be subscribed part of current plan.",
|
|
11389
11923
|
"x-f5xc-required-for": {
|
|
11390
11924
|
"minimum_config": false,
|
|
11391
11925
|
"create": false,
|
|
@@ -11399,6 +11933,7 @@
|
|
|
11399
11933
|
"title": "Billing disabled.",
|
|
11400
11934
|
"format": "boolean",
|
|
11401
11935
|
"x-displayname": "Billing disabled.",
|
|
11936
|
+
"x-f5xc-description-short": "If true then there's no automatic billing.",
|
|
11402
11937
|
"x-f5xc-required-for": {
|
|
11403
11938
|
"minimum_config": false,
|
|
11404
11939
|
"create": false,
|
|
@@ -11412,6 +11947,7 @@
|
|
|
11412
11947
|
"title": "Current",
|
|
11413
11948
|
"format": "boolean",
|
|
11414
11949
|
"x-displayname": "Current",
|
|
11950
|
+
"x-f5xc-description-short": "True if plan is active. Note that customers are only allowed to current plans.",
|
|
11415
11951
|
"x-f5xc-required-for": {
|
|
11416
11952
|
"minimum_config": false,
|
|
11417
11953
|
"create": false,
|
|
@@ -11429,6 +11965,7 @@
|
|
|
11429
11965
|
"x-displayname": "Description.",
|
|
11430
11966
|
"x-ves-example": "###Free plan, includes x y z *Free item 1 *Free item 2 ##Self-support only.",
|
|
11431
11967
|
"x-f5xc-example": "###Free plan, includes x y z *Free item 1 *Free item 2 ##Self-support only",
|
|
11968
|
+
"x-f5xc-description-short": "Description of the plan as mark-down text.",
|
|
11432
11969
|
"minLength": 0,
|
|
11433
11970
|
"maxLength": 0,
|
|
11434
11971
|
"x-f5xc-required-for": {
|
|
@@ -11439,7 +11976,7 @@
|
|
|
11439
11976
|
},
|
|
11440
11977
|
"x-original-maxLength": 1024,
|
|
11441
11978
|
"x-reconciled-from-discovery": true,
|
|
11442
|
-
"x-reconciled-at": "2026-01-
|
|
11979
|
+
"x-reconciled-at": "2026-01-07T15:29:38.477812+00:00"
|
|
11443
11980
|
},
|
|
11444
11981
|
"flat_price": {
|
|
11445
11982
|
"type": "integer",
|
|
@@ -11465,6 +12002,7 @@
|
|
|
11465
12002
|
"$ref": "#/components/schemas/planAddonServiceDetails"
|
|
11466
12003
|
},
|
|
11467
12004
|
"x-displayname": "Included Addon Services.",
|
|
12005
|
+
"x-f5xc-description-short": "List of addon services that are available part of current plan.",
|
|
11468
12006
|
"x-f5xc-required-for": {
|
|
11469
12007
|
"minimum_config": false,
|
|
11470
12008
|
"create": false,
|
|
@@ -11479,6 +12017,7 @@
|
|
|
11479
12017
|
"x-displayname": "Name",
|
|
11480
12018
|
"x-ves-example": "Free-p25-v2.",
|
|
11481
12019
|
"x-f5xc-example": "free-p25-v2",
|
|
12020
|
+
"x-f5xc-description-short": "Name of the plan, the name is not guaranteed to be human readable.",
|
|
11482
12021
|
"minLength": 0,
|
|
11483
12022
|
"maxLength": 16,
|
|
11484
12023
|
"x-f5xc-required-for": {
|
|
@@ -11489,7 +12028,7 @@
|
|
|
11489
12028
|
},
|
|
11490
12029
|
"x-original-maxLength": 1024,
|
|
11491
12030
|
"x-reconciled-from-discovery": true,
|
|
11492
|
-
"x-reconciled-at": "2026-01-
|
|
12031
|
+
"x-reconciled-at": "2026-01-07T15:29:38.477821+00:00"
|
|
11493
12032
|
},
|
|
11494
12033
|
"renewal_period_unit": {
|
|
11495
12034
|
"$ref": "#/components/schemas/planPeriodUnitType"
|
|
@@ -11504,6 +12043,7 @@
|
|
|
11504
12043
|
"x-displayname": "Sub-title",
|
|
11505
12044
|
"x-ves-example": "Our free plan.",
|
|
11506
12045
|
"x-f5xc-example": "Our free plan",
|
|
12046
|
+
"x-f5xc-description-short": "Optional second line of the title of the plan, human readable.",
|
|
11507
12047
|
"minLength": 0,
|
|
11508
12048
|
"maxLength": 1024,
|
|
11509
12049
|
"x-f5xc-required-for": {
|
|
@@ -11533,7 +12073,7 @@
|
|
|
11533
12073
|
},
|
|
11534
12074
|
"x-original-maxLength": 1024,
|
|
11535
12075
|
"x-reconciled-from-discovery": true,
|
|
11536
|
-
"x-reconciled-at": "2026-01-
|
|
12076
|
+
"x-reconciled-at": "2026-01-07T15:29:38.477830+00:00"
|
|
11537
12077
|
},
|
|
11538
12078
|
"transition_flow": {
|
|
11539
12079
|
"$ref": "#/components/schemas/planUsagePlanTransitionFlow"
|
|
@@ -11546,6 +12086,8 @@
|
|
|
11546
12086
|
"x-displayname": "Trial period.",
|
|
11547
12087
|
"x-ves-example": "3",
|
|
11548
12088
|
"x-f5xc-example": "3",
|
|
12089
|
+
"x-f5xc-description-short": "Trial period associated with this plan. Different pricing conditions are in place during the trial period - flat fee my not apply, or similar.",
|
|
12090
|
+
"x-f5xc-description-medium": "Trial period associated with this plan. Different pricing conditions are in place during the trial period - flat fee my not apply, or similar.",
|
|
11549
12091
|
"minimum": 0,
|
|
11550
12092
|
"maximum": 2147483647,
|
|
11551
12093
|
"x-f5xc-required-for": {
|
|
@@ -11562,6 +12104,7 @@
|
|
|
11562
12104
|
"$ref": "#/components/schemas/schemaPlanType"
|
|
11563
12105
|
}
|
|
11564
12106
|
},
|
|
12107
|
+
"x-f5xc-description-short": "Structure that holds all data needed to choose usage plan.",
|
|
11565
12108
|
"x-f5xc-minimum-configuration": {
|
|
11566
12109
|
"description": "Minimum configuration for planPlanInternal",
|
|
11567
12110
|
"required_fields": [
|
|
@@ -11602,6 +12145,8 @@
|
|
|
11602
12145
|
"default": "STATE_UNSPECIFIED",
|
|
11603
12146
|
"x-displayname": "PlanTransitionState.",
|
|
11604
12147
|
"x-ves-proto-enum": "ves.io.schema.usage.plan.PlanState",
|
|
12148
|
+
"x-f5xc-description-short": "State of the - STATE_UNSPECIFIED: zero value - STATE_READY: the plan is in default state - STATE_TRANSITION_PENDING: the plan is in the state of...",
|
|
12149
|
+
"x-f5xc-description-medium": "State of the - STATE_UNSPECIFIED: zero value - STATE_READY: the plan is in default state - STATE_TRANSITION_PENDING: the plan is in the state of plan transitioning. If the plan has current flag equals to true and in TRANSITION_PENDING then tenant moves to another plan which is in state...",
|
|
11605
12150
|
"x-f5xc-minimum-configuration": {
|
|
11606
12151
|
"description": "Minimum configuration for planPlanState",
|
|
11607
12152
|
"required_fields": [],
|
|
@@ -11625,6 +12170,8 @@
|
|
|
11625
12170
|
"default": "TRANSITION_METHOD_UNSPECIFIED",
|
|
11626
12171
|
"x-displayname": "PlanTransitionMethod.",
|
|
11627
12172
|
"x-ves-proto-enum": "ves.io.schema.usage.plan.PlanTransitionMethod",
|
|
12173
|
+
"x-f5xc-description-short": "Transitioning method which UI should show to the customer to properly execute the transition between - TRANSITION_METHOD_UNSPECIFIED: Zero value ...",
|
|
12174
|
+
"x-f5xc-description-medium": "Transitioning method which UI should show to the customer to properly execute the transition between - TRANSITION_METHOD_UNSPECIFIED: Zero value - TRANSITION_METHOD_SUPPORT: The transition should be done via a support request, the current behaviour for any transition - TRANSITION_METHOD_WIZARD...",
|
|
11628
12175
|
"x-f5xc-minimum-configuration": {
|
|
11629
12176
|
"description": "Minimum configuration for planPlanTransitionMethod",
|
|
11630
12177
|
"required_fields": [],
|
|
@@ -11648,6 +12195,8 @@
|
|
|
11648
12195
|
"default": "TRANSITION_REQUIRED_FIELD_UNSPECIFIED",
|
|
11649
12196
|
"x-displayname": "PlanTransitionRequiredField.",
|
|
11650
12197
|
"x-ves-proto-enum": "ves.io.schema.usage.plan.PlanTransitionRequiredField",
|
|
12198
|
+
"x-f5xc-description-short": "Fields which UI should provide to the backend to properly execute the transition between plans - TRANSITION_REQUIRED_FIELD_UNSPECIFIED: Zero value...",
|
|
12199
|
+
"x-f5xc-description-medium": "Fields which UI should provide to the backend to properly execute the transition between plans - TRANSITION_REQUIRED_FIELD_UNSPECIFIED: Zero value - TRANSITION_REQUIRED_FIELD_PAYMENT_TOKEN: Stripe token after user enters CC info and we submit it to stripe - TRANSITION_REQUIRED_FIELD_DOMAIN...",
|
|
11651
12200
|
"x-f5xc-minimum-configuration": {
|
|
11652
12201
|
"description": "Minimum configuration for planPlanTransitionRequiredField",
|
|
11653
12202
|
"required_fields": [],
|
|
@@ -11676,6 +12225,7 @@
|
|
|
11676
12225
|
"$ref": "#/components/schemas/planPlanTransitionRequiredField"
|
|
11677
12226
|
},
|
|
11678
12227
|
"x-displayname": "Required fields.",
|
|
12228
|
+
"x-f5xc-description-short": "Mandatory information to migrate onto this plan.",
|
|
11679
12229
|
"x-f5xc-required-for": {
|
|
11680
12230
|
"minimum_config": false,
|
|
11681
12231
|
"create": false,
|
|
@@ -11689,6 +12239,8 @@
|
|
|
11689
12239
|
"title": "Manual approval.",
|
|
11690
12240
|
"format": "boolean",
|
|
11691
12241
|
"x-displayname": "Manual approval.",
|
|
12242
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
12243
|
+
"x-f5xc-description-short": "If true then any migration onto this plan must be approved by the billing department.",
|
|
11692
12244
|
"x-f5xc-required-for": {
|
|
11693
12245
|
"minimum_config": false,
|
|
11694
12246
|
"create": false,
|
|
@@ -11697,6 +12249,7 @@
|
|
|
11697
12249
|
}
|
|
11698
12250
|
}
|
|
11699
12251
|
},
|
|
12252
|
+
"x-f5xc-description-short": "Details for transition flow. Is used as part of UsagePlanInternal.",
|
|
11700
12253
|
"x-f5xc-minimum-configuration": {
|
|
11701
12254
|
"description": "Minimum configuration for planUsagePlanTransitionFlow",
|
|
11702
12255
|
"required_fields": [
|
|
@@ -11731,6 +12284,7 @@
|
|
|
11731
12284
|
}
|
|
11732
12285
|
}
|
|
11733
12286
|
},
|
|
12287
|
+
"x-f5xc-description-short": "X-displayName: \"Hours\" Input Duration Hours.",
|
|
11734
12288
|
"x-f5xc-minimum-configuration": {
|
|
11735
12289
|
"description": "Minimum configuration for rate_limiterInputHours",
|
|
11736
12290
|
"required_fields": [
|
|
@@ -11763,6 +12317,7 @@
|
|
|
11763
12317
|
}
|
|
11764
12318
|
}
|
|
11765
12319
|
},
|
|
12320
|
+
"x-f5xc-description-short": "X-displayName: \"Minutes\" Input Duration Minutes.",
|
|
11766
12321
|
"x-f5xc-minimum-configuration": {
|
|
11767
12322
|
"description": "Minimum configuration for rate_limiterInputMinutes",
|
|
11768
12323
|
"required_fields": [
|
|
@@ -11795,6 +12350,7 @@
|
|
|
11795
12350
|
}
|
|
11796
12351
|
}
|
|
11797
12352
|
},
|
|
12353
|
+
"x-f5xc-description-short": "X-displayName: \"Seconds\" Input Duration Seconds.",
|
|
11798
12354
|
"x-f5xc-minimum-configuration": {
|
|
11799
12355
|
"description": "Minimum configuration for rate_limiterInputSeconds",
|
|
11800
12356
|
"required_fields": [
|
|
@@ -11811,6 +12367,8 @@
|
|
|
11811
12367
|
"type": "object",
|
|
11812
12368
|
"description": "X-displayName: \"Leaky Bucket Rate Limiter\"\nLeaky-Bucket is the default rate limiter algorithm for F5.",
|
|
11813
12369
|
"title": "LeakyBucketRateLimiter.",
|
|
12370
|
+
"x-f5xc-description-short": "X-displayName: \"Leaky Bucket Rate Limiter\" Leaky-Bucket is the default rate limiter algorithm for F5.",
|
|
12371
|
+
"x-f5xc-description-medium": "X-displayName: \"Leaky Bucket Rate Limiter\" Leaky-Bucket is the default rate limiter algorithm for F5.",
|
|
11814
12372
|
"x-f5xc-minimum-configuration": {
|
|
11815
12373
|
"description": "Minimum configuration for rate_limiterLeakyBucketRateLimiter",
|
|
11816
12374
|
"required_fields": [],
|
|
@@ -11836,6 +12394,8 @@
|
|
|
11836
12394
|
"$ref": "#/components/schemas/rate_limiterInputSeconds"
|
|
11837
12395
|
}
|
|
11838
12396
|
},
|
|
12397
|
+
"x-f5xc-description-short": "X-displayName: \"Rate Limit Block Action\" Action where a user is blocked from making further requests after exceeding rate limit threshold.",
|
|
12398
|
+
"x-f5xc-description-medium": "X-displayName: \"Rate Limit Block Action\" Action where a user is blocked from making further requests after exceeding rate limit threshold.",
|
|
11839
12399
|
"x-f5xc-minimum-configuration": {
|
|
11840
12400
|
"description": "Minimum configuration for rate_limiterRateLimitBlockAction",
|
|
11841
12401
|
"required_fields": [
|
|
@@ -11861,6 +12421,8 @@
|
|
|
11861
12421
|
"DAY"
|
|
11862
12422
|
],
|
|
11863
12423
|
"default": "SECOND",
|
|
12424
|
+
"x-f5xc-description-short": "X-displayName: \"Rate Limit Period Unit\" Unit for the period per which the rate limit is applied. - SECOND: Second x-displayName: \"Seconds\" Rate...",
|
|
12425
|
+
"x-f5xc-description-medium": "X-displayName: \"Rate Limit Period Unit\" Unit for the period per which the rate limit is applied. - SECOND: Second x-displayName: \"Seconds\" Rate limit period unit is seconds - MINUTE: Minute x-displayName: \"Minutes\" Rate limit period unit is minutes - HOUR: Hour x-displayName: \"Hours\" Rate limit...",
|
|
11864
12426
|
"x-f5xc-minimum-configuration": {
|
|
11865
12427
|
"description": "Minimum configuration for rate_limiterRateLimitPeriodUnit",
|
|
11866
12428
|
"required_fields": [],
|
|
@@ -11885,6 +12447,8 @@
|
|
|
11885
12447
|
"title": "Burst_multiplier.",
|
|
11886
12448
|
"format": "int64",
|
|
11887
12449
|
"x-f5xc-example": "1",
|
|
12450
|
+
"x-f5xc-description-short": "X-displayName: \"Burst Multiplier\" The maximum burst of requests to accommodate, expressed as a multiple of the rate.",
|
|
12451
|
+
"x-f5xc-description-medium": "X-displayName: \"Burst Multiplier\" The maximum burst of requests to accommodate, expressed as a multiple of the rate.",
|
|
11888
12452
|
"minimum": 0,
|
|
11889
12453
|
"maximum": 2147483647,
|
|
11890
12454
|
"x-f5xc-required-for": {
|
|
@@ -11906,6 +12470,7 @@
|
|
|
11906
12470
|
"title": "Period_multiplier.",
|
|
11907
12471
|
"format": "int64",
|
|
11908
12472
|
"x-f5xc-example": "1",
|
|
12473
|
+
"x-f5xc-description-short": "X-displayName: \"Periods\" This setting, combined with Per Period units, provides a duration.",
|
|
11909
12474
|
"minimum": 0,
|
|
11910
12475
|
"maximum": 2147483647,
|
|
11911
12476
|
"x-f5xc-required-for": {
|
|
@@ -11924,6 +12489,8 @@
|
|
|
11924
12489
|
"title": "Total_number.",
|
|
11925
12490
|
"format": "int64",
|
|
11926
12491
|
"x-f5xc-example": "1",
|
|
12492
|
+
"x-f5xc-description-short": "X-displayName: \"Number Of Requests\" x-required The total number of allowed requests per rate-limiting period.",
|
|
12493
|
+
"x-f5xc-description-medium": "X-displayName: \"Number Of Requests\" x-required The total number of allowed requests per rate-limiting period.",
|
|
11927
12494
|
"minimum": 0,
|
|
11928
12495
|
"maximum": 2147483647,
|
|
11929
12496
|
"x-f5xc-required-for": {
|
|
@@ -11937,6 +12504,8 @@
|
|
|
11937
12504
|
"$ref": "#/components/schemas/rate_limiterRateLimitPeriodUnit"
|
|
11938
12505
|
}
|
|
11939
12506
|
},
|
|
12507
|
+
"x-f5xc-description-short": "X-displayName: \"Rate Limit Value\" A tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
|
|
12508
|
+
"x-f5xc-description-medium": "X-displayName: \"Rate Limit Value\" A tuple consisting of a rate limit period unit and the total number of allowed requests for that period.",
|
|
11940
12509
|
"x-f5xc-minimum-configuration": {
|
|
11941
12510
|
"description": "Minimum configuration for rate_limiterRateLimitValue",
|
|
11942
12511
|
"required_fields": [
|
|
@@ -11960,6 +12529,8 @@
|
|
|
11960
12529
|
"type": "object",
|
|
11961
12530
|
"description": "X-displayName: \"Token Bucket Rate Limiter\"\nToken-Bucket is a rate limiter algorithm that is stricter with enforcing limits.",
|
|
11962
12531
|
"title": "TokenBucketRateLimiter.",
|
|
12532
|
+
"x-f5xc-description-short": "X-displayName: \"Token Bucket Rate Limiter\" Token-Bucket is a rate limiter algorithm that is stricter with enforcing limits.",
|
|
12533
|
+
"x-f5xc-description-medium": "X-displayName: \"Token Bucket Rate Limiter\" Token-Bucket is a rate limiter algorithm that is stricter with enforcing limits.",
|
|
11963
12534
|
"x-f5xc-minimum-configuration": {
|
|
11964
12535
|
"description": "Minimum configuration for rate_limiterTokenBucketRateLimiter",
|
|
11965
12536
|
"required_fields": [],
|
|
@@ -11984,6 +12555,7 @@
|
|
|
11984
12555
|
"default": "FREE",
|
|
11985
12556
|
"x-displayname": "Plan Type",
|
|
11986
12557
|
"x-ves-proto-enum": "ves.io.schema.PlanType",
|
|
12558
|
+
"x-f5xc-description-short": "PlanType is the type of billing plan for the customer.",
|
|
11987
12559
|
"x-f5xc-minimum-configuration": {
|
|
11988
12560
|
"description": "Minimum configuration for schemaPlanType",
|
|
11989
12561
|
"required_fields": [],
|
|
@@ -12006,6 +12578,8 @@
|
|
|
12006
12578
|
"default": "UNKNOWN",
|
|
12007
12579
|
"x-displayname": "Tenant type.",
|
|
12008
12580
|
"x-ves-proto-enum": "ves.io.schema.TenantType",
|
|
12581
|
+
"x-f5xc-description-short": "TenantType is the type of the customer UNKNOWN indicates the field not being set FREEMIUM are customer that don't have their domain ENTERPRiISE...",
|
|
12582
|
+
"x-f5xc-description-medium": "TenantType is the type of the customer UNKNOWN indicates the field not being set FREEMIUM are customer that don't have their domain ENTERPRiISE customer have their domain.",
|
|
12009
12583
|
"x-f5xc-minimum-configuration": {
|
|
12010
12584
|
"description": "Minimum configuration for schemaTenantType",
|
|
12011
12585
|
"required_fields": [],
|
|
@@ -12038,6 +12612,8 @@
|
|
|
12038
12612
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
12039
12613
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
12040
12614
|
},
|
|
12615
|
+
"x-f5xc-description-short": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g...",
|
|
12616
|
+
"x-f5xc-description-medium": "API Limits defines ratelimit parameters for an API at the stdlib service The key of the api_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
|
|
12041
12617
|
"x-f5xc-required-for": {
|
|
12042
12618
|
"minimum_config": false,
|
|
12043
12619
|
"create": false,
|
|
@@ -12060,6 +12636,8 @@
|
|
|
12060
12636
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
12061
12637
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
12062
12638
|
},
|
|
12639
|
+
"x-f5xc-description-short": "API Gateway Limits defines rate limit value parameters for an API at a service level (prism, sentinel, etc) The key of the apigw_limits map is rpc...",
|
|
12640
|
+
"x-f5xc-description-medium": "API Gateway Limits defines rate limit value parameters for an API at a service level (prism, sentinel, etc) The key of the apigw_limits map is rpc FQN e.g. \"VES.I/o.schema.advertise_policy.api.create\".",
|
|
12063
12641
|
"x-f5xc-required-for": {
|
|
12064
12642
|
"minimum_config": false,
|
|
12065
12643
|
"create": false,
|
|
@@ -12082,6 +12660,8 @@
|
|
|
12082
12660
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
12083
12661
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
12084
12662
|
},
|
|
12663
|
+
"x-f5xc-description-short": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object...",
|
|
12664
|
+
"x-f5xc-description-medium": "Object Limits define maximum number of instances that can be present per object kind for the tenant The key of the object_limits map is object kind e.g. \"virtual_host\".",
|
|
12085
12665
|
"x-f5xc-required-for": {
|
|
12086
12666
|
"minimum_config": false,
|
|
12087
12667
|
"create": false,
|
|
@@ -12104,6 +12684,8 @@
|
|
|
12104
12684
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
12105
12685
|
"ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z][a-zA-Z0-9-._]*[a-zA-Z0-9]$"
|
|
12106
12686
|
},
|
|
12687
|
+
"x-f5xc-description-short": "Resource Limits define maximum value of resources in the appropriate units that can be present.",
|
|
12688
|
+
"x-f5xc-description-medium": "Resource Limits define maximum value of resources in the appropriate units that can be present. The key of the resource limits is the resource name.",
|
|
12107
12689
|
"x-f5xc-required-for": {
|
|
12108
12690
|
"minimum_config": false,
|
|
12109
12691
|
"create": false,
|
|
@@ -12112,6 +12694,7 @@
|
|
|
12112
12694
|
}
|
|
12113
12695
|
}
|
|
12114
12696
|
},
|
|
12697
|
+
"x-f5xc-description-short": "GlobalSpecType defines the shape of the object in database as present in Global Controller.",
|
|
12115
12698
|
"x-f5xc-minimum-configuration": {
|
|
12116
12699
|
"description": "Minimum configuration for schemaquotaGlobalSpecType",
|
|
12117
12700
|
"required_fields": [
|