Repository navigation
Fix the Server start example's duplicate_policy value #357
Description
Problem
The Server API reference's start example sends a duplicate_policy the Server rejects. A reader who copies it gets HTTP 422 instead of a started workflow, and the reference never lists the values the field accepts.
- The start example sends
"duplicate_policy": "reject". - The Server's start validator accepts only
failoruse-existingand rejects anything else with "The duplicate_policy field only supports fail or use-existing." - The published request contract lists the same two canonical values.
The Python SDK's docstring had the same mismatch, tracked in sdk-python#163. This is the docs site's copy of the request shape.
Source-verified, not reproduced.
Acceptance criteria
- The start example uses a value the Server accepts, and running it against a current Server starts the workflow.
- The Server API reference lists the accepted
duplicate_policyvalues, the default when the field is omitted, and what each does when a run with that id is already open or has closed.
Activity
rmcdaniel commentedon Oct 22, 2026
Accepted as a P2 documentation correction. The Server's start validator and published control-plane contract already agree on
failanduse-existing; changing the runtime to accept the erroneous example is unnecessary.The fix will update the runnable example, explain the omitted default and active/closed-run outcomes, and update all seven translated copies and their source hashes alongside English. Acceptance includes a real current-Server start using the corrected request. No API, dependency or protocol change is required. General owns this follow-through after the urgent trust-dependency remediation already in progress.
rmcdaniel commentedon Oct 22, 2026
Delivered through #358, normal merge 9684116, with exactly the reviewed tree 44b872fc. All applicable candidate checks pass, including executable examples, translations, CodeQL, Sonar and the public boundary. The merged remote branch is absent.
GitHub Pages deployment 39787625509 is successful. Independent live checks return HTTP 200 for English, German, Spanish, French, Japanese, Brazilian Portuguese, Ukrainian and Simplified Chinese. Each serves the corrected literal
failrequest and both policy values, with no locale redirect or English fallback.Ten isolated published-Server HTTP controls pass: invalid
rejectreturns 422, the literal documentedfailrequest starts with 201, default/null/omitted duplicates refuse,use-existingreturns the same active run, both policies refuse after closure, and a new id starts a new run. Server 2.11.0 was borrowed for that control; its controller and start-service hashes exactly match published 2.11.1 source. The first recorder's absentstarted-field assumption remains an unsuccessful fixture observation, followed by a separate fresh-database control using canonicaloutcome.All API, bootstrap, database and network resources are retired; the API exited 0 without OOM. No production requests or new image pull. This was a documentation correction to the existing contract, with all eight language copies and reviewed source hashes delivered together.