Skip to content
Embabel Worlds

Say this step is not going to be done, or take that back

PUT
/api/v1/next-steps/{id}/dismissed
curl --request PUT \
  --url http://localhost:11044/api/v1/next-steps/example/dismissed \
  --header 'Content-Type: application/json' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
  --data '{ "dismissed": true }'

The only remembered thing here: every other answer is derived from the graph. Dismissing does NOT mark a step done — it is still evaluated, so one waved away and then done anyway still reports DONE.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Step id as the list returns it, <source>_<declared id or position>. Not checked against the declared steps: an id nothing declares is recorded and has no effect

Query Parameters

Section titled “Query Parameters”
username
string

Username whose world the dismissal is recorded in, and whose list comes back; when it names an existing user it is used even if the request is authenticated as someone else. Omitted, blank or unknown, the authenticated user is used; 401 when neither resolves to a user

Request Bodyrequired

Section titled “Request Bodyrequired”

dismissed: true records the step as dismissed in the acting user’s world, false takes that back; omitted, it defaults to true. The step is still evaluated, so dismissing never makes it DONE

Media typeapplication/json

Whether the acting user has waved a step away — the body of PUT /next-steps/{id}/dismissed.

object
dismissed
required

True dismisses the step, false takes the dismissal back. Defaults to true. The step is still evaluated either way, so dismissing never marks it done.

boolean

Example generated

{
  "dismissed": true
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

Every declared onboarding step, done ones included. Which to show and in what order is the client’s decision

object
steps
required

The steps, in declaration order

Array<object>

One onboarding step and the answer to its own question

object
detail

Why the status is UNKNOWN, in the step author’s words; null otherwise

string
dismissed
required

The user said they will not do this step. Orthogonal to status: a dismissed step that gets done still reports DONE

boolean
id
required

The step’s id, as the dismiss endpoint names it

string
presentation
required

Everything else the step’s YAML declared, carried through uninterpreted: a console reads a route from it, a chat surface an input. Open by contract

object
key
additional properties
any
status
required

DONE, TODO, or UNKNOWN when the step’s query could not be answered — which must not be shown as outstanding work

string
Allowed values: DONE TODO UNKNOWN

Example 

{
  "steps": [
    {
      "status": "DONE"
    }
  ]
}