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

package/specs/domains/object_storage.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Object Storage",
     "description": "Blob management for application component delivery across namespaces. Time-limited download links with cryptographic signing protect asset retrieval. Version-controlled packages organized by operating system type support artifact discovery. Query filtering by name, type, and release number enables programmatic access to integrator libraries and protection modules for mobile deployments.",
-    "version": "2.0.10",
+    "version": "2.0.19",
     "contact": {
       "name": "F5 Distributed Cloud",
       "url": "https://docs.cloud.f5.com"
@@ -13,7 +13,57 @@
       "url": "https://www.f5.com/company/policies/eula"
     },
     "summary": "Versioned library distribution for mobile app integrators. Presigned URLs enable secure downloads with OS-specific builds for iOS and Android.",
-    "x-f5xc-cli-domain": "object_storage"
+    "x-f5xc-cli-domain": "object_storage",
+    "x-f5xc-best-practices": {
+      "common_errors": [
+        {
+          "code": 400,
+          "message": "Invalid request body",
+          "resolution": "Validate JSON structure and required fields before submission",
+          "prevention": "Use schema validation from OpenAPI spec"
+        },
+        {
+          "code": 401,
+          "message": "Authentication failed",
+          "resolution": "Verify API token is valid and not expired",
+          "prevention": "Use environment variables for token management"
+        },
+        {
+          "code": 403,
+          "message": "Permission denied",
+          "resolution": "Check user role and namespace permissions",
+          "prevention": "Verify RBAC policies before operations"
+        },
+        {
+          "code": 404,
+          "message": "Resource not found",
+          "resolution": "Verify resource name and namespace exist",
+          "prevention": "List resources before attempting operations"
+        },
+        {
+          "code": 409,
+          "message": "Resource already exists",
+          "resolution": "Use unique name or delete existing resource",
+          "prevention": "Check existence before creation"
+        },
+        {
+          "code": 429,
+          "message": "Rate limit exceeded",
+          "resolution": "Implement exponential backoff and retry logic",
+          "prevention": "Batch operations and add delays between requests"
+        }
+      ],
+      "security_notes": [
+        "Always use HTTPS for all API communications",
+        "Store API tokens securely, never in source code",
+        "Rotate API tokens regularly following security policies"
+      ],
+      "performance_tips": [
+        "Use pagination for large result sets",
+        "Batch related operations when possible",
+        "Cache read-only responses appropriately"
+      ]
+    }
   },
   "servers": [
     {
@@ -298,6 +348,13 @@
             "latency": "moderate",
             "resource_usage": "moderate"
           }
+        },
+        "x-f5xc-discovered-response-time": {
+          "p50_ms": 200,
+          "p95_ms": 800,
+          "p99_ms": 2000,
+          "sample_count": 0,
+          "source": "estimate"
         }
       },
       "x-displayname": "Stored Object.",
@@ -523,6 +580,13 @@
             "latency": "low",
             "resource_usage": "low"
           }
+        },
+        "x-f5xc-discovered-response-time": {
+          "p50_ms": 200,
+          "p95_ms": 800,
+          "p99_ms": 2000,
+          "sample_count": 0,
+          "source": "estimate"
         }
       },
       "x-displayname": "Stored Object.",
@@ -759,6 +823,13 @@
             "latency": "moderate",
             "resource_usage": "moderate"
           }
+        },
+        "x-f5xc-discovered-response-time": {
+          "p50_ms": 200,
+          "p95_ms": 800,
+          "p99_ms": 2000,
+          "sample_count": 0,
+          "source": "estimate"
         }
       },
       "x-displayname": "Stored Object.",
@@ -984,6 +1055,13 @@
             "latency": "low",
             "resource_usage": "low"
           }
+        },
+        "x-f5xc-discovered-response-time": {
+          "p50_ms": 200,
+          "p95_ms": 800,
+          "p99_ms": 2000,
+          "sample_count": 0,
+          "source": "estimate"
         }
       },
       "x-displayname": "Stored Object.",
@@ -1222,6 +1300,13 @@
             "latency": "low",
             "resource_usage": "low"
           }
+        },
+        "x-f5xc-discovered-response-time": {
+          "p50_ms": 200,
+          "p95_ms": 800,
+          "p99_ms": 2000,
+          "sample_count": 0,
+          "source": "estimate"
         }
       },
       "x-displayname": "Stored Object.",
@@ -1474,6 +1559,13 @@
             "latency": "high",
             "resource_usage": "moderate"
           }
+        },
+        "x-f5xc-discovered-response-time": {
+          "p50_ms": 500,
+          "p95_ms": 1500,
+          "p99_ms": 4000,
+          "sample_count": 0,
+          "source": "estimate"
         }
       },
       "put": {
@@ -1704,6 +1796,13 @@
             "latency": "low",
             "resource_usage": "low"
           }
+        },
+        "x-f5xc-discovered-response-time": {
+          "p50_ms": 800,
+          "p95_ms": 2500,
+          "p99_ms": 6000,
+          "sample_count": 0,
+          "source": "estimate"
         }
       },
       "x-displayname": "Stored Object.",
@@ -1931,6 +2030,13 @@
             "latency": "low",
             "resource_usage": "low"
           }
+        },
+        "x-f5xc-discovered-response-time": {
+          "p50_ms": 200,
+          "p95_ms": 800,
+          "p99_ms": 2000,
+          "sample_count": 0,
+          "source": "estimate"
         }
       },
       "delete": {
@@ -2180,6 +2286,13 @@
             "latency": "high",
             "resource_usage": "moderate"
           }
+        },
+        "x-f5xc-discovered-response-time": {
+          "p50_ms": 500,
+          "p95_ms": 1500,
+          "p99_ms": 4000,
+          "sample_count": 0,
+          "source": "estimate"
         }
       },
       "x-displayname": "Stored Object.",
@@ -2203,6 +2316,7 @@
         "title": "Empty",
         "x-displayname": "Empty",
         "x-ves-proto-message": "ves.io.schema.Empty",
+        "x-f5xc-description-short": "Can be used for messages where no values are needed.",
         "x-f5xc-minimum-configuration": {
           "description": "Minimum configuration for schemaEmpty",
           "required_fields": [],
@@ -2233,6 +2347,7 @@
         "default": "ANY",
         "x-displayname": "HTTP Method.",
         "x-ves-proto-enum": "ves.io.schema.HttpMethod",
+        "x-f5xc-description-short": "Specifies the HTTP method used to access a resource. Any HTTP Method.",
         "x-f5xc-minimum-configuration": {
           "description": "Minimum configuration for schemaHttpMethod",
           "required_fields": [],
@@ -2265,6 +2380,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.bytes.max_len": "5242880"
             },
+            "x-f5xc-description-short": "Exclusive with [string_value] Binary object contents. Should be encoded in base64 scheme.",
             "minLength": 0,
             "maxLength": 1024,
             "x-f5xc-required-for": {
@@ -2287,6 +2403,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.string.in": "[\\\"\\\", \\\"json\\\", \\\"yaml\\\", \\\"txt\\\", \\\"bin\\\"]"
             },
+            "x-f5xc-description-short": "The optional content format associated with object.",
             "minLength": 0,
             "maxLength": 1024,
             "x-f5xc-required-for": {
@@ -2310,6 +2427,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.string.max_len": "512"
             },
+            "x-f5xc-description-short": "The optional description associated with object.",
             "minLength": 0,
             "x-f5xc-required-for": {
               "minimum_config": false,
@@ -2319,7 +2437,7 @@
             },
             "x-original-maxLength": 512,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621064+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859862+00:00"
           },
           "mobile_app_shield": {
             "$ref": "#/components/schemas/stored_objectMobileAppShieldAttributes"
@@ -2352,6 +2470,7 @@
               "ves.io.schema.rules.string.min_len": "1",
               "ves.io.schema.rules.string.ves_object_name": "true"
             },
+            "x-f5xc-description-short": "Name of the stored_object. Required: YES.",
             "x-f5xc-required-for": {
               "minimum_config": false,
               "create": false,
@@ -2360,7 +2479,7 @@
             },
             "x-original-maxLength": 512,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621075+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859873+00:00"
           },
           "namespace": {
             "type": "string",
@@ -2376,6 +2495,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.message.required": "true"
             },
+            "x-f5xc-description-short": "Namespace in which object is to be created Required: YES.",
             "minLength": 0,
             "maxLength": 6,
             "x-f5xc-required-for": {
@@ -2386,7 +2506,7 @@
             },
             "x-original-maxLength": 1024,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621080+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859878+00:00"
           },
           "no_attributes": {
             "$ref": "#/components/schemas/schemaEmpty"
@@ -2407,6 +2527,7 @@
               "ves.io.schema.rules.message.required": "true",
               "ves.io.schema.rules.string.in": "[\\\"swagger\\\", \\\"generic\\\", \\\"big-object\\\", \\\"mobile-sdk\\\", \\\"mobile-integrator\\\", \\\"mobile-app-shield\\\"]"
             },
+            "x-f5xc-description-short": "Type of the stored_object Required: YES.",
             "minLength": 0,
             "maxLength": 1024,
             "x-f5xc-required-for": {
@@ -2428,6 +2549,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.string.max_len": "5242880"
             },
+            "x-f5xc-description-short": "Exclusive with [bytes_value] String formatted contents.",
             "minLength": 0,
             "x-f5xc-required-for": {
               "minimum_config": false,
@@ -2554,6 +2676,8 @@
             "x-validation-rules": {
               "ves.io.schema.rules.bytes.max_len": "5242880"
             },
+            "x-f5xc-description-short": "Exclusive with [presigned_url string_value] Binary object contents. This will be a base64 encoded string.",
+            "x-f5xc-description-medium": "Exclusive with [presigned_url string_value] Binary object contents. This will be a base64 encoded string. The client should decode it to see the actual contents of the object.",
             "minLength": 0,
             "maxLength": 1024,
             "x-f5xc-required-for": {
@@ -2570,6 +2694,7 @@
             "x-displayname": "Content Format.",
             "x-ves-example": "JSON, YAML.",
             "x-f5xc-example": "json, yaml",
+            "x-f5xc-description-short": "The optional content format associated with object.",
             "minLength": 0,
             "maxLength": 1024,
             "x-f5xc-required-for": {
@@ -2598,6 +2723,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.string.max_len": "5242880"
             },
+            "x-f5xc-description-short": "Exclusive with [bytes_value presigned_url] String formatted contents.",
             "minLength": 0,
             "x-f5xc-required-for": {
               "minimum_config": false,
@@ -2656,7 +2782,7 @@
             },
             "x-original-maxLength": 1024,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621110+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859906+00:00"
           },
           "no_attributes": {
             "$ref": "#/components/schemas/schemaEmpty"
@@ -2679,7 +2805,7 @@
             "x-field-mutability": "read-only",
             "x-original-maxLength": 1024,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621116+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859912+00:00"
           },
           "versions": {
             "type": "array",
@@ -2689,6 +2815,7 @@
               "$ref": "#/components/schemas/stored_objectVersionDescriptor"
             },
             "x-displayname": "Versions",
+            "x-f5xc-description-short": "Available versions for the stored object.",
             "x-f5xc-required-for": {
               "minimum_config": false,
               "create": false,
@@ -2730,6 +2857,8 @@
               "$ref": "#/components/schemas/stored_objectListItemDescriptor"
             },
             "x-displayname": "Stored Object Descriptors.",
+            "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
+            "x-f5xc-description-short": "Stored object names and available versions for each object.",
             "x-f5xc-required-for": {
               "minimum_config": false,
               "create": false,
@@ -2785,6 +2914,7 @@
             }
           }
         },
+        "x-f5xc-description-short": "Describes attributes specific to object type - mobile-app-shield.",
         "x-f5xc-minimum-configuration": {
           "description": "Minimum configuration for stored_objectMobileAppShieldAttributes",
           "required_fields": [
@@ -2833,6 +2963,7 @@
             }
           }
         },
+        "x-f5xc-description-short": "Describes attributes specific to object type - mobile-integrator.",
         "x-f5xc-minimum-configuration": {
           "description": "Minimum configuration for stored_objectMobileIntegratorAttributes",
           "required_fields": [
@@ -2873,6 +3004,7 @@
             }
           }
         },
+        "x-f5xc-description-short": "Describes attributes specific to object type - mobile-SDK.",
         "x-f5xc-minimum-configuration": {
           "description": "Minimum configuration for stored_objectMobileSDKAttributes",
           "required_fields": [
@@ -2897,6 +3029,8 @@
         "default": "ANDROID",
         "x-displayname": "Operating System type.",
         "x-ves-proto-enum": "ves.io.schema.stored_object.OSType",
+        "x-f5xc-description-short": "Defines a selection for operating system type. Its either ANDROID or IOS - ANDROID: ANDROID - IOS: IOS.",
+        "x-f5xc-description-medium": "Defines a selection for operating system type. Its either ANDROID or IOS - ANDROID: ANDROID - IOS: IOS.",
         "x-f5xc-minimum-configuration": {
           "description": "Minimum configuration for stored_objectOSType",
           "required_fields": [],
@@ -2946,7 +3080,7 @@
             "description": "The URL to upload or download the resource.",
             "title": "URL",
             "x-displayname": "URL",
-            "x-f5xc-example": "https://example.com",
+            "x-f5xc-description-short": "The URL to upload or download the resource.",
             "format": "uri",
             "minLength": 0,
             "maxLength": 1024,
@@ -2980,6 +3114,8 @@
           "PREFIX_MATCH"
         ],
         "default": "EXACT_MATCH",
+        "x-f5xc-description-short": "X-displayName: \"Query Type\" The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.",
+        "x-f5xc-description-medium": "X-displayName: \"Query Type\" The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH. EXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object having the 'name' as prefix.",
         "x-f5xc-minimum-configuration": {
           "description": "Minimum configuration for stored_objectQueryType",
           "required_fields": [],
@@ -3011,6 +3147,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.message.required": "true"
             },
+            "x-f5xc-description-short": "Creation date & time for the object Required: YES.",
             "minLength": 0,
             "maxLength": 1024,
             "x-f5xc-required-for": {
@@ -3033,6 +3170,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.string.max_len": "512"
             },
+            "x-f5xc-description-short": "Optional field, the Description for the object.",
             "minLength": 0,
             "x-f5xc-required-for": {
               "minimum_config": false,
@@ -3042,7 +3180,7 @@
             },
             "x-original-maxLength": 512,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621142+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859936+00:00"
           },
           "mobile_app_shield": {
             "$ref": "#/components/schemas/stored_objectMobileAppShieldAttributes"
@@ -3066,6 +3204,7 @@
               "ves.io.schema.rules.message.required": "true"
             },
             "x-f5xc-example": "example-resource",
+            "x-f5xc-description-short": "Name of the stored object Required: YES.",
             "minLength": 0,
             "maxLength": 16,
             "x-f5xc-required-for": {
@@ -3076,7 +3215,7 @@
             },
             "x-original-maxLength": 1024,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621150+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859944+00:00"
           },
           "namespace": {
             "type": "string",
@@ -3090,6 +3229,8 @@
             "x-validation-rules": {
               "ves.io.schema.rules.message.required": "true"
             },
+            "x-f5xc-example": "example-resource",
+            "x-f5xc-description-short": "Namespace of the stored object Required: YES.",
             "minLength": 0,
             "maxLength": 6,
             "x-f5xc-required-for": {
@@ -3100,7 +3241,7 @@
             },
             "x-original-maxLength": 1024,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621155+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859949+00:00"
           },
           "no_attributes": {
             "$ref": "#/components/schemas/schemaEmpty"
@@ -3117,7 +3258,6 @@
             "x-validation-rules": {
               "ves.io.schema.rules.message.required": "true"
             },
-            "x-f5xc-example": "https://example.com",
             "format": "uri",
             "minLength": 0,
             "maxLength": 1024,
@@ -3140,6 +3280,8 @@
             "x-validation-rules": {
               "ves.io.schema.rules.message.required": "true"
             },
+            "x-f5xc-example": "v1.2.3",
+            "x-f5xc-description-short": "Version of the stored object Required: YES.",
             "minLength": 0,
             "maxLength": 1,
             "x-f5xc-required-for": {
@@ -3150,7 +3292,7 @@
             },
             "x-original-maxLength": 1024,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621162+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859955+00:00"
           }
         },
         "x-f5xc-minimum-configuration": {
@@ -3187,6 +3329,8 @@
         "default": "STORED_OBJECT_STATUS_NONE",
         "x-displayname": "",
         "x-ves-proto-enum": "ves.io.schema.stored_object.StoredObjectResponseStatus",
+        "x-f5xc-description-short": "The stored object status represents status of create object response if object got created, updated or already exists.",
+        "x-f5xc-description-medium": "The stored object status represents status of create object response if object got created, updated or already exists.",
         "x-f5xc-minimum-configuration": {
           "description": "Minimum configuration for stored_objectStoredObjectResponseStatus",
           "required_fields": [],
@@ -3217,6 +3361,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.message.required": "true"
             },
+            "x-f5xc-description-short": "Creation date & time for the object Required: YES.",
             "minLength": 0,
             "maxLength": 1024,
             "x-f5xc-required-for": {
@@ -3239,6 +3384,7 @@
             "x-validation-rules": {
               "ves.io.schema.rules.string.max_len": "512"
             },
+            "x-f5xc-description-short": "Optional field, the Description for the object.",
             "minLength": 0,
             "x-f5xc-required-for": {
               "minimum_config": false,
@@ -3248,7 +3394,7 @@
             },
             "x-original-maxLength": 512,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621169+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859962+00:00"
           },
           "latest_version": {
             "type": "boolean",
@@ -3256,6 +3402,7 @@
             "title": "Latest_version.",
             "format": "boolean",
             "x-displayname": "Latest Version.",
+            "x-f5xc-description-short": "Tag representing if this is the latest version for the object.",
             "x-f5xc-required-for": {
               "minimum_config": false,
               "create": false,
@@ -3275,7 +3422,6 @@
             "x-validation-rules": {
               "ves.io.schema.rules.message.required": "true"
             },
-            "x-f5xc-example": "https://example.com",
             "format": "uri",
             "minLength": 0,
             "maxLength": 1024,
@@ -3291,6 +3437,7 @@
             "description": "Version of the stored object.",
             "title": "Version",
             "x-displayname": "Version",
+            "x-f5xc-example": "v1.2.3",
             "minLength": 0,
             "maxLength": 1,
             "x-f5xc-required-for": {
@@ -3301,7 +3448,7 @@
             },
             "x-original-maxLength": 1024,
             "x-reconciled-from-discovery": true,
-            "x-reconciled-at": "2026-01-05T14:39:04.621176+00:00"
+            "x-reconciled-at": "2026-01-07T15:29:27.859969+00:00"
           }
         },
         "x-f5xc-minimum-configuration": {