@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
package/specs/domains/users.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Users",
|
|
5
5
|
"description": "Token lifecycle governs automated site onboarding through cloud-init integration with configurable validity periods. Explicit category keys establish permitted classification hierarchies enforced across deployments. Inferred attributes attach automatically based on object characteristics and placement context. Namespace-scoped operations handle credential generation, revocation, and state transitions for streamlined provisioning workflows.",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.19",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -13,7 +13,57 @@
|
|
|
13
13
|
"url": "https://www.f5.com/company/policies/eula"
|
|
14
14
|
},
|
|
15
15
|
"summary": "Site enrollment credentials with automatic expiration. Taxonomy keys define allowed categorization while auto-derived tags apply dynamically.",
|
|
16
|
-
"x-f5xc-cli-domain": "users"
|
|
16
|
+
"x-f5xc-cli-domain": "users",
|
|
17
|
+
"x-f5xc-best-practices": {
|
|
18
|
+
"common_errors": [
|
|
19
|
+
{
|
|
20
|
+
"code": 400,
|
|
21
|
+
"message": "Invalid request body",
|
|
22
|
+
"resolution": "Validate JSON structure and required fields before submission",
|
|
23
|
+
"prevention": "Use schema validation from OpenAPI spec"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"code": 401,
|
|
27
|
+
"message": "Authentication failed",
|
|
28
|
+
"resolution": "Verify API token is valid and not expired",
|
|
29
|
+
"prevention": "Use environment variables for token management"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"code": 403,
|
|
33
|
+
"message": "Permission denied",
|
|
34
|
+
"resolution": "Check user role and namespace permissions",
|
|
35
|
+
"prevention": "Verify RBAC policies before operations"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"code": 404,
|
|
39
|
+
"message": "Resource not found",
|
|
40
|
+
"resolution": "Verify resource name and namespace exist",
|
|
41
|
+
"prevention": "List resources before attempting operations"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"code": 409,
|
|
45
|
+
"message": "Resource already exists",
|
|
46
|
+
"resolution": "Use unique name or delete existing resource",
|
|
47
|
+
"prevention": "Check existence before creation"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"code": 429,
|
|
51
|
+
"message": "Rate limit exceeded",
|
|
52
|
+
"resolution": "Implement exponential backoff and retry logic",
|
|
53
|
+
"prevention": "Batch operations and add delays between requests"
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
"security_notes": [
|
|
57
|
+
"Always use HTTPS for all API communications",
|
|
58
|
+
"Store API tokens securely, never in source code",
|
|
59
|
+
"Rotate API tokens regularly following security policies"
|
|
60
|
+
],
|
|
61
|
+
"performance_tips": [
|
|
62
|
+
"Use pagination for large result sets",
|
|
63
|
+
"Batch related operations when possible",
|
|
64
|
+
"Cache read-only responses appropriately"
|
|
65
|
+
]
|
|
66
|
+
}
|
|
17
67
|
},
|
|
18
68
|
"servers": [
|
|
19
69
|
{
|
|
@@ -307,7 +357,15 @@
|
|
|
307
357
|
}
|
|
308
358
|
},
|
|
309
359
|
"x-discovered-response-time-ms": 3042.24,
|
|
310
|
-
"x-discovered-sample-size": 1
|
|
360
|
+
"x-discovered-sample-size": 1,
|
|
361
|
+
"x-f5xc-discovered-response-time": {
|
|
362
|
+
"p50_ms": 3042.24,
|
|
363
|
+
"p95_ms": 6084.48,
|
|
364
|
+
"p99_ms": 9126.72,
|
|
365
|
+
"sample_count": 1,
|
|
366
|
+
"source": "discovery",
|
|
367
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
368
|
+
}
|
|
311
369
|
},
|
|
312
370
|
"x-displayname": "Implicit Label.",
|
|
313
371
|
"x-ves-proto-service": "ves.io.schema.implicit_label.CustomAPI",
|
|
@@ -521,6 +579,13 @@
|
|
|
521
579
|
"latency": "low",
|
|
522
580
|
"resource_usage": "low"
|
|
523
581
|
}
|
|
582
|
+
},
|
|
583
|
+
"x-f5xc-discovered-response-time": {
|
|
584
|
+
"p50_ms": 1000,
|
|
585
|
+
"p95_ms": 3000,
|
|
586
|
+
"p99_ms": 8000,
|
|
587
|
+
"sample_count": 0,
|
|
588
|
+
"source": "estimate"
|
|
524
589
|
}
|
|
525
590
|
},
|
|
526
591
|
"x-displayname": "Known Label.",
|
|
@@ -735,6 +800,13 @@
|
|
|
735
800
|
"latency": "low",
|
|
736
801
|
"resource_usage": "low"
|
|
737
802
|
}
|
|
803
|
+
},
|
|
804
|
+
"x-f5xc-discovered-response-time": {
|
|
805
|
+
"p50_ms": 1000,
|
|
806
|
+
"p95_ms": 3000,
|
|
807
|
+
"p99_ms": 8000,
|
|
808
|
+
"sample_count": 0,
|
|
809
|
+
"source": "estimate"
|
|
738
810
|
}
|
|
739
811
|
},
|
|
740
812
|
"x-displayname": "Known Label.",
|
|
@@ -964,7 +1036,15 @@
|
|
|
964
1036
|
}
|
|
965
1037
|
},
|
|
966
1038
|
"x-discovered-response-time-ms": 179.39,
|
|
967
|
-
"x-discovered-sample-size": 1
|
|
1039
|
+
"x-discovered-sample-size": 1,
|
|
1040
|
+
"x-f5xc-discovered-response-time": {
|
|
1041
|
+
"p50_ms": 179.39,
|
|
1042
|
+
"p95_ms": 358.78,
|
|
1043
|
+
"p99_ms": 538.17,
|
|
1044
|
+
"sample_count": 1,
|
|
1045
|
+
"source": "discovery",
|
|
1046
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
1047
|
+
}
|
|
968
1048
|
},
|
|
969
1049
|
"x-displayname": "Known Label.",
|
|
970
1050
|
"x-ves-proto-service": "ves.io.schema.known_label.CustomAPI",
|
|
@@ -1178,6 +1258,13 @@
|
|
|
1178
1258
|
"latency": "low",
|
|
1179
1259
|
"resource_usage": "low"
|
|
1180
1260
|
}
|
|
1261
|
+
},
|
|
1262
|
+
"x-f5xc-discovered-response-time": {
|
|
1263
|
+
"p50_ms": 1000,
|
|
1264
|
+
"p95_ms": 3000,
|
|
1265
|
+
"p99_ms": 8000,
|
|
1266
|
+
"sample_count": 0,
|
|
1267
|
+
"source": "estimate"
|
|
1181
1268
|
}
|
|
1182
1269
|
},
|
|
1183
1270
|
"x-displayname": "Known Label Key.",
|
|
@@ -1392,6 +1479,13 @@
|
|
|
1392
1479
|
"latency": "low",
|
|
1393
1480
|
"resource_usage": "low"
|
|
1394
1481
|
}
|
|
1482
|
+
},
|
|
1483
|
+
"x-f5xc-discovered-response-time": {
|
|
1484
|
+
"p50_ms": 1000,
|
|
1485
|
+
"p95_ms": 3000,
|
|
1486
|
+
"p99_ms": 8000,
|
|
1487
|
+
"sample_count": 0,
|
|
1488
|
+
"source": "estimate"
|
|
1395
1489
|
}
|
|
1396
1490
|
},
|
|
1397
1491
|
"x-displayname": "Known Label Key.",
|
|
@@ -1609,7 +1703,15 @@
|
|
|
1609
1703
|
}
|
|
1610
1704
|
},
|
|
1611
1705
|
"x-discovered-response-time-ms": 166.28,
|
|
1612
|
-
"x-discovered-sample-size": 1
|
|
1706
|
+
"x-discovered-sample-size": 1,
|
|
1707
|
+
"x-f5xc-discovered-response-time": {
|
|
1708
|
+
"p50_ms": 166.28,
|
|
1709
|
+
"p95_ms": 332.56,
|
|
1710
|
+
"p99_ms": 498.84,
|
|
1711
|
+
"sample_count": 1,
|
|
1712
|
+
"source": "discovery",
|
|
1713
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
1714
|
+
}
|
|
1613
1715
|
},
|
|
1614
1716
|
"x-displayname": "Known Label Key.",
|
|
1615
1717
|
"x-ves-proto-service": "ves.io.schema.known_label_key.CustomAPI",
|
|
@@ -1805,7 +1907,15 @@
|
|
|
1805
1907
|
}
|
|
1806
1908
|
},
|
|
1807
1909
|
"x-discovered-response-time-ms": 153.29,
|
|
1808
|
-
"x-discovered-sample-size": 1
|
|
1910
|
+
"x-discovered-sample-size": 1,
|
|
1911
|
+
"x-f5xc-discovered-response-time": {
|
|
1912
|
+
"p50_ms": 153.29,
|
|
1913
|
+
"p95_ms": 306.58,
|
|
1914
|
+
"p99_ms": 459.87,
|
|
1915
|
+
"sample_count": 1,
|
|
1916
|
+
"source": "discovery",
|
|
1917
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
1918
|
+
}
|
|
1809
1919
|
},
|
|
1810
1920
|
"x-displayname": "Token",
|
|
1811
1921
|
"x-ves-proto-service": "ves.io.schema.token.CustomAPI",
|
|
@@ -2019,6 +2129,13 @@
|
|
|
2019
2129
|
"latency": "low",
|
|
2020
2130
|
"resource_usage": "low"
|
|
2021
2131
|
}
|
|
2132
|
+
},
|
|
2133
|
+
"x-f5xc-discovered-response-time": {
|
|
2134
|
+
"p50_ms": 1000,
|
|
2135
|
+
"p95_ms": 3000,
|
|
2136
|
+
"p99_ms": 8000,
|
|
2137
|
+
"sample_count": 0,
|
|
2138
|
+
"source": "estimate"
|
|
2022
2139
|
}
|
|
2023
2140
|
},
|
|
2024
2141
|
"x-displayname": "Token",
|
|
@@ -2241,6 +2358,13 @@
|
|
|
2241
2358
|
"latency": "low",
|
|
2242
2359
|
"resource_usage": "low"
|
|
2243
2360
|
}
|
|
2361
|
+
},
|
|
2362
|
+
"x-f5xc-discovered-response-time": {
|
|
2363
|
+
"p50_ms": 800,
|
|
2364
|
+
"p95_ms": 2500,
|
|
2365
|
+
"p99_ms": 6000,
|
|
2366
|
+
"sample_count": 0,
|
|
2367
|
+
"source": "estimate"
|
|
2244
2368
|
}
|
|
2245
2369
|
},
|
|
2246
2370
|
"x-displayname": "Token",
|
|
@@ -2470,7 +2594,15 @@
|
|
|
2470
2594
|
}
|
|
2471
2595
|
},
|
|
2472
2596
|
"x-discovered-response-time-ms": 177.4,
|
|
2473
|
-
"x-discovered-sample-size": 1
|
|
2597
|
+
"x-discovered-sample-size": 1,
|
|
2598
|
+
"x-f5xc-discovered-response-time": {
|
|
2599
|
+
"p50_ms": 177.4,
|
|
2600
|
+
"p95_ms": 354.8,
|
|
2601
|
+
"p99_ms": 532.2,
|
|
2602
|
+
"sample_count": 1,
|
|
2603
|
+
"source": "discovery",
|
|
2604
|
+
"last_measured": "2025-12-20T19:39:20.211392+00:00"
|
|
2605
|
+
}
|
|
2474
2606
|
},
|
|
2475
2607
|
"x-displayname": "Token",
|
|
2476
2608
|
"x-ves-proto-service": "ves.io.schema.token.API",
|
|
@@ -2691,6 +2823,13 @@
|
|
|
2691
2823
|
"latency": "low",
|
|
2692
2824
|
"resource_usage": "low"
|
|
2693
2825
|
}
|
|
2826
|
+
},
|
|
2827
|
+
"x-f5xc-discovered-response-time": {
|
|
2828
|
+
"p50_ms": 200,
|
|
2829
|
+
"p95_ms": 800,
|
|
2830
|
+
"p99_ms": 2000,
|
|
2831
|
+
"sample_count": 0,
|
|
2832
|
+
"source": "estimate"
|
|
2694
2833
|
}
|
|
2695
2834
|
},
|
|
2696
2835
|
"delete": {
|
|
@@ -2910,6 +3049,13 @@
|
|
|
2910
3049
|
"latency": "high",
|
|
2911
3050
|
"resource_usage": "moderate"
|
|
2912
3051
|
}
|
|
3052
|
+
},
|
|
3053
|
+
"x-f5xc-discovered-response-time": {
|
|
3054
|
+
"p50_ms": 500,
|
|
3055
|
+
"p95_ms": 1500,
|
|
3056
|
+
"p99_ms": 4000,
|
|
3057
|
+
"sample_count": 0,
|
|
3058
|
+
"source": "estimate"
|
|
2913
3059
|
}
|
|
2914
3060
|
},
|
|
2915
3061
|
"x-displayname": "Token",
|
|
@@ -3137,6 +3283,13 @@
|
|
|
3137
3283
|
"latency": "low",
|
|
3138
3284
|
"resource_usage": "low"
|
|
3139
3285
|
}
|
|
3286
|
+
},
|
|
3287
|
+
"x-f5xc-discovered-response-time": {
|
|
3288
|
+
"p50_ms": 1000,
|
|
3289
|
+
"p95_ms": 3000,
|
|
3290
|
+
"p99_ms": 8000,
|
|
3291
|
+
"sample_count": 0,
|
|
3292
|
+
"source": "estimate"
|
|
3140
3293
|
}
|
|
3141
3294
|
},
|
|
3142
3295
|
"x-displayname": "Token",
|
|
@@ -3213,7 +3366,7 @@
|
|
|
3213
3366
|
},
|
|
3214
3367
|
"x-original-maxLength": 1024,
|
|
3215
3368
|
"x-reconciled-from-discovery": true,
|
|
3216
|
-
"x-reconciled-at": "2026-01-
|
|
3369
|
+
"x-reconciled-at": "2026-01-07T15:28:46.181203+00:00"
|
|
3217
3370
|
},
|
|
3218
3371
|
"key": {
|
|
3219
3372
|
"type": "string",
|
|
@@ -3232,7 +3385,7 @@
|
|
|
3232
3385
|
},
|
|
3233
3386
|
"x-original-maxLength": 1024,
|
|
3234
3387
|
"x-reconciled-from-discovery": true,
|
|
3235
|
-
"x-reconciled-at": "2026-01-
|
|
3388
|
+
"x-reconciled-at": "2026-01-07T15:28:46.181210+00:00"
|
|
3236
3389
|
},
|
|
3237
3390
|
"value": {
|
|
3238
3391
|
"type": "string",
|
|
@@ -3251,9 +3404,10 @@
|
|
|
3251
3404
|
},
|
|
3252
3405
|
"x-original-maxLength": 1024,
|
|
3253
3406
|
"x-reconciled-from-discovery": true,
|
|
3254
|
-
"x-reconciled-at": "2026-01-
|
|
3407
|
+
"x-reconciled-at": "2026-01-07T15:28:46.181215+00:00"
|
|
3255
3408
|
}
|
|
3256
3409
|
},
|
|
3410
|
+
"x-f5xc-description-short": "Generic Label type label.key(label.value).",
|
|
3257
3411
|
"x-f5xc-minimum-configuration": {
|
|
3258
3412
|
"description": "Minimum configuration for implicit_labelLabelType",
|
|
3259
3413
|
"required_fields": [
|
|
@@ -3281,6 +3435,8 @@
|
|
|
3281
3435
|
"QUERY_KEY_SUBSTRING"
|
|
3282
3436
|
],
|
|
3283
3437
|
"default": "QUERY_ALL_LABELS",
|
|
3438
|
+
"x-f5xc-description-short": "X-displayName: \"Label Query\" Type of query for implicit labels - QUERY_ALL_LABELS: x-displayName: \"All Labels\" GET all available implicit labels ...",
|
|
3439
|
+
"x-f5xc-description-medium": "X-displayName: \"Label Query\" Type of query for implicit labels - QUERY_ALL_LABELS: x-displayName: \"All Labels\" GET all available implicit labels - QUERY_EXACT_LABEL: x-displayName: \"Exact Label\" GET exact match of label.key = label.value Or label.key(label.value) - QUERY_VALUE_PREFIX_LABELS...",
|
|
3284
3440
|
"x-f5xc-minimum-configuration": {
|
|
3285
3441
|
"description": "Minimum configuration for implicit_labelQueryType",
|
|
3286
3442
|
"required_fields": [],
|
|
@@ -3307,6 +3463,8 @@
|
|
|
3307
3463
|
"KEY_CLASS_AWS"
|
|
3308
3464
|
],
|
|
3309
3465
|
"default": "KEY_CLASS_GENERIC",
|
|
3466
|
+
"x-f5xc-description-short": "X-displayName: \"LabelKeyClass\" LabelKeyClass is an enumeration of supported label key classes - KEY_CLASS_GENERIC: x-displayName: \"Key Class...",
|
|
3467
|
+
"x-f5xc-description-medium": "X-displayName: \"LabelKeyClass\" LabelKeyClass is an enumeration of supported label key classes - KEY_CLASS_GENERIC: x-displayName: \"Key Class Generic\" Includes label keys with generic names such as \"example-key\", \"foobar-key\" etc. - KEY_CLASS_KNOWN: x-displayName: \"Key Class Known\" Keys that are...",
|
|
3310
3468
|
"x-f5xc-minimum-configuration": {
|
|
3311
3469
|
"description": "Minimum configuration for schemaLabelKeyClass",
|
|
3312
3470
|
"required_fields": [],
|
|
@@ -3341,7 +3499,7 @@
|
|
|
3341
3499
|
},
|
|
3342
3500
|
"x-original-maxLength": 1024,
|
|
3343
3501
|
"x-reconciled-from-discovery": true,
|
|
3344
|
-
"x-reconciled-at": "2026-01-
|
|
3502
|
+
"x-reconciled-at": "2026-01-07T15:28:52.777987+00:00"
|
|
3345
3503
|
},
|
|
3346
3504
|
"key": {
|
|
3347
3505
|
"type": "string",
|
|
@@ -3360,7 +3518,7 @@
|
|
|
3360
3518
|
},
|
|
3361
3519
|
"x-original-maxLength": 1024,
|
|
3362
3520
|
"x-reconciled-from-discovery": true,
|
|
3363
|
-
"x-reconciled-at": "2026-01-
|
|
3521
|
+
"x-reconciled-at": "2026-01-07T15:28:52.777994+00:00"
|
|
3364
3522
|
},
|
|
3365
3523
|
"namespace": {
|
|
3366
3524
|
"type": "string",
|
|
@@ -3379,7 +3537,7 @@
|
|
|
3379
3537
|
},
|
|
3380
3538
|
"x-original-maxLength": 1024,
|
|
3381
3539
|
"x-reconciled-from-discovery": true,
|
|
3382
|
-
"x-reconciled-at": "2026-01-
|
|
3540
|
+
"x-reconciled-at": "2026-01-07T15:28:52.777999+00:00"
|
|
3383
3541
|
},
|
|
3384
3542
|
"value": {
|
|
3385
3543
|
"type": "string",
|
|
@@ -3404,9 +3562,10 @@
|
|
|
3404
3562
|
},
|
|
3405
3563
|
"x-original-maxLength": 1024,
|
|
3406
3564
|
"x-reconciled-from-discovery": true,
|
|
3407
|
-
"x-reconciled-at": "2026-01-
|
|
3565
|
+
"x-reconciled-at": "2026-01-07T15:28:52.778004+00:00"
|
|
3408
3566
|
}
|
|
3409
3567
|
},
|
|
3568
|
+
"x-f5xc-description-short": "Create label request in shared namespace. Only shared namespace supported.",
|
|
3410
3569
|
"x-f5xc-minimum-configuration": {
|
|
3411
3570
|
"description": "Minimum configuration for known_labelCreateRequest",
|
|
3412
3571
|
"required_fields": [
|
|
@@ -3469,7 +3628,7 @@
|
|
|
3469
3628
|
},
|
|
3470
3629
|
"x-original-maxLength": 1024,
|
|
3471
3630
|
"x-reconciled-from-discovery": true,
|
|
3472
|
-
"x-reconciled-at": "2026-01-
|
|
3631
|
+
"x-reconciled-at": "2026-01-07T15:28:52.778012+00:00"
|
|
3473
3632
|
},
|
|
3474
3633
|
"namespace": {
|
|
3475
3634
|
"type": "string",
|
|
@@ -3488,7 +3647,7 @@
|
|
|
3488
3647
|
},
|
|
3489
3648
|
"x-original-maxLength": 1024,
|
|
3490
3649
|
"x-reconciled-from-discovery": true,
|
|
3491
|
-
"x-reconciled-at": "2026-01-
|
|
3650
|
+
"x-reconciled-at": "2026-01-07T15:28:52.778016+00:00"
|
|
3492
3651
|
},
|
|
3493
3652
|
"value": {
|
|
3494
3653
|
"type": "string",
|
|
@@ -3513,9 +3672,10 @@
|
|
|
3513
3672
|
},
|
|
3514
3673
|
"x-original-maxLength": 1024,
|
|
3515
3674
|
"x-reconciled-from-discovery": true,
|
|
3516
|
-
"x-reconciled-at": "2026-01-
|
|
3675
|
+
"x-reconciled-at": "2026-01-07T15:28:52.778020+00:00"
|
|
3517
3676
|
}
|
|
3518
3677
|
},
|
|
3678
|
+
"x-f5xc-description-short": "Deletes Label matching label.key=label.value.",
|
|
3519
3679
|
"x-f5xc-minimum-configuration": {
|
|
3520
3680
|
"description": "Minimum configuration for known_labelDeleteRequest",
|
|
3521
3681
|
"required_fields": [
|
|
@@ -3605,7 +3765,7 @@
|
|
|
3605
3765
|
},
|
|
3606
3766
|
"x-original-maxLength": 1024,
|
|
3607
3767
|
"x-reconciled-from-discovery": true,
|
|
3608
|
-
"x-reconciled-at": "2026-01-
|
|
3768
|
+
"x-reconciled-at": "2026-01-07T15:28:52.778027+00:00"
|
|
3609
3769
|
},
|
|
3610
3770
|
"key": {
|
|
3611
3771
|
"type": "string",
|
|
@@ -3624,7 +3784,7 @@
|
|
|
3624
3784
|
},
|
|
3625
3785
|
"x-original-maxLength": 1024,
|
|
3626
3786
|
"x-reconciled-from-discovery": true,
|
|
3627
|
-
"x-reconciled-at": "2026-01-
|
|
3787
|
+
"x-reconciled-at": "2026-01-07T15:28:52.778031+00:00"
|
|
3628
3788
|
},
|
|
3629
3789
|
"value": {
|
|
3630
3790
|
"type": "string",
|
|
@@ -3643,9 +3803,10 @@
|
|
|
3643
3803
|
},
|
|
3644
3804
|
"x-original-maxLength": 1024,
|
|
3645
3805
|
"x-reconciled-from-discovery": true,
|
|
3646
|
-
"x-reconciled-at": "2026-01-
|
|
3806
|
+
"x-reconciled-at": "2026-01-07T15:28:52.778035+00:00"
|
|
3647
3807
|
}
|
|
3648
3808
|
},
|
|
3809
|
+
"x-f5xc-description-short": "Generic Label type label.key(label.value).",
|
|
3649
3810
|
"x-f5xc-minimum-configuration": {
|
|
3650
3811
|
"description": "Minimum configuration for known_labelLabelType",
|
|
3651
3812
|
"required_fields": [
|
|
@@ -3671,6 +3832,8 @@
|
|
|
3671
3832
|
"QUERY_KEY_PREFIX_LABELS"
|
|
3672
3833
|
],
|
|
3673
3834
|
"default": "QUERY_ALL_LABELS",
|
|
3835
|
+
"x-f5xc-description-short": "X-displayName: \"Query Type\" Type of label query - QUERY_ALL_LABELS: x-displayName: \"All Labels\" Generic GET of all available labels for a given...",
|
|
3836
|
+
"x-f5xc-description-medium": "X-displayName: \"Query Type\" Type of label query - QUERY_ALL_LABELS: x-displayName: \"All Labels\" Generic GET of all available labels for a given tenant - QUERY_EXACT_LABEL: x-displayName: \"Exact Label\" GET exact match of label.key = label.value Or label.key(label.value) ...",
|
|
3674
3837
|
"x-f5xc-minimum-configuration": {
|
|
3675
3838
|
"description": "Minimum configuration for known_labelQueryType",
|
|
3676
3839
|
"required_fields": [],
|
|
@@ -3705,7 +3868,7 @@
|
|
|
3705
3868
|
},
|
|
3706
3869
|
"x-original-maxLength": 1024,
|
|
3707
3870
|
"x-reconciled-from-discovery": true,
|
|
3708
|
-
"x-reconciled-at": "2026-01-
|
|
3871
|
+
"x-reconciled-at": "2026-01-07T15:28:53.037110+00:00"
|
|
3709
3872
|
},
|
|
3710
3873
|
"key": {
|
|
3711
3874
|
"type": "string",
|
|
@@ -3724,7 +3887,7 @@
|
|
|
3724
3887
|
},
|
|
3725
3888
|
"x-original-maxLength": 1024,
|
|
3726
3889
|
"x-reconciled-from-discovery": true,
|
|
3727
|
-
"x-reconciled-at": "2026-01-
|
|
3890
|
+
"x-reconciled-at": "2026-01-07T15:28:53.037118+00:00"
|
|
3728
3891
|
},
|
|
3729
3892
|
"namespace": {
|
|
3730
3893
|
"type": "string",
|
|
@@ -3743,9 +3906,10 @@
|
|
|
3743
3906
|
},
|
|
3744
3907
|
"x-original-maxLength": 1024,
|
|
3745
3908
|
"x-reconciled-from-discovery": true,
|
|
3746
|
-
"x-reconciled-at": "2026-01-
|
|
3909
|
+
"x-reconciled-at": "2026-01-07T15:28:53.037123+00:00"
|
|
3747
3910
|
}
|
|
3748
3911
|
},
|
|
3912
|
+
"x-f5xc-description-short": "Create label Key request in shared namespace. Only shared namespace supported.",
|
|
3749
3913
|
"x-f5xc-minimum-configuration": {
|
|
3750
3914
|
"description": "Minimum configuration for known_label_keyCreateRequest",
|
|
3751
3915
|
"required_fields": [
|
|
@@ -3807,7 +3971,7 @@
|
|
|
3807
3971
|
},
|
|
3808
3972
|
"x-original-maxLength": 1024,
|
|
3809
3973
|
"x-reconciled-from-discovery": true,
|
|
3810
|
-
"x-reconciled-at": "2026-01-
|
|
3974
|
+
"x-reconciled-at": "2026-01-07T15:28:53.037132+00:00"
|
|
3811
3975
|
},
|
|
3812
3976
|
"namespace": {
|
|
3813
3977
|
"type": "string",
|
|
@@ -3816,6 +3980,7 @@
|
|
|
3816
3980
|
"x-displayname": "Namespace",
|
|
3817
3981
|
"x-ves-example": "Value",
|
|
3818
3982
|
"x-f5xc-example": "value",
|
|
3983
|
+
"x-f5xc-description-short": "Namespace in which to DELETE the label key.",
|
|
3819
3984
|
"minLength": 0,
|
|
3820
3985
|
"maxLength": 6,
|
|
3821
3986
|
"x-f5xc-required-for": {
|
|
@@ -3826,7 +3991,7 @@
|
|
|
3826
3991
|
},
|
|
3827
3992
|
"x-original-maxLength": 1024,
|
|
3828
3993
|
"x-reconciled-from-discovery": true,
|
|
3829
|
-
"x-reconciled-at": "2026-01-
|
|
3994
|
+
"x-reconciled-at": "2026-01-07T15:28:53.037136+00:00"
|
|
3830
3995
|
}
|
|
3831
3996
|
},
|
|
3832
3997
|
"x-f5xc-minimum-configuration": {
|
|
@@ -3907,6 +4072,7 @@
|
|
|
3907
4072
|
"x-displayname": "Description.",
|
|
3908
4073
|
"x-ves-example": "Value",
|
|
3909
4074
|
"x-f5xc-example": "value",
|
|
4075
|
+
"x-f5xc-description-short": "Description of what this label key means.",
|
|
3910
4076
|
"minLength": 0,
|
|
3911
4077
|
"maxLength": 0,
|
|
3912
4078
|
"x-f5xc-required-for": {
|
|
@@ -3917,7 +4083,7 @@
|
|
|
3917
4083
|
},
|
|
3918
4084
|
"x-original-maxLength": 1024,
|
|
3919
4085
|
"x-reconciled-from-discovery": true,
|
|
3920
|
-
"x-reconciled-at": "2026-01-
|
|
4086
|
+
"x-reconciled-at": "2026-01-07T15:28:53.037143+00:00"
|
|
3921
4087
|
},
|
|
3922
4088
|
"key": {
|
|
3923
4089
|
"type": "string",
|
|
@@ -3936,7 +4102,7 @@
|
|
|
3936
4102
|
},
|
|
3937
4103
|
"x-original-maxLength": 1024,
|
|
3938
4104
|
"x-reconciled-from-discovery": true,
|
|
3939
|
-
"x-reconciled-at": "2026-01-
|
|
4105
|
+
"x-reconciled-at": "2026-01-07T15:28:53.037147+00:00"
|
|
3940
4106
|
}
|
|
3941
4107
|
},
|
|
3942
4108
|
"x-f5xc-minimum-configuration": {
|
|
@@ -3962,6 +4128,8 @@
|
|
|
3962
4128
|
"QUERY_PREFIX_LABEL_KEYS"
|
|
3963
4129
|
],
|
|
3964
4130
|
"default": "QUERY_ALL_LABEL_KEYS",
|
|
4131
|
+
"x-f5xc-description-short": "X-displayName: \"Query Type\" Type of label key query - QUERY_ALL_LABEL_KEYS: x-displayName: \"All Labels\" Generic GET of all available labels for a...",
|
|
4132
|
+
"x-f5xc-description-medium": "X-displayName: \"Query Type\" Type of label key query - QUERY_ALL_LABEL_KEYS: x-displayName: \"All Labels\" Generic GET of all available labels for a given tenant - QUERY_EXACT_LABEL_KEY: x-displayName: \"Exact Label Key\" GET exact match of label.key = label.value Or label.key(label.value) ...",
|
|
3965
4133
|
"x-f5xc-minimum-configuration": {
|
|
3966
4134
|
"description": "Minimum configuration for known_label_keyQueryType",
|
|
3967
4135
|
"required_fields": [],
|
|
@@ -3979,6 +4147,8 @@
|
|
|
3979
4147
|
"type_url": {
|
|
3980
4148
|
"type": "string",
|
|
3981
4149
|
"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.",
|
|
4150
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
4151
|
+
"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 ).",
|
|
3982
4152
|
"minLength": 0,
|
|
3983
4153
|
"maxLength": 1024,
|
|
3984
4154
|
"x-f5xc-required-for": {
|
|
@@ -4002,9 +4172,11 @@
|
|
|
4002
4172
|
},
|
|
4003
4173
|
"x-original-maxLength": 1024,
|
|
4004
4174
|
"x-reconciled-from-discovery": true,
|
|
4005
|
-
"x-reconciled-at": "2026-01-
|
|
4175
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556577+00:00"
|
|
4006
4176
|
}
|
|
4007
4177
|
},
|
|
4178
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
4179
|
+
"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...",
|
|
4008
4180
|
"x-f5xc-minimum-configuration": {
|
|
4009
4181
|
"description": "Minimum configuration for protobufAny",
|
|
4010
4182
|
"required_fields": [
|
|
@@ -4030,6 +4202,8 @@
|
|
|
4030
4202
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
4031
4203
|
"title": "Hostname",
|
|
4032
4204
|
"x-displayname": "Hostname",
|
|
4205
|
+
"x-f5xc-example": "example-resource",
|
|
4206
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
4033
4207
|
"minLength": 0,
|
|
4034
4208
|
"maxLength": 1024,
|
|
4035
4209
|
"x-f5xc-required-for": {
|
|
@@ -4061,6 +4235,8 @@
|
|
|
4061
4235
|
"x-displayname": "Reason",
|
|
4062
4236
|
"x-ves-example": "Value",
|
|
4063
4237
|
"x-f5xc-example": "value",
|
|
4238
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
4239
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
4064
4240
|
"minLength": 0,
|
|
4065
4241
|
"maxLength": 43,
|
|
4066
4242
|
"x-f5xc-required-for": {
|
|
@@ -4071,13 +4247,15 @@
|
|
|
4071
4247
|
},
|
|
4072
4248
|
"x-original-maxLength": 1024,
|
|
4073
4249
|
"x-reconciled-from-discovery": true,
|
|
4074
|
-
"x-reconciled-at": "2026-01-
|
|
4250
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556588+00:00"
|
|
4075
4251
|
},
|
|
4076
4252
|
"service_name": {
|
|
4077
4253
|
"type": "string",
|
|
4078
4254
|
"description": "Name of the service that sent the status.",
|
|
4079
4255
|
"title": "Service name.",
|
|
4080
4256
|
"x-displayname": "Service Name.",
|
|
4257
|
+
"x-f5xc-example": "example-resource",
|
|
4258
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
4081
4259
|
"minLength": 0,
|
|
4082
4260
|
"maxLength": 1024,
|
|
4083
4261
|
"x-f5xc-required-for": {
|
|
@@ -4100,6 +4278,8 @@
|
|
|
4100
4278
|
"x-validation-rules": {
|
|
4101
4279
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
4102
4280
|
},
|
|
4281
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
4282
|
+
"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...",
|
|
4103
4283
|
"minLength": 0,
|
|
4104
4284
|
"maxLength": 17,
|
|
4105
4285
|
"x-f5xc-required-for": {
|
|
@@ -4110,7 +4290,7 @@
|
|
|
4110
4290
|
},
|
|
4111
4291
|
"x-original-maxLength": 1024,
|
|
4112
4292
|
"x-reconciled-from-discovery": true,
|
|
4113
|
-
"x-reconciled-at": "2026-01-
|
|
4293
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556595+00:00"
|
|
4114
4294
|
},
|
|
4115
4295
|
"type": {
|
|
4116
4296
|
"type": "string",
|
|
@@ -4125,6 +4305,8 @@
|
|
|
4125
4305
|
"x-validation-rules": {
|
|
4126
4306
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
4127
4307
|
},
|
|
4308
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
4309
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
4128
4310
|
"minLength": 0,
|
|
4129
4311
|
"maxLength": 1024,
|
|
4130
4312
|
"x-f5xc-required-for": {
|
|
@@ -4135,6 +4317,8 @@
|
|
|
4135
4317
|
}
|
|
4136
4318
|
}
|
|
4137
4319
|
},
|
|
4320
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
4321
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
4138
4322
|
"x-f5xc-minimum-configuration": {
|
|
4139
4323
|
"description": "Minimum configuration for schemaConditionType",
|
|
4140
4324
|
"required_fields": [
|
|
@@ -4170,6 +4354,8 @@
|
|
|
4170
4354
|
"default": "EOK",
|
|
4171
4355
|
"x-displayname": "Error Code.",
|
|
4172
4356
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
4357
|
+
"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...",
|
|
4358
|
+
"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...",
|
|
4173
4359
|
"x-f5xc-minimum-configuration": {
|
|
4174
4360
|
"description": "Minimum configuration for schemaErrorCode",
|
|
4175
4361
|
"required_fields": [],
|
|
@@ -4210,6 +4396,7 @@
|
|
|
4210
4396
|
}
|
|
4211
4397
|
}
|
|
4212
4398
|
},
|
|
4399
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
4213
4400
|
"x-f5xc-minimum-configuration": {
|
|
4214
4401
|
"description": "Minimum configuration for schemaErrorType",
|
|
4215
4402
|
"required_fields": [
|
|
@@ -4237,6 +4424,7 @@
|
|
|
4237
4424
|
"title": "Name",
|
|
4238
4425
|
"x-displayname": "Name",
|
|
4239
4426
|
"x-f5xc-example": "example-resource",
|
|
4427
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
4240
4428
|
"minLength": 0,
|
|
4241
4429
|
"maxLength": 16,
|
|
4242
4430
|
"x-f5xc-required-for": {
|
|
@@ -4247,9 +4435,10 @@
|
|
|
4247
4435
|
},
|
|
4248
4436
|
"x-original-maxLength": 1024,
|
|
4249
4437
|
"x-reconciled-from-discovery": true,
|
|
4250
|
-
"x-reconciled-at": "2026-01-
|
|
4438
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556606+00:00"
|
|
4251
4439
|
}
|
|
4252
4440
|
},
|
|
4441
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
4253
4442
|
"x-f5xc-minimum-configuration": {
|
|
4254
4443
|
"description": "Minimum configuration for schemaInitializerType",
|
|
4255
4444
|
"required_fields": [
|
|
@@ -4277,6 +4466,8 @@
|
|
|
4277
4466
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
4278
4467
|
},
|
|
4279
4468
|
"x-displayname": "Pending",
|
|
4469
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
4470
|
+
"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.",
|
|
4280
4471
|
"x-f5xc-required-for": {
|
|
4281
4472
|
"minimum_config": false,
|
|
4282
4473
|
"create": false,
|
|
@@ -4288,6 +4479,7 @@
|
|
|
4288
4479
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
4289
4480
|
}
|
|
4290
4481
|
},
|
|
4482
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
4291
4483
|
"x-f5xc-minimum-configuration": {
|
|
4292
4484
|
"description": "Minimum configuration for schemaInitializersType",
|
|
4293
4485
|
"required_fields": [
|
|
@@ -4326,6 +4518,8 @@
|
|
|
4326
4518
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
4327
4519
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
4328
4520
|
},
|
|
4521
|
+
"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.",
|
|
4522
|
+
"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.",
|
|
4329
4523
|
"x-f5xc-required-for": {
|
|
4330
4524
|
"minimum_config": false,
|
|
4331
4525
|
"create": false,
|
|
@@ -4347,6 +4541,7 @@
|
|
|
4347
4541
|
"x-validation-rules": {
|
|
4348
4542
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
4349
4543
|
},
|
|
4544
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
4350
4545
|
"minLength": 0,
|
|
4351
4546
|
"x-f5xc-required-for": {
|
|
4352
4547
|
"minimum_config": false,
|
|
@@ -4356,7 +4551,7 @@
|
|
|
4356
4551
|
},
|
|
4357
4552
|
"x-original-maxLength": 1200,
|
|
4358
4553
|
"x-reconciled-from-discovery": true,
|
|
4359
|
-
"x-reconciled-at": "2026-01-
|
|
4554
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556617+00:00"
|
|
4360
4555
|
},
|
|
4361
4556
|
"disable": {
|
|
4362
4557
|
"type": "boolean",
|
|
@@ -4365,6 +4560,7 @@
|
|
|
4365
4560
|
"format": "boolean",
|
|
4366
4561
|
"x-displayname": "Disable",
|
|
4367
4562
|
"x-f5xc-example": "true",
|
|
4563
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
4368
4564
|
"x-f5xc-required-for": {
|
|
4369
4565
|
"minimum_config": false,
|
|
4370
4566
|
"create": false,
|
|
@@ -4378,6 +4574,8 @@
|
|
|
4378
4574
|
"title": "Labels",
|
|
4379
4575
|
"x-displayname": "Labels",
|
|
4380
4576
|
"x-f5xc-example": "value",
|
|
4577
|
+
"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.",
|
|
4578
|
+
"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.",
|
|
4381
4579
|
"x-f5xc-required-for": {
|
|
4382
4580
|
"minimum_config": false,
|
|
4383
4581
|
"create": false,
|
|
@@ -4399,6 +4597,8 @@
|
|
|
4399
4597
|
"x-validation-rules": {
|
|
4400
4598
|
"ves.io.schema.rules.message.required": "true"
|
|
4401
4599
|
},
|
|
4600
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
4601
|
+
"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.",
|
|
4402
4602
|
"minLength": 0,
|
|
4403
4603
|
"maxLength": 16,
|
|
4404
4604
|
"x-f5xc-required-for": {
|
|
@@ -4409,7 +4609,7 @@
|
|
|
4409
4609
|
},
|
|
4410
4610
|
"x-original-maxLength": 1024,
|
|
4411
4611
|
"x-reconciled-from-discovery": true,
|
|
4412
|
-
"x-reconciled-at": "2026-01-
|
|
4612
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556624+00:00"
|
|
4413
4613
|
},
|
|
4414
4614
|
"namespace": {
|
|
4415
4615
|
"type": "string",
|
|
@@ -4418,6 +4618,8 @@
|
|
|
4418
4618
|
"x-displayname": "Namespace",
|
|
4419
4619
|
"x-ves-example": "Staging",
|
|
4420
4620
|
"x-f5xc-example": "staging",
|
|
4621
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
4622
|
+
"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 \"\".",
|
|
4421
4623
|
"minLength": 0,
|
|
4422
4624
|
"maxLength": 6,
|
|
4423
4625
|
"x-f5xc-required-for": {
|
|
@@ -4428,9 +4630,10 @@
|
|
|
4428
4630
|
},
|
|
4429
4631
|
"x-original-maxLength": 1024,
|
|
4430
4632
|
"x-reconciled-from-discovery": true,
|
|
4431
|
-
"x-reconciled-at": "2026-01-
|
|
4633
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556628+00:00"
|
|
4432
4634
|
}
|
|
4433
4635
|
},
|
|
4636
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
4434
4637
|
"x-f5xc-minimum-configuration": {
|
|
4435
4638
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
4436
4639
|
"required_fields": [
|
|
@@ -4474,6 +4677,8 @@
|
|
|
4474
4677
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
4475
4678
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
4476
4679
|
},
|
|
4680
|
+
"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.",
|
|
4681
|
+
"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.",
|
|
4477
4682
|
"x-f5xc-required-for": {
|
|
4478
4683
|
"minimum_config": false,
|
|
4479
4684
|
"create": false,
|
|
@@ -4495,6 +4700,7 @@
|
|
|
4495
4700
|
"x-validation-rules": {
|
|
4496
4701
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
4497
4702
|
},
|
|
4703
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
4498
4704
|
"minLength": 0,
|
|
4499
4705
|
"x-f5xc-required-for": {
|
|
4500
4706
|
"minimum_config": false,
|
|
@@ -4504,7 +4710,7 @@
|
|
|
4504
4710
|
},
|
|
4505
4711
|
"x-original-maxLength": 1200,
|
|
4506
4712
|
"x-reconciled-from-discovery": true,
|
|
4507
|
-
"x-reconciled-at": "2026-01-
|
|
4713
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556634+00:00"
|
|
4508
4714
|
},
|
|
4509
4715
|
"disable": {
|
|
4510
4716
|
"type": "boolean",
|
|
@@ -4514,6 +4720,7 @@
|
|
|
4514
4720
|
"x-displayname": "Disable",
|
|
4515
4721
|
"x-ves-example": "True",
|
|
4516
4722
|
"x-f5xc-example": "true",
|
|
4723
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
4517
4724
|
"x-f5xc-required-for": {
|
|
4518
4725
|
"minimum_config": false,
|
|
4519
4726
|
"create": false,
|
|
@@ -4528,6 +4735,8 @@
|
|
|
4528
4735
|
"x-displayname": "Labels",
|
|
4529
4736
|
"x-ves-example": "Value",
|
|
4530
4737
|
"x-f5xc-example": "value",
|
|
4738
|
+
"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.",
|
|
4739
|
+
"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.",
|
|
4531
4740
|
"x-f5xc-required-for": {
|
|
4532
4741
|
"minimum_config": false,
|
|
4533
4742
|
"create": false,
|
|
@@ -4549,6 +4758,8 @@
|
|
|
4549
4758
|
"x-validation-rules": {
|
|
4550
4759
|
"ves.io.schema.rules.message.required": "true"
|
|
4551
4760
|
},
|
|
4761
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
4762
|
+
"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.",
|
|
4552
4763
|
"minLength": 0,
|
|
4553
4764
|
"maxLength": 16,
|
|
4554
4765
|
"x-f5xc-required-for": {
|
|
@@ -4559,7 +4770,7 @@
|
|
|
4559
4770
|
},
|
|
4560
4771
|
"x-original-maxLength": 1024,
|
|
4561
4772
|
"x-reconciled-from-discovery": true,
|
|
4562
|
-
"x-reconciled-at": "2026-01-
|
|
4773
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556641+00:00"
|
|
4563
4774
|
},
|
|
4564
4775
|
"namespace": {
|
|
4565
4776
|
"type": "string",
|
|
@@ -4568,6 +4779,8 @@
|
|
|
4568
4779
|
"x-displayname": "Namespace",
|
|
4569
4780
|
"x-ves-example": "Staging",
|
|
4570
4781
|
"x-f5xc-example": "staging",
|
|
4782
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
4783
|
+
"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 \"\".",
|
|
4571
4784
|
"minLength": 0,
|
|
4572
4785
|
"maxLength": 6,
|
|
4573
4786
|
"x-f5xc-required-for": {
|
|
@@ -4578,9 +4791,10 @@
|
|
|
4578
4791
|
},
|
|
4579
4792
|
"x-original-maxLength": 1024,
|
|
4580
4793
|
"x-reconciled-from-discovery": true,
|
|
4581
|
-
"x-reconciled-at": "2026-01-
|
|
4794
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556645+00:00"
|
|
4582
4795
|
}
|
|
4583
4796
|
},
|
|
4797
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
4584
4798
|
"x-f5xc-minimum-configuration": {
|
|
4585
4799
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
4586
4800
|
"required_fields": [
|
|
@@ -4624,6 +4838,8 @@
|
|
|
4624
4838
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
4625
4839
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
4626
4840
|
},
|
|
4841
|
+
"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.",
|
|
4842
|
+
"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.",
|
|
4627
4843
|
"x-f5xc-required-for": {
|
|
4628
4844
|
"minimum_config": false,
|
|
4629
4845
|
"create": false,
|
|
@@ -4645,6 +4861,7 @@
|
|
|
4645
4861
|
"x-validation-rules": {
|
|
4646
4862
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
4647
4863
|
},
|
|
4864
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
4648
4865
|
"minLength": 0,
|
|
4649
4866
|
"x-f5xc-required-for": {
|
|
4650
4867
|
"minimum_config": false,
|
|
@@ -4654,7 +4871,7 @@
|
|
|
4654
4871
|
},
|
|
4655
4872
|
"x-original-maxLength": 1200,
|
|
4656
4873
|
"x-reconciled-from-discovery": true,
|
|
4657
|
-
"x-reconciled-at": "2026-01-
|
|
4874
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556652+00:00"
|
|
4658
4875
|
},
|
|
4659
4876
|
"disable": {
|
|
4660
4877
|
"type": "boolean",
|
|
@@ -4664,6 +4881,7 @@
|
|
|
4664
4881
|
"x-displayname": "Disable",
|
|
4665
4882
|
"x-ves-example": "True",
|
|
4666
4883
|
"x-f5xc-example": "true",
|
|
4884
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
4667
4885
|
"x-f5xc-required-for": {
|
|
4668
4886
|
"minimum_config": false,
|
|
4669
4887
|
"create": false,
|
|
@@ -4678,6 +4896,8 @@
|
|
|
4678
4896
|
"x-displayname": "Labels",
|
|
4679
4897
|
"x-ves-example": "Value",
|
|
4680
4898
|
"x-f5xc-example": "value",
|
|
4899
|
+
"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.",
|
|
4900
|
+
"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.",
|
|
4681
4901
|
"x-f5xc-required-for": {
|
|
4682
4902
|
"minimum_config": false,
|
|
4683
4903
|
"create": false,
|
|
@@ -4699,6 +4919,8 @@
|
|
|
4699
4919
|
"x-validation-rules": {
|
|
4700
4920
|
"ves.io.schema.rules.message.required": "true"
|
|
4701
4921
|
},
|
|
4922
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
4923
|
+
"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.",
|
|
4702
4924
|
"minLength": 0,
|
|
4703
4925
|
"maxLength": 16,
|
|
4704
4926
|
"x-f5xc-required-for": {
|
|
@@ -4709,7 +4931,7 @@
|
|
|
4709
4931
|
},
|
|
4710
4932
|
"x-original-maxLength": 1024,
|
|
4711
4933
|
"x-reconciled-from-discovery": true,
|
|
4712
|
-
"x-reconciled-at": "2026-01-
|
|
4934
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556659+00:00"
|
|
4713
4935
|
},
|
|
4714
4936
|
"namespace": {
|
|
4715
4937
|
"type": "string",
|
|
@@ -4718,6 +4940,8 @@
|
|
|
4718
4940
|
"x-displayname": "Namespace",
|
|
4719
4941
|
"x-ves-example": "Staging",
|
|
4720
4942
|
"x-f5xc-example": "staging",
|
|
4943
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
4944
|
+
"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 \"\".",
|
|
4721
4945
|
"minLength": 0,
|
|
4722
4946
|
"maxLength": 6,
|
|
4723
4947
|
"x-f5xc-required-for": {
|
|
@@ -4728,7 +4952,7 @@
|
|
|
4728
4952
|
},
|
|
4729
4953
|
"x-original-maxLength": 1024,
|
|
4730
4954
|
"x-reconciled-from-discovery": true,
|
|
4731
|
-
"x-reconciled-at": "2026-01-
|
|
4955
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556663+00:00"
|
|
4732
4956
|
},
|
|
4733
4957
|
"uid": {
|
|
4734
4958
|
"type": "string",
|
|
@@ -4737,6 +4961,8 @@
|
|
|
4737
4961
|
"x-displayname": "UID",
|
|
4738
4962
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
4739
4963
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
4964
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system.",
|
|
4965
|
+
"x-f5xc-description-medium": "Uid is the unique in time and space value for this object. Object create will fail if provided by the client and the value exists in the system. Typically generated by the server on successful creation of an object and is not allowed to change once populated.",
|
|
4740
4966
|
"minLength": 0,
|
|
4741
4967
|
"maxLength": 36,
|
|
4742
4968
|
"x-f5xc-required-for": {
|
|
@@ -4750,9 +4976,11 @@
|
|
|
4750
4976
|
"x-original-maxLength": 1024,
|
|
4751
4977
|
"format": "uuid",
|
|
4752
4978
|
"x-reconciled-from-discovery": true,
|
|
4753
|
-
"x-reconciled-at": "2026-01-
|
|
4979
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556669+00:00"
|
|
4754
4980
|
}
|
|
4755
4981
|
},
|
|
4982
|
+
"x-f5xc-description-short": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have.",
|
|
4983
|
+
"x-f5xc-description-medium": "ObjectMetaType is metadata(common attributes) of an object that all configuration objects will have. The information in this type can be specified by user during create and replace APIs.",
|
|
4756
4984
|
"x-f5xc-minimum-configuration": {
|
|
4757
4985
|
"description": "Minimum configuration for schemaObjectMetaType",
|
|
4758
4986
|
"required_fields": [
|
|
@@ -4785,6 +5013,8 @@
|
|
|
4785
5013
|
"x-displayname": "Kind",
|
|
4786
5014
|
"x-ves-example": "Virtual_site.",
|
|
4787
5015
|
"x-f5xc-example": "virtual_site",
|
|
5016
|
+
"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\")",
|
|
5017
|
+
"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\").",
|
|
4788
5018
|
"minLength": 0,
|
|
4789
5019
|
"maxLength": 14,
|
|
4790
5020
|
"x-f5xc-required-for": {
|
|
@@ -4796,7 +5026,7 @@
|
|
|
4796
5026
|
"readOnly": true,
|
|
4797
5027
|
"x-original-maxLength": 1024,
|
|
4798
5028
|
"x-reconciled-from-discovery": true,
|
|
4799
|
-
"x-reconciled-at": "2026-01-
|
|
5029
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556674+00:00"
|
|
4800
5030
|
},
|
|
4801
5031
|
"name": {
|
|
4802
5032
|
"type": "string",
|
|
@@ -4805,6 +5035,8 @@
|
|
|
4805
5035
|
"x-displayname": "Name",
|
|
4806
5036
|
"x-ves-example": "Contactus-route.",
|
|
4807
5037
|
"x-f5xc-example": "contactus-route",
|
|
5038
|
+
"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.",
|
|
5039
|
+
"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.",
|
|
4808
5040
|
"minLength": 0,
|
|
4809
5041
|
"maxLength": 16,
|
|
4810
5042
|
"x-f5xc-required-for": {
|
|
@@ -4815,7 +5047,7 @@
|
|
|
4815
5047
|
},
|
|
4816
5048
|
"x-original-maxLength": 1024,
|
|
4817
5049
|
"x-reconciled-from-discovery": true,
|
|
4818
|
-
"x-reconciled-at": "2026-01-
|
|
5050
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556679+00:00"
|
|
4819
5051
|
},
|
|
4820
5052
|
"namespace": {
|
|
4821
5053
|
"type": "string",
|
|
@@ -4824,6 +5056,8 @@
|
|
|
4824
5056
|
"x-displayname": "Namespace",
|
|
4825
5057
|
"x-ves-example": "Ns1",
|
|
4826
5058
|
"x-f5xc-example": "ns1",
|
|
5059
|
+
"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.",
|
|
5060
|
+
"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.",
|
|
4827
5061
|
"minLength": 0,
|
|
4828
5062
|
"maxLength": 6,
|
|
4829
5063
|
"x-f5xc-required-for": {
|
|
@@ -4834,7 +5068,7 @@
|
|
|
4834
5068
|
},
|
|
4835
5069
|
"x-original-maxLength": 1024,
|
|
4836
5070
|
"x-reconciled-from-discovery": true,
|
|
4837
|
-
"x-reconciled-at": "2026-01-
|
|
5071
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556683+00:00"
|
|
4838
5072
|
},
|
|
4839
5073
|
"tenant": {
|
|
4840
5074
|
"type": "string",
|
|
@@ -4843,6 +5077,8 @@
|
|
|
4843
5077
|
"x-displayname": "Tenant",
|
|
4844
5078
|
"x-ves-example": "Example-corp.",
|
|
4845
5079
|
"x-f5xc-example": "example-corp",
|
|
5080
|
+
"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.",
|
|
5081
|
+
"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.",
|
|
4846
5082
|
"minLength": 0,
|
|
4847
5083
|
"maxLength": 18,
|
|
4848
5084
|
"x-f5xc-required-for": {
|
|
@@ -4855,7 +5091,7 @@
|
|
|
4855
5091
|
"x-field-mutability": "read-only",
|
|
4856
5092
|
"x-original-maxLength": 1024,
|
|
4857
5093
|
"x-reconciled-from-discovery": true,
|
|
4858
|
-
"x-reconciled-at": "2026-01-
|
|
5094
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556687+00:00"
|
|
4859
5095
|
},
|
|
4860
5096
|
"uid": {
|
|
4861
5097
|
"type": "string",
|
|
@@ -4864,6 +5100,8 @@
|
|
|
4864
5100
|
"x-displayname": "UID",
|
|
4865
5101
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
4866
5102
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
5103
|
+
"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.",
|
|
5104
|
+
"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.",
|
|
4867
5105
|
"minLength": 0,
|
|
4868
5106
|
"maxLength": 36,
|
|
4869
5107
|
"x-f5xc-required-for": {
|
|
@@ -4877,9 +5115,11 @@
|
|
|
4877
5115
|
"x-original-maxLength": 1024,
|
|
4878
5116
|
"format": "uuid",
|
|
4879
5117
|
"x-reconciled-from-discovery": true,
|
|
4880
|
-
"x-reconciled-at": "2026-01-
|
|
5118
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556692+00:00"
|
|
4881
5119
|
}
|
|
4882
5120
|
},
|
|
5121
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
5122
|
+
"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...",
|
|
4883
5123
|
"x-f5xc-minimum-configuration": {
|
|
4884
5124
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
4885
5125
|
"required_fields": [
|
|
@@ -4922,6 +5162,8 @@
|
|
|
4922
5162
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
4923
5163
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
4924
5164
|
},
|
|
5165
|
+
"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.",
|
|
5166
|
+
"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.",
|
|
4925
5167
|
"x-f5xc-required-for": {
|
|
4926
5168
|
"minimum_config": false,
|
|
4927
5169
|
"create": false,
|
|
@@ -4943,6 +5185,7 @@
|
|
|
4943
5185
|
"x-validation-rules": {
|
|
4944
5186
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
4945
5187
|
},
|
|
5188
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
4946
5189
|
"minLength": 0,
|
|
4947
5190
|
"x-f5xc-required-for": {
|
|
4948
5191
|
"minimum_config": false,
|
|
@@ -4952,7 +5195,7 @@
|
|
|
4952
5195
|
},
|
|
4953
5196
|
"x-original-maxLength": 1200,
|
|
4954
5197
|
"x-reconciled-from-discovery": true,
|
|
4955
|
-
"x-reconciled-at": "2026-01-
|
|
5198
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556699+00:00"
|
|
4956
5199
|
},
|
|
4957
5200
|
"disable": {
|
|
4958
5201
|
"type": "boolean",
|
|
@@ -4961,6 +5204,7 @@
|
|
|
4961
5204
|
"format": "boolean",
|
|
4962
5205
|
"x-displayname": "Disable",
|
|
4963
5206
|
"x-f5xc-example": "true",
|
|
5207
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
4964
5208
|
"x-f5xc-required-for": {
|
|
4965
5209
|
"minimum_config": false,
|
|
4966
5210
|
"create": false,
|
|
@@ -4975,6 +5219,8 @@
|
|
|
4975
5219
|
"x-displayname": "Labels",
|
|
4976
5220
|
"x-ves-example": "Value",
|
|
4977
5221
|
"x-f5xc-example": "value",
|
|
5222
|
+
"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.",
|
|
5223
|
+
"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.",
|
|
4978
5224
|
"x-f5xc-required-for": {
|
|
4979
5225
|
"minimum_config": false,
|
|
4980
5226
|
"create": false,
|
|
@@ -4995,6 +5241,8 @@
|
|
|
4995
5241
|
"x-validation-rules": {
|
|
4996
5242
|
"ves.io.schema.rules.message.required": "true"
|
|
4997
5243
|
},
|
|
5244
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
5245
|
+
"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.",
|
|
4998
5246
|
"minLength": 0,
|
|
4999
5247
|
"maxLength": 16,
|
|
5000
5248
|
"x-f5xc-required-for": {
|
|
@@ -5005,7 +5253,7 @@
|
|
|
5005
5253
|
},
|
|
5006
5254
|
"x-original-maxLength": 1024,
|
|
5007
5255
|
"x-reconciled-from-discovery": true,
|
|
5008
|
-
"x-reconciled-at": "2026-01-
|
|
5256
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556707+00:00"
|
|
5009
5257
|
},
|
|
5010
5258
|
"namespace": {
|
|
5011
5259
|
"type": "string",
|
|
@@ -5014,6 +5262,8 @@
|
|
|
5014
5262
|
"x-displayname": "Namespace",
|
|
5015
5263
|
"x-ves-example": "Staging",
|
|
5016
5264
|
"x-f5xc-example": "staging",
|
|
5265
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
5266
|
+
"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 \"\".",
|
|
5017
5267
|
"minLength": 0,
|
|
5018
5268
|
"maxLength": 6,
|
|
5019
5269
|
"x-f5xc-required-for": {
|
|
@@ -5024,9 +5274,10 @@
|
|
|
5024
5274
|
},
|
|
5025
5275
|
"x-original-maxLength": 1024,
|
|
5026
5276
|
"x-reconciled-from-discovery": true,
|
|
5027
|
-
"x-reconciled-at": "2026-01-
|
|
5277
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556711+00:00"
|
|
5028
5278
|
}
|
|
5029
5279
|
},
|
|
5280
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
5030
5281
|
"x-f5xc-minimum-configuration": {
|
|
5031
5282
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
5032
5283
|
"required_fields": [
|
|
@@ -5057,6 +5308,8 @@
|
|
|
5057
5308
|
"title": "Creation_timestamp.",
|
|
5058
5309
|
"format": "date-time",
|
|
5059
5310
|
"x-displayname": "Creation Timestamp.",
|
|
5311
|
+
"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.",
|
|
5312
|
+
"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.",
|
|
5060
5313
|
"minLength": 0,
|
|
5061
5314
|
"maxLength": 1024,
|
|
5062
5315
|
"x-f5xc-required-for": {
|
|
@@ -5074,6 +5327,8 @@
|
|
|
5074
5327
|
"x-displayname": "Creator Class.",
|
|
5075
5328
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
5076
5329
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
5330
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
5331
|
+
"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.",
|
|
5077
5332
|
"minLength": 0,
|
|
5078
5333
|
"maxLength": 1024,
|
|
5079
5334
|
"x-f5xc-required-for": {
|
|
@@ -5091,6 +5346,8 @@
|
|
|
5091
5346
|
"x-displayname": "Creator ID.",
|
|
5092
5347
|
"x-ves-example": "Ver-instance-1.",
|
|
5093
5348
|
"x-f5xc-example": "ver-instance-1",
|
|
5349
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
5350
|
+
"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.",
|
|
5094
5351
|
"minLength": 0,
|
|
5095
5352
|
"maxLength": 1024,
|
|
5096
5353
|
"x-f5xc-required-for": {
|
|
@@ -5109,6 +5366,8 @@
|
|
|
5109
5366
|
"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)",
|
|
5110
5367
|
"title": "Status_id",
|
|
5111
5368
|
"x-displayname": "Status ID",
|
|
5369
|
+
"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...",
|
|
5370
|
+
"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).",
|
|
5112
5371
|
"minLength": 0,
|
|
5113
5372
|
"maxLength": 1024,
|
|
5114
5373
|
"x-f5xc-required-for": {
|
|
@@ -5126,6 +5385,7 @@
|
|
|
5126
5385
|
"x-displayname": "UID",
|
|
5127
5386
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
5128
5387
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
5388
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
5129
5389
|
"minLength": 0,
|
|
5130
5390
|
"maxLength": 36,
|
|
5131
5391
|
"x-f5xc-required-for": {
|
|
@@ -5138,13 +5398,14 @@
|
|
|
5138
5398
|
"x-original-maxLength": 1024,
|
|
5139
5399
|
"format": "uuid",
|
|
5140
5400
|
"x-reconciled-from-discovery": true,
|
|
5141
|
-
"x-reconciled-at": "2026-01-
|
|
5401
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556723+00:00"
|
|
5142
5402
|
},
|
|
5143
5403
|
"vtrp_id": {
|
|
5144
5404
|
"type": "string",
|
|
5145
5405
|
"description": "Origin of this status exchanged by VTRP.",
|
|
5146
5406
|
"title": "Vtrp_id",
|
|
5147
5407
|
"x-displayname": "VTRP ID",
|
|
5408
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
5148
5409
|
"minLength": 0,
|
|
5149
5410
|
"maxLength": 1024,
|
|
5150
5411
|
"x-f5xc-required-for": {
|
|
@@ -5161,6 +5422,7 @@
|
|
|
5161
5422
|
"title": "Vtrp_stale.",
|
|
5162
5423
|
"format": "boolean",
|
|
5163
5424
|
"x-displayname": "VTRP Stale.",
|
|
5425
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
5164
5426
|
"x-f5xc-required-for": {
|
|
5165
5427
|
"minimum_config": false,
|
|
5166
5428
|
"create": false,
|
|
@@ -5169,6 +5431,7 @@
|
|
|
5169
5431
|
}
|
|
5170
5432
|
}
|
|
5171
5433
|
},
|
|
5434
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
5172
5435
|
"x-f5xc-minimum-configuration": {
|
|
5173
5436
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
5174
5437
|
"required_fields": [
|
|
@@ -5199,6 +5462,8 @@
|
|
|
5199
5462
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
5200
5463
|
"x-displayname": "Status Publish Type.",
|
|
5201
5464
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
5465
|
+
"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.",
|
|
5466
|
+
"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.",
|
|
5202
5467
|
"x-f5xc-minimum-configuration": {
|
|
5203
5468
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
5204
5469
|
"required_fields": [],
|
|
@@ -5224,6 +5489,7 @@
|
|
|
5224
5489
|
"x-displayname": "Code",
|
|
5225
5490
|
"x-ves-example": "0",
|
|
5226
5491
|
"x-f5xc-example": "0",
|
|
5492
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
5227
5493
|
"minimum": 0,
|
|
5228
5494
|
"maximum": 2147483647,
|
|
5229
5495
|
"x-f5xc-required-for": {
|
|
@@ -5240,6 +5506,8 @@
|
|
|
5240
5506
|
"x-displayname": "Reason",
|
|
5241
5507
|
"x-ves-example": "Value",
|
|
5242
5508
|
"x-f5xc-example": "value",
|
|
5509
|
+
"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.",
|
|
5510
|
+
"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.",
|
|
5243
5511
|
"minLength": 0,
|
|
5244
5512
|
"maxLength": 43,
|
|
5245
5513
|
"x-f5xc-required-for": {
|
|
@@ -5250,7 +5518,7 @@
|
|
|
5250
5518
|
},
|
|
5251
5519
|
"x-original-maxLength": 1024,
|
|
5252
5520
|
"x-reconciled-from-discovery": true,
|
|
5253
|
-
"x-reconciled-at": "2026-01-
|
|
5521
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556732+00:00"
|
|
5254
5522
|
},
|
|
5255
5523
|
"status": {
|
|
5256
5524
|
"type": "string",
|
|
@@ -5259,6 +5527,7 @@
|
|
|
5259
5527
|
"x-displayname": "Status",
|
|
5260
5528
|
"x-ves-example": "Value",
|
|
5261
5529
|
"x-f5xc-example": "value",
|
|
5530
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
5262
5531
|
"minLength": 0,
|
|
5263
5532
|
"maxLength": 17,
|
|
5264
5533
|
"x-f5xc-required-for": {
|
|
@@ -5269,9 +5538,10 @@
|
|
|
5269
5538
|
},
|
|
5270
5539
|
"x-original-maxLength": 1024,
|
|
5271
5540
|
"x-reconciled-from-discovery": true,
|
|
5272
|
-
"x-reconciled-at": "2026-01-
|
|
5541
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556736+00:00"
|
|
5273
5542
|
}
|
|
5274
5543
|
},
|
|
5544
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
5275
5545
|
"x-f5xc-minimum-configuration": {
|
|
5276
5546
|
"description": "Minimum configuration for schemaStatusType",
|
|
5277
5547
|
"required_fields": [
|
|
@@ -5299,6 +5569,8 @@
|
|
|
5299
5569
|
"title": "Creation_timestamp.",
|
|
5300
5570
|
"format": "date-time",
|
|
5301
5571
|
"x-displayname": "Creation Timestamp.",
|
|
5572
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
5573
|
+
"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.",
|
|
5302
5574
|
"minLength": 0,
|
|
5303
5575
|
"maxLength": 1024,
|
|
5304
5576
|
"x-f5xc-required-for": {
|
|
@@ -5316,6 +5588,7 @@
|
|
|
5316
5588
|
"x-displayname": "Creator Class.",
|
|
5317
5589
|
"x-ves-example": "Prism",
|
|
5318
5590
|
"x-f5xc-example": "value",
|
|
5591
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
5319
5592
|
"minLength": 0,
|
|
5320
5593
|
"maxLength": 1024,
|
|
5321
5594
|
"x-f5xc-required-for": {
|
|
@@ -5333,6 +5606,7 @@
|
|
|
5333
5606
|
"x-displayname": "Creator ID.",
|
|
5334
5607
|
"x-ves-example": "Admin@example-corp.com.",
|
|
5335
5608
|
"x-f5xc-example": "value",
|
|
5609
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
5336
5610
|
"minLength": 0,
|
|
5337
5611
|
"maxLength": 1024,
|
|
5338
5612
|
"x-f5xc-required-for": {
|
|
@@ -5349,6 +5623,8 @@
|
|
|
5349
5623
|
"title": "Deletion_timestamp.",
|
|
5350
5624
|
"format": "date-time",
|
|
5351
5625
|
"x-displayname": "Deletion Timestamp.",
|
|
5626
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
5627
|
+
"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...",
|
|
5352
5628
|
"minLength": 0,
|
|
5353
5629
|
"maxLength": 1024,
|
|
5354
5630
|
"x-f5xc-required-for": {
|
|
@@ -5368,6 +5644,8 @@
|
|
|
5368
5644
|
"x-displayname": "Finalizers.",
|
|
5369
5645
|
"x-ves-example": "Value",
|
|
5370
5646
|
"x-f5xc-example": "value",
|
|
5647
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
5648
|
+
"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.",
|
|
5371
5649
|
"x-f5xc-required-for": {
|
|
5372
5650
|
"minimum_config": false,
|
|
5373
5651
|
"create": false,
|
|
@@ -5385,6 +5663,8 @@
|
|
|
5385
5663
|
"x-displayname": "Labels",
|
|
5386
5664
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
5387
5665
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
5666
|
+
"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.",
|
|
5667
|
+
"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).",
|
|
5388
5668
|
"x-f5xc-required-for": {
|
|
5389
5669
|
"minimum_config": false,
|
|
5390
5670
|
"create": false,
|
|
@@ -5398,6 +5678,8 @@
|
|
|
5398
5678
|
"title": "Modification_timestamp.",
|
|
5399
5679
|
"format": "date-time",
|
|
5400
5680
|
"x-displayname": "Modification Timestamp.",
|
|
5681
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
5682
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
5401
5683
|
"minLength": 0,
|
|
5402
5684
|
"maxLength": 1024,
|
|
5403
5685
|
"x-f5xc-required-for": {
|
|
@@ -5416,6 +5698,8 @@
|
|
|
5416
5698
|
"x-displayname": "Object Index.",
|
|
5417
5699
|
"x-ves-example": "0",
|
|
5418
5700
|
"x-f5xc-example": "0",
|
|
5701
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
5702
|
+
"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.",
|
|
5419
5703
|
"minimum": 0,
|
|
5420
5704
|
"maximum": 2147483647,
|
|
5421
5705
|
"x-f5xc-required-for": {
|
|
@@ -5436,6 +5720,8 @@
|
|
|
5436
5720
|
"x-displayname": "Tenant",
|
|
5437
5721
|
"x-ves-example": "Example-corp.",
|
|
5438
5722
|
"x-f5xc-example": "example-corp",
|
|
5723
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
5724
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
5439
5725
|
"minLength": 0,
|
|
5440
5726
|
"maxLength": 18,
|
|
5441
5727
|
"x-f5xc-required-for": {
|
|
@@ -5447,7 +5733,7 @@
|
|
|
5447
5733
|
"x-field-mutability": "read-only",
|
|
5448
5734
|
"x-original-maxLength": 1024,
|
|
5449
5735
|
"x-reconciled-from-discovery": true,
|
|
5450
|
-
"x-reconciled-at": "2026-01-
|
|
5736
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556755+00:00"
|
|
5451
5737
|
},
|
|
5452
5738
|
"uid": {
|
|
5453
5739
|
"type": "string",
|
|
@@ -5456,6 +5742,8 @@
|
|
|
5456
5742
|
"x-displayname": "UID",
|
|
5457
5743
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
5458
5744
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
5745
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
5746
|
+
"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.",
|
|
5459
5747
|
"minLength": 0,
|
|
5460
5748
|
"maxLength": 36,
|
|
5461
5749
|
"x-f5xc-required-for": {
|
|
@@ -5468,9 +5756,11 @@
|
|
|
5468
5756
|
"x-original-maxLength": 1024,
|
|
5469
5757
|
"format": "uuid",
|
|
5470
5758
|
"x-reconciled-from-discovery": true,
|
|
5471
|
-
"x-reconciled-at": "2026-01-
|
|
5759
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556760+00:00"
|
|
5472
5760
|
}
|
|
5473
5761
|
},
|
|
5762
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
5763
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
5474
5764
|
"x-f5xc-minimum-configuration": {
|
|
5475
5765
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
5476
5766
|
"required_fields": [
|
|
@@ -5507,6 +5797,8 @@
|
|
|
5507
5797
|
"title": "Creation_timestamp.",
|
|
5508
5798
|
"format": "date-time",
|
|
5509
5799
|
"x-displayname": "Creation Timestamp.",
|
|
5800
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
5801
|
+
"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.",
|
|
5510
5802
|
"minLength": 0,
|
|
5511
5803
|
"maxLength": 1024,
|
|
5512
5804
|
"x-f5xc-required-for": {
|
|
@@ -5525,6 +5817,7 @@
|
|
|
5525
5817
|
"x-displayname": "Creator Class.",
|
|
5526
5818
|
"x-ves-example": "Value",
|
|
5527
5819
|
"x-f5xc-example": "value",
|
|
5820
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
5528
5821
|
"minLength": 0,
|
|
5529
5822
|
"maxLength": 1024,
|
|
5530
5823
|
"x-f5xc-required-for": {
|
|
@@ -5543,6 +5836,8 @@
|
|
|
5543
5836
|
"x-displayname": "Creator Cookie.",
|
|
5544
5837
|
"x-ves-example": "Value",
|
|
5545
5838
|
"x-f5xc-example": "value",
|
|
5839
|
+
"x-f5xc-description-short": "Can used by the creator of the object for later audit for e.g.",
|
|
5840
|
+
"x-f5xc-description-medium": "Can used by the creator of the object for later audit for e.g. By storing the version identifying information of the object so at future it can be determined if version present at remote end is current or stale.",
|
|
5546
5841
|
"minLength": 0,
|
|
5547
5842
|
"maxLength": 1024,
|
|
5548
5843
|
"x-f5xc-required-for": {
|
|
@@ -5560,6 +5855,7 @@
|
|
|
5560
5855
|
"x-displayname": "Creator ID.",
|
|
5561
5856
|
"x-ves-example": "Value",
|
|
5562
5857
|
"x-f5xc-example": "value",
|
|
5858
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
5563
5859
|
"minLength": 0,
|
|
5564
5860
|
"maxLength": 1024,
|
|
5565
5861
|
"x-f5xc-required-for": {
|
|
@@ -5577,6 +5873,8 @@
|
|
|
5577
5873
|
"title": "Deletion_timestamp.",
|
|
5578
5874
|
"format": "date-time",
|
|
5579
5875
|
"x-displayname": "Deletion Timestamp.",
|
|
5876
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
5877
|
+
"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...",
|
|
5580
5878
|
"minLength": 0,
|
|
5581
5879
|
"maxLength": 1024,
|
|
5582
5880
|
"x-f5xc-required-for": {
|
|
@@ -5591,6 +5889,8 @@
|
|
|
5591
5889
|
"description": "A hash of the UIDs of direct references on this object. This can be used to determine if\nthis object hash has had references become resolved/unresolved.",
|
|
5592
5890
|
"title": "Direct_ref_hash.",
|
|
5593
5891
|
"x-displayname": "Direct Reference Hash.",
|
|
5892
|
+
"x-f5xc-description-short": "Hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.",
|
|
5893
|
+
"x-f5xc-description-medium": "Hash of the UIDs of direct references on this object. This can be used to determine if this object hash has had references become resolved/unresolved.",
|
|
5594
5894
|
"minLength": 0,
|
|
5595
5895
|
"maxLength": 1024,
|
|
5596
5896
|
"x-f5xc-required-for": {
|
|
@@ -5610,6 +5910,8 @@
|
|
|
5610
5910
|
"x-displayname": "Finalizers.",
|
|
5611
5911
|
"x-ves-example": "Value",
|
|
5612
5912
|
"x-f5xc-example": "value",
|
|
5913
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
5914
|
+
"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.",
|
|
5613
5915
|
"x-f5xc-required-for": {
|
|
5614
5916
|
"minimum_config": false,
|
|
5615
5917
|
"create": false,
|
|
@@ -5627,6 +5929,8 @@
|
|
|
5627
5929
|
"x-displayname": "Labels",
|
|
5628
5930
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
5629
5931
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
5932
|
+
"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.",
|
|
5933
|
+
"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).",
|
|
5630
5934
|
"x-f5xc-required-for": {
|
|
5631
5935
|
"minimum_config": false,
|
|
5632
5936
|
"create": false,
|
|
@@ -5640,6 +5944,8 @@
|
|
|
5640
5944
|
"title": "Modification_timestamp.",
|
|
5641
5945
|
"format": "date-time",
|
|
5642
5946
|
"x-displayname": "Modification Timestamp.",
|
|
5947
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
5948
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
5643
5949
|
"minLength": 0,
|
|
5644
5950
|
"maxLength": 1024,
|
|
5645
5951
|
"x-f5xc-required-for": {
|
|
@@ -5666,6 +5972,9 @@
|
|
|
5666
5972
|
"x-validation-rules": {
|
|
5667
5973
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
5668
5974
|
},
|
|
5975
|
+
"x-f5xc-example": "example-resource",
|
|
5976
|
+
"x-f5xc-description-short": "The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.",
|
|
5977
|
+
"x-f5xc-description-medium": "The namespace this object belongs to. This is populated by the service based on the metadata.namespace field when an object is created.",
|
|
5669
5978
|
"x-f5xc-required-for": {
|
|
5670
5979
|
"minimum_config": false,
|
|
5671
5980
|
"create": false,
|
|
@@ -5675,7 +5984,7 @@
|
|
|
5675
5984
|
"maxLength": 6,
|
|
5676
5985
|
"minLength": 6,
|
|
5677
5986
|
"x-reconciled-from-discovery": true,
|
|
5678
|
-
"x-reconciled-at": "2026-01-
|
|
5987
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556780+00:00"
|
|
5679
5988
|
},
|
|
5680
5989
|
"object_index": {
|
|
5681
5990
|
"type": "integer",
|
|
@@ -5685,6 +5994,8 @@
|
|
|
5685
5994
|
"x-displayname": "Object Index.",
|
|
5686
5995
|
"x-ves-example": "0",
|
|
5687
5996
|
"x-f5xc-example": "0",
|
|
5997
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
5998
|
+
"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.",
|
|
5688
5999
|
"minimum": 0,
|
|
5689
6000
|
"maximum": 2147483647,
|
|
5690
6001
|
"x-f5xc-required-for": {
|
|
@@ -5705,6 +6016,8 @@
|
|
|
5705
6016
|
"title": "Revision",
|
|
5706
6017
|
"format": "int64",
|
|
5707
6018
|
"x-displayname": "Revision",
|
|
6019
|
+
"x-f5xc-description-short": "Revision number which always increases with each modification of the object in storage This doesn't necessarily increase sequentially, but should...",
|
|
6020
|
+
"x-f5xc-description-medium": "Revision number which always increases with each modification of the object in storage This doesn't necessarily increase sequentially, but should always increase. This will be 0 when first created, and before any modifications.",
|
|
5708
6021
|
"minLength": 0,
|
|
5709
6022
|
"maxLength": 1024,
|
|
5710
6023
|
"x-f5xc-required-for": {
|
|
@@ -5722,6 +6035,8 @@
|
|
|
5722
6035
|
"x-displayname": "SRE Disable.",
|
|
5723
6036
|
"x-ves-example": "True",
|
|
5724
6037
|
"x-f5xc-example": "true",
|
|
6038
|
+
"x-f5xc-description-short": "Should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g.",
|
|
6039
|
+
"x-f5xc-description-medium": "Should be set to true If F5XC/SRE operator wants to suppress an object from being presented to business-logic of a daemon(e.g. Due to bad-form/issue-causing Object). This is meant only to be used in temporary situations for operational continuity till a fix is rolled out in business-logic.",
|
|
5725
6040
|
"x-f5xc-required-for": {
|
|
5726
6041
|
"minimum_config": false,
|
|
5727
6042
|
"create": false,
|
|
@@ -5736,6 +6051,8 @@
|
|
|
5736
6051
|
"x-displayname": "Tenant",
|
|
5737
6052
|
"x-ves-example": "Example-corp.",
|
|
5738
6053
|
"x-f5xc-example": "example-corp",
|
|
6054
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
6055
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
5739
6056
|
"minLength": 0,
|
|
5740
6057
|
"maxLength": 18,
|
|
5741
6058
|
"x-f5xc-required-for": {
|
|
@@ -5748,7 +6065,7 @@
|
|
|
5748
6065
|
"x-field-mutability": "read-only",
|
|
5749
6066
|
"x-original-maxLength": 1024,
|
|
5750
6067
|
"x-reconciled-from-discovery": true,
|
|
5751
|
-
"x-reconciled-at": "2026-01-
|
|
6068
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556790+00:00"
|
|
5752
6069
|
},
|
|
5753
6070
|
"trace_info": {
|
|
5754
6071
|
"type": "string",
|
|
@@ -5757,6 +6074,8 @@
|
|
|
5757
6074
|
"x-displayname": "Trace Info.",
|
|
5758
6075
|
"x-ves-example": "Value",
|
|
5759
6076
|
"x-f5xc-example": "value",
|
|
6077
|
+
"x-f5xc-description-short": "Trace_info holds information(<trace-ID>:<span-ID>:<parent-span-ID>) of the request doing the object modification.",
|
|
6078
|
+
"x-f5xc-description-medium": "Trace_info holds information(<trace-ID>:<span-ID>:<parent-span-ID>) of the request doing the object modification. This can be used on the watch side to create subsequent spans. This information can be used to co-relate activities across services (modulo state compression) for a synchronous API.",
|
|
5760
6079
|
"minLength": 0,
|
|
5761
6080
|
"maxLength": 1024,
|
|
5762
6081
|
"x-f5xc-required-for": {
|
|
@@ -5773,6 +6092,8 @@
|
|
|
5773
6092
|
"x-displayname": "UID",
|
|
5774
6093
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
5775
6094
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6095
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
6096
|
+
"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.",
|
|
5776
6097
|
"minLength": 0,
|
|
5777
6098
|
"maxLength": 36,
|
|
5778
6099
|
"x-f5xc-required-for": {
|
|
@@ -5786,7 +6107,7 @@
|
|
|
5786
6107
|
"x-original-maxLength": 1024,
|
|
5787
6108
|
"format": "uuid",
|
|
5788
6109
|
"x-reconciled-from-discovery": true,
|
|
5789
|
-
"x-reconciled-at": "2026-01-
|
|
6110
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556797+00:00"
|
|
5790
6111
|
},
|
|
5791
6112
|
"vtrp_id": {
|
|
5792
6113
|
"type": "string",
|
|
@@ -5809,6 +6130,7 @@
|
|
|
5809
6130
|
"title": "Vtrp_stale.",
|
|
5810
6131
|
"format": "boolean",
|
|
5811
6132
|
"x-displayname": "VTRP Stale.",
|
|
6133
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
5812
6134
|
"x-f5xc-required-for": {
|
|
5813
6135
|
"minimum_config": false,
|
|
5814
6136
|
"create": false,
|
|
@@ -5817,6 +6139,8 @@
|
|
|
5817
6139
|
}
|
|
5818
6140
|
}
|
|
5819
6141
|
},
|
|
6142
|
+
"x-f5xc-description-short": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
6143
|
+
"x-f5xc-description-medium": "SystemObjectMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
5820
6144
|
"x-f5xc-minimum-configuration": {
|
|
5821
6145
|
"description": "Minimum configuration for schemaSystemObjectMetaType",
|
|
5822
6146
|
"required_fields": [
|
|
@@ -5872,7 +6196,7 @@
|
|
|
5872
6196
|
},
|
|
5873
6197
|
"x-original-maxLength": 1024,
|
|
5874
6198
|
"x-reconciled-from-discovery": true,
|
|
5875
|
-
"x-reconciled-at": "2026-01-
|
|
6199
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556804+00:00"
|
|
5876
6200
|
},
|
|
5877
6201
|
"name": {
|
|
5878
6202
|
"type": "string",
|
|
@@ -5881,6 +6205,8 @@
|
|
|
5881
6205
|
"x-displayname": "Name",
|
|
5882
6206
|
"x-ves-example": "Contactus-route.",
|
|
5883
6207
|
"x-f5xc-example": "contactus-route",
|
|
6208
|
+
"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.",
|
|
6209
|
+
"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.",
|
|
5884
6210
|
"minLength": 0,
|
|
5885
6211
|
"maxLength": 16,
|
|
5886
6212
|
"x-f5xc-required-for": {
|
|
@@ -5891,7 +6217,7 @@
|
|
|
5891
6217
|
},
|
|
5892
6218
|
"x-original-maxLength": 1024,
|
|
5893
6219
|
"x-reconciled-from-discovery": true,
|
|
5894
|
-
"x-reconciled-at": "2026-01-
|
|
6220
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556808+00:00"
|
|
5895
6221
|
},
|
|
5896
6222
|
"namespace": {
|
|
5897
6223
|
"type": "string",
|
|
@@ -5900,6 +6226,8 @@
|
|
|
5900
6226
|
"x-displayname": "Namespace",
|
|
5901
6227
|
"x-ves-example": "Ns1",
|
|
5902
6228
|
"x-f5xc-example": "ns1",
|
|
6229
|
+
"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.",
|
|
6230
|
+
"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.",
|
|
5903
6231
|
"minLength": 0,
|
|
5904
6232
|
"maxLength": 6,
|
|
5905
6233
|
"x-f5xc-required-for": {
|
|
@@ -5910,7 +6238,7 @@
|
|
|
5910
6238
|
},
|
|
5911
6239
|
"x-original-maxLength": 1024,
|
|
5912
6240
|
"x-reconciled-from-discovery": true,
|
|
5913
|
-
"x-reconciled-at": "2026-01-
|
|
6241
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556812+00:00"
|
|
5914
6242
|
},
|
|
5915
6243
|
"uid": {
|
|
5916
6244
|
"type": "string",
|
|
@@ -5931,9 +6259,10 @@
|
|
|
5931
6259
|
"x-original-maxLength": 1024,
|
|
5932
6260
|
"format": "uuid",
|
|
5933
6261
|
"x-reconciled-from-discovery": true,
|
|
5934
|
-
"x-reconciled-at": "2026-01-
|
|
6262
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556817+00:00"
|
|
5935
6263
|
}
|
|
5936
6264
|
},
|
|
6265
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
5937
6266
|
"x-f5xc-minimum-configuration": {
|
|
5938
6267
|
"description": "Minimum configuration for schemaViewRefType",
|
|
5939
6268
|
"required_fields": [
|
|
@@ -5958,6 +6287,8 @@
|
|
|
5958
6287
|
"JWT"
|
|
5959
6288
|
],
|
|
5960
6289
|
"default": "NORMAL",
|
|
6290
|
+
"x-f5xc-description-short": "X-displayName: \"Token Type\" Token type has two values, 1. \"normal\", 2. \"JWT\".",
|
|
6291
|
+
"x-f5xc-description-medium": "X-displayName: \"Token Type\" Token type has two values, 1. \"normal\", 2. \"JWT\". For Secure Mesh Site v2 UI, JWT is used, other workflow sticks to normal Single token can be used to register multiple sites - NORMAL: x-displayName: \"Normal\" token is in UUID format - JWT: x-displayName: \"JWT\" token...",
|
|
5961
6292
|
"x-f5xc-minimum-configuration": {
|
|
5962
6293
|
"description": "Minimum configuration for schematokenType",
|
|
5963
6294
|
"required_fields": [],
|
|
@@ -6029,6 +6360,8 @@
|
|
|
6029
6360
|
"title": "Create token.",
|
|
6030
6361
|
"x-displayname": "Create Token.",
|
|
6031
6362
|
"x-ves-proto-message": "ves.io.schema.token.CreateSpecType",
|
|
6363
|
+
"x-f5xc-description-short": "Creates new token. Token object is used to manage site admission.",
|
|
6364
|
+
"x-f5xc-description-medium": "Creates new token. Token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.",
|
|
6032
6365
|
"x-f5xc-minimum-configuration": {
|
|
6033
6366
|
"description": "Minimum configuration for tokenCreateSpecType",
|
|
6034
6367
|
"required_fields": [],
|
|
@@ -6052,6 +6385,7 @@
|
|
|
6052
6385
|
"title": "Fail_if_referred.",
|
|
6053
6386
|
"format": "boolean",
|
|
6054
6387
|
"x-displayname": "Fail-If-Referred.",
|
|
6388
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
6055
6389
|
"x-f5xc-required-for": {
|
|
6056
6390
|
"minimum_config": false,
|
|
6057
6391
|
"create": false,
|
|
@@ -6076,7 +6410,7 @@
|
|
|
6076
6410
|
},
|
|
6077
6411
|
"x-original-maxLength": 1024,
|
|
6078
6412
|
"x-reconciled-from-discovery": true,
|
|
6079
|
-
"x-reconciled-at": "2026-01-
|
|
6413
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556830+00:00"
|
|
6080
6414
|
},
|
|
6081
6415
|
"namespace": {
|
|
6082
6416
|
"type": "string",
|
|
@@ -6085,6 +6419,7 @@
|
|
|
6085
6419
|
"x-displayname": "Namespace",
|
|
6086
6420
|
"x-ves-example": "Ns1",
|
|
6087
6421
|
"x-f5xc-example": "ns1",
|
|
6422
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
6088
6423
|
"minLength": 0,
|
|
6089
6424
|
"maxLength": 6,
|
|
6090
6425
|
"x-f5xc-required-for": {
|
|
@@ -6095,7 +6430,7 @@
|
|
|
6095
6430
|
},
|
|
6096
6431
|
"x-original-maxLength": 1024,
|
|
6097
6432
|
"x-reconciled-from-discovery": true,
|
|
6098
|
-
"x-reconciled-at": "2026-01-
|
|
6433
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556834+00:00"
|
|
6099
6434
|
}
|
|
6100
6435
|
},
|
|
6101
6436
|
"x-f5xc-minimum-configuration": {
|
|
@@ -6134,7 +6469,7 @@
|
|
|
6134
6469
|
},
|
|
6135
6470
|
"x-original-maxLength": 1024,
|
|
6136
6471
|
"x-reconciled-from-discovery": true,
|
|
6137
|
-
"x-reconciled-at": "2026-01-
|
|
6472
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556839+00:00"
|
|
6138
6473
|
}
|
|
6139
6474
|
},
|
|
6140
6475
|
"x-f5xc-minimum-configuration": {
|
|
@@ -6167,6 +6502,7 @@
|
|
|
6167
6502
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6168
6503
|
},
|
|
6169
6504
|
"x-displayname": "Deleted Referred Objects.",
|
|
6505
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6170
6506
|
"x-f5xc-required-for": {
|
|
6171
6507
|
"minimum_config": false,
|
|
6172
6508
|
"create": false,
|
|
@@ -6182,6 +6518,7 @@
|
|
|
6182
6518
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6183
6519
|
},
|
|
6184
6520
|
"x-displayname": "Disabled Referred Objects.",
|
|
6521
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6185
6522
|
"x-f5xc-required-for": {
|
|
6186
6523
|
"minimum_config": false,
|
|
6187
6524
|
"create": false,
|
|
@@ -6200,6 +6537,7 @@
|
|
|
6200
6537
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6201
6538
|
},
|
|
6202
6539
|
"x-displayname": "Referring Objects.",
|
|
6540
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
6203
6541
|
"x-f5xc-required-for": {
|
|
6204
6542
|
"minimum_config": false,
|
|
6205
6543
|
"create": false,
|
|
@@ -6221,6 +6559,8 @@
|
|
|
6221
6559
|
"$ref": "#/components/schemas/tokenStatusObject"
|
|
6222
6560
|
},
|
|
6223
6561
|
"x-displayname": "Status",
|
|
6562
|
+
"x-f5xc-example": "active",
|
|
6563
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6224
6564
|
"x-f5xc-required-for": {
|
|
6225
6565
|
"minimum_config": false,
|
|
6226
6566
|
"create": false,
|
|
@@ -6230,7 +6570,7 @@
|
|
|
6230
6570
|
"maxLength": 17,
|
|
6231
6571
|
"minLength": 17,
|
|
6232
6572
|
"x-reconciled-from-discovery": true,
|
|
6233
|
-
"x-reconciled-at": "2026-01-
|
|
6573
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556854+00:00"
|
|
6234
6574
|
},
|
|
6235
6575
|
"system_metadata": {
|
|
6236
6576
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -6270,6 +6610,8 @@
|
|
|
6270
6610
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
6271
6611
|
],
|
|
6272
6612
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
6613
|
+
"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...",
|
|
6614
|
+
"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...",
|
|
6273
6615
|
"x-f5xc-minimum-configuration": {
|
|
6274
6616
|
"description": "Minimum configuration for tokenGetResponseFormatCode",
|
|
6275
6617
|
"required_fields": [],
|
|
@@ -6291,6 +6633,8 @@
|
|
|
6291
6633
|
"$ref": "#/components/schemas/tokenState"
|
|
6292
6634
|
}
|
|
6293
6635
|
},
|
|
6636
|
+
"x-f5xc-description-short": "GET token. Token object is used to manage site admission.",
|
|
6637
|
+
"x-f5xc-description-medium": "GET token. Token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.",
|
|
6294
6638
|
"x-f5xc-minimum-configuration": {
|
|
6295
6639
|
"description": "Minimum configuration for tokenGetSpecType",
|
|
6296
6640
|
"required_fields": [
|
|
@@ -6341,6 +6685,7 @@
|
|
|
6341
6685
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
6342
6686
|
},
|
|
6343
6687
|
"x-displayname": "Errors",
|
|
6688
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
6344
6689
|
"x-f5xc-required-for": {
|
|
6345
6690
|
"minimum_config": false,
|
|
6346
6691
|
"create": false,
|
|
@@ -6356,6 +6701,8 @@
|
|
|
6356
6701
|
"$ref": "#/components/schemas/tokenListResponseItem"
|
|
6357
6702
|
},
|
|
6358
6703
|
"x-displayname": "Items",
|
|
6704
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
6705
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
6359
6706
|
"x-f5xc-required-for": {
|
|
6360
6707
|
"minimum_config": false,
|
|
6361
6708
|
"create": false,
|
|
@@ -6389,6 +6736,8 @@
|
|
|
6389
6736
|
"description": "The set of annotations present on this token.",
|
|
6390
6737
|
"title": "Annotations.",
|
|
6391
6738
|
"x-displayname": "Annotations.",
|
|
6739
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6740
|
+
"x-f5xc-description-short": "The set of annotations present on this token.",
|
|
6392
6741
|
"x-f5xc-required-for": {
|
|
6393
6742
|
"minimum_config": false,
|
|
6394
6743
|
"create": false,
|
|
@@ -6411,7 +6760,7 @@
|
|
|
6411
6760
|
},
|
|
6412
6761
|
"x-original-maxLength": 1024,
|
|
6413
6762
|
"x-reconciled-from-discovery": true,
|
|
6414
|
-
"x-reconciled-at": "2026-01-
|
|
6763
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556867+00:00"
|
|
6415
6764
|
},
|
|
6416
6765
|
"disabled": {
|
|
6417
6766
|
"type": "boolean",
|
|
@@ -6419,6 +6768,8 @@
|
|
|
6419
6768
|
"title": "Disabled",
|
|
6420
6769
|
"format": "boolean",
|
|
6421
6770
|
"x-displayname": "Disabled",
|
|
6771
|
+
"x-f5xc-example": "True",
|
|
6772
|
+
"x-f5xc-description-short": "Value of true indicates token is administratively disabled.",
|
|
6422
6773
|
"x-f5xc-required-for": {
|
|
6423
6774
|
"minimum_config": false,
|
|
6424
6775
|
"create": false,
|
|
@@ -6434,6 +6785,8 @@
|
|
|
6434
6785
|
"description": "The set of labels present on this token.",
|
|
6435
6786
|
"title": "Labels",
|
|
6436
6787
|
"x-displayname": "Labels",
|
|
6788
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6789
|
+
"x-f5xc-description-short": "The set of labels present on this token.",
|
|
6437
6790
|
"x-f5xc-required-for": {
|
|
6438
6791
|
"minimum_config": false,
|
|
6439
6792
|
"create": false,
|
|
@@ -6461,7 +6814,7 @@
|
|
|
6461
6814
|
},
|
|
6462
6815
|
"x-original-maxLength": 1024,
|
|
6463
6816
|
"x-reconciled-from-discovery": true,
|
|
6464
|
-
"x-reconciled-at": "2026-01-
|
|
6817
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556877+00:00"
|
|
6465
6818
|
},
|
|
6466
6819
|
"namespace": {
|
|
6467
6820
|
"type": "string",
|
|
@@ -6480,7 +6833,7 @@
|
|
|
6480
6833
|
},
|
|
6481
6834
|
"x-original-maxLength": 1024,
|
|
6482
6835
|
"x-reconciled-from-discovery": true,
|
|
6483
|
-
"x-reconciled-at": "2026-01-
|
|
6836
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556881+00:00"
|
|
6484
6837
|
},
|
|
6485
6838
|
"owner_view": {
|
|
6486
6839
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -6493,6 +6846,7 @@
|
|
|
6493
6846
|
"$ref": "#/components/schemas/tokenStatusObject"
|
|
6494
6847
|
},
|
|
6495
6848
|
"x-displayname": "Status",
|
|
6849
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6496
6850
|
"x-f5xc-required-for": {
|
|
6497
6851
|
"minimum_config": false,
|
|
6498
6852
|
"create": false,
|
|
@@ -6521,7 +6875,7 @@
|
|
|
6521
6875
|
"x-field-mutability": "read-only",
|
|
6522
6876
|
"x-original-maxLength": 1024,
|
|
6523
6877
|
"x-reconciled-from-discovery": true,
|
|
6524
|
-
"x-reconciled-at": "2026-01-
|
|
6878
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556889+00:00"
|
|
6525
6879
|
},
|
|
6526
6880
|
"uid": {
|
|
6527
6881
|
"type": "string",
|
|
@@ -6542,9 +6896,11 @@
|
|
|
6542
6896
|
"x-original-maxLength": 1024,
|
|
6543
6897
|
"format": "uuid",
|
|
6544
6898
|
"x-reconciled-from-discovery": true,
|
|
6545
|
-
"x-reconciled-at": "2026-01-
|
|
6899
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556894+00:00"
|
|
6546
6900
|
}
|
|
6547
6901
|
},
|
|
6902
|
+
"x-f5xc-description-short": "By default a summary of token is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6903
|
+
"x-f5xc-description-medium": "By default a summary of token is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6548
6904
|
"x-f5xc-minimum-configuration": {
|
|
6549
6905
|
"description": "Minimum configuration for tokenListResponseItem",
|
|
6550
6906
|
"required_fields": [
|
|
@@ -6587,6 +6943,7 @@
|
|
|
6587
6943
|
"$ref": "#/components/schemas/schemaSystemObjectMetaType"
|
|
6588
6944
|
}
|
|
6589
6945
|
},
|
|
6946
|
+
"x-f5xc-description-short": "Token object store token specification and state.",
|
|
6590
6947
|
"x-f5xc-minimum-configuration": {
|
|
6591
6948
|
"description": "Minimum configuration for tokenObject",
|
|
6592
6949
|
"required_fields": [
|
|
@@ -6612,6 +6969,7 @@
|
|
|
6612
6969
|
"$ref": "#/components/schemas/tokenObject"
|
|
6613
6970
|
}
|
|
6614
6971
|
},
|
|
6972
|
+
"x-f5xc-description-short": "Generic response when object is changed.",
|
|
6615
6973
|
"x-f5xc-minimum-configuration": {
|
|
6616
6974
|
"description": "Minimum configuration for tokenObjectChangeResp",
|
|
6617
6975
|
"required_fields": [
|
|
@@ -6670,6 +7028,8 @@
|
|
|
6670
7028
|
"title": "Replace token.",
|
|
6671
7029
|
"x-displayname": "Replace Token.",
|
|
6672
7030
|
"x-ves-proto-message": "ves.io.schema.token.ReplaceSpecType",
|
|
7031
|
+
"x-f5xc-description-short": "Replaces token. Token object is used to manage site admission.",
|
|
7032
|
+
"x-f5xc-description-medium": "Replaces token. Token object is used to manage site admission. User must generate token before provisioning and pass this token to site during it's registration.",
|
|
6673
7033
|
"x-f5xc-minimum-configuration": {
|
|
6674
7034
|
"description": "Minimum configuration for tokenReplaceSpecType",
|
|
6675
7035
|
"required_fields": [],
|
|
@@ -6714,6 +7074,8 @@
|
|
|
6714
7074
|
"default": "UNKNOWN",
|
|
6715
7075
|
"x-displayname": "Token State Values.",
|
|
6716
7076
|
"x-ves-proto-enum": "ves.io.schema.token.State",
|
|
7077
|
+
"x-f5xc-description-short": "Token state defines whether token can be used or node. VALID token is required, other states are invalid.",
|
|
7078
|
+
"x-f5xc-description-medium": "Token state defines whether token can be used or node. VALID token is required, other states are invalid. Single token can be used to register multiple sites Token state isn't set Token can be (RE)used Token can't be used anymore.",
|
|
6717
7079
|
"x-f5xc-minimum-configuration": {
|
|
6718
7080
|
"description": "Minimum configuration for tokenState",
|
|
6719
7081
|
"required_fields": [],
|
|
@@ -6738,6 +7100,7 @@
|
|
|
6738
7100
|
"x-displayname": "Name",
|
|
6739
7101
|
"x-ves-example": "Value",
|
|
6740
7102
|
"x-f5xc-example": "value",
|
|
7103
|
+
"x-f5xc-description-short": "Token object name to change, it's usually same as metadata.uid.",
|
|
6741
7104
|
"minLength": 0,
|
|
6742
7105
|
"maxLength": 16,
|
|
6743
7106
|
"x-f5xc-required-for": {
|
|
@@ -6748,7 +7111,7 @@
|
|
|
6748
7111
|
},
|
|
6749
7112
|
"x-original-maxLength": 1024,
|
|
6750
7113
|
"x-reconciled-from-discovery": true,
|
|
6751
|
-
"x-reconciled-at": "2026-01-
|
|
7114
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556908+00:00"
|
|
6752
7115
|
},
|
|
6753
7116
|
"namespace": {
|
|
6754
7117
|
"type": "string",
|
|
@@ -6767,12 +7130,13 @@
|
|
|
6767
7130
|
},
|
|
6768
7131
|
"x-original-maxLength": 1024,
|
|
6769
7132
|
"x-reconciled-from-discovery": true,
|
|
6770
|
-
"x-reconciled-at": "2026-01-
|
|
7133
|
+
"x-reconciled-at": "2026-01-07T15:29:34.556912+00:00"
|
|
6771
7134
|
},
|
|
6772
7135
|
"state": {
|
|
6773
7136
|
"$ref": "#/components/schemas/tokenState"
|
|
6774
7137
|
}
|
|
6775
7138
|
},
|
|
7139
|
+
"x-f5xc-description-short": "Changes token state, only state is changing, namespace and name is used to find token to change.",
|
|
6776
7140
|
"x-f5xc-minimum-configuration": {
|
|
6777
7141
|
"description": "Minimum configuration for tokenStateReq",
|
|
6778
7142
|
"required_fields": [
|
|
@@ -6802,6 +7166,7 @@
|
|
|
6802
7166
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
6803
7167
|
},
|
|
6804
7168
|
"x-displayname": "Conditions.",
|
|
7169
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
6805
7170
|
"x-f5xc-required-for": {
|
|
6806
7171
|
"minimum_config": false,
|
|
6807
7172
|
"create": false,
|