npm - @portpowered/reference-data - Versions diffs - 0.4.1 → 0.4.2 - Mend

@portpowered/reference-data 0.4.1 → 0.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1031) hide show

package/generated/public/docs/references/capability-interfaces/flows/1.0/configuration.yaml ADDED Viewed

@@ -0,0 +1,125 @@
+type: object
+properties:
+  maxFlowIdLength:
+    type: integer
+    description: Maximum length for flow IDs
+    default: 100
+  maxNodeIdLength:
+    type: integer
+    description: Maximum length for node IDs
+    default: 100
+  supportedStatuses:
+    type: object
+    description: Supported flow status categories
+    properties:
+      flow:
+        type: array
+        items:
+          type: string
+          enum:
+            - SUCCESS
+            - FAILURE
+            - CANCELLED
+            - TIMEOUT
+        description: Supported flow statuses
+      node:
+        type: array
+        items:
+          type: string
+          enum:
+            - SUCCESS
+            - FAILURE
+            - SKIPPED
+            - TIMEOUT
+        description: Supported node statuses
+      ack:
+        type: array
+        items:
+          type: string
+          enum:
+            - RECEIVED
+            - PROCESSED
+            - FAILED
+        description: Supported acknowledgment statuses
+    required:
+      - flow
+      - node
+      - ack
+    additionalProperties: false
+    title: FlowSupportedStatuses
+  supportedReasons:
+    type: object
+    description: Supported flow reason categories
+    properties:
+      termination:
+        type: array
+        items:
+          type: string
+          enum:
+            - USER_REQUEST
+            - ERROR
+            - TIMEOUT
+            - COMPLETION
+            - CANCELLATION
+        description: Supported termination reasons
+      pause:
+        type: array
+        items:
+          type: string
+          enum:
+            - USER_REQUEST
+            - RESOURCE_LIMIT
+            - WAITING
+            - MAINTENANCE
+        description: Supported pause reasons
+      unack:
+        type: array
+        items:
+          type: string
+          enum:
+            - TIMEOUT
+            - ERROR
+            - REJECTED
+            - DUPLICATE
+        description: Supported unacknowledgment reasons
+    required:
+      - termination
+      - pause
+      - unack
+    additionalProperties: false
+    title: FlowSupportedReasons
+  supportedPriorities:
+    type: array
+    items:
+      type: string
+      enum:
+        - LOW
+        - NORMAL
+        - HIGH
+        - URGENT
+    description: Supported flow priorities
+  defaultTimeout:
+    type: integer
+    description: Default flow timeout in milliseconds
+    default: 300000
+  maxTimeout:
+    type: integer
+    description: Maximum flow timeout in milliseconds
+    default: 86400000
+  checkpointEnabled:
+    type: boolean
+    description: Whether checkpoints are enabled
+    default: true
+required:
+  - maxFlowIdLength
+  - maxNodeIdLength
+  - supportedStatuses
+  - supportedReasons
+  - supportedPriorities
+  - defaultTimeout
+  - maxTimeout
+  - checkpointEnabled
+additionalProperties: false
+description: >-
+  Flows run automations that can be initiated, paused, resumed, or terminated. Follow completion and
+  acknowledgement events to understand the progress of a run.

package/generated/public/docs/references/capability-interfaces/flows/1.0/messages/complete.yaml CHANGED Viewed

@@ -8,10 +8,10 @@ properties:
     type: string
     description: Completion status
     enum:
-      - success
-      - failure
-      - cancelled
-      - timeout
+      - SUCCESS
+      - FAILURE
+      - CANCELLED
+      - TIMEOUT
   result:
     type: object
     description: Flow execution result

package/generated/public/docs/references/capability-interfaces/flows/1.0/messages/initiate.yaml CHANGED Viewed

@@ -16,11 +16,11 @@ properties:
     type: string
     description: Flow execution priority
     enum:
-      - low
-      - normal
-      - high
-      - urgent
-    default: normal
+      - LOW
+      - NORMAL
+      - HIGH
+      - URGENT
+    default: NORMAL
   timeout:
     type: integer
     description: Flow timeout in milliseconds

package/generated/public/docs/references/capability-interfaces/flows/1.0/messages/message-ack.yaml CHANGED Viewed

@@ -16,9 +16,9 @@ properties:
     type: string
     description: Acknowledgment status
     enum:
-      - received
-      - processed
-      - failed
+      - RECEIVED
+      - PROCESSED
+      - FAILED
   timestamp:
     type: string
     format: date-time

package/generated/public/docs/references/capability-interfaces/flows/1.0/messages/message-unack.yaml CHANGED Viewed

@@ -16,10 +16,10 @@ properties:
     type: string
     description: Reason for unacknowledgment
     enum:
-      - timeout
-      - error
-      - rejected
-      - duplicate
+      - TIMEOUT
+      - ERROR
+      - REJECTED
+      - DUPLICATE
   timestamp:
     type: string
     format: date-time

package/generated/public/docs/references/capability-interfaces/flows/1.0/messages/node-complete.yaml CHANGED Viewed

@@ -12,10 +12,10 @@ properties:
     type: string
     description: Node completion status
     enum:
-      - success
-      - failure
-      - skipped
-      - timeout
+      - SUCCESS
+      - FAILURE
+      - SKIPPED
+      - TIMEOUT
   result:
     type: object
     description: Node execution result

package/generated/public/docs/references/capability-interfaces/flows/1.0/messages/pause.yaml CHANGED Viewed

@@ -8,10 +8,10 @@ properties:
     type: string
     description: Reason for pausing
     enum:
-      - user_request
-      - resource_limit
-      - waiting
-      - maintenance
+      - USER_REQUEST
+      - RESOURCE_LIMIT
+      - WAITING
+      - MAINTENANCE
   checkpoint:
     type: boolean
     description: Whether to create a checkpoint before pausing

package/generated/public/docs/references/capability-interfaces/flows/1.0/messages/terminate.yaml CHANGED Viewed

@@ -8,11 +8,11 @@ properties:
     type: string
     description: Reason for termination
     enum:
-      - user_request
-      - error
-      - timeout
-      - completion
-      - cancellation
+      - USER_REQUEST
+      - ERROR
+      - TIMEOUT
+      - COMPLETION
+      - CANCELLATION
   graceful:
     type: boolean
     description: Whether to perform graceful termination

package/generated/public/docs/references/capability-interfaces/flows/1.0.yaml CHANGED Viewed

@@ -19,10 +19,10 @@ messages:
           type: string
           description: Completion status
           enum:
-            - success
-            - failure
-            - cancelled
-            - timeout
+            - SUCCESS
+            - FAILURE
+            - CANCELLED
+            - TIMEOUT
         result:
           type: object
           description: Flow execution result
@@ -62,11 +62,11 @@ messages:
           type: string
           description: Flow execution priority
           enum:
-            - low
-            - normal
-            - high
-            - urgent
-          default: normal
+            - LOW
+            - NORMAL
+            - HIGH
+            - URGENT
+          default: NORMAL
         timeout:
           type: integer
           description: Flow timeout in milliseconds
@@ -103,9 +103,9 @@ messages:
           type: string
           description: Acknowledgment status
           enum:
-            - received
-            - processed
-            - failed
+            - RECEIVED
+            - PROCESSED
+            - FAILED
         timestamp:
           type: string
           format: date-time
@@ -143,10 +143,10 @@ messages:
           type: string
           description: Reason for unacknowledgment
           enum:
-            - timeout
-            - error
-            - rejected
-            - duplicate
+            - TIMEOUT
+            - ERROR
+            - REJECTED
+            - DUPLICATE
         timestamp:
           type: string
           format: date-time
@@ -180,10 +180,10 @@ messages:
           type: string
           description: Node completion status
           enum:
-            - success
-            - failure
-            - skipped
-            - timeout
+            - SUCCESS
+            - FAILURE
+            - SKIPPED
+            - TIMEOUT
         result:
           type: object
           description: Node execution result
@@ -221,10 +221,10 @@ messages:
           type: string
           description: Reason for pausing
           enum:
-            - user_request
-            - resource_limit
-            - waiting
-            - maintenance
+            - USER_REQUEST
+            - RESOURCE_LIMIT
+            - WAITING
+            - MAINTENANCE
         checkpoint:
           type: boolean
           description: Whether to create a checkpoint before pausing
@@ -271,11 +271,11 @@ messages:
           type: string
           description: Reason for termination
           enum:
-            - user_request
-            - error
-            - timeout
-            - completion
-            - cancellation
+            - USER_REQUEST
+            - ERROR
+            - TIMEOUT
+            - COMPLETION
+            - CANCELLATION
         graceful:
           type: boolean
           description: Whether to perform graceful termination
@@ -313,29 +313,29 @@ configuration:
           items:
             type: string
             enum:
-              - success
-              - failure
-              - cancelled
-              - timeout
+              - SUCCESS
+              - FAILURE
+              - CANCELLED
+              - TIMEOUT
           description: Supported flow statuses
         node:
           type: array
           items:
             type: string
             enum:
-              - success
-              - failure
-              - skipped
-              - timeout
+              - SUCCESS
+              - FAILURE
+              - SKIPPED
+              - TIMEOUT
           description: Supported node statuses
         ack:
           type: array
           items:
             type: string
             enum:
-              - received
-              - processed
-              - failed
+              - RECEIVED
+              - PROCESSED
+              - FAILED
           description: Supported acknowledgment statuses
       required:
         - flow
@@ -352,31 +352,31 @@ configuration:
           items:
             type: string
             enum:
-              - user_request
-              - error
-              - timeout
-              - completion
-              - cancellation
+              - USER_REQUEST
+              - ERROR
+              - TIMEOUT
+              - COMPLETION
+              - CANCELLATION
           description: Supported termination reasons
         pause:
           type: array
           items:
             type: string
             enum:
-              - user_request
-              - resource_limit
-              - waiting
-              - maintenance
+              - USER_REQUEST
+              - RESOURCE_LIMIT
+              - WAITING
+              - MAINTENANCE
           description: Supported pause reasons
         unack:
           type: array
           items:
             type: string
             enum:
-              - timeout
-              - error
-              - rejected
-              - duplicate
+              - TIMEOUT
+              - ERROR
+              - REJECTED
+              - DUPLICATE
           description: Supported unacknowledgment reasons
       required:
         - termination
@@ -389,10 +389,10 @@ configuration:
       items:
         type: string
         enum:
-          - low
-          - normal
-          - high
-          - urgent
+          - LOW
+          - NORMAL
+          - HIGH
+          - URGENT
       description: Supported flow priorities
     defaultTimeout:
       type: integer

package/generated/public/docs/references/capability-interfaces/flows.yaml CHANGED Viewed

@@ -2,9 +2,8 @@ name: flows
 namespace: port1/systems/zero/capability-interfaces/flows
 version: '1.0'
 description: >-
-  Flows run automations that can be initiated, paused, resumed, or terminated.
-  Follow completion and acknowledgement events to understand the progress of a
-  run.
+  Flows run automations that can be initiated, paused, resumed, or terminated. Follow completion and
+  acknowledgement events to understand the progress of a run.
 messages:
   - name: complete
     description: null
@@ -20,10 +19,10 @@ messages:
           type: string
           description: Completion status
           enum:
-            - success
-            - failure
-            - cancelled
-            - timeout
+            - SUCCESS
+            - FAILURE
+            - CANCELLED
+            - TIMEOUT
         result:
           type: object
           description: Flow execution result
@@ -63,11 +62,11 @@ messages:
           type: string
           description: Flow execution priority
           enum:
-            - low
-            - normal
-            - high
-            - urgent
-          default: normal
+            - LOW
+            - NORMAL
+            - HIGH
+            - URGENT
+          default: NORMAL
         timeout:
           type: integer
           description: Flow timeout in milliseconds
@@ -104,9 +103,9 @@ messages:
           type: string
           description: Acknowledgment status
           enum:
-            - received
-            - processed
-            - failed
+            - RECEIVED
+            - PROCESSED
+            - FAILED
         timestamp:
           type: string
           format: date-time
@@ -144,10 +143,10 @@ messages:
           type: string
           description: Reason for unacknowledgment
           enum:
-            - timeout
-            - error
-            - rejected
-            - duplicate
+            - TIMEOUT
+            - ERROR
+            - REJECTED
+            - DUPLICATE
         timestamp:
           type: string
           format: date-time
@@ -181,10 +180,10 @@ messages:
           type: string
           description: Node completion status
           enum:
-            - success
-            - failure
-            - skipped
-            - timeout
+            - SUCCESS
+            - FAILURE
+            - SKIPPED
+            - TIMEOUT
         result:
           type: object
           description: Node execution result
@@ -222,10 +221,10 @@ messages:
           type: string
           description: Reason for pausing
           enum:
-            - user_request
-            - resource_limit
-            - waiting
-            - maintenance
+            - USER_REQUEST
+            - RESOURCE_LIMIT
+            - WAITING
+            - MAINTENANCE
         checkpoint:
           type: boolean
           description: Whether to create a checkpoint before pausing
@@ -272,11 +271,11 @@ messages:
           type: string
           description: Reason for termination
           enum:
-            - user_request
-            - error
-            - timeout
-            - completion
-            - cancellation
+            - USER_REQUEST
+            - ERROR
+            - TIMEOUT
+            - COMPLETION
+            - CANCELLATION
         graceful:
           type: boolean
           description: Whether to perform graceful termination
@@ -314,29 +313,29 @@ configuration:
           items:
             type: string
             enum:
-              - success
-              - failure
-              - cancelled
-              - timeout
+              - SUCCESS
+              - FAILURE
+              - CANCELLED
+              - TIMEOUT
           description: Supported flow statuses
         node:
           type: array
           items:
             type: string
             enum:
-              - success
-              - failure
-              - skipped
-              - timeout
+              - SUCCESS
+              - FAILURE
+              - SKIPPED
+              - TIMEOUT
           description: Supported node statuses
         ack:
           type: array
           items:
             type: string
             enum:
-              - received
-              - processed
-              - failed
+              - RECEIVED
+              - PROCESSED
+              - FAILED
           description: Supported acknowledgment statuses
       required:
         - flow
@@ -353,31 +352,31 @@ configuration:
           items:
             type: string
             enum:
-              - user_request
-              - error
-              - timeout
-              - completion
-              - cancellation
+              - USER_REQUEST
+              - ERROR
+              - TIMEOUT
+              - COMPLETION
+              - CANCELLATION
           description: Supported termination reasons
         pause:
           type: array
           items:
             type: string
             enum:
-              - user_request
-              - resource_limit
-              - waiting
-              - maintenance
+              - USER_REQUEST
+              - RESOURCE_LIMIT
+              - WAITING
+              - MAINTENANCE
           description: Supported pause reasons
         unack:
           type: array
           items:
             type: string
             enum:
-              - timeout
-              - error
-              - rejected
-              - duplicate
+              - TIMEOUT
+              - ERROR
+              - REJECTED
+              - DUPLICATE
           description: Supported unacknowledgment reasons
       required:
         - termination
@@ -390,10 +389,10 @@ configuration:
       items:
         type: string
         enum:
-          - low
-          - normal
-          - high
-          - urgent
+          - LOW
+          - NORMAL
+          - HIGH
+          - URGENT
       description: Supported flow priorities
     defaultTimeout:
       type: integer
@@ -418,9 +417,8 @@ configuration:
     - checkpointEnabled
   additionalProperties: false
   description: >-
-    Flows run automations that can be initiated, paused, resumed, or terminated.
-    Follow completion and acknowledgement events to understand the progress of a
-    run.
+    Flows run automations that can be initiated, paused, resumed, or terminated. Follow completion
+    and acknowledgement events to understand the progress of a run.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/formaldehyde-concentration-sensor.yaml CHANGED Viewed

@@ -2,8 +2,8 @@ name: formaldehyde-concentration-sensor
 namespace: port1/systems/zero/capability-interfaces/formaldehyde-concentration-sensor
 version: '1.0'
 description: >-
-  Formaldehyde measurements report the concentration observed by a sensor. Use
-  the reading and its declared unit when presenting environmental measurements.
+  Formaldehyde measurements report the concentration observed by a sensor. Use the reading and its
+  declared unit when presenting environmental measurements.
 messages: []
 attributes:
   - name: measured-value