sdk-php/docs/quickstart-contract.json at main · durable-workflow/sdk-php · GitHub

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
  "$schema": "https://php.durable-workflow.com/quickstart-contract.schema.v2.json",
  "schema_version": 2,
  "package": {
    "name": "durable-workflow/sdk",
    "published_version": "2.0.0-rc.42",
    "composer_requirement": "2.0.0-rc.42@RC",
    "onboarding_requirement": "^2.0@RC"
  },
  "runtime_targets": {
    "server": {
      "client_input": "http://localhost:8080",
      "namespace_input": "default",
      "input_kind": "server_origin",
      "example_request": "http://localhost:8080/api/workflows",
      "image": "durableworkflow/server:2.0.0-rc.38"
    },
    "cloud": {
      "client_input": "https://cloud.example/api/runtime/v1/namespaces/<runtime-id>",
      "namespace_input": "<provisioned-namespace>",
      "input_kind": "complete_namespace_runtime_uri",
      "example_request": "https://cloud.example/api/runtime/v1/namespaces/<runtime-id>/api/workflows"
    }
  },
  "environment": {
    "runtime_url": "DURABLE_WORKFLOW_RUNTIME_URL",
    "namespace": "DURABLE_WORKFLOW_NAMESPACE",
    "task_queue": "DURABLE_WORKFLOW_TASK_QUEUE",
    "client_credential": "DURABLE_WORKFLOW_CLIENT_TOKEN",
    "worker_credential": "DURABLE_WORKFLOW_WORKER_TOKEN"
  },
  "reference_resolution": {
    "version": 1,
    "bases": {
      "published_sdk": {
        "kind": "composer_package",
        "package_pointer": "/package"
      }
    }
  },
  "sources": {
    "bootstrap": {
      "kind": "composer_package_path",
      "base": "published_sdk",
      "path": "examples/bootstrap.php"
    },
    "worker": {
      "kind": "composer_package_path",
      "base": "published_sdk",
      "path": "examples/worker.php"
    },
    "client": {
      "kind": "composer_package_path",
      "base": "published_sdk",
      "path": "examples/client.php"
    }
  },
  "registration": {
    "preferred": "attribute_discovery",
    "attributes": [
      "DurableWorkflow\\Attribute\\Workflow",
      "DurableWorkflow\\Attribute\\Activity"
    ],
    "entrypoint": "DurableWorkflow\\Worker::register",
    "direct_alternative": [
      "DurableWorkflow\\Worker::registerWorkflow",
      "DurableWorkflow\\Worker::registerActivity"
    ]
  },
  "workflow_authoring": {
    "execution_model": "fiber",
    "syntax": "straight_line",
    "operation_results": "direct_return",
    "generator_compatibility": false
  },
  "expected_result": {
    "result": {
      "greeting": "hello, PHP"
    }
  },
  "qualification_provenance": {
    "subject_base": "published_sdk",
    "evidence": {
      "kind": "github_actions_workflow",
      "api_url": "https://api.github.com/repos/durable-workflow/sdk-php/actions/workflows/service-mode-published-smoke.yml",
      "web_url": "https://github.com/durable-workflow/sdk-php/actions/workflows/service-mode-published-smoke.yml",
      "version_input": {
        "name": "sdk_version",
        "value_pointer": "/package/published_version"
      }
    }
  },
  "integrations": {
    "laravel_service_mode": "https://github.com/durable-workflow/sdk-php#laravel-service-mode",
    "symfony_service_mode": "https://github.com/durable-workflow/sdk-php#symfony-service-mode",
    "embedded_laravel": "https://php.durable-workflow.com/frameworks/laravel/"
  }
}