Register a process

POST /sop/processes/register

Upload a .sop.yaml file to register or update a process definition. If a process with the same name already exists, a new version is published. In-flight instances are unaffected.

AUTH —

Requires X-SOP-Token header. See Authentication.

Request body

Multipart form upload. Content-Type: multipart/form-data

file file REQUIRED: The .sop.yaml file to register.

Response

201 application/json — The registered process definition.

Errors

422 invalid_definition YAML failed schema or syntax check.

401 unauthorized Token missing or revoked.

curl https://api.opensop.dev/sop/processes/register \
  -X POST \
  -H "X-SOP-Token: $OPENSOP_TOKEN" \
  -F "[email protected]"

const form = new FormData();
form.append("file", fs.createReadStream("./customer-onboarding.sop.yaml"));
await fetch("https://api.opensop.dev/sop/processes/register", {
  method: "POST",
  headers: { "X-SOP-Token": process.env.OPENSOP_TOKEN },
  body: form
});

with open("customer-onboarding.sop.yaml", "rb") as f:
  resp = requests.post(
    "https://api.opensop.dev/sop/processes/register",
    headers={"X-SOP-Token": os.environ["OPENSOP_TOKEN"]},
    files={"file": f}
  )

uri = URI("https://api.opensop.dev/sop/processes/register")
req = Net::HTTP::Post.new(uri)
req["X-SOP-Token"] = ENV["OPENSOP_TOKEN"]
req.set_form([["file", File.open("./customer-onboarding.sop.yaml")]])

RESPONSE 201

{
  "name":    "customer-onboarding",
  "version": "1.0"
}