@portpowered/reference-data 0.4.1 → 0.4.2

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

@@ -62,13 +62,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/RemoveEndpointGroupMembersRequest'
+          $ref: /docs/references/schemas/RemoveEndpointGroupMembersRequest.json
         example:
           memberEndpointIds: []
   responses:
@@ -76,74 +76,86 @@ post:
       description: Members removal 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)
+- [RemoveEndpointGroupMembersRequest.json](/docs/references/schemas/RemoveEndpointGroupMembersRequest.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/requestFutureIntegration.md

@@ -41,14 +41,14 @@ post:
           pluginId: port1/systems/zero/plugins/715b7b85-311f-4851-8430-88bbac6dd3e7
           consent: true
         schema:
-          $ref: '#/components/schemas/IntegrationRequest'
+          $ref: /docs/references/schemas/IntegrationRequest.json
   responses:
     '201':
       description: Request saved
       content:
         application/json:
           example:
-            status: requested
+            status: REQUESTED
           schema:
             type: object
             required:
@@ -57,39 +57,46 @@ post:
               status:
                 type: string
                 enum:
-                  - requested
+                  - REQUESTED
+                x-enum-varnames:
+                  - Requested
     '400':
       description: Invalid email, consent, or future plugin identifier
       content:
         application/json:
           example:
             message: Invalid email, consent, or future plugin identifier
-            type: BAD_REQUEST
+            code: BAD_REQUEST
             family: BAD_REQUEST
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
     '429':
       description: Too many requests; retry after the Retry-After interval
       content:
         application/json:
           example:
             message: Too many requests; retry after the Retry-After interval
-            type: TOO_MANY_REQUESTS
+            code: TOO_MANY_REQUESTS
             family: TOO_MANY_REQUESTS
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
     '500':
       description: Waitlist temporarily unavailable; the client may retry
       content:
         application/json:
           example:
             message: Waitlist temporarily unavailable; the client may retry
-            type: INTERNAL_SERVER_ERROR
+            code: INTERNAL
             family: INTERNAL_SERVER_ERROR
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
   x-portos-delegated: false
   x-portos-resource-permission: false
 ```
 
-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)
+- [IntegrationRequest.json](/docs/references/schemas/IntegrationRequest.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/revokeOAuthGrant.md

@@ -59,4 +59,8 @@ post:
       description: Revocation storage unavailable; do not claim success.
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+This operation uses inline schemas.
+
+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/sendMessage.md

@@ -101,7 +101,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/CreateMessageRequest'
+          $ref: /docs/references/schemas/CreateMessageRequest.json
         example:
           target:
             type: ENDPOINT
@@ -118,7 +118,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/CreateMessageResponse'
+            $ref: /docs/references/schemas/CreateMessageResponse.json
           example:
             messageId: example-dispatch-id
     '400':
@@ -126,13 +126,13 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: INVALID_VALUE
+            code: INVALID_VALUE
             family: REQUEST_INVALID
-            code: provider-invalid-speed
             message: Fan speed must be one of the supported values.
             details:
+              providerCode: provider-invalid-speed
               parameter: speed
               actual: storm
     '401':
@@ -140,59 +140,60 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: AUTHORIZATION_CREDENTIAL_EXPIRED
+            code: AUTHORIZATION_CREDENTIAL_EXPIRED
             family: AUTHENTICATION
-            code: provider-token-expired
             message: The provider authorization has expired. Re-link the plugin.
+            details:
+              providerCode: provider-token-expired
     '403':
       description: Plugin provider denied the requested operation
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: INSUFFICIENT_PERMISSIONS
+            code: INSUFFICIENT_PERMISSIONS
             family: PERMISSION
-            code: provider-scope-missing
             message: The linked account does not grant permission for this device.
+            details:
+              providerCode: provider-scope-missing
     '404':
       description: Target endpoint or plugin route was not found
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: NOT_FOUND
+            code: NOT_FOUND
             family: NOT_FOUND
-            code: message-not-found
             message: The linked account does not grant permission for this device.
     '409':
       description: Endpoint state conflicts with the requested message
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: NOT_SUPPORTED_IN_CURRENT_MODE
+            code: NOT_SUPPORTED_IN_CURRENT_MODE
             family: ENDPOINT_STATE_CONFLICT
-            code: device-mode-conflict
             message: The command is not supported while the endpoint is in eco mode.
             details:
+              providerCode: device-mode-conflict
               currentMode: eco
     '422':
       description: Plugin rejected a semantically invalid message value
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: VALUE_OUT_OF_RANGE
+            code: VALUE_OUT_OF_RANGE
             family: REQUEST_INVALID
-            code: brightness-out-of-range
             message: Brightness must be between 1 and 100.
             details:
+              providerCode: brightness-out-of-range
               parameter: brightness
               minimum: 1
               maximum: 100
@@ -202,13 +203,13 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: ENDPOINT_UNREACHABLE
+            code: ENDPOINT_UNREACHABLE
             family: ENDPOINT_UNAVAILABLE
-            code: device-offline
             message: The device is not reachable.
             details:
+              providerCode: device-offline
               pluginId: port1.plugin.hue
               pluginRouteId: hue-device-42
     '429':
@@ -216,58 +217,60 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: RATE_LIMIT_EXCEEDED
+            code: RATE_LIMIT_EXCEEDED
             family: RATE_LIMIT
-            code: provider-rate-limit
             message: The provider rate limit was exceeded.
             details:
+              providerCode: provider-rate-limit
               retryAfterSeconds: 60
     '500':
       description: Internal server error
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: INTERNAL_SERVER_ERROR
+            code: INTERNAL
             family: INTERNAL_SERVER_ERROR
-            code: internal-server-error
             message: The server failed
     '502':
       description: Plugin provider returned an invalid or internal error response
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: PROVIDER_INTERNAL_ERROR
+            code: PROVIDER_INTERNAL_ERROR
             family: PROVIDER_BAD_RESPONSE
-            code: provider-internal-error
             message: The provider failed while handling the command.
+            details:
+              providerCode: provider-internal-error
     '503':
       description: Plugin provider or bridge is unavailable
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: PROVIDER_SERVICE_UNAVAILABLE
+            code: PROVIDER_SERVICE_UNAVAILABLE
             family: PROVIDER_UNAVAILABLE
-            code: vendor-outage
             message: The provider service is temporarily unavailable.
+            details:
+              providerCode: vendor-outage
     '504':
       description: Plugin provider timed out
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: PROVIDER_TIMEOUT
+            code: PROVIDER_TIMEOUT
             family: PROVIDER_TIMEOUT
-            code: provider-timeout
             message: The provider did not respond before the timeout.
+            details:
+              providerCode: provider-timeout
   x-portos-delegated: true
   x-portos-resource-permission: true
   security:
@@ -276,4 +279,10 @@ post:
     - bearerAuth: []
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+- [CreateMessageRequest.json](/docs/references/schemas/CreateMessageRequest.json)
+- [CreateMessageResponse.json](/docs/references/schemas/CreateMessageResponse.json)
+- [Error.json](/docs/references/schemas/Error.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/sendMessageLegacyAlias.md

@@ -101,7 +101,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '#/components/schemas/CreateMessageRequest'
+          $ref: /docs/references/schemas/CreateMessageRequest.json
         example:
           target:
             type: ENDPOINT
@@ -118,7 +118,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/CreateMessageResponse'
+            $ref: /docs/references/schemas/CreateMessageResponse.json
           example:
             messageId: example-dispatch-id
     '400':
@@ -126,148 +126,155 @@ post:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: INVALID_VALUE
             family: REQUEST_INVALID
-            code: provider-invalid-speed
+            code: INVALID_VALUE
             message: Fan speed must be one of the supported values.
             details:
               parameter: speed
               actual: storm
+              providerCode: provider-invalid-speed
     '401':
       description: Plugin authorization credential is invalid or expired
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: AUTHORIZATION_CREDENTIAL_EXPIRED
             family: AUTHENTICATION
-            code: provider-token-expired
+            code: AUTHORIZATION_CREDENTIAL_EXPIRED
             message: The provider authorization has expired. Re-link the plugin.
+            details:
+              providerCode: provider-token-expired
     '403':
       description: Plugin provider denied the requested operation
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: INSUFFICIENT_PERMISSIONS
             family: PERMISSION
-            code: provider-scope-missing
+            code: INSUFFICIENT_PERMISSIONS
             message: The linked account does not grant permission for this device.
+            details:
+              providerCode: provider-scope-missing
     '404':
       description: Target endpoint or plugin route was not found
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: NOT_FOUND
             family: NOT_FOUND
-            code: message-not-found
+            code: NOT_FOUND
             message: The linked account does not grant permission for this device.
+            details:
+              providerCode: message-not-found
     '409':
       description: Endpoint state conflicts with the requested message
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: NOT_SUPPORTED_IN_CURRENT_MODE
             family: ENDPOINT_STATE_CONFLICT
-            code: device-mode-conflict
+            code: NOT_SUPPORTED_IN_CURRENT_MODE
             message: The command is not supported while the endpoint is in eco mode.
             details:
               currentMode: eco
+              providerCode: device-mode-conflict
     '422':
       description: Plugin rejected a semantically invalid message value
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: VALUE_OUT_OF_RANGE
             family: REQUEST_INVALID
-            code: brightness-out-of-range
+            code: VALUE_OUT_OF_RANGE
             message: Brightness must be between 1 and 100.
             details:
               parameter: brightness
               minimum: 1
               maximum: 100
               actual: '150'
+              providerCode: brightness-out-of-range
     '423':
       description: Endpoint is unavailable, unreachable, locked, or low power
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: ENDPOINT_UNREACHABLE
             family: ENDPOINT_UNAVAILABLE
-            code: device-offline
+            code: ENDPOINT_UNREACHABLE
             message: The device is not reachable.
             details:
               pluginId: port1.plugin.hue
               pluginRouteId: hue-device-42
+              providerCode: device-offline
     '429':
       description: Plugin provider rate limit exceeded
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: RATE_LIMIT_EXCEEDED
             family: RATE_LIMIT
-            code: provider-rate-limit
+            code: RATE_LIMIT_EXCEEDED
             message: The provider rate limit was exceeded.
             details:
               retryAfterSeconds: 60
+              providerCode: provider-rate-limit
     '500':
       description: Internal server error
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: INTERNAL_SERVER_ERROR
             family: INTERNAL_SERVER_ERROR
-            code: internal-server-error
+            code: INTERNAL
             message: The server failed
+            details:
+              providerCode: internal-server-error
     '502':
       description: Plugin provider returned an invalid or internal error response
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: PROVIDER_INTERNAL_ERROR
             family: PROVIDER_BAD_RESPONSE
-            code: provider-internal-error
+            code: PROVIDER_INTERNAL_ERROR
             message: The provider failed while handling the command.
+            details:
+              providerCode: provider-internal-error
     '503':
       description: Plugin provider or bridge is unavailable
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: PROVIDER_SERVICE_UNAVAILABLE
             family: PROVIDER_UNAVAILABLE
-            code: vendor-outage
+            code: PROVIDER_SERVICE_UNAVAILABLE
             message: The provider service is temporarily unavailable.
+            details:
+              providerCode: vendor-outage
     '504':
       description: Plugin provider timed out
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: /docs/references/schemas/Error.json
           example:
-            type: PROVIDER_TIMEOUT
             family: PROVIDER_TIMEOUT
-            code: provider-timeout
+            code: PROVIDER_TIMEOUT
             message: The provider did not respond before the timeout.
+            details:
+              providerCode: provider-timeout
   x-portos-delegated: true
   x-portos-resource-permission: true
   security:
@@ -276,4 +283,10 @@ post:
     - bearerAuth: []
 ```
 
-Resolve component references against [OpenAPI](/docs/references/openapi.yaml). [Auth guide](/docs/for-ai/guides/authentication-and-dcr.md).
+## Linked components
+
+- [CreateMessageRequest.json](/docs/references/schemas/CreateMessageRequest.json)
+- [CreateMessageResponse.json](/docs/references/schemas/CreateMessageResponse.json)
+- [Error.json](/docs/references/schemas/Error.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).