@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.20-2601072244
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/README.md +23 -0
- package/dist/config/paths.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +179 -1582
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2 -265
- package/dist/version.d.ts +2 -2
- package/dist/version.js +2 -2
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +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": "Data And Privacy Security",
|
|
5
5
|
"description": "Pattern-based detection for personally identifiable information across request and response payloads. Custom data type definitions enable organization-specific classification beyond built-in PII categories. Regional log and metrics aggregation with Clickhouse, Elasticsearch, and Kafka export options. Geo-configuration policies enforce data residency requirements and jurisdiction-specific privacy regulations.",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.20",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -3217,6 +3217,8 @@
|
|
|
3217
3217
|
"ves.io.schema.rules.repeated.max_items": "17",
|
|
3218
3218
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
3219
3219
|
},
|
|
3220
|
+
"x-f5xc-description-short": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints...",
|
|
3221
|
+
"x-f5xc-description-medium": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach.",
|
|
3220
3222
|
"x-f5xc-required-for": {
|
|
3221
3223
|
"minimum_config": false,
|
|
3222
3224
|
"create": false,
|
|
@@ -3229,6 +3231,7 @@
|
|
|
3229
3231
|
"description": "Select this option to classify the custom data type as personally identifiable information (PII)",
|
|
3230
3232
|
"format": "boolean",
|
|
3231
3233
|
"x-displayname": "Mark as PII.",
|
|
3234
|
+
"x-f5xc-description-short": "Select this option to classify the custom data type as personally identifiable information (PII).",
|
|
3232
3235
|
"x-f5xc-required-for": {
|
|
3233
3236
|
"minimum_config": false,
|
|
3234
3237
|
"create": false,
|
|
@@ -3241,6 +3244,9 @@
|
|
|
3241
3244
|
"description": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
|
|
3242
3245
|
"format": "boolean",
|
|
3243
3246
|
"x-displayname": "Mark as Sensitive Data.",
|
|
3247
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
3248
|
+
"x-f5xc-description-short": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
|
|
3249
|
+
"x-f5xc-description-medium": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
|
|
3244
3250
|
"x-f5xc-required-for": {
|
|
3245
3251
|
"minimum_config": false,
|
|
3246
3252
|
"create": false,
|
|
@@ -3272,6 +3278,8 @@
|
|
|
3272
3278
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
3273
3279
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
3274
3280
|
},
|
|
3281
|
+
"x-f5xc-description-short": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
|
|
3282
|
+
"x-f5xc-description-medium": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
|
|
3275
3283
|
"x-f5xc-required-for": {
|
|
3276
3284
|
"minimum_config": false,
|
|
3277
3285
|
"create": false,
|
|
@@ -3280,6 +3288,7 @@
|
|
|
3280
3288
|
}
|
|
3281
3289
|
}
|
|
3282
3290
|
},
|
|
3291
|
+
"x-f5xc-description-short": "Create data_type creates a new object in the storage backend for metadata.namespace.",
|
|
3283
3292
|
"x-f5xc-minimum-configuration": {
|
|
3284
3293
|
"description": "Minimum configuration for data_typeCreateSpecType",
|
|
3285
3294
|
"required_fields": [
|
|
@@ -3308,6 +3317,7 @@
|
|
|
3308
3317
|
"title": "Fail_if_referred.",
|
|
3309
3318
|
"format": "boolean",
|
|
3310
3319
|
"x-displayname": "Fail-If-Referred.",
|
|
3320
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
3311
3321
|
"x-f5xc-required-for": {
|
|
3312
3322
|
"minimum_config": false,
|
|
3313
3323
|
"create": false,
|
|
@@ -3332,7 +3342,7 @@
|
|
|
3332
3342
|
},
|
|
3333
3343
|
"x-original-maxLength": 1024,
|
|
3334
3344
|
"x-reconciled-from-discovery": true,
|
|
3335
|
-
"x-reconciled-at": "2026-01-
|
|
3345
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225384+00:00"
|
|
3336
3346
|
},
|
|
3337
3347
|
"namespace": {
|
|
3338
3348
|
"type": "string",
|
|
@@ -3341,6 +3351,7 @@
|
|
|
3341
3351
|
"x-displayname": "Namespace",
|
|
3342
3352
|
"x-ves-example": "Ns1",
|
|
3343
3353
|
"x-f5xc-example": "ns1",
|
|
3354
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
3344
3355
|
"minLength": 0,
|
|
3345
3356
|
"maxLength": 6,
|
|
3346
3357
|
"x-f5xc-required-for": {
|
|
@@ -3351,7 +3362,7 @@
|
|
|
3351
3362
|
},
|
|
3352
3363
|
"x-original-maxLength": 1024,
|
|
3353
3364
|
"x-reconciled-from-discovery": true,
|
|
3354
|
-
"x-reconciled-at": "2026-01-
|
|
3365
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225391+00:00"
|
|
3355
3366
|
}
|
|
3356
3367
|
},
|
|
3357
3368
|
"x-f5xc-minimum-configuration": {
|
|
@@ -3386,6 +3397,7 @@
|
|
|
3386
3397
|
"$ref": "#/components/schemas/data_typeRulePatternType"
|
|
3387
3398
|
}
|
|
3388
3399
|
},
|
|
3400
|
+
"x-f5xc-description-short": "The detection rule specifies patterns and values to detect data type by.",
|
|
3389
3401
|
"x-f5xc-minimum-configuration": {
|
|
3390
3402
|
"description": "Minimum configuration for data_typeDetectionRule",
|
|
3391
3403
|
"required_fields": [
|
|
@@ -3429,6 +3441,7 @@
|
|
|
3429
3441
|
"ves.io.schema.rules.repeated.items.string.max_bytes": "1024",
|
|
3430
3442
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
3431
3443
|
},
|
|
3444
|
+
"x-f5xc-description-short": "List of exact values to match. Required: YES.",
|
|
3432
3445
|
"x-f5xc-required-for": {
|
|
3433
3446
|
"minimum_config": false,
|
|
3434
3447
|
"create": false,
|
|
@@ -3467,6 +3480,7 @@
|
|
|
3467
3480
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
3468
3481
|
},
|
|
3469
3482
|
"x-displayname": "Deleted Referred Objects.",
|
|
3483
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
3470
3484
|
"x-f5xc-required-for": {
|
|
3471
3485
|
"minimum_config": false,
|
|
3472
3486
|
"create": false,
|
|
@@ -3482,6 +3496,7 @@
|
|
|
3482
3496
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
3483
3497
|
},
|
|
3484
3498
|
"x-displayname": "Disabled Referred Objects.",
|
|
3499
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
3485
3500
|
"x-f5xc-required-for": {
|
|
3486
3501
|
"minimum_config": false,
|
|
3487
3502
|
"create": false,
|
|
@@ -3500,6 +3515,7 @@
|
|
|
3500
3515
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
3501
3516
|
},
|
|
3502
3517
|
"x-displayname": "Referring Objects.",
|
|
3518
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
3503
3519
|
"x-f5xc-required-for": {
|
|
3504
3520
|
"minimum_config": false,
|
|
3505
3521
|
"create": false,
|
|
@@ -3521,6 +3537,8 @@
|
|
|
3521
3537
|
"$ref": "#/components/schemas/data_typeStatusObject"
|
|
3522
3538
|
},
|
|
3523
3539
|
"x-displayname": "Status",
|
|
3540
|
+
"x-f5xc-example": "active",
|
|
3541
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
3524
3542
|
"x-f5xc-required-for": {
|
|
3525
3543
|
"minimum_config": false,
|
|
3526
3544
|
"create": false,
|
|
@@ -3530,7 +3548,7 @@
|
|
|
3530
3548
|
"maxLength": 17,
|
|
3531
3549
|
"minLength": 17,
|
|
3532
3550
|
"x-reconciled-from-discovery": true,
|
|
3533
|
-
"x-reconciled-at": "2026-01-
|
|
3551
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225413+00:00"
|
|
3534
3552
|
},
|
|
3535
3553
|
"system_metadata": {
|
|
3536
3554
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -3570,6 +3588,8 @@
|
|
|
3570
3588
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
3571
3589
|
],
|
|
3572
3590
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
3591
|
+
"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...",
|
|
3592
|
+
"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...",
|
|
3573
3593
|
"x-f5xc-minimum-configuration": {
|
|
3574
3594
|
"description": "Minimum configuration for data_typeGetResponseFormatCode",
|
|
3575
3595
|
"required_fields": [],
|
|
@@ -3607,6 +3627,8 @@
|
|
|
3607
3627
|
"ves.io.schema.rules.repeated.max_items": "17",
|
|
3608
3628
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
3609
3629
|
},
|
|
3630
|
+
"x-f5xc-description-short": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints...",
|
|
3631
|
+
"x-f5xc-description-medium": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach.",
|
|
3610
3632
|
"x-f5xc-required-for": {
|
|
3611
3633
|
"minimum_config": false,
|
|
3612
3634
|
"create": false,
|
|
@@ -3619,6 +3641,7 @@
|
|
|
3619
3641
|
"description": "Select this option to classify the custom data type as personally identifiable information (PII)",
|
|
3620
3642
|
"format": "boolean",
|
|
3621
3643
|
"x-displayname": "Mark as PII.",
|
|
3644
|
+
"x-f5xc-description-short": "Select this option to classify the custom data type as personally identifiable information (PII).",
|
|
3622
3645
|
"x-f5xc-required-for": {
|
|
3623
3646
|
"minimum_config": false,
|
|
3624
3647
|
"create": false,
|
|
@@ -3631,6 +3654,9 @@
|
|
|
3631
3654
|
"description": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
|
|
3632
3655
|
"format": "boolean",
|
|
3633
3656
|
"x-displayname": "Mark as Sensitive Data.",
|
|
3657
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
3658
|
+
"x-f5xc-description-short": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
|
|
3659
|
+
"x-f5xc-description-medium": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
|
|
3634
3660
|
"x-f5xc-required-for": {
|
|
3635
3661
|
"minimum_config": false,
|
|
3636
3662
|
"create": false,
|
|
@@ -3662,6 +3688,8 @@
|
|
|
3662
3688
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
3663
3689
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
3664
3690
|
},
|
|
3691
|
+
"x-f5xc-description-short": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
|
|
3692
|
+
"x-f5xc-description-medium": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
|
|
3665
3693
|
"x-f5xc-required-for": {
|
|
3666
3694
|
"minimum_config": false,
|
|
3667
3695
|
"create": false,
|
|
@@ -3673,6 +3701,7 @@
|
|
|
3673
3701
|
"$ref": "#/components/schemas/data_typeOriginType"
|
|
3674
3702
|
}
|
|
3675
3703
|
},
|
|
3704
|
+
"x-f5xc-description-short": "GET data_type reads a given object from storage backend for metadata.namespace.",
|
|
3676
3705
|
"x-f5xc-minimum-configuration": {
|
|
3677
3706
|
"description": "Minimum configuration for data_typeGetSpecType",
|
|
3678
3707
|
"required_fields": [
|
|
@@ -3703,6 +3732,7 @@
|
|
|
3703
3732
|
"$ref": "#/components/schemas/data_typeRulePatternType"
|
|
3704
3733
|
}
|
|
3705
3734
|
},
|
|
3735
|
+
"x-f5xc-description-short": "Search for specific key & value patterns in the specified sections.",
|
|
3706
3736
|
"x-f5xc-minimum-configuration": {
|
|
3707
3737
|
"description": "Minimum configuration for data_typeKeyValuePattern",
|
|
3708
3738
|
"required_fields": [
|
|
@@ -3731,6 +3761,7 @@
|
|
|
3731
3761
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
3732
3762
|
},
|
|
3733
3763
|
"x-displayname": "Errors",
|
|
3764
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
3734
3765
|
"x-f5xc-required-for": {
|
|
3735
3766
|
"minimum_config": false,
|
|
3736
3767
|
"create": false,
|
|
@@ -3746,6 +3777,8 @@
|
|
|
3746
3777
|
"$ref": "#/components/schemas/data_typeListResponseItem"
|
|
3747
3778
|
},
|
|
3748
3779
|
"x-displayname": "Items",
|
|
3780
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
3781
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
3749
3782
|
"x-f5xc-required-for": {
|
|
3750
3783
|
"minimum_config": false,
|
|
3751
3784
|
"create": false,
|
|
@@ -3779,6 +3812,8 @@
|
|
|
3779
3812
|
"description": "The set of annotations present on this data_type.",
|
|
3780
3813
|
"title": "Annotations.",
|
|
3781
3814
|
"x-displayname": "Annotations.",
|
|
3815
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
3816
|
+
"x-f5xc-description-short": "The set of annotations present on this data_type.",
|
|
3782
3817
|
"x-f5xc-required-for": {
|
|
3783
3818
|
"minimum_config": false,
|
|
3784
3819
|
"create": false,
|
|
@@ -3801,7 +3836,7 @@
|
|
|
3801
3836
|
},
|
|
3802
3837
|
"x-original-maxLength": 1024,
|
|
3803
3838
|
"x-reconciled-from-discovery": true,
|
|
3804
|
-
"x-reconciled-at": "2026-01-
|
|
3839
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225436+00:00"
|
|
3805
3840
|
},
|
|
3806
3841
|
"disabled": {
|
|
3807
3842
|
"type": "boolean",
|
|
@@ -3809,6 +3844,8 @@
|
|
|
3809
3844
|
"title": "Disabled",
|
|
3810
3845
|
"format": "boolean",
|
|
3811
3846
|
"x-displayname": "Disabled",
|
|
3847
|
+
"x-f5xc-example": "True",
|
|
3848
|
+
"x-f5xc-description-short": "Value of true indicates data_type is administratively disabled.",
|
|
3812
3849
|
"x-f5xc-required-for": {
|
|
3813
3850
|
"minimum_config": false,
|
|
3814
3851
|
"create": false,
|
|
@@ -3824,6 +3861,8 @@
|
|
|
3824
3861
|
"description": "The set of labels present on this data_type.",
|
|
3825
3862
|
"title": "Labels",
|
|
3826
3863
|
"x-displayname": "Labels",
|
|
3864
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
3865
|
+
"x-f5xc-description-short": "The set of labels present on this data_type.",
|
|
3827
3866
|
"x-f5xc-required-for": {
|
|
3828
3867
|
"minimum_config": false,
|
|
3829
3868
|
"create": false,
|
|
@@ -3851,7 +3890,7 @@
|
|
|
3851
3890
|
},
|
|
3852
3891
|
"x-original-maxLength": 1024,
|
|
3853
3892
|
"x-reconciled-from-discovery": true,
|
|
3854
|
-
"x-reconciled-at": "2026-01-
|
|
3893
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225446+00:00"
|
|
3855
3894
|
},
|
|
3856
3895
|
"namespace": {
|
|
3857
3896
|
"type": "string",
|
|
@@ -3870,7 +3909,7 @@
|
|
|
3870
3909
|
},
|
|
3871
3910
|
"x-original-maxLength": 1024,
|
|
3872
3911
|
"x-reconciled-from-discovery": true,
|
|
3873
|
-
"x-reconciled-at": "2026-01-
|
|
3912
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225450+00:00"
|
|
3874
3913
|
},
|
|
3875
3914
|
"owner_view": {
|
|
3876
3915
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -3883,6 +3922,7 @@
|
|
|
3883
3922
|
"$ref": "#/components/schemas/data_typeStatusObject"
|
|
3884
3923
|
},
|
|
3885
3924
|
"x-displayname": "Status",
|
|
3925
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
3886
3926
|
"x-f5xc-required-for": {
|
|
3887
3927
|
"minimum_config": false,
|
|
3888
3928
|
"create": false,
|
|
@@ -3911,7 +3951,7 @@
|
|
|
3911
3951
|
"x-field-mutability": "read-only",
|
|
3912
3952
|
"x-original-maxLength": 1024,
|
|
3913
3953
|
"x-reconciled-from-discovery": true,
|
|
3914
|
-
"x-reconciled-at": "2026-01-
|
|
3954
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225458+00:00"
|
|
3915
3955
|
},
|
|
3916
3956
|
"uid": {
|
|
3917
3957
|
"type": "string",
|
|
@@ -3932,9 +3972,11 @@
|
|
|
3932
3972
|
"x-original-maxLength": 1024,
|
|
3933
3973
|
"format": "uuid",
|
|
3934
3974
|
"x-reconciled-from-discovery": true,
|
|
3935
|
-
"x-reconciled-at": "2026-01-
|
|
3975
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225464+00:00"
|
|
3936
3976
|
}
|
|
3937
3977
|
},
|
|
3978
|
+
"x-f5xc-description-short": "By default a summary of data_type is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
3979
|
+
"x-f5xc-description-medium": "By default a summary of data_type is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
3938
3980
|
"x-f5xc-minimum-configuration": {
|
|
3939
3981
|
"description": "Minimum configuration for data_typeListResponseItem",
|
|
3940
3982
|
"required_fields": [
|
|
@@ -4051,6 +4093,8 @@
|
|
|
4051
4093
|
"ves.io.schema.rules.repeated.max_items": "17",
|
|
4052
4094
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
4053
4095
|
},
|
|
4096
|
+
"x-f5xc-description-short": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints...",
|
|
4097
|
+
"x-f5xc-description-medium": "Choose applicable compliance frameworks such as GDPR, PCI/DSS, or CCPA to ensure the platform identifies whether vulnerabilities in API endpoints handling this data type may cause a compliance breach.",
|
|
4054
4098
|
"x-f5xc-required-for": {
|
|
4055
4099
|
"minimum_config": false,
|
|
4056
4100
|
"create": false,
|
|
@@ -4063,6 +4107,7 @@
|
|
|
4063
4107
|
"description": "Select this option to classify the custom data type as personally identifiable information (PII)",
|
|
4064
4108
|
"format": "boolean",
|
|
4065
4109
|
"x-displayname": "Mark as PII.",
|
|
4110
|
+
"x-f5xc-description-short": "Select this option to classify the custom data type as personally identifiable information (PII).",
|
|
4066
4111
|
"x-f5xc-required-for": {
|
|
4067
4112
|
"minimum_config": false,
|
|
4068
4113
|
"create": false,
|
|
@@ -4075,6 +4120,9 @@
|
|
|
4075
4120
|
"description": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
|
|
4076
4121
|
"format": "boolean",
|
|
4077
4122
|
"x-displayname": "Mark as Sensitive Data.",
|
|
4123
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
4124
|
+
"x-f5xc-description-short": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
|
|
4125
|
+
"x-f5xc-description-medium": "Select this option to classify the custom data type as sensitive, enabling detection of API vulnerabilities related to this data type.",
|
|
4078
4126
|
"x-f5xc-required-for": {
|
|
4079
4127
|
"minimum_config": false,
|
|
4080
4128
|
"create": false,
|
|
@@ -4106,6 +4154,8 @@
|
|
|
4106
4154
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
4107
4155
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
4108
4156
|
},
|
|
4157
|
+
"x-f5xc-description-short": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
|
|
4158
|
+
"x-f5xc-description-medium": "Configure key/value or regex match rules to enable the platform to detect this custom data type in the API request or response Required: YES.",
|
|
4109
4159
|
"x-f5xc-required-for": {
|
|
4110
4160
|
"minimum_config": false,
|
|
4111
4161
|
"create": false,
|
|
@@ -4114,6 +4164,7 @@
|
|
|
4114
4164
|
}
|
|
4115
4165
|
}
|
|
4116
4166
|
},
|
|
4167
|
+
"x-f5xc-description-short": "Replace data_type replaces an existing object in the storage backend for metadata.namespace.",
|
|
4117
4168
|
"x-f5xc-minimum-configuration": {
|
|
4118
4169
|
"description": "Minimum configuration for data_typeReplaceSpecType",
|
|
4119
4170
|
"required_fields": [
|
|
@@ -4156,6 +4207,7 @@
|
|
|
4156
4207
|
"ves.io.schema.rules.string.max_bytes": "1024",
|
|
4157
4208
|
"ves.io.schema.rules.string.regex": "true"
|
|
4158
4209
|
},
|
|
4210
|
+
"x-f5xc-description-short": "Exclusive with [exact_values substring_value] Search for values matching this regular expression.",
|
|
4159
4211
|
"minLength": 0,
|
|
4160
4212
|
"x-f5xc-required-for": {
|
|
4161
4213
|
"minimum_config": false,
|
|
@@ -4178,6 +4230,7 @@
|
|
|
4178
4230
|
"x-validation-rules": {
|
|
4179
4231
|
"ves.io.schema.rules.string.max_bytes": "1024"
|
|
4180
4232
|
},
|
|
4233
|
+
"x-f5xc-description-short": "Exclusive with [exact_values regex_value] Search for values that include this substring.",
|
|
4181
4234
|
"minLength": 0,
|
|
4182
4235
|
"x-f5xc-required-for": {
|
|
4183
4236
|
"minimum_config": false,
|
|
@@ -4215,6 +4268,7 @@
|
|
|
4215
4268
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
4216
4269
|
},
|
|
4217
4270
|
"x-displayname": "Conditions.",
|
|
4271
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
4218
4272
|
"x-f5xc-required-for": {
|
|
4219
4273
|
"minimum_config": false,
|
|
4220
4274
|
"create": false,
|
|
@@ -4261,6 +4315,7 @@
|
|
|
4261
4315
|
"title": "Empty",
|
|
4262
4316
|
"x-displayname": "Empty",
|
|
4263
4317
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
4318
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
4264
4319
|
"x-f5xc-minimum-configuration": {
|
|
4265
4320
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
4266
4321
|
"required_fields": [],
|
|
@@ -4278,6 +4333,8 @@
|
|
|
4278
4333
|
"type_url": {
|
|
4279
4334
|
"type": "string",
|
|
4280
4335
|
"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.",
|
|
4336
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
4337
|
+
"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 ).",
|
|
4281
4338
|
"minLength": 0,
|
|
4282
4339
|
"maxLength": 1024,
|
|
4283
4340
|
"x-f5xc-required-for": {
|
|
@@ -4301,9 +4358,11 @@
|
|
|
4301
4358
|
},
|
|
4302
4359
|
"x-original-maxLength": 1024,
|
|
4303
4360
|
"x-reconciled-from-discovery": true,
|
|
4304
|
-
"x-reconciled-at": "2026-01-
|
|
4361
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225493+00:00"
|
|
4305
4362
|
}
|
|
4306
4363
|
},
|
|
4364
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
4365
|
+
"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...",
|
|
4307
4366
|
"x-f5xc-minimum-configuration": {
|
|
4308
4367
|
"description": "Minimum configuration for protobufAny",
|
|
4309
4368
|
"required_fields": [
|
|
@@ -4329,6 +4388,8 @@
|
|
|
4329
4388
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
4330
4389
|
"title": "Hostname",
|
|
4331
4390
|
"x-displayname": "Hostname",
|
|
4391
|
+
"x-f5xc-example": "example-resource",
|
|
4392
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
4332
4393
|
"minLength": 0,
|
|
4333
4394
|
"maxLength": 1024,
|
|
4334
4395
|
"x-f5xc-required-for": {
|
|
@@ -4360,6 +4421,8 @@
|
|
|
4360
4421
|
"x-displayname": "Reason",
|
|
4361
4422
|
"x-ves-example": "Value",
|
|
4362
4423
|
"x-f5xc-example": "value",
|
|
4424
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
4425
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
4363
4426
|
"minLength": 0,
|
|
4364
4427
|
"maxLength": 43,
|
|
4365
4428
|
"x-f5xc-required-for": {
|
|
@@ -4370,13 +4433,15 @@
|
|
|
4370
4433
|
},
|
|
4371
4434
|
"x-original-maxLength": 1024,
|
|
4372
4435
|
"x-reconciled-from-discovery": true,
|
|
4373
|
-
"x-reconciled-at": "2026-01-
|
|
4436
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225502+00:00"
|
|
4374
4437
|
},
|
|
4375
4438
|
"service_name": {
|
|
4376
4439
|
"type": "string",
|
|
4377
4440
|
"description": "Name of the service that sent the status.",
|
|
4378
4441
|
"title": "Service name.",
|
|
4379
4442
|
"x-displayname": "Service Name.",
|
|
4443
|
+
"x-f5xc-example": "example-resource",
|
|
4444
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
4380
4445
|
"minLength": 0,
|
|
4381
4446
|
"maxLength": 1024,
|
|
4382
4447
|
"x-f5xc-required-for": {
|
|
@@ -4399,6 +4464,8 @@
|
|
|
4399
4464
|
"x-validation-rules": {
|
|
4400
4465
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
4401
4466
|
},
|
|
4467
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
4468
|
+
"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...",
|
|
4402
4469
|
"minLength": 0,
|
|
4403
4470
|
"maxLength": 17,
|
|
4404
4471
|
"x-f5xc-required-for": {
|
|
@@ -4409,7 +4476,7 @@
|
|
|
4409
4476
|
},
|
|
4410
4477
|
"x-original-maxLength": 1024,
|
|
4411
4478
|
"x-reconciled-from-discovery": true,
|
|
4412
|
-
"x-reconciled-at": "2026-01-
|
|
4479
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225508+00:00"
|
|
4413
4480
|
},
|
|
4414
4481
|
"type": {
|
|
4415
4482
|
"type": "string",
|
|
@@ -4424,6 +4491,8 @@
|
|
|
4424
4491
|
"x-validation-rules": {
|
|
4425
4492
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
4426
4493
|
},
|
|
4494
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
4495
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
4427
4496
|
"minLength": 0,
|
|
4428
4497
|
"maxLength": 1024,
|
|
4429
4498
|
"x-f5xc-required-for": {
|
|
@@ -4434,6 +4503,8 @@
|
|
|
4434
4503
|
}
|
|
4435
4504
|
}
|
|
4436
4505
|
},
|
|
4506
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
4507
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
4437
4508
|
"x-f5xc-minimum-configuration": {
|
|
4438
4509
|
"description": "Minimum configuration for schemaConditionType",
|
|
4439
4510
|
"required_fields": [
|
|
@@ -4469,6 +4540,8 @@
|
|
|
4469
4540
|
"default": "EOK",
|
|
4470
4541
|
"x-displayname": "Error Code.",
|
|
4471
4542
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
4543
|
+
"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...",
|
|
4544
|
+
"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...",
|
|
4472
4545
|
"x-f5xc-minimum-configuration": {
|
|
4473
4546
|
"description": "Minimum configuration for schemaErrorCode",
|
|
4474
4547
|
"required_fields": [],
|
|
@@ -4509,6 +4582,7 @@
|
|
|
4509
4582
|
}
|
|
4510
4583
|
}
|
|
4511
4584
|
},
|
|
4585
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
4512
4586
|
"x-f5xc-minimum-configuration": {
|
|
4513
4587
|
"description": "Minimum configuration for schemaErrorType",
|
|
4514
4588
|
"required_fields": [
|
|
@@ -4536,6 +4610,7 @@
|
|
|
4536
4610
|
"title": "Name",
|
|
4537
4611
|
"x-displayname": "Name",
|
|
4538
4612
|
"x-f5xc-example": "example-resource",
|
|
4613
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
4539
4614
|
"minLength": 0,
|
|
4540
4615
|
"maxLength": 16,
|
|
4541
4616
|
"x-f5xc-required-for": {
|
|
@@ -4546,9 +4621,10 @@
|
|
|
4546
4621
|
},
|
|
4547
4622
|
"x-original-maxLength": 1024,
|
|
4548
4623
|
"x-reconciled-from-discovery": true,
|
|
4549
|
-
"x-reconciled-at": "2026-01-
|
|
4624
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225520+00:00"
|
|
4550
4625
|
}
|
|
4551
4626
|
},
|
|
4627
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
4552
4628
|
"x-f5xc-minimum-configuration": {
|
|
4553
4629
|
"description": "Minimum configuration for schemaInitializerType",
|
|
4554
4630
|
"required_fields": [
|
|
@@ -4576,6 +4652,8 @@
|
|
|
4576
4652
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
4577
4653
|
},
|
|
4578
4654
|
"x-displayname": "Pending",
|
|
4655
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
4656
|
+
"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.",
|
|
4579
4657
|
"x-f5xc-required-for": {
|
|
4580
4658
|
"minimum_config": false,
|
|
4581
4659
|
"create": false,
|
|
@@ -4587,6 +4665,7 @@
|
|
|
4587
4665
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
4588
4666
|
}
|
|
4589
4667
|
},
|
|
4668
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
4590
4669
|
"x-f5xc-minimum-configuration": {
|
|
4591
4670
|
"description": "Minimum configuration for schemaInitializersType",
|
|
4592
4671
|
"required_fields": [
|
|
@@ -4625,6 +4704,8 @@
|
|
|
4625
4704
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
4626
4705
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
4627
4706
|
},
|
|
4707
|
+
"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.",
|
|
4708
|
+
"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.",
|
|
4628
4709
|
"x-f5xc-required-for": {
|
|
4629
4710
|
"minimum_config": false,
|
|
4630
4711
|
"create": false,
|
|
@@ -4646,6 +4727,7 @@
|
|
|
4646
4727
|
"x-validation-rules": {
|
|
4647
4728
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
4648
4729
|
},
|
|
4730
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
4649
4731
|
"minLength": 0,
|
|
4650
4732
|
"x-f5xc-required-for": {
|
|
4651
4733
|
"minimum_config": false,
|
|
@@ -4655,7 +4737,7 @@
|
|
|
4655
4737
|
},
|
|
4656
4738
|
"x-original-maxLength": 1200,
|
|
4657
4739
|
"x-reconciled-from-discovery": true,
|
|
4658
|
-
"x-reconciled-at": "2026-01-
|
|
4740
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225530+00:00"
|
|
4659
4741
|
},
|
|
4660
4742
|
"disable": {
|
|
4661
4743
|
"type": "boolean",
|
|
@@ -4664,6 +4746,7 @@
|
|
|
4664
4746
|
"format": "boolean",
|
|
4665
4747
|
"x-displayname": "Disable",
|
|
4666
4748
|
"x-f5xc-example": "true",
|
|
4749
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
4667
4750
|
"x-f5xc-required-for": {
|
|
4668
4751
|
"minimum_config": false,
|
|
4669
4752
|
"create": false,
|
|
@@ -4677,6 +4760,8 @@
|
|
|
4677
4760
|
"title": "Labels",
|
|
4678
4761
|
"x-displayname": "Labels",
|
|
4679
4762
|
"x-f5xc-example": "value",
|
|
4763
|
+
"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.",
|
|
4764
|
+
"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.",
|
|
4680
4765
|
"x-f5xc-required-for": {
|
|
4681
4766
|
"minimum_config": false,
|
|
4682
4767
|
"create": false,
|
|
@@ -4698,6 +4783,8 @@
|
|
|
4698
4783
|
"x-validation-rules": {
|
|
4699
4784
|
"ves.io.schema.rules.message.required": "true"
|
|
4700
4785
|
},
|
|
4786
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
4787
|
+
"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.",
|
|
4701
4788
|
"minLength": 0,
|
|
4702
4789
|
"maxLength": 16,
|
|
4703
4790
|
"x-f5xc-required-for": {
|
|
@@ -4708,7 +4795,7 @@
|
|
|
4708
4795
|
},
|
|
4709
4796
|
"x-original-maxLength": 1024,
|
|
4710
4797
|
"x-reconciled-from-discovery": true,
|
|
4711
|
-
"x-reconciled-at": "2026-01-
|
|
4798
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225538+00:00"
|
|
4712
4799
|
},
|
|
4713
4800
|
"namespace": {
|
|
4714
4801
|
"type": "string",
|
|
@@ -4717,6 +4804,8 @@
|
|
|
4717
4804
|
"x-displayname": "Namespace",
|
|
4718
4805
|
"x-ves-example": "Staging",
|
|
4719
4806
|
"x-f5xc-example": "staging",
|
|
4807
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
4808
|
+
"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 \"\".",
|
|
4720
4809
|
"minLength": 0,
|
|
4721
4810
|
"maxLength": 6,
|
|
4722
4811
|
"x-f5xc-required-for": {
|
|
@@ -4727,9 +4816,10 @@
|
|
|
4727
4816
|
},
|
|
4728
4817
|
"x-original-maxLength": 1024,
|
|
4729
4818
|
"x-reconciled-from-discovery": true,
|
|
4730
|
-
"x-reconciled-at": "2026-01-
|
|
4819
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225542+00:00"
|
|
4731
4820
|
}
|
|
4732
4821
|
},
|
|
4822
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
4733
4823
|
"x-f5xc-minimum-configuration": {
|
|
4734
4824
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
4735
4825
|
"required_fields": [
|
|
@@ -4773,6 +4863,8 @@
|
|
|
4773
4863
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
4774
4864
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
4775
4865
|
},
|
|
4866
|
+
"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.",
|
|
4867
|
+
"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.",
|
|
4776
4868
|
"x-f5xc-required-for": {
|
|
4777
4869
|
"minimum_config": false,
|
|
4778
4870
|
"create": false,
|
|
@@ -4794,6 +4886,7 @@
|
|
|
4794
4886
|
"x-validation-rules": {
|
|
4795
4887
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
4796
4888
|
},
|
|
4889
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
4797
4890
|
"minLength": 0,
|
|
4798
4891
|
"x-f5xc-required-for": {
|
|
4799
4892
|
"minimum_config": false,
|
|
@@ -4803,7 +4896,7 @@
|
|
|
4803
4896
|
},
|
|
4804
4897
|
"x-original-maxLength": 1200,
|
|
4805
4898
|
"x-reconciled-from-discovery": true,
|
|
4806
|
-
"x-reconciled-at": "2026-01-
|
|
4899
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225548+00:00"
|
|
4807
4900
|
},
|
|
4808
4901
|
"disable": {
|
|
4809
4902
|
"type": "boolean",
|
|
@@ -4813,6 +4906,7 @@
|
|
|
4813
4906
|
"x-displayname": "Disable",
|
|
4814
4907
|
"x-ves-example": "True",
|
|
4815
4908
|
"x-f5xc-example": "true",
|
|
4909
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
4816
4910
|
"x-f5xc-required-for": {
|
|
4817
4911
|
"minimum_config": false,
|
|
4818
4912
|
"create": false,
|
|
@@ -4827,6 +4921,8 @@
|
|
|
4827
4921
|
"x-displayname": "Labels",
|
|
4828
4922
|
"x-ves-example": "Value",
|
|
4829
4923
|
"x-f5xc-example": "value",
|
|
4924
|
+
"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.",
|
|
4925
|
+
"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.",
|
|
4830
4926
|
"x-f5xc-required-for": {
|
|
4831
4927
|
"minimum_config": false,
|
|
4832
4928
|
"create": false,
|
|
@@ -4848,6 +4944,8 @@
|
|
|
4848
4944
|
"x-validation-rules": {
|
|
4849
4945
|
"ves.io.schema.rules.message.required": "true"
|
|
4850
4946
|
},
|
|
4947
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
4948
|
+
"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.",
|
|
4851
4949
|
"minLength": 0,
|
|
4852
4950
|
"maxLength": 16,
|
|
4853
4951
|
"x-f5xc-required-for": {
|
|
@@ -4858,7 +4956,7 @@
|
|
|
4858
4956
|
},
|
|
4859
4957
|
"x-original-maxLength": 1024,
|
|
4860
4958
|
"x-reconciled-from-discovery": true,
|
|
4861
|
-
"x-reconciled-at": "2026-01-
|
|
4959
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225567+00:00"
|
|
4862
4960
|
},
|
|
4863
4961
|
"namespace": {
|
|
4864
4962
|
"type": "string",
|
|
@@ -4867,6 +4965,8 @@
|
|
|
4867
4965
|
"x-displayname": "Namespace",
|
|
4868
4966
|
"x-ves-example": "Staging",
|
|
4869
4967
|
"x-f5xc-example": "staging",
|
|
4968
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
4969
|
+
"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 \"\".",
|
|
4870
4970
|
"minLength": 0,
|
|
4871
4971
|
"maxLength": 6,
|
|
4872
4972
|
"x-f5xc-required-for": {
|
|
@@ -4877,9 +4977,10 @@
|
|
|
4877
4977
|
},
|
|
4878
4978
|
"x-original-maxLength": 1024,
|
|
4879
4979
|
"x-reconciled-from-discovery": true,
|
|
4880
|
-
"x-reconciled-at": "2026-01-
|
|
4980
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225572+00:00"
|
|
4881
4981
|
}
|
|
4882
4982
|
},
|
|
4983
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
4883
4984
|
"x-f5xc-minimum-configuration": {
|
|
4884
4985
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
4885
4986
|
"required_fields": [
|
|
@@ -4911,6 +5012,8 @@
|
|
|
4911
5012
|
"x-displayname": "Kind",
|
|
4912
5013
|
"x-ves-example": "Virtual_site.",
|
|
4913
5014
|
"x-f5xc-example": "virtual_site",
|
|
5015
|
+
"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\")",
|
|
5016
|
+
"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\").",
|
|
4914
5017
|
"minLength": 0,
|
|
4915
5018
|
"maxLength": 14,
|
|
4916
5019
|
"x-f5xc-required-for": {
|
|
@@ -4922,7 +5025,7 @@
|
|
|
4922
5025
|
"readOnly": true,
|
|
4923
5026
|
"x-original-maxLength": 1024,
|
|
4924
5027
|
"x-reconciled-from-discovery": true,
|
|
4925
|
-
"x-reconciled-at": "2026-01-
|
|
5028
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225576+00:00"
|
|
4926
5029
|
},
|
|
4927
5030
|
"name": {
|
|
4928
5031
|
"type": "string",
|
|
@@ -4931,6 +5034,8 @@
|
|
|
4931
5034
|
"x-displayname": "Name",
|
|
4932
5035
|
"x-ves-example": "Contactus-route.",
|
|
4933
5036
|
"x-f5xc-example": "contactus-route",
|
|
5037
|
+
"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.",
|
|
5038
|
+
"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.",
|
|
4934
5039
|
"minLength": 0,
|
|
4935
5040
|
"maxLength": 16,
|
|
4936
5041
|
"x-f5xc-required-for": {
|
|
@@ -4941,7 +5046,7 @@
|
|
|
4941
5046
|
},
|
|
4942
5047
|
"x-original-maxLength": 1024,
|
|
4943
5048
|
"x-reconciled-from-discovery": true,
|
|
4944
|
-
"x-reconciled-at": "2026-01-
|
|
5049
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225581+00:00"
|
|
4945
5050
|
},
|
|
4946
5051
|
"namespace": {
|
|
4947
5052
|
"type": "string",
|
|
@@ -4950,6 +5055,8 @@
|
|
|
4950
5055
|
"x-displayname": "Namespace",
|
|
4951
5056
|
"x-ves-example": "Ns1",
|
|
4952
5057
|
"x-f5xc-example": "ns1",
|
|
5058
|
+
"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.",
|
|
5059
|
+
"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.",
|
|
4953
5060
|
"minLength": 0,
|
|
4954
5061
|
"maxLength": 6,
|
|
4955
5062
|
"x-f5xc-required-for": {
|
|
@@ -4960,7 +5067,7 @@
|
|
|
4960
5067
|
},
|
|
4961
5068
|
"x-original-maxLength": 1024,
|
|
4962
5069
|
"x-reconciled-from-discovery": true,
|
|
4963
|
-
"x-reconciled-at": "2026-01-
|
|
5070
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225584+00:00"
|
|
4964
5071
|
},
|
|
4965
5072
|
"tenant": {
|
|
4966
5073
|
"type": "string",
|
|
@@ -4969,6 +5076,8 @@
|
|
|
4969
5076
|
"x-displayname": "Tenant",
|
|
4970
5077
|
"x-ves-example": "Example-corp.",
|
|
4971
5078
|
"x-f5xc-example": "example-corp",
|
|
5079
|
+
"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.",
|
|
5080
|
+
"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.",
|
|
4972
5081
|
"minLength": 0,
|
|
4973
5082
|
"maxLength": 18,
|
|
4974
5083
|
"x-f5xc-required-for": {
|
|
@@ -4981,7 +5090,7 @@
|
|
|
4981
5090
|
"x-field-mutability": "read-only",
|
|
4982
5091
|
"x-original-maxLength": 1024,
|
|
4983
5092
|
"x-reconciled-from-discovery": true,
|
|
4984
|
-
"x-reconciled-at": "2026-01-
|
|
5093
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225588+00:00"
|
|
4985
5094
|
},
|
|
4986
5095
|
"uid": {
|
|
4987
5096
|
"type": "string",
|
|
@@ -4990,6 +5099,8 @@
|
|
|
4990
5099
|
"x-displayname": "UID",
|
|
4991
5100
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
4992
5101
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
5102
|
+
"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.",
|
|
5103
|
+
"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.",
|
|
4993
5104
|
"minLength": 0,
|
|
4994
5105
|
"maxLength": 36,
|
|
4995
5106
|
"x-f5xc-required-for": {
|
|
@@ -5003,9 +5114,11 @@
|
|
|
5003
5114
|
"x-original-maxLength": 1024,
|
|
5004
5115
|
"format": "uuid",
|
|
5005
5116
|
"x-reconciled-from-discovery": true,
|
|
5006
|
-
"x-reconciled-at": "2026-01-
|
|
5117
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225594+00:00"
|
|
5007
5118
|
}
|
|
5008
5119
|
},
|
|
5120
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
5121
|
+
"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...",
|
|
5009
5122
|
"x-f5xc-minimum-configuration": {
|
|
5010
5123
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
5011
5124
|
"required_fields": [
|
|
@@ -5048,6 +5161,8 @@
|
|
|
5048
5161
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
5049
5162
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
5050
5163
|
},
|
|
5164
|
+
"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.",
|
|
5165
|
+
"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.",
|
|
5051
5166
|
"x-f5xc-required-for": {
|
|
5052
5167
|
"minimum_config": false,
|
|
5053
5168
|
"create": false,
|
|
@@ -5069,6 +5184,7 @@
|
|
|
5069
5184
|
"x-validation-rules": {
|
|
5070
5185
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
5071
5186
|
},
|
|
5187
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
5072
5188
|
"minLength": 0,
|
|
5073
5189
|
"x-f5xc-required-for": {
|
|
5074
5190
|
"minimum_config": false,
|
|
@@ -5078,7 +5194,7 @@
|
|
|
5078
5194
|
},
|
|
5079
5195
|
"x-original-maxLength": 1200,
|
|
5080
5196
|
"x-reconciled-from-discovery": true,
|
|
5081
|
-
"x-reconciled-at": "2026-01-
|
|
5197
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225601+00:00"
|
|
5082
5198
|
},
|
|
5083
5199
|
"disable": {
|
|
5084
5200
|
"type": "boolean",
|
|
@@ -5087,6 +5203,7 @@
|
|
|
5087
5203
|
"format": "boolean",
|
|
5088
5204
|
"x-displayname": "Disable",
|
|
5089
5205
|
"x-f5xc-example": "true",
|
|
5206
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
5090
5207
|
"x-f5xc-required-for": {
|
|
5091
5208
|
"minimum_config": false,
|
|
5092
5209
|
"create": false,
|
|
@@ -5101,6 +5218,8 @@
|
|
|
5101
5218
|
"x-displayname": "Labels",
|
|
5102
5219
|
"x-ves-example": "Value",
|
|
5103
5220
|
"x-f5xc-example": "value",
|
|
5221
|
+
"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.",
|
|
5222
|
+
"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.",
|
|
5104
5223
|
"x-f5xc-required-for": {
|
|
5105
5224
|
"minimum_config": false,
|
|
5106
5225
|
"create": false,
|
|
@@ -5121,6 +5240,8 @@
|
|
|
5121
5240
|
"x-validation-rules": {
|
|
5122
5241
|
"ves.io.schema.rules.message.required": "true"
|
|
5123
5242
|
},
|
|
5243
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
5244
|
+
"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.",
|
|
5124
5245
|
"minLength": 0,
|
|
5125
5246
|
"maxLength": 16,
|
|
5126
5247
|
"x-f5xc-required-for": {
|
|
@@ -5131,7 +5252,7 @@
|
|
|
5131
5252
|
},
|
|
5132
5253
|
"x-original-maxLength": 1024,
|
|
5133
5254
|
"x-reconciled-from-discovery": true,
|
|
5134
|
-
"x-reconciled-at": "2026-01-
|
|
5255
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225609+00:00"
|
|
5135
5256
|
},
|
|
5136
5257
|
"namespace": {
|
|
5137
5258
|
"type": "string",
|
|
@@ -5140,6 +5261,8 @@
|
|
|
5140
5261
|
"x-displayname": "Namespace",
|
|
5141
5262
|
"x-ves-example": "Staging",
|
|
5142
5263
|
"x-f5xc-example": "staging",
|
|
5264
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
5265
|
+
"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 \"\".",
|
|
5143
5266
|
"minLength": 0,
|
|
5144
5267
|
"maxLength": 6,
|
|
5145
5268
|
"x-f5xc-required-for": {
|
|
@@ -5150,9 +5273,10 @@
|
|
|
5150
5273
|
},
|
|
5151
5274
|
"x-original-maxLength": 1024,
|
|
5152
5275
|
"x-reconciled-from-discovery": true,
|
|
5153
|
-
"x-reconciled-at": "2026-01-
|
|
5276
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225613+00:00"
|
|
5154
5277
|
}
|
|
5155
5278
|
},
|
|
5279
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
5156
5280
|
"x-f5xc-minimum-configuration": {
|
|
5157
5281
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
5158
5282
|
"required_fields": [
|
|
@@ -5183,6 +5307,8 @@
|
|
|
5183
5307
|
"title": "Creation_timestamp.",
|
|
5184
5308
|
"format": "date-time",
|
|
5185
5309
|
"x-displayname": "Creation Timestamp.",
|
|
5310
|
+
"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.",
|
|
5311
|
+
"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.",
|
|
5186
5312
|
"minLength": 0,
|
|
5187
5313
|
"maxLength": 1024,
|
|
5188
5314
|
"x-f5xc-required-for": {
|
|
@@ -5200,6 +5326,8 @@
|
|
|
5200
5326
|
"x-displayname": "Creator Class.",
|
|
5201
5327
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
5202
5328
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
5329
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
5330
|
+
"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.",
|
|
5203
5331
|
"minLength": 0,
|
|
5204
5332
|
"maxLength": 1024,
|
|
5205
5333
|
"x-f5xc-required-for": {
|
|
@@ -5217,6 +5345,8 @@
|
|
|
5217
5345
|
"x-displayname": "Creator ID.",
|
|
5218
5346
|
"x-ves-example": "Ver-instance-1.",
|
|
5219
5347
|
"x-f5xc-example": "ver-instance-1",
|
|
5348
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
5349
|
+
"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.",
|
|
5220
5350
|
"minLength": 0,
|
|
5221
5351
|
"maxLength": 1024,
|
|
5222
5352
|
"x-f5xc-required-for": {
|
|
@@ -5235,6 +5365,8 @@
|
|
|
5235
5365
|
"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)",
|
|
5236
5366
|
"title": "Status_id",
|
|
5237
5367
|
"x-displayname": "Status ID",
|
|
5368
|
+
"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...",
|
|
5369
|
+
"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).",
|
|
5238
5370
|
"minLength": 0,
|
|
5239
5371
|
"maxLength": 1024,
|
|
5240
5372
|
"x-f5xc-required-for": {
|
|
@@ -5252,6 +5384,7 @@
|
|
|
5252
5384
|
"x-displayname": "UID",
|
|
5253
5385
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
5254
5386
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
5387
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
5255
5388
|
"minLength": 0,
|
|
5256
5389
|
"maxLength": 36,
|
|
5257
5390
|
"x-f5xc-required-for": {
|
|
@@ -5264,13 +5397,14 @@
|
|
|
5264
5397
|
"x-original-maxLength": 1024,
|
|
5265
5398
|
"format": "uuid",
|
|
5266
5399
|
"x-reconciled-from-discovery": true,
|
|
5267
|
-
"x-reconciled-at": "2026-01-
|
|
5400
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225626+00:00"
|
|
5268
5401
|
},
|
|
5269
5402
|
"vtrp_id": {
|
|
5270
5403
|
"type": "string",
|
|
5271
5404
|
"description": "Origin of this status exchanged by VTRP.",
|
|
5272
5405
|
"title": "Vtrp_id",
|
|
5273
5406
|
"x-displayname": "VTRP ID",
|
|
5407
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
5274
5408
|
"minLength": 0,
|
|
5275
5409
|
"maxLength": 1024,
|
|
5276
5410
|
"x-f5xc-required-for": {
|
|
@@ -5287,6 +5421,7 @@
|
|
|
5287
5421
|
"title": "Vtrp_stale.",
|
|
5288
5422
|
"format": "boolean",
|
|
5289
5423
|
"x-displayname": "VTRP Stale.",
|
|
5424
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
5290
5425
|
"x-f5xc-required-for": {
|
|
5291
5426
|
"minimum_config": false,
|
|
5292
5427
|
"create": false,
|
|
@@ -5295,6 +5430,7 @@
|
|
|
5295
5430
|
}
|
|
5296
5431
|
}
|
|
5297
5432
|
},
|
|
5433
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
5298
5434
|
"x-f5xc-minimum-configuration": {
|
|
5299
5435
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
5300
5436
|
"required_fields": [
|
|
@@ -5325,6 +5461,8 @@
|
|
|
5325
5461
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
5326
5462
|
"x-displayname": "Status Publish Type.",
|
|
5327
5463
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
5464
|
+
"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.",
|
|
5465
|
+
"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.",
|
|
5328
5466
|
"x-f5xc-minimum-configuration": {
|
|
5329
5467
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
5330
5468
|
"required_fields": [],
|
|
@@ -5350,6 +5488,7 @@
|
|
|
5350
5488
|
"x-displayname": "Code",
|
|
5351
5489
|
"x-ves-example": "0",
|
|
5352
5490
|
"x-f5xc-example": "0",
|
|
5491
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
5353
5492
|
"minimum": 0,
|
|
5354
5493
|
"maximum": 2147483647,
|
|
5355
5494
|
"x-f5xc-required-for": {
|
|
@@ -5366,6 +5505,8 @@
|
|
|
5366
5505
|
"x-displayname": "Reason",
|
|
5367
5506
|
"x-ves-example": "Value",
|
|
5368
5507
|
"x-f5xc-example": "value",
|
|
5508
|
+
"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.",
|
|
5509
|
+
"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.",
|
|
5369
5510
|
"minLength": 0,
|
|
5370
5511
|
"maxLength": 43,
|
|
5371
5512
|
"x-f5xc-required-for": {
|
|
@@ -5376,7 +5517,7 @@
|
|
|
5376
5517
|
},
|
|
5377
5518
|
"x-original-maxLength": 1024,
|
|
5378
5519
|
"x-reconciled-from-discovery": true,
|
|
5379
|
-
"x-reconciled-at": "2026-01-
|
|
5520
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225635+00:00"
|
|
5380
5521
|
},
|
|
5381
5522
|
"status": {
|
|
5382
5523
|
"type": "string",
|
|
@@ -5385,6 +5526,7 @@
|
|
|
5385
5526
|
"x-displayname": "Status",
|
|
5386
5527
|
"x-ves-example": "Value",
|
|
5387
5528
|
"x-f5xc-example": "value",
|
|
5529
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
5388
5530
|
"minLength": 0,
|
|
5389
5531
|
"maxLength": 17,
|
|
5390
5532
|
"x-f5xc-required-for": {
|
|
@@ -5395,9 +5537,10 @@
|
|
|
5395
5537
|
},
|
|
5396
5538
|
"x-original-maxLength": 1024,
|
|
5397
5539
|
"x-reconciled-from-discovery": true,
|
|
5398
|
-
"x-reconciled-at": "2026-01-
|
|
5540
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225639+00:00"
|
|
5399
5541
|
}
|
|
5400
5542
|
},
|
|
5543
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
5401
5544
|
"x-f5xc-minimum-configuration": {
|
|
5402
5545
|
"description": "Minimum configuration for schemaStatusType",
|
|
5403
5546
|
"required_fields": [
|
|
@@ -5425,6 +5568,8 @@
|
|
|
5425
5568
|
"title": "Creation_timestamp.",
|
|
5426
5569
|
"format": "date-time",
|
|
5427
5570
|
"x-displayname": "Creation Timestamp.",
|
|
5571
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
5572
|
+
"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.",
|
|
5428
5573
|
"minLength": 0,
|
|
5429
5574
|
"maxLength": 1024,
|
|
5430
5575
|
"x-f5xc-required-for": {
|
|
@@ -5442,6 +5587,7 @@
|
|
|
5442
5587
|
"x-displayname": "Creator Class.",
|
|
5443
5588
|
"x-ves-example": "Prism",
|
|
5444
5589
|
"x-f5xc-example": "value",
|
|
5590
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
5445
5591
|
"minLength": 0,
|
|
5446
5592
|
"maxLength": 1024,
|
|
5447
5593
|
"x-f5xc-required-for": {
|
|
@@ -5459,6 +5605,7 @@
|
|
|
5459
5605
|
"x-displayname": "Creator ID.",
|
|
5460
5606
|
"x-ves-example": "Admin@example-corp.com.",
|
|
5461
5607
|
"x-f5xc-example": "value",
|
|
5608
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
5462
5609
|
"minLength": 0,
|
|
5463
5610
|
"maxLength": 1024,
|
|
5464
5611
|
"x-f5xc-required-for": {
|
|
@@ -5475,6 +5622,8 @@
|
|
|
5475
5622
|
"title": "Deletion_timestamp.",
|
|
5476
5623
|
"format": "date-time",
|
|
5477
5624
|
"x-displayname": "Deletion Timestamp.",
|
|
5625
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
5626
|
+
"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...",
|
|
5478
5627
|
"minLength": 0,
|
|
5479
5628
|
"maxLength": 1024,
|
|
5480
5629
|
"x-f5xc-required-for": {
|
|
@@ -5494,6 +5643,8 @@
|
|
|
5494
5643
|
"x-displayname": "Finalizers.",
|
|
5495
5644
|
"x-ves-example": "Value",
|
|
5496
5645
|
"x-f5xc-example": "value",
|
|
5646
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
5647
|
+
"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.",
|
|
5497
5648
|
"x-f5xc-required-for": {
|
|
5498
5649
|
"minimum_config": false,
|
|
5499
5650
|
"create": false,
|
|
@@ -5511,6 +5662,8 @@
|
|
|
5511
5662
|
"x-displayname": "Labels",
|
|
5512
5663
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
5513
5664
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
5665
|
+
"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.",
|
|
5666
|
+
"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).",
|
|
5514
5667
|
"x-f5xc-required-for": {
|
|
5515
5668
|
"minimum_config": false,
|
|
5516
5669
|
"create": false,
|
|
@@ -5524,6 +5677,8 @@
|
|
|
5524
5677
|
"title": "Modification_timestamp.",
|
|
5525
5678
|
"format": "date-time",
|
|
5526
5679
|
"x-displayname": "Modification Timestamp.",
|
|
5680
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
5681
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
5527
5682
|
"minLength": 0,
|
|
5528
5683
|
"maxLength": 1024,
|
|
5529
5684
|
"x-f5xc-required-for": {
|
|
@@ -5542,6 +5697,8 @@
|
|
|
5542
5697
|
"x-displayname": "Object Index.",
|
|
5543
5698
|
"x-ves-example": "0",
|
|
5544
5699
|
"x-f5xc-example": "0",
|
|
5700
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
5701
|
+
"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.",
|
|
5545
5702
|
"minimum": 0,
|
|
5546
5703
|
"maximum": 2147483647,
|
|
5547
5704
|
"x-f5xc-required-for": {
|
|
@@ -5562,6 +5719,8 @@
|
|
|
5562
5719
|
"x-displayname": "Tenant",
|
|
5563
5720
|
"x-ves-example": "Example-corp.",
|
|
5564
5721
|
"x-f5xc-example": "example-corp",
|
|
5722
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
5723
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
5565
5724
|
"minLength": 0,
|
|
5566
5725
|
"maxLength": 18,
|
|
5567
5726
|
"x-f5xc-required-for": {
|
|
@@ -5573,7 +5732,7 @@
|
|
|
5573
5732
|
"x-field-mutability": "read-only",
|
|
5574
5733
|
"x-original-maxLength": 1024,
|
|
5575
5734
|
"x-reconciled-from-discovery": true,
|
|
5576
|
-
"x-reconciled-at": "2026-01-
|
|
5735
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225663+00:00"
|
|
5577
5736
|
},
|
|
5578
5737
|
"uid": {
|
|
5579
5738
|
"type": "string",
|
|
@@ -5582,6 +5741,8 @@
|
|
|
5582
5741
|
"x-displayname": "UID",
|
|
5583
5742
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
5584
5743
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
5744
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
5745
|
+
"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.",
|
|
5585
5746
|
"minLength": 0,
|
|
5586
5747
|
"maxLength": 36,
|
|
5587
5748
|
"x-f5xc-required-for": {
|
|
@@ -5594,9 +5755,11 @@
|
|
|
5594
5755
|
"x-original-maxLength": 1024,
|
|
5595
5756
|
"format": "uuid",
|
|
5596
5757
|
"x-reconciled-from-discovery": true,
|
|
5597
|
-
"x-reconciled-at": "2026-01-
|
|
5758
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225668+00:00"
|
|
5598
5759
|
}
|
|
5599
5760
|
},
|
|
5761
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
5762
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
5600
5763
|
"x-f5xc-minimum-configuration": {
|
|
5601
5764
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
5602
5765
|
"required_fields": [
|
|
@@ -5644,7 +5807,7 @@
|
|
|
5644
5807
|
},
|
|
5645
5808
|
"x-original-maxLength": 1024,
|
|
5646
5809
|
"x-reconciled-from-discovery": true,
|
|
5647
|
-
"x-reconciled-at": "2026-01-
|
|
5810
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225673+00:00"
|
|
5648
5811
|
},
|
|
5649
5812
|
"name": {
|
|
5650
5813
|
"type": "string",
|
|
@@ -5653,6 +5816,8 @@
|
|
|
5653
5816
|
"x-displayname": "Name",
|
|
5654
5817
|
"x-ves-example": "Contactus-route.",
|
|
5655
5818
|
"x-f5xc-example": "contactus-route",
|
|
5819
|
+
"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.",
|
|
5820
|
+
"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.",
|
|
5656
5821
|
"minLength": 0,
|
|
5657
5822
|
"maxLength": 16,
|
|
5658
5823
|
"x-f5xc-required-for": {
|
|
@@ -5663,7 +5828,7 @@
|
|
|
5663
5828
|
},
|
|
5664
5829
|
"x-original-maxLength": 1024,
|
|
5665
5830
|
"x-reconciled-from-discovery": true,
|
|
5666
|
-
"x-reconciled-at": "2026-01-
|
|
5831
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225677+00:00"
|
|
5667
5832
|
},
|
|
5668
5833
|
"namespace": {
|
|
5669
5834
|
"type": "string",
|
|
@@ -5672,6 +5837,8 @@
|
|
|
5672
5837
|
"x-displayname": "Namespace",
|
|
5673
5838
|
"x-ves-example": "Ns1",
|
|
5674
5839
|
"x-f5xc-example": "ns1",
|
|
5840
|
+
"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.",
|
|
5841
|
+
"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.",
|
|
5675
5842
|
"minLength": 0,
|
|
5676
5843
|
"maxLength": 6,
|
|
5677
5844
|
"x-f5xc-required-for": {
|
|
@@ -5682,7 +5849,7 @@
|
|
|
5682
5849
|
},
|
|
5683
5850
|
"x-original-maxLength": 1024,
|
|
5684
5851
|
"x-reconciled-from-discovery": true,
|
|
5685
|
-
"x-reconciled-at": "2026-01-
|
|
5852
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225681+00:00"
|
|
5686
5853
|
},
|
|
5687
5854
|
"uid": {
|
|
5688
5855
|
"type": "string",
|
|
@@ -5703,9 +5870,10 @@
|
|
|
5703
5870
|
"x-original-maxLength": 1024,
|
|
5704
5871
|
"format": "uuid",
|
|
5705
5872
|
"x-reconciled-from-discovery": true,
|
|
5706
|
-
"x-reconciled-at": "2026-01-
|
|
5873
|
+
"x-reconciled-at": "2026-01-07T15:53:13.225686+00:00"
|
|
5707
5874
|
}
|
|
5708
5875
|
},
|
|
5876
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
5709
5877
|
"x-f5xc-minimum-configuration": {
|
|
5710
5878
|
"description": "Minimum configuration for schemaViewRefType",
|
|
5711
5879
|
"required_fields": [
|
|
@@ -5736,6 +5904,7 @@
|
|
|
5736
5904
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
5737
5905
|
},
|
|
5738
5906
|
"x-displayname": "Deleted Referred Objects.",
|
|
5907
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
5739
5908
|
"x-f5xc-required-for": {
|
|
5740
5909
|
"minimum_config": false,
|
|
5741
5910
|
"create": false,
|
|
@@ -5751,6 +5920,7 @@
|
|
|
5751
5920
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
5752
5921
|
},
|
|
5753
5922
|
"x-displayname": "Disabled Referred Objects.",
|
|
5923
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
5754
5924
|
"x-f5xc-required-for": {
|
|
5755
5925
|
"minimum_config": false,
|
|
5756
5926
|
"create": false,
|
|
@@ -5769,6 +5939,7 @@
|
|
|
5769
5939
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
5770
5940
|
},
|
|
5771
5941
|
"x-displayname": "Referring Objects.",
|
|
5942
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
5772
5943
|
"x-f5xc-required-for": {
|
|
5773
5944
|
"minimum_config": false,
|
|
5774
5945
|
"create": false,
|
|
@@ -5787,6 +5958,8 @@
|
|
|
5787
5958
|
"$ref": "#/components/schemas/geo_configStatusObject"
|
|
5788
5959
|
},
|
|
5789
5960
|
"x-displayname": "Status",
|
|
5961
|
+
"x-f5xc-example": "active",
|
|
5962
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
5790
5963
|
"x-f5xc-required-for": {
|
|
5791
5964
|
"minimum_config": false,
|
|
5792
5965
|
"create": false,
|
|
@@ -5796,7 +5969,7 @@
|
|
|
5796
5969
|
"maxLength": 17,
|
|
5797
5970
|
"minLength": 17,
|
|
5798
5971
|
"x-reconciled-from-discovery": true,
|
|
5799
|
-
"x-reconciled-at": "2026-01-
|
|
5972
|
+
"x-reconciled-at": "2026-01-07T15:53:22.524900+00:00"
|
|
5800
5973
|
},
|
|
5801
5974
|
"system_metadata": {
|
|
5802
5975
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -5832,6 +6005,8 @@
|
|
|
5832
6005
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
5833
6006
|
],
|
|
5834
6007
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
6008
|
+
"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...",
|
|
6009
|
+
"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_STATUS: x-displayName: \"Status format\" Response should be in...",
|
|
5835
6010
|
"x-f5xc-minimum-configuration": {
|
|
5836
6011
|
"description": "Minimum configuration for geo_configGetResponseFormatCode",
|
|
5837
6012
|
"required_fields": [],
|
|
@@ -5900,6 +6075,7 @@
|
|
|
5900
6075
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
5901
6076
|
},
|
|
5902
6077
|
"x-displayname": "Conditions.",
|
|
6078
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
5903
6079
|
"x-f5xc-required-for": {
|
|
5904
6080
|
"minimum_config": false,
|
|
5905
6081
|
"create": false,
|
|
@@ -5926,6 +6102,7 @@
|
|
|
5926
6102
|
}
|
|
5927
6103
|
}
|
|
5928
6104
|
},
|
|
6105
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
5929
6106
|
"x-f5xc-minimum-configuration": {
|
|
5930
6107
|
"description": "Minimum configuration for geo_configStatusObject",
|
|
5931
6108
|
"required_fields": [
|
|
@@ -5954,6 +6131,8 @@
|
|
|
5954
6131
|
"x-displayname": "Kind",
|
|
5955
6132
|
"x-ves-example": "Virtual_site.",
|
|
5956
6133
|
"x-f5xc-example": "virtual_site",
|
|
6134
|
+
"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\")",
|
|
6135
|
+
"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\").",
|
|
5957
6136
|
"minLength": 0,
|
|
5958
6137
|
"maxLength": 14,
|
|
5959
6138
|
"x-f5xc-required-for": {
|
|
@@ -5965,7 +6144,7 @@
|
|
|
5965
6144
|
"readOnly": true,
|
|
5966
6145
|
"x-original-maxLength": 1024,
|
|
5967
6146
|
"x-reconciled-from-discovery": true,
|
|
5968
|
-
"x-reconciled-at": "2026-01-
|
|
6147
|
+
"x-reconciled-at": "2026-01-07T15:53:22.524916+00:00"
|
|
5969
6148
|
},
|
|
5970
6149
|
"name": {
|
|
5971
6150
|
"type": "string",
|
|
@@ -5974,6 +6153,8 @@
|
|
|
5974
6153
|
"x-displayname": "Name",
|
|
5975
6154
|
"x-ves-example": "Contactus-route.",
|
|
5976
6155
|
"x-f5xc-example": "contactus-route",
|
|
6156
|
+
"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.",
|
|
6157
|
+
"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.",
|
|
5977
6158
|
"minLength": 0,
|
|
5978
6159
|
"maxLength": 16,
|
|
5979
6160
|
"x-f5xc-required-for": {
|
|
@@ -5984,7 +6165,7 @@
|
|
|
5984
6165
|
},
|
|
5985
6166
|
"x-original-maxLength": 1024,
|
|
5986
6167
|
"x-reconciled-from-discovery": true,
|
|
5987
|
-
"x-reconciled-at": "2026-01-
|
|
6168
|
+
"x-reconciled-at": "2026-01-07T15:53:22.524922+00:00"
|
|
5988
6169
|
},
|
|
5989
6170
|
"namespace": {
|
|
5990
6171
|
"type": "string",
|
|
@@ -5993,6 +6174,8 @@
|
|
|
5993
6174
|
"x-displayname": "Namespace",
|
|
5994
6175
|
"x-ves-example": "Ns1",
|
|
5995
6176
|
"x-f5xc-example": "ns1",
|
|
6177
|
+
"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.",
|
|
6178
|
+
"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.",
|
|
5996
6179
|
"minLength": 0,
|
|
5997
6180
|
"maxLength": 6,
|
|
5998
6181
|
"x-f5xc-required-for": {
|
|
@@ -6003,7 +6186,7 @@
|
|
|
6003
6186
|
},
|
|
6004
6187
|
"x-original-maxLength": 1024,
|
|
6005
6188
|
"x-reconciled-from-discovery": true,
|
|
6006
|
-
"x-reconciled-at": "2026-01-
|
|
6189
|
+
"x-reconciled-at": "2026-01-07T15:53:22.524927+00:00"
|
|
6007
6190
|
},
|
|
6008
6191
|
"tenant": {
|
|
6009
6192
|
"type": "string",
|
|
@@ -6012,6 +6195,8 @@
|
|
|
6012
6195
|
"x-displayname": "Tenant",
|
|
6013
6196
|
"x-ves-example": "Example-corp.",
|
|
6014
6197
|
"x-f5xc-example": "example-corp",
|
|
6198
|
+
"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.",
|
|
6199
|
+
"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.",
|
|
6015
6200
|
"minLength": 0,
|
|
6016
6201
|
"maxLength": 18,
|
|
6017
6202
|
"x-f5xc-required-for": {
|
|
@@ -6024,7 +6209,7 @@
|
|
|
6024
6209
|
"x-field-mutability": "read-only",
|
|
6025
6210
|
"x-original-maxLength": 1024,
|
|
6026
6211
|
"x-reconciled-from-discovery": true,
|
|
6027
|
-
"x-reconciled-at": "2026-01-
|
|
6212
|
+
"x-reconciled-at": "2026-01-07T15:53:22.524932+00:00"
|
|
6028
6213
|
},
|
|
6029
6214
|
"uid": {
|
|
6030
6215
|
"type": "string",
|
|
@@ -6033,6 +6218,8 @@
|
|
|
6033
6218
|
"x-displayname": "UID",
|
|
6034
6219
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6035
6220
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6221
|
+
"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.",
|
|
6222
|
+
"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.",
|
|
6036
6223
|
"minLength": 0,
|
|
6037
6224
|
"maxLength": 36,
|
|
6038
6225
|
"x-f5xc-required-for": {
|
|
@@ -6046,9 +6233,11 @@
|
|
|
6046
6233
|
"x-original-maxLength": 1024,
|
|
6047
6234
|
"format": "uuid",
|
|
6048
6235
|
"x-reconciled-from-discovery": true,
|
|
6049
|
-
"x-reconciled-at": "2026-01-
|
|
6236
|
+
"x-reconciled-at": "2026-01-07T15:53:22.524938+00:00"
|
|
6050
6237
|
}
|
|
6051
6238
|
},
|
|
6239
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
6240
|
+
"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...",
|
|
6052
6241
|
"x-f5xc-minimum-configuration": {
|
|
6053
6242
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
6054
6243
|
"required_fields": [
|
|
@@ -6084,6 +6273,7 @@
|
|
|
6084
6273
|
"x-validation-rules": {
|
|
6085
6274
|
"ves.io.schema.rules.message.required": "true"
|
|
6086
6275
|
},
|
|
6276
|
+
"x-f5xc-example": "api.example.com",
|
|
6087
6277
|
"minLength": 0,
|
|
6088
6278
|
"maxLength": 1024,
|
|
6089
6279
|
"x-f5xc-required-for": {
|
|
@@ -6216,6 +6406,7 @@
|
|
|
6216
6406
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6217
6407
|
},
|
|
6218
6408
|
"x-displayname": "Deleted Referred Objects.",
|
|
6409
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6219
6410
|
"x-f5xc-required-for": {
|
|
6220
6411
|
"minimum_config": false,
|
|
6221
6412
|
"create": false,
|
|
@@ -6231,6 +6422,7 @@
|
|
|
6231
6422
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6232
6423
|
},
|
|
6233
6424
|
"x-displayname": "Disabled Referred Objects.",
|
|
6425
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6234
6426
|
"x-f5xc-required-for": {
|
|
6235
6427
|
"minimum_config": false,
|
|
6236
6428
|
"create": false,
|
|
@@ -6249,6 +6441,7 @@
|
|
|
6249
6441
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
6250
6442
|
},
|
|
6251
6443
|
"x-displayname": "Referring Objects.",
|
|
6444
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
6252
6445
|
"x-f5xc-required-for": {
|
|
6253
6446
|
"minimum_config": false,
|
|
6254
6447
|
"create": false,
|
|
@@ -6267,6 +6460,8 @@
|
|
|
6267
6460
|
"$ref": "#/components/schemas/lma_regionStatusObject"
|
|
6268
6461
|
},
|
|
6269
6462
|
"x-displayname": "Status",
|
|
6463
|
+
"x-f5xc-example": "active",
|
|
6464
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6270
6465
|
"x-f5xc-required-for": {
|
|
6271
6466
|
"minimum_config": false,
|
|
6272
6467
|
"create": false,
|
|
@@ -6276,7 +6471,7 @@
|
|
|
6276
6471
|
"maxLength": 17,
|
|
6277
6472
|
"minLength": 17,
|
|
6278
6473
|
"x-reconciled-from-discovery": true,
|
|
6279
|
-
"x-reconciled-at": "2026-01-
|
|
6474
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630188+00:00"
|
|
6280
6475
|
},
|
|
6281
6476
|
"system_metadata": {
|
|
6282
6477
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -6312,6 +6507,8 @@
|
|
|
6312
6507
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
6313
6508
|
],
|
|
6314
6509
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
6510
|
+
"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...",
|
|
6511
|
+
"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_STATUS: x-displayName: \"Status format\" Response should be in...",
|
|
6315
6512
|
"x-f5xc-minimum-configuration": {
|
|
6316
6513
|
"description": "Minimum configuration for lma_regionGetResponseFormatCode",
|
|
6317
6514
|
"required_fields": [],
|
|
@@ -6392,6 +6589,8 @@
|
|
|
6392
6589
|
"ves.io.schema.rules.message.required": "true",
|
|
6393
6590
|
"ves.io.schema.rules.string.max_len": "8096"
|
|
6394
6591
|
},
|
|
6592
|
+
"x-f5xc-description-short": "Servers in a Kafka cluster that a client should use to bootstrap its connection to the cluster.",
|
|
6593
|
+
"x-f5xc-description-medium": "Servers in a Kafka cluster that a client should use to bootstrap its connection to the cluster. Required: YES.",
|
|
6395
6594
|
"x-f5xc-required-for": {
|
|
6396
6595
|
"minimum_config": false,
|
|
6397
6596
|
"create": false,
|
|
@@ -6427,6 +6626,7 @@
|
|
|
6427
6626
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
6428
6627
|
},
|
|
6429
6628
|
"x-displayname": "Errors",
|
|
6629
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
6430
6630
|
"x-f5xc-required-for": {
|
|
6431
6631
|
"minimum_config": false,
|
|
6432
6632
|
"create": false,
|
|
@@ -6442,6 +6642,8 @@
|
|
|
6442
6642
|
"$ref": "#/components/schemas/lma_regionListResponseItem"
|
|
6443
6643
|
},
|
|
6444
6644
|
"x-displayname": "Items",
|
|
6645
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
6646
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
6445
6647
|
"x-f5xc-required-for": {
|
|
6446
6648
|
"minimum_config": false,
|
|
6447
6649
|
"create": false,
|
|
@@ -6475,6 +6677,8 @@
|
|
|
6475
6677
|
"description": "The set of annotations present on this lma_region.",
|
|
6476
6678
|
"title": "Annotations.",
|
|
6477
6679
|
"x-displayname": "Annotations.",
|
|
6680
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6681
|
+
"x-f5xc-description-short": "The set of annotations present on this lma_region.",
|
|
6478
6682
|
"x-f5xc-required-for": {
|
|
6479
6683
|
"minimum_config": false,
|
|
6480
6684
|
"create": false,
|
|
@@ -6487,6 +6691,7 @@
|
|
|
6487
6691
|
"description": "The description set for this lma_region.",
|
|
6488
6692
|
"title": "Description.",
|
|
6489
6693
|
"x-displayname": "Description.",
|
|
6694
|
+
"x-f5xc-description-short": "The description set for this lma_region.",
|
|
6490
6695
|
"minLength": 0,
|
|
6491
6696
|
"maxLength": 0,
|
|
6492
6697
|
"x-f5xc-required-for": {
|
|
@@ -6497,7 +6702,7 @@
|
|
|
6497
6702
|
},
|
|
6498
6703
|
"x-original-maxLength": 1024,
|
|
6499
6704
|
"x-reconciled-from-discovery": true,
|
|
6500
|
-
"x-reconciled-at": "2026-01-
|
|
6705
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630208+00:00"
|
|
6501
6706
|
},
|
|
6502
6707
|
"disabled": {
|
|
6503
6708
|
"type": "boolean",
|
|
@@ -6505,6 +6710,8 @@
|
|
|
6505
6710
|
"title": "Disabled",
|
|
6506
6711
|
"format": "boolean",
|
|
6507
6712
|
"x-displayname": "Disabled",
|
|
6713
|
+
"x-f5xc-example": "True",
|
|
6714
|
+
"x-f5xc-description-short": "Value of true indicates lma_region is administratively disabled.",
|
|
6508
6715
|
"x-f5xc-required-for": {
|
|
6509
6716
|
"minimum_config": false,
|
|
6510
6717
|
"create": false,
|
|
@@ -6520,6 +6727,8 @@
|
|
|
6520
6727
|
"description": "The set of labels present on this lma_region.",
|
|
6521
6728
|
"title": "Labels",
|
|
6522
6729
|
"x-displayname": "Labels",
|
|
6730
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6731
|
+
"x-f5xc-description-short": "The set of labels present on this lma_region.",
|
|
6523
6732
|
"x-f5xc-required-for": {
|
|
6524
6733
|
"minimum_config": false,
|
|
6525
6734
|
"create": false,
|
|
@@ -6547,7 +6756,7 @@
|
|
|
6547
6756
|
},
|
|
6548
6757
|
"x-original-maxLength": 1024,
|
|
6549
6758
|
"x-reconciled-from-discovery": true,
|
|
6550
|
-
"x-reconciled-at": "2026-01-
|
|
6759
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630218+00:00"
|
|
6551
6760
|
},
|
|
6552
6761
|
"namespace": {
|
|
6553
6762
|
"type": "string",
|
|
@@ -6566,7 +6775,7 @@
|
|
|
6566
6775
|
},
|
|
6567
6776
|
"x-original-maxLength": 1024,
|
|
6568
6777
|
"x-reconciled-from-discovery": true,
|
|
6569
|
-
"x-reconciled-at": "2026-01-
|
|
6778
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630222+00:00"
|
|
6570
6779
|
},
|
|
6571
6780
|
"owner_view": {
|
|
6572
6781
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -6579,6 +6788,7 @@
|
|
|
6579
6788
|
"$ref": "#/components/schemas/lma_regionStatusObject"
|
|
6580
6789
|
},
|
|
6581
6790
|
"x-displayname": "Status",
|
|
6791
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6582
6792
|
"x-f5xc-required-for": {
|
|
6583
6793
|
"minimum_config": false,
|
|
6584
6794
|
"create": false,
|
|
@@ -6607,7 +6817,7 @@
|
|
|
6607
6817
|
"x-field-mutability": "read-only",
|
|
6608
6818
|
"x-original-maxLength": 1024,
|
|
6609
6819
|
"x-reconciled-from-discovery": true,
|
|
6610
|
-
"x-reconciled-at": "2026-01-
|
|
6820
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630230+00:00"
|
|
6611
6821
|
},
|
|
6612
6822
|
"uid": {
|
|
6613
6823
|
"type": "string",
|
|
@@ -6628,9 +6838,11 @@
|
|
|
6628
6838
|
"x-original-maxLength": 1024,
|
|
6629
6839
|
"format": "uuid",
|
|
6630
6840
|
"x-reconciled-from-discovery": true,
|
|
6631
|
-
"x-reconciled-at": "2026-01-
|
|
6841
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630236+00:00"
|
|
6632
6842
|
}
|
|
6633
6843
|
},
|
|
6844
|
+
"x-f5xc-description-short": "By default a summary of lma_region is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6845
|
+
"x-f5xc-description-medium": "By default a summary of lma_region is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
6634
6846
|
"x-f5xc-minimum-configuration": {
|
|
6635
6847
|
"description": "Minimum configuration for lma_regionListResponseItem",
|
|
6636
6848
|
"required_fields": [
|
|
@@ -6670,6 +6882,7 @@
|
|
|
6670
6882
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
6671
6883
|
},
|
|
6672
6884
|
"x-displayname": "Conditions.",
|
|
6885
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
6673
6886
|
"x-f5xc-required-for": {
|
|
6674
6887
|
"minimum_config": false,
|
|
6675
6888
|
"create": false,
|
|
@@ -6696,6 +6909,7 @@
|
|
|
6696
6909
|
}
|
|
6697
6910
|
}
|
|
6698
6911
|
},
|
|
6912
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
6699
6913
|
"x-f5xc-minimum-configuration": {
|
|
6700
6914
|
"description": "Minimum configuration for lma_regionStatusObject",
|
|
6701
6915
|
"required_fields": [
|
|
@@ -6725,6 +6939,8 @@
|
|
|
6725
6939
|
"x-displayname": "Decryption Provider.",
|
|
6726
6940
|
"x-ves-example": "Value",
|
|
6727
6941
|
"x-f5xc-example": "value",
|
|
6942
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
6943
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
6728
6944
|
"minLength": 0,
|
|
6729
6945
|
"maxLength": 1024,
|
|
6730
6946
|
"x-f5xc-required-for": {
|
|
@@ -6750,6 +6966,8 @@
|
|
|
6750
6966
|
"ves.io.schema.rules.message.required": "true",
|
|
6751
6967
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
6752
6968
|
},
|
|
6969
|
+
"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.",
|
|
6970
|
+
"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.",
|
|
6753
6971
|
"minLength": 0,
|
|
6754
6972
|
"maxLength": 4,
|
|
6755
6973
|
"x-f5xc-required-for": {
|
|
@@ -6760,7 +6978,7 @@
|
|
|
6760
6978
|
},
|
|
6761
6979
|
"x-original-maxLength": 1024,
|
|
6762
6980
|
"x-reconciled-from-discovery": true,
|
|
6763
|
-
"x-reconciled-at": "2026-01-
|
|
6981
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630254+00:00"
|
|
6764
6982
|
},
|
|
6765
6983
|
"store_provider": {
|
|
6766
6984
|
"type": "string",
|
|
@@ -6769,6 +6987,8 @@
|
|
|
6769
6987
|
"x-displayname": "Store Provider.",
|
|
6770
6988
|
"x-ves-example": "Value",
|
|
6771
6989
|
"x-f5xc-example": "value",
|
|
6990
|
+
"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...",
|
|
6991
|
+
"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:///.",
|
|
6772
6992
|
"minLength": 0,
|
|
6773
6993
|
"maxLength": 1024,
|
|
6774
6994
|
"x-f5xc-required-for": {
|
|
@@ -6779,6 +6999,7 @@
|
|
|
6779
6999
|
}
|
|
6780
7000
|
}
|
|
6781
7001
|
},
|
|
7002
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
6782
7003
|
"x-f5xc-minimum-configuration": {
|
|
6783
7004
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
6784
7005
|
"required_fields": [
|
|
@@ -6808,6 +7029,8 @@
|
|
|
6808
7029
|
"x-displayname": "Provider",
|
|
6809
7030
|
"x-ves-example": "Box-provider.",
|
|
6810
7031
|
"x-f5xc-example": "box-provider",
|
|
7032
|
+
"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...",
|
|
7033
|
+
"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:///.",
|
|
6811
7034
|
"minLength": 0,
|
|
6812
7035
|
"maxLength": 8,
|
|
6813
7036
|
"x-f5xc-required-for": {
|
|
@@ -6818,7 +7041,7 @@
|
|
|
6818
7041
|
},
|
|
6819
7042
|
"x-original-maxLength": 1024,
|
|
6820
7043
|
"x-reconciled-from-discovery": true,
|
|
6821
|
-
"x-reconciled-at": "2026-01-
|
|
7044
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630260+00:00"
|
|
6822
7045
|
},
|
|
6823
7046
|
"url": {
|
|
6824
7047
|
"type": "string",
|
|
@@ -6839,6 +7062,8 @@
|
|
|
6839
7062
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
6840
7063
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
6841
7064
|
},
|
|
7065
|
+
"x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
|
|
7066
|
+
"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.",
|
|
6842
7067
|
"format": "uri",
|
|
6843
7068
|
"minLength": 0,
|
|
6844
7069
|
"x-f5xc-required-for": {
|
|
@@ -6849,6 +7074,7 @@
|
|
|
6849
7074
|
}
|
|
6850
7075
|
}
|
|
6851
7076
|
},
|
|
7077
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
6852
7078
|
"x-f5xc-minimum-configuration": {
|
|
6853
7079
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
6854
7080
|
"required_fields": [
|
|
@@ -6871,6 +7097,8 @@
|
|
|
6871
7097
|
"EncodingBase64"
|
|
6872
7098
|
],
|
|
6873
7099
|
"default": "EncodingNone",
|
|
7100
|
+
"x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
|
|
7101
|
+
"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.",
|
|
6874
7102
|
"x-f5xc-minimum-configuration": {
|
|
6875
7103
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
6876
7104
|
"required_fields": [],
|
|
@@ -6896,6 +7124,7 @@
|
|
|
6896
7124
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
6897
7125
|
}
|
|
6898
7126
|
},
|
|
7127
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
6899
7128
|
"x-f5xc-minimum-configuration": {
|
|
6900
7129
|
"description": "Minimum configuration for schemaSecretType",
|
|
6901
7130
|
"required_fields": [
|
|
@@ -6919,6 +7148,8 @@
|
|
|
6919
7148
|
"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.",
|
|
6920
7149
|
"title": "Key",
|
|
6921
7150
|
"x-f5xc-example": "key_pem",
|
|
7151
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
|
|
7152
|
+
"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.",
|
|
6922
7153
|
"minLength": 0,
|
|
6923
7154
|
"maxLength": 16,
|
|
6924
7155
|
"x-f5xc-required-for": {
|
|
@@ -6929,13 +7160,14 @@
|
|
|
6929
7160
|
},
|
|
6930
7161
|
"x-original-maxLength": 1024,
|
|
6931
7162
|
"x-reconciled-from-discovery": true,
|
|
6932
|
-
"x-reconciled-at": "2026-01-
|
|
7163
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630367+00:00"
|
|
6933
7164
|
},
|
|
6934
7165
|
"location": {
|
|
6935
7166
|
"type": "string",
|
|
6936
7167
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
6937
7168
|
"title": "Location",
|
|
6938
7169
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
7170
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
6939
7171
|
"minLength": 0,
|
|
6940
7172
|
"maxLength": 4,
|
|
6941
7173
|
"x-f5xc-required-for": {
|
|
@@ -6946,13 +7178,15 @@
|
|
|
6946
7178
|
},
|
|
6947
7179
|
"x-original-maxLength": 1024,
|
|
6948
7180
|
"x-reconciled-from-discovery": true,
|
|
6949
|
-
"x-reconciled-at": "2026-01-
|
|
7181
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630371+00:00"
|
|
6950
7182
|
},
|
|
6951
7183
|
"provider": {
|
|
6952
7184
|
"type": "string",
|
|
6953
7185
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
6954
7186
|
"title": "Provider",
|
|
6955
7187
|
"x-f5xc-example": "vault-vh-provider",
|
|
7188
|
+
"x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
7189
|
+
"x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
6956
7190
|
"minLength": 0,
|
|
6957
7191
|
"maxLength": 8,
|
|
6958
7192
|
"x-f5xc-required-for": {
|
|
@@ -6963,7 +7197,7 @@
|
|
|
6963
7197
|
},
|
|
6964
7198
|
"x-original-maxLength": 1024,
|
|
6965
7199
|
"x-reconciled-from-discovery": true,
|
|
6966
|
-
"x-reconciled-at": "2026-01-
|
|
7200
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630376+00:00"
|
|
6967
7201
|
},
|
|
6968
7202
|
"secret_encoding": {
|
|
6969
7203
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -6974,6 +7208,8 @@
|
|
|
6974
7208
|
"title": "Version",
|
|
6975
7209
|
"format": "int64",
|
|
6976
7210
|
"x-f5xc-example": "1",
|
|
7211
|
+
"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.",
|
|
7212
|
+
"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.",
|
|
6977
7213
|
"minimum": 0,
|
|
6978
7214
|
"maximum": 2147483647,
|
|
6979
7215
|
"x-f5xc-required-for": {
|
|
@@ -6985,9 +7221,11 @@
|
|
|
6985
7221
|
"maxLength": 1,
|
|
6986
7222
|
"minLength": 1,
|
|
6987
7223
|
"x-reconciled-from-discovery": true,
|
|
6988
|
-
"x-reconciled-at": "2026-01-
|
|
7224
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630382+00:00"
|
|
6989
7225
|
}
|
|
6990
7226
|
},
|
|
7227
|
+
"x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
7228
|
+
"x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
6991
7229
|
"x-f5xc-minimum-configuration": {
|
|
6992
7230
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
6993
7231
|
"required_fields": [
|
|
@@ -7014,6 +7252,7 @@
|
|
|
7014
7252
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
7015
7253
|
"title": "Name",
|
|
7016
7254
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
7255
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
7017
7256
|
"minLength": 0,
|
|
7018
7257
|
"maxLength": 16,
|
|
7019
7258
|
"x-f5xc-required-for": {
|
|
@@ -7024,9 +7263,10 @@
|
|
|
7024
7263
|
},
|
|
7025
7264
|
"x-original-maxLength": 1024,
|
|
7026
7265
|
"x-reconciled-from-discovery": true,
|
|
7027
|
-
"x-reconciled-at": "2026-01-
|
|
7266
|
+
"x-reconciled-at": "2026-01-07T15:53:34.630404+00:00"
|
|
7028
7267
|
}
|
|
7029
7268
|
},
|
|
7269
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
7030
7270
|
"x-f5xc-minimum-configuration": {
|
|
7031
7271
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
7032
7272
|
"required_fields": [
|
|
@@ -7066,6 +7306,8 @@
|
|
|
7066
7306
|
"ves.io.schema.rules.repeated.max_items": "17",
|
|
7067
7307
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7068
7308
|
},
|
|
7309
|
+
"x-f5xc-description-short": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
|
|
7310
|
+
"x-f5xc-description-medium": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
|
|
7069
7311
|
"x-f5xc-required-for": {
|
|
7070
7312
|
"minimum_config": false,
|
|
7071
7313
|
"create": false,
|
|
@@ -7086,6 +7328,8 @@
|
|
|
7086
7328
|
"x-validation-rules": {
|
|
7087
7329
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7088
7330
|
},
|
|
7331
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7332
|
+
"x-f5xc-description-short": "Select your custom data types to be monitored in the API discovery.",
|
|
7089
7333
|
"x-f5xc-required-for": {
|
|
7090
7334
|
"minimum_config": false,
|
|
7091
7335
|
"create": false,
|
|
@@ -7112,6 +7356,9 @@
|
|
|
7112
7356
|
"ves.io.schema.rules.repeated.unique": "true",
|
|
7113
7357
|
"ves.io.schema.rules.string.max_len": "64"
|
|
7114
7358
|
},
|
|
7359
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7360
|
+
"x-f5xc-description-short": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
|
|
7361
|
+
"x-f5xc-description-medium": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
|
|
7115
7362
|
"x-f5xc-required-for": {
|
|
7116
7363
|
"minimum_config": false,
|
|
7117
7364
|
"create": false,
|
|
@@ -7120,6 +7367,7 @@
|
|
|
7120
7367
|
}
|
|
7121
7368
|
}
|
|
7122
7369
|
},
|
|
7370
|
+
"x-f5xc-description-short": "Create sensitive_data_policy creates a new object in the storage backend for metadata.namespace.",
|
|
7123
7371
|
"x-f5xc-minimum-configuration": {
|
|
7124
7372
|
"description": "Minimum configuration for schemasensitive_data_policyCreateSpecType",
|
|
7125
7373
|
"required_fields": [
|
|
@@ -7161,6 +7409,8 @@
|
|
|
7161
7409
|
"ves.io.schema.rules.repeated.max_items": "17",
|
|
7162
7410
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7163
7411
|
},
|
|
7412
|
+
"x-f5xc-description-short": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
|
|
7413
|
+
"x-f5xc-description-medium": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
|
|
7164
7414
|
"x-f5xc-required-for": {
|
|
7165
7415
|
"minimum_config": false,
|
|
7166
7416
|
"create": false,
|
|
@@ -7181,6 +7431,8 @@
|
|
|
7181
7431
|
"x-validation-rules": {
|
|
7182
7432
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7183
7433
|
},
|
|
7434
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7435
|
+
"x-f5xc-description-short": "Select your custom data types to be monitored in the API discovery.",
|
|
7184
7436
|
"x-f5xc-required-for": {
|
|
7185
7437
|
"minimum_config": false,
|
|
7186
7438
|
"create": false,
|
|
@@ -7207,6 +7459,9 @@
|
|
|
7207
7459
|
"ves.io.schema.rules.repeated.unique": "true",
|
|
7208
7460
|
"ves.io.schema.rules.string.max_len": "64"
|
|
7209
7461
|
},
|
|
7462
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7463
|
+
"x-f5xc-description-short": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
|
|
7464
|
+
"x-f5xc-description-medium": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
|
|
7210
7465
|
"x-f5xc-required-for": {
|
|
7211
7466
|
"minimum_config": false,
|
|
7212
7467
|
"create": false,
|
|
@@ -7215,6 +7470,7 @@
|
|
|
7215
7470
|
}
|
|
7216
7471
|
}
|
|
7217
7472
|
},
|
|
7473
|
+
"x-f5xc-description-short": "GET sensitive_data_policy reads a given object from storage backend for metadata.namespace.",
|
|
7218
7474
|
"x-f5xc-minimum-configuration": {
|
|
7219
7475
|
"description": "Minimum configuration for schemasensitive_data_policyGetSpecType",
|
|
7220
7476
|
"required_fields": [
|
|
@@ -7256,6 +7512,8 @@
|
|
|
7256
7512
|
"ves.io.schema.rules.repeated.max_items": "17",
|
|
7257
7513
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7258
7514
|
},
|
|
7515
|
+
"x-f5xc-description-short": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
|
|
7516
|
+
"x-f5xc-description-medium": "Select relevant compliance frameworks, such as GDPR, HIPAA, or PCI-DSS, to ensure monitoring under your sensitive data discovery.",
|
|
7259
7517
|
"x-f5xc-required-for": {
|
|
7260
7518
|
"minimum_config": false,
|
|
7261
7519
|
"create": false,
|
|
@@ -7276,6 +7534,8 @@
|
|
|
7276
7534
|
"x-validation-rules": {
|
|
7277
7535
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7278
7536
|
},
|
|
7537
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7538
|
+
"x-f5xc-description-short": "Select your custom data types to be monitored in the API discovery.",
|
|
7279
7539
|
"x-f5xc-required-for": {
|
|
7280
7540
|
"minimum_config": false,
|
|
7281
7541
|
"create": false,
|
|
@@ -7302,6 +7562,9 @@
|
|
|
7302
7562
|
"ves.io.schema.rules.repeated.unique": "true",
|
|
7303
7563
|
"ves.io.schema.rules.string.max_len": "64"
|
|
7304
7564
|
},
|
|
7565
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7566
|
+
"x-f5xc-description-short": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
|
|
7567
|
+
"x-f5xc-description-medium": "Select which pre-configured data types to disable, disabled data types will not be shown as sensitive in the API discovery.",
|
|
7305
7568
|
"x-f5xc-required-for": {
|
|
7306
7569
|
"minimum_config": false,
|
|
7307
7570
|
"create": false,
|
|
@@ -7310,6 +7573,8 @@
|
|
|
7310
7573
|
}
|
|
7311
7574
|
}
|
|
7312
7575
|
},
|
|
7576
|
+
"x-f5xc-description-short": "Replace sensitive_data_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
7577
|
+
"x-f5xc-description-medium": "Replace sensitive_data_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
7313
7578
|
"x-f5xc-minimum-configuration": {
|
|
7314
7579
|
"description": "Minimum configuration for schemasensitive_data_policyReplaceSpecType",
|
|
7315
7580
|
"required_fields": [
|
|
@@ -7339,6 +7604,7 @@
|
|
|
7339
7604
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
7340
7605
|
},
|
|
7341
7606
|
"x-displayname": "Conditions.",
|
|
7607
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
7342
7608
|
"x-f5xc-required-for": {
|
|
7343
7609
|
"minimum_config": false,
|
|
7344
7610
|
"create": false,
|
|
@@ -7365,6 +7631,7 @@
|
|
|
7365
7631
|
}
|
|
7366
7632
|
}
|
|
7367
7633
|
},
|
|
7634
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
7368
7635
|
"x-f5xc-minimum-configuration": {
|
|
7369
7636
|
"description": "Minimum configuration for schemasensitive_data_policyStatusObject",
|
|
7370
7637
|
"required_fields": [
|
|
@@ -7406,6 +7673,8 @@
|
|
|
7406
7673
|
"ves.io.schema.rules.string.max_bytes": "128",
|
|
7407
7674
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
7408
7675
|
},
|
|
7676
|
+
"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.",
|
|
7677
|
+
"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.",
|
|
7409
7678
|
"x-f5xc-required-for": {
|
|
7410
7679
|
"minimum_config": false,
|
|
7411
7680
|
"create": false,
|
|
@@ -7414,7 +7683,7 @@
|
|
|
7414
7683
|
},
|
|
7415
7684
|
"x-original-maxLength": 128,
|
|
7416
7685
|
"x-reconciled-from-discovery": true,
|
|
7417
|
-
"x-reconciled-at": "2026-01-
|
|
7686
|
+
"x-reconciled-at": "2026-01-07T15:53:59.649959+00:00"
|
|
7418
7687
|
},
|
|
7419
7688
|
"namespace": {
|
|
7420
7689
|
"type": "string",
|
|
@@ -7430,6 +7699,8 @@
|
|
|
7430
7699
|
"x-validation-rules": {
|
|
7431
7700
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
7432
7701
|
},
|
|
7702
|
+
"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.",
|
|
7703
|
+
"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.",
|
|
7433
7704
|
"minLength": 0,
|
|
7434
7705
|
"x-f5xc-required-for": {
|
|
7435
7706
|
"minimum_config": false,
|
|
@@ -7439,7 +7710,7 @@
|
|
|
7439
7710
|
},
|
|
7440
7711
|
"x-original-maxLength": 64,
|
|
7441
7712
|
"x-reconciled-from-discovery": true,
|
|
7442
|
-
"x-reconciled-at": "2026-01-
|
|
7713
|
+
"x-reconciled-at": "2026-01-07T15:53:59.649963+00:00"
|
|
7443
7714
|
},
|
|
7444
7715
|
"tenant": {
|
|
7445
7716
|
"type": "string",
|
|
@@ -7455,6 +7726,8 @@
|
|
|
7455
7726
|
"x-validation-rules": {
|
|
7456
7727
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
7457
7728
|
},
|
|
7729
|
+
"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.",
|
|
7730
|
+
"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.",
|
|
7458
7731
|
"minLength": 0,
|
|
7459
7732
|
"x-f5xc-required-for": {
|
|
7460
7733
|
"minimum_config": false,
|
|
@@ -7466,9 +7739,11 @@
|
|
|
7466
7739
|
"x-field-mutability": "read-only",
|
|
7467
7740
|
"x-original-maxLength": 64,
|
|
7468
7741
|
"x-reconciled-from-discovery": true,
|
|
7469
|
-
"x-reconciled-at": "2026-01-
|
|
7742
|
+
"x-reconciled-at": "2026-01-07T15:53:59.649968+00:00"
|
|
7470
7743
|
}
|
|
7471
7744
|
},
|
|
7745
|
+
"x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
|
|
7746
|
+
"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.",
|
|
7472
7747
|
"x-f5xc-minimum-configuration": {
|
|
7473
7748
|
"description": "Minimum configuration for schemaviewsObjectRefType",
|
|
7474
7749
|
"required_fields": [
|
|
@@ -7574,6 +7849,7 @@
|
|
|
7574
7849
|
"title": "Fail_if_referred.",
|
|
7575
7850
|
"format": "boolean",
|
|
7576
7851
|
"x-displayname": "Fail-If-Referred.",
|
|
7852
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
7577
7853
|
"x-f5xc-required-for": {
|
|
7578
7854
|
"minimum_config": false,
|
|
7579
7855
|
"create": false,
|
|
@@ -7598,7 +7874,7 @@
|
|
|
7598
7874
|
},
|
|
7599
7875
|
"x-original-maxLength": 1024,
|
|
7600
7876
|
"x-reconciled-from-discovery": true,
|
|
7601
|
-
"x-reconciled-at": "2026-01-
|
|
7877
|
+
"x-reconciled-at": "2026-01-07T15:53:59.649982+00:00"
|
|
7602
7878
|
},
|
|
7603
7879
|
"namespace": {
|
|
7604
7880
|
"type": "string",
|
|
@@ -7607,6 +7883,7 @@
|
|
|
7607
7883
|
"x-displayname": "Namespace",
|
|
7608
7884
|
"x-ves-example": "Ns1",
|
|
7609
7885
|
"x-f5xc-example": "ns1",
|
|
7886
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
7610
7887
|
"minLength": 0,
|
|
7611
7888
|
"maxLength": 6,
|
|
7612
7889
|
"x-f5xc-required-for": {
|
|
@@ -7617,7 +7894,7 @@
|
|
|
7617
7894
|
},
|
|
7618
7895
|
"x-original-maxLength": 1024,
|
|
7619
7896
|
"x-reconciled-from-discovery": true,
|
|
7620
|
-
"x-reconciled-at": "2026-01-
|
|
7897
|
+
"x-reconciled-at": "2026-01-07T15:53:59.649986+00:00"
|
|
7621
7898
|
}
|
|
7622
7899
|
},
|
|
7623
7900
|
"x-f5xc-minimum-configuration": {
|
|
@@ -7652,6 +7929,7 @@
|
|
|
7652
7929
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
7653
7930
|
},
|
|
7654
7931
|
"x-displayname": "Deleted Referred Objects.",
|
|
7932
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
7655
7933
|
"x-f5xc-required-for": {
|
|
7656
7934
|
"minimum_config": false,
|
|
7657
7935
|
"create": false,
|
|
@@ -7667,6 +7945,7 @@
|
|
|
7667
7945
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
7668
7946
|
},
|
|
7669
7947
|
"x-displayname": "Disabled Referred Objects.",
|
|
7948
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
7670
7949
|
"x-f5xc-required-for": {
|
|
7671
7950
|
"minimum_config": false,
|
|
7672
7951
|
"create": false,
|
|
@@ -7685,6 +7964,7 @@
|
|
|
7685
7964
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
7686
7965
|
},
|
|
7687
7966
|
"x-displayname": "Referring Objects.",
|
|
7967
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
7688
7968
|
"x-f5xc-required-for": {
|
|
7689
7969
|
"minimum_config": false,
|
|
7690
7970
|
"create": false,
|
|
@@ -7706,6 +7986,8 @@
|
|
|
7706
7986
|
"$ref": "#/components/schemas/schemasensitive_data_policyStatusObject"
|
|
7707
7987
|
},
|
|
7708
7988
|
"x-displayname": "Status",
|
|
7989
|
+
"x-f5xc-example": "active",
|
|
7990
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
7709
7991
|
"x-f5xc-required-for": {
|
|
7710
7992
|
"minimum_config": false,
|
|
7711
7993
|
"create": false,
|
|
@@ -7715,7 +7997,7 @@
|
|
|
7715
7997
|
"maxLength": 17,
|
|
7716
7998
|
"minLength": 17,
|
|
7717
7999
|
"x-reconciled-from-discovery": true,
|
|
7718
|
-
"x-reconciled-at": "2026-01-
|
|
8000
|
+
"x-reconciled-at": "2026-01-07T15:53:59.649999+00:00"
|
|
7719
8001
|
},
|
|
7720
8002
|
"system_metadata": {
|
|
7721
8003
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -7755,6 +8037,8 @@
|
|
|
7755
8037
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
7756
8038
|
],
|
|
7757
8039
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
8040
|
+
"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...",
|
|
8041
|
+
"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...",
|
|
7758
8042
|
"x-f5xc-minimum-configuration": {
|
|
7759
8043
|
"description": "Minimum configuration for sensitive_data_policyGetResponseFormatCode",
|
|
7760
8044
|
"required_fields": [],
|
|
@@ -7780,6 +8064,7 @@
|
|
|
7780
8064
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
7781
8065
|
},
|
|
7782
8066
|
"x-displayname": "Errors",
|
|
8067
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
7783
8068
|
"x-f5xc-required-for": {
|
|
7784
8069
|
"minimum_config": false,
|
|
7785
8070
|
"create": false,
|
|
@@ -7795,6 +8080,8 @@
|
|
|
7795
8080
|
"$ref": "#/components/schemas/sensitive_data_policyListResponseItem"
|
|
7796
8081
|
},
|
|
7797
8082
|
"x-displayname": "Items",
|
|
8083
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
8084
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
7798
8085
|
"x-f5xc-required-for": {
|
|
7799
8086
|
"minimum_config": false,
|
|
7800
8087
|
"create": false,
|
|
@@ -7828,6 +8115,8 @@
|
|
|
7828
8115
|
"description": "The set of annotations present on this sensitive_data_policy.",
|
|
7829
8116
|
"title": "Annotations.",
|
|
7830
8117
|
"x-displayname": "Annotations.",
|
|
8118
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
8119
|
+
"x-f5xc-description-short": "The set of annotations present on this sensitive_data_policy.",
|
|
7831
8120
|
"x-f5xc-required-for": {
|
|
7832
8121
|
"minimum_config": false,
|
|
7833
8122
|
"create": false,
|
|
@@ -7840,6 +8129,7 @@
|
|
|
7840
8129
|
"description": "The description set for this sensitive_data_policy.",
|
|
7841
8130
|
"title": "Description.",
|
|
7842
8131
|
"x-displayname": "Description.",
|
|
8132
|
+
"x-f5xc-description-short": "The description set for this sensitive_data_policy.",
|
|
7843
8133
|
"minLength": 0,
|
|
7844
8134
|
"maxLength": 0,
|
|
7845
8135
|
"x-f5xc-required-for": {
|
|
@@ -7850,7 +8140,7 @@
|
|
|
7850
8140
|
},
|
|
7851
8141
|
"x-original-maxLength": 1024,
|
|
7852
8142
|
"x-reconciled-from-discovery": true,
|
|
7853
|
-
"x-reconciled-at": "2026-01-
|
|
8143
|
+
"x-reconciled-at": "2026-01-07T15:53:59.650011+00:00"
|
|
7854
8144
|
},
|
|
7855
8145
|
"disabled": {
|
|
7856
8146
|
"type": "boolean",
|
|
@@ -7858,6 +8148,8 @@
|
|
|
7858
8148
|
"title": "Disabled",
|
|
7859
8149
|
"format": "boolean",
|
|
7860
8150
|
"x-displayname": "Disabled",
|
|
8151
|
+
"x-f5xc-example": "True",
|
|
8152
|
+
"x-f5xc-description-short": "Value of true indicates sensitive_data_policy is administratively disabled.",
|
|
7861
8153
|
"x-f5xc-required-for": {
|
|
7862
8154
|
"minimum_config": false,
|
|
7863
8155
|
"create": false,
|
|
@@ -7873,6 +8165,8 @@
|
|
|
7873
8165
|
"description": "The set of labels present on this sensitive_data_policy.",
|
|
7874
8166
|
"title": "Labels",
|
|
7875
8167
|
"x-displayname": "Labels",
|
|
8168
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
8169
|
+
"x-f5xc-description-short": "The set of labels present on this sensitive_data_policy.",
|
|
7876
8170
|
"x-f5xc-required-for": {
|
|
7877
8171
|
"minimum_config": false,
|
|
7878
8172
|
"create": false,
|
|
@@ -7900,7 +8194,7 @@
|
|
|
7900
8194
|
},
|
|
7901
8195
|
"x-original-maxLength": 1024,
|
|
7902
8196
|
"x-reconciled-from-discovery": true,
|
|
7903
|
-
"x-reconciled-at": "2026-01-
|
|
8197
|
+
"x-reconciled-at": "2026-01-07T15:53:59.650020+00:00"
|
|
7904
8198
|
},
|
|
7905
8199
|
"namespace": {
|
|
7906
8200
|
"type": "string",
|
|
@@ -7919,7 +8213,7 @@
|
|
|
7919
8213
|
},
|
|
7920
8214
|
"x-original-maxLength": 1024,
|
|
7921
8215
|
"x-reconciled-from-discovery": true,
|
|
7922
|
-
"x-reconciled-at": "2026-01-
|
|
8216
|
+
"x-reconciled-at": "2026-01-07T15:53:59.650024+00:00"
|
|
7923
8217
|
},
|
|
7924
8218
|
"owner_view": {
|
|
7925
8219
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -7932,6 +8226,7 @@
|
|
|
7932
8226
|
"$ref": "#/components/schemas/schemasensitive_data_policyStatusObject"
|
|
7933
8227
|
},
|
|
7934
8228
|
"x-displayname": "Status",
|
|
8229
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
7935
8230
|
"x-f5xc-required-for": {
|
|
7936
8231
|
"minimum_config": false,
|
|
7937
8232
|
"create": false,
|
|
@@ -7960,7 +8255,7 @@
|
|
|
7960
8255
|
"x-field-mutability": "read-only",
|
|
7961
8256
|
"x-original-maxLength": 1024,
|
|
7962
8257
|
"x-reconciled-from-discovery": true,
|
|
7963
|
-
"x-reconciled-at": "2026-01-
|
|
8258
|
+
"x-reconciled-at": "2026-01-07T15:53:59.650032+00:00"
|
|
7964
8259
|
},
|
|
7965
8260
|
"uid": {
|
|
7966
8261
|
"type": "string",
|
|
@@ -7969,6 +8264,7 @@
|
|
|
7969
8264
|
"x-displayname": "UID",
|
|
7970
8265
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
7971
8266
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
8267
|
+
"x-f5xc-description-short": "The unique uid of this sensitive_data_policy.",
|
|
7972
8268
|
"minLength": 0,
|
|
7973
8269
|
"maxLength": 36,
|
|
7974
8270
|
"x-f5xc-required-for": {
|
|
@@ -7981,9 +8277,11 @@
|
|
|
7981
8277
|
"x-original-maxLength": 1024,
|
|
7982
8278
|
"format": "uuid",
|
|
7983
8279
|
"x-reconciled-from-discovery": true,
|
|
7984
|
-
"x-reconciled-at": "2026-01-
|
|
8280
|
+
"x-reconciled-at": "2026-01-07T15:53:59.650036+00:00"
|
|
7985
8281
|
}
|
|
7986
8282
|
},
|
|
8283
|
+
"x-f5xc-description-short": "By default a summary of sensitive_data_policy is returned in 'List'.",
|
|
8284
|
+
"x-f5xc-description-medium": "By default a summary of sensitive_data_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
7987
8285
|
"x-f5xc-minimum-configuration": {
|
|
7988
8286
|
"description": "Minimum configuration for sensitive_data_policyListResponseItem",
|
|
7989
8287
|
"required_fields": [
|