Skip to main content
PATCH
/
api
/
v1
/
tasks
/
{id}
/
steps
/
{stepId}
Update a plan step
curl --request PATCH \
  --url http://localhost:3001/api/v1/tasks/{id}/steps/{stepId} \
  --header 'Content-Type: application/json' \
  --cookie nut-session= \
  --data '
{
  "status": "pending",
  "description": "<string>",
  "command": "<string>",
  "expectedOutcome": "<string>",
  "output": "<string>",
  "error": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "title": "<string>",
    "status": "draft",
    "intent": "<string>",
    "content": "<string>",
    "priority": "low",
    "readiness": 50,
    "tags": [
      "<string>"
    ],
    "author": {
      "type": "user",
      "id": "<string>",
      "name": "<string>"
    },
    "reviewers": [
      "<string>"
    ],
    "planSteps": [
      {
        "id": "<string>",
        "description": "<string>",
        "status": "pending",
        "command": "<string>",
        "expectedOutcome": "<string>",
        "output": "<string>",
        "error": "<string>",
        "executedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "comments": [
      {
        "id": "<string>",
        "author": "<string>",
        "content": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "changes": [
      {
        "path": "<string>",
        "type": "create",
        "content": "<string>",
        "oldPath": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Path Parameters

id
string
required

Task ID

stepId
string
required

Step ID (e.g. step-01)

Body

application/json
status
enum<string>

Plan step status

Available options:
pending,
active,
done,
failed,
skipped
description
string
command
string
expectedOutcome
string
output
string
error
string

Response

Step updated successfully

success
boolean
required
data
object