{ "openapi": "3.1.1", "info": { "title": "CrmSaas.Api | v1", "version": "1.0.0" }, "servers": [ { "url": "http://www.bayucend.com/" } ], "paths": { "/api/v1/telemetry/client-events": { "post": { "tags": [ "Observability" ], "operationId": "ClientTelemetryBatch", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ClientTelemetryBatchV1" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugins": { "get": { "tags": [ "Plugins" ], "operationId": "PluginRegistryList", "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugins/{pluginId}/health": { "get": { "tags": [ "Plugins" ], "operationId": "PluginHealth", "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugins/{pluginId}/dependencies": { "get": { "tags": [ "Plugins" ], "operationId": "PluginDependencies", "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugins/{pluginId}/metadata": { "get": { "tags": [ "Plugins" ], "operationId": "PluginMetadataCoverage", "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugins/{pluginId}/manifest": { "get": { "tags": [ "Plugins" ], "operationId": "PluginPackageManifest", "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugins/frontend-manifest": { "get": { "tags": [ "Plugins" ], "operationId": "PluginFrontendManifest", "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-assets/{pluginId}/{version}/{path}": { "get": { "tags": [ "PluginAssets" ], "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/ontology": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataOntologyProjection", "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/objects": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataObjectsList", "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/relations": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataRelationsList", "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/seeds/item-brand/preview": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataItemBrandSeedPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/seeds/item-period-discount/preview": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataItemPeriodDiscountSeedPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/seeds/package-code-flow/preview": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataPackageCodeFlowSeedPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/seeds/item-multi-spec/preview": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataItemMultiSpecSeedPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/seeds/branch-area/preview": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataBranchAreaSeedPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/seeds/enterprise-master-data/preview": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataEnterpriseMasterDataSeedPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/seeds/{seedKey}/preview": { "get": { "tags": [ "Metadata" ], "operationId": "MetadataRegisteredSeedPreview", "parameters": [ { "name": "seedKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/inventory/transfer-orders/preview": { "get": { "tags": [ "Inventory", "Menu9303" ], "operationId": "InventoryTransferOrdersPreview", "responses": { "200": { "description": "OK" } } } }, "/api/mobile-update/pgyer/install": { "get": { "tags": [ "MobileUpdate" ], "operationId": "PgyerInstallProxy", "responses": { "200": { "description": "OK" } } } }, "/api/mobile-update/pgyer/check": { "post": { "tags": [ "MobileUpdate" ], "operationId": "PgyerCheckProxy", "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/auth/login": { "post": { "tags": [ "Admin", "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdminWebLoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/auth/trusted-access": { "get": { "tags": [ "Admin", "Authentication" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/auth/trusted-login": { "post": { "tags": [ "Admin", "Authentication" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/auth/me": { "get": { "tags": [ "Admin", "Authentication" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/admin/auth/logout": { "post": { "tags": [ "Admin", "Authentication" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/dashboard": { "get": { "tags": [ "PluginCenter" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/catalog": { "get": { "tags": [ "PluginCenter" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/installations": { "get": { "tags": [ "PluginCenter" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/feature-availability": { "get": { "tags": [ "PluginCenter" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/plugins/{pluginId}": { "get": { "tags": [ "PluginCenter" ], "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/plugins/{pluginId}/dependencies": { "get": { "tags": [ "PluginCenter" ], "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/plugins/{pluginId}/extension-points": { "get": { "tags": [ "PluginCenter" ], "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/plugins/{pluginId}/changes": { "get": { "tags": [ "PluginCenter" ], "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/install-plan": { "post": { "tags": [ "PluginCenter" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginInstallPlanRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/install": { "post": { "tags": [ "PluginCenter" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginCenterOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/upgrade": { "post": { "tags": [ "PluginCenter" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginCenterOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/enable": { "post": { "tags": [ "PluginCenter" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginCenterVersionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/disable": { "post": { "tags": [ "PluginCenter" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginCenterVersionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/rollback": { "post": { "tags": [ "PluginCenter" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginCenterVersionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-center/sync-runtime": { "post": { "tags": [ "PluginCenter" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-admin/catalog": { "get": { "tags": [ "PluginAdmin" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-admin/installed": { "get": { "tags": [ "PluginAdmin" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-admin/install-plan": { "post": { "tags": [ "PluginAdmin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginInstallPlanRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-admin/install": { "post": { "tags": [ "PluginAdmin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginInstallRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-admin/enable": { "post": { "tags": [ "PluginAdmin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginVersionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-admin/disable": { "post": { "tags": [ "PluginAdmin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginVersionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/plugin-admin/rollback": { "post": { "tags": [ "PluginAdmin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginVersionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/extension-overlays": { "get": { "tags": [ "MetadataExtensionOverlays" ], "operationId": "MetadataExtensionOverlayList", "parameters": [ { "name": "deploymentKey", "in": "query", "schema": { "type": "string" } }, { "name": "baseObjectId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "ownerPackageId", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/extension-overlays/{overlayId}/audit": { "get": { "tags": [ "MetadataExtensionOverlays" ], "operationId": "MetadataExtensionOverlayAudit", "parameters": [ { "name": "overlayId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/extension-overlays/preview": { "post": { "tags": [ "MetadataExtensionOverlays" ], "operationId": "MetadataExtensionOverlayPreview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataExtensionOverlayPackage" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/extension-overlays/enable": { "post": { "tags": [ "MetadataExtensionOverlays" ], "operationId": "MetadataExtensionOverlayEnable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableMetadataExtensionOverlayApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/metadata/extension-overlays/rollback": { "post": { "tags": [ "MetadataExtensionOverlays" ], "operationId": "MetadataExtensionOverlayRollback", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RollbackMetadataExtensionOverlayApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/platform-initialization/status": { "get": { "tags": [ "PlatformInitialization" ], "operationId": "PlatformInitializationStatus", "responses": { "200": { "description": "OK" } } } }, "/api/v1/platform-initialization/preview": { "post": { "tags": [ "PlatformInitialization" ], "operationId": "PlatformInitializationPreview", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformInitializationRequest" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/platform-initialization/apply": { "post": { "tags": [ "PlatformInitialization" ], "operationId": "PlatformInitializationApply", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlatformInitializationRequest" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-provider-routes": { "get": { "tags": [ "AiProviderRoutes" ], "operationId": "AiProviderRouteList", "parameters": [ { "name": "tenantId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "deploymentId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "providerId", "in": "query", "schema": { "type": "string" } }, { "name": "modelId", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/AiProviderRouteStatus" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-provider-routes/{routeId}/versions/{version}/audit": { "get": { "tags": [ "AiProviderRoutes" ], "operationId": "AiProviderRouteAudit", "parameters": [ { "name": "routeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-provider-routes/drafts": { "post": { "tags": [ "AiProviderRoutes" ], "operationId": "AiProviderRouteCreateDraft", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiProviderRouteDraftApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-provider-routes/{routeId}/versions/{version}/approve": { "post": { "tags": [ "AiProviderRoutes" ], "operationId": "AiProviderRouteApprove", "parameters": [ { "name": "routeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiProviderRouteDecisionApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-provider-routes/{routeId}/versions/{version}/revoke": { "post": { "tags": [ "AiProviderRoutes" ], "operationId": "AiProviderRouteRevoke", "parameters": [ { "name": "routeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiProviderRouteDecisionApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/roles": { "get": { "tags": [ "Security" ], "operationId": "SecurityRolesList", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/permission-points/tree": { "get": { "tags": [ "Security" ], "operationId": "SecurityPermissionPointsTree", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/roles/{roleCode}/grants": { "get": { "tags": [ "Security" ], "operationId": "SecurityRoleGrantsGet", "parameters": [ { "name": "roleCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Security" ], "operationId": "SecurityRoleGrantsSave", "parameters": [ { "name": "roleCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecuritySaveRoleGrantsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/me/permissions": { "get": { "tags": [ "Security" ], "operationId": "SecurityMePermissions", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/admin-master-data/item-brand/preview": { "get": { "tags": [ "Security" ], "operationId": "SecurityItemBrandManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/admin-master-data/branch-area/preview": { "get": { "tags": [ "Security" ], "operationId": "SecurityBranchAreaManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/admin-master-data/supplier-area/preview": { "get": { "tags": [ "Security" ], "operationId": "SecuritySupplierAreaManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/admin-master-data/supplier-profile/preview": { "get": { "tags": [ "Security" ], "operationId": "SecuritySupplierProfileManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/admin-master-data/salesperson/preview": { "get": { "tags": [ "Security" ], "operationId": "SecuritySalespersonManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/admin-master-data/retail-sales-setting/preview": { "get": { "tags": [ "Security" ], "operationId": "SecurityRetailSalesSettingManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/admin-master-data/double-screen-setting/preview": { "get": { "tags": [ "Security" ], "operationId": "SecurityDoubleScreenSettingManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/admin-master-data/promotion-foundation/preview": { "get": { "tags": [ "Security" ], "operationId": "SecurityPromotionFoundationManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/platform-report-center/preview": { "get": { "tags": [ "Security" ], "operationId": "SecurityReportCenterManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/finance-config/preview": { "get": { "tags": [ "Security" ], "operationId": "SecurityFinanceConfigManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/platform-initialization/preview": { "get": { "tags": [ "Security" ], "operationId": "SecurityPlatformInitializationManifestPreview", "responses": { "200": { "description": "OK" } } } }, "/api/v1/security/manifests/reconcile": { "post": { "tags": [ "Security" ], "operationId": "SecurityManifestReconcile", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SecurityPermissionManifestDto" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/actions": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneActions", "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/plugin-capabilities": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlanePluginCapabilities", "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/traces": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneTraceList", "parameters": [ { "name": "actionCode", "in": "query", "schema": { "type": "string" } }, { "name": "actorUserKey", "in": "query", "schema": { "type": "string" } }, { "name": "entityCode", "in": "query", "schema": { "type": "string" } }, { "name": "traceId", "in": "query", "schema": { "type": "string" } }, { "name": "correlationId", "in": "query", "schema": { "type": "string" } }, { "name": "idempotencyKey", "in": "query", "schema": { "type": "string" } }, { "name": "agentId", "in": "query", "schema": { "type": "string" } }, { "name": "agentSessionId", "in": "query", "schema": { "type": "string" } }, { "name": "delegationId", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/traces/{traceId}": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneTraceDetail", "parameters": [ { "name": "traceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/outbox": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneOutboxList", "parameters": [ { "name": "traceId", "in": "query", "schema": { "type": "string" } }, { "name": "correlationId", "in": "query", "schema": { "type": "string" } }, { "name": "idempotencyKey", "in": "query", "schema": { "type": "string" } }, { "name": "deduplicationKey", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/drafts": { "post": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneDraftCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBusinessActionDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneDraftList", "parameters": [ { "name": "actionCode", "in": "query", "schema": { "type": "string" } }, { "name": "entityCode", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "createdByUser", "in": "query", "schema": { "type": "string" } }, { "name": "correlationId", "in": "query", "schema": { "type": "string" } }, { "name": "idempotencyKey", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/drafts/{draftId}": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneDraftDetail", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/drafts/{draftId}/command-preview": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneDraftCommandPreview", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/drafts/{draftId}/validate": { "post": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneDraftValidate", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/drafts/{draftId}/reject": { "post": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneDraftReject", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectBusinessActionDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/semantic-context/entities/{entityCode}": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneSemanticEntity", "parameters": [ { "name": "entityCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/semantic-context/actions/{actionCode}": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneSemanticAction", "parameters": [ { "name": "actionCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/query-tools": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneQueryToolCatalog", "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/query-tools/{toolCode}/run": { "post": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneQueryToolRun", "parameters": [ { "name": "toolCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/evals": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneEvalCatalog", "responses": { "200": { "description": "OK" } } } }, "/api/v1/ai-control-plane/governance": { "get": { "tags": [ "AiControlPlane" ], "operationId": "AiControlPlaneGovernanceSnapshot", "responses": { "200": { "description": "OK" } } } }, "/api/v1/cloud-fleet/tenants": { "post": { "tags": [ "Cloud Fleet" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCloudTenantRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Cloud Fleet" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/cloud-fleet/organizations": { "post": { "tags": [ "Cloud Fleet" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCloudOrganizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/cloud-fleet/deployments": { "post": { "tags": [ "Cloud Fleet" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCloudDeploymentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/cloud-fleet/nodes": { "post": { "tags": [ "Cloud Fleet" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCloudEdgeNodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Cloud Fleet" ], "parameters": [ { "name": "tenantId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/cloud-fleet/nodes/{edgeNodeId}/registration-tickets": { "post": { "tags": [ "Cloud Fleet" ], "parameters": [ { "name": "edgeNodeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueEdgeRegistrationTicketRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/cloud-fleet/nodes/{edgeNodeId}/tasks": { "post": { "tags": [ "Cloud Fleet" ], "parameters": [ { "name": "edgeNodeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueCloudFleetTaskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/cloud-fleet/nodes/{edgeNodeId}/credentials/{keyId}:revoke": { "post": { "tags": [ "Cloud Fleet" ], "parameters": [ { "name": "edgeNodeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeCloudFleetCredentialRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/cloud-fleet/audit": { "get": { "tags": [ "Cloud Fleet" ], "parameters": [ { "name": "tenantId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "take", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/edge/v1/registrations:exchange": { "post": { "tags": [ "Edge Control" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeRegistrationExchangeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/edge/v1/nodes/{edgeNodeId}/heartbeats": { "post": { "tags": [ "Edge Control" ], "parameters": [ { "name": "edgeNodeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeNodeHeartbeat" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/edge/v1/nodes/{edgeNodeId}/control-messages:poll": { "post": { "tags": [ "Edge Control" ], "parameters": [ { "name": "edgeNodeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeReplayRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/edge/v1/nodes/{edgeNodeId}/task-receipts": { "post": { "tags": [ "Edge Control" ], "parameters": [ { "name": "edgeNodeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeTaskReceipt" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/edge/v1/nodes/{edgeNodeId}/credentials:prepare-rotation": { "post": { "tags": [ "Edge Control" ], "parameters": [ { "name": "edgeNodeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeCredentialRotationPrepareRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/edge/v1/nodes/{edgeNodeId}/credentials:confirm-rotation": { "post": { "tags": [ "Edge Control" ], "parameters": [ { "name": "edgeNodeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeCredentialRotationConfirmation" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/edge/v1/nodes/{edgeNodeId}/credentials/{keyId}:revoke": { "post": { "tags": [ "Edge Control" ], "parameters": [ { "name": "edgeNodeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgeCredentialRevocation" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AdminWebLoginRequest": { "required": [ "account", "password" ], "type": "object", "properties": { "account": { "type": [ "null", "string" ] }, "password": { "type": [ "null", "string" ] } } }, "AiProviderDataEgressMode": { "type": "integer" }, "AiProviderRouteDecisionApiRequest": { "required": [ "operationId", "reason" ], "type": "object", "properties": { "operationId": { "type": "string", "format": "uuid" }, "reason": { "type": "string" } } }, "AiProviderRouteDraftApiRequest": { "required": [ "operationId", "routeId", "version", "tenantId", "deploymentId", "providerId", "modelId", "endpointRef", "credentialRef", "dataEgressMode", "timeout", "validFromUtc", "validToUtc", "reason" ], "type": "object", "properties": { "operationId": { "type": "string", "format": "uuid" }, "routeId": { "type": "string" }, "version": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "tenantId": { "type": "string", "format": "uuid" }, "deploymentId": { "type": "string", "format": "uuid" }, "providerId": { "type": "string" }, "modelId": { "type": "string" }, "endpointRef": { "type": "string" }, "credentialRef": { "type": "string" }, "dataEgressMode": { "$ref": "#/components/schemas/AiProviderDataEgressMode" }, "timeout": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string" }, "validFromUtc": { "type": "string", "format": "date-time" }, "validToUtc": { "type": [ "null", "string" ], "format": "date-time" }, "reason": { "type": "string" } } }, "AiProviderRouteStatus": { "type": "integer" }, "ClientTelemetryBatchV1": { "required": [ "events" ], "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/ClientTelemetryEventV1" } }, "schemaVersion": { "type": "string", "default": "ProductSaleTelemetryV1" } } }, "ClientTelemetryEventV1": { "required": [ "eventId", "eventName", "occurredAtUtc", "correlationId", "appId", "resultStatus" ], "type": "object", "properties": { "eventId": { "type": "string", "format": "uuid" }, "eventName": { "type": "string" }, "occurredAtUtc": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string" }, "appId": { "type": "string" }, "resultStatus": { "type": "string" }, "errorCode": { "type": [ "null", "string" ] }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "featureId": { "type": [ "null", "string" ] }, "pluginId": { "type": [ "null", "string" ] }, "pluginVersion": { "type": [ "null", "string" ] }, "buildCommit": { "type": [ "null", "string" ] }, "deviceIdHash": { "type": [ "null", "string" ] }, "attributes": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "schemaVersion": { "type": "string", "default": "1.0" } } }, "CreateBusinessActionDraftRequest": { "required": [ "actionCode", "entityCode", "draftPayload", "createdByAgent", "createdByUser", "sourceIntent", "evidenceRefs", "expiresAtUtc" ], "type": "object", "properties": { "actionCode": { "type": "string" }, "entityCode": { "type": [ "null", "string" ] }, "draftPayload": { "$ref": "#/components/schemas/JsonElement" }, "createdByAgent": { "type": [ "null", "string" ] }, "createdByUser": { "type": [ "null", "string" ] }, "sourceIntent": { "type": [ "null", "string" ] }, "evidenceRefs": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/EvidenceRef" } }, "expiresAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "correlationId": { "type": [ "null", "string" ] }, "idempotencyKey": { "type": [ "null", "string" ] }, "requestHash": { "type": [ "null", "string" ] }, "sourceIntentHash": { "type": [ "null", "string" ] } } }, "CreateCloudDeploymentRequest": { "required": [ "tenantId", "organizationId", "code", "displayName", "environment" ], "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "displayName": { "type": "string" }, "environment": { "type": "string" } } }, "CreateCloudEdgeNodeRequest": { "required": [ "tenantId", "organizationId", "deploymentId", "code", "displayName", "roles" ], "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "deploymentId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "displayName": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/EdgeNodeRole" } } } }, "CreateCloudOrganizationRequest": { "required": [ "tenantId", "code", "displayName" ], "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "displayName": { "type": "string" } } }, "CreateCloudTenantRequest": { "required": [ "code", "displayName" ], "type": "object", "properties": { "code": { "type": "string" }, "displayName": { "type": "string" } } }, "EdgeChannel": { "enum": [ "Registration", "Telemetry", "Control", "Receipt" ] }, "EdgeCredentialRevocation": { "required": [ "envelope", "credentialKeyId", "reason", "reasonCode", "requestedAtUtc" ], "type": "object", "properties": { "envelope": { "$ref": "#/components/schemas/EdgeMessageEnvelope" }, "credentialKeyId": { "type": "string" }, "reason": { "$ref": "#/components/schemas/EdgeCredentialRevocationReason" }, "reasonCode": { "type": "string" }, "requestedAtUtc": { "type": "string", "format": "date-time" } } }, "EdgeCredentialRevocationReason": { "enum": [ "LocalOperatorRequest", "CredentialRotation", "NodeRetired", "SuspectedCompromise" ] }, "EdgeCredentialRotationConfirmation": { "required": [ "envelope", "rotationId", "previousCredentialKeyId", "newCredentialKeyId", "confirmedAtUtc" ], "type": "object", "properties": { "envelope": { "$ref": "#/components/schemas/EdgeMessageEnvelope" }, "rotationId": { "type": "string", "format": "uuid" }, "previousCredentialKeyId": { "type": "string" }, "newCredentialKeyId": { "type": "string" }, "confirmedAtUtc": { "type": "string", "format": "date-time" } } }, "EdgeCredentialRotationPrepareRequest": { "required": [ "envelope", "rotationId", "currentCredentialKeyId", "newPublicKeyAlgorithm", "newPublicKey", "requestedAtUtc" ], "type": "object", "properties": { "envelope": { "$ref": "#/components/schemas/EdgeMessageEnvelope" }, "rotationId": { "type": "string", "format": "uuid" }, "currentCredentialKeyId": { "type": "string" }, "newPublicKeyAlgorithm": { "type": "string" }, "newPublicKey": { "type": "string" }, "requestedAtUtc": { "type": "string", "format": "date-time" } } }, "EdgeDataClassification": { "enum": [ "C0", "C1", "C2", "C3", "C4" ] }, "EdgeDeviceScope": { "required": [ "tenantId", "organizationId", "deploymentId", "edgeNodeId" ], "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "deploymentId": { "type": "string", "format": "uuid" }, "edgeNodeId": { "type": "string", "format": "uuid" } } }, "EdgeGovernanceSnapshotKind": { "enum": [ "Health", "Versions", "PluginInventory", "PolicyDigest" ] }, "EdgeMessageEnvelope": { "required": [ "schemaVersion", "messageId", "messageType", "channel", "scope", "occurredAtUtc", "expiresAtUtc", "sequence", "correlationId", "idempotencyKey", "dataClassification", "payloadHash", "keyId", "signature" ], "type": "object", "properties": { "schemaVersion": { "type": "string" }, "messageId": { "type": "string", "format": "uuid" }, "messageType": { "$ref": "#/components/schemas/EdgeMessageType" }, "channel": { "$ref": "#/components/schemas/EdgeChannel" }, "scope": { "$ref": "#/components/schemas/EdgeDeviceScope" }, "occurredAtUtc": { "type": "string", "format": "date-time" }, "expiresAtUtc": { "type": "string", "format": "date-time" }, "sequence": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "correlationId": { "type": "string" }, "idempotencyKey": { "type": "string" }, "dataClassification": { "$ref": "#/components/schemas/EdgeDataClassification" }, "payloadHash": { "type": "string" }, "keyId": { "type": "string" }, "signature": { "type": "string" } } }, "EdgeMessageType": { "enum": [ "RegistrationRequest", "RegistrationResult", "Heartbeat", "DesiredTask", "TaskReceipt", "ReplayRequest", "TaskRevocation", "CredentialRevocation", "CredentialRotationPrepare", "CredentialRotationPrepared", "CredentialRotationConfirm" ] }, "EdgeNodeHealth": { "enum": [ "Healthy", "Degraded", "Unhealthy" ] }, "EdgeNodeHeartbeat": { "required": [ "envelope", "health", "edgeRuntimeVersion", "apiVersion", "officialPlugins", "observedAtUtc", "lastAppliedTaskSequence", "lastReceiptSequence" ], "type": "object", "properties": { "envelope": { "$ref": "#/components/schemas/EdgeMessageEnvelope" }, "health": { "$ref": "#/components/schemas/EdgeNodeHealth" }, "edgeRuntimeVersion": { "type": "string" }, "apiVersion": { "type": "string" }, "officialPlugins": { "type": "array", "items": { "$ref": "#/components/schemas/EdgePluginObservation" } }, "observedAtUtc": { "type": "string", "format": "date-time" }, "lastAppliedTaskSequence": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "lastReceiptSequence": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "EdgeNodeRole": { "enum": [ "ApiHost", "PluginHost", "DeviceHub", "StoreNode", "BuildRunner" ] }, "EdgePluginLoadState": { "enum": [ "Installed", "Loaded", "Degraded", "Failed", "Disabled" ] }, "EdgePluginObservation": { "required": [ "pluginId", "version", "loadState", "healthCode" ], "type": "object", "properties": { "pluginId": { "type": "string" }, "version": { "type": "string" }, "loadState": { "$ref": "#/components/schemas/EdgePluginLoadState" }, "healthCode": { "type": "string" } } }, "EdgeRegistrationExchangeRequest": { "required": [ "envelope", "ticketId", "ticketProof", "nonce", "publicKeyAlgorithm", "publicKey", "requestedRoles", "edgeRuntimeVersion", "apiVersion", "requestedAtUtc" ], "type": "object", "properties": { "envelope": { "$ref": "#/components/schemas/EdgeMessageEnvelope" }, "ticketId": { "type": "string", "format": "uuid" }, "ticketProof": { "type": "string" }, "nonce": { "type": "string" }, "publicKeyAlgorithm": { "type": "string" }, "publicKey": { "type": "string" }, "requestedRoles": { "type": "array", "items": { "$ref": "#/components/schemas/EdgeNodeRole" } }, "edgeRuntimeVersion": { "type": "string" }, "apiVersion": { "type": "string" }, "requestedAtUtc": { "type": "string", "format": "date-time" } } }, "EdgeReplayRequest": { "required": [ "envelope", "requestedChannel", "lastContiguousSequence", "missingSequences", "maxMessages" ], "type": "object", "properties": { "envelope": { "$ref": "#/components/schemas/EdgeMessageEnvelope" }, "requestedChannel": { "$ref": "#/components/schemas/EdgeChannel" }, "lastContiguousSequence": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "missingSequences": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, "maxMessages": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "EdgeTaskKind": { "enum": [ "SynchronizeOfficialPlugin", "RotateDeviceCredential", "CollectGovernanceSnapshot", "RefreshGovernancePolicy" ] }, "EdgeTaskPayload": { "required": [ "$type" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/EdgeTaskPayloadSynchronizeOfficialPluginTaskPayload" }, { "$ref": "#/components/schemas/EdgeTaskPayloadRotateDeviceCredentialTaskPayload" }, { "$ref": "#/components/schemas/EdgeTaskPayloadCollectGovernanceSnapshotTaskPayload" }, { "$ref": "#/components/schemas/EdgeTaskPayloadRefreshGovernancePolicyTaskPayload" } ], "discriminator": { "propertyName": "$type", "mapping": { "synchronizeOfficialPlugin": "#/components/schemas/EdgeTaskPayloadSynchronizeOfficialPluginTaskPayload", "rotateDeviceCredential": "#/components/schemas/EdgeTaskPayloadRotateDeviceCredentialTaskPayload", "collectGovernanceSnapshot": "#/components/schemas/EdgeTaskPayloadCollectGovernanceSnapshotTaskPayload", "refreshGovernancePolicy": "#/components/schemas/EdgeTaskPayloadRefreshGovernancePolicyTaskPayload" } } }, "EdgeTaskPayloadCollectGovernanceSnapshotTaskPayload": { "required": [ "snapshotKinds", "maxItems" ], "properties": { "$type": { "enum": [ "collectGovernanceSnapshot" ], "type": "string" }, "snapshotKinds": { "type": "array", "items": { "$ref": "#/components/schemas/EdgeGovernanceSnapshotKind" } }, "maxItems": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "EdgeTaskPayloadRefreshGovernancePolicyTaskPayload": { "required": [ "policyVersion", "policySha256", "signingKeyId" ], "properties": { "$type": { "enum": [ "refreshGovernancePolicy" ], "type": "string" }, "policyVersion": { "type": "string" }, "policySha256": { "type": "string" }, "signingKeyId": { "type": "string" } } }, "EdgeTaskPayloadRotateDeviceCredentialTaskPayload": { "required": [ "newCredentialKeyId", "notBeforeUtc", "expiresAtUtc" ], "properties": { "$type": { "enum": [ "rotateDeviceCredential" ], "type": "string" }, "newCredentialKeyId": { "type": "string" }, "notBeforeUtc": { "type": "string", "format": "date-time" }, "expiresAtUtc": { "type": "string", "format": "date-time" } } }, "EdgeTaskPayloadSynchronizeOfficialPluginTaskPayload": { "required": [ "attemptId", "desiredRelease", "manifest", "expectedCurrentVersion", "requiresRestart", "policySha256" ], "properties": { "$type": { "enum": [ "synchronizeOfficialPlugin" ], "type": "string" }, "attemptId": { "type": "string", "format": "uuid" }, "desiredRelease": { "$ref": "#/components/schemas/OfficialPluginDesiredRelease" }, "manifest": { "$ref": "#/components/schemas/OfficialPluginReleaseManifest" }, "expectedCurrentVersion": { "type": [ "null", "string" ] }, "requiresRestart": { "type": "boolean" }, "policySha256": { "type": "string" } } }, "EdgeTaskReceipt": { "required": [ "envelope", "taskId", "taskSequence", "status", "outcomeCode", "resultHash", "startedAtUtc", "completedAtUtc", "retryable", "diagnosticCode" ], "type": "object", "properties": { "envelope": { "$ref": "#/components/schemas/EdgeMessageEnvelope" }, "taskId": { "type": "string", "format": "uuid" }, "taskSequence": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "status": { "$ref": "#/components/schemas/EdgeTaskReceiptStatus" }, "outcomeCode": { "type": "string" }, "resultHash": { "type": [ "null", "string" ] }, "startedAtUtc": { "type": "string", "format": "date-time" }, "completedAtUtc": { "type": [ "null", "string" ], "format": "date-time" }, "retryable": { "type": "boolean" }, "diagnosticCode": { "type": [ "null", "string" ] } } }, "EdgeTaskReceiptStatus": { "enum": [ "Accepted", "Rejected", "InProgress", "Succeeded", "Failed", "Expired", "Cancelled" ] }, "EnableMetadataExtensionOverlayApiRequest": { "required": [ "operationId", "package", "reason" ], "type": "object", "properties": { "operationId": { "type": "string", "format": "uuid" }, "package": { "$ref": "#/components/schemas/MetadataExtensionOverlayPackage" }, "reason": { "type": "string" } } }, "EvidenceRef": { "required": [ "kind", "code" ], "type": "object", "properties": { "kind": { "type": "string" }, "code": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "source": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EvidenceSourceRef" } ] } } }, "EvidenceSourceKind": { "type": "integer" }, "EvidenceSourceRef": { "required": [ "kind", "reference" ], "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/EvidenceSourceKind" }, "reference": { "type": "string" }, "locator": { "type": [ "null", "string" ] }, "observedAtUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "HumanCorrectionInput": { "required": [ "reasonCode" ], "type": "object", "properties": { "reasonCode": { "$ref": "#/components/schemas/HumanCorrectionReasonCode" }, "affectedFields": { "type": [ "null", "array" ], "items": { "type": "string" } }, "expectedValues": { }, "comment": { "type": [ "null", "string" ] } } }, "HumanCorrectionReasonCode": { "type": "integer" }, "IssueEdgeRegistrationTicketRequest": { "type": "object", "properties": { "lifetimeMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 10 } } }, "JsonElement": { }, "MetadataExtensionOverlayOperation": { "required": [ "operation", "targetPath", "value" ], "type": "object", "properties": { "operation": { "type": "string" }, "targetPath": { "type": "string" }, "value": { "$ref": "#/components/schemas/JsonElement" } } }, "MetadataExtensionOverlayPackage": { "required": [ "schemaVersion", "packageId", "packageVersion", "deploymentKey", "baseObjectId", "expectedBaseObjectVersion", "overlayKey", "priority", "operations" ], "type": "object", "properties": { "schemaVersion": { "type": "string" }, "packageId": { "type": "string" }, "packageVersion": { "type": "string" }, "deploymentKey": { "type": "string" }, "baseObjectId": { "type": "string", "format": "uuid" }, "expectedBaseObjectVersion": { "type": "string" }, "overlayKey": { "type": "string" }, "priority": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataExtensionOverlayOperation" } } } }, "OfficialPluginArtifact": { "required": [ "fileName", "mediaType", "sha256", "sizeBytes" ], "type": "object", "properties": { "fileName": { "type": "string" }, "mediaType": { "type": "string" }, "sha256": { "type": "string" }, "sizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "OfficialPluginCompatibility": { "required": [ "minimumHostVersion", "maximumHostVersionExclusive", "minimumEdgeRuntimeVersion", "maximumEdgeRuntimeVersionExclusive", "requiredCapabilities" ], "type": "object", "properties": { "minimumHostVersion": { "type": "string" }, "maximumHostVersionExclusive": { "type": [ "null", "string" ] }, "minimumEdgeRuntimeVersion": { "type": "string" }, "maximumEdgeRuntimeVersionExclusive": { "type": [ "null", "string" ] }, "requiredCapabilities": { "type": "array", "items": { "type": "string" } } } }, "OfficialPluginDesiredRelease": { "required": [ "releaseId", "pluginId", "version", "releaseDigest", "artifactSha256", "signingKeyId", "promotionId", "channel", "entitlementIds" ], "type": "object", "properties": { "releaseId": { "type": "string", "format": "uuid" }, "pluginId": { "type": "string" }, "version": { "type": "string" }, "releaseDigest": { "type": "string" }, "artifactSha256": { "type": "string" }, "signingKeyId": { "type": "string" }, "promotionId": { "type": "string", "format": "uuid" }, "channel": { "$ref": "#/components/schemas/OfficialPluginReleaseChannel" }, "entitlementIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "OfficialPluginReleaseChannel": { "type": "integer" }, "OfficialPluginReleaseManifest": { "required": [ "schemaVersion", "releaseId", "pluginId", "version", "publishedAtUtc", "expiresAtUtc", "package", "sbom", "compatibility", "rollback", "signingKeyId", "signatureAlgorithm", "signature" ], "type": "object", "properties": { "schemaVersion": { "type": "string" }, "releaseId": { "type": "string", "format": "uuid" }, "pluginId": { "type": "string" }, "version": { "type": "string" }, "publishedAtUtc": { "type": "string", "format": "date-time" }, "expiresAtUtc": { "type": "string", "format": "date-time" }, "package": { "$ref": "#/components/schemas/OfficialPluginArtifact" }, "sbom": { "$ref": "#/components/schemas/OfficialPluginSbom" }, "compatibility": { "$ref": "#/components/schemas/OfficialPluginCompatibility" }, "rollback": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OfficialPluginRollbackPlan" } ] }, "signingKeyId": { "type": "string" }, "signatureAlgorithm": { "type": "string" }, "signature": { "type": "string" } } }, "OfficialPluginRollbackPlan": { "required": [ "targetReleaseId", "targetVersion", "packageSha256", "healthTimeoutSeconds", "automaticRollbackAllowed" ], "type": "object", "properties": { "targetReleaseId": { "type": "string", "format": "uuid" }, "targetVersion": { "type": "string" }, "packageSha256": { "type": "string" }, "healthTimeoutSeconds": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "automaticRollbackAllowed": { "type": "boolean" } } }, "OfficialPluginSbom": { "required": [ "format", "specVersion", "sha256", "sizeBytes" ], "type": "object", "properties": { "format": { "type": "string" }, "specVersion": { "type": "string" }, "sha256": { "type": "string" }, "sizeBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } } }, "PlatformInitializationRequest": { "type": "object", "properties": { "includeDemoData": { "type": "boolean", "default": false }, "seedKeys": { "type": [ "null", "array" ], "items": { "type": "string" } }, "planHash": { "type": [ "null", "string" ] }, "confirmationText": { "type": [ "null", "string" ] }, "applyMigrations": { "type": "boolean", "default": true } } }, "PluginCenterOperationRequest": { "required": [ "pluginId", "version", "packageUrl", "sha256", "executeMigrations" ], "type": "object", "properties": { "pluginId": { "type": "string" }, "version": { "type": "string" }, "packageUrl": { "type": [ "null", "string" ] }, "sha256": { "type": [ "null", "string" ] }, "executeMigrations": { "type": "boolean" } } }, "PluginCenterVersionRequest": { "required": [ "pluginId", "version" ], "type": "object", "properties": { "pluginId": { "type": "string" }, "version": { "type": "string" } } }, "PluginInstallPlanRequest": { "required": [ "pluginId", "version", "packageUrl", "sha256" ], "type": "object", "properties": { "pluginId": { "type": "string" }, "version": { "type": "string" }, "packageUrl": { "type": [ "null", "string" ] }, "sha256": { "type": [ "null", "string" ] } } }, "PluginInstallRequest": { "required": [ "pluginId", "version", "packageUrl", "sha256", "executeMigrations" ], "type": "object", "properties": { "pluginId": { "type": "string" }, "version": { "type": "string" }, "packageUrl": { "type": [ "null", "string" ] }, "sha256": { "type": [ "null", "string" ] }, "executeMigrations": { "type": "boolean" } } }, "PluginVersionRequest": { "required": [ "pluginId", "version" ], "type": "object", "properties": { "pluginId": { "type": "string" }, "version": { "type": "string" } } }, "QueueCloudFleetTaskRequest": { "required": [ "taskKind", "notBeforeUtc", "expiresAtUtc", "expectedStateHash", "requiredCapabilities", "payload" ], "type": "object", "properties": { "taskKind": { "$ref": "#/components/schemas/EdgeTaskKind" }, "notBeforeUtc": { "type": "string", "format": "date-time" }, "expiresAtUtc": { "type": "string", "format": "date-time" }, "expectedStateHash": { "type": "string" }, "requiredCapabilities": { "type": "array", "items": { "type": "string" } }, "payload": { "$ref": "#/components/schemas/EdgeTaskPayload" } } }, "RejectBusinessActionDraftRequest": { "required": [ "rejectedBy", "reason", "correctionJson" ], "type": "object", "properties": { "rejectedBy": { "type": [ "null", "string" ] }, "reason": { "type": [ "null", "string" ] }, "correctionJson": { "type": [ "null", "string" ] }, "correction": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/HumanCorrectionInput" } ] } } }, "RevokeCloudFleetCredentialRequest": { "required": [ "reasonCode" ], "type": "object", "properties": { "reasonCode": { "type": "string" } } }, "RollbackMetadataExtensionOverlayApiRequest": { "required": [ "operationId", "deploymentKey", "baseObjectId", "overlayKey", "expectedPackageHash", "reason" ], "type": "object", "properties": { "operationId": { "type": "string", "format": "uuid" }, "deploymentKey": { "type": "string" }, "baseObjectId": { "type": "string", "format": "uuid" }, "overlayKey": { "type": "string" }, "expectedPackageHash": { "type": "string" }, "reason": { "type": "string" } } }, "SecurityPermissionManifestDto": { "required": [ "schemaVersion", "ownerPluginId", "deploymentKey", "permissions" ], "type": "object", "properties": { "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "ownerPluginId": { "type": "string" }, "deploymentKey": { "type": "string" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityPermissionPointDto" } } } }, "SecurityPermissionPointDto": { "required": [ "code", "name", "kind", "moduleCode", "menuCode", "routePath", "apiMethod", "apiPathPattern", "parentCode", "ownerPluginId", "source", "status", "props" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "moduleCode": { "type": "string" }, "menuCode": { "type": "string" }, "routePath": { "type": "string" }, "apiMethod": { "type": "string" }, "apiPathPattern": { "type": "string" }, "parentCode": { "type": "string" }, "ownerPluginId": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string" }, "props": { "type": "object" } } }, "SecuritySaveRoleGrantsRequest": { "required": [ "permissionCodes" ], "type": "object", "properties": { "permissionCodes": { "type": [ "null", "array" ], "items": { "type": "string" } } } } } }, "tags": [ { "name": "Observability" }, { "name": "Plugins" }, { "name": "PluginAssets" }, { "name": "Metadata" }, { "name": "Inventory" }, { "name": "Menu9303" }, { "name": "MobileUpdate" }, { "name": "Admin" }, { "name": "Authentication" }, { "name": "PluginCenter" }, { "name": "PluginAdmin" }, { "name": "MetadataExtensionOverlays" }, { "name": "PlatformInitialization" }, { "name": "AiProviderRoutes" }, { "name": "Security" }, { "name": "AiControlPlane" }, { "name": "Cloud Fleet" }, { "name": "Edge Control" } ] }