Merge branch 'serverlessworkflow:main' into fix-usage-of-endpoint-in-call-http

Author: matthias-pichler

dsl-reference.md

@@ -1015,10 +1015,10 @@ Defines the mechanism used to authenticate users and workflows attempting to acc
 | Property | Type | Required | Description |
 |----------|:----:|:--------:|-------------|
 | basic | [`basicAuthentication`](#basic-authentication) | `no` | The `basic` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
-| bearer | [`basicAuthentication`](#bearer-authentication) | `no` | The `bearer` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
+| bearer | [`bearerAuthentication`](#bearer-authentication) | `no` | The `bearer` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
 | certificate | [`certificateAuthentication`](#certificate-authentication) | `no` | The `certificate` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
 | digest | [`digestAuthentication`](#digest-authentication) | `no` | The `digest` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
-| bearer | [`oauth2`](#oauth2-authentication) | `no` | The `oauth2` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
+| oauth2 | [`oauth2`](#oauth2-authentication) | `no` | The `oauth2` authentication scheme to use, if any.<br>Required if no other property has been set, otherwise ignored. |
 
 ##### Examples
 
@@ -1087,7 +1087,7 @@ Defines the fundamentals of a 'bearer' authentication
 
 | Property | Type | Required | Description |
 |----------|:----:|:--------:|-------------|
-| bearer | `string` | `yes` | The bearer token to use. |
+| token | `string` | `yes` | The bearer token to use. |
 
 ##### Examples
 

examples/asyncapi.yaml

@@ -0,0 +1,20 @@
+document:
+  dsl: 1.0.0-alpha1
+  namespace: examples
+  name: bearer-auth
+  version: 1.0.0-alpha1
+do:
+  greetUser:
+    call: asyncapi
+    with:
+      document:
+        uri: https://fake.com/docs/asyncapi.json
+      operationRef: findPetsByStatus
+      server: staging
+      message: getPetByStatusQuery
+      binding: http
+      payload:
+        petId: ${ .pet.id }
+      authentication:
+        bearer:
+          token: ${ .token }

examples/bearer-auth-uri-format.yaml

@@ -0,0 +1,15 @@
+document:
+  dsl: 1.0.0-alpha1
+  namespace: examples
+  name: bearer-auth-uri-format
+  version: 1.0.0-alpha1
+do:
+  getPetById:
+    call: http
+    with:
+      method: get
+      endpoint:
+        uri: https://petstore.swagger.io/v2/pet/1
+        authentication:
+          bearer:
+            token: ${ .token }

examples/bearer-auth.yaml

@@ -0,0 +1,15 @@
+document:
+  dsl: 1.0.0-alpha1
+  namespace: examples
+  name: bearer-auth
+  version: 1.0.0-alpha1
+do:
+  getPetById:
+    call: http
+    with:
+      method: get
+      endpoint:
+        uri: https://petstore.swagger.io/v2/pet/{petId}
+        authentication:
+          bearer:
+            token: ${ .token }

examples/use-authentication.yaml

@@ -0,0 +1,18 @@
+document:
+  dsl: 1.0.0-alpha1
+  namespace: examples
+  name: bearer-auth
+  version: 1.0.0-alpha1
+use:
+  authentications:
+    petStoreAuth:
+      bearer:
+        token: ${ .token }
+do:
+  getPetById:
+    call: http
+    with:
+      method: get
+      endpoint:
+        uri: https://petstore.swagger.io/v2/pet/{petId}
+        authentication: petStoreAuth

schema/workflow.yaml

@@ -133,7 +133,7 @@ $defs:
       - properties:
           call:
             type: string
-            constant: asyncapi
+            const: asyncapi
           with:
             type: object
             properties:
@@ -156,15 +156,17 @@ $defs:
                 type: object
                 description: The payload to call the AsyncAPI operation with, if any.
               authentication:
-                ref: '#/$defs/authenticationPolicy'
                 description: The authentication policy, if any, to use when calling the AsyncAPI operation.
+                oneOf:
+                  - $ref: '#/$defs/authenticationPolicy'
+                  - type: string
             required: [ document, operationRef ]
             description: Defines the AsyncAPI call to perform.
         required: [ call, with ]
       - properties:
           call:
             type: string
-            constant: grpc
+            const: grpc
           with:
             type: object
             properties:
@@ -187,8 +189,10 @@ $defs:
                     max: 65535
                     description: The port number of the GRPC service to call.
                   authentication:
-                    $ref: '#/$defs/authenticationPolicy'
                     description: The endpoint's authentication policy, if any.
+                    oneOf:
+                      - $ref: '#/$defs/authenticationPolicy'
+                      - type: string
                 required: [ name, host ]
               method:
                 type: string
@@ -203,7 +207,7 @@ $defs:
       - properties:
           call:
             type: string
-            constant: http
+            const: http
           with:
             type: object
             properties:
@@ -231,7 +235,7 @@ $defs:
       - properties:
           call:
             type: string
-            constant: openapi
+            const: openapi
           with:
             type: object
             properties:
@@ -246,8 +250,10 @@ $defs:
                 additionalProperties: true
                 description: A name/value mapping of the parameters of the OpenAPI operation to call.
               authentication:
-                $ref: '#/$defs/authenticationPolicy'
                 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 ]
@@ -267,6 +273,7 @@ $defs:
             description: A name/value mapping of the parameters, if any, to call the function with.
         required: [ call ]
   compositeTask:
+    type: object
     properties:
       execute:
         type: object
@@ -294,6 +301,7 @@ $defs:
     required: [ execute ]
     description: Serves as a pivotal orchestrator within workflow systems, enabling the seamless integration and execution of multiple subtasks to accomplish complex operations
   emitTask:
+    type: object
     properties:
       emit:
         type: object
@@ -335,6 +343,7 @@ $defs:
         default: continue
       - type: string
   forTask:
+    type: object
     properties:
       for:
         type: object
@@ -668,11 +677,13 @@ $defs:
     properties:
       uri:
         type: string
-        format: uri
+        format: uri-template
         description: The endpoint's URI.
       authentication:
-        $ref: '#/$defs/authenticationPolicy'
         description: The authentication policy to use.
+        oneOf:
+          - $ref: '#/$defs/authenticationPolicy'
+          - type: string
     required: [ uri ]
   eventConsumptionStrategy:
     type: object
@@ -764,8 +775,10 @@ $defs:
         format: uri
         description: The endpoint's URI.
       authentication:
-        $ref: '#/$defs/authenticationPolicy'
         description: The authentication policy to use.
+        oneOf:
+          - $ref: '#/$defs/authenticationPolicy'
+          - type: string
       name:
         type: string
         description: The external resource's name, if any.