Data Orchestrator DSL reference (based on Open Workflow Specification)

document:
  dsl: '1.0.3'
  namespace: test
  name: order-pet
  version: '0.1.0'
  title: Order Pet - 1.0.0
  summary: >
    # Order Pet - 1.0.0
    ## Table of Contents
    - [Description](#description)
    - [Requirements](#requirements)
    ## Description
    A sample workflow used to process an hypothetic pet order using the [PetStore API](https://petstore.swagger.io/)
    ## Requirements
    ## Secrets
    - my-oauth2-secret
use:
  authentications:
    petStoreOAuth2:
      oauth2: 
        authority: https://petstore.swagger.io/.well-known/openid-configuration
        grant: client_credentials
        client:
          id: workflow-runtime
          secret: "**********"
        scopes: [ api ]
        audiences: [ runtime ]
  extensions:
    - externalLogging:
        extend: all
        before:
          - sendLog:
              call: http
              with:
                method: post
                endpoint: https://fake.log.collector.com
                body:
                  message: ${ "Executing task '\($task.reference)'..." }
        after:
          - sendLog:
              call: http
              with:
                method: post
                endpoint: https://fake.log.collector.com
                body:
                  message: ${ "Executed task '\($task.reference)'..." }
  functions:
    getAvailablePets:
      call: openapi
      with:
        document:
          endpoint: https://petstore.swagger.io/v2/swagger.json
        operationId: findByStatus
        parameters:
          status: available
  secrets:
    - my-oauth2-secret
do:
  - getAvailablePets:
      call: getAvailablePets
      output:
        as: "$input + { availablePets: [.[] | select(.category.name == \"dog\" and (.tags[] | .breed == $input.order.breed))] }"
  - submitMatchesByMail:
      call: http
      with:
        method: post
        endpoint:
          uri: https://fake.smtp.service.com/email/send
          authentication: 
            use: petStoreOAuth2
        body:
          from: noreply@fake.petstore.com
          to: ${ .order.client.email }
          subject: Candidates for Adoption
          body: >
            Hello ${ .order.client.preferredDisplayName }!

            Following your interest to adopt a dog, here is a list of candidates that you might be interested in:

            ${ .pets | map("-\(.name)") | join("\n") }

            Please do not hesitate to contact us at info@fake.petstore.com if your have questions.

            Hope to hear from you soon!

            ----------------------------------------------------------------------------------------------
            DO NOT REPLY
            ----------------------------------------------------------------------------------------------

document:
  dsl: '1.0.3'
  namespace: test
  name: call-example
  version: '0.1.0'
do:
  - getPet:
      call: http
      with:
        method: get
        endpoint: https://petstore.swagger.io/v2/pet/{petId}

document:
  dsl: '1.0.3'
  namespace: test
  name: http-example
  version: '0.1.0'
do:
  - getPet:
      call: http
      with:
        method: get
        endpoint: https://petstore.swagger.io/v2/pet/{petId}

document:
  dsl: '1.0.3'
  namespace: test
  name: mcp-example
  version: '0.1.0'
do:
  - pushDataOnS3:
      call: "serverless_job"
      with:
        id: "0dbc8c9f-e6f2-4dd5-88e0-a4b7a4743f02"
        region: "fr-par"
        startupCommand:
          - "sh"
          - "-c"
        args:
          - "echo 'print from workflow args'"

document:
  dsl: '1.0.3'
  namespace: test
  name: function-example
  version: '0.1.0'
do:
  - WeCallOurAwesomeServerlessFunction:
      call: "serverless_function"
      with:
        method: GET
        id: "c351de27-d595-44eb-8e4c-2f3d660baff8"
        region: "fr-par"
        output: "response"

document:
  dsl: '1.0.3'
  namespace: test
  name: call-container-example
  version: '0.1.0'
do:
  - WeCallOurAwesomeServerlessContainer:
      call: "serverless_container"
      with:
        method: GET
        name: "mycontainer"
        namespaceId: "a351de27-d596-33eb-8e4c-2f3d120baff8"
        region: "fr-par"
        output: "response"

document:
  dsl: '1.0.3'
  namespace: test
  name: do-example
  version: '0.1.0'
use:
  authentications:
    fake-booking-agency-oauth2:
      oauth2:
        authority: https://fake-booking-agency.com
        grant: client_credentials
        client:
          id: serverless-workflow-runtime
          secret: secret0123456789
do:
  - bookHotel:
      call: http
      with:
        method: post
        endpoint: 
          uri: https://fake-booking-agency.com/hotels/book
          authentication: 
            use: fake-booking-agency-oauth2
        body:
          name: Four Seasons
          city: Antwerp
          country: Belgium
  - bookFlight:
      call: http
      with:
        method: post
        endpoint: 
          uri: https://fake-booking-agency.com/flights/book
          authentication: 
            use: fake-booking-agency-oauth2
        body:
          departure:
            date: '01/01/26'
            time: '07:25:00'
            from:
              airport: BRU
              city: Zaventem
              country: Belgium
          arrival:
            date: '01/01/26'
            time: '11:12:00'
            to:
              airport: LIS
              city: Lisbon
              country: Portugal

document:
  dsl: '1.0.3'
  namespace: test
  name: fork-example
  version: '0.1.0'
do:
  - raiseAlarm:
      fork:
        compete: true
        branches:
          - callNurse:
              call: http
              with:
                method: put
                endpoint: https://fake-hospital.com/api/v3/alert/nurses
                body:
                  patientId: ${ .patient.fullName }
                  room: ${ .room.number }
          - callDoctor:
              call: http
              with:
                method: put
                endpoint: https://fake-hospital.com/api/v3/alert/doctor
                body:
                  patientId: ${ .patient.fullName }
                  room: ${ .room.number }

document:
  dsl: '1.0.3'
  namespace: test
  name: raise-example
  version: '0.1.0'
do:
  - processTicket:
      switch:
        - highPriority:
            when: .ticket.priority == "high"
            then: escalateToManager
        - mediumPriority:
            when: .ticket.priority == "medium"
            then: assignToSpecialist
        - lowPriority:
            when: .ticket.priority == "low"
            then: resolveTicket
        - default:
            then: raiseUndefinedPriorityError
  - raiseUndefinedPriorityError:
      raise:
        error:
          type: https://fake.com/errors/tickets/undefined-priority
          status: 400
          instance: /raiseUndefinedPriorityError
          title: Undefined Priority
  - escalateToManager:
      call: http
      with:
        method: post
        endpoint: https://fake-ticketing-system.com/tickets/escalate
        body:
          ticketId: ${ .ticket.id }
  - assignToSpecialist:
      call: http
      with:
        method: post
        endpoint: https://fake-ticketing-system.com/tickets/assign
        body:
          ticketId: ${ .ticket.id }
  - resolveTicket:
      call: http
      with:
        method: post
        endpoint: https://fake-ticketing-system.com/tickets/resolve
        body:
          ticketId: ${ .ticket.id }

document:
  dsl: '1.0.3'
  namespace: test
  name: run-example
  version: '0.1.0'
do:
  - deployServerlessContainer:
      run:
        serverless_container:
          action: deploy
          name: my-api-container
          namespaceName: production
          region: fr-par
          imageUrl: rg.fr-par.scw.cloud/my-registry/api:v2.1.0
          port: 8080
          minScale: 2
          maxScale: 10
          environmentVariables:
            LOG_LEVEL: info
            API_VERSION: v2
          secretEnvironmentVariables:
            DB_PASSWORD: 11111111-1111-1111-1111-111111111111
          scalingOption:
            ConcurrentRequestsThreshold: 100

  - getServerlessContainer:
      run:
        serverless_container:
          action: get
          name: my-api-container
          namespaceName: production
          region: fr-par
          await: false

  - deleteServerlessContainer:
      run:
        serverless_container:
          action: delete
          name: old-container
          namespaceName: staging
          region: fr-par

document:
  dsl: '1.0.3'
  namespace: examples
  name: serverless-container-deploy
  version: '1.0.0'
do:
  - deployMyContainer:
      run:
        serverless_container:
          action: deploy
          name: my-api
          namespaceName: production
          region: fr-par
          imageUrl: rg.fr-par.scw.cloud/my-registry/api:v2.1.0
          # OR use Scaleway Registry:
          # scalewayRegistryImage:
          #   registryNamespace: my-registry
          #   registryRegion: fr-par
          #   image: api
          #   tag: v2.1.0
          port: 8080
          minScale: 2
          maxScale: 10
          cpuLimit: 2000
          memoryLimitBytes: 2147483648
          environmentVariables:
            LOG_LEVEL: info
            API_VERSION: v2
          secretEnvironmentVariables:
            DB_PASSWORD: 11111111-1111-1111-1111-111111111111
            API_KEY: 22222222-2222-2222-2222-222222222222
          scalingOption:
            ScalingRule: ConcurrentRequestsThreshold
            ScalingValue: 100
          livenessProbe:
            failureThreshold: 3
            interval: 10s
            timeout: 5s
            healthCheckProbe: http
            pathProbeHttp: /health

document:
  dsl: '1.0.3'
  namespace: examples
  name: serverless-container-get
  version: '1.0.0'
do:
  - getContainerStatus:
      run:
        serverless_container:
          action: get
          name: my-api
          namespaceName: production
          region: fr-par
          await: false

document:
  dsl: '1.0.3'
  namespace: examples
  name: serverless-container-delete
  version: '1.0.0'
do:
  - deleteOldContainer:
      run:
        serverless_container:
          action: delete
          name: old-api
          namespaceName: staging
          region: fr-par
          ignoreErrors:
            onDelete:
              notExists: true

document:
  dsl: '1.0.3'
  namespace: default
  name: set-example
  version: '0.1.0'
do:
  - setShape:
      set:
        shape: circle
        size: ${ .configuration.size }
        fill: ${ .configuration.fill }
  - setColor:
      set: ${ .configuration.color }

document:
  dsl: '1.0.3'
  namespace: test
  name: switch-example
  version: '0.1.0'
do:
  - processOrder:
      switch:
        - case1:
            when: .orderType == "electronic"
            then: processElectronicOrder
        - case2:
            when: .orderType == "physical"
            then: processPhysicalOrder
        - default:
            then: handleUnknownOrderType
  - processElectronicOrder:
      do:
        - validatePayment:
            call: http
            with:
              method: post
              endpoint: https://fake-payment-service.com/validate
        - fulfillOrder:
            call: http
            with:
              method: post
              endpoint: https://fake-fulfillment-service.com/fulfill
      then: exit
  - processPhysicalOrder:
      do:
        - checkInventory:
            call: http
            with:
              method: get
              endpoint: https://fake-inventory-service.com/inventory
        - packItems:
            call: http
            with:
              method: post
              endpoint: https://fake-packaging-service.com/pack
        - scheduleShipping:
            call: http
            with:
              method: post
              endpoint: https://fake-shipping-service.com/schedule
      then: exit
  - handleUnknownOrderType:
      do:
        - logWarning:
            call: http
            with:
              method: post
              endpoint: https://fake-logging-service.com/warn
        - notifyAdmin:
            call: http
            with:
              method: post
              endpoint: https://fake-notification-service.com/notify

document:
  dsl: '1.0.3'
  namespace: test
  name: try-example
  version: '0.1.0'
do:
  - trySomething:
      try:
        - invalidHttpCall:
            call: http
            with:
              method: get
              endpoint: https://
      catch:
        errors:
          with:
            type: https://open-workflow-specification.org/dsl/errors/types/communication
            status: 503
        as: error
        retry:
          delay:
            seconds: 3
          backoff:
            exponential: {}
          limit:
            attempt:
              count: 5

document:
  dsl: '1.0.3'
  namespace: test
  name: wait-example
  version: '0.1.0'
do:
  - waitAWhile:
      wait:
        seconds: 10

document:
  dsl: '1.0.3'
  namespace: test
  name: authentication-example
  version: '0.1.0'
use:
  secrets:
    - usernamePasswordSecret
  authentications:
    sampleBasicFromSecret:
      basic:
        use: usernamePasswordSecret
do:
  - sampleTask:
      call: http
      with:
        method: get
        endpoint: 
          uri: https://secured.fake.com/sample
          authentication:
            use: sampleBasicFromSecret

document:
  dsl: '1.0.3'
  namespace: test
  name: basic-authentication-example
  version: '0.1.0'
use:
  authentications:
    sampleBasic:
      basic:
        username: admin
        password: password123
do:
  - sampleTask:
      call: http
      with:
        method: get
        endpoint: 
          uri: https://secured.fake.com/sample
          authentication: 
            use: sampleBasic

document:
  dsl: '1.0.3'
  namespace: test
  name: bearer-authentication-example
  version: '0.1.0'
do:
  - sampleTask:
      call: http
      with:
        method: get
        endpoint: 
          uri: https://secured.fake.com/sample
          authentication:
            bearer:
              token: ${ .user.token }

document:
  dsl: '1.0.3'
  namespace: test
  name: digest-authentication-example
  version: '0.1.0'
use:
  authentications:
    sampleDigest:
      digest:
        username: admin
        password: password123
do:
  - sampleTask:
      call: http
      with:
        method: get
        endpoint: 
          uri: https://secured.fake.com/sample
          authentication: 
            use: sampleDigest

type: https://open-workflow-specification.org/spec/1.0.0/errors/communication
title: Service Not Available
status: 503

schema:
  format: json
  document:
    type: object
    properties:
      order:
        type: object
        required: [ pet ]
        properties:
          pet:
            type: object
            required: [ id ]
            properties:
              id:
                type: string
from: .order.pet

output:
  schema:
    format: json
    document:
      type: object
      properties:
        petId:
          type: string
      required: [ petId ]
  as:
    petId: '${ .pet.id }'

as: '$context+.'

as: '.'

format: json
document:
  type: object
  properties:
    id:
      type: string
    firstName:
      type: string
    lastName:
      type: string
  required: [ id, firstName, lastName ]

format: json
resource:
  endpoint: https://test.com/fake/schema/json/document.json

document:
  dsl: '1.0.3'
  namespace: default
  name: timeout-example
  version: '0.1.0'
do:
  - waitAMinute:
      wait:
        seconds: 60
timeout:
  after:
    seconds: 30

hours: 2
minutes: 15
seconds: 30

request:
  method: get
  uri: https://petstore.swagger.io/v2/pet/1
  headers:
    Content-Type: application/json
headers:
  Content-Type: application/json
statusCode: 200
content:
  id: 1
  name: milou
  status: pending

method: get
uri: https://petstore.swagger.io/v2/pet/1
headers:
  Content-Type: application/json

uri: https://petstore.swagger.io/v2/pet/{petId}

document:
  dsl: '1.0.3'
  namespace: test
  name: run-container-example
  version: '0.1.0'
do:
  - runContainer:
      run:
        container:
          image: fake-image
          lifetime:
            cleanup: eventually
            after:
              minutes: 30
        return: stderr

  - runScript:
      run:
        script:
          language: js
          code: >
            Some cool multiline script
        return: code

  - runShell:
      run:
        shell:
          command: 'echo "Hello, ${ .user.name }"'
        return: all

  - runWorkflow:
      run:
        workflow:
          namespace: another-one
          name: do-stuff
          version: '0.1.0'
          input: {}
        return: none