@portpowered/reference-data 0.4.1 → 0.4.2

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

@@ -60,13 +60,13 @@ post:
       schema:
         type: string
       description: The ID of the endpoint group
-    - $ref: '#/components/parameters/IfMatch'
+    - $ref: /docs/references/parameters/IfMatch.json
   requestBody:
     required: true
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/SetEndpointGroupNameRequest'
+          $ref: /docs/references/schemas/SetEndpointGroupNameRequest.json
         example:
           name:
             type: LIGHT
@@ -76,74 +76,86 @@ post:
       description: Endpoint group name update accepted
       headers:
         ETag:
-          $ref: '#/components/headers/ETag'
+          $ref: /docs/references/headers/ETag.json
     '400':
       description: Invalid request payload
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Invalid request payload
-            type: BAD_REQUEST
+            code: BAD_REQUEST
+            family: BAD_REQUEST
     '401':
       description: Unauthorized - invalid or missing authentication token
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Authentication required
-            type: UNAUTHORIZED
+            code: UNAUTHORIZED
+            family: UNAUTHORIZED
     '403':
       description: Forbidden - insufficient permissions
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Insufficient permissions
-            type: FORBIDDEN
+            code: FORBIDDEN
+            family: FORBIDDEN
     '404':
       description: Endpoint group not found
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Resource not found
-            type: NOT_FOUND
+            code: NOT_FOUND
+            family: NOT_FOUND
     '412':
       description: The If-Match etag does not match the current group version; re-read the group and retry
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: group etag does not match; re-read the group and retry
-            type: PRECONDITION_FAILED
+            code: PRECONDITION_FAILED
             family: PRECONDITION_FAILED
     '428':
       description: The If-Match header is missing
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: If-Match header is required; send the group's etag
-            type: PRECONDITION_REQUIRED
+            code: PRECONDITION_REQUIRED
             family: PRECONDITION_REQUIRED
     '500':
       description: Internal server error
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Internal server error
-            type: INTERNAL
+            code: INTERNAL
+            family: INTERNAL_SERVER_ERROR
   x-portos-delegated: true
   x-portos-resource-permission: true
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+- [ETag.json](/docs/references/headers/ETag.json)
+- [IfMatch.json](/docs/references/parameters/IfMatch.json)
+- [Error.json](/docs/references/schemas/Error.json)
+- [SetEndpointGroupNameRequest.json](/docs/references/schemas/SetEndpointGroupNameRequest.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -79,7 +79,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/SetFlowRunStatusRequest'
+          $ref: /docs/references/schemas/SetFlowRunStatusRequest.json
         example:
           id: port1/principals/user123/resources/abc-123
   responses:
@@ -92,30 +92,38 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Invalid request payload
-            type: BAD_REQUEST
+            code: BAD_REQUEST
+            family: BAD_REQUEST
     '401':
       description: Unauthorized — invalid or missing authentication token.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Authentication required
-            type: UNAUTHORIZED
+            code: UNAUTHORIZED
+            family: UNAUTHORIZED
     '403':
       description: Forbidden — insufficient permissions.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Insufficient permissions
-            type: FORBIDDEN
+            code: FORBIDDEN
+            family: 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).
+## Linked components
+
+- [Error.json](/docs/references/schemas/Error.json)
+- [SetFlowRunStatusRequest.json](/docs/references/schemas/SetFlowRunStatusRequest.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -76,7 +76,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/SynchronizationRequest'
+          $ref: /docs/references/schemas/SynchronizationRequest.json
         example:
           routes: []
   responses:
@@ -89,12 +89,12 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: >-
               discovery rejected: 1 route does not conform to the capability-interface library;
               nothing was synchronized
-            type: BAD_REQUEST
+            code: BAD_REQUEST
             family: BAD_REQUEST
             errors:
               - pluginRouteId: robot-1
@@ -114,30 +114,38 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Authentication required
-            type: UNAUTHORIZED
+            code: UNAUTHORIZED
+            family: UNAUTHORIZED
     '403':
       description: Forbidden — insufficient permissions
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Insufficient permissions
-            type: FORBIDDEN
+            code: FORBIDDEN
+            family: FORBIDDEN
     '500':
       description: Internal server error
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Internal server error
-            type: INTERNAL
+            code: INTERNAL
+            family: INTERNAL_SERVER_ERROR
   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).
+## Linked components
+
+- [Error.json](/docs/references/schemas/Error.json)
+- [SynchronizationRequest.json](/docs/references/schemas/SynchronizationRequest.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -45,7 +45,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/TriggerFlowRequest'
+          $ref: /docs/references/schemas/TriggerFlowRequest.json
         example:
           id: port1/principals/user123/resources/abc-123
   responses:
@@ -54,7 +54,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/TriggerFlowResponse'
+            $ref: /docs/references/schemas/TriggerFlowResponse.json
           example:
             id: port1/principals/user123/resources/abc-123
     '400':
@@ -62,30 +62,39 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Invalid request payload
-            type: BAD_REQUEST
+            code: BAD_REQUEST
+            family: BAD_REQUEST
     '401':
       description: Unauthorized — invalid or missing authentication token.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Authentication required
-            type: UNAUTHORIZED
+            code: UNAUTHORIZED
+            family: UNAUTHORIZED
     '403':
       description: Forbidden — insufficient permissions.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Insufficient permissions
-            type: FORBIDDEN
+            code: FORBIDDEN
+            family: 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).
+## Linked components
+
+- [Error.json](/docs/references/schemas/Error.json)
+- [TriggerFlowRequest.json](/docs/references/schemas/TriggerFlowRequest.json)
+- [TriggerFlowResponse.json](/docs/references/schemas/TriggerFlowResponse.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -70,7 +70,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/OAuthClientUpdateRequest'
+          $ref: /docs/references/schemas/OAuthClientUpdateRequest.json
         example:
           name:
             type: PLAIN
@@ -81,7 +81,7 @@ put:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/UpdateOAuthClientResponse'
+            $ref: /docs/references/schemas/UpdateOAuthClientResponse.json
           example:
             clientId: port1/principals/example
     '400':
@@ -99,4 +99,9 @@ put:
     - bearerAuth: []
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+- [OAuthClientUpdateRequest.json](/docs/references/schemas/OAuthClientUpdateRequest.json)
+- [UpdateOAuthClientResponse.json](/docs/references/schemas/UpdateOAuthClientResponse.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -68,7 +68,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/UpsertViewRequest'
+          $ref: /docs/references/schemas/UpsertViewRequest.json
         example:
           title:
             type: LIGHT
@@ -83,28 +83,31 @@ put:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Invalid request payload
-            type: BAD_REQUEST
+            code: BAD_REQUEST
+            family: BAD_REQUEST
     '404':
       description: View not found
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Resource not found
-            type: NOT_FOUND
+            code: NOT_FOUND
+            family: NOT_FOUND
     '500':
       description: Internal server error
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Internal server error
-            type: INTERNAL
+            code: INTERNAL
+            family: INTERNAL_SERVER_ERROR
   x-portos-delegated: false
   x-portos-resource-permission: true
   security:
@@ -112,4 +115,9 @@ put:
     - bearerAuth: []
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+- [Error.json](/docs/references/schemas/Error.json)
+- [UpsertViewRequest.json](/docs/references/schemas/UpsertViewRequest.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -43,7 +43,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/UpsertAccessControlRuleRequest'
+          $ref: /docs/references/schemas/UpsertAccessControlRuleRequest.json
         example:
           operation: port1/principals/example
           resource: port1/users/alice/endpoints/thermostat-zero
@@ -55,7 +55,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/UpsertAccessControlRuleResponse'
+            $ref: /docs/references/schemas/UpsertAccessControlRuleResponse.json
           example:
             id: port1/principals/user123/resources/abc-123
     '400':
@@ -65,12 +65,11 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Internal server error
-            type: INTERNAL_SERVER_ERROR
+            code: INTERNAL
             family: INTERNAL_SERVER_ERROR
-            code: internal-server-error
   x-portos-delegated: false
   x-portos-resource-permission: true
   security:
@@ -78,4 +77,10 @@ post:
     - bearerAuth: []
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+- [Error.json](/docs/references/schemas/Error.json)
+- [UpsertAccessControlRuleRequest.json](/docs/references/schemas/UpsertAccessControlRuleRequest.json)
+- [UpsertAccessControlRuleResponse.json](/docs/references/schemas/UpsertAccessControlRuleResponse.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -41,7 +41,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/UpsertAuthLinkRequest'
+          $ref: /docs/references/schemas/UpsertAuthLinkRequest.json
         example:
           authLink:
             associatedPrincipalId: port1/principals/example
@@ -54,7 +54,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/UpsertAuthLinkResponse'
+            $ref: /docs/references/schemas/UpsertAuthLinkResponse.json
           example:
             id: port1/principals/user123/resources/abc-123
     '400':
@@ -68,4 +68,9 @@ post:
     - bearerAuth: []
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+- [UpsertAuthLinkRequest.json](/docs/references/schemas/UpsertAuthLinkRequest.json)
+- [UpsertAuthLinkResponse.json](/docs/references/schemas/UpsertAuthLinkResponse.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -35,7 +35,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/UpsertEndpointRequest'
+          $ref: /docs/references/schemas/UpsertEndpointRequest.json
         example:
           id: port1/principals/example/endpoints/light-1
           name:
@@ -57,4 +57,8 @@ post:
     - bearerAuth: []
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+- [UpsertEndpointRequest.json](/docs/references/schemas/UpsertEndpointRequest.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -46,7 +46,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/UpsertFlowRequest'
+          $ref: /docs/references/schemas/UpsertFlowRequest.json
         example:
           name:
             type: PLAIN
@@ -57,7 +57,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/UpsertFlowResponse'
+            $ref: /docs/references/schemas/UpsertFlowResponse.json
           example:
             id: port1/principals/user123/resources/abc-123
     '400':
@@ -65,30 +65,39 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Invalid request payload
-            type: BAD_REQUEST
+            code: BAD_REQUEST
+            family: BAD_REQUEST
     '401':
       description: Unauthorized — invalid or missing authentication token.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Authentication required
-            type: UNAUTHORIZED
+            code: UNAUTHORIZED
+            family: UNAUTHORIZED
     '403':
       description: Forbidden — insufficient permissions.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Insufficient permissions
-            type: FORBIDDEN
+            code: FORBIDDEN
+            family: 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).
+## Linked components
+
+- [Error.json](/docs/references/schemas/Error.json)
+- [UpsertFlowRequest.json](/docs/references/schemas/UpsertFlowRequest.json)
+- [UpsertFlowResponse.json](/docs/references/schemas/UpsertFlowResponse.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -78,7 +78,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/UpsertFlowRunMessageRequest'
+          $ref: /docs/references/schemas/UpsertFlowRunMessageRequest.json
         example:
           name:
             type: PLAIN
@@ -89,7 +89,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/UpsertFlowRunMessageResponse'
+            $ref: /docs/references/schemas/UpsertFlowRunMessageResponse.json
           example:
             id: port1/principals/user123/resources/abc-123
     '400':
@@ -97,30 +97,39 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Invalid request payload
-            type: BAD_REQUEST
+            code: BAD_REQUEST
+            family: BAD_REQUEST
     '401':
       description: Unauthorized — invalid or missing authentication token.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Authentication required
-            type: UNAUTHORIZED
+            code: UNAUTHORIZED
+            family: UNAUTHORIZED
     '403':
       description: Forbidden — insufficient permissions.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
             message: Insufficient permissions
-            type: FORBIDDEN
+            code: FORBIDDEN
+            family: 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).
+## Linked components
+
+- [Error.json](/docs/references/schemas/Error.json)
+- [UpsertFlowRunMessageRequest.json](/docs/references/schemas/UpsertFlowRunMessageRequest.json)
+- [UpsertFlowRunMessageResponse.json](/docs/references/schemas/UpsertFlowRunMessageResponse.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).

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

@@ -41,7 +41,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/UpsertPluginRequest'
+          $ref: /docs/references/schemas/UpsertPluginRequest.json
         example:
           name:
             type: PLAIN
@@ -52,7 +52,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/UpsertPluginResponse'
+            $ref: /docs/references/schemas/UpsertPluginResponse.json
           example:
             id: port1/principals/example/plugins/example
     '400':
@@ -66,4 +66,9 @@ post:
     - bearerAuth: []
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+- [UpsertPluginRequest.json](/docs/references/schemas/UpsertPluginRequest.json)
+- [UpsertPluginResponse.json](/docs/references/schemas/UpsertPluginResponse.json)
+
+Follow only the linked components needed for this operation. [Schema directory](/docs/for-ai/schemas.md). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).