@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": "Nginx One",
|
|
5
5
|
"description": "Dataplane server registration with health status tracking and location awareness. Service discovery bindings for dynamic upstream resolution. Cloud service gateway integration for hybrid deployments. WAF policy attachment and instance-level security controls.",
|
|
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"
|
|
@@ -3288,6 +3288,7 @@
|
|
|
3288
3288
|
"title": "Empty",
|
|
3289
3289
|
"x-displayname": "Empty",
|
|
3290
3290
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
3291
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
3291
3292
|
"x-f5xc-minimum-configuration": {
|
|
3292
3293
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
3293
3294
|
"required_fields": [],
|
|
@@ -3312,6 +3313,8 @@
|
|
|
3312
3313
|
"x-displayname": "Kind",
|
|
3313
3314
|
"x-ves-example": "Virtual_site.",
|
|
3314
3315
|
"x-f5xc-example": "virtual_site",
|
|
3316
|
+
"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\")",
|
|
3317
|
+
"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\").",
|
|
3315
3318
|
"minLength": 0,
|
|
3316
3319
|
"maxLength": 14,
|
|
3317
3320
|
"x-f5xc-required-for": {
|
|
@@ -3323,7 +3326,7 @@
|
|
|
3323
3326
|
"readOnly": true,
|
|
3324
3327
|
"x-original-maxLength": 1024,
|
|
3325
3328
|
"x-reconciled-from-discovery": true,
|
|
3326
|
-
"x-reconciled-at": "2026-01-
|
|
3329
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178036+00:00"
|
|
3327
3330
|
},
|
|
3328
3331
|
"name": {
|
|
3329
3332
|
"type": "string",
|
|
@@ -3332,6 +3335,8 @@
|
|
|
3332
3335
|
"x-displayname": "Name",
|
|
3333
3336
|
"x-ves-example": "Contactus-route.",
|
|
3334
3337
|
"x-f5xc-example": "contactus-route",
|
|
3338
|
+
"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.",
|
|
3339
|
+
"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.",
|
|
3335
3340
|
"minLength": 0,
|
|
3336
3341
|
"maxLength": 16,
|
|
3337
3342
|
"x-f5xc-required-for": {
|
|
@@ -3342,7 +3347,7 @@
|
|
|
3342
3347
|
},
|
|
3343
3348
|
"x-original-maxLength": 1024,
|
|
3344
3349
|
"x-reconciled-from-discovery": true,
|
|
3345
|
-
"x-reconciled-at": "2026-01-
|
|
3350
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178044+00:00"
|
|
3346
3351
|
},
|
|
3347
3352
|
"namespace": {
|
|
3348
3353
|
"type": "string",
|
|
@@ -3351,6 +3356,8 @@
|
|
|
3351
3356
|
"x-displayname": "Namespace",
|
|
3352
3357
|
"x-ves-example": "Ns1",
|
|
3353
3358
|
"x-f5xc-example": "ns1",
|
|
3359
|
+
"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.",
|
|
3360
|
+
"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.",
|
|
3354
3361
|
"minLength": 0,
|
|
3355
3362
|
"maxLength": 6,
|
|
3356
3363
|
"x-f5xc-required-for": {
|
|
@@ -3361,7 +3368,7 @@
|
|
|
3361
3368
|
},
|
|
3362
3369
|
"x-original-maxLength": 1024,
|
|
3363
3370
|
"x-reconciled-from-discovery": true,
|
|
3364
|
-
"x-reconciled-at": "2026-01-
|
|
3371
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178049+00:00"
|
|
3365
3372
|
},
|
|
3366
3373
|
"tenant": {
|
|
3367
3374
|
"type": "string",
|
|
@@ -3370,6 +3377,8 @@
|
|
|
3370
3377
|
"x-displayname": "Tenant",
|
|
3371
3378
|
"x-ves-example": "Example-corp.",
|
|
3372
3379
|
"x-f5xc-example": "example-corp",
|
|
3380
|
+
"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.",
|
|
3381
|
+
"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.",
|
|
3373
3382
|
"minLength": 0,
|
|
3374
3383
|
"maxLength": 18,
|
|
3375
3384
|
"x-f5xc-required-for": {
|
|
@@ -3382,7 +3391,7 @@
|
|
|
3382
3391
|
"x-field-mutability": "read-only",
|
|
3383
3392
|
"x-original-maxLength": 1024,
|
|
3384
3393
|
"x-reconciled-from-discovery": true,
|
|
3385
|
-
"x-reconciled-at": "2026-01-
|
|
3394
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178053+00:00"
|
|
3386
3395
|
},
|
|
3387
3396
|
"uid": {
|
|
3388
3397
|
"type": "string",
|
|
@@ -3391,6 +3400,8 @@
|
|
|
3391
3400
|
"x-displayname": "UID",
|
|
3392
3401
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
3393
3402
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
3403
|
+
"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.",
|
|
3404
|
+
"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.",
|
|
3394
3405
|
"minLength": 0,
|
|
3395
3406
|
"maxLength": 36,
|
|
3396
3407
|
"x-f5xc-required-for": {
|
|
@@ -3404,9 +3415,11 @@
|
|
|
3404
3415
|
"x-original-maxLength": 1024,
|
|
3405
3416
|
"format": "uuid",
|
|
3406
3417
|
"x-reconciled-from-discovery": true,
|
|
3407
|
-
"x-reconciled-at": "2026-01-
|
|
3418
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178059+00:00"
|
|
3408
3419
|
}
|
|
3409
3420
|
},
|
|
3421
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
3422
|
+
"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...",
|
|
3410
3423
|
"x-f5xc-minimum-configuration": {
|
|
3411
3424
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
3412
3425
|
"required_fields": [
|
|
@@ -3438,6 +3451,7 @@
|
|
|
3438
3451
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
3439
3452
|
},
|
|
3440
3453
|
"x-displayname": "Deleted Referred Objects.",
|
|
3454
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
3441
3455
|
"x-f5xc-required-for": {
|
|
3442
3456
|
"minimum_config": false,
|
|
3443
3457
|
"create": false,
|
|
@@ -3453,6 +3467,7 @@
|
|
|
3453
3467
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
3454
3468
|
},
|
|
3455
3469
|
"x-displayname": "Disabled Referred Objects.",
|
|
3470
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
3456
3471
|
"x-f5xc-required-for": {
|
|
3457
3472
|
"minimum_config": false,
|
|
3458
3473
|
"create": false,
|
|
@@ -3471,6 +3486,7 @@
|
|
|
3471
3486
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
3472
3487
|
},
|
|
3473
3488
|
"x-displayname": "Referring Objects.",
|
|
3489
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
3474
3490
|
"x-f5xc-required-for": {
|
|
3475
3491
|
"minimum_config": false,
|
|
3476
3492
|
"create": false,
|
|
@@ -3513,6 +3529,8 @@
|
|
|
3513
3529
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
3514
3530
|
],
|
|
3515
3531
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
3532
|
+
"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...",
|
|
3533
|
+
"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_READ: x-displayName: \"GetSpecType format\" Response should be in format...",
|
|
3516
3534
|
"x-f5xc-minimum-configuration": {
|
|
3517
3535
|
"description": "Minimum configuration for nginx_csgGetResponseFormatCode",
|
|
3518
3536
|
"required_fields": [],
|
|
@@ -3538,6 +3556,7 @@
|
|
|
3538
3556
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
3539
3557
|
},
|
|
3540
3558
|
"x-displayname": "Errors",
|
|
3559
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
3541
3560
|
"x-f5xc-required-for": {
|
|
3542
3561
|
"minimum_config": false,
|
|
3543
3562
|
"create": false,
|
|
@@ -3553,6 +3572,8 @@
|
|
|
3553
3572
|
"$ref": "#/components/schemas/nginx_csgListResponseItem"
|
|
3554
3573
|
},
|
|
3555
3574
|
"x-displayname": "Items",
|
|
3575
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
3576
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
3556
3577
|
"x-f5xc-required-for": {
|
|
3557
3578
|
"minimum_config": false,
|
|
3558
3579
|
"create": false,
|
|
@@ -3586,6 +3607,8 @@
|
|
|
3586
3607
|
"description": "The set of annotations present on this nginx_csg.",
|
|
3587
3608
|
"title": "Annotations.",
|
|
3588
3609
|
"x-displayname": "Annotations.",
|
|
3610
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
3611
|
+
"x-f5xc-description-short": "The set of annotations present on this nginx_csg.",
|
|
3589
3612
|
"x-f5xc-required-for": {
|
|
3590
3613
|
"minimum_config": false,
|
|
3591
3614
|
"create": false,
|
|
@@ -3608,7 +3631,7 @@
|
|
|
3608
3631
|
},
|
|
3609
3632
|
"x-original-maxLength": 1024,
|
|
3610
3633
|
"x-reconciled-from-discovery": true,
|
|
3611
|
-
"x-reconciled-at": "2026-01-
|
|
3634
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178079+00:00"
|
|
3612
3635
|
},
|
|
3613
3636
|
"disabled": {
|
|
3614
3637
|
"type": "boolean",
|
|
@@ -3616,6 +3639,8 @@
|
|
|
3616
3639
|
"title": "Disabled",
|
|
3617
3640
|
"format": "boolean",
|
|
3618
3641
|
"x-displayname": "Disabled",
|
|
3642
|
+
"x-f5xc-example": "True",
|
|
3643
|
+
"x-f5xc-description-short": "Value of true indicates nginx_csg is administratively disabled.",
|
|
3619
3644
|
"x-f5xc-required-for": {
|
|
3620
3645
|
"minimum_config": false,
|
|
3621
3646
|
"create": false,
|
|
@@ -3631,6 +3656,8 @@
|
|
|
3631
3656
|
"description": "The set of labels present on this nginx_csg.",
|
|
3632
3657
|
"title": "Labels",
|
|
3633
3658
|
"x-displayname": "Labels",
|
|
3659
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
3660
|
+
"x-f5xc-description-short": "The set of labels present on this nginx_csg.",
|
|
3634
3661
|
"x-f5xc-required-for": {
|
|
3635
3662
|
"minimum_config": false,
|
|
3636
3663
|
"create": false,
|
|
@@ -3658,7 +3685,7 @@
|
|
|
3658
3685
|
},
|
|
3659
3686
|
"x-original-maxLength": 1024,
|
|
3660
3687
|
"x-reconciled-from-discovery": true,
|
|
3661
|
-
"x-reconciled-at": "2026-01-
|
|
3688
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178090+00:00"
|
|
3662
3689
|
},
|
|
3663
3690
|
"namespace": {
|
|
3664
3691
|
"type": "string",
|
|
@@ -3677,7 +3704,7 @@
|
|
|
3677
3704
|
},
|
|
3678
3705
|
"x-original-maxLength": 1024,
|
|
3679
3706
|
"x-reconciled-from-discovery": true,
|
|
3680
|
-
"x-reconciled-at": "2026-01-
|
|
3707
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178094+00:00"
|
|
3681
3708
|
},
|
|
3682
3709
|
"owner_view": {
|
|
3683
3710
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -3703,7 +3730,7 @@
|
|
|
3703
3730
|
"x-field-mutability": "read-only",
|
|
3704
3731
|
"x-original-maxLength": 1024,
|
|
3705
3732
|
"x-reconciled-from-discovery": true,
|
|
3706
|
-
"x-reconciled-at": "2026-01-
|
|
3733
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178101+00:00"
|
|
3707
3734
|
},
|
|
3708
3735
|
"uid": {
|
|
3709
3736
|
"type": "string",
|
|
@@ -3724,9 +3751,11 @@
|
|
|
3724
3751
|
"x-original-maxLength": 1024,
|
|
3725
3752
|
"format": "uuid",
|
|
3726
3753
|
"x-reconciled-from-discovery": true,
|
|
3727
|
-
"x-reconciled-at": "2026-01-
|
|
3754
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178106+00:00"
|
|
3728
3755
|
}
|
|
3729
3756
|
},
|
|
3757
|
+
"x-f5xc-description-short": "By default a summary of nginx_csg is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
3758
|
+
"x-f5xc-description-medium": "By default a summary of nginx_csg is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
3730
3759
|
"x-f5xc-minimum-configuration": {
|
|
3731
3760
|
"description": "Minimum configuration for nginx_csgListResponseItem",
|
|
3732
3761
|
"required_fields": [
|
|
@@ -3808,6 +3837,7 @@
|
|
|
3808
3837
|
"x-validation-rules": {
|
|
3809
3838
|
"ves.io.schema.rules.message.required": "true"
|
|
3810
3839
|
},
|
|
3840
|
+
"x-f5xc-example": "example-resource",
|
|
3811
3841
|
"minLength": 0,
|
|
3812
3842
|
"maxLength": 1024,
|
|
3813
3843
|
"x-f5xc-required-for": {
|
|
@@ -3829,6 +3859,8 @@
|
|
|
3829
3859
|
"x-validation-rules": {
|
|
3830
3860
|
"ves.io.schema.rules.message.required": "true"
|
|
3831
3861
|
},
|
|
3862
|
+
"x-f5xc-example": "example-resource",
|
|
3863
|
+
"x-f5xc-description-short": "Policy name configured for WAF Required: YES.",
|
|
3832
3864
|
"minLength": 0,
|
|
3833
3865
|
"maxLength": 1024,
|
|
3834
3866
|
"x-f5xc-required-for": {
|
|
@@ -3844,6 +3876,7 @@
|
|
|
3844
3876
|
"title": "Security_log_enabled.",
|
|
3845
3877
|
"format": "boolean",
|
|
3846
3878
|
"x-displayname": "WAF Log Enabled.",
|
|
3879
|
+
"x-f5xc-description-short": "Specifies if security logging is enabled.",
|
|
3847
3880
|
"x-f5xc-required-for": {
|
|
3848
3881
|
"minimum_config": false,
|
|
3849
3882
|
"create": false,
|
|
@@ -3859,6 +3892,8 @@
|
|
|
3859
3892
|
"type": "string"
|
|
3860
3893
|
},
|
|
3861
3894
|
"x-displayname": "WAF Log File Names.",
|
|
3895
|
+
"x-f5xc-example": "example-resource",
|
|
3896
|
+
"x-f5xc-description-short": "Specifies the list of security log files specification.",
|
|
3862
3897
|
"x-f5xc-required-for": {
|
|
3863
3898
|
"minimum_config": false,
|
|
3864
3899
|
"create": false,
|
|
@@ -3901,6 +3936,7 @@
|
|
|
3901
3936
|
"type": "string",
|
|
3902
3937
|
"description": "Name for CSG in NGINX One.",
|
|
3903
3938
|
"x-displayname": "CSGName",
|
|
3939
|
+
"x-f5xc-example": "example-resource",
|
|
3904
3940
|
"minLength": 0,
|
|
3905
3941
|
"maxLength": 1024,
|
|
3906
3942
|
"x-f5xc-required-for": {
|
|
@@ -3914,6 +3950,7 @@
|
|
|
3914
3950
|
"type": "string",
|
|
3915
3951
|
"description": "Identifier for config sync group in NGINX One.",
|
|
3916
3952
|
"x-displayname": "ObjectId",
|
|
3953
|
+
"x-f5xc-description-short": "Identifier for config sync group in NGINX One.",
|
|
3917
3954
|
"minLength": 0,
|
|
3918
3955
|
"maxLength": 1024,
|
|
3919
3956
|
"x-f5xc-required-for": {
|
|
@@ -3950,6 +3987,8 @@
|
|
|
3950
3987
|
"type_url": {
|
|
3951
3988
|
"type": "string",
|
|
3952
3989
|
"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.",
|
|
3990
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
3991
|
+
"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 ).",
|
|
3953
3992
|
"minLength": 0,
|
|
3954
3993
|
"maxLength": 1024,
|
|
3955
3994
|
"x-f5xc-required-for": {
|
|
@@ -3973,9 +4012,11 @@
|
|
|
3973
4012
|
},
|
|
3974
4013
|
"x-original-maxLength": 1024,
|
|
3975
4014
|
"x-reconciled-from-discovery": true,
|
|
3976
|
-
"x-reconciled-at": "2026-01-
|
|
4015
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178133+00:00"
|
|
3977
4016
|
}
|
|
3978
4017
|
},
|
|
4018
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
4019
|
+
"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...",
|
|
3979
4020
|
"x-f5xc-minimum-configuration": {
|
|
3980
4021
|
"description": "Minimum configuration for protobufAny",
|
|
3981
4022
|
"required_fields": [
|
|
@@ -4007,6 +4048,8 @@
|
|
|
4007
4048
|
"default": "EOK",
|
|
4008
4049
|
"x-displayname": "Error Code.",
|
|
4009
4050
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
4051
|
+
"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...",
|
|
4052
|
+
"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...",
|
|
4010
4053
|
"x-f5xc-minimum-configuration": {
|
|
4011
4054
|
"description": "Minimum configuration for schemaErrorCode",
|
|
4012
4055
|
"required_fields": [],
|
|
@@ -4047,6 +4090,7 @@
|
|
|
4047
4090
|
}
|
|
4048
4091
|
}
|
|
4049
4092
|
},
|
|
4093
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
4050
4094
|
"x-f5xc-minimum-configuration": {
|
|
4051
4095
|
"description": "Minimum configuration for schemaErrorType",
|
|
4052
4096
|
"required_fields": [
|
|
@@ -4074,6 +4118,7 @@
|
|
|
4074
4118
|
"title": "Name",
|
|
4075
4119
|
"x-displayname": "Name",
|
|
4076
4120
|
"x-f5xc-example": "example-resource",
|
|
4121
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
4077
4122
|
"minLength": 0,
|
|
4078
4123
|
"maxLength": 16,
|
|
4079
4124
|
"x-f5xc-required-for": {
|
|
@@ -4084,9 +4129,10 @@
|
|
|
4084
4129
|
},
|
|
4085
4130
|
"x-original-maxLength": 1024,
|
|
4086
4131
|
"x-reconciled-from-discovery": true,
|
|
4087
|
-
"x-reconciled-at": "2026-01-
|
|
4132
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178143+00:00"
|
|
4088
4133
|
}
|
|
4089
4134
|
},
|
|
4135
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
4090
4136
|
"x-f5xc-minimum-configuration": {
|
|
4091
4137
|
"description": "Minimum configuration for schemaInitializerType",
|
|
4092
4138
|
"required_fields": [
|
|
@@ -4114,6 +4160,8 @@
|
|
|
4114
4160
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
4115
4161
|
},
|
|
4116
4162
|
"x-displayname": "Pending",
|
|
4163
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
4164
|
+
"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.",
|
|
4117
4165
|
"x-f5xc-required-for": {
|
|
4118
4166
|
"minimum_config": false,
|
|
4119
4167
|
"create": false,
|
|
@@ -4125,6 +4173,7 @@
|
|
|
4125
4173
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
4126
4174
|
}
|
|
4127
4175
|
},
|
|
4176
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
4128
4177
|
"x-f5xc-minimum-configuration": {
|
|
4129
4178
|
"description": "Minimum configuration for schemaInitializersType",
|
|
4130
4179
|
"required_fields": [
|
|
@@ -4164,6 +4213,8 @@
|
|
|
4164
4213
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
4165
4214
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
4166
4215
|
},
|
|
4216
|
+
"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.",
|
|
4217
|
+
"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.",
|
|
4167
4218
|
"x-f5xc-required-for": {
|
|
4168
4219
|
"minimum_config": false,
|
|
4169
4220
|
"create": false,
|
|
@@ -4185,6 +4236,7 @@
|
|
|
4185
4236
|
"x-validation-rules": {
|
|
4186
4237
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
4187
4238
|
},
|
|
4239
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
4188
4240
|
"minLength": 0,
|
|
4189
4241
|
"x-f5xc-required-for": {
|
|
4190
4242
|
"minimum_config": false,
|
|
@@ -4194,7 +4246,7 @@
|
|
|
4194
4246
|
},
|
|
4195
4247
|
"x-original-maxLength": 1200,
|
|
4196
4248
|
"x-reconciled-from-discovery": true,
|
|
4197
|
-
"x-reconciled-at": "2026-01-
|
|
4249
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178153+00:00"
|
|
4198
4250
|
},
|
|
4199
4251
|
"disable": {
|
|
4200
4252
|
"type": "boolean",
|
|
@@ -4204,6 +4256,7 @@
|
|
|
4204
4256
|
"x-displayname": "Disable",
|
|
4205
4257
|
"x-ves-example": "True",
|
|
4206
4258
|
"x-f5xc-example": "true",
|
|
4259
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
4207
4260
|
"x-f5xc-required-for": {
|
|
4208
4261
|
"minimum_config": false,
|
|
4209
4262
|
"create": false,
|
|
@@ -4218,6 +4271,8 @@
|
|
|
4218
4271
|
"x-displayname": "Labels",
|
|
4219
4272
|
"x-ves-example": "Value",
|
|
4220
4273
|
"x-f5xc-example": "value",
|
|
4274
|
+
"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.",
|
|
4275
|
+
"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.",
|
|
4221
4276
|
"x-f5xc-required-for": {
|
|
4222
4277
|
"minimum_config": false,
|
|
4223
4278
|
"create": false,
|
|
@@ -4239,6 +4294,8 @@
|
|
|
4239
4294
|
"x-validation-rules": {
|
|
4240
4295
|
"ves.io.schema.rules.message.required": "true"
|
|
4241
4296
|
},
|
|
4297
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
4298
|
+
"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.",
|
|
4242
4299
|
"minLength": 0,
|
|
4243
4300
|
"maxLength": 16,
|
|
4244
4301
|
"x-f5xc-required-for": {
|
|
@@ -4249,7 +4306,7 @@
|
|
|
4249
4306
|
},
|
|
4250
4307
|
"x-original-maxLength": 1024,
|
|
4251
4308
|
"x-reconciled-from-discovery": true,
|
|
4252
|
-
"x-reconciled-at": "2026-01-
|
|
4309
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178160+00:00"
|
|
4253
4310
|
},
|
|
4254
4311
|
"namespace": {
|
|
4255
4312
|
"type": "string",
|
|
@@ -4258,6 +4315,8 @@
|
|
|
4258
4315
|
"x-displayname": "Namespace",
|
|
4259
4316
|
"x-ves-example": "Staging",
|
|
4260
4317
|
"x-f5xc-example": "staging",
|
|
4318
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
4319
|
+
"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 \"\".",
|
|
4261
4320
|
"minLength": 0,
|
|
4262
4321
|
"maxLength": 6,
|
|
4263
4322
|
"x-f5xc-required-for": {
|
|
@@ -4268,9 +4327,10 @@
|
|
|
4268
4327
|
},
|
|
4269
4328
|
"x-original-maxLength": 1024,
|
|
4270
4329
|
"x-reconciled-from-discovery": true,
|
|
4271
|
-
"x-reconciled-at": "2026-01-
|
|
4330
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178165+00:00"
|
|
4272
4331
|
}
|
|
4273
4332
|
},
|
|
4333
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
4274
4334
|
"x-f5xc-minimum-configuration": {
|
|
4275
4335
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
4276
4336
|
"required_fields": [
|
|
@@ -4303,6 +4363,7 @@
|
|
|
4303
4363
|
"x-displayname": "Code",
|
|
4304
4364
|
"x-ves-example": "0",
|
|
4305
4365
|
"x-f5xc-example": "0",
|
|
4366
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
4306
4367
|
"minimum": 0,
|
|
4307
4368
|
"maximum": 2147483647,
|
|
4308
4369
|
"x-f5xc-required-for": {
|
|
@@ -4319,6 +4380,8 @@
|
|
|
4319
4380
|
"x-displayname": "Reason",
|
|
4320
4381
|
"x-ves-example": "Value",
|
|
4321
4382
|
"x-f5xc-example": "value",
|
|
4383
|
+
"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.",
|
|
4384
|
+
"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.",
|
|
4322
4385
|
"minLength": 0,
|
|
4323
4386
|
"maxLength": 43,
|
|
4324
4387
|
"x-f5xc-required-for": {
|
|
@@ -4329,7 +4392,7 @@
|
|
|
4329
4392
|
},
|
|
4330
4393
|
"x-original-maxLength": 1024,
|
|
4331
4394
|
"x-reconciled-from-discovery": true,
|
|
4332
|
-
"x-reconciled-at": "2026-01-
|
|
4395
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178171+00:00"
|
|
4333
4396
|
},
|
|
4334
4397
|
"status": {
|
|
4335
4398
|
"type": "string",
|
|
@@ -4338,6 +4401,7 @@
|
|
|
4338
4401
|
"x-displayname": "Status",
|
|
4339
4402
|
"x-ves-example": "Value",
|
|
4340
4403
|
"x-f5xc-example": "value",
|
|
4404
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
4341
4405
|
"minLength": 0,
|
|
4342
4406
|
"maxLength": 17,
|
|
4343
4407
|
"x-f5xc-required-for": {
|
|
@@ -4348,9 +4412,10 @@
|
|
|
4348
4412
|
},
|
|
4349
4413
|
"x-original-maxLength": 1024,
|
|
4350
4414
|
"x-reconciled-from-discovery": true,
|
|
4351
|
-
"x-reconciled-at": "2026-01-
|
|
4415
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178175+00:00"
|
|
4352
4416
|
}
|
|
4353
4417
|
},
|
|
4418
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
4354
4419
|
"x-f5xc-minimum-configuration": {
|
|
4355
4420
|
"description": "Minimum configuration for schemaStatusType",
|
|
4356
4421
|
"required_fields": [
|
|
@@ -4378,6 +4443,8 @@
|
|
|
4378
4443
|
"title": "Creation_timestamp.",
|
|
4379
4444
|
"format": "date-time",
|
|
4380
4445
|
"x-displayname": "Creation Timestamp.",
|
|
4446
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
4447
|
+
"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.",
|
|
4381
4448
|
"minLength": 0,
|
|
4382
4449
|
"maxLength": 1024,
|
|
4383
4450
|
"x-f5xc-required-for": {
|
|
@@ -4395,6 +4462,7 @@
|
|
|
4395
4462
|
"x-displayname": "Creator Class.",
|
|
4396
4463
|
"x-ves-example": "Prism",
|
|
4397
4464
|
"x-f5xc-example": "value",
|
|
4465
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
4398
4466
|
"minLength": 0,
|
|
4399
4467
|
"maxLength": 1024,
|
|
4400
4468
|
"x-f5xc-required-for": {
|
|
@@ -4412,6 +4480,7 @@
|
|
|
4412
4480
|
"x-displayname": "Creator ID.",
|
|
4413
4481
|
"x-ves-example": "Admin@example-corp.com.",
|
|
4414
4482
|
"x-f5xc-example": "value",
|
|
4483
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
4415
4484
|
"minLength": 0,
|
|
4416
4485
|
"maxLength": 1024,
|
|
4417
4486
|
"x-f5xc-required-for": {
|
|
@@ -4428,6 +4497,8 @@
|
|
|
4428
4497
|
"title": "Deletion_timestamp.",
|
|
4429
4498
|
"format": "date-time",
|
|
4430
4499
|
"x-displayname": "Deletion Timestamp.",
|
|
4500
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
4501
|
+
"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...",
|
|
4431
4502
|
"minLength": 0,
|
|
4432
4503
|
"maxLength": 1024,
|
|
4433
4504
|
"x-f5xc-required-for": {
|
|
@@ -4447,6 +4518,8 @@
|
|
|
4447
4518
|
"x-displayname": "Finalizers.",
|
|
4448
4519
|
"x-ves-example": "Value",
|
|
4449
4520
|
"x-f5xc-example": "value",
|
|
4521
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
4522
|
+
"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.",
|
|
4450
4523
|
"x-f5xc-required-for": {
|
|
4451
4524
|
"minimum_config": false,
|
|
4452
4525
|
"create": false,
|
|
@@ -4464,6 +4537,8 @@
|
|
|
4464
4537
|
"x-displayname": "Labels",
|
|
4465
4538
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
4466
4539
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
4540
|
+
"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.",
|
|
4541
|
+
"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).",
|
|
4467
4542
|
"x-f5xc-required-for": {
|
|
4468
4543
|
"minimum_config": false,
|
|
4469
4544
|
"create": false,
|
|
@@ -4477,6 +4552,8 @@
|
|
|
4477
4552
|
"title": "Modification_timestamp.",
|
|
4478
4553
|
"format": "date-time",
|
|
4479
4554
|
"x-displayname": "Modification Timestamp.",
|
|
4555
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
4556
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
4480
4557
|
"minLength": 0,
|
|
4481
4558
|
"maxLength": 1024,
|
|
4482
4559
|
"x-f5xc-required-for": {
|
|
@@ -4495,6 +4572,8 @@
|
|
|
4495
4572
|
"x-displayname": "Object Index.",
|
|
4496
4573
|
"x-ves-example": "0",
|
|
4497
4574
|
"x-f5xc-example": "0",
|
|
4575
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
4576
|
+
"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.",
|
|
4498
4577
|
"minimum": 0,
|
|
4499
4578
|
"maximum": 2147483647,
|
|
4500
4579
|
"x-f5xc-required-for": {
|
|
@@ -4515,6 +4594,8 @@
|
|
|
4515
4594
|
"x-displayname": "Tenant",
|
|
4516
4595
|
"x-ves-example": "Example-corp.",
|
|
4517
4596
|
"x-f5xc-example": "example-corp",
|
|
4597
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
4598
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
4518
4599
|
"minLength": 0,
|
|
4519
4600
|
"maxLength": 18,
|
|
4520
4601
|
"x-f5xc-required-for": {
|
|
@@ -4526,7 +4607,7 @@
|
|
|
4526
4607
|
"x-field-mutability": "read-only",
|
|
4527
4608
|
"x-original-maxLength": 1024,
|
|
4528
4609
|
"x-reconciled-from-discovery": true,
|
|
4529
|
-
"x-reconciled-at": "2026-01-
|
|
4610
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178194+00:00"
|
|
4530
4611
|
},
|
|
4531
4612
|
"uid": {
|
|
4532
4613
|
"type": "string",
|
|
@@ -4535,6 +4616,8 @@
|
|
|
4535
4616
|
"x-displayname": "UID",
|
|
4536
4617
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
4537
4618
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
4619
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
4620
|
+
"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.",
|
|
4538
4621
|
"minLength": 0,
|
|
4539
4622
|
"maxLength": 36,
|
|
4540
4623
|
"x-f5xc-required-for": {
|
|
@@ -4547,9 +4630,11 @@
|
|
|
4547
4630
|
"x-original-maxLength": 1024,
|
|
4548
4631
|
"format": "uuid",
|
|
4549
4632
|
"x-reconciled-from-discovery": true,
|
|
4550
|
-
"x-reconciled-at": "2026-01-
|
|
4633
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178200+00:00"
|
|
4551
4634
|
}
|
|
4552
4635
|
},
|
|
4636
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
4637
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
4553
4638
|
"x-f5xc-minimum-configuration": {
|
|
4554
4639
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
4555
4640
|
"required_fields": [
|
|
@@ -4597,7 +4682,7 @@
|
|
|
4597
4682
|
},
|
|
4598
4683
|
"x-original-maxLength": 1024,
|
|
4599
4684
|
"x-reconciled-from-discovery": true,
|
|
4600
|
-
"x-reconciled-at": "2026-01-
|
|
4685
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178205+00:00"
|
|
4601
4686
|
},
|
|
4602
4687
|
"name": {
|
|
4603
4688
|
"type": "string",
|
|
@@ -4606,6 +4691,8 @@
|
|
|
4606
4691
|
"x-displayname": "Name",
|
|
4607
4692
|
"x-ves-example": "Contactus-route.",
|
|
4608
4693
|
"x-f5xc-example": "contactus-route",
|
|
4694
|
+
"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.",
|
|
4695
|
+
"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.",
|
|
4609
4696
|
"minLength": 0,
|
|
4610
4697
|
"maxLength": 16,
|
|
4611
4698
|
"x-f5xc-required-for": {
|
|
@@ -4616,7 +4703,7 @@
|
|
|
4616
4703
|
},
|
|
4617
4704
|
"x-original-maxLength": 1024,
|
|
4618
4705
|
"x-reconciled-from-discovery": true,
|
|
4619
|
-
"x-reconciled-at": "2026-01-
|
|
4706
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178209+00:00"
|
|
4620
4707
|
},
|
|
4621
4708
|
"namespace": {
|
|
4622
4709
|
"type": "string",
|
|
@@ -4625,6 +4712,8 @@
|
|
|
4625
4712
|
"x-displayname": "Namespace",
|
|
4626
4713
|
"x-ves-example": "Ns1",
|
|
4627
4714
|
"x-f5xc-example": "ns1",
|
|
4715
|
+
"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.",
|
|
4716
|
+
"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.",
|
|
4628
4717
|
"minLength": 0,
|
|
4629
4718
|
"maxLength": 6,
|
|
4630
4719
|
"x-f5xc-required-for": {
|
|
@@ -4635,7 +4724,7 @@
|
|
|
4635
4724
|
},
|
|
4636
4725
|
"x-original-maxLength": 1024,
|
|
4637
4726
|
"x-reconciled-from-discovery": true,
|
|
4638
|
-
"x-reconciled-at": "2026-01-
|
|
4727
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178213+00:00"
|
|
4639
4728
|
},
|
|
4640
4729
|
"uid": {
|
|
4641
4730
|
"type": "string",
|
|
@@ -4656,9 +4745,10 @@
|
|
|
4656
4745
|
"x-original-maxLength": 1024,
|
|
4657
4746
|
"format": "uuid",
|
|
4658
4747
|
"x-reconciled-from-discovery": true,
|
|
4659
|
-
"x-reconciled-at": "2026-01-
|
|
4748
|
+
"x-reconciled-at": "2026-01-07T15:53:40.178218+00:00"
|
|
4660
4749
|
}
|
|
4661
4750
|
},
|
|
4751
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
4662
4752
|
"x-f5xc-minimum-configuration": {
|
|
4663
4753
|
"description": "Minimum configuration for schemaViewRefType",
|
|
4664
4754
|
"required_fields": [
|
|
@@ -4689,6 +4779,7 @@
|
|
|
4689
4779
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4690
4780
|
},
|
|
4691
4781
|
"x-displayname": "Deleted Referred Objects.",
|
|
4782
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4692
4783
|
"x-f5xc-required-for": {
|
|
4693
4784
|
"minimum_config": false,
|
|
4694
4785
|
"create": false,
|
|
@@ -4704,6 +4795,7 @@
|
|
|
4704
4795
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4705
4796
|
},
|
|
4706
4797
|
"x-displayname": "Disabled Referred Objects.",
|
|
4798
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
4707
4799
|
"x-f5xc-required-for": {
|
|
4708
4800
|
"minimum_config": false,
|
|
4709
4801
|
"create": false,
|
|
@@ -4722,6 +4814,7 @@
|
|
|
4722
4814
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
4723
4815
|
},
|
|
4724
4816
|
"x-displayname": "Referring Objects.",
|
|
4817
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
4725
4818
|
"x-f5xc-required-for": {
|
|
4726
4819
|
"minimum_config": false,
|
|
4727
4820
|
"create": false,
|
|
@@ -4764,6 +4857,8 @@
|
|
|
4764
4857
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
4765
4858
|
],
|
|
4766
4859
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
4860
|
+
"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...",
|
|
4861
|
+
"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_READ: x-displayName: \"GetSpecType format\" Response should be in format...",
|
|
4767
4862
|
"x-f5xc-minimum-configuration": {
|
|
4768
4863
|
"description": "Minimum configuration for nginx_instanceGetResponseFormatCode",
|
|
4769
4864
|
"required_fields": [],
|
|
@@ -4788,6 +4883,8 @@
|
|
|
4788
4883
|
"type": "string",
|
|
4789
4884
|
"description": "Dataplane identifier name for instance in NGINX One.",
|
|
4790
4885
|
"x-displayname": "HostName",
|
|
4886
|
+
"x-f5xc-example": "example-resource",
|
|
4887
|
+
"x-f5xc-description-short": "Dataplane identifier name for instance in NGINX One.",
|
|
4791
4888
|
"minLength": 0,
|
|
4792
4889
|
"maxLength": 1024,
|
|
4793
4890
|
"x-f5xc-required-for": {
|
|
@@ -4801,6 +4898,7 @@
|
|
|
4801
4898
|
"type": "string",
|
|
4802
4899
|
"description": "Identifier for individual instance in NGINX One.",
|
|
4803
4900
|
"x-displayname": "ObjectId",
|
|
4901
|
+
"x-f5xc-description-short": "Identifier for individual instance in NGINX One.",
|
|
4804
4902
|
"minLength": 0,
|
|
4805
4903
|
"maxLength": 1024,
|
|
4806
4904
|
"x-f5xc-required-for": {
|
|
@@ -4845,6 +4943,7 @@
|
|
|
4845
4943
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
4846
4944
|
},
|
|
4847
4945
|
"x-displayname": "Errors",
|
|
4946
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
4848
4947
|
"x-f5xc-required-for": {
|
|
4849
4948
|
"minimum_config": false,
|
|
4850
4949
|
"create": false,
|
|
@@ -4860,6 +4959,8 @@
|
|
|
4860
4959
|
"$ref": "#/components/schemas/nginx_instanceListResponseItem"
|
|
4861
4960
|
},
|
|
4862
4961
|
"x-displayname": "Items",
|
|
4962
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
4963
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
4863
4964
|
"x-f5xc-required-for": {
|
|
4864
4965
|
"minimum_config": false,
|
|
4865
4966
|
"create": false,
|
|
@@ -4893,6 +4994,8 @@
|
|
|
4893
4994
|
"description": "The set of annotations present on this nginx_instance.",
|
|
4894
4995
|
"title": "Annotations.",
|
|
4895
4996
|
"x-displayname": "Annotations.",
|
|
4997
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
4998
|
+
"x-f5xc-description-short": "The set of annotations present on this nginx_instance.",
|
|
4896
4999
|
"x-f5xc-required-for": {
|
|
4897
5000
|
"minimum_config": false,
|
|
4898
5001
|
"create": false,
|
|
@@ -4905,6 +5008,7 @@
|
|
|
4905
5008
|
"description": "The description set for this nginx_instance.",
|
|
4906
5009
|
"title": "Description.",
|
|
4907
5010
|
"x-displayname": "Description.",
|
|
5011
|
+
"x-f5xc-description-short": "The description set for this nginx_instance.",
|
|
4908
5012
|
"minLength": 0,
|
|
4909
5013
|
"maxLength": 0,
|
|
4910
5014
|
"x-f5xc-required-for": {
|
|
@@ -4915,7 +5019,7 @@
|
|
|
4915
5019
|
},
|
|
4916
5020
|
"x-original-maxLength": 1024,
|
|
4917
5021
|
"x-reconciled-from-discovery": true,
|
|
4918
|
-
"x-reconciled-at": "2026-01-
|
|
5022
|
+
"x-reconciled-at": "2026-01-07T15:53:40.524305+00:00"
|
|
4919
5023
|
},
|
|
4920
5024
|
"disabled": {
|
|
4921
5025
|
"type": "boolean",
|
|
@@ -4923,6 +5027,8 @@
|
|
|
4923
5027
|
"title": "Disabled",
|
|
4924
5028
|
"format": "boolean",
|
|
4925
5029
|
"x-displayname": "Disabled",
|
|
5030
|
+
"x-f5xc-example": "True",
|
|
5031
|
+
"x-f5xc-description-short": "Value of true indicates nginx_instance is administratively disabled.",
|
|
4926
5032
|
"x-f5xc-required-for": {
|
|
4927
5033
|
"minimum_config": false,
|
|
4928
5034
|
"create": false,
|
|
@@ -4938,6 +5044,8 @@
|
|
|
4938
5044
|
"description": "The set of labels present on this nginx_instance.",
|
|
4939
5045
|
"title": "Labels",
|
|
4940
5046
|
"x-displayname": "Labels",
|
|
5047
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
5048
|
+
"x-f5xc-description-short": "The set of labels present on this nginx_instance.",
|
|
4941
5049
|
"x-f5xc-required-for": {
|
|
4942
5050
|
"minimum_config": false,
|
|
4943
5051
|
"create": false,
|
|
@@ -4965,7 +5073,7 @@
|
|
|
4965
5073
|
},
|
|
4966
5074
|
"x-original-maxLength": 1024,
|
|
4967
5075
|
"x-reconciled-from-discovery": true,
|
|
4968
|
-
"x-reconciled-at": "2026-01-
|
|
5076
|
+
"x-reconciled-at": "2026-01-07T15:53:40.524315+00:00"
|
|
4969
5077
|
},
|
|
4970
5078
|
"namespace": {
|
|
4971
5079
|
"type": "string",
|
|
@@ -4984,7 +5092,7 @@
|
|
|
4984
5092
|
},
|
|
4985
5093
|
"x-original-maxLength": 1024,
|
|
4986
5094
|
"x-reconciled-from-discovery": true,
|
|
4987
|
-
"x-reconciled-at": "2026-01-
|
|
5095
|
+
"x-reconciled-at": "2026-01-07T15:53:40.524320+00:00"
|
|
4988
5096
|
},
|
|
4989
5097
|
"owner_view": {
|
|
4990
5098
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -5010,7 +5118,7 @@
|
|
|
5010
5118
|
"x-field-mutability": "read-only",
|
|
5011
5119
|
"x-original-maxLength": 1024,
|
|
5012
5120
|
"x-reconciled-from-discovery": true,
|
|
5013
|
-
"x-reconciled-at": "2026-01-
|
|
5121
|
+
"x-reconciled-at": "2026-01-07T15:53:40.524326+00:00"
|
|
5014
5122
|
},
|
|
5015
5123
|
"uid": {
|
|
5016
5124
|
"type": "string",
|
|
@@ -5031,9 +5139,11 @@
|
|
|
5031
5139
|
"x-original-maxLength": 1024,
|
|
5032
5140
|
"format": "uuid",
|
|
5033
5141
|
"x-reconciled-from-discovery": true,
|
|
5034
|
-
"x-reconciled-at": "2026-01-
|
|
5142
|
+
"x-reconciled-at": "2026-01-07T15:53:40.524332+00:00"
|
|
5035
5143
|
}
|
|
5036
5144
|
},
|
|
5145
|
+
"x-f5xc-description-short": "By default a summary of nginx_instance is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
5146
|
+
"x-f5xc-description-medium": "By default a summary of nginx_instance is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
5037
5147
|
"x-f5xc-minimum-configuration": {
|
|
5038
5148
|
"description": "Minimum configuration for nginx_instanceListResponseItem",
|
|
5039
5149
|
"required_fields": [
|
|
@@ -5139,9 +5249,10 @@
|
|
|
5139
5249
|
},
|
|
5140
5250
|
"x-original-maxLength": 1024,
|
|
5141
5251
|
"x-reconciled-from-discovery": true,
|
|
5142
|
-
"x-reconciled-at": "2026-01-
|
|
5252
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921047+00:00"
|
|
5143
5253
|
}
|
|
5144
5254
|
},
|
|
5255
|
+
"x-f5xc-description-short": "GET NGINX One Dataplane servers request.",
|
|
5145
5256
|
"x-f5xc-minimum-configuration": {
|
|
5146
5257
|
"description": "Minimum configuration for nginx_serverGetDataplaneServersRequest",
|
|
5147
5258
|
"required_fields": [
|
|
@@ -5177,6 +5288,8 @@
|
|
|
5177
5288
|
"x-validation-rules": {
|
|
5178
5289
|
"ves.io.schema.rules.message.required": "true"
|
|
5179
5290
|
},
|
|
5291
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
5292
|
+
"x-f5xc-description-short": "The NGINX One Servers associated to the dataplane Required: YES.",
|
|
5180
5293
|
"x-f5xc-required-for": {
|
|
5181
5294
|
"minimum_config": false,
|
|
5182
5295
|
"create": false,
|
|
@@ -5185,6 +5298,7 @@
|
|
|
5185
5298
|
}
|
|
5186
5299
|
}
|
|
5187
5300
|
},
|
|
5301
|
+
"x-f5xc-description-short": "GET NGINX One Dataplane servers response.",
|
|
5188
5302
|
"x-f5xc-minimum-configuration": {
|
|
5189
5303
|
"description": "Minimum configuration for nginx_serverGetDataplaneServersResponse",
|
|
5190
5304
|
"required_fields": [
|
|
@@ -5212,6 +5326,7 @@
|
|
|
5212
5326
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
5213
5327
|
},
|
|
5214
5328
|
"x-displayname": "Deleted Referred Objects.",
|
|
5329
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
5215
5330
|
"x-f5xc-required-for": {
|
|
5216
5331
|
"minimum_config": false,
|
|
5217
5332
|
"create": false,
|
|
@@ -5227,6 +5342,7 @@
|
|
|
5227
5342
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
5228
5343
|
},
|
|
5229
5344
|
"x-displayname": "Disabled Referred Objects.",
|
|
5345
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
5230
5346
|
"x-f5xc-required-for": {
|
|
5231
5347
|
"minimum_config": false,
|
|
5232
5348
|
"create": false,
|
|
@@ -5245,6 +5361,7 @@
|
|
|
5245
5361
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
5246
5362
|
},
|
|
5247
5363
|
"x-displayname": "Referring Objects.",
|
|
5364
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
5248
5365
|
"x-f5xc-required-for": {
|
|
5249
5366
|
"minimum_config": false,
|
|
5250
5367
|
"create": false,
|
|
@@ -5263,6 +5380,8 @@
|
|
|
5263
5380
|
"$ref": "#/components/schemas/nginx_serverStatusObject"
|
|
5264
5381
|
},
|
|
5265
5382
|
"x-displayname": "Status",
|
|
5383
|
+
"x-f5xc-example": "active",
|
|
5384
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
5266
5385
|
"x-f5xc-required-for": {
|
|
5267
5386
|
"minimum_config": false,
|
|
5268
5387
|
"create": false,
|
|
@@ -5272,7 +5391,7 @@
|
|
|
5272
5391
|
"maxLength": 17,
|
|
5273
5392
|
"minLength": 17,
|
|
5274
5393
|
"x-reconciled-from-discovery": true,
|
|
5275
|
-
"x-reconciled-at": "2026-01-
|
|
5394
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921061+00:00"
|
|
5276
5395
|
},
|
|
5277
5396
|
"system_metadata": {
|
|
5278
5397
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -5308,6 +5427,8 @@
|
|
|
5308
5427
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
5309
5428
|
],
|
|
5310
5429
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
5430
|
+
"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...",
|
|
5431
|
+
"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...",
|
|
5311
5432
|
"x-f5xc-minimum-configuration": {
|
|
5312
5433
|
"description": "Minimum configuration for nginx_serverGetResponseFormatCode",
|
|
5313
5434
|
"required_fields": [],
|
|
@@ -5333,6 +5454,7 @@
|
|
|
5333
5454
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
5334
5455
|
},
|
|
5335
5456
|
"x-displayname": "Errors",
|
|
5457
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
5336
5458
|
"x-f5xc-required-for": {
|
|
5337
5459
|
"minimum_config": false,
|
|
5338
5460
|
"create": false,
|
|
@@ -5348,6 +5470,8 @@
|
|
|
5348
5470
|
"$ref": "#/components/schemas/nginx_serverListResponseItem"
|
|
5349
5471
|
},
|
|
5350
5472
|
"x-displayname": "Items",
|
|
5473
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
5474
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
5351
5475
|
"x-f5xc-required-for": {
|
|
5352
5476
|
"minimum_config": false,
|
|
5353
5477
|
"create": false,
|
|
@@ -5381,6 +5505,8 @@
|
|
|
5381
5505
|
"description": "The set of annotations present on this nginx_server.",
|
|
5382
5506
|
"title": "Annotations.",
|
|
5383
5507
|
"x-displayname": "Annotations.",
|
|
5508
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
5509
|
+
"x-f5xc-description-short": "The set of annotations present on this nginx_server.",
|
|
5384
5510
|
"x-f5xc-required-for": {
|
|
5385
5511
|
"minimum_config": false,
|
|
5386
5512
|
"create": false,
|
|
@@ -5393,6 +5519,7 @@
|
|
|
5393
5519
|
"description": "The description set for this nginx_server.",
|
|
5394
5520
|
"title": "Description.",
|
|
5395
5521
|
"x-displayname": "Description.",
|
|
5522
|
+
"x-f5xc-description-short": "The description set for this nginx_server.",
|
|
5396
5523
|
"minLength": 0,
|
|
5397
5524
|
"maxLength": 0,
|
|
5398
5525
|
"x-f5xc-required-for": {
|
|
@@ -5403,7 +5530,7 @@
|
|
|
5403
5530
|
},
|
|
5404
5531
|
"x-original-maxLength": 1024,
|
|
5405
5532
|
"x-reconciled-from-discovery": true,
|
|
5406
|
-
"x-reconciled-at": "2026-01-
|
|
5533
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921073+00:00"
|
|
5407
5534
|
},
|
|
5408
5535
|
"disabled": {
|
|
5409
5536
|
"type": "boolean",
|
|
@@ -5411,6 +5538,8 @@
|
|
|
5411
5538
|
"title": "Disabled",
|
|
5412
5539
|
"format": "boolean",
|
|
5413
5540
|
"x-displayname": "Disabled",
|
|
5541
|
+
"x-f5xc-example": "True",
|
|
5542
|
+
"x-f5xc-description-short": "Value of true indicates nginx_server is administratively disabled.",
|
|
5414
5543
|
"x-f5xc-required-for": {
|
|
5415
5544
|
"minimum_config": false,
|
|
5416
5545
|
"create": false,
|
|
@@ -5426,6 +5555,8 @@
|
|
|
5426
5555
|
"description": "The set of labels present on this nginx_server.",
|
|
5427
5556
|
"title": "Labels",
|
|
5428
5557
|
"x-displayname": "Labels",
|
|
5558
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
5559
|
+
"x-f5xc-description-short": "The set of labels present on this nginx_server.",
|
|
5429
5560
|
"x-f5xc-required-for": {
|
|
5430
5561
|
"minimum_config": false,
|
|
5431
5562
|
"create": false,
|
|
@@ -5453,7 +5584,7 @@
|
|
|
5453
5584
|
},
|
|
5454
5585
|
"x-original-maxLength": 1024,
|
|
5455
5586
|
"x-reconciled-from-discovery": true,
|
|
5456
|
-
"x-reconciled-at": "2026-01-
|
|
5587
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921083+00:00"
|
|
5457
5588
|
},
|
|
5458
5589
|
"namespace": {
|
|
5459
5590
|
"type": "string",
|
|
@@ -5472,7 +5603,7 @@
|
|
|
5472
5603
|
},
|
|
5473
5604
|
"x-original-maxLength": 1024,
|
|
5474
5605
|
"x-reconciled-from-discovery": true,
|
|
5475
|
-
"x-reconciled-at": "2026-01-
|
|
5606
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921087+00:00"
|
|
5476
5607
|
},
|
|
5477
5608
|
"owner_view": {
|
|
5478
5609
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -5485,6 +5616,7 @@
|
|
|
5485
5616
|
"$ref": "#/components/schemas/nginx_serverStatusObject"
|
|
5486
5617
|
},
|
|
5487
5618
|
"x-displayname": "Status",
|
|
5619
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
5488
5620
|
"x-f5xc-required-for": {
|
|
5489
5621
|
"minimum_config": false,
|
|
5490
5622
|
"create": false,
|
|
@@ -5513,7 +5645,7 @@
|
|
|
5513
5645
|
"x-field-mutability": "read-only",
|
|
5514
5646
|
"x-original-maxLength": 1024,
|
|
5515
5647
|
"x-reconciled-from-discovery": true,
|
|
5516
|
-
"x-reconciled-at": "2026-01-
|
|
5648
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921095+00:00"
|
|
5517
5649
|
},
|
|
5518
5650
|
"uid": {
|
|
5519
5651
|
"type": "string",
|
|
@@ -5534,9 +5666,11 @@
|
|
|
5534
5666
|
"x-original-maxLength": 1024,
|
|
5535
5667
|
"format": "uuid",
|
|
5536
5668
|
"x-reconciled-from-discovery": true,
|
|
5537
|
-
"x-reconciled-at": "2026-01-
|
|
5669
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921100+00:00"
|
|
5538
5670
|
}
|
|
5539
5671
|
},
|
|
5672
|
+
"x-f5xc-description-short": "By default a summary of nginx_server is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
5673
|
+
"x-f5xc-description-medium": "By default a summary of nginx_server is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
5540
5674
|
"x-f5xc-minimum-configuration": {
|
|
5541
5675
|
"description": "Minimum configuration for nginx_serverListResponseItem",
|
|
5542
5676
|
"required_fields": [
|
|
@@ -5583,6 +5717,8 @@
|
|
|
5583
5717
|
"x-validation-rules": {
|
|
5584
5718
|
"ves.io.schema.rules.message.required": "true"
|
|
5585
5719
|
},
|
|
5720
|
+
"x-f5xc-description-short": "Server name list specified as ${server_name} in NGINX config.",
|
|
5721
|
+
"x-f5xc-description-medium": "Server name list specified as ${server_name} in NGINX config. If no value is specified corresponding to this variable, \"default\" is used Reference: https://nginx.org/en/docs/HTTP/ngx_http_core_module.html#server.",
|
|
5586
5722
|
"x-f5xc-required-for": {
|
|
5587
5723
|
"minimum_config": false,
|
|
5588
5724
|
"create": false,
|
|
@@ -5605,6 +5741,7 @@
|
|
|
5605
5741
|
"x-validation-rules": {
|
|
5606
5742
|
"ves.io.schema.rules.repeated.max_items": "1000"
|
|
5607
5743
|
},
|
|
5744
|
+
"x-f5xc-description-short": "Configuration of the set of locations corresponding to this server.",
|
|
5608
5745
|
"x-f5xc-required-for": {
|
|
5609
5746
|
"minimum_config": false,
|
|
5610
5747
|
"create": false,
|
|
@@ -5617,6 +5754,7 @@
|
|
|
5617
5754
|
"description": "Signifies the uniqueness identifier for NGINX One representation of\nthis NGINX server.",
|
|
5618
5755
|
"title": "Nginx_one_object_id.",
|
|
5619
5756
|
"x-displayname": "Instance or Config Sync Group Object ID.",
|
|
5757
|
+
"x-f5xc-description-short": "Signifies the uniqueness identifier for NGINX One representation of this NGINX server.",
|
|
5620
5758
|
"minLength": 0,
|
|
5621
5759
|
"maxLength": 1024,
|
|
5622
5760
|
"x-f5xc-required-for": {
|
|
@@ -5632,6 +5770,8 @@
|
|
|
5632
5770
|
"description": "Hostname value set for Instance or Name for a Config Sync Group\nin NGINX One.",
|
|
5633
5771
|
"title": "Nginx_one_object_name.",
|
|
5634
5772
|
"x-displayname": "Instance or Config Sync Group Name.",
|
|
5773
|
+
"x-f5xc-example": "example-resource",
|
|
5774
|
+
"x-f5xc-description-short": "Hostname value set for Instance or Name for a Config Sync Group in NGINX One.",
|
|
5635
5775
|
"minLength": 0,
|
|
5636
5776
|
"maxLength": 1024,
|
|
5637
5777
|
"x-f5xc-required-for": {
|
|
@@ -5656,6 +5796,7 @@
|
|
|
5656
5796
|
"ves.io.schema.rules.uint32.lte": "65535"
|
|
5657
5797
|
},
|
|
5658
5798
|
"x-f5xc-example": "8080",
|
|
5799
|
+
"x-f5xc-description-short": "Signifies the port configured for the NGINX server.",
|
|
5659
5800
|
"minimum": 1,
|
|
5660
5801
|
"maximum": 65535,
|
|
5661
5802
|
"x-f5xc-required-for": {
|
|
@@ -5670,6 +5811,9 @@
|
|
|
5670
5811
|
"description": "Signifies the combination of first element in domains array and the port\nconfigured for the NGINX server.",
|
|
5671
5812
|
"title": "Server_name.",
|
|
5672
5813
|
"x-displayname": "ServerName.",
|
|
5814
|
+
"x-f5xc-example": "example-resource",
|
|
5815
|
+
"x-f5xc-description-short": "Signifies the combination of first element in domains array and the port configured for the NGINX server.",
|
|
5816
|
+
"x-f5xc-description-medium": "Signifies the combination of first element in domains array and the port configured for the NGINX server.",
|
|
5673
5817
|
"minLength": 0,
|
|
5674
5818
|
"maxLength": 1024,
|
|
5675
5819
|
"x-f5xc-required-for": {
|
|
@@ -5685,6 +5829,7 @@
|
|
|
5685
5829
|
"title": "Total locations configured in the NGINX Server.",
|
|
5686
5830
|
"format": "int64",
|
|
5687
5831
|
"x-displayname": "Routes",
|
|
5832
|
+
"x-f5xc-description-short": "Total locations configured in the NGINX Server.",
|
|
5688
5833
|
"minimum": 0,
|
|
5689
5834
|
"maximum": 2147483647,
|
|
5690
5835
|
"x-f5xc-required-for": {
|
|
@@ -5733,6 +5878,7 @@
|
|
|
5733
5878
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
5734
5879
|
},
|
|
5735
5880
|
"x-displayname": "Conditions.",
|
|
5881
|
+
"x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.",
|
|
5736
5882
|
"x-f5xc-required-for": {
|
|
5737
5883
|
"minimum_config": false,
|
|
5738
5884
|
"create": false,
|
|
@@ -5759,6 +5905,7 @@
|
|
|
5759
5905
|
}
|
|
5760
5906
|
}
|
|
5761
5907
|
},
|
|
5908
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
5762
5909
|
"x-f5xc-minimum-configuration": {
|
|
5763
5910
|
"description": "Minimum configuration for nginx_serverStatusObject",
|
|
5764
5911
|
"required_fields": [
|
|
@@ -5821,6 +5968,8 @@
|
|
|
5821
5968
|
"x-validation-rules": {
|
|
5822
5969
|
"ves.io.schema.rules.message.required": "true"
|
|
5823
5970
|
},
|
|
5971
|
+
"x-f5xc-description-short": "Location definition specified as the attributes of ${location} block in NGINX config.",
|
|
5972
|
+
"x-f5xc-description-medium": "Location definition specified as the attributes of ${location} block in NGINX config. This includes both the optional_modifier and the location_match combined. A location can either be defined by a prefix string, or by a regular expression.",
|
|
5824
5973
|
"minLength": 0,
|
|
5825
5974
|
"maxLength": 1024,
|
|
5826
5975
|
"x-f5xc-required-for": {
|
|
@@ -5844,6 +5993,7 @@
|
|
|
5844
5993
|
"x-validation-rules": {
|
|
5845
5994
|
"ves.io.schema.rules.message.required": "true"
|
|
5846
5995
|
},
|
|
5996
|
+
"x-f5xc-description-short": "Uniqueness identifier for a location definition Required: YES.",
|
|
5847
5997
|
"minLength": 0,
|
|
5848
5998
|
"maxLength": 16,
|
|
5849
5999
|
"x-f5xc-required-for": {
|
|
@@ -5854,7 +6004,7 @@
|
|
|
5854
6004
|
},
|
|
5855
6005
|
"x-original-maxLength": 1024,
|
|
5856
6006
|
"x-reconciled-from-discovery": true,
|
|
5857
|
-
"x-reconciled-at": "2026-01-
|
|
6007
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921129+00:00"
|
|
5858
6008
|
},
|
|
5859
6009
|
"waf_spec": {
|
|
5860
6010
|
"$ref": "#/components/schemas/nginx_instanceWAFSpec"
|
|
@@ -5887,6 +6037,8 @@
|
|
|
5887
6037
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
5888
6038
|
"title": "Hostname",
|
|
5889
6039
|
"x-displayname": "Hostname",
|
|
6040
|
+
"x-f5xc-example": "example-resource",
|
|
6041
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
5890
6042
|
"minLength": 0,
|
|
5891
6043
|
"maxLength": 1024,
|
|
5892
6044
|
"x-f5xc-required-for": {
|
|
@@ -5918,6 +6070,8 @@
|
|
|
5918
6070
|
"x-displayname": "Reason",
|
|
5919
6071
|
"x-ves-example": "Value",
|
|
5920
6072
|
"x-f5xc-example": "value",
|
|
6073
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
6074
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
5921
6075
|
"minLength": 0,
|
|
5922
6076
|
"maxLength": 43,
|
|
5923
6077
|
"x-f5xc-required-for": {
|
|
@@ -5928,13 +6082,15 @@
|
|
|
5928
6082
|
},
|
|
5929
6083
|
"x-original-maxLength": 1024,
|
|
5930
6084
|
"x-reconciled-from-discovery": true,
|
|
5931
|
-
"x-reconciled-at": "2026-01-
|
|
6085
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921144+00:00"
|
|
5932
6086
|
},
|
|
5933
6087
|
"service_name": {
|
|
5934
6088
|
"type": "string",
|
|
5935
6089
|
"description": "Name of the service that sent the status.",
|
|
5936
6090
|
"title": "Service name.",
|
|
5937
6091
|
"x-displayname": "Service Name.",
|
|
6092
|
+
"x-f5xc-example": "example-resource",
|
|
6093
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
5938
6094
|
"minLength": 0,
|
|
5939
6095
|
"maxLength": 1024,
|
|
5940
6096
|
"x-f5xc-required-for": {
|
|
@@ -5957,6 +6113,8 @@
|
|
|
5957
6113
|
"x-validation-rules": {
|
|
5958
6114
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
5959
6115
|
},
|
|
6116
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
6117
|
+
"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...",
|
|
5960
6118
|
"minLength": 0,
|
|
5961
6119
|
"maxLength": 17,
|
|
5962
6120
|
"x-f5xc-required-for": {
|
|
@@ -5967,7 +6125,7 @@
|
|
|
5967
6125
|
},
|
|
5968
6126
|
"x-original-maxLength": 1024,
|
|
5969
6127
|
"x-reconciled-from-discovery": true,
|
|
5970
|
-
"x-reconciled-at": "2026-01-
|
|
6128
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921150+00:00"
|
|
5971
6129
|
},
|
|
5972
6130
|
"type": {
|
|
5973
6131
|
"type": "string",
|
|
@@ -5982,6 +6140,8 @@
|
|
|
5982
6140
|
"x-validation-rules": {
|
|
5983
6141
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
5984
6142
|
},
|
|
6143
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
6144
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
5985
6145
|
"minLength": 0,
|
|
5986
6146
|
"maxLength": 1024,
|
|
5987
6147
|
"x-f5xc-required-for": {
|
|
@@ -5992,6 +6152,8 @@
|
|
|
5992
6152
|
}
|
|
5993
6153
|
}
|
|
5994
6154
|
},
|
|
6155
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
6156
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
5995
6157
|
"x-f5xc-minimum-configuration": {
|
|
5996
6158
|
"description": "Minimum configuration for schemaConditionType",
|
|
5997
6159
|
"required_fields": [
|
|
@@ -6022,6 +6184,8 @@
|
|
|
6022
6184
|
"title": "Creation_timestamp.",
|
|
6023
6185
|
"format": "date-time",
|
|
6024
6186
|
"x-displayname": "Creation Timestamp.",
|
|
6187
|
+
"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.",
|
|
6188
|
+
"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.",
|
|
6025
6189
|
"minLength": 0,
|
|
6026
6190
|
"maxLength": 1024,
|
|
6027
6191
|
"x-f5xc-required-for": {
|
|
@@ -6039,6 +6203,8 @@
|
|
|
6039
6203
|
"x-displayname": "Creator Class.",
|
|
6040
6204
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
6041
6205
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
6206
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
6207
|
+
"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.",
|
|
6042
6208
|
"minLength": 0,
|
|
6043
6209
|
"maxLength": 1024,
|
|
6044
6210
|
"x-f5xc-required-for": {
|
|
@@ -6056,6 +6222,8 @@
|
|
|
6056
6222
|
"x-displayname": "Creator ID.",
|
|
6057
6223
|
"x-ves-example": "Ver-instance-1.",
|
|
6058
6224
|
"x-f5xc-example": "ver-instance-1",
|
|
6225
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
6226
|
+
"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.",
|
|
6059
6227
|
"minLength": 0,
|
|
6060
6228
|
"maxLength": 1024,
|
|
6061
6229
|
"x-f5xc-required-for": {
|
|
@@ -6074,6 +6242,8 @@
|
|
|
6074
6242
|
"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)",
|
|
6075
6243
|
"title": "Status_id",
|
|
6076
6244
|
"x-displayname": "Status ID",
|
|
6245
|
+
"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...",
|
|
6246
|
+
"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).",
|
|
6077
6247
|
"minLength": 0,
|
|
6078
6248
|
"maxLength": 1024,
|
|
6079
6249
|
"x-f5xc-required-for": {
|
|
@@ -6091,6 +6261,7 @@
|
|
|
6091
6261
|
"x-displayname": "UID",
|
|
6092
6262
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
6093
6263
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
6264
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
6094
6265
|
"minLength": 0,
|
|
6095
6266
|
"maxLength": 36,
|
|
6096
6267
|
"x-f5xc-required-for": {
|
|
@@ -6103,13 +6274,14 @@
|
|
|
6103
6274
|
"x-original-maxLength": 1024,
|
|
6104
6275
|
"format": "uuid",
|
|
6105
6276
|
"x-reconciled-from-discovery": true,
|
|
6106
|
-
"x-reconciled-at": "2026-01-
|
|
6277
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921194+00:00"
|
|
6107
6278
|
},
|
|
6108
6279
|
"vtrp_id": {
|
|
6109
6280
|
"type": "string",
|
|
6110
6281
|
"description": "Origin of this status exchanged by VTRP.",
|
|
6111
6282
|
"title": "Vtrp_id",
|
|
6112
6283
|
"x-displayname": "VTRP ID",
|
|
6284
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
6113
6285
|
"minLength": 0,
|
|
6114
6286
|
"maxLength": 1024,
|
|
6115
6287
|
"x-f5xc-required-for": {
|
|
@@ -6126,6 +6298,7 @@
|
|
|
6126
6298
|
"title": "Vtrp_stale.",
|
|
6127
6299
|
"format": "boolean",
|
|
6128
6300
|
"x-displayname": "VTRP Stale.",
|
|
6301
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
6129
6302
|
"x-f5xc-required-for": {
|
|
6130
6303
|
"minimum_config": false,
|
|
6131
6304
|
"create": false,
|
|
@@ -6134,6 +6307,7 @@
|
|
|
6134
6307
|
}
|
|
6135
6308
|
}
|
|
6136
6309
|
},
|
|
6310
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
6137
6311
|
"x-f5xc-minimum-configuration": {
|
|
6138
6312
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
6139
6313
|
"required_fields": [
|
|
@@ -6164,6 +6338,8 @@
|
|
|
6164
6338
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
6165
6339
|
"x-displayname": "Status Publish Type.",
|
|
6166
6340
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
6341
|
+
"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.",
|
|
6342
|
+
"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.",
|
|
6167
6343
|
"x-f5xc-minimum-configuration": {
|
|
6168
6344
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
6169
6345
|
"required_fields": [],
|
|
@@ -6201,6 +6377,8 @@
|
|
|
6201
6377
|
"ves.io.schema.rules.string.max_bytes": "128",
|
|
6202
6378
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
6203
6379
|
},
|
|
6380
|
+
"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.",
|
|
6381
|
+
"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.",
|
|
6204
6382
|
"x-f5xc-required-for": {
|
|
6205
6383
|
"minimum_config": false,
|
|
6206
6384
|
"create": false,
|
|
@@ -6209,7 +6387,7 @@
|
|
|
6209
6387
|
},
|
|
6210
6388
|
"x-original-maxLength": 128,
|
|
6211
6389
|
"x-reconciled-from-discovery": true,
|
|
6212
|
-
"x-reconciled-at": "2026-01-
|
|
6390
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921254+00:00"
|
|
6213
6391
|
},
|
|
6214
6392
|
"namespace": {
|
|
6215
6393
|
"type": "string",
|
|
@@ -6225,6 +6403,8 @@
|
|
|
6225
6403
|
"x-validation-rules": {
|
|
6226
6404
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
6227
6405
|
},
|
|
6406
|
+
"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.",
|
|
6407
|
+
"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.",
|
|
6228
6408
|
"minLength": 0,
|
|
6229
6409
|
"x-f5xc-required-for": {
|
|
6230
6410
|
"minimum_config": false,
|
|
@@ -6234,7 +6414,7 @@
|
|
|
6234
6414
|
},
|
|
6235
6415
|
"x-original-maxLength": 64,
|
|
6236
6416
|
"x-reconciled-from-discovery": true,
|
|
6237
|
-
"x-reconciled-at": "2026-01-
|
|
6417
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921259+00:00"
|
|
6238
6418
|
},
|
|
6239
6419
|
"tenant": {
|
|
6240
6420
|
"type": "string",
|
|
@@ -6250,6 +6430,8 @@
|
|
|
6250
6430
|
"x-validation-rules": {
|
|
6251
6431
|
"ves.io.schema.rules.string.max_bytes": "64"
|
|
6252
6432
|
},
|
|
6433
|
+
"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.",
|
|
6434
|
+
"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.",
|
|
6253
6435
|
"minLength": 0,
|
|
6254
6436
|
"x-f5xc-required-for": {
|
|
6255
6437
|
"minimum_config": false,
|
|
@@ -6261,9 +6443,11 @@
|
|
|
6261
6443
|
"x-field-mutability": "read-only",
|
|
6262
6444
|
"x-original-maxLength": 64,
|
|
6263
6445
|
"x-reconciled-from-discovery": true,
|
|
6264
|
-
"x-reconciled-at": "2026-01-
|
|
6446
|
+
"x-reconciled-at": "2026-01-07T15:53:40.921263+00:00"
|
|
6265
6447
|
}
|
|
6266
6448
|
},
|
|
6449
|
+
"x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).",
|
|
6450
|
+
"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.",
|
|
6267
6451
|
"x-f5xc-minimum-configuration": {
|
|
6268
6452
|
"description": "Minimum configuration for schemaviewsObjectRefType",
|
|
6269
6453
|
"required_fields": [
|
|
@@ -6367,6 +6551,7 @@
|
|
|
6367
6551
|
"ves.io.schema.rules.message.required": "true",
|
|
6368
6552
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
6369
6553
|
},
|
|
6554
|
+
"x-f5xc-description-short": "Select new ConfigSyncGroup Required: YES.",
|
|
6370
6555
|
"x-f5xc-required-for": {
|
|
6371
6556
|
"minimum_config": false,
|
|
6372
6557
|
"create": false,
|
|
@@ -6469,6 +6654,9 @@
|
|
|
6469
6654
|
"ves.io.schema.rules.repeated.max_items": "10",
|
|
6470
6655
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
6471
6656
|
},
|
|
6657
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6658
|
+
"x-f5xc-description-short": "Filters discovered server blocks based on server name, domain and ports. Atleast, one field should be populated for each filter.",
|
|
6659
|
+
"x-f5xc-description-medium": "Filters discovered server blocks based on server name, domain and ports. Atleast, one field should be populated for each filter. X-textBlockContent: If no filters are specified, all server blocks will be discovered by default.",
|
|
6472
6660
|
"x-f5xc-required-for": {
|
|
6473
6661
|
"minimum_config": false,
|
|
6474
6662
|
"create": false,
|
|
@@ -6477,6 +6665,7 @@
|
|
|
6477
6665
|
}
|
|
6478
6666
|
}
|
|
6479
6667
|
},
|
|
6668
|
+
"x-f5xc-description-short": "API to create NGINX Service Discovery object for a site or virtual site in system namespace.",
|
|
6480
6669
|
"x-f5xc-minimum-configuration": {
|
|
6481
6670
|
"description": "Minimum configuration for nginx_service_discoveryCreateSpecType",
|
|
6482
6671
|
"required_fields": [
|
|
@@ -6503,6 +6692,7 @@
|
|
|
6503
6692
|
"title": "Fail_if_referred.",
|
|
6504
6693
|
"format": "boolean",
|
|
6505
6694
|
"x-displayname": "Fail-If-Referred.",
|
|
6695
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
6506
6696
|
"x-f5xc-required-for": {
|
|
6507
6697
|
"minimum_config": false,
|
|
6508
6698
|
"create": false,
|
|
@@ -6527,7 +6717,7 @@
|
|
|
6527
6717
|
},
|
|
6528
6718
|
"x-original-maxLength": 1024,
|
|
6529
6719
|
"x-reconciled-from-discovery": true,
|
|
6530
|
-
"x-reconciled-at": "2026-01-
|
|
6720
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588107+00:00"
|
|
6531
6721
|
},
|
|
6532
6722
|
"namespace": {
|
|
6533
6723
|
"type": "string",
|
|
@@ -6536,6 +6726,7 @@
|
|
|
6536
6726
|
"x-displayname": "Namespace",
|
|
6537
6727
|
"x-ves-example": "Ns1",
|
|
6538
6728
|
"x-f5xc-example": "ns1",
|
|
6729
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
6539
6730
|
"minLength": 0,
|
|
6540
6731
|
"maxLength": 6,
|
|
6541
6732
|
"x-f5xc-required-for": {
|
|
@@ -6546,7 +6737,7 @@
|
|
|
6546
6737
|
},
|
|
6547
6738
|
"x-original-maxLength": 1024,
|
|
6548
6739
|
"x-reconciled-from-discovery": true,
|
|
6549
|
-
"x-reconciled-at": "2026-01-
|
|
6740
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588114+00:00"
|
|
6550
6741
|
}
|
|
6551
6742
|
},
|
|
6552
6743
|
"x-f5xc-minimum-configuration": {
|
|
@@ -6608,6 +6799,7 @@
|
|
|
6608
6799
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6609
6800
|
},
|
|
6610
6801
|
"x-displayname": "Deleted Referred Objects.",
|
|
6802
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6611
6803
|
"x-f5xc-required-for": {
|
|
6612
6804
|
"minimum_config": false,
|
|
6613
6805
|
"create": false,
|
|
@@ -6623,6 +6815,7 @@
|
|
|
6623
6815
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6624
6816
|
},
|
|
6625
6817
|
"x-displayname": "Disabled Referred Objects.",
|
|
6818
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
6626
6819
|
"x-f5xc-required-for": {
|
|
6627
6820
|
"minimum_config": false,
|
|
6628
6821
|
"create": false,
|
|
@@ -6641,6 +6834,7 @@
|
|
|
6641
6834
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
6642
6835
|
},
|
|
6643
6836
|
"x-displayname": "Referring Objects.",
|
|
6837
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
6644
6838
|
"x-f5xc-required-for": {
|
|
6645
6839
|
"minimum_config": false,
|
|
6646
6840
|
"create": false,
|
|
@@ -6662,6 +6856,8 @@
|
|
|
6662
6856
|
"$ref": "#/components/schemas/nginx_service_discoveryStatusObject"
|
|
6663
6857
|
},
|
|
6664
6858
|
"x-displayname": "Status",
|
|
6859
|
+
"x-f5xc-example": "active",
|
|
6860
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6665
6861
|
"x-f5xc-required-for": {
|
|
6666
6862
|
"minimum_config": false,
|
|
6667
6863
|
"create": false,
|
|
@@ -6671,7 +6867,7 @@
|
|
|
6671
6867
|
"maxLength": 17,
|
|
6672
6868
|
"minLength": 17,
|
|
6673
6869
|
"x-reconciled-from-discovery": true,
|
|
6674
|
-
"x-reconciled-at": "2026-01-
|
|
6870
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588134+00:00"
|
|
6675
6871
|
},
|
|
6676
6872
|
"system_metadata": {
|
|
6677
6873
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -6711,6 +6907,8 @@
|
|
|
6711
6907
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
6712
6908
|
],
|
|
6713
6909
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
6910
|
+
"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...",
|
|
6911
|
+
"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...",
|
|
6714
6912
|
"x-f5xc-minimum-configuration": {
|
|
6715
6913
|
"description": "Minimum configuration for nginx_service_discoveryGetResponseFormatCode",
|
|
6716
6914
|
"required_fields": [],
|
|
@@ -6734,6 +6932,7 @@
|
|
|
6734
6932
|
"nginx_one_object_id": {
|
|
6735
6933
|
"type": "string",
|
|
6736
6934
|
"x-displayname": "Instance or Config Sync Group Object ID.",
|
|
6935
|
+
"description": "Unique identifier for this resource",
|
|
6737
6936
|
"minLength": 0,
|
|
6738
6937
|
"maxLength": 1024,
|
|
6739
6938
|
"x-f5xc-required-for": {
|
|
@@ -6748,6 +6947,8 @@
|
|
|
6748
6947
|
"type": "string",
|
|
6749
6948
|
"description": "Hostname value set for Instance or Name for a Config Sync Group\nin NGINX One.",
|
|
6750
6949
|
"x-displayname": "Instance or Config Sync Group Name.",
|
|
6950
|
+
"x-f5xc-example": "example-resource",
|
|
6951
|
+
"x-f5xc-description-short": "Hostname value set for Instance or Name for a Config Sync Group in NGINX One.",
|
|
6751
6952
|
"minLength": 0,
|
|
6752
6953
|
"maxLength": 1024,
|
|
6753
6954
|
"x-f5xc-required-for": {
|
|
@@ -6773,6 +6974,9 @@
|
|
|
6773
6974
|
"ves.io.schema.rules.repeated.max_items": "10",
|
|
6774
6975
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
6775
6976
|
},
|
|
6977
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
6978
|
+
"x-f5xc-description-short": "Filters discovered server blocks based on server name, domain and ports. Atleast, one field should be populated for each filter.",
|
|
6979
|
+
"x-f5xc-description-medium": "Filters discovered server blocks based on server name, domain and ports. Atleast, one field should be populated for each filter. X-textBlockContent: If no filters are specified, all server blocks will be discovered by default.",
|
|
6776
6980
|
"x-f5xc-required-for": {
|
|
6777
6981
|
"minimum_config": false,
|
|
6778
6982
|
"create": false,
|
|
@@ -6781,6 +6985,7 @@
|
|
|
6781
6985
|
}
|
|
6782
6986
|
}
|
|
6783
6987
|
},
|
|
6988
|
+
"x-f5xc-description-short": "API to GET NGINX Service Discovery object for a site or virtual site in system namespace.",
|
|
6784
6989
|
"x-f5xc-minimum-configuration": {
|
|
6785
6990
|
"description": "Minimum configuration for nginx_service_discoveryGetSpecType",
|
|
6786
6991
|
"required_fields": [
|
|
@@ -6811,6 +7016,7 @@
|
|
|
6811
7016
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
6812
7017
|
},
|
|
6813
7018
|
"x-displayname": "Errors",
|
|
7019
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
6814
7020
|
"x-f5xc-required-for": {
|
|
6815
7021
|
"minimum_config": false,
|
|
6816
7022
|
"create": false,
|
|
@@ -6826,6 +7032,8 @@
|
|
|
6826
7032
|
"$ref": "#/components/schemas/nginx_service_discoveryListResponseItem"
|
|
6827
7033
|
},
|
|
6828
7034
|
"x-displayname": "Items",
|
|
7035
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
7036
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
6829
7037
|
"x-f5xc-required-for": {
|
|
6830
7038
|
"minimum_config": false,
|
|
6831
7039
|
"create": false,
|
|
@@ -6859,6 +7067,8 @@
|
|
|
6859
7067
|
"description": "The set of annotations present on this nginx_service_discovery.",
|
|
6860
7068
|
"title": "Annotations.",
|
|
6861
7069
|
"x-displayname": "Annotations.",
|
|
7070
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7071
|
+
"x-f5xc-description-short": "The set of annotations present on this nginx_service_discovery.",
|
|
6862
7072
|
"x-f5xc-required-for": {
|
|
6863
7073
|
"minimum_config": false,
|
|
6864
7074
|
"create": false,
|
|
@@ -6871,6 +7081,7 @@
|
|
|
6871
7081
|
"description": "The description set for this nginx_service_discovery.",
|
|
6872
7082
|
"title": "Description.",
|
|
6873
7083
|
"x-displayname": "Description.",
|
|
7084
|
+
"x-f5xc-description-short": "The description set for this nginx_service_discovery.",
|
|
6874
7085
|
"minLength": 0,
|
|
6875
7086
|
"maxLength": 0,
|
|
6876
7087
|
"x-f5xc-required-for": {
|
|
@@ -6881,7 +7092,7 @@
|
|
|
6881
7092
|
},
|
|
6882
7093
|
"x-original-maxLength": 1024,
|
|
6883
7094
|
"x-reconciled-from-discovery": true,
|
|
6884
|
-
"x-reconciled-at": "2026-01-
|
|
7095
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588154+00:00"
|
|
6885
7096
|
},
|
|
6886
7097
|
"disabled": {
|
|
6887
7098
|
"type": "boolean",
|
|
@@ -6889,6 +7100,8 @@
|
|
|
6889
7100
|
"title": "Disabled",
|
|
6890
7101
|
"format": "boolean",
|
|
6891
7102
|
"x-displayname": "Disabled",
|
|
7103
|
+
"x-f5xc-example": "True",
|
|
7104
|
+
"x-f5xc-description-short": "Value of true indicates nginx_service_discovery is administratively disabled.",
|
|
6892
7105
|
"x-f5xc-required-for": {
|
|
6893
7106
|
"minimum_config": false,
|
|
6894
7107
|
"create": false,
|
|
@@ -6904,6 +7117,8 @@
|
|
|
6904
7117
|
"description": "The set of labels present on this nginx_service_discovery.",
|
|
6905
7118
|
"title": "Labels",
|
|
6906
7119
|
"x-displayname": "Labels",
|
|
7120
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7121
|
+
"x-f5xc-description-short": "The set of labels present on this nginx_service_discovery.",
|
|
6907
7122
|
"x-f5xc-required-for": {
|
|
6908
7123
|
"minimum_config": false,
|
|
6909
7124
|
"create": false,
|
|
@@ -6921,6 +7136,7 @@
|
|
|
6921
7136
|
"x-displayname": "Name",
|
|
6922
7137
|
"x-ves-example": "Name",
|
|
6923
7138
|
"x-f5xc-example": "name",
|
|
7139
|
+
"x-f5xc-description-short": "The name of this nginx_service_discovery.",
|
|
6924
7140
|
"minLength": 0,
|
|
6925
7141
|
"maxLength": 16,
|
|
6926
7142
|
"x-f5xc-required-for": {
|
|
@@ -6931,7 +7147,7 @@
|
|
|
6931
7147
|
},
|
|
6932
7148
|
"x-original-maxLength": 1024,
|
|
6933
7149
|
"x-reconciled-from-discovery": true,
|
|
6934
|
-
"x-reconciled-at": "2026-01-
|
|
7150
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588164+00:00"
|
|
6935
7151
|
},
|
|
6936
7152
|
"namespace": {
|
|
6937
7153
|
"type": "string",
|
|
@@ -6950,7 +7166,7 @@
|
|
|
6950
7166
|
},
|
|
6951
7167
|
"x-original-maxLength": 1024,
|
|
6952
7168
|
"x-reconciled-from-discovery": true,
|
|
6953
|
-
"x-reconciled-at": "2026-01-
|
|
7169
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588169+00:00"
|
|
6954
7170
|
},
|
|
6955
7171
|
"owner_view": {
|
|
6956
7172
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -6963,6 +7179,7 @@
|
|
|
6963
7179
|
"$ref": "#/components/schemas/nginx_service_discoveryStatusObject"
|
|
6964
7180
|
},
|
|
6965
7181
|
"x-displayname": "Status",
|
|
7182
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
6966
7183
|
"x-f5xc-required-for": {
|
|
6967
7184
|
"minimum_config": false,
|
|
6968
7185
|
"create": false,
|
|
@@ -6991,7 +7208,7 @@
|
|
|
6991
7208
|
"x-field-mutability": "read-only",
|
|
6992
7209
|
"x-original-maxLength": 1024,
|
|
6993
7210
|
"x-reconciled-from-discovery": true,
|
|
6994
|
-
"x-reconciled-at": "2026-01-
|
|
7211
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588176+00:00"
|
|
6995
7212
|
},
|
|
6996
7213
|
"uid": {
|
|
6997
7214
|
"type": "string",
|
|
@@ -7000,6 +7217,7 @@
|
|
|
7000
7217
|
"x-displayname": "UID",
|
|
7001
7218
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
7002
7219
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
7220
|
+
"x-f5xc-description-short": "The unique uid of this nginx_service_discovery.",
|
|
7003
7221
|
"minLength": 0,
|
|
7004
7222
|
"maxLength": 36,
|
|
7005
7223
|
"x-f5xc-required-for": {
|
|
@@ -7012,9 +7230,11 @@
|
|
|
7012
7230
|
"x-original-maxLength": 1024,
|
|
7013
7231
|
"format": "uuid",
|
|
7014
7232
|
"x-reconciled-from-discovery": true,
|
|
7015
|
-
"x-reconciled-at": "2026-01-
|
|
7233
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588182+00:00"
|
|
7016
7234
|
}
|
|
7017
7235
|
},
|
|
7236
|
+
"x-f5xc-description-short": "By default a summary of nginx_service_discovery is returned in 'List'.",
|
|
7237
|
+
"x-f5xc-description-medium": "By default a summary of nginx_service_discovery is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
7018
7238
|
"x-f5xc-minimum-configuration": {
|
|
7019
7239
|
"description": "Minimum configuration for nginx_service_discoveryListResponseItem",
|
|
7020
7240
|
"required_fields": [
|
|
@@ -7064,6 +7284,7 @@
|
|
|
7064
7284
|
"ves.io.schema.rules.message.required": "true",
|
|
7065
7285
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
7066
7286
|
},
|
|
7287
|
+
"x-f5xc-description-short": "Select new NGINX Instance Required: YES.",
|
|
7067
7288
|
"x-f5xc-required-for": {
|
|
7068
7289
|
"minimum_config": false,
|
|
7069
7290
|
"create": false,
|
|
@@ -7151,6 +7372,9 @@
|
|
|
7151
7372
|
"ves.io.schema.rules.repeated.max_items": "10",
|
|
7152
7373
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7153
7374
|
},
|
|
7375
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7376
|
+
"x-f5xc-description-short": "Filters discovered server blocks based on server name, domain and ports. Atleast, one field should be populated for each filter.",
|
|
7377
|
+
"x-f5xc-description-medium": "Filters discovered server blocks based on server name, domain and ports. Atleast, one field should be populated for each filter. X-textBlockContent: If no filters are specified, all server blocks will be discovered by default.",
|
|
7154
7378
|
"x-f5xc-required-for": {
|
|
7155
7379
|
"minimum_config": false,
|
|
7156
7380
|
"create": false,
|
|
@@ -7159,6 +7383,7 @@
|
|
|
7159
7383
|
}
|
|
7160
7384
|
}
|
|
7161
7385
|
},
|
|
7386
|
+
"x-f5xc-description-short": "API to replace NGINX Service Discovery object for a site or virtual site in system namespace.",
|
|
7162
7387
|
"x-f5xc-minimum-configuration": {
|
|
7163
7388
|
"description": "Minimum configuration for nginx_service_discoveryReplaceSpecType",
|
|
7164
7389
|
"required_fields": [
|
|
@@ -7192,6 +7417,8 @@
|
|
|
7192
7417
|
"ves.io.schema.rules.string.max_len": "256",
|
|
7193
7418
|
"ves.io.schema.rules.string.regex": "true"
|
|
7194
7419
|
},
|
|
7420
|
+
"x-f5xc-example": "example-resource",
|
|
7421
|
+
"x-f5xc-description-short": "Regular expression to match the server name or domain that must be discovered.",
|
|
7195
7422
|
"minLength": 0,
|
|
7196
7423
|
"x-f5xc-required-for": {
|
|
7197
7424
|
"minimum_config": false,
|
|
@@ -7220,6 +7447,8 @@
|
|
|
7220
7447
|
"ves.io.schema.rules.string.port_range_list": "true",
|
|
7221
7448
|
"ves.io.schema.rules.string.unique_port_range_list": "true"
|
|
7222
7449
|
},
|
|
7450
|
+
"x-f5xc-description-short": "String containing a comma separated list of individual service ports or port ranges.",
|
|
7451
|
+
"x-f5xc-description-medium": "String containing a comma separated list of individual service ports or port ranges. Each port range consists of a single port or two ports separated by \"-\". For example, 8000-8191.",
|
|
7223
7452
|
"minLength": 0,
|
|
7224
7453
|
"x-f5xc-required-for": {
|
|
7225
7454
|
"minimum_config": false,
|
|
@@ -7283,6 +7512,7 @@
|
|
|
7283
7512
|
}
|
|
7284
7513
|
}
|
|
7285
7514
|
},
|
|
7515
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
7286
7516
|
"x-f5xc-minimum-configuration": {
|
|
7287
7517
|
"description": "Minimum configuration for nginx_service_discoveryStatusObject",
|
|
7288
7518
|
"required_fields": [
|
|
@@ -7322,6 +7552,8 @@
|
|
|
7322
7552
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
7323
7553
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
7324
7554
|
},
|
|
7555
|
+
"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.",
|
|
7556
|
+
"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.",
|
|
7325
7557
|
"x-f5xc-required-for": {
|
|
7326
7558
|
"minimum_config": false,
|
|
7327
7559
|
"create": false,
|
|
@@ -7343,6 +7575,7 @@
|
|
|
7343
7575
|
"x-validation-rules": {
|
|
7344
7576
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
7345
7577
|
},
|
|
7578
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
7346
7579
|
"minLength": 0,
|
|
7347
7580
|
"x-f5xc-required-for": {
|
|
7348
7581
|
"minimum_config": false,
|
|
@@ -7352,7 +7585,7 @@
|
|
|
7352
7585
|
},
|
|
7353
7586
|
"x-original-maxLength": 1200,
|
|
7354
7587
|
"x-reconciled-from-discovery": true,
|
|
7355
|
-
"x-reconciled-at": "2026-01-
|
|
7588
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588241+00:00"
|
|
7356
7589
|
},
|
|
7357
7590
|
"disable": {
|
|
7358
7591
|
"type": "boolean",
|
|
@@ -7361,6 +7594,7 @@
|
|
|
7361
7594
|
"format": "boolean",
|
|
7362
7595
|
"x-displayname": "Disable",
|
|
7363
7596
|
"x-f5xc-example": "true",
|
|
7597
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
7364
7598
|
"x-f5xc-required-for": {
|
|
7365
7599
|
"minimum_config": false,
|
|
7366
7600
|
"create": false,
|
|
@@ -7374,6 +7608,8 @@
|
|
|
7374
7608
|
"title": "Labels",
|
|
7375
7609
|
"x-displayname": "Labels",
|
|
7376
7610
|
"x-f5xc-example": "value",
|
|
7611
|
+
"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.",
|
|
7612
|
+
"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.",
|
|
7377
7613
|
"x-f5xc-required-for": {
|
|
7378
7614
|
"minimum_config": false,
|
|
7379
7615
|
"create": false,
|
|
@@ -7395,6 +7631,8 @@
|
|
|
7395
7631
|
"x-validation-rules": {
|
|
7396
7632
|
"ves.io.schema.rules.message.required": "true"
|
|
7397
7633
|
},
|
|
7634
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
7635
|
+
"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.",
|
|
7398
7636
|
"minLength": 0,
|
|
7399
7637
|
"maxLength": 16,
|
|
7400
7638
|
"x-f5xc-required-for": {
|
|
@@ -7405,7 +7643,7 @@
|
|
|
7405
7643
|
},
|
|
7406
7644
|
"x-original-maxLength": 1024,
|
|
7407
7645
|
"x-reconciled-from-discovery": true,
|
|
7408
|
-
"x-reconciled-at": "2026-01-
|
|
7646
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588248+00:00"
|
|
7409
7647
|
},
|
|
7410
7648
|
"namespace": {
|
|
7411
7649
|
"type": "string",
|
|
@@ -7414,6 +7652,8 @@
|
|
|
7414
7652
|
"x-displayname": "Namespace",
|
|
7415
7653
|
"x-ves-example": "Staging",
|
|
7416
7654
|
"x-f5xc-example": "staging",
|
|
7655
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
7656
|
+
"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 \"\".",
|
|
7417
7657
|
"minLength": 0,
|
|
7418
7658
|
"maxLength": 6,
|
|
7419
7659
|
"x-f5xc-required-for": {
|
|
@@ -7424,9 +7664,10 @@
|
|
|
7424
7664
|
},
|
|
7425
7665
|
"x-original-maxLength": 1024,
|
|
7426
7666
|
"x-reconciled-from-discovery": true,
|
|
7427
|
-
"x-reconciled-at": "2026-01-
|
|
7667
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588252+00:00"
|
|
7428
7668
|
}
|
|
7429
7669
|
},
|
|
7670
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
7430
7671
|
"x-f5xc-minimum-configuration": {
|
|
7431
7672
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
7432
7673
|
"required_fields": [
|
|
@@ -7458,6 +7699,8 @@
|
|
|
7458
7699
|
"x-displayname": "Kind",
|
|
7459
7700
|
"x-ves-example": "Virtual_site.",
|
|
7460
7701
|
"x-f5xc-example": "virtual_site",
|
|
7702
|
+
"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\")",
|
|
7703
|
+
"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\").",
|
|
7461
7704
|
"minLength": 0,
|
|
7462
7705
|
"maxLength": 14,
|
|
7463
7706
|
"x-f5xc-required-for": {
|
|
@@ -7469,7 +7712,7 @@
|
|
|
7469
7712
|
"readOnly": true,
|
|
7470
7713
|
"x-original-maxLength": 1024,
|
|
7471
7714
|
"x-reconciled-from-discovery": true,
|
|
7472
|
-
"x-reconciled-at": "2026-01-
|
|
7715
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588274+00:00"
|
|
7473
7716
|
},
|
|
7474
7717
|
"name": {
|
|
7475
7718
|
"type": "string",
|
|
@@ -7478,6 +7721,8 @@
|
|
|
7478
7721
|
"x-displayname": "Name",
|
|
7479
7722
|
"x-ves-example": "Contactus-route.",
|
|
7480
7723
|
"x-f5xc-example": "contactus-route",
|
|
7724
|
+
"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.",
|
|
7725
|
+
"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.",
|
|
7481
7726
|
"minLength": 0,
|
|
7482
7727
|
"maxLength": 16,
|
|
7483
7728
|
"x-f5xc-required-for": {
|
|
@@ -7488,7 +7733,7 @@
|
|
|
7488
7733
|
},
|
|
7489
7734
|
"x-original-maxLength": 1024,
|
|
7490
7735
|
"x-reconciled-from-discovery": true,
|
|
7491
|
-
"x-reconciled-at": "2026-01-
|
|
7736
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588278+00:00"
|
|
7492
7737
|
},
|
|
7493
7738
|
"namespace": {
|
|
7494
7739
|
"type": "string",
|
|
@@ -7497,6 +7742,8 @@
|
|
|
7497
7742
|
"x-displayname": "Namespace",
|
|
7498
7743
|
"x-ves-example": "Ns1",
|
|
7499
7744
|
"x-f5xc-example": "ns1",
|
|
7745
|
+
"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.",
|
|
7746
|
+
"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.",
|
|
7500
7747
|
"minLength": 0,
|
|
7501
7748
|
"maxLength": 6,
|
|
7502
7749
|
"x-f5xc-required-for": {
|
|
@@ -7507,7 +7754,7 @@
|
|
|
7507
7754
|
},
|
|
7508
7755
|
"x-original-maxLength": 1024,
|
|
7509
7756
|
"x-reconciled-from-discovery": true,
|
|
7510
|
-
"x-reconciled-at": "2026-01-
|
|
7757
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588282+00:00"
|
|
7511
7758
|
},
|
|
7512
7759
|
"tenant": {
|
|
7513
7760
|
"type": "string",
|
|
@@ -7516,6 +7763,8 @@
|
|
|
7516
7763
|
"x-displayname": "Tenant",
|
|
7517
7764
|
"x-ves-example": "Example-corp.",
|
|
7518
7765
|
"x-f5xc-example": "example-corp",
|
|
7766
|
+
"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.",
|
|
7767
|
+
"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.",
|
|
7519
7768
|
"minLength": 0,
|
|
7520
7769
|
"maxLength": 18,
|
|
7521
7770
|
"x-f5xc-required-for": {
|
|
@@ -7528,7 +7777,7 @@
|
|
|
7528
7777
|
"x-field-mutability": "read-only",
|
|
7529
7778
|
"x-original-maxLength": 1024,
|
|
7530
7779
|
"x-reconciled-from-discovery": true,
|
|
7531
|
-
"x-reconciled-at": "2026-01-
|
|
7780
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588286+00:00"
|
|
7532
7781
|
},
|
|
7533
7782
|
"uid": {
|
|
7534
7783
|
"type": "string",
|
|
@@ -7537,6 +7786,8 @@
|
|
|
7537
7786
|
"x-displayname": "UID",
|
|
7538
7787
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
7539
7788
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
7789
|
+
"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.",
|
|
7790
|
+
"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.",
|
|
7540
7791
|
"minLength": 0,
|
|
7541
7792
|
"maxLength": 36,
|
|
7542
7793
|
"x-f5xc-required-for": {
|
|
@@ -7550,9 +7801,11 @@
|
|
|
7550
7801
|
"x-original-maxLength": 1024,
|
|
7551
7802
|
"format": "uuid",
|
|
7552
7803
|
"x-reconciled-from-discovery": true,
|
|
7553
|
-
"x-reconciled-at": "2026-01-
|
|
7804
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588291+00:00"
|
|
7554
7805
|
}
|
|
7555
7806
|
},
|
|
7807
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
7808
|
+
"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...",
|
|
7556
7809
|
"x-f5xc-minimum-configuration": {
|
|
7557
7810
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
7558
7811
|
"required_fields": [
|
|
@@ -7595,6 +7848,8 @@
|
|
|
7595
7848
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
7596
7849
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
7597
7850
|
},
|
|
7851
|
+
"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.",
|
|
7852
|
+
"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.",
|
|
7598
7853
|
"x-f5xc-required-for": {
|
|
7599
7854
|
"minimum_config": false,
|
|
7600
7855
|
"create": false,
|
|
@@ -7616,6 +7871,7 @@
|
|
|
7616
7871
|
"x-validation-rules": {
|
|
7617
7872
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
7618
7873
|
},
|
|
7874
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
7619
7875
|
"minLength": 0,
|
|
7620
7876
|
"x-f5xc-required-for": {
|
|
7621
7877
|
"minimum_config": false,
|
|
@@ -7625,7 +7881,7 @@
|
|
|
7625
7881
|
},
|
|
7626
7882
|
"x-original-maxLength": 1200,
|
|
7627
7883
|
"x-reconciled-from-discovery": true,
|
|
7628
|
-
"x-reconciled-at": "2026-01-
|
|
7884
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588298+00:00"
|
|
7629
7885
|
},
|
|
7630
7886
|
"disable": {
|
|
7631
7887
|
"type": "boolean",
|
|
@@ -7634,6 +7890,7 @@
|
|
|
7634
7890
|
"format": "boolean",
|
|
7635
7891
|
"x-displayname": "Disable",
|
|
7636
7892
|
"x-f5xc-example": "true",
|
|
7893
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
7637
7894
|
"x-f5xc-required-for": {
|
|
7638
7895
|
"minimum_config": false,
|
|
7639
7896
|
"create": false,
|
|
@@ -7648,6 +7905,8 @@
|
|
|
7648
7905
|
"x-displayname": "Labels",
|
|
7649
7906
|
"x-ves-example": "Value",
|
|
7650
7907
|
"x-f5xc-example": "value",
|
|
7908
|
+
"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.",
|
|
7909
|
+
"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.",
|
|
7651
7910
|
"x-f5xc-required-for": {
|
|
7652
7911
|
"minimum_config": false,
|
|
7653
7912
|
"create": false,
|
|
@@ -7668,6 +7927,8 @@
|
|
|
7668
7927
|
"x-validation-rules": {
|
|
7669
7928
|
"ves.io.schema.rules.message.required": "true"
|
|
7670
7929
|
},
|
|
7930
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
7931
|
+
"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.",
|
|
7671
7932
|
"minLength": 0,
|
|
7672
7933
|
"maxLength": 16,
|
|
7673
7934
|
"x-f5xc-required-for": {
|
|
@@ -7678,7 +7939,7 @@
|
|
|
7678
7939
|
},
|
|
7679
7940
|
"x-original-maxLength": 1024,
|
|
7680
7941
|
"x-reconciled-from-discovery": true,
|
|
7681
|
-
"x-reconciled-at": "2026-01-
|
|
7942
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588306+00:00"
|
|
7682
7943
|
},
|
|
7683
7944
|
"namespace": {
|
|
7684
7945
|
"type": "string",
|
|
@@ -7687,6 +7948,8 @@
|
|
|
7687
7948
|
"x-displayname": "Namespace",
|
|
7688
7949
|
"x-ves-example": "Staging",
|
|
7689
7950
|
"x-f5xc-example": "staging",
|
|
7951
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
7952
|
+
"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 \"\".",
|
|
7690
7953
|
"minLength": 0,
|
|
7691
7954
|
"maxLength": 6,
|
|
7692
7955
|
"x-f5xc-required-for": {
|
|
@@ -7697,9 +7960,10 @@
|
|
|
7697
7960
|
},
|
|
7698
7961
|
"x-original-maxLength": 1024,
|
|
7699
7962
|
"x-reconciled-from-discovery": true,
|
|
7700
|
-
"x-reconciled-at": "2026-01-
|
|
7963
|
+
"x-reconciled-at": "2026-01-07T15:53:41.588310+00:00"
|
|
7701
7964
|
}
|
|
7702
7965
|
},
|
|
7966
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
7703
7967
|
"x-f5xc-minimum-configuration": {
|
|
7704
7968
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
7705
7969
|
"required_fields": [
|