fix: refactor step schema to isolate operation-specific fields and deduplicate operation step parameter rules

Author: nashjain

src/schemas/validation/schema.yaml

@@ -172,9 +172,6 @@ $defs:
       description:
         description: A description of the step. CommonMark syntax MAY be used for rich text representation
         type: string
-      operationId:
-        description: The name of an existing, resolvable operation, as defined with a unique operationId and existing within one of the sourceDescriptions
-        type: string
       timeout:
         description: The duration in milliseconds to wait before timing out the step
         type: integer
@@ -233,29 +230,28 @@ $defs:
               - $ref: '#/$defs/selector-object'
     required:
       - stepId
+  operation-step-parameters:
+    type: array
+    uniqueItems: true
+    items:
+      oneOf:
+        - $ref: '#/$defs/reusable-object'
+        - $ref: '#/$defs/parameter-object'
+          required:
+            - in
   openapi-step-object:
     allOf:
       - $ref: '#/$defs/step-object-base'
       - type: object
         properties:
+          operationId:
+            description: The name of an existing, resolvable operation, as defined with a unique operationId and existing within one of the sourceDescriptions
+            type: string
           operationPath:
             description: A reference to a Source combined with a JSON Pointer to reference an operation
             type: string
-      - if:
-          oneOf:
-            - required:
-                - operationPath
-            - required:
-                - operationId
-        then:
-          properties:
-            parameters:
-              items:
-                oneOf:
-                  - $ref: '#/$defs/reusable-object'
-                  - $ref: '#/$defs/parameter-object'
-                    required:
-                      - in
+          parameters:
+            $ref: '#/$defs/operation-step-parameters'
       - oneOf:
           - required:
               - operationId
@@ -268,6 +264,9 @@ $defs:
       - $ref: '#/$defs/step-object-base'
       - type: object
         properties:
+          operationId:
+            description: The name of an existing, resolvable operation, as defined with a unique operationId and existing within one of the sourceDescriptions
+            type: string
           channelPath:
             description: A reference to a Source combined with a JSON Pointer to reference an async channel
             type: string
@@ -284,23 +283,10 @@ $defs:
             enum:
               - send
               - receive
+          parameters:
+            $ref: '#/$defs/operation-step-parameters'
         required:
           - action
-      - if:
-          oneOf:
-            - required:
-                - operationId
-            - required:
-                - channelPath
-        then:
-          properties:
-            parameters:
-              items:
-                oneOf:
-                  - $ref: '#/$defs/reusable-object'
-                  - $ref: '#/$defs/parameter-object'
-                    required:
-                      - in
       - if:
           required:
             - correlationId

tests/schema/fail/invalid-async-correlation-id-non-receive-action.arazzo.yaml

@@ -1,6 +1,6 @@
 arazzo: 1.1.0
 info:
-  title: Minimal Arazzo Example for AsyncAPI
+  title: CorrelationId should only be present when action is receive
   version: 1.0.0
 sourceDescriptions:
   - name: exampleAPI

tests/schema/fail/invalid-async-parameter-without-in.arazzo.yaml

@@ -0,0 +1,17 @@
+arazzo: 1.1.0
+info:
+  title: Async step parameter requires in
+  version: 1.0.0
+sourceDescriptions:
+  - name: eventAPI
+    url: https://events.com/asyncapi.yaml
+    type: asyncapi
+workflows:
+  - workflowId: asyncWorkflow
+    steps:
+      - stepId: sendEvent
+        operationId: $sourceDescriptions.eventAPI.orderCreated
+        action: send
+        parameters:
+          - name: correlationId
+            value: abc123

tests/schema/fail/invalid-openapi-parameter-without-in.arazzo.yaml

@@ -0,0 +1,18 @@
+arazzo: 1.1.0
+info:
+  title: OpenAPI step parameter requires in
+  version: 1.0.0
+sourceDescriptions:
+  - name: userAPI
+    url: https://users.com/openapi.yaml
+    type: openapi
+workflows:
+  - workflowId: openapiWorkflow
+    steps:
+      - stepId: getUsers
+        operationId: $sourceDescriptions.userAPI.listUsers
+        parameters:
+          - name: limit
+            value: 10
+        successCriteria:
+          - condition: $statusCode == 200

tests/schema/fail/invalid-workflow-step-with-operationId.arazzo.yaml

@@ -2,6 +2,10 @@ arazzo: 1.1.0
 info:
   title: Workflow step cannot have operationId
   version: 1.0.0
+sourceDescriptions:
+  - name: exampleAPI
+    url: https://example.com/asyncapi.yaml
+    type: asyncapi
 workflows:
   - workflowId: parentWorkflow
     steps:

tests/schema/fail/invalid-workflow-success-criteria.arazzo.yaml

@@ -2,6 +2,10 @@ arazzo: 1.1.0
 info:
   title: Invalid workflow step success criteria
   version: 1.0.0
+sourceDescriptions:
+  - name: exampleAPI
+    url: https://example.com/asyncapi.yaml
+    type: asyncapi
 workflows:
   - workflowId: parentWorkflow
     steps:

tests/schema/pass/async-parameter-with-in.arazzo.yaml

@@ -0,0 +1,18 @@
+arazzo: 1.1.0
+info:
+  title: Async step parameter with in
+  version: 1.0.0
+sourceDescriptions:
+  - name: eventAPI
+    url: https://events.com/asyncapi.yaml
+    type: asyncapi
+workflows:
+  - workflowId: asyncWorkflow
+    steps:
+      - stepId: sendEvent
+        operationId: $sourceDescriptions.eventAPI.orderCreated
+        action: send
+        parameters:
+          - name: correlationId
+            in: header
+            value: abc123

tests/schema/pass/openapi-parameter-with-in.arazzo.yaml

@@ -0,0 +1,19 @@
+arazzo: 1.1.0
+info:
+  title: OpenAPI step parameter with in
+  version: 1.0.0
+sourceDescriptions:
+  - name: userAPI
+    url: https://users.com/openapi.yaml
+    type: openapi
+workflows:
+  - workflowId: openapiWorkflow
+    steps:
+      - stepId: getUsers
+        operationId: $sourceDescriptions.userAPI.listUsers
+        parameters:
+          - name: limit
+            in: query
+            value: 10
+        successCriteria:
+          - condition: $statusCode == 200

tests/schema/pass/workflow-parameter-without-in.arazzo.yaml

@@ -0,0 +1,27 @@
+arazzo: 1.1.0
+info:
+  title: Workflow step parameter does not require in
+  version: 1.0.0
+sourceDescriptions:
+  - name: userAPI
+    url: https://users.com/openapi.yaml
+    type: openapi
+workflows:
+  - workflowId: parentWorkflow
+    steps:
+      - stepId: nestedWorkflow
+        workflowId: childWorkflow
+        parameters:
+          - name: userId
+            value: 10
+  - workflowId: childWorkflow
+    inputs:
+      type: object
+      properties:
+        userId:
+          type: integer
+    steps:
+      - stepId: childStep
+        operationId: $sourceDescriptions.userAPI.listUsers
+        successCriteria:
+          - condition: $statusCode == 200