Descriptions

You can document flows, inputs, outputs, tasks, and triggers by adding a description property.

The description property is a string field that supports Markdown syntax.

You can add a description property on:

  • Flows
  • Inputs
  • Outputs
  • Tasks
  • Triggers

All Markdown descriptions are rendered directly in the UI.

description

Here is an example flow with descriptions in different components:

id: myflow
namespace: company.team
description: |
  This is the **Flow Description**.
  You can look at `input description`, `task description`, `output description` and `trigger description` as well in this example.


labels:
  env: dev
  project: myproject


inputs:
  - id: payload
    type: JSON
    description: JSON request payload to the API # Input description example
    defaults: |
      [{"name": "kestra", "rating": "best in class"}]


tasks:
  - id: send_data
    type: io.kestra.plugin.core.http.Request
    description: Sends a POST API request to https://kestra.io/api/mock # Task description example
    uri: https://kestra.io/api/mock
    method: POST
    contentType: application/json
    body: "{{ inputs.payload }}"


  - id: print_status
    type: io.kestra.plugin.core.debug.Return
    description: Prints the API request date # Task description example
    format: hello on {{ outputs.send_data.headers.date | first }}


outputs:
  - id: final
    type: STRING
    description: Final flow output derived from the task result
    value: "{{ outputs.print_status.value }}"


triggers:
  - id: daily
    type: io.kestra.plugin.core.trigger.Schedule
    description: Triggers the flow every day at 09:00 AM # Trigger description example
    cron: "0 9 * * *"