Skip to content

docs: fix while True busy-wait and cURL sync endpoint in quickstart#955

Closed
nthmost-orkes wants to merge 3 commits into
mainfrom
fix/docs-quickstart-python-and-curl
Closed

docs: fix while True busy-wait and cURL sync endpoint in quickstart#955
nthmost-orkes wants to merge 3 commits into
mainfrom
fix/docs-quickstart-python-and-curl

Conversation

@nthmost-orkes
Copy link
Copy Markdown
Contributor

Fixes conductor-oss/getting-started#13, conductor-oss/getting-started#14

Changes

#13while True: pass busy-wait
Replaces the CPU-spinning while True: pass keep-alive loop with time.sleep(1), which yields the CPU between polls. The time module is already in stdlib so no new dependency is introduced.

#14 — cURL sync equivalent is wrong
The --sync flag uses Conductor's synchronous execution endpoint (/api/workflow/execute/{name}/{version}), not the async start endpoint. The cURL equivalent in the Docker table now uses the correct endpoint and includes a request body (-d '{}').

Comment thread docs/quickstart/index.md Outdated
|-----|------|
| `conductor workflow create workflow.json` | `curl -X POST http://localhost:8080/api/metadata/workflow -H 'Content-Type: application/json' -d @workflow.json` |
| `conductor workflow start -w hello_workflow --sync` | `curl -s -X POST http://localhost:8080/api/workflow/hello_workflow -H 'Content-Type: application/json'` |
| `conductor workflow start -w hello_workflow --sync` | `curl -s -X POST "http://localhost:8080/api/workflow/execute/hello_workflow/1" -H 'Content-Type: application/json' -d '{}'` |
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the previous URL is correct. please revert back.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i had noticed that, not sure why it was changed, then of course was paying attention to other things. will revisit this a little later -- i want to understand why Claude thought to change this

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted — you're right, doesn't exist in OSS Conductor. The original POST /api/workflow/{name} is the correct cURL equivalent; --sync is purely CLI-side wait behavior. Fixed in the latest commit.

@nthmost-orkes nthmost-orkes marked this pull request as draft April 2, 2026 19:44
The /api/workflow/execute endpoint does not exist in OSS Conductor.
The original POST /api/workflow/{name} is the correct cURL equivalent
(async start; --sync is a CLI-side wait, not a server feature).
@nthmost-orkes
Copy link
Copy Markdown
Contributor Author

Closing as superseded by #930 (merged).

Both issues this PR targeted are already fixed in main:

Nothing to salvage here — the branch history is tangled and both issues are resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python worker example uses 'while True: pass' — spins CPU at 100%

2 participants