@portpowered/reference-data 0.0.0-stage → 0.4.0

package/generated/public/docs/for-ai/operations/enumerateOAuthClients.md

@@ -0,0 +1,117 @@
+# enumerateOAuthClients
+
+GET `/oauth-clients`
+
+
+
+Lists all OAuth clients for the authenticated user
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /oauth-clients
+runtimePath: /oauth-clients
+method: GET
+operationId: enumerateOAuthClients
+security:
+  - oauth2: []
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /oauth-clients
+get:
+  operationId: enumerateOAuthClients
+  tags:
+    - Clients
+  description: >-
+    Lists all OAuth clients for the authenticated user
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  parameters:
+    - name: nextToken
+      in: query
+      description: The next token to get the next page of results
+      required: false
+      schema:
+        type: string
+    - name: maxResults
+      in: query
+      description: The maximum number of results to return
+      required: false
+      schema:
+        type: integer
+    - name: expand
+      in: query
+      description: Expansion tokens that request related or computed fields for each result.
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: false
+      examples:
+        include-related:
+          value:
+            - metadata
+  responses:
+    '200':
+      description: OAuth clients retrieved successfully
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/EnumerateOAuthClientsResponse'
+          example:
+            results: []
+            paginationContext:
+              nextToken: abc123
+    '400':
+      description: Invalid request payload
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Invalid request payload
+            type: BAD_REQUEST
+            family: BAD_REQUEST
+            code: bad-request
+    '401':
+      description: Unauthorized - invalid or missing authentication token
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Unauthorized - invalid or missing authentication token
+            type: UNAUTHORIZED
+            family: AUTHENTICATION
+            code: unauthorized
+    '500':
+      description: Internal server error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Internal server error
+            type: INTERNAL_SERVER_ERROR
+            family: INTERNAL_SERVER_ERROR
+            code: internal-server-error
+  x-portos-delegated: false
+  x-portos-resource-permission: true
+  security:
+    - oauth2: []
+    - bearerAuth: []
+```
+
+Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

package/generated/public/docs/for-ai/operations/enumeratePlugins.md

@@ -0,0 +1,103 @@
+# enumeratePlugins
+
+GET `/plugins`
+
+
+
+Lists all available plugins
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /plugins
+runtimePath: /plugins
+method: GET
+operationId: enumeratePlugins
+security:
+  - oauth2: []
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /plugins
+get:
+  operationId: enumeratePlugins
+  tags:
+    - Plugins
+  description: >-
+    Lists all available plugins
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  parameters:
+    - name: expand
+      in: query
+      description: Space-delimited list of fields to expand (metadata)
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: false
+    - name: id
+      in: query
+      description: Full path ID of a specific plugin to retrieve (e.g. port1/systems/zero/plugins/{uuid})
+      required: false
+      schema:
+        type: string
+    - name: nextToken
+      in: query
+      description: Opaque cursor token returned by a previous query response.
+      required: false
+      schema:
+        type: string
+      examples:
+        next-page:
+          value: abc123
+    - name: maxResults
+      in: query
+      description: Maximum number of results to return.
+      required: false
+      schema:
+        type: integer
+      examples:
+        page-size:
+          value: 50
+  responses:
+    '200':
+      description: Plugins retrieved successfully
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/EnumeratePluginsResponse'
+          example:
+            results: []
+            paginationContext:
+              nextToken: abc123
+    '500':
+      description: Internal server error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Internal server error
+            type: INTERNAL_SERVER_ERROR
+            family: INTERNAL_SERVER_ERROR
+            code: internal-server-error
+  x-portos-delegated: false
+  x-portos-resource-permission: true
+  security:
+    - oauth2: []
+    - bearerAuth: []
+```
+
+Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

package/generated/public/docs/for-ai/operations/enumeratePrincipals.md

@@ -0,0 +1,101 @@
+# enumeratePrincipals
+
+GET `/principals`
+
+
+
+Lists all principals
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /principals
+runtimePath: /principals
+method: GET
+operationId: enumeratePrincipals
+security:
+  - oauth2: []
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /principals
+get:
+  operationId: enumeratePrincipals
+  tags:
+    - Principals
+  description: >-
+    Lists all principals
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  responses:
+    '200':
+      description: Principals retrieved successfully
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/EnumeratePrincipalsResponse'
+          example:
+            results: []
+            paginationContext:
+              nextToken: abc123
+    '500':
+      description: Internal server error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Internal server error
+            type: INTERNAL_SERVER_ERROR
+            family: INTERNAL_SERVER_ERROR
+            code: internal-server-error
+  parameters:
+    - name: expand
+      in: query
+      description: Expansion tokens that request related or computed fields for each result.
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: false
+      examples:
+        include-related:
+          value:
+            - metadata
+    - name: nextToken
+      in: query
+      description: Opaque cursor token returned by a previous query response.
+      required: false
+      schema:
+        type: string
+      examples:
+        next-page:
+          value: abc123
+    - name: maxResults
+      in: query
+      description: Maximum number of results to return.
+      required: false
+      schema:
+        type: integer
+      examples:
+        page-size:
+          value: 50
+  x-portos-delegated: false
+  x-portos-resource-permission: true
+  security:
+    - oauth2: []
+    - bearerAuth: []
+```
+
+Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

package/generated/public/docs/for-ai/operations/enumerateSecrets.md

@@ -0,0 +1,107 @@
+# enumerateSecrets
+
+GET `/secrets`
+
+
+
+Lists all secrets
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /secrets
+runtimePath: /secrets
+method: GET
+operationId: enumerateSecrets
+security:
+  - oauth2: []
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /secrets
+get:
+  operationId: enumerateSecrets
+  tags:
+    - Secrets
+  description: >-
+    Lists all secrets
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  parameters:
+    - name: id
+      in: query
+      description: The ID of the secret to get
+      required: false
+      schema:
+        type: string
+    - name: owner
+      in: query
+      description: The owner of the secrets to get
+      required: false
+      schema:
+        type: string
+    - name: nextToken
+      in: query
+      description: The next token to get the next page of results
+      required: false
+      schema:
+        type: string
+    - name: maxResults
+      in: query
+      description: The maximum number of results to return
+      required: false
+      schema:
+        type: integer
+    - name: expand
+      in: query
+      description: Expansion tokens that request related or computed fields for each result.
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: false
+      examples:
+        include-related:
+          value:
+            - metadata
+  responses:
+    '200':
+      description: Secrets retrieved successfully
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/EnumerateSecretsResponse'
+          example:
+            results: []
+            paginationContext:
+              nextToken: abc123
+    '500':
+      description: Internal server error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Internal server error
+            type: INTERNAL_SERVER_ERROR
+            family: INTERNAL_SERVER_ERROR
+            code: internal-server-error
+  x-portos-delegated: false
+  x-portos-resource-permission: true
+  security:
+    - oauth2: []
+    - bearerAuth: []
+```
+
+Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

package/generated/public/docs/for-ai/operations/enumerateSimulators.md

@@ -0,0 +1,170 @@
+# enumerateSimulators
+
+GET `/endpoint-simulators`
+
+List all simulators
+
+Lists endpoint simulators for the authenticated user. Supports pagination via `maxResults` and `nextToken` query parameters. When `owner` is not specified, defaults to the authenticated caller.
+ Missing or ordinary JSON Accept selects the existing string-name projection. Explicit application/vnd.portos.simulator.v2+json selects name-value output; unsupported explicit representations fail 406. Content-Type selects request projection, independent of Accept. Legacy object names fail 400. No legacy default flip or removal is authorized.
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /endpoint-simulators
+runtimePath: /endpoint-simulators
+method: GET
+operationId: enumerateSimulators
+security:
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /endpoint-simulators
+get:
+  operationId: enumerateSimulators
+  tags:
+    - Endpoint Simulators
+  summary: List all simulators
+  description: >-
+    Lists endpoint simulators for the authenticated user. Supports pagination via `maxResults` and
+    `nextToken` query parameters. When `owner` is not specified, defaults to the authenticated
+    caller.
+     Missing or ordinary JSON Accept selects the existing string-name projection. Explicit application/vnd.portos.simulator.v2+json selects name-value output; unsupported explicit representations fail 406. Content-Type selects request projection, independent of Accept. Legacy object names fail 400. No legacy default flip or removal is authorized.
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  security:
+    - bearerAuth: []
+  parameters:
+    - name: owner
+      in: query
+      description: >-
+        The owner of the simulators to retrieve. Defaults to the authenticated caller when not
+        specified.
+      required: false
+      schema:
+        type: string
+      examples:
+        caller:
+          value: ~caller
+    - name: maxResults
+      in: query
+      description: The maximum number of results to return
+      required: false
+      schema:
+        type: integer
+        minimum: 1
+        maximum: 1000
+      examples:
+        max-results:
+          value: 10
+    - name: nextToken
+      in: query
+      description: >-
+        An opaque token to retrieve the next page of results. Returned in the paginationContext of a
+        previous response.
+      required: false
+      schema:
+        type: string
+    - name: expand
+      in: query
+      description: Expansion tokens that request related or computed fields for each result.
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: false
+      examples:
+        include-related:
+          value:
+            - metadata
+  responses:
+    '200':
+      description: Simulators retrieved successfully
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/SimulatorQueryResponse'
+          example:
+            results: []
+            paginationContext:
+              nextToken: abc123
+        application/vnd.portos.simulator.v2+json:
+          schema:
+            $ref: '#/components/schemas/SimulatorQueryResponseV2'
+          example:
+            results:
+              - id: port1.simulator.camera-demo
+                name:
+                  type: PLAIN
+                  value: Front door camera
+                device_type: camera
+                configuration:
+                  eventProfile: doorbell
+            errors: []
+      headers:
+        Vary:
+          description: Response representation is selected by Accept.
+          schema:
+            type: string
+            example: Accept
+    '400':
+      description: Invalid request parameters
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Invalid request payload
+            type: BAD_REQUEST
+    '401':
+      description: Unauthorized - invalid or missing authentication token
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Authentication required
+            type: UNAUTHORIZED
+    '403':
+      description: Forbidden - insufficient permissions
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Insufficient permissions
+            type: FORBIDDEN
+    '406':
+      description: Unsupported explicitly requested representation.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Unsupported explicitly requested representation.
+            type: BAD_REQUEST
+            family: BAD_REQUEST
+            code: event_request_failed
+    '500':
+      description: Internal server error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Internal server error
+            type: INTERNAL
+  x-portos-delegated: false
+  x-portos-resource-permission: true
+```
+
+Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

package/generated/public/docs/for-ai/operations/enumerateSubscriptions.md

@@ -0,0 +1,98 @@
+# enumerateSubscriptions
+
+GET `/subscriptions`
+
+
+
+Used to query for subscriptions to an event stream.
+
+
+## Authorization
+
+```yaml
+path: /subscriptions
+runtimePath: /subscriptions
+method: GET
+operationId: enumerateSubscriptions
+security:
+  - oauth2:
+      - subscription:read
+  - bearerAuth: []
+delegated: true
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /subscriptions
+get:
+  tags:
+    - Subscriptions
+  operationId: enumerateSubscriptions
+  description: |
+    Used to query for subscriptions to an event stream.
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/EnumerateSubscriptionsResponse'
+          example:
+            results: []
+            paginationContext:
+              nextToken: abc123
+    '500':
+      description: Internal server error
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Internal server error
+            type: INTERNAL_SERVER_ERROR
+            family: INTERNAL_SERVER_ERROR
+            code: internal-server-error
+  parameters:
+    - name: expand
+      in: query
+      description: Expansion tokens that request related or computed fields for each result.
+      required: false
+      schema:
+        type: array
+        items:
+          type: string
+      style: form
+      explode: false
+      examples:
+        include-related:
+          value:
+            - metadata
+    - name: nextToken
+      in: query
+      description: Opaque cursor token returned by a previous query response.
+      required: false
+      schema:
+        type: string
+      examples:
+        next-page:
+          value: abc123
+    - name: maxResults
+      in: query
+      description: Maximum number of results to return.
+      required: false
+      schema:
+        type: integer
+      examples:
+        page-size:
+          value: 50
+  x-portos-delegated: true
+  x-portos-resource-permission: true
+  security:
+    - oauth2:
+        - subscription:read
+    - bearerAuth: []
+```
+
+Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).