@robinmordasiewicz/f5xc-api-mcp 2.0.10-2601051503 → 2.0.19-2601071557

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/CHANGELOG.md +25 -14
  2. package/README.md +9 -5
  3. package/dist/generator/domain-metadata.d.ts +1 -3
  4. package/dist/generator/domain-metadata.d.ts.map +1 -1
  5. package/dist/generator/domain-metadata.js +0 -20
  6. package/dist/generator/domain-metadata.js.map +1 -1
  7. package/dist/generator/naming/acronyms.d.ts +1 -1
  8. package/dist/generator/naming/acronyms.js +1 -1
  9. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  10. package/dist/tools/generated/ce_management/index.js +179 -1582
  11. package/dist/tools/generated/ce_management/index.js.map +1 -1
  12. package/dist/tools/generated/dependency-graph.json +2 -265
  13. package/dist/version.d.ts +2 -2
  14. package/dist/version.js +2 -2
  15. package/manifest.json +1 -1
  16. package/package.json +1 -1
  17. package/specs/domains/admin_console_and_ui.json +176 -26
  18. package/specs/domains/ai_services.json +242 -36
  19. package/specs/domains/api.json +1507 -183
  20. package/specs/domains/authentication.json +358 -46
  21. package/specs/domains/bigip.json +825 -105
  22. package/specs/domains/billing_and_usage.json +666 -83
  23. package/specs/domains/blindfold.json +988 -111
  24. package/specs/domains/bot_and_threat_defense.json +550 -66
  25. package/specs/domains/cdn.json +2431 -198
  26. package/specs/domains/ce_management.json +9272 -15726
  27. package/specs/domains/certificates.json +540 -78
  28. package/specs/domains/cloud_infrastructure.json +1102 -122
  29. package/specs/domains/container_services.json +782 -99
  30. package/specs/domains/data_and_privacy_security.json +508 -68
  31. package/specs/domains/data_intelligence.json +487 -64
  32. package/specs/domains/ddos.json +1302 -161
  33. package/specs/domains/dns.json +1286 -162
  34. package/specs/domains/managed_kubernetes.json +687 -89
  35. package/specs/domains/marketplace.json +994 -105
  36. package/specs/domains/network.json +2340 -239
  37. package/specs/domains/network_security.json +1963 -192
  38. package/specs/domains/nginx_one.json +475 -63
  39. package/specs/domains/object_storage.json +163 -16
  40. package/specs/domains/observability.json +1519 -148
  41. package/specs/domains/rate_limiting.json +456 -56
  42. package/specs/domains/secops_and_incident_response.json +275 -37
  43. package/specs/domains/service_mesh.json +1320 -128
  44. package/specs/domains/shape.json +4196 -398
  45. package/specs/domains/sites.json +5053 -405
  46. package/specs/domains/statistics.json +2784 -236
  47. package/specs/domains/support.json +1038 -109
  48. package/specs/domains/telemetry_and_insights.json +993 -80
  49. package/specs/domains/tenant_and_identity.json +3487 -313
  50. package/specs/domains/threat_campaign.json +695 -72
  51. package/specs/domains/users.json +437 -72
  52. package/specs/domains/virtual.json +3716 -261
  53. package/specs/domains/vpm_and_node_management.json +61 -2
  54. package/specs/domains/waf.json +1551 -149
  55. package/specs/index.json +121 -26
@@ -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.10",
6
+ "version": "2.0.19",
7
7
  "contact": {
8
8
  "name": "F5 Distributed Cloud",
9
9
  "url": "https://docs.cloud.f5.com"
@@ -13,7 +13,57 @@
13
13
  "url": "https://www.f5.com/company/policies/eula"
14
14
  },
15
15
  "summary": "Instance discovery, WAF integration, and service mesh connectivity. Subscription lifecycle and configuration synchronization.",
16
- "x-f5xc-cli-domain": "nginx_one"
16
+ "x-f5xc-cli-domain": "nginx_one",
17
+ "x-f5xc-best-practices": {
18
+ "common_errors": [
19
+ {
20
+ "code": 400,
21
+ "message": "Invalid request body",
22
+ "resolution": "Validate JSON structure and required fields before submission",
23
+ "prevention": "Use schema validation from OpenAPI spec"
24
+ },
25
+ {
26
+ "code": 401,
27
+ "message": "Authentication failed",
28
+ "resolution": "Verify API token is valid and not expired",
29
+ "prevention": "Use environment variables for token management"
30
+ },
31
+ {
32
+ "code": 403,
33
+ "message": "Permission denied",
34
+ "resolution": "Check user role and namespace permissions",
35
+ "prevention": "Verify RBAC policies before operations"
36
+ },
37
+ {
38
+ "code": 404,
39
+ "message": "Resource not found",
40
+ "resolution": "Verify resource name and namespace exist",
41
+ "prevention": "List resources before attempting operations"
42
+ },
43
+ {
44
+ "code": 409,
45
+ "message": "Resource already exists",
46
+ "resolution": "Use unique name or delete existing resource",
47
+ "prevention": "Check existence before creation"
48
+ },
49
+ {
50
+ "code": 429,
51
+ "message": "Rate limit exceeded",
52
+ "resolution": "Implement exponential backoff and retry logic",
53
+ "prevention": "Batch operations and add delays between requests"
54
+ }
55
+ ],
56
+ "security_notes": [
57
+ "Always use HTTPS for all API communications",
58
+ "Store API tokens securely, never in source code",
59
+ "Rotate API tokens regularly following security policies"
60
+ ],
61
+ "performance_tips": [
62
+ "Use pagination for large result sets",
63
+ "Batch related operations when possible",
64
+ "Cache read-only responses appropriately"
65
+ ]
66
+ }
17
67
  },
18
68
  "servers": [
19
69
  {
@@ -293,6 +343,13 @@
293
343
  "latency": "moderate",
294
344
  "resource_usage": "moderate"
295
345
  }
346
+ },
347
+ "x-f5xc-discovered-response-time": {
348
+ "p50_ms": 200,
349
+ "p95_ms": 800,
350
+ "p99_ms": 2000,
351
+ "sample_count": 0,
352
+ "source": "estimate"
296
353
  }
297
354
  },
298
355
  "x-displayname": "NGINX One CSG Object configuration.",
@@ -511,6 +568,13 @@
511
568
  "latency": "low",
512
569
  "resource_usage": "low"
513
570
  }
571
+ },
572
+ "x-f5xc-discovered-response-time": {
573
+ "p50_ms": 200,
574
+ "p95_ms": 800,
575
+ "p99_ms": 2000,
576
+ "sample_count": 0,
577
+ "source": "estimate"
514
578
  }
515
579
  },
516
580
  "x-displayname": "NGINX One CSG Object configuration.",
@@ -738,6 +802,13 @@
738
802
  "latency": "moderate",
739
803
  "resource_usage": "moderate"
740
804
  }
805
+ },
806
+ "x-f5xc-discovered-response-time": {
807
+ "p50_ms": 200,
808
+ "p95_ms": 800,
809
+ "p99_ms": 2000,
810
+ "sample_count": 0,
811
+ "source": "estimate"
741
812
  }
742
813
  },
743
814
  "x-displayname": "NGINX One Instance Object configuration.",
@@ -956,6 +1027,13 @@
956
1027
  "latency": "low",
957
1028
  "resource_usage": "low"
958
1029
  }
1030
+ },
1031
+ "x-f5xc-discovered-response-time": {
1032
+ "p50_ms": 200,
1033
+ "p95_ms": 800,
1034
+ "p99_ms": 2000,
1035
+ "sample_count": 0,
1036
+ "source": "estimate"
959
1037
  }
960
1038
  },
961
1039
  "x-displayname": "NGINX One Instance Object configuration.",
@@ -1170,6 +1248,13 @@
1170
1248
  "latency": "low",
1171
1249
  "resource_usage": "low"
1172
1250
  }
1251
+ },
1252
+ "x-f5xc-discovered-response-time": {
1253
+ "p50_ms": 1000,
1254
+ "p95_ms": 3000,
1255
+ "p99_ms": 8000,
1256
+ "sample_count": 0,
1257
+ "source": "estimate"
1173
1258
  }
1174
1259
  },
1175
1260
  "x-displayname": "NGINX One Server APIs.",
@@ -1397,6 +1482,13 @@
1397
1482
  "latency": "moderate",
1398
1483
  "resource_usage": "moderate"
1399
1484
  }
1485
+ },
1486
+ "x-f5xc-discovered-response-time": {
1487
+ "p50_ms": 200,
1488
+ "p95_ms": 800,
1489
+ "p99_ms": 2000,
1490
+ "sample_count": 0,
1491
+ "source": "estimate"
1400
1492
  }
1401
1493
  },
1402
1494
  "x-displayname": "NGINX One Server APIs.",
@@ -1616,6 +1708,13 @@
1616
1708
  "latency": "low",
1617
1709
  "resource_usage": "low"
1618
1710
  }
1711
+ },
1712
+ "x-f5xc-discovered-response-time": {
1713
+ "p50_ms": 200,
1714
+ "p95_ms": 800,
1715
+ "p99_ms": 2000,
1716
+ "sample_count": 0,
1717
+ "source": "estimate"
1619
1718
  }
1620
1719
  },
1621
1720
  "x-displayname": "NGINX One Server APIs.",
@@ -1815,6 +1914,13 @@
1815
1914
  "latency": "low",
1816
1915
  "resource_usage": "low"
1817
1916
  }
1917
+ },
1918
+ "x-f5xc-discovered-response-time": {
1919
+ "p50_ms": 1000,
1920
+ "p95_ms": 3000,
1921
+ "p99_ms": 8000,
1922
+ "sample_count": 0,
1923
+ "source": "estimate"
1818
1924
  }
1819
1925
  },
1820
1926
  "x-displayname": "NGINX One Subscription API.",
@@ -2014,6 +2120,13 @@
2014
2120
  "latency": "low",
2015
2121
  "resource_usage": "low"
2016
2122
  }
2123
+ },
2124
+ "x-f5xc-discovered-response-time": {
2125
+ "p50_ms": 1000,
2126
+ "p95_ms": 3000,
2127
+ "p99_ms": 8000,
2128
+ "sample_count": 0,
2129
+ "source": "estimate"
2017
2130
  }
2018
2131
  },
2019
2132
  "x-displayname": "NGINX One Subscription API.",
@@ -2228,6 +2341,13 @@
2228
2341
  "latency": "low",
2229
2342
  "resource_usage": "low"
2230
2343
  }
2344
+ },
2345
+ "x-f5xc-discovered-response-time": {
2346
+ "p50_ms": 1000,
2347
+ "p95_ms": 3000,
2348
+ "p99_ms": 8000,
2349
+ "sample_count": 0,
2350
+ "source": "estimate"
2231
2351
  }
2232
2352
  },
2233
2353
  "x-displayname": "NGINX Service Discovery.",
@@ -2450,6 +2570,13 @@
2450
2570
  "latency": "low",
2451
2571
  "resource_usage": "low"
2452
2572
  }
2573
+ },
2574
+ "x-f5xc-discovered-response-time": {
2575
+ "p50_ms": 800,
2576
+ "p95_ms": 2500,
2577
+ "p99_ms": 6000,
2578
+ "sample_count": 0,
2579
+ "source": "estimate"
2453
2580
  }
2454
2581
  },
2455
2582
  "x-displayname": "NGINX Service Discovery.",
@@ -2677,6 +2804,13 @@
2677
2804
  "latency": "moderate",
2678
2805
  "resource_usage": "moderate"
2679
2806
  }
2807
+ },
2808
+ "x-f5xc-discovered-response-time": {
2809
+ "p50_ms": 200,
2810
+ "p95_ms": 800,
2811
+ "p99_ms": 2000,
2812
+ "sample_count": 0,
2813
+ "source": "estimate"
2680
2814
  }
2681
2815
  },
2682
2816
  "x-displayname": "NGINX Service Discovery.",
@@ -2898,6 +3032,13 @@
2898
3032
  "latency": "low",
2899
3033
  "resource_usage": "low"
2900
3034
  }
3035
+ },
3036
+ "x-f5xc-discovered-response-time": {
3037
+ "p50_ms": 200,
3038
+ "p95_ms": 800,
3039
+ "p99_ms": 2000,
3040
+ "sample_count": 0,
3041
+ "source": "estimate"
2901
3042
  }
2902
3043
  },
2903
3044
  "delete": {
@@ -3117,6 +3258,13 @@
3117
3258
  "latency": "high",
3118
3259
  "resource_usage": "moderate"
3119
3260
  }
3261
+ },
3262
+ "x-f5xc-discovered-response-time": {
3263
+ "p50_ms": 500,
3264
+ "p95_ms": 1500,
3265
+ "p99_ms": 4000,
3266
+ "sample_count": 0,
3267
+ "source": "estimate"
3120
3268
  }
3121
3269
  },
3122
3270
  "x-displayname": "NGINX Service Discovery.",
@@ -3140,6 +3288,7 @@
3140
3288
  "title": "Empty",
3141
3289
  "x-displayname": "Empty",
3142
3290
  "x-ves-proto-message": "ves.io.schema.Empty",
3291
+ "x-f5xc-description-short": "Can be used for messages where no values are needed.",
3143
3292
  "x-f5xc-minimum-configuration": {
3144
3293
  "description": "Minimum configuration for ioschemaEmpty",
3145
3294
  "required_fields": [],
@@ -3164,6 +3313,8 @@
3164
3313
  "x-displayname": "Kind",
3165
3314
  "x-ves-example": "Virtual_site.",
3166
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\").",
3167
3318
  "minLength": 0,
3168
3319
  "maxLength": 14,
3169
3320
  "x-f5xc-required-for": {
@@ -3175,7 +3326,7 @@
3175
3326
  "readOnly": true,
3176
3327
  "x-original-maxLength": 1024,
3177
3328
  "x-reconciled-from-discovery": true,
3178
- "x-reconciled-at": "2026-01-05T14:38:38.688966+00:00"
3329
+ "x-reconciled-at": "2026-01-07T15:28:58.902072+00:00"
3179
3330
  },
3180
3331
  "name": {
3181
3332
  "type": "string",
@@ -3184,6 +3335,8 @@
3184
3335
  "x-displayname": "Name",
3185
3336
  "x-ves-example": "Contactus-route.",
3186
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.",
3187
3340
  "minLength": 0,
3188
3341
  "maxLength": 16,
3189
3342
  "x-f5xc-required-for": {
@@ -3194,7 +3347,7 @@
3194
3347
  },
3195
3348
  "x-original-maxLength": 1024,
3196
3349
  "x-reconciled-from-discovery": true,
3197
- "x-reconciled-at": "2026-01-05T14:38:38.688973+00:00"
3350
+ "x-reconciled-at": "2026-01-07T15:28:58.902080+00:00"
3198
3351
  },
3199
3352
  "namespace": {
3200
3353
  "type": "string",
@@ -3203,6 +3356,8 @@
3203
3356
  "x-displayname": "Namespace",
3204
3357
  "x-ves-example": "Ns1",
3205
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.",
3206
3361
  "minLength": 0,
3207
3362
  "maxLength": 6,
3208
3363
  "x-f5xc-required-for": {
@@ -3213,7 +3368,7 @@
3213
3368
  },
3214
3369
  "x-original-maxLength": 1024,
3215
3370
  "x-reconciled-from-discovery": true,
3216
- "x-reconciled-at": "2026-01-05T14:38:38.688978+00:00"
3371
+ "x-reconciled-at": "2026-01-07T15:28:58.902084+00:00"
3217
3372
  },
3218
3373
  "tenant": {
3219
3374
  "type": "string",
@@ -3222,6 +3377,8 @@
3222
3377
  "x-displayname": "Tenant",
3223
3378
  "x-ves-example": "Example-corp.",
3224
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.",
3225
3382
  "minLength": 0,
3226
3383
  "maxLength": 18,
3227
3384
  "x-f5xc-required-for": {
@@ -3234,7 +3391,7 @@
3234
3391
  "x-field-mutability": "read-only",
3235
3392
  "x-original-maxLength": 1024,
3236
3393
  "x-reconciled-from-discovery": true,
3237
- "x-reconciled-at": "2026-01-05T14:38:38.688983+00:00"
3394
+ "x-reconciled-at": "2026-01-07T15:28:58.902089+00:00"
3238
3395
  },
3239
3396
  "uid": {
3240
3397
  "type": "string",
@@ -3243,6 +3400,8 @@
3243
3400
  "x-displayname": "UID",
3244
3401
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
3245
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.",
3246
3405
  "minLength": 0,
3247
3406
  "maxLength": 36,
3248
3407
  "x-f5xc-required-for": {
@@ -3256,9 +3415,11 @@
3256
3415
  "x-original-maxLength": 1024,
3257
3416
  "format": "uuid",
3258
3417
  "x-reconciled-from-discovery": true,
3259
- "x-reconciled-at": "2026-01-05T14:38:38.688989+00:00"
3418
+ "x-reconciled-at": "2026-01-07T15:28:58.902095+00:00"
3260
3419
  }
3261
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...",
3262
3423
  "x-f5xc-minimum-configuration": {
3263
3424
  "description": "Minimum configuration for ioschemaObjectRefType",
3264
3425
  "required_fields": [
@@ -3290,6 +3451,7 @@
3290
3451
  "$ref": "#/components/schemas/ioschemaObjectRefType"
3291
3452
  },
3292
3453
  "x-displayname": "Deleted Referred Objects.",
3454
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
3293
3455
  "x-f5xc-required-for": {
3294
3456
  "minimum_config": false,
3295
3457
  "create": false,
@@ -3305,6 +3467,7 @@
3305
3467
  "$ref": "#/components/schemas/ioschemaObjectRefType"
3306
3468
  },
3307
3469
  "x-displayname": "Disabled Referred Objects.",
3470
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
3308
3471
  "x-f5xc-required-for": {
3309
3472
  "minimum_config": false,
3310
3473
  "create": false,
@@ -3323,6 +3486,7 @@
3323
3486
  "$ref": "#/components/schemas/ioschemaObjectRefType"
3324
3487
  },
3325
3488
  "x-displayname": "Referring Objects.",
3489
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
3326
3490
  "x-f5xc-required-for": {
3327
3491
  "minimum_config": false,
3328
3492
  "create": false,
@@ -3365,6 +3529,8 @@
3365
3529
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
3366
3530
  ],
3367
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...",
3368
3534
  "x-f5xc-minimum-configuration": {
3369
3535
  "description": "Minimum configuration for nginx_csgGetResponseFormatCode",
3370
3536
  "required_fields": [],
@@ -3390,6 +3556,7 @@
3390
3556
  "$ref": "#/components/schemas/schemaErrorType"
3391
3557
  },
3392
3558
  "x-displayname": "Errors",
3559
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
3393
3560
  "x-f5xc-required-for": {
3394
3561
  "minimum_config": false,
3395
3562
  "create": false,
@@ -3405,6 +3572,8 @@
3405
3572
  "$ref": "#/components/schemas/nginx_csgListResponseItem"
3406
3573
  },
3407
3574
  "x-displayname": "Items",
3575
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
3576
+ "x-f5xc-description-short": "Items represents the collection in response.",
3408
3577
  "x-f5xc-required-for": {
3409
3578
  "minimum_config": false,
3410
3579
  "create": false,
@@ -3438,6 +3607,8 @@
3438
3607
  "description": "The set of annotations present on this nginx_csg.",
3439
3608
  "title": "Annotations.",
3440
3609
  "x-displayname": "Annotations.",
3610
+ "x-f5xc-example": "{\"key\": \"value\"}",
3611
+ "x-f5xc-description-short": "The set of annotations present on this nginx_csg.",
3441
3612
  "x-f5xc-required-for": {
3442
3613
  "minimum_config": false,
3443
3614
  "create": false,
@@ -3460,7 +3631,7 @@
3460
3631
  },
3461
3632
  "x-original-maxLength": 1024,
3462
3633
  "x-reconciled-from-discovery": true,
3463
- "x-reconciled-at": "2026-01-05T14:38:38.689011+00:00"
3634
+ "x-reconciled-at": "2026-01-07T15:28:58.902129+00:00"
3464
3635
  },
3465
3636
  "disabled": {
3466
3637
  "type": "boolean",
@@ -3468,6 +3639,8 @@
3468
3639
  "title": "Disabled",
3469
3640
  "format": "boolean",
3470
3641
  "x-displayname": "Disabled",
3642
+ "x-f5xc-example": "True",
3643
+ "x-f5xc-description-short": "Value of true indicates nginx_csg is administratively disabled.",
3471
3644
  "x-f5xc-required-for": {
3472
3645
  "minimum_config": false,
3473
3646
  "create": false,
@@ -3483,6 +3656,8 @@
3483
3656
  "description": "The set of labels present on this nginx_csg.",
3484
3657
  "title": "Labels",
3485
3658
  "x-displayname": "Labels",
3659
+ "x-f5xc-example": "{\"key\": \"value\"}",
3660
+ "x-f5xc-description-short": "The set of labels present on this nginx_csg.",
3486
3661
  "x-f5xc-required-for": {
3487
3662
  "minimum_config": false,
3488
3663
  "create": false,
@@ -3510,7 +3685,7 @@
3510
3685
  },
3511
3686
  "x-original-maxLength": 1024,
3512
3687
  "x-reconciled-from-discovery": true,
3513
- "x-reconciled-at": "2026-01-05T14:38:38.689023+00:00"
3688
+ "x-reconciled-at": "2026-01-07T15:28:58.902140+00:00"
3514
3689
  },
3515
3690
  "namespace": {
3516
3691
  "type": "string",
@@ -3529,7 +3704,7 @@
3529
3704
  },
3530
3705
  "x-original-maxLength": 1024,
3531
3706
  "x-reconciled-from-discovery": true,
3532
- "x-reconciled-at": "2026-01-05T14:38:38.689028+00:00"
3707
+ "x-reconciled-at": "2026-01-07T15:28:58.902145+00:00"
3533
3708
  },
3534
3709
  "owner_view": {
3535
3710
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -3555,7 +3730,7 @@
3555
3730
  "x-field-mutability": "read-only",
3556
3731
  "x-original-maxLength": 1024,
3557
3732
  "x-reconciled-from-discovery": true,
3558
- "x-reconciled-at": "2026-01-05T14:38:38.689035+00:00"
3733
+ "x-reconciled-at": "2026-01-07T15:28:58.902151+00:00"
3559
3734
  },
3560
3735
  "uid": {
3561
3736
  "type": "string",
@@ -3576,9 +3751,11 @@
3576
3751
  "x-original-maxLength": 1024,
3577
3752
  "format": "uuid",
3578
3753
  "x-reconciled-from-discovery": true,
3579
- "x-reconciled-at": "2026-01-05T14:38:38.689041+00:00"
3754
+ "x-reconciled-at": "2026-01-07T15:28:58.902157+00:00"
3580
3755
  }
3581
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.",
3582
3759
  "x-f5xc-minimum-configuration": {
3583
3760
  "description": "Minimum configuration for nginx_csgListResponseItem",
3584
3761
  "required_fields": [
@@ -3660,6 +3837,7 @@
3660
3837
  "x-validation-rules": {
3661
3838
  "ves.io.schema.rules.message.required": "true"
3662
3839
  },
3840
+ "x-f5xc-example": "example-resource",
3663
3841
  "minLength": 0,
3664
3842
  "maxLength": 1024,
3665
3843
  "x-f5xc-required-for": {
@@ -3681,6 +3859,8 @@
3681
3859
  "x-validation-rules": {
3682
3860
  "ves.io.schema.rules.message.required": "true"
3683
3861
  },
3862
+ "x-f5xc-example": "example-resource",
3863
+ "x-f5xc-description-short": "Policy name configured for WAF Required: YES.",
3684
3864
  "minLength": 0,
3685
3865
  "maxLength": 1024,
3686
3866
  "x-f5xc-required-for": {
@@ -3696,6 +3876,7 @@
3696
3876
  "title": "Security_log_enabled.",
3697
3877
  "format": "boolean",
3698
3878
  "x-displayname": "WAF Log Enabled.",
3879
+ "x-f5xc-description-short": "Specifies if security logging is enabled.",
3699
3880
  "x-f5xc-required-for": {
3700
3881
  "minimum_config": false,
3701
3882
  "create": false,
@@ -3711,6 +3892,8 @@
3711
3892
  "type": "string"
3712
3893
  },
3713
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.",
3714
3897
  "x-f5xc-required-for": {
3715
3898
  "minimum_config": false,
3716
3899
  "create": false,
@@ -3753,6 +3936,7 @@
3753
3936
  "type": "string",
3754
3937
  "description": "Name for CSG in NGINX One.",
3755
3938
  "x-displayname": "CSGName",
3939
+ "x-f5xc-example": "example-resource",
3756
3940
  "minLength": 0,
3757
3941
  "maxLength": 1024,
3758
3942
  "x-f5xc-required-for": {
@@ -3766,6 +3950,7 @@
3766
3950
  "type": "string",
3767
3951
  "description": "Identifier for config sync group in NGINX One.",
3768
3952
  "x-displayname": "ObjectId",
3953
+ "x-f5xc-description-short": "Identifier for config sync group in NGINX One.",
3769
3954
  "minLength": 0,
3770
3955
  "maxLength": 1024,
3771
3956
  "x-f5xc-required-for": {
@@ -3802,6 +3987,8 @@
3802
3987
  "type_url": {
3803
3988
  "type": "string",
3804
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 ).",
3805
3992
  "minLength": 0,
3806
3993
  "maxLength": 1024,
3807
3994
  "x-f5xc-required-for": {
@@ -3825,9 +4012,11 @@
3825
4012
  },
3826
4013
  "x-original-maxLength": 1024,
3827
4014
  "x-reconciled-from-discovery": true,
3828
- "x-reconciled-at": "2026-01-05T14:38:38.689070+00:00"
4015
+ "x-reconciled-at": "2026-01-07T15:28:58.902184+00:00"
3829
4016
  }
3830
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...",
3831
4020
  "x-f5xc-minimum-configuration": {
3832
4021
  "description": "Minimum configuration for protobufAny",
3833
4022
  "required_fields": [
@@ -3859,6 +4048,8 @@
3859
4048
  "default": "EOK",
3860
4049
  "x-displayname": "Error Code.",
3861
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...",
3862
4053
  "x-f5xc-minimum-configuration": {
3863
4054
  "description": "Minimum configuration for schemaErrorCode",
3864
4055
  "required_fields": [],
@@ -3899,6 +4090,7 @@
3899
4090
  }
3900
4091
  }
3901
4092
  },
4093
+ "x-f5xc-description-short": "Information about a error in API operation.",
3902
4094
  "x-f5xc-minimum-configuration": {
3903
4095
  "description": "Minimum configuration for schemaErrorType",
3904
4096
  "required_fields": [
@@ -3926,6 +4118,7 @@
3926
4118
  "title": "Name",
3927
4119
  "x-displayname": "Name",
3928
4120
  "x-f5xc-example": "example-resource",
4121
+ "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
3929
4122
  "minLength": 0,
3930
4123
  "maxLength": 16,
3931
4124
  "x-f5xc-required-for": {
@@ -3936,9 +4129,10 @@
3936
4129
  },
3937
4130
  "x-original-maxLength": 1024,
3938
4131
  "x-reconciled-from-discovery": true,
3939
- "x-reconciled-at": "2026-01-05T14:38:38.689080+00:00"
4132
+ "x-reconciled-at": "2026-01-07T15:28:58.902195+00:00"
3940
4133
  }
3941
4134
  },
4135
+ "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
3942
4136
  "x-f5xc-minimum-configuration": {
3943
4137
  "description": "Minimum configuration for schemaInitializerType",
3944
4138
  "required_fields": [
@@ -3966,6 +4160,8 @@
3966
4160
  "$ref": "#/components/schemas/schemaInitializerType"
3967
4161
  },
3968
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.",
3969
4165
  "x-f5xc-required-for": {
3970
4166
  "minimum_config": false,
3971
4167
  "create": false,
@@ -3977,6 +4173,7 @@
3977
4173
  "$ref": "#/components/schemas/schemaStatusType"
3978
4174
  }
3979
4175
  },
4176
+ "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
3980
4177
  "x-f5xc-minimum-configuration": {
3981
4178
  "description": "Minimum configuration for schemaInitializersType",
3982
4179
  "required_fields": [
@@ -4016,6 +4213,8 @@
4016
4213
  "ves.io.schema.rules.map.values.string.max_len": "1024",
4017
4214
  "ves.io.schema.rules.map.values.string.min_len": "1"
4018
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.",
4019
4218
  "x-f5xc-required-for": {
4020
4219
  "minimum_config": false,
4021
4220
  "create": false,
@@ -4037,6 +4236,7 @@
4037
4236
  "x-validation-rules": {
4038
4237
  "ves.io.schema.rules.string.max_bytes": "1200"
4039
4238
  },
4239
+ "x-f5xc-description-short": "Human readable description for the object.",
4040
4240
  "minLength": 0,
4041
4241
  "x-f5xc-required-for": {
4042
4242
  "minimum_config": false,
@@ -4046,7 +4246,7 @@
4046
4246
  },
4047
4247
  "x-original-maxLength": 1200,
4048
4248
  "x-reconciled-from-discovery": true,
4049
- "x-reconciled-at": "2026-01-05T14:38:38.689090+00:00"
4249
+ "x-reconciled-at": "2026-01-07T15:28:58.902205+00:00"
4050
4250
  },
4051
4251
  "disable": {
4052
4252
  "type": "boolean",
@@ -4056,6 +4256,7 @@
4056
4256
  "x-displayname": "Disable",
4057
4257
  "x-ves-example": "True",
4058
4258
  "x-f5xc-example": "true",
4259
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
4059
4260
  "x-f5xc-required-for": {
4060
4261
  "minimum_config": false,
4061
4262
  "create": false,
@@ -4070,6 +4271,8 @@
4070
4271
  "x-displayname": "Labels",
4071
4272
  "x-ves-example": "Value",
4072
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.",
4073
4276
  "x-f5xc-required-for": {
4074
4277
  "minimum_config": false,
4075
4278
  "create": false,
@@ -4091,6 +4294,8 @@
4091
4294
  "x-validation-rules": {
4092
4295
  "ves.io.schema.rules.message.required": "true"
4093
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.",
4094
4299
  "minLength": 0,
4095
4300
  "maxLength": 16,
4096
4301
  "x-f5xc-required-for": {
@@ -4101,7 +4306,7 @@
4101
4306
  },
4102
4307
  "x-original-maxLength": 1024,
4103
4308
  "x-reconciled-from-discovery": true,
4104
- "x-reconciled-at": "2026-01-05T14:38:38.689098+00:00"
4309
+ "x-reconciled-at": "2026-01-07T15:28:58.902212+00:00"
4105
4310
  },
4106
4311
  "namespace": {
4107
4312
  "type": "string",
@@ -4110,6 +4315,8 @@
4110
4315
  "x-displayname": "Namespace",
4111
4316
  "x-ves-example": "Staging",
4112
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 \"\".",
4113
4320
  "minLength": 0,
4114
4321
  "maxLength": 6,
4115
4322
  "x-f5xc-required-for": {
@@ -4120,9 +4327,10 @@
4120
4327
  },
4121
4328
  "x-original-maxLength": 1024,
4122
4329
  "x-reconciled-from-discovery": true,
4123
- "x-reconciled-at": "2026-01-05T14:38:38.689103+00:00"
4330
+ "x-reconciled-at": "2026-01-07T15:28:58.902217+00:00"
4124
4331
  }
4125
4332
  },
4333
+ "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
4126
4334
  "x-f5xc-minimum-configuration": {
4127
4335
  "description": "Minimum configuration for schemaObjectGetMetaType",
4128
4336
  "required_fields": [
@@ -4155,6 +4363,7 @@
4155
4363
  "x-displayname": "Code",
4156
4364
  "x-ves-example": "0",
4157
4365
  "x-f5xc-example": "0",
4366
+ "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
4158
4367
  "minimum": 0,
4159
4368
  "maximum": 2147483647,
4160
4369
  "x-f5xc-required-for": {
@@ -4171,6 +4380,8 @@
4171
4380
  "x-displayname": "Reason",
4172
4381
  "x-ves-example": "Value",
4173
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.",
4174
4385
  "minLength": 0,
4175
4386
  "maxLength": 43,
4176
4387
  "x-f5xc-required-for": {
@@ -4181,7 +4392,7 @@
4181
4392
  },
4182
4393
  "x-original-maxLength": 1024,
4183
4394
  "x-reconciled-from-discovery": true,
4184
- "x-reconciled-at": "2026-01-05T14:38:38.689109+00:00"
4395
+ "x-reconciled-at": "2026-01-07T15:28:58.902223+00:00"
4185
4396
  },
4186
4397
  "status": {
4187
4398
  "type": "string",
@@ -4190,6 +4401,7 @@
4190
4401
  "x-displayname": "Status",
4191
4402
  "x-ves-example": "Value",
4192
4403
  "x-f5xc-example": "value",
4404
+ "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
4193
4405
  "minLength": 0,
4194
4406
  "maxLength": 17,
4195
4407
  "x-f5xc-required-for": {
@@ -4200,9 +4412,10 @@
4200
4412
  },
4201
4413
  "x-original-maxLength": 1024,
4202
4414
  "x-reconciled-from-discovery": true,
4203
- "x-reconciled-at": "2026-01-05T14:38:38.689114+00:00"
4415
+ "x-reconciled-at": "2026-01-07T15:28:58.902227+00:00"
4204
4416
  }
4205
4417
  },
4418
+ "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
4206
4419
  "x-f5xc-minimum-configuration": {
4207
4420
  "description": "Minimum configuration for schemaStatusType",
4208
4421
  "required_fields": [
@@ -4230,6 +4443,8 @@
4230
4443
  "title": "Creation_timestamp.",
4231
4444
  "format": "date-time",
4232
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.",
4233
4448
  "minLength": 0,
4234
4449
  "maxLength": 1024,
4235
4450
  "x-f5xc-required-for": {
@@ -4247,6 +4462,7 @@
4247
4462
  "x-displayname": "Creator Class.",
4248
4463
  "x-ves-example": "Prism",
4249
4464
  "x-f5xc-example": "value",
4465
+ "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
4250
4466
  "minLength": 0,
4251
4467
  "maxLength": 1024,
4252
4468
  "x-f5xc-required-for": {
@@ -4264,6 +4480,7 @@
4264
4480
  "x-displayname": "Creator ID.",
4265
4481
  "x-ves-example": "Admin@example-corp.com.",
4266
4482
  "x-f5xc-example": "value",
4483
+ "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
4267
4484
  "minLength": 0,
4268
4485
  "maxLength": 1024,
4269
4486
  "x-f5xc-required-for": {
@@ -4280,6 +4497,8 @@
4280
4497
  "title": "Deletion_timestamp.",
4281
4498
  "format": "date-time",
4282
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...",
4283
4502
  "minLength": 0,
4284
4503
  "maxLength": 1024,
4285
4504
  "x-f5xc-required-for": {
@@ -4299,6 +4518,8 @@
4299
4518
  "x-displayname": "Finalizers.",
4300
4519
  "x-ves-example": "Value",
4301
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.",
4302
4523
  "x-f5xc-required-for": {
4303
4524
  "minimum_config": false,
4304
4525
  "create": false,
@@ -4316,6 +4537,8 @@
4316
4537
  "x-displayname": "Labels",
4317
4538
  "x-ves-example": "'VES.I/O/soft-deleted': 'true'",
4318
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).",
4319
4542
  "x-f5xc-required-for": {
4320
4543
  "minimum_config": false,
4321
4544
  "create": false,
@@ -4329,6 +4552,8 @@
4329
4552
  "title": "Modification_timestamp.",
4330
4553
  "format": "date-time",
4331
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.",
4332
4557
  "minLength": 0,
4333
4558
  "maxLength": 1024,
4334
4559
  "x-f5xc-required-for": {
@@ -4347,6 +4572,8 @@
4347
4572
  "x-displayname": "Object Index.",
4348
4573
  "x-ves-example": "0",
4349
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.",
4350
4577
  "minimum": 0,
4351
4578
  "maximum": 2147483647,
4352
4579
  "x-f5xc-required-for": {
@@ -4367,6 +4594,8 @@
4367
4594
  "x-displayname": "Tenant",
4368
4595
  "x-ves-example": "Example-corp.",
4369
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.",
4370
4599
  "minLength": 0,
4371
4600
  "maxLength": 18,
4372
4601
  "x-f5xc-required-for": {
@@ -4378,7 +4607,7 @@
4378
4607
  "x-field-mutability": "read-only",
4379
4608
  "x-original-maxLength": 1024,
4380
4609
  "x-reconciled-from-discovery": true,
4381
- "x-reconciled-at": "2026-01-05T14:38:38.689134+00:00"
4610
+ "x-reconciled-at": "2026-01-07T15:28:58.902245+00:00"
4382
4611
  },
4383
4612
  "uid": {
4384
4613
  "type": "string",
@@ -4387,6 +4616,8 @@
4387
4616
  "x-displayname": "UID",
4388
4617
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
4389
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.",
4390
4621
  "minLength": 0,
4391
4622
  "maxLength": 36,
4392
4623
  "x-f5xc-required-for": {
@@ -4399,9 +4630,11 @@
4399
4630
  "x-original-maxLength": 1024,
4400
4631
  "format": "uuid",
4401
4632
  "x-reconciled-from-discovery": true,
4402
- "x-reconciled-at": "2026-01-05T14:38:38.689139+00:00"
4633
+ "x-reconciled-at": "2026-01-07T15:28:58.902251+00:00"
4403
4634
  }
4404
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.",
4405
4638
  "x-f5xc-minimum-configuration": {
4406
4639
  "description": "Minimum configuration for schemaSystemObjectGetMetaType",
4407
4640
  "required_fields": [
@@ -4449,7 +4682,7 @@
4449
4682
  },
4450
4683
  "x-original-maxLength": 1024,
4451
4684
  "x-reconciled-from-discovery": true,
4452
- "x-reconciled-at": "2026-01-05T14:38:38.689144+00:00"
4685
+ "x-reconciled-at": "2026-01-07T15:28:58.902256+00:00"
4453
4686
  },
4454
4687
  "name": {
4455
4688
  "type": "string",
@@ -4458,6 +4691,8 @@
4458
4691
  "x-displayname": "Name",
4459
4692
  "x-ves-example": "Contactus-route.",
4460
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.",
4461
4696
  "minLength": 0,
4462
4697
  "maxLength": 16,
4463
4698
  "x-f5xc-required-for": {
@@ -4468,7 +4703,7 @@
4468
4703
  },
4469
4704
  "x-original-maxLength": 1024,
4470
4705
  "x-reconciled-from-discovery": true,
4471
- "x-reconciled-at": "2026-01-05T14:38:38.689149+00:00"
4706
+ "x-reconciled-at": "2026-01-07T15:28:58.902261+00:00"
4472
4707
  },
4473
4708
  "namespace": {
4474
4709
  "type": "string",
@@ -4477,6 +4712,8 @@
4477
4712
  "x-displayname": "Namespace",
4478
4713
  "x-ves-example": "Ns1",
4479
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.",
4480
4717
  "minLength": 0,
4481
4718
  "maxLength": 6,
4482
4719
  "x-f5xc-required-for": {
@@ -4487,7 +4724,7 @@
4487
4724
  },
4488
4725
  "x-original-maxLength": 1024,
4489
4726
  "x-reconciled-from-discovery": true,
4490
- "x-reconciled-at": "2026-01-05T14:38:38.689153+00:00"
4727
+ "x-reconciled-at": "2026-01-07T15:28:58.902265+00:00"
4491
4728
  },
4492
4729
  "uid": {
4493
4730
  "type": "string",
@@ -4508,9 +4745,10 @@
4508
4745
  "x-original-maxLength": 1024,
4509
4746
  "format": "uuid",
4510
4747
  "x-reconciled-from-discovery": true,
4511
- "x-reconciled-at": "2026-01-05T14:38:38.689158+00:00"
4748
+ "x-reconciled-at": "2026-01-07T15:28:58.902270+00:00"
4512
4749
  }
4513
4750
  },
4751
+ "x-f5xc-description-short": "ViewRefType represents a reference to a view.",
4514
4752
  "x-f5xc-minimum-configuration": {
4515
4753
  "description": "Minimum configuration for schemaViewRefType",
4516
4754
  "required_fields": [
@@ -4541,6 +4779,7 @@
4541
4779
  "$ref": "#/components/schemas/ioschemaObjectRefType"
4542
4780
  },
4543
4781
  "x-displayname": "Deleted Referred Objects.",
4782
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
4544
4783
  "x-f5xc-required-for": {
4545
4784
  "minimum_config": false,
4546
4785
  "create": false,
@@ -4556,6 +4795,7 @@
4556
4795
  "$ref": "#/components/schemas/ioschemaObjectRefType"
4557
4796
  },
4558
4797
  "x-displayname": "Disabled Referred Objects.",
4798
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
4559
4799
  "x-f5xc-required-for": {
4560
4800
  "minimum_config": false,
4561
4801
  "create": false,
@@ -4574,6 +4814,7 @@
4574
4814
  "$ref": "#/components/schemas/ioschemaObjectRefType"
4575
4815
  },
4576
4816
  "x-displayname": "Referring Objects.",
4817
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
4577
4818
  "x-f5xc-required-for": {
4578
4819
  "minimum_config": false,
4579
4820
  "create": false,
@@ -4616,6 +4857,8 @@
4616
4857
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
4617
4858
  ],
4618
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...",
4619
4862
  "x-f5xc-minimum-configuration": {
4620
4863
  "description": "Minimum configuration for nginx_instanceGetResponseFormatCode",
4621
4864
  "required_fields": [],
@@ -4640,6 +4883,8 @@
4640
4883
  "type": "string",
4641
4884
  "description": "Dataplane identifier name for instance in NGINX One.",
4642
4885
  "x-displayname": "HostName",
4886
+ "x-f5xc-example": "example-resource",
4887
+ "x-f5xc-description-short": "Dataplane identifier name for instance in NGINX One.",
4643
4888
  "minLength": 0,
4644
4889
  "maxLength": 1024,
4645
4890
  "x-f5xc-required-for": {
@@ -4653,6 +4898,7 @@
4653
4898
  "type": "string",
4654
4899
  "description": "Identifier for individual instance in NGINX One.",
4655
4900
  "x-displayname": "ObjectId",
4901
+ "x-f5xc-description-short": "Identifier for individual instance in NGINX One.",
4656
4902
  "minLength": 0,
4657
4903
  "maxLength": 1024,
4658
4904
  "x-f5xc-required-for": {
@@ -4697,6 +4943,7 @@
4697
4943
  "$ref": "#/components/schemas/schemaErrorType"
4698
4944
  },
4699
4945
  "x-displayname": "Errors",
4946
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
4700
4947
  "x-f5xc-required-for": {
4701
4948
  "minimum_config": false,
4702
4949
  "create": false,
@@ -4712,6 +4959,8 @@
4712
4959
  "$ref": "#/components/schemas/nginx_instanceListResponseItem"
4713
4960
  },
4714
4961
  "x-displayname": "Items",
4962
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
4963
+ "x-f5xc-description-short": "Items represents the collection in response.",
4715
4964
  "x-f5xc-required-for": {
4716
4965
  "minimum_config": false,
4717
4966
  "create": false,
@@ -4745,6 +4994,8 @@
4745
4994
  "description": "The set of annotations present on this nginx_instance.",
4746
4995
  "title": "Annotations.",
4747
4996
  "x-displayname": "Annotations.",
4997
+ "x-f5xc-example": "{\"key\": \"value\"}",
4998
+ "x-f5xc-description-short": "The set of annotations present on this nginx_instance.",
4748
4999
  "x-f5xc-required-for": {
4749
5000
  "minimum_config": false,
4750
5001
  "create": false,
@@ -4757,6 +5008,7 @@
4757
5008
  "description": "The description set for this nginx_instance.",
4758
5009
  "title": "Description.",
4759
5010
  "x-displayname": "Description.",
5011
+ "x-f5xc-description-short": "The description set for this nginx_instance.",
4760
5012
  "minLength": 0,
4761
5013
  "maxLength": 0,
4762
5014
  "x-f5xc-required-for": {
@@ -4767,7 +5019,7 @@
4767
5019
  },
4768
5020
  "x-original-maxLength": 1024,
4769
5021
  "x-reconciled-from-discovery": true,
4770
- "x-reconciled-at": "2026-01-05T14:38:38.981952+00:00"
5022
+ "x-reconciled-at": "2026-01-07T15:28:59.239967+00:00"
4771
5023
  },
4772
5024
  "disabled": {
4773
5025
  "type": "boolean",
@@ -4775,6 +5027,8 @@
4775
5027
  "title": "Disabled",
4776
5028
  "format": "boolean",
4777
5029
  "x-displayname": "Disabled",
5030
+ "x-f5xc-example": "True",
5031
+ "x-f5xc-description-short": "Value of true indicates nginx_instance is administratively disabled.",
4778
5032
  "x-f5xc-required-for": {
4779
5033
  "minimum_config": false,
4780
5034
  "create": false,
@@ -4790,6 +5044,8 @@
4790
5044
  "description": "The set of labels present on this nginx_instance.",
4791
5045
  "title": "Labels",
4792
5046
  "x-displayname": "Labels",
5047
+ "x-f5xc-example": "{\"key\": \"value\"}",
5048
+ "x-f5xc-description-short": "The set of labels present on this nginx_instance.",
4793
5049
  "x-f5xc-required-for": {
4794
5050
  "minimum_config": false,
4795
5051
  "create": false,
@@ -4817,7 +5073,7 @@
4817
5073
  },
4818
5074
  "x-original-maxLength": 1024,
4819
5075
  "x-reconciled-from-discovery": true,
4820
- "x-reconciled-at": "2026-01-05T14:38:38.981964+00:00"
5076
+ "x-reconciled-at": "2026-01-07T15:28:59.239978+00:00"
4821
5077
  },
4822
5078
  "namespace": {
4823
5079
  "type": "string",
@@ -4836,7 +5092,7 @@
4836
5092
  },
4837
5093
  "x-original-maxLength": 1024,
4838
5094
  "x-reconciled-from-discovery": true,
4839
- "x-reconciled-at": "2026-01-05T14:38:38.981968+00:00"
5095
+ "x-reconciled-at": "2026-01-07T15:28:59.239982+00:00"
4840
5096
  },
4841
5097
  "owner_view": {
4842
5098
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -4862,7 +5118,7 @@
4862
5118
  "x-field-mutability": "read-only",
4863
5119
  "x-original-maxLength": 1024,
4864
5120
  "x-reconciled-from-discovery": true,
4865
- "x-reconciled-at": "2026-01-05T14:38:38.981975+00:00"
5121
+ "x-reconciled-at": "2026-01-07T15:28:59.239989+00:00"
4866
5122
  },
4867
5123
  "uid": {
4868
5124
  "type": "string",
@@ -4883,9 +5139,11 @@
4883
5139
  "x-original-maxLength": 1024,
4884
5140
  "format": "uuid",
4885
5141
  "x-reconciled-from-discovery": true,
4886
- "x-reconciled-at": "2026-01-05T14:38:38.981981+00:00"
5142
+ "x-reconciled-at": "2026-01-07T15:28:59.239995+00:00"
4887
5143
  }
4888
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.",
4889
5147
  "x-f5xc-minimum-configuration": {
4890
5148
  "description": "Minimum configuration for nginx_instanceListResponseItem",
4891
5149
  "required_fields": [
@@ -4991,9 +5249,10 @@
4991
5249
  },
4992
5250
  "x-original-maxLength": 1024,
4993
5251
  "x-reconciled-from-discovery": true,
4994
- "x-reconciled-at": "2026-01-05T14:38:39.321480+00:00"
5252
+ "x-reconciled-at": "2026-01-07T15:28:59.634450+00:00"
4995
5253
  }
4996
5254
  },
5255
+ "x-f5xc-description-short": "GET NGINX One Dataplane servers request.",
4997
5256
  "x-f5xc-minimum-configuration": {
4998
5257
  "description": "Minimum configuration for nginx_serverGetDataplaneServersRequest",
4999
5258
  "required_fields": [
@@ -5029,6 +5288,8 @@
5029
5288
  "x-validation-rules": {
5030
5289
  "ves.io.schema.rules.message.required": "true"
5031
5290
  },
5291
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
5292
+ "x-f5xc-description-short": "The NGINX One Servers associated to the dataplane Required: YES.",
5032
5293
  "x-f5xc-required-for": {
5033
5294
  "minimum_config": false,
5034
5295
  "create": false,
@@ -5037,6 +5298,7 @@
5037
5298
  }
5038
5299
  }
5039
5300
  },
5301
+ "x-f5xc-description-short": "GET NGINX One Dataplane servers response.",
5040
5302
  "x-f5xc-minimum-configuration": {
5041
5303
  "description": "Minimum configuration for nginx_serverGetDataplaneServersResponse",
5042
5304
  "required_fields": [
@@ -5064,6 +5326,7 @@
5064
5326
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5065
5327
  },
5066
5328
  "x-displayname": "Deleted Referred Objects.",
5329
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5067
5330
  "x-f5xc-required-for": {
5068
5331
  "minimum_config": false,
5069
5332
  "create": false,
@@ -5079,6 +5342,7 @@
5079
5342
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5080
5343
  },
5081
5344
  "x-displayname": "Disabled Referred Objects.",
5345
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
5082
5346
  "x-f5xc-required-for": {
5083
5347
  "minimum_config": false,
5084
5348
  "create": false,
@@ -5097,6 +5361,7 @@
5097
5361
  "$ref": "#/components/schemas/ioschemaObjectRefType"
5098
5362
  },
5099
5363
  "x-displayname": "Referring Objects.",
5364
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
5100
5365
  "x-f5xc-required-for": {
5101
5366
  "minimum_config": false,
5102
5367
  "create": false,
@@ -5115,6 +5380,8 @@
5115
5380
  "$ref": "#/components/schemas/nginx_serverStatusObject"
5116
5381
  },
5117
5382
  "x-displayname": "Status",
5383
+ "x-f5xc-example": "active",
5384
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5118
5385
  "x-f5xc-required-for": {
5119
5386
  "minimum_config": false,
5120
5387
  "create": false,
@@ -5124,7 +5391,7 @@
5124
5391
  "maxLength": 17,
5125
5392
  "minLength": 17,
5126
5393
  "x-reconciled-from-discovery": true,
5127
- "x-reconciled-at": "2026-01-05T14:38:39.321495+00:00"
5394
+ "x-reconciled-at": "2026-01-07T15:28:59.634465+00:00"
5128
5395
  },
5129
5396
  "system_metadata": {
5130
5397
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -5160,6 +5427,8 @@
5160
5427
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
5161
5428
  ],
5162
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...",
5163
5432
  "x-f5xc-minimum-configuration": {
5164
5433
  "description": "Minimum configuration for nginx_serverGetResponseFormatCode",
5165
5434
  "required_fields": [],
@@ -5185,6 +5454,7 @@
5185
5454
  "$ref": "#/components/schemas/schemaErrorType"
5186
5455
  },
5187
5456
  "x-displayname": "Errors",
5457
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
5188
5458
  "x-f5xc-required-for": {
5189
5459
  "minimum_config": false,
5190
5460
  "create": false,
@@ -5200,6 +5470,8 @@
5200
5470
  "$ref": "#/components/schemas/nginx_serverListResponseItem"
5201
5471
  },
5202
5472
  "x-displayname": "Items",
5473
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
5474
+ "x-f5xc-description-short": "Items represents the collection in response.",
5203
5475
  "x-f5xc-required-for": {
5204
5476
  "minimum_config": false,
5205
5477
  "create": false,
@@ -5233,6 +5505,8 @@
5233
5505
  "description": "The set of annotations present on this nginx_server.",
5234
5506
  "title": "Annotations.",
5235
5507
  "x-displayname": "Annotations.",
5508
+ "x-f5xc-example": "{\"key\": \"value\"}",
5509
+ "x-f5xc-description-short": "The set of annotations present on this nginx_server.",
5236
5510
  "x-f5xc-required-for": {
5237
5511
  "minimum_config": false,
5238
5512
  "create": false,
@@ -5245,6 +5519,7 @@
5245
5519
  "description": "The description set for this nginx_server.",
5246
5520
  "title": "Description.",
5247
5521
  "x-displayname": "Description.",
5522
+ "x-f5xc-description-short": "The description set for this nginx_server.",
5248
5523
  "minLength": 0,
5249
5524
  "maxLength": 0,
5250
5525
  "x-f5xc-required-for": {
@@ -5255,7 +5530,7 @@
5255
5530
  },
5256
5531
  "x-original-maxLength": 1024,
5257
5532
  "x-reconciled-from-discovery": true,
5258
- "x-reconciled-at": "2026-01-05T14:38:39.321507+00:00"
5533
+ "x-reconciled-at": "2026-01-07T15:28:59.634478+00:00"
5259
5534
  },
5260
5535
  "disabled": {
5261
5536
  "type": "boolean",
@@ -5263,6 +5538,8 @@
5263
5538
  "title": "Disabled",
5264
5539
  "format": "boolean",
5265
5540
  "x-displayname": "Disabled",
5541
+ "x-f5xc-example": "True",
5542
+ "x-f5xc-description-short": "Value of true indicates nginx_server is administratively disabled.",
5266
5543
  "x-f5xc-required-for": {
5267
5544
  "minimum_config": false,
5268
5545
  "create": false,
@@ -5278,6 +5555,8 @@
5278
5555
  "description": "The set of labels present on this nginx_server.",
5279
5556
  "title": "Labels",
5280
5557
  "x-displayname": "Labels",
5558
+ "x-f5xc-example": "{\"key\": \"value\"}",
5559
+ "x-f5xc-description-short": "The set of labels present on this nginx_server.",
5281
5560
  "x-f5xc-required-for": {
5282
5561
  "minimum_config": false,
5283
5562
  "create": false,
@@ -5305,7 +5584,7 @@
5305
5584
  },
5306
5585
  "x-original-maxLength": 1024,
5307
5586
  "x-reconciled-from-discovery": true,
5308
- "x-reconciled-at": "2026-01-05T14:38:39.321518+00:00"
5587
+ "x-reconciled-at": "2026-01-07T15:28:59.634488+00:00"
5309
5588
  },
5310
5589
  "namespace": {
5311
5590
  "type": "string",
@@ -5324,7 +5603,7 @@
5324
5603
  },
5325
5604
  "x-original-maxLength": 1024,
5326
5605
  "x-reconciled-from-discovery": true,
5327
- "x-reconciled-at": "2026-01-05T14:38:39.321522+00:00"
5606
+ "x-reconciled-at": "2026-01-07T15:28:59.634492+00:00"
5328
5607
  },
5329
5608
  "owner_view": {
5330
5609
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -5337,6 +5616,7 @@
5337
5616
  "$ref": "#/components/schemas/nginx_serverStatusObject"
5338
5617
  },
5339
5618
  "x-displayname": "Status",
5619
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
5340
5620
  "x-f5xc-required-for": {
5341
5621
  "minimum_config": false,
5342
5622
  "create": false,
@@ -5365,7 +5645,7 @@
5365
5645
  "x-field-mutability": "read-only",
5366
5646
  "x-original-maxLength": 1024,
5367
5647
  "x-reconciled-from-discovery": true,
5368
- "x-reconciled-at": "2026-01-05T14:38:39.321530+00:00"
5648
+ "x-reconciled-at": "2026-01-07T15:28:59.634500+00:00"
5369
5649
  },
5370
5650
  "uid": {
5371
5651
  "type": "string",
@@ -5386,9 +5666,11 @@
5386
5666
  "x-original-maxLength": 1024,
5387
5667
  "format": "uuid",
5388
5668
  "x-reconciled-from-discovery": true,
5389
- "x-reconciled-at": "2026-01-05T14:38:39.321536+00:00"
5669
+ "x-reconciled-at": "2026-01-07T15:28:59.634518+00:00"
5390
5670
  }
5391
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.",
5392
5674
  "x-f5xc-minimum-configuration": {
5393
5675
  "description": "Minimum configuration for nginx_serverListResponseItem",
5394
5676
  "required_fields": [
@@ -5435,6 +5717,8 @@
5435
5717
  "x-validation-rules": {
5436
5718
  "ves.io.schema.rules.message.required": "true"
5437
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.",
5438
5722
  "x-f5xc-required-for": {
5439
5723
  "minimum_config": false,
5440
5724
  "create": false,
@@ -5457,6 +5741,7 @@
5457
5741
  "x-validation-rules": {
5458
5742
  "ves.io.schema.rules.repeated.max_items": "1000"
5459
5743
  },
5744
+ "x-f5xc-description-short": "Configuration of the set of locations corresponding to this server.",
5460
5745
  "x-f5xc-required-for": {
5461
5746
  "minimum_config": false,
5462
5747
  "create": false,
@@ -5469,6 +5754,7 @@
5469
5754
  "description": "Signifies the uniqueness identifier for NGINX One representation of\nthis NGINX server.",
5470
5755
  "title": "Nginx_one_object_id.",
5471
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.",
5472
5758
  "minLength": 0,
5473
5759
  "maxLength": 1024,
5474
5760
  "x-f5xc-required-for": {
@@ -5484,6 +5770,8 @@
5484
5770
  "description": "Hostname value set for Instance or Name for a Config Sync Group\nin NGINX One.",
5485
5771
  "title": "Nginx_one_object_name.",
5486
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.",
5487
5775
  "minLength": 0,
5488
5776
  "maxLength": 1024,
5489
5777
  "x-f5xc-required-for": {
@@ -5508,6 +5796,7 @@
5508
5796
  "ves.io.schema.rules.uint32.lte": "65535"
5509
5797
  },
5510
5798
  "x-f5xc-example": "8080",
5799
+ "x-f5xc-description-short": "Signifies the port configured for the NGINX server.",
5511
5800
  "minimum": 1,
5512
5801
  "maximum": 65535,
5513
5802
  "x-f5xc-required-for": {
@@ -5522,6 +5811,9 @@
5522
5811
  "description": "Signifies the combination of first element in domains array and the port\nconfigured for the NGINX server.",
5523
5812
  "title": "Server_name.",
5524
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.",
5525
5817
  "minLength": 0,
5526
5818
  "maxLength": 1024,
5527
5819
  "x-f5xc-required-for": {
@@ -5537,6 +5829,7 @@
5537
5829
  "title": "Total locations configured in the NGINX Server.",
5538
5830
  "format": "int64",
5539
5831
  "x-displayname": "Routes",
5832
+ "x-f5xc-description-short": "Total locations configured in the NGINX Server.",
5540
5833
  "minimum": 0,
5541
5834
  "maximum": 2147483647,
5542
5835
  "x-f5xc-required-for": {
@@ -5585,6 +5878,7 @@
5585
5878
  "$ref": "#/components/schemas/schemaConditionType"
5586
5879
  },
5587
5880
  "x-displayname": "Conditions.",
5881
+ "x-f5xc-description-short": "Conditions represent the normalized status values for configuration object.",
5588
5882
  "x-f5xc-required-for": {
5589
5883
  "minimum_config": false,
5590
5884
  "create": false,
@@ -5611,6 +5905,7 @@
5611
5905
  }
5612
5906
  }
5613
5907
  },
5908
+ "x-f5xc-description-short": "Most recently observed status of object.",
5614
5909
  "x-f5xc-minimum-configuration": {
5615
5910
  "description": "Minimum configuration for nginx_serverStatusObject",
5616
5911
  "required_fields": [
@@ -5673,6 +5968,8 @@
5673
5968
  "x-validation-rules": {
5674
5969
  "ves.io.schema.rules.message.required": "true"
5675
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.",
5676
5973
  "minLength": 0,
5677
5974
  "maxLength": 1024,
5678
5975
  "x-f5xc-required-for": {
@@ -5696,6 +5993,7 @@
5696
5993
  "x-validation-rules": {
5697
5994
  "ves.io.schema.rules.message.required": "true"
5698
5995
  },
5996
+ "x-f5xc-description-short": "Uniqueness identifier for a location definition Required: YES.",
5699
5997
  "minLength": 0,
5700
5998
  "maxLength": 16,
5701
5999
  "x-f5xc-required-for": {
@@ -5706,7 +6004,7 @@
5706
6004
  },
5707
6005
  "x-original-maxLength": 1024,
5708
6006
  "x-reconciled-from-discovery": true,
5709
- "x-reconciled-at": "2026-01-05T14:38:39.321566+00:00"
6007
+ "x-reconciled-at": "2026-01-07T15:28:59.634547+00:00"
5710
6008
  },
5711
6009
  "waf_spec": {
5712
6010
  "$ref": "#/components/schemas/nginx_instanceWAFSpec"
@@ -5739,6 +6037,8 @@
5739
6037
  "description": "Hostname of the instance of the site that sent the status.",
5740
6038
  "title": "Hostname",
5741
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.",
5742
6042
  "minLength": 0,
5743
6043
  "maxLength": 1024,
5744
6044
  "x-f5xc-required-for": {
@@ -5770,6 +6070,8 @@
5770
6070
  "x-displayname": "Reason",
5771
6071
  "x-ves-example": "Value",
5772
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.",
5773
6075
  "minLength": 0,
5774
6076
  "maxLength": 43,
5775
6077
  "x-f5xc-required-for": {
@@ -5780,13 +6082,15 @@
5780
6082
  },
5781
6083
  "x-original-maxLength": 1024,
5782
6084
  "x-reconciled-from-discovery": true,
5783
- "x-reconciled-at": "2026-01-05T14:38:39.321582+00:00"
6085
+ "x-reconciled-at": "2026-01-07T15:28:59.634562+00:00"
5784
6086
  },
5785
6087
  "service_name": {
5786
6088
  "type": "string",
5787
6089
  "description": "Name of the service that sent the status.",
5788
6090
  "title": "Service name.",
5789
6091
  "x-displayname": "Service Name.",
6092
+ "x-f5xc-example": "example-resource",
6093
+ "x-f5xc-description-short": "Name of the service that sent the status.",
5790
6094
  "minLength": 0,
5791
6095
  "maxLength": 1024,
5792
6096
  "x-f5xc-required-for": {
@@ -5809,6 +6113,8 @@
5809
6113
  "x-validation-rules": {
5810
6114
  "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
5811
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...",
5812
6118
  "minLength": 0,
5813
6119
  "maxLength": 17,
5814
6120
  "x-f5xc-required-for": {
@@ -5819,7 +6125,7 @@
5819
6125
  },
5820
6126
  "x-original-maxLength": 1024,
5821
6127
  "x-reconciled-from-discovery": true,
5822
- "x-reconciled-at": "2026-01-05T14:38:39.321588+00:00"
6128
+ "x-reconciled-at": "2026-01-07T15:28:59.634569+00:00"
5823
6129
  },
5824
6130
  "type": {
5825
6131
  "type": "string",
@@ -5834,6 +6140,8 @@
5834
6140
  "x-validation-rules": {
5835
6141
  "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
5836
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.",
5837
6145
  "minLength": 0,
5838
6146
  "maxLength": 1024,
5839
6147
  "x-f5xc-required-for": {
@@ -5844,6 +6152,8 @@
5844
6152
  }
5845
6153
  }
5846
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.",
5847
6157
  "x-f5xc-minimum-configuration": {
5848
6158
  "description": "Minimum configuration for schemaConditionType",
5849
6159
  "required_fields": [
@@ -5874,6 +6184,8 @@
5874
6184
  "title": "Creation_timestamp.",
5875
6185
  "format": "date-time",
5876
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.",
5877
6189
  "minLength": 0,
5878
6190
  "maxLength": 1024,
5879
6191
  "x-f5xc-required-for": {
@@ -5891,6 +6203,8 @@
5891
6203
  "x-displayname": "Creator Class.",
5892
6204
  "x-ves-example": "ver.re1.int.ves.I/O.",
5893
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.",
5894
6208
  "minLength": 0,
5895
6209
  "maxLength": 1024,
5896
6210
  "x-f5xc-required-for": {
@@ -5908,6 +6222,8 @@
5908
6222
  "x-displayname": "Creator ID.",
5909
6223
  "x-ves-example": "Ver-instance-1.",
5910
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.",
5911
6227
  "minLength": 0,
5912
6228
  "maxLength": 1024,
5913
6229
  "x-f5xc-required-for": {
@@ -5926,6 +6242,8 @@
5926
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)",
5927
6243
  "title": "Status_id",
5928
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).",
5929
6247
  "minLength": 0,
5930
6248
  "maxLength": 1024,
5931
6249
  "x-f5xc-required-for": {
@@ -5943,6 +6261,7 @@
5943
6261
  "x-displayname": "UID",
5944
6262
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
5945
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.",
5946
6265
  "minLength": 0,
5947
6266
  "maxLength": 36,
5948
6267
  "x-f5xc-required-for": {
@@ -5955,13 +6274,14 @@
5955
6274
  "x-original-maxLength": 1024,
5956
6275
  "format": "uuid",
5957
6276
  "x-reconciled-from-discovery": true,
5958
- "x-reconciled-at": "2026-01-05T14:38:39.321636+00:00"
6277
+ "x-reconciled-at": "2026-01-07T15:28:59.634615+00:00"
5959
6278
  },
5960
6279
  "vtrp_id": {
5961
6280
  "type": "string",
5962
6281
  "description": "Origin of this status exchanged by VTRP.",
5963
6282
  "title": "Vtrp_id",
5964
6283
  "x-displayname": "VTRP ID",
6284
+ "x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
5965
6285
  "minLength": 0,
5966
6286
  "maxLength": 1024,
5967
6287
  "x-f5xc-required-for": {
@@ -5978,6 +6298,7 @@
5978
6298
  "title": "Vtrp_stale.",
5979
6299
  "format": "boolean",
5980
6300
  "x-displayname": "VTRP Stale.",
6301
+ "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
5981
6302
  "x-f5xc-required-for": {
5982
6303
  "minimum_config": false,
5983
6304
  "create": false,
@@ -5986,6 +6307,7 @@
5986
6307
  }
5987
6308
  }
5988
6309
  },
6310
+ "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
5989
6311
  "x-f5xc-minimum-configuration": {
5990
6312
  "description": "Minimum configuration for schemaStatusMetaType",
5991
6313
  "required_fields": [
@@ -6016,6 +6338,8 @@
6016
6338
  "default": "STATUS_DO_NOT_PUBLISH",
6017
6339
  "x-displayname": "Status Publish Type.",
6018
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.",
6019
6343
  "x-f5xc-minimum-configuration": {
6020
6344
  "description": "Minimum configuration for schemaStatusPublishType",
6021
6345
  "required_fields": [],
@@ -6053,6 +6377,8 @@
6053
6377
  "ves.io.schema.rules.string.max_bytes": "128",
6054
6378
  "ves.io.schema.rules.string.min_bytes": "1"
6055
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.",
6056
6382
  "x-f5xc-required-for": {
6057
6383
  "minimum_config": false,
6058
6384
  "create": false,
@@ -6061,7 +6387,7 @@
6061
6387
  },
6062
6388
  "x-original-maxLength": 128,
6063
6389
  "x-reconciled-from-discovery": true,
6064
- "x-reconciled-at": "2026-01-05T14:38:39.321699+00:00"
6390
+ "x-reconciled-at": "2026-01-07T15:28:59.634676+00:00"
6065
6391
  },
6066
6392
  "namespace": {
6067
6393
  "type": "string",
@@ -6077,6 +6403,8 @@
6077
6403
  "x-validation-rules": {
6078
6404
  "ves.io.schema.rules.string.max_bytes": "64"
6079
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.",
6080
6408
  "minLength": 0,
6081
6409
  "x-f5xc-required-for": {
6082
6410
  "minimum_config": false,
@@ -6086,7 +6414,7 @@
6086
6414
  },
6087
6415
  "x-original-maxLength": 64,
6088
6416
  "x-reconciled-from-discovery": true,
6089
- "x-reconciled-at": "2026-01-05T14:38:39.321704+00:00"
6417
+ "x-reconciled-at": "2026-01-07T15:28:59.634681+00:00"
6090
6418
  },
6091
6419
  "tenant": {
6092
6420
  "type": "string",
@@ -6102,6 +6430,8 @@
6102
6430
  "x-validation-rules": {
6103
6431
  "ves.io.schema.rules.string.max_bytes": "64"
6104
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.",
6105
6435
  "minLength": 0,
6106
6436
  "x-f5xc-required-for": {
6107
6437
  "minimum_config": false,
@@ -6113,9 +6443,11 @@
6113
6443
  "x-field-mutability": "read-only",
6114
6444
  "x-original-maxLength": 64,
6115
6445
  "x-reconciled-from-discovery": true,
6116
- "x-reconciled-at": "2026-01-05T14:38:39.321708+00:00"
6446
+ "x-reconciled-at": "2026-01-07T15:28:59.634685+00:00"
6117
6447
  }
6118
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.",
6119
6451
  "x-f5xc-minimum-configuration": {
6120
6452
  "description": "Minimum configuration for schemaviewsObjectRefType",
6121
6453
  "required_fields": [
@@ -6219,6 +6551,7 @@
6219
6551
  "ves.io.schema.rules.message.required": "true",
6220
6552
  "ves.io.schema.rules.repeated.max_items": "1"
6221
6553
  },
6554
+ "x-f5xc-description-short": "Select new ConfigSyncGroup Required: YES.",
6222
6555
  "x-f5xc-required-for": {
6223
6556
  "minimum_config": false,
6224
6557
  "create": false,
@@ -6321,6 +6654,9 @@
6321
6654
  "ves.io.schema.rules.repeated.max_items": "10",
6322
6655
  "ves.io.schema.rules.repeated.unique": "true"
6323
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.",
6324
6660
  "x-f5xc-required-for": {
6325
6661
  "minimum_config": false,
6326
6662
  "create": false,
@@ -6329,6 +6665,7 @@
6329
6665
  }
6330
6666
  }
6331
6667
  },
6668
+ "x-f5xc-description-short": "API to create NGINX Service Discovery object for a site or virtual site in system namespace.",
6332
6669
  "x-f5xc-minimum-configuration": {
6333
6670
  "description": "Minimum configuration for nginx_service_discoveryCreateSpecType",
6334
6671
  "required_fields": [
@@ -6355,6 +6692,7 @@
6355
6692
  "title": "Fail_if_referred.",
6356
6693
  "format": "boolean",
6357
6694
  "x-displayname": "Fail-If-Referred.",
6695
+ "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
6358
6696
  "x-f5xc-required-for": {
6359
6697
  "minimum_config": false,
6360
6698
  "create": false,
@@ -6379,7 +6717,7 @@
6379
6717
  },
6380
6718
  "x-original-maxLength": 1024,
6381
6719
  "x-reconciled-from-discovery": true,
6382
- "x-reconciled-at": "2026-01-05T14:38:39.891692+00:00"
6720
+ "x-reconciled-at": "2026-01-07T15:29:00.300426+00:00"
6383
6721
  },
6384
6722
  "namespace": {
6385
6723
  "type": "string",
@@ -6388,6 +6726,7 @@
6388
6726
  "x-displayname": "Namespace",
6389
6727
  "x-ves-example": "Ns1",
6390
6728
  "x-f5xc-example": "ns1",
6729
+ "x-f5xc-description-short": "Namespace in which the configuration object is present.",
6391
6730
  "minLength": 0,
6392
6731
  "maxLength": 6,
6393
6732
  "x-f5xc-required-for": {
@@ -6398,7 +6737,7 @@
6398
6737
  },
6399
6738
  "x-original-maxLength": 1024,
6400
6739
  "x-reconciled-from-discovery": true,
6401
- "x-reconciled-at": "2026-01-05T14:38:39.891699+00:00"
6740
+ "x-reconciled-at": "2026-01-07T15:29:00.300433+00:00"
6402
6741
  }
6403
6742
  },
6404
6743
  "x-f5xc-minimum-configuration": {
@@ -6460,6 +6799,7 @@
6460
6799
  "$ref": "#/components/schemas/schemaObjectRefType"
6461
6800
  },
6462
6801
  "x-displayname": "Deleted Referred Objects.",
6802
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6463
6803
  "x-f5xc-required-for": {
6464
6804
  "minimum_config": false,
6465
6805
  "create": false,
@@ -6475,6 +6815,7 @@
6475
6815
  "$ref": "#/components/schemas/schemaObjectRefType"
6476
6816
  },
6477
6817
  "x-displayname": "Disabled Referred Objects.",
6818
+ "x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
6478
6819
  "x-f5xc-required-for": {
6479
6820
  "minimum_config": false,
6480
6821
  "create": false,
@@ -6493,6 +6834,7 @@
6493
6834
  "$ref": "#/components/schemas/schemaObjectRefType"
6494
6835
  },
6495
6836
  "x-displayname": "Referring Objects.",
6837
+ "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
6496
6838
  "x-f5xc-required-for": {
6497
6839
  "minimum_config": false,
6498
6840
  "create": false,
@@ -6514,6 +6856,8 @@
6514
6856
  "$ref": "#/components/schemas/nginx_service_discoveryStatusObject"
6515
6857
  },
6516
6858
  "x-displayname": "Status",
6859
+ "x-f5xc-example": "active",
6860
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6517
6861
  "x-f5xc-required-for": {
6518
6862
  "minimum_config": false,
6519
6863
  "create": false,
@@ -6523,7 +6867,7 @@
6523
6867
  "maxLength": 17,
6524
6868
  "minLength": 17,
6525
6869
  "x-reconciled-from-discovery": true,
6526
- "x-reconciled-at": "2026-01-05T14:38:39.891719+00:00"
6870
+ "x-reconciled-at": "2026-01-07T15:29:00.300452+00:00"
6527
6871
  },
6528
6872
  "system_metadata": {
6529
6873
  "$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
@@ -6563,6 +6907,8 @@
6563
6907
  "GET_RSP_FORMAT_BROKEN_REFERENCES"
6564
6908
  ],
6565
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...",
6566
6912
  "x-f5xc-minimum-configuration": {
6567
6913
  "description": "Minimum configuration for nginx_service_discoveryGetResponseFormatCode",
6568
6914
  "required_fields": [],
@@ -6586,6 +6932,7 @@
6586
6932
  "nginx_one_object_id": {
6587
6933
  "type": "string",
6588
6934
  "x-displayname": "Instance or Config Sync Group Object ID.",
6935
+ "description": "Unique identifier for this resource",
6589
6936
  "minLength": 0,
6590
6937
  "maxLength": 1024,
6591
6938
  "x-f5xc-required-for": {
@@ -6600,6 +6947,8 @@
6600
6947
  "type": "string",
6601
6948
  "description": "Hostname value set for Instance or Name for a Config Sync Group\nin NGINX One.",
6602
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.",
6603
6952
  "minLength": 0,
6604
6953
  "maxLength": 1024,
6605
6954
  "x-f5xc-required-for": {
@@ -6625,6 +6974,9 @@
6625
6974
  "ves.io.schema.rules.repeated.max_items": "10",
6626
6975
  "ves.io.schema.rules.repeated.unique": "true"
6627
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.",
6628
6980
  "x-f5xc-required-for": {
6629
6981
  "minimum_config": false,
6630
6982
  "create": false,
@@ -6633,6 +6985,7 @@
6633
6985
  }
6634
6986
  }
6635
6987
  },
6988
+ "x-f5xc-description-short": "API to GET NGINX Service Discovery object for a site or virtual site in system namespace.",
6636
6989
  "x-f5xc-minimum-configuration": {
6637
6990
  "description": "Minimum configuration for nginx_service_discoveryGetSpecType",
6638
6991
  "required_fields": [
@@ -6663,6 +7016,7 @@
6663
7016
  "$ref": "#/components/schemas/schemaErrorType"
6664
7017
  },
6665
7018
  "x-displayname": "Errors",
7019
+ "x-f5xc-description-short": "Errors(if any) while listing items from collection.",
6666
7020
  "x-f5xc-required-for": {
6667
7021
  "minimum_config": false,
6668
7022
  "create": false,
@@ -6678,6 +7032,8 @@
6678
7032
  "$ref": "#/components/schemas/nginx_service_discoveryListResponseItem"
6679
7033
  },
6680
7034
  "x-displayname": "Items",
7035
+ "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
7036
+ "x-f5xc-description-short": "Items represents the collection in response.",
6681
7037
  "x-f5xc-required-for": {
6682
7038
  "minimum_config": false,
6683
7039
  "create": false,
@@ -6711,6 +7067,8 @@
6711
7067
  "description": "The set of annotations present on this nginx_service_discovery.",
6712
7068
  "title": "Annotations.",
6713
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.",
6714
7072
  "x-f5xc-required-for": {
6715
7073
  "minimum_config": false,
6716
7074
  "create": false,
@@ -6723,6 +7081,7 @@
6723
7081
  "description": "The description set for this nginx_service_discovery.",
6724
7082
  "title": "Description.",
6725
7083
  "x-displayname": "Description.",
7084
+ "x-f5xc-description-short": "The description set for this nginx_service_discovery.",
6726
7085
  "minLength": 0,
6727
7086
  "maxLength": 0,
6728
7087
  "x-f5xc-required-for": {
@@ -6733,7 +7092,7 @@
6733
7092
  },
6734
7093
  "x-original-maxLength": 1024,
6735
7094
  "x-reconciled-from-discovery": true,
6736
- "x-reconciled-at": "2026-01-05T14:38:39.891738+00:00"
7095
+ "x-reconciled-at": "2026-01-07T15:29:00.300472+00:00"
6737
7096
  },
6738
7097
  "disabled": {
6739
7098
  "type": "boolean",
@@ -6741,6 +7100,8 @@
6741
7100
  "title": "Disabled",
6742
7101
  "format": "boolean",
6743
7102
  "x-displayname": "Disabled",
7103
+ "x-f5xc-example": "True",
7104
+ "x-f5xc-description-short": "Value of true indicates nginx_service_discovery is administratively disabled.",
6744
7105
  "x-f5xc-required-for": {
6745
7106
  "minimum_config": false,
6746
7107
  "create": false,
@@ -6756,6 +7117,8 @@
6756
7117
  "description": "The set of labels present on this nginx_service_discovery.",
6757
7118
  "title": "Labels",
6758
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.",
6759
7122
  "x-f5xc-required-for": {
6760
7123
  "minimum_config": false,
6761
7124
  "create": false,
@@ -6773,6 +7136,7 @@
6773
7136
  "x-displayname": "Name",
6774
7137
  "x-ves-example": "Name",
6775
7138
  "x-f5xc-example": "name",
7139
+ "x-f5xc-description-short": "The name of this nginx_service_discovery.",
6776
7140
  "minLength": 0,
6777
7141
  "maxLength": 16,
6778
7142
  "x-f5xc-required-for": {
@@ -6783,7 +7147,7 @@
6783
7147
  },
6784
7148
  "x-original-maxLength": 1024,
6785
7149
  "x-reconciled-from-discovery": true,
6786
- "x-reconciled-at": "2026-01-05T14:38:39.891749+00:00"
7150
+ "x-reconciled-at": "2026-01-07T15:29:00.300482+00:00"
6787
7151
  },
6788
7152
  "namespace": {
6789
7153
  "type": "string",
@@ -6802,7 +7166,7 @@
6802
7166
  },
6803
7167
  "x-original-maxLength": 1024,
6804
7168
  "x-reconciled-from-discovery": true,
6805
- "x-reconciled-at": "2026-01-05T14:38:39.891753+00:00"
7169
+ "x-reconciled-at": "2026-01-07T15:29:00.300486+00:00"
6806
7170
  },
6807
7171
  "owner_view": {
6808
7172
  "$ref": "#/components/schemas/schemaViewRefType"
@@ -6815,6 +7179,7 @@
6815
7179
  "$ref": "#/components/schemas/nginx_service_discoveryStatusObject"
6816
7180
  },
6817
7181
  "x-displayname": "Status",
7182
+ "x-f5xc-description-short": "The status reported by different services for this configuration object.",
6818
7183
  "x-f5xc-required-for": {
6819
7184
  "minimum_config": false,
6820
7185
  "create": false,
@@ -6843,7 +7208,7 @@
6843
7208
  "x-field-mutability": "read-only",
6844
7209
  "x-original-maxLength": 1024,
6845
7210
  "x-reconciled-from-discovery": true,
6846
- "x-reconciled-at": "2026-01-05T14:38:39.891773+00:00"
7211
+ "x-reconciled-at": "2026-01-07T15:29:00.300494+00:00"
6847
7212
  },
6848
7213
  "uid": {
6849
7214
  "type": "string",
@@ -6852,6 +7217,7 @@
6852
7217
  "x-displayname": "UID",
6853
7218
  "x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
6854
7219
  "x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
7220
+ "x-f5xc-description-short": "The unique uid of this nginx_service_discovery.",
6855
7221
  "minLength": 0,
6856
7222
  "maxLength": 36,
6857
7223
  "x-f5xc-required-for": {
@@ -6864,9 +7230,11 @@
6864
7230
  "x-original-maxLength": 1024,
6865
7231
  "format": "uuid",
6866
7232
  "x-reconciled-from-discovery": true,
6867
- "x-reconciled-at": "2026-01-05T14:38:39.891780+00:00"
7233
+ "x-reconciled-at": "2026-01-07T15:29:00.300500+00:00"
6868
7234
  }
6869
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.",
6870
7238
  "x-f5xc-minimum-configuration": {
6871
7239
  "description": "Minimum configuration for nginx_service_discoveryListResponseItem",
6872
7240
  "required_fields": [
@@ -6916,6 +7284,7 @@
6916
7284
  "ves.io.schema.rules.message.required": "true",
6917
7285
  "ves.io.schema.rules.repeated.max_items": "1"
6918
7286
  },
7287
+ "x-f5xc-description-short": "Select new NGINX Instance Required: YES.",
6919
7288
  "x-f5xc-required-for": {
6920
7289
  "minimum_config": false,
6921
7290
  "create": false,
@@ -7003,6 +7372,9 @@
7003
7372
  "ves.io.schema.rules.repeated.max_items": "10",
7004
7373
  "ves.io.schema.rules.repeated.unique": "true"
7005
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.",
7006
7378
  "x-f5xc-required-for": {
7007
7379
  "minimum_config": false,
7008
7380
  "create": false,
@@ -7011,6 +7383,7 @@
7011
7383
  }
7012
7384
  }
7013
7385
  },
7386
+ "x-f5xc-description-short": "API to replace NGINX Service Discovery object for a site or virtual site in system namespace.",
7014
7387
  "x-f5xc-minimum-configuration": {
7015
7388
  "description": "Minimum configuration for nginx_service_discoveryReplaceSpecType",
7016
7389
  "required_fields": [
@@ -7044,6 +7417,8 @@
7044
7417
  "ves.io.schema.rules.string.max_len": "256",
7045
7418
  "ves.io.schema.rules.string.regex": "true"
7046
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.",
7047
7422
  "minLength": 0,
7048
7423
  "x-f5xc-required-for": {
7049
7424
  "minimum_config": false,
@@ -7072,6 +7447,8 @@
7072
7447
  "ves.io.schema.rules.string.port_range_list": "true",
7073
7448
  "ves.io.schema.rules.string.unique_port_range_list": "true"
7074
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.",
7075
7452
  "minLength": 0,
7076
7453
  "x-f5xc-required-for": {
7077
7454
  "minimum_config": false,
@@ -7135,6 +7512,7 @@
7135
7512
  }
7136
7513
  }
7137
7514
  },
7515
+ "x-f5xc-description-short": "Most recently observed status of object.",
7138
7516
  "x-f5xc-minimum-configuration": {
7139
7517
  "description": "Minimum configuration for nginx_service_discoveryStatusObject",
7140
7518
  "required_fields": [
@@ -7174,6 +7552,8 @@
7174
7552
  "ves.io.schema.rules.map.values.string.max_len": "1024",
7175
7553
  "ves.io.schema.rules.map.values.string.min_len": "1"
7176
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.",
7177
7557
  "x-f5xc-required-for": {
7178
7558
  "minimum_config": false,
7179
7559
  "create": false,
@@ -7195,6 +7575,7 @@
7195
7575
  "x-validation-rules": {
7196
7576
  "ves.io.schema.rules.string.max_bytes": "1200"
7197
7577
  },
7578
+ "x-f5xc-description-short": "Human readable description for the object.",
7198
7579
  "minLength": 0,
7199
7580
  "x-f5xc-required-for": {
7200
7581
  "minimum_config": false,
@@ -7204,7 +7585,7 @@
7204
7585
  },
7205
7586
  "x-original-maxLength": 1200,
7206
7587
  "x-reconciled-from-discovery": true,
7207
- "x-reconciled-at": "2026-01-05T14:38:39.891841+00:00"
7588
+ "x-reconciled-at": "2026-01-07T15:29:00.300587+00:00"
7208
7589
  },
7209
7590
  "disable": {
7210
7591
  "type": "boolean",
@@ -7213,6 +7594,7 @@
7213
7594
  "format": "boolean",
7214
7595
  "x-displayname": "Disable",
7215
7596
  "x-f5xc-example": "true",
7597
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
7216
7598
  "x-f5xc-required-for": {
7217
7599
  "minimum_config": false,
7218
7600
  "create": false,
@@ -7226,6 +7608,8 @@
7226
7608
  "title": "Labels",
7227
7609
  "x-displayname": "Labels",
7228
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.",
7229
7613
  "x-f5xc-required-for": {
7230
7614
  "minimum_config": false,
7231
7615
  "create": false,
@@ -7247,6 +7631,8 @@
7247
7631
  "x-validation-rules": {
7248
7632
  "ves.io.schema.rules.message.required": "true"
7249
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.",
7250
7636
  "minLength": 0,
7251
7637
  "maxLength": 16,
7252
7638
  "x-f5xc-required-for": {
@@ -7257,7 +7643,7 @@
7257
7643
  },
7258
7644
  "x-original-maxLength": 1024,
7259
7645
  "x-reconciled-from-discovery": true,
7260
- "x-reconciled-at": "2026-01-05T14:38:39.891849+00:00"
7646
+ "x-reconciled-at": "2026-01-07T15:29:00.300594+00:00"
7261
7647
  },
7262
7648
  "namespace": {
7263
7649
  "type": "string",
@@ -7266,6 +7652,8 @@
7266
7652
  "x-displayname": "Namespace",
7267
7653
  "x-ves-example": "Staging",
7268
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 \"\".",
7269
7657
  "minLength": 0,
7270
7658
  "maxLength": 6,
7271
7659
  "x-f5xc-required-for": {
@@ -7276,9 +7664,10 @@
7276
7664
  },
7277
7665
  "x-original-maxLength": 1024,
7278
7666
  "x-reconciled-from-discovery": true,
7279
- "x-reconciled-at": "2026-01-05T14:38:39.891853+00:00"
7667
+ "x-reconciled-at": "2026-01-07T15:29:00.300598+00:00"
7280
7668
  }
7281
7669
  },
7670
+ "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
7282
7671
  "x-f5xc-minimum-configuration": {
7283
7672
  "description": "Minimum configuration for schemaObjectCreateMetaType",
7284
7673
  "required_fields": [
@@ -7310,6 +7699,8 @@
7310
7699
  "x-displayname": "Kind",
7311
7700
  "x-ves-example": "Virtual_site.",
7312
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\").",
7313
7704
  "minLength": 0,
7314
7705
  "maxLength": 14,
7315
7706
  "x-f5xc-required-for": {
@@ -7321,7 +7712,7 @@
7321
7712
  "readOnly": true,
7322
7713
  "x-original-maxLength": 1024,
7323
7714
  "x-reconciled-from-discovery": true,
7324
- "x-reconciled-at": "2026-01-05T14:38:39.891876+00:00"
7715
+ "x-reconciled-at": "2026-01-07T15:29:00.300620+00:00"
7325
7716
  },
7326
7717
  "name": {
7327
7718
  "type": "string",
@@ -7330,6 +7721,8 @@
7330
7721
  "x-displayname": "Name",
7331
7722
  "x-ves-example": "Contactus-route.",
7332
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.",
7333
7726
  "minLength": 0,
7334
7727
  "maxLength": 16,
7335
7728
  "x-f5xc-required-for": {
@@ -7340,7 +7733,7 @@
7340
7733
  },
7341
7734
  "x-original-maxLength": 1024,
7342
7735
  "x-reconciled-from-discovery": true,
7343
- "x-reconciled-at": "2026-01-05T14:38:39.891880+00:00"
7736
+ "x-reconciled-at": "2026-01-07T15:29:00.300624+00:00"
7344
7737
  },
7345
7738
  "namespace": {
7346
7739
  "type": "string",
@@ -7349,6 +7742,8 @@
7349
7742
  "x-displayname": "Namespace",
7350
7743
  "x-ves-example": "Ns1",
7351
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.",
7352
7747
  "minLength": 0,
7353
7748
  "maxLength": 6,
7354
7749
  "x-f5xc-required-for": {
@@ -7359,7 +7754,7 @@
7359
7754
  },
7360
7755
  "x-original-maxLength": 1024,
7361
7756
  "x-reconciled-from-discovery": true,
7362
- "x-reconciled-at": "2026-01-05T14:38:39.891885+00:00"
7757
+ "x-reconciled-at": "2026-01-07T15:29:00.300628+00:00"
7363
7758
  },
7364
7759
  "tenant": {
7365
7760
  "type": "string",
@@ -7368,6 +7763,8 @@
7368
7763
  "x-displayname": "Tenant",
7369
7764
  "x-ves-example": "Example-corp.",
7370
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.",
7371
7768
  "minLength": 0,
7372
7769
  "maxLength": 18,
7373
7770
  "x-f5xc-required-for": {
@@ -7380,7 +7777,7 @@
7380
7777
  "x-field-mutability": "read-only",
7381
7778
  "x-original-maxLength": 1024,
7382
7779
  "x-reconciled-from-discovery": true,
7383
- "x-reconciled-at": "2026-01-05T14:38:39.891889+00:00"
7780
+ "x-reconciled-at": "2026-01-07T15:29:00.300632+00:00"
7384
7781
  },
7385
7782
  "uid": {
7386
7783
  "type": "string",
@@ -7389,6 +7786,8 @@
7389
7786
  "x-displayname": "UID",
7390
7787
  "x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
7391
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.",
7392
7791
  "minLength": 0,
7393
7792
  "maxLength": 36,
7394
7793
  "x-f5xc-required-for": {
@@ -7402,9 +7801,11 @@
7402
7801
  "x-original-maxLength": 1024,
7403
7802
  "format": "uuid",
7404
7803
  "x-reconciled-from-discovery": true,
7405
- "x-reconciled-at": "2026-01-05T14:38:39.891894+00:00"
7804
+ "x-reconciled-at": "2026-01-07T15:29:00.300637+00:00"
7406
7805
  }
7407
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...",
7408
7809
  "x-f5xc-minimum-configuration": {
7409
7810
  "description": "Minimum configuration for schemaObjectRefType",
7410
7811
  "required_fields": [
@@ -7447,6 +7848,8 @@
7447
7848
  "ves.io.schema.rules.map.values.string.max_len": "1024",
7448
7849
  "ves.io.schema.rules.map.values.string.min_len": "1"
7449
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.",
7450
7853
  "x-f5xc-required-for": {
7451
7854
  "minimum_config": false,
7452
7855
  "create": false,
@@ -7468,6 +7871,7 @@
7468
7871
  "x-validation-rules": {
7469
7872
  "ves.io.schema.rules.string.max_bytes": "1200"
7470
7873
  },
7874
+ "x-f5xc-description-short": "Human readable description for the object.",
7471
7875
  "minLength": 0,
7472
7876
  "x-f5xc-required-for": {
7473
7877
  "minimum_config": false,
@@ -7477,7 +7881,7 @@
7477
7881
  },
7478
7882
  "x-original-maxLength": 1200,
7479
7883
  "x-reconciled-from-discovery": true,
7480
- "x-reconciled-at": "2026-01-05T14:38:39.891901+00:00"
7884
+ "x-reconciled-at": "2026-01-07T15:29:00.300645+00:00"
7481
7885
  },
7482
7886
  "disable": {
7483
7887
  "type": "boolean",
@@ -7486,6 +7890,7 @@
7486
7890
  "format": "boolean",
7487
7891
  "x-displayname": "Disable",
7488
7892
  "x-f5xc-example": "true",
7893
+ "x-f5xc-description-short": "Value of true will administratively disable the object.",
7489
7894
  "x-f5xc-required-for": {
7490
7895
  "minimum_config": false,
7491
7896
  "create": false,
@@ -7500,6 +7905,8 @@
7500
7905
  "x-displayname": "Labels",
7501
7906
  "x-ves-example": "Value",
7502
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.",
7503
7910
  "x-f5xc-required-for": {
7504
7911
  "minimum_config": false,
7505
7912
  "create": false,
@@ -7520,6 +7927,8 @@
7520
7927
  "x-validation-rules": {
7521
7928
  "ves.io.schema.rules.message.required": "true"
7522
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.",
7523
7932
  "minLength": 0,
7524
7933
  "maxLength": 16,
7525
7934
  "x-f5xc-required-for": {
@@ -7530,7 +7939,7 @@
7530
7939
  },
7531
7940
  "x-original-maxLength": 1024,
7532
7941
  "x-reconciled-from-discovery": true,
7533
- "x-reconciled-at": "2026-01-05T14:38:39.891908+00:00"
7942
+ "x-reconciled-at": "2026-01-07T15:29:00.300652+00:00"
7534
7943
  },
7535
7944
  "namespace": {
7536
7945
  "type": "string",
@@ -7539,6 +7948,8 @@
7539
7948
  "x-displayname": "Namespace",
7540
7949
  "x-ves-example": "Staging",
7541
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 \"\".",
7542
7953
  "minLength": 0,
7543
7954
  "maxLength": 6,
7544
7955
  "x-f5xc-required-for": {
@@ -7549,9 +7960,10 @@
7549
7960
  },
7550
7961
  "x-original-maxLength": 1024,
7551
7962
  "x-reconciled-from-discovery": true,
7552
- "x-reconciled-at": "2026-01-05T14:38:39.891913+00:00"
7963
+ "x-reconciled-at": "2026-01-07T15:29:00.300657+00:00"
7553
7964
  }
7554
7965
  },
7966
+ "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
7555
7967
  "x-f5xc-minimum-configuration": {
7556
7968
  "description": "Minimum configuration for schemaObjectReplaceMetaType",
7557
7969
  "required_fields": [