@portpowered/reference-data 0.4.1 → 0.4.2

package/generated/public/docs/references/schemas/ErrorCode.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "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",
+    "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",
+    "EVENT_MANAGEMENT_DISABLED",
+    "SUBSCRIPTION_IDENTITY_IMMUTABLE",
+    "UNSUPPORTED_MEDIA_TYPE",
+    "EVENT_PAYLOAD_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_ATTRIBUTE",
+    "PLUGIN_ROUTE_ID_CONFLICT",
+    "UNRESOLVED_REFERENCE",
+    "INVALID_RELATIONSHIP",
+    "RELATIONSHIP_CYCLE",
+    "MULTIPLE_PARENTS",
+    "FLOW_VALIDATION_FAILED"
+  ]
+}

package/generated/public/docs/references/schemas/ErrorDetails.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "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": {
+    "endpointId": {
+      "type": "string",
+      "description": "Port OS endpoint ID involved in the failed dispatch."
+    },
+    "pluginId": {
+      "type": "string",
+      "description": "Port OS plugin ID that reported the failure."
+    },
+    "pluginRouteId": {
+      "type": "string",
+      "description": "Plugin-owned route identifier involved in the failed dispatch."
+    },
+    "provider": {
+      "type": "string",
+      "description": "Third-party provider or bridge name that reported the failure."
+    },
+    "directive": {
+      "type": "string",
+      "description": "Message namespace and name or provider directive that failed."
+    },
+    "parameter": {
+      "type": "string",
+      "description": "Request parameter or capability value that caused the failure."
+    },
+    "minimum": {
+      "type": "number",
+      "description": "Minimum accepted value when `code` is `VALUE_OUT_OF_RANGE`."
+    },
+    "maximum": {
+      "type": "number",
+      "description": "Maximum accepted value when `code` is `VALUE_OUT_OF_RANGE`."
+    },
+    "actual": {
+      "type": "string",
+      "description": "String representation of the submitted value when the plugin can safely report it."
+    },
+    "currentMode": {
+      "type": "string",
+      "description": "Current endpoint mode when `code` is `NOT_SUPPORTED_IN_CURRENT_MODE`."
+    },
+    "retryAfterSeconds": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "Suggested retry delay for rate-limit or provider-unavailable failures."
+    },
+    "correlationId": {
+      "type": "string",
+      "description": "Provider or plugin correlation ID useful for support."
+    },
+    "providerCode": {
+      "type": "string",
+      "description": "The third-party provider's own error code, for support. It is opaque and provider-specific; branch on `code` and `family` instead."
+    },
+    "correlationToken": {
+      "type": "string",
+      "description": "Token that correlates an outcome-unknown dispatch with its eventual result."
+    },
+    "fieldErrors": {
+      "type": "array",
+      "description": "The request fields that were rejected, when the error is about the request's content.",
+      "items": {
+        "$ref": "/docs/references/schemas/ErrorFieldError.json"
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/ErrorFamily.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "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"
+  ],
+  "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."
+}

package/generated/public/docs/references/schemas/ErrorFieldError.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "One rejected request field of an error.",
+  "additionalProperties": false,
+  "required": [
+    "field",
+    "reason"
+  ],
+  "properties": {
+    "field": {
+      "type": "string",
+      "description": "Name or JSON path of the rejected field."
+    },
+    "reason": {
+      "type": "string",
+      "description": "Why the field was rejected and what an accepted value looks like."
+    }
+  }
+}

package/generated/public/docs/references/schemas/EstablishAuthLinkRequest.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "pluginId"
+  ],
+  "properties": {
+    "authLinkId": {
+      "type": "string",
+      "description": "Identifier for the auth link"
+    },
+    "pluginId": {
+      "type": "string",
+      "description": "The plugin to associate with this auth link"
+    },
+    "applePushNotificationDeviceToken": {
+      "type": "string",
+      "description": "Device token for Apple Push Notification Service"
+    },
+    "oauthTokens": {
+      "type": "object",
+      "description": "OAuth token credentials",
+      "properties": {
+        "accessToken": {
+          "type": "string"
+        },
+        "refreshToken": {
+          "type": "string"
+        },
+        "expiresIn": {
+          "type": "integer"
+        }
+      }
+    },
+    "usernamePassword": {
+      "type": "object",
+      "description": "Username and password credentials",
+      "properties": {
+        "username": {
+          "type": "string"
+        },
+        "password": {
+          "type": "string"
+        }
+      }
+    },
+    "apiKey": {
+      "type": "string",
+      "description": "API key for service authentication (e.g. OpenRouter)"
+    }
+  }
+}

package/generated/public/docs/references/schemas/EstablishAuthLinkResponse.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The ID of the created auth link"
+    }
+  }
+}

package/generated/public/docs/references/schemas/EstablishPluginRequest.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "plugin"
+  ],
+  "properties": {
+    "plugin": {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The plugin type (e.g. local, webservice, applePushNotification)\n"
+        },
+        "applePushNotificationPlugin": {
+          "type": "object",
+          "description": "Configuration for Apple Push Notification plugins"
+        },
+        "webservicePlugin": {
+          "type": "object",
+          "description": "Configuration for HTTP-based remote plugins"
+        },
+        "localPlugin": {
+          "type": "object",
+          "description": "Configuration for plugins running on the server instance"
+        },
+        "clientCredentials": {
+          "type": "object",
+          "description": "OAuth client credentials for webservice plugins",
+          "properties": {
+            "clientId": {
+              "type": "string"
+            },
+            "clientSecret": {
+              "type": "string"
+            },
+            "tokenEndpoint": {
+              "type": "string"
+            }
+          }
+        },
+        "secretReferenceId": {
+          "type": "string",
+          "description": "Reference to an existing secret in the secret store"
+        },
+        "applePushNotificationSecret": {
+          "type": "object",
+          "description": "APNS authentication token secret"
+        }
+      }
+    }
+  }
+}

package/generated/public/docs/references/schemas/EstablishPluginResponse.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "pluginId"
+  ],
+  "properties": {
+    "pluginId": {
+      "type": "string",
+      "description": "The ID of the created or updated plugin"
+    },
+    "isUpdateResponse": {
+      "type": "boolean",
+      "description": "Whether this was an update to an existing plugin rather than a new creation"
+    }
+  }
+}

package/generated/public/docs/references/schemas/EvaluateAccessControlRuleRequest.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Evaluate whether or not a request is allowed to be performed.",
+  "required": [
+    "requests"
+  ],
+  "properties": {
+    "requesterContext": {
+      "$ref": "/docs/references/schemas/AccessControlRequesterContext.json"
+    },
+    "resourceContext": {
+      "$ref": "/docs/references/schemas/AccessControlResourceContext.json"
+    },
+    "entities": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/AccessControlEntity.json"
+      }
+    },
+    "operation": {
+      "type": "string"
+    }
+  }
+}

package/generated/public/docs/references/schemas/EvaluateAccessControlRuleResponse.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "result": {
+      "$ref": "/docs/references/schemas/EvaluateAccessControlRuleResult.json"
+    },
+    "error": {
+      "$ref": "/docs/references/schemas/Error.json"
+    }
+  }
+}

package/generated/public/docs/references/schemas/EvaluateAccessControlRuleResult.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": [
+    "ALLOW",
+    "DENY"
+  ]
+}

package/generated/public/docs/references/schemas/EventDeadLetter.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "additionalProperties": false,
+  "description": "Tenant/operator-authorized redacted diagnostics. Does not expose raw payload, callback URL or credentials. Unresolved provider records belong only to provider operators.",
+  "required": [
+    "id",
+    "stage",
+    "reasonCode",
+    "createdAt",
+    "expiresAt",
+    "redriveCount",
+    "redriveEligible",
+    "observedAt"
+  ],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "receiptId": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "eventId": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "subscriptionId": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "stage": {
+      "type": "string",
+      "enum": [
+        "INGRESS",
+        "PROCESSING",
+        "DELIVERY",
+        "MANAGEMENT"
+      ],
+      "x-enum-varnames": [
+        "EventDeadLetterStageIngress",
+        "EventDeadLetterStageProcessing",
+        "EventDeadLetterStageDelivery",
+        "EventDeadLetterStageManagement"
+      ]
+    },
+    "reasonCode": {
+      "type": "string"
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "expiresAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "redriveCount": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 3
+    },
+    "redriveEligible": {
+      "type": "boolean"
+    },
+    "observedAt": {
+      "type": "string",
+      "format": "date-time"
+    }
+  }
+}

package/generated/public/docs/references/schemas/EventDeadLetterQueryResponse.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "results"
+  ],
+  "properties": {
+    "results": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/EventDeadLetter.json"
+      }
+    },
+    "paginationContext": {
+      "$ref": "/docs/references/schemas/PaginationContext.json"
+    },
+    "errors": {
+      "type": "array",
+      "description": "Partial query errors; omitted when no errors occurred.",
+      "items": {
+        "$ref": "/docs/references/schemas/Error.json"
+      }
+    }
+  },
+  "description": "Authorized redacted dead-letter results with opaque cursor pagination and partial query errors."
+}

package/generated/public/docs/references/schemas/EventDeliverySummary.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "additionalProperties": false,
+  "description": "Authorized subscription delivery metadata. Acknowledged means host HTTP acceptance only. Callback URL, credentials and event body are never exposed.",
+  "required": [
+    "subscriptionId",
+    "eventId",
+    "status",
+    "attemptCount"
+  ],
+  "properties": {
+    "subscriptionId": {
+      "type": "string"
+    },
+    "eventId": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "PENDING",
+        "SENDING",
+        "ACKNOWLEDGED",
+        "DEAD",
+        "DROPPED",
+        "CANCELLED"
+      ],
+      "x-enum-varnames": [
+        "EventDeliveryStatusPending",
+        "EventDeliveryStatusSending",
+        "EventDeliveryStatusAcknowledged",
+        "EventDeliveryStatusDead",
+        "EventDeliveryStatusDropped",
+        "EventDeliveryStatusCancelled"
+      ]
+    },
+    "reasonCode": {
+      "type": "string"
+    },
+    "attemptCount": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "lastAttemptAt": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "format": "date-time"
+    }
+  }
+}

package/generated/public/docs/references/schemas/EventDetectionSensorInterfaceConfiguration.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/event-detection-sensor",
+  "x-name": "event-detection-sensor",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "properties": {
+    "detectionMethods": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "AUDIO",
+          "VIDEO"
+        ]
+      }
+    },
+    "supportedEvents": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/SupportedEvent.json"
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/EventDetectionSensorInterfaceHumanPresenceDetectionStateAttribute.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/event-detection-sensor",
+  "x-name": "human-presence-detection-state",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "string",
+      "enum": [
+        "DETECTED",
+        "NOT_DETECTED"
+      ]
+    },
+    "detectionMethods": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "AUDIO",
+          "VIDEO"
+        ]
+      }
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/EventDetectionSensorInterfacePersonDetectedMessage.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/event-detection-sensor",
+  "x-name": "person-detected",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "out",
+  "x-event": true,
+  "x-event-name": "camera.person_detected",
+  "description": "A distinct person detection occurrence, independent of cached presence state.",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "string",
+      "enum": [
+        "DETECTED"
+      ],
+      "x-enum-varnames": [
+        "PersonOccurrenceDetected"
+      ]
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}