scriptoriumadmin/fabro
1
0
Fork 0
mirror of https://github.com/fabro-sh/fabro.git synced 2026-10-10 03:30:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Apply API design guidelines to all non-Session endpoints

Browse source 
Enrich the entire OpenAPI spec with descriptions, examples, format
annotations, extracted parameters, discriminated unions, and richer
response schemas — matching the patterns already established for
Sessions.

Structural changes:
- Extract CancelRunResponse and SteerRunResponse from inline schemas
- Change POST /runs/{id}/steer from 200 to 202 (async fire-and-forget)
- Split StageTurn into discriminated union (SystemStageTurn,
  AssistantStageTurn, ToolStageTurn) with oneOf + discriminator
- Add status + created_at to StartRunResponse
- Add created_at to RunListItem and RunStatusResponse
- Add created_at + updated_at to SavedQuery
- Add format: date-time on RetroListItem.timestamp
- Extract 7 new reusable parameters (StageId, QuestionId, WorkflowName,
  VerificationSlug, InsightQueryId, ProjectId, CheckpointFilter)
- Enrich existing RunId, PageLimit, PageOffset parameters
- Add descriptions + examples to all ~66 schemas and ~200+ properties
- Add operation descriptions to all ~35 endpoints

Rust handler updates:
- Change ManagedRun.created_at from Instant to chrono::DateTime<Utc>
- Populate new fields in StartRunResponse, RunStatusResponse
- Use new StageTurn discriminated union variants in demo data
- Update demo data timestamps to use DateTime<Utc>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Bryan Helmkamp 2026-03-06 10:30:33 -05:00
parent a9645132fc
commit b2b25fbe6c
103 changed files with 2006 additions and 581 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
crates/arc-api/src/demo/mod.rs
View file

@ -42,7 +42,7 @@ pub async fn start_run_stub(
) -> Response {
(
StatusCode::CREATED,
Json(serde_json::json!({"id": "demo-run-new"})),
Json(serde_json::json!({"id": "demo-run-new", "status": "queued", "created_at": "2026-03-06T14:30:00Z"})),
)
.into_response()
}
@ -113,7 +113,7 @@ pub async fn steer_run_stub(
State(_state): State<Arc<AppState>>,
Path(_id): Path<String>,
) -> Response {
(StatusCode::OK, Json(serde_json::json!({"accepted": true}))).into_response()
(StatusCode::ACCEPTED, Json(serde_json::json!({"accepted": true}))).into_response()
}
pub async fn generate_preview_url_stub(
@ -134,13 +134,14 @@ pub async fn get_run_status(
Path(id): Path<String>,
) -> Response {
match runs::list_items().into_iter().find(|r| r.id == id) {
Some(_) => (
Some(item) => (
StatusCode::OK,
Json(arc_types::RunStatusResponse {
id: id.clone(),
status: arc_types::RunStatus::Running,
error: None,
queue_position: None,
created_at: item.created_at,
}),
)
.into_response(),
@ -452,7 +453,7 @@ pub async fn trigger_workflow_run_stub(
) -> Response {
(
StatusCode::CREATED,
Json(serde_json::json!({"id": "demo-workflow-run"})),
Json(serde_json::json!({"id": "demo-workflow-run", "status": "queued", "created_at": "2026-03-06T14:30:00Z"})),
)
.into_response()
}
@ -597,7 +598,7 @@ pub async fn save_query_stub(
) -> Response {
(
StatusCode::CREATED,
Json(serde_json::json!({"id": "new-q", "name": "New Query", "sql": "SELECT 1"})),
Json(serde_json::json!({"id": "new-q", "name": "New Query", "sql": "SELECT 1", "created_at": "2026-03-06T16:00:00Z"})),
)
.into_response()
}
@ -609,7 +610,7 @@ pub async fn update_query_stub(
) -> Response {
(
StatusCode::OK,
Json(serde_json::json!({"id": "1", "name": "Updated", "sql": "SELECT 1"})),
Json(serde_json::json!({"id": "1", "name": "Updated", "sql": "SELECT 1", "created_at": "2026-03-01T10:00:00Z", "updated_at": "2026-03-06T16:00:00Z"})),
)
.into_response()
}
@ -687,6 +688,11 @@ pub async fn get_aggregate_usage(
mod runs {
use arc_types::*;
use chrono::{DateTime, Utc};
fn ts(s: &str) -> DateTime<Utc> {
s.parse().unwrap()
}
pub fn list_items() -> Vec<RunListItem> {
vec![
@ -706,6 +712,7 @@ mod runs {
comments: Some(0),
question: None,
sandbox_id: Some("sb-a1b2c3d4".into()),
created_at: ts("2026-03-06T14:30:00Z"),
},
RunListItem {
id: "run-2".into(),
@ -723,6 +730,7 @@ mod runs {
comments: Some(0),
question: None,
sandbox_id: Some("sb-e5f6g7h8".into()),
created_at: ts("2026-03-06T12:00:00Z"),
},
RunListItem {
id: "run-3".into(),
@ -740,6 +748,7 @@ mod runs {
comments: Some(0),
question: None,
sandbox_id: Some("sb-i9j0k1l2".into()),
created_at: ts("2026-03-05T09:20:00Z"),
},
RunListItem {
id: "run-4".into(),
@ -757,6 +766,7 @@ mod runs {
comments: Some(0),
question: Some("Accept or push for another round?".into()),
sandbox_id: Some("sb-q7r8s9t0".into()),
created_at: ts("2026-03-04T15:00:00Z"),
},
RunListItem {
id: "run-5".into(),
@ -774,6 +784,7 @@ mod runs {
comments: Some(0),
question: Some("Proceed from investigation to fix?".into()),
sandbox_id: Some("sb-u1v2w3x4".into()),
created_at: ts("2026-03-04T10:00:00Z"),
},
RunListItem {
id: "run-6".into(),
@ -827,6 +838,7 @@ mod runs {
comments: Some(4),
question: None,
sandbox_id: Some("sb-m3n4o5p6".into()),
created_at: ts("2026-03-03T16:45:00Z"),
},
RunListItem {
id: "run-7".into(),
@ -870,6 +882,7 @@ mod runs {
comments: Some(1),
question: None,
sandbox_id: Some("sb-y5z6a7b8".into()),
created_at: ts("2026-03-03T11:00:00Z"),
},
RunListItem {
id: "run-8".into(),
@ -948,6 +961,7 @@ mod runs {
comments: Some(7),
question: None,
sandbox_id: Some("sb-c9d0e1f2".into()),
created_at: ts("2026-02-28T14:00:00Z"),
},
RunListItem {
id: "run-9".into(),
@ -996,6 +1010,7 @@ mod runs {
comments: Some(2),
question: None,
sandbox_id: Some("sb-g3h4i5j6".into()),
created_at: ts("2026-02-27T09:00:00Z"),
},
RunListItem {
id: "run-10".into(),
@ -1034,6 +1049,7 @@ mod runs {
comments: Some(0),
question: None,
sandbox_id: Some("sb-k7l8m9n0".into()),
created_at: ts("2026-02-26T08:00:00Z"),
},
]
}
@ -1073,16 +1089,16 @@ mod runs {
pub fn turns() -> Vec<StageTurn> {
vec![
StageTurn { kind: StageTurnKind::System, content: Some("You are a drift detection agent. Compare the production and staging environments and identify any configuration or code drift.".into()), tools: vec![] },
StageTurn { kind: StageTurnKind::Assistant, content: Some("I'll start by loading the environment configurations for both production and staging to compare them.".into()), tools: vec![] },
StageTurn {
kind: StageTurnKind::Tool, content: None,
StageTurn::SystemStageTurn(SystemStageTurn { kind: SystemStageTurnKind::System, content: "You are a drift detection agent. Compare the production and staging environments and identify any configuration or code drift.".into(), tools: vec![] }),
StageTurn::AssistantStageTurn(AssistantStageTurn { kind: AssistantStageTurnKind::Assistant, content: "I'll start by loading the environment configurations for both production and staging to compare them.".into(), tools: vec![] }),
StageTurn::ToolStageTurn(ToolStageTurn {
kind: ToolStageTurnKind::Tool, content: None,
tools: vec![
ToolUse { id: "toolu_01".into(), tool_name: "read_file".into(), input: r#"{ "path": "environments/production/config.toml" }"#.into(), result: "[redis]\nhost = \"redis-prod.internal\"\nport = 6379".into(), is_error: false, duration_ms: Some(45) },
ToolUse { id: "toolu_02".into(), tool_name: "read_file".into(), input: r#"{ "path": "environments/staging/config.toml" }"#.into(), result: "[redis]\nhost = \"redis-staging.internal\"\nport = 6379".into(), is_error: false, duration_ms: Some(38) },
],
},
StageTurn { kind: StageTurnKind::Assistant, content: Some("I've detected drift in 3 resources between production and staging:\n\n1. **redis.max_connections** — production has 200, staging has 100\n2. **redis.tls** — enabled in production, disabled in staging\n3. **iam.session_duration** — production uses 3600s, staging uses 1800s".into()), tools: vec![] },
}),
StageTurn::AssistantStageTurn(AssistantStageTurn { kind: AssistantStageTurnKind::Assistant, content: "I've detected drift in 3 resources between production and staging:\n\n1. **redis.max_connections** — production has 200, staging has 100\n2. **redis.tls** — enabled in production, disabled in staging\n3. **iam.session_duration** — production uses 3600s, staging uses 1800s".into(), tools: vec![] }),
]
}
@ -2295,6 +2311,11 @@ mod verifications {
mod retros {
use arc_types::*;
use chrono::{DateTime, Utc};
fn ts(s: &str) -> DateTime<Utc> {
s.parse().unwrap()
}
pub fn list_items() -> Vec<RetroListItem> {
vec![
@ -2302,7 +2323,7 @@ mod retros {
run_id: "run-1".into(),
workflow_name: "implement".into(),
goal: "Add rate limiting to auth endpoints".into(),
timestamp: "2026-02-28T14:32:00Z".into(),
timestamp: ts("2026-02-28T14:32:00Z"),
smoothness: Some(SmoothnessRating::Smooth),
stats: RetroStats {
total_duration_ms: 389000,
@ -2323,7 +2344,7 @@ mod retros {
run_id: "run-2".into(),
workflow_name: "implement".into(),
goal: "Migrate to React Router v7".into(),
timestamp: "2026-02-28T10:15:00Z".into(),
timestamp: ts("2026-02-28T10:15:00Z"),
smoothness: Some(SmoothnessRating::Bumpy),
stats: RetroStats {
total_duration_ms: 975000,
@ -2347,7 +2368,7 @@ mod retros {
run_id: "run-6".into(),
workflow_name: "implement".into(),
goal: "Add dark mode toggle".into(),
timestamp: "2026-02-27T16:45:00Z".into(),
timestamp: ts("2026-02-27T16:45:00Z"),
smoothness: Some(SmoothnessRating::Effortless),
stats: RetroStats {
total_duration_ms: 216000,
@ -2367,7 +2388,7 @@ mod retros {
run_id: "run-3".into(),
workflow_name: "fix_build".into(),
goal: "Fix config parsing for nested values".into(),
timestamp: "2026-02-27T09:20:00Z".into(),
timestamp: ts("2026-02-27T09:20:00Z"),
smoothness: Some(SmoothnessRating::Struggled),
stats: RetroStats {
total_duration_ms: 830000,
@ -2388,7 +2409,7 @@ mod retros {
run_id: "run-8".into(),
workflow_name: "implement".into(),
goal: "Implement webhook retry logic".into(),
timestamp: "2026-02-26T11:00:00Z".into(),
timestamp: ts("2026-02-26T11:00:00Z"),
smoothness: Some(SmoothnessRating::Smooth),
stats: RetroStats {
total_duration_ms: 440000,
@ -2557,12 +2578,17 @@ mod sessions {
mod insights {
use arc_types::*;
use chrono::{DateTime, Utc};
fn ts(s: &str) -> DateTime<Utc> {
s.parse().unwrap()
}
pub fn saved_queries() -> Vec<SavedQuery> {
vec![
SavedQuery { id: "1".into(), name: "Run duration by workflow".into(), sql: "SELECT workflow_name, AVG(duration_seconds) as avg_duration,\n COUNT(*) as run_count\nFROM runs\nGROUP BY workflow_name\nORDER BY avg_duration DESC\nLIMIT 20".into() },
SavedQuery { id: "2".into(), name: "Daily failure rate".into(), sql: "SELECT date_trunc('day', created_at) as day,\n COUNT(*) FILTER (WHERE status = 'failed') as failures,\n COUNT(*) as total\nFROM runs\nGROUP BY 1\nORDER BY 1 DESC\nLIMIT 30".into() },
SavedQuery { id: "3".into(), name: "Top repos by activity".into(), sql: "SELECT repo, COUNT(*) as runs\nFROM runs\nGROUP BY repo\nORDER BY runs DESC".into() },
SavedQuery { id: "1".into(), name: "Run duration by workflow".into(), sql: "SELECT workflow_name, AVG(duration_seconds) as avg_duration,\n COUNT(*) as run_count\nFROM runs\nGROUP BY workflow_name\nORDER BY avg_duration DESC\nLIMIT 20".into(), created_at: ts("2026-03-01T10:00:00Z"), updated_at: Some(ts("2026-03-05T14:30:00Z")) },
SavedQuery { id: "2".into(), name: "Daily failure rate".into(), sql: "SELECT date_trunc('day', created_at) as day,\n COUNT(*) FILTER (WHERE status = 'failed') as failures,\n COUNT(*) as total\nFROM runs\nGROUP BY 1\nORDER BY 1 DESC\nLIMIT 30".into(), created_at: ts("2026-03-02T09:00:00Z"), updated_at: None },
SavedQuery { id: "3".into(), name: "Top repos by activity".into(), sql: "SELECT repo, COUNT(*) as runs\nFROM runs\nGROUP BY repo\nORDER BY runs DESC".into(), created_at: ts("2026-03-03T11:00:00Z"), updated_at: None },
]
}

16
crates/arc-api/src/server.rs
View file

@ -67,7 +67,7 @@ struct ManagedRun {
graph: arc_workflows::graph::Graph,
status: RunStatus,
error: Option<String>,
created_at: std::time::Instant,
created_at: chrono::DateTime<chrono::Utc>,
// Populated when running:
interviewer: Option<Arc<WebInterviewer>>,
event_tx: Option<broadcast::Sender<WorkflowRunEvent>>,
@ -379,6 +379,7 @@ async fn list_runs(
status: managed_run.status,
error: managed_run.error.clone(),
queue_position: queue_positions.get(id).copied(),
created_at: managed_run.created_at,
})
.collect();
let page: Vec<_> = all_items.into_iter().skip(offset).take(limit + 1).collect();
@ -432,7 +433,7 @@ async fn start_run(
graph,
status: RunStatus::Queued,
error: None,
created_at: std::time::Instant::now(),
created_at: chrono::Utc::now(),
interviewer: None,
event_tx: None,
context: None,
@ -446,7 +447,15 @@ async fn start_run(
state.scheduler_notify.notify_one();
(StatusCode::CREATED, Json(StartRunResponse { id: run_id })).into_response()
(
StatusCode::CREATED,
Json(StartRunResponse {
id: run_id,
status: RunStatus::Queued,
created_at: chrono::Utc::now(),
}),
)
.into_response()
}
/// Execute a single run: transitions queued → starting → running → completed/failed/cancelled.
@ -678,6 +687,7 @@ async fn get_run_status(
id: id.clone(),
status: managed_run.status,
error: managed_run.error.clone(),
created_at: managed_run.created_at,
queue_position,
}),
)

736
docs/api-reference/arc-api.yaml
View file

File diff suppressed because it is too large Load diff

45
docs/execution/observability.mdx
View file

@ -153,17 +153,7 @@ ARC_LOG=debug arc run start workflow.dot
### API: Server-Sent Events
When running workflows through the API server, subscribe to a live event stream:
```
GET /runs/{id}/events
```
This returns a Server-Sent Events (SSE) stream. Each event is a JSON-serialized `WorkflowRunEvent`. The stream stays open until the run completes, at which point the connection closes. If the run has already finished, the endpoint returns `410 Gone`.
```bash
curl -N http://localhost:3000/runs/01JKXYZ.../events
```
When running workflows through the API server, subscribe to a live event stream via the [run events endpoint](/api-reference/runs#get-events). Each event is a JSON-serialized `WorkflowRunEvent`. The stream stays open until the run completes.
### Web UI
@ -204,34 +194,13 @@ Each run's logs directory contains a standard set of files:
### Inspecting stages and turns
The API provides endpoints for drilling into individual stages and the agent turns within them:
```
GET /runs/{id}/stages
```
Returns per-stage metadata: node ID, status, duration, cost, files touched.
```
GET /runs/{id}/stages/{stageId}/turns
```
Returns the conversation turns within an agent stage — each user prompt, assistant response, and tool call with its result.
The API provides endpoints for drilling into individual stages and the agent turns within them. See the [stages](/api-reference/run-internals#get-stages) and [turns](/api-reference/run-internals#get-stage-turns) API reference for details.
## Insights (SQL analytics)
The Insights feature lets you run SQL queries across your run data using DuckDB. This is useful for aggregate analysis — finding slow workflows, tracking failure rates, comparing model costs, and spotting trends.
### API endpoints
| Endpoint | Description |
|---|---|
| `GET /insights/queries` | List saved queries |
| `POST /insights/queries` | Save a new query |
| `PUT /insights/queries/{id}` | Update a saved query |
| `DELETE /insights/queries/{id}` | Delete a saved query |
| `POST /insights/execute` | Execute a SQL query |
| `GET /insights/history` | View recent query executions |
Insights is managed through the [Insights API endpoints](/api-reference/insights). You can save, update, and execute queries programmatically.
### Example queries
@ -269,13 +238,7 @@ ORDER BY runs DESC
## Aggregate usage
The API server tracks aggregate usage counters across all runs. These are available at:
```
GET /usage
```
This returns total run count, total runtime, and per-model breakdowns of token usage and cost. Counters reset on server restart.
The API server tracks aggregate usage counters across all runs — total run count, total runtime, and per-model breakdowns of token usage and cost. See the [usage endpoint](/api-reference/run-outputs#get-usage) in the API reference. Counters reset on server restart.
## Credential redaction

65
docs/execution/retros.mdx
View file

@ -116,71 +116,8 @@ arc run start workflow.dot --no-retro
### API
Retrieve the retro for a specific run:
```
GET /runs/{id}/retro
```
Returns the full retro JSON, or `null` if no retro is available yet.
List retros across all runs (paginated):
```
GET /retros
```
Returns a summary for each retro including `run_id`, `workflow_name`, `goal`, `timestamp`, `smoothness`, aggregate stats, and a count of friction points.
Retros are also available via the REST API. See the [Retros API reference](/api-reference/retros) for endpoints to retrieve a single run's retro or list retros across all runs.
## Storage
Retros are stored as `retro.json` in the run's logs directory alongside `checkpoint.json` and `progress.jsonl`. They are plain JSON files — easy to parse, query, or pipe into other tools.
```json
{
"run_id": "01JKXYZ...",
"workflow_name": "PlanImplement",
"goal": "Fix the authentication bug",
"timestamp": "2026-03-05T14:30:00Z",
"smoothness": "smooth",
"stages": [
{
"stage_id": "plan",
"stage_label": "Plan",
"status": "success",
"duration_ms": 5000,
"retries": 0,
"cost": 0.05,
"files_touched": ["plan.md"]
},
{
"stage_id": "implement",
"stage_label": "Implement",
"status": "success",
"duration_ms": 15000,
"retries": 1,
"cost": 0.10,
"files_touched": ["src/auth.rs", "src/auth_test.rs"]
}
],
"stats": {
"total_duration_ms": 20000,
"total_cost": 0.15,
"total_retries": 1,
"files_touched": ["plan.md", "src/auth.rs", "src/auth_test.rs"],
"stages_completed": 2,
"stages_failed": 0
},
"intent": "Fix the authentication bug causing login failures",
"outcome": "Successfully fixed the token refresh logic",
"learnings": [
{ "category": "code", "text": "Token refresh was in the wrong module" }
],
"friction_points": [
{ "kind": "retry", "description": "First implementation attempt had an incorrect import", "stage_id": "implement" }
],
"open_items": [
{ "kind": "test_gap", "description": "No integration test for token refresh flow" }
]
}
```

15
docs/reference/architecture.mdx
View file

@ -53,22 +53,11 @@ Key server config options:
### Event streaming
The API streams run events via [Server-Sent Events (SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events):
```
GET /runs/{id}/events
```
Every significant action — stage starts, LLM calls, tool invocations, edge selections — is emitted as a structured JSON event. The web UI uses this endpoint for real-time run monitoring. Any HTTP client that supports SSE can subscribe.
The API streams run events via [Server-Sent Events (SSE)](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events). Every significant action — stage starts, LLM calls, tool invocations, edge selections — is emitted as a structured JSON event. The web UI uses this endpoint for real-time run monitoring. Any HTTP client that supports SSE can subscribe. See the [run events endpoint](/api-reference/runs#get-events) in the API reference.
### Human-in-the-loop
In API mode, human-in-the-loop questions are served over HTTP instead of terminal prompts:
- `GET /runs/{id}/questions` — Poll for pending questions
- `POST /runs/{id}/questions/{qid}/answer` — Submit an answer
The engine blocks the current stage until the answer is received, then continues execution.
In API mode, human-in-the-loop questions are served over HTTP instead of terminal prompts. The engine blocks the current stage until an answer is received, then continues execution. See the [Human-in-the-Loop API reference](/api-reference/human-in-the-loop) for the polling and answer submission endpoints.
### Authentication

7
packages/arc-api-client/src/.openapi-generator/FILES
View file

@ -19,9 +19,10 @@ index.ts
models/aggregate-usage.ts
models/api-question-option.ts
models/api-question.ts
models/assistant-stage-turn.ts
models/assistant-turn.ts
models/branch.ts
models/cancel-run200-response.ts
models/cancel-run-response.ts
models/check-run-status.ts
models/check-run.ts
models/control-detail.ts
@ -90,9 +91,11 @@ models/stage-turn.ts
models/start-run-request.ts
models/start-run-response.ts
models/steer-request.ts
models/steer-run200-response.ts
models/steer-run-response.ts
models/submit-answer-request.ts
models/submit-answer-response.ts
models/system-stage-turn.ts
models/tool-stage-turn.ts
models/tool-turn.ts
models/tool-use.ts
models/usage-by-model.ts

8
packages/arc-api-client/src/api/discovery-api.ts
View file

@ -35,7 +35,7 @@ import type { UserResponse } from '../models';
export const DiscoveryApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Returns service health status. Used by load balancers and monitoring.
* @summary Health Check
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -171,7 +171,7 @@ export const DiscoveryApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = DiscoveryApiAxiosParamCreator(configuration)
return {
/**
*
* Returns service health status. Used by load balancers and monitoring.
* @summary Health Check
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -228,7 +228,7 @@ export const DiscoveryApiFactory = function (configuration?: Configuration, base
const localVarFp = DiscoveryApiFp(configuration)
return {
/**
*
* Returns service health status. Used by load balancers and monitoring.
* @summary Health Check
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -271,7 +271,7 @@ export const DiscoveryApiFactory = function (configuration?: Configuration, base
*/
export class DiscoveryApi extends BaseAPI {
/**
*
* Returns service health status. Used by load balancers and monitoring.
* @summary Health Check
* @param {*} [options] Override http request option.
* @throws {RequiredError}

78
packages/arc-api-client/src/api/human-in-the-loop-api.ts
View file

@ -32,7 +32,7 @@ import type { PreviewUrlResponse } from '../models';
// @ts-ignore
import type { SteerRequest } from '../models';
// @ts-ignore
import type { SteerRun200Response } from '../models';
import type { SteerRunResponse } from '../models';
// @ts-ignore
import type { SubmitAnswerRequest } from '../models';
// @ts-ignore
@ -43,9 +43,9 @@ import type { SubmitAnswerResponse } from '../models';
export const HumanInTheLoopApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Generates a time-limited preview URL for a port exposed by the run\'s sandbox environment.
* @summary Preview URL
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {PreviewUrlRequest} previewUrlRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -89,9 +89,9 @@ export const HumanInTheLoopApiAxiosParamCreator = function (configuration?: Conf
};
},
/**
*
* Returns pending human-in-the-loop questions for a run. Questions are generated when the workflow needs user input to proceed.
* @summary List Run Questions
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -130,9 +130,9 @@ export const HumanInTheLoopApiAxiosParamCreator = function (configuration?: Conf
};
},
/**
*
* Sends inline guidance to a running agent, targeting a specific file and line. The guidance is delivered asynchronously.
* @summary Steer Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {SteerRequest} steerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -176,10 +176,10 @@ export const HumanInTheLoopApiAxiosParamCreator = function (configuration?: Conf
};
},
/**
*
* Submits an answer to a pending question. The answer can be freeform text or a selected option key, depending on the question type.
* @summary Submit Run Answer
* @param {string} id
* @param {string} qid
* @param {string} id Unique run identifier (ULID).
* @param {string} qid Unique identifier of a pending question.
* @param {SubmitAnswerRequest} submitAnswerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -235,9 +235,9 @@ export const HumanInTheLoopApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = HumanInTheLoopApiAxiosParamCreator(configuration)
return {
/**
*
* Generates a time-limited preview URL for a port exposed by the run\'s sandbox environment.
* @summary Preview URL
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {PreviewUrlRequest} previewUrlRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -249,9 +249,9 @@ export const HumanInTheLoopApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns pending human-in-the-loop questions for a run. Questions are generated when the workflow needs user input to proceed.
* @summary List Run Questions
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -262,24 +262,24 @@ export const HumanInTheLoopApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Sends inline guidance to a running agent, targeting a specific file and line. The guidance is delivered asynchronously.
* @summary Steer Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {SteerRequest} steerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async steerRun(id: string, steerRequest: SteerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SteerRun200Response>> {
async steerRun(id: string, steerRequest: SteerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SteerRunResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.steerRun(id, steerRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['HumanInTheLoopApi.steerRun']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Submits an answer to a pending question. The answer can be freeform text or a selected option key, depending on the question type.
* @summary Submit Run Answer
* @param {string} id
* @param {string} qid
* @param {string} id Unique run identifier (ULID).
* @param {string} qid Unique identifier of a pending question.
* @param {SubmitAnswerRequest} submitAnswerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -300,9 +300,9 @@ export const HumanInTheLoopApiFactory = function (configuration?: Configuration,
const localVarFp = HumanInTheLoopApiFp(configuration)
return {
/**
*
* Generates a time-limited preview URL for a port exposed by the run\'s sandbox environment.
* @summary Preview URL
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {PreviewUrlRequest} previewUrlRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -311,9 +311,9 @@ export const HumanInTheLoopApiFactory = function (configuration?: Configuration,
return localVarFp.generatePreviewUrl(id, previewUrlRequest, options).then((request) => request(axios, basePath));
},
/**
*
* Returns pending human-in-the-loop questions for a run. Questions are generated when the workflow needs user input to proceed.
* @summary List Run Questions
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -321,21 +321,21 @@ export const HumanInTheLoopApiFactory = function (configuration?: Configuration,
return localVarFp.listRunQuestions(id, options).then((request) => request(axios, basePath));
},
/**
*
* Sends inline guidance to a running agent, targeting a specific file and line. The guidance is delivered asynchronously.
* @summary Steer Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {SteerRequest} steerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
steerRun(id: string, steerRequest: SteerRequest, options?: RawAxiosRequestConfig): AxiosPromise<SteerRun200Response> {
steerRun(id: string, steerRequest: SteerRequest, options?: RawAxiosRequestConfig): AxiosPromise<SteerRunResponse> {
return localVarFp.steerRun(id, steerRequest, options).then((request) => request(axios, basePath));
},
/**
*
* Submits an answer to a pending question. The answer can be freeform text or a selected option key, depending on the question type.
* @summary Submit Run Answer
* @param {string} id
* @param {string} qid
* @param {string} id Unique run identifier (ULID).
* @param {string} qid Unique identifier of a pending question.
* @param {SubmitAnswerRequest} submitAnswerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -351,9 +351,9 @@ export const HumanInTheLoopApiFactory = function (configuration?: Configuration,
*/
export class HumanInTheLoopApi extends BaseAPI {
/**
*
* Generates a time-limited preview URL for a port exposed by the run\'s sandbox environment.
* @summary Preview URL
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {PreviewUrlRequest} previewUrlRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -363,9 +363,9 @@ export class HumanInTheLoopApi extends BaseAPI {
}
/**
*
* Returns pending human-in-the-loop questions for a run. Questions are generated when the workflow needs user input to proceed.
* @summary List Run Questions
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -374,9 +374,9 @@ export class HumanInTheLoopApi extends BaseAPI {
}
/**
*
* Sends inline guidance to a running agent, targeting a specific file and line. The guidance is delivered asynchronously.
* @summary Steer Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {SteerRequest} steerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -386,10 +386,10 @@ export class HumanInTheLoopApi extends BaseAPI {
}
/**
*
* Submits an answer to a pending question. The answer can be freeform text or a selected option key, depending on the question type.
* @summary Submit Run Answer
* @param {string} id
* @param {string} qid
* @param {string} id Unique run identifier (ULID).
* @param {string} qid Unique identifier of a pending question.
* @param {SubmitAnswerRequest} submitAnswerRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}

96
packages/arc-api-client/src/api/insights-api.ts
View file

@ -41,7 +41,7 @@ import type { SavedQuery } from '../models';
export const InsightsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Saves a new named SQL query for later reuse.
* @summary Create Saved Query
* @param {SaveQueryRequest} saveQueryRequest
* @param {*} [options] Override http request option.
@ -83,9 +83,9 @@ export const InsightsApiAxiosParamCreator = function (configuration?: Configurat
};
},
/**
*
* Permanently removes a saved query.
* @summary Delete Saved Query
* @param {string} id
* @param {string} id Unique identifier of a saved query.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -124,7 +124,7 @@ export const InsightsApiAxiosParamCreator = function (configuration?: Configurat
};
},
/**
*
* Executes an ad-hoc SQL query against the analytics database and returns columnar results.
* @summary Execute Query
* @param {ExecuteQueryRequest} executeQueryRequest
* @param {*} [options] Override http request option.
@ -166,10 +166,10 @@ export const InsightsApiAxiosParamCreator = function (configuration?: Configurat
};
},
/**
*
* Returns a paginated history of recently executed queries with timing and row counts.
* @summary List Query History
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -213,10 +213,10 @@ export const InsightsApiAxiosParamCreator = function (configuration?: Configurat
};
},
/**
*
* Returns a paginated list of saved SQL queries for the insights editor.
* @summary List Saved Queries
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -260,9 +260,9 @@ export const InsightsApiAxiosParamCreator = function (configuration?: Configurat
};
},
/**
*
* Replaces the name and SQL of an existing saved query.
* @summary Update Saved Query
* @param {string} id
* @param {string} id Unique identifier of a saved query.
* @param {SaveQueryRequest} saveQueryRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -315,7 +315,7 @@ export const InsightsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = InsightsApiAxiosParamCreator(configuration)
return {
/**
*
* Saves a new named SQL query for later reuse.
* @summary Create Saved Query
* @param {SaveQueryRequest} saveQueryRequest
* @param {*} [options] Override http request option.
@ -328,9 +328,9 @@ export const InsightsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Permanently removes a saved query.
* @summary Delete Saved Query
* @param {string} id
* @param {string} id Unique identifier of a saved query.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -341,7 +341,7 @@ export const InsightsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Executes an ad-hoc SQL query against the analytics database and returns columnar results.
* @summary Execute Query
* @param {ExecuteQueryRequest} executeQueryRequest
* @param {*} [options] Override http request option.
@ -354,10 +354,10 @@ export const InsightsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns a paginated history of recently executed queries with timing and row counts.
* @summary List Query History
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -368,10 +368,10 @@ export const InsightsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns a paginated list of saved SQL queries for the insights editor.
* @summary List Saved Queries
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -382,9 +382,9 @@ export const InsightsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Replaces the name and SQL of an existing saved query.
* @summary Update Saved Query
* @param {string} id
* @param {string} id Unique identifier of a saved query.
* @param {SaveQueryRequest} saveQueryRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -405,7 +405,7 @@ export const InsightsApiFactory = function (configuration?: Configuration, baseP
const localVarFp = InsightsApiFp(configuration)
return {
/**
*
* Saves a new named SQL query for later reuse.
* @summary Create Saved Query
* @param {SaveQueryRequest} saveQueryRequest
* @param {*} [options] Override http request option.
@ -415,9 +415,9 @@ export const InsightsApiFactory = function (configuration?: Configuration, baseP
return localVarFp.createSavedQuery(saveQueryRequest, options).then((request) => request(axios, basePath));
},
/**
*
* Permanently removes a saved query.
* @summary Delete Saved Query
* @param {string} id
* @param {string} id Unique identifier of a saved query.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -425,7 +425,7 @@ export const InsightsApiFactory = function (configuration?: Configuration, baseP
return localVarFp.deleteSavedQuery(id, options).then((request) => request(axios, basePath));
},
/**
*
* Executes an ad-hoc SQL query against the analytics database and returns columnar results.
* @summary Execute Query
* @param {ExecuteQueryRequest} executeQueryRequest
* @param {*} [options] Override http request option.
@ -435,10 +435,10 @@ export const InsightsApiFactory = function (configuration?: Configuration, baseP
return localVarFp.executeQuery(executeQueryRequest, options).then((request) => request(axios, basePath));
},
/**
*
* Returns a paginated history of recently executed queries with timing and row counts.
* @summary List Query History
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -446,10 +446,10 @@ export const InsightsApiFactory = function (configuration?: Configuration, baseP
return localVarFp.listQueryHistory(pageLimit, pageOffset, options).then((request) => request(axios, basePath));
},
/**
*
* Returns a paginated list of saved SQL queries for the insights editor.
* @summary List Saved Queries
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -457,9 +457,9 @@ export const InsightsApiFactory = function (configuration?: Configuration, baseP
return localVarFp.listSavedQueries(pageLimit, pageOffset, options).then((request) => request(axios, basePath));
},
/**
*
* Replaces the name and SQL of an existing saved query.
* @summary Update Saved Query
* @param {string} id
* @param {string} id Unique identifier of a saved query.
* @param {SaveQueryRequest} saveQueryRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -475,7 +475,7 @@ export const InsightsApiFactory = function (configuration?: Configuration, baseP
*/
export class InsightsApi extends BaseAPI {
/**
*
* Saves a new named SQL query for later reuse.
* @summary Create Saved Query
* @param {SaveQueryRequest} saveQueryRequest
* @param {*} [options] Override http request option.
@ -486,9 +486,9 @@ export class InsightsApi extends BaseAPI {
}
/**
*
* Permanently removes a saved query.
* @summary Delete Saved Query
* @param {string} id
* @param {string} id Unique identifier of a saved query.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -497,7 +497,7 @@ export class InsightsApi extends BaseAPI {
}
/**
*
* Executes an ad-hoc SQL query against the analytics database and returns columnar results.
* @summary Execute Query
* @param {ExecuteQueryRequest} executeQueryRequest
* @param {*} [options] Override http request option.
@ -508,10 +508,10 @@ export class InsightsApi extends BaseAPI {
}
/**
*
* Returns a paginated history of recently executed queries with timing and row counts.
* @summary List Query History
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -520,10 +520,10 @@ export class InsightsApi extends BaseAPI {
}
/**
*
* Returns a paginated list of saved SQL queries for the insights editor.
* @summary List Saved Queries
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -532,9 +532,9 @@ export class InsightsApi extends BaseAPI {
}
/**
*
* Replaces the name and SQL of an existing saved query.
* @summary Update Saved Query
* @param {string} id
* @param {string} id Unique identifier of a saved query.
* @param {SaveQueryRequest} saveQueryRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}

56
packages/arc-api-client/src/api/projects-api.ts
View file

@ -33,11 +33,11 @@ import type { PaginatedProjectList } from '../models';
export const ProjectsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Returns a paginated list of branches for a specific project.
* @summary List Branches
* @param {string} id
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} id Unique identifier of a project (repository).
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -84,10 +84,10 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
};
},
/**
*
* Returns a paginated list of registered projects (repositories).
* @summary List Projects
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -140,11 +140,11 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = ProjectsApiAxiosParamCreator(configuration)
return {
/**
*
* Returns a paginated list of branches for a specific project.
* @summary List Branches
* @param {string} id
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} id Unique identifier of a project (repository).
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -155,10 +155,10 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns a paginated list of registered projects (repositories).
* @summary List Projects
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -178,11 +178,11 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
const localVarFp = ProjectsApiFp(configuration)
return {
/**
*
* Returns a paginated list of branches for a specific project.
* @summary List Branches
* @param {string} id
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} id Unique identifier of a project (repository).
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -190,10 +190,10 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
return localVarFp.listBranches(id, pageLimit, pageOffset, options).then((request) => request(axios, basePath));
},
/**
*
* Returns a paginated list of registered projects (repositories).
* @summary List Projects
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -208,11 +208,11 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
*/
export class ProjectsApi extends BaseAPI {
/**
*
* Returns a paginated list of branches for a specific project.
* @summary List Branches
* @param {string} id
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} id Unique identifier of a project (repository).
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -221,10 +221,10 @@ export class ProjectsApi extends BaseAPI {
}
/**
*
* Returns a paginated list of registered projects (repositories).
* @summary List Projects
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/

40
packages/arc-api-client/src/api/retros-api.ts
View file

@ -31,10 +31,10 @@ import type { PaginatedRetroList } from '../models';
export const RetrosApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Returns a paginated list of run retrospectives ordered by recency, with smoothness ratings and summary statistics.
* @summary List Retros
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -78,9 +78,9 @@ export const RetrosApiAxiosParamCreator = function (configuration?: Configuratio
};
},
/**
*
* Returns the retrospective analysis for a completed run, or null if the retro has not been generated yet.
* @summary Retrieve Retro
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -128,10 +128,10 @@ export const RetrosApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = RetrosApiAxiosParamCreator(configuration)
return {
/**
*
* Returns a paginated list of run retrospectives ordered by recency, with smoothness ratings and summary statistics.
* @summary List Retros
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -142,9 +142,9 @@ export const RetrosApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns the retrospective analysis for a completed run, or null if the retro has not been generated yet.
* @summary Retrieve Retro
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -164,10 +164,10 @@ export const RetrosApiFactory = function (configuration?: Configuration, basePat
const localVarFp = RetrosApiFp(configuration)
return {
/**
*
* Returns a paginated list of run retrospectives ordered by recency, with smoothness ratings and summary statistics.
* @summary List Retros
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -175,9 +175,9 @@ export const RetrosApiFactory = function (configuration?: Configuration, basePat
return localVarFp.listRetros(pageLimit, pageOffset, options).then((request) => request(axios, basePath));
},
/**
*
* Returns the retrospective analysis for a completed run, or null if the retro has not been generated yet.
* @summary Retrieve Retro
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -192,10 +192,10 @@ export const RetrosApiFactory = function (configuration?: Configuration, basePat
*/
export class RetrosApi extends BaseAPI {
/**
*
* Returns a paginated list of run retrospectives ordered by recency, with smoothness ratings and summary statistics.
* @summary List Retros
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -204,9 +204,9 @@ export class RetrosApi extends BaseAPI {
}
/**
*
* Returns the retrospective analysis for a completed run, or null if the retro has not been generated yet.
* @summary Retrieve Retro
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/

104
packages/arc-api-client/src/api/run-internals-api.ts
View file

@ -33,9 +33,9 @@ import type { PaginatedStageTurnList } from '../models';
export const RunInternalsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Returns the ordered list of stages in a run\'s workflow graph with their current status and timing.
* @summary List Run Stages
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -74,12 +74,12 @@ export const RunInternalsApiAxiosParamCreator = function (configuration?: Config
};
},
/**
*
* Returns a paginated list of conversation turns within a specific stage, including system prompts, assistant responses, and tool invocations.
* @summary List Stage Turns
* @param {string} id
* @param {string} stageId
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} id Unique run identifier (ULID).
* @param {string} stageId Identifier of a stage within a run\&#39;s workflow graph.
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -129,9 +129,9 @@ export const RunInternalsApiAxiosParamCreator = function (configuration?: Config
};
},
/**
*
* Returns the latest checkpoint data for a run, or null if no checkpoint has been recorded yet.
* @summary Retrieve Run Checkpoint
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -170,9 +170,9 @@ export const RunInternalsApiAxiosParamCreator = function (configuration?: Config
};
},
/**
*
* Returns the TOML configuration file content used to launch this run.
* @summary Retrieve Run Configuration
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -211,9 +211,9 @@ export const RunInternalsApiAxiosParamCreator = function (configuration?: Config
};
},
/**
*
* Returns the key-value context map accumulated during the run. Empty if the run has not started.
* @summary Retrieve Run Context
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -261,9 +261,9 @@ export const RunInternalsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = RunInternalsApiAxiosParamCreator(configuration)
return {
/**
*
* Returns the ordered list of stages in a run\'s workflow graph with their current status and timing.
* @summary List Run Stages
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -274,12 +274,12 @@ export const RunInternalsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns a paginated list of conversation turns within a specific stage, including system prompts, assistant responses, and tool invocations.
* @summary List Stage Turns
* @param {string} id
* @param {string} stageId
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} id Unique run identifier (ULID).
* @param {string} stageId Identifier of a stage within a run\&#39;s workflow graph.
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -290,9 +290,9 @@ export const RunInternalsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns the latest checkpoint data for a run, or null if no checkpoint has been recorded yet.
* @summary Retrieve Run Checkpoint
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -303,9 +303,9 @@ export const RunInternalsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns the TOML configuration file content used to launch this run.
* @summary Retrieve Run Configuration
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -316,9 +316,9 @@ export const RunInternalsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns the key-value context map accumulated during the run. Empty if the run has not started.
* @summary Retrieve Run Context
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -338,9 +338,9 @@ export const RunInternalsApiFactory = function (configuration?: Configuration, b
const localVarFp = RunInternalsApiFp(configuration)
return {
/**
*
* Returns the ordered list of stages in a run\'s workflow graph with their current status and timing.
* @summary List Run Stages
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -348,12 +348,12 @@ export const RunInternalsApiFactory = function (configuration?: Configuration, b
return localVarFp.listRunStages(id, options).then((request) => request(axios, basePath));
},
/**
*
* Returns a paginated list of conversation turns within a specific stage, including system prompts, assistant responses, and tool invocations.
* @summary List Stage Turns
* @param {string} id
* @param {string} stageId
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} id Unique run identifier (ULID).
* @param {string} stageId Identifier of a stage within a run\&#39;s workflow graph.
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -361,9 +361,9 @@ export const RunInternalsApiFactory = function (configuration?: Configuration, b
return localVarFp.listStageTurns(id, stageId, pageLimit, pageOffset, options).then((request) => request(axios, basePath));
},
/**
*
* Returns the latest checkpoint data for a run, or null if no checkpoint has been recorded yet.
* @summary Retrieve Run Checkpoint
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -371,9 +371,9 @@ export const RunInternalsApiFactory = function (configuration?: Configuration, b
return localVarFp.retrieveRunCheckpoint(id, options).then((request) => request(axios, basePath));
},
/**
*
* Returns the TOML configuration file content used to launch this run.
* @summary Retrieve Run Configuration
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -381,9 +381,9 @@ export const RunInternalsApiFactory = function (configuration?: Configuration, b
return localVarFp.retrieveRunConfiguration(id, options).then((request) => request(axios, basePath));
},
/**
*
* Returns the key-value context map accumulated during the run. Empty if the run has not started.
* @summary Retrieve Run Context
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -398,9 +398,9 @@ export const RunInternalsApiFactory = function (configuration?: Configuration, b
*/
export class RunInternalsApi extends BaseAPI {
/**
*
* Returns the ordered list of stages in a run\'s workflow graph with their current status and timing.
* @summary List Run Stages
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -409,12 +409,12 @@ export class RunInternalsApi extends BaseAPI {
}
/**
*
* Returns a paginated list of conversation turns within a specific stage, including system prompts, assistant responses, and tool invocations.
* @summary List Stage Turns
* @param {string} id
* @param {string} stageId
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} id Unique run identifier (ULID).
* @param {string} stageId Identifier of a stage within a run\&#39;s workflow graph.
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -423,9 +423,9 @@ export class RunInternalsApi extends BaseAPI {
}
/**
*
* Returns the latest checkpoint data for a run, or null if no checkpoint has been recorded yet.
* @summary Retrieve Run Checkpoint
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -434,9 +434,9 @@ export class RunInternalsApi extends BaseAPI {
}
/**
*
* Returns the TOML configuration file content used to launch this run.
* @summary Retrieve Run Configuration
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -445,9 +445,9 @@ export class RunInternalsApi extends BaseAPI {
}
/**
*
* Returns the key-value context map accumulated during the run. Empty if the run has not started.
* @summary Retrieve Run Context
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/

56
packages/arc-api-client/src/api/run-outputs-api.ts
View file

@ -35,10 +35,10 @@ import type { RunUsage } from '../models';
export const RunOutputsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Returns file-level diffs produced by the run, optionally filtered to a specific checkpoint.
* @summary List Run Compare
* @param {string} id
* @param {string} [checkpoint]
* @param {string} id Unique run identifier (ULID).
* @param {string} [checkpoint] Filter file diffs to a specific checkpoint. Defaults to all changes.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -81,9 +81,9 @@ export const RunOutputsApiAxiosParamCreator = function (configuration?: Configur
};
},
/**
*
* Returns verification results for a run, organized by category with individual control statuses.
* @summary List Run Verifications
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -122,9 +122,9 @@ export const RunOutputsApiAxiosParamCreator = function (configuration?: Configur
};
},
/**
*
* Returns token and cost usage broken down by stage and model for a specific run.
* @summary Retrieve Run Usage
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -172,10 +172,10 @@ export const RunOutputsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = RunOutputsApiAxiosParamCreator(configuration)
return {
/**
*
* Returns file-level diffs produced by the run, optionally filtered to a specific checkpoint.
* @summary List Run Compare
* @param {string} id
* @param {string} [checkpoint]
* @param {string} id Unique run identifier (ULID).
* @param {string} [checkpoint] Filter file diffs to a specific checkpoint. Defaults to all changes.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -186,9 +186,9 @@ export const RunOutputsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns verification results for a run, organized by category with individual control statuses.
* @summary List Run Verifications
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -199,9 +199,9 @@ export const RunOutputsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns token and cost usage broken down by stage and model for a specific run.
* @summary Retrieve Run Usage
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -221,10 +221,10 @@ export const RunOutputsApiFactory = function (configuration?: Configuration, bas
const localVarFp = RunOutputsApiFp(configuration)
return {
/**
*
* Returns file-level diffs produced by the run, optionally filtered to a specific checkpoint.
* @summary List Run Compare
* @param {string} id
* @param {string} [checkpoint]
* @param {string} id Unique run identifier (ULID).
* @param {string} [checkpoint] Filter file diffs to a specific checkpoint. Defaults to all changes.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -232,9 +232,9 @@ export const RunOutputsApiFactory = function (configuration?: Configuration, bas
return localVarFp.listRunCompare(id, checkpoint, options).then((request) => request(axios, basePath));
},
/**
*
* Returns verification results for a run, organized by category with individual control statuses.
* @summary List Run Verifications
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -242,9 +242,9 @@ export const RunOutputsApiFactory = function (configuration?: Configuration, bas
return localVarFp.listRunVerifications(id, options).then((request) => request(axios, basePath));
},
/**
*
* Returns token and cost usage broken down by stage and model for a specific run.
* @summary Retrieve Run Usage
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -259,10 +259,10 @@ export const RunOutputsApiFactory = function (configuration?: Configuration, bas
*/
export class RunOutputsApi extends BaseAPI {
/**
*
* Returns file-level diffs produced by the run, optionally filtered to a specific checkpoint.
* @summary List Run Compare
* @param {string} id
* @param {string} [checkpoint]
* @param {string} id Unique run identifier (ULID).
* @param {string} [checkpoint] Filter file diffs to a specific checkpoint. Defaults to all changes.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -271,9 +271,9 @@ export class RunOutputsApi extends BaseAPI {
}
/**
*
* Returns verification results for a run, organized by category with individual control statuses.
* @summary List Run Verifications
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -282,9 +282,9 @@ export class RunOutputsApi extends BaseAPI {
}
/**
*
* Returns token and cost usage broken down by stage and model for a specific run.
* @summary Retrieve Run Usage
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/

102
packages/arc-api-client/src/api/runs-api.ts
View file

@ -22,7 +22,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
// @ts-ignore
import type { CancelRun200Response } from '../models';
import type { CancelRunResponse } from '../models';
// @ts-ignore
import type { ErrorResponse } from '../models';
// @ts-ignore
@ -39,9 +39,9 @@ import type { StartRunResponse } from '../models';
export const RunsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Cancels a running or queued run. Returns 409 if the run has already completed or been cancelled.
* @summary Cancel Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -80,10 +80,10 @@ export const RunsApiAxiosParamCreator = function (configuration?: Configuration)
};
},
/**
*
* Returns a paginated list of runs for the board view, ordered by recency.
* @summary List Runs
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -127,9 +127,9 @@ export const RunsApiAxiosParamCreator = function (configuration?: Configuration)
};
},
/**
*
* Returns the current status of a run, including error details and queue position if applicable.
* @summary Retrieve Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -168,9 +168,9 @@ export const RunsApiAxiosParamCreator = function (configuration?: Configuration)
};
},
/**
*
* Renders the workflow graph as an SVG image using Graphviz.
* @summary Render SVG
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -209,7 +209,7 @@ export const RunsApiAxiosParamCreator = function (configuration?: Configuration)
};
},
/**
*
* Queues a new workflow run from a DOT graph source. The run is created in `queued` status and will be picked up by the scheduler.
* @summary Start Run
* @param {StartRunRequest} startRunRequest
* @param {*} [options] Override http request option.
@ -251,9 +251,9 @@ export const RunsApiAxiosParamCreator = function (configuration?: Configuration)
};
},
/**
*
* Opens a server-sent event (SSE) stream for real-time run updates. Returns 410 if the stream has been closed.
* @summary Stream Run Events
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -301,23 +301,23 @@ export const RunsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = RunsApiAxiosParamCreator(configuration)
return {
/**
*
* Cancels a running or queued run. Returns 409 if the run has already completed or been cancelled.
* @summary Cancel Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async cancelRun(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelRun200Response>> {
async cancelRun(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelRunResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelRun(id, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['RunsApi.cancelRun']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns a paginated list of runs for the board view, ordered by recency.
* @summary List Runs
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -328,9 +328,9 @@ export const RunsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns the current status of a run, including error details and queue position if applicable.
* @summary Retrieve Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -341,9 +341,9 @@ export const RunsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Renders the workflow graph as an SVG image using Graphviz.
* @summary Render SVG
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -354,7 +354,7 @@ export const RunsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Queues a new workflow run from a DOT graph source. The run is created in `queued` status and will be picked up by the scheduler.
* @summary Start Run
* @param {StartRunRequest} startRunRequest
* @param {*} [options] Override http request option.
@ -367,9 +367,9 @@ export const RunsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Opens a server-sent event (SSE) stream for real-time run updates. Returns 410 if the stream has been closed.
* @summary Stream Run Events
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -389,20 +389,20 @@ export const RunsApiFactory = function (configuration?: Configuration, basePath?
const localVarFp = RunsApiFp(configuration)
return {
/**
*
* Cancels a running or queued run. Returns 409 if the run has already completed or been cancelled.
* @summary Cancel Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelRun(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CancelRun200Response> {
cancelRun(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CancelRunResponse> {
return localVarFp.cancelRun(id, options).then((request) => request(axios, basePath));
},
/**
*
* Returns a paginated list of runs for the board view, ordered by recency.
* @summary List Runs
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -410,9 +410,9 @@ export const RunsApiFactory = function (configuration?: Configuration, basePath?
return localVarFp.listRuns(pageLimit, pageOffset, options).then((request) => request(axios, basePath));
},
/**
*
* Returns the current status of a run, including error details and queue position if applicable.
* @summary Retrieve Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -420,9 +420,9 @@ export const RunsApiFactory = function (configuration?: Configuration, basePath?
return localVarFp.retrieveRun(id, options).then((request) => request(axios, basePath));
},
/**
*
* Renders the workflow graph as an SVG image using Graphviz.
* @summary Render SVG
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -430,7 +430,7 @@ export const RunsApiFactory = function (configuration?: Configuration, basePath?
return localVarFp.retrieveRunSvg(id, options).then((request) => request(axios, basePath));
},
/**
*
* Queues a new workflow run from a DOT graph source. The run is created in `queued` status and will be picked up by the scheduler.
* @summary Start Run
* @param {StartRunRequest} startRunRequest
* @param {*} [options] Override http request option.
@ -440,9 +440,9 @@ export const RunsApiFactory = function (configuration?: Configuration, basePath?
return localVarFp.startRun(startRunRequest, options).then((request) => request(axios, basePath));
},
/**
*
* Opens a server-sent event (SSE) stream for real-time run updates. Returns 410 if the stream has been closed.
* @summary Stream Run Events
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -457,9 +457,9 @@ export const RunsApiFactory = function (configuration?: Configuration, basePath?
*/
export class RunsApi extends BaseAPI {
/**
*
* Cancels a running or queued run. Returns 409 if the run has already completed or been cancelled.
* @summary Cancel Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -468,10 +468,10 @@ export class RunsApi extends BaseAPI {
}
/**
*
* Returns a paginated list of runs for the board view, ordered by recency.
* @summary List Runs
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -480,9 +480,9 @@ export class RunsApi extends BaseAPI {
}
/**
*
* Returns the current status of a run, including error details and queue position if applicable.
* @summary Retrieve Run
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -491,9 +491,9 @@ export class RunsApi extends BaseAPI {
}
/**
*
* Renders the workflow graph as an SVG image using Graphviz.
* @summary Render SVG
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -502,7 +502,7 @@ export class RunsApi extends BaseAPI {
}
/**
*
* Queues a new workflow run from a DOT graph source. The run is created in `queued` status and will be picked up by the scheduler.
* @summary Start Run
* @param {StartRunRequest} startRunRequest
* @param {*} [options] Override http request option.
@ -513,9 +513,9 @@ export class RunsApi extends BaseAPI {
}
/**
*
* Opens a server-sent event (SSE) stream for real-time run updates. Returns 410 if the stream has been closed.
* @summary Stream Run Events
* @param {string} id
* @param {string} id Unique run identifier (ULID).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/

16
packages/arc-api-client/src/api/sessions-api.ts
View file

@ -85,8 +85,8 @@ export const SessionsApiAxiosParamCreator = function (configuration?: Configurat
/**
* Returns sessions ordered by recency (newest first).
* @summary List Sessions
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -286,8 +286,8 @@ export const SessionsApiFp = function(configuration?: Configuration) {
/**
* Returns sessions ordered by recency (newest first).
* @summary List Sessions
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -360,8 +360,8 @@ export const SessionsApiFactory = function (configuration?: Configuration, baseP
/**
* Returns sessions ordered by recency (newest first).
* @summary List Sessions
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -421,8 +421,8 @@ export class SessionsApi extends BaseAPI {
/**
* Returns sessions ordered by recency (newest first).
* @summary List Sessions
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/

8
packages/arc-api-client/src/api/settings-api.ts
View file

@ -29,7 +29,7 @@ import type { SettingGroup } from '../models';
export const SettingsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Returns all server settings organized into groups. Each group contains fields with their current values and input types.
* @summary Retrieve Server Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -75,7 +75,7 @@ export const SettingsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = SettingsApiAxiosParamCreator(configuration)
return {
/**
*
* Returns all server settings organized into groups. Each group contains fields with their current values and input types.
* @summary Retrieve Server Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -96,7 +96,7 @@ export const SettingsApiFactory = function (configuration?: Configuration, baseP
const localVarFp = SettingsApiFp(configuration)
return {
/**
*
* Returns all server settings organized into groups. Each group contains fields with their current values and input types.
* @summary Retrieve Server Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -112,7 +112,7 @@ export const SettingsApiFactory = function (configuration?: Configuration, baseP
*/
export class SettingsApi extends BaseAPI {
/**
*
* Returns all server settings organized into groups. Each group contains fields with their current values and input types.
* @summary Retrieve Server Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}

24
packages/arc-api-client/src/api/verifications-api.ts
View file

@ -33,7 +33,7 @@ import type { VerificationDetailResponse } from '../models';
export const VerificationsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Returns all verification categories with their controls and performance metrics.
* @summary List Verifications
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -70,9 +70,9 @@ export const VerificationsApiAxiosParamCreator = function (configuration?: Confi
};
},
/**
*
* Returns detailed information about a specific verification control, including performance data, recent results, and sibling controls in the same category.
* @summary Retrieve Verification
* @param {string} slug
* @param {string} slug URL-safe slug identifying a verification control.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -120,7 +120,7 @@ export const VerificationsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = VerificationsApiAxiosParamCreator(configuration)
return {
/**
*
* Returns all verification categories with their controls and performance metrics.
* @summary List Verifications
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -132,9 +132,9 @@ export const VerificationsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns detailed information about a specific verification control, including performance data, recent results, and sibling controls in the same category.
* @summary Retrieve Verification
* @param {string} slug
* @param {string} slug URL-safe slug identifying a verification control.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -154,7 +154,7 @@ export const VerificationsApiFactory = function (configuration?: Configuration,
const localVarFp = VerificationsApiFp(configuration)
return {
/**
*
* Returns all verification categories with their controls and performance metrics.
* @summary List Verifications
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -163,9 +163,9 @@ export const VerificationsApiFactory = function (configuration?: Configuration,
return localVarFp.listVerifications(options).then((request) => request(axios, basePath));
},
/**
*
* Returns detailed information about a specific verification control, including performance data, recent results, and sibling controls in the same category.
* @summary Retrieve Verification
* @param {string} slug
* @param {string} slug URL-safe slug identifying a verification control.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -180,7 +180,7 @@ export const VerificationsApiFactory = function (configuration?: Configuration,
*/
export class VerificationsApi extends BaseAPI {
/**
*
* Returns all verification categories with their controls and performance metrics.
* @summary List Verifications
* @param {*} [options] Override http request option.
* @throws {RequiredError}
@ -190,9 +190,9 @@ export class VerificationsApi extends BaseAPI {
}
/**
*
* Returns detailed information about a specific verification control, including performance data, recent results, and sibling controls in the same category.
* @summary Retrieve Verification
* @param {string} slug
* @param {string} slug URL-safe slug identifying a verification control.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/

88
packages/arc-api-client/src/api/workflows-api.ts
View file

@ -37,11 +37,11 @@ import type { WorkflowDetail } from '../models';
export const WorkflowsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* Returns a paginated list of runs filtered to a specific workflow.
* @summary List Workflow Runs
* @param {string} name
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -88,10 +88,10 @@ export const WorkflowsApiAxiosParamCreator = function (configuration?: Configura
};
},
/**
*
* Returns a paginated list of workflow definitions available for execution.
* @summary List Workflows
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -135,9 +135,9 @@ export const WorkflowsApiAxiosParamCreator = function (configuration?: Configura
};
},
/**
*
* Returns the full detail of a workflow including its DOT graph, TOML config, and description.
* @summary Retrieve Workflow
* @param {string} name
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -176,9 +176,9 @@ export const WorkflowsApiAxiosParamCreator = function (configuration?: Configura
};
},
/**
*
* Queues a new run of the specified workflow using its stored DOT graph.
* @summary Start Workflow Run
* @param {string} name
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -226,11 +226,11 @@ export const WorkflowsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = WorkflowsApiAxiosParamCreator(configuration)
return {
/**
*
* Returns a paginated list of runs filtered to a specific workflow.
* @summary List Workflow Runs
* @param {string} name
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -241,10 +241,10 @@ export const WorkflowsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns a paginated list of workflow definitions available for execution.
* @summary List Workflows
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -255,9 +255,9 @@ export const WorkflowsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Returns the full detail of a workflow including its DOT graph, TOML config, and description.
* @summary Retrieve Workflow
* @param {string} name
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -268,9 +268,9 @@ export const WorkflowsApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* Queues a new run of the specified workflow using its stored DOT graph.
* @summary Start Workflow Run
* @param {string} name
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -290,11 +290,11 @@ export const WorkflowsApiFactory = function (configuration?: Configuration, base
const localVarFp = WorkflowsApiFp(configuration)
return {
/**
*
* Returns a paginated list of runs filtered to a specific workflow.
* @summary List Workflow Runs
* @param {string} name
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -302,10 +302,10 @@ export const WorkflowsApiFactory = function (configuration?: Configuration, base
return localVarFp.listWorkflowRuns(name, pageLimit, pageOffset, options).then((request) => request(axios, basePath));
},
/**
*
* Returns a paginated list of workflow definitions available for execution.
* @summary List Workflows
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -313,9 +313,9 @@ export const WorkflowsApiFactory = function (configuration?: Configuration, base
return localVarFp.listWorkflows(pageLimit, pageOffset, options).then((request) => request(axios, basePath));
},
/**
*
* Returns the full detail of a workflow including its DOT graph, TOML config, and description.
* @summary Retrieve Workflow
* @param {string} name
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -323,9 +323,9 @@ export const WorkflowsApiFactory = function (configuration?: Configuration, base
return localVarFp.retrieveWorkflow(name, options).then((request) => request(axios, basePath));
},
/**
*
* Queues a new run of the specified workflow using its stored DOT graph.
* @summary Start Workflow Run
* @param {string} name
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -340,11 +340,11 @@ export const WorkflowsApiFactory = function (configuration?: Configuration, base
*/
export class WorkflowsApi extends BaseAPI {
/**
*
* Returns a paginated list of runs filtered to a specific workflow.
* @summary List Workflow Runs
* @param {string} name
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -353,10 +353,10 @@ export class WorkflowsApi extends BaseAPI {
}
/**
*
* Returns a paginated list of workflow definitions available for execution.
* @summary List Workflows
* @param {number} [pageLimit]
* @param {number} [pageOffset]
* @param {number} [pageLimit] Maximum number of items to return per page.
* @param {number} [pageOffset] Number of items to skip before returning results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -365,9 +365,9 @@ export class WorkflowsApi extends BaseAPI {
}
/**
*
* Returns the full detail of a workflow including its DOT graph, TOML config, and description.
* @summary Retrieve Workflow
* @param {string} name
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
@ -376,9 +376,9 @@ export class WorkflowsApi extends BaseAPI {
}
/**
*
* Queues a new run of the specified workflow using its stored DOT graph.
* @summary Start Workflow Run
* @param {string} name
* @param {string} name URL-safe slug identifying a workflow definition.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/

21
packages/arc-api-client/src/models/aggregate-usage.ts
View file

@ -17,12 +17,33 @@
// @ts-ignore
import type { UsageByModel } from './usage-by-model';
/**
* Aggregate token and cost usage across all runs since server start.
*/
export interface AggregateUsage {
/**
* Total number of completed runs.
*/
'total_runs': number;
/**
* Total input tokens across all runs.
*/
'total_input_tokens': number;
/**
* Total output tokens across all runs.
*/
'total_output_tokens': number;
/**
* Total cost in USD across all runs.
*/
'total_cost': number;
/**
* Total wall-clock runtime in seconds.
*/
'total_runtime_secs': number;
/**
* Usage grouped by model.
*/
'by_model': Array<UsageByModel>;
}

9
packages/arc-api-client/src/models/api-question-option.ts
View file

@ -14,8 +14,17 @@
/**
* A selectable option for a multiple-choice or multi-select question.
*/
export interface ApiQuestionOption {
/**
* Machine-readable option key used when submitting an answer.
*/
'key': string;
/**
* Human-readable label displayed to the user.
*/
'label': string;
}

15
packages/arc-api-client/src/models/api-question.ts
View file

@ -20,11 +20,26 @@ import type { ApiQuestionOption } from './api-question-option';
// @ts-ignore
import type { QuestionType } from './question-type';
/**
* A pending human-in-the-loop question generated by a workflow stage.
*/
export interface ApiQuestion {
/**
* Unique question identifier.
*/
'id': string;
/**
* The question text displayed to the user.
*/
'text': string;
'question_type': QuestionType;
/**
* Available options for selection-based questions. Empty for freeform questions.
*/
'options': Array<ApiQuestionOption>;
/**
* Whether the user may provide freeform text in addition to selecting options.
*/
'allow_freeform': boolean;
}

41
packages/arc-api-client/src/models/assistant-stage-turn.ts Normal file
View file

@ -0,0 +1,41 @@
/* tslint:disable */
/* eslint-disable */
/**
* Arc Run API
* HTTP API for managing Arc workflow run executions.
*
* The version of the OpenAPI document: 0.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
// May contain unused imports in some cases
// @ts-ignore
import type { ToolUse } from './tool-use';
/**
* An assistant response turn within a stage.
*/
export interface AssistantStageTurn {
'kind': AssistantStageTurnKindEnum;
/**
* Assistant response text.
*/
'content': string;
/**
* Tool invocations (always empty for assistant turns).
*/
'tools'?: Array<ToolUse>;
}
export const AssistantStageTurnKindEnum = {
ASSISTANT: 'assistant'
} as const;
export type AssistantStageTurnKindEnum = typeof AssistantStageTurnKindEnum[keyof typeof AssistantStageTurnKindEnum];

9
packages/arc-api-client/src/models/branch.ts
View file

@ -14,8 +14,17 @@
/**
* A branch within a project.
*/
export interface Branch {
/**
* Branch identifier.
*/
'id': string;
/**
* Branch name.
*/
'name': string;
}

26
packages/arc-api-client/src/models/cancel-run-response.ts Normal file
View file

@ -0,0 +1,26 @@
/* tslint:disable */
/* eslint-disable */
/**
* Arc Run API
* HTTP API for managing Arc workflow run executions.
*
* The version of the OpenAPI document: 0.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Response returned after cancelling a run.
*/
export interface CancelRunResponse {
/**
* Whether the cancellation was successful.
*/
'cancelled': boolean;
}

3
packages/arc-api-client/src/models/check-run-status.ts
View file

@ -14,6 +14,9 @@
/**
* Status of a CI check run.
*/
export const CheckRunStatus = {
SUCCESS: 'success',

9
packages/arc-api-client/src/models/check-run.ts
View file

@ -17,9 +17,18 @@
// @ts-ignore
import type { CheckRunStatus } from './check-run-status';
/**
* A CI check run result associated with a run\'s pull request.
*/
export interface CheckRun {
/**
* Name of the CI check.
*/
'name': string;
'status': CheckRunStatus;
/**
* Duration of the check run in seconds.
*/
'duration_secs'?: number;
}

15
packages/arc-api-client/src/models/control-detail.ts
View file

@ -14,10 +14,25 @@
/**
* Detailed information about a verification control including checks and examples.
*/
export interface ControlDetail {
/**
* Detailed prose description of the control\'s purpose and rationale.
*/
'description': string;
/**
* Specific checks performed by this control.
*/
'checks': Array<string>;
/**
* Example scenario where the control passes.
*/
'pass_example': string;
/**
* Example scenario where the control fails.
*/
'fail_example': string;
}

15
packages/arc-api-client/src/models/control-info.ts
View file

@ -17,11 +17,26 @@
// @ts-ignore
import type { VerificationType } from './verification-type';
/**
* Core metadata about a verification control.
*/
export interface ControlInfo {
/**
* Human-readable control name.
*/
'name': string;
/**
* URL-safe slug.
*/
'slug': string;
/**
* Short description of what the control verifies.
*/
'description': string;
'type'?: VerificationType;
/**
* Name of the category this control belongs to.
*/
'category': string;
}

12
packages/arc-api-client/src/models/control-performance.ts
View file

@ -20,10 +20,22 @@ import type { EvaluationResult } from './evaluation-result';
// @ts-ignore
import type { VerificationMode } from './verification-mode';
/**
* Performance metrics for a verification control.
*/
export interface ControlPerformance {
'mode': VerificationMode;
/**
* F1 score of the control\'s AI evaluator.
*/
'f1'?: number;
/**
* Pass@1 rate.
*/
'pass_at_1'?: number;
/**
* Recent evaluation results (newest first).
*/
'evaluations': Array<EvaluationResult>;
}

9
packages/arc-api-client/src/models/diff-file.ts
View file

@ -14,8 +14,17 @@
/**
* A file\'s contents at one side of a diff.
*/
export interface DiffFile {
/**
* File path relative to the repository root.
*/
'name': string;
/**
* Full file contents. Empty string for newly created or deleted files.
*/
'contents': string;
}

9
packages/arc-api-client/src/models/diff-stats.ts
View file

@ -14,8 +14,17 @@
/**
* Aggregate line-change statistics for a diff.
*/
export interface DiffStats {
/**
* Total lines added.
*/
'additions': number;
/**
* Total lines deleted.
*/
'deletions': number;
}

12
packages/arc-api-client/src/models/error-response-entry.ts
View file

@ -14,9 +14,21 @@
/**
* A single error entry in an error response.
*/
export interface ErrorResponseEntry {
/**
* HTTP status code as a string.
*/
'status': string;
/**
* Short error classification.
*/
'title': string;
/**
* Human-readable error description.
*/
'detail': string;
}

6
packages/arc-api-client/src/models/error-response.ts
View file

@ -17,7 +17,13 @@
// @ts-ignore
import type { ErrorResponseEntry } from './error-response-entry';
/**
* Standard error response containing one or more error entries.
*/
export interface ErrorResponse {
/**
* List of error entries.
*/
'errors': Array<ErrorResponseEntry>;
}

3
packages/arc-api-client/src/models/evaluation-result.ts
View file

@ -14,6 +14,9 @@
/**
* Outcome of a single verification evaluation.
*/
export const EvaluationResult = {
PASS: 'pass',

6
packages/arc-api-client/src/models/execute-query-request.ts
View file

@ -14,7 +14,13 @@
/**
* Request body for executing an ad-hoc SQL query.
*/
export interface ExecuteQueryRequest {
/**
* SQL query to execute.
*/
'sql': string;
}

15
packages/arc-api-client/src/models/execute-query-response.ts
View file

@ -14,10 +14,25 @@
/**
* Columnar result set from an executed query.
*/
export interface ExecuteQueryResponse {
/**
* Column names in the result set.
*/
'columns': Array<string>;
/**
* Result rows, each an array of values matching the column order.
*/
'rows': Array<Array<any>>;
/**
* Query execution time in seconds.
*/
'elapsed': number;
/**
* Number of rows returned.
*/
'row_count': number;
}

9
packages/arc-api-client/src/models/file-checkpoint.ts
View file

@ -14,8 +14,17 @@
/**
* A named checkpoint within a run, used to filter file diffs.
*/
export interface FileCheckpoint {
/**
* Checkpoint identifier.
*/
'id': string;
/**
* Human-readable label for the checkpoint.
*/
'label': string;
}

3
packages/arc-api-client/src/models/file-diff.ts
View file

@ -17,6 +17,9 @@
// @ts-ignore
import type { DiffFile } from './diff-file';
/**
* A before/after pair showing changes to a single file.
*/
export interface FileDiff {
'old_file': DiffFile;
'new_file': DiffFile;

6
packages/arc-api-client/src/models/health-response.ts
View file

@ -14,7 +14,13 @@
/**
* Service health check response.
*/
export interface HealthResponse {
/**
* Health status indicator.
*/
'status': string;
}

18
packages/arc-api-client/src/models/history-entry.ts
View file

@ -14,11 +14,29 @@
/**
* A previously executed query in the history log.
*/
export interface HistoryEntry {
/**
* Unique history entry identifier.
*/
'id': string;
/**
* SQL query that was executed.
*/
'sql': string;
/**
* Human-readable relative timestamp of execution.
*/
'timestamp': string;
/**
* Query execution time in seconds.
*/
'elapsed': number;
/**
* Number of rows returned.
*/
'row_count': number;
}

7
packages/arc-api-client/src/models/index.ts
View file

@ -1,9 +1,10 @@
export * from './aggregate-usage';
export * from './api-question';
export * from './api-question-option';
export * from './assistant-stage-turn';
export * from './assistant-turn';
export * from './branch';
export * from './cancel-run200-response';
export * from './cancel-run-response';
export * from './check-run';
export * from './check-run-status';
export * from './control-detail';
@ -71,9 +72,11 @@ export * from './stage-turn';
export * from './start-run-request';
export * from './start-run-response';
export * from './steer-request';
export * from './steer-run200-response';
export * from './steer-run-response';
export * from './submit-answer-request';
export * from './submit-answer-response';
export * from './system-stage-turn';
export * from './tool-stage-turn';
export * from './tool-turn';
export * from './tool-use';
export * from './usage-by-model';

3
packages/arc-api-client/src/models/paginated-api-question-list.ts
View file

@ -20,6 +20,9 @@ import type { ApiQuestion } from './api-question';
// @ts-ignore
import type { PaginationMeta } from './pagination-meta';
/**
* Paginated list of pending questions.
*/
export interface PaginatedApiQuestionList {
'data': Array<ApiQuestion>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-branch-list.ts
View file

@ -20,6 +20,9 @@ import type { Branch } from './branch';
// @ts-ignore
import type { PaginationMeta } from './pagination-meta';
/**
* Paginated list of branches.
*/
export interface PaginatedBranchList {
'data': Array<Branch>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-history-entry-list.ts
View file

@ -20,6 +20,9 @@ import type { HistoryEntry } from './history-entry';
// @ts-ignore
import type { PaginationMeta } from './pagination-meta';
/**
* Paginated list of query history entries.
*/
export interface PaginatedHistoryEntryList {
'data': Array<HistoryEntry>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-project-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { Project } from './project';
/**
* Paginated list of projects.
*/
export interface PaginatedProjectList {
'data': Array<Project>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-retro-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { RetroListItem } from './retro-list-item';
/**
* Paginated list of run retrospectives.
*/
export interface PaginatedRetroList {
'data': Array<RetroListItem>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-run-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { RunListItem } from './run-list-item';
/**
* Paginated list of runs.
*/
export interface PaginatedRunList {
'data': Array<RunListItem>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-run-stage-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { RunStage } from './run-stage';
/**
* Paginated list of run stages.
*/
export interface PaginatedRunStageList {
'data': Array<RunStage>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-run-verification-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { RunVerification } from './run-verification';
/**
* Paginated list of run verification categories.
*/
export interface PaginatedRunVerificationList {
'data': Array<RunVerification>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-saved-query-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { SavedQuery } from './saved-query';
/**
* Paginated list of saved queries.
*/
export interface PaginatedSavedQueryList {
'data': Array<SavedQuery>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-session-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { SessionListItem } from './session-list-item';
/**
* Paginated list of sessions.
*/
export interface PaginatedSessionList {
'data': Array<SessionListItem>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-stage-turn-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { StageTurn } from './stage-turn';
/**
* Paginated list of stage turns.
*/
export interface PaginatedStageTurnList {
'data': Array<StageTurn>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-verification-category-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { VerificationCategory } from './verification-category';
/**
* Paginated list of verification categories.
*/
export interface PaginatedVerificationCategoryList {
'data': Array<VerificationCategory>;
'meta': PaginationMeta;

3
packages/arc-api-client/src/models/paginated-workflow-list.ts
View file

@ -20,6 +20,9 @@ import type { PaginationMeta } from './pagination-meta';
// @ts-ignore
import type { WorkflowListItem } from './workflow-list-item';
/**
* Paginated list of workflows.
*/
export interface PaginatedWorkflowList {
'data': Array<WorkflowListItem>;
'meta': PaginationMeta;

6
packages/arc-api-client/src/models/pagination-meta.ts
View file

@ -14,7 +14,13 @@
/**
* Pagination metadata included in every paginated response.
*/
export interface PaginationMeta {
/**
* Whether additional pages of results are available.
*/
'has_more': boolean;
}

9
packages/arc-api-client/src/models/preview-url-request.ts
View file

@ -14,8 +14,17 @@
/**
* Request body for generating a preview URL from a sandbox port.
*/
export interface PreviewUrlRequest {
/**
* Port number exposed by the sandbox.
*/
'port': number;
/**
* Time-to-live for the preview URL in seconds.
*/
'expires_in_secs': number;
}

6
packages/arc-api-client/src/models/preview-url-response.ts
View file

@ -14,7 +14,13 @@
/**
* Response containing the generated preview URL.
*/
export interface PreviewUrlResponse {
/**
* Time-limited preview URL.
*/
'url': string;
}

9
packages/arc-api-client/src/models/project.ts
View file

@ -14,8 +14,17 @@
/**
* A registered project (repository).
*/
export interface Project {
/**
* Unique project identifier.
*/
'id': string;
/**
* Human-readable project name.
*/
'name': string;
}

3
packages/arc-api-client/src/models/question-type.ts
View file

@ -14,6 +14,9 @@
/**
* The interaction type of a human-in-the-loop question.
*/
export const QuestionType = {
YES_NO: 'yes_no',

15
packages/arc-api-client/src/models/recent-control-result.ts
View file

@ -17,11 +17,26 @@
// @ts-ignore
import type { VerificationStatus } from './verification-status';
/**
* Result of a recent verification control evaluation for a specific run.
*/
export interface RecentControlResult {
/**
* Identifier of the run that was evaluated.
*/
'run_id': string;
/**
* Title of the evaluated run.
*/
'run_title': string;
/**
* Workflow that produced the run.
*/
'workflow': string;
'result': VerificationStatus;
/**
* Human-readable relative timestamp of the evaluation.
*/
'timestamp': string;
}

18
packages/arc-api-client/src/models/retro-list-item.ts
View file

@ -20,13 +20,31 @@ import type { RetroStats } from './retro-stats';
// @ts-ignore
import type { SmoothnessRating } from './smoothness-rating';
/**
* Summary of a run retrospective shown in list views.
*/
export interface RetroListItem {
/**
* Identifier of the run this retro belongs to.
*/
'run_id': string;
/**
* Name of the workflow that produced the run.
*/
'workflow_name': string;
/**
* The run\'s goal.
*/
'goal': string;
/**
* Timestamp when the retro was generated.
*/
'timestamp': string;
'smoothness'?: SmoothnessRating;
'stats': RetroStats;
/**
* Number of friction points identified in the retro.
*/
'friction_point_count': number;
}

21
packages/arc-api-client/src/models/retro-stats.ts
View file

@ -14,12 +14,33 @@
/**
* Summary statistics for a run retrospective.
*/
export interface RetroStats {
/**
* Total run duration in milliseconds.
*/
'total_duration_ms': number;
/**
* Total cost in USD.
*/
'total_cost'?: number;
/**
* Total number of retries across all stages.
*/
'total_retries': number;
/**
* List of files modified during the run.
*/
'files_touched': Array<string>;
/**
* Number of stages that completed successfully.
*/
'stages_completed': number;
/**
* Number of stages that failed.
*/
'stages_failed': number;
}

12
packages/arc-api-client/src/models/root-response-urls.ts
View file

@ -14,9 +14,21 @@
/**
* Collection of API discovery URLs.
*/
export interface RootResponseUrls {
/**
* URL of the OpenAPI JSON specification.
*/
'openapi_url': string;
/**
* URL of the current user endpoint.
*/
'current_user_url': string;
/**
* URL of the health check endpoint.
*/
'health_url': string;
}

3
packages/arc-api-client/src/models/root-response.ts
View file

@ -17,6 +17,9 @@
// @ts-ignore
import type { RootResponseUrls } from './root-response-urls';
/**
* API discovery response with navigation URLs.
*/
export interface RootResponse {
'urls': RootResponseUrls;
}

9
packages/arc-api-client/src/models/run-compare.ts
View file

@ -23,8 +23,17 @@ import type { FileCheckpoint } from './file-checkpoint';
// @ts-ignore
import type { FileDiff } from './file-diff';
/**
* File-level diff output for a run, with checkpoint filtering support.
*/
export interface RunCompare {
/**
* Available checkpoints for filtering.
*/
'checkpoints': Array<FileCheckpoint>;
/**
* File diffs, optionally filtered by checkpoint.
*/
'files': Array<FileDiff>;
'stats': DiffStats;
}

3
packages/arc-api-client/src/models/run-list-item-status.ts
View file

@ -14,6 +14,9 @@
/**
* Board column status for a run in the list view.
*/
export const RunListItemStatus = {
WORKING: 'working',

49
packages/arc-api-client/src/models/run-list-item.ts
View file

@ -20,22 +20,71 @@ import type { CheckRun } from './check-run';
// @ts-ignore
import type { RunListItemStatus } from './run-list-item-status';
/**
* Summary of a run shown in the board view.
*/
export interface RunListItem {
/**
* Unique run identifier (ULID).
*/
'id': string;
/**
* Repository name.
*/
'repo': string;
/**
* Human-readable title describing the run\'s goal.
*/
'title': string;
/**
* Slug of the workflow that produced this run.
*/
'workflow': string;
'status': RunListItemStatus;
/**
* Pull request number, if the run has opened a PR.
*/
'number'?: number;
/**
* Lines added in the run\'s diff.
*/
'additions'?: number;
/**
* Lines deleted in the run\'s diff.
*/
'deletions'?: number;
/**
* CI check run results for the run\'s PR.
*/
'checks'?: Array<CheckRun>;
/**
* Wall-clock time elapsed since the run started, in seconds.
*/
'elapsed_secs'?: number;
/**
* Whether the elapsed time exceeds the expected threshold.
*/
'elapsed_warning'?: boolean;
/**
* Compute resources allocated to the run.
*/
'resources'?: string;
/**
* Number of review comments on the run\'s PR.
*/
'comments'?: number;
/**
* Text of a pending human-in-the-loop question, if any.
*/
'question'?: string;
/**
* Identifier of the sandbox environment running this run.
*/
'sandbox_id'?: string;
/**
* Timestamp when the run was created.
*/
'created_at': string;
}

15
packages/arc-api-client/src/models/run-stage.ts
View file

@ -17,11 +17,26 @@
// @ts-ignore
import type { StageStatus } from './stage-status';
/**
* A single stage in a run\'s workflow graph.
*/
export interface RunStage {
/**
* Unique stage identifier within the run.
*/
'id': string;
/**
* Human-readable stage name.
*/
'name': string;
'status': StageStatus;
/**
* Time spent in this stage, in seconds.
*/
'duration_secs'?: number;
/**
* Node identifier in the DOT graph source.
*/
'dot_id'?: string;
}

16
packages/arc-api-client/src/models/run-status-response.ts
View file

@ -17,11 +17,27 @@
// @ts-ignore
import type { RunStatus } from './run-status';
/**
* Current status of a run with optional error and queue position.
*/
export interface RunStatusResponse {
/**
* Unique run identifier (ULID).
*/
'id': string;
'status': RunStatus;
/**
* Error message if the run failed.
*/
'error'?: string;
/**
* Position in the queue (1-based). Only present when status is `queued`.
*/
'queue_position'?: number;
/**
* Timestamp when the run was created.
*/
'created_at': string;
}

3
packages/arc-api-client/src/models/run-status.ts
View file

@ -14,6 +14,9 @@
/**
* Lifecycle status of a run.
*/
export const RunStatus = {
QUEUED: 'queued',

9
packages/arc-api-client/src/models/run-usage.ts
View file

@ -23,9 +23,18 @@ import type { UsageStage } from './usage-stage';
// @ts-ignore
import type { UsageTotals } from './usage-totals';
/**
* Complete usage breakdown for a single run.
*/
export interface RunUsage {
/**
* Per-stage usage breakdown.
*/
'stages': Array<UsageStage>;
'totals': UsageTotals;
/**
* Usage grouped by model.
*/
'by_model': Array<UsageByModel>;
}

9
packages/arc-api-client/src/models/run-verification-control.ts
View file

@ -20,8 +20,17 @@ import type { VerificationStatus } from './verification-status';
// @ts-ignore
import type { VerificationType } from './verification-type';
/**
* A verification control result within a run.
*/
export interface RunVerificationControl {
/**
* Human-readable control name.
*/
'name': string;
/**
* Short description of what the control verifies.
*/
'description': string;
'type'?: VerificationType;
'status': VerificationStatus;

12
packages/arc-api-client/src/models/run-verification.ts
View file

@ -20,10 +20,22 @@ import type { RunVerificationControl } from './run-verification-control';
// @ts-ignore
import type { VerificationStatus } from './verification-status';
/**
* Verification results for a category within a run.
*/
export interface RunVerification {
/**
* Category name.
*/
'name': string;
/**
* The guiding question for this verification category.
*/
'question': string;
'status': VerificationStatus;
/**
* Individual control results within this category.
*/
'controls': Array<RunVerificationControl>;
}

9
packages/arc-api-client/src/models/save-query-request.ts
View file

@ -14,8 +14,17 @@
/**
* Request body for creating or updating a saved query.
*/
export interface SaveQueryRequest {
/**
* Human-readable query name.
*/
'name': string;
/**
* SQL query text.
*/
'sql': string;
}

20
packages/arc-api-client/src/models/saved-query.ts
View file

@ -14,9 +14,29 @@
/**
* A saved SQL query for the insights editor.
*/
export interface SavedQuery {
/**
* Unique query identifier.
*/
'id': string;
/**
* Human-readable query name.
*/
'name': string;
/**
* SQL query text.
*/
'sql': string;
/**
* Timestamp when the query was saved.
*/
'created_at': string;
/**
* Timestamp when the query was last modified.
*/
'updated_at'?: string;
}

3
packages/arc-api-client/src/models/setting-field-type.ts
View file

@ -14,6 +14,9 @@
/**
* Input type for a setting field.
*/
export const SettingFieldType = {
TEXT: 'text',

18
packages/arc-api-client/src/models/setting-field.ts
View file

@ -17,12 +17,30 @@
// @ts-ignore
import type { SettingFieldType } from './setting-field-type';
/**
* A single configurable setting within a group.
*/
export interface SettingField {
/**
* Machine-readable setting key.
*/
'key': string;
/**
* Human-readable label displayed in the UI.
*/
'label': string;
/**
* Current value of the setting.
*/
'value': string;
'type': SettingFieldType;
/**
* Available options for select-type fields.
*/
'options'?: Array<string>;
/**
* Additional help text for the setting.
*/
'description'?: string;
}

15
packages/arc-api-client/src/models/setting-group.ts
View file

@ -17,10 +17,25 @@
// @ts-ignore
import type { SettingField } from './setting-field';
/**
* A logical group of related settings.
*/
export interface SettingGroup {
/**
* Machine-readable group identifier.
*/
'id': string;
/**
* Human-readable group name.
*/
'name': string;
/**
* Prose description of the settings group.
*/
'description': string;
/**
* Settings within this group.
*/
'fields': Array<SettingField>;
}

9
packages/arc-api-client/src/models/sibling-control.ts
View file

@ -20,8 +20,17 @@ import type { VerificationMode } from './verification-mode';
// @ts-ignore
import type { VerificationType } from './verification-type';
/**
* Summary of a sibling verification control in the same category.
*/
export interface SiblingControl {
/**
* Human-readable control name.
*/
'name': string;
/**
* URL-safe slug.
*/
'slug': string;
'type'?: VerificationType;
'mode'?: VerificationMode;

3
packages/arc-api-client/src/models/smoothness-rating.ts
View file

@ -14,6 +14,9 @@
/**
* Qualitative assessment of how smoothly a run executed.
*/
export const SmoothnessRating = {
EFFORTLESS: 'effortless',

3
packages/arc-api-client/src/models/stage-status.ts
View file

@ -14,6 +14,9 @@
/**
* Execution status of a workflow stage.
*/
export const StageStatus = {
COMPLETED: 'completed',

27
packages/arc-api-client/src/models/stage-turn.ts
View file

@ -13,22 +13,23 @@
*/
// May contain unused imports in some cases
// @ts-ignore
import type { AssistantStageTurn } from './assistant-stage-turn';
// May contain unused imports in some cases
// @ts-ignore
import type { SystemStageTurn } from './system-stage-turn';
// May contain unused imports in some cases
// @ts-ignore
import type { ToolStageTurn } from './tool-stage-turn';
// May contain unused imports in some cases
// @ts-ignore
import type { ToolUse } from './tool-use';
export interface StageTurn {
'kind': StageTurnKindEnum;
'content'?: string;
'tools'?: Array<ToolUse>;
}
export const StageTurnKindEnum = {
SYSTEM: 'system',
ASSISTANT: 'assistant',
TOOL: 'tool'
} as const;
export type StageTurnKindEnum = typeof StageTurnKindEnum[keyof typeof StageTurnKindEnum];
/**
* @type StageTurn
* A single turn in a stage conversation — a system prompt, assistant response, or tool invocation block.
*/
export type StageTurn = { kind: 'assistant' } & AssistantStageTurn | { kind: 'system' } & SystemStageTurn | { kind: 'tool' } & ToolStageTurn;

6
packages/arc-api-client/src/models/start-run-request.ts
View file

@ -14,7 +14,13 @@
/**
* Request body for starting a new run from a DOT graph source.
*/
export interface StartRunRequest {
/**
* DOT language source defining the workflow graph.
*/
'dot_source': string;
}

16
packages/arc-api-client/src/models/start-run-response.ts
View file

@ -13,8 +13,24 @@
*/
// May contain unused imports in some cases
// @ts-ignore
import type { RunStatus } from './run-status';
/**
* Response returned after successfully queuing a new run.
*/
export interface StartRunResponse {
/**
* Unique run identifier (ULID).
*/
'id': string;
'status': RunStatus;
/**
* Timestamp when the run was created.
*/
'created_at': string;
}

12
packages/arc-api-client/src/models/steer-request.ts
View file

@ -14,9 +14,21 @@
/**
* Request body for sending inline steering guidance to a running agent.
*/
export interface SteerRequest {
/**
* File path to target with the guidance.
*/
'file': string;
/**
* Line number in the file to annotate.
*/
'line': number;
/**
* Guidance text for the agent.
*/
'guidance': string;
}

26
packages/arc-api-client/src/models/steer-run-response.ts Normal file
View file

@ -0,0 +1,26 @@
/* tslint:disable */
/* eslint-disable */
/**
* Arc Run API
* HTTP API for managing Arc workflow run executions.
*
* The version of the OpenAPI document: 0.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Acknowledgement that the steering guidance was accepted for delivery.
*/
export interface SteerRunResponse {
/**
* Whether the steering guidance was accepted.
*/
'accepted': boolean;
}

9
packages/arc-api-client/src/models/submit-answer-request.ts
View file

@ -14,8 +14,17 @@
/**
* Request body for submitting an answer to a pending question.
*/
export interface SubmitAnswerRequest {
/**
* Freeform answer text.
*/
'value': string;
/**
* Key of the selected option (for multiple-choice questions).
*/
'selected_option_key'?: string;
}

6
packages/arc-api-client/src/models/submit-answer-response.ts
View file

@ -14,7 +14,13 @@
/**
* Response indicating whether the submitted answer was accepted.
*/
export interface SubmitAnswerResponse {
/**
* Whether the answer was accepted. Returns false if the question no longer exists.
*/
'accepted': boolean;
}

41
packages/arc-api-client/src/models/system-stage-turn.ts Normal file
View file

@ -0,0 +1,41 @@
/* tslint:disable */
/* eslint-disable */
/**
* Arc Run API
* HTTP API for managing Arc workflow run executions.
*
* The version of the OpenAPI document: 0.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
// May contain unused imports in some cases
// @ts-ignore
import type { ToolUse } from './tool-use';
/**
* A system prompt turn that sets the stage\'s instructions.
*/
export interface SystemStageTurn {
'kind': SystemStageTurnKindEnum;
/**
* System prompt text.
*/
'content': string;
/**
* Tool invocations (always empty for system turns).
*/
'tools'?: Array<ToolUse>;
}
export const SystemStageTurnKindEnum = {
SYSTEM: 'system'
} as const;
export type SystemStageTurnKindEnum = typeof SystemStageTurnKindEnum[keyof typeof SystemStageTurnKindEnum];

41
packages/arc-api-client/src/models/tool-stage-turn.ts Normal file
View file

@ -0,0 +1,41 @@
/* tslint:disable */
/* eslint-disable */
/**
* Arc Run API
* HTTP API for managing Arc workflow run executions.
*
* The version of the OpenAPI document: 0.1.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
// May contain unused imports in some cases
// @ts-ignore
import type { ToolUse } from './tool-use';
/**
* A tool invocation turn containing one or more tool calls.
*/
export interface ToolStageTurn {
'kind': ToolStageTurnKindEnum;
/**
* Optional text content (usually null for tool turns).
*/
'content'?: string;
/**
* Tool invocations executed in this turn.
*/
'tools': Array<ToolUse>;
}
export const ToolStageTurnKindEnum = {
TOOL: 'tool'
} as const;
export type ToolStageTurnKindEnum = typeof ToolStageTurnKindEnum[keyof typeof ToolStageTurnKindEnum];

18
packages/arc-api-client/src/models/usage-by-model.ts
View file

@ -14,11 +14,29 @@
/**
* Usage statistics grouped by model.
*/
export interface UsageByModel {
/**
* Model slug.
*/
'model': string;
/**
* Number of stages that used this model.
*/
'stages': number;
/**
* Total input tokens for this model.
*/
'input_tokens': number;
/**
* Total output tokens for this model.
*/
'output_tokens': number;
/**
* Total cost in USD for this model.
*/
'cost': number;
}

21
packages/arc-api-client/src/models/usage-stage.ts
View file

@ -14,12 +14,33 @@
/**
* Token and cost usage for a single stage within a run.
*/
export interface UsageStage {
/**
* Human-readable stage name.
*/
'stage': string;
/**
* Model slug used for this stage.
*/
'model': string;
/**
* Number of input tokens consumed.
*/
'input_tokens': number;
/**
* Number of output tokens generated.
*/
'output_tokens': number;
/**
* Wall-clock runtime in seconds.
*/
'runtime_secs': number;
/**
* Cost in USD for this stage.
*/
'cost': number;
}

15
packages/arc-api-client/src/models/usage-totals.ts
View file

@ -14,10 +14,25 @@
/**
* Aggregate usage totals across all stages of a run.
*/
export interface UsageTotals {
/**
* Total wall-clock runtime in seconds.
*/
'runtime_secs': number;
/**
* Total input tokens consumed.
*/
'input_tokens': number;
/**
* Total output tokens generated.
*/
'output_tokens': number;
/**
* Total cost in USD.
*/
'cost': number;
}

6
packages/arc-api-client/src/models/user-response.ts
View file

@ -14,7 +14,13 @@
/**
* Information about the authenticated user.
*/
export interface UserResponse {
/**
* User\'s login identifier (e.g. GitHub username).
*/
'login': string;
}

12
packages/arc-api-client/src/models/verification-category.ts
View file

@ -17,9 +17,21 @@
// @ts-ignore
import type { VerificationControl } from './verification-control';
/**
* A group of related verification controls.
*/
export interface VerificationCategory {
/**
* Category name.
*/
'name': string;
/**
* Guiding question for the category.
*/
'question': string;
/**
* Verification controls in this category.
*/
'controls': Array<VerificationControl>;
}

21
packages/arc-api-client/src/models/verification-control.ts
View file

@ -23,14 +23,35 @@ import type { VerificationMode } from './verification-mode';
// @ts-ignore
import type { VerificationType } from './verification-type';
/**
* A verification control within a category, with performance metrics.
*/
export interface VerificationControl {
/**
* Human-readable control name.
*/
'name': string;
/**
* URL-safe slug for API lookups.
*/
'slug': string;
/**
* Short description of what the control verifies.
*/
'description': string;
'type'?: VerificationType;
'mode'?: VerificationMode;
/**
* F1 score of the control\'s AI evaluator.
*/
'f1'?: number;
/**
* Pass@1 rate — probability of passing on the first evaluation.
*/
'pass_at_1'?: number;
/**
* Recent evaluation results (newest first).
*/
'evaluations'?: Array<EvaluationResult>;
}

9
packages/arc-api-client/src/models/verification-detail-response.ts
View file

@ -29,11 +29,20 @@ import type { RecentControlResult } from './recent-control-result';
// @ts-ignore
import type { SiblingControl } from './sibling-control';
/**
* Complete detail view of a verification control with performance, examples, and recent results.
*/
export interface VerificationDetailResponse {
'control': ControlInfo;
'performance': ControlPerformance;
'control_detail': ControlDetail;
/**
* Recent evaluation results across runs.
*/
'recent_results': Array<RecentControlResult>;
/**
* Other controls in the same category.
*/
'siblings': Array<SiblingControl>;
}

3
packages/arc-api-client/src/models/verification-mode.ts
View file

@ -14,6 +14,9 @@
/**
* Operational mode of a verification control.
*/
export const VerificationMode = {
ACTIVE: 'active',

3
packages/arc-api-client/src/models/verification-status.ts
View file

@ -14,6 +14,9 @@
/**
* Result status of a verification control evaluation.
*/
export const VerificationStatus = {
PASS: 'pass',

Some files were not shown because too many files have changed in this diff Show more