@portpowered/reference-data 0.4.0 → 0.4.1

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

@@ -92,12 +92,21 @@ post:
                   client_id_issued_at:
                     type: integer
                     format: int64
+          example:
+            redirect_uris:
+              - http://127.0.0.1:8765/callback
+            token_endpoint_auth_method: none
+            client_id: dcr_example
+            client_id_issued_at: 1791504000
     '400':
       description: Invalid metadata, redirect URI, or unapproved software statement.
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/OAuthProtocolError'
+          example:
+            error: invalid_client_metadata
+            error_description: Use HTTPS callbacks or an entirely local callback set.
     '415':
       description: Use application/json.
     '429':

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

@@ -69,6 +69,8 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/RemoveEndpointGroupMembersRequest'
+        example:
+          memberEndpointIds: []
   responses:
     '202':
       description: Members removal accepted

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

@@ -47,6 +47,9 @@ post:
               type: string
             client_id:
               type: string
+        example:
+          token: port1/principals/example
+          client_id: dcr_example
   responses:
     '200':
       description: Grant revoked or token was already invalid.

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

@@ -67,6 +67,10 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/SetEndpointGroupNameRequest'
+        example:
+          name:
+            type: LIGHT
+            value: port1/principals/example
   responses:
     '202':
       description: Endpoint group name update accepted

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

@@ -77,6 +77,8 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/SynchronizationRequest'
+        example:
+          routes: []
   responses:
     '200':
       description: Routes synchronized successfully

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

@@ -82,6 +82,8 @@ put:
         application/json:
           schema:
             $ref: '#/components/schemas/UpdateOAuthClientResponse'
+          example:
+            clientId: port1/principals/example
     '400':
       description: Invalid request payload
     '401':

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

@@ -69,6 +69,12 @@ put:
       application/json:
         schema:
           $ref: '#/components/schemas/UpsertViewRequest'
+        example:
+          title:
+            type: LIGHT
+            value: port1/principals/example
+          positions: []
+          widgets: []
   responses:
     '200':
       description: View updated successfully

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

@@ -44,6 +44,11 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/UpsertAccessControlRuleRequest'
+        example:
+          operation: port1/principals/example
+          resource: port1/users/alice/endpoints/thermostat-zero
+          identity: port1/account/john/users/alice
+          effect: ALLOW
   responses:
     '200':
       description: Access control rule upserted successfully

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

@@ -42,6 +42,12 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/UpsertAuthLinkRequest'
+        example:
+          authLink:
+            associatedPrincipalId: port1/principals/example
+            associatedPluginId: port1/systems/zero/plugins/example
+            associatedSecrets:
+              - id: port1/principals/example/secrets/plugin-credential
   responses:
     '200':
       description: Auth link created successfully

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

@@ -36,6 +36,12 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/UpsertEndpointRequest'
+        example:
+          id: port1/principals/example/endpoints/light-1
+          name:
+            type: PLAIN
+            value: Office light
+          type: LIGHT
   responses:
     '200':
       description: Endpoint upserted successfully

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

@@ -53,6 +53,8 @@ post:
         application/json:
           schema:
             $ref: '#/components/schemas/UpsertPluginResponse'
+          example:
+            id: port1/principals/example/plugins/example
     '400':
       description: Invalid request payload
     '500':

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

@@ -42,6 +42,8 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/UpsertPrincipalRequest'
+        example:
+          items: port1/principals/example
   responses:
     '200':
       description: Principal created successfully

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

@@ -36,6 +36,10 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/UpsertRouteRequest'
+        example:
+          id: port1/principals/example/routes/light-route
+          endpointId: port1/principals/example/endpoints/light-1
+          pluginId: port1/systems/zero/plugins/example
   responses:
     '200':
       description: Route upserted successfully

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

@@ -89,6 +89,12 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/UpsertSecretRequest'
+        example:
+          secret:
+            id: port1/principals/example
+            type: LIGHT
+            clientId: port1/principals/example
+            clientSecret: port1/principals/example
   responses:
     '200':
       description: Secret created successfully

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

@@ -69,6 +69,10 @@ post:
         application/json:
           schema:
             $ref: '#/components/schemas/Simulator'
+          example:
+            device_type: light
+            id: port1.simulator.example
+            name: Example device
         application/vnd.portos.simulator.v2+json:
           schema:
             $ref: '#/components/schemas/SimulatorV2'

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

@@ -46,6 +46,9 @@ post:
       application/json:
         schema:
           $ref: '#/components/schemas/ValidateOAuthRequestRequest'
+        example:
+          client_id: port1/principals/user123/oauth-clients/my-client
+          redirect_uri: https://myapp.com/callback
   responses:
     '200':
       description: Request validated successfully, returns client information
@@ -53,6 +56,9 @@ post:
         application/json:
           schema:
             $ref: '#/components/schemas/ValidateOAuthRequestResponse'
+          example:
+            clientName: My OAuth Application
+            scopes: []
     '400':
       description: Invalid request (e.g., invalid client_id, redirect_uri, or scopes)
     '500':

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

@@ -58,6 +58,10 @@ post:
               description: >
                 Optional override for the Tuya authentication API endpoint. Defaults to
                 https://apigw.iotbing.com if not provided.
+        example:
+          loginCode: port1/principals/example
+          userCode: port1/principals/example
+          clientId: port1/principals/example
   responses:
     '200':
       description: Login code validated successfully

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

@@ -53,18 +53,29 @@ get:
         application/json:
           schema:
             $ref: '#/components/schemas/VerifyDeviceResponse'
+          example:
+            deviceauth_id: da_1234567890abcdef
+            client_name: My OAuth Application
+            client_id: port1/principals/user123/oauth-clients/my-client
+            status: pending
     '400':
       description: Invalid request (e.g., missing or invalid user_code)
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/OAuthErrorResponse'
+          example:
+            error: invalid_request
+            error_description: user_code is required
     '500':
       description: Internal server error
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/OAuthErrorResponse'
+          example:
+            error: invalid_request
+            error_description: user_code is required
   x-portos-delegated: false
   x-portos-resource-permission: false
 ```

package/generated/public/docs/references/authorization.json

@@ -972,8 +972,8 @@
       "resourcePermissionRequired": false
     },
     {
-      "path": "/auth/device_authorization",
-      "runtimePath": "/auth/device_authorization",
+      "path": "/auth/device-authorization",
+      "runtimePath": "/auth/device-authorization",
       "method": "POST",
       "operationId": "deviceAuthorize",
       "security": [

package/generated/public/docs/references/authorization.yaml

@@ -599,8 +599,8 @@ operations:
     security: []
     delegated: false
     resourcePermissionRequired: false
-  - path: /auth/device_authorization
-    runtimePath: /auth/device_authorization
+  - path: /auth/device-authorization
+    runtimePath: /auth/device-authorization
     method: POST
     operationId: deviceAuthorize
     security: