Get workspace setup

The setup wizard's steps and the viewer's to-do list, from the workspace's records. Steps follow what structural risk checks need: code, infrastructure as code, cloud, runtime, then the architecture context confirmed in discovery. The to-do list holds what the viewer's role can still do about them, and clears each item once it holds. It is in-app only. Reading never writes.

GET

/v1/workspaces/{workspace_id}/setup

GET

/v1/workspaces/{workspace_id}/setup

The setup wizard's steps and the viewer's to-do list, from the workspace's records.

Steps follow what structural risk checks need: code, infrastructure as code, cloud, runtime, then the architecture context confirmed in discovery. The to-do list holds what the viewer's role can still do about them, and clears each item once it holds. It is in-app only. Reading never writes.

Authorization

workspaceToken

headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id

Formatuuid

Response Body

Successful Response

application/json

response

complete*Complete

context_inference?|

The latest pass suggesting architecture context, if any.

done_count*Done Count

Range0 <= value

finished_at?|

When the viewer finished or left the setup wizard.

intent*

What brings the viewer to Veriom, asked as the wizard opens.

skipped_steps*array<>

step_count*Step Count

Range0 <= value

steps*array<>

structural_check_count?Structural Check Count

How many structural checks the invariant pack holds.

Range0 <= value

Default0

todos*array<>

Example Request

curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/setup'

Example Request

curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/setup'

Example ResponseSchema

{
  "complete": true,
  "context_inference": {
    "completed_at": "2019-08-24T14:15:22Z",
    "error": "allowance_exhausted",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "requested_at": "2019-08-24T14:15:22Z",
    "stage": "string",
    "stale": true,
    "status": "queued",
    "suggestion_count": 0,
    "trigger": "setup"
  },
  "done_count": 0,
  "finished_at": "2019-08-24T14:15:22Z",
  "intent": {
    "answered_at": "2019-08-24T14:15:22Z",
    "leads": [
      {
        "id": "pull_request_audits",
        "reason": "ai_code"
      }
    ],
    "pull_request_audits": "on",
    "reasons": [
      "ai_code"
    ],
    "referral": "search",
    "skipped": true,
    "todo_focus": [
      "string"
    ]
  },
  "skipped_steps": [
    "code"
  ],
  "step_count": 0,
  "steps": [
    {
      "can_act": true,
      "checks_improved": 0,
      "checks_required": 0,
      "count": 0,
      "id": "code",
      "ledger": "string",
      "minimum_role": "owner",
      "skipped": true,
      "sources": [
        {
          "detail": "string",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "kind": "repository",
          "label": "string",
          "state": "connected"
        }
      ],
      "status": "done",
      "total": 0,
      "waiting_for": "code"
    }
  ],
  "structural_check_count": 0,
  "todos": [
    {
      "connector_id": "9389ba6f-3696-4571-84d4-34d588c4b109",
      "detail": "string",
      "field_key": "string",
      "id": "string",
      "in_progress": false,
      "kind": "source_attention",
      "label": "string",
      "ledger": "string",
      "next_action": "string",
      "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
      "skipped": false,
      "source": "string",
      "step": "code",
      "suggestion": {
        "by_model": true,
        "confidence": 0,
        "revision_id": "f8f7f022-982b-4bef-ba7d-4bb808fdbe2a",
        "values": [
          "string"
        ]
      }
    }
  ]
}

{  "complete": true,  "context_inference": {    "completed_at": "2019-08-24T14:15:22Z",    "error": "allowance_exhausted",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "requested_at": "2019-08-24T14:15:22Z",    "stage": "string",    "stale": true,    "status": "queued",    "suggestion_count": 0,    "trigger": "setup"  },  "done_count": 0,  "finished_at": "2019-08-24T14:15:22Z",  "intent": {    "answered_at": "2019-08-24T14:15:22Z",    "leads": [      {        "id": "pull_request_audits",        "reason": "ai_code"      }    ],    "pull_request_audits": "on",    "reasons": [      "ai_code"    ],    "referral": "search",    "skipped": true,    "todo_focus": [      "string"    ]  },  "skipped_steps": [    "code"  ],  "step_count": 0,  "steps": [    {      "can_act": true,      "checks_improved": 0,      "checks_required": 0,      "count": 0,      "id": "code",      "ledger": "string",      "minimum_role": "owner",      "skipped": true,      "sources": [        {          "detail": "string",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "kind": "repository",          "label": "string",          "state": "connected"        }      ],      "status": "done",      "total": 0,      "waiting_for": "code"    }  ],  "structural_check_count": 0,  "todos": [    {      "connector_id": "9389ba6f-3696-4571-84d4-34d588c4b109",      "detail": "string",      "field_key": "string",      "id": "string",      "in_progress": false,      "kind": "source_attention",      "label": "string",      "ledger": "string",      "next_action": "string",      "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",      "skipped": false,      "source": "string",      "step": "code",      "suggestion": {        "by_model": true,        "confidence": 0,        "revision_id": "f8f7f022-982b-4bef-ba7d-4bb808fdbe2a",        "values": [          "string"        ]      }    }  ]}

Get workspace setup

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body