@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.19-2601071557
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +179 -1582
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2 -265
- package/dist/version.d.ts +2 -2
- package/dist/version.js +2 -2
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +111 -25
- package/specs/domains/ai_services.json +114 -35
- package/specs/domains/api.json +1082 -177
- package/specs/domains/authentication.json +205 -45
- package/specs/domains/bigip.json +593 -101
- package/specs/domains/billing_and_usage.json +440 -82
- package/specs/domains/blindfold.json +713 -110
- package/specs/domains/bot_and_threat_defense.json +359 -65
- package/specs/domains/cdn.json +2131 -194
- package/specs/domains/ce_management.json +9110 -15844
- package/specs/domains/certificates.json +362 -75
- package/specs/domains/cloud_infrastructure.json +802 -119
- package/specs/domains/container_services.json +613 -95
- package/specs/domains/data_and_privacy_security.json +364 -66
- package/specs/domains/data_intelligence.json +324 -63
- package/specs/domains/ddos.json +766 -159
- package/specs/domains/dns.json +820 -161
- package/specs/domains/managed_kubernetes.json +455 -85
- package/specs/domains/marketplace.json +670 -104
- package/specs/domains/network.json +1620 -238
- package/specs/domains/network_security.json +1401 -191
- package/specs/domains/nginx_one.json +326 -62
- package/specs/domains/object_storage.json +49 -15
- package/specs/domains/observability.json +999 -147
- package/specs/domains/rate_limiting.json +300 -55
- package/specs/domains/secops_and_incident_response.json +189 -36
- package/specs/domains/service_mesh.json +955 -124
- package/specs/domains/shape.json +2150 -397
- package/specs/domains/sites.json +3830 -364
- package/specs/domains/statistics.json +2117 -235
- package/specs/domains/support.json +602 -108
- package/specs/domains/telemetry_and_insights.json +753 -79
- package/specs/domains/tenant_and_identity.json +1874 -308
- package/specs/domains/threat_campaign.json +637 -71
- package/specs/domains/users.json +278 -66
- package/specs/domains/virtual.json +2803 -260
- package/specs/domains/vpm_and_node_management.json +3 -1
- package/specs/domains/waf.json +1125 -148
- package/specs/index.json +24 -24
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Managed Kubernetes",
|
|
5
5
|
"description": "Role-based access controls with cluster-scoped permissions and namespace bindings. Pod security admission levels enforce baseline, restricted, or privileged profiles. Container registry credentials support private image pulls across hybrid deployments. Policy rules define resource verbs, groups, and non-resource URL access patterns.",
|
|
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"
|
|
@@ -5936,6 +5936,7 @@
|
|
|
5936
5936
|
"ves.io.schema.rules.message.required": "true",
|
|
5937
5937
|
"ves.io.schema.rules.string.hostname": "true"
|
|
5938
5938
|
},
|
|
5939
|
+
"x-f5xc-description-short": "Fully qualified name of the registry login server Required: YES.",
|
|
5939
5940
|
"minLength": 0,
|
|
5940
5941
|
"maxLength": 1024,
|
|
5941
5942
|
"x-f5xc-required-for": {
|
|
@@ -5961,6 +5962,7 @@
|
|
|
5961
5962
|
"ves.io.schema.rules.message.required": "true",
|
|
5962
5963
|
"ves.io.schema.rules.string.max_len": "128"
|
|
5963
5964
|
},
|
|
5965
|
+
"x-f5xc-description-short": "Username used to access the registry Required: YES.",
|
|
5964
5966
|
"minLength": 0,
|
|
5965
5967
|
"x-f5xc-required-for": {
|
|
5966
5968
|
"minimum_config": false,
|
|
@@ -5998,6 +6000,7 @@
|
|
|
5998
6000
|
"title": "Fail_if_referred.",
|
|
5999
6001
|
"format": "boolean",
|
|
6000
6002
|
"x-displayname": "Fail-If-Referred.",
|
|
6003
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
6001
6004
|
"x-f5xc-required-for": {
|
|
6002
6005
|
"minimum_config": false,
|
|
6003
6006
|
"create": false,
|
|
@@ -6022,7 +6025,7 @@
|
|
|
6022
6025
|
},
|
|
6023
6026
|
"x-original-maxLength": 1024,
|
|
6024
6027
|
"x-reconciled-from-discovery": true,
|
|
6025
|
-
"x-reconciled-at": "2026-01-
|
|
6028
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165235+00:00"
|
|
6026
6029
|
},
|
|
6027
6030
|
"namespace": {
|
|
6028
6031
|
"type": "string",
|
|
@@ -6031,6 +6034,7 @@
|
|
|
6031
6034
|
"x-displayname": "Namespace",
|
|
6032
6035
|
"x-ves-example": "Ns1",
|
|
6033
6036
|
"x-f5xc-example": "ns1",
|
|
6037
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
6034
6038
|
"minLength": 0,
|
|
6035
6039
|
"maxLength": 6,
|
|
6036
6040
|
"x-f5xc-required-for": {
|
|
@@ -6041,7 +6045,7 @@
|
|
|
6041
6045
|
},
|
|
6042
6046
|
"x-original-maxLength": 1024,
|
|
6043
6047
|
"x-reconciled-from-discovery": true,
|
|
6044
|
-
"x-reconciled-at": "2026-01-
|
|
6048
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165242+00:00"
|
|
6045
6049
|
}
|
|
6046
6050
|
},
|
|
6047
6051
|
"x-f5xc-minimum-configuration": {
|
|
@@ -6076,6 +6080,7 @@
|
|
|
6076
6080
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6077
6081
|
},
|
|
6078
6082
|
"x-displayname": "Deleted Referred Objects.",
|
|
6083
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6079
6084
|
"x-f5xc-required-for": {
|
|
6080
6085
|
"minimum_config": false,
|
|
6081
6086
|
"create": false,
|
|
@@ -6091,6 +6096,7 @@
|
|
|
6091
6096
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6092
6097
|
},
|
|
6093
6098
|
"x-displayname": "Disabled Referred Objects.",
|
|
6099
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6094
6100
|
"x-f5xc-required-for": {
|
|
6095
6101
|
"minimum_config": false,
|
|
6096
6102
|
"create": false,
|
|
@@ -6109,6 +6115,7 @@
|
|
|
6109
6115
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6110
6116
|
},
|
|
6111
6117
|
"x-displayname": "Referring Objects.",
|
|
6118
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
6112
6119
|
"x-f5xc-required-for": {
|
|
6113
6120
|
"minimum_config": false,
|
|
6114
6121
|
"create": false,
|
|
@@ -6130,6 +6137,8 @@
|
|
|
6130
6137
|
"$ref": "#/components/schemas/container_registryStatusObject"
|
|
6131
6138
|
},
|
|
6132
6139
|
"x-displayname": "Status",
|
|
6140
|
+
"x-f5xc-example": "active",
|
|
6141
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6133
6142
|
"x-f5xc-required-for": {
|
|
6134
6143
|
"minimum_config": false,
|
|
6135
6144
|
"create": false,
|
|
@@ -6139,7 +6148,7 @@
|
|
|
6139
6148
|
"maxLength": 17,
|
|
6140
6149
|
"minLength": 17,
|
|
6141
6150
|
"x-reconciled-from-discovery": true,
|
|
6142
|
-
"x-reconciled-at": "2026-01-
|
|
6151
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165258+00:00"
|
|
6143
6152
|
},
|
|
6144
6153
|
"system_metadata": {
|
|
6145
6154
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -6179,6 +6188,8 @@
|
|
|
6179
6188
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
6180
6189
|
],
|
|
6181
6190
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
6191
|
+
"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...",
|
|
6192
|
+
"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...",
|
|
6182
6193
|
"x-f5xc-minimum-configuration": {
|
|
6183
6194
|
"description": "Minimum configuration for container_registryGetResponseFormatCode",
|
|
6184
6195
|
"required_fields": [],
|
|
@@ -6237,6 +6248,7 @@
|
|
|
6237
6248
|
"ves.io.schema.rules.message.required": "true",
|
|
6238
6249
|
"ves.io.schema.rules.string.hostname": "true"
|
|
6239
6250
|
},
|
|
6251
|
+
"x-f5xc-description-short": "Fully qualified name of the registry login server Required: YES.",
|
|
6240
6252
|
"minLength": 0,
|
|
6241
6253
|
"maxLength": 1024,
|
|
6242
6254
|
"x-f5xc-required-for": {
|
|
@@ -6262,6 +6274,7 @@
|
|
|
6262
6274
|
"ves.io.schema.rules.message.required": "true",
|
|
6263
6275
|
"ves.io.schema.rules.string.max_len": "128"
|
|
6264
6276
|
},
|
|
6277
|
+
"x-f5xc-description-short": "Username used to access the registry Required: YES.",
|
|
6265
6278
|
"minLength": 0,
|
|
6266
6279
|
"x-f5xc-required-for": {
|
|
6267
6280
|
"minimum_config": false,
|
|
@@ -6301,6 +6314,7 @@
|
|
|
6301
6314
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
6302
6315
|
},
|
|
6303
6316
|
"x-displayname": "Errors",
|
|
6317
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
6304
6318
|
"x-f5xc-required-for": {
|
|
6305
6319
|
"minimum_config": false,
|
|
6306
6320
|
"create": false,
|
|
@@ -6316,6 +6330,8 @@
|
|
|
6316
6330
|
"$ref": "#/components/schemas/container_registryListResponseItem"
|
|
6317
6331
|
},
|
|
6318
6332
|
"x-displayname": "Items",
|
|
6333
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
6334
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
6319
6335
|
"x-f5xc-required-for": {
|
|
6320
6336
|
"minimum_config": false,
|
|
6321
6337
|
"create": false,
|
|
@@ -6349,6 +6365,8 @@
|
|
|
6349
6365
|
"description": "The set of annotations present on this container_registry.",
|
|
6350
6366
|
"title": "Annotations.",
|
|
6351
6367
|
"x-displayname": "Annotations.",
|
|
6368
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6369
|
+
"x-f5xc-description-short": "The set of annotations present on this container_registry.",
|
|
6352
6370
|
"x-f5xc-required-for": {
|
|
6353
6371
|
"minimum_config": false,
|
|
6354
6372
|
"create": false,
|
|
@@ -6361,6 +6379,7 @@
|
|
|
6361
6379
|
"description": "The description set for this container_registry.",
|
|
6362
6380
|
"title": "Description.",
|
|
6363
6381
|
"x-displayname": "Description.",
|
|
6382
|
+
"x-f5xc-description-short": "The description set for this container_registry.",
|
|
6364
6383
|
"minLength": 0,
|
|
6365
6384
|
"maxLength": 0,
|
|
6366
6385
|
"x-f5xc-required-for": {
|
|
@@ -6371,7 +6390,7 @@
|
|
|
6371
6390
|
},
|
|
6372
6391
|
"x-original-maxLength": 1024,
|
|
6373
6392
|
"x-reconciled-from-discovery": true,
|
|
6374
|
-
"x-reconciled-at": "2026-01-
|
|
6393
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165277+00:00"
|
|
6375
6394
|
},
|
|
6376
6395
|
"disabled": {
|
|
6377
6396
|
"type": "boolean",
|
|
@@ -6379,6 +6398,8 @@
|
|
|
6379
6398
|
"title": "Disabled",
|
|
6380
6399
|
"format": "boolean",
|
|
6381
6400
|
"x-displayname": "Disabled",
|
|
6401
|
+
"x-f5xc-example": "True",
|
|
6402
|
+
"x-f5xc-description-short": "Value of true indicates container_registry is administratively disabled.",
|
|
6382
6403
|
"x-f5xc-required-for": {
|
|
6383
6404
|
"minimum_config": false,
|
|
6384
6405
|
"create": false,
|
|
@@ -6394,6 +6415,8 @@
|
|
|
6394
6415
|
"description": "The set of labels present on this container_registry.",
|
|
6395
6416
|
"title": "Labels",
|
|
6396
6417
|
"x-displayname": "Labels",
|
|
6418
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6419
|
+
"x-f5xc-description-short": "The set of labels present on this container_registry.",
|
|
6397
6420
|
"x-f5xc-required-for": {
|
|
6398
6421
|
"minimum_config": false,
|
|
6399
6422
|
"create": false,
|
|
@@ -6421,7 +6444,7 @@
|
|
|
6421
6444
|
},
|
|
6422
6445
|
"x-original-maxLength": 1024,
|
|
6423
6446
|
"x-reconciled-from-discovery": true,
|
|
6424
|
-
"x-reconciled-at": "2026-01-
|
|
6447
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165288+00:00"
|
|
6425
6448
|
},
|
|
6426
6449
|
"namespace": {
|
|
6427
6450
|
"type": "string",
|
|
@@ -6440,7 +6463,7 @@
|
|
|
6440
6463
|
},
|
|
6441
6464
|
"x-original-maxLength": 1024,
|
|
6442
6465
|
"x-reconciled-from-discovery": true,
|
|
6443
|
-
"x-reconciled-at": "2026-01-
|
|
6466
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165292+00:00"
|
|
6444
6467
|
},
|
|
6445
6468
|
"owner_view": {
|
|
6446
6469
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -6453,6 +6476,7 @@
|
|
|
6453
6476
|
"$ref": "#/components/schemas/container_registryStatusObject"
|
|
6454
6477
|
},
|
|
6455
6478
|
"x-displayname": "Status",
|
|
6479
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6456
6480
|
"x-f5xc-required-for": {
|
|
6457
6481
|
"minimum_config": false,
|
|
6458
6482
|
"create": false,
|
|
@@ -6481,7 +6505,7 @@
|
|
|
6481
6505
|
"x-field-mutability": "read-only",
|
|
6482
6506
|
"x-original-maxLength": 1024,
|
|
6483
6507
|
"x-reconciled-from-discovery": true,
|
|
6484
|
-
"x-reconciled-at": "2026-01-
|
|
6508
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165300+00:00"
|
|
6485
6509
|
},
|
|
6486
6510
|
"uid": {
|
|
6487
6511
|
"type": "string",
|
|
@@ -6490,6 +6514,7 @@
|
|
|
6490
6514
|
"x-displayname": "UID",
|
|
6491
6515
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
6492
6516
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
6517
|
+
"x-f5xc-description-short": "The unique uid of this container_registry.",
|
|
6493
6518
|
"minLength": 0,
|
|
6494
6519
|
"maxLength": 36,
|
|
6495
6520
|
"x-f5xc-required-for": {
|
|
@@ -6502,9 +6527,11 @@
|
|
|
6502
6527
|
"x-original-maxLength": 1024,
|
|
6503
6528
|
"format": "uuid",
|
|
6504
6529
|
"x-reconciled-from-discovery": true,
|
|
6505
|
-
"x-reconciled-at": "2026-01-
|
|
6530
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165306+00:00"
|
|
6506
6531
|
}
|
|
6507
6532
|
},
|
|
6533
|
+
"x-f5xc-description-short": "By default a summary of container_registry is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6534
|
+
"x-f5xc-description-medium": "By default a summary of container_registry is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6508
6535
|
"x-f5xc-minimum-configuration": {
|
|
6509
6536
|
"description": "Minimum configuration for container_registryListResponseItem",
|
|
6510
6537
|
"required_fields": [
|
|
@@ -6617,6 +6644,7 @@
|
|
|
6617
6644
|
"ves.io.schema.rules.message.required": "true",
|
|
6618
6645
|
"ves.io.schema.rules.string.hostname": "true"
|
|
6619
6646
|
},
|
|
6647
|
+
"x-f5xc-description-short": "Fully qualified name of the registry login server Required: YES.",
|
|
6620
6648
|
"minLength": 0,
|
|
6621
6649
|
"maxLength": 1024,
|
|
6622
6650
|
"x-f5xc-required-for": {
|
|
@@ -6642,6 +6670,7 @@
|
|
|
6642
6670
|
"ves.io.schema.rules.message.required": "true",
|
|
6643
6671
|
"ves.io.schema.rules.string.max_len": "128"
|
|
6644
6672
|
},
|
|
6673
|
+
"x-f5xc-description-short": "Username used to access the registry Required: YES.",
|
|
6645
6674
|
"minLength": 0,
|
|
6646
6675
|
"x-f5xc-required-for": {
|
|
6647
6676
|
"minimum_config": false,
|
|
@@ -6707,6 +6736,7 @@
|
|
|
6707
6736
|
}
|
|
6708
6737
|
}
|
|
6709
6738
|
},
|
|
6739
|
+
"x-f5xc-description-short": "Most recently observed status of the Container Registry.",
|
|
6710
6740
|
"x-f5xc-minimum-configuration": {
|
|
6711
6741
|
"description": "Minimum configuration for container_registryStatusObject",
|
|
6712
6742
|
"required_fields": [
|
|
@@ -6728,6 +6758,8 @@
|
|
|
6728
6758
|
"type_url": {
|
|
6729
6759
|
"type": "string",
|
|
6730
6760
|
"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.",
|
|
6761
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
6762
|
+
"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 ).",
|
|
6731
6763
|
"minLength": 0,
|
|
6732
6764
|
"maxLength": 1024,
|
|
6733
6765
|
"x-f5xc-required-for": {
|
|
@@ -6751,9 +6783,11 @@
|
|
|
6751
6783
|
},
|
|
6752
6784
|
"x-original-maxLength": 1024,
|
|
6753
6785
|
"x-reconciled-from-discovery": true,
|
|
6754
|
-
"x-reconciled-at": "2026-01-
|
|
6786
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165326+00:00"
|
|
6755
6787
|
}
|
|
6756
6788
|
},
|
|
6789
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
6790
|
+
"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...",
|
|
6757
6791
|
"x-f5xc-minimum-configuration": {
|
|
6758
6792
|
"description": "Minimum configuration for protobufAny",
|
|
6759
6793
|
"required_fields": [
|
|
@@ -6782,6 +6816,8 @@
|
|
|
6782
6816
|
"x-displayname": "Decryption Provider.",
|
|
6783
6817
|
"x-ves-example": "Value",
|
|
6784
6818
|
"x-f5xc-example": "value",
|
|
6819
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
6820
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
6785
6821
|
"minLength": 0,
|
|
6786
6822
|
"maxLength": 1024,
|
|
6787
6823
|
"x-f5xc-required-for": {
|
|
@@ -6807,6 +6843,8 @@
|
|
|
6807
6843
|
"ves.io.schema.rules.message.required": "true",
|
|
6808
6844
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
6809
6845
|
},
|
|
6846
|
+
"x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
6847
|
+
"x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
6810
6848
|
"minLength": 0,
|
|
6811
6849
|
"maxLength": 4,
|
|
6812
6850
|
"x-f5xc-required-for": {
|
|
@@ -6817,7 +6855,7 @@
|
|
|
6817
6855
|
},
|
|
6818
6856
|
"x-original-maxLength": 1024,
|
|
6819
6857
|
"x-reconciled-from-discovery": true,
|
|
6820
|
-
"x-reconciled-at": "2026-01-
|
|
6858
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165332+00:00"
|
|
6821
6859
|
},
|
|
6822
6860
|
"store_provider": {
|
|
6823
6861
|
"type": "string",
|
|
@@ -6826,6 +6864,8 @@
|
|
|
6826
6864
|
"x-displayname": "Store Provider.",
|
|
6827
6865
|
"x-ves-example": "Value",
|
|
6828
6866
|
"x-f5xc-example": "value",
|
|
6867
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
6868
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
6829
6869
|
"minLength": 0,
|
|
6830
6870
|
"maxLength": 1024,
|
|
6831
6871
|
"x-f5xc-required-for": {
|
|
@@ -6836,6 +6876,7 @@
|
|
|
6836
6876
|
}
|
|
6837
6877
|
}
|
|
6838
6878
|
},
|
|
6879
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
6839
6880
|
"x-f5xc-minimum-configuration": {
|
|
6840
6881
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
6841
6882
|
"required_fields": [
|
|
@@ -6865,6 +6906,8 @@
|
|
|
6865
6906
|
"x-displayname": "Provider",
|
|
6866
6907
|
"x-ves-example": "Box-provider.",
|
|
6867
6908
|
"x-f5xc-example": "box-provider",
|
|
6909
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
6910
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
6868
6911
|
"minLength": 0,
|
|
6869
6912
|
"maxLength": 8,
|
|
6870
6913
|
"x-f5xc-required-for": {
|
|
@@ -6875,7 +6918,7 @@
|
|
|
6875
6918
|
},
|
|
6876
6919
|
"x-original-maxLength": 1024,
|
|
6877
6920
|
"x-reconciled-from-discovery": true,
|
|
6878
|
-
"x-reconciled-at": "2026-01-
|
|
6921
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165338+00:00"
|
|
6879
6922
|
},
|
|
6880
6923
|
"url": {
|
|
6881
6924
|
"type": "string",
|
|
@@ -6896,6 +6939,8 @@
|
|
|
6896
6939
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
6897
6940
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
6898
6941
|
},
|
|
6942
|
+
"x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
|
|
6943
|
+
"x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
|
|
6899
6944
|
"format": "uri",
|
|
6900
6945
|
"minLength": 0,
|
|
6901
6946
|
"x-f5xc-required-for": {
|
|
@@ -6906,6 +6951,7 @@
|
|
|
6906
6951
|
}
|
|
6907
6952
|
}
|
|
6908
6953
|
},
|
|
6954
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
6909
6955
|
"x-f5xc-minimum-configuration": {
|
|
6910
6956
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
6911
6957
|
"required_fields": [
|
|
@@ -6931,6 +6977,8 @@
|
|
|
6931
6977
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
6932
6978
|
"title": "Hostname",
|
|
6933
6979
|
"x-displayname": "Hostname",
|
|
6980
|
+
"x-f5xc-example": "example-resource",
|
|
6981
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
6934
6982
|
"minLength": 0,
|
|
6935
6983
|
"maxLength": 1024,
|
|
6936
6984
|
"x-f5xc-required-for": {
|
|
@@ -6962,6 +7010,8 @@
|
|
|
6962
7010
|
"x-displayname": "Reason",
|
|
6963
7011
|
"x-ves-example": "Value",
|
|
6964
7012
|
"x-f5xc-example": "value",
|
|
7013
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
7014
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
6965
7015
|
"minLength": 0,
|
|
6966
7016
|
"maxLength": 43,
|
|
6967
7017
|
"x-f5xc-required-for": {
|
|
@@ -6972,13 +7022,15 @@
|
|
|
6972
7022
|
},
|
|
6973
7023
|
"x-original-maxLength": 1024,
|
|
6974
7024
|
"x-reconciled-from-discovery": true,
|
|
6975
|
-
"x-reconciled-at": "2026-01-
|
|
7025
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165348+00:00"
|
|
6976
7026
|
},
|
|
6977
7027
|
"service_name": {
|
|
6978
7028
|
"type": "string",
|
|
6979
7029
|
"description": "Name of the service that sent the status.",
|
|
6980
7030
|
"title": "Service name.",
|
|
6981
7031
|
"x-displayname": "Service Name.",
|
|
7032
|
+
"x-f5xc-example": "example-resource",
|
|
7033
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
6982
7034
|
"minLength": 0,
|
|
6983
7035
|
"maxLength": 1024,
|
|
6984
7036
|
"x-f5xc-required-for": {
|
|
@@ -7001,6 +7053,8 @@
|
|
|
7001
7053
|
"x-validation-rules": {
|
|
7002
7054
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
7003
7055
|
},
|
|
7056
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
7057
|
+
"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...",
|
|
7004
7058
|
"minLength": 0,
|
|
7005
7059
|
"maxLength": 17,
|
|
7006
7060
|
"x-f5xc-required-for": {
|
|
@@ -7011,7 +7065,7 @@
|
|
|
7011
7065
|
},
|
|
7012
7066
|
"x-original-maxLength": 1024,
|
|
7013
7067
|
"x-reconciled-from-discovery": true,
|
|
7014
|
-
"x-reconciled-at": "2026-01-
|
|
7068
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165353+00:00"
|
|
7015
7069
|
},
|
|
7016
7070
|
"type": {
|
|
7017
7071
|
"type": "string",
|
|
@@ -7026,6 +7080,8 @@
|
|
|
7026
7080
|
"x-validation-rules": {
|
|
7027
7081
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
7028
7082
|
},
|
|
7083
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
7084
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
7029
7085
|
"minLength": 0,
|
|
7030
7086
|
"maxLength": 1024,
|
|
7031
7087
|
"x-f5xc-required-for": {
|
|
@@ -7036,6 +7092,8 @@
|
|
|
7036
7092
|
}
|
|
7037
7093
|
}
|
|
7038
7094
|
},
|
|
7095
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
7096
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
7039
7097
|
"x-f5xc-minimum-configuration": {
|
|
7040
7098
|
"description": "Minimum configuration for schemaConditionType",
|
|
7041
7099
|
"required_fields": [
|
|
@@ -7071,6 +7129,8 @@
|
|
|
7071
7129
|
"default": "EOK",
|
|
7072
7130
|
"x-displayname": "Error Code.",
|
|
7073
7131
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
7132
|
+
"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...",
|
|
7133
|
+
"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...",
|
|
7074
7134
|
"x-f5xc-minimum-configuration": {
|
|
7075
7135
|
"description": "Minimum configuration for schemaErrorCode",
|
|
7076
7136
|
"required_fields": [],
|
|
@@ -7111,6 +7171,7 @@
|
|
|
7111
7171
|
}
|
|
7112
7172
|
}
|
|
7113
7173
|
},
|
|
7174
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
7114
7175
|
"x-f5xc-minimum-configuration": {
|
|
7115
7176
|
"description": "Minimum configuration for schemaErrorType",
|
|
7116
7177
|
"required_fields": [
|
|
@@ -7138,6 +7199,7 @@
|
|
|
7138
7199
|
"title": "Name",
|
|
7139
7200
|
"x-displayname": "Name",
|
|
7140
7201
|
"x-f5xc-example": "example-resource",
|
|
7202
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
7141
7203
|
"minLength": 0,
|
|
7142
7204
|
"maxLength": 16,
|
|
7143
7205
|
"x-f5xc-required-for": {
|
|
@@ -7148,9 +7210,10 @@
|
|
|
7148
7210
|
},
|
|
7149
7211
|
"x-original-maxLength": 1024,
|
|
7150
7212
|
"x-reconciled-from-discovery": true,
|
|
7151
|
-
"x-reconciled-at": "2026-01-
|
|
7213
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165364+00:00"
|
|
7152
7214
|
}
|
|
7153
7215
|
},
|
|
7216
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
7154
7217
|
"x-f5xc-minimum-configuration": {
|
|
7155
7218
|
"description": "Minimum configuration for schemaInitializerType",
|
|
7156
7219
|
"required_fields": [
|
|
@@ -7178,6 +7241,8 @@
|
|
|
7178
7241
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
7179
7242
|
},
|
|
7180
7243
|
"x-displayname": "Pending",
|
|
7244
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
7245
|
+
"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.",
|
|
7181
7246
|
"x-f5xc-required-for": {
|
|
7182
7247
|
"minimum_config": false,
|
|
7183
7248
|
"create": false,
|
|
@@ -7189,6 +7254,7 @@
|
|
|
7189
7254
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
7190
7255
|
}
|
|
7191
7256
|
},
|
|
7257
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
7192
7258
|
"x-f5xc-minimum-configuration": {
|
|
7193
7259
|
"description": "Minimum configuration for schemaInitializersType",
|
|
7194
7260
|
"required_fields": [
|
|
@@ -7227,6 +7293,8 @@
|
|
|
7227
7293
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
7228
7294
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
7229
7295
|
},
|
|
7296
|
+
"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.",
|
|
7297
|
+
"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.",
|
|
7230
7298
|
"x-f5xc-required-for": {
|
|
7231
7299
|
"minimum_config": false,
|
|
7232
7300
|
"create": false,
|
|
@@ -7248,6 +7316,7 @@
|
|
|
7248
7316
|
"x-validation-rules": {
|
|
7249
7317
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
7250
7318
|
},
|
|
7319
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
7251
7320
|
"minLength": 0,
|
|
7252
7321
|
"x-f5xc-required-for": {
|
|
7253
7322
|
"minimum_config": false,
|
|
@@ -7257,7 +7326,7 @@
|
|
|
7257
7326
|
},
|
|
7258
7327
|
"x-original-maxLength": 1200,
|
|
7259
7328
|
"x-reconciled-from-discovery": true,
|
|
7260
|
-
"x-reconciled-at": "2026-01-
|
|
7329
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165374+00:00"
|
|
7261
7330
|
},
|
|
7262
7331
|
"disable": {
|
|
7263
7332
|
"type": "boolean",
|
|
@@ -7266,6 +7335,7 @@
|
|
|
7266
7335
|
"format": "boolean",
|
|
7267
7336
|
"x-displayname": "Disable",
|
|
7268
7337
|
"x-f5xc-example": "true",
|
|
7338
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
7269
7339
|
"x-f5xc-required-for": {
|
|
7270
7340
|
"minimum_config": false,
|
|
7271
7341
|
"create": false,
|
|
@@ -7279,6 +7349,8 @@
|
|
|
7279
7349
|
"title": "Labels",
|
|
7280
7350
|
"x-displayname": "Labels",
|
|
7281
7351
|
"x-f5xc-example": "value",
|
|
7352
|
+
"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.",
|
|
7353
|
+
"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.",
|
|
7282
7354
|
"x-f5xc-required-for": {
|
|
7283
7355
|
"minimum_config": false,
|
|
7284
7356
|
"create": false,
|
|
@@ -7300,6 +7372,8 @@
|
|
|
7300
7372
|
"x-validation-rules": {
|
|
7301
7373
|
"ves.io.schema.rules.message.required": "true"
|
|
7302
7374
|
},
|
|
7375
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
7376
|
+
"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.",
|
|
7303
7377
|
"minLength": 0,
|
|
7304
7378
|
"maxLength": 16,
|
|
7305
7379
|
"x-f5xc-required-for": {
|
|
@@ -7310,7 +7384,7 @@
|
|
|
7310
7384
|
},
|
|
7311
7385
|
"x-original-maxLength": 1024,
|
|
7312
7386
|
"x-reconciled-from-discovery": true,
|
|
7313
|
-
"x-reconciled-at": "2026-01-
|
|
7387
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165382+00:00"
|
|
7314
7388
|
},
|
|
7315
7389
|
"namespace": {
|
|
7316
7390
|
"type": "string",
|
|
@@ -7319,6 +7393,8 @@
|
|
|
7319
7393
|
"x-displayname": "Namespace",
|
|
7320
7394
|
"x-ves-example": "Staging",
|
|
7321
7395
|
"x-f5xc-example": "staging",
|
|
7396
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
7397
|
+
"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 \"\".",
|
|
7322
7398
|
"minLength": 0,
|
|
7323
7399
|
"maxLength": 6,
|
|
7324
7400
|
"x-f5xc-required-for": {
|
|
@@ -7329,9 +7405,10 @@
|
|
|
7329
7405
|
},
|
|
7330
7406
|
"x-original-maxLength": 1024,
|
|
7331
7407
|
"x-reconciled-from-discovery": true,
|
|
7332
|
-
"x-reconciled-at": "2026-01-
|
|
7408
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165386+00:00"
|
|
7333
7409
|
}
|
|
7334
7410
|
},
|
|
7411
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
7335
7412
|
"x-f5xc-minimum-configuration": {
|
|
7336
7413
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
7337
7414
|
"required_fields": [
|
|
@@ -7375,6 +7452,8 @@
|
|
|
7375
7452
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
7376
7453
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
7377
7454
|
},
|
|
7455
|
+
"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.",
|
|
7456
|
+
"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.",
|
|
7378
7457
|
"x-f5xc-required-for": {
|
|
7379
7458
|
"minimum_config": false,
|
|
7380
7459
|
"create": false,
|
|
@@ -7396,6 +7475,7 @@
|
|
|
7396
7475
|
"x-validation-rules": {
|
|
7397
7476
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
7398
7477
|
},
|
|
7478
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
7399
7479
|
"minLength": 0,
|
|
7400
7480
|
"x-f5xc-required-for": {
|
|
7401
7481
|
"minimum_config": false,
|
|
@@ -7405,7 +7485,7 @@
|
|
|
7405
7485
|
},
|
|
7406
7486
|
"x-original-maxLength": 1200,
|
|
7407
7487
|
"x-reconciled-from-discovery": true,
|
|
7408
|
-
"x-reconciled-at": "2026-01-
|
|
7488
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165392+00:00"
|
|
7409
7489
|
},
|
|
7410
7490
|
"disable": {
|
|
7411
7491
|
"type": "boolean",
|
|
@@ -7415,6 +7495,7 @@
|
|
|
7415
7495
|
"x-displayname": "Disable",
|
|
7416
7496
|
"x-ves-example": "True",
|
|
7417
7497
|
"x-f5xc-example": "true",
|
|
7498
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
7418
7499
|
"x-f5xc-required-for": {
|
|
7419
7500
|
"minimum_config": false,
|
|
7420
7501
|
"create": false,
|
|
@@ -7429,6 +7510,8 @@
|
|
|
7429
7510
|
"x-displayname": "Labels",
|
|
7430
7511
|
"x-ves-example": "Value",
|
|
7431
7512
|
"x-f5xc-example": "value",
|
|
7513
|
+
"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.",
|
|
7514
|
+
"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.",
|
|
7432
7515
|
"x-f5xc-required-for": {
|
|
7433
7516
|
"minimum_config": false,
|
|
7434
7517
|
"create": false,
|
|
@@ -7450,6 +7533,8 @@
|
|
|
7450
7533
|
"x-validation-rules": {
|
|
7451
7534
|
"ves.io.schema.rules.message.required": "true"
|
|
7452
7535
|
},
|
|
7536
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
7537
|
+
"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.",
|
|
7453
7538
|
"minLength": 0,
|
|
7454
7539
|
"maxLength": 16,
|
|
7455
7540
|
"x-f5xc-required-for": {
|
|
@@ -7460,7 +7545,7 @@
|
|
|
7460
7545
|
},
|
|
7461
7546
|
"x-original-maxLength": 1024,
|
|
7462
7547
|
"x-reconciled-from-discovery": true,
|
|
7463
|
-
"x-reconciled-at": "2026-01-
|
|
7548
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165400+00:00"
|
|
7464
7549
|
},
|
|
7465
7550
|
"namespace": {
|
|
7466
7551
|
"type": "string",
|
|
@@ -7469,6 +7554,8 @@
|
|
|
7469
7554
|
"x-displayname": "Namespace",
|
|
7470
7555
|
"x-ves-example": "Staging",
|
|
7471
7556
|
"x-f5xc-example": "staging",
|
|
7557
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
7558
|
+
"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 \"\".",
|
|
7472
7559
|
"minLength": 0,
|
|
7473
7560
|
"maxLength": 6,
|
|
7474
7561
|
"x-f5xc-required-for": {
|
|
@@ -7479,9 +7566,10 @@
|
|
|
7479
7566
|
},
|
|
7480
7567
|
"x-original-maxLength": 1024,
|
|
7481
7568
|
"x-reconciled-from-discovery": true,
|
|
7482
|
-
"x-reconciled-at": "2026-01-
|
|
7569
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165404+00:00"
|
|
7483
7570
|
}
|
|
7484
7571
|
},
|
|
7572
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
7485
7573
|
"x-f5xc-minimum-configuration": {
|
|
7486
7574
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
7487
7575
|
"required_fields": [
|
|
@@ -7513,6 +7601,8 @@
|
|
|
7513
7601
|
"x-displayname": "Kind",
|
|
7514
7602
|
"x-ves-example": "Virtual_site.",
|
|
7515
7603
|
"x-f5xc-example": "virtual_site",
|
|
7604
|
+
"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\")",
|
|
7605
|
+
"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\").",
|
|
7516
7606
|
"minLength": 0,
|
|
7517
7607
|
"maxLength": 14,
|
|
7518
7608
|
"x-f5xc-required-for": {
|
|
@@ -7524,7 +7614,7 @@
|
|
|
7524
7614
|
"readOnly": true,
|
|
7525
7615
|
"x-original-maxLength": 1024,
|
|
7526
7616
|
"x-reconciled-from-discovery": true,
|
|
7527
|
-
"x-reconciled-at": "2026-01-
|
|
7617
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165409+00:00"
|
|
7528
7618
|
},
|
|
7529
7619
|
"name": {
|
|
7530
7620
|
"type": "string",
|
|
@@ -7533,6 +7623,8 @@
|
|
|
7533
7623
|
"x-displayname": "Name",
|
|
7534
7624
|
"x-ves-example": "Contactus-route.",
|
|
7535
7625
|
"x-f5xc-example": "contactus-route",
|
|
7626
|
+
"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.",
|
|
7627
|
+
"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.",
|
|
7536
7628
|
"minLength": 0,
|
|
7537
7629
|
"maxLength": 16,
|
|
7538
7630
|
"x-f5xc-required-for": {
|
|
@@ -7543,7 +7635,7 @@
|
|
|
7543
7635
|
},
|
|
7544
7636
|
"x-original-maxLength": 1024,
|
|
7545
7637
|
"x-reconciled-from-discovery": true,
|
|
7546
|
-
"x-reconciled-at": "2026-01-
|
|
7638
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165413+00:00"
|
|
7547
7639
|
},
|
|
7548
7640
|
"namespace": {
|
|
7549
7641
|
"type": "string",
|
|
@@ -7552,6 +7644,8 @@
|
|
|
7552
7644
|
"x-displayname": "Namespace",
|
|
7553
7645
|
"x-ves-example": "Ns1",
|
|
7554
7646
|
"x-f5xc-example": "ns1",
|
|
7647
|
+
"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.",
|
|
7648
|
+
"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.",
|
|
7555
7649
|
"minLength": 0,
|
|
7556
7650
|
"maxLength": 6,
|
|
7557
7651
|
"x-f5xc-required-for": {
|
|
@@ -7562,7 +7656,7 @@
|
|
|
7562
7656
|
},
|
|
7563
7657
|
"x-original-maxLength": 1024,
|
|
7564
7658
|
"x-reconciled-from-discovery": true,
|
|
7565
|
-
"x-reconciled-at": "2026-01-
|
|
7659
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165417+00:00"
|
|
7566
7660
|
},
|
|
7567
7661
|
"tenant": {
|
|
7568
7662
|
"type": "string",
|
|
@@ -7571,6 +7665,8 @@
|
|
|
7571
7665
|
"x-displayname": "Tenant",
|
|
7572
7666
|
"x-ves-example": "Example-corp.",
|
|
7573
7667
|
"x-f5xc-example": "example-corp",
|
|
7668
|
+
"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.",
|
|
7669
|
+
"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.",
|
|
7574
7670
|
"minLength": 0,
|
|
7575
7671
|
"maxLength": 18,
|
|
7576
7672
|
"x-f5xc-required-for": {
|
|
@@ -7583,7 +7679,7 @@
|
|
|
7583
7679
|
"x-field-mutability": "read-only",
|
|
7584
7680
|
"x-original-maxLength": 1024,
|
|
7585
7681
|
"x-reconciled-from-discovery": true,
|
|
7586
|
-
"x-reconciled-at": "2026-01-
|
|
7682
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165421+00:00"
|
|
7587
7683
|
},
|
|
7588
7684
|
"uid": {
|
|
7589
7685
|
"type": "string",
|
|
@@ -7592,6 +7688,8 @@
|
|
|
7592
7688
|
"x-displayname": "UID",
|
|
7593
7689
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7594
7690
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
7691
|
+
"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.",
|
|
7692
|
+
"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.",
|
|
7595
7693
|
"minLength": 0,
|
|
7596
7694
|
"maxLength": 36,
|
|
7597
7695
|
"x-f5xc-required-for": {
|
|
@@ -7605,9 +7703,11 @@
|
|
|
7605
7703
|
"x-original-maxLength": 1024,
|
|
7606
7704
|
"format": "uuid",
|
|
7607
7705
|
"x-reconciled-from-discovery": true,
|
|
7608
|
-
"x-reconciled-at": "2026-01-
|
|
7706
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165426+00:00"
|
|
7609
7707
|
}
|
|
7610
7708
|
},
|
|
7709
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
7710
|
+
"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...",
|
|
7611
7711
|
"x-f5xc-minimum-configuration": {
|
|
7612
7712
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
7613
7713
|
"required_fields": [
|
|
@@ -7650,6 +7750,8 @@
|
|
|
7650
7750
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
7651
7751
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
7652
7752
|
},
|
|
7753
|
+
"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.",
|
|
7754
|
+
"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.",
|
|
7653
7755
|
"x-f5xc-required-for": {
|
|
7654
7756
|
"minimum_config": false,
|
|
7655
7757
|
"create": false,
|
|
@@ -7671,6 +7773,7 @@
|
|
|
7671
7773
|
"x-validation-rules": {
|
|
7672
7774
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
7673
7775
|
},
|
|
7776
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
7674
7777
|
"minLength": 0,
|
|
7675
7778
|
"x-f5xc-required-for": {
|
|
7676
7779
|
"minimum_config": false,
|
|
@@ -7680,7 +7783,7 @@
|
|
|
7680
7783
|
},
|
|
7681
7784
|
"x-original-maxLength": 1200,
|
|
7682
7785
|
"x-reconciled-from-discovery": true,
|
|
7683
|
-
"x-reconciled-at": "2026-01-
|
|
7786
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165433+00:00"
|
|
7684
7787
|
},
|
|
7685
7788
|
"disable": {
|
|
7686
7789
|
"type": "boolean",
|
|
@@ -7689,6 +7792,7 @@
|
|
|
7689
7792
|
"format": "boolean",
|
|
7690
7793
|
"x-displayname": "Disable",
|
|
7691
7794
|
"x-f5xc-example": "true",
|
|
7795
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
7692
7796
|
"x-f5xc-required-for": {
|
|
7693
7797
|
"minimum_config": false,
|
|
7694
7798
|
"create": false,
|
|
@@ -7703,6 +7807,8 @@
|
|
|
7703
7807
|
"x-displayname": "Labels",
|
|
7704
7808
|
"x-ves-example": "Value",
|
|
7705
7809
|
"x-f5xc-example": "value",
|
|
7810
|
+
"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.",
|
|
7811
|
+
"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.",
|
|
7706
7812
|
"x-f5xc-required-for": {
|
|
7707
7813
|
"minimum_config": false,
|
|
7708
7814
|
"create": false,
|
|
@@ -7723,6 +7829,8 @@
|
|
|
7723
7829
|
"x-validation-rules": {
|
|
7724
7830
|
"ves.io.schema.rules.message.required": "true"
|
|
7725
7831
|
},
|
|
7832
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
7833
|
+
"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.",
|
|
7726
7834
|
"minLength": 0,
|
|
7727
7835
|
"maxLength": 16,
|
|
7728
7836
|
"x-f5xc-required-for": {
|
|
@@ -7733,7 +7841,7 @@
|
|
|
7733
7841
|
},
|
|
7734
7842
|
"x-original-maxLength": 1024,
|
|
7735
7843
|
"x-reconciled-from-discovery": true,
|
|
7736
|
-
"x-reconciled-at": "2026-01-
|
|
7844
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165440+00:00"
|
|
7737
7845
|
},
|
|
7738
7846
|
"namespace": {
|
|
7739
7847
|
"type": "string",
|
|
@@ -7742,6 +7850,8 @@
|
|
|
7742
7850
|
"x-displayname": "Namespace",
|
|
7743
7851
|
"x-ves-example": "Staging",
|
|
7744
7852
|
"x-f5xc-example": "staging",
|
|
7853
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
7854
|
+
"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 \"\".",
|
|
7745
7855
|
"minLength": 0,
|
|
7746
7856
|
"maxLength": 6,
|
|
7747
7857
|
"x-f5xc-required-for": {
|
|
@@ -7752,9 +7862,10 @@
|
|
|
7752
7862
|
},
|
|
7753
7863
|
"x-original-maxLength": 1024,
|
|
7754
7864
|
"x-reconciled-from-discovery": true,
|
|
7755
|
-
"x-reconciled-at": "2026-01-
|
|
7865
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165444+00:00"
|
|
7756
7866
|
}
|
|
7757
7867
|
},
|
|
7868
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
7758
7869
|
"x-f5xc-minimum-configuration": {
|
|
7759
7870
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
7760
7871
|
"required_fields": [
|
|
@@ -7781,6 +7892,8 @@
|
|
|
7781
7892
|
"EncodingBase64"
|
|
7782
7893
|
],
|
|
7783
7894
|
"default": "EncodingNone",
|
|
7895
|
+
"x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
|
|
7896
|
+
"x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
|
|
7784
7897
|
"x-f5xc-minimum-configuration": {
|
|
7785
7898
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
7786
7899
|
"required_fields": [],
|
|
@@ -7806,6 +7919,7 @@
|
|
|
7806
7919
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
7807
7920
|
}
|
|
7808
7921
|
},
|
|
7922
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
7809
7923
|
"x-f5xc-minimum-configuration": {
|
|
7810
7924
|
"description": "Minimum configuration for schemaSecretType",
|
|
7811
7925
|
"required_fields": [
|
|
@@ -7832,6 +7946,8 @@
|
|
|
7832
7946
|
"title": "Creation_timestamp.",
|
|
7833
7947
|
"format": "date-time",
|
|
7834
7948
|
"x-displayname": "Creation Timestamp.",
|
|
7949
|
+
"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.",
|
|
7950
|
+
"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.",
|
|
7835
7951
|
"minLength": 0,
|
|
7836
7952
|
"maxLength": 1024,
|
|
7837
7953
|
"x-f5xc-required-for": {
|
|
@@ -7849,6 +7965,8 @@
|
|
|
7849
7965
|
"x-displayname": "Creator Class.",
|
|
7850
7966
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
7851
7967
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
7968
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
7969
|
+
"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.",
|
|
7852
7970
|
"minLength": 0,
|
|
7853
7971
|
"maxLength": 1024,
|
|
7854
7972
|
"x-f5xc-required-for": {
|
|
@@ -7866,6 +7984,8 @@
|
|
|
7866
7984
|
"x-displayname": "Creator ID.",
|
|
7867
7985
|
"x-ves-example": "Ver-instance-1.",
|
|
7868
7986
|
"x-f5xc-example": "ver-instance-1",
|
|
7987
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
7988
|
+
"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.",
|
|
7869
7989
|
"minLength": 0,
|
|
7870
7990
|
"maxLength": 1024,
|
|
7871
7991
|
"x-f5xc-required-for": {
|
|
@@ -7884,6 +8004,8 @@
|
|
|
7884
8004
|
"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)",
|
|
7885
8005
|
"title": "Status_id",
|
|
7886
8006
|
"x-displayname": "Status ID",
|
|
8007
|
+
"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...",
|
|
8008
|
+
"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).",
|
|
7887
8009
|
"minLength": 0,
|
|
7888
8010
|
"maxLength": 1024,
|
|
7889
8011
|
"x-f5xc-required-for": {
|
|
@@ -7901,6 +8023,7 @@
|
|
|
7901
8023
|
"x-displayname": "UID",
|
|
7902
8024
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7903
8025
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
8026
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
7904
8027
|
"minLength": 0,
|
|
7905
8028
|
"maxLength": 36,
|
|
7906
8029
|
"x-f5xc-required-for": {
|
|
@@ -7913,13 +8036,14 @@
|
|
|
7913
8036
|
"x-original-maxLength": 1024,
|
|
7914
8037
|
"format": "uuid",
|
|
7915
8038
|
"x-reconciled-from-discovery": true,
|
|
7916
|
-
"x-reconciled-at": "2026-01-
|
|
8039
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165460+00:00"
|
|
7917
8040
|
},
|
|
7918
8041
|
"vtrp_id": {
|
|
7919
8042
|
"type": "string",
|
|
7920
8043
|
"description": "Origin of this status exchanged by VTRP.",
|
|
7921
8044
|
"title": "Vtrp_id",
|
|
7922
8045
|
"x-displayname": "VTRP ID",
|
|
8046
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
7923
8047
|
"minLength": 0,
|
|
7924
8048
|
"maxLength": 1024,
|
|
7925
8049
|
"x-f5xc-required-for": {
|
|
@@ -7936,6 +8060,7 @@
|
|
|
7936
8060
|
"title": "Vtrp_stale.",
|
|
7937
8061
|
"format": "boolean",
|
|
7938
8062
|
"x-displayname": "VTRP Stale.",
|
|
8063
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
7939
8064
|
"x-f5xc-required-for": {
|
|
7940
8065
|
"minimum_config": false,
|
|
7941
8066
|
"create": false,
|
|
@@ -7944,6 +8069,7 @@
|
|
|
7944
8069
|
}
|
|
7945
8070
|
}
|
|
7946
8071
|
},
|
|
8072
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
7947
8073
|
"x-f5xc-minimum-configuration": {
|
|
7948
8074
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
7949
8075
|
"required_fields": [
|
|
@@ -7974,6 +8100,8 @@
|
|
|
7974
8100
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
7975
8101
|
"x-displayname": "Status Publish Type.",
|
|
7976
8102
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
8103
|
+
"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.",
|
|
8104
|
+
"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.",
|
|
7977
8105
|
"x-f5xc-minimum-configuration": {
|
|
7978
8106
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
7979
8107
|
"required_fields": [],
|
|
@@ -7999,6 +8127,7 @@
|
|
|
7999
8127
|
"x-displayname": "Code",
|
|
8000
8128
|
"x-ves-example": "0",
|
|
8001
8129
|
"x-f5xc-example": "0",
|
|
8130
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
8002
8131
|
"minimum": 0,
|
|
8003
8132
|
"maximum": 2147483647,
|
|
8004
8133
|
"x-f5xc-required-for": {
|
|
@@ -8015,6 +8144,8 @@
|
|
|
8015
8144
|
"x-displayname": "Reason",
|
|
8016
8145
|
"x-ves-example": "Value",
|
|
8017
8146
|
"x-f5xc-example": "value",
|
|
8147
|
+
"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.",
|
|
8148
|
+
"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.",
|
|
8018
8149
|
"minLength": 0,
|
|
8019
8150
|
"maxLength": 43,
|
|
8020
8151
|
"x-f5xc-required-for": {
|
|
@@ -8025,7 +8156,7 @@
|
|
|
8025
8156
|
},
|
|
8026
8157
|
"x-original-maxLength": 1024,
|
|
8027
8158
|
"x-reconciled-from-discovery": true,
|
|
8028
|
-
"x-reconciled-at": "2026-01-
|
|
8159
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165469+00:00"
|
|
8029
8160
|
},
|
|
8030
8161
|
"status": {
|
|
8031
8162
|
"type": "string",
|
|
@@ -8034,6 +8165,7 @@
|
|
|
8034
8165
|
"x-displayname": "Status",
|
|
8035
8166
|
"x-ves-example": "Value",
|
|
8036
8167
|
"x-f5xc-example": "value",
|
|
8168
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
8037
8169
|
"minLength": 0,
|
|
8038
8170
|
"maxLength": 17,
|
|
8039
8171
|
"x-f5xc-required-for": {
|
|
@@ -8044,9 +8176,10 @@
|
|
|
8044
8176
|
},
|
|
8045
8177
|
"x-original-maxLength": 1024,
|
|
8046
8178
|
"x-reconciled-from-discovery": true,
|
|
8047
|
-
"x-reconciled-at": "2026-01-
|
|
8179
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165473+00:00"
|
|
8048
8180
|
}
|
|
8049
8181
|
},
|
|
8182
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
8050
8183
|
"x-f5xc-minimum-configuration": {
|
|
8051
8184
|
"description": "Minimum configuration for schemaStatusType",
|
|
8052
8185
|
"required_fields": [
|
|
@@ -8074,6 +8207,8 @@
|
|
|
8074
8207
|
"title": "Creation_timestamp.",
|
|
8075
8208
|
"format": "date-time",
|
|
8076
8209
|
"x-displayname": "Creation Timestamp.",
|
|
8210
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
8211
|
+
"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.",
|
|
8077
8212
|
"minLength": 0,
|
|
8078
8213
|
"maxLength": 1024,
|
|
8079
8214
|
"x-f5xc-required-for": {
|
|
@@ -8091,6 +8226,7 @@
|
|
|
8091
8226
|
"x-displayname": "Creator Class.",
|
|
8092
8227
|
"x-ves-example": "Prism",
|
|
8093
8228
|
"x-f5xc-example": "value",
|
|
8229
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
8094
8230
|
"minLength": 0,
|
|
8095
8231
|
"maxLength": 1024,
|
|
8096
8232
|
"x-f5xc-required-for": {
|
|
@@ -8108,6 +8244,7 @@
|
|
|
8108
8244
|
"x-displayname": "Creator ID.",
|
|
8109
8245
|
"x-ves-example": "Admin@example-corp.com.",
|
|
8110
8246
|
"x-f5xc-example": "value",
|
|
8247
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
8111
8248
|
"minLength": 0,
|
|
8112
8249
|
"maxLength": 1024,
|
|
8113
8250
|
"x-f5xc-required-for": {
|
|
@@ -8124,6 +8261,8 @@
|
|
|
8124
8261
|
"title": "Deletion_timestamp.",
|
|
8125
8262
|
"format": "date-time",
|
|
8126
8263
|
"x-displayname": "Deletion Timestamp.",
|
|
8264
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
8265
|
+
"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...",
|
|
8127
8266
|
"minLength": 0,
|
|
8128
8267
|
"maxLength": 1024,
|
|
8129
8268
|
"x-f5xc-required-for": {
|
|
@@ -8143,6 +8282,8 @@
|
|
|
8143
8282
|
"x-displayname": "Finalizers.",
|
|
8144
8283
|
"x-ves-example": "Value",
|
|
8145
8284
|
"x-f5xc-example": "value",
|
|
8285
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
8286
|
+
"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.",
|
|
8146
8287
|
"x-f5xc-required-for": {
|
|
8147
8288
|
"minimum_config": false,
|
|
8148
8289
|
"create": false,
|
|
@@ -8160,6 +8301,8 @@
|
|
|
8160
8301
|
"x-displayname": "Labels",
|
|
8161
8302
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
8162
8303
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
8304
|
+
"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.",
|
|
8305
|
+
"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).",
|
|
8163
8306
|
"x-f5xc-required-for": {
|
|
8164
8307
|
"minimum_config": false,
|
|
8165
8308
|
"create": false,
|
|
@@ -8173,6 +8316,8 @@
|
|
|
8173
8316
|
"title": "Modification_timestamp.",
|
|
8174
8317
|
"format": "date-time",
|
|
8175
8318
|
"x-displayname": "Modification Timestamp.",
|
|
8319
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
8320
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
8176
8321
|
"minLength": 0,
|
|
8177
8322
|
"maxLength": 1024,
|
|
8178
8323
|
"x-f5xc-required-for": {
|
|
@@ -8191,6 +8336,8 @@
|
|
|
8191
8336
|
"x-displayname": "Object Index.",
|
|
8192
8337
|
"x-ves-example": "0",
|
|
8193
8338
|
"x-f5xc-example": "0",
|
|
8339
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
8340
|
+
"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.",
|
|
8194
8341
|
"minimum": 0,
|
|
8195
8342
|
"maximum": 2147483647,
|
|
8196
8343
|
"x-f5xc-required-for": {
|
|
@@ -8211,6 +8358,8 @@
|
|
|
8211
8358
|
"x-displayname": "Tenant",
|
|
8212
8359
|
"x-ves-example": "Example-corp.",
|
|
8213
8360
|
"x-f5xc-example": "example-corp",
|
|
8361
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
8362
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
8214
8363
|
"minLength": 0,
|
|
8215
8364
|
"maxLength": 18,
|
|
8216
8365
|
"x-f5xc-required-for": {
|
|
@@ -8222,7 +8371,7 @@
|
|
|
8222
8371
|
"x-field-mutability": "read-only",
|
|
8223
8372
|
"x-original-maxLength": 1024,
|
|
8224
8373
|
"x-reconciled-from-discovery": true,
|
|
8225
|
-
"x-reconciled-at": "2026-01-
|
|
8374
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165492+00:00"
|
|
8226
8375
|
},
|
|
8227
8376
|
"uid": {
|
|
8228
8377
|
"type": "string",
|
|
@@ -8231,6 +8380,8 @@
|
|
|
8231
8380
|
"x-displayname": "UID",
|
|
8232
8381
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
8233
8382
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
8383
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
8384
|
+
"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.",
|
|
8234
8385
|
"minLength": 0,
|
|
8235
8386
|
"maxLength": 36,
|
|
8236
8387
|
"x-f5xc-required-for": {
|
|
@@ -8243,9 +8394,11 @@
|
|
|
8243
8394
|
"x-original-maxLength": 1024,
|
|
8244
8395
|
"format": "uuid",
|
|
8245
8396
|
"x-reconciled-from-discovery": true,
|
|
8246
|
-
"x-reconciled-at": "2026-01-
|
|
8397
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165497+00:00"
|
|
8247
8398
|
}
|
|
8248
8399
|
},
|
|
8400
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
8401
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
8249
8402
|
"x-f5xc-minimum-configuration": {
|
|
8250
8403
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
8251
8404
|
"required_fields": [
|
|
@@ -8279,6 +8432,8 @@
|
|
|
8279
8432
|
"description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
|
|
8280
8433
|
"title": "Key",
|
|
8281
8434
|
"x-f5xc-example": "key_pem",
|
|
8435
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
|
|
8436
|
+
"x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
|
|
8282
8437
|
"minLength": 0,
|
|
8283
8438
|
"maxLength": 16,
|
|
8284
8439
|
"x-f5xc-required-for": {
|
|
@@ -8289,13 +8444,14 @@
|
|
|
8289
8444
|
},
|
|
8290
8445
|
"x-original-maxLength": 1024,
|
|
8291
8446
|
"x-reconciled-from-discovery": true,
|
|
8292
|
-
"x-reconciled-at": "2026-01-
|
|
8447
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165502+00:00"
|
|
8293
8448
|
},
|
|
8294
8449
|
"location": {
|
|
8295
8450
|
"type": "string",
|
|
8296
8451
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
8297
8452
|
"title": "Location",
|
|
8298
8453
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
8454
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
8299
8455
|
"minLength": 0,
|
|
8300
8456
|
"maxLength": 4,
|
|
8301
8457
|
"x-f5xc-required-for": {
|
|
@@ -8306,13 +8462,15 @@
|
|
|
8306
8462
|
},
|
|
8307
8463
|
"x-original-maxLength": 1024,
|
|
8308
8464
|
"x-reconciled-from-discovery": true,
|
|
8309
|
-
"x-reconciled-at": "2026-01-
|
|
8465
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165518+00:00"
|
|
8310
8466
|
},
|
|
8311
8467
|
"provider": {
|
|
8312
8468
|
"type": "string",
|
|
8313
8469
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
8314
8470
|
"title": "Provider",
|
|
8315
8471
|
"x-f5xc-example": "vault-vh-provider",
|
|
8472
|
+
"x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
8473
|
+
"x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
8316
8474
|
"minLength": 0,
|
|
8317
8475
|
"maxLength": 8,
|
|
8318
8476
|
"x-f5xc-required-for": {
|
|
@@ -8323,7 +8481,7 @@
|
|
|
8323
8481
|
},
|
|
8324
8482
|
"x-original-maxLength": 1024,
|
|
8325
8483
|
"x-reconciled-from-discovery": true,
|
|
8326
|
-
"x-reconciled-at": "2026-01-
|
|
8484
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165522+00:00"
|
|
8327
8485
|
},
|
|
8328
8486
|
"secret_encoding": {
|
|
8329
8487
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -8334,6 +8492,8 @@
|
|
|
8334
8492
|
"title": "Version",
|
|
8335
8493
|
"format": "int64",
|
|
8336
8494
|
"x-f5xc-example": "1",
|
|
8495
|
+
"x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
|
|
8496
|
+
"x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
|
|
8337
8497
|
"minimum": 0,
|
|
8338
8498
|
"maximum": 2147483647,
|
|
8339
8499
|
"x-f5xc-required-for": {
|
|
@@ -8345,9 +8505,11 @@
|
|
|
8345
8505
|
"maxLength": 1,
|
|
8346
8506
|
"minLength": 1,
|
|
8347
8507
|
"x-reconciled-from-discovery": true,
|
|
8348
|
-
"x-reconciled-at": "2026-01-
|
|
8508
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165529+00:00"
|
|
8349
8509
|
}
|
|
8350
8510
|
},
|
|
8511
|
+
"x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
8512
|
+
"x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
8351
8513
|
"x-f5xc-minimum-configuration": {
|
|
8352
8514
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
8353
8515
|
"required_fields": [
|
|
@@ -8388,7 +8550,7 @@
|
|
|
8388
8550
|
},
|
|
8389
8551
|
"x-original-maxLength": 1024,
|
|
8390
8552
|
"x-reconciled-from-discovery": true,
|
|
8391
|
-
"x-reconciled-at": "2026-01-
|
|
8553
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165534+00:00"
|
|
8392
8554
|
},
|
|
8393
8555
|
"name": {
|
|
8394
8556
|
"type": "string",
|
|
@@ -8397,6 +8559,8 @@
|
|
|
8397
8559
|
"x-displayname": "Name",
|
|
8398
8560
|
"x-ves-example": "Contactus-route.",
|
|
8399
8561
|
"x-f5xc-example": "contactus-route",
|
|
8562
|
+
"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.",
|
|
8563
|
+
"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.",
|
|
8400
8564
|
"minLength": 0,
|
|
8401
8565
|
"maxLength": 16,
|
|
8402
8566
|
"x-f5xc-required-for": {
|
|
@@ -8407,7 +8571,7 @@
|
|
|
8407
8571
|
},
|
|
8408
8572
|
"x-original-maxLength": 1024,
|
|
8409
8573
|
"x-reconciled-from-discovery": true,
|
|
8410
|
-
"x-reconciled-at": "2026-01-
|
|
8574
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165538+00:00"
|
|
8411
8575
|
},
|
|
8412
8576
|
"namespace": {
|
|
8413
8577
|
"type": "string",
|
|
@@ -8416,6 +8580,8 @@
|
|
|
8416
8580
|
"x-displayname": "Namespace",
|
|
8417
8581
|
"x-ves-example": "Ns1",
|
|
8418
8582
|
"x-f5xc-example": "ns1",
|
|
8583
|
+
"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.",
|
|
8584
|
+
"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.",
|
|
8419
8585
|
"minLength": 0,
|
|
8420
8586
|
"maxLength": 6,
|
|
8421
8587
|
"x-f5xc-required-for": {
|
|
@@ -8426,7 +8592,7 @@
|
|
|
8426
8592
|
},
|
|
8427
8593
|
"x-original-maxLength": 1024,
|
|
8428
8594
|
"x-reconciled-from-discovery": true,
|
|
8429
|
-
"x-reconciled-at": "2026-01-
|
|
8595
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165542+00:00"
|
|
8430
8596
|
},
|
|
8431
8597
|
"uid": {
|
|
8432
8598
|
"type": "string",
|
|
@@ -8447,9 +8613,10 @@
|
|
|
8447
8613
|
"x-original-maxLength": 1024,
|
|
8448
8614
|
"format": "uuid",
|
|
8449
8615
|
"x-reconciled-from-discovery": true,
|
|
8450
|
-
"x-reconciled-at": "2026-01-
|
|
8616
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165546+00:00"
|
|
8451
8617
|
}
|
|
8452
8618
|
},
|
|
8619
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
8453
8620
|
"x-f5xc-minimum-configuration": {
|
|
8454
8621
|
"description": "Minimum configuration for schemaViewRefType",
|
|
8455
8622
|
"required_fields": [
|
|
@@ -8475,6 +8642,7 @@
|
|
|
8475
8642
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
8476
8643
|
"title": "Name",
|
|
8477
8644
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
8645
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
8478
8646
|
"minLength": 0,
|
|
8479
8647
|
"maxLength": 16,
|
|
8480
8648
|
"x-f5xc-required-for": {
|
|
@@ -8485,9 +8653,10 @@
|
|
|
8485
8653
|
},
|
|
8486
8654
|
"x-original-maxLength": 1024,
|
|
8487
8655
|
"x-reconciled-from-discovery": true,
|
|
8488
|
-
"x-reconciled-at": "2026-01-
|
|
8656
|
+
"x-reconciled-at": "2026-01-07T15:28:26.165551+00:00"
|
|
8489
8657
|
}
|
|
8490
8658
|
},
|
|
8659
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
8491
8660
|
"x-f5xc-minimum-configuration": {
|
|
8492
8661
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
8493
8662
|
"required_fields": [
|
|
@@ -8582,6 +8751,7 @@
|
|
|
8582
8751
|
"ves.io.schema.rules.string.max_len": "4096",
|
|
8583
8752
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
8584
8753
|
},
|
|
8754
|
+
"x-f5xc-description-short": "Exclusive with [k8s_cluster_role_selector policy_rule_list] K8s YAML for ClusterRole.",
|
|
8585
8755
|
"minLength": 0,
|
|
8586
8756
|
"x-f5xc-required-for": {
|
|
8587
8757
|
"minimum_config": false,
|
|
@@ -8591,6 +8761,8 @@
|
|
|
8591
8761
|
}
|
|
8592
8762
|
}
|
|
8593
8763
|
},
|
|
8764
|
+
"x-f5xc-description-short": "Create k8s_cluster_role will create the object in the storage backend for namespace metadata.namespace.",
|
|
8765
|
+
"x-f5xc-description-medium": "Create k8s_cluster_role will create the object in the storage backend for namespace metadata.namespace.",
|
|
8594
8766
|
"x-f5xc-minimum-configuration": {
|
|
8595
8767
|
"description": "Minimum configuration for k8s_cluster_roleCreateSpecType",
|
|
8596
8768
|
"required_fields": [
|
|
@@ -8618,6 +8790,7 @@
|
|
|
8618
8790
|
"title": "Fail_if_referred.",
|
|
8619
8791
|
"format": "boolean",
|
|
8620
8792
|
"x-displayname": "Fail-If-Referred.",
|
|
8793
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
8621
8794
|
"x-f5xc-required-for": {
|
|
8622
8795
|
"minimum_config": false,
|
|
8623
8796
|
"create": false,
|
|
@@ -8642,7 +8815,7 @@
|
|
|
8642
8815
|
},
|
|
8643
8816
|
"x-original-maxLength": 1024,
|
|
8644
8817
|
"x-reconciled-from-discovery": true,
|
|
8645
|
-
"x-reconciled-at": "2026-01-
|
|
8818
|
+
"x-reconciled-at": "2026-01-07T15:28:51.212118+00:00"
|
|
8646
8819
|
},
|
|
8647
8820
|
"namespace": {
|
|
8648
8821
|
"type": "string",
|
|
@@ -8651,6 +8824,7 @@
|
|
|
8651
8824
|
"x-displayname": "Namespace",
|
|
8652
8825
|
"x-ves-example": "Ns1",
|
|
8653
8826
|
"x-f5xc-example": "ns1",
|
|
8827
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
8654
8828
|
"minLength": 0,
|
|
8655
8829
|
"maxLength": 6,
|
|
8656
8830
|
"x-f5xc-required-for": {
|
|
@@ -8661,7 +8835,7 @@
|
|
|
8661
8835
|
},
|
|
8662
8836
|
"x-original-maxLength": 1024,
|
|
8663
8837
|
"x-reconciled-from-discovery": true,
|
|
8664
|
-
"x-reconciled-at": "2026-01-
|
|
8838
|
+
"x-reconciled-at": "2026-01-07T15:28:51.212125+00:00"
|
|
8665
8839
|
}
|
|
8666
8840
|
},
|
|
8667
8841
|
"x-f5xc-minimum-configuration": {
|
|
@@ -8696,6 +8870,7 @@
|
|
|
8696
8870
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8697
8871
|
},
|
|
8698
8872
|
"x-displayname": "Deleted Referred Objects.",
|
|
8873
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8699
8874
|
"x-f5xc-required-for": {
|
|
8700
8875
|
"minimum_config": false,
|
|
8701
8876
|
"create": false,
|
|
@@ -8711,6 +8886,7 @@
|
|
|
8711
8886
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8712
8887
|
},
|
|
8713
8888
|
"x-displayname": "Disabled Referred Objects.",
|
|
8889
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
8714
8890
|
"x-f5xc-required-for": {
|
|
8715
8891
|
"minimum_config": false,
|
|
8716
8892
|
"create": false,
|
|
@@ -8729,6 +8905,7 @@
|
|
|
8729
8905
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
8730
8906
|
},
|
|
8731
8907
|
"x-displayname": "Referring Objects.",
|
|
8908
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
8732
8909
|
"x-f5xc-required-for": {
|
|
8733
8910
|
"minimum_config": false,
|
|
8734
8911
|
"create": false,
|
|
@@ -8750,6 +8927,8 @@
|
|
|
8750
8927
|
"$ref": "#/components/schemas/k8s_cluster_roleStatusObject"
|
|
8751
8928
|
},
|
|
8752
8929
|
"x-displayname": "Status",
|
|
8930
|
+
"x-f5xc-example": "active",
|
|
8931
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
8753
8932
|
"x-f5xc-required-for": {
|
|
8754
8933
|
"minimum_config": false,
|
|
8755
8934
|
"create": false,
|
|
@@ -8759,7 +8938,7 @@
|
|
|
8759
8938
|
"maxLength": 17,
|
|
8760
8939
|
"minLength": 17,
|
|
8761
8940
|
"x-reconciled-from-discovery": true,
|
|
8762
|
-
"x-reconciled-at": "2026-01-
|
|
8941
|
+
"x-reconciled-at": "2026-01-07T15:28:51.212141+00:00"
|
|
8763
8942
|
},
|
|
8764
8943
|
"system_metadata": {
|
|
8765
8944
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -8799,6 +8978,8 @@
|
|
|
8799
8978
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
8800
8979
|
],
|
|
8801
8980
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
8981
|
+
"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...",
|
|
8982
|
+
"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...",
|
|
8802
8983
|
"x-f5xc-minimum-configuration": {
|
|
8803
8984
|
"description": "Minimum configuration for k8s_cluster_roleGetResponseFormatCode",
|
|
8804
8985
|
"required_fields": [],
|
|
@@ -8836,6 +9017,7 @@
|
|
|
8836
9017
|
"ves.io.schema.rules.string.max_len": "4096",
|
|
8837
9018
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
8838
9019
|
},
|
|
9020
|
+
"x-f5xc-description-short": "Exclusive with [k8s_cluster_role_selector policy_rule_list] K8s YAML for ClusterRole.",
|
|
8839
9021
|
"minLength": 0,
|
|
8840
9022
|
"x-f5xc-required-for": {
|
|
8841
9023
|
"minimum_config": false,
|
|
@@ -8845,6 +9027,7 @@
|
|
|
8845
9027
|
}
|
|
8846
9028
|
}
|
|
8847
9029
|
},
|
|
9030
|
+
"x-f5xc-description-short": "GET k8s_cluster_role will GET the object from the storage backend for namespace metadata.namespace.",
|
|
8848
9031
|
"x-f5xc-minimum-configuration": {
|
|
8849
9032
|
"description": "Minimum configuration for k8s_cluster_roleGetSpecType",
|
|
8850
9033
|
"required_fields": [
|
|
@@ -8874,6 +9057,7 @@
|
|
|
8874
9057
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
8875
9058
|
},
|
|
8876
9059
|
"x-displayname": "Errors",
|
|
9060
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
8877
9061
|
"x-f5xc-required-for": {
|
|
8878
9062
|
"minimum_config": false,
|
|
8879
9063
|
"create": false,
|
|
@@ -8889,6 +9073,8 @@
|
|
|
8889
9073
|
"$ref": "#/components/schemas/k8s_cluster_roleListResponseItem"
|
|
8890
9074
|
},
|
|
8891
9075
|
"x-displayname": "Items",
|
|
9076
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
9077
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
8892
9078
|
"x-f5xc-required-for": {
|
|
8893
9079
|
"minimum_config": false,
|
|
8894
9080
|
"create": false,
|
|
@@ -8922,6 +9108,8 @@
|
|
|
8922
9108
|
"description": "The set of annotations present on this k8s_cluster_role.",
|
|
8923
9109
|
"title": "Annotations.",
|
|
8924
9110
|
"x-displayname": "Annotations.",
|
|
9111
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9112
|
+
"x-f5xc-description-short": "The set of annotations present on this k8s_cluster_role.",
|
|
8925
9113
|
"x-f5xc-required-for": {
|
|
8926
9114
|
"minimum_config": false,
|
|
8927
9115
|
"create": false,
|
|
@@ -8934,6 +9122,7 @@
|
|
|
8934
9122
|
"description": "The description set for this k8s_cluster_role.",
|
|
8935
9123
|
"title": "Description.",
|
|
8936
9124
|
"x-displayname": "Description.",
|
|
9125
|
+
"x-f5xc-description-short": "The description set for this k8s_cluster_role.",
|
|
8937
9126
|
"minLength": 0,
|
|
8938
9127
|
"maxLength": 0,
|
|
8939
9128
|
"x-f5xc-required-for": {
|
|
@@ -8944,7 +9133,7 @@
|
|
|
8944
9133
|
},
|
|
8945
9134
|
"x-original-maxLength": 1024,
|
|
8946
9135
|
"x-reconciled-from-discovery": true,
|
|
8947
|
-
"x-reconciled-at": "2026-01-
|
|
9136
|
+
"x-reconciled-at": "2026-01-07T15:28:51.212159+00:00"
|
|
8948
9137
|
},
|
|
8949
9138
|
"disabled": {
|
|
8950
9139
|
"type": "boolean",
|
|
@@ -8952,6 +9141,8 @@
|
|
|
8952
9141
|
"title": "Disabled",
|
|
8953
9142
|
"format": "boolean",
|
|
8954
9143
|
"x-displayname": "Disabled",
|
|
9144
|
+
"x-f5xc-example": "True",
|
|
9145
|
+
"x-f5xc-description-short": "Value of true indicates k8s_cluster_role is administratively disabled.",
|
|
8955
9146
|
"x-f5xc-required-for": {
|
|
8956
9147
|
"minimum_config": false,
|
|
8957
9148
|
"create": false,
|
|
@@ -8967,6 +9158,8 @@
|
|
|
8967
9158
|
"description": "The set of labels present on this k8s_cluster_role.",
|
|
8968
9159
|
"title": "Labels",
|
|
8969
9160
|
"x-displayname": "Labels",
|
|
9161
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9162
|
+
"x-f5xc-description-short": "The set of labels present on this k8s_cluster_role.",
|
|
8970
9163
|
"x-f5xc-required-for": {
|
|
8971
9164
|
"minimum_config": false,
|
|
8972
9165
|
"create": false,
|
|
@@ -8994,7 +9187,7 @@
|
|
|
8994
9187
|
},
|
|
8995
9188
|
"x-original-maxLength": 1024,
|
|
8996
9189
|
"x-reconciled-from-discovery": true,
|
|
8997
|
-
"x-reconciled-at": "2026-01-
|
|
9190
|
+
"x-reconciled-at": "2026-01-07T15:28:51.212169+00:00"
|
|
8998
9191
|
},
|
|
8999
9192
|
"namespace": {
|
|
9000
9193
|
"type": "string",
|
|
@@ -9013,7 +9206,7 @@
|
|
|
9013
9206
|
},
|
|
9014
9207
|
"x-original-maxLength": 1024,
|
|
9015
9208
|
"x-reconciled-from-discovery": true,
|
|
9016
|
-
"x-reconciled-at": "2026-01-
|
|
9209
|
+
"x-reconciled-at": "2026-01-07T15:28:51.212174+00:00"
|
|
9017
9210
|
},
|
|
9018
9211
|
"owner_view": {
|
|
9019
9212
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -9026,6 +9219,7 @@
|
|
|
9026
9219
|
"$ref": "#/components/schemas/k8s_cluster_roleStatusObject"
|
|
9027
9220
|
},
|
|
9028
9221
|
"x-displayname": "Status",
|
|
9222
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
9029
9223
|
"x-f5xc-required-for": {
|
|
9030
9224
|
"minimum_config": false,
|
|
9031
9225
|
"create": false,
|
|
@@ -9054,7 +9248,7 @@
|
|
|
9054
9248
|
"x-field-mutability": "read-only",
|
|
9055
9249
|
"x-original-maxLength": 1024,
|
|
9056
9250
|
"x-reconciled-from-discovery": true,
|
|
9057
|
-
"x-reconciled-at": "2026-01-
|
|
9251
|
+
"x-reconciled-at": "2026-01-07T15:28:51.212182+00:00"
|
|
9058
9252
|
},
|
|
9059
9253
|
"uid": {
|
|
9060
9254
|
"type": "string",
|
|
@@ -9063,6 +9257,7 @@
|
|
|
9063
9257
|
"x-displayname": "UID",
|
|
9064
9258
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
9065
9259
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
9260
|
+
"x-f5xc-description-short": "The unique uid of this k8s_cluster_role.",
|
|
9066
9261
|
"minLength": 0,
|
|
9067
9262
|
"maxLength": 36,
|
|
9068
9263
|
"x-f5xc-required-for": {
|
|
@@ -9075,9 +9270,11 @@
|
|
|
9075
9270
|
"x-original-maxLength": 1024,
|
|
9076
9271
|
"format": "uuid",
|
|
9077
9272
|
"x-reconciled-from-discovery": true,
|
|
9078
|
-
"x-reconciled-at": "2026-01-
|
|
9273
|
+
"x-reconciled-at": "2026-01-07T15:28:51.212188+00:00"
|
|
9079
9274
|
}
|
|
9080
9275
|
},
|
|
9276
|
+
"x-f5xc-description-short": "By default a summary of k8s_cluster_role is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
9277
|
+
"x-f5xc-description-medium": "By default a summary of k8s_cluster_role is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
9081
9278
|
"x-f5xc-minimum-configuration": {
|
|
9082
9279
|
"description": "Minimum configuration for k8s_cluster_roleListResponseItem",
|
|
9083
9280
|
"required_fields": [
|
|
@@ -9137,6 +9334,7 @@
|
|
|
9137
9334
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
9138
9335
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
9139
9336
|
},
|
|
9337
|
+
"x-f5xc-description-short": "Allowed URL(s) that do not represent any K8s resource. URL can be suffix or regex.",
|
|
9140
9338
|
"x-f5xc-required-for": {
|
|
9141
9339
|
"minimum_config": false,
|
|
9142
9340
|
"create": false,
|
|
@@ -9172,6 +9370,7 @@
|
|
|
9172
9370
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
9173
9371
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
9174
9372
|
},
|
|
9373
|
+
"x-f5xc-description-short": "Allowed list of verbs(operations) on resources. Use VerbAll for all operations Required: YES.",
|
|
9175
9374
|
"x-f5xc-required-for": {
|
|
9176
9375
|
"minimum_config": false,
|
|
9177
9376
|
"create": false,
|
|
@@ -9180,6 +9379,7 @@
|
|
|
9180
9379
|
}
|
|
9181
9380
|
}
|
|
9182
9381
|
},
|
|
9382
|
+
"x-f5xc-description-short": "Permissions for URL(s) that do not represent K8s resource.",
|
|
9183
9383
|
"x-f5xc-minimum-configuration": {
|
|
9184
9384
|
"description": "Minimum configuration for k8s_cluster_roleNonResourceURLListType",
|
|
9185
9385
|
"required_fields": [
|
|
@@ -9223,6 +9423,8 @@
|
|
|
9223
9423
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
9224
9424
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
9225
9425
|
},
|
|
9426
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
9427
|
+
"x-f5xc-description-short": "List of rules for role permissions Required: YES.",
|
|
9226
9428
|
"x-f5xc-required-for": {
|
|
9227
9429
|
"minimum_config": false,
|
|
9228
9430
|
"create": false,
|
|
@@ -9338,6 +9540,7 @@
|
|
|
9338
9540
|
"ves.io.schema.rules.string.max_len": "4096",
|
|
9339
9541
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
9340
9542
|
},
|
|
9543
|
+
"x-f5xc-description-short": "Exclusive with [k8s_cluster_role_selector policy_rule_list] K8s YAML for ClusterRole.",
|
|
9341
9544
|
"minLength": 0,
|
|
9342
9545
|
"x-f5xc-required-for": {
|
|
9343
9546
|
"minimum_config": false,
|
|
@@ -9347,6 +9550,8 @@
|
|
|
9347
9550
|
}
|
|
9348
9551
|
}
|
|
9349
9552
|
},
|
|
9553
|
+
"x-f5xc-description-short": "Replacing an k8s_cluster_role object will update the object by replacing the existing spec with the provided one.",
|
|
9554
|
+
"x-f5xc-description-medium": "Replacing an k8s_cluster_role object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
|
|
9350
9555
|
"x-f5xc-minimum-configuration": {
|
|
9351
9556
|
"description": "Minimum configuration for k8s_cluster_roleReplaceSpecType",
|
|
9352
9557
|
"required_fields": [
|
|
@@ -9396,6 +9601,8 @@
|
|
|
9396
9601
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
9397
9602
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
9398
9603
|
},
|
|
9604
|
+
"x-f5xc-description-short": "Allowed list of API group that contains resources, all resources of a given API group Required: YES.",
|
|
9605
|
+
"x-f5xc-description-medium": "Allowed list of API group that contains resources, all resources of a given API group Required: YES.",
|
|
9399
9606
|
"x-f5xc-required-for": {
|
|
9400
9607
|
"minimum_config": false,
|
|
9401
9608
|
"create": false,
|
|
@@ -9425,6 +9632,7 @@
|
|
|
9425
9632
|
"ves.io.schema.rules.repeated.max_items": "16",
|
|
9426
9633
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
9427
9634
|
},
|
|
9635
|
+
"x-f5xc-description-short": "Allowed list of resource instances within the resource types.",
|
|
9428
9636
|
"x-f5xc-required-for": {
|
|
9429
9637
|
"minimum_config": false,
|
|
9430
9638
|
"create": false,
|
|
@@ -9460,6 +9668,7 @@
|
|
|
9460
9668
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
9461
9669
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
9462
9670
|
},
|
|
9671
|
+
"x-f5xc-description-short": "Allowed list of resource types within the API groups. Required: YES.",
|
|
9463
9672
|
"x-f5xc-required-for": {
|
|
9464
9673
|
"minimum_config": false,
|
|
9465
9674
|
"create": false,
|
|
@@ -9495,6 +9704,7 @@
|
|
|
9495
9704
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
9496
9705
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
9497
9706
|
},
|
|
9707
|
+
"x-f5xc-description-short": "Allowed list of verbs(operations) on resources. Use * for all operations Required: YES.",
|
|
9498
9708
|
"x-f5xc-required-for": {
|
|
9499
9709
|
"minimum_config": false,
|
|
9500
9710
|
"create": false,
|
|
@@ -9503,6 +9713,7 @@
|
|
|
9503
9713
|
}
|
|
9504
9714
|
}
|
|
9505
9715
|
},
|
|
9716
|
+
"x-f5xc-description-short": "List of resources in terms of API groups/resource types/resource instances and verbs allowed.",
|
|
9506
9717
|
"x-f5xc-minimum-configuration": {
|
|
9507
9718
|
"description": "Minimum configuration for k8s_cluster_roleResourceListType",
|
|
9508
9719
|
"required_fields": [
|
|
@@ -9559,6 +9770,7 @@
|
|
|
9559
9770
|
}
|
|
9560
9771
|
}
|
|
9561
9772
|
},
|
|
9773
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
9562
9774
|
"x-f5xc-minimum-configuration": {
|
|
9563
9775
|
"description": "Minimum configuration for k8s_cluster_roleStatusObject",
|
|
9564
9776
|
"required_fields": [
|
|
@@ -9608,6 +9820,7 @@
|
|
|
9608
9820
|
"ves.io.schema.rules.repeated.items.string.min_len": "1",
|
|
9609
9821
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
9610
9822
|
},
|
|
9823
|
+
"x-f5xc-description-short": "Expressions contains the Kubernetes style label expression for selections. Required: YES.",
|
|
9611
9824
|
"x-f5xc-required-for": {
|
|
9612
9825
|
"minimum_config": false,
|
|
9613
9826
|
"create": false,
|
|
@@ -9616,6 +9829,8 @@
|
|
|
9616
9829
|
}
|
|
9617
9830
|
}
|
|
9618
9831
|
},
|
|
9832
|
+
"x-f5xc-description-short": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the...",
|
|
9833
|
+
"x-f5xc-description-medium": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects.",
|
|
9619
9834
|
"x-f5xc-minimum-configuration": {
|
|
9620
9835
|
"description": "Minimum configuration for schemaLabelSelectorType",
|
|
9621
9836
|
"required_fields": [
|
|
@@ -9642,6 +9857,8 @@
|
|
|
9642
9857
|
"x-displayname": "Kind",
|
|
9643
9858
|
"x-ves-example": "Virtual_site.",
|
|
9644
9859
|
"x-f5xc-example": "virtual_site",
|
|
9860
|
+
"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\")",
|
|
9861
|
+
"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\").",
|
|
9645
9862
|
"minLength": 0,
|
|
9646
9863
|
"maxLength": 14,
|
|
9647
9864
|
"x-f5xc-required-for": {
|
|
@@ -9653,7 +9870,7 @@
|
|
|
9653
9870
|
"readOnly": true,
|
|
9654
9871
|
"x-original-maxLength": 1024,
|
|
9655
9872
|
"x-reconciled-from-discovery": true,
|
|
9656
|
-
"x-reconciled-at": "2026-01-
|
|
9873
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642244+00:00"
|
|
9657
9874
|
},
|
|
9658
9875
|
"name": {
|
|
9659
9876
|
"type": "string",
|
|
@@ -9662,6 +9879,8 @@
|
|
|
9662
9879
|
"x-displayname": "Name",
|
|
9663
9880
|
"x-ves-example": "Contactus-route.",
|
|
9664
9881
|
"x-f5xc-example": "contactus-route",
|
|
9882
|
+
"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.",
|
|
9883
|
+
"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.",
|
|
9665
9884
|
"minLength": 0,
|
|
9666
9885
|
"maxLength": 16,
|
|
9667
9886
|
"x-f5xc-required-for": {
|
|
@@ -9672,7 +9891,7 @@
|
|
|
9672
9891
|
},
|
|
9673
9892
|
"x-original-maxLength": 1024,
|
|
9674
9893
|
"x-reconciled-from-discovery": true,
|
|
9675
|
-
"x-reconciled-at": "2026-01-
|
|
9894
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642251+00:00"
|
|
9676
9895
|
},
|
|
9677
9896
|
"namespace": {
|
|
9678
9897
|
"type": "string",
|
|
@@ -9681,6 +9900,8 @@
|
|
|
9681
9900
|
"x-displayname": "Namespace",
|
|
9682
9901
|
"x-ves-example": "Ns1",
|
|
9683
9902
|
"x-f5xc-example": "ns1",
|
|
9903
|
+
"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.",
|
|
9904
|
+
"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.",
|
|
9684
9905
|
"minLength": 0,
|
|
9685
9906
|
"maxLength": 6,
|
|
9686
9907
|
"x-f5xc-required-for": {
|
|
@@ -9691,7 +9912,7 @@
|
|
|
9691
9912
|
},
|
|
9692
9913
|
"x-original-maxLength": 1024,
|
|
9693
9914
|
"x-reconciled-from-discovery": true,
|
|
9694
|
-
"x-reconciled-at": "2026-01-
|
|
9915
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642256+00:00"
|
|
9695
9916
|
},
|
|
9696
9917
|
"tenant": {
|
|
9697
9918
|
"type": "string",
|
|
@@ -9700,6 +9921,8 @@
|
|
|
9700
9921
|
"x-displayname": "Tenant",
|
|
9701
9922
|
"x-ves-example": "Example-corp.",
|
|
9702
9923
|
"x-f5xc-example": "example-corp",
|
|
9924
|
+
"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.",
|
|
9925
|
+
"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.",
|
|
9703
9926
|
"minLength": 0,
|
|
9704
9927
|
"maxLength": 18,
|
|
9705
9928
|
"x-f5xc-required-for": {
|
|
@@ -9712,7 +9935,7 @@
|
|
|
9712
9935
|
"x-field-mutability": "read-only",
|
|
9713
9936
|
"x-original-maxLength": 1024,
|
|
9714
9937
|
"x-reconciled-from-discovery": true,
|
|
9715
|
-
"x-reconciled-at": "2026-01-
|
|
9938
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642261+00:00"
|
|
9716
9939
|
},
|
|
9717
9940
|
"uid": {
|
|
9718
9941
|
"type": "string",
|
|
@@ -9721,6 +9944,8 @@
|
|
|
9721
9944
|
"x-displayname": "UID",
|
|
9722
9945
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
9723
9946
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
9947
|
+
"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.",
|
|
9948
|
+
"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.",
|
|
9724
9949
|
"minLength": 0,
|
|
9725
9950
|
"maxLength": 36,
|
|
9726
9951
|
"x-f5xc-required-for": {
|
|
@@ -9734,9 +9959,11 @@
|
|
|
9734
9959
|
"x-original-maxLength": 1024,
|
|
9735
9960
|
"format": "uuid",
|
|
9736
9961
|
"x-reconciled-from-discovery": true,
|
|
9737
|
-
"x-reconciled-at": "2026-01-
|
|
9962
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642267+00:00"
|
|
9738
9963
|
}
|
|
9739
9964
|
},
|
|
9965
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
9966
|
+
"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...",
|
|
9740
9967
|
"x-f5xc-minimum-configuration": {
|
|
9741
9968
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
9742
9969
|
"required_fields": [
|
|
@@ -9840,6 +10067,7 @@
|
|
|
9840
10067
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
9841
10068
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
9842
10069
|
},
|
|
10070
|
+
"x-f5xc-description-short": "List of subjects (user, group or service account) to which this role is bound Required: YES.",
|
|
9843
10071
|
"x-f5xc-required-for": {
|
|
9844
10072
|
"minimum_config": false,
|
|
9845
10073
|
"create": false,
|
|
@@ -9848,6 +10076,8 @@
|
|
|
9848
10076
|
}
|
|
9849
10077
|
}
|
|
9850
10078
|
},
|
|
10079
|
+
"x-f5xc-description-short": "Create k8s_cluster_role_binding will create the object in the storage backend for namespace metadata.namespace.",
|
|
10080
|
+
"x-f5xc-description-medium": "Create k8s_cluster_role_binding will create the object in the storage backend for namespace metadata.namespace.",
|
|
9851
10081
|
"x-f5xc-minimum-configuration": {
|
|
9852
10082
|
"description": "Minimum configuration for k8s_cluster_role_bindingCreateSpecType",
|
|
9853
10083
|
"required_fields": [
|
|
@@ -9874,6 +10104,7 @@
|
|
|
9874
10104
|
"title": "Fail_if_referred.",
|
|
9875
10105
|
"format": "boolean",
|
|
9876
10106
|
"x-displayname": "Fail-If-Referred.",
|
|
10107
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
9877
10108
|
"x-f5xc-required-for": {
|
|
9878
10109
|
"minimum_config": false,
|
|
9879
10110
|
"create": false,
|
|
@@ -9898,7 +10129,7 @@
|
|
|
9898
10129
|
},
|
|
9899
10130
|
"x-original-maxLength": 1024,
|
|
9900
10131
|
"x-reconciled-from-discovery": true,
|
|
9901
|
-
"x-reconciled-at": "2026-01-
|
|
10132
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642284+00:00"
|
|
9902
10133
|
},
|
|
9903
10134
|
"namespace": {
|
|
9904
10135
|
"type": "string",
|
|
@@ -9907,6 +10138,7 @@
|
|
|
9907
10138
|
"x-displayname": "Namespace",
|
|
9908
10139
|
"x-ves-example": "Ns1",
|
|
9909
10140
|
"x-f5xc-example": "ns1",
|
|
10141
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
9910
10142
|
"minLength": 0,
|
|
9911
10143
|
"maxLength": 6,
|
|
9912
10144
|
"x-f5xc-required-for": {
|
|
@@ -9917,7 +10149,7 @@
|
|
|
9917
10149
|
},
|
|
9918
10150
|
"x-original-maxLength": 1024,
|
|
9919
10151
|
"x-reconciled-from-discovery": true,
|
|
9920
|
-
"x-reconciled-at": "2026-01-
|
|
10152
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642289+00:00"
|
|
9921
10153
|
}
|
|
9922
10154
|
},
|
|
9923
10155
|
"x-f5xc-minimum-configuration": {
|
|
@@ -9952,6 +10184,7 @@
|
|
|
9952
10184
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
9953
10185
|
},
|
|
9954
10186
|
"x-displayname": "Deleted Referred Objects.",
|
|
10187
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
9955
10188
|
"x-f5xc-required-for": {
|
|
9956
10189
|
"minimum_config": false,
|
|
9957
10190
|
"create": false,
|
|
@@ -9967,6 +10200,7 @@
|
|
|
9967
10200
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
9968
10201
|
},
|
|
9969
10202
|
"x-displayname": "Disabled Referred Objects.",
|
|
10203
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
9970
10204
|
"x-f5xc-required-for": {
|
|
9971
10205
|
"minimum_config": false,
|
|
9972
10206
|
"create": false,
|
|
@@ -9985,6 +10219,7 @@
|
|
|
9985
10219
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
9986
10220
|
},
|
|
9987
10221
|
"x-displayname": "Referring Objects.",
|
|
10222
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
9988
10223
|
"x-f5xc-required-for": {
|
|
9989
10224
|
"minimum_config": false,
|
|
9990
10225
|
"create": false,
|
|
@@ -10006,6 +10241,8 @@
|
|
|
10006
10241
|
"$ref": "#/components/schemas/k8s_cluster_role_bindingStatusObject"
|
|
10007
10242
|
},
|
|
10008
10243
|
"x-displayname": "Status",
|
|
10244
|
+
"x-f5xc-example": "active",
|
|
10245
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
10009
10246
|
"x-f5xc-required-for": {
|
|
10010
10247
|
"minimum_config": false,
|
|
10011
10248
|
"create": false,
|
|
@@ -10015,7 +10252,7 @@
|
|
|
10015
10252
|
"maxLength": 17,
|
|
10016
10253
|
"minLength": 17,
|
|
10017
10254
|
"x-reconciled-from-discovery": true,
|
|
10018
|
-
"x-reconciled-at": "2026-01-
|
|
10255
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642303+00:00"
|
|
10019
10256
|
},
|
|
10020
10257
|
"system_metadata": {
|
|
10021
10258
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -10055,6 +10292,8 @@
|
|
|
10055
10292
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
10056
10293
|
],
|
|
10057
10294
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
10295
|
+
"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...",
|
|
10296
|
+
"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...",
|
|
10058
10297
|
"x-f5xc-minimum-configuration": {
|
|
10059
10298
|
"description": "Minimum configuration for k8s_cluster_role_bindingGetResponseFormatCode",
|
|
10060
10299
|
"required_fields": [],
|
|
@@ -10097,6 +10336,7 @@
|
|
|
10097
10336
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
10098
10337
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
10099
10338
|
},
|
|
10339
|
+
"x-f5xc-description-short": "List of subjects (user, group or service account) to which this role is bound Required: YES.",
|
|
10100
10340
|
"x-f5xc-required-for": {
|
|
10101
10341
|
"minimum_config": false,
|
|
10102
10342
|
"create": false,
|
|
@@ -10105,6 +10345,8 @@
|
|
|
10105
10345
|
}
|
|
10106
10346
|
}
|
|
10107
10347
|
},
|
|
10348
|
+
"x-f5xc-description-short": "GET k8s_cluster_role_binding will GET the object from the storage backend for namespace metadata.namespace.",
|
|
10349
|
+
"x-f5xc-description-medium": "GET k8s_cluster_role_binding will GET the object from the storage backend for namespace metadata.namespace.",
|
|
10108
10350
|
"x-f5xc-minimum-configuration": {
|
|
10109
10351
|
"description": "Minimum configuration for k8s_cluster_role_bindingGetSpecType",
|
|
10110
10352
|
"required_fields": [
|
|
@@ -10133,6 +10375,7 @@
|
|
|
10133
10375
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
10134
10376
|
},
|
|
10135
10377
|
"x-displayname": "Errors",
|
|
10378
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
10136
10379
|
"x-f5xc-required-for": {
|
|
10137
10380
|
"minimum_config": false,
|
|
10138
10381
|
"create": false,
|
|
@@ -10148,6 +10391,8 @@
|
|
|
10148
10391
|
"$ref": "#/components/schemas/k8s_cluster_role_bindingListResponseItem"
|
|
10149
10392
|
},
|
|
10150
10393
|
"x-displayname": "Items",
|
|
10394
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
10395
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
10151
10396
|
"x-f5xc-required-for": {
|
|
10152
10397
|
"minimum_config": false,
|
|
10153
10398
|
"create": false,
|
|
@@ -10181,6 +10426,8 @@
|
|
|
10181
10426
|
"description": "The set of annotations present on this k8s_cluster_role_binding.",
|
|
10182
10427
|
"title": "Annotations.",
|
|
10183
10428
|
"x-displayname": "Annotations.",
|
|
10429
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
10430
|
+
"x-f5xc-description-short": "The set of annotations present on this k8s_cluster_role_binding.",
|
|
10184
10431
|
"x-f5xc-required-for": {
|
|
10185
10432
|
"minimum_config": false,
|
|
10186
10433
|
"create": false,
|
|
@@ -10193,6 +10440,7 @@
|
|
|
10193
10440
|
"description": "The description set for this k8s_cluster_role_binding.",
|
|
10194
10441
|
"title": "Description.",
|
|
10195
10442
|
"x-displayname": "Description.",
|
|
10443
|
+
"x-f5xc-description-short": "The description set for this k8s_cluster_role_binding.",
|
|
10196
10444
|
"minLength": 0,
|
|
10197
10445
|
"maxLength": 0,
|
|
10198
10446
|
"x-f5xc-required-for": {
|
|
@@ -10203,7 +10451,7 @@
|
|
|
10203
10451
|
},
|
|
10204
10452
|
"x-original-maxLength": 1024,
|
|
10205
10453
|
"x-reconciled-from-discovery": true,
|
|
10206
|
-
"x-reconciled-at": "2026-01-
|
|
10454
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642319+00:00"
|
|
10207
10455
|
},
|
|
10208
10456
|
"disabled": {
|
|
10209
10457
|
"type": "boolean",
|
|
@@ -10211,6 +10459,8 @@
|
|
|
10211
10459
|
"title": "Disabled",
|
|
10212
10460
|
"format": "boolean",
|
|
10213
10461
|
"x-displayname": "Disabled",
|
|
10462
|
+
"x-f5xc-example": "True",
|
|
10463
|
+
"x-f5xc-description-short": "Value of true indicates k8s_cluster_role_binding is administratively disabled.",
|
|
10214
10464
|
"x-f5xc-required-for": {
|
|
10215
10465
|
"minimum_config": false,
|
|
10216
10466
|
"create": false,
|
|
@@ -10226,6 +10476,8 @@
|
|
|
10226
10476
|
"description": "The set of labels present on this k8s_cluster_role_binding.",
|
|
10227
10477
|
"title": "Labels",
|
|
10228
10478
|
"x-displayname": "Labels",
|
|
10479
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
10480
|
+
"x-f5xc-description-short": "The set of labels present on this k8s_cluster_role_binding.",
|
|
10229
10481
|
"x-f5xc-required-for": {
|
|
10230
10482
|
"minimum_config": false,
|
|
10231
10483
|
"create": false,
|
|
@@ -10243,6 +10495,7 @@
|
|
|
10243
10495
|
"x-displayname": "Name",
|
|
10244
10496
|
"x-ves-example": "Name",
|
|
10245
10497
|
"x-f5xc-example": "name",
|
|
10498
|
+
"x-f5xc-description-short": "The name of this k8s_cluster_role_binding.",
|
|
10246
10499
|
"minLength": 0,
|
|
10247
10500
|
"maxLength": 16,
|
|
10248
10501
|
"x-f5xc-required-for": {
|
|
@@ -10253,7 +10506,7 @@
|
|
|
10253
10506
|
},
|
|
10254
10507
|
"x-original-maxLength": 1024,
|
|
10255
10508
|
"x-reconciled-from-discovery": true,
|
|
10256
|
-
"x-reconciled-at": "2026-01-
|
|
10509
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642329+00:00"
|
|
10257
10510
|
},
|
|
10258
10511
|
"namespace": {
|
|
10259
10512
|
"type": "string",
|
|
@@ -10272,7 +10525,7 @@
|
|
|
10272
10525
|
},
|
|
10273
10526
|
"x-original-maxLength": 1024,
|
|
10274
10527
|
"x-reconciled-from-discovery": true,
|
|
10275
|
-
"x-reconciled-at": "2026-01-
|
|
10528
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642334+00:00"
|
|
10276
10529
|
},
|
|
10277
10530
|
"owner_view": {
|
|
10278
10531
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -10285,6 +10538,7 @@
|
|
|
10285
10538
|
"$ref": "#/components/schemas/k8s_cluster_role_bindingStatusObject"
|
|
10286
10539
|
},
|
|
10287
10540
|
"x-displayname": "Status",
|
|
10541
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
10288
10542
|
"x-f5xc-required-for": {
|
|
10289
10543
|
"minimum_config": false,
|
|
10290
10544
|
"create": false,
|
|
@@ -10313,7 +10567,7 @@
|
|
|
10313
10567
|
"x-field-mutability": "read-only",
|
|
10314
10568
|
"x-original-maxLength": 1024,
|
|
10315
10569
|
"x-reconciled-from-discovery": true,
|
|
10316
|
-
"x-reconciled-at": "2026-01-
|
|
10570
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642342+00:00"
|
|
10317
10571
|
},
|
|
10318
10572
|
"uid": {
|
|
10319
10573
|
"type": "string",
|
|
@@ -10322,6 +10576,7 @@
|
|
|
10322
10576
|
"x-displayname": "UID",
|
|
10323
10577
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
10324
10578
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
10579
|
+
"x-f5xc-description-short": "The unique uid of this k8s_cluster_role_binding.",
|
|
10325
10580
|
"minLength": 0,
|
|
10326
10581
|
"maxLength": 36,
|
|
10327
10582
|
"x-f5xc-required-for": {
|
|
@@ -10334,9 +10589,11 @@
|
|
|
10334
10589
|
"x-original-maxLength": 1024,
|
|
10335
10590
|
"format": "uuid",
|
|
10336
10591
|
"x-reconciled-from-discovery": true,
|
|
10337
|
-
"x-reconciled-at": "2026-01-
|
|
10592
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642347+00:00"
|
|
10338
10593
|
}
|
|
10339
10594
|
},
|
|
10595
|
+
"x-f5xc-description-short": "By default a summary of k8s_cluster_role_binding is returned in 'List'.",
|
|
10596
|
+
"x-f5xc-description-medium": "By default a summary of k8s_cluster_role_binding is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
10340
10597
|
"x-f5xc-minimum-configuration": {
|
|
10341
10598
|
"description": "Minimum configuration for k8s_cluster_role_bindingListResponseItem",
|
|
10342
10599
|
"required_fields": [
|
|
@@ -10433,6 +10690,7 @@
|
|
|
10433
10690
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
10434
10691
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
10435
10692
|
},
|
|
10693
|
+
"x-f5xc-description-short": "List of subjects (user, group or service account) to which this role is bound Required: YES.",
|
|
10436
10694
|
"x-f5xc-required-for": {
|
|
10437
10695
|
"minimum_config": false,
|
|
10438
10696
|
"create": false,
|
|
@@ -10441,6 +10699,8 @@
|
|
|
10441
10699
|
}
|
|
10442
10700
|
}
|
|
10443
10701
|
},
|
|
10702
|
+
"x-f5xc-description-short": "Replacing an k8s_cluster_role_binding object will update the object by replacing the existing spec with the provided one.",
|
|
10703
|
+
"x-f5xc-description-medium": "Replacing an k8s_cluster_role_binding object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
|
|
10444
10704
|
"x-f5xc-minimum-configuration": {
|
|
10445
10705
|
"description": "Minimum configuration for k8s_cluster_role_bindingReplaceSpecType",
|
|
10446
10706
|
"required_fields": [
|
|
@@ -10480,6 +10740,7 @@
|
|
|
10480
10740
|
"ves.io.schema.rules.string.max_len": "64",
|
|
10481
10741
|
"ves.io.schema.rules.string.min_len": "1"
|
|
10482
10742
|
},
|
|
10743
|
+
"x-f5xc-description-short": "Name of the service account Required: YES.",
|
|
10483
10744
|
"x-f5xc-required-for": {
|
|
10484
10745
|
"minimum_config": false,
|
|
10485
10746
|
"create": false,
|
|
@@ -10488,7 +10749,7 @@
|
|
|
10488
10749
|
},
|
|
10489
10750
|
"x-original-maxLength": 64,
|
|
10490
10751
|
"x-reconciled-from-discovery": true,
|
|
10491
|
-
"x-reconciled-at": "2026-01-
|
|
10752
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642359+00:00"
|
|
10492
10753
|
},
|
|
10493
10754
|
"namespace": {
|
|
10494
10755
|
"type": "string",
|
|
@@ -10510,6 +10771,7 @@
|
|
|
10510
10771
|
"ves.io.schema.rules.string.max_len": "64",
|
|
10511
10772
|
"ves.io.schema.rules.string.min_len": "1"
|
|
10512
10773
|
},
|
|
10774
|
+
"x-f5xc-description-short": "Namespace of the service account Required: YES.",
|
|
10513
10775
|
"x-f5xc-required-for": {
|
|
10514
10776
|
"minimum_config": false,
|
|
10515
10777
|
"create": false,
|
|
@@ -10518,7 +10780,7 @@
|
|
|
10518
10780
|
},
|
|
10519
10781
|
"x-original-maxLength": 64,
|
|
10520
10782
|
"x-reconciled-from-discovery": true,
|
|
10521
|
-
"x-reconciled-at": "2026-01-
|
|
10783
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642364+00:00"
|
|
10522
10784
|
}
|
|
10523
10785
|
},
|
|
10524
10786
|
"x-f5xc-minimum-configuration": {
|
|
@@ -10575,6 +10837,7 @@
|
|
|
10575
10837
|
}
|
|
10576
10838
|
}
|
|
10577
10839
|
},
|
|
10840
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
10578
10841
|
"x-f5xc-minimum-configuration": {
|
|
10579
10842
|
"description": "Minimum configuration for k8s_cluster_role_bindingStatusObject",
|
|
10580
10843
|
"required_fields": [
|
|
@@ -10614,6 +10877,7 @@
|
|
|
10614
10877
|
"ves.io.schema.rules.string.max_len": "64",
|
|
10615
10878
|
"ves.io.schema.rules.string.min_len": "1"
|
|
10616
10879
|
},
|
|
10880
|
+
"x-f5xc-description-short": "Exclusive with [service_account user] Group ID of the user group.",
|
|
10617
10881
|
"x-f5xc-required-for": {
|
|
10618
10882
|
"minimum_config": false,
|
|
10619
10883
|
"create": false,
|
|
@@ -10641,6 +10905,7 @@
|
|
|
10641
10905
|
"ves.io.schema.rules.string.max_len": "64",
|
|
10642
10906
|
"ves.io.schema.rules.string.min_len": "1"
|
|
10643
10907
|
},
|
|
10908
|
+
"x-f5xc-description-short": "Exclusive with [group service_account] User ID of the user.",
|
|
10644
10909
|
"x-f5xc-required-for": {
|
|
10645
10910
|
"minimum_config": false,
|
|
10646
10911
|
"create": false,
|
|
@@ -10690,6 +10955,8 @@
|
|
|
10690
10955
|
"ves.io.schema.rules.string.max_bytes": "128",
|
|
10691
10956
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
10692
10957
|
},
|
|
10958
|
+
"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.",
|
|
10959
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name. Required: YES.",
|
|
10693
10960
|
"x-f5xc-required-for": {
|
|
10694
10961
|
"minimum_config": false,
|
|
10695
10962
|
"create": false,
|
|
@@ -10698,7 +10965,7 @@
|
|
|
10698
10965
|
},
|
|
10699
10966
|
"x-original-maxLength": 128,
|
|
10700
10967
|
"x-reconciled-from-discovery": true,
|
|
10701
|
-
"x-reconciled-at": "2026-01-
|
|
10968
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642544+00:00"
|
|
10702
10969
|
},
|
|
10703
10970
|
"namespace": {
|
|
10704
10971
|
"type": "string",
|
|
@@ -10714,6 +10981,8 @@
|
|
|
10714
10981
|
"x-validation-rules": {
|
|
10715
10982
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
10716
10983
|
},
|
|
10984
|
+
"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.",
|
|
10985
|
+
"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.",
|
|
10717
10986
|
"minLength": 0,
|
|
10718
10987
|
"x-f5xc-required-for": {
|
|
10719
10988
|
"minimum_config": false,
|
|
@@ -10723,7 +10992,7 @@
|
|
|
10723
10992
|
},
|
|
10724
10993
|
"x-original-maxLength": 64,
|
|
10725
10994
|
"x-reconciled-from-discovery": true,
|
|
10726
|
-
"x-reconciled-at": "2026-01-
|
|
10995
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642549+00:00"
|
|
10727
10996
|
},
|
|
10728
10997
|
"tenant": {
|
|
10729
10998
|
"type": "string",
|
|
@@ -10739,6 +11008,8 @@
|
|
|
10739
11008
|
"x-validation-rules": {
|
|
10740
11009
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
10741
11010
|
},
|
|
11011
|
+
"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.",
|
|
11012
|
+
"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.",
|
|
10742
11013
|
"minLength": 0,
|
|
10743
11014
|
"x-f5xc-required-for": {
|
|
10744
11015
|
"minimum_config": false,
|
|
@@ -10750,9 +11021,11 @@
|
|
|
10750
11021
|
"x-field-mutability": "read-only",
|
|
10751
11022
|
"x-original-maxLength": 64,
|
|
10752
11023
|
"x-reconciled-from-discovery": true,
|
|
10753
|
-
"x-reconciled-at": "2026-01-
|
|
11024
|
+
"x-reconciled-at": "2026-01-07T15:28:51.642554+00:00"
|
|
10754
11025
|
}
|
|
10755
11026
|
},
|
|
11027
|
+
"x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
|
|
11028
|
+
"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.",
|
|
10756
11029
|
"x-f5xc-minimum-configuration": {
|
|
10757
11030
|
"description": "Minimum configuration for schemaviewsObjectRefType",
|
|
10758
11031
|
"required_fields": [
|
|
@@ -10773,6 +11046,7 @@
|
|
|
10773
11046
|
"title": "Empty",
|
|
10774
11047
|
"x-displayname": "Empty",
|
|
10775
11048
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
11049
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
10776
11050
|
"x-f5xc-minimum-configuration": {
|
|
10777
11051
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
10778
11052
|
"required_fields": [],
|
|
@@ -10875,6 +11149,7 @@
|
|
|
10875
11149
|
}
|
|
10876
11150
|
}
|
|
10877
11151
|
},
|
|
11152
|
+
"x-f5xc-description-short": "Create k8s_pod_security_admission will create the object in the storage backend.",
|
|
10878
11153
|
"x-f5xc-minimum-configuration": {
|
|
10879
11154
|
"description": "Minimum configuration for k8s_pod_security_admissionCreateSpecType",
|
|
10880
11155
|
"required_fields": [
|
|
@@ -10900,6 +11175,7 @@
|
|
|
10900
11175
|
"title": "Fail_if_referred.",
|
|
10901
11176
|
"format": "boolean",
|
|
10902
11177
|
"x-displayname": "Fail-If-Referred.",
|
|
11178
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
10903
11179
|
"x-f5xc-required-for": {
|
|
10904
11180
|
"minimum_config": false,
|
|
10905
11181
|
"create": false,
|
|
@@ -10924,7 +11200,7 @@
|
|
|
10924
11200
|
},
|
|
10925
11201
|
"x-original-maxLength": 1024,
|
|
10926
11202
|
"x-reconciled-from-discovery": true,
|
|
10927
|
-
"x-reconciled-at": "2026-01-
|
|
11203
|
+
"x-reconciled-at": "2026-01-07T15:28:52.060311+00:00"
|
|
10928
11204
|
},
|
|
10929
11205
|
"namespace": {
|
|
10930
11206
|
"type": "string",
|
|
@@ -10933,6 +11209,7 @@
|
|
|
10933
11209
|
"x-displayname": "Namespace",
|
|
10934
11210
|
"x-ves-example": "Ns1",
|
|
10935
11211
|
"x-f5xc-example": "ns1",
|
|
11212
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
10936
11213
|
"minLength": 0,
|
|
10937
11214
|
"maxLength": 6,
|
|
10938
11215
|
"x-f5xc-required-for": {
|
|
@@ -10943,7 +11220,7 @@
|
|
|
10943
11220
|
},
|
|
10944
11221
|
"x-original-maxLength": 1024,
|
|
10945
11222
|
"x-reconciled-from-discovery": true,
|
|
10946
|
-
"x-reconciled-at": "2026-01-
|
|
11223
|
+
"x-reconciled-at": "2026-01-07T15:28:52.060315+00:00"
|
|
10947
11224
|
}
|
|
10948
11225
|
},
|
|
10949
11226
|
"x-f5xc-minimum-configuration": {
|
|
@@ -10978,6 +11255,7 @@
|
|
|
10978
11255
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
10979
11256
|
},
|
|
10980
11257
|
"x-displayname": "Deleted Referred Objects.",
|
|
11258
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
10981
11259
|
"x-f5xc-required-for": {
|
|
10982
11260
|
"minimum_config": false,
|
|
10983
11261
|
"create": false,
|
|
@@ -10993,6 +11271,7 @@
|
|
|
10993
11271
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
10994
11272
|
},
|
|
10995
11273
|
"x-displayname": "Disabled Referred Objects.",
|
|
11274
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
10996
11275
|
"x-f5xc-required-for": {
|
|
10997
11276
|
"minimum_config": false,
|
|
10998
11277
|
"create": false,
|
|
@@ -11011,6 +11290,7 @@
|
|
|
11011
11290
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
11012
11291
|
},
|
|
11013
11292
|
"x-displayname": "Referring Objects.",
|
|
11293
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
11014
11294
|
"x-f5xc-required-for": {
|
|
11015
11295
|
"minimum_config": false,
|
|
11016
11296
|
"create": false,
|
|
@@ -11032,6 +11312,8 @@
|
|
|
11032
11312
|
"$ref": "#/components/schemas/k8s_pod_security_admissionStatusObject"
|
|
11033
11313
|
},
|
|
11034
11314
|
"x-displayname": "Status",
|
|
11315
|
+
"x-f5xc-example": "active",
|
|
11316
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
11035
11317
|
"x-f5xc-required-for": {
|
|
11036
11318
|
"minimum_config": false,
|
|
11037
11319
|
"create": false,
|
|
@@ -11041,7 +11323,7 @@
|
|
|
11041
11323
|
"maxLength": 17,
|
|
11042
11324
|
"minLength": 17,
|
|
11043
11325
|
"x-reconciled-from-discovery": true,
|
|
11044
|
-
"x-reconciled-at": "2026-01-
|
|
11326
|
+
"x-reconciled-at": "2026-01-07T15:28:52.060329+00:00"
|
|
11045
11327
|
},
|
|
11046
11328
|
"system_metadata": {
|
|
11047
11329
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -11081,6 +11363,8 @@
|
|
|
11081
11363
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
11082
11364
|
],
|
|
11083
11365
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
11366
|
+
"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...",
|
|
11367
|
+
"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...",
|
|
11084
11368
|
"x-f5xc-minimum-configuration": {
|
|
11085
11369
|
"description": "Minimum configuration for k8s_pod_security_admissionGetResponseFormatCode",
|
|
11086
11370
|
"required_fields": [],
|
|
@@ -11128,6 +11412,7 @@
|
|
|
11128
11412
|
}
|
|
11129
11413
|
}
|
|
11130
11414
|
},
|
|
11415
|
+
"x-f5xc-description-short": "GET k8s_pod_security_admission will GET the object from the storage backend.",
|
|
11131
11416
|
"x-f5xc-minimum-configuration": {
|
|
11132
11417
|
"description": "Minimum configuration for k8s_pod_security_admissionGetSpecType",
|
|
11133
11418
|
"required_fields": [
|
|
@@ -11155,6 +11440,7 @@
|
|
|
11155
11440
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
11156
11441
|
},
|
|
11157
11442
|
"x-displayname": "Errors",
|
|
11443
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
11158
11444
|
"x-f5xc-required-for": {
|
|
11159
11445
|
"minimum_config": false,
|
|
11160
11446
|
"create": false,
|
|
@@ -11170,6 +11456,8 @@
|
|
|
11170
11456
|
"$ref": "#/components/schemas/k8s_pod_security_admissionListResponseItem"
|
|
11171
11457
|
},
|
|
11172
11458
|
"x-displayname": "Items",
|
|
11459
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
11460
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
11173
11461
|
"x-f5xc-required-for": {
|
|
11174
11462
|
"minimum_config": false,
|
|
11175
11463
|
"create": false,
|
|
@@ -11203,6 +11491,8 @@
|
|
|
11203
11491
|
"description": "The set of annotations present on this k8s_pod_security_admission.",
|
|
11204
11492
|
"title": "Annotations.",
|
|
11205
11493
|
"x-displayname": "Annotations.",
|
|
11494
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
11495
|
+
"x-f5xc-description-short": "The set of annotations present on this k8s_pod_security_admission.",
|
|
11206
11496
|
"x-f5xc-required-for": {
|
|
11207
11497
|
"minimum_config": false,
|
|
11208
11498
|
"create": false,
|
|
@@ -11215,6 +11505,7 @@
|
|
|
11215
11505
|
"description": "The description set for this k8s_pod_security_admission.",
|
|
11216
11506
|
"title": "Description.",
|
|
11217
11507
|
"x-displayname": "Description.",
|
|
11508
|
+
"x-f5xc-description-short": "The description set for this k8s_pod_security_admission.",
|
|
11218
11509
|
"minLength": 0,
|
|
11219
11510
|
"maxLength": 0,
|
|
11220
11511
|
"x-f5xc-required-for": {
|
|
@@ -11225,7 +11516,7 @@
|
|
|
11225
11516
|
},
|
|
11226
11517
|
"x-original-maxLength": 1024,
|
|
11227
11518
|
"x-reconciled-from-discovery": true,
|
|
11228
|
-
"x-reconciled-at": "2026-01-
|
|
11519
|
+
"x-reconciled-at": "2026-01-07T15:28:52.060344+00:00"
|
|
11229
11520
|
},
|
|
11230
11521
|
"disabled": {
|
|
11231
11522
|
"type": "boolean",
|
|
@@ -11233,6 +11524,8 @@
|
|
|
11233
11524
|
"title": "Disabled",
|
|
11234
11525
|
"format": "boolean",
|
|
11235
11526
|
"x-displayname": "Disabled",
|
|
11527
|
+
"x-f5xc-example": "True",
|
|
11528
|
+
"x-f5xc-description-short": "Value of true indicates k8s_pod_security_admission is administratively disabled.",
|
|
11236
11529
|
"x-f5xc-required-for": {
|
|
11237
11530
|
"minimum_config": false,
|
|
11238
11531
|
"create": false,
|
|
@@ -11248,6 +11541,8 @@
|
|
|
11248
11541
|
"description": "The set of labels present on this k8s_pod_security_admission.",
|
|
11249
11542
|
"title": "Labels",
|
|
11250
11543
|
"x-displayname": "Labels",
|
|
11544
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
11545
|
+
"x-f5xc-description-short": "The set of labels present on this k8s_pod_security_admission.",
|
|
11251
11546
|
"x-f5xc-required-for": {
|
|
11252
11547
|
"minimum_config": false,
|
|
11253
11548
|
"create": false,
|
|
@@ -11265,6 +11560,7 @@
|
|
|
11265
11560
|
"x-displayname": "Name",
|
|
11266
11561
|
"x-ves-example": "Name",
|
|
11267
11562
|
"x-f5xc-example": "name",
|
|
11563
|
+
"x-f5xc-description-short": "The name of this k8s_pod_security_admission.",
|
|
11268
11564
|
"minLength": 0,
|
|
11269
11565
|
"maxLength": 16,
|
|
11270
11566
|
"x-f5xc-required-for": {
|
|
@@ -11275,7 +11571,7 @@
|
|
|
11275
11571
|
},
|
|
11276
11572
|
"x-original-maxLength": 1024,
|
|
11277
11573
|
"x-reconciled-from-discovery": true,
|
|
11278
|
-
"x-reconciled-at": "2026-01-
|
|
11574
|
+
"x-reconciled-at": "2026-01-07T15:28:52.060354+00:00"
|
|
11279
11575
|
},
|
|
11280
11576
|
"namespace": {
|
|
11281
11577
|
"type": "string",
|
|
@@ -11294,7 +11590,7 @@
|
|
|
11294
11590
|
},
|
|
11295
11591
|
"x-original-maxLength": 1024,
|
|
11296
11592
|
"x-reconciled-from-discovery": true,
|
|
11297
|
-
"x-reconciled-at": "2026-01-
|
|
11593
|
+
"x-reconciled-at": "2026-01-07T15:28:52.060358+00:00"
|
|
11298
11594
|
},
|
|
11299
11595
|
"owner_view": {
|
|
11300
11596
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -11307,6 +11603,7 @@
|
|
|
11307
11603
|
"$ref": "#/components/schemas/k8s_pod_security_admissionStatusObject"
|
|
11308
11604
|
},
|
|
11309
11605
|
"x-displayname": "Status",
|
|
11606
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
11310
11607
|
"x-f5xc-required-for": {
|
|
11311
11608
|
"minimum_config": false,
|
|
11312
11609
|
"create": false,
|
|
@@ -11335,7 +11632,7 @@
|
|
|
11335
11632
|
"x-field-mutability": "read-only",
|
|
11336
11633
|
"x-original-maxLength": 1024,
|
|
11337
11634
|
"x-reconciled-from-discovery": true,
|
|
11338
|
-
"x-reconciled-at": "2026-01-
|
|
11635
|
+
"x-reconciled-at": "2026-01-07T15:28:52.060366+00:00"
|
|
11339
11636
|
},
|
|
11340
11637
|
"uid": {
|
|
11341
11638
|
"type": "string",
|
|
@@ -11344,6 +11641,7 @@
|
|
|
11344
11641
|
"x-displayname": "UID",
|
|
11345
11642
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
11346
11643
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
11644
|
+
"x-f5xc-description-short": "The unique uid of this k8s_pod_security_admission.",
|
|
11347
11645
|
"minLength": 0,
|
|
11348
11646
|
"maxLength": 36,
|
|
11349
11647
|
"x-f5xc-required-for": {
|
|
@@ -11356,9 +11654,11 @@
|
|
|
11356
11654
|
"x-original-maxLength": 1024,
|
|
11357
11655
|
"format": "uuid",
|
|
11358
11656
|
"x-reconciled-from-discovery": true,
|
|
11359
|
-
"x-reconciled-at": "2026-01-
|
|
11657
|
+
"x-reconciled-at": "2026-01-07T15:28:52.060371+00:00"
|
|
11360
11658
|
}
|
|
11361
11659
|
},
|
|
11660
|
+
"x-f5xc-description-short": "By default a summary of k8s_pod_security_admission is returned in 'List'.",
|
|
11661
|
+
"x-f5xc-description-medium": "By default a summary of k8s_pod_security_admission is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
11362
11662
|
"x-f5xc-minimum-configuration": {
|
|
11363
11663
|
"description": "Minimum configuration for k8s_pod_security_admissionListResponseItem",
|
|
11364
11664
|
"required_fields": [
|
|
@@ -11411,6 +11711,7 @@
|
|
|
11411
11711
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
11412
11712
|
}
|
|
11413
11713
|
},
|
|
11714
|
+
"x-f5xc-description-short": "Pod Security Admission Spec is combination of policy type and admission mode.",
|
|
11414
11715
|
"x-f5xc-minimum-configuration": {
|
|
11415
11716
|
"description": "Minimum configuration for k8s_pod_security_admissionPodSecurityAdmissionSpec",
|
|
11416
11717
|
"required_fields": [
|
|
@@ -11505,6 +11806,8 @@
|
|
|
11505
11806
|
}
|
|
11506
11807
|
}
|
|
11507
11808
|
},
|
|
11809
|
+
"x-f5xc-description-short": "Replacing an k8s_pod_security_admission object will update the object by replacing the existing spec with the provided one.",
|
|
11810
|
+
"x-f5xc-description-medium": "Replacing an k8s_pod_security_admission object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
|
|
11508
11811
|
"x-f5xc-minimum-configuration": {
|
|
11509
11812
|
"description": "Minimum configuration for k8s_pod_security_admissionReplaceSpecType",
|
|
11510
11813
|
"required_fields": [
|
|
@@ -11558,6 +11861,7 @@
|
|
|
11558
11861
|
}
|
|
11559
11862
|
}
|
|
11560
11863
|
},
|
|
11864
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
11561
11865
|
"x-f5xc-minimum-configuration": {
|
|
11562
11866
|
"description": "Minimum configuration for k8s_pod_security_admissionStatusObject",
|
|
11563
11867
|
"required_fields": [
|
|
@@ -11604,6 +11908,7 @@
|
|
|
11604
11908
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
11605
11909
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
11606
11910
|
},
|
|
11911
|
+
"x-f5xc-description-short": "List of capabilities that docker container has. Required: YES.",
|
|
11607
11912
|
"x-f5xc-required-for": {
|
|
11608
11913
|
"minimum_config": false,
|
|
11609
11914
|
"create": false,
|
|
@@ -11612,6 +11917,7 @@
|
|
|
11612
11917
|
}
|
|
11613
11918
|
}
|
|
11614
11919
|
},
|
|
11920
|
+
"x-f5xc-description-short": "List of capabilities that docker container has.",
|
|
11615
11921
|
"x-f5xc-minimum-configuration": {
|
|
11616
11922
|
"description": "Minimum configuration for k8s_pod_security_policyCapabilityListType",
|
|
11617
11923
|
"required_fields": [
|
|
@@ -11703,6 +12009,7 @@
|
|
|
11703
12009
|
"ves.io.schema.rules.string.max_len": "4096",
|
|
11704
12010
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
11705
12011
|
},
|
|
12012
|
+
"x-f5xc-description-short": "Exclusive with [psp_spec] K8s YAML for Pod Security Policy.",
|
|
11706
12013
|
"minLength": 0,
|
|
11707
12014
|
"x-f5xc-required-for": {
|
|
11708
12015
|
"minimum_config": false,
|
|
@@ -11712,6 +12019,8 @@
|
|
|
11712
12019
|
}
|
|
11713
12020
|
}
|
|
11714
12021
|
},
|
|
12022
|
+
"x-f5xc-description-short": "Create k8s_pod_security_policy will create the object in the storage backend for namespace metadata.namespace.",
|
|
12023
|
+
"x-f5xc-description-medium": "Create k8s_pod_security_policy will create the object in the storage backend for namespace metadata.namespace.",
|
|
11715
12024
|
"x-f5xc-minimum-configuration": {
|
|
11716
12025
|
"description": "Minimum configuration for k8s_pod_security_policyCreateSpecType",
|
|
11717
12026
|
"required_fields": [
|
|
@@ -11738,6 +12047,7 @@
|
|
|
11738
12047
|
"title": "Fail_if_referred.",
|
|
11739
12048
|
"format": "boolean",
|
|
11740
12049
|
"x-displayname": "Fail-If-Referred.",
|
|
12050
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
11741
12051
|
"x-f5xc-required-for": {
|
|
11742
12052
|
"minimum_config": false,
|
|
11743
12053
|
"create": false,
|
|
@@ -11762,7 +12072,7 @@
|
|
|
11762
12072
|
},
|
|
11763
12073
|
"x-original-maxLength": 1024,
|
|
11764
12074
|
"x-reconciled-from-discovery": true,
|
|
11765
|
-
"x-reconciled-at": "2026-01-
|
|
12075
|
+
"x-reconciled-at": "2026-01-07T15:28:52.515713+00:00"
|
|
11766
12076
|
},
|
|
11767
12077
|
"namespace": {
|
|
11768
12078
|
"type": "string",
|
|
@@ -11771,6 +12081,7 @@
|
|
|
11771
12081
|
"x-displayname": "Namespace",
|
|
11772
12082
|
"x-ves-example": "Ns1",
|
|
11773
12083
|
"x-f5xc-example": "ns1",
|
|
12084
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
11774
12085
|
"minLength": 0,
|
|
11775
12086
|
"maxLength": 6,
|
|
11776
12087
|
"x-f5xc-required-for": {
|
|
@@ -11781,7 +12092,7 @@
|
|
|
11781
12092
|
},
|
|
11782
12093
|
"x-original-maxLength": 1024,
|
|
11783
12094
|
"x-reconciled-from-discovery": true,
|
|
11784
|
-
"x-reconciled-at": "2026-01-
|
|
12095
|
+
"x-reconciled-at": "2026-01-07T15:28:52.515720+00:00"
|
|
11785
12096
|
}
|
|
11786
12097
|
},
|
|
11787
12098
|
"x-f5xc-minimum-configuration": {
|
|
@@ -11816,6 +12127,7 @@
|
|
|
11816
12127
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11817
12128
|
},
|
|
11818
12129
|
"x-displayname": "Deleted Referred Objects.",
|
|
12130
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
11819
12131
|
"x-f5xc-required-for": {
|
|
11820
12132
|
"minimum_config": false,
|
|
11821
12133
|
"create": false,
|
|
@@ -11831,6 +12143,7 @@
|
|
|
11831
12143
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11832
12144
|
},
|
|
11833
12145
|
"x-displayname": "Disabled Referred Objects.",
|
|
12146
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
11834
12147
|
"x-f5xc-required-for": {
|
|
11835
12148
|
"minimum_config": false,
|
|
11836
12149
|
"create": false,
|
|
@@ -11849,6 +12162,7 @@
|
|
|
11849
12162
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
11850
12163
|
},
|
|
11851
12164
|
"x-displayname": "Referring Objects.",
|
|
12165
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
11852
12166
|
"x-f5xc-required-for": {
|
|
11853
12167
|
"minimum_config": false,
|
|
11854
12168
|
"create": false,
|
|
@@ -11870,6 +12184,8 @@
|
|
|
11870
12184
|
"$ref": "#/components/schemas/k8s_pod_security_policyStatusObject"
|
|
11871
12185
|
},
|
|
11872
12186
|
"x-displayname": "Status",
|
|
12187
|
+
"x-f5xc-example": "active",
|
|
12188
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
11873
12189
|
"x-f5xc-required-for": {
|
|
11874
12190
|
"minimum_config": false,
|
|
11875
12191
|
"create": false,
|
|
@@ -11879,7 +12195,7 @@
|
|
|
11879
12195
|
"maxLength": 17,
|
|
11880
12196
|
"minLength": 17,
|
|
11881
12197
|
"x-reconciled-from-discovery": true,
|
|
11882
|
-
"x-reconciled-at": "2026-01-
|
|
12198
|
+
"x-reconciled-at": "2026-01-07T15:28:52.515737+00:00"
|
|
11883
12199
|
},
|
|
11884
12200
|
"system_metadata": {
|
|
11885
12201
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -11919,6 +12235,8 @@
|
|
|
11919
12235
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
11920
12236
|
],
|
|
11921
12237
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
12238
|
+
"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...",
|
|
12239
|
+
"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...",
|
|
11922
12240
|
"x-f5xc-minimum-configuration": {
|
|
11923
12241
|
"description": "Minimum configuration for k8s_pod_security_policyGetResponseFormatCode",
|
|
11924
12242
|
"required_fields": [],
|
|
@@ -11953,6 +12271,7 @@
|
|
|
11953
12271
|
"ves.io.schema.rules.string.max_len": "4096",
|
|
11954
12272
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
11955
12273
|
},
|
|
12274
|
+
"x-f5xc-description-short": "Exclusive with [psp_spec] K8s YAML for Pod Security Policy.",
|
|
11956
12275
|
"minLength": 0,
|
|
11957
12276
|
"x-f5xc-required-for": {
|
|
11958
12277
|
"minimum_config": false,
|
|
@@ -11962,6 +12281,8 @@
|
|
|
11962
12281
|
}
|
|
11963
12282
|
}
|
|
11964
12283
|
},
|
|
12284
|
+
"x-f5xc-description-short": "GET k8s_pod_security_policy will GET the object from the storage backend for namespace metadata.namespace.",
|
|
12285
|
+
"x-f5xc-description-medium": "GET k8s_pod_security_policy will GET the object from the storage backend for namespace metadata.namespace.",
|
|
11965
12286
|
"x-f5xc-minimum-configuration": {
|
|
11966
12287
|
"description": "Minimum configuration for k8s_pod_security_policyGetSpecType",
|
|
11967
12288
|
"required_fields": [
|
|
@@ -12002,6 +12323,8 @@
|
|
|
12002
12323
|
"ves.io.schema.rules.string.max_len": "128",
|
|
12003
12324
|
"ves.io.schema.rules.string.min_len": "1"
|
|
12004
12325
|
},
|
|
12326
|
+
"x-f5xc-description-short": "Host path prefix is the path prefix that the host volume must match. It does not support *.",
|
|
12327
|
+
"x-f5xc-description-medium": "Host path prefix is the path prefix that the host volume must match. It does not support *. Required: YES.",
|
|
12005
12328
|
"x-f5xc-required-for": {
|
|
12006
12329
|
"minimum_config": false,
|
|
12007
12330
|
"create": false,
|
|
@@ -12015,6 +12338,7 @@
|
|
|
12015
12338
|
"title": "Read Only",
|
|
12016
12339
|
"format": "boolean",
|
|
12017
12340
|
"x-displayname": "Read Only",
|
|
12341
|
+
"x-f5xc-description-short": "Volume will be allowed to mount read only.",
|
|
12018
12342
|
"x-f5xc-required-for": {
|
|
12019
12343
|
"minimum_config": false,
|
|
12020
12344
|
"create": false,
|
|
@@ -12061,6 +12385,7 @@
|
|
|
12061
12385
|
"ves.io.schema.rules.uint32.gte": "1",
|
|
12062
12386
|
"ves.io.schema.rules.uint32.lte": "65535"
|
|
12063
12387
|
},
|
|
12388
|
+
"x-f5xc-description-short": "Ending(maximum) ID for for ID range Required: YES.",
|
|
12064
12389
|
"minimum": 0,
|
|
12065
12390
|
"maximum": 2147483647,
|
|
12066
12391
|
"x-f5xc-required-for": {
|
|
@@ -12090,6 +12415,7 @@
|
|
|
12090
12415
|
"ves.io.schema.rules.uint32.gte": "1",
|
|
12091
12416
|
"ves.io.schema.rules.uint32.lte": "65535"
|
|
12092
12417
|
},
|
|
12418
|
+
"x-f5xc-description-short": "Starting(minimum) ID for for ID range Required: YES.",
|
|
12093
12419
|
"minimum": 0,
|
|
12094
12420
|
"maximum": 2147483647,
|
|
12095
12421
|
"x-f5xc-required-for": {
|
|
@@ -12136,6 +12462,7 @@
|
|
|
12136
12462
|
"x-validation-rules": {
|
|
12137
12463
|
"ves.io.schema.rules.repeated.max_items": "16"
|
|
12138
12464
|
},
|
|
12465
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
12139
12466
|
"x-f5xc-required-for": {
|
|
12140
12467
|
"minimum_config": false,
|
|
12141
12468
|
"create": false,
|
|
@@ -12160,6 +12487,7 @@
|
|
|
12160
12487
|
"ves.io.schema.rules.string.max_bytes": "128",
|
|
12161
12488
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
12162
12489
|
},
|
|
12490
|
+
"x-f5xc-description-short": "Rule indicated how the FS group ID range is used.",
|
|
12163
12491
|
"x-f5xc-required-for": {
|
|
12164
12492
|
"minimum_config": false,
|
|
12165
12493
|
"create": false,
|
|
@@ -12196,6 +12524,7 @@
|
|
|
12196
12524
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
12197
12525
|
},
|
|
12198
12526
|
"x-displayname": "Errors",
|
|
12527
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
12199
12528
|
"x-f5xc-required-for": {
|
|
12200
12529
|
"minimum_config": false,
|
|
12201
12530
|
"create": false,
|
|
@@ -12211,6 +12540,8 @@
|
|
|
12211
12540
|
"$ref": "#/components/schemas/k8s_pod_security_policyListResponseItem"
|
|
12212
12541
|
},
|
|
12213
12542
|
"x-displayname": "Items",
|
|
12543
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
12544
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
12214
12545
|
"x-f5xc-required-for": {
|
|
12215
12546
|
"minimum_config": false,
|
|
12216
12547
|
"create": false,
|
|
@@ -12244,6 +12575,8 @@
|
|
|
12244
12575
|
"description": "The set of annotations present on this k8s_pod_security_policy.",
|
|
12245
12576
|
"title": "Annotations.",
|
|
12246
12577
|
"x-displayname": "Annotations.",
|
|
12578
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
12579
|
+
"x-f5xc-description-short": "The set of annotations present on this k8s_pod_security_policy.",
|
|
12247
12580
|
"x-f5xc-required-for": {
|
|
12248
12581
|
"minimum_config": false,
|
|
12249
12582
|
"create": false,
|
|
@@ -12256,6 +12589,7 @@
|
|
|
12256
12589
|
"description": "The description set for this k8s_pod_security_policy.",
|
|
12257
12590
|
"title": "Description.",
|
|
12258
12591
|
"x-displayname": "Description.",
|
|
12592
|
+
"x-f5xc-description-short": "The description set for this k8s_pod_security_policy.",
|
|
12259
12593
|
"minLength": 0,
|
|
12260
12594
|
"maxLength": 0,
|
|
12261
12595
|
"x-f5xc-required-for": {
|
|
@@ -12266,7 +12600,7 @@
|
|
|
12266
12600
|
},
|
|
12267
12601
|
"x-original-maxLength": 1024,
|
|
12268
12602
|
"x-reconciled-from-discovery": true,
|
|
12269
|
-
"x-reconciled-at": "2026-01-
|
|
12603
|
+
"x-reconciled-at": "2026-01-07T15:28:52.515763+00:00"
|
|
12270
12604
|
},
|
|
12271
12605
|
"disabled": {
|
|
12272
12606
|
"type": "boolean",
|
|
@@ -12274,6 +12608,8 @@
|
|
|
12274
12608
|
"title": "Disabled",
|
|
12275
12609
|
"format": "boolean",
|
|
12276
12610
|
"x-displayname": "Disabled",
|
|
12611
|
+
"x-f5xc-example": "True",
|
|
12612
|
+
"x-f5xc-description-short": "Value of true indicates k8s_pod_security_policy is administratively disabled.",
|
|
12277
12613
|
"x-f5xc-required-for": {
|
|
12278
12614
|
"minimum_config": false,
|
|
12279
12615
|
"create": false,
|
|
@@ -12289,6 +12625,8 @@
|
|
|
12289
12625
|
"description": "The set of labels present on this k8s_pod_security_policy.",
|
|
12290
12626
|
"title": "Labels",
|
|
12291
12627
|
"x-displayname": "Labels",
|
|
12628
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
12629
|
+
"x-f5xc-description-short": "The set of labels present on this k8s_pod_security_policy.",
|
|
12292
12630
|
"x-f5xc-required-for": {
|
|
12293
12631
|
"minimum_config": false,
|
|
12294
12632
|
"create": false,
|
|
@@ -12306,6 +12644,7 @@
|
|
|
12306
12644
|
"x-displayname": "Name",
|
|
12307
12645
|
"x-ves-example": "Name",
|
|
12308
12646
|
"x-f5xc-example": "name",
|
|
12647
|
+
"x-f5xc-description-short": "The name of this k8s_pod_security_policy.",
|
|
12309
12648
|
"minLength": 0,
|
|
12310
12649
|
"maxLength": 16,
|
|
12311
12650
|
"x-f5xc-required-for": {
|
|
@@ -12316,7 +12655,7 @@
|
|
|
12316
12655
|
},
|
|
12317
12656
|
"x-original-maxLength": 1024,
|
|
12318
12657
|
"x-reconciled-from-discovery": true,
|
|
12319
|
-
"x-reconciled-at": "2026-01-
|
|
12658
|
+
"x-reconciled-at": "2026-01-07T15:28:52.515774+00:00"
|
|
12320
12659
|
},
|
|
12321
12660
|
"namespace": {
|
|
12322
12661
|
"type": "string",
|
|
@@ -12335,7 +12674,7 @@
|
|
|
12335
12674
|
},
|
|
12336
12675
|
"x-original-maxLength": 1024,
|
|
12337
12676
|
"x-reconciled-from-discovery": true,
|
|
12338
|
-
"x-reconciled-at": "2026-01-
|
|
12677
|
+
"x-reconciled-at": "2026-01-07T15:28:52.515779+00:00"
|
|
12339
12678
|
},
|
|
12340
12679
|
"owner_view": {
|
|
12341
12680
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -12348,6 +12687,7 @@
|
|
|
12348
12687
|
"$ref": "#/components/schemas/k8s_pod_security_policyStatusObject"
|
|
12349
12688
|
},
|
|
12350
12689
|
"x-displayname": "Status",
|
|
12690
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
12351
12691
|
"x-f5xc-required-for": {
|
|
12352
12692
|
"minimum_config": false,
|
|
12353
12693
|
"create": false,
|
|
@@ -12376,7 +12716,7 @@
|
|
|
12376
12716
|
"x-field-mutability": "read-only",
|
|
12377
12717
|
"x-original-maxLength": 1024,
|
|
12378
12718
|
"x-reconciled-from-discovery": true,
|
|
12379
|
-
"x-reconciled-at": "2026-01-
|
|
12719
|
+
"x-reconciled-at": "2026-01-07T15:28:52.515787+00:00"
|
|
12380
12720
|
},
|
|
12381
12721
|
"uid": {
|
|
12382
12722
|
"type": "string",
|
|
@@ -12385,6 +12725,7 @@
|
|
|
12385
12725
|
"x-displayname": "UID",
|
|
12386
12726
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
12387
12727
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
12728
|
+
"x-f5xc-description-short": "The unique uid of this k8s_pod_security_policy.",
|
|
12388
12729
|
"minLength": 0,
|
|
12389
12730
|
"maxLength": 36,
|
|
12390
12731
|
"x-f5xc-required-for": {
|
|
@@ -12397,9 +12738,11 @@
|
|
|
12397
12738
|
"x-original-maxLength": 1024,
|
|
12398
12739
|
"format": "uuid",
|
|
12399
12740
|
"x-reconciled-from-discovery": true,
|
|
12400
|
-
"x-reconciled-at": "2026-01-
|
|
12741
|
+
"x-reconciled-at": "2026-01-07T15:28:52.515793+00:00"
|
|
12401
12742
|
}
|
|
12402
12743
|
},
|
|
12744
|
+
"x-f5xc-description-short": "By default a summary of k8s_pod_security_policy is returned in 'List'.",
|
|
12745
|
+
"x-f5xc-description-medium": "By default a summary of k8s_pod_security_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
12403
12746
|
"x-f5xc-minimum-configuration": {
|
|
12404
12747
|
"description": "Minimum configuration for k8s_pod_security_policyListResponseItem",
|
|
12405
12748
|
"required_fields": [
|
|
@@ -12446,6 +12789,7 @@
|
|
|
12446
12789
|
"title": "Allow Privilege Escalation.",
|
|
12447
12790
|
"format": "boolean",
|
|
12448
12791
|
"x-displayname": "Allow Privilege Escalation.",
|
|
12792
|
+
"x-f5xc-description-short": "Pod can request to privilege escalation.",
|
|
12449
12793
|
"x-f5xc-required-for": {
|
|
12450
12794
|
"minimum_config": false,
|
|
12451
12795
|
"create": false,
|
|
@@ -12481,6 +12825,7 @@
|
|
|
12481
12825
|
"ves.io.schema.rules.repeated.max_items": "8",
|
|
12482
12826
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12483
12827
|
},
|
|
12828
|
+
"x-f5xc-description-short": "Restrict the available CSI drivers for POD, default all drivers are available.",
|
|
12484
12829
|
"x-f5xc-required-for": {
|
|
12485
12830
|
"minimum_config": false,
|
|
12486
12831
|
"create": false,
|
|
@@ -12513,6 +12858,7 @@
|
|
|
12513
12858
|
"ves.io.schema.rules.repeated.max_items": "8",
|
|
12514
12859
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12515
12860
|
},
|
|
12861
|
+
"x-f5xc-description-short": "Restrict list of Flex volumes, default all volumes are allowed.",
|
|
12516
12862
|
"x-f5xc-required-for": {
|
|
12517
12863
|
"minimum_config": false,
|
|
12518
12864
|
"create": false,
|
|
@@ -12537,6 +12883,7 @@
|
|
|
12537
12883
|
"ves.io.schema.rules.repeated.max_items": "8",
|
|
12538
12884
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12539
12885
|
},
|
|
12886
|
+
"x-f5xc-description-short": "Restrict list of host paths, default all host paths are allowed.",
|
|
12540
12887
|
"x-f5xc-required-for": {
|
|
12541
12888
|
"minimum_config": false,
|
|
12542
12889
|
"create": false,
|
|
@@ -12563,6 +12910,7 @@
|
|
|
12563
12910
|
"ves.io.schema.rules.repeated.max_items": "8",
|
|
12564
12911
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12565
12912
|
},
|
|
12913
|
+
"x-f5xc-description-short": "Allowed list of proc mounts, empty list allows default proc mounts.",
|
|
12566
12914
|
"x-f5xc-required-for": {
|
|
12567
12915
|
"minimum_config": false,
|
|
12568
12916
|
"create": false,
|
|
@@ -12589,6 +12937,7 @@
|
|
|
12589
12937
|
"ves.io.schema.rules.repeated.max_items": "16",
|
|
12590
12938
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12591
12939
|
},
|
|
12940
|
+
"x-f5xc-description-short": "Allowed list of unsafe sysctls, empty list allows none. Supports prefix reg-ex.",
|
|
12592
12941
|
"x-f5xc-required-for": {
|
|
12593
12942
|
"minimum_config": false,
|
|
12594
12943
|
"create": false,
|
|
@@ -12602,6 +12951,7 @@
|
|
|
12602
12951
|
"title": "Default Allow Privilege Escalation.",
|
|
12603
12952
|
"format": "boolean",
|
|
12604
12953
|
"x-displayname": "Default Allow Privilege Escalation.",
|
|
12954
|
+
"x-f5xc-description-short": "Pod has permission for privilege escalation by default.",
|
|
12605
12955
|
"x-f5xc-required-for": {
|
|
12606
12956
|
"minimum_config": false,
|
|
12607
12957
|
"create": false,
|
|
@@ -12634,6 +12984,7 @@
|
|
|
12634
12984
|
"ves.io.schema.rules.repeated.max_items": "16",
|
|
12635
12985
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12636
12986
|
},
|
|
12987
|
+
"x-f5xc-description-short": "Forbidden list of sysctls, empty list forbids none. Supports prefix reg-ex.",
|
|
12637
12988
|
"x-f5xc-required-for": {
|
|
12638
12989
|
"minimum_config": false,
|
|
12639
12990
|
"create": false,
|
|
@@ -12650,6 +13001,7 @@
|
|
|
12650
13001
|
"title": "Host IPC",
|
|
12651
13002
|
"format": "boolean",
|
|
12652
13003
|
"x-displayname": "Host IPC",
|
|
13004
|
+
"x-f5xc-description-short": "Host IPC determines if the policy allows the use of host IPC in the pod spec.",
|
|
12653
13005
|
"x-f5xc-required-for": {
|
|
12654
13006
|
"minimum_config": false,
|
|
12655
13007
|
"create": false,
|
|
@@ -12663,6 +13015,7 @@
|
|
|
12663
13015
|
"title": "Host Network.",
|
|
12664
13016
|
"format": "boolean",
|
|
12665
13017
|
"x-displayname": "Host Network.",
|
|
13018
|
+
"x-f5xc-description-short": "Host Network determines if the policy allows the use of host network in the pod spec.",
|
|
12666
13019
|
"x-f5xc-required-for": {
|
|
12667
13020
|
"minimum_config": false,
|
|
12668
13021
|
"create": false,
|
|
@@ -12676,6 +13029,7 @@
|
|
|
12676
13029
|
"title": "Host PID",
|
|
12677
13030
|
"format": "boolean",
|
|
12678
13031
|
"x-displayname": "Host PID",
|
|
13032
|
+
"x-f5xc-description-short": "Host PID determines if the policy allows the use of host PID in the pod spec.",
|
|
12679
13033
|
"x-f5xc-required-for": {
|
|
12680
13034
|
"minimum_config": false,
|
|
12681
13035
|
"create": false,
|
|
@@ -12696,6 +13050,7 @@
|
|
|
12696
13050
|
"x-validation-rules": {
|
|
12697
13051
|
"ves.io.schema.rules.string.port_range_list": "true"
|
|
12698
13052
|
},
|
|
13053
|
+
"x-f5xc-description-short": "Host port ranges determines which ports ranges are allowed to be exposed.",
|
|
12699
13054
|
"minLength": 0,
|
|
12700
13055
|
"maxLength": 1024,
|
|
12701
13056
|
"x-f5xc-required-for": {
|
|
@@ -12738,6 +13093,7 @@
|
|
|
12738
13093
|
"title": "Privileged.",
|
|
12739
13094
|
"format": "boolean",
|
|
12740
13095
|
"x-displayname": "Privileged.",
|
|
13096
|
+
"x-f5xc-description-short": "Privileged determines if a pod can request to be run as privileged.",
|
|
12741
13097
|
"x-f5xc-required-for": {
|
|
12742
13098
|
"minimum_config": false,
|
|
12743
13099
|
"create": false,
|
|
@@ -12751,6 +13107,7 @@
|
|
|
12751
13107
|
"title": "Read Only Root Filesystem.",
|
|
12752
13108
|
"format": "boolean",
|
|
12753
13109
|
"x-displayname": "Read Only Root Filesystem.",
|
|
13110
|
+
"x-f5xc-description-short": "Containers can only run with read only root filesystem.",
|
|
12754
13111
|
"x-f5xc-required-for": {
|
|
12755
13112
|
"minimum_config": false,
|
|
12756
13113
|
"create": false,
|
|
@@ -12792,6 +13149,7 @@
|
|
|
12792
13149
|
"ves.io.schema.rules.repeated.max_items": "8",
|
|
12793
13150
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12794
13151
|
},
|
|
13152
|
+
"x-f5xc-description-short": "Allow List of volume plugins. Empty no volumes are allowed.",
|
|
12795
13153
|
"x-f5xc-required-for": {
|
|
12796
13154
|
"minimum_config": false,
|
|
12797
13155
|
"create": false,
|
|
@@ -12906,6 +13264,7 @@
|
|
|
12906
13264
|
"ves.io.schema.rules.string.max_len": "4096",
|
|
12907
13265
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
12908
13266
|
},
|
|
13267
|
+
"x-f5xc-description-short": "Exclusive with [psp_spec] K8s YAML for Pod Security Policy.",
|
|
12909
13268
|
"minLength": 0,
|
|
12910
13269
|
"x-f5xc-required-for": {
|
|
12911
13270
|
"minimum_config": false,
|
|
@@ -12915,6 +13274,8 @@
|
|
|
12915
13274
|
}
|
|
12916
13275
|
}
|
|
12917
13276
|
},
|
|
13277
|
+
"x-f5xc-description-short": "Replacing an k8s_pod_security_policy object will update the object by replacing the existing spec with the provided one.",
|
|
13278
|
+
"x-f5xc-description-medium": "Replacing an k8s_pod_security_policy object will update the object by replacing the existing spec with the provided one. For read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
|
|
12918
13279
|
"x-f5xc-minimum-configuration": {
|
|
12919
13280
|
"description": "Minimum configuration for k8s_pod_security_policyReplaceSpecType",
|
|
12920
13281
|
"required_fields": [
|
|
@@ -12941,6 +13302,7 @@
|
|
|
12941
13302
|
"type": "string"
|
|
12942
13303
|
},
|
|
12943
13304
|
"x-f5xc-example": "value",
|
|
13305
|
+
"x-f5xc-description-short": "X-displayName: \"Allowed Runtime Classes\" x-required List of allowed runtime class names.",
|
|
12944
13306
|
"x-f5xc-required-for": {
|
|
12945
13307
|
"minimum_config": false,
|
|
12946
13308
|
"create": false,
|
|
@@ -12953,6 +13315,7 @@
|
|
|
12953
13315
|
"description": "X-displayName: \"Default Runtime Class\"\ndescription.",
|
|
12954
13316
|
"title": "Default Runtime Class.",
|
|
12955
13317
|
"x-f5xc-example": "value",
|
|
13318
|
+
"x-f5xc-description-short": "X-displayName: \"Default Runtime Class\" description.",
|
|
12956
13319
|
"minLength": 0,
|
|
12957
13320
|
"maxLength": 1024,
|
|
12958
13321
|
"x-f5xc-required-for": {
|
|
@@ -12963,6 +13326,7 @@
|
|
|
12963
13326
|
}
|
|
12964
13327
|
}
|
|
12965
13328
|
},
|
|
13329
|
+
"x-f5xc-description-short": "X-displayName: \"Runtime Class Strategy\" Allowed runtime classes.",
|
|
12966
13330
|
"x-f5xc-minimum-configuration": {
|
|
12967
13331
|
"description": "Minimum configuration for k8s_pod_security_policyRuntimeClassStrategyOptions",
|
|
12968
13332
|
"required_fields": [
|
|
@@ -12986,6 +13350,7 @@
|
|
|
12986
13350
|
"description": "X-displayName: \"SE Linux Level\"\nRun as SE linux level label.",
|
|
12987
13351
|
"title": "SE Linux Level.",
|
|
12988
13352
|
"x-f5xc-example": "secret",
|
|
13353
|
+
"x-f5xc-description-short": "X-displayName: \"SE Linux Level\" Run as SE linux level label.",
|
|
12989
13354
|
"minLength": 0,
|
|
12990
13355
|
"maxLength": 1024,
|
|
12991
13356
|
"x-f5xc-required-for": {
|
|
@@ -13000,6 +13365,7 @@
|
|
|
13000
13365
|
"description": "X-displayName: \"SE Linux Role\"\nRun as SE linux label.",
|
|
13001
13366
|
"title": "SE Linux Role.",
|
|
13002
13367
|
"x-f5xc-example": "admin_r",
|
|
13368
|
+
"x-f5xc-description-short": "X-displayName: \"SE Linux Role\" Run as SE linux label.",
|
|
13003
13369
|
"minLength": 0,
|
|
13004
13370
|
"maxLength": 1024,
|
|
13005
13371
|
"x-f5xc-required-for": {
|
|
@@ -13014,6 +13380,7 @@
|
|
|
13014
13380
|
"description": "X-displayName: \"Rule\"\nRule indicated how the FS group ID range is used.",
|
|
13015
13381
|
"title": "Rule",
|
|
13016
13382
|
"x-f5xc-example": "MustRunAs",
|
|
13383
|
+
"x-f5xc-description-short": "X-displayName: \"Rule\" Rule indicated how the FS group ID range is used.",
|
|
13017
13384
|
"minLength": 0,
|
|
13018
13385
|
"maxLength": 1024,
|
|
13019
13386
|
"x-f5xc-required-for": {
|
|
@@ -13028,6 +13395,7 @@
|
|
|
13028
13395
|
"description": "X-displayName: \"SE Linux Type\"\nRun as SE linux type label.",
|
|
13029
13396
|
"title": "SE Linux Type.",
|
|
13030
13397
|
"x-f5xc-example": "admin_t",
|
|
13398
|
+
"x-f5xc-description-short": "X-displayName: \"SE Linux Type\" Run as SE linux type label.",
|
|
13031
13399
|
"minLength": 0,
|
|
13032
13400
|
"maxLength": 1024,
|
|
13033
13401
|
"x-f5xc-required-for": {
|
|
@@ -13042,6 +13410,7 @@
|
|
|
13042
13410
|
"description": "X-displayName: \"SE Linux User\"\nRun as SE linux user label.",
|
|
13043
13411
|
"title": "SE Linux User.",
|
|
13044
13412
|
"x-f5xc-example": "system_u",
|
|
13413
|
+
"x-f5xc-description-short": "X-displayName: \"SE Linux User\" Run as SE linux user label.",
|
|
13045
13414
|
"minLength": 0,
|
|
13046
13415
|
"maxLength": 1024,
|
|
13047
13416
|
"x-f5xc-required-for": {
|
|
@@ -13109,6 +13478,7 @@
|
|
|
13109
13478
|
}
|
|
13110
13479
|
}
|
|
13111
13480
|
},
|
|
13481
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
13112
13482
|
"x-f5xc-minimum-configuration": {
|
|
13113
13483
|
"description": "Minimum configuration for k8s_pod_security_policyStatusObject",
|
|
13114
13484
|
"required_fields": [
|