deploy: b3e82fe

Author: github-actions[bot]

2.0/llms-full.txt

@@ -868,18 +868,13 @@ Per-call options take highest priority, then activity class properties, then the
 
 # Starting Workflows
 
-To start a workflow, create a workflow instance and then call the `start()` method on it. The `start()` method splits public instance identity from run identity.
+To start a workflow, create a workflow instance and then call the `start()` method on it.
 
 ```php
 use Workflow\V2\WorkflowStub;
 
 $workflow = WorkflowStub::make(MyWorkflow::class);
-
-$instanceId = $workflow->id(); // Public workflow instance id
-
 $workflow->start();
-
-$runId = $workflow->runId(); // Active run id after start is accepted
 ```
 
 Once a workflow has been started, it will be executed asynchronously by a queue worker. The `start()` method returns immediately and does not block the current request.
@@ -892,23 +887,6 @@ use Workflow\V2\WorkflowStub;
 $workflow = WorkflowStub::load($id);
 ```
 
-## Instance and Run Identity
-
-- `id()` is the stable public workflow instance id.
-- Caller-supplied instance ids must currently be non-empty URL-safe strings up to 191 characters using only letters, numbers, `.`, `_`, `-`, and `:`.
-- `runId()` is the current run id for that instance.
-- `load($instanceId)` keeps the stub instance-centric, while `loadRun($runId)` selects one concrete run explicitly.
-- `make()` durably reserves the public workflow instance id immediately, before the first start command is accepted.
-- `status()` returns `reserved` while that durable reservation exists but no run has started yet.
-- `make(MyWorkflow::class, 'order-123')` creates or reloads the same durable reservation through the public instance id itself, so repeated callers can address one logical workflow instance without creating duplicate rows.
-- `start()` accepts the first start command, creates the first run, records typed `StartAccepted` and `WorkflowStarted` history events, and schedules the initial workflow task.
-- `start()` can also receive `StartOptions::withVisibility(...)->withMemo(...)` as its final argument to attach operator-facing `business_key`, exact-match string `visibility_labels`, and returned-only `memo` metadata. `business_key` and `visibility_labels` flow into the instance, run, run summary, typed start history, selected-run detail, and history export. `memo` flows into the instance, run, typed start history, selected-run detail, and history export, and it is carried into later `continueAsNew()` runs.
-- `summary()` returns the current run summary projection when one exists.
-- `refresh()` reloads the current instance and resolves the newest durable run for that instance from storage.
-- `continueAsNew()` keeps that same instance id but advances `runId()` to the newest run after `refresh()`.
-- `completed()`, `failed()`, `cancelled()`, and `terminated()` are convenience helpers for terminal run states.
-- Instance-targeted `load($instanceId)` and current-run commands resolve the newest durable run in the instance chain instead of trusting only the mutable current-run pointer, so continue-as-new chains stay addressable even if that column drifts.
-
 ## Start Options
 
 ```php
@@ -935,32 +913,6 @@ $workflow->start(
 );
 ```
 
-Visibility labels are exact-match strings for operator filtering in Waterline, not a high-volume analytics payload. Label keys use letters, numbers, `.`, `_`, `-`, and `:`, up to 64 characters. Label values and `business_key` are non-empty strings up to 191 characters.
-
-`memo` is JSON-like metadata for selected-run detail and history export, not a list-filter or run-summary search field. Top-level and nested memo object keys must be non-empty strings up to 64 characters, and memo values may be scalars, `null`, arrays, or nested objects.
-
-### Search Attributes
-
-Search attributes are indexed scalar metadata for operator filtering and fleet visibility. Unlike memo, search attributes are surfaced in run list views and can be used for visibility filtering in Waterline:
-
-```php
-$workflow->start(
-    $orderId,
-    StartOptions::withVisibility(
-        businessKey: 'order-123',
-        labels: ['tenant' => 'acme'],
-    )->withSearchAttributes([
-        'priority' => 'high',
-        'status' => 'pending',
-        'amount' => '99.50',
-    ]),
-);
-```
-
-Search attribute keys follow the same rules as visibility label keys: letters, numbers, `.`, `_`, `-`, and `:`, up to 64 characters. Values must be scalars or `null`. Boolean values are cast to `"1"` or `"0"`, and `null` values are silently dropped. Empty string values after casting are also dropped.
-
-Search attributes can be upserted during workflow execution using `upsertSearchAttributes()`, which merges the new attributes into the existing set.
-
 ### Execution and Run Timeouts
 
 `StartOptions` also supports execution-level and run-level timeouts:
@@ -979,97 +931,6 @@ $workflow->start(
 
 Both timeouts must be at least 1 second. Pass `null` (the default) to leave the timeout unlimited.
 
-## Workflow Type
-
-The durable `workflow_type` for that instance comes from either:
-
-- a `#[Type('...')]` attribute on the workflow class, or
-- a config registration under `workflows.v2.types.workflows`
-
-Example config registration when you do not want to annotate the class directly:
-
-```php
-// config/workflows.php
-'v2' => [
-    'types' => [
-        'workflows' => [
-            'billing.invoice-sync' => App\Workflows\InvoiceSyncWorkflow::class,
-        ],
-        'activities' => [
-            'payments.capture' => App\Activities\CapturePaymentActivity::class,
-        ],
-    ],
-],
-```
-
-That same config map is also the fallback path when a worker needs to resolve a stored durable type after a PHP class rename. Keep the durable type key stable, update the map to the new class, and the runtime can continue loading the run without rewriting the public instance id.
-
-When that fallback is used on a reserved start or on `continueAsNew()`, the newly written run is now normalized onto the resolved class before it is stored. That means the next run's `workflow_class` and snapped signal or update contract no longer stay stuck on the stale PHP FQCN once the durable type key has been remapped.
-
-## Cancellation and Termination
-
-The same stub can close an in-flight run explicitly:
-
-```php
-$workflow = WorkflowStub::load($instanceId);
-
-$workflow->cancel();    // marks the current run as cancelled
-$workflow->terminate(); // marks the current run as terminated
-```
-
-Both methods target the current run for that instance, return a typed command result, and persist durable command history before the run summary is updated. If the command cannot be applied, `cancel()` and `terminate()` throw a `LogicException`.
-
-Use `attemptCancel()` or `attemptTerminate()` when you want the outcome without an exception:
-
-```php
-$workflow = WorkflowStub::load($instanceId);
-
-$result = $workflow->attemptCancel();
-// or $result = $workflow->attemptTerminate();
-
-$result->commandId();       // Durable terminal command id
-$result->commandSequence(); // Durable command order within the selected run
-$result->instanceId();      // Public workflow instance id
-$result->runId();           // Current run id, or null if the instance never started
-$result->requestedRunId();  // Explicitly selected run id, or null for instance-targeted commands
-$result->resolvedRunId();   // Run the engine actually resolved for this command
-$result->targetScope();     // "instance" or "run"
-$result->workflowType();    // Durable workflow type key for the targeted instance
-$result->status();          // "accepted" or "rejected"
-$result->accepted();        // true or false
-$result->outcome();         // "cancelled", "terminated", "rejected_not_started", "rejected_not_active", or "rejected_not_current"
-$result->rejectionReason(); // null, "instance_not_started", "run_not_active", or "selected_run_not_current"
-```
-
-If you want to target one selected run explicitly, load it by run id:
-
-```php
-$selectedRun = WorkflowStub::loadRun($runId);
-
-$selectedRun->currentRunId(); // current run for the instance
-$selectedRun->currentRunIsSelected(); // whether this selected run is still current
-
-$result = $selectedRun->attemptCancel();
-```
-
-That run-targeted command stays durable even when the selected run is historical. In that case the engine rejects it with `targetScope() === 'run'`, `outcome() === 'rejected_not_current'`, and `rejectionReason() === 'selected_run_not_current'`, while `requestedRunId()` keeps the rejected historical run and `resolvedRunId()` points at the current run that should be addressed next.
-
-## Webhook Routes
-
-The same engine-level commands are exposed to external callers through webhook routes:
-
-```text
-POST /webhooks/instances/{workflowId}/runs/{runId}/updates/{update}
-POST /webhooks/instances/{workflowId}/runs/{runId}/cancel
-POST /webhooks/instances/{workflowId}/runs/{runId}/terminate
-POST /webhooks/instances/{workflowId}/updates/{update}
-POST /webhooks/instances/{workflowId}/cancel
-POST /webhooks/instances/{workflowId}/terminate
-```
-
-The instance routes expect the public instance id and always resolve the current active run at apply time. The run routes expect both the public instance id and one selected run id. Accepted update, cancel, and terminate webhook calls return HTTP `200`. Rejected update, cancel, and terminate webhook calls usually return HTTP `409` with the same `outcome` and `rejection_reason` values shown above, while unknown update methods return HTTP `404` with `outcome = rejected_unknown_update`.
-The JSON field names are `workflow_type`, `command_status`, `target_scope`, `requested_run_id`, and `resolved_run_id`, which correspond to `workflowType()`, `status()`, `targetScope()`, `requestedRunId()`, and `resolvedRunId()` on the PHP command result. Run-targeted webhook calls return `target_scope = run` and reject historical selections with `outcome = rejected_not_current` plus `rejection_reason = selected_run_not_current`, keeping the rejected run in `requested_run_id` and the current run in `resolved_run_id`.
-
 ## Attempt Start
 
 If you want the durable start-command identity or a non-throwing duplicate-start outcome, use `attemptStart()`:

404.html

@@ -13,13 +13,13 @@
 
 
 <link rel="search" type="application/opensearchdescription+xml" title="Durable Workflow" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.5aeb371e.css">
-<link rel="preload" href="/assets/js/runtime~main.8d57d7ab.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.11c346cf.js" as="script">
 <link rel="preload" href="/assets/js/main.09bafa3b.js" as="script">
 </head>
 <body class="navigation-with-keyboard">
 <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
 <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Durable Workflow</b></a><a class="navbar__item navbar__link" href="/docs/installation/">Docs</a><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/introduction/">1.x</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/2.0/introduction/">2.0</a></li><li><a class="dropdown__link" href="/docs/introduction/">1.x</a></li></ul></div><a class="navbar__item navbar__link" href="/blog/">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__item navbar__link" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__link navbar-github-star-link--mobile-topbar" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><div class="toggle_vylO colorModeToggle_x44X"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/introduction/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/installation/">Installation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.gg/xu5aDDpqVy" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://x.com/DurableWorkflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">X<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://durable-workflow.com/llms-full.txt" target="_blank" rel="noopener noreferrer" class="footer__link-item">LLM Docs<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://packagist.org/packages/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">Packagist<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 <a href="https://durable-workflow.com">Durable Workflow</a>.</div></div></div></footer></div></div>
-<script src="/assets/js/runtime~main.8d57d7ab.js"></script>
+<script src="/assets/js/runtime~main.11c346cf.js"></script>
 <script src="/assets/js/main.09bafa3b.js"></script>
 </body>
 </html>