@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": "Certificates",
|
|
5
5
|
"description": "X.509 certificate chains with intermediate and root CA support. Trusted CA list bundles for client authentication and mTLS validation. CRL distribution points and OCSP stapling configuration. Certificate manifests link credentials to load balancers and gateways. Automatic expiration tracking and renewal notifications.",
|
|
6
|
-
"version": "2.0.
|
|
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,40 @@
|
|
|
13
13
|
"url": "https://www.f5.com/company/policies/eula"
|
|
14
14
|
},
|
|
15
15
|
"summary": "Certificate chains and trusted CA bundles. Revocation list management and manifest configuration for PKI operations.",
|
|
16
|
-
"x-f5xc-cli-domain": "certificates"
|
|
16
|
+
"x-f5xc-cli-domain": "certificates",
|
|
17
|
+
"x-f5xc-best-practices": {
|
|
18
|
+
"common_errors": [
|
|
19
|
+
{
|
|
20
|
+
"code": 400,
|
|
21
|
+
"message": "Certificate chain incomplete",
|
|
22
|
+
"resolution": "Include intermediate certificates in chain",
|
|
23
|
+
"prevention": "Validate certificate chain before upload"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"code": 400,
|
|
27
|
+
"message": "Private key mismatch",
|
|
28
|
+
"resolution": "Ensure private key matches certificate",
|
|
29
|
+
"prevention": "Verify key-cert pair before upload"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"code": 400,
|
|
33
|
+
"message": "Certificate expired",
|
|
34
|
+
"resolution": "Renew certificate and upload new version",
|
|
35
|
+
"prevention": "Set up certificate expiry monitoring"
|
|
36
|
+
}
|
|
37
|
+
],
|
|
38
|
+
"security_notes": [
|
|
39
|
+
"Use certificates with at least 2048-bit RSA or 256-bit ECDSA keys",
|
|
40
|
+
"Enable OCSP stapling for revocation checking",
|
|
41
|
+
"Configure certificate transparency logging",
|
|
42
|
+
"Use separate certificates for different environments"
|
|
43
|
+
],
|
|
44
|
+
"performance_tips": [
|
|
45
|
+
"Use ECDSA certificates for faster TLS handshakes",
|
|
46
|
+
"Enable session resumption for repeat visitors",
|
|
47
|
+
"Configure OCSP stapling to reduce client latency"
|
|
48
|
+
]
|
|
49
|
+
}
|
|
17
50
|
},
|
|
18
51
|
"servers": [
|
|
19
52
|
{
|
|
@@ -276,6 +309,13 @@
|
|
|
276
309
|
"latency": "low",
|
|
277
310
|
"resource_usage": "low"
|
|
278
311
|
}
|
|
312
|
+
},
|
|
313
|
+
"x-f5xc-discovered-response-time": {
|
|
314
|
+
"p50_ms": 1000,
|
|
315
|
+
"p95_ms": 3000,
|
|
316
|
+
"p99_ms": 8000,
|
|
317
|
+
"sample_count": 0,
|
|
318
|
+
"source": "estimate"
|
|
279
319
|
}
|
|
280
320
|
},
|
|
281
321
|
"x-displayname": "CRL",
|
|
@@ -498,6 +538,13 @@
|
|
|
498
538
|
"latency": "low",
|
|
499
539
|
"resource_usage": "low"
|
|
500
540
|
}
|
|
541
|
+
},
|
|
542
|
+
"x-f5xc-discovered-response-time": {
|
|
543
|
+
"p50_ms": 800,
|
|
544
|
+
"p95_ms": 2500,
|
|
545
|
+
"p99_ms": 6000,
|
|
546
|
+
"sample_count": 0,
|
|
547
|
+
"source": "estimate"
|
|
501
548
|
}
|
|
502
549
|
},
|
|
503
550
|
"x-displayname": "CRL",
|
|
@@ -725,6 +772,13 @@
|
|
|
725
772
|
"latency": "moderate",
|
|
726
773
|
"resource_usage": "moderate"
|
|
727
774
|
}
|
|
775
|
+
},
|
|
776
|
+
"x-f5xc-discovered-response-time": {
|
|
777
|
+
"p50_ms": 200,
|
|
778
|
+
"p95_ms": 800,
|
|
779
|
+
"p99_ms": 2000,
|
|
780
|
+
"sample_count": 0,
|
|
781
|
+
"source": "estimate"
|
|
728
782
|
}
|
|
729
783
|
},
|
|
730
784
|
"x-displayname": "CRL",
|
|
@@ -946,6 +1000,13 @@
|
|
|
946
1000
|
"latency": "low",
|
|
947
1001
|
"resource_usage": "low"
|
|
948
1002
|
}
|
|
1003
|
+
},
|
|
1004
|
+
"x-f5xc-discovered-response-time": {
|
|
1005
|
+
"p50_ms": 200,
|
|
1006
|
+
"p95_ms": 800,
|
|
1007
|
+
"p99_ms": 2000,
|
|
1008
|
+
"sample_count": 0,
|
|
1009
|
+
"source": "estimate"
|
|
949
1010
|
}
|
|
950
1011
|
},
|
|
951
1012
|
"delete": {
|
|
@@ -1165,6 +1226,13 @@
|
|
|
1165
1226
|
"latency": "high",
|
|
1166
1227
|
"resource_usage": "moderate"
|
|
1167
1228
|
}
|
|
1229
|
+
},
|
|
1230
|
+
"x-f5xc-discovered-response-time": {
|
|
1231
|
+
"p50_ms": 500,
|
|
1232
|
+
"p95_ms": 1500,
|
|
1233
|
+
"p99_ms": 4000,
|
|
1234
|
+
"sample_count": 0,
|
|
1235
|
+
"source": "estimate"
|
|
1168
1236
|
}
|
|
1169
1237
|
},
|
|
1170
1238
|
"x-displayname": "CRL",
|
|
@@ -1380,6 +1448,13 @@
|
|
|
1380
1448
|
"latency": "low",
|
|
1381
1449
|
"resource_usage": "low"
|
|
1382
1450
|
}
|
|
1451
|
+
},
|
|
1452
|
+
"x-f5xc-discovered-response-time": {
|
|
1453
|
+
"p50_ms": 1000,
|
|
1454
|
+
"p95_ms": 3000,
|
|
1455
|
+
"p99_ms": 8000,
|
|
1456
|
+
"sample_count": 0,
|
|
1457
|
+
"source": "estimate"
|
|
1383
1458
|
}
|
|
1384
1459
|
},
|
|
1385
1460
|
"x-displayname": "Certificate.",
|
|
@@ -1603,6 +1678,13 @@
|
|
|
1603
1678
|
"latency": "low",
|
|
1604
1679
|
"resource_usage": "low"
|
|
1605
1680
|
}
|
|
1681
|
+
},
|
|
1682
|
+
"x-f5xc-discovered-response-time": {
|
|
1683
|
+
"p50_ms": 800,
|
|
1684
|
+
"p95_ms": 2500,
|
|
1685
|
+
"p99_ms": 6000,
|
|
1686
|
+
"sample_count": 0,
|
|
1687
|
+
"source": "estimate"
|
|
1606
1688
|
}
|
|
1607
1689
|
},
|
|
1608
1690
|
"x-displayname": "Certificate.",
|
|
@@ -1833,7 +1915,15 @@
|
|
|
1833
1915
|
}
|
|
1834
1916
|
},
|
|
1835
1917
|
"x-discovered-response-time-ms": 159.59,
|
|
1836
|
-
"x-discovered-sample-size": 1
|
|
1918
|
+
"x-discovered-sample-size": 1,
|
|
1919
|
+
"x-f5xc-discovered-response-time": {
|
|
1920
|
+
"p50_ms": 159.59,
|
|
1921
|
+
"p95_ms": 319.18,
|
|
1922
|
+
"p99_ms": 478.77,
|
|
1923
|
+
"sample_count": 1,
|
|
1924
|
+
"source": "discovery",
|
|
1925
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
1926
|
+
}
|
|
1837
1927
|
},
|
|
1838
1928
|
"x-displayname": "Certificate.",
|
|
1839
1929
|
"x-ves-proto-service": "ves.io.schema.certificate.API",
|
|
@@ -2055,6 +2145,13 @@
|
|
|
2055
2145
|
"latency": "low",
|
|
2056
2146
|
"resource_usage": "low"
|
|
2057
2147
|
}
|
|
2148
|
+
},
|
|
2149
|
+
"x-f5xc-discovered-response-time": {
|
|
2150
|
+
"p50_ms": 200,
|
|
2151
|
+
"p95_ms": 800,
|
|
2152
|
+
"p99_ms": 2000,
|
|
2153
|
+
"sample_count": 0,
|
|
2154
|
+
"source": "estimate"
|
|
2058
2155
|
}
|
|
2059
2156
|
},
|
|
2060
2157
|
"delete": {
|
|
@@ -2275,6 +2372,13 @@
|
|
|
2275
2372
|
"latency": "high",
|
|
2276
2373
|
"resource_usage": "moderate"
|
|
2277
2374
|
}
|
|
2375
|
+
},
|
|
2376
|
+
"x-f5xc-discovered-response-time": {
|
|
2377
|
+
"p50_ms": 500,
|
|
2378
|
+
"p95_ms": 1500,
|
|
2379
|
+
"p99_ms": 4000,
|
|
2380
|
+
"sample_count": 0,
|
|
2381
|
+
"source": "estimate"
|
|
2278
2382
|
}
|
|
2279
2383
|
},
|
|
2280
2384
|
"x-displayname": "Certificate.",
|
|
@@ -2490,6 +2594,13 @@
|
|
|
2490
2594
|
"latency": "low",
|
|
2491
2595
|
"resource_usage": "low"
|
|
2492
2596
|
}
|
|
2597
|
+
},
|
|
2598
|
+
"x-f5xc-discovered-response-time": {
|
|
2599
|
+
"p50_ms": 1000,
|
|
2600
|
+
"p95_ms": 3000,
|
|
2601
|
+
"p99_ms": 8000,
|
|
2602
|
+
"sample_count": 0,
|
|
2603
|
+
"source": "estimate"
|
|
2493
2604
|
}
|
|
2494
2605
|
},
|
|
2495
2606
|
"x-displayname": "Certificate Chain.",
|
|
@@ -2713,6 +2824,13 @@
|
|
|
2713
2824
|
"latency": "low",
|
|
2714
2825
|
"resource_usage": "low"
|
|
2715
2826
|
}
|
|
2827
|
+
},
|
|
2828
|
+
"x-f5xc-discovered-response-time": {
|
|
2829
|
+
"p50_ms": 800,
|
|
2830
|
+
"p95_ms": 2500,
|
|
2831
|
+
"p99_ms": 6000,
|
|
2832
|
+
"sample_count": 0,
|
|
2833
|
+
"source": "estimate"
|
|
2716
2834
|
}
|
|
2717
2835
|
},
|
|
2718
2836
|
"x-displayname": "Certificate Chain.",
|
|
@@ -2943,7 +3061,15 @@
|
|
|
2943
3061
|
}
|
|
2944
3062
|
},
|
|
2945
3063
|
"x-discovered-response-time-ms": 152.78,
|
|
2946
|
-
"x-discovered-sample-size": 1
|
|
3064
|
+
"x-discovered-sample-size": 1,
|
|
3065
|
+
"x-f5xc-discovered-response-time": {
|
|
3066
|
+
"p50_ms": 152.78,
|
|
3067
|
+
"p95_ms": 305.56,
|
|
3068
|
+
"p99_ms": 458.34,
|
|
3069
|
+
"sample_count": 1,
|
|
3070
|
+
"source": "discovery",
|
|
3071
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
3072
|
+
}
|
|
2947
3073
|
},
|
|
2948
3074
|
"x-displayname": "Certificate Chain.",
|
|
2949
3075
|
"x-ves-proto-service": "ves.io.schema.certificate_chain.API",
|
|
@@ -3165,6 +3291,13 @@
|
|
|
3165
3291
|
"latency": "low",
|
|
3166
3292
|
"resource_usage": "low"
|
|
3167
3293
|
}
|
|
3294
|
+
},
|
|
3295
|
+
"x-f5xc-discovered-response-time": {
|
|
3296
|
+
"p50_ms": 200,
|
|
3297
|
+
"p95_ms": 800,
|
|
3298
|
+
"p99_ms": 2000,
|
|
3299
|
+
"sample_count": 0,
|
|
3300
|
+
"source": "estimate"
|
|
3168
3301
|
}
|
|
3169
3302
|
},
|
|
3170
3303
|
"delete": {
|
|
@@ -3385,6 +3518,13 @@
|
|
|
3385
3518
|
"latency": "high",
|
|
3386
3519
|
"resource_usage": "moderate"
|
|
3387
3520
|
}
|
|
3521
|
+
},
|
|
3522
|
+
"x-f5xc-discovered-response-time": {
|
|
3523
|
+
"p50_ms": 500,
|
|
3524
|
+
"p95_ms": 1500,
|
|
3525
|
+
"p99_ms": 4000,
|
|
3526
|
+
"sample_count": 0,
|
|
3527
|
+
"source": "estimate"
|
|
3388
3528
|
}
|
|
3389
3529
|
},
|
|
3390
3530
|
"x-displayname": "Certificate Chain.",
|
|
@@ -3599,6 +3739,13 @@
|
|
|
3599
3739
|
"latency": "low",
|
|
3600
3740
|
"resource_usage": "low"
|
|
3601
3741
|
}
|
|
3742
|
+
},
|
|
3743
|
+
"x-f5xc-discovered-response-time": {
|
|
3744
|
+
"p50_ms": 1000,
|
|
3745
|
+
"p95_ms": 3000,
|
|
3746
|
+
"p99_ms": 8000,
|
|
3747
|
+
"sample_count": 0,
|
|
3748
|
+
"source": "estimate"
|
|
3602
3749
|
}
|
|
3603
3750
|
},
|
|
3604
3751
|
"x-displayname": "Root CA Certificate.",
|
|
@@ -3821,6 +3968,13 @@
|
|
|
3821
3968
|
"latency": "low",
|
|
3822
3969
|
"resource_usage": "low"
|
|
3823
3970
|
}
|
|
3971
|
+
},
|
|
3972
|
+
"x-f5xc-discovered-response-time": {
|
|
3973
|
+
"p50_ms": 800,
|
|
3974
|
+
"p95_ms": 2500,
|
|
3975
|
+
"p99_ms": 6000,
|
|
3976
|
+
"sample_count": 0,
|
|
3977
|
+
"source": "estimate"
|
|
3824
3978
|
}
|
|
3825
3979
|
},
|
|
3826
3980
|
"x-displayname": "Root CA Certificate.",
|
|
@@ -4048,6 +4202,13 @@
|
|
|
4048
4202
|
"latency": "moderate",
|
|
4049
4203
|
"resource_usage": "moderate"
|
|
4050
4204
|
}
|
|
4205
|
+
},
|
|
4206
|
+
"x-f5xc-discovered-response-time": {
|
|
4207
|
+
"p50_ms": 200,
|
|
4208
|
+
"p95_ms": 800,
|
|
4209
|
+
"p99_ms": 2000,
|
|
4210
|
+
"sample_count": 0,
|
|
4211
|
+
"source": "estimate"
|
|
4051
4212
|
}
|
|
4052
4213
|
},
|
|
4053
4214
|
"x-displayname": "Root CA Certificate.",
|
|
@@ -4269,6 +4430,13 @@
|
|
|
4269
4430
|
"latency": "low",
|
|
4270
4431
|
"resource_usage": "low"
|
|
4271
4432
|
}
|
|
4433
|
+
},
|
|
4434
|
+
"x-f5xc-discovered-response-time": {
|
|
4435
|
+
"p50_ms": 200,
|
|
4436
|
+
"p95_ms": 800,
|
|
4437
|
+
"p99_ms": 2000,
|
|
4438
|
+
"sample_count": 0,
|
|
4439
|
+
"source": "estimate"
|
|
4272
4440
|
}
|
|
4273
4441
|
},
|
|
4274
4442
|
"delete": {
|
|
@@ -4488,6 +4656,13 @@
|
|
|
4488
4656
|
"latency": "high",
|
|
4489
4657
|
"resource_usage": "moderate"
|
|
4490
4658
|
}
|
|
4659
|
+
},
|
|
4660
|
+
"x-f5xc-discovered-response-time": {
|
|
4661
|
+
"p50_ms": 500,
|
|
4662
|
+
"p95_ms": 1500,
|
|
4663
|
+
"p99_ms": 4000,
|
|
4664
|
+
"sample_count": 0,
|
|
4665
|
+
"source": "estimate"
|
|
4491
4666
|
}
|
|
4492
4667
|
},
|
|
4493
4668
|
"x-displayname": "Root CA Certificate.",
|
|
@@ -4613,6 +4788,7 @@
|
|
|
4613
4788
|
"ves.io.schema.rules.string.hostname_or_ip": "true",
|
|
4614
4789
|
"ves.io.schema.rules.string.max_len": "255"
|
|
4615
4790
|
},
|
|
4791
|
+
"x-f5xc-description-short": "CRL server address or hostname Required: YES.",
|
|
4616
4792
|
"minLength": 0,
|
|
4617
4793
|
"x-f5xc-required-for": {
|
|
4618
4794
|
"minimum_config": false,
|
|
@@ -4699,6 +4875,7 @@
|
|
|
4699
4875
|
"title": "Fail_if_referred.",
|
|
4700
4876
|
"format": "boolean",
|
|
4701
4877
|
"x-displayname": "Fail-If-Referred.",
|
|
4878
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
4702
4879
|
"x-f5xc-required-for": {
|
|
4703
4880
|
"minimum_config": false,
|
|
4704
4881
|
"create": false,
|
|
@@ -4723,7 +4900,7 @@
|
|
|
4723
4900
|
},
|
|
4724
4901
|
"x-original-maxLength": 1024,
|
|
4725
4902
|
"x-reconciled-from-discovery": true,
|
|
4726
|
-
"x-reconciled-at": "2026-01-
|
|
4903
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070682+00:00"
|
|
4727
4904
|
},
|
|
4728
4905
|
"namespace": {
|
|
4729
4906
|
"type": "string",
|
|
@@ -4732,6 +4909,7 @@
|
|
|
4732
4909
|
"x-displayname": "Namespace",
|
|
4733
4910
|
"x-ves-example": "Ns1",
|
|
4734
4911
|
"x-f5xc-example": "ns1",
|
|
4912
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
4735
4913
|
"minLength": 0,
|
|
4736
4914
|
"maxLength": 6,
|
|
4737
4915
|
"x-f5xc-required-for": {
|
|
@@ -4742,7 +4920,7 @@
|
|
|
4742
4920
|
},
|
|
4743
4921
|
"x-original-maxLength": 1024,
|
|
4744
4922
|
"x-reconciled-from-discovery": true,
|
|
4745
|
-
"x-reconciled-at": "2026-01-
|
|
4923
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070689+00:00"
|
|
4746
4924
|
}
|
|
4747
4925
|
},
|
|
4748
4926
|
"x-f5xc-minimum-configuration": {
|
|
@@ -4777,6 +4955,7 @@
|
|
|
4777
4955
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
4778
4956
|
},
|
|
4779
4957
|
"x-displayname": "Deleted Referred Objects.",
|
|
4958
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4780
4959
|
"x-f5xc-required-for": {
|
|
4781
4960
|
"minimum_config": false,
|
|
4782
4961
|
"create": false,
|
|
@@ -4792,6 +4971,7 @@
|
|
|
4792
4971
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
4793
4972
|
},
|
|
4794
4973
|
"x-displayname": "Disabled Referred Objects.",
|
|
4974
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4795
4975
|
"x-f5xc-required-for": {
|
|
4796
4976
|
"minimum_config": false,
|
|
4797
4977
|
"create": false,
|
|
@@ -4810,6 +4990,7 @@
|
|
|
4810
4990
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
4811
4991
|
},
|
|
4812
4992
|
"x-displayname": "Referring Objects.",
|
|
4993
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
4813
4994
|
"x-f5xc-required-for": {
|
|
4814
4995
|
"minimum_config": false,
|
|
4815
4996
|
"create": false,
|
|
@@ -4831,6 +5012,8 @@
|
|
|
4831
5012
|
"$ref": "#/components/schemas/crlStatusObject"
|
|
4832
5013
|
},
|
|
4833
5014
|
"x-displayname": "Status",
|
|
5015
|
+
"x-f5xc-example": "active",
|
|
5016
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
4834
5017
|
"x-f5xc-required-for": {
|
|
4835
5018
|
"minimum_config": false,
|
|
4836
5019
|
"create": false,
|
|
@@ -4840,7 +5023,7 @@
|
|
|
4840
5023
|
"maxLength": 17,
|
|
4841
5024
|
"minLength": 17,
|
|
4842
5025
|
"x-reconciled-from-discovery": true,
|
|
4843
|
-
"x-reconciled-at": "2026-01-
|
|
5026
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070706+00:00"
|
|
4844
5027
|
},
|
|
4845
5028
|
"system_metadata": {
|
|
4846
5029
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -4880,6 +5063,8 @@
|
|
|
4880
5063
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
4881
5064
|
],
|
|
4882
5065
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
5066
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
5067
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
4883
5068
|
"x-f5xc-minimum-configuration": {
|
|
4884
5069
|
"description": "Minimum configuration for crlGetResponseFormatCode",
|
|
4885
5070
|
"required_fields": [],
|
|
@@ -4943,6 +5128,7 @@
|
|
|
4943
5128
|
"ves.io.schema.rules.string.hostname_or_ip": "true",
|
|
4944
5129
|
"ves.io.schema.rules.string.max_len": "255"
|
|
4945
5130
|
},
|
|
5131
|
+
"x-f5xc-description-short": "CRL server address or hostname Required: YES.",
|
|
4946
5132
|
"minLength": 0,
|
|
4947
5133
|
"x-f5xc-required-for": {
|
|
4948
5134
|
"minimum_config": false,
|
|
@@ -5074,6 +5260,7 @@
|
|
|
5074
5260
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
5075
5261
|
},
|
|
5076
5262
|
"x-displayname": "Errors",
|
|
5263
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
5077
5264
|
"x-f5xc-required-for": {
|
|
5078
5265
|
"minimum_config": false,
|
|
5079
5266
|
"create": false,
|
|
@@ -5089,6 +5276,8 @@
|
|
|
5089
5276
|
"$ref": "#/components/schemas/crlListResponseItem"
|
|
5090
5277
|
},
|
|
5091
5278
|
"x-displayname": "Items",
|
|
5279
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
5280
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
5092
5281
|
"x-f5xc-required-for": {
|
|
5093
5282
|
"minimum_config": false,
|
|
5094
5283
|
"create": false,
|
|
@@ -5122,6 +5311,8 @@
|
|
|
5122
5311
|
"description": "The set of annotations present on this CRL.",
|
|
5123
5312
|
"title": "Annotations.",
|
|
5124
5313
|
"x-displayname": "Annotations.",
|
|
5314
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
5315
|
+
"x-f5xc-description-short": "The set of annotations present on this CRL.",
|
|
5125
5316
|
"x-f5xc-required-for": {
|
|
5126
5317
|
"minimum_config": false,
|
|
5127
5318
|
"create": false,
|
|
@@ -5144,7 +5335,7 @@
|
|
|
5144
5335
|
},
|
|
5145
5336
|
"x-original-maxLength": 1024,
|
|
5146
5337
|
"x-reconciled-from-discovery": true,
|
|
5147
|
-
"x-reconciled-at": "2026-01-
|
|
5338
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070728+00:00"
|
|
5148
5339
|
},
|
|
5149
5340
|
"disabled": {
|
|
5150
5341
|
"type": "boolean",
|
|
@@ -5152,6 +5343,8 @@
|
|
|
5152
5343
|
"title": "Disabled",
|
|
5153
5344
|
"format": "boolean",
|
|
5154
5345
|
"x-displayname": "Disabled",
|
|
5346
|
+
"x-f5xc-example": "True",
|
|
5347
|
+
"x-f5xc-description-short": "Value of true indicates CRL is administratively disabled.",
|
|
5155
5348
|
"x-f5xc-required-for": {
|
|
5156
5349
|
"minimum_config": false,
|
|
5157
5350
|
"create": false,
|
|
@@ -5167,6 +5360,7 @@
|
|
|
5167
5360
|
"description": "The set of labels present on this CRL.",
|
|
5168
5361
|
"title": "Labels",
|
|
5169
5362
|
"x-displayname": "Labels",
|
|
5363
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
5170
5364
|
"x-f5xc-required-for": {
|
|
5171
5365
|
"minimum_config": false,
|
|
5172
5366
|
"create": false,
|
|
@@ -5194,7 +5388,7 @@
|
|
|
5194
5388
|
},
|
|
5195
5389
|
"x-original-maxLength": 1024,
|
|
5196
5390
|
"x-reconciled-from-discovery": true,
|
|
5197
|
-
"x-reconciled-at": "2026-01-
|
|
5391
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070739+00:00"
|
|
5198
5392
|
},
|
|
5199
5393
|
"namespace": {
|
|
5200
5394
|
"type": "string",
|
|
@@ -5213,7 +5407,7 @@
|
|
|
5213
5407
|
},
|
|
5214
5408
|
"x-original-maxLength": 1024,
|
|
5215
5409
|
"x-reconciled-from-discovery": true,
|
|
5216
|
-
"x-reconciled-at": "2026-01-
|
|
5410
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070744+00:00"
|
|
5217
5411
|
},
|
|
5218
5412
|
"owner_view": {
|
|
5219
5413
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -5226,6 +5420,7 @@
|
|
|
5226
5420
|
"$ref": "#/components/schemas/crlStatusObject"
|
|
5227
5421
|
},
|
|
5228
5422
|
"x-displayname": "Status",
|
|
5423
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
5229
5424
|
"x-f5xc-required-for": {
|
|
5230
5425
|
"minimum_config": false,
|
|
5231
5426
|
"create": false,
|
|
@@ -5254,7 +5449,7 @@
|
|
|
5254
5449
|
"x-field-mutability": "read-only",
|
|
5255
5450
|
"x-original-maxLength": 1024,
|
|
5256
5451
|
"x-reconciled-from-discovery": true,
|
|
5257
|
-
"x-reconciled-at": "2026-01-
|
|
5452
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070752+00:00"
|
|
5258
5453
|
},
|
|
5259
5454
|
"uid": {
|
|
5260
5455
|
"type": "string",
|
|
@@ -5275,9 +5470,11 @@
|
|
|
5275
5470
|
"x-original-maxLength": 1024,
|
|
5276
5471
|
"format": "uuid",
|
|
5277
5472
|
"x-reconciled-from-discovery": true,
|
|
5278
|
-
"x-reconciled-at": "2026-01-
|
|
5473
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070757+00:00"
|
|
5279
5474
|
}
|
|
5280
5475
|
},
|
|
5476
|
+
"x-f5xc-description-short": "By default a summary of CRL is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
5477
|
+
"x-f5xc-description-medium": "By default a summary of CRL is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
5281
5478
|
"x-f5xc-minimum-configuration": {
|
|
5282
5479
|
"description": "Minimum configuration for crlListResponseItem",
|
|
5283
5480
|
"required_fields": [
|
|
@@ -5395,6 +5592,7 @@
|
|
|
5395
5592
|
"ves.io.schema.rules.string.hostname_or_ip": "true",
|
|
5396
5593
|
"ves.io.schema.rules.string.max_len": "255"
|
|
5397
5594
|
},
|
|
5595
|
+
"x-f5xc-description-short": "CRL server address or hostname Required: YES.",
|
|
5398
5596
|
"minLength": 0,
|
|
5399
5597
|
"x-f5xc-required-for": {
|
|
5400
5598
|
"minimum_config": false,
|
|
@@ -5509,6 +5707,7 @@
|
|
|
5509
5707
|
}
|
|
5510
5708
|
}
|
|
5511
5709
|
},
|
|
5710
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
5512
5711
|
"x-f5xc-minimum-configuration": {
|
|
5513
5712
|
"description": "Minimum configuration for crlStatusObject",
|
|
5514
5713
|
"required_fields": [
|
|
@@ -5530,6 +5729,8 @@
|
|
|
5530
5729
|
"type_url": {
|
|
5531
5730
|
"type": "string",
|
|
5532
5731
|
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.",
|
|
5732
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
5733
|
+
"x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).",
|
|
5533
5734
|
"minLength": 0,
|
|
5534
5735
|
"maxLength": 1024,
|
|
5535
5736
|
"x-f5xc-required-for": {
|
|
@@ -5553,9 +5754,11 @@
|
|
|
5553
5754
|
},
|
|
5554
5755
|
"x-original-maxLength": 1024,
|
|
5555
5756
|
"x-reconciled-from-discovery": true,
|
|
5556
|
-
"x-reconciled-at": "2026-01-
|
|
5757
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070780+00:00"
|
|
5557
5758
|
}
|
|
5558
5759
|
},
|
|
5760
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
5761
|
+
"x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...",
|
|
5559
5762
|
"x-f5xc-minimum-configuration": {
|
|
5560
5763
|
"description": "Minimum configuration for protobufAny",
|
|
5561
5764
|
"required_fields": [
|
|
@@ -5581,6 +5784,8 @@
|
|
|
5581
5784
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
5582
5785
|
"title": "Hostname",
|
|
5583
5786
|
"x-displayname": "Hostname",
|
|
5787
|
+
"x-f5xc-example": "example-resource",
|
|
5788
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
5584
5789
|
"minLength": 0,
|
|
5585
5790
|
"maxLength": 1024,
|
|
5586
5791
|
"x-f5xc-required-for": {
|
|
@@ -5612,6 +5817,8 @@
|
|
|
5612
5817
|
"x-displayname": "Reason",
|
|
5613
5818
|
"x-ves-example": "Value",
|
|
5614
5819
|
"x-f5xc-example": "value",
|
|
5820
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
5821
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
5615
5822
|
"minLength": 0,
|
|
5616
5823
|
"maxLength": 43,
|
|
5617
5824
|
"x-f5xc-required-for": {
|
|
@@ -5622,13 +5829,15 @@
|
|
|
5622
5829
|
},
|
|
5623
5830
|
"x-original-maxLength": 1024,
|
|
5624
5831
|
"x-reconciled-from-discovery": true,
|
|
5625
|
-
"x-reconciled-at": "2026-01-
|
|
5832
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070788+00:00"
|
|
5626
5833
|
},
|
|
5627
5834
|
"service_name": {
|
|
5628
5835
|
"type": "string",
|
|
5629
5836
|
"description": "Name of the service that sent the status.",
|
|
5630
5837
|
"title": "Service name.",
|
|
5631
5838
|
"x-displayname": "Service Name.",
|
|
5839
|
+
"x-f5xc-example": "example-resource",
|
|
5840
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
5632
5841
|
"minLength": 0,
|
|
5633
5842
|
"maxLength": 1024,
|
|
5634
5843
|
"x-f5xc-required-for": {
|
|
@@ -5651,6 +5860,8 @@
|
|
|
5651
5860
|
"x-validation-rules": {
|
|
5652
5861
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
5653
5862
|
},
|
|
5863
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
5864
|
+
"x-f5xc-description-medium": "Status of the condition \"Success\" Validtion has succeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...",
|
|
5654
5865
|
"minLength": 0,
|
|
5655
5866
|
"maxLength": 17,
|
|
5656
5867
|
"x-f5xc-required-for": {
|
|
@@ -5661,7 +5872,7 @@
|
|
|
5661
5872
|
},
|
|
5662
5873
|
"x-original-maxLength": 1024,
|
|
5663
5874
|
"x-reconciled-from-discovery": true,
|
|
5664
|
-
"x-reconciled-at": "2026-01-
|
|
5875
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070794+00:00"
|
|
5665
5876
|
},
|
|
5666
5877
|
"type": {
|
|
5667
5878
|
"type": "string",
|
|
@@ -5676,6 +5887,8 @@
|
|
|
5676
5887
|
"x-validation-rules": {
|
|
5677
5888
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
5678
5889
|
},
|
|
5890
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
5891
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
5679
5892
|
"minLength": 0,
|
|
5680
5893
|
"maxLength": 1024,
|
|
5681
5894
|
"x-f5xc-required-for": {
|
|
@@ -5686,6 +5899,8 @@
|
|
|
5686
5899
|
}
|
|
5687
5900
|
}
|
|
5688
5901
|
},
|
|
5902
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
5903
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
5689
5904
|
"x-f5xc-minimum-configuration": {
|
|
5690
5905
|
"description": "Minimum configuration for schemaConditionType",
|
|
5691
5906
|
"required_fields": [
|
|
@@ -5721,6 +5936,8 @@
|
|
|
5721
5936
|
"default": "EOK",
|
|
5722
5937
|
"x-displayname": "Error Code.",
|
|
5723
5938
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
5939
|
+
"x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...",
|
|
5940
|
+
"x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...",
|
|
5724
5941
|
"x-f5xc-minimum-configuration": {
|
|
5725
5942
|
"description": "Minimum configuration for schemaErrorCode",
|
|
5726
5943
|
"required_fields": [],
|
|
@@ -5761,6 +5978,7 @@
|
|
|
5761
5978
|
}
|
|
5762
5979
|
}
|
|
5763
5980
|
},
|
|
5981
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
5764
5982
|
"x-f5xc-minimum-configuration": {
|
|
5765
5983
|
"description": "Minimum configuration for schemaErrorType",
|
|
5766
5984
|
"required_fields": [
|
|
@@ -5788,6 +6006,7 @@
|
|
|
5788
6006
|
"title": "Name",
|
|
5789
6007
|
"x-displayname": "Name",
|
|
5790
6008
|
"x-f5xc-example": "example-resource",
|
|
6009
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
5791
6010
|
"minLength": 0,
|
|
5792
6011
|
"maxLength": 16,
|
|
5793
6012
|
"x-f5xc-required-for": {
|
|
@@ -5798,9 +6017,10 @@
|
|
|
5798
6017
|
},
|
|
5799
6018
|
"x-original-maxLength": 1024,
|
|
5800
6019
|
"x-reconciled-from-discovery": true,
|
|
5801
|
-
"x-reconciled-at": "2026-01-
|
|
6020
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070806+00:00"
|
|
5802
6021
|
}
|
|
5803
6022
|
},
|
|
6023
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
5804
6024
|
"x-f5xc-minimum-configuration": {
|
|
5805
6025
|
"description": "Minimum configuration for schemaInitializerType",
|
|
5806
6026
|
"required_fields": [
|
|
@@ -5828,6 +6048,8 @@
|
|
|
5828
6048
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
5829
6049
|
},
|
|
5830
6050
|
"x-displayname": "Pending",
|
|
6051
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
6052
|
+
"x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.",
|
|
5831
6053
|
"x-f5xc-required-for": {
|
|
5832
6054
|
"minimum_config": false,
|
|
5833
6055
|
"create": false,
|
|
@@ -5839,6 +6061,7 @@
|
|
|
5839
6061
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
5840
6062
|
}
|
|
5841
6063
|
},
|
|
6064
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
5842
6065
|
"x-f5xc-minimum-configuration": {
|
|
5843
6066
|
"description": "Minimum configuration for schemaInitializersType",
|
|
5844
6067
|
"required_fields": [
|
|
@@ -5877,6 +6100,8 @@
|
|
|
5877
6100
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
5878
6101
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
5879
6102
|
},
|
|
6103
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
6104
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
5880
6105
|
"x-f5xc-required-for": {
|
|
5881
6106
|
"minimum_config": false,
|
|
5882
6107
|
"create": false,
|
|
@@ -5898,6 +6123,7 @@
|
|
|
5898
6123
|
"x-validation-rules": {
|
|
5899
6124
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
5900
6125
|
},
|
|
6126
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
5901
6127
|
"minLength": 0,
|
|
5902
6128
|
"x-f5xc-required-for": {
|
|
5903
6129
|
"minimum_config": false,
|
|
@@ -5907,7 +6133,7 @@
|
|
|
5907
6133
|
},
|
|
5908
6134
|
"x-original-maxLength": 1200,
|
|
5909
6135
|
"x-reconciled-from-discovery": true,
|
|
5910
|
-
"x-reconciled-at": "2026-01-
|
|
6136
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070816+00:00"
|
|
5911
6137
|
},
|
|
5912
6138
|
"disable": {
|
|
5913
6139
|
"type": "boolean",
|
|
@@ -5916,6 +6142,7 @@
|
|
|
5916
6142
|
"format": "boolean",
|
|
5917
6143
|
"x-displayname": "Disable",
|
|
5918
6144
|
"x-f5xc-example": "true",
|
|
6145
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
5919
6146
|
"x-f5xc-required-for": {
|
|
5920
6147
|
"minimum_config": false,
|
|
5921
6148
|
"create": false,
|
|
@@ -5929,6 +6156,8 @@
|
|
|
5929
6156
|
"title": "Labels",
|
|
5930
6157
|
"x-displayname": "Labels",
|
|
5931
6158
|
"x-f5xc-example": "value",
|
|
6159
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
6160
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
5932
6161
|
"x-f5xc-required-for": {
|
|
5933
6162
|
"minimum_config": false,
|
|
5934
6163
|
"create": false,
|
|
@@ -5950,6 +6179,8 @@
|
|
|
5950
6179
|
"x-validation-rules": {
|
|
5951
6180
|
"ves.io.schema.rules.message.required": "true"
|
|
5952
6181
|
},
|
|
6182
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6183
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
5953
6184
|
"minLength": 0,
|
|
5954
6185
|
"maxLength": 16,
|
|
5955
6186
|
"x-f5xc-required-for": {
|
|
@@ -5960,7 +6191,7 @@
|
|
|
5960
6191
|
},
|
|
5961
6192
|
"x-original-maxLength": 1024,
|
|
5962
6193
|
"x-reconciled-from-discovery": true,
|
|
5963
|
-
"x-reconciled-at": "2026-01-
|
|
6194
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070823+00:00"
|
|
5964
6195
|
},
|
|
5965
6196
|
"namespace": {
|
|
5966
6197
|
"type": "string",
|
|
@@ -5969,6 +6200,8 @@
|
|
|
5969
6200
|
"x-displayname": "Namespace",
|
|
5970
6201
|
"x-ves-example": "Staging",
|
|
5971
6202
|
"x-f5xc-example": "staging",
|
|
6203
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6204
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
5972
6205
|
"minLength": 0,
|
|
5973
6206
|
"maxLength": 6,
|
|
5974
6207
|
"x-f5xc-required-for": {
|
|
@@ -5979,9 +6212,10 @@
|
|
|
5979
6212
|
},
|
|
5980
6213
|
"x-original-maxLength": 1024,
|
|
5981
6214
|
"x-reconciled-from-discovery": true,
|
|
5982
|
-
"x-reconciled-at": "2026-01-
|
|
6215
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070827+00:00"
|
|
5983
6216
|
}
|
|
5984
6217
|
},
|
|
6218
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
5985
6219
|
"x-f5xc-minimum-configuration": {
|
|
5986
6220
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
5987
6221
|
"required_fields": [
|
|
@@ -6025,6 +6259,8 @@
|
|
|
6025
6259
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6026
6260
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6027
6261
|
},
|
|
6262
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
6263
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
6028
6264
|
"x-f5xc-required-for": {
|
|
6029
6265
|
"minimum_config": false,
|
|
6030
6266
|
"create": false,
|
|
@@ -6046,6 +6282,7 @@
|
|
|
6046
6282
|
"x-validation-rules": {
|
|
6047
6283
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6048
6284
|
},
|
|
6285
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
6049
6286
|
"minLength": 0,
|
|
6050
6287
|
"x-f5xc-required-for": {
|
|
6051
6288
|
"minimum_config": false,
|
|
@@ -6055,7 +6292,7 @@
|
|
|
6055
6292
|
},
|
|
6056
6293
|
"x-original-maxLength": 1200,
|
|
6057
6294
|
"x-reconciled-from-discovery": true,
|
|
6058
|
-
"x-reconciled-at": "2026-01-
|
|
6295
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070834+00:00"
|
|
6059
6296
|
},
|
|
6060
6297
|
"disable": {
|
|
6061
6298
|
"type": "boolean",
|
|
@@ -6065,6 +6302,7 @@
|
|
|
6065
6302
|
"x-displayname": "Disable",
|
|
6066
6303
|
"x-ves-example": "True",
|
|
6067
6304
|
"x-f5xc-example": "true",
|
|
6305
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
6068
6306
|
"x-f5xc-required-for": {
|
|
6069
6307
|
"minimum_config": false,
|
|
6070
6308
|
"create": false,
|
|
@@ -6079,6 +6317,8 @@
|
|
|
6079
6317
|
"x-displayname": "Labels",
|
|
6080
6318
|
"x-ves-example": "Value",
|
|
6081
6319
|
"x-f5xc-example": "value",
|
|
6320
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
6321
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
6082
6322
|
"x-f5xc-required-for": {
|
|
6083
6323
|
"minimum_config": false,
|
|
6084
6324
|
"create": false,
|
|
@@ -6100,6 +6340,8 @@
|
|
|
6100
6340
|
"x-validation-rules": {
|
|
6101
6341
|
"ves.io.schema.rules.message.required": "true"
|
|
6102
6342
|
},
|
|
6343
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6344
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
6103
6345
|
"minLength": 0,
|
|
6104
6346
|
"maxLength": 16,
|
|
6105
6347
|
"x-f5xc-required-for": {
|
|
@@ -6110,7 +6352,7 @@
|
|
|
6110
6352
|
},
|
|
6111
6353
|
"x-original-maxLength": 1024,
|
|
6112
6354
|
"x-reconciled-from-discovery": true,
|
|
6113
|
-
"x-reconciled-at": "2026-01-
|
|
6355
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070841+00:00"
|
|
6114
6356
|
},
|
|
6115
6357
|
"namespace": {
|
|
6116
6358
|
"type": "string",
|
|
@@ -6119,6 +6361,8 @@
|
|
|
6119
6361
|
"x-displayname": "Namespace",
|
|
6120
6362
|
"x-ves-example": "Staging",
|
|
6121
6363
|
"x-f5xc-example": "staging",
|
|
6364
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6365
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
6122
6366
|
"minLength": 0,
|
|
6123
6367
|
"maxLength": 6,
|
|
6124
6368
|
"x-f5xc-required-for": {
|
|
@@ -6129,9 +6373,10 @@
|
|
|
6129
6373
|
},
|
|
6130
6374
|
"x-original-maxLength": 1024,
|
|
6131
6375
|
"x-reconciled-from-discovery": true,
|
|
6132
|
-
"x-reconciled-at": "2026-01-
|
|
6376
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070845+00:00"
|
|
6133
6377
|
}
|
|
6134
6378
|
},
|
|
6379
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
6135
6380
|
"x-f5xc-minimum-configuration": {
|
|
6136
6381
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
6137
6382
|
"required_fields": [
|
|
@@ -6163,6 +6408,8 @@
|
|
|
6163
6408
|
"x-displayname": "Kind",
|
|
6164
6409
|
"x-ves-example": "Virtual_site.",
|
|
6165
6410
|
"x-f5xc-example": "virtual_site",
|
|
6411
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
|
|
6412
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
|
|
6166
6413
|
"minLength": 0,
|
|
6167
6414
|
"maxLength": 14,
|
|
6168
6415
|
"x-f5xc-required-for": {
|
|
@@ -6174,7 +6421,7 @@
|
|
|
6174
6421
|
"readOnly": true,
|
|
6175
6422
|
"x-original-maxLength": 1024,
|
|
6176
6423
|
"x-reconciled-from-discovery": true,
|
|
6177
|
-
"x-reconciled-at": "2026-01-
|
|
6424
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070849+00:00"
|
|
6178
6425
|
},
|
|
6179
6426
|
"name": {
|
|
6180
6427
|
"type": "string",
|
|
@@ -6183,6 +6430,8 @@
|
|
|
6183
6430
|
"x-displayname": "Name",
|
|
6184
6431
|
"x-ves-example": "Contactus-route.",
|
|
6185
6432
|
"x-f5xc-example": "contactus-route",
|
|
6433
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
6434
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
6186
6435
|
"minLength": 0,
|
|
6187
6436
|
"maxLength": 16,
|
|
6188
6437
|
"x-f5xc-required-for": {
|
|
@@ -6193,7 +6442,7 @@
|
|
|
6193
6442
|
},
|
|
6194
6443
|
"x-original-maxLength": 1024,
|
|
6195
6444
|
"x-reconciled-from-discovery": true,
|
|
6196
|
-
"x-reconciled-at": "2026-01-
|
|
6445
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070853+00:00"
|
|
6197
6446
|
},
|
|
6198
6447
|
"namespace": {
|
|
6199
6448
|
"type": "string",
|
|
@@ -6202,6 +6451,8 @@
|
|
|
6202
6451
|
"x-displayname": "Namespace",
|
|
6203
6452
|
"x-ves-example": "Ns1",
|
|
6204
6453
|
"x-f5xc-example": "ns1",
|
|
6454
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
6455
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
6205
6456
|
"minLength": 0,
|
|
6206
6457
|
"maxLength": 6,
|
|
6207
6458
|
"x-f5xc-required-for": {
|
|
@@ -6212,7 +6463,7 @@
|
|
|
6212
6463
|
},
|
|
6213
6464
|
"x-original-maxLength": 1024,
|
|
6214
6465
|
"x-reconciled-from-discovery": true,
|
|
6215
|
-
"x-reconciled-at": "2026-01-
|
|
6466
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070857+00:00"
|
|
6216
6467
|
},
|
|
6217
6468
|
"tenant": {
|
|
6218
6469
|
"type": "string",
|
|
@@ -6221,6 +6472,8 @@
|
|
|
6221
6472
|
"x-displayname": "Tenant",
|
|
6222
6473
|
"x-ves-example": "Example-corp.",
|
|
6223
6474
|
"x-f5xc-example": "example-corp",
|
|
6475
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
6476
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
6224
6477
|
"minLength": 0,
|
|
6225
6478
|
"maxLength": 18,
|
|
6226
6479
|
"x-f5xc-required-for": {
|
|
@@ -6233,7 +6486,7 @@
|
|
|
6233
6486
|
"x-field-mutability": "read-only",
|
|
6234
6487
|
"x-original-maxLength": 1024,
|
|
6235
6488
|
"x-reconciled-from-discovery": true,
|
|
6236
|
-
"x-reconciled-at": "2026-01-
|
|
6489
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070861+00:00"
|
|
6237
6490
|
},
|
|
6238
6491
|
"uid": {
|
|
6239
6492
|
"type": "string",
|
|
@@ -6242,6 +6495,8 @@
|
|
|
6242
6495
|
"x-displayname": "UID",
|
|
6243
6496
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6244
6497
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6498
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
|
|
6499
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
|
|
6245
6500
|
"minLength": 0,
|
|
6246
6501
|
"maxLength": 36,
|
|
6247
6502
|
"x-f5xc-required-for": {
|
|
@@ -6255,9 +6510,11 @@
|
|
|
6255
6510
|
"x-original-maxLength": 1024,
|
|
6256
6511
|
"format": "uuid",
|
|
6257
6512
|
"x-reconciled-from-discovery": true,
|
|
6258
|
-
"x-reconciled-at": "2026-01-
|
|
6513
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070866+00:00"
|
|
6259
6514
|
}
|
|
6260
6515
|
},
|
|
6516
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
6517
|
+
"x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
|
|
6261
6518
|
"x-f5xc-minimum-configuration": {
|
|
6262
6519
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
6263
6520
|
"required_fields": [
|
|
@@ -6300,6 +6557,8 @@
|
|
|
6300
6557
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
6301
6558
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
6302
6559
|
},
|
|
6560
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
6561
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
6303
6562
|
"x-f5xc-required-for": {
|
|
6304
6563
|
"minimum_config": false,
|
|
6305
6564
|
"create": false,
|
|
@@ -6321,6 +6580,7 @@
|
|
|
6321
6580
|
"x-validation-rules": {
|
|
6322
6581
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
6323
6582
|
},
|
|
6583
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
6324
6584
|
"minLength": 0,
|
|
6325
6585
|
"x-f5xc-required-for": {
|
|
6326
6586
|
"minimum_config": false,
|
|
@@ -6330,7 +6590,7 @@
|
|
|
6330
6590
|
},
|
|
6331
6591
|
"x-original-maxLength": 1200,
|
|
6332
6592
|
"x-reconciled-from-discovery": true,
|
|
6333
|
-
"x-reconciled-at": "2026-01-
|
|
6593
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070873+00:00"
|
|
6334
6594
|
},
|
|
6335
6595
|
"disable": {
|
|
6336
6596
|
"type": "boolean",
|
|
@@ -6339,6 +6599,7 @@
|
|
|
6339
6599
|
"format": "boolean",
|
|
6340
6600
|
"x-displayname": "Disable",
|
|
6341
6601
|
"x-f5xc-example": "true",
|
|
6602
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
6342
6603
|
"x-f5xc-required-for": {
|
|
6343
6604
|
"minimum_config": false,
|
|
6344
6605
|
"create": false,
|
|
@@ -6353,6 +6614,8 @@
|
|
|
6353
6614
|
"x-displayname": "Labels",
|
|
6354
6615
|
"x-ves-example": "Value",
|
|
6355
6616
|
"x-f5xc-example": "value",
|
|
6617
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
6618
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
6356
6619
|
"x-f5xc-required-for": {
|
|
6357
6620
|
"minimum_config": false,
|
|
6358
6621
|
"create": false,
|
|
@@ -6373,6 +6636,8 @@
|
|
|
6373
6636
|
"x-validation-rules": {
|
|
6374
6637
|
"ves.io.schema.rules.message.required": "true"
|
|
6375
6638
|
},
|
|
6639
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
6640
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
6376
6641
|
"minLength": 0,
|
|
6377
6642
|
"maxLength": 16,
|
|
6378
6643
|
"x-f5xc-required-for": {
|
|
@@ -6383,7 +6648,7 @@
|
|
|
6383
6648
|
},
|
|
6384
6649
|
"x-original-maxLength": 1024,
|
|
6385
6650
|
"x-reconciled-from-discovery": true,
|
|
6386
|
-
"x-reconciled-at": "2026-01-
|
|
6651
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070880+00:00"
|
|
6387
6652
|
},
|
|
6388
6653
|
"namespace": {
|
|
6389
6654
|
"type": "string",
|
|
@@ -6392,6 +6657,8 @@
|
|
|
6392
6657
|
"x-displayname": "Namespace",
|
|
6393
6658
|
"x-ves-example": "Staging",
|
|
6394
6659
|
"x-f5xc-example": "staging",
|
|
6660
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
6661
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
6395
6662
|
"minLength": 0,
|
|
6396
6663
|
"maxLength": 6,
|
|
6397
6664
|
"x-f5xc-required-for": {
|
|
@@ -6402,9 +6669,10 @@
|
|
|
6402
6669
|
},
|
|
6403
6670
|
"x-original-maxLength": 1024,
|
|
6404
6671
|
"x-reconciled-from-discovery": true,
|
|
6405
|
-
"x-reconciled-at": "2026-01-
|
|
6672
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070884+00:00"
|
|
6406
6673
|
}
|
|
6407
6674
|
},
|
|
6675
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
6408
6676
|
"x-f5xc-minimum-configuration": {
|
|
6409
6677
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
6410
6678
|
"required_fields": [
|
|
@@ -6435,6 +6703,8 @@
|
|
|
6435
6703
|
"title": "Creation_timestamp.",
|
|
6436
6704
|
"format": "date-time",
|
|
6437
6705
|
"x-displayname": "Creation Timestamp.",
|
|
6706
|
+
"x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
6707
|
+
"x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
6438
6708
|
"minLength": 0,
|
|
6439
6709
|
"maxLength": 1024,
|
|
6440
6710
|
"x-f5xc-required-for": {
|
|
@@ -6452,6 +6722,8 @@
|
|
|
6452
6722
|
"x-displayname": "Creator Class.",
|
|
6453
6723
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
6454
6724
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
6725
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
6726
|
+
"x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.",
|
|
6455
6727
|
"minLength": 0,
|
|
6456
6728
|
"maxLength": 1024,
|
|
6457
6729
|
"x-f5xc-required-for": {
|
|
@@ -6469,6 +6741,8 @@
|
|
|
6469
6741
|
"x-displayname": "Creator ID.",
|
|
6470
6742
|
"x-ves-example": "Ver-instance-1.",
|
|
6471
6743
|
"x-f5xc-example": "ver-instance-1",
|
|
6744
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
6745
|
+
"x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.",
|
|
6472
6746
|
"minLength": 0,
|
|
6473
6747
|
"maxLength": 1024,
|
|
6474
6748
|
"x-f5xc-required-for": {
|
|
@@ -6487,6 +6761,8 @@
|
|
|
6487
6761
|
"description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)",
|
|
6488
6762
|
"title": "Status_id",
|
|
6489
6763
|
"x-displayname": "Status ID",
|
|
6764
|
+
"x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...",
|
|
6765
|
+
"x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).",
|
|
6490
6766
|
"minLength": 0,
|
|
6491
6767
|
"maxLength": 1024,
|
|
6492
6768
|
"x-f5xc-required-for": {
|
|
@@ -6504,6 +6780,7 @@
|
|
|
6504
6780
|
"x-displayname": "UID",
|
|
6505
6781
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6506
6782
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6783
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
6507
6784
|
"minLength": 0,
|
|
6508
6785
|
"maxLength": 36,
|
|
6509
6786
|
"x-f5xc-required-for": {
|
|
@@ -6516,13 +6793,14 @@
|
|
|
6516
6793
|
"x-original-maxLength": 1024,
|
|
6517
6794
|
"format": "uuid",
|
|
6518
6795
|
"x-reconciled-from-discovery": true,
|
|
6519
|
-
"x-reconciled-at": "2026-01-
|
|
6796
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070896+00:00"
|
|
6520
6797
|
},
|
|
6521
6798
|
"vtrp_id": {
|
|
6522
6799
|
"type": "string",
|
|
6523
6800
|
"description": "Origin of this status exchanged by VTRP.",
|
|
6524
6801
|
"title": "Vtrp_id",
|
|
6525
6802
|
"x-displayname": "VTRP ID",
|
|
6803
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
6526
6804
|
"minLength": 0,
|
|
6527
6805
|
"maxLength": 1024,
|
|
6528
6806
|
"x-f5xc-required-for": {
|
|
@@ -6539,6 +6817,7 @@
|
|
|
6539
6817
|
"title": "Vtrp_stale.",
|
|
6540
6818
|
"format": "boolean",
|
|
6541
6819
|
"x-displayname": "VTRP Stale.",
|
|
6820
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
6542
6821
|
"x-f5xc-required-for": {
|
|
6543
6822
|
"minimum_config": false,
|
|
6544
6823
|
"create": false,
|
|
@@ -6547,6 +6826,7 @@
|
|
|
6547
6826
|
}
|
|
6548
6827
|
}
|
|
6549
6828
|
},
|
|
6829
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
6550
6830
|
"x-f5xc-minimum-configuration": {
|
|
6551
6831
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
6552
6832
|
"required_fields": [
|
|
@@ -6577,6 +6857,8 @@
|
|
|
6577
6857
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
6578
6858
|
"x-displayname": "Status Publish Type.",
|
|
6579
6859
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
6860
|
+
"x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.",
|
|
6861
|
+
"x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.",
|
|
6580
6862
|
"x-f5xc-minimum-configuration": {
|
|
6581
6863
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
6582
6864
|
"required_fields": [],
|
|
@@ -6602,6 +6884,7 @@
|
|
|
6602
6884
|
"x-displayname": "Code",
|
|
6603
6885
|
"x-ves-example": "0",
|
|
6604
6886
|
"x-f5xc-example": "0",
|
|
6887
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
6605
6888
|
"minimum": 0,
|
|
6606
6889
|
"maximum": 2147483647,
|
|
6607
6890
|
"x-f5xc-required-for": {
|
|
@@ -6618,6 +6901,8 @@
|
|
|
6618
6901
|
"x-displayname": "Reason",
|
|
6619
6902
|
"x-ves-example": "Value",
|
|
6620
6903
|
"x-f5xc-example": "value",
|
|
6904
|
+
"x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
6905
|
+
"x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
6621
6906
|
"minLength": 0,
|
|
6622
6907
|
"maxLength": 43,
|
|
6623
6908
|
"x-f5xc-required-for": {
|
|
@@ -6628,7 +6913,7 @@
|
|
|
6628
6913
|
},
|
|
6629
6914
|
"x-original-maxLength": 1024,
|
|
6630
6915
|
"x-reconciled-from-discovery": true,
|
|
6631
|
-
"x-reconciled-at": "2026-01-
|
|
6916
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070905+00:00"
|
|
6632
6917
|
},
|
|
6633
6918
|
"status": {
|
|
6634
6919
|
"type": "string",
|
|
@@ -6637,6 +6922,7 @@
|
|
|
6637
6922
|
"x-displayname": "Status",
|
|
6638
6923
|
"x-ves-example": "Value",
|
|
6639
6924
|
"x-f5xc-example": "value",
|
|
6925
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
6640
6926
|
"minLength": 0,
|
|
6641
6927
|
"maxLength": 17,
|
|
6642
6928
|
"x-f5xc-required-for": {
|
|
@@ -6647,9 +6933,10 @@
|
|
|
6647
6933
|
},
|
|
6648
6934
|
"x-original-maxLength": 1024,
|
|
6649
6935
|
"x-reconciled-from-discovery": true,
|
|
6650
|
-
"x-reconciled-at": "2026-01-
|
|
6936
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070909+00:00"
|
|
6651
6937
|
}
|
|
6652
6938
|
},
|
|
6939
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
6653
6940
|
"x-f5xc-minimum-configuration": {
|
|
6654
6941
|
"description": "Minimum configuration for schemaStatusType",
|
|
6655
6942
|
"required_fields": [
|
|
@@ -6677,6 +6964,8 @@
|
|
|
6677
6964
|
"title": "Creation_timestamp.",
|
|
6678
6965
|
"format": "date-time",
|
|
6679
6966
|
"x-displayname": "Creation Timestamp.",
|
|
6967
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
6968
|
+
"x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.",
|
|
6680
6969
|
"minLength": 0,
|
|
6681
6970
|
"maxLength": 1024,
|
|
6682
6971
|
"x-f5xc-required-for": {
|
|
@@ -6694,6 +6983,7 @@
|
|
|
6694
6983
|
"x-displayname": "Creator Class.",
|
|
6695
6984
|
"x-ves-example": "Prism",
|
|
6696
6985
|
"x-f5xc-example": "value",
|
|
6986
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
6697
6987
|
"minLength": 0,
|
|
6698
6988
|
"maxLength": 1024,
|
|
6699
6989
|
"x-f5xc-required-for": {
|
|
@@ -6711,6 +7001,7 @@
|
|
|
6711
7001
|
"x-displayname": "Creator ID.",
|
|
6712
7002
|
"x-ves-example": "Admin@example-corp.com.",
|
|
6713
7003
|
"x-f5xc-example": "value",
|
|
7004
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
6714
7005
|
"minLength": 0,
|
|
6715
7006
|
"maxLength": 1024,
|
|
6716
7007
|
"x-f5xc-required-for": {
|
|
@@ -6727,6 +7018,8 @@
|
|
|
6727
7018
|
"title": "Deletion_timestamp.",
|
|
6728
7019
|
"format": "date-time",
|
|
6729
7020
|
"x-displayname": "Deletion Timestamp.",
|
|
7021
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
7022
|
+
"x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...",
|
|
6730
7023
|
"minLength": 0,
|
|
6731
7024
|
"maxLength": 1024,
|
|
6732
7025
|
"x-f5xc-required-for": {
|
|
@@ -6746,6 +7039,8 @@
|
|
|
6746
7039
|
"x-displayname": "Finalizers.",
|
|
6747
7040
|
"x-ves-example": "Value",
|
|
6748
7041
|
"x-f5xc-example": "value",
|
|
7042
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
7043
|
+
"x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.",
|
|
6749
7044
|
"x-f5xc-required-for": {
|
|
6750
7045
|
"minimum_config": false,
|
|
6751
7046
|
"create": false,
|
|
@@ -6763,6 +7058,8 @@
|
|
|
6763
7058
|
"x-displayname": "Labels",
|
|
6764
7059
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
6765
7060
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
7061
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.",
|
|
7062
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).",
|
|
6766
7063
|
"x-f5xc-required-for": {
|
|
6767
7064
|
"minimum_config": false,
|
|
6768
7065
|
"create": false,
|
|
@@ -6776,6 +7073,8 @@
|
|
|
6776
7073
|
"title": "Modification_timestamp.",
|
|
6777
7074
|
"format": "date-time",
|
|
6778
7075
|
"x-displayname": "Modification Timestamp.",
|
|
7076
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
7077
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
6779
7078
|
"minLength": 0,
|
|
6780
7079
|
"maxLength": 1024,
|
|
6781
7080
|
"x-f5xc-required-for": {
|
|
@@ -6794,6 +7093,8 @@
|
|
|
6794
7093
|
"x-displayname": "Object Index.",
|
|
6795
7094
|
"x-ves-example": "0",
|
|
6796
7095
|
"x-f5xc-example": "0",
|
|
7096
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
7097
|
+
"x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.",
|
|
6797
7098
|
"minimum": 0,
|
|
6798
7099
|
"maximum": 2147483647,
|
|
6799
7100
|
"x-f5xc-required-for": {
|
|
@@ -6814,6 +7115,8 @@
|
|
|
6814
7115
|
"x-displayname": "Tenant",
|
|
6815
7116
|
"x-ves-example": "Example-corp.",
|
|
6816
7117
|
"x-f5xc-example": "example-corp",
|
|
7118
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
7119
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
6817
7120
|
"minLength": 0,
|
|
6818
7121
|
"maxLength": 18,
|
|
6819
7122
|
"x-f5xc-required-for": {
|
|
@@ -6825,7 +7128,7 @@
|
|
|
6825
7128
|
"x-field-mutability": "read-only",
|
|
6826
7129
|
"x-original-maxLength": 1024,
|
|
6827
7130
|
"x-reconciled-from-discovery": true,
|
|
6828
|
-
"x-reconciled-at": "2026-01-
|
|
7131
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070928+00:00"
|
|
6829
7132
|
},
|
|
6830
7133
|
"uid": {
|
|
6831
7134
|
"type": "string",
|
|
@@ -6834,6 +7137,8 @@
|
|
|
6834
7137
|
"x-displayname": "UID",
|
|
6835
7138
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6836
7139
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
7140
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
7141
|
+
"x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.",
|
|
6837
7142
|
"minLength": 0,
|
|
6838
7143
|
"maxLength": 36,
|
|
6839
7144
|
"x-f5xc-required-for": {
|
|
@@ -6846,9 +7151,11 @@
|
|
|
6846
7151
|
"x-original-maxLength": 1024,
|
|
6847
7152
|
"format": "uuid",
|
|
6848
7153
|
"x-reconciled-from-discovery": true,
|
|
6849
|
-
"x-reconciled-at": "2026-01-
|
|
7154
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070932+00:00"
|
|
6850
7155
|
}
|
|
6851
7156
|
},
|
|
7157
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
7158
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
6852
7159
|
"x-f5xc-minimum-configuration": {
|
|
6853
7160
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
6854
7161
|
"required_fields": [
|
|
@@ -6896,7 +7203,7 @@
|
|
|
6896
7203
|
},
|
|
6897
7204
|
"x-original-maxLength": 1024,
|
|
6898
7205
|
"x-reconciled-from-discovery": true,
|
|
6899
|
-
"x-reconciled-at": "2026-01-
|
|
7206
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070937+00:00"
|
|
6900
7207
|
},
|
|
6901
7208
|
"name": {
|
|
6902
7209
|
"type": "string",
|
|
@@ -6905,6 +7212,8 @@
|
|
|
6905
7212
|
"x-displayname": "Name",
|
|
6906
7213
|
"x-ves-example": "Contactus-route.",
|
|
6907
7214
|
"x-f5xc-example": "contactus-route",
|
|
7215
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
7216
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
6908
7217
|
"minLength": 0,
|
|
6909
7218
|
"maxLength": 16,
|
|
6910
7219
|
"x-f5xc-required-for": {
|
|
@@ -6915,7 +7224,7 @@
|
|
|
6915
7224
|
},
|
|
6916
7225
|
"x-original-maxLength": 1024,
|
|
6917
7226
|
"x-reconciled-from-discovery": true,
|
|
6918
|
-
"x-reconciled-at": "2026-01-
|
|
7227
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070941+00:00"
|
|
6919
7228
|
},
|
|
6920
7229
|
"namespace": {
|
|
6921
7230
|
"type": "string",
|
|
@@ -6924,6 +7233,8 @@
|
|
|
6924
7233
|
"x-displayname": "Namespace",
|
|
6925
7234
|
"x-ves-example": "Ns1",
|
|
6926
7235
|
"x-f5xc-example": "ns1",
|
|
7236
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
7237
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
6927
7238
|
"minLength": 0,
|
|
6928
7239
|
"maxLength": 6,
|
|
6929
7240
|
"x-f5xc-required-for": {
|
|
@@ -6934,7 +7245,7 @@
|
|
|
6934
7245
|
},
|
|
6935
7246
|
"x-original-maxLength": 1024,
|
|
6936
7247
|
"x-reconciled-from-discovery": true,
|
|
6937
|
-
"x-reconciled-at": "2026-01-
|
|
7248
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070945+00:00"
|
|
6938
7249
|
},
|
|
6939
7250
|
"uid": {
|
|
6940
7251
|
"type": "string",
|
|
@@ -6955,9 +7266,10 @@
|
|
|
6955
7266
|
"x-original-maxLength": 1024,
|
|
6956
7267
|
"format": "uuid",
|
|
6957
7268
|
"x-reconciled-from-discovery": true,
|
|
6958
|
-
"x-reconciled-at": "2026-01-
|
|
7269
|
+
"x-reconciled-at": "2026-01-07T15:28:05.070950+00:00"
|
|
6959
7270
|
}
|
|
6960
7271
|
},
|
|
7272
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
6961
7273
|
"x-f5xc-minimum-configuration": {
|
|
6962
7274
|
"description": "Minimum configuration for schemaViewRefType",
|
|
6963
7275
|
"required_fields": [
|
|
@@ -7060,6 +7372,8 @@
|
|
|
7060
7372
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
7061
7373
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
7062
7374
|
},
|
|
7375
|
+
"x-f5xc-description-short": "Certificate. Certificate or certificate chain in PEM format including the PEM headers.",
|
|
7376
|
+
"x-f5xc-description-medium": "Certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
|
|
7063
7377
|
"x-f5xc-required-for": {
|
|
7064
7378
|
"minimum_config": false,
|
|
7065
7379
|
"create": false,
|
|
@@ -7110,6 +7424,7 @@
|
|
|
7110
7424
|
"title": "Fail_if_referred.",
|
|
7111
7425
|
"format": "boolean",
|
|
7112
7426
|
"x-displayname": "Fail-If-Referred.",
|
|
7427
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
7113
7428
|
"x-f5xc-required-for": {
|
|
7114
7429
|
"minimum_config": false,
|
|
7115
7430
|
"create": false,
|
|
@@ -7134,7 +7449,7 @@
|
|
|
7134
7449
|
},
|
|
7135
7450
|
"x-original-maxLength": 1024,
|
|
7136
7451
|
"x-reconciled-from-discovery": true,
|
|
7137
|
-
"x-reconciled-at": "2026-01-
|
|
7452
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469581+00:00"
|
|
7138
7453
|
},
|
|
7139
7454
|
"namespace": {
|
|
7140
7455
|
"type": "string",
|
|
@@ -7143,6 +7458,7 @@
|
|
|
7143
7458
|
"x-displayname": "Namespace",
|
|
7144
7459
|
"x-ves-example": "Ns1",
|
|
7145
7460
|
"x-f5xc-example": "ns1",
|
|
7461
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
7146
7462
|
"minLength": 0,
|
|
7147
7463
|
"maxLength": 6,
|
|
7148
7464
|
"x-f5xc-required-for": {
|
|
@@ -7153,7 +7469,7 @@
|
|
|
7153
7469
|
},
|
|
7154
7470
|
"x-original-maxLength": 1024,
|
|
7155
7471
|
"x-reconciled-from-discovery": true,
|
|
7156
|
-
"x-reconciled-at": "2026-01-
|
|
7472
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469587+00:00"
|
|
7157
7473
|
}
|
|
7158
7474
|
},
|
|
7159
7475
|
"x-f5xc-minimum-configuration": {
|
|
@@ -7188,6 +7504,7 @@
|
|
|
7188
7504
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
7189
7505
|
},
|
|
7190
7506
|
"x-displayname": "Deleted Referred Objects.",
|
|
7507
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
7191
7508
|
"x-f5xc-required-for": {
|
|
7192
7509
|
"minimum_config": false,
|
|
7193
7510
|
"create": false,
|
|
@@ -7203,6 +7520,7 @@
|
|
|
7203
7520
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
7204
7521
|
},
|
|
7205
7522
|
"x-displayname": "Disabled Referred Objects.",
|
|
7523
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
7206
7524
|
"x-f5xc-required-for": {
|
|
7207
7525
|
"minimum_config": false,
|
|
7208
7526
|
"create": false,
|
|
@@ -7221,6 +7539,7 @@
|
|
|
7221
7539
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
7222
7540
|
},
|
|
7223
7541
|
"x-displayname": "Referring Objects.",
|
|
7542
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
7224
7543
|
"x-f5xc-required-for": {
|
|
7225
7544
|
"minimum_config": false,
|
|
7226
7545
|
"create": false,
|
|
@@ -7242,6 +7561,8 @@
|
|
|
7242
7561
|
"$ref": "#/components/schemas/certificateStatusObject"
|
|
7243
7562
|
},
|
|
7244
7563
|
"x-displayname": "Status",
|
|
7564
|
+
"x-f5xc-example": "active",
|
|
7565
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
7245
7566
|
"x-f5xc-required-for": {
|
|
7246
7567
|
"minimum_config": false,
|
|
7247
7568
|
"create": false,
|
|
@@ -7251,7 +7572,7 @@
|
|
|
7251
7572
|
"maxLength": 17,
|
|
7252
7573
|
"minLength": 17,
|
|
7253
7574
|
"x-reconciled-from-discovery": true,
|
|
7254
|
-
"x-reconciled-at": "2026-01-
|
|
7575
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469602+00:00"
|
|
7255
7576
|
},
|
|
7256
7577
|
"system_metadata": {
|
|
7257
7578
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -7291,6 +7612,8 @@
|
|
|
7291
7612
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
7292
7613
|
],
|
|
7293
7614
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
7615
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
7616
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
7294
7617
|
"x-f5xc-minimum-configuration": {
|
|
7295
7618
|
"description": "Minimum configuration for certificateGetResponseFormatCode",
|
|
7296
7619
|
"required_fields": [],
|
|
@@ -7333,6 +7656,8 @@
|
|
|
7333
7656
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
7334
7657
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
7335
7658
|
},
|
|
7659
|
+
"x-f5xc-description-short": "Certificate. Certificate or certificate chain in PEM format including the PEM headers.",
|
|
7660
|
+
"x-f5xc-description-medium": "Certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
|
|
7336
7661
|
"x-f5xc-required-for": {
|
|
7337
7662
|
"minimum_config": false,
|
|
7338
7663
|
"create": false,
|
|
@@ -7353,6 +7678,7 @@
|
|
|
7353
7678
|
"$ref": "#/components/schemas/schemaviewsObjectRefType"
|
|
7354
7679
|
},
|
|
7355
7680
|
"x-displayname": "HTTP Loadbalancers.",
|
|
7681
|
+
"x-f5xc-description-short": "HTTP Loadbalancers using this certificate.",
|
|
7356
7682
|
"x-f5xc-required-for": {
|
|
7357
7683
|
"minimum_config": false,
|
|
7358
7684
|
"create": false,
|
|
@@ -7384,6 +7710,7 @@
|
|
|
7384
7710
|
"$ref": "#/components/schemas/schemaviewsObjectRefType"
|
|
7385
7711
|
},
|
|
7386
7712
|
"x-displayname": "TCP Loadbalancers.",
|
|
7713
|
+
"x-f5xc-description-short": "TCP Loadbalancers using this certificate.",
|
|
7387
7714
|
"x-f5xc-required-for": {
|
|
7388
7715
|
"minimum_config": false,
|
|
7389
7716
|
"create": false,
|
|
@@ -7430,6 +7757,7 @@
|
|
|
7430
7757
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
7431
7758
|
},
|
|
7432
7759
|
"x-displayname": "Errors",
|
|
7760
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
7433
7761
|
"x-f5xc-required-for": {
|
|
7434
7762
|
"minimum_config": false,
|
|
7435
7763
|
"create": false,
|
|
@@ -7445,6 +7773,8 @@
|
|
|
7445
7773
|
"$ref": "#/components/schemas/certificateListResponseItem"
|
|
7446
7774
|
},
|
|
7447
7775
|
"x-displayname": "Items",
|
|
7776
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
7777
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
7448
7778
|
"x-f5xc-required-for": {
|
|
7449
7779
|
"minimum_config": false,
|
|
7450
7780
|
"create": false,
|
|
@@ -7478,6 +7808,8 @@
|
|
|
7478
7808
|
"description": "The set of annotations present on this certificate.",
|
|
7479
7809
|
"title": "Annotations.",
|
|
7480
7810
|
"x-displayname": "Annotations.",
|
|
7811
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7812
|
+
"x-f5xc-description-short": "The set of annotations present on this certificate.",
|
|
7481
7813
|
"x-f5xc-required-for": {
|
|
7482
7814
|
"minimum_config": false,
|
|
7483
7815
|
"create": false,
|
|
@@ -7490,6 +7822,7 @@
|
|
|
7490
7822
|
"description": "The description set for this certificate.",
|
|
7491
7823
|
"title": "Description.",
|
|
7492
7824
|
"x-displayname": "Description.",
|
|
7825
|
+
"x-f5xc-description-short": "The description set for this certificate.",
|
|
7493
7826
|
"minLength": 0,
|
|
7494
7827
|
"maxLength": 0,
|
|
7495
7828
|
"x-f5xc-required-for": {
|
|
@@ -7500,7 +7833,7 @@
|
|
|
7500
7833
|
},
|
|
7501
7834
|
"x-original-maxLength": 1024,
|
|
7502
7835
|
"x-reconciled-from-discovery": true,
|
|
7503
|
-
"x-reconciled-at": "2026-01-
|
|
7836
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469627+00:00"
|
|
7504
7837
|
},
|
|
7505
7838
|
"disabled": {
|
|
7506
7839
|
"type": "boolean",
|
|
@@ -7508,6 +7841,8 @@
|
|
|
7508
7841
|
"title": "Disabled",
|
|
7509
7842
|
"format": "boolean",
|
|
7510
7843
|
"x-displayname": "Disabled",
|
|
7844
|
+
"x-f5xc-example": "True",
|
|
7845
|
+
"x-f5xc-description-short": "Value of true indicates certificate is administratively disabled.",
|
|
7511
7846
|
"x-f5xc-required-for": {
|
|
7512
7847
|
"minimum_config": false,
|
|
7513
7848
|
"create": false,
|
|
@@ -7523,6 +7858,8 @@
|
|
|
7523
7858
|
"description": "The set of labels present on this certificate.",
|
|
7524
7859
|
"title": "Labels",
|
|
7525
7860
|
"x-displayname": "Labels",
|
|
7861
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7862
|
+
"x-f5xc-description-short": "The set of labels present on this certificate.",
|
|
7526
7863
|
"x-f5xc-required-for": {
|
|
7527
7864
|
"minimum_config": false,
|
|
7528
7865
|
"create": false,
|
|
@@ -7550,7 +7887,7 @@
|
|
|
7550
7887
|
},
|
|
7551
7888
|
"x-original-maxLength": 1024,
|
|
7552
7889
|
"x-reconciled-from-discovery": true,
|
|
7553
|
-
"x-reconciled-at": "2026-01-
|
|
7890
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469638+00:00"
|
|
7554
7891
|
},
|
|
7555
7892
|
"namespace": {
|
|
7556
7893
|
"type": "string",
|
|
@@ -7569,7 +7906,7 @@
|
|
|
7569
7906
|
},
|
|
7570
7907
|
"x-original-maxLength": 1024,
|
|
7571
7908
|
"x-reconciled-from-discovery": true,
|
|
7572
|
-
"x-reconciled-at": "2026-01-
|
|
7909
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469642+00:00"
|
|
7573
7910
|
},
|
|
7574
7911
|
"owner_view": {
|
|
7575
7912
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -7582,6 +7919,7 @@
|
|
|
7582
7919
|
"$ref": "#/components/schemas/certificateStatusObject"
|
|
7583
7920
|
},
|
|
7584
7921
|
"x-displayname": "Status",
|
|
7922
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
7585
7923
|
"x-f5xc-required-for": {
|
|
7586
7924
|
"minimum_config": false,
|
|
7587
7925
|
"create": false,
|
|
@@ -7610,7 +7948,7 @@
|
|
|
7610
7948
|
"x-field-mutability": "read-only",
|
|
7611
7949
|
"x-original-maxLength": 1024,
|
|
7612
7950
|
"x-reconciled-from-discovery": true,
|
|
7613
|
-
"x-reconciled-at": "2026-01-
|
|
7951
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469650+00:00"
|
|
7614
7952
|
},
|
|
7615
7953
|
"uid": {
|
|
7616
7954
|
"type": "string",
|
|
@@ -7631,9 +7969,11 @@
|
|
|
7631
7969
|
"x-original-maxLength": 1024,
|
|
7632
7970
|
"format": "uuid",
|
|
7633
7971
|
"x-reconciled-from-discovery": true,
|
|
7634
|
-
"x-reconciled-at": "2026-01-
|
|
7972
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469656+00:00"
|
|
7635
7973
|
}
|
|
7636
7974
|
},
|
|
7975
|
+
"x-f5xc-description-short": "By default a summary of certificate is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
7976
|
+
"x-f5xc-description-medium": "By default a summary of certificate is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
7637
7977
|
"x-f5xc-minimum-configuration": {
|
|
7638
7978
|
"description": "Minimum configuration for certificateListResponseItem",
|
|
7639
7979
|
"required_fields": [
|
|
@@ -7730,6 +8070,8 @@
|
|
|
7730
8070
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
7731
8071
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
7732
8072
|
},
|
|
8073
|
+
"x-f5xc-description-short": "Certificate. Certificate or certificate chain in PEM format including the PEM headers.",
|
|
8074
|
+
"x-f5xc-description-medium": "Certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
|
|
7733
8075
|
"x-f5xc-required-for": {
|
|
7734
8076
|
"minimum_config": false,
|
|
7735
8077
|
"create": false,
|
|
@@ -7782,6 +8124,7 @@
|
|
|
7782
8124
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
7783
8125
|
},
|
|
7784
8126
|
"x-displayname": "Conditions.",
|
|
8127
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
7785
8128
|
"x-f5xc-required-for": {
|
|
7786
8129
|
"minimum_config": false,
|
|
7787
8130
|
"create": false,
|
|
@@ -7808,6 +8151,7 @@
|
|
|
7808
8151
|
}
|
|
7809
8152
|
}
|
|
7810
8153
|
},
|
|
8154
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
7811
8155
|
"x-f5xc-minimum-configuration": {
|
|
7812
8156
|
"description": "Minimum configuration for certificateStatusObject",
|
|
7813
8157
|
"required_fields": [
|
|
@@ -7828,6 +8172,7 @@
|
|
|
7828
8172
|
"title": "Empty",
|
|
7829
8173
|
"x-displayname": "Empty",
|
|
7830
8174
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
8175
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
7831
8176
|
"x-f5xc-minimum-configuration": {
|
|
7832
8177
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
7833
8178
|
"required_fields": [],
|
|
@@ -7852,6 +8197,8 @@
|
|
|
7852
8197
|
"x-displayname": "Kind",
|
|
7853
8198
|
"x-ves-example": "Virtual_site.",
|
|
7854
8199
|
"x-f5xc-example": "virtual_site",
|
|
8200
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
|
|
8201
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
|
|
7855
8202
|
"minLength": 0,
|
|
7856
8203
|
"maxLength": 14,
|
|
7857
8204
|
"x-f5xc-required-for": {
|
|
@@ -7863,7 +8210,7 @@
|
|
|
7863
8210
|
"readOnly": true,
|
|
7864
8211
|
"x-original-maxLength": 1024,
|
|
7865
8212
|
"x-reconciled-from-discovery": true,
|
|
7866
|
-
"x-reconciled-at": "2026-01-
|
|
8213
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469677+00:00"
|
|
7867
8214
|
},
|
|
7868
8215
|
"name": {
|
|
7869
8216
|
"type": "string",
|
|
@@ -7872,6 +8219,8 @@
|
|
|
7872
8219
|
"x-displayname": "Name",
|
|
7873
8220
|
"x-ves-example": "Contactus-route.",
|
|
7874
8221
|
"x-f5xc-example": "contactus-route",
|
|
8222
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
8223
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
7875
8224
|
"minLength": 0,
|
|
7876
8225
|
"maxLength": 16,
|
|
7877
8226
|
"x-f5xc-required-for": {
|
|
@@ -7882,7 +8231,7 @@
|
|
|
7882
8231
|
},
|
|
7883
8232
|
"x-original-maxLength": 1024,
|
|
7884
8233
|
"x-reconciled-from-discovery": true,
|
|
7885
|
-
"x-reconciled-at": "2026-01-
|
|
8234
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469682+00:00"
|
|
7886
8235
|
},
|
|
7887
8236
|
"namespace": {
|
|
7888
8237
|
"type": "string",
|
|
@@ -7891,6 +8240,8 @@
|
|
|
7891
8240
|
"x-displayname": "Namespace",
|
|
7892
8241
|
"x-ves-example": "Ns1",
|
|
7893
8242
|
"x-f5xc-example": "ns1",
|
|
8243
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
8244
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
7894
8245
|
"minLength": 0,
|
|
7895
8246
|
"maxLength": 6,
|
|
7896
8247
|
"x-f5xc-required-for": {
|
|
@@ -7901,7 +8252,7 @@
|
|
|
7901
8252
|
},
|
|
7902
8253
|
"x-original-maxLength": 1024,
|
|
7903
8254
|
"x-reconciled-from-discovery": true,
|
|
7904
|
-
"x-reconciled-at": "2026-01-
|
|
8255
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469686+00:00"
|
|
7905
8256
|
},
|
|
7906
8257
|
"tenant": {
|
|
7907
8258
|
"type": "string",
|
|
@@ -7910,6 +8261,8 @@
|
|
|
7910
8261
|
"x-displayname": "Tenant",
|
|
7911
8262
|
"x-ves-example": "Example-corp.",
|
|
7912
8263
|
"x-f5xc-example": "example-corp",
|
|
8264
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
8265
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
7913
8266
|
"minLength": 0,
|
|
7914
8267
|
"maxLength": 18,
|
|
7915
8268
|
"x-f5xc-required-for": {
|
|
@@ -7922,7 +8275,7 @@
|
|
|
7922
8275
|
"x-field-mutability": "read-only",
|
|
7923
8276
|
"x-original-maxLength": 1024,
|
|
7924
8277
|
"x-reconciled-from-discovery": true,
|
|
7925
|
-
"x-reconciled-at": "2026-01-
|
|
8278
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469690+00:00"
|
|
7926
8279
|
},
|
|
7927
8280
|
"uid": {
|
|
7928
8281
|
"type": "string",
|
|
@@ -7931,6 +8284,8 @@
|
|
|
7931
8284
|
"x-displayname": "UID",
|
|
7932
8285
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7933
8286
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
8287
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
|
|
8288
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
|
|
7934
8289
|
"minLength": 0,
|
|
7935
8290
|
"maxLength": 36,
|
|
7936
8291
|
"x-f5xc-required-for": {
|
|
@@ -7944,9 +8299,11 @@
|
|
|
7944
8299
|
"x-original-maxLength": 1024,
|
|
7945
8300
|
"format": "uuid",
|
|
7946
8301
|
"x-reconciled-from-discovery": true,
|
|
7947
|
-
"x-reconciled-at": "2026-01-
|
|
8302
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469695+00:00"
|
|
7948
8303
|
}
|
|
7949
8304
|
},
|
|
8305
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
8306
|
+
"x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
|
|
7950
8307
|
"x-f5xc-minimum-configuration": {
|
|
7951
8308
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
7952
8309
|
"required_fields": [
|
|
@@ -7978,6 +8335,8 @@
|
|
|
7978
8335
|
"x-displayname": "Decryption Provider.",
|
|
7979
8336
|
"x-ves-example": "Value",
|
|
7980
8337
|
"x-f5xc-example": "value",
|
|
8338
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
8339
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
7981
8340
|
"minLength": 0,
|
|
7982
8341
|
"maxLength": 1024,
|
|
7983
8342
|
"x-f5xc-required-for": {
|
|
@@ -8003,6 +8362,8 @@
|
|
|
8003
8362
|
"ves.io.schema.rules.message.required": "true",
|
|
8004
8363
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
8005
8364
|
},
|
|
8365
|
+
"x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
8366
|
+
"x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
8006
8367
|
"minLength": 0,
|
|
8007
8368
|
"maxLength": 4,
|
|
8008
8369
|
"x-f5xc-required-for": {
|
|
@@ -8013,7 +8374,7 @@
|
|
|
8013
8374
|
},
|
|
8014
8375
|
"x-original-maxLength": 1024,
|
|
8015
8376
|
"x-reconciled-from-discovery": true,
|
|
8016
|
-
"x-reconciled-at": "2026-01-
|
|
8377
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469710+00:00"
|
|
8017
8378
|
},
|
|
8018
8379
|
"store_provider": {
|
|
8019
8380
|
"type": "string",
|
|
@@ -8022,6 +8383,8 @@
|
|
|
8022
8383
|
"x-displayname": "Store Provider.",
|
|
8023
8384
|
"x-ves-example": "Value",
|
|
8024
8385
|
"x-f5xc-example": "value",
|
|
8386
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
8387
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
8025
8388
|
"minLength": 0,
|
|
8026
8389
|
"maxLength": 1024,
|
|
8027
8390
|
"x-f5xc-required-for": {
|
|
@@ -8032,6 +8395,7 @@
|
|
|
8032
8395
|
}
|
|
8033
8396
|
}
|
|
8034
8397
|
},
|
|
8398
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
8035
8399
|
"x-f5xc-minimum-configuration": {
|
|
8036
8400
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
8037
8401
|
"required_fields": [
|
|
@@ -8058,6 +8422,7 @@
|
|
|
8058
8422
|
"description": "Common Name (CN) of this certificate.",
|
|
8059
8423
|
"title": "Common Name.",
|
|
8060
8424
|
"x-displayname": "Common Name.",
|
|
8425
|
+
"x-f5xc-example": "example-resource",
|
|
8061
8426
|
"minLength": 0,
|
|
8062
8427
|
"maxLength": 1024,
|
|
8063
8428
|
"x-f5xc-required-for": {
|
|
@@ -8115,6 +8480,7 @@
|
|
|
8115
8480
|
"description": "Public Key Algorithm of this certificate.",
|
|
8116
8481
|
"title": "Public Key Algorithm.",
|
|
8117
8482
|
"x-displayname": "Public Key Algorithm.",
|
|
8483
|
+
"x-f5xc-description-short": "Public Key Algorithm of this certificate.",
|
|
8118
8484
|
"minLength": 0,
|
|
8119
8485
|
"maxLength": 1024,
|
|
8120
8486
|
"x-f5xc-required-for": {
|
|
@@ -8132,6 +8498,8 @@
|
|
|
8132
8498
|
"type": "string"
|
|
8133
8499
|
},
|
|
8134
8500
|
"x-displayname": "SANs",
|
|
8501
|
+
"x-f5xc-example": "example-resource",
|
|
8502
|
+
"x-f5xc-description-short": "Subject Alternative Names of this certificate.",
|
|
8135
8503
|
"x-f5xc-required-for": {
|
|
8136
8504
|
"minimum_config": false,
|
|
8137
8505
|
"create": false,
|
|
@@ -8172,6 +8540,8 @@
|
|
|
8172
8540
|
"x-displayname": "Provider",
|
|
8173
8541
|
"x-ves-example": "Box-provider.",
|
|
8174
8542
|
"x-f5xc-example": "box-provider",
|
|
8543
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
8544
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
8175
8545
|
"minLength": 0,
|
|
8176
8546
|
"maxLength": 8,
|
|
8177
8547
|
"x-f5xc-required-for": {
|
|
@@ -8182,7 +8552,7 @@
|
|
|
8182
8552
|
},
|
|
8183
8553
|
"x-original-maxLength": 1024,
|
|
8184
8554
|
"x-reconciled-from-discovery": true,
|
|
8185
|
-
"x-reconciled-at": "2026-01-
|
|
8555
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469725+00:00"
|
|
8186
8556
|
},
|
|
8187
8557
|
"url": {
|
|
8188
8558
|
"type": "string",
|
|
@@ -8203,6 +8573,8 @@
|
|
|
8203
8573
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
8204
8574
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
8205
8575
|
},
|
|
8576
|
+
"x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
|
|
8577
|
+
"x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
|
|
8206
8578
|
"format": "uri",
|
|
8207
8579
|
"minLength": 0,
|
|
8208
8580
|
"x-f5xc-required-for": {
|
|
@@ -8213,6 +8585,7 @@
|
|
|
8213
8585
|
}
|
|
8214
8586
|
}
|
|
8215
8587
|
},
|
|
8588
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
8216
8589
|
"x-f5xc-minimum-configuration": {
|
|
8217
8590
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
8218
8591
|
"required_fields": [
|
|
@@ -8238,6 +8611,8 @@
|
|
|
8238
8611
|
"default": "INVALID_HASH_ALGORITHM",
|
|
8239
8612
|
"x-displayname": "Hash Algorithm.",
|
|
8240
8613
|
"x-ves-proto-enum": "ves.io.schema.HashAlgorithm",
|
|
8614
|
+
"x-f5xc-description-short": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
8615
|
+
"x-f5xc-description-medium": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
8241
8616
|
"x-f5xc-minimum-configuration": {
|
|
8242
8617
|
"description": "Minimum configuration for schemaHashAlgorithm",
|
|
8243
8618
|
"required_fields": [],
|
|
@@ -8278,6 +8653,7 @@
|
|
|
8278
8653
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
8279
8654
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
8280
8655
|
},
|
|
8656
|
+
"x-f5xc-description-short": "Ordered list of hash algorithms to be used. Required: YES.",
|
|
8281
8657
|
"x-f5xc-required-for": {
|
|
8282
8658
|
"minimum_config": false,
|
|
8283
8659
|
"create": false,
|
|
@@ -8286,6 +8662,7 @@
|
|
|
8286
8662
|
}
|
|
8287
8663
|
}
|
|
8288
8664
|
},
|
|
8665
|
+
"x-f5xc-description-short": "Specifies the hash algorithms to be used.",
|
|
8289
8666
|
"x-f5xc-minimum-configuration": {
|
|
8290
8667
|
"description": "Minimum configuration for schemaHashAlgorithms",
|
|
8291
8668
|
"required_fields": [
|
|
@@ -8307,6 +8684,8 @@
|
|
|
8307
8684
|
"EncodingBase64"
|
|
8308
8685
|
],
|
|
8309
8686
|
"default": "EncodingNone",
|
|
8687
|
+
"x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
|
|
8688
|
+
"x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
|
|
8310
8689
|
"x-f5xc-minimum-configuration": {
|
|
8311
8690
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
8312
8691
|
"required_fields": [],
|
|
@@ -8332,6 +8711,7 @@
|
|
|
8332
8711
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
8333
8712
|
}
|
|
8334
8713
|
},
|
|
8714
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
8335
8715
|
"x-f5xc-minimum-configuration": {
|
|
8336
8716
|
"description": "Minimum configuration for schemaSecretType",
|
|
8337
8717
|
"required_fields": [
|
|
@@ -8355,6 +8735,8 @@
|
|
|
8355
8735
|
"description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
|
|
8356
8736
|
"title": "Key",
|
|
8357
8737
|
"x-f5xc-example": "key_pem",
|
|
8738
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
|
|
8739
|
+
"x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
|
|
8358
8740
|
"minLength": 0,
|
|
8359
8741
|
"maxLength": 16,
|
|
8360
8742
|
"x-f5xc-required-for": {
|
|
@@ -8365,13 +8747,14 @@
|
|
|
8365
8747
|
},
|
|
8366
8748
|
"x-original-maxLength": 1024,
|
|
8367
8749
|
"x-reconciled-from-discovery": true,
|
|
8368
|
-
"x-reconciled-at": "2026-01-
|
|
8750
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469868+00:00"
|
|
8369
8751
|
},
|
|
8370
8752
|
"location": {
|
|
8371
8753
|
"type": "string",
|
|
8372
8754
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
8373
8755
|
"title": "Location",
|
|
8374
8756
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
8757
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
8375
8758
|
"minLength": 0,
|
|
8376
8759
|
"maxLength": 4,
|
|
8377
8760
|
"x-f5xc-required-for": {
|
|
@@ -8382,13 +8765,15 @@
|
|
|
8382
8765
|
},
|
|
8383
8766
|
"x-original-maxLength": 1024,
|
|
8384
8767
|
"x-reconciled-from-discovery": true,
|
|
8385
|
-
"x-reconciled-at": "2026-01-
|
|
8768
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469872+00:00"
|
|
8386
8769
|
},
|
|
8387
8770
|
"provider": {
|
|
8388
8771
|
"type": "string",
|
|
8389
8772
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
8390
8773
|
"title": "Provider",
|
|
8391
8774
|
"x-f5xc-example": "vault-vh-provider",
|
|
8775
|
+
"x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
8776
|
+
"x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
8392
8777
|
"minLength": 0,
|
|
8393
8778
|
"maxLength": 8,
|
|
8394
8779
|
"x-f5xc-required-for": {
|
|
@@ -8399,7 +8784,7 @@
|
|
|
8399
8784
|
},
|
|
8400
8785
|
"x-original-maxLength": 1024,
|
|
8401
8786
|
"x-reconciled-from-discovery": true,
|
|
8402
|
-
"x-reconciled-at": "2026-01-
|
|
8787
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469876+00:00"
|
|
8403
8788
|
},
|
|
8404
8789
|
"secret_encoding": {
|
|
8405
8790
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -8410,6 +8795,8 @@
|
|
|
8410
8795
|
"title": "Version",
|
|
8411
8796
|
"format": "int64",
|
|
8412
8797
|
"x-f5xc-example": "1",
|
|
8798
|
+
"x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
|
|
8799
|
+
"x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
|
|
8413
8800
|
"minimum": 0,
|
|
8414
8801
|
"maximum": 2147483647,
|
|
8415
8802
|
"x-f5xc-required-for": {
|
|
@@ -8421,9 +8808,11 @@
|
|
|
8421
8808
|
"maxLength": 1,
|
|
8422
8809
|
"minLength": 1,
|
|
8423
8810
|
"x-reconciled-from-discovery": true,
|
|
8424
|
-
"x-reconciled-at": "2026-01-
|
|
8811
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469882+00:00"
|
|
8425
8812
|
}
|
|
8426
8813
|
},
|
|
8814
|
+
"x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
8815
|
+
"x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
8427
8816
|
"x-f5xc-minimum-configuration": {
|
|
8428
8817
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
8429
8818
|
"required_fields": [
|
|
@@ -8450,6 +8839,7 @@
|
|
|
8450
8839
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
8451
8840
|
"title": "Name",
|
|
8452
8841
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
8842
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
8453
8843
|
"minLength": 0,
|
|
8454
8844
|
"maxLength": 16,
|
|
8455
8845
|
"x-f5xc-required-for": {
|
|
@@ -8460,9 +8850,10 @@
|
|
|
8460
8850
|
},
|
|
8461
8851
|
"x-original-maxLength": 1024,
|
|
8462
8852
|
"x-reconciled-from-discovery": true,
|
|
8463
|
-
"x-reconciled-at": "2026-01-
|
|
8853
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469905+00:00"
|
|
8464
8854
|
}
|
|
8465
8855
|
},
|
|
8856
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
8466
8857
|
"x-f5xc-minimum-configuration": {
|
|
8467
8858
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
8468
8859
|
"required_fields": [
|
|
@@ -8502,6 +8893,8 @@
|
|
|
8502
8893
|
"ves.io.schema.rules.string.max_bytes": "128",
|
|
8503
8894
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
8504
8895
|
},
|
|
8896
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
8897
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name. Required: YES.",
|
|
8505
8898
|
"x-f5xc-required-for": {
|
|
8506
8899
|
"minimum_config": false,
|
|
8507
8900
|
"create": false,
|
|
@@ -8510,7 +8903,7 @@
|
|
|
8510
8903
|
},
|
|
8511
8904
|
"x-original-maxLength": 128,
|
|
8512
8905
|
"x-reconciled-from-discovery": true,
|
|
8513
|
-
"x-reconciled-at": "2026-01-
|
|
8906
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469910+00:00"
|
|
8514
8907
|
},
|
|
8515
8908
|
"namespace": {
|
|
8516
8909
|
"type": "string",
|
|
@@ -8526,6 +8919,8 @@
|
|
|
8526
8919
|
"x-validation-rules": {
|
|
8527
8920
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
8528
8921
|
},
|
|
8922
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
8923
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
8529
8924
|
"minLength": 0,
|
|
8530
8925
|
"x-f5xc-required-for": {
|
|
8531
8926
|
"minimum_config": false,
|
|
@@ -8535,7 +8930,7 @@
|
|
|
8535
8930
|
},
|
|
8536
8931
|
"x-original-maxLength": 64,
|
|
8537
8932
|
"x-reconciled-from-discovery": true,
|
|
8538
|
-
"x-reconciled-at": "2026-01-
|
|
8933
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469915+00:00"
|
|
8539
8934
|
},
|
|
8540
8935
|
"tenant": {
|
|
8541
8936
|
"type": "string",
|
|
@@ -8551,6 +8946,8 @@
|
|
|
8551
8946
|
"x-validation-rules": {
|
|
8552
8947
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
8553
8948
|
},
|
|
8949
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
8950
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
8554
8951
|
"minLength": 0,
|
|
8555
8952
|
"x-f5xc-required-for": {
|
|
8556
8953
|
"minimum_config": false,
|
|
@@ -8562,9 +8959,11 @@
|
|
|
8562
8959
|
"x-field-mutability": "read-only",
|
|
8563
8960
|
"x-original-maxLength": 64,
|
|
8564
8961
|
"x-reconciled-from-discovery": true,
|
|
8565
|
-
"x-reconciled-at": "2026-01-
|
|
8962
|
+
"x-reconciled-at": "2026-01-07T15:28:06.469919+00:00"
|
|
8566
8963
|
}
|
|
8567
8964
|
},
|
|
8965
|
+
"x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
|
|
8966
|
+
"x-f5xc-description-medium": "Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.",
|
|
8568
8967
|
"x-f5xc-minimum-configuration": {
|
|
8569
8968
|
"description": "Minimum configuration for schemaviewsObjectRefType",
|
|
8570
8969
|
"required_fields": [
|
|
@@ -8662,6 +9061,8 @@
|
|
|
8662
9061
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
8663
9062
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
8664
9063
|
},
|
|
9064
|
+
"x-f5xc-description-short": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers.",
|
|
9065
|
+
"x-f5xc-description-medium": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers. Required: YES.",
|
|
8665
9066
|
"x-f5xc-required-for": {
|
|
8666
9067
|
"minimum_config": false,
|
|
8667
9068
|
"create": false,
|
|
@@ -8670,6 +9071,7 @@
|
|
|
8670
9071
|
}
|
|
8671
9072
|
}
|
|
8672
9073
|
},
|
|
9074
|
+
"x-f5xc-description-short": "Shape of the Certificate Chain specification.",
|
|
8673
9075
|
"x-f5xc-minimum-configuration": {
|
|
8674
9076
|
"description": "Minimum configuration for certificate_chainCreateSpecType",
|
|
8675
9077
|
"required_fields": [
|
|
@@ -8695,6 +9097,7 @@
|
|
|
8695
9097
|
"title": "Fail_if_referred.",
|
|
8696
9098
|
"format": "boolean",
|
|
8697
9099
|
"x-displayname": "Fail-If-Referred.",
|
|
9100
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
8698
9101
|
"x-f5xc-required-for": {
|
|
8699
9102
|
"minimum_config": false,
|
|
8700
9103
|
"create": false,
|
|
@@ -8719,7 +9122,7 @@
|
|
|
8719
9122
|
},
|
|
8720
9123
|
"x-original-maxLength": 1024,
|
|
8721
9124
|
"x-reconciled-from-discovery": true,
|
|
8722
|
-
"x-reconciled-at": "2026-01-
|
|
9125
|
+
"x-reconciled-at": "2026-01-07T15:28:06.882539+00:00"
|
|
8723
9126
|
},
|
|
8724
9127
|
"namespace": {
|
|
8725
9128
|
"type": "string",
|
|
@@ -8728,6 +9131,7 @@
|
|
|
8728
9131
|
"x-displayname": "Namespace",
|
|
8729
9132
|
"x-ves-example": "Ns1",
|
|
8730
9133
|
"x-f5xc-example": "ns1",
|
|
9134
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
8731
9135
|
"minLength": 0,
|
|
8732
9136
|
"maxLength": 6,
|
|
8733
9137
|
"x-f5xc-required-for": {
|
|
@@ -8738,7 +9142,7 @@
|
|
|
8738
9142
|
},
|
|
8739
9143
|
"x-original-maxLength": 1024,
|
|
8740
9144
|
"x-reconciled-from-discovery": true,
|
|
8741
|
-
"x-reconciled-at": "2026-01-
|
|
9145
|
+
"x-reconciled-at": "2026-01-07T15:28:06.882546+00:00"
|
|
8742
9146
|
}
|
|
8743
9147
|
},
|
|
8744
9148
|
"x-f5xc-minimum-configuration": {
|
|
@@ -8773,6 +9177,7 @@
|
|
|
8773
9177
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8774
9178
|
},
|
|
8775
9179
|
"x-displayname": "Deleted Referred Objects.",
|
|
9180
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8776
9181
|
"x-f5xc-required-for": {
|
|
8777
9182
|
"minimum_config": false,
|
|
8778
9183
|
"create": false,
|
|
@@ -8788,6 +9193,7 @@
|
|
|
8788
9193
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8789
9194
|
},
|
|
8790
9195
|
"x-displayname": "Disabled Referred Objects.",
|
|
9196
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8791
9197
|
"x-f5xc-required-for": {
|
|
8792
9198
|
"minimum_config": false,
|
|
8793
9199
|
"create": false,
|
|
@@ -8806,6 +9212,7 @@
|
|
|
8806
9212
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8807
9213
|
},
|
|
8808
9214
|
"x-displayname": "Referring Objects.",
|
|
9215
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
8809
9216
|
"x-f5xc-required-for": {
|
|
8810
9217
|
"minimum_config": false,
|
|
8811
9218
|
"create": false,
|
|
@@ -8827,6 +9234,8 @@
|
|
|
8827
9234
|
"$ref": "#/components/schemas/certificate_chainStatusObject"
|
|
8828
9235
|
},
|
|
8829
9236
|
"x-displayname": "Status",
|
|
9237
|
+
"x-f5xc-example": "active",
|
|
9238
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
8830
9239
|
"x-f5xc-required-for": {
|
|
8831
9240
|
"minimum_config": false,
|
|
8832
9241
|
"create": false,
|
|
@@ -8836,7 +9245,7 @@
|
|
|
8836
9245
|
"maxLength": 17,
|
|
8837
9246
|
"minLength": 17,
|
|
8838
9247
|
"x-reconciled-from-discovery": true,
|
|
8839
|
-
"x-reconciled-at": "2026-01-
|
|
9248
|
+
"x-reconciled-at": "2026-01-07T15:28:06.882562+00:00"
|
|
8840
9249
|
},
|
|
8841
9250
|
"system_metadata": {
|
|
8842
9251
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -8876,6 +9285,8 @@
|
|
|
8876
9285
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
8877
9286
|
],
|
|
8878
9287
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
9288
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
9289
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
8879
9290
|
"x-f5xc-minimum-configuration": {
|
|
8880
9291
|
"description": "Minimum configuration for certificate_chainGetResponseFormatCode",
|
|
8881
9292
|
"required_fields": [],
|
|
@@ -8914,6 +9325,8 @@
|
|
|
8914
9325
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
8915
9326
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
8916
9327
|
},
|
|
9328
|
+
"x-f5xc-description-short": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers.",
|
|
9329
|
+
"x-f5xc-description-medium": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers. Required: YES.",
|
|
8917
9330
|
"x-f5xc-required-for": {
|
|
8918
9331
|
"minimum_config": false,
|
|
8919
9332
|
"create": false,
|
|
@@ -8936,6 +9349,7 @@
|
|
|
8936
9349
|
}
|
|
8937
9350
|
}
|
|
8938
9351
|
},
|
|
9352
|
+
"x-f5xc-description-short": "Shape of the Certificate Chain specification.",
|
|
8939
9353
|
"x-f5xc-minimum-configuration": {
|
|
8940
9354
|
"description": "Minimum configuration for certificate_chainGetSpecType",
|
|
8941
9355
|
"required_fields": [
|
|
@@ -8964,6 +9378,7 @@
|
|
|
8964
9378
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
8965
9379
|
},
|
|
8966
9380
|
"x-displayname": "Errors",
|
|
9381
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
8967
9382
|
"x-f5xc-required-for": {
|
|
8968
9383
|
"minimum_config": false,
|
|
8969
9384
|
"create": false,
|
|
@@ -8979,6 +9394,8 @@
|
|
|
8979
9394
|
"$ref": "#/components/schemas/certificate_chainListResponseItem"
|
|
8980
9395
|
},
|
|
8981
9396
|
"x-displayname": "Items",
|
|
9397
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
9398
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
8982
9399
|
"x-f5xc-required-for": {
|
|
8983
9400
|
"minimum_config": false,
|
|
8984
9401
|
"create": false,
|
|
@@ -9012,6 +9429,8 @@
|
|
|
9012
9429
|
"description": "The set of annotations present on this certificate_chain.",
|
|
9013
9430
|
"title": "Annotations.",
|
|
9014
9431
|
"x-displayname": "Annotations.",
|
|
9432
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9433
|
+
"x-f5xc-description-short": "The set of annotations present on this certificate_chain.",
|
|
9015
9434
|
"x-f5xc-required-for": {
|
|
9016
9435
|
"minimum_config": false,
|
|
9017
9436
|
"create": false,
|
|
@@ -9024,6 +9443,7 @@
|
|
|
9024
9443
|
"description": "The description set for this certificate_chain.",
|
|
9025
9444
|
"title": "Description.",
|
|
9026
9445
|
"x-displayname": "Description.",
|
|
9446
|
+
"x-f5xc-description-short": "The description set for this certificate_chain.",
|
|
9027
9447
|
"minLength": 0,
|
|
9028
9448
|
"maxLength": 0,
|
|
9029
9449
|
"x-f5xc-required-for": {
|
|
@@ -9034,7 +9454,7 @@
|
|
|
9034
9454
|
},
|
|
9035
9455
|
"x-original-maxLength": 1024,
|
|
9036
9456
|
"x-reconciled-from-discovery": true,
|
|
9037
|
-
"x-reconciled-at": "2026-01-
|
|
9457
|
+
"x-reconciled-at": "2026-01-07T15:28:06.882579+00:00"
|
|
9038
9458
|
},
|
|
9039
9459
|
"disabled": {
|
|
9040
9460
|
"type": "boolean",
|
|
@@ -9042,6 +9462,8 @@
|
|
|
9042
9462
|
"title": "Disabled",
|
|
9043
9463
|
"format": "boolean",
|
|
9044
9464
|
"x-displayname": "Disabled",
|
|
9465
|
+
"x-f5xc-example": "True",
|
|
9466
|
+
"x-f5xc-description-short": "Value of true indicates certificate_chain is administratively disabled.",
|
|
9045
9467
|
"x-f5xc-required-for": {
|
|
9046
9468
|
"minimum_config": false,
|
|
9047
9469
|
"create": false,
|
|
@@ -9057,6 +9479,8 @@
|
|
|
9057
9479
|
"description": "The set of labels present on this certificate_chain.",
|
|
9058
9480
|
"title": "Labels",
|
|
9059
9481
|
"x-displayname": "Labels",
|
|
9482
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9483
|
+
"x-f5xc-description-short": "The set of labels present on this certificate_chain.",
|
|
9060
9484
|
"x-f5xc-required-for": {
|
|
9061
9485
|
"minimum_config": false,
|
|
9062
9486
|
"create": false,
|
|
@@ -9084,7 +9508,7 @@
|
|
|
9084
9508
|
},
|
|
9085
9509
|
"x-original-maxLength": 1024,
|
|
9086
9510
|
"x-reconciled-from-discovery": true,
|
|
9087
|
-
"x-reconciled-at": "2026-01-
|
|
9511
|
+
"x-reconciled-at": "2026-01-07T15:28:06.882589+00:00"
|
|
9088
9512
|
},
|
|
9089
9513
|
"namespace": {
|
|
9090
9514
|
"type": "string",
|
|
@@ -9103,7 +9527,7 @@
|
|
|
9103
9527
|
},
|
|
9104
9528
|
"x-original-maxLength": 1024,
|
|
9105
9529
|
"x-reconciled-from-discovery": true,
|
|
9106
|
-
"x-reconciled-at": "2026-01-
|
|
9530
|
+
"x-reconciled-at": "2026-01-07T15:28:06.882594+00:00"
|
|
9107
9531
|
},
|
|
9108
9532
|
"owner_view": {
|
|
9109
9533
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -9116,6 +9540,7 @@
|
|
|
9116
9540
|
"$ref": "#/components/schemas/certificate_chainStatusObject"
|
|
9117
9541
|
},
|
|
9118
9542
|
"x-displayname": "Status",
|
|
9543
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
9119
9544
|
"x-f5xc-required-for": {
|
|
9120
9545
|
"minimum_config": false,
|
|
9121
9546
|
"create": false,
|
|
@@ -9144,7 +9569,7 @@
|
|
|
9144
9569
|
"x-field-mutability": "read-only",
|
|
9145
9570
|
"x-original-maxLength": 1024,
|
|
9146
9571
|
"x-reconciled-from-discovery": true,
|
|
9147
|
-
"x-reconciled-at": "2026-01-
|
|
9572
|
+
"x-reconciled-at": "2026-01-07T15:28:06.882602+00:00"
|
|
9148
9573
|
},
|
|
9149
9574
|
"uid": {
|
|
9150
9575
|
"type": "string",
|
|
@@ -9153,6 +9578,7 @@
|
|
|
9153
9578
|
"x-displayname": "UID",
|
|
9154
9579
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
9155
9580
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
9581
|
+
"x-f5xc-description-short": "The unique uid of this certificate_chain.",
|
|
9156
9582
|
"minLength": 0,
|
|
9157
9583
|
"maxLength": 36,
|
|
9158
9584
|
"x-f5xc-required-for": {
|
|
@@ -9165,9 +9591,11 @@
|
|
|
9165
9591
|
"x-original-maxLength": 1024,
|
|
9166
9592
|
"format": "uuid",
|
|
9167
9593
|
"x-reconciled-from-discovery": true,
|
|
9168
|
-
"x-reconciled-at": "2026-01-
|
|
9594
|
+
"x-reconciled-at": "2026-01-07T15:28:06.882608+00:00"
|
|
9169
9595
|
}
|
|
9170
9596
|
},
|
|
9597
|
+
"x-f5xc-description-short": "By default a summary of certificate_chain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
9598
|
+
"x-f5xc-description-medium": "By default a summary of certificate_chain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
9171
9599
|
"x-f5xc-minimum-configuration": {
|
|
9172
9600
|
"description": "Minimum configuration for certificate_chainListResponseItem",
|
|
9173
9601
|
"required_fields": [
|
|
@@ -9238,6 +9666,7 @@
|
|
|
9238
9666
|
"title": "Replace Certificate Chain.",
|
|
9239
9667
|
"x-displayname": "Replace Certificate Chain.",
|
|
9240
9668
|
"x-ves-proto-message": "ves.io.schema.certificate_chain.ReplaceSpecType",
|
|
9669
|
+
"x-f5xc-description-short": "Shape of the Certificate Chain specification.",
|
|
9241
9670
|
"x-f5xc-minimum-configuration": {
|
|
9242
9671
|
"description": "Minimum configuration for certificate_chainReplaceSpecType",
|
|
9243
9672
|
"required_fields": [],
|
|
@@ -9263,6 +9692,7 @@
|
|
|
9263
9692
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
9264
9693
|
},
|
|
9265
9694
|
"x-displayname": "Conditions.",
|
|
9695
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
9266
9696
|
"x-f5xc-required-for": {
|
|
9267
9697
|
"minimum_config": false,
|
|
9268
9698
|
"create": false,
|
|
@@ -9289,6 +9719,7 @@
|
|
|
9289
9719
|
}
|
|
9290
9720
|
}
|
|
9291
9721
|
},
|
|
9722
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
9292
9723
|
"x-f5xc-minimum-configuration": {
|
|
9293
9724
|
"description": "Minimum configuration for certificate_chainStatusObject",
|
|
9294
9725
|
"required_fields": [
|
|
@@ -9380,6 +9811,7 @@
|
|
|
9380
9811
|
"ves.io.schema.rules.string.max_len": "512000",
|
|
9381
9812
|
"ves.io.schema.rules.string.truststore_url": "true"
|
|
9382
9813
|
},
|
|
9814
|
+
"x-f5xc-description-short": "Trusted CA certificates for validating certificates.",
|
|
9383
9815
|
"minLength": 0,
|
|
9384
9816
|
"x-f5xc-required-for": {
|
|
9385
9817
|
"minimum_config": false,
|
|
@@ -9389,6 +9821,7 @@
|
|
|
9389
9821
|
}
|
|
9390
9822
|
}
|
|
9391
9823
|
},
|
|
9824
|
+
"x-f5xc-description-short": "Shape of the Root CA Certificate specification.",
|
|
9392
9825
|
"x-f5xc-minimum-configuration": {
|
|
9393
9826
|
"description": "Minimum configuration for trusted_ca_listCreateSpecType",
|
|
9394
9827
|
"required_fields": [
|
|
@@ -9414,6 +9847,7 @@
|
|
|
9414
9847
|
"title": "Fail_if_referred.",
|
|
9415
9848
|
"format": "boolean",
|
|
9416
9849
|
"x-displayname": "Fail-If-Referred.",
|
|
9850
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
9417
9851
|
"x-f5xc-required-for": {
|
|
9418
9852
|
"minimum_config": false,
|
|
9419
9853
|
"create": false,
|
|
@@ -9438,7 +9872,7 @@
|
|
|
9438
9872
|
},
|
|
9439
9873
|
"x-original-maxLength": 1024,
|
|
9440
9874
|
"x-reconciled-from-discovery": true,
|
|
9441
|
-
"x-reconciled-at": "2026-01-
|
|
9875
|
+
"x-reconciled-at": "2026-01-07T15:29:13.450761+00:00"
|
|
9442
9876
|
},
|
|
9443
9877
|
"namespace": {
|
|
9444
9878
|
"type": "string",
|
|
@@ -9447,6 +9881,7 @@
|
|
|
9447
9881
|
"x-displayname": "Namespace",
|
|
9448
9882
|
"x-ves-example": "Ns1",
|
|
9449
9883
|
"x-f5xc-example": "ns1",
|
|
9884
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
9450
9885
|
"minLength": 0,
|
|
9451
9886
|
"maxLength": 6,
|
|
9452
9887
|
"x-f5xc-required-for": {
|
|
@@ -9457,7 +9892,7 @@
|
|
|
9457
9892
|
},
|
|
9458
9893
|
"x-original-maxLength": 1024,
|
|
9459
9894
|
"x-reconciled-from-discovery": true,
|
|
9460
|
-
"x-reconciled-at": "2026-01-
|
|
9895
|
+
"x-reconciled-at": "2026-01-07T15:29:13.450765+00:00"
|
|
9461
9896
|
}
|
|
9462
9897
|
},
|
|
9463
9898
|
"x-f5xc-minimum-configuration": {
|
|
@@ -9492,6 +9927,7 @@
|
|
|
9492
9927
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
9493
9928
|
},
|
|
9494
9929
|
"x-displayname": "Deleted Referred Objects.",
|
|
9930
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
9495
9931
|
"x-f5xc-required-for": {
|
|
9496
9932
|
"minimum_config": false,
|
|
9497
9933
|
"create": false,
|
|
@@ -9507,6 +9943,7 @@
|
|
|
9507
9943
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
9508
9944
|
},
|
|
9509
9945
|
"x-displayname": "Disabled Referred Objects.",
|
|
9946
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
9510
9947
|
"x-f5xc-required-for": {
|
|
9511
9948
|
"minimum_config": false,
|
|
9512
9949
|
"create": false,
|
|
@@ -9525,6 +9962,7 @@
|
|
|
9525
9962
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
9526
9963
|
},
|
|
9527
9964
|
"x-displayname": "Referring Objects.",
|
|
9965
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
9528
9966
|
"x-f5xc-required-for": {
|
|
9529
9967
|
"minimum_config": false,
|
|
9530
9968
|
"create": false,
|
|
@@ -9546,6 +9984,8 @@
|
|
|
9546
9984
|
"$ref": "#/components/schemas/trusted_ca_listStatusObject"
|
|
9547
9985
|
},
|
|
9548
9986
|
"x-displayname": "Status",
|
|
9987
|
+
"x-f5xc-example": "active",
|
|
9988
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
9549
9989
|
"x-f5xc-required-for": {
|
|
9550
9990
|
"minimum_config": false,
|
|
9551
9991
|
"create": false,
|
|
@@ -9555,7 +9995,7 @@
|
|
|
9555
9995
|
"maxLength": 17,
|
|
9556
9996
|
"minLength": 17,
|
|
9557
9997
|
"x-reconciled-from-discovery": true,
|
|
9558
|
-
"x-reconciled-at": "2026-01-
|
|
9998
|
+
"x-reconciled-at": "2026-01-07T15:29:13.450779+00:00"
|
|
9559
9999
|
},
|
|
9560
10000
|
"system_metadata": {
|
|
9561
10001
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -9595,6 +10035,8 @@
|
|
|
9595
10035
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
9596
10036
|
],
|
|
9597
10037
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
10038
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
10039
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
9598
10040
|
"x-f5xc-minimum-configuration": {
|
|
9599
10041
|
"description": "Minimum configuration for trusted_ca_listGetResponseFormatCode",
|
|
9600
10042
|
"required_fields": [],
|
|
@@ -9619,6 +10061,7 @@
|
|
|
9619
10061
|
"$ref": "#/components/schemas/schemaCertInfoType"
|
|
9620
10062
|
},
|
|
9621
10063
|
"x-displayname": "Trusted CA Certificates Information.",
|
|
10064
|
+
"x-f5xc-description-short": "Information about Trusted CA certificates.",
|
|
9622
10065
|
"x-f5xc-required-for": {
|
|
9623
10066
|
"minimum_config": false,
|
|
9624
10067
|
"create": false,
|
|
@@ -9641,6 +10084,7 @@
|
|
|
9641
10084
|
"ves.io.schema.rules.string.max_len": "512000",
|
|
9642
10085
|
"ves.io.schema.rules.string.truststore_url": "true"
|
|
9643
10086
|
},
|
|
10087
|
+
"x-f5xc-description-short": "Trusted CA certificates for validating certificates.",
|
|
9644
10088
|
"minLength": 0,
|
|
9645
10089
|
"x-f5xc-required-for": {
|
|
9646
10090
|
"minimum_config": false,
|
|
@@ -9650,6 +10094,7 @@
|
|
|
9650
10094
|
}
|
|
9651
10095
|
}
|
|
9652
10096
|
},
|
|
10097
|
+
"x-f5xc-description-short": "Shape of the Root CA Certificate specification.",
|
|
9653
10098
|
"x-f5xc-minimum-configuration": {
|
|
9654
10099
|
"description": "Minimum configuration for trusted_ca_listGetSpecType",
|
|
9655
10100
|
"required_fields": [
|
|
@@ -9678,6 +10123,7 @@
|
|
|
9678
10123
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
9679
10124
|
},
|
|
9680
10125
|
"x-displayname": "Errors",
|
|
10126
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
9681
10127
|
"x-f5xc-required-for": {
|
|
9682
10128
|
"minimum_config": false,
|
|
9683
10129
|
"create": false,
|
|
@@ -9693,6 +10139,8 @@
|
|
|
9693
10139
|
"$ref": "#/components/schemas/trusted_ca_listListResponseItem"
|
|
9694
10140
|
},
|
|
9695
10141
|
"x-displayname": "Items",
|
|
10142
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
10143
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
9696
10144
|
"x-f5xc-required-for": {
|
|
9697
10145
|
"minimum_config": false,
|
|
9698
10146
|
"create": false,
|
|
@@ -9726,6 +10174,8 @@
|
|
|
9726
10174
|
"description": "The set of annotations present on this trusted_ca_list.",
|
|
9727
10175
|
"title": "Annotations.",
|
|
9728
10176
|
"x-displayname": "Annotations.",
|
|
10177
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
10178
|
+
"x-f5xc-description-short": "The set of annotations present on this trusted_ca_list.",
|
|
9729
10179
|
"x-f5xc-required-for": {
|
|
9730
10180
|
"minimum_config": false,
|
|
9731
10181
|
"create": false,
|
|
@@ -9738,6 +10188,7 @@
|
|
|
9738
10188
|
"description": "The description set for this trusted_ca_list.",
|
|
9739
10189
|
"title": "Description.",
|
|
9740
10190
|
"x-displayname": "Description.",
|
|
10191
|
+
"x-f5xc-description-short": "The description set for this trusted_ca_list.",
|
|
9741
10192
|
"minLength": 0,
|
|
9742
10193
|
"maxLength": 0,
|
|
9743
10194
|
"x-f5xc-required-for": {
|
|
@@ -9748,7 +10199,7 @@
|
|
|
9748
10199
|
},
|
|
9749
10200
|
"x-original-maxLength": 1024,
|
|
9750
10201
|
"x-reconciled-from-discovery": true,
|
|
9751
|
-
"x-reconciled-at": "2026-01-
|
|
10202
|
+
"x-reconciled-at": "2026-01-07T15:29:13.450794+00:00"
|
|
9752
10203
|
},
|
|
9753
10204
|
"disabled": {
|
|
9754
10205
|
"type": "boolean",
|
|
@@ -9756,6 +10207,8 @@
|
|
|
9756
10207
|
"title": "Disabled",
|
|
9757
10208
|
"format": "boolean",
|
|
9758
10209
|
"x-displayname": "Disabled",
|
|
10210
|
+
"x-f5xc-example": "True",
|
|
10211
|
+
"x-f5xc-description-short": "Value of true indicates trusted_ca_list is administratively disabled.",
|
|
9759
10212
|
"x-f5xc-required-for": {
|
|
9760
10213
|
"minimum_config": false,
|
|
9761
10214
|
"create": false,
|
|
@@ -9771,6 +10224,8 @@
|
|
|
9771
10224
|
"description": "The set of labels present on this trusted_ca_list.",
|
|
9772
10225
|
"title": "Labels",
|
|
9773
10226
|
"x-displayname": "Labels",
|
|
10227
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
10228
|
+
"x-f5xc-description-short": "The set of labels present on this trusted_ca_list.",
|
|
9774
10229
|
"x-f5xc-required-for": {
|
|
9775
10230
|
"minimum_config": false,
|
|
9776
10231
|
"create": false,
|
|
@@ -9798,7 +10253,7 @@
|
|
|
9798
10253
|
},
|
|
9799
10254
|
"x-original-maxLength": 1024,
|
|
9800
10255
|
"x-reconciled-from-discovery": true,
|
|
9801
|
-
"x-reconciled-at": "2026-01-
|
|
10256
|
+
"x-reconciled-at": "2026-01-07T15:29:13.450803+00:00"
|
|
9802
10257
|
},
|
|
9803
10258
|
"namespace": {
|
|
9804
10259
|
"type": "string",
|
|
@@ -9817,7 +10272,7 @@
|
|
|
9817
10272
|
},
|
|
9818
10273
|
"x-original-maxLength": 1024,
|
|
9819
10274
|
"x-reconciled-from-discovery": true,
|
|
9820
|
-
"x-reconciled-at": "2026-01-
|
|
10275
|
+
"x-reconciled-at": "2026-01-07T15:29:13.450808+00:00"
|
|
9821
10276
|
},
|
|
9822
10277
|
"owner_view": {
|
|
9823
10278
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -9830,6 +10285,7 @@
|
|
|
9830
10285
|
"$ref": "#/components/schemas/trusted_ca_listStatusObject"
|
|
9831
10286
|
},
|
|
9832
10287
|
"x-displayname": "Status",
|
|
10288
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
9833
10289
|
"x-f5xc-required-for": {
|
|
9834
10290
|
"minimum_config": false,
|
|
9835
10291
|
"create": false,
|
|
@@ -9858,7 +10314,7 @@
|
|
|
9858
10314
|
"x-field-mutability": "read-only",
|
|
9859
10315
|
"x-original-maxLength": 1024,
|
|
9860
10316
|
"x-reconciled-from-discovery": true,
|
|
9861
|
-
"x-reconciled-at": "2026-01-
|
|
10317
|
+
"x-reconciled-at": "2026-01-07T15:29:13.450815+00:00"
|
|
9862
10318
|
},
|
|
9863
10319
|
"uid": {
|
|
9864
10320
|
"type": "string",
|
|
@@ -9879,9 +10335,11 @@
|
|
|
9879
10335
|
"x-original-maxLength": 1024,
|
|
9880
10336
|
"format": "uuid",
|
|
9881
10337
|
"x-reconciled-from-discovery": true,
|
|
9882
|
-
"x-reconciled-at": "2026-01-
|
|
10338
|
+
"x-reconciled-at": "2026-01-07T15:29:13.450820+00:00"
|
|
9883
10339
|
}
|
|
9884
10340
|
},
|
|
10341
|
+
"x-f5xc-description-short": "By default a summary of trusted_ca_list is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
10342
|
+
"x-f5xc-description-medium": "By default a summary of trusted_ca_list is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
9885
10343
|
"x-f5xc-minimum-configuration": {
|
|
9886
10344
|
"description": "Minimum configuration for trusted_ca_listListResponseItem",
|
|
9887
10345
|
"required_fields": [
|
|
@@ -9968,6 +10426,7 @@
|
|
|
9968
10426
|
"ves.io.schema.rules.string.max_len": "512000",
|
|
9969
10427
|
"ves.io.schema.rules.string.truststore_url": "true"
|
|
9970
10428
|
},
|
|
10429
|
+
"x-f5xc-description-short": "Trusted CA certificates for validating certificates.",
|
|
9971
10430
|
"minLength": 0,
|
|
9972
10431
|
"x-f5xc-required-for": {
|
|
9973
10432
|
"minimum_config": false,
|
|
@@ -9977,6 +10436,7 @@
|
|
|
9977
10436
|
}
|
|
9978
10437
|
}
|
|
9979
10438
|
},
|
|
10439
|
+
"x-f5xc-description-short": "Shape of the Root CA Certificate specification.",
|
|
9980
10440
|
"x-f5xc-minimum-configuration": {
|
|
9981
10441
|
"description": "Minimum configuration for trusted_ca_listReplaceSpecType",
|
|
9982
10442
|
"required_fields": [
|
|
@@ -10004,6 +10464,7 @@
|
|
|
10004
10464
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
10005
10465
|
},
|
|
10006
10466
|
"x-displayname": "Conditions.",
|
|
10467
|
+
"x-f5xc-description-short": "Conditions reported by various components of the system.",
|
|
10007
10468
|
"x-f5xc-required-for": {
|
|
10008
10469
|
"minimum_config": false,
|
|
10009
10470
|
"create": false,
|
|
@@ -10030,6 +10491,7 @@
|
|
|
10030
10491
|
}
|
|
10031
10492
|
}
|
|
10032
10493
|
},
|
|
10494
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
10033
10495
|
"x-f5xc-minimum-configuration": {
|
|
10034
10496
|
"description": "Minimum configuration for trusted_ca_listStatusObject",
|
|
10035
10497
|
"required_fields": [
|