{ "openapi": "3.0.3", "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": "8.0.2", "contact": { "name": "F5 Distributed Cloud", "url": "https://docs.cloud.f5.com" }, "license": { "name": "Proprietary", "url": "https://www.f5.com/company/policies/eula" }, "x-f5xc-description-long": "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.", "x-f5xc-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", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/reference/api-ref", "description": "F5 XC Documentation - Object Storage" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/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" ] }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "servers": [ { "url": "https://{tenant}.{console_url}/api/v1/{domain_prefix}/{environment}/{region}/namespaces/{namespace}", "description": "F5 Distributed Cloud Console", "variables": { "tenant": { "default": "example-corp", "description": "F5 Distributed Cloud tenant identifier (e.g., example-corp, example-partners)" }, "console_url": { "default": "console.ves.volterra.io", "description": "Console URL base (e.g., console.ves.volterra.io for production, staging.volterra.us for staging)", "enum": [ "console.ves.volterra.io", "staging.volterra.us" ] }, "environment": { "default": "production", "description": "Environment designation (production, staging, development)", "enum": [ "production", "staging", "development" ] }, "domain_prefix": { "default": "api", "description": "Domain naming prefix for consistent naming conventions" }, "region": { "default": "us-east-1", "description": "Geographic region for API deployment (e.g., us-east-1, eu-west-1)" }, "namespace": { "default": "default", "description": "Kubernetes-style namespace for environment separation (e.g., 'default', 'production', 'staging')" } } } ], "security": [ { "ApiToken": [] } ], "tags": [ { "name": "object_store" } ], "paths": { "/api/object_store/namespaces/{namespace}/stored_objects/mobile-app-shield": { "get": { "summary": "GET List Of Mobile App Shields.", "description": "ListMobileAppShields is an API to list all mobile app shields available for download.", "operationId": "ves.io.schema.stored_object.MobileAppShieldCustomAPI.ListMobileAppShields", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectListObjectsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "object_type", "description": "Optional query parameter. Type of the stored_object.", "in": "query", "required": false, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" }, { "name": "name", "description": "Optional query parameter. Name of the stored_object.", "in": "query", "required": false, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-file, shared/example-file, example-ns/example-file" }, { "name": "query_type", "description": "Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n- EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n- PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.", "in": "query", "required": false, "x-displayname": "PREFIX MATCH.", "schema": { "type": "string", "enum": [ "EXACT_MATCH", "PREFIX_MATCH" ], "default": "EXACT_MATCH" } }, { "name": "latest_version_only", "description": "Optional query parameter. If passed, returns only latest version of the objects.", "in": "query", "required": false, "x-displayname": "Latest Versions Only.", "schema": { "type": "boolean", "format": "boolean" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.MobileAppShieldCustomAPI.ListMobileAppShields", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Stored Object.", "x-ves-proto-service": "ves.io.schema.stored_object.MobileAppShieldCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/mobile-app-shield/{name}/{version}": { "get": { "summary": "GET Mobile App Shield.", "description": "GetMobileAppShield is an API to download particular version of mobile app shield.", "operationId": "ves.io.schema.stored_object.MobileAppShieldCustomAPI.GetMobileAppShield", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectGetObjectResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nx-required\nName of the stored_object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "volt-api-specs" }, { "name": "version", "description": "Version\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.", "in": "path", "required": true, "x-displayname": "Version", "schema": { "type": "string" }, "x-f5xc-example": "v0-21-09-13" }, { "name": "object_type", "description": "X-required\nType of the stored_object.", "in": "query", "required": false, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.MobileAppShieldCustomAPI.GetMobileAppShield", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace", "path.version" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.version" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Stored Object.", "x-ves-proto-service": "ves.io.schema.stored_object.MobileAppShieldCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/mobile-integrator": { "get": { "summary": "GET List Of Mobile Integrators.", "description": "ListMobileIntegrators is an API to list all mobile integrators available for download.", "operationId": "ves.io.schema.stored_object.MobileIntegratorCustomAPI.ListMobileIntegrators", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectListObjectsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "object_type", "description": "Optional query parameter. Type of the stored_object.", "in": "query", "required": false, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" }, { "name": "name", "description": "Optional query parameter. Name of the stored_object.", "in": "query", "required": false, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-file, shared/example-file, example-ns/example-file" }, { "name": "query_type", "description": "Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n- EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n- PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.", "in": "query", "required": false, "x-displayname": "PREFIX MATCH.", "schema": { "type": "string", "enum": [ "EXACT_MATCH", "PREFIX_MATCH" ], "default": "EXACT_MATCH" } }, { "name": "latest_version_only", "description": "Optional query parameter. If passed, returns only latest version of the objects.", "in": "query", "required": false, "x-displayname": "Latest Versions Only.", "schema": { "type": "boolean", "format": "boolean" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.MobileIntegratorCustomAPI.ListMobileIntegrators", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Stored Object.", "x-ves-proto-service": "ves.io.schema.stored_object.MobileIntegratorCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/mobile-integrator/{name}/{version}": { "get": { "summary": "GET Mobile Integrator.", "description": "GetMobileIntegrator is an API to download particular version of Integrator.", "operationId": "ves.io.schema.stored_object.MobileIntegratorCustomAPI.GetMobileIntegrator", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectGetObjectResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nx-required\nName of the stored_object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "volt-api-specs" }, { "name": "version", "description": "Version\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.", "in": "path", "required": true, "x-displayname": "Version", "schema": { "type": "string" }, "x-f5xc-example": "v0-21-09-13" }, { "name": "object_type", "description": "X-required\nType of the stored_object.", "in": "query", "required": false, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.MobileIntegratorCustomAPI.GetMobileIntegrator", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace", "path.version" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.version" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Stored Object.", "x-ves-proto-service": "ves.io.schema.stored_object.MobileIntegratorCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/mobile-sdk-self-serve": { "get": { "summary": "GET List Of Mobile SDKs self serve.", "description": "ListMobileSDKs is an API to list all mobile SDKs available for download Bot advanced Self serve.", "operationId": "ves.io.schema.stored_object.MobileSdkSelfServeCustomAPI.ListMobileSDKSelfServe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectListObjectsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "object_type", "description": "Optional query parameter. Type of the stored_object.", "in": "query", "required": false, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" }, { "name": "name", "description": "Optional query parameter. Name of the stored_object.", "in": "query", "required": false, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-file, shared/example-file, example-ns/example-file" }, { "name": "query_type", "description": "Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n- EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n- PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.", "in": "query", "required": false, "x-displayname": "PREFIX MATCH.", "schema": { "type": "string", "enum": [ "EXACT_MATCH", "PREFIX_MATCH" ], "default": "EXACT_MATCH" } }, { "name": "latest_version_only", "description": "Optional query parameter. If passed, returns only latest version of the objects.", "in": "query", "required": false, "x-displayname": "Latest Versions Only.", "schema": { "type": "boolean", "format": "boolean" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.MobileSdkSelfServeCustomAPI.ListMobileSDKSelfServe", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Stored Object.", "x-ves-proto-service": "ves.io.schema.stored_object.MobileSdkSelfServeCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/mobile-sdk-self-serve/{name}/{version}": { "get": { "summary": "GET Mobile SDK Self serve.", "description": "GetMobileSDK is an API to download particular version of SDK for Bot advanced Self serve.", "operationId": "ves.io.schema.stored_object.MobileSdkSelfServeCustomAPI.GetMobileSDKSelfServe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectGetObjectResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nx-required\nName of the stored_object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "volt-api-specs" }, { "name": "version", "description": "Version\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.", "in": "path", "required": true, "x-displayname": "Version", "schema": { "type": "string" }, "x-f5xc-example": "v0-21-09-13" }, { "name": "object_type", "description": "X-required\nType of the stored_object.", "in": "query", "required": false, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.MobileSdkSelfServeCustomAPI.GetMobileSDKSelfServe", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace", "path.version" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.version" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Stored Object.", "x-ves-proto-service": "ves.io.schema.stored_object.MobileSdkSelfServeCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}": { "get": { "summary": "GET List Of Stored Objects.", "description": "ListObjects is an API to list objects in object store.", "operationId": "ves.io.schema.stored_object.CustomAPI.ListObjects", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectListObjectsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "object_type", "description": "Object_type\nOptional query parameter. Type of the stored_object.", "in": "path", "required": true, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" }, { "name": "name", "description": "Optional query parameter. Name of the stored_object.", "in": "query", "required": false, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-file, shared/example-file, example-ns/example-file" }, { "name": "query_type", "description": "Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n- EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n- PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.", "in": "query", "required": false, "x-displayname": "PREFIX MATCH.", "schema": { "type": "string", "enum": [ "EXACT_MATCH", "PREFIX_MATCH" ], "default": "EXACT_MATCH" } }, { "name": "latest_version_only", "description": "Optional query parameter. If passed, returns only latest version of the objects.", "in": "query", "required": false, "x-displayname": "Latest Versions Only.", "schema": { "type": "boolean", "format": "boolean" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.CustomAPI.ListObjects", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.object_type" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.namespace", "path.object_type" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Stored Object.", "x-ves-proto-service": "ves.io.schema.stored_object.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}/{name}": { "delete": { "summary": "DELETE Stored Object(s)", "description": "DeleteObjects is an API to DELETE object(s) in object store.", "operationId": "ves.io.schema.stored_object.CustomAPI.DeleteObject_delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectDeleteObjectResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "object_type", "description": "Object_type\nx-required\nType of the stored_object.", "in": "path", "required": true, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" }, { "name": "name", "description": "Name\nx-required\nName of the stored_object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "volt-api-specs" }, { "name": "version", "description": "Version of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.", "in": "query", "required": false, "x-displayname": "Version", "schema": { "type": "string" }, "x-f5xc-example": "v1-21-01-12" }, { "name": "force_delete", "description": "Optional query parameter. If provided will DELETE all the versions of the specified object.", "in": "query", "required": false, "x-displayname": "Force DELETE.", "schema": { "type": "boolean", "format": "boolean" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.CustomAPI.DeleteObject", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace", "path.object_type" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "stored-object", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.object_type" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "stored-object", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Create Stored Object.", "description": "CreateObject is an API to upload an object to generic object store. Objects are immutable, a new version is created when the content is updated.", "operationId": "ves.io.schema.stored_object.CustomAPI.CreateObject", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectCreateObjectResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace in which object is to be created.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "object_type", "description": "Object_type\nx-required\nType of the stored_object.", "in": "path", "required": true, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" }, { "name": "name", "description": "Name\nx-required\nName of the stored_object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "volt-api-specs" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectCreateObjectRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.CustomAPI.CreateObject", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.name", "path.namespace", "path.object_type" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "stored-object" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.object_type" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "stored-object" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Stored Object.", "x-ves-proto-service": "ves.io.schema.stored_object.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}/{name}/{version}": { "get": { "summary": "GET Stored Object.", "description": "GetObject is an API to download an object from object store.", "operationId": "ves.io.schema.stored_object.CustomAPI.GetObject", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectGetObjectResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "object_type", "description": "Object_type\nx-required\nType of the stored_object.", "in": "path", "required": true, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" }, { "name": "name", "description": "Name\nx-required\nName of the stored_object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "volt-api-specs" }, { "name": "version", "description": "Version\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.", "in": "path", "required": true, "x-displayname": "Version", "schema": { "type": "string" }, "x-f5xc-example": "v0-21-09-13" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.CustomAPI.GetObject", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace", "path.object_type", "path.version" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.object_type", "path.version" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Stored Object(s)", "description": "DeleteObjects is an API to DELETE object(s) in object store.", "operationId": "ves.io.schema.stored_object.CustomAPI.DeleteObject_delete_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectDeleteObjectResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "object_type", "description": "Object_type\nx-required\nType of the stored_object.", "in": "path", "required": true, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" }, { "name": "name", "description": "Name\nx-required\nName of the stored_object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "volt-api-specs" }, { "name": "version", "description": "Version\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.", "in": "path", "required": true, "x-displayname": "Version", "schema": { "type": "string" }, "x-f5xc-example": "v1-21-01-12" }, { "name": "force_delete", "description": "Optional query parameter. If provided will DELETE all the versions of the specified object.", "in": "query", "required": false, "x-displayname": "Force DELETE.", "schema": { "type": "boolean", "format": "boolean" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/object_storage/" }, "x-ves-proto-rpc": "ves.io.schema.stored_object.CustomAPI.DeleteObject", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace", "path.object_type", "path.version" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "stored-object", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.object_type", "path.version" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "stored-object", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Stored Object.", "x-ves-proto-service": "ves.io.schema.stored_object.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" } }, "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "API Token authentication. Format: 'APIToken '" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "F5 XC API Token (format: APIToken )" } }, "schemas": { "schemaEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaHttpMethod": { "type": "string", "description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method.", "title": "HttpMethod", "enum": [ "ANY", "GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH", "COPY" ], "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": [], "mutually_exclusive_groups": [], "example_json": "\"ANY\"", "example_yaml": "ANY\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectCreateObjectRequest": { "type": "object", "description": "Request message for CreateObject API.", "title": "CreateObjectRequest", "x-displayname": "Create Object Request.", "x-ves-oneof-field-contents": "[\"bytes_value\",\"string_value\"]", "x-ves-oneof-field-object_attributes": "[\"mobile_app_shield\",\"mobile_integrator\",\"mobile_sdk\",\"mobile_sdk_self_serve\",\"no_attributes\"]", "x-ves-proto-message": "ves.io.schema.stored_object.CreateObjectRequest", "properties": { "bytes_value": { "type": "string", "description": "Exclusive with [string_value]\nBinary object contents. Should be encoded in base64 scheme.", "title": "bytes_value", "format": "byte", "maximum": 5242880, "x-displayname": "Byte Value.", "x-ves-validation-rules": { "ves.io.schema.rules.bytes.max_len": "5242880" }, "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.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "string_value" ] }, "content_format": { "type": "string", "description": "The optional content format associated with object.", "title": "content_format", "x-displayname": "Content Format.", "x-ves-example": "JSON, YAML.", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"\\\", \\\"json\\\", \\\"yaml\\\", \\\"txt\\\", \\\"bin\\\"]" }, "x-f5xc-example": "json, yaml", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"\\\", \\\"json\\\", \\\"yaml\\\", \\\"txt\\\", \\\"bin\\\"]" }, "x-f5xc-description-short": "The optional content format associated with object.", "maxLength": 1024, "enum": [ "", "json", "yaml", "txt", "bin" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The optional description associated with object.", "title": "description", "maxLength": 512, "x-displayname": "Description.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "The optional description associated with object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "mobile_app_shield": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileAppShieldAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_integrator": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileIntegratorAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk_self_serve": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "no_attributes" ] }, "name": { "type": "string", "description": "Name of the stored_object.", "title": "name", "minLength": 1, "maxLength": 512, "x-displayname": "Name", "x-ves-example": "Volt-API-specs.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "volt-api-specs", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 512, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which object is to be created.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace in which object is to be created.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "no_attributes": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no attributes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve" ] }, "object_type": { "type": "string", "description": "Type of the stored_object.", "title": "object_type", "x-displayname": "Object Type.", "x-ves-example": "Swagger", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"swagger\\\", \\\"generic\\\", \\\"big-object\\\", \\\"mobile-sdk\\\", \\\"mobile-integrator\\\", \\\"mobile-app-shield\\\", \\\"mobile-sdk-self-serve\\\"]" }, "x-f5xc-example": "swagger", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"swagger\\\", \\\"generic\\\", \\\"big-object\\\", \\\"mobile-sdk\\\", \\\"mobile-integrator\\\", \\\"mobile-app-shield\\\", \\\"mobile-sdk-self-serve\\\"]" }, "maxLength": 1024, "enum": [ "swagger", "generic", "big-object", "mobile-sdk", "mobile-integrator", "mobile-app-shield", "mobile-sdk-self-serve" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "string_value": { "type": "string", "description": "Exclusive with [bytes_value]\nString formatted contents.", "title": "contents", "maxLength": 5242880, "x-displayname": "String Value.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "5242880" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "5242880" }, "x-f5xc-description-short": "Exclusive with [bytes_value] String formatted contents.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 5242880, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bytes_value" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectCreateObjectRequest", "required_fields": [ "name", "namespace", "object_type" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"volt-api-specs\",\n \"namespace\": \"system\",\n \"object_type\": \"swagger\"\n}", "example_yaml": "name: volt-api-specs\nnamespace: system\nobject_type: swagger" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectCreateObjectResponse": { "type": "object", "description": "Response message for CreateObject API.", "title": "CreateObjectResponse", "x-displayname": "Create Object Response.", "x-ves-oneof-field-additional_info": "[\"no_additional_info\",\"presigned_url\"]", "x-ves-proto-message": "ves.io.schema.stored_object.CreateObjectResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/stored_objectStoredObjectDescriptor" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_additional_info": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no additional info.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "presigned_url" ] }, "presigned_url": { "allOf": [ { "$ref": "#/components/schemas/stored_objectPreSignedUrl" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_additional_info" ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/stored_objectStoredObjectResponseStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectCreateObjectResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectDeleteObjectResponse": { "type": "object", "description": "Response for DeleteObjects API.", "title": "DeleteObjectResponse", "x-displayname": "DELETE Objects Response.", "x-ves-proto-message": "ves.io.schema.stored_object.DeleteObjectResponse", "properties": { "deleted_objects": { "type": "array", "description": "Names of Deleted Object.", "title": "deleted_objects", "items": { "type": "string" }, "x-displayname": "Deleted Object Names.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectDeleteObjectResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectGetObjectResponse": { "type": "object", "description": "Response message for GetObject API.", "title": "GetObjectResponse", "x-displayname": "GET Object Response.", "x-ves-oneof-field-contents": "[\"bytes_value\",\"presigned_url\",\"string_value\"]", "x-ves-proto-message": "ves.io.schema.stored_object.GetObjectResponse", "properties": { "bytes_value": { "type": "string", "description": "Exclusive with [presigned_url string_value]\nBinary object contents. This will be a base64 encoded string. The client should decode it to see the actual contents of the object.", "title": "bytes_value", "format": "byte", "maximum": 5242880, "x-displayname": "Byte Value.", "x-ves-validation-rules": { "ves.io.schema.rules.bytes.max_len": "5242880" }, "x-f5xc-example": "\"\"", "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.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "presigned_url", "string_value" ] }, "content_format": { "type": "string", "description": "The optional content format associated with object.", "title": "content_format", "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.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/stored_objectStoredObjectDescriptor" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "presigned_url": { "allOf": [ { "$ref": "#/components/schemas/stored_objectPreSignedUrl" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bytes_value", "string_value" ] }, "string_value": { "type": "string", "description": "Exclusive with [bytes_value presigned_url]\nString formatted contents.", "title": "contents", "maxLength": 5242880, "x-displayname": "Contents", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "5242880" }, "x-f5xc-example": "\"\"", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "5242880" }, "x-f5xc-description-short": "Exclusive with [bytes_value presigned_url] String formatted contents.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 5242880, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bytes_value", "presigned_url" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectGetObjectResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectListItemDescriptor": { "type": "object", "description": "A descriptor for list response item.", "title": "ListItemDescriptor", "x-displayname": "List Item Descriptor.", "x-ves-oneof-field-object_attributes": "[\"mobile_app_shield\",\"mobile_integrator\",\"mobile_sdk\",\"mobile_sdk_self_serve\",\"no_attributes\"]", "x-ves-proto-message": "ves.io.schema.stored_object.ListItemDescriptor", "properties": { "mobile_app_shield": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileAppShieldAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_integrator": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileIntegratorAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk_self_serve": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "no_attributes" ] }, "name": { "type": "string", "description": "Name of the stored object.", "title": "name", "x-displayname": "Object Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "no_attributes": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no attributes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve" ] }, "tenant": { "type": "string", "description": "Tenant to which this object belongs.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "versions": { "type": "array", "description": "Available versions for the stored object.", "title": "versions", "items": { "$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, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectListItemDescriptor", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectListObjectsResponse": { "type": "object", "description": "Response for GetListOfObjects API.", "title": "ListObjectsResponse", "x-displayname": "List Objects Response.", "x-ves-proto-message": "ves.io.schema.stored_object.ListObjectsResponse", "properties": { "items": { "type": "array", "description": "Stored object names and available versions for each object.", "title": "list of store object descriptors", "items": { "$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-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectListObjectsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectMobileAppShieldAttributes": { "type": "object", "description": "Describes attributes specific to object type - mobile-app-shield.", "title": "MobileAppShieldAttributes", "x-displayname": "Mobile-app-shield attributes.", "x-ves-proto-message": "ves.io.schema.stored_object.MobileAppShieldAttributes", "properties": { "os_type": { "allOf": [ { "$ref": "#/components/schemas/stored_objectOSType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "release_version": { "type": "string", "description": "Version of mobile app shield release.", "title": "release_version", "maxLength": 32, "x-displayname": "Mobile app shield release version.", "x-ves-example": "V.4.2.1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "32", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "v.4.2.1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "32", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 32, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "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": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectMobileIntegratorAttributes": { "type": "object", "description": "Describes attributes specific to object type - mobile-integrator.", "title": "MobileIntegratorAttributes", "x-displayname": "Mobile-integrator attributes.", "x-ves-proto-message": "ves.io.schema.stored_object.MobileIntegratorAttributes", "properties": { "os_type": { "allOf": [ { "$ref": "#/components/schemas/stored_objectOSType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "release_version": { "type": "string", "description": "Version of mobile integrator release.", "title": "release_version", "maxLength": 32, "x-displayname": "Mobile integrator release version.", "x-ves-example": "V.4.2.1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "32", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "v.4.2.1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "32", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 32, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Describes attributes specific to object type - mobile-integrator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectMobileIntegratorAttributes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectMobileSDKAttributes": { "type": "object", "description": "Describes attributes specific to object type - mobile-SDK.", "title": "MobileSDKAttributes", "x-displayname": "Mobile-SDK attributes.", "x-ves-proto-message": "ves.io.schema.stored_object.MobileSDKAttributes", "properties": { "os_type": { "allOf": [ { "$ref": "#/components/schemas/stored_objectOSType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "release_version": { "type": "string", "description": "Version of mobile SDK release.", "title": "release_version", "x-displayname": "Mobile SDK release version.", "x-ves-example": "V.4.2.1", "x-f5xc-example": "v.4.2.1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Describes attributes specific to object type - mobile-SDK.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectMobileSDKAttributes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectOSType": { "type": "string", "description": "Defines a selection for operating system type. Its either ANDROID or IOS\n\n- ANDROID: ANDROID\n\n- IOS: IOS.", "title": "OSType", "enum": [ "ANDROID", "IOS" ], "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": [], "mutually_exclusive_groups": [], "example_json": "\"ANDROID\"", "example_yaml": "ANDROID\n..." }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectPreSignedUrl": { "type": "object", "description": "Pre signed URL.", "title": "PreSignedUrl", "x-displayname": "Pre Signed URL.", "x-ves-oneof-field-storage_provider_choice": "[\"aws\"]", "x-ves-proto-message": "ves.io.schema.stored_object.PreSignedUrl", "properties": { "aws": { "allOf": [ { "$ref": "#/components/schemas/stored_objectPresignedUrlData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectPreSignedUrl", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectPresignedUrlData": { "type": "object", "description": "Pre signed URL data.", "title": "PresignedUrlData", "x-displayname": "Pre Signed URL Data.", "x-ves-proto-message": "ves.io.schema.stored_object.PresignedUrlData", "properties": { "method": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpMethod" } ], "x-f5xc-example": "GET", "x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "The URL to upload or download the resource.", "title": "url", "x-displayname": "URL", "x-f5xc-description-short": "The URL to upload or download the resource.", "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectPresignedUrlData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectStoredObjectDescriptor": { "type": "object", "description": "Response for GET, Create APIs.", "title": "StoredObjectDescriptor", "x-displayname": "Object Metadata Response.", "x-ves-oneof-field-object_attributes": "[\"mobile_app_shield\",\"mobile_integrator\",\"mobile_sdk\",\"mobile_sdk_self_serve\",\"no_attributes\"]", "x-ves-proto-message": "ves.io.schema.stored_object.StoredObjectDescriptor", "properties": { "creation_timestamp": { "type": "string", "description": "Creation date & time for the object.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "description": { "type": "string", "description": "Optional field, the Description for the object.", "title": "description", "maxLength": 512, "x-displayname": "Description.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "Optional field, the Description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "mobile_app_shield": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileAppShieldAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_integrator": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileIntegratorAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk_self_serve": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "no_attributes" ] }, "name": { "type": "string", "description": "Name of the stored object.", "title": "name", "x-displayname": "Name", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of the stored object.", "title": "namespace", "x-displayname": "Namespace", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "no_attributes": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no attributes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve" ] }, "url": { "type": "string", "description": "URL of the stored object.", "title": "url", "x-displayname": "URL", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "version": { "type": "string", "description": "Version of the stored object.", "title": "version", "x-displayname": "Version", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "v1.2.3", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectStoredObjectDescriptor", "required_fields": [ "creation_timestamp", "name", "namespace", "url", "version" ], "mutually_exclusive_groups": [], "example_json": "{\n \"creation_timestamp\": \"value\",\n \"name\": \"example-resource\",\n \"namespace\": \"example-resource\",\n \"url\": \"value\",\n \"version\": \"v1.2.3\"\n}", "example_yaml": "creation_timestamp: value\nname: example-resource\nnamespace: example-resource\nurl: value\nversion: v1.2.3" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectStoredObjectResponseStatus": { "type": "string", "description": "The stored object status represents status of create object response if object got created, updated or already exists.", "title": "StoredObjectResponseStatus", "enum": [ "STORED_OBJECT_STATUS_NONE", "STORED_OBJECT_STATUS_CREATED", "STORED_OBJECT_STATUS_UPDATED", "STORED_OBJECT_STATUS_ALREADY_EXISTS" ], "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": [], "mutually_exclusive_groups": [], "example_json": "\"STORED_OBJECT_STATUS_NONE\"", "example_yaml": "STORED_OBJECT_STATUS_NONE\n..." }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectVersionDescriptor": { "type": "object", "description": "Descriptor for store object version.", "title": "VersionDescriptor", "x-displayname": "Version Descriptor.", "x-ves-proto-message": "ves.io.schema.stored_object.VersionDescriptor", "properties": { "creation_timestamp": { "type": "string", "description": "Creation date & time for the object.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "description": { "type": "string", "description": "Optional field, the Description for the object.", "title": "description", "maxLength": 512, "x-displayname": "Description.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "Optional field, the Description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "latest_version": { "type": "boolean", "description": "A tag representing if this is the latest version for the object.", "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, "update": false, "read": false } }, "url": { "type": "string", "description": "URL of the stored object.", "title": "url", "x-displayname": "URL", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "version": { "type": "string", "description": "Version of the stored object.", "title": "version", "x-displayname": "Version", "x-f5xc-example": "v1.2.3", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectVersionDescriptor", "required_fields": [ "creation_timestamp", "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"creation_timestamp\": \"value\",\n \"url\": \"value\"\n}", "example_yaml": "creation_timestamp: value\nurl: value" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } } }, "responses": {}, "parameters": {}, "requestBodies": {} } }