Skip to content

Docker 'Using Docker instead' section: cURL sync equivalent is incomplete #14

@nthmost-orkes

Description

@nthmost-orkes

Problem

The quickstart docs offer this cURL equivalent for `conductor workflow start -w hello_workflow --sync`:

```bash
curl -s -X POST http://localhost:8080/api/workflow/hello_workflow -H 'Content-Type: application/json'
```

This has two problems:

  1. No request body — the API requires at least `-d '{}'` or it may reject the request
  2. Not synchronous — this hits the async start endpoint and returns a workflow ID, not the completed result. The `--sync` behavior uses a different API endpoint (`/api/workflow/execute/{name}/{version}`) that polls for completion

A new user following the Docker path and trying to replicate the `--sync` experience will get a workflow ID back instead of the output, with no guidance on what to do next.

Fix

Either:

  • Show the correct synchronous execution API call with proper body
  • Or note that the Docker path doesn't have a direct `--sync` equivalent and link to the API docs for polling

Affects

  • `conductor-oss/conductor` docs/quickstart/index.md (Docker section)

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: dockerDocker images, docker-compose, Dockerfilearea: docsdocs.conductor-oss.org contentfix: docs-onlyFix is a documentation/copy change, no code needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions