Every declared onboarding step, with whether it is already done

GET

/api/v1/next-steps

const url = 'http://localhost:11044/api/v1/next-steps';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/next-steps \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

status is DONE, TODO or UNKNOWN. UNKNOWN means the step’s own query could not be answered — detail says why — and must not be shown as outstanding work: a surface that nags on a broken query nags hardest when the appliance is least well.

Authorizations

apiKeyAuth
basicAuth

Parameters

Query Parameters

username

string

Username whose world is read; 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

Responses

200

application/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

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"
    }
  ]
}