changedOutput schema / oneOf
Previous value: -[
- {
- "additionalProperties": false,
- "properties": {
- "correlationToken": {
- "type": "string"
- },
- "memberResults": {
- "description": "Each effective member's dispatch outcome when group control fans out. ACCEPTED confirms dispatch only; SUCCEEDED requires a correlated reply. Individual failures are retained.",
- "items": {
- "description": "One effective endpoint's outcome when a group command fans out to individual members.",
- "properties": {
- "endpointId": {
- "description": "The effective endpoint targeted by this dispatch.",
- "type": "string"
- },
- "error": {
- "description": "The one Port OS error shape, returned by every REST error response and every MCP tool error. `code` names the specific failure and `family` its broad class; both are closed enums, so clients branch on them and show `message`, which says what failed and what to do next.",
- "properties": {
- "code": {
- "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
- "enum": [
- "BAD_REQUEST",
- "UNAUTHORIZED",
- "FORBIDDEN",
- "INSUFFICIENT_SCOPE",
- "NOT_FOUND",
- "CONFLICT",
- "UNPROCESSABLE_ENTITY",
- "UNSUPPORTED_OPERATION",
- "TOO_MANY_REQUESTS",
- "SERVICE_UNAVAILABLE",
- "NOT_IMPLEMENTED",
- "INTERNAL",
- "CHECKSUM_MISMATCH",
- "FILE_TOO_LARGE",
- "STORAGE_UNAVAILABLE",
- "INSUFFICIENT_PERMISSIONS",
- "INVALID_FILE_TYPE",
- "QUOTA_EXCEEDED",
- "CONCURRENT_MODIFICATION",
- "ENDPOINT_UNREACHABLE",
- "BRIDGE_UNREACHABLE",
- "CLOUD_CONTROL_DISABLED",
- "ENDPOINT_BUSY",
- "ENDPOINT_LOW_POWER",
- "AUTHORIZATION_CREDENTIAL_INVALID",
- "AUTHORIZATION_CREDENTIAL_EXPIRED",
- "INVALID_DIRECTIVE",
- "INVALID_VALUE",
- "VALUE_OUT_OF_RANGE",
- "NOT_SUPPORTED_IN_CURRENT_MODE",
- "RATE_LIMIT_EXCEEDED",
- "PROVIDER_SERVICE_UNAVAILABLE",
- "PROVIDER_TIMEOUT",
- "PROVIDER_INTERNAL_ERROR",
- "INVALID_PROVIDER_RESPONSE",
- "OUTCOME_UNKNOWN",
- "PRECONDITION_FAILED",
- "AUTH_LINK_NOT_READY",
- "AUTH_LINK_NOT_DISCONNECTABLE",
- "PRECONDITION_REQUIRED",
- "IDEMPOTENCY_KEY_REQUIRED",
- "IDEMPOTENCY_KEY_REUSED",
- "IDEMPOTENCY_KEY_IN_FLIGHT",
- "IDEMPOTENCY_KEY_INVALID",
- "GROUP_MERGED",
- "MULTI_ROOM_UNSUPPORTED",
- "MAP_NOT_ACTIVE",
- "TARGET_UNSUPPORTED",
- "TARGET_AMBIGUOUS",
- "TARGET_GROUP_NOT_FOUND",
- "TARGET_GROUP_DISABLED",
- "DUPLICATE_TARGET_GROUP",
- "MESSAGE_UNSUPPORTED",
- "MESSAGE_AMBIGUOUS",
- "ENDPOINT_DISABLED",
- "ENDPOINT_ROUTE_CHANGED",
- "ENDPOINT_HAS_DEPENDENCIES",
- "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
- "ENDPOINT_COMMITTED_CLEANUP_PENDING",
- "DEEP_QUERY_FAILED",
- "PROVIDER_NO_STATE",
- "EVENT_MANAGEMENT_DISABLED",
- "SUBSCRIPTION_IDENTITY_IMMUTABLE",
- "UNSUPPORTED_MEDIA_TYPE",
- "EVENT_PAYLOAD_TOO_LARGE",
- "REQUEST_BODY_TOO_LARGE",
- "EVENT_IDENTITY_CONFLICT",
- "EVENT_INGRESS_QUOTA_EXCEEDED",
- "EVENT_RECEIPT_EXPIRED",
- "EVENT_STORAGE_UNAVAILABLE",
- "EVENT_DEAD_LETTER_NOT_FOUND",
- "EVENT_REDRIVE_CONFLICT",
- "EVENT_REDRIVE_EXPIRED",
- "RECEIPT_CONTEXT_EXPIRED",
- "EVENT_MAINTENANCE_INCOMPLETE",
- "UNKNOWN_INTERFACE",
- "INVALID_CONFIGURATION",
- "INVALID_PLUGIN_MANIFEST",
- "INVALID_ATTRIBUTE",
- "INVALID_PROVIDER_MESSAGE",
- "UNDECLARED_CAPABILITY",
- "PLUGIN_ROUTE_ID_CONFLICT",
- "UNRESOLVED_REFERENCE",
- "INVALID_RELATIONSHIP",
- "RELATIONSHIP_CYCLE",
- "MULTIPLE_PARENTS",
- "FLOW_VALIDATION_FAILED",
- "PROVIDER_SYNC_UNSUPPORTED"
- ],
- "type": "string"
- },
- "details": {
- "description": "Optional typed context for an error. Fields are additive and only populated when the error can safely expose that context to API clients.\n",
- "properties": {
- "actual": {
- "description": "String representation of the submitted value when the plugin can safely report it.",
- "type": "string"
- },
- "correlationId": {
- "description": "Provider or plugin correlation ID useful for support.",
- "type": "string"
- },
- "correlationToken": {
- "description": "Token that correlates an outcome-unknown dispatch with its eventual result.",
- "type": "string"
- },
- "currentMode": {
- "description": "Current endpoint mode when `code` is `NOT_SUPPORTED_IN_CURRENT_MODE`.",
- "type": "string"
- },
- "directive": {
- "description": "Message namespace and name or provider directive that failed.",
- "type": "string"
- },
- "discoveryEndpointId": {
- "description": "Port OS provider endpoint (type ENDPOINT_PLUGIN) of the connection to send `discover-routes` to when `code` is `TARGET_UNSUPPORTED` because the route must be rediscovered.",
- "type": "string"
- },
- "endpointId": {
- "description": "Port OS endpoint ID involved in the failed dispatch.",
- "type": "string"
- },
- "fieldErrors": {
- "description": "The request fields that were rejected, when the error is about the request's content.",
- "items": {
- "description": "One rejected request field of an error.",
- "properties": {
- "field": {
- "description": "Name or JSON path of the rejected field.",
- "type": "string"
- },
- "reason": {
- "description": "Why the field was rejected and what an accepted value looks like.",
- "type": "string"
- }
- },
- "required": [
- "field",
- "reason"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "maximum": {
- "description": "Maximum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
- "type": "number"
- },
- "minimum": {
- "description": "Minimum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
- "type": "number"
- },
- "parameter": {
- "description": "Request parameter or capability value that caused the failure.",
- "type": "string"
- },
- "pluginId": {
- "description": "Port OS plugin ID that reported the failure.",
- "type": "string"
- },
- "pluginRouteId": {
- "description": "Plugin-owned route identifier involved in the failed dispatch.",
- "type": "string"
- },
- "provider": {
- "description": "Third-party provider or bridge name that reported the failure.",
- "type": "string"
- },
- "providerCode": {
- "description": "The third-party provider's own error code, for support. It is opaque and provider-specific; branch on `code` and `family` instead.",
- "type": "string"
- },
- "retryAfterSeconds": {
- "description": "Suggested retry delay for rate-limit or provider-unavailable failures.",
- "minimum": 0,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "errors": {
- "description": "Every rejected item when a request that is validated item by item and applied atomically fails, such as a discovery `SynchronizationRequest` whose routes, group routes or relationships are rejected. Omitted for single-item failures.\n",
- "items": {
- "description": "One rejected discovery item of a `SynchronizationRequest`, keyed by the plugin-owned identity of the rejected item: `pluginRouteId` for a route or group route, or `relationshipExternalId` for a relationship. Exactly one of the two is set. It shares the `code`, `family`, `status` and `message` fields of `BatchItemError`; discovery items are keyed by plugin-owned identity because they carry no `requestId`. A request with any rejected item is rejected as a whole and lists every rejected item.\n",
- "properties": {
- "code": {
- "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
- "enum": [
- "BAD_REQUEST",
- "UNAUTHORIZED",
- "FORBIDDEN",
- "INSUFFICIENT_SCOPE",
- "NOT_FOUND",
- "CONFLICT",
- "UNPROCESSABLE_ENTITY",
- "UNSUPPORTED_OPERATION",
- "TOO_MANY_REQUESTS",
- "SERVICE_UNAVAILABLE",
- "NOT_IMPLEMENTED",
- "INTERNAL",
- "CHECKSUM_MISMATCH",
- "FILE_TOO_LARGE",
- "STORAGE_UNAVAILABLE",
- "INSUFFICIENT_PERMISSIONS",
- "INVALID_FILE_TYPE",
- "QUOTA_EXCEEDED",
- "CONCURRENT_MODIFICATION",
- "ENDPOINT_UNREACHABLE",
- "BRIDGE_UNREACHABLE",
- "CLOUD_CONTROL_DISABLED",
- "ENDPOINT_BUSY",
- "ENDPOINT_LOW_POWER",
- "AUTHORIZATION_CREDENTIAL_INVALID",
- "AUTHORIZATION_CREDENTIAL_EXPIRED",
- "INVALID_DIRECTIVE",
- "INVALID_VALUE",
- "VALUE_OUT_OF_RANGE",
- "NOT_SUPPORTED_IN_CURRENT_MODE",
- "RATE_LIMIT_EXCEEDED",
- "PROVIDER_SERVICE_UNAVAILABLE",
- "PROVIDER_TIMEOUT",
- "PROVIDER_INTERNAL_ERROR",
- "INVALID_PROVIDER_RESPONSE",
- "OUTCOME_UNKNOWN",
- "PRECONDITION_FAILED",
- "AUTH_LINK_NOT_READY",
- "AUTH_LINK_NOT_DISCONNECTABLE",
- "PRECONDITION_REQUIRED",
- "IDEMPOTENCY_KEY_REQUIRED",
- "IDEMPOTENCY_KEY_REUSED",
- "IDEMPOTENCY_KEY_IN_FLIGHT",
- "IDEMPOTENCY_KEY_INVALID",
- "GROUP_MERGED",
- "MULTI_ROOM_UNSUPPORTED",
- "MAP_NOT_ACTIVE",
- "TARGET_UNSUPPORTED",
- "TARGET_AMBIGUOUS",
- "TARGET_GROUP_NOT_FOUND",
- "TARGET_GROUP_DISABLED",
- "DUPLICATE_TARGET_GROUP",
- "MESSAGE_UNSUPPORTED",
- "MESSAGE_AMBIGUOUS",
- "ENDPOINT_DISABLED",
- "ENDPOINT_ROUTE_CHANGED",
- "ENDPOINT_HAS_DEPENDENCIES",
- "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
- "ENDPOINT_COMMITTED_CLEANUP_PENDING",
- "DEEP_QUERY_FAILED",
- "PROVIDER_NO_STATE",
- "EVENT_MANAGEMENT_DISABLED",
- "SUBSCRIPTION_IDENTITY_IMMUTABLE",
- "UNSUPPORTED_MEDIA_TYPE",
- "EVENT_PAYLOAD_TOO_LARGE",
- "REQUEST_BODY_TOO_LARGE",
- "EVENT_IDENTITY_CONFLICT",
- "EVENT_INGRESS_QUOTA_EXCEEDED",
- "EVENT_RECEIPT_EXPIRED",
- "EVENT_STORAGE_UNAVAILABLE",
- "EVENT_DEAD_LETTER_NOT_FOUND",
- "EVENT_REDRIVE_CONFLICT",
- "EVENT_REDRIVE_EXPIRED",
- "RECEIPT_CONTEXT_EXPIRED",
- "EVENT_MAINTENANCE_INCOMPLETE",
- "UNKNOWN_INTERFACE",
- "INVALID_CONFIGURATION",
- "INVALID_PLUGIN_MANIFEST",
- "INVALID_ATTRIBUTE",
- "INVALID_PROVIDER_MESSAGE",
- "UNDECLARED_CAPABILITY",
- "PLUGIN_ROUTE_ID_CONFLICT",
- "UNRESOLVED_REFERENCE",
- "INVALID_RELATIONSHIP",
- "RELATIONSHIP_CYCLE",
- "MULTIPLE_PARENTS",
- "FLOW_VALIDATION_FAILED",
- "PROVIDER_SYNC_UNSUPPORTED"
- ],
- "type": "string"
- },
- "family": {
- "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
- "enum": [
- "NOT_FOUND",
- "BAD_REQUEST",
- "UNAUTHORIZED",
- "FORBIDDEN",
- "CONFLICT",
- "GONE",
- "PRECONDITION_FAILED",
- "PRECONDITION_REQUIRED",
- "PAYLOAD_TOO_LARGE",
- "UNSUPPORTED_MEDIA_TYPE",
- "UNPROCESSABLE_ENTITY",
- "LOCKED",
- "TOO_MANY_REQUESTS",
- "BAD_GATEWAY",
- "SERVICE_UNAVAILABLE",
- "GATEWAY_TIMEOUT",
- "NOT_IMPLEMENTED",
- "INTERNAL_SERVER_ERROR",
- "REQUEST_INVALID",
- "AUTHENTICATION",
- "PERMISSION",
- "ENDPOINT_NOT_FOUND",
- "ENDPOINT_STATE_CONFLICT",
- "ENDPOINT_UNAVAILABLE",
- "RATE_LIMIT",
- "PROVIDER_BAD_RESPONSE",
- "PROVIDER_UNAVAILABLE",
- "PROVIDER_TIMEOUT"
- ],
- "type": "string"
- },
- "interface": {
- "description": "Canonical capability interface name the failure applies to, when the failure is interface-specific.",
- "type": "string"
- },
- "message": {
- "description": "Plain-language description of the failure and the suggested fix.",
- "type": "string"
- },
- "pluginRouteId": {
- "description": "Plugin-owned identifier of the rejected route or group route. Set unless the item is a relationship.",
- "type": "string"
- },
- "relationshipExternalId": {
- "description": "Plugin-owned `externalId` of the rejected relationship. Set only for relationship items.",
- "type": "string"
- },
- "status": {
- "description": "HTTP-equivalent status code of the item failure.",
- "maximum": 599,
- "minimum": 400,
- "type": "integer"
- },
- "version": {
- "description": "Declared capability interface version the failure applies to, when the failure is interface-specific.",
- "type": "string"
- }
- },
- "required": [
- "code",
- "family",
- "status",
- "message"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "family": {
- "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
- "enum": [
- "NOT_FOUND",
- "BAD_REQUEST",
- "UNAUTHORIZED",
- "FORBIDDEN",
- "CONFLICT",
- "GONE",
- "PRECONDITION_FAILED",
- "PRECONDITION_REQUIRED",
- "PAYLOAD_TOO_LARGE",
- "UNSUPPORTED_MEDIA_TYPE",
- "UNPROCESSABLE_ENTITY",
- "LOCKED",
- "TOO_MANY_REQUESTS",
- "BAD_GATEWAY",
- "SERVICE_UNAVAILABLE",
- "GATEWAY_TIMEOUT",
- "NOT_IMPLEMENTED",
- "INTERNAL_SERVER_ERROR",
- "REQUEST_INVALID",
- "AUTHENTICATION",
- "PERMISSION",
- "ENDPOINT_NOT_FOUND",
- "ENDPOINT_STATE_CONFLICT",
- "ENDPOINT_UNAVAILABLE",
- "RATE_LIMIT",
- "PROVIDER_BAD_RESPONSE",
- "PROVIDER_UNAVAILABLE",
- "PROVIDER_TIMEOUT"
- ],
- "type": "string"
- },
- "message": {
- "description": "Plain-language description of the failure and the suggested next action.",
- "type": "string"
- }
- },
- "required": [
- "family",
- "code",
- "message"
- ],
- "type": "object"
- },
- "message": {
- "description": "The message that was responded with when there was a unary message response, exactly one of the outbound capability messages. A synchronous send can return one; an acknowledgment with no message back leaves this empty. The header namespace, name and version select the variant and the body schema.",
- "oneOf": [
- {
- "description": "The `authorization-established` message (version 1.0) of the `port1/systems/zero/capability-interfaces/authorization` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The authorization established message is sent to a plugin to indicate that the plugin has been installed and authorized for a principal",
- "properties": {
- "authlinkId": {
- "description": "The id of the authorized link between the principal and the plugin",
- "type": "string"
- },
- "pluginAccessToken": {
- "description": "The access token of the authorization link representing the principal as understood by the plugin",
- "type": "string"
- },
- "portosAccessToken": {
- "description": "The access token of the authorization link representing the principala as understood by port OS",
- "type": "string"
- }
- },
- "required": [
- "portosAccessToken",
- "authlinkId"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "authorization-established"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/authorization"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `authorization-update-report` message (version 1.0) of the `port1/systems/zero/capability-interfaces/authorization` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Report refreshed credentials for an authorization, including the new access token, refresh token and expiry time.",
- "properties": {
- "accessToken": {
- "description": "The access token to refresh",
- "type": "string"
- },
- "authlinkId": {
- "description": "The id of the auth link to update",
- "type": "string"
- },
- "customMetadata": {
- "additionalProperties": true,
- "description": "Custom metadata to attach to the authorization update report",
- "type": "object"
- },
- "expiryTime": {
- "description": "The expiry time in seconds from current time",
- "format": "int64",
- "type": "integer"
- },
- "refreshToken": {
- "description": "The refresh token to refresh",
- "type": "string"
- },
- "secretId": {
- "description": "The id of the secret to update",
- "type": "string"
- }
- },
- "required": [
- "refreshToken",
- "accessToken",
- "expiryTime"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "authorization-update-report"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/authorization"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `authorization-status` message (version 1.0) of the `port1/systems/zero/capability-interfaces/authorization-requirements` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Redacted saved authorization status. Contains no pattern, PIN or ciphertext.",
- "properties": {
- "requirementId": {
- "type": "string"
- },
- "status": {
- "enum": [
- "MISSING",
- "CONFIGURED",
- "NEEDS_UPDATE"
- ],
- "type": "string"
- }
- },
- "required": [
- "requirementId",
- "status"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "authorization-status"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/authorization-requirements"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `list-events-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/calendar-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Response containing a list of events from a calendar provider",
- "properties": {
- "events": {
- "items": {
- "description": "A calendar event",
- "properties": {
- "allDay": {
- "type": "boolean"
- },
- "description": {
- "type": "string"
- },
- "eventId": {
- "type": "string"
- },
- "location": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- },
- "required": [
- "eventId"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "events"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "list-events-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/calendar-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `event-image-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/camera` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Event image URL and provider token returned for a get-event-image request.",
- "properties": {
- "token": {
- "type": "string"
- },
- "url": {
- "format": "uri",
- "type": "string"
- }
- },
- "required": [
- "url",
- "token"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "event-image-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/camera"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `list-contacts-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/contacts-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Response containing a list of contacts from a contacts provider",
- "properties": {
- "contacts": {
- "items": {
- "description": "A contact entry",
- "properties": {
- "companyName": {
- "type": "string"
- },
- "contactId": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- }
- },
- "required": [
- "contactId"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "contacts"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "list-contacts-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/contacts-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `group-routes-changed` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-route-groups-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Confirmed provider state after a group create, delete, membership change or rename. Both arrays are explicit read-back data from the provider, scoped to the authenticated publisher's provider account. Include the full current state of every affected surviving group route, including source groups changed by exclusive membership. Report retired routes only in retiredPluginRouteIds. Unrelated group routes are unchanged; this is not a complete account listing.",
- "properties": {
- "groupRoutes": {
- "description": "Full current provider state of every affected surviving group route.",
- "items": {
- "description": "A provider-reported group route (for example a vacuum map or room, a lighting room or a speaker group) as carried by discovery. It is shared by the route-discovery report message and `SynchronizationRequest.groupRoutes` so both decode to the same model.\n",
- "properties": {
- "interfaces": {
- "items": {
- "properties": {
- "attributes": {
- "description": "Supported attribute subset. An omitted or empty list declares no supported attributes.",
- "items": {
- "properties": {
- "name": {
- "description": "The name of the attribute",
- "type": "string"
- },
- "value": {
- "additionalProperties": true,
- "description": "the value of the attribute, this is an opaque resource object, so it can be any type of struct.",
- "type": "object"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "configuration": {
- "additionalProperties": true,
- "description": "The configuration of the interface",
- "type": "object"
- },
- "messages": {
- "description": "Supported inbound message subset for the declared interface version. An omitted or empty list declares no supported messages; null also declares none. A supplied array contains distinct canonical names for implemented messages.",
- "items": {
- "properties": {
- "name": {
- "description": "The name of the command",
- "type": "string"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "name": {
- "description": "The name of the interface",
- "type": "string"
- },
- "version": {
- "description": "the version of the interface",
- "type": "string"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "memberPluginRouteIds": {
- "description": "Full current native membership; an empty array explicitly reports an empty route.",
- "items": {
- "type": "string"
- },
- "type": "array",
- "uniqueItems": true
- },
- "name": {
- "description": "The name of the associated group route",
- "type": "string"
- },
- "ontologicalTypes": {
- "description": "Actual classifications of the native group route, constrained by its selected plugin profile for V2 discovery.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pluginCustomMetadata": {
- "additionalProperties": true,
- "description": "Private plugin metadata (native map, segment or cloud room addressing) returned to the plugin on dispatch; never exposed as application data. A route declaring the canonical SPATIAL geometry capability can carry a valid SpatialInterfaceGeometryAttribute in geometry. Only that canonical geometry's observedAt is observation time rather than a meaningful group-etag contribution; it is still stored. Geometry shape, frame, native context and all other metadata remain meaningful.\n",
- "type": "object"
- },
- "pluginProfileId": {
- "description": "Stable group-route profile ID selected from the registered V2 plugin declaration.",
- "minLength": 1,
- "type": "string"
- },
- "pluginRouteId": {
- "description": "Plugin-owned stable identifier of the group route. Must be unique across routes and group routes within one plugin and auth link.\n",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "pluginRouteId",
- "name",
- "pluginProfileId",
- "ontologicalTypes",
- "interfaces",
- "memberPluginRouteIds"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "retiredPluginRouteIds": {
- "description": "Provider-native pluginRouteIds of affected group routes confirmed absent after the mutation, including a delete whose target was already absent.",
- "items": {
- "minLength": 1,
- "type": "string"
- },
- "type": "array",
- "uniqueItems": true
- }
- },
- "required": [
- "groupRoutes",
- "retiredPluginRouteIds"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "group-routes-changed"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/control-route-groups-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `acknowledged` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Response to acknowledge a message was dispatched, it confirms that a message was dispatched, but not necessarily that it did anything. Consider this to happen on any infrared based device (TV remotes), where no ack is feasible.",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "acknowledged"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/control-routes-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `attribute-report` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Response to report attributes of a control route",
- "properties": {
- "items": {
- "items": {
- "description": "A control route item with associated plugin route and attributes",
- "properties": {
- "associatedPluginRouteId": {
- "type": "string"
- },
- "attributes": {
- "items": {
- "properties": {
- "name": {
- "description": "The name of the attribute",
- "type": "string"
- },
- "namespace": {
- "description": "The namespace of the attribute",
- "type": "string"
- },
- "sampledAt": {
- "description": "Actual observation time in UTC; omit when unknown. Request time is not a sample time.",
- "format": "date-time",
- "type": "string"
- },
- "value": {
- "description": "The value of the attribute",
- "type": "object"
- },
- "version": {
- "description": "The version of the attribute",
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version",
- "value"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "unavailableAttributes": {
- "description": "Exact attributes freshly found unavailable by a successful correlated native-group report-attributes read. Presence, including an empty list, is unsupported for endpoint, capability-query, proactive or uncorrelated reports. These identities carry no value or sample time; omission is not an unavailable acknowledgement. Upgrade consuming hosts before providers emit this field.",
- "items": {
- "description": "The exact identity of an attribute requested from a provider, without an observed value.",
- "properties": {
- "name": {
- "minLength": 1,
- "type": "string"
- },
- "namespace": {
- "minLength": 1,
- "type": "string"
- },
- "version": {
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "type": "object"
- },
- "type": "array",
- "uniqueItems": true
- }
- },
- "required": [
- "associatedPluginRouteId",
- "attributes"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "items"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "attribute-report"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/control-routes-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `deferred-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Response to acknowledge a message was dispatched, it confirms that a message was dispatched, and that a confirmation of the result will be sent later on. We generate this message when the device is expected to respond some time later on, and we need to wait for the result. For the default behavior, we expect to wait up to a minute to handle low powered devices.",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "deferred-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/control-routes-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `error-dispatch` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Response to acknowledge a message was dispatched, it confirms that a message was dispatched, and that the result was not successful.",
- "properties": {
- "error": {
- "description": "An error from a dispatch operation",
- "properties": {
- "code": {
- "description": "The code of the error, an opaque error code that can be given for debugging purposes.",
- "type": "string"
- },
- "family": {
- "description": "The family of the error, an enum which denotes a general set of issues similar to the http error set. Some examples are BAD_REQUEST, SYSTEM_ERROR, etc.",
- "type": "string"
- },
- "message": {
- "description": "The message of the error, a human readable message that describes the error.",
- "type": "string"
- },
- "type": {
- "description": "The type of the error, an enum which denotes a specific type of error that belongs to a family of errors.",
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "error-dispatch"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/control-routes-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `successful-dispatch` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Response to acknowledge a message was successfully dispatched, it confirms that a message was dispatched, and that the result was successful.",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "successful-dispatch"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/control-routes-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `chime` message (version 1.0) of the `port1/systems/zero/capability-interfaces/doorbell` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "A distinct doorbell press. A chime does not imply a door was opened.",
- "properties": {
- "value": {
- "enum": [
- "PRESSED"
- ],
- "type": "string"
- }
- },
- "required": [
- "value"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "chime"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/doorbell"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `embedding-uri` message (version 1.0) of the `port1/systems/zero/capability-interfaces/embedding-generation` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The result of an embedding request: the location, format and MIME type of the generated embedding.",
- "properties": {
- "format": {
- "description": "Format of the embedding (e.g., safetensors, onnx)",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type of the embedding resource",
- "type": "string"
- },
- "uri": {
- "description": "URL of the generated embedding resource",
- "type": "string"
- }
- },
- "required": [
- "uri"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "embedding-uri"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/embedding-generation"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `endpoint-updated` message (version 1.0) of the `port1/systems/zero/capability-interfaces/endpoint-registry` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Port OS emitted a durable endpoint metadata or enablement change. Delivery is best effort.",
- "properties": {
- "enablement": {
- "description": "Whether Port OS permits messages to be sent to this endpoint.",
- "enum": [
- "ENABLED",
- "DISABLED"
- ],
- "type": "string"
- },
- "endpointId": {
- "description": "Full Port OS endpoint identifier.",
- "type": "string"
- },
- "name": {
- "description": "Current endpoint name.",
- "type": "string"
- },
- "type": {
- "description": "Current ontological endpoint type.",
- "type": "string"
- }
- },
- "required": [
- "endpointId",
- "name",
- "type",
- "enablement"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "endpoint-updated"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/endpoint-registry"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `person-detected` message (version 1.0) of the `port1/systems/zero/capability-interfaces/event-detection-sensor` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "A distinct person detection occurrence, independent of cached presence state.",
- "properties": {
- "value": {
- "enum": [
- "DETECTED"
- ],
- "type": "string"
- }
- },
- "required": [
- "value"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "person-detected"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/event-detection-sensor"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `delete-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The provider confirmed deletion of the requested file.",
- "title": "FilesystemProviderInterfaceDeleteFileResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "delete-file-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/filesystem-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `download-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Download file response.",
- "properties": {
- "expiresAt": {
- "description": "Expiration of the download URL, if supplied by the provider.",
- "format": "date-time",
- "type": "string"
- },
- "uri": {
- "description": "Provider URL for downloading the file.",
- "format": "uri",
- "type": "string"
- }
- },
- "required": [
- "uri"
- ],
- "title": "FilesystemProviderInterfaceDownloadFileResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "download-file-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/filesystem-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `list-albums-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Response containing a list of photo albums from a filesystem provider",
- "properties": {
- "albums": {
- "items": {
- "description": "A photo album",
- "properties": {
- "albumId": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "photoCount": {
- "type": "integer"
- }
- },
- "required": [
- "albumId"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "nextCursor": {
- "description": "Opaque cursor for the next page; omitted when there are no further results.",
- "type": "string"
- }
- },
- "required": [
- "albums"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "list-albums-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/filesystem-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `list-folder-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Response containing a list of files and folders from a filesystem provider",
- "properties": {
- "folderId": {
- "description": "Current folder identifier, including the provider root when returned. Use it as a destination for upload or move.",
- "type": "string"
- },
- "items": {
- "items": {
- "description": "A cloud storage item (file or folder)",
- "properties": {
- "extension": {
- "type": "string"
- },
- "itemId": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "size": {
- "description": "File size in bytes",
- "format": "int64",
- "type": "integer"
- },
- "type": {
- "description": "Item type: FILE, FOLDER, or APP_LIBRARY",
- "type": "string"
- }
- },
- "required": [
- "name",
- "type"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "nextCursor": {
- "description": "Opaque cursor for the next page; omitted when there are no further results.",
- "type": "string"
- }
- },
- "required": [
- "items"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "list-folder-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/filesystem-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `move-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Verified file selection after the operation; use this fileId for subsequent reads or writes.",
- "properties": {
- "fileId": {
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "fileId"
- ],
- "title": "FilesystemProviderInterfaceMoveFileResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "move-file-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/filesystem-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `rename-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Verified file selection after the operation; use this fileId for subsequent reads or writes.",
- "properties": {
- "fileId": {
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "fileId"
- ],
- "title": "FilesystemProviderInterfaceRenameFileResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "rename-file-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/filesystem-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `upload-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Upload file response.",
- "properties": {
- "fileId": {
- "description": "Provider identifier of the uploaded file.",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "fileId"
- ],
- "title": "FilesystemProviderInterfaceUploadFileResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "upload-file-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/filesystem-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `complete` message (version 1.0) of the `port1/systems/zero/capability-interfaces/flows` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Reports that a flow has finished, with its completion status, result and duration.",
- "properties": {
- "duration": {
- "description": "Total execution duration in milliseconds",
- "minimum": 0,
- "type": "number"
- },
- "flowId": {
- "description": "Unique identifier for the completed flow",
- "minLength": 1,
- "type": "string"
- },
- "metadata": {
- "additionalProperties": true,
- "description": "Additional metadata for the completion",
- "type": "object"
- },
- "result": {
- "additionalProperties": true,
- "description": "Flow execution result",
- "type": "object"
- },
- "status": {
- "description": "Completion status",
- "enum": [
- "SUCCESS",
- "FAILURE",
- "CANCELLED",
- "TIMEOUT"
- ],
- "type": "string"
- }
- },
- "required": [
- "flowId",
- "status",
- "duration"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "complete"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/flows"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `message-ack` message (version 1.0) of the `port1/systems/zero/capability-interfaces/flows` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Reports that a flow message was acknowledged.",
- "properties": {
- "ackId": {
- "description": "Unique identifier for this acknowledgment",
- "minLength": 1,
- "type": "string"
- },
- "flowId": {
- "description": "Unique identifier for the flow",
- "minLength": 1,
- "type": "string"
- },
- "messageId": {
- "description": "Unique identifier for the acknowledged message",
- "minLength": 1,
- "type": "string"
- },
- "metadata": {
- "additionalProperties": true,
- "description": "Additional metadata for the acknowledgment",
- "type": "object"
- },
- "status": {
- "description": "Acknowledgment status",
- "enum": [
- "RECEIVED",
- "PROCESSED",
- "FAILED"
- ],
- "type": "string"
- },
- "timestamp": {
- "description": "Acknowledgment timestamp",
- "format": "date-time",
- "type": "string"
- }
- },
- "required": [
- "flowId",
- "messageId",
- "ackId",
- "status",
- "timestamp"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "message-ack"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/flows"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `message-unack` message (version 1.0) of the `port1/systems/zero/capability-interfaces/flows` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Reports that a flow message was not acknowledged, with the reason.",
- "properties": {
- "flowId": {
- "description": "Unique identifier for the flow",
- "minLength": 1,
- "type": "string"
- },
- "messageId": {
- "description": "Unique identifier for the unacknowledged message",
- "minLength": 1,
- "type": "string"
- },
- "metadata": {
- "additionalProperties": true,
- "description": "Additional metadata for the unacknowledgment",
- "type": "object"
- },
- "reason": {
- "description": "Reason for unacknowledgment",
- "enum": [
- "TIMEOUT",
- "ERROR",
- "REJECTED",
- "DUPLICATE"
- ],
- "type": "string"
- },
- "timestamp": {
- "description": "Unacknowledgment timestamp",
- "format": "date-time",
- "type": "string"
- },
- "unackId": {
- "description": "Unique identifier for this unacknowledgment",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "flowId",
- "messageId",
- "unackId",
- "reason",
- "timestamp"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "message-unack"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/flows"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `node-complete` message (version 1.0) of the `port1/systems/zero/capability-interfaces/flows` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Reports that a node in a flow has finished, with its status, result and the nodes that run next.",
- "properties": {
- "duration": {
- "description": "Node execution duration in milliseconds",
- "minimum": 0,
- "type": "number"
- },
- "flowId": {
- "description": "Unique identifier for the flow",
- "minLength": 1,
- "type": "string"
- },
- "metadata": {
- "additionalProperties": true,
- "description": "Additional metadata for the node completion",
- "type": "object"
- },
- "nextNodes": {
- "description": "List of next node IDs to execute",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "nodeId": {
- "description": "Unique identifier for the completed node",
- "minLength": 1,
- "type": "string"
- },
- "result": {
- "additionalProperties": true,
- "description": "Node execution result",
- "type": "object"
- },
- "status": {
- "description": "Node completion status",
- "enum": [
- "SUCCESS",
- "FAILURE",
- "SKIPPED",
- "TIMEOUT"
- ],
- "type": "string"
- }
- },
- "required": [
- "flowId",
- "nodeId",
- "status",
- "duration"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "node-complete"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/flows"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `image-generated` message (version 1.0) of the `port1/systems/zero/capability-interfaces/image-generation` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The image produced by generate-image, as a short-lived URL or inline base64 according to the responseFormat of the request",
- "properties": {
- "image": {
- "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
- "properties": {
- "byteLength": {
- "description": "Size of the decoded bytes. Always present on host responses.",
- "maximum": 26214400,
- "minimum": 1,
- "type": "integer"
- },
- "data": {
- "description": "Base64 encoded bytes, at most 10 MiB decoded.",
- "format": "byte",
- "maxLength": 13981016,
- "type": "string"
- },
- "durationMs": {
- "description": "Duration of audio in milliseconds, when known.",
- "minimum": 0,
- "type": "integer"
- },
- "expiresAt": {
- "description": "When `url` stops working. Present with `url` on host responses.",
- "format": "date-time",
- "type": "string"
- },
- "height": {
- "description": "Image height in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- },
- "mimeType": {
- "description": "The media type of the bytes.",
- "enum": [
- "audio/mpeg",
- "audio/wav",
- "audio/ogg",
- "audio/flac",
- "image/png",
- "image/jpeg",
- "image/webp"
- ],
- "type": "string"
- },
- "url": {
- "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
- "type": "string"
- },
- "width": {
- "description": "Image width in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- }
- },
- "required": [
- "mimeType"
- ],
- "type": "object"
- }
- },
- "required": [
- "image"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "image-generated"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/image-generation"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `audio` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-player` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Audio data the player sends, with the stream ID, sequence, and whether it is the final chunk.",
- "properties": {
- "audioData": {
- "description": "Base64 encoded audio data",
- "format": "base64",
- "type": "string"
- },
- "duration": {
- "description": "Audio duration in seconds",
- "minimum": 0,
- "type": "number"
- },
- "isFinal": {
- "default": false,
- "description": "Whether the audio is the final chunk",
- "type": "boolean"
- },
- "mimeType": {
- "default": "audio/ogg",
- "description": "Audio MIME type",
- "type": "string"
- },
- "rawBytes": {
- "description": "Audio raw bytes",
- "format": "binary",
- "type": "string"
- },
- "sequenceId": {
- "description": "Number of audio channels",
- "type": "integer"
- },
- "streamId": {
- "default": "default",
- "description": "Audio stream ID",
- "type": "string"
- },
- "text": {
- "default": "",
- "description": "Audio text",
- "type": "string"
- }
- },
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "audio"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/media-player"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `audio-stream` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-player` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "A chunk of an audio stream the player sends, with its stream ID and sequence, and whether it is the final chunk.",
- "properties": {
- "audioData": {
- "description": "Base64 encoded audio data",
- "format": "base64",
- "type": "string"
- },
- "isFinal": {
- "default": false,
- "description": "Whether this is the final chunk in the stream",
- "type": "boolean"
- },
- "rawBytes": {
- "description": "Audio raw bytes",
- "format": "binary",
- "type": "string"
- },
- "sequenceId": {
- "description": "Sequence ID for this audio stream",
- "minimum": 0,
- "type": "integer"
- },
- "streamId": {
- "description": "Unique identifier for this audio stream",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "streamId",
- "sequenceId",
- "isFinal"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "audio-stream"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/media-player"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `playlist-contents` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-playlist` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "A bounded playlist page containing playable tracks or episodes.",
- "properties": {
- "episodes": {
- "items": {
- "description": "Provider-qualified podcast episode with selection metadata.",
- "properties": {
- "id": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- },
- "name": {
- "minLength": 1,
- "type": "string"
- },
- "releaseDate": {
- "description": "Provider release date; precision can be year, month or day.",
- "type": "string"
- },
- "releaseDatePrecision": {
- "description": "Provider date precision.",
- "type": "string"
- },
- "showId": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "nextToken": {
- "minLength": 1,
- "type": "string"
- },
- "playlistId": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- },
- "tracks": {
- "items": {
- "description": "Track information",
- "properties": {
- "album": {
- "allOf": [
- {
- "description": "Album information",
- "properties": {
- "artists": {
- "description": "Album artists",
- "items": {
- "description": "Artist information",
- "properties": {
- "id": {
- "description": "Unique identifier for the artist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Artist name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "id": {
- "description": "Unique identifier for the album",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Album name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "artists"
- ],
- "type": "object"
- }
- ],
- "description": "Track album when supplied by the provider. Omitted for sources such as YouTube videos that do not supply album metadata."
- },
- "artists": {
- "description": "Track artists",
- "items": {
- "description": "Artist information",
- "properties": {
- "id": {
- "description": "Unique identifier for the artist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Artist name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "id": {
- "description": "Unique identifier for the track",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Track name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "artists"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "playlistId",
- "tracks",
- "episodes"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "playlist-contents"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/media-playlist"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `playlist-mutation-result` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-playlist` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Provider acknowledgement for one playlist mutation. Re-read contents to verify the requested outcome. A partial result must not be retried automatically.",
- "properties": {
- "applied": {
- "description": "Whether all requested steps were acknowledged. False can mean playlist creation succeeded but initial track insertion did not.",
- "type": "boolean"
- },
- "detail": {
- "type": "string"
- },
- "playlistId": {
- "minLength": 1,
- "type": "string"
- },
- "snapshotId": {
- "description": "Provider revision acknowledging the change, when returned.",
- "type": "string"
- }
- },
- "required": [
- "playlistId",
- "applied"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "playlist-mutation-result"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/media-playlist"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `playlists` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-playlist` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "A page of the connected customer's playlists with exact resource IDs.",
- "properties": {
- "nextToken": {
- "minLength": 1,
- "type": "string"
- },
- "playlists": {
- "items": {
- "properties": {
- "id": {
- "description": "Unique identifier for the playlist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Playlist name",
- "minLength": 1,
- "type": "string"
- },
- "ownerId": {
- "description": "Provider-scoped owner identity, when supplied by the provider.",
- "type": "string"
- },
- "ownerName": {
- "description": "Owner display name, useful for distinguishing owned and followed playlists.",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "playlists"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "playlists"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/media-playlist"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `queue-contents` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-queue` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Observed queue items in playback order, including intentional duplicates. This is a point-in-time provider observation; it is not a saved playlist or proof of audible output.",
- "properties": {
- "complete": {
- "description": "True only when these items describe the whole upcoming queue. False means the provider supplies a bounded window without a continuation cursor; do not treat omitted items as absent.",
- "type": "boolean"
- },
- "currentMediaId": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- },
- "mediaIds": {
- "description": "Upcoming media IDs in provider playback order. The currently playing item is separate.",
- "items": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- },
- "type": "array"
- },
- "queueVersion": {
- "description": "Opaque queue revision for conditional edits when the route requires it. A revision describes hosted contents, not audible playback or player refresh completion.",
- "maxLength": 256,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "mediaIds",
- "complete"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "queue-contents"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/media-queue"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `audio-media-results` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-search` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The results of an audio search: matching artists, albums, tracks, playlists, shows and episodes.",
- "properties": {
- "albums": {
- "description": "Album results",
- "items": {
- "description": "Album information",
- "properties": {
- "artists": {
- "description": "Album artists",
- "items": {
- "description": "Artist information",
- "properties": {
- "id": {
- "description": "Unique identifier for the artist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Artist name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "id": {
- "description": "Unique identifier for the album",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Album name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "artists"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "artists": {
- "description": "Artist results",
- "items": {
- "description": "Artist information",
- "properties": {
- "id": {
- "description": "Unique identifier for the artist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Artist name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "episodes": {
- "items": {
- "description": "Provider-qualified podcast episode with selection metadata.",
- "properties": {
- "id": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- },
- "name": {
- "minLength": 1,
- "type": "string"
- },
- "releaseDate": {
- "description": "Provider release date; precision can be year, month or day.",
- "type": "string"
- },
- "releaseDatePrecision": {
- "description": "Provider date precision.",
- "type": "string"
- },
- "showId": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "nextToken": {
- "description": "Opaque continuation for the same search; omit when exhausted.",
- "minLength": 1,
- "type": "string"
- },
- "playlists": {
- "description": "Playlist results",
- "items": {
- "properties": {
- "id": {
- "description": "Unique identifier for the playlist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Playlist name",
- "minLength": 1,
- "type": "string"
- },
- "ownerId": {
- "description": "Provider-scoped owner identity, when supplied by the provider.",
- "type": "string"
- },
- "ownerName": {
- "description": "Owner display name, useful for distinguishing owned and followed playlists.",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "shows": {
- "items": {
- "description": "Provider-qualified podcast series; read episodes before playback.",
- "properties": {
- "id": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- },
- "name": {
- "minLength": 1,
- "type": "string"
- },
- "publisher": {
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "tracks": {
- "description": "Track results",
- "items": {
- "description": "Track information",
- "properties": {
- "album": {
- "allOf": [
- {
- "description": "Album information",
- "properties": {
- "artists": {
- "description": "Album artists",
- "items": {
- "description": "Artist information",
- "properties": {
- "id": {
- "description": "Unique identifier for the artist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Artist name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "id": {
- "description": "Unique identifier for the album",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Album name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "artists"
- ],
- "type": "object"
- }
- ],
- "description": "Track album when supplied by the provider. Omitted for sources such as YouTube videos that do not supply album metadata."
- },
- "artists": {
- "description": "Track artists",
- "items": {
- "description": "Artist information",
- "properties": {
- "id": {
- "description": "Unique identifier for the artist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Artist name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "id": {
- "description": "Unique identifier for the track",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Track name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "artists"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "artists",
- "albums",
- "tracks",
- "playlists"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "audio-media-results"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/media-search"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `media-details` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-search` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Exact media resource details and a bounded page of its children.",
- "properties": {
- "episodes": {
- "items": {
- "description": "Provider-qualified podcast episode with selection metadata.",
- "properties": {
- "id": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- },
- "name": {
- "minLength": 1,
- "type": "string"
- },
- "releaseDate": {
- "description": "Provider release date; precision can be year, month or day.",
- "type": "string"
- },
- "releaseDatePrecision": {
- "description": "Provider date precision.",
- "type": "string"
- },
- "showId": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "mediaId": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "nextToken": {
- "minLength": 1,
- "type": "string"
- },
- "resourceKind": {
- "description": "Provider resource kind from the media URI.",
- "type": "string"
- },
- "tracks": {
- "items": {
- "description": "Track information",
- "properties": {
- "album": {
- "allOf": [
- {
- "description": "Album information",
- "properties": {
- "artists": {
- "description": "Album artists",
- "items": {
- "description": "Artist information",
- "properties": {
- "id": {
- "description": "Unique identifier for the artist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Artist name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "id": {
- "description": "Unique identifier for the album",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Album name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "artists"
- ],
- "type": "object"
- }
- ],
- "description": "Track album when supplied by the provider. Omitted for sources such as YouTube videos that do not supply album metadata."
- },
- "artists": {
- "description": "Track artists",
- "items": {
- "description": "Artist information",
- "properties": {
- "id": {
- "description": "Unique identifier for the artist",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Artist name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "id": {
- "description": "Unique identifier for the track",
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "description": "Track name",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "artists"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "mediaId",
- "resourceKind"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "media-details"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/media-search"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `models-listed` message (version 1.0) of the `port1/systems/zero/capability-interfaces/model-catalog` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The models matching query-models",
- "properties": {
- "models": {
- "items": {
- "description": "One model offered for one capability interface, with the configuration it supports and how to prompt it. Exactly the section that matches the capability interface is present (`speech`, `speechToSpeech`, `image` or `music`).",
- "properties": {
- "capabilityInterface": {
- "description": "Canonical name of the capability interface the model serves, for example port1/systems/zero/capability-interfaces/speech-audio-generation.",
- "type": "string"
- },
- "displayName": {
- "description": "Human readable model name.",
- "type": "string"
- },
- "image": {
- "description": "Image generation configuration.",
- "properties": {
- "arbitraryAspectRatio": {
- "description": "True when any width:height ratio is accepted, not only `aspectRatios`.",
- "type": "boolean"
- },
- "aspectRatios": {
- "description": "Accepted values of `aspectRatio`, written as width:height.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "defaultAspectRatio": {
- "description": "The ratio the vendor uses when `aspectRatio` is omitted, when it documents one.",
- "type": "string"
- },
- "resolutions": {
- "description": "Accepted values of `resolution`.",
- "items": {
- "description": "Output resolution tier of a generated image. STANDARD is about 1 megapixel (a 1K tier), HIGH is about 2K and ULTRA is about 4K. A model lists the tiers it supports in the model catalog.",
- "enum": [
- "STANDARD",
- "HIGH",
- "ULTRA"
- ],
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "maxPromptCharacters": {
- "description": "Longest accepted text or prompt in characters, when the vendor documents one.",
- "minimum": 1,
- "type": "integer"
- },
- "model": {
- "description": "The model identifier to pass as `model` in the interface generation message.",
- "type": "string"
- },
- "music": {
- "description": "Music generation configuration.",
- "properties": {
- "genres": {
- "description": "Accepted values of `genres`. Empty when `genres` is unsupported.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "maxDurationSeconds": {
- "description": "Longest accepted `durationSeconds`, when the model takes a duration.",
- "minimum": 1,
- "type": "integer"
- },
- "maxLyricsCharacters": {
- "description": "Longest accepted `lyrics`, when the vendor documents one.",
- "minimum": 1,
- "type": "integer"
- },
- "supportsDuration": {
- "description": "True when `durationSeconds` is accepted.",
- "type": "boolean"
- },
- "supportsGenres": {
- "description": "True when `genres` is accepted. When false, name the genre in the prompt.",
- "type": "boolean"
- },
- "supportsLyrics": {
- "description": "True when `lyrics` is accepted as a separate field. When false, put the lyrics in the prompt.",
- "type": "boolean"
- },
- "supportsVocalGender": {
- "description": "True when `vocalGender` is accepted.",
- "type": "boolean"
- }
- },
- "required": [
- "supportsLyrics",
- "supportsGenres",
- "supportsVocalGender",
- "supportsDuration"
- ],
- "type": "object"
- },
- "promptingInstructions": {
- "description": "Free text on how to prompt the model, for example whether lyrics go in the prompt or in a separate field and which emotion or sound tags the model understands.",
- "type": "string"
- },
- "provenance": {
- "description": "Where the catalog entry came from.",
- "properties": {
- "checkedOn": {
- "description": "The date (YYYY-MM-DD) the entry was last checked.",
- "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
- "type": "string"
- },
- "sourceUrl": {
- "description": "The vendor model page the entry was checked against.",
- "type": "string"
- }
- },
- "required": [
- "sourceUrl",
- "checkedOn"
- ],
- "type": "object"
- },
- "speech": {
- "description": "Text to speech configuration.",
- "properties": {
- "customVoicesAccepted": {
- "description": "True when `voice` also accepts a voice name that is not in `voices`.",
- "type": "boolean"
- },
- "defaultVoice": {
- "description": "The voice the vendor uses when `voice` is omitted, when the vendor documents one.",
- "type": "string"
- },
- "soundTags": {
- "description": "Emotion or sound tags the model documents, written exactly as they appear inline in the text, for example [whispering] or <laugh>. The list is documented examples, not a filter; the model may understand more.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "supportsStyleInstructions": {
- "description": "True when `styleInstructions` steers the delivery.",
- "type": "boolean"
- },
- "voices": {
- "description": "Voices the model offers.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "speechToSpeech": {
- "description": "Speech to speech (voice conversion) configuration.",
- "properties": {
- "inputAudio": {
- "description": "What an audio input accepts.",
- "properties": {
- "formats": {
- "description": "Accepted media types of the input.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "maxBytes": {
- "description": "Largest accepted input in decoded bytes.",
- "minimum": 1,
- "type": "integer"
- },
- "maxSeconds": {
- "description": "Longest accepted duration, when the model has one.",
- "minimum": 0,
- "type": "number"
- },
- "minSeconds": {
- "description": "Shortest accepted duration, when the model has one.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "formats"
- ],
- "type": "object"
- },
- "speakerReference": {
- "description": "Reference audio of the voice to convert to.",
- "properties": {
- "limits": {
- "description": "What an audio input accepts.",
- "properties": {
- "formats": {
- "description": "Accepted media types of the input.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "maxBytes": {
- "description": "Largest accepted input in decoded bytes.",
- "minimum": 1,
- "type": "integer"
- },
- "maxSeconds": {
- "description": "Longest accepted duration, when the model has one.",
- "minimum": 0,
- "type": "number"
- },
- "minSeconds": {
- "description": "Shortest accepted duration, when the model has one.",
- "minimum": 0,
- "type": "number"
- }
- },
- "required": [
- "formats"
- ],
- "type": "object"
- },
- "supported": {
- "description": "True when `speakerReference` is accepted.",
- "type": "boolean"
- }
- },
- "required": [
- "supported"
- ],
- "type": "object"
- },
- "voices": {
- "description": "Preset target voices; `voice` selects one when no speaker reference is given.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "required": [
- "inputAudio",
- "speakerReference"
- ],
- "type": "object"
- }
- },
- "required": [
- "capabilityInterface",
- "model",
- "displayName",
- "promptingInstructions",
- "provenance"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "models"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "models-listed"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/model-catalog"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `motion-detected` message (version 1.0) of the `port1/systems/zero/capability-interfaces/motion-sensor` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "A distinct motion occurrence, independent of cached detection state.",
- "properties": {
- "value": {
- "enum": [
- "DETECTED"
- ],
- "type": "string"
- }
- },
- "required": [
- "value"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "motion-detected"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/motion-sensor"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `music-generated` message (version 1.0) of the `port1/systems/zero/capability-interfaces/music-generation` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The music produced by generate-music, as a short-lived URL or inline base64 according to the responseFormat of the request",
- "properties": {
- "audio": {
- "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
- "properties": {
- "byteLength": {
- "description": "Size of the decoded bytes. Always present on host responses.",
- "maximum": 26214400,
- "minimum": 1,
- "type": "integer"
- },
- "data": {
- "description": "Base64 encoded bytes, at most 10 MiB decoded.",
- "format": "byte",
- "maxLength": 13981016,
- "type": "string"
- },
- "durationMs": {
- "description": "Duration of audio in milliseconds, when known.",
- "minimum": 0,
- "type": "integer"
- },
- "expiresAt": {
- "description": "When `url` stops working. Present with `url` on host responses.",
- "format": "date-time",
- "type": "string"
- },
- "height": {
- "description": "Image height in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- },
- "mimeType": {
- "description": "The media type of the bytes.",
- "enum": [
- "audio/mpeg",
- "audio/wav",
- "audio/ogg",
- "audio/flac",
- "image/png",
- "image/jpeg",
- "image/webp"
- ],
- "type": "string"
- },
- "url": {
- "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
- "type": "string"
- },
- "width": {
- "description": "Image width in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- }
- },
- "required": [
- "mimeType"
- ],
- "type": "object"
- },
- "lyrics": {
- "description": "The lyrics of the track when the model returns them",
- "type": "string"
- }
- },
- "required": [
- "audio"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "music-generated"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/music-generation"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `notification` message (version 1.0) of the `port1/systems/zero/capability-interfaces/notification` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "A notification delivered to target users, with its title, body, priority and delivery channels.",
- "properties": {
- "body": {
- "description": "Notification body text",
- "maxLength": 2000,
- "minLength": 1,
- "type": "string"
- },
- "channels": {
- "description": "Channels to send the notification through",
- "items": {
- "enum": [
- "PUSH",
- "EMAIL",
- "SMS",
- "IN_APP",
- "WEBHOOK"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "metadata": {
- "additionalProperties": true,
- "description": "Additional metadata for the notification",
- "type": "object"
- },
- "notificationId": {
- "description": "Unique identifier for this notification",
- "minLength": 1,
- "type": "string"
- },
- "priority": {
- "description": "Notification priority level",
- "enum": [
- "LOW",
- "NORMAL",
- "HIGH",
- "URGENT"
- ],
- "type": "string"
- },
- "targetUsers": {
- "description": "List of user IDs to send the notification to",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "title": {
- "description": "Notification title",
- "maxLength": 200,
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "title",
- "body"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "notification"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/notification"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `delete-recording-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/recordings` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Delete recording response.",
- "title": "RecordingsInterfaceDeleteRecordingResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "delete-recording-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/recordings"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `download-recording-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/recordings` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Download recording response.",
- "properties": {
- "uri": {
- "description": "Provider URL for downloading the recording.",
- "format": "uri",
- "type": "string"
- }
- },
- "required": [
- "uri"
- ],
- "title": "RecordingsInterfaceDownloadRecordingResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "download-recording-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/recordings"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `list-recordings-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/recordings` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "List recordings response.",
- "properties": {
- "items": {
- "description": "Recordings in this page.",
- "items": {
- "description": "A stored recording.",
- "properties": {
- "durationSeconds": {
- "description": "Recording duration in seconds.",
- "minimum": 0,
- "type": "number"
- },
- "mediaId": {
- "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
- "minLength": 1,
- "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
- "title": "MediaId",
- "type": "string"
- },
- "recordingId": {
- "description": "Provider identifier of the recording.",
- "minLength": 1,
- "type": "string"
- },
- "startedAt": {
- "description": "Recording start time.",
- "format": "date-time",
- "type": "string"
- }
- },
- "required": [
- "recordingId"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "nextCursor": {
- "description": "Opaque cursor for the next page; omitted when there are no further results.",
- "type": "string"
- }
- },
- "required": [
- "items"
- ],
- "title": "RecordingsInterfaceListRecordingsResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "list-recordings-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/recordings"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `create-reminder-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/reminders-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The provider accepted the reminder change.",
- "properties": {
- "reminder": {
- "description": "A reminder and its current provider revision for guarded edits.",
- "properties": {
- "allDay": {
- "description": "Whether the supplied due date represents an all-day reminder.",
- "type": "boolean"
- },
- "completed": {
- "type": "boolean"
- },
- "dueDate": {
- "description": "Exact due instant in RFC3339 with an explicit UTC offset. Omitted on undated reminders.",
- "format": "date-time",
- "type": "string"
- },
- "listId": {
- "type": "string"
- },
- "notes": {
- "type": "string"
- },
- "reminderId": {
- "type": "string"
- },
- "revision": {
- "description": "Omitted when the provider does not supply a revision; writes require it.",
- "type": "string"
- },
- "timeZone": {
- "description": "IANA time zone, for example America/Los_Angeles. Defaults to UTC for newly dated reminders.",
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- },
- "required": [
- "reminderId",
- "listId",
- "title",
- "completed"
- ],
- "type": "object"
- }
- },
- "required": [
- "reminder"
- ],
- "title": "RemindersProviderInterfaceCreateReminderResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "create-reminder-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/reminders-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `delete-reminder-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/reminders-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The provider accepted soft deletion of the reminder.",
- "title": "RemindersProviderInterfaceDeleteReminderResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "delete-reminder-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/reminders-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `list-reminders-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/reminders-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Reminder lists and one bounded page of reminders.",
- "properties": {
- "nextCursor": {
- "type": "string"
- },
- "reminderLists": {
- "items": {
- "description": "A reminder list",
- "properties": {
- "listId": {
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- },
- "required": [
- "listId"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "reminders": {
- "items": {
- "description": "A reminder and its current provider revision for guarded edits.",
- "properties": {
- "allDay": {
- "description": "Whether the supplied due date represents an all-day reminder.",
- "type": "boolean"
- },
- "completed": {
- "type": "boolean"
- },
- "dueDate": {
- "description": "Exact due instant in RFC3339 with an explicit UTC offset. Omitted on undated reminders.",
- "format": "date-time",
- "type": "string"
- },
- "listId": {
- "type": "string"
- },
- "notes": {
- "type": "string"
- },
- "reminderId": {
- "type": "string"
- },
- "revision": {
- "description": "Omitted when the provider does not supply a revision; writes require it.",
- "type": "string"
- },
- "timeZone": {
- "description": "IANA time zone, for example America/Los_Angeles. Defaults to UTC for newly dated reminders.",
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- },
- "required": [
- "reminderId",
- "listId",
- "title",
- "completed"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "reminderLists",
- "reminders"
- ],
- "title": "RemindersProviderInterfaceListRemindersResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "list-reminders-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/reminders-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `update-reminder-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/reminders-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The provider accepted the reminder change.",
- "properties": {
- "reminder": {
- "description": "A reminder and its current provider revision for guarded edits.",
- "properties": {
- "allDay": {
- "description": "Whether the supplied due date represents an all-day reminder.",
- "type": "boolean"
- },
- "completed": {
- "type": "boolean"
- },
- "dueDate": {
- "description": "Exact due instant in RFC3339 with an explicit UTC offset. Omitted on undated reminders.",
- "format": "date-time",
- "type": "string"
- },
- "listId": {
- "type": "string"
- },
- "notes": {
- "type": "string"
- },
- "reminderId": {
- "type": "string"
- },
- "revision": {
- "description": "Omitted when the provider does not supply a revision; writes require it.",
- "type": "string"
- },
- "timeZone": {
- "description": "IANA time zone, for example America/Los_Angeles. Defaults to UTC for newly dated reminders.",
- "type": "string"
- },
- "title": {
- "type": "string"
- }
- },
- "required": [
- "reminderId",
- "listId",
- "title",
- "completed"
- ],
- "type": "object"
- }
- },
- "required": [
- "reminder"
- ],
- "title": "RemindersProviderInterfaceUpdateReminderResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "update-reminder-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/reminders-provider"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `route-discovery-report` message (version 1.0) of the `port1/systems/zero/capability-interfaces/route-discovery` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Provider report of discovered routes, group routes and their relationships. Plugin and auth-link identity come from the authenticated publisher context.",
- "properties": {
- "authLinkIdentity": {
- "description": "The ID of the auth link the routes were discovered for.",
- "type": "string"
- },
- "groupRoutes": {
- "items": {
- "description": "A provider-reported group route (for example a vacuum map or room, a lighting room or a speaker group) as carried by discovery. It is shared by the route-discovery report message and `SynchronizationRequest.groupRoutes` so both decode to the same model.\n",
- "properties": {
- "interfaces": {
- "items": {
- "properties": {
- "attributes": {
- "description": "Supported attribute subset. An omitted or empty list declares no supported attributes.",
- "items": {
- "properties": {
- "name": {
- "description": "The name of the attribute",
- "type": "string"
- },
- "value": {
- "additionalProperties": true,
- "description": "the value of the attribute, this is an opaque resource object, so it can be any type of struct.",
- "type": "object"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "configuration": {
- "additionalProperties": true,
- "description": "The configuration of the interface",
- "type": "object"
- },
- "messages": {
- "description": "Supported inbound message subset for the declared interface version. An omitted or empty list declares no supported messages; null also declares none. A supplied array contains distinct canonical names for implemented messages.",
- "items": {
- "properties": {
- "name": {
- "description": "The name of the command",
- "type": "string"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "name": {
- "description": "The name of the interface",
- "type": "string"
- },
- "version": {
- "description": "the version of the interface",
- "type": "string"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "memberPluginRouteIds": {
- "description": "Full current native membership; an empty array explicitly reports an empty route.",
- "items": {
- "type": "string"
- },
- "type": "array",
- "uniqueItems": true
- },
- "name": {
- "description": "The name of the associated group route",
- "type": "string"
- },
- "ontologicalTypes": {
- "description": "Actual classifications of the native group route, constrained by its selected plugin profile for V2 discovery.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pluginCustomMetadata": {
- "additionalProperties": true,
- "description": "Private plugin metadata (native map, segment or cloud room addressing) returned to the plugin on dispatch; never exposed as application data. A route declaring the canonical SPATIAL geometry capability can carry a valid SpatialInterfaceGeometryAttribute in geometry. Only that canonical geometry's observedAt is observation time rather than a meaningful group-etag contribution; it is still stored. Geometry shape, frame, native context and all other metadata remain meaningful.\n",
- "type": "object"
- },
- "pluginProfileId": {
- "description": "Stable group-route profile ID selected from the registered V2 plugin declaration.",
- "minLength": 1,
- "type": "string"
- },
- "pluginRouteId": {
- "description": "Plugin-owned stable identifier of the group route. Must be unique across routes and group routes within one plugin and auth link.\n",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "pluginRouteId",
- "name",
- "pluginProfileId",
- "ontologicalTypes",
- "interfaces",
- "memberPluginRouteIds"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "pluginIdentity": {
- "description": "Identifies a plugin client by its type and unique identifier.",
- "properties": {
- "pluginId": {
- "description": "The ID of the plugin",
- "type": "string"
- },
- "pluginType": {
- "enum": [
- "WEBSOCKET",
- "HTTP",
- "WEBSERVICE",
- "APPLE_PUSH_NOTIFICATION",
- "HOSTED_COMPUTE"
- ],
- "type": "string"
- }
- },
- "required": [
- "pluginType",
- "pluginId"
- ],
- "type": "object"
- },
- "relationships": {
- "description": "Provider relationships excluding output-only MEMBER_OF edges. Report native group membership in groupRoutes[].memberPluginRouteIds; use group management APIs for customer intent.",
- "items": {
- "description": "A provider-reported relationship between typed port resources. Identity is `externalId` within the reporting plugin and auth link; resubmitting the same `externalId` updates the relationship. Omission from a later synchronization is not a deletion instruction. MEMBER_OF is an output-only membership projection and is rejected as provider input, including native route-to-group-route membership edges. Supply native members in GroupRoute.memberPluginRouteIds instead.\n",
- "properties": {
- "externalId": {
- "description": "Plugin-owned stable identifier of the relationship.",
- "minLength": 1,
- "type": "string"
- },
- "interfaces": {
- "description": "Optional interface applicability; used by `CAN_CONTROL` to declare which messages the source supports on the target.",
- "items": {
- "description": "Capability-interface applicability of a relationship, for example the robotic-vacuum-cleaner messages a `CAN_CONTROL` edge supports on a room.\n",
- "properties": {
- "messages": {
- "description": "Message names of the interface the relationship applies to. An explicit empty array applies to no messages. Omission retains every message supported by the source interface.",
- "items": {
- "minLength": 1,
- "type": "string"
- },
- "type": "array",
- "uniqueItems": true
- },
- "name": {
- "description": "The capability interface namespace.",
- "minLength": 1,
- "type": "string"
- },
- "version": {
- "description": "The capability interface version.",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "name",
- "version"
- ],
- "type": "object"
- },
- "minItems": 1,
- "type": "array"
- },
- "source": {
- "description": "One end of a discovered relationship, addressed by plugin-owned identity within the reporting plugin and auth link. Exactly one of `pluginRouteId` (a route), `groupPluginRouteId` (a group route), `endpointId` or `groupId` must be set.\n",
- "maxProperties": 1,
- "minProperties": 1,
- "properties": {
- "endpointId": {
- "description": "The full ID of an endpoint owned by the reporting principal.",
- "minLength": 1,
- "type": "string"
- },
- "groupId": {
- "description": "The full ID of a group owned by the reporting principal.",
- "minLength": 1,
- "type": "string"
- },
- "groupPluginRouteId": {
- "description": "The plugin route ID of a group route reported in the same or an earlier synchronization.",
- "minLength": 1,
- "type": "string"
- },
- "pluginRouteId": {
- "description": "The plugin route ID of a route reported in the same or an earlier synchronization.",
- "minLength": 1,
- "type": "string"
- }
- },
- "type": "object"
- },
- "target": {
- "description": "One end of a discovered relationship, addressed by plugin-owned identity within the reporting plugin and auth link. Exactly one of `pluginRouteId` (a route), `groupPluginRouteId` (a group route), `endpointId` or `groupId` must be set.\n",
- "maxProperties": 1,
- "minProperties": 1,
- "properties": {
- "endpointId": {
- "description": "The full ID of an endpoint owned by the reporting principal.",
- "minLength": 1,
- "type": "string"
- },
- "groupId": {
- "description": "The full ID of a group owned by the reporting principal.",
- "minLength": 1,
- "type": "string"
- },
- "groupPluginRouteId": {
- "description": "The plugin route ID of a group route reported in the same or an earlier synchronization.",
- "minLength": 1,
- "type": "string"
- },
- "pluginRouteId": {
- "description": "The plugin route ID of a route reported in the same or an earlier synchronization.",
- "minLength": 1,
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": {
- "description": "Writable provider relationship kind. MEMBER_OF is an output-only projection maintained by group resolution; native membership is reported through GroupRoute.memberPluginRouteIds.",
- "enum": [
- "IS_PART_OF",
- "CAN_CONTROL",
- "LOCATED_IN"
- ],
- "type": "string"
- }
- },
- "required": [
- "externalId",
- "type",
- "source",
- "target"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "routes": {
- "items": {
- "description": "Provider input before host synchronization assigns persisted route identity and ownership. Canonical provider facts reuse Route property definitions. The Go projection reuses the Route wire adapter; validation uses this input schema, not persisted Route. Host identity fields may be omitted or empty and never establish authenticated publisher or installation authority. Nonempty id and associatedEndpointId may select an existing authorized route during scoped rediscovery; newly created routes and endpoints receive host-assigned IDs.\n",
- "properties": {
- "associatedAuthLinkId": {
- "description": "The ID of the associated auth link",
- "type": "string"
- },
- "associatedEndpointId": {
- "description": "The ID of the associated endpoint",
- "type": "string"
- },
- "associatedPluginId": {
- "description": "The ID of the associated plugin",
- "type": "string"
- },
- "associatedPluginRouteId": {
- "allOf": [
- {
- "description": "The stable plugin-owned route identifier associated with this Port OS route. For synchronized plugin capability contracts and fixture parity checks, use this field to match a route from enumeration back to the discovery payload.\n",
- "type": "string"
- }
- ],
- "minLength": 1
- },
- "description": {
- "allOf": [
- {
- "properties": {
- "type": {
- "description": "The type identifier of the name value, defined as plain when not defined.",
- "type": "string"
- },
- "value": {
- "description": "the raw value of a plain name.",
- "type": "string"
- }
- },
- "required": [
- "type",
- "value"
- ],
- "type": "object"
- }
- ],
- "description": "The description of the route as a human readable string or a localizable asset."
- },
- "externalId": {
- "description": "The external ID of the route given by the reporting system",
- "type": "string"
- },
- "id": {
- "description": "Advisory value, including empty. Together with associatedEndpointId it may select an existing route within the authenticated scope. New persisted IDs are assigned by the host and validated by the separate persisted Route schema.",
- "type": "string"
- },
- "interfaces": {
- "description": "List of interfaces supported by the route. These denote what the route is capable of performing such as turning off/on, etc.",
- "items": {
- "properties": {
- "attributes": {
- "description": "Supported attribute subset. An omitted or empty list declares no supported attributes.",
- "items": {
- "properties": {
- "name": {
- "description": "The name of the attribute",
- "type": "string"
- },
- "value": {
- "additionalProperties": true,
- "description": "the value of the attribute, this is an opaque resource object, so it can be any type of struct.",
- "type": "object"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "configuration": {
- "additionalProperties": true,
- "description": "The configuration of the interface",
- "type": "object"
- },
- "messages": {
- "description": "Supported inbound message subset for the declared interface version. An omitted or empty list declares no supported messages; null also declares none. A supplied array contains distinct canonical names for implemented messages.",
- "items": {
- "properties": {
- "name": {
- "description": "The name of the command",
- "type": "string"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "type": [
- "array",
- "null"
- ]
- },
- "name": {
- "description": "The name of the interface",
- "type": "string"
- },
- "version": {
- "description": "the version of the interface",
- "type": "string"
- }
- },
- "required": [
- "name"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "manufacturer": {
- "allOf": [
- {
- "properties": {
- "type": {
- "description": "The type identifier of the name value, defined as plain when not defined.",
- "type": "string"
- },
- "value": {
- "description": "the raw value of a plain name.",
- "type": "string"
- }
- },
- "required": [
- "type",
- "value"
- ],
- "type": "object"
- }
- ],
- "description": "The manufacturer of the route as a human readable string or a localizable asset."
- },
- "model": {
- "allOf": [
- {
- "properties": {
- "type": {
- "description": "The type identifier of the name value, defined as plain when not defined.",
- "type": "string"
- },
- "value": {
- "description": "the raw value of a plain name.",
- "type": "string"
- }
- },
- "required": [
- "type",
- "value"
- ],
- "type": "object"
- }
- ],
- "description": "The model of the route as a human readable string or a localizable asset."
- },
- "name": {
- "allOf": [
- {
- "properties": {
- "type": {
- "description": "The type identifier of the name value, defined as plain when not defined.",
- "type": "string"
- },
- "value": {
- "description": "the raw value of a plain name.",
- "type": "string"
- }
- },
- "required": [
- "type",
- "value"
- ],
- "type": "object"
- }
- ],
- "description": "The name of the route as a human readable string or a localizable asset. This is either a raw string or a localizable asset reference."
- },
- "ontologicalTypes": {
- "description": "List of ontological types for the route. These are used mostly for customers to know what an endpoint is, like if its a lightbulb, or a speaker, etc.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pluginCustomMetadata": {
- "additionalProperties": true,
- "description": "A set of custom metadata that the plugin uses and attaches to the route, this is meant specifically for the plugin to use.",
- "type": "object"
- },
- "pluginProfileId": {
- "description": "Stable profile ID selected from the registered plugin declaration. Required for V2 plugin discovery; retained with the route for admission and presentation.",
- "minLength": 1,
- "type": "string"
- },
- "serialNumber": {
- "allOf": [
- {
- "properties": {
- "type": {
- "description": "The type identifier of the name value, defined as plain when not defined.",
- "type": "string"
- },
- "value": {
- "description": "the raw value of a plain name.",
- "type": "string"
- }
- },
- "required": [
- "type",
- "value"
- ],
- "type": "object"
- }
- ],
- "description": "The serial number of the route as a human readable string or a localizable asset."
- }
- },
- "required": [
- "associatedPluginRouteId",
- "interfaces",
- "ontologicalTypes"
- ],
- "type": "object"
- },
- "maxItems": 1000,
- "type": "array"
- }
- },
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "route-discovery-report"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/route-discovery"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `answer-generated-for-session` message (version 1.0) of the `port1/systems/zero/capability-interfaces/rtc-session` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The answer generated for a real-time communication session, which completes the connection.",
- "properties": {
- "answer": {
- "description": "An RTC session answer",
- "properties": {
- "format": {
- "enum": [
- "SDP"
- ],
- "type": "string"
- },
- "value": {
- "description": "The content of the answer",
- "properties": {
- "expiresAt": {
- "description": "Provider-reported stream expiration",
- "type": "string"
- },
- "sdp": {
- "description": "The SDP answer session contents",
- "type": "string"
- },
- "streamExtensionToken": {
- "description": "Provider token used to extend the established stream",
- "type": "string"
- },
- "streamToken": {
- "description": "Provider token for the established stream",
- "type": "string"
- },
- "streamUrl": {
- "description": "Provider stream URL when the answer is not SDP",
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- }
- },
- "required": [
- "answer"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "answer-generated-for-session"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/rtc-session"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `session-disconnected` message (version 1.0) of the `port1/systems/zero/capability-interfaces/rtc-session` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Reports that a real-time communication session has disconnected.",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "session-disconnected"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/rtc-session"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `start-session-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/rtsp-session` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Start session response.",
- "properties": {
- "sdp": {
- "description": "Optional SDP describing the stream.",
- "minLength": 1,
- "type": "string"
- },
- "sessionId": {
- "description": "Session identifier.",
- "minLength": 1,
- "type": "string"
- },
- "uri": {
- "description": "RTSP stream URI.",
- "format": "uri",
- "pattern": "^rtsps?://",
- "type": "string"
- }
- },
- "required": [
- "sessionId",
- "uri"
- ],
- "title": "RtspSessionInterfaceStartSessionResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "start-session-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/rtsp-session"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `stop-session-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/rtsp-session` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Stop session response.",
- "properties": {
- "sessionId": {
- "description": "Closed session identifier.",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "sessionId"
- ],
- "title": "RtspSessionInterfaceStopSessionResponseMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "stop-session-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/rtsp-session"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `scene-created` message (version 1.0) of the `port1/systems/zero/capability-interfaces/scene` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Confirms that a new scene was saved for the selected room or group. The scene is available to recall on that same target; creation does not activate it or establish that any light changed state.",
- "properties": {
- "name": {
- "description": "Name of the saved scene",
- "maxLength": 128,
- "minLength": 1,
- "pattern": "\\S",
- "type": "string"
- },
- "sceneId": {
- "description": "Saved scene identifier to pass to the activate message on the same target",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "sceneId",
- "name"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "scene-created"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/scene"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `pin-operation-result` message (version 1.0) of the `port1/systems/zero/capability-interfaces/security-pin` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Correlated safe PIN provisioning result. APPLIED requires vendor-confirmed completion, not dispatch acceptance. CREATE supplies recordId once assigned; UPDATE and DELETE retain the requested ID. FAILED requires a safe code; other statuses forbid code. Never include credentials or raw vendor errors.",
- "properties": {
- "code": {
- "description": "Stable safe structured failure code. Never raw vendor text, credentials or response bodies.",
- "minLength": 1,
- "type": "string"
- },
- "correlationToken": {
- "minLength": 1,
- "type": "string"
- },
- "operation": {
- "enum": [
- "CREATE",
- "UPDATE",
- "DELETE"
- ],
- "type": "string"
- },
- "provisioningStatus": {
- "enum": [
- "PENDING",
- "APPLIED",
- "FAILED"
- ],
- "type": "string"
- },
- "recordId": {
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "correlationToken",
- "operation",
- "provisioningStatus"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "pin-operation-result"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/security-pin"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `pin-records-report` message (version 1.0) of the `port1/systems/zero/capability-interfaces/security-pin` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "Bounded credential-free record page aligned with the pin-records attribute. Echo the query correlation token in the message header.",
- "properties": {
- "items": {
- "items": {
- "description": "Endpoint-scoped PIN metadata without credentials. TEMPORARY requires both validity timestamps; PERMANENT forbids them. Provisioning status is distinct from observation freshness.",
- "properties": {
- "id": {
- "minLength": 1,
- "type": "string"
- },
- "kind": {
- "enum": [
- "PERMANENT",
- "TEMPORARY"
- ],
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "provisioningStatus": {
- "enum": [
- "PENDING",
- "APPLIED",
- "FAILED"
- ],
- "type": "string"
- },
- "validFrom": {
- "format": "date-time",
- "type": "string"
- },
- "validUntil": {
- "format": "date-time",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "kind",
- "provisioningStatus"
- ],
- "type": "object"
- },
- "maxItems": 100,
- "type": "array"
- },
- "nextToken": {
- "description": "Opaque continuation bound to endpoint, caller and query; omitted on the final page.",
- "minLength": 1,
- "type": "string"
- }
- },
- "required": [
- "items"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "pin-records-report"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/security-pin"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `get-snapshot-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/snapshot` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "A camera still image, as a short-lived URL or inline base64 according to the request's responseFormat, with the time it was captured",
- "properties": {
- "image": {
- "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
- "properties": {
- "byteLength": {
- "description": "Size of the decoded bytes. Always present on host responses.",
- "maximum": 26214400,
- "minimum": 1,
- "type": "integer"
- },
- "data": {
- "description": "Base64 encoded bytes, at most 10 MiB decoded.",
- "format": "byte",
- "maxLength": 13981016,
- "type": "string"
- },
- "durationMs": {
- "description": "Duration of audio in milliseconds, when known.",
- "minimum": 0,
- "type": "integer"
- },
- "expiresAt": {
- "description": "When `url` stops working. Present with `url` on host responses.",
- "format": "date-time",
- "type": "string"
- },
- "height": {
- "description": "Image height in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- },
- "mimeType": {
- "description": "The media type of the bytes.",
- "enum": [
- "audio/mpeg",
- "audio/wav",
- "audio/ogg",
- "audio/flac",
- "image/png",
- "image/jpeg",
- "image/webp"
- ],
- "type": "string"
- },
- "url": {
- "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
- "type": "string"
- },
- "width": {
- "description": "Image width in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- }
- },
- "required": [
- "mimeType"
- ],
- "type": "object"
- },
- "timeOfSample": {
- "format": "date-time",
- "type": "string"
- }
- },
- "required": [
- "image",
- "timeOfSample"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "get-snapshot-response"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/snapshot"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `audio-generated` message (version 1.0) of the `port1/systems/zero/capability-interfaces/speech-audio-generation` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The speech audio synthesized by generate-speech, as a short-lived URL or inline base64 according to the request's responseFormat",
- "properties": {
- "audio": {
- "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
- "properties": {
- "byteLength": {
- "description": "Size of the decoded bytes. Always present on host responses.",
- "maximum": 26214400,
- "minimum": 1,
- "type": "integer"
- },
- "data": {
- "description": "Base64 encoded bytes, at most 10 MiB decoded.",
- "format": "byte",
- "maxLength": 13981016,
- "type": "string"
- },
- "durationMs": {
- "description": "Duration of audio in milliseconds, when known.",
- "minimum": 0,
- "type": "integer"
- },
- "expiresAt": {
- "description": "When `url` stops working. Present with `url` on host responses.",
- "format": "date-time",
- "type": "string"
- },
- "height": {
- "description": "Image height in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- },
- "mimeType": {
- "description": "The media type of the bytes.",
- "enum": [
- "audio/mpeg",
- "audio/wav",
- "audio/ogg",
- "audio/flac",
- "image/png",
- "image/jpeg",
- "image/webp"
- ],
- "type": "string"
- },
- "url": {
- "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
- "type": "string"
- },
- "width": {
- "description": "Image width in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- }
- },
- "required": [
- "mimeType"
- ],
- "type": "object"
- }
- },
- "required": [
- "audio"
- ],
- "title": "SpeechAudioGenerationInterfaceAudioGeneratedMessage",
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "audio-generated"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/speech-audio-generation"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `speech-converted` message (version 1.0) of the `port1/systems/zero/capability-interfaces/speech-to-speech` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "The converted speech produced by convert-speech, as a short-lived URL or inline base64 according to the responseFormat of the request",
- "properties": {
- "audio": {
- "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
- "properties": {
- "byteLength": {
- "description": "Size of the decoded bytes. Always present on host responses.",
- "maximum": 26214400,
- "minimum": 1,
- "type": "integer"
- },
- "data": {
- "description": "Base64 encoded bytes, at most 10 MiB decoded.",
- "format": "byte",
- "maxLength": 13981016,
- "type": "string"
- },
- "durationMs": {
- "description": "Duration of audio in milliseconds, when known.",
- "minimum": 0,
- "type": "integer"
- },
- "expiresAt": {
- "description": "When `url` stops working. Present with `url` on host responses.",
- "format": "date-time",
- "type": "string"
- },
- "height": {
- "description": "Image height in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- },
- "mimeType": {
- "description": "The media type of the bytes.",
- "enum": [
- "audio/mpeg",
- "audio/wav",
- "audio/ogg",
- "audio/flac",
- "image/png",
- "image/jpeg",
- "image/webp"
- ],
- "type": "string"
- },
- "url": {
- "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
- "type": "string"
- },
- "width": {
- "description": "Image width in pixels, when known.",
- "minimum": 1,
- "type": "integer"
- }
- },
- "required": [
- "mimeType"
- ],
- "type": "object"
- }
- },
- "required": [
- "audio"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "speech-converted"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/speech-to-speech"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- },
- {
- "description": "The `text-stream` message (version 1.0) of the `port1/systems/zero/capability-interfaces/text-stream` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
- "properties": {
- "body": {
- "description": "A chunk of streamed text, with its stream ID and sequence, and whether it is the final chunk.",
- "properties": {
- "isFinal": {
- "default": false,
- "description": "Whether this is the final chunk in the stream",
- "type": "boolean"
- },
- "sequenceId": {
- "description": "Sequence ID for this text stream",
- "minimum": 0,
- "type": "integer"
- },
- "streamId": {
- "description": "Unique identifier for this text stream",
- "minLength": 1,
- "type": "string"
- },
- "text": {
- "type": "string"
- }
- },
- "required": [
- "streamId",
- "text",
- "sequenceId",
- "isFinal"
- ],
- "type": "object"
- },
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "header": {
- "description": "Identifies this capability message.",
- "properties": {
- "correlationToken": {
- "description": "Token used for correlating related messages",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the message",
- "type": "string"
- },
- "name": {
- "enum": [
- "text-stream"
- ],
- "type": "string"
- },
- "namespace": {
- "enum": [
- "port1/systems/zero/capability-interfaces/text-stream"
- ],
- "type": "string"
- },
- "version": {
- "enum": [
- "1.0"
- ],
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "title": "MessageHeader",
- "type": "object"
- }
- },
- "required": [
- "header",
- "body"
- ],
- "type": "object"
- }
- ]
- },
- "messageId": {
- "description": "The unary response message ID, when a reply was received.",
- "type": "string"
- },
- "outcome": {
- "description": "ACCEPTED means dispatch was accepted without a correlated reply. SUCCEEDED means a valid correlated reply was received. FAILED means dispatch returned an error or timed out. None of these states alone proves an observed physical device state.",
- "enum": [
- "ACCEPTED",
- "SUCCEEDED",
- "FAILED"
- ],
- "type": "string"
- }
- },
- "required": [
- "endpointId",
- "outcome"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "result": {
- "properties": {
- "header": {
- "properties": {
- "name": {
- "type": "string"
- },
- "namespace": {
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "required": [
- "namespace",
- "name",
- "version"
- ],
- "type": "object"
- },
- "payload": {
- "type": "object"
- }
- },
- "required": [
- "header",
- "payload"
- ],
- "type": "object"
- },
- "status": {
- "enum": [
- "accepted",
- "responded"
- ],
- "type": "string"
- },
- "timeOfSample": {
- "format": "date-time",
- "type": "string"
- }
- },
- "required": [
- "status"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "The one Port OS error shape, returned by every REST error response and every MCP tool error. `code` names the specific failure and `family` its broad class; both are closed enums, so clients branch on them and show `message`, which says what failed and what to do next.",
- "properties": {
- "code": {
- "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
- "enum": [
- "BAD_REQUEST",
- "UNAUTHORIZED",
- "FORBIDDEN",
- "INSUFFICIENT_SCOPE",
- "NOT_FOUND",
- "CONFLICT",
- "UNPROCESSABLE_ENTITY",
- "UNSUPPORTED_OPERATION",
- "TOO_MANY_REQUESTS",
- "SERVICE_UNAVAILABLE",
- "NOT_IMPLEMENTED",
- "INTERNAL",
- "CHECKSUM_MISMATCH",
- "FILE_TOO_LARGE",
- "STORAGE_UNAVAILABLE",
- "INSUFFICIENT_PERMISSIONS",
- "INVALID_FILE_TYPE",
- "QUOTA_EXCEEDED",
- "CONCURRENT_MODIFICATION",
- "ENDPOINT_UNREACHABLE",
- "BRIDGE_UNREACHABLE",
- "CLOUD_CONTROL_DISABLED",
- "ENDPOINT_BUSY",
- "ENDPOINT_LOW_POWER",
- "AUTHORIZATION_CREDENTIAL_INVALID",
- "AUTHORIZATION_CREDENTIAL_EXPIRED",
- "INVALID_DIRECTIVE",
- "INVALID_VALUE",
- "VALUE_OUT_OF_RANGE",
- "NOT_SUPPORTED_IN_CURRENT_MODE",
- "RATE_LIMIT_EXCEEDED",
- "PROVIDER_SERVICE_UNAVAILABLE",
- "PROVIDER_TIMEOUT",
- "PROVIDER_INTERNAL_ERROR",
- "INVALID_PROVIDER_RESPONSE",
- "OUTCOME_UNKNOWN",
- "PRECONDITION_FAILED",
- "AUTH_LINK_NOT_READY",
- "AUTH_LINK_NOT_DISCONNECTABLE",
- "PRECONDITION_REQUIRED",
- "IDEMPOTENCY_KEY_REQUIRED",
- "IDEMPOTENCY_KEY_REUSED",
- "IDEMPOTENCY_KEY_IN_FLIGHT",
- "IDEMPOTENCY_KEY_INVALID",
- "GROUP_MERGED",
- "MULTI_ROOM_UNSUPPORTED",
- "MAP_NOT_ACTIVE",
- "TARGET_UNSUPPORTED",
- "TARGET_AMBIGUOUS",
- "TARGET_GROUP_NOT_FOUND",
- "TARGET_GROUP_DISABLED",
- "DUPLICATE_TARGET_GROUP",
- "MESSAGE_UNSUPPORTED",
- "MESSAGE_AMBIGUOUS",
- "ENDPOINT_DISABLED",
- "ENDPOINT_ROUTE_CHANGED",
- "ENDPOINT_HAS_DEPENDENCIES",
- "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
- "ENDPOINT_COMMITTED_CLEANUP_PENDING",
- "DEEP_QUERY_FAILED",
- "PROVIDER_NO_STATE",
- "EVENT_MANAGEMENT_DISABLED",
- "SUBSCRIPTION_IDENTITY_IMMUTABLE",
- "UNSUPPORTED_MEDIA_TYPE",
- "EVENT_PAYLOAD_TOO_LARGE",
- "REQUEST_BODY_TOO_LARGE",
- "EVENT_IDENTITY_CONFLICT",
- "EVENT_INGRESS_QUOTA_EXCEEDED",
- "EVENT_RECEIPT_EXPIRED",
- "EVENT_STORAGE_UNAVAILABLE",
- "EVENT_DEAD_LETTER_NOT_FOUND",
- "EVENT_REDRIVE_CONFLICT",
- "EVENT_REDRIVE_EXPIRED",
- "RECEIPT_CONTEXT_EXPIRED",
- "EVENT_MAINTENANCE_INCOMPLETE",
- "UNKNOWN_INTERFACE",
- "INVALID_CONFIGURATION",
- "INVALID_PLUGIN_MANIFEST",
- "INVALID_ATTRIBUTE",
- "INVALID_PROVIDER_MESSAGE",
- "UNDECLARED_CAPABILITY",
- "PLUGIN_ROUTE_ID_CONFLICT",
- "UNRESOLVED_REFERENCE",
- "INVALID_RELATIONSHIP",
- "RELATIONSHIP_CYCLE",
- "MULTIPLE_PARENTS",
- "FLOW_VALIDATION_FAILED",
- "PROVIDER_SYNC_UNSUPPORTED"
- ],
- "type": "string"
- },
- "details": {
- "description": "Optional typed context for an error. Fields are additive and only populated when the error can safely expose that context to API clients.\n",
- "properties": {
- "actual": {
- "description": "String representation of the submitted value when the plugin can safely report it.",
- "type": "string"
- },
- "correlationId": {
- "description": "Provider or plugin correlation ID useful for support.",
- "type": "string"
- },
- "correlationToken": {
- "description": "Token that correlates an outcome-unknown dispatch with its eventual result.",
- "type": "string"
- },
- "currentMode": {
- "description": "Current endpoint mode when `code` is `NOT_SUPPORTED_IN_CURRENT_MODE`.",
- "type": "string"
- },
- "directive": {
- "description": "Message namespace and name or provider directive that failed.",
- "type": "string"
- },
- "discoveryEndpointId": {
- "description": "Port OS provider endpoint (type ENDPOINT_PLUGIN) of the connection to send `discover-routes` to when `code` is `TARGET_UNSUPPORTED` because the route must be rediscovered.",
- "type": "string"
- },
- "endpointId": {
- "description": "Port OS endpoint ID involved in the failed dispatch.",
- "type": "string"
- },
- "fieldErrors": {
- "description": "The request fields that were rejected, when the error is about the request's content.",
- "items": {
- "description": "One rejected request field of an error.",
- "properties": {
- "field": {
- "description": "Name or JSON path of the rejected field.",
- "type": "string"
- },
- "reason": {
- "description": "Why the field was rejected and what an accepted value looks like.",
- "type": "string"
- }
- },
- "required": [
- "field",
- "reason"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "maximum": {
- "description": "Maximum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
- "type": "number"
- },
- "minimum": {
- "description": "Minimum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
- "type": "number"
- },
- "parameter": {
- "description": "Request parameter or capability value that caused the failure.",
- "type": "string"
- },
- "pluginId": {
- "description": "Port OS plugin ID that reported the failure.",
- "type": "string"
- },
- "pluginRouteId": {
- "description": "Plugin-owned route identifier involved in the failed dispatch.",
- "type": "string"
- },
- "provider": {
- "description": "Third-party provider or bridge name that reported the failure.",
- "type": "string"
- },
- "providerCode": {
- "description": "The third-party provider's own error code, for support. It is opaque and provider-specific; branch on `code` and `family` instead.",
- "type": "string"
- },
- "retryAfterSeconds": {
- "description": "Suggested retry delay for rate-limit or provider-unavailable failures.",
- "minimum": 0,
- "type": "integer"
- }
- },
- "type": "object"
- },
- "errors": {
- "description": "Every rejected item when a request that is validated item by item and applied atomically fails, such as a discovery `SynchronizationRequest` whose routes, group routes or relationships are rejected. Omitted for single-item failures.\n",
- "items": {
- "description": "One rejected discovery item of a `SynchronizationRequest`, keyed by the plugin-owned identity of the rejected item: `pluginRouteId` for a route or group route, or `relationshipExternalId` for a relationship. Exactly one of the two is set. It shares the `code`, `family`, `status` and `message` fields of `BatchItemError`; discovery items are keyed by plugin-owned identity because they carry no `requestId`. A request with any rejected item is rejected as a whole and lists every rejected item.\n",
- "properties": {
- "code": {
- "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
- "enum": [
- "BAD_REQUEST",
- "UNAUTHORIZED",
- "FORBIDDEN",
- "INSUFFICIENT_SCOPE",
- "NOT_FOUND",
- "CONFLICT",
- "UNPROCESSABLE_ENTITY",
- "UNSUPPORTED_OPERATION",
- "TOO_MANY_REQUESTS",
- "SERVICE_UNAVAILABLE",
- "NOT_IMPLEMENTED",
- "INTERNAL",
- "CHECKSUM_MISMATCH",
- "FILE_TOO_LARGE",
- "STORAGE_UNAVAILABLE",
- "INSUFFICIENT_PERMISSIONS",
- "INVALID_FILE_TYPE",
- "QUOTA_EXCEEDED",
- "CONCURRENT_MODIFICATION",
- "ENDPOINT_UNREACHABLE",
- "BRIDGE_UNREACHABLE",
- "CLOUD_CONTROL_DISABLED",
- "ENDPOINT_BUSY",
- "ENDPOINT_LOW_POWER",
- "AUTHORIZATION_CREDENTIAL_INVALID",
- "AUTHORIZATION_CREDENTIAL_EXPIRED",
- "INVALID_DIRECTIVE",
- "INVALID_VALUE",
- "VALUE_OUT_OF_RANGE",
- "NOT_SUPPORTED_IN_CURRENT_MODE",
- "RATE_LIMIT_EXCEEDED",
- "PROVIDER_SERVICE_UNAVAILABLE",
- "PROVIDER_TIMEOUT",
- "PROVIDER_INTERNAL_ERROR",
- "INVALID_PROVIDER_RESPONSE",
- "OUTCOME_UNKNOWN",
- "PRECONDITION_FAILED",
- "AUTH_LINK_NOT_READY",
- "AUTH_LINK_NOT_DISCONNECTABLE",
- "PRECONDITION_REQUIRED",
- "IDEMPOTENCY_KEY_REQUIRED",
- "IDEMPOTENCY_KEY_REUSED",
- "IDEMPOTENCY_KEY_IN_FLIGHT",
- "IDEMPOTENCY_KEY_INVALID",
- "GROUP_MERGED",
- "MULTI_ROOM_UNSUPPORTED",
- "MAP_NOT_ACTIVE",
- "TARGET_UNSUPPORTED",
- "TARGET_AMBIGUOUS",
- "TARGET_GROUP_NOT_FOUND",
- "TARGET_GROUP_DISABLED",
- "DUPLICATE_TARGET_GROUP",
- "MESSAGE_UNSUPPORTED",
- "MESSAGE_AMBIGUOUS",
- "ENDPOINT_DISABLED",
- "ENDPOINT_ROUTE_CHANGED",
- "ENDPOINT_HAS_DEPENDENCIES",
- "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
- "ENDPOINT_COMMITTED_CLEANUP_PENDING",
- "DEEP_QUERY_FAILED",
- "PROVIDER_NO_STATE",
- "EVENT_MANAGEMENT_DISABLED",
- "SUBSCRIPTION_IDENTITY_IMMUTABLE",
- "UNSUPPORTED_MEDIA_TYPE",
- "EVENT_PAYLOAD_TOO_LARGE",
- "REQUEST_BODY_TOO_LARGE",
- "EVENT_IDENTITY_CONFLICT",
- "EVENT_INGRESS_QUOTA_EXCEEDED",
- "EVENT_RECEIPT_EXPIRED",
- "EVENT_STORAGE_UNAVAILABLE",
- "EVENT_DEAD_LETTER_NOT_FOUND",
- "EVENT_REDRIVE_CONFLICT",
- "EVENT_REDRIVE_EXPIRED",
- "RECEIPT_CONTEXT_EXPIRED",
- "EVENT_MAINTENANCE_INCOMPLETE",
- "UNKNOWN_INTERFACE",
- "INVALID_CONFIGURATION",
- "INVALID_PLUGIN_MANIFEST",
- "INVALID_ATTRIBUTE",
- "INVALID_PROVIDER_MESSAGE",
- "UNDECLARED_CAPABILITY",
- "PLUGIN_ROUTE_ID_CONFLICT",
- "UNRESOLVED_REFERENCE",
- "INVALID_RELATIONSHIP",
- "RELATIONSHIP_CYCLE",
- "MULTIPLE_PARENTS",
- "FLOW_VALIDATION_FAILED",
- "PROVIDER_SYNC_UNSUPPORTED"
- ],
- "type": "string"
- },
- "family": {
- "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
- "enum": [
- "NOT_FOUND",
- "BAD_REQUEST",
- "UNAUTHORIZED",
- "FORBIDDEN",
- "CONFLICT",
- "GONE",
- "PRECONDITION_FAILED",
- "PRECONDITION_REQUIRED",
- "PAYLOAD_TOO_LARGE",
- "UNSUPPORTED_MEDIA_TYPE",
- "UNPROCESSABLE_ENTITY",
- "LOCKED",
- "TOO_MANY_REQUESTS",
- "BAD_GATEWAY",
- "SERVICE_UNAVAILABLE",
- "GATEWAY_TIMEOUT",
- "NOT_IMPLEMENTED",
- "INTERNAL_SERVER_ERROR",
- "REQUEST_INVALID",
- "AUTHENTICATION",
- "PERMISSION",
- "ENDPOINT_NOT_FOUND",
- "ENDPOINT_STATE_CONFLICT",
- "ENDPOINT_UNAVAILABLE",
- "RATE_LIMIT",
- "PROVIDER_BAD_RESPONSE",
- "PROVIDER_UNAVAILABLE",
- "PROVIDER_TIMEOUT"
- ],
- "type": "string"
- },
- "interface": {
- "description": "Canonical capability interface name the failure applies to, when the failure is interface-specific.",
- "type": "string"
- },
- "message": {
- "description": "Plain-language description of the failure and the suggested fix.",
- "type": "string"
- },
- "pluginRouteId": {
- "description": "Plugin-owned identifier of the rejected route or group route. Set unless the item is a relationship.",
- "type": "string"
- },
- "relationshipExternalId": {
- "description": "Plugin-owned `externalId` of the rejected relationship. Set only for relationship items.",
- "type": "string"
- },
- "status": {
- "description": "HTTP-equivalent status code of the item failure.",
- "maximum": 599,
- "minimum": 400,
- "type": "integer"
- },
- "version": {
- "description": "Declared capability interface version the failure applies to, when the failure is interface-specific.",
- "type": "string"
- }
- },
- "required": [
- "code",
- "family",
- "status",
- "message"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "family": {
- "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
- "enum": [
- "NOT_FOUND",
- "BAD_REQUEST",
- "UNAUTHORIZED",
- "FORBIDDEN",
- "CONFLICT",
- "GONE",
- "PRECONDITION_FAILED",
- "PRECONDITION_REQUIRED",
- "PAYLOAD_TOO_LARGE",
- "UNSUPPORTED_MEDIA_TYPE",
- "UNPROCESSABLE_ENTITY",
- "LOCKED",
- "TOO_MANY_REQUESTS",
- "BAD_GATEWAY",
- "SERVICE_UNAVAILABLE",
- "GATEWAY_TIMEOUT",
- "NOT_IMPLEMENTED",
- "INTERNAL_SERVER_ERROR",
- "REQUEST_INVALID",
- "AUTHENTICATION",
- "PERMISSION",
- "ENDPOINT_NOT_FOUND",
- "ENDPOINT_STATE_CONFLICT",
- "ENDPOINT_UNAVAILABLE",
- "RATE_LIMIT",
- "PROVIDER_BAD_RESPONSE",
- "PROVIDER_UNAVAILABLE",
- "PROVIDER_TIMEOUT"
- ],
- "type": "string"
- },
- "message": {
- "description": "Plain-language description of the failure and the suggested next action.",
- "type": "string"
- }
- },
- "required": [
- "family",
- "code",
- "message"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "deadline": {
+ "description": "Outstanding deliveries end TIMED_OUT at this deadline; their external outcome remains unknown.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "errors": {
+ "items": {
+ "properties": {
+ "code": {
+ "enum": [
+ "REJECTED",
+ "UNREACHABLE",
+ "NOT_ACCEPTED",
+ "TIMED_OUT"
+ ],
+ "type": "string"
+ },
+ "error": {
+ "description": "The one Port OS error shape, returned by every REST error response and every MCP tool error. `code` names the specific failure and `family` its broad class; both are closed enums, so clients branch on them and show `message`, which says what failed and what to do next.",
+ "properties": {
+ "code": {
+ "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
+ "enum": [
+ "BAD_REQUEST",
+ "UNAUTHORIZED",
+ "FORBIDDEN",
+ "INSUFFICIENT_SCOPE",
+ "NOT_FOUND",
+ "CONFLICT",
+ "UNPROCESSABLE_ENTITY",
+ "UNSUPPORTED_OPERATION",
+ "TOO_MANY_REQUESTS",
+ "SERVICE_UNAVAILABLE",
+ "NOT_IMPLEMENTED",
+ "INTERNAL",
+ "CHECKSUM_MISMATCH",
+ "FILE_TOO_LARGE",
+ "STORAGE_UNAVAILABLE",
+ "INSUFFICIENT_PERMISSIONS",
+ "INVALID_FILE_TYPE",
+ "QUOTA_EXCEEDED",
+ "CONCURRENT_MODIFICATION",
+ "ENDPOINT_UNREACHABLE",
+ "BRIDGE_UNREACHABLE",
+ "CLOUD_CONTROL_DISABLED",
+ "ENDPOINT_BUSY",
+ "ENDPOINT_LOW_POWER",
+ "AUTHORIZATION_CREDENTIAL_INVALID",
+ "AUTHORIZATION_CREDENTIAL_EXPIRED",
+ "INVALID_DIRECTIVE",
+ "INVALID_VALUE",
+ "VALUE_OUT_OF_RANGE",
+ "NOT_SUPPORTED_IN_CURRENT_MODE",
+ "RATE_LIMIT_EXCEEDED",
+ "PROVIDER_SERVICE_UNAVAILABLE",
+ "PROVIDER_TIMEOUT",
+ "PROVIDER_INTERNAL_ERROR",
+ "INVALID_PROVIDER_RESPONSE",
+ "OUTCOME_UNKNOWN",
+ "PRECONDITION_FAILED",
+ "AUTH_LINK_NOT_READY",
+ "AUTH_LINK_NOT_DISCONNECTABLE",
+ "PRECONDITION_REQUIRED",
+ "IDEMPOTENCY_KEY_REQUIRED",
+ "IDEMPOTENCY_KEY_REUSED",
+ "IDEMPOTENCY_KEY_IN_FLIGHT",
+ "IDEMPOTENCY_KEY_INVALID",
+ "GROUP_MERGED",
+ "MULTI_ROOM_UNSUPPORTED",
+ "MAP_NOT_ACTIVE",
+ "TARGET_UNSUPPORTED",
+ "TARGET_AMBIGUOUS",
+ "TARGET_GROUP_NOT_FOUND",
+ "TARGET_GROUP_DISABLED",
+ "DUPLICATE_TARGET_GROUP",
+ "MESSAGE_UNSUPPORTED",
+ "MESSAGE_AMBIGUOUS",
+ "ENDPOINT_DISABLED",
+ "ENDPOINT_ROUTE_CHANGED",
+ "ENDPOINT_HAS_DEPENDENCIES",
+ "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
+ "ENDPOINT_COMMITTED_CLEANUP_PENDING",
+ "DEEP_QUERY_FAILED",
+ "PROVIDER_NO_STATE",
+ "EVENT_MANAGEMENT_DISABLED",
+ "SUBSCRIPTION_IDENTITY_IMMUTABLE",
+ "UNSUPPORTED_MEDIA_TYPE",
+ "EVENT_PAYLOAD_TOO_LARGE",
+ "REQUEST_BODY_TOO_LARGE",
+ "EVENT_IDENTITY_CONFLICT",
+ "EVENT_INGRESS_QUOTA_EXCEEDED",
+ "EVENT_RECEIPT_EXPIRED",
+ "EVENT_STORAGE_UNAVAILABLE",
+ "EVENT_DEAD_LETTER_NOT_FOUND",
+ "EVENT_REDRIVE_CONFLICT",
+ "EVENT_REDRIVE_EXPIRED",
+ "RECEIPT_CONTEXT_EXPIRED",
+ "EVENT_MAINTENANCE_INCOMPLETE",
+ "UNKNOWN_INTERFACE",
+ "INVALID_CONFIGURATION",
+ "INVALID_PLUGIN_MANIFEST",
+ "INVALID_ATTRIBUTE",
+ "INVALID_PROVIDER_MESSAGE",
+ "UNDECLARED_CAPABILITY",
+ "PLUGIN_ROUTE_ID_CONFLICT",
+ "UNRESOLVED_REFERENCE",
+ "INVALID_RELATIONSHIP",
+ "RELATIONSHIP_CYCLE",
+ "MULTIPLE_PARENTS",
+ "FLOW_VALIDATION_FAILED",
+ "PROVIDER_SYNC_UNSUPPORTED"
+ ],
+ "type": "string"
+ },
+ "details": {
+ "description": "Optional typed context for an error. Fields are additive and only populated when the error can safely expose that context to API clients.\n",
+ "properties": {
+ "actual": {
+ "description": "String representation of the submitted value when the plugin can safely report it.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Provider or plugin correlation ID useful for support.",
+ "type": "string"
+ },
+ "correlationToken": {
+ "description": "Token that correlates an outcome-unknown dispatch with its eventual result.",
+ "type": "string"
+ },
+ "currentMode": {
+ "description": "Current endpoint mode when `code` is `NOT_SUPPORTED_IN_CURRENT_MODE`.",
+ "type": "string"
+ },
+ "directive": {
+ "description": "Message namespace and name or provider directive that failed.",
+ "type": "string"
+ },
+ "discoveryEndpointId": {
+ "description": "Port OS provider endpoint (type ENDPOINT_PLUGIN) of the connection to send `discover-routes` to when `code` is `TARGET_UNSUPPORTED` because the route must be rediscovered.",
+ "type": "string"
+ },
+ "endpointId": {
+ "description": "Port OS endpoint ID involved in the failed dispatch.",
+ "type": "string"
+ },
+ "fieldErrors": {
+ "description": "The request fields that were rejected, when the error is about the request's content.",
+ "items": {
+ "description": "One rejected request field of an error.",
+ "properties": {
+ "field": {
+ "description": "Name or JSON path of the rejected field.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Why the field was rejected and what an accepted value looks like.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field",
+ "reason"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "maximum": {
+ "description": "Maximum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
+ "type": "number"
+ },
+ "minimum": {
+ "description": "Minimum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
+ "type": "number"
+ },
+ "parameter": {
+ "description": "Request parameter or capability value that caused the failure.",
+ "type": "string"
+ },
+ "pluginId": {
+ "description": "Port OS plugin ID that reported the failure.",
+ "type": "string"
+ },
+ "pluginRouteId": {
+ "description": "Plugin-owned route identifier involved in the failed dispatch.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Third-party provider or bridge name that reported the failure.",
+ "type": "string"
+ },
+ "providerCode": {
+ "description": "The third-party provider's own error code, for support. It is opaque and provider-specific; branch on `code` and `family` instead.",
+ "type": "string"
+ },
+ "retryAfterSeconds": {
+ "description": "Suggested retry delay for rate-limit or provider-unavailable failures.",
+ "minimum": 0,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "errors": {
+ "description": "Every rejected item when a request that is validated item by item and applied atomically fails, such as a discovery `SynchronizationRequest` whose routes, group routes or relationships are rejected. Omitted for single-item failures.\n",
+ "items": {
+ "description": "One rejected discovery item of a `SynchronizationRequest`, keyed by the plugin-owned identity of the rejected item: `pluginRouteId` for a route or group route, or `relationshipExternalId` for a relationship. Exactly one of the two is set. It shares the `code`, `family`, `status` and `message` fields of `BatchItemError`; discovery items are keyed by plugin-owned identity because they carry no `requestId`. A request with any rejected item is rejected as a whole and lists every rejected item.\n",
+ "properties": {
+ "code": {
+ "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
+ "enum": [
+ "BAD_REQUEST",
+ "UNAUTHORIZED",
+ "FORBIDDEN",
+ "INSUFFICIENT_SCOPE",
+ "NOT_FOUND",
+ "CONFLICT",
+ "UNPROCESSABLE_ENTITY",
+ "UNSUPPORTED_OPERATION",
+ "TOO_MANY_REQUESTS",
+ "SERVICE_UNAVAILABLE",
+ "NOT_IMPLEMENTED",
+ "INTERNAL",
+ "CHECKSUM_MISMATCH",
+ "FILE_TOO_LARGE",
+ "STORAGE_UNAVAILABLE",
+ "INSUFFICIENT_PERMISSIONS",
+ "INVALID_FILE_TYPE",
+ "QUOTA_EXCEEDED",
+ "CONCURRENT_MODIFICATION",
+ "ENDPOINT_UNREACHABLE",
+ "BRIDGE_UNREACHABLE",
+ "CLOUD_CONTROL_DISABLED",
+ "ENDPOINT_BUSY",
+ "ENDPOINT_LOW_POWER",
+ "AUTHORIZATION_CREDENTIAL_INVALID",
+ "AUTHORIZATION_CREDENTIAL_EXPIRED",
+ "INVALID_DIRECTIVE",
+ "INVALID_VALUE",
+ "VALUE_OUT_OF_RANGE",
+ "NOT_SUPPORTED_IN_CURRENT_MODE",
+ "RATE_LIMIT_EXCEEDED",
+ "PROVIDER_SERVICE_UNAVAILABLE",
+ "PROVIDER_TIMEOUT",
+ "PROVIDER_INTERNAL_ERROR",
+ "INVALID_PROVIDER_RESPONSE",
+ "OUTCOME_UNKNOWN",
+ "PRECONDITION_FAILED",
+ "AUTH_LINK_NOT_READY",
+ "AUTH_LINK_NOT_DISCONNECTABLE",
+ "PRECONDITION_REQUIRED",
+ "IDEMPOTENCY_KEY_REQUIRED",
+ "IDEMPOTENCY_KEY_REUSED",
+ "IDEMPOTENCY_KEY_IN_FLIGHT",
+ "IDEMPOTENCY_KEY_INVALID",
+ "GROUP_MERGED",
+ "MULTI_ROOM_UNSUPPORTED",
+ "MAP_NOT_ACTIVE",
+ "TARGET_UNSUPPORTED",
+ "TARGET_AMBIGUOUS",
+ "TARGET_GROUP_NOT_FOUND",
+ "TARGET_GROUP_DISABLED",
+ "DUPLICATE_TARGET_GROUP",
+ "MESSAGE_UNSUPPORTED",
+ "MESSAGE_AMBIGUOUS",
+ "ENDPOINT_DISABLED",
+ "ENDPOINT_ROUTE_CHANGED",
+ "ENDPOINT_HAS_DEPENDENCIES",
+ "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
+ "ENDPOINT_COMMITTED_CLEANUP_PENDING",
+ "DEEP_QUERY_FAILED",
+ "PROVIDER_NO_STATE",
+ "EVENT_MANAGEMENT_DISABLED",
+ "SUBSCRIPTION_IDENTITY_IMMUTABLE",
+ "UNSUPPORTED_MEDIA_TYPE",
+ "EVENT_PAYLOAD_TOO_LARGE",
+ "REQUEST_BODY_TOO_LARGE",
+ "EVENT_IDENTITY_CONFLICT",
+ "EVENT_INGRESS_QUOTA_EXCEEDED",
+ "EVENT_RECEIPT_EXPIRED",
+ "EVENT_STORAGE_UNAVAILABLE",
+ "EVENT_DEAD_LETTER_NOT_FOUND",
+ "EVENT_REDRIVE_CONFLICT",
+ "EVENT_REDRIVE_EXPIRED",
+ "RECEIPT_CONTEXT_EXPIRED",
+ "EVENT_MAINTENANCE_INCOMPLETE",
+ "UNKNOWN_INTERFACE",
+ "INVALID_CONFIGURATION",
+ "INVALID_PLUGIN_MANIFEST",
+ "INVALID_ATTRIBUTE",
+ "INVALID_PROVIDER_MESSAGE",
+ "UNDECLARED_CAPABILITY",
+ "PLUGIN_ROUTE_ID_CONFLICT",
+ "UNRESOLVED_REFERENCE",
+ "INVALID_RELATIONSHIP",
+ "RELATIONSHIP_CYCLE",
+ "MULTIPLE_PARENTS",
+ "FLOW_VALIDATION_FAILED",
+ "PROVIDER_SYNC_UNSUPPORTED"
+ ],
+ "type": "string"
+ },
+ "family": {
+ "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
+ "enum": [
+ "NOT_FOUND",
+ "BAD_REQUEST",
+ "UNAUTHORIZED",
+ "FORBIDDEN",
+ "CONFLICT",
+ "GONE",
+ "PRECONDITION_FAILED",
+ "PRECONDITION_REQUIRED",
+ "PAYLOAD_TOO_LARGE",
+ "UNSUPPORTED_MEDIA_TYPE",
+ "UNPROCESSABLE_ENTITY",
+ "LOCKED",
+ "TOO_MANY_REQUESTS",
+ "BAD_GATEWAY",
+ "SERVICE_UNAVAILABLE",
+ "GATEWAY_TIMEOUT",
+ "NOT_IMPLEMENTED",
+ "INTERNAL_SERVER_ERROR",
+ "REQUEST_INVALID",
+ "AUTHENTICATION",
+ "PERMISSION",
+ "ENDPOINT_NOT_FOUND",
+ "ENDPOINT_STATE_CONFLICT",
+ "ENDPOINT_UNAVAILABLE",
+ "RATE_LIMIT",
+ "PROVIDER_BAD_RESPONSE",
+ "PROVIDER_UNAVAILABLE",
+ "PROVIDER_TIMEOUT"
+ ],
+ "type": "string"
+ },
+ "interface": {
+ "description": "Canonical capability interface name the failure applies to, when the failure is interface-specific.",
+ "type": "string"
+ },
+ "message": {
+ "description": "Plain-language description of the failure and the suggested fix.",
+ "type": "string"
+ },
+ "pluginRouteId": {
+ "description": "Plugin-owned identifier of the rejected route or group route. Set unless the item is a relationship.",
+ "type": "string"
+ },
+ "relationshipExternalId": {
+ "description": "Plugin-owned `externalId` of the rejected relationship. Set only for relationship items.",
+ "type": "string"
+ },
+ "status": {
+ "description": "HTTP-equivalent status code of the item failure.",
+ "maximum": 599,
+ "minimum": 400,
+ "type": "integer"
+ },
+ "version": {
+ "description": "Declared capability interface version the failure applies to, when the failure is interface-specific.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "family",
+ "status",
+ "message"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "family": {
+ "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
+ "enum": [
+ "NOT_FOUND",
+ "BAD_REQUEST",
+ "UNAUTHORIZED",
+ "FORBIDDEN",
+ "CONFLICT",
+ "GONE",
+ "PRECONDITION_FAILED",
+ "PRECONDITION_REQUIRED",
+ "PAYLOAD_TOO_LARGE",
+ "UNSUPPORTED_MEDIA_TYPE",
+ "UNPROCESSABLE_ENTITY",
+ "LOCKED",
+ "TOO_MANY_REQUESTS",
+ "BAD_GATEWAY",
+ "SERVICE_UNAVAILABLE",
+ "GATEWAY_TIMEOUT",
+ "NOT_IMPLEMENTED",
+ "INTERNAL_SERVER_ERROR",
+ "REQUEST_INVALID",
+ "AUTHENTICATION",
+ "PERMISSION",
+ "ENDPOINT_NOT_FOUND",
+ "ENDPOINT_STATE_CONFLICT",
+ "ENDPOINT_UNAVAILABLE",
+ "RATE_LIMIT",
+ "PROVIDER_BAD_RESPONSE",
+ "PROVIDER_UNAVAILABLE",
+ "PROVIDER_TIMEOUT"
+ ],
+ "type": "string"
+ },
+ "message": {
+ "description": "Plain-language description of the failure and the suggested next action.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "family",
+ "code",
+ "message"
+ ],
+ "type": "object"
+ },
+ "routeId": {
+ "type": "string"
+ },
+ "targetId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "targetId",
+ "code"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Server assigned durable request identifier.",
+ "type": "string"
+ },
+ "results": {
+ "items": {
+ "properties": {
+ "message": {
+ "description": "The message that was responded with when there was a unary message response, exactly one of the outbound capability messages. A synchronous send can return one; an acknowledgment with no message back leaves this empty. The header namespace, name and version select the variant and the body schema.",
+ "oneOf": [
+ {
+ "description": "The `authorization-established` message (version 1.0) of the `port1/systems/zero/capability-interfaces/authorization` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The authorization established message is sent to a plugin to indicate that the plugin has been installed and authorized for a principal",
+ "properties": {
+ "authlinkId": {
+ "description": "The id of the authorized link between the principal and the plugin",
+ "type": "string"
+ },
+ "pluginAccessToken": {
+ "description": "The access token of the authorization link representing the principal as understood by the plugin",
+ "type": "string"
+ },
+ "portosAccessToken": {
+ "description": "The access token of the authorization link representing the principala as understood by port OS",
+ "type": "string"
+ }
+ },
+ "required": [
+ "portosAccessToken",
+ "authlinkId"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "authorization-established"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/authorization"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `authorization-update-report` message (version 1.0) of the `port1/systems/zero/capability-interfaces/authorization` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Report refreshed credentials for an authorization, including the new access token, refresh token and expiry time.",
+ "properties": {
+ "accessToken": {
+ "description": "The access token to refresh",
+ "type": "string"
+ },
+ "authlinkId": {
+ "description": "The id of the auth link to update",
+ "type": "string"
+ },
+ "customMetadata": {
+ "additionalProperties": true,
+ "description": "Custom metadata to attach to the authorization update report",
+ "type": "object"
+ },
+ "expiryTime": {
+ "description": "The expiry time in seconds from current time",
+ "format": "int64",
+ "type": "integer"
+ },
+ "refreshToken": {
+ "description": "The refresh token to refresh",
+ "type": "string"
+ },
+ "secretId": {
+ "description": "The id of the secret to update",
+ "type": "string"
+ }
+ },
+ "required": [
+ "refreshToken",
+ "accessToken",
+ "expiryTime"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "authorization-update-report"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/authorization"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `authorization-status` message (version 1.0) of the `port1/systems/zero/capability-interfaces/authorization-requirements` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Redacted saved authorization status. Contains no pattern, PIN or ciphertext.",
+ "properties": {
+ "requirementId": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "MISSING",
+ "CONFIGURED",
+ "NEEDS_UPDATE"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "requirementId",
+ "status"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "authorization-status"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/authorization-requirements"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `list-events-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/calendar-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Response containing a list of events from a calendar provider",
+ "properties": {
+ "events": {
+ "items": {
+ "description": "A calendar event",
+ "properties": {
+ "allDay": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "string"
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "eventId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "events"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "list-events-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/calendar-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `event-image-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/camera` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Event image URL and provider token returned for a get-event-image request.",
+ "properties": {
+ "token": {
+ "type": "string"
+ },
+ "url": {
+ "format": "uri",
+ "type": "string"
+ }
+ },
+ "required": [
+ "url",
+ "token"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "event-image-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/camera"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `list-contacts-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/contacts-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Response containing a list of contacts from a contacts provider",
+ "properties": {
+ "contacts": {
+ "items": {
+ "description": "A contact entry",
+ "properties": {
+ "companyName": {
+ "type": "string"
+ },
+ "contactId": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "contactId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "contacts"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "list-contacts-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/contacts-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `group-routes-changed` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-route-groups-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Confirmed provider state after a group create, delete, membership change or rename. Both arrays are explicit read-back data from the provider, scoped to the authenticated publisher's provider account. Include the full current state of every affected surviving group route, including source groups changed by exclusive membership. Report retired routes only in retiredPluginRouteIds. Unrelated group routes are unchanged; this is not a complete account listing.",
+ "properties": {
+ "groupRoutes": {
+ "description": "Full current provider state of every affected surviving group route.",
+ "items": {
+ "description": "A provider-reported group route (for example a vacuum map or room, a lighting room or a speaker group) as carried by discovery. It is shared by the route-discovery report message and `SynchronizationRequest.groupRoutes` so both decode to the same model.\n",
+ "properties": {
+ "interfaces": {
+ "items": {
+ "properties": {
+ "attributes": {
+ "description": "Supported attribute subset. An omitted or empty list declares no supported attributes.",
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The name of the attribute",
+ "type": "string"
+ },
+ "value": {
+ "additionalProperties": true,
+ "description": "the value of the attribute, this is an opaque resource object, so it can be any type of struct.",
+ "type": "object"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "configuration": {
+ "additionalProperties": true,
+ "description": "The configuration of the interface",
+ "type": "object"
+ },
+ "messages": {
+ "description": "Supported inbound message subset for the declared interface version. An omitted or empty list declares no supported messages; null also declares none. A supplied array contains distinct canonical names for implemented messages.",
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The name of the command",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "name": {
+ "description": "The name of the interface",
+ "type": "string"
+ },
+ "version": {
+ "description": "the version of the interface",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "memberPluginRouteIds": {
+ "description": "Full current native membership; an empty array explicitly reports an empty route.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "uniqueItems": true
+ },
+ "name": {
+ "description": "The name of the associated group route",
+ "type": "string"
+ },
+ "ontologicalTypes": {
+ "description": "Actual classifications of the native group route, constrained by its selected plugin profile for V2 discovery.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pluginCustomMetadata": {
+ "additionalProperties": true,
+ "description": "Private plugin metadata (native map, segment or cloud room addressing) returned to the plugin on dispatch; never exposed as application data. A route declaring the canonical SPATIAL geometry capability can carry a valid SpatialInterfaceGeometryAttribute in geometry. Only that canonical geometry's observedAt is observation time rather than a meaningful group-etag contribution; it is still stored. Geometry shape, frame, native context and all other metadata remain meaningful.\n",
+ "type": "object"
+ },
+ "pluginProfileId": {
+ "description": "Stable group-route profile ID selected from the registered V2 plugin declaration.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "pluginRouteId": {
+ "description": "Plugin-owned stable identifier of the group route. Must be unique across routes and group routes within one plugin and auth link.\n",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "pluginRouteId",
+ "name",
+ "pluginProfileId",
+ "ontologicalTypes",
+ "interfaces",
+ "memberPluginRouteIds"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "retiredPluginRouteIds": {
+ "description": "Provider-native pluginRouteIds of affected group routes confirmed absent after the mutation, including a delete whose target was already absent.",
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "type": "array",
+ "uniqueItems": true
+ }
+ },
+ "required": [
+ "groupRoutes",
+ "retiredPluginRouteIds"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "group-routes-changed"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/control-route-groups-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `acknowledged` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Response to acknowledge a message was dispatched, it confirms that a message was dispatched, but not necessarily that it did anything. Consider this to happen on any infrared based device (TV remotes), where no ack is feasible.",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "acknowledged"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/control-routes-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `attribute-report` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Response to report attributes of a control route",
+ "properties": {
+ "items": {
+ "items": {
+ "description": "A control route item with associated plugin route and attributes",
+ "properties": {
+ "associatedPluginRouteId": {
+ "type": "string"
+ },
+ "attributes": {
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The name of the attribute",
+ "type": "string"
+ },
+ "namespace": {
+ "description": "The namespace of the attribute",
+ "type": "string"
+ },
+ "sampledAt": {
+ "description": "Actual observation time in UTC; omit when unknown. Request time is not a sample time.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the attribute",
+ "type": "object"
+ },
+ "version": {
+ "description": "The version of the attribute",
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version",
+ "value"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "unavailableAttributes": {
+ "description": "Exact attributes freshly found unavailable by a successful correlated native-group report-attributes read. Presence, including an empty list, is unsupported for endpoint, capability-query, proactive or uncorrelated reports. These identities carry no value or sample time; omission is not an unavailable acknowledgement. Upgrade consuming hosts before providers emit this field.",
+ "items": {
+ "description": "The exact identity of an attribute requested from a provider, without an observed value.",
+ "properties": {
+ "name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "namespace": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "version": {
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "type": "object"
+ },
+ "type": "array",
+ "uniqueItems": true
+ }
+ },
+ "required": [
+ "associatedPluginRouteId",
+ "attributes"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "items"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "attribute-report"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/control-routes-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `batch-dispatch-results` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Per-item batch admission and replies. Reports may contain a completed subset; omitted or pending items must not be treated as successful. Item IDs must be unique and belong to the request.",
+ "properties": {
+ "items": {
+ "items": {
+ "additionalProperties": false,
+ "description": "One outcome entry correlated to the request's itemId. ACKNOWLEDGED and PENDING record progress without a terminal reply; REPLIED carries a reply and REJECTED carries a definite item error. Missing entries remain unresolved.",
+ "oneOf": [
+ {
+ "description": "Admits ACKNOWLEDGED or PENDING progress entries. Neither state carries a reply or error; both leave the item's final outcome unconfirmed.",
+ "not": {
+ "anyOf": [
+ {
+ "required": [
+ "reply"
+ ]
+ },
+ {
+ "required": [
+ "error"
+ ]
+ }
+ ]
+ },
+ "properties": {
+ "status": {
+ "enum": [
+ "ACKNOWLEDGED",
+ "PENDING"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ {
+ "description": "Requires a correlated reply for a REPLIED item and excludes an item error. The reply's declared message determines the operation result.",
+ "not": {
+ "required": [
+ "error"
+ ]
+ },
+ "properties": {
+ "status": {
+ "enum": [
+ "REPLIED"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "reply"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "Requires a definite per-item error for REJECTED and excludes a reply. The other items retain their independently reported outcomes.",
+ "not": {
+ "required": [
+ "reply"
+ ]
+ },
+ "properties": {
+ "status": {
+ "enum": [
+ "REJECTED"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "error"
+ ],
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "error": {
+ "description": "Canonical Port OS plugin dispatch error. This contract is used when a plugin reports a third-party service, bridge, or device failure during message dispatch. It is inspired by Alexa-style error responses, but the type and family values are Port OS-specific.\n",
+ "properties": {
+ "code": {
+ "description": "Opaque plugin or provider debug code suitable for support.",
+ "type": "string"
+ },
+ "details": {
+ "description": "Optional typed context for an error. Fields are additive and only populated when the error can safely expose that context to API clients.\n",
+ "properties": {
+ "actual": {
+ "description": "String representation of the submitted value when the plugin can safely report it.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Provider or plugin correlation ID useful for support.",
+ "type": "string"
+ },
+ "correlationToken": {
+ "description": "Token that correlates an outcome-unknown dispatch with its eventual result.",
+ "type": "string"
+ },
+ "currentMode": {
+ "description": "Current endpoint mode when `code` is `NOT_SUPPORTED_IN_CURRENT_MODE`.",
+ "type": "string"
+ },
+ "directive": {
+ "description": "Message namespace and name or provider directive that failed.",
+ "type": "string"
+ },
+ "discoveryEndpointId": {
+ "description": "Port OS provider endpoint (type ENDPOINT_PLUGIN) of the connection to send `discover-routes` to when `code` is `TARGET_UNSUPPORTED` because the route must be rediscovered.",
+ "type": "string"
+ },
+ "endpointId": {
+ "description": "Port OS endpoint ID involved in the failed dispatch.",
+ "type": "string"
+ },
+ "fieldErrors": {
+ "description": "The request fields that were rejected, when the error is about the request's content.",
+ "items": {
+ "description": "One rejected request field of an error.",
+ "properties": {
+ "field": {
+ "description": "Name or JSON path of the rejected field.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Why the field was rejected and what an accepted value looks like.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field",
+ "reason"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "maximum": {
+ "description": "Maximum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
+ "type": "number"
+ },
+ "minimum": {
+ "description": "Minimum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
+ "type": "number"
+ },
+ "parameter": {
+ "description": "Request parameter or capability value that caused the failure.",
+ "type": "string"
+ },
+ "pluginId": {
+ "description": "Port OS plugin ID that reported the failure.",
+ "type": "string"
+ },
+ "pluginRouteId": {
+ "description": "Plugin-owned route identifier involved in the failed dispatch.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Third-party provider or bridge name that reported the failure.",
+ "type": "string"
+ },
+ "providerCode": {
+ "description": "The third-party provider's own error code, for support. It is opaque and provider-specific; branch on `code` and `family` instead.",
+ "type": "string"
+ },
+ "retryAfterSeconds": {
+ "description": "Suggested retry delay for rate-limit or provider-unavailable failures.",
+ "minimum": 0,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "family": {
+ "description": "Canonical plugin dispatch error family. The family controls the default `/messages` HTTP status mapping for plugin-originated failures.\n",
+ "enum": [
+ "REQUEST_INVALID",
+ "AUTHENTICATION",
+ "PERMISSION",
+ "ENDPOINT_NOT_FOUND",
+ "ENDPOINT_STATE_CONFLICT",
+ "ENDPOINT_UNAVAILABLE",
+ "RATE_LIMIT",
+ "PROVIDER_BAD_RESPONSE",
+ "PROVIDER_UNAVAILABLE",
+ "PROVIDER_TIMEOUT"
+ ],
+ "type": "string"
+ },
+ "message": {
+ "description": "Human-readable explanation of the plugin dispatch failure.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Canonical machine-readable plugin dispatch error type. Plugins use these values when a third-party service, bridge, or device cannot complete a message dispatch.\n",
+ "enum": [
+ "ENDPOINT_UNREACHABLE",
+ "BRIDGE_UNREACHABLE",
+ "CLOUD_CONTROL_DISABLED",
+ "ENDPOINT_BUSY",
+ "ENDPOINT_LOW_POWER",
+ "AUTHORIZATION_CREDENTIAL_INVALID",
+ "AUTHORIZATION_CREDENTIAL_EXPIRED",
+ "INSUFFICIENT_PERMISSIONS",
+ "INVALID_DIRECTIVE",
+ "INVALID_VALUE",
+ "VALUE_OUT_OF_RANGE",
+ "NOT_SUPPORTED_IN_CURRENT_MODE",
+ "MAP_NOT_ACTIVE",
+ "RATE_LIMIT_EXCEEDED",
+ "PROVIDER_SERVICE_UNAVAILABLE",
+ "PROVIDER_TIMEOUT",
+ "PROVIDER_INTERNAL_ERROR"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "family",
+ "code",
+ "message"
+ ],
+ "type": "object"
+ },
+ "itemId": {
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9._:-]+$",
+ "type": "string"
+ },
+ "reply": {
+ "description": "Correlated capability reply for one batch item. The header selects the reply schema; admission validates its body against the declared capability. The correlated message determines the reported operation outcome.",
+ "properties": {
+ "body": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "header": {
+ "description": "Canonical capability message identity for one batch operation or its reply. Namespace, name and version select the declared message schema used to validate that item.",
+ "properties": {
+ "name": {
+ "maxLength": 128,
+ "minLength": 1,
+ "type": "string"
+ },
+ "namespace": {
+ "maxLength": 256,
+ "minLength": 1,
+ "type": "string"
+ },
+ "version": {
+ "maxLength": 32,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ "status": {
+ "description": "ACKNOWLEDGED accepts delivery only; PENDING awaits a correlated reply; REPLIED carries that reply; REJECTED carries a definite item failure. Missing results and pending items remain uncertain until timeout.",
+ "enum": [
+ "ACKNOWLEDGED",
+ "PENDING",
+ "REPLIED",
+ "REJECTED"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "itemId",
+ "status"
+ ],
+ "type": "object"
+ },
+ "maxItems": 100,
+ "minItems": 1,
+ "type": "array"
+ }
+ },
+ "required": [
+ "items"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "batch-dispatch-results"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/control-routes-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `deferred-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Acknowledges dispatch when the device is expected to return its result later.\nA terminal response must arrive before the configured request deadline.",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "deferred-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/control-routes-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `error-dispatch` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Response to acknowledge a message was dispatched, it confirms that a message was dispatched, and that the result was not successful.",
+ "properties": {
+ "error": {
+ "description": "An error from a dispatch operation",
+ "properties": {
+ "code": {
+ "description": "The code of the error, an opaque error code that can be given for debugging purposes.",
+ "type": "string"
+ },
+ "family": {
+ "description": "The family of the error, an enum which denotes a general set of issues similar to the http error set. Some examples are BAD_REQUEST, SYSTEM_ERROR, etc.",
+ "type": "string"
+ },
+ "message": {
+ "description": "The message of the error, a human readable message that describes the error.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the error, an enum which denotes a specific type of error that belongs to a family of errors.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "error-dispatch"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/control-routes-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `successful-dispatch` message (version 1.0) of the `port1/systems/zero/capability-interfaces/control-routes-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Response to acknowledge a message was successfully dispatched, it confirms that a message was dispatched, and that the result was successful.",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "successful-dispatch"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/control-routes-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `chime` message (version 1.0) of the `port1/systems/zero/capability-interfaces/doorbell` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "A distinct doorbell press. A chime does not imply a door was opened.",
+ "properties": {
+ "value": {
+ "enum": [
+ "PRESSED"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "chime"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/doorbell"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `embedding-uri` message (version 1.0) of the `port1/systems/zero/capability-interfaces/embedding-generation` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The result of an embedding request: the location, format and MIME type of the generated embedding.",
+ "properties": {
+ "format": {
+ "description": "Format of the embedding (e.g., safetensors, onnx)",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type of the embedding resource",
+ "type": "string"
+ },
+ "uri": {
+ "description": "URL of the generated embedding resource",
+ "type": "string"
+ }
+ },
+ "required": [
+ "uri"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "embedding-uri"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/embedding-generation"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `endpoint-updated` message (version 1.0) of the `port1/systems/zero/capability-interfaces/endpoint-registry` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Port OS emitted a durable endpoint metadata or enablement change. Delivery is best effort.",
+ "properties": {
+ "enablement": {
+ "description": "Whether Port OS permits messages to be sent to this endpoint.",
+ "enum": [
+ "ENABLED",
+ "DISABLED"
+ ],
+ "type": "string"
+ },
+ "endpointId": {
+ "description": "Full Port OS endpoint identifier.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Current endpoint name.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Current ontological endpoint type.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "endpointId",
+ "name",
+ "type",
+ "enablement"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "endpoint-updated"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/endpoint-registry"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `person-detected` message (version 1.0) of the `port1/systems/zero/capability-interfaces/event-detection-sensor` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "A distinct person detection occurrence, independent of cached presence state.",
+ "properties": {
+ "value": {
+ "enum": [
+ "DETECTED"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "person-detected"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/event-detection-sensor"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `delete-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The provider confirmed deletion of the requested file.",
+ "title": "FilesystemProviderInterfaceDeleteFileResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "delete-file-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/filesystem-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `download-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Download file response.",
+ "properties": {
+ "expiresAt": {
+ "description": "Expiration of the download URL, if supplied by the provider.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "uri": {
+ "description": "Provider URL for downloading the file.",
+ "format": "uri",
+ "type": "string"
+ }
+ },
+ "required": [
+ "uri"
+ ],
+ "title": "FilesystemProviderInterfaceDownloadFileResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "download-file-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/filesystem-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `list-albums-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Response containing a list of photo albums from a filesystem provider",
+ "properties": {
+ "albums": {
+ "items": {
+ "description": "A photo album",
+ "properties": {
+ "albumId": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "photoCount": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "albumId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "nextCursor": {
+ "description": "Opaque cursor for the next page; omitted when there are no further results.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "albums"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "list-albums-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/filesystem-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `list-folder-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Response containing a list of files and folders from a filesystem provider",
+ "properties": {
+ "folderId": {
+ "description": "Current folder identifier, including the provider root when returned. Use it as a destination for upload or move.",
+ "type": "string"
+ },
+ "items": {
+ "items": {
+ "description": "A cloud storage item (file or folder)",
+ "properties": {
+ "extension": {
+ "type": "string"
+ },
+ "itemId": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "size": {
+ "description": "File size in bytes",
+ "format": "int64",
+ "type": "integer"
+ },
+ "type": {
+ "description": "Item type: FILE, FOLDER, or APP_LIBRARY",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "nextCursor": {
+ "description": "Opaque cursor for the next page; omitted when there are no further results.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "items"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "list-folder-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/filesystem-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `move-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Verified file selection after the operation; use this fileId for subsequent reads or writes.",
+ "properties": {
+ "fileId": {
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "fileId"
+ ],
+ "title": "FilesystemProviderInterfaceMoveFileResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "move-file-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/filesystem-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `rename-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Verified file selection after the operation; use this fileId for subsequent reads or writes.",
+ "properties": {
+ "fileId": {
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "fileId"
+ ],
+ "title": "FilesystemProviderInterfaceRenameFileResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "rename-file-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/filesystem-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `upload-file-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/filesystem-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Upload file response.",
+ "properties": {
+ "fileId": {
+ "description": "Provider identifier of the uploaded file.",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "fileId"
+ ],
+ "title": "FilesystemProviderInterfaceUploadFileResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "upload-file-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/filesystem-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `complete` message (version 1.0) of the `port1/systems/zero/capability-interfaces/flows` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Reports that a flow has finished, with its completion status, result and duration.",
+ "properties": {
+ "duration": {
+ "description": "Total execution duration in milliseconds",
+ "minimum": 0,
+ "type": "number"
+ },
+ "flowId": {
+ "description": "Unique identifier for the completed flow",
+ "minLength": 1,
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": true,
+ "description": "Additional metadata for the completion",
+ "type": "object"
+ },
+ "result": {
+ "additionalProperties": true,
+ "description": "Flow execution result",
+ "type": "object"
+ },
+ "status": {
+ "description": "Completion status",
+ "enum": [
+ "SUCCESS",
+ "FAILURE",
+ "CANCELLED",
+ "TIMEOUT"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "flowId",
+ "status",
+ "duration"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "complete"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/flows"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `message-ack` message (version 1.0) of the `port1/systems/zero/capability-interfaces/flows` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Reports that a flow message was acknowledged.",
+ "properties": {
+ "ackId": {
+ "description": "Unique identifier for this acknowledgment",
+ "minLength": 1,
+ "type": "string"
+ },
+ "flowId": {
+ "description": "Unique identifier for the flow",
+ "minLength": 1,
+ "type": "string"
+ },
+ "messageId": {
+ "description": "Unique identifier for the acknowledged message",
+ "minLength": 1,
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": true,
+ "description": "Additional metadata for the acknowledgment",
+ "type": "object"
+ },
+ "status": {
+ "description": "Acknowledgment status",
+ "enum": [
+ "RECEIVED",
+ "PROCESSED",
+ "FAILED"
+ ],
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Acknowledgment timestamp",
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "required": [
+ "flowId",
+ "messageId",
+ "ackId",
+ "status",
+ "timestamp"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "message-ack"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/flows"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `message-unack` message (version 1.0) of the `port1/systems/zero/capability-interfaces/flows` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Reports that a flow message was not acknowledged, with the reason.",
+ "properties": {
+ "flowId": {
+ "description": "Unique identifier for the flow",
+ "minLength": 1,
+ "type": "string"
+ },
+ "messageId": {
+ "description": "Unique identifier for the unacknowledged message",
+ "minLength": 1,
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": true,
+ "description": "Additional metadata for the unacknowledgment",
+ "type": "object"
+ },
+ "reason": {
+ "description": "Reason for unacknowledgment",
+ "enum": [
+ "TIMEOUT",
+ "ERROR",
+ "REJECTED",
+ "DUPLICATE"
+ ],
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "Unacknowledgment timestamp",
+ "format": "date-time",
+ "type": "string"
+ },
+ "unackId": {
+ "description": "Unique identifier for this unacknowledgment",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "flowId",
+ "messageId",
+ "unackId",
+ "reason",
+ "timestamp"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "message-unack"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/flows"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `node-complete` message (version 1.0) of the `port1/systems/zero/capability-interfaces/flows` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Reports that a node in a flow has finished, with its status, result and the nodes that run next.",
+ "properties": {
+ "duration": {
+ "description": "Node execution duration in milliseconds",
+ "minimum": 0,
+ "type": "number"
+ },
+ "flowId": {
+ "description": "Unique identifier for the flow",
+ "minLength": 1,
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": true,
+ "description": "Additional metadata for the node completion",
+ "type": "object"
+ },
+ "nextNodes": {
+ "description": "List of next node IDs to execute",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "nodeId": {
+ "description": "Unique identifier for the completed node",
+ "minLength": 1,
+ "type": "string"
+ },
+ "result": {
+ "additionalProperties": true,
+ "description": "Node execution result",
+ "type": "object"
+ },
+ "status": {
+ "description": "Node completion status",
+ "enum": [
+ "SUCCESS",
+ "FAILURE",
+ "SKIPPED",
+ "TIMEOUT"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "flowId",
+ "nodeId",
+ "status",
+ "duration"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "node-complete"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/flows"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `image-generated` message (version 1.0) of the `port1/systems/zero/capability-interfaces/image-generation` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The image produced by generate-image, as a short-lived URL or inline base64 according to the responseFormat of the request",
+ "properties": {
+ "image": {
+ "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
+ "properties": {
+ "byteLength": {
+ "description": "Size of the decoded bytes. Always present on host responses.",
+ "maximum": 26214400,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "data": {
+ "description": "Base64 encoded bytes, at most 10 MiB decoded.",
+ "format": "byte",
+ "maxLength": 13981016,
+ "type": "string"
+ },
+ "durationMs": {
+ "description": "Duration of audio in milliseconds, when known.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "expiresAt": {
+ "description": "When `url` stops working. Present with `url` on host responses.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "height": {
+ "description": "Image height in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "mimeType": {
+ "description": "The media type of the bytes.",
+ "enum": [
+ "audio/mpeg",
+ "audio/wav",
+ "audio/ogg",
+ "audio/flac",
+ "image/png",
+ "image/jpeg",
+ "image/webp"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
+ "type": "string"
+ },
+ "width": {
+ "description": "Image width in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "mimeType"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "image"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "image-generated"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/image-generation"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `audio` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-player` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Audio data the player sends, with the stream ID, sequence, and whether it is the final chunk.",
+ "properties": {
+ "audioData": {
+ "description": "Base64 encoded audio data",
+ "format": "base64",
+ "type": "string"
+ },
+ "duration": {
+ "description": "Audio duration in seconds",
+ "minimum": 0,
+ "type": "number"
+ },
+ "isFinal": {
+ "default": false,
+ "description": "Whether the audio is the final chunk",
+ "type": "boolean"
+ },
+ "mimeType": {
+ "default": "audio/ogg",
+ "description": "Audio MIME type",
+ "type": "string"
+ },
+ "rawBytes": {
+ "description": "Audio raw bytes",
+ "format": "binary",
+ "type": "string"
+ },
+ "sequenceId": {
+ "description": "Number of audio channels",
+ "type": "integer"
+ },
+ "streamId": {
+ "default": "default",
+ "description": "Audio stream ID",
+ "type": "string"
+ },
+ "text": {
+ "default": "",
+ "description": "Audio text",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "audio"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/media-player"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `audio-stream` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-player` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "A chunk of an audio stream the player sends, with its stream ID and sequence, and whether it is the final chunk.",
+ "properties": {
+ "audioData": {
+ "description": "Base64 encoded audio data",
+ "format": "base64",
+ "type": "string"
+ },
+ "isFinal": {
+ "default": false,
+ "description": "Whether this is the final chunk in the stream",
+ "type": "boolean"
+ },
+ "rawBytes": {
+ "description": "Audio raw bytes",
+ "format": "binary",
+ "type": "string"
+ },
+ "sequenceId": {
+ "description": "Sequence ID for this audio stream",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "streamId": {
+ "description": "Unique identifier for this audio stream",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "streamId",
+ "sequenceId",
+ "isFinal"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "audio-stream"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/media-player"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `playlist-contents` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-playlist` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "A bounded playlist page containing playable tracks or episodes.",
+ "properties": {
+ "episodes": {
+ "items": {
+ "description": "Provider-qualified podcast episode with selection metadata.",
+ "properties": {
+ "id": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ },
+ "name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "releaseDate": {
+ "description": "Provider release date; precision can be year, month or day.",
+ "type": "string"
+ },
+ "releaseDatePrecision": {
+ "description": "Provider date precision.",
+ "type": "string"
+ },
+ "showId": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "nextToken": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "playlistId": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ },
+ "tracks": {
+ "items": {
+ "description": "Track information",
+ "properties": {
+ "album": {
+ "allOf": [
+ {
+ "description": "Album information",
+ "properties": {
+ "artists": {
+ "description": "Album artists",
+ "items": {
+ "description": "Artist information",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the artist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Artist name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for the album",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Album name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "artists"
+ ],
+ "type": "object"
+ }
+ ],
+ "description": "Track album when supplied by the provider. Omitted for sources such as YouTube videos that do not supply album metadata."
+ },
+ "artists": {
+ "description": "Track artists",
+ "items": {
+ "description": "Artist information",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the artist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Artist name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for the track",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Track name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "artists"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "playlistId",
+ "tracks",
+ "episodes"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "playlist-contents"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/media-playlist"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `playlist-mutation-result` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-playlist` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Provider acknowledgement for one playlist mutation. Re-read contents to verify the requested outcome. A partial result must not be retried automatically.",
+ "properties": {
+ "applied": {
+ "description": "Whether all requested steps were acknowledged. False can mean playlist creation succeeded but initial track insertion did not.",
+ "type": "boolean"
+ },
+ "detail": {
+ "type": "string"
+ },
+ "playlistId": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "snapshotId": {
+ "description": "Provider revision acknowledging the change, when returned.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "playlistId",
+ "applied"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "playlist-mutation-result"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/media-playlist"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `playlists` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-playlist` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "A page of the connected customer's playlists with exact resource IDs.",
+ "properties": {
+ "nextToken": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "playlists": {
+ "items": {
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the playlist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Playlist name",
+ "minLength": 1,
+ "type": "string"
+ },
+ "ownerId": {
+ "description": "Provider-scoped owner identity, when supplied by the provider.",
+ "type": "string"
+ },
+ "ownerName": {
+ "description": "Owner display name, useful for distinguishing owned and followed playlists.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "playlists"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "playlists"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/media-playlist"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `queue-contents` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-queue` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Observed queue items in playback order, including intentional duplicates. This is a point-in-time provider observation; it is not a saved playlist or proof of audible output.",
+ "properties": {
+ "complete": {
+ "description": "True only when these items describe the whole upcoming queue. False means the provider supplies a bounded window without a continuation cursor; do not treat omitted items as absent.",
+ "type": "boolean"
+ },
+ "currentMediaId": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ },
+ "mediaIds": {
+ "description": "Upcoming media IDs in provider playback order. The currently playing item is separate.",
+ "items": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "queueVersion": {
+ "description": "Opaque queue revision for conditional edits when the route requires it. A revision describes hosted contents, not audible playback or player refresh completion.",
+ "maxLength": 256,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "mediaIds",
+ "complete"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "queue-contents"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/media-queue"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `audio-media-results` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-search` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The results of an audio search: matching artists, albums, tracks, playlists, shows and episodes.",
+ "properties": {
+ "albums": {
+ "description": "Album results",
+ "items": {
+ "description": "Album information",
+ "properties": {
+ "artists": {
+ "description": "Album artists",
+ "items": {
+ "description": "Artist information",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the artist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Artist name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for the album",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Album name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "artists"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "artists": {
+ "description": "Artist results",
+ "items": {
+ "description": "Artist information",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the artist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Artist name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "episodes": {
+ "items": {
+ "description": "Provider-qualified podcast episode with selection metadata.",
+ "properties": {
+ "id": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ },
+ "name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "releaseDate": {
+ "description": "Provider release date; precision can be year, month or day.",
+ "type": "string"
+ },
+ "releaseDatePrecision": {
+ "description": "Provider date precision.",
+ "type": "string"
+ },
+ "showId": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "nextToken": {
+ "description": "Opaque continuation for the same search; omit when exhausted.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "playlists": {
+ "description": "Playlist results",
+ "items": {
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the playlist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Playlist name",
+ "minLength": 1,
+ "type": "string"
+ },
+ "ownerId": {
+ "description": "Provider-scoped owner identity, when supplied by the provider.",
+ "type": "string"
+ },
+ "ownerName": {
+ "description": "Owner display name, useful for distinguishing owned and followed playlists.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "shows": {
+ "items": {
+ "description": "Provider-qualified podcast series; read episodes before playback.",
+ "properties": {
+ "id": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ },
+ "name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "publisher": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "tracks": {
+ "description": "Track results",
+ "items": {
+ "description": "Track information",
+ "properties": {
+ "album": {
+ "allOf": [
+ {
+ "description": "Album information",
+ "properties": {
+ "artists": {
+ "description": "Album artists",
+ "items": {
+ "description": "Artist information",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the artist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Artist name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for the album",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Album name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "artists"
+ ],
+ "type": "object"
+ }
+ ],
+ "description": "Track album when supplied by the provider. Omitted for sources such as YouTube videos that do not supply album metadata."
+ },
+ "artists": {
+ "description": "Track artists",
+ "items": {
+ "description": "Artist information",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the artist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Artist name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for the track",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Track name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "artists"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "artists",
+ "albums",
+ "tracks",
+ "playlists"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "audio-media-results"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/media-search"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `media-details` message (version 1.0) of the `port1/systems/zero/capability-interfaces/media-search` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Exact media resource details and a bounded page of its children.",
+ "properties": {
+ "episodes": {
+ "items": {
+ "description": "Provider-qualified podcast episode with selection metadata.",
+ "properties": {
+ "id": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ },
+ "name": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "releaseDate": {
+ "description": "Provider release date; precision can be year, month or day.",
+ "type": "string"
+ },
+ "releaseDatePrecision": {
+ "description": "Provider date precision.",
+ "type": "string"
+ },
+ "showId": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "mediaId": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "nextToken": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "resourceKind": {
+ "description": "Provider resource kind from the media URI.",
+ "type": "string"
+ },
+ "tracks": {
+ "items": {
+ "description": "Track information",
+ "properties": {
+ "album": {
+ "allOf": [
+ {
+ "description": "Album information",
+ "properties": {
+ "artists": {
+ "description": "Album artists",
+ "items": {
+ "description": "Artist information",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the artist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Artist name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for the album",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Album name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "artists"
+ ],
+ "type": "object"
+ }
+ ],
+ "description": "Track album when supplied by the provider. Omitted for sources such as YouTube videos that do not supply album metadata."
+ },
+ "artists": {
+ "description": "Track artists",
+ "items": {
+ "description": "Artist information",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the artist",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Artist name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "id": {
+ "description": "Unique identifier for the track",
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "description": "Track name",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "artists"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "mediaId",
+ "resourceKind"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "media-details"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/media-search"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `models-listed` message (version 1.0) of the `port1/systems/zero/capability-interfaces/model-catalog` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The models matching query-models",
+ "properties": {
+ "models": {
+ "items": {
+ "description": "One model offered for one capability interface, with the configuration it supports and how to prompt it. Exactly the section that matches the capability interface is present (`speech`, `speechToSpeech`, `image` or `music`).",
+ "properties": {
+ "capabilityInterface": {
+ "description": "Canonical name of the capability interface the model serves, for example port1/systems/zero/capability-interfaces/speech-audio-generation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Human readable model name.",
+ "type": "string"
+ },
+ "image": {
+ "description": "Image generation configuration.",
+ "properties": {
+ "arbitraryAspectRatio": {
+ "description": "True when any width:height ratio is accepted, not only `aspectRatios`.",
+ "type": "boolean"
+ },
+ "aspectRatios": {
+ "description": "Accepted values of `aspectRatio`, written as width:height.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "defaultAspectRatio": {
+ "description": "The ratio the vendor uses when `aspectRatio` is omitted, when it documents one.",
+ "type": "string"
+ },
+ "resolutions": {
+ "description": "Accepted values of `resolution`.",
+ "items": {
+ "description": "Output resolution tier of a generated image. STANDARD is about 1 megapixel (a 1K tier), HIGH is about 2K and ULTRA is about 4K. A model lists the tiers it supports in the model catalog.",
+ "enum": [
+ "STANDARD",
+ "HIGH",
+ "ULTRA"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "maxPromptCharacters": {
+ "description": "Longest accepted text or prompt in characters, when the vendor documents one.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "model": {
+ "description": "The model identifier to pass as `model` in the interface generation message.",
+ "type": "string"
+ },
+ "music": {
+ "description": "Music generation configuration.",
+ "properties": {
+ "genres": {
+ "description": "Accepted values of `genres`. Empty when `genres` is unsupported.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "maxDurationSeconds": {
+ "description": "Longest accepted `durationSeconds`, when the model takes a duration.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "maxLyricsCharacters": {
+ "description": "Longest accepted `lyrics`, when the vendor documents one.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "supportsDuration": {
+ "description": "True when `durationSeconds` is accepted.",
+ "type": "boolean"
+ },
+ "supportsGenres": {
+ "description": "True when `genres` is accepted. When false, name the genre in the prompt.",
+ "type": "boolean"
+ },
+ "supportsLyrics": {
+ "description": "True when `lyrics` is accepted as a separate field. When false, put the lyrics in the prompt.",
+ "type": "boolean"
+ },
+ "supportsVocalGender": {
+ "description": "True when `vocalGender` is accepted.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "supportsLyrics",
+ "supportsGenres",
+ "supportsVocalGender",
+ "supportsDuration"
+ ],
+ "type": "object"
+ },
+ "promptingInstructions": {
+ "description": "Free text on how to prompt the model, for example whether lyrics go in the prompt or in a separate field and which emotion or sound tags the model understands.",
+ "type": "string"
+ },
+ "provenance": {
+ "description": "Where the catalog entry came from.",
+ "properties": {
+ "checkedOn": {
+ "description": "The date (YYYY-MM-DD) the entry was last checked.",
+ "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+ "type": "string"
+ },
+ "sourceUrl": {
+ "description": "The vendor model page the entry was checked against.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "sourceUrl",
+ "checkedOn"
+ ],
+ "type": "object"
+ },
+ "speech": {
+ "description": "Text to speech configuration.",
+ "properties": {
+ "customVoicesAccepted": {
+ "description": "True when `voice` also accepts a voice name that is not in `voices`.",
+ "type": "boolean"
+ },
+ "defaultVoice": {
+ "description": "The voice the vendor uses when `voice` is omitted, when the vendor documents one.",
+ "type": "string"
+ },
+ "soundTags": {
+ "description": "Emotion or sound tags the model documents, written exactly as they appear inline in the text, for example [whispering] or <laugh>. The list is documented examples, not a filter; the model may understand more.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "supportsStyleInstructions": {
+ "description": "True when `styleInstructions` steers the delivery.",
+ "type": "boolean"
+ },
+ "voices": {
+ "description": "Voices the model offers.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "speechToSpeech": {
+ "description": "Speech to speech (voice conversion) configuration.",
+ "properties": {
+ "inputAudio": {
+ "description": "What an audio input accepts.",
+ "properties": {
+ "formats": {
+ "description": "Accepted media types of the input.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "maxBytes": {
+ "description": "Largest accepted input in decoded bytes.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "maxSeconds": {
+ "description": "Longest accepted duration, when the model has one.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "minSeconds": {
+ "description": "Shortest accepted duration, when the model has one.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "formats"
+ ],
+ "type": "object"
+ },
+ "speakerReference": {
+ "description": "Reference audio of the voice to convert to.",
+ "properties": {
+ "limits": {
+ "description": "What an audio input accepts.",
+ "properties": {
+ "formats": {
+ "description": "Accepted media types of the input.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "maxBytes": {
+ "description": "Largest accepted input in decoded bytes.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "maxSeconds": {
+ "description": "Longest accepted duration, when the model has one.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "minSeconds": {
+ "description": "Shortest accepted duration, when the model has one.",
+ "minimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "formats"
+ ],
+ "type": "object"
+ },
+ "supported": {
+ "description": "True when `speakerReference` is accepted.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "supported"
+ ],
+ "type": "object"
+ },
+ "voices": {
+ "description": "Preset target voices; `voice` selects one when no speaker reference is given.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "inputAudio",
+ "speakerReference"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "capabilityInterface",
+ "model",
+ "displayName",
+ "promptingInstructions",
+ "provenance"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "models"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "models-listed"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/model-catalog"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `motion-detected` message (version 1.0) of the `port1/systems/zero/capability-interfaces/motion-sensor` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "A distinct motion occurrence, independent of cached detection state.",
+ "properties": {
+ "value": {
+ "enum": [
+ "DETECTED"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "motion-detected"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/motion-sensor"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `music-generated` message (version 1.0) of the `port1/systems/zero/capability-interfaces/music-generation` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The music produced by generate-music, as a short-lived URL or inline base64 according to the responseFormat of the request",
+ "properties": {
+ "audio": {
+ "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
+ "properties": {
+ "byteLength": {
+ "description": "Size of the decoded bytes. Always present on host responses.",
+ "maximum": 26214400,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "data": {
+ "description": "Base64 encoded bytes, at most 10 MiB decoded.",
+ "format": "byte",
+ "maxLength": 13981016,
+ "type": "string"
+ },
+ "durationMs": {
+ "description": "Duration of audio in milliseconds, when known.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "expiresAt": {
+ "description": "When `url` stops working. Present with `url` on host responses.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "height": {
+ "description": "Image height in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "mimeType": {
+ "description": "The media type of the bytes.",
+ "enum": [
+ "audio/mpeg",
+ "audio/wav",
+ "audio/ogg",
+ "audio/flac",
+ "image/png",
+ "image/jpeg",
+ "image/webp"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
+ "type": "string"
+ },
+ "width": {
+ "description": "Image width in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "mimeType"
+ ],
+ "type": "object"
+ },
+ "lyrics": {
+ "description": "The lyrics of the track when the model returns them",
+ "type": "string"
+ }
+ },
+ "required": [
+ "audio"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "music-generated"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/music-generation"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `notification` message (version 1.0) of the `port1/systems/zero/capability-interfaces/notification` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "A notification delivered to target users, with its title, body, priority and delivery channels.",
+ "properties": {
+ "body": {
+ "description": "Notification body text",
+ "maxLength": 2000,
+ "minLength": 1,
+ "type": "string"
+ },
+ "channels": {
+ "description": "Channels to send the notification through",
+ "items": {
+ "enum": [
+ "PUSH",
+ "EMAIL",
+ "SMS",
+ "IN_APP",
+ "WEBHOOK"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "metadata": {
+ "additionalProperties": true,
+ "description": "Additional metadata for the notification",
+ "type": "object"
+ },
+ "notificationId": {
+ "description": "Unique identifier for this notification",
+ "minLength": 1,
+ "type": "string"
+ },
+ "priority": {
+ "description": "Notification priority level",
+ "enum": [
+ "LOW",
+ "NORMAL",
+ "HIGH",
+ "URGENT"
+ ],
+ "type": "string"
+ },
+ "targetUsers": {
+ "description": "List of user IDs to send the notification to",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "title": {
+ "description": "Notification title",
+ "maxLength": 200,
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "title",
+ "body"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "notification"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/notification"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `delete-recording-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/recordings` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Delete recording response.",
+ "title": "RecordingsInterfaceDeleteRecordingResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "delete-recording-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/recordings"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `download-recording-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/recordings` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Download recording response.",
+ "properties": {
+ "uri": {
+ "description": "Provider URL for downloading the recording.",
+ "format": "uri",
+ "type": "string"
+ }
+ },
+ "required": [
+ "uri"
+ ],
+ "title": "RecordingsInterfaceDownloadRecordingResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "download-recording-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/recordings"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `list-recordings-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/recordings` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "List recordings response.",
+ "properties": {
+ "items": {
+ "description": "Recordings in this page.",
+ "items": {
+ "description": "A stored recording.",
+ "properties": {
+ "durationSeconds": {
+ "description": "Recording duration in seconds.",
+ "minimum": 0,
+ "type": "number"
+ },
+ "mediaId": {
+ "description": "Exact provider resource identity. The canonical form is portos-media://portoperatingsystem.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. The prior authority remains readable. YouTube and YouTube Music share provider youtube, with video/video and video/channel resource kinds. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. See https://portoperatingsystem.com/docs/media.\n",
+ "minLength": 1,
+ "pattern": "^(portos-media://(portpowered[.]com|portoperatingsystem[.]com)/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+)$",
+ "title": "MediaId",
+ "type": "string"
+ },
+ "recordingId": {
+ "description": "Provider identifier of the recording.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "startedAt": {
+ "description": "Recording start time.",
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "required": [
+ "recordingId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "nextCursor": {
+ "description": "Opaque cursor for the next page; omitted when there are no further results.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "items"
+ ],
+ "title": "RecordingsInterfaceListRecordingsResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "list-recordings-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/recordings"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `create-reminder-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/reminders-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The provider accepted the reminder change.",
+ "properties": {
+ "reminder": {
+ "description": "A reminder and its current provider revision for guarded edits.",
+ "properties": {
+ "allDay": {
+ "description": "Whether the supplied due date represents an all-day reminder.",
+ "type": "boolean"
+ },
+ "completed": {
+ "type": "boolean"
+ },
+ "dueDate": {
+ "description": "Exact due instant in RFC3339 with an explicit UTC offset. Omitted on undated reminders.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "listId": {
+ "type": "string"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "reminderId": {
+ "type": "string"
+ },
+ "revision": {
+ "description": "Omitted when the provider does not supply a revision; writes require it.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "IANA time zone, for example America/Los_Angeles. Defaults to UTC for newly dated reminders.",
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "reminderId",
+ "listId",
+ "title",
+ "completed"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "reminder"
+ ],
+ "title": "RemindersProviderInterfaceCreateReminderResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "create-reminder-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/reminders-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `delete-reminder-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/reminders-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The provider accepted soft deletion of the reminder.",
+ "title": "RemindersProviderInterfaceDeleteReminderResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "delete-reminder-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/reminders-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `list-reminders-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/reminders-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Reminder lists and one bounded page of reminders.",
+ "properties": {
+ "nextCursor": {
+ "type": "string"
+ },
+ "reminderLists": {
+ "items": {
+ "description": "A reminder list",
+ "properties": {
+ "listId": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "listId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "reminders": {
+ "items": {
+ "description": "A reminder and its current provider revision for guarded edits.",
+ "properties": {
+ "allDay": {
+ "description": "Whether the supplied due date represents an all-day reminder.",
+ "type": "boolean"
+ },
+ "completed": {
+ "type": "boolean"
+ },
+ "dueDate": {
+ "description": "Exact due instant in RFC3339 with an explicit UTC offset. Omitted on undated reminders.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "listId": {
+ "type": "string"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "reminderId": {
+ "type": "string"
+ },
+ "revision": {
+ "description": "Omitted when the provider does not supply a revision; writes require it.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "IANA time zone, for example America/Los_Angeles. Defaults to UTC for newly dated reminders.",
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "reminderId",
+ "listId",
+ "title",
+ "completed"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "reminderLists",
+ "reminders"
+ ],
+ "title": "RemindersProviderInterfaceListRemindersResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "list-reminders-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/reminders-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `update-reminder-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/reminders-provider` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The provider accepted the reminder change.",
+ "properties": {
+ "reminder": {
+ "description": "A reminder and its current provider revision for guarded edits.",
+ "properties": {
+ "allDay": {
+ "description": "Whether the supplied due date represents an all-day reminder.",
+ "type": "boolean"
+ },
+ "completed": {
+ "type": "boolean"
+ },
+ "dueDate": {
+ "description": "Exact due instant in RFC3339 with an explicit UTC offset. Omitted on undated reminders.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "listId": {
+ "type": "string"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "reminderId": {
+ "type": "string"
+ },
+ "revision": {
+ "description": "Omitted when the provider does not supply a revision; writes require it.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "IANA time zone, for example America/Los_Angeles. Defaults to UTC for newly dated reminders.",
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "reminderId",
+ "listId",
+ "title",
+ "completed"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "reminder"
+ ],
+ "title": "RemindersProviderInterfaceUpdateReminderResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "update-reminder-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/reminders-provider"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `route-discovery-report` message (version 1.0) of the `port1/systems/zero/capability-interfaces/route-discovery` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Provider report of discovered routes, group routes and their relationships. Plugin and auth-link identity come from the authenticated publisher context.",
+ "properties": {
+ "authLinkIdentity": {
+ "description": "The ID of the auth link the routes were discovered for.",
+ "type": "string"
+ },
+ "groupRoutes": {
+ "items": {
+ "description": "A provider-reported group route (for example a vacuum map or room, a lighting room or a speaker group) as carried by discovery. It is shared by the route-discovery report message and `SynchronizationRequest.groupRoutes` so both decode to the same model.\n",
+ "properties": {
+ "interfaces": {
+ "items": {
+ "properties": {
+ "attributes": {
+ "description": "Supported attribute subset. An omitted or empty list declares no supported attributes.",
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The name of the attribute",
+ "type": "string"
+ },
+ "value": {
+ "additionalProperties": true,
+ "description": "the value of the attribute, this is an opaque resource object, so it can be any type of struct.",
+ "type": "object"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "configuration": {
+ "additionalProperties": true,
+ "description": "The configuration of the interface",
+ "type": "object"
+ },
+ "messages": {
+ "description": "Supported inbound message subset for the declared interface version. An omitted or empty list declares no supported messages; null also declares none. A supplied array contains distinct canonical names for implemented messages.",
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The name of the command",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "name": {
+ "description": "The name of the interface",
+ "type": "string"
+ },
+ "version": {
+ "description": "the version of the interface",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "memberPluginRouteIds": {
+ "description": "Full current native membership; an empty array explicitly reports an empty route.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "uniqueItems": true
+ },
+ "name": {
+ "description": "The name of the associated group route",
+ "type": "string"
+ },
+ "ontologicalTypes": {
+ "description": "Actual classifications of the native group route, constrained by its selected plugin profile for V2 discovery.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pluginCustomMetadata": {
+ "additionalProperties": true,
+ "description": "Private plugin metadata (native map, segment or cloud room addressing) returned to the plugin on dispatch; never exposed as application data. A route declaring the canonical SPATIAL geometry capability can carry a valid SpatialInterfaceGeometryAttribute in geometry. Only that canonical geometry's observedAt is observation time rather than a meaningful group-etag contribution; it is still stored. Geometry shape, frame, native context and all other metadata remain meaningful.\n",
+ "type": "object"
+ },
+ "pluginProfileId": {
+ "description": "Stable group-route profile ID selected from the registered V2 plugin declaration.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "pluginRouteId": {
+ "description": "Plugin-owned stable identifier of the group route. Must be unique across routes and group routes within one plugin and auth link.\n",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "pluginRouteId",
+ "name",
+ "pluginProfileId",
+ "ontologicalTypes",
+ "interfaces",
+ "memberPluginRouteIds"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "pluginIdentity": {
+ "description": "Identifies a plugin client by its type and unique identifier.",
+ "properties": {
+ "pluginId": {
+ "description": "The ID of the plugin",
+ "type": "string"
+ },
+ "pluginType": {
+ "enum": [
+ "WEBSOCKET",
+ "HTTP",
+ "WEBSERVICE",
+ "APPLE_PUSH_NOTIFICATION",
+ "HOSTED_COMPUTE"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "pluginType",
+ "pluginId"
+ ],
+ "type": "object"
+ },
+ "relationships": {
+ "description": "Provider relationships excluding output-only MEMBER_OF edges. Report native group membership in groupRoutes[].memberPluginRouteIds; use group management APIs for customer intent.",
+ "items": {
+ "description": "A provider-reported relationship between typed port resources. Identity is `externalId` within the reporting plugin and auth link; resubmitting the same `externalId` updates the relationship. Omission from a later synchronization is not a deletion instruction. MEMBER_OF is an output-only membership projection and is rejected as provider input, including native route-to-group-route membership edges. Supply native members in GroupRoute.memberPluginRouteIds instead.\n",
+ "properties": {
+ "externalId": {
+ "description": "Plugin-owned stable identifier of the relationship.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "interfaces": {
+ "description": "Optional interface applicability; used by `CAN_CONTROL` to declare which messages the source supports on the target.",
+ "items": {
+ "description": "Capability-interface applicability of a relationship, for example the robotic-vacuum-cleaner messages a `CAN_CONTROL` edge supports on a room.\n",
+ "properties": {
+ "messages": {
+ "description": "Message names of the interface the relationship applies to. An explicit empty array applies to no messages. Omission retains every message supported by the source interface.",
+ "items": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "type": "array",
+ "uniqueItems": true
+ },
+ "name": {
+ "description": "The capability interface namespace.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "version": {
+ "description": "The capability interface version.",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "version"
+ ],
+ "type": "object"
+ },
+ "minItems": 1,
+ "type": "array"
+ },
+ "source": {
+ "description": "One end of a discovered relationship, addressed by plugin-owned identity within the reporting plugin and auth link. Exactly one of `pluginRouteId` (a route), `groupPluginRouteId` (a group route), `endpointId` or `groupId` must be set.\n",
+ "maxProperties": 1,
+ "minProperties": 1,
+ "properties": {
+ "endpointId": {
+ "description": "The full ID of an endpoint owned by the reporting principal.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "groupId": {
+ "description": "The full ID of a group owned by the reporting principal.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "groupPluginRouteId": {
+ "description": "The plugin route ID of a group route reported in the same or an earlier synchronization.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "pluginRouteId": {
+ "description": "The plugin route ID of a route reported in the same or an earlier synchronization.",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "target": {
+ "description": "One end of a discovered relationship, addressed by plugin-owned identity within the reporting plugin and auth link. Exactly one of `pluginRouteId` (a route), `groupPluginRouteId` (a group route), `endpointId` or `groupId` must be set.\n",
+ "maxProperties": 1,
+ "minProperties": 1,
+ "properties": {
+ "endpointId": {
+ "description": "The full ID of an endpoint owned by the reporting principal.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "groupId": {
+ "description": "The full ID of a group owned by the reporting principal.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "groupPluginRouteId": {
+ "description": "The plugin route ID of a group route reported in the same or an earlier synchronization.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "pluginRouteId": {
+ "description": "The plugin route ID of a route reported in the same or an earlier synchronization.",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": {
+ "description": "Writable provider relationship kind. MEMBER_OF is an output-only projection maintained by group resolution; native membership is reported through GroupRoute.memberPluginRouteIds.",
+ "enum": [
+ "IS_PART_OF",
+ "CAN_CONTROL",
+ "LOCATED_IN"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "externalId",
+ "type",
+ "source",
+ "target"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "routes": {
+ "items": {
+ "description": "Provider input before host synchronization assigns persisted route identity and ownership. Canonical provider facts reuse Route property definitions. The Go projection is separate from the persisted Route read model. Host identity fields may be omitted or empty and never establish authenticated publisher or installation authority. Nonempty id and associatedEndpointId may select an existing authorized route during scoped rediscovery; newly created routes and endpoints receive host-assigned IDs.\n",
+ "properties": {
+ "associatedAuthLinkId": {
+ "description": "Provider report routing identity, separate from writable customer intent.",
+ "type": "string"
+ },
+ "associatedEndpointId": {
+ "description": "Provider report routing identity, separate from writable customer intent.",
+ "type": "string"
+ },
+ "associatedPluginId": {
+ "description": "Provider report routing identity, separate from writable customer intent.",
+ "type": "string"
+ },
+ "associatedPluginRouteId": {
+ "allOf": [
+ {
+ "description": "The stable plugin-owned route identifier associated with this Port OS route. For synchronized plugin capability contracts and fixture parity checks, use this field to match a route from enumeration back to the discovery payload.\n",
+ "type": "string"
+ }
+ ],
+ "minLength": 1
+ },
+ "description": {
+ "allOf": [
+ {
+ "properties": {
+ "type": {
+ "description": "The type identifier of the name value, defined as plain when not defined.",
+ "type": "string"
+ },
+ "value": {
+ "description": "the raw value of a plain name.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ],
+ "type": "object"
+ }
+ ],
+ "description": "The description of the route as a human readable string or a localizable asset."
+ },
+ "externalId": {
+ "description": "Provider report routing identity, separate from writable customer intent.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Existing route ID only. Omit for a new route; an unknown ID returns 404. Persisted IDs are assigned by the host.",
+ "type": "string"
+ },
+ "interfaces": {
+ "description": "List of interfaces supported by the route. These denote what the route is capable of performing such as turning off/on, etc.",
+ "items": {
+ "properties": {
+ "attributes": {
+ "description": "Supported attribute subset. An omitted or empty list declares no supported attributes.",
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The name of the attribute",
+ "type": "string"
+ },
+ "value": {
+ "additionalProperties": true,
+ "description": "the value of the attribute, this is an opaque resource object, so it can be any type of struct.",
+ "type": "object"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "configuration": {
+ "additionalProperties": true,
+ "description": "The configuration of the interface",
+ "type": "object"
+ },
+ "messages": {
+ "description": "Supported inbound message subset for the declared interface version. An omitted or empty list declares no supported messages; null also declares none. A supplied array contains distinct canonical names for implemented messages.",
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The name of the command",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": [
+ "array",
+ "null"
+ ]
+ },
+ "name": {
+ "description": "The name of the interface",
+ "type": "string"
+ },
+ "version": {
+ "description": "the version of the interface",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "manufacturer": {
+ "allOf": [
+ {
+ "properties": {
+ "type": {
+ "description": "The type identifier of the name value, defined as plain when not defined.",
+ "type": "string"
+ },
+ "value": {
+ "description": "the raw value of a plain name.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ],
+ "type": "object"
+ }
+ ],
+ "description": "The manufacturer of the route as a human readable string or a localizable asset."
+ },
+ "model": {
+ "allOf": [
+ {
+ "properties": {
+ "type": {
+ "description": "The type identifier of the name value, defined as plain when not defined.",
+ "type": "string"
+ },
+ "value": {
+ "description": "the raw value of a plain name.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ],
+ "type": "object"
+ }
+ ],
+ "description": "The model of the route as a human readable string or a localizable asset."
+ },
+ "name": {
+ "allOf": [
+ {
+ "properties": {
+ "type": {
+ "description": "The type identifier of the name value, defined as plain when not defined.",
+ "type": "string"
+ },
+ "value": {
+ "description": "the raw value of a plain name.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ],
+ "type": "object"
+ }
+ ],
+ "description": "The name of the route as a human readable string or a localizable asset. This is either a raw string or a localizable asset reference."
+ },
+ "ontologicalTypes": {
+ "description": "List of ontological types for the route. These are used mostly for customers to know what an endpoint is, like if its a lightbulb, or a speaker, etc.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pluginCustomMetadata": {
+ "additionalProperties": true,
+ "description": "A set of custom metadata that the plugin uses and attaches to the route, this is meant specifically for the plugin to use.",
+ "type": "object"
+ },
+ "pluginProfileId": {
+ "description": "Stable profile ID selected from the registered plugin declaration. Required for V2 plugin discovery; retained with the route for admission and presentation.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "serialNumber": {
+ "allOf": [
+ {
+ "properties": {
+ "type": {
+ "description": "The type identifier of the name value, defined as plain when not defined.",
+ "type": "string"
+ },
+ "value": {
+ "description": "the raw value of a plain name.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ],
+ "type": "object"
+ }
+ ],
+ "description": "The serial number of the route as a human readable string or a localizable asset."
+ }
+ },
+ "required": [
+ "associatedPluginRouteId",
+ "interfaces",
+ "ontologicalTypes"
+ ],
+ "type": "object"
+ },
+ "maxItems": 1000,
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "route-discovery-report"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/route-discovery"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `answer-generated-for-session` message (version 1.0) of the `port1/systems/zero/capability-interfaces/rtc-session` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The answer generated for a real-time communication session, which completes the connection.",
+ "properties": {
+ "answer": {
+ "description": "An RTC session answer",
+ "properties": {
+ "format": {
+ "enum": [
+ "SDP"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The content of the answer",
+ "properties": {
+ "expiresAt": {
+ "description": "Provider-reported stream expiration",
+ "type": "string"
+ },
+ "sdp": {
+ "description": "The SDP answer session contents",
+ "type": "string"
+ },
+ "streamExtensionToken": {
+ "description": "Provider token used to extend the established stream",
+ "type": "string"
+ },
+ "streamToken": {
+ "description": "Provider token for the established stream",
+ "type": "string"
+ },
+ "streamUrl": {
+ "description": "Provider stream URL when the answer is not SDP",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "answer"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "answer-generated-for-session"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/rtc-session"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `session-disconnected` message (version 1.0) of the `port1/systems/zero/capability-interfaces/rtc-session` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Reports that a real-time communication session has disconnected.",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "session-disconnected"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/rtc-session"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `start-session-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/rtsp-session` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Start session response.",
+ "properties": {
+ "sdp": {
+ "description": "Optional SDP describing the stream.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "sessionId": {
+ "description": "Session identifier.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "uri": {
+ "description": "RTSP stream URI.",
+ "format": "uri",
+ "pattern": "^rtsps?://",
+ "type": "string"
+ }
+ },
+ "required": [
+ "sessionId",
+ "uri"
+ ],
+ "title": "RtspSessionInterfaceStartSessionResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "start-session-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/rtsp-session"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `stop-session-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/rtsp-session` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Stop session response.",
+ "properties": {
+ "sessionId": {
+ "description": "Closed session identifier.",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "sessionId"
+ ],
+ "title": "RtspSessionInterfaceStopSessionResponseMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "stop-session-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/rtsp-session"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `scene-created` message (version 1.0) of the `port1/systems/zero/capability-interfaces/scene` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Confirms that a new scene was saved for the selected room or group. The scene is available to recall on that same target; creation does not activate it or establish that any light changed state.",
+ "properties": {
+ "name": {
+ "description": "Name of the saved scene",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "\\S",
+ "type": "string"
+ },
+ "sceneId": {
+ "description": "Saved scene identifier to pass to the activate message on the same target",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "sceneId",
+ "name"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "scene-created"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/scene"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `pin-operation-result` message (version 1.0) of the `port1/systems/zero/capability-interfaces/security-pin` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Correlated safe PIN provisioning result. APPLIED requires vendor-confirmed completion, not dispatch acceptance. CREATE supplies recordId once assigned; UPDATE and DELETE retain the requested ID. FAILED requires a safe code; other statuses forbid code. Never include credentials or raw vendor errors.",
+ "properties": {
+ "code": {
+ "description": "Stable safe structured failure code. Never raw vendor text, credentials or response bodies.",
+ "minLength": 1,
+ "type": "string"
+ },
+ "correlationToken": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "operation": {
+ "enum": [
+ "CREATE",
+ "UPDATE",
+ "DELETE"
+ ],
+ "type": "string"
+ },
+ "provisioningStatus": {
+ "enum": [
+ "PENDING",
+ "APPLIED",
+ "FAILED"
+ ],
+ "type": "string"
+ },
+ "recordId": {
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "correlationToken",
+ "operation",
+ "provisioningStatus"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "pin-operation-result"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/security-pin"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `pin-records-report` message (version 1.0) of the `port1/systems/zero/capability-interfaces/security-pin` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "Bounded credential-free record page aligned with the pin-records attribute. Echo the query correlation token in the message header.",
+ "properties": {
+ "items": {
+ "items": {
+ "description": "Endpoint-scoped PIN metadata without credentials. TEMPORARY requires both validity timestamps; PERMANENT forbids them. Provisioning status is distinct from observation freshness.",
+ "properties": {
+ "id": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "kind": {
+ "enum": [
+ "PERMANENT",
+ "TEMPORARY"
+ ],
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "provisioningStatus": {
+ "enum": [
+ "PENDING",
+ "APPLIED",
+ "FAILED"
+ ],
+ "type": "string"
+ },
+ "validFrom": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "validUntil": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "kind",
+ "provisioningStatus"
+ ],
+ "type": "object"
+ },
+ "maxItems": 100,
+ "type": "array"
+ },
+ "nextToken": {
+ "description": "Opaque continuation bound to endpoint, caller and query; omitted on the final page.",
+ "minLength": 1,
+ "type": "string"
+ }
+ },
+ "required": [
+ "items"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "pin-records-report"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/security-pin"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `get-snapshot-response` message (version 1.0) of the `port1/systems/zero/capability-interfaces/snapshot` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "A camera still image, as a short-lived URL or inline base64 according to the request's responseFormat, with the time it was captured",
+ "properties": {
+ "image": {
+ "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
+ "properties": {
+ "byteLength": {
+ "description": "Size of the decoded bytes. Always present on host responses.",
+ "maximum": 26214400,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "data": {
+ "description": "Base64 encoded bytes, at most 10 MiB decoded.",
+ "format": "byte",
+ "maxLength": 13981016,
+ "type": "string"
+ },
+ "durationMs": {
+ "description": "Duration of audio in milliseconds, when known.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "expiresAt": {
+ "description": "When `url` stops working. Present with `url` on host responses.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "height": {
+ "description": "Image height in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "mimeType": {
+ "description": "The media type of the bytes.",
+ "enum": [
+ "audio/mpeg",
+ "audio/wav",
+ "audio/ogg",
+ "audio/flac",
+ "image/png",
+ "image/jpeg",
+ "image/webp"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
+ "type": "string"
+ },
+ "width": {
+ "description": "Image width in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "mimeType"
+ ],
+ "type": "object"
+ },
+ "timeOfSample": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "required": [
+ "image",
+ "timeOfSample"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "get-snapshot-response"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/snapshot"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `audio-generated` message (version 1.0) of the `port1/systems/zero/capability-interfaces/speech-audio-generation` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The speech audio synthesized by generate-speech, as a short-lived URL or inline base64 according to the request's responseFormat",
+ "properties": {
+ "audio": {
+ "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
+ "properties": {
+ "byteLength": {
+ "description": "Size of the decoded bytes. Always present on host responses.",
+ "maximum": 26214400,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "data": {
+ "description": "Base64 encoded bytes, at most 10 MiB decoded.",
+ "format": "byte",
+ "maxLength": 13981016,
+ "type": "string"
+ },
+ "durationMs": {
+ "description": "Duration of audio in milliseconds, when known.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "expiresAt": {
+ "description": "When `url` stops working. Present with `url` on host responses.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "height": {
+ "description": "Image height in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "mimeType": {
+ "description": "The media type of the bytes.",
+ "enum": [
+ "audio/mpeg",
+ "audio/wav",
+ "audio/ogg",
+ "audio/flac",
+ "image/png",
+ "image/jpeg",
+ "image/webp"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
+ "type": "string"
+ },
+ "width": {
+ "description": "Image width in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "mimeType"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "audio"
+ ],
+ "title": "SpeechAudioGenerationInterfaceAudioGeneratedMessage",
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "audio-generated"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/speech-audio-generation"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `speech-converted` message (version 1.0) of the `port1/systems/zero/capability-interfaces/speech-to-speech` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "The converted speech produced by convert-speech, as a short-lived URL or inline base64 according to the responseFormat of the request",
+ "properties": {
+ "audio": {
+ "description": "One binary media result (audio or image). Exactly one of `data` (base64, inline) or `url` (a short-lived Port OS URL with its `expiresAt`) is present; the host rejects a result that carries both or neither. A plugin may return the vendor's fetchable `url` without `expiresAt`; the host always fetches it, republishes or inlines the bytes as the caller's `responseFormat` asks, and fills `byteLength`, so callers never see a vendor URL.",
+ "properties": {
+ "byteLength": {
+ "description": "Size of the decoded bytes. Always present on host responses.",
+ "maximum": 26214400,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "data": {
+ "description": "Base64 encoded bytes, at most 10 MiB decoded.",
+ "format": "byte",
+ "maxLength": 13981016,
+ "type": "string"
+ },
+ "durationMs": {
+ "description": "Duration of audio in milliseconds, when known.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "expiresAt": {
+ "description": "When `url` stops working. Present with `url` on host responses.",
+ "format": "date-time",
+ "type": "string"
+ },
+ "height": {
+ "description": "Image height in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "mimeType": {
+ "description": "The media type of the bytes.",
+ "enum": [
+ "audio/mpeg",
+ "audio/wav",
+ "audio/ogg",
+ "audio/flac",
+ "image/png",
+ "image/jpeg",
+ "image/webp"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "Short-lived URL of the media (valid until `expiresAt`, at most 10 minutes).",
+ "type": "string"
+ },
+ "width": {
+ "description": "Image width in pixels, when known.",
+ "minimum": 1,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "mimeType"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "audio"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "speech-converted"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/speech-to-speech"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "The `text-stream` message (version 1.0) of the `port1/systems/zero/capability-interfaces/text-stream` capability interface, as returned by an endpoint. The header identifies the message and selects the body schema.",
+ "properties": {
+ "body": {
+ "description": "A chunk of streamed text, with its stream ID and sequence, and whether it is the final chunk.",
+ "properties": {
+ "isFinal": {
+ "default": false,
+ "description": "Whether this is the final chunk in the stream",
+ "type": "boolean"
+ },
+ "sequenceId": {
+ "description": "Sequence ID for this text stream",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "streamId": {
+ "description": "Unique identifier for this text stream",
+ "minLength": 1,
+ "type": "string"
+ },
+ "text": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "streamId",
+ "text",
+ "sequenceId",
+ "isFinal"
+ ],
+ "type": "object"
+ },
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "header": {
+ "description": "Identifies this capability message.",
+ "properties": {
+ "correlationToken": {
+ "description": "Token used for correlating related messages",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the message",
+ "type": "string"
+ },
+ "name": {
+ "enum": [
+ "text-stream"
+ ],
+ "type": "string"
+ },
+ "namespace": {
+ "enum": [
+ "port1/systems/zero/capability-interfaces/text-stream"
+ ],
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "1.0"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "namespace",
+ "name",
+ "version"
+ ],
+ "title": "MessageHeader",
+ "type": "object"
+ }
+ },
+ "required": [
+ "header",
+ "body"
+ ],
+ "type": "object"
+ }
+ ]
+ },
+ "routeId": {
+ "type": "string"
+ },
+ "targetId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "targetId",
+ "routeId"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "status": {
+ "enum": [
+ "QUEUED",
+ "IN_PROGRESS",
+ "SUCCEEDED",
+ "PARTIALLY_SUCCEEDED",
+ "FAILED"
+ ],
+ "type": "string"
+ },
+ "syncDeadlineSeconds": {
+ "default": 30,
+ "description": "Configured delivery deadline in seconds, visible to callers.",
+ "maximum": 3600,
+ "minimum": 1,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "id",
+ "status",
+ "results",
+ "errors",
+ "deadline",
+ "syncDeadlineSeconds"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "description": "The one Port OS error shape, returned by every REST error response and every MCP tool error. `code` names the specific failure and `family` its broad class; both are closed enums, so clients branch on them and show `message`, which says what failed and what to do next.",
+ "properties": {
+ "code": {
+ "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
+ "enum": [
+ "BAD_REQUEST",
+ "UNAUTHORIZED",
+ "FORBIDDEN",
+ "INSUFFICIENT_SCOPE",
+ "NOT_FOUND",
+ "CONFLICT",
+ "UNPROCESSABLE_ENTITY",
+ "UNSUPPORTED_OPERATION",
+ "TOO_MANY_REQUESTS",
+ "SERVICE_UNAVAILABLE",
+ "NOT_IMPLEMENTED",
+ "INTERNAL",
+ "CHECKSUM_MISMATCH",
+ "FILE_TOO_LARGE",
+ "STORAGE_UNAVAILABLE",
+ "INSUFFICIENT_PERMISSIONS",
+ "INVALID_FILE_TYPE",
+ "QUOTA_EXCEEDED",
+ "CONCURRENT_MODIFICATION",
+ "ENDPOINT_UNREACHABLE",
+ "BRIDGE_UNREACHABLE",
+ "CLOUD_CONTROL_DISABLED",
+ "ENDPOINT_BUSY",
+ "ENDPOINT_LOW_POWER",
+ "AUTHORIZATION_CREDENTIAL_INVALID",
+ "AUTHORIZATION_CREDENTIAL_EXPIRED",
+ "INVALID_DIRECTIVE",
+ "INVALID_VALUE",
+ "VALUE_OUT_OF_RANGE",
+ "NOT_SUPPORTED_IN_CURRENT_MODE",
+ "RATE_LIMIT_EXCEEDED",
+ "PROVIDER_SERVICE_UNAVAILABLE",
+ "PROVIDER_TIMEOUT",
+ "PROVIDER_INTERNAL_ERROR",
+ "INVALID_PROVIDER_RESPONSE",
+ "OUTCOME_UNKNOWN",
+ "PRECONDITION_FAILED",
+ "AUTH_LINK_NOT_READY",
+ "AUTH_LINK_NOT_DISCONNECTABLE",
+ "PRECONDITION_REQUIRED",
+ "IDEMPOTENCY_KEY_REQUIRED",
+ "IDEMPOTENCY_KEY_REUSED",
+ "IDEMPOTENCY_KEY_IN_FLIGHT",
+ "IDEMPOTENCY_KEY_INVALID",
+ "GROUP_MERGED",
+ "MULTI_ROOM_UNSUPPORTED",
+ "MAP_NOT_ACTIVE",
+ "TARGET_UNSUPPORTED",
+ "TARGET_AMBIGUOUS",
+ "TARGET_GROUP_NOT_FOUND",
+ "TARGET_GROUP_DISABLED",
+ "DUPLICATE_TARGET_GROUP",
+ "MESSAGE_UNSUPPORTED",
+ "MESSAGE_AMBIGUOUS",
+ "ENDPOINT_DISABLED",
+ "ENDPOINT_ROUTE_CHANGED",
+ "ENDPOINT_HAS_DEPENDENCIES",
+ "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
+ "ENDPOINT_COMMITTED_CLEANUP_PENDING",
+ "DEEP_QUERY_FAILED",
+ "PROVIDER_NO_STATE",
+ "EVENT_MANAGEMENT_DISABLED",
+ "SUBSCRIPTION_IDENTITY_IMMUTABLE",
+ "UNSUPPORTED_MEDIA_TYPE",
+ "EVENT_PAYLOAD_TOO_LARGE",
+ "REQUEST_BODY_TOO_LARGE",
+ "EVENT_IDENTITY_CONFLICT",
+ "EVENT_INGRESS_QUOTA_EXCEEDED",
+ "EVENT_RECEIPT_EXPIRED",
+ "EVENT_STORAGE_UNAVAILABLE",
+ "EVENT_DEAD_LETTER_NOT_FOUND",
+ "EVENT_REDRIVE_CONFLICT",
+ "EVENT_REDRIVE_EXPIRED",
+ "RECEIPT_CONTEXT_EXPIRED",
+ "EVENT_MAINTENANCE_INCOMPLETE",
+ "UNKNOWN_INTERFACE",
+ "INVALID_CONFIGURATION",
+ "INVALID_PLUGIN_MANIFEST",
+ "INVALID_ATTRIBUTE",
+ "INVALID_PROVIDER_MESSAGE",
+ "UNDECLARED_CAPABILITY",
+ "PLUGIN_ROUTE_ID_CONFLICT",
+ "UNRESOLVED_REFERENCE",
+ "INVALID_RELATIONSHIP",
+ "RELATIONSHIP_CYCLE",
+ "MULTIPLE_PARENTS",
+ "FLOW_VALIDATION_FAILED",
+ "PROVIDER_SYNC_UNSUPPORTED"
+ ],
+ "type": "string"
+ },
+ "details": {
+ "description": "Optional typed context for an error. Fields are additive and only populated when the error can safely expose that context to API clients.\n",
+ "properties": {
+ "actual": {
+ "description": "String representation of the submitted value when the plugin can safely report it.",
+ "type": "string"
+ },
+ "correlationId": {
+ "description": "Provider or plugin correlation ID useful for support.",
+ "type": "string"
+ },
+ "correlationToken": {
+ "description": "Token that correlates an outcome-unknown dispatch with its eventual result.",
+ "type": "string"
+ },
+ "currentMode": {
+ "description": "Current endpoint mode when `code` is `NOT_SUPPORTED_IN_CURRENT_MODE`.",
+ "type": "string"
+ },
+ "directive": {
+ "description": "Message namespace and name or provider directive that failed.",
+ "type": "string"
+ },
+ "discoveryEndpointId": {
+ "description": "Port OS provider endpoint (type ENDPOINT_PLUGIN) of the connection to send `discover-routes` to when `code` is `TARGET_UNSUPPORTED` because the route must be rediscovered.",
+ "type": "string"
+ },
+ "endpointId": {
+ "description": "Port OS endpoint ID involved in the failed dispatch.",
+ "type": "string"
+ },
+ "fieldErrors": {
+ "description": "The request fields that were rejected, when the error is about the request's content.",
+ "items": {
+ "description": "One rejected request field of an error.",
+ "properties": {
+ "field": {
+ "description": "Name or JSON path of the rejected field.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Why the field was rejected and what an accepted value looks like.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "field",
+ "reason"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "maximum": {
+ "description": "Maximum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
+ "type": "number"
+ },
+ "minimum": {
+ "description": "Minimum accepted value when `code` is `VALUE_OUT_OF_RANGE`.",
+ "type": "number"
+ },
+ "parameter": {
+ "description": "Request parameter or capability value that caused the failure.",
+ "type": "string"
+ },
+ "pluginId": {
+ "description": "Port OS plugin ID that reported the failure.",
+ "type": "string"
+ },
+ "pluginRouteId": {
+ "description": "Plugin-owned route identifier involved in the failed dispatch.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "Third-party provider or bridge name that reported the failure.",
+ "type": "string"
+ },
+ "providerCode": {
+ "description": "The third-party provider's own error code, for support. It is opaque and provider-specific; branch on `code` and `family` instead.",
+ "type": "string"
+ },
+ "retryAfterSeconds": {
+ "description": "Suggested retry delay for rate-limit or provider-unavailable failures.",
+ "minimum": 0,
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "errors": {
+ "description": "Every rejected item when a request that is validated item by item and applied atomically fails, such as a discovery `SynchronizationRequest` whose routes, group routes or relationships are rejected. Omitted for single-item failures.\n",
+ "items": {
+ "description": "One rejected discovery item of a `SynchronizationRequest`, keyed by the plugin-owned identity of the rejected item: `pluginRouteId` for a route or group route, or `relationshipExternalId` for a relationship. Exactly one of the two is set. It shares the `code`, `family`, `status` and `message` fields of `BatchItemError`; discovery items are keyed by plugin-owned identity because they carry no `requestId`. A request with any rejected item is rejected as a whole and lists every rejected item.\n",
+ "properties": {
+ "code": {
+ "description": "The specific error, one of a closed set of Port OS codes. Every REST error body, MCP tool error, batch item error and discovery item error uses this enum; each code belongs to an `ErrorFamily` that decides its HTTP status. Provider-specific codes are never codes: they travel in `details.providerCode`. New failure kinds are added here, never as free strings.",
+ "enum": [
+ "BAD_REQUEST",
+ "UNAUTHORIZED",
+ "FORBIDDEN",
+ "INSUFFICIENT_SCOPE",
+ "NOT_FOUND",
+ "CONFLICT",
+ "UNPROCESSABLE_ENTITY",
+ "UNSUPPORTED_OPERATION",
+ "TOO_MANY_REQUESTS",
+ "SERVICE_UNAVAILABLE",
+ "NOT_IMPLEMENTED",
+ "INTERNAL",
+ "CHECKSUM_MISMATCH",
+ "FILE_TOO_LARGE",
+ "STORAGE_UNAVAILABLE",
+ "INSUFFICIENT_PERMISSIONS",
+ "INVALID_FILE_TYPE",
+ "QUOTA_EXCEEDED",
+ "CONCURRENT_MODIFICATION",
+ "ENDPOINT_UNREACHABLE",
+ "BRIDGE_UNREACHABLE",
+ "CLOUD_CONTROL_DISABLED",
+ "ENDPOINT_BUSY",
+ "ENDPOINT_LOW_POWER",
+ "AUTHORIZATION_CREDENTIAL_INVALID",
+ "AUTHORIZATION_CREDENTIAL_EXPIRED",
+ "INVALID_DIRECTIVE",
+ "INVALID_VALUE",
+ "VALUE_OUT_OF_RANGE",
+ "NOT_SUPPORTED_IN_CURRENT_MODE",
+ "RATE_LIMIT_EXCEEDED",
+ "PROVIDER_SERVICE_UNAVAILABLE",
+ "PROVIDER_TIMEOUT",
+ "PROVIDER_INTERNAL_ERROR",
+ "INVALID_PROVIDER_RESPONSE",
+ "OUTCOME_UNKNOWN",
+ "PRECONDITION_FAILED",
+ "AUTH_LINK_NOT_READY",
+ "AUTH_LINK_NOT_DISCONNECTABLE",
+ "PRECONDITION_REQUIRED",
+ "IDEMPOTENCY_KEY_REQUIRED",
+ "IDEMPOTENCY_KEY_REUSED",
+ "IDEMPOTENCY_KEY_IN_FLIGHT",
+ "IDEMPOTENCY_KEY_INVALID",
+ "GROUP_MERGED",
+ "MULTI_ROOM_UNSUPPORTED",
+ "MAP_NOT_ACTIVE",
+ "TARGET_UNSUPPORTED",
+ "TARGET_AMBIGUOUS",
+ "TARGET_GROUP_NOT_FOUND",
+ "TARGET_GROUP_DISABLED",
+ "DUPLICATE_TARGET_GROUP",
+ "MESSAGE_UNSUPPORTED",
+ "MESSAGE_AMBIGUOUS",
+ "ENDPOINT_DISABLED",
+ "ENDPOINT_ROUTE_CHANGED",
+ "ENDPOINT_HAS_DEPENDENCIES",
+ "ENDPOINT_EVENT_SUBSCRIPTIONS_ACTIVE",
+ "ENDPOINT_COMMITTED_CLEANUP_PENDING",
+ "DEEP_QUERY_FAILED",
+ "PROVIDER_NO_STATE",
+ "EVENT_MANAGEMENT_DISABLED",
+ "SUBSCRIPTION_IDENTITY_IMMUTABLE",
+ "UNSUPPORTED_MEDIA_TYPE",
+ "EVENT_PAYLOAD_TOO_LARGE",
+ "REQUEST_BODY_TOO_LARGE",
+ "EVENT_IDENTITY_CONFLICT",
+ "EVENT_INGRESS_QUOTA_EXCEEDED",
+ "EVENT_RECEIPT_EXPIRED",
+ "EVENT_STORAGE_UNAVAILABLE",
+ "EVENT_DEAD_LETTER_NOT_FOUND",
+ "EVENT_REDRIVE_CONFLICT",
+ "EVENT_REDRIVE_EXPIRED",
+ "RECEIPT_CONTEXT_EXPIRED",
+ "EVENT_MAINTENANCE_INCOMPLETE",
+ "UNKNOWN_INTERFACE",
+ "INVALID_CONFIGURATION",
+ "INVALID_PLUGIN_MANIFEST",
+ "INVALID_ATTRIBUTE",
+ "INVALID_PROVIDER_MESSAGE",
+ "UNDECLARED_CAPABILITY",
+ "PLUGIN_ROUTE_ID_CONFLICT",
+ "UNRESOLVED_REFERENCE",
+ "INVALID_RELATIONSHIP",
+ "RELATIONSHIP_CYCLE",
+ "MULTIPLE_PARENTS",
+ "FLOW_VALIDATION_FAILED",
+ "PROVIDER_SYNC_UNSUPPORTED"
+ ],
+ "type": "string"
+ },
+ "family": {
+ "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
+ "enum": [
+ "NOT_FOUND",
+ "BAD_REQUEST",
+ "UNAUTHORIZED",
+ "FORBIDDEN",
+ "CONFLICT",
+ "GONE",
+ "PRECONDITION_FAILED",
+ "PRECONDITION_REQUIRED",
+ "PAYLOAD_TOO_LARGE",
+ "UNSUPPORTED_MEDIA_TYPE",
+ "UNPROCESSABLE_ENTITY",
+ "LOCKED",
+ "TOO_MANY_REQUESTS",
+ "BAD_GATEWAY",
+ "SERVICE_UNAVAILABLE",
+ "GATEWAY_TIMEOUT",
+ "NOT_IMPLEMENTED",
+ "INTERNAL_SERVER_ERROR",
+ "REQUEST_INVALID",
+ "AUTHENTICATION",
+ "PERMISSION",
+ "ENDPOINT_NOT_FOUND",
+ "ENDPOINT_STATE_CONFLICT",
+ "ENDPOINT_UNAVAILABLE",
+ "RATE_LIMIT",
+ "PROVIDER_BAD_RESPONSE",
+ "PROVIDER_UNAVAILABLE",
+ "PROVIDER_TIMEOUT"
+ ],
+ "type": "string"
+ },
+ "interface": {
+ "description": "Canonical capability interface name the failure applies to, when the failure is interface-specific.",
+ "type": "string"
+ },
+ "message": {
+ "description": "Plain-language description of the failure and the suggested fix.",
+ "type": "string"
+ },
+ "pluginRouteId": {
+ "description": "Plugin-owned identifier of the rejected route or group route. Set unless the item is a relationship.",
+ "type": "string"
+ },
+ "relationshipExternalId": {
+ "description": "Plugin-owned `externalId` of the rejected relationship. Set only for relationship items.",
+ "type": "string"
+ },
+ "status": {
+ "description": "HTTP-equivalent status code of the item failure.",
+ "maximum": 599,
+ "minimum": 400,
+ "type": "integer"
+ },
+ "version": {
+ "description": "Declared capability interface version the failure applies to, when the failure is interface-specific.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "family",
+ "status",
+ "message"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "family": {
+ "description": "The broad class of an error. The family decides the HTTP status of a REST error, so clients can handle every code of a family alike.",
+ "enum": [
+ "NOT_FOUND",
+ "BAD_REQUEST",
+ "UNAUTHORIZED",
+ "FORBIDDEN",
+ "CONFLICT",
+ "GONE",
+ "PRECONDITION_FAILED",
+ "PRECONDITION_REQUIRED",
+ "PAYLOAD_TOO_LARGE",
+ "UNSUPPORTED_MEDIA_TYPE",
+ "UNPROCESSABLE_ENTITY",
+ "LOCKED",
+ "TOO_MANY_REQUESTS",
+ "BAD_GATEWAY",
+ "SERVICE_UNAVAILABLE",
+ "GATEWAY_TIMEOUT",
+ "NOT_IMPLEMENTED",
+ "INTERNAL_SERVER_ERROR",
+ "REQUEST_INVALID",
+ "AUTHENTICATION",
+ "PERMISSION",
+ "ENDPOINT_NOT_FOUND",
+ "ENDPOINT_STATE_CONFLICT",
+ "ENDPOINT_UNAVAILABLE",
+ "RATE_LIMIT",
+ "PROVIDER_BAD_RESPONSE",
+ "PROVIDER_UNAVAILABLE",
+ "PROVIDER_TIMEOUT"
+ ],
+ "type": "string"
+ },
+ "message": {
+ "description": "Plain-language description of the failure and the suggested next action.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "family",
+ "code",
+ "message"
+ ],
+ "type": "object"
+ }
+]