@portpowered/reference-data 0.4.1 → 0.4.3

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

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The ID of the flow"
+    }
+  }
+}

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

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "message": {
+      "$ref": "/docs/references/schemas/Message.json"
+    },
+    "target": {
+      "$ref": "/docs/references/schemas/FlowRunMessageTarget.json"
+    }
+  }
+}

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

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

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

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The ID of the flow run message"
+    }
+  }
+}

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

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "flowRun": {
+      "$ref": "/docs/references/schemas/FlowRun.json"
+    }
+  }
+}

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

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

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

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The ID of the flow run"
+    }
+  }
+}

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

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "plugin": {
+      "$ref": "/docs/references/schemas/Plugin.json"
+    },
+    "applePushNotificationSecret": {
+      "type": "object",
+      "description": "APNS authentication token secret (required when creating an APPLE_PUSH_NOTIFICATION plugin with new credentials)",
+      "properties": {
+        "keyId": {
+          "type": "string",
+          "description": "The Apple Push Notification key ID"
+        },
+        "authKey": {
+          "type": "string",
+          "description": "The Apple Push Notification private key (P8 file contents)"
+        }
+      }
+    },
+    "secretReferenceId": {
+      "type": "string",
+      "description": "Reference to an existing secret in the secret store (use instead of inline credentials when the secret already exists)"
+    }
+  }
+}

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

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The created plugin ID",
+      "pattern": "^port1/[^/]+/[^/]+/plugins/[^/]+$"
+    }
+  }
+}

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

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "items"
+  ],
+  "properties": {
+    "item": {
+      "$ref": "/docs/references/schemas/Principal.json"
+    }
+  }
+}

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

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "result": {
+      "$ref": "/docs/references/schemas/Principal.json"
+    }
+  }
+}

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

@@ -0,0 +1,48 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "id",
+    "endpointId",
+    "pluginId"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The route ID"
+    },
+    "endpointId": {
+      "type": "string",
+      "description": "The endpoint ID"
+    },
+    "pluginId": {
+      "type": "string",
+      "description": "The plugin ID"
+    },
+    "interfaces": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/ApplicationInterface.json"
+      },
+      "description": "List of interfaces to support"
+    },
+    "metadata": {
+      "type": "object",
+      "description": "Additional metadata about the route",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The name of the route"
+        },
+        "manufacturer": {
+          "type": "string",
+          "description": "The manufacturer of the device"
+        },
+        "model": {
+          "type": "string",
+          "description": "The model of the device"
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "secret"
+  ],
+  "properties": {
+    "secret": {
+      "$ref": "/docs/references/schemas/Secret.json"
+    }
+  }
+}

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

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

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

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Legacy string-name application/json projection; default representation remains unchanged.",
+  "allOf": [
+    {
+      "$ref": "/docs/references/schemas/SimulatorSharedFields.json"
+    },
+    {
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Display name; legacy application/json projection of the canonical PLAIN name."
+        },
+        "id": {
+          "type": "string",
+          "description": "The unique identifier for the simulator (optional; if provided, performs an update/upsert)",
+          "pattern": "^port1\\.simulator\\..*"
+        }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Vendor v2 name-value projection.",
+  "allOf": [
+    {
+      "$ref": "/docs/references/schemas/SimulatorSharedFields.json"
+    },
+    {
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "properties": {
+        "name": {
+          "$ref": "/docs/references/schemas/TypeValue.json"
+        },
+        "id": {
+          "type": "string",
+          "description": "The unique identifier for the simulator (optional; if provided, performs an update/upsert)",
+          "pattern": "^port1\\.simulator\\..*"
+        }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "subscription": {
+      "$ref": "/docs/references/schemas/Subscription.json"
+    }
+  }
+}

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

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

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

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The ID of the subscription",
+      "example": "port1/systems/zero/subscriptions/123"
+    }
+  }
+}

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

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "title",
+    "positions",
+    "widgets"
+  ],
+  "properties": {
+    "title": {
+      "$ref": "/docs/references/schemas/TypeValue.json",
+      "description": "The title of the view"
+    },
+    "schemaVersion": {
+      "$ref": "/docs/references/schemas/ViewSchemaVersion.json"
+    },
+    "widgets": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/Widget.json"
+      },
+      "description": "The list of widgets in the view"
+    },
+    "positions": {
+      "type": "array",
+      "description": "Optional array of position objects for widgets",
+      "items": {
+        "$ref": "/docs/references/schemas/Position.json"
+      }
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The ID of the view that was created or updated"
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "client_id",
+    "redirect_uri"
+  ],
+  "properties": {
+    "client_id": {
+      "type": "string",
+      "description": "OAuth client identifier",
+      "example": "port1/principals/user123/oauth-clients/my-client"
+    },
+    "redirect_uri": {
+      "type": "string",
+      "description": "Redirect URI to validate",
+      "example": "https://myapp.com/callback"
+    },
+    "scopes": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/OAuthScope.json"
+      },
+      "description": "Requested scopes to validate"
+    },
+    "code_challenge": {
+      "type": "string",
+      "description": "PKCE code challenge (required if client requires PKCE)",
+      "example": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM"
+    },
+    "code_challenge_method": {
+      "type": "string",
+      "x-enum-exempt": "PKCE code challenge methods (RFC 7636)",
+      "enum": [
+        "S256",
+        "plain"
+      ],
+      "description": "PKCE code challenge method (S256 or plain)",
+      "example": "S256"
+    }
+  }
+}

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

@@ -0,0 +1,47 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "clientName",
+    "scopes"
+  ],
+  "description": "Response from the /oauth/validate-request endpoint. Contains client information relevant for displaying on the authorization page.\n",
+  "properties": {
+    "clientName": {
+      "type": "string",
+      "description": "Client name to display on the authorization page",
+      "example": "My OAuth Application"
+    },
+    "tosUri": {
+      "type": "string",
+      "format": "uri",
+      "description": "Terms of Service URI (optional)",
+      "example": "https://myapp.com/terms"
+    },
+    "policyUri": {
+      "type": "string",
+      "format": "uri",
+      "description": "Privacy Policy URI (optional)",
+      "example": "https://myapp.com/privacy"
+    },
+    "logoUri": {
+      "type": "string",
+      "format": "uri",
+      "description": "Logo URI for the client (optional)",
+      "example": "https://myapp.com/logo.png"
+    },
+    "clientUri": {
+      "type": "string",
+      "format": "uri",
+      "description": "Client URI (optional)",
+      "example": "https://myapp.com"
+    },
+    "scopes": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/OAuthScope.json"
+      },
+      "description": "Validated scopes that will be granted if the user consents"
+    }
+  }
+}

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

@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "deviceauth_id",
+    "client_name",
+    "client_id",
+    "status"
+  ],
+  "description": "Response from the /oauth/verify-device endpoint. Contains device and client information for display on the authorization page.\n",
+  "properties": {
+    "deviceauth_id": {
+      "type": "string",
+      "description": "Unique identifier for the device authentication entry",
+      "example": "da_1234567890abcdef"
+    },
+    "client_name": {
+      "type": "string",
+      "description": "Display name of the OAuth client requesting authorization",
+      "example": "My OAuth Application"
+    },
+    "client_id": {
+      "type": "string",
+      "description": "OAuth client identifier",
+      "example": "port1/principals/user123/oauth-clients/my-client"
+    },
+    "status": {
+      "type": "string",
+      "description": "Current status of the device authentication (e.g., \"pending\", \"authorized\", \"expired\")",
+      "example": "pending"
+    },
+    "logo_uri": {
+      "type": "string",
+      "format": "uri",
+      "description": "Logo URI for the client (optional)",
+      "example": "https://myapp.com/logo.png"
+    },
+    "client_uri": {
+      "type": "string",
+      "format": "uri",
+      "description": "Client URI (optional)",
+      "example": "https://myapp.com"
+    },
+    "tos_uri": {
+      "type": "string",
+      "format": "uri",
+      "description": "Terms of Service URI (optional)",
+      "example": "https://myapp.com/terms"
+    },
+    "policy_uri": {
+      "type": "string",
+      "format": "uri",
+      "description": "Privacy Policy URI (optional)",
+      "example": "https://myapp.com/privacy"
+    }
+  }
+}

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

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The unique identifier for the view"
+    },
+    "title": {
+      "$ref": "/docs/references/schemas/TypeValue.json",
+      "description": "The title of the view"
+    },
+    "schemaVersion": {
+      "type": "string",
+      "description": "The schema version of the view"
+    },
+    "version": {
+      "type": "string",
+      "description": "The version of the view schema that this view has been updated to"
+    },
+    "ownerId": {
+      "type": "string",
+      "description": "The ID of the owner of the view"
+    },
+    "widgets": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/Widget.json"
+      },
+      "description": "The list of widgets in the view"
+    },
+    "positions": {
+      "type": "array",
+      "description": "Optional array of position objects for widgets",
+      "items": {
+        "$ref": "/docs/references/schemas/Position.json"
+      }
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "description": "The schema version of the view",
+  "x-enum-exempt": "schema version identifiers",
+  "enum": [
+    "1.0"
+  ]
+}

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

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "description": "Mop water flow level, ordered from off to highest. CUSTOM is a vendor-specific setting with no Port OS name (for example per-room settings); devices report it but do not accept it.",
+  "enum": [
+    "OFF",
+    "LOW",
+    "MEDIUM",
+    "HIGH",
+    "EXTREME",
+    "CUSTOM"
+  ],
+  "x-enum-varnames": [
+    "WaterFlowOff",
+    "WaterFlowLow",
+    "WaterFlowMedium",
+    "WaterFlowHigh",
+    "WaterFlowExtreme",
+    "WaterFlowCustom"
+  ]
+}

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

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/water-heater",
+  "x-name": "water-heater",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "properties": {
+    "supportedModes": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "OFF",
+          "AUTO",
+          "HEAT",
+          "ECO",
+          "BOOST"
+        ]
+      },
+      "description": "Supported water heater modes"
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/water-heater",
+  "x-name": "mode",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "string",
+      "enum": [
+        "OFF",
+        "AUTO",
+        "HEAT",
+        "ECO",
+        "BOOST"
+      ]
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}