[Fix #379] Update to last version of the schema

fjtirado · fjtirado · commit d3190f487d81 · 2024-07-18T17:56:37.000+02:00
diff --git a/api/src/main/resources/schema/workflow.yaml b/api/src/main/resources/schema/workflow.yaml
@@ -103,6 +103,7 @@ properties:
     description: Schedules the workflow
 $defs:
   taskList:
+    title: TaskList
     type: array
     items:
       type: object
@@ -181,10 +182,8 @@ $defs:
                 type: object
                 description: The payload to call the AsyncAPI operation with, if any.
               authentication:
+                $ref: '#/$defs/referenceableAuthenticationPolicy'
                 description: The authentication policy, if any, to use when calling the AsyncAPI operation.
-                oneOf:
-                  - $ref: '#/$defs/authenticationPolicy'
-                  - type: string
             required: [ document, operationRef ]
             additionalProperties: false
             description: Defines the AsyncAPI call to perform.
@@ -216,14 +215,12 @@ $defs:
                     description: The hostname of the GRPC service to call.
                   port:
                     type: integer
-                    min: 0
-                    max: 65535
+                    minimum: 0
+                    maximum: 65535
                     description: The port number of the GRPC service to call.
                   authentication:
+                    $ref: '#/$defs/referenceableAuthenticationPolicy'
                     description: The endpoint's authentication policy, if any.
-                    oneOf:
-                      - $ref: '#/$defs/authenticationPolicy'
-                      - type: string
                 required: [ name, host ]
               method:
                 type: string
@@ -293,10 +290,8 @@ $defs:
                 additionalProperties: true
                 description: A name/value mapping of the parameters of the OpenAPI operation to call.
               authentication:
+                $ref: '#/$defs/referenceableAuthenticationPolicy'
                 description: The authentication policy, if any, to use when calling the OpenAPI operation.
-                oneOf:
-                  - $ref: '#/$defs/authenticationPolicy'
-                  - type: string
               output:
                 type: string
                 enum: [ raw, content, response ]
@@ -320,6 +315,7 @@ $defs:
             additionalProperties: true
             description: A name/value mapping of the parameters, if any, to call the function with.
   forkTask:
+    title: ForkTask
     description: Allows workflows to execute multiple tasks concurrently and optionally race them against each other, with a single possible winner, which sets the task's output.
     $ref: '#/$defs/taskBase'
     type: object
@@ -337,6 +333,7 @@ $defs:
             type: boolean
             default: false  
   doTask:
+    title: DoTask
     description: Allows to execute a list of tasks in sequence
     $ref: '#/$defs/taskBase'
     type: object
@@ -346,6 +343,7 @@ $defs:
       do:
         $ref: '#/$defs/taskList'
   emitTask:
+    title: EmitTask
     description: Allows workflows to publish events to event brokers or messaging systems, facilitating communication and coordination between different components and services.
     $ref: '#/$defs/taskBase'
     type: object
@@ -383,6 +381,7 @@ $defs:
             additionalProperties: true
         required: [ event ]
   forTask:
+    title: ForTask
     description: Allows workflows to iterate over a collection of items, executing a defined set of subtasks for each item in the collection. This task type is instrumental in handling scenarios such as batch processing, data transformation, and repetitive operations across datasets.
     $ref: '#/$defs/taskBase'
     type: object
@@ -410,6 +409,7 @@ $defs:
       do:
         $ref: '#/$defs/taskList'
   listenTask:
+    title: ListenTask
     description: Provides a mechanism for workflows to await and react to external events, enabling event-driven behavior within workflow systems.
     $ref: '#/$defs/taskBase'
     type: object
@@ -424,6 +424,7 @@ $defs:
             description: Defines the event(s) to listen to.
         required: [ to ]
   raiseTask:
+    title: RaiseTask
     description: Intentionally triggers and propagates errors.
     $ref: '#/$defs/taskBase'
     type: object
@@ -438,6 +439,7 @@ $defs:
             description: Defines the error to raise.
         required: [ error ]
   runTask:
+    title: RunTask
     description: Provides the capability to execute external containers, shell commands, scripts, or workflows.
     $ref: '#/$defs/taskBase'
     type: object
@@ -546,6 +548,7 @@ $defs:
             required: [ workflow ]
             description: Enables the invocation and execution of nested workflows within a parent workflow, facilitating modularization, reusability, and abstraction of complex logic or business processes by encapsulating them into standalone workflow units.
   setTask:
+    title: SetTask
     description: A task used to set data
     $ref: '#/$defs/taskBase'
     type: object
@@ -558,6 +561,7 @@ $defs:
         additionalProperties: true
         description: The data to set
   switchTask:
+    title: SwitchTask
     description: Enables conditional branching within workflows, allowing them to dynamically select different paths based on specified conditions or criteria
     $ref: '#/$defs/taskBase'
     type: object
@@ -575,17 +579,17 @@ $defs:
           additionalProperties:
             type: object
             title: SwitchCase
+            required:
+              - then
             properties:
-              name:
-                type: string
-                description: The case's name.
               when:
                 type: string
                 description: A runtime expression used to determine whether or not the case matches.
               then:
                 $ref: '#/$defs/flowDirective'
                 description: The flow directive to execute when the case matches.
   tryTask:
+    title: TryTask
     description: Serves as a mechanism within workflows to handle errors gracefully, potentially retrying failed tasks before proceeding with alternate ones.
     $ref: '#/$defs/taskBase'
     type: object
@@ -617,6 +621,7 @@ $defs:
             description: The definition of the task(s) to run when catching an error.
             $ref: '#/$defs/taskList'
   waitTask:
+    title: WaitTask
     description: Allows workflows to pause or delay their execution for a specified period of time.
     $ref: '#/$defs/taskBase'
     type: object
@@ -627,85 +632,109 @@ $defs:
         description: The amount of time to wait.
         $ref: '#/$defs/duration'
   flowDirective:
-    additionalProperties: false
     anyOf:
       - type: string
         enum: [ continue, exit, end ]
         default: continue
       - type: string
+  referenceableAuthenticationPolicy:
+    type: object
+    oneOf:
+      - title: AuthenticationPolicyReference
+        properties:
+          use:
+            type: string
+            minLength: 1
+            description: The name of the authentication policy to use
+        required: [use]
+      - $ref: '#/$defs/authenticationPolicy'
+  secretBasedAuthenticationPolicy:
+    type: object
+    properties:
+      use:
+        type: string
+        minLength: 1
+        description: The name of the authentication policy to use
+    required: [use]
   authenticationPolicy:
     type: object
     oneOf:
     - title: BasicAuthenticationPolicy 
       properties:
         basic:
           type: object
-          properties:
-            username:
-              type: string
-              description: The username to use.
-            password:
-              type: string
-              description: The password to use.
-          required: [ username, password ]
+          oneOf:
+            - properties:
+                username:
+                  type: string
+                  description: The username to use.
+                password:
+                  type: string
+                  description: The password to use.
+              required: [ username, password ]
+            - $ref: '#/$defs/secretBasedAuthenticationPolicy'
       required: [ basic ]
       description: Use basic authentication.
     - title: BearerAuthenticationPolicy
       properties:
         bearer:
           type: object
-          properties:
-            token:
-              type: string
-              description: The bearer token to use.
-          required: [ token ]
+          oneOf:
+            - properties:
+                token:
+                  type: string
+                  description: The bearer token to use.
+              required: [ token ]
+            - $ref: '#/$defs/secretBasedAuthenticationPolicy'
       required: [ bearer ]
       description: Use bearer authentication.
     - title: OAuth2AuthenticationPolicy
       properties:
         oauth2:
           type: object
-          properties:
-            authority:
-              type: string
-              format: uri
-              description: The URI that references the OAuth2 authority to use.
-            grant:
-              type: string
-              description: The grant type to use.
-            client:
-              type: object
-              properties:
-                id:
+          oneOf:
+            - properties:
+                authority:
                   type: string
-                  description: The client id to use.
-                secret:
+                  format: uri
+                  description: The URI that references the OAuth2 authority to use.
+                grant:
                   type: string
-                  description: The client secret to use, if any.
-              required: [ id ]
-            scopes:
-              type: array
-              items:
-                type: string
-              description: The scopes, if any, to request the token for.
-            audiences:
-              type: array
-              items:
-                type: string
-              description: The audiences, if any, to request the token for.
-            username:
-              type: string
-              description: The username to use. Used only if the grant type is Password.
-            password:
-              type: string
-              description: The password to use. Used only if the grant type is Password.
-            subject:
-              $ref: '#/$defs/oauth2Token'
-              description: The security token that represents the identity of the party on behalf of whom the request is being made.
-            actor:
-              $ref: '#/$defs/oauth2Token'
-              description: The security token that represents the identity of the acting party.
-          required: [ authority, grant, client ]
+                  description: The grant type to use.
+                client:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                      description: The client id to use.
+                    secret:
+                      type: string
+                      description: The client secret to use, if any.
+                  required: [ id ]
+                scopes:
+                  type: array
+                  items:
+                    type: string
+                  description: The scopes, if any, to request the token for.
+                audiences:
+                  type: array
+                  items:
+                    type: string
+                  description: The audiences, if any, to request the token for.
+                username:
+                  type: string
+                  description: The username to use. Used only if the grant type is Password.
+                password:
+                  type: string
+                  description: The password to use. Used only if the grant type is Password.
+                subject:
+                  $ref: '#/$defs/oauth2Token'
+                  description: The security token that represents the identity of the party on behalf of whom the request is being made.
+                actor:
+                  $ref: '#/$defs/oauth2Token'
+                  description: The security token that represents the identity of the acting party.
+              required: [ authority, grant, client ]
+            - $ref: '#/$defs/secretBasedAuthenticationPolicy'
       required: [ oauth2 ]
       description: Use OAUTH2 authentication.
     description: Defines an authentication policy.
@@ -768,10 +797,8 @@ $defs:
         format: uri-template
         description: The endpoint's URI.
       authentication:
+        $ref: '#/$defs/referenceableAuthenticationPolicy'
         description: The authentication policy to use.
-        oneOf:
-          - $ref: '#/$defs/authenticationPolicy'
-          - type: string
     required: [ uri ]
   eventConsumptionStrategy:
     type: object
@@ -871,10 +898,8 @@ $defs:
             format: uri
             description: The endpoint's URI.
           authentication:
+            $ref: '#/$defs/referenceableAuthenticationPolicy'
             description: The authentication policy to use.
-            oneOf:
-              - $ref: '#/$defs/authenticationPolicy'
-              - type: string
           name:
             type: string
             description: The external resource's name, if any.
@@ -886,7 +911,9 @@ $defs:
         $ref: '#/$defs/schema'
         description: The schema used to describe and validate the input of the workflow or task.
       from:
-        type: string
+        oneOf:
+          - type: string
+          - type: object
         description: A runtime expression, if any, used to mutate and/or filter the input of the workflow or task.
     description: Configures the input of a workflow or task.
   output:
@@ -896,7 +923,9 @@ $defs:
         $ref: '#/$defs/schema'
         description: The schema used to describe and validate the output of the workflow or task.
       as:
-        type: string
+        oneOf:
+          - type: string
+          - type: object
         description: A runtime expression, if any, used to mutate and/or filter the output of the workflow or task.
     description: Configures the output of a workflow or task.
   export:
@@ -906,7 +935,9 @@ $defs:
         $ref: '#/$defs/schema'
         description: The schema used to describe and validate the workflow context.
       as:
-        type: string
+        oneOf:
+          - type: string
+          - type: object
         description: A runtime expression, if any, used to export the output data to the context.
     description: Set the content of the context. 
   retryPolicy:
