@portpowered/reference-data 0.0.0-stage → 0.4.0

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

@@ -0,0 +1,91 @@
+# triggerFlow
+
+POST `/flows/trigger`
+
+Trigger a flow
+
+Triggers the execution of a flow with the provided trigger messages.
+
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /flows/trigger
+runtimePath: /flows/trigger
+method: POST
+operationId: triggerFlow
+security:
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /flows/trigger
+post:
+  tags:
+    - Flows
+  operationId: triggerFlow
+  summary: Trigger a flow
+  description: >-
+    Triggers the execution of a flow with the provided trigger messages.
+
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  security:
+    - bearerAuth: []
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/TriggerFlowRequest'
+        example:
+          id: port1/principals/user123/resources/abc-123
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/TriggerFlowResponse'
+          example:
+            id: port1/principals/user123/resources/abc-123
+    '400':
+      description: Bad request — invalid request payload.
+      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
+  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/updateOAuthClient.md

@@ -0,0 +1,100 @@
+# updateOAuthClient
+
+PUT `/port1/{principalType}/{principalId}/oauth-clients/{clientId}`
+
+
+
+Updates an existing OAuth client.
+This endpoint allows you to update the configuration of an OAuth client,  such as its name, redirect URIs, grant types, and scopes.
+Note: The client secret cannot be updated through this endpoint. If you  need to rotate the client secret, you should create a new client.
+
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /port1/{principalType}/{principalId}/oauth-clients/{clientId}
+runtimePath: /{namespace}/{principalType}/{principalId}/oauth-clients/{clientId}
+method: PUT
+operationId: updateOAuthClient
+security:
+  - oauth2: []
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /port1/{principalType}/{principalId}/oauth-clients/{clientId}
+put:
+  operationId: updateOAuthClient
+  tags:
+    - Clients
+  description: >-
+    Updates an existing OAuth client.
+
+    This endpoint allows you to update the configuration of an OAuth client,  such as its name,
+    redirect URIs, grant types, and scopes.
+
+    Note: The client secret cannot be updated through this endpoint. If you  need to rotate the
+    client secret, you should create a new client.
+
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  parameters:
+    - name: principalType
+      in: path
+      required: true
+      schema:
+        type: string
+      description: The type of principal that owns the OAuth client
+    - name: principalId
+      in: path
+      required: true
+      schema:
+        type: string
+      description: The ID of the principal that owns the OAuth client
+    - name: clientId
+      in: path
+      required: true
+      schema:
+        type: string
+      description: The ID of the OAuth client to update
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/OAuthClientUpdateRequest'
+        example:
+          name:
+            type: PLAIN
+            value: Updated Resource
+  responses:
+    '200':
+      description: OAuth client updated successfully
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/UpdateOAuthClientResponse'
+    '400':
+      description: Invalid request payload
+    '401':
+      description: Unauthorized - invalid or missing authentication token
+    '404':
+      description: OAuth client not found
+    '500':
+      description: 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/updateView.md

@@ -0,0 +1,109 @@
+# updateView
+
+PUT `/{namespace}/{principalType}/{principalId}/views/{viewId}`
+
+
+
+Update a view by ID.
+
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /{namespace}/{principalType}/{principalId}/views/{viewId}
+runtimePath: /{namespace}/{principalType}/{principalId}/views/{viewId}
+method: PUT
+operationId: updateView
+security:
+  - oauth2: []
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /{namespace}/{principalType}/{principalId}/views/{viewId}
+put:
+  tags:
+    - Views
+  operationId: updateView
+  description: >-
+    Update a view by ID.
+
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  parameters:
+    - name: namespace
+      required: true
+      in: path
+      schema:
+        type: string
+      description: The namespace of the principal
+    - name: principalType
+      required: true
+      in: path
+      schema:
+        type: string
+      description: The type of principal
+    - name: principalId
+      required: true
+      in: path
+      schema:
+        type: string
+      description: The ID of the principal
+    - name: viewId
+      required: true
+      in: path
+      schema:
+        type: string
+      description: The ID of the view to update
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/UpsertViewRequest'
+  responses:
+    '200':
+      description: View updated successfully
+    '400':
+      description: Invalid request payload
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Invalid request payload
+            type: BAD_REQUEST
+    '404':
+      description: View not found
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+          example:
+            message: Resource not found
+            type: NOT_FOUND
+    '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
+  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/upsertAccessControlRule.md

@@ -0,0 +1,76 @@
+# upsertAccessControlRule
+
+POST `/access-control-rules`
+
+
+
+Upsert an access control rule.
+
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /access-control-rules
+runtimePath: /access-control-rules
+method: POST
+operationId: upsertAccessControlRule
+security:
+  - oauth2: []
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /access-control-rules
+post:
+  tags:
+    - Access Control Rules
+  operationId: upsertAccessControlRule
+  description: >-
+    Upsert an access control rule.
+
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/UpsertAccessControlRuleRequest'
+  responses:
+    '200':
+      description: Access control rule upserted successfully
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/UpsertAccessControlRuleResponse'
+          example:
+            id: port1/principals/user123/resources/abc-123
+    '400':
+      description: Invalid request payload
+    '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/upsertAuthLink.md

@@ -0,0 +1,65 @@
+# upsertAuthLink
+
+POST `/auth-links`
+
+
+
+Creates a new auth link
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /auth-links
+runtimePath: /auth-links
+method: POST
+operationId: upsertAuthLink
+security:
+  - oauth2: []
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /auth-links
+post:
+  operationId: upsertAuthLink
+  tags:
+    - Auth Links
+  description: >-
+    Creates a new auth link
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/UpsertAuthLinkRequest'
+  responses:
+    '200':
+      description: Auth link created successfully
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/UpsertAuthLinkResponse'
+          example:
+            id: port1/principals/user123/resources/abc-123
+    '400':
+      description: Invalid request payload
+    '500':
+      description: 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/upsertEndpoint.md

@@ -0,0 +1,54 @@
+# upsertEndpoint
+
+POST `/endpoints`
+
+
+
+Creates or updates an endpoint
+
+## Authorization
+
+```yaml
+path: /endpoints
+runtimePath: /endpoints
+method: POST
+operationId: upsertEndpoint
+security:
+  - oauth2:
+      - endpoint:write
+  - bearerAuth: []
+delegated: true
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /endpoints
+post:
+  operationId: upsertEndpoint
+  tags:
+    - Endpoints
+  description: Creates or updates an endpoint
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/UpsertEndpointRequest'
+  responses:
+    '200':
+      description: Endpoint upserted successfully
+    '400':
+      description: Invalid request payload
+    '500':
+      description: Internal server error
+  x-portos-delegated: true
+  x-portos-resource-permission: true
+  security:
+    - oauth2:
+        - endpoint:write
+    - 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/upsertFlow.md

@@ -0,0 +1,94 @@
+# upsertFlow
+
+POST `/flows`
+
+Create or update a flow
+
+Creates or updates a flow definition. Flows are general operations that take in messages, send messages, perform computation, and read from storage.
+
+
+Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.
+
+## Authorization
+
+```yaml
+path: /flows
+runtimePath: /flows
+method: POST
+operationId: upsertFlow
+security:
+  - bearerAuth: []
+delegated: false
+resourcePermissionRequired: true
+```
+
+## Complete operation contract
+
+```yaml
+path: /flows
+post:
+  tags:
+    - Flows
+  operationId: upsertFlow
+  summary: Create or update a flow
+  description: >-
+    Creates or updates a flow definition. Flows are general operations that take in messages, send
+    messages, perform computation, and read from storage.
+
+
+
+    Requires a signed user/session or the existing authenticated client flow. The anonymous DCR
+    delegated device profile cannot invoke this operation.
+  security:
+    - bearerAuth: []
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '#/components/schemas/UpsertFlowRequest'
+        example:
+          name:
+            type: PLAIN
+            value: My Resource
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/UpsertFlowResponse'
+          example:
+            id: port1/principals/user123/resources/abc-123
+    '400':
+      description: Bad request — invalid request payload.
+      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
+  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).