Skip to content

New Http Decorator

This example shows the use of the http decorator and special Input/Output classes.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
from typing_extensions import Annotated

from hera.expr import g
from hera.shared import global_config
from hera.workflows import Input, Output, Parameter, Workflow
from hera.workflows.models import SuppliedValueFrom, ValueFrom

global_config.experimental_features["decorator_syntax"] = True


# We start by defining our Workflow
w = Workflow(generate_name="http-workflow-")


# This defines the template's inputs
class MyInput(Input):
    url: str = "https://example.com"


class MyOutput(Output):
    approve: Annotated[
        str,
        Parameter(
            name="approve",
            value_from=ValueFrom(
                supplied=SuppliedValueFrom(),
            ),
        ),
    ]


# We then use the decorators of the `Workflow` object
# to set the entrypoint and create a HTTP template
@w.set_entrypoint
@w.http_template(
    timeout_seconds=20,
    url=f"{g.inputs.parameters.url:$}",
    method="GET",
    headers=[{"name": "x-header-name", "value": "test-value"}],
    success_condition=str(g.response.body.contains("google")),  # type: ignore
    body="test body",
)
def basic_hello_world(my_input: MyInput) -> MyOutput: ...

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: http-workflow-
spec:
  entrypoint: basic-hello-world
  templates:
  - name: basic-hello-world
    http:
      body: test body
      method: GET
      successCondition: response.body contains 'google'
      timeoutSeconds: 20
      url: '{{inputs.parameters.url}}'
      headers:
      - name: x-header-name
        value: test-value
    inputs:
      parameters:
      - name: url
        default: https://example.com
    outputs:
      parameters:
      - name: approve
        valueFrom:
          supplied: {}

Comments