refactor: add descriptive comments for various response payload interfaces
This commit is contained in:
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Serialized activity event payload returned by activity endpoints.
|
||||
*/
|
||||
export interface ActivityEventRead {
|
||||
id: string;
|
||||
event_type: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Denormalized task-comment feed item enriched with task and board fields.
|
||||
*/
|
||||
export interface ActivityTaskCommentFeedItemRead {
|
||||
id: string;
|
||||
created_at: string;
|
||||
|
||||
@@ -7,6 +7,9 @@
|
||||
import type { AgentCreateHeartbeatConfig } from "./agentCreateHeartbeatConfig";
|
||||
import type { AgentCreateIdentityProfile } from "./agentCreateIdentityProfile";
|
||||
|
||||
/**
|
||||
* Payload for creating a new agent.
|
||||
*/
|
||||
export interface AgentCreate {
|
||||
board_id?: string | null;
|
||||
/** @minLength 1 */
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Heartbeat status payload sent by agents.
|
||||
*/
|
||||
export interface AgentHeartbeat {
|
||||
status?: string | null;
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Heartbeat payload used to create an agent lazily.
|
||||
*/
|
||||
export interface AgentHeartbeatCreate {
|
||||
status?: string | null;
|
||||
/** @minLength 1 */
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Nudge message payload for pinging an agent.
|
||||
*/
|
||||
export interface AgentNudge {
|
||||
/** @minLength 1 */
|
||||
message: string;
|
||||
|
||||
@@ -7,6 +7,9 @@
|
||||
import type { AgentReadHeartbeatConfig } from "./agentReadHeartbeatConfig";
|
||||
import type { AgentReadIdentityProfile } from "./agentReadIdentityProfile";
|
||||
|
||||
/**
|
||||
* Public agent representation returned by the API.
|
||||
*/
|
||||
export interface AgentRead {
|
||||
board_id?: string | null;
|
||||
/** @minLength 1 */
|
||||
|
||||
@@ -7,6 +7,9 @@
|
||||
import type { AgentUpdateHeartbeatConfig } from "./agentUpdateHeartbeatConfig";
|
||||
import type { AgentUpdateIdentityProfile } from "./agentUpdateIdentityProfile";
|
||||
|
||||
/**
|
||||
* Payload for patching an existing agent.
|
||||
*/
|
||||
export interface AgentUpdate {
|
||||
board_id?: string | null;
|
||||
is_gateway_main?: boolean | null;
|
||||
|
||||
@@ -8,6 +8,9 @@ import type { ApprovalCreatePayload } from "./approvalCreatePayload";
|
||||
import type { ApprovalCreateRubricScores } from "./approvalCreateRubricScores";
|
||||
import type { ApprovalCreateStatus } from "./approvalCreateStatus";
|
||||
|
||||
/**
|
||||
* Payload for creating a new approval request.
|
||||
*/
|
||||
export interface ApprovalCreate {
|
||||
action_type: string;
|
||||
task_id?: string | null;
|
||||
|
||||
@@ -8,6 +8,9 @@ import type { ApprovalReadPayload } from "./approvalReadPayload";
|
||||
import type { ApprovalReadRubricScores } from "./approvalReadRubricScores";
|
||||
import type { ApprovalReadStatus } from "./approvalReadStatus";
|
||||
|
||||
/**
|
||||
* Approval payload returned from read endpoints.
|
||||
*/
|
||||
export interface ApprovalRead {
|
||||
action_type: string;
|
||||
task_id?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for mutating approval status.
|
||||
*/
|
||||
export interface ApprovalUpdate {
|
||||
status?: "pending" | "approved" | "rejected" | null;
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Error detail payload listing blocking dependency task identifiers.
|
||||
*/
|
||||
export interface BlockedTaskDetail {
|
||||
message: string;
|
||||
blocked_by_task_ids?: string[];
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { BlockedTaskDetail } from "./blockedTaskDetail";
|
||||
|
||||
/**
|
||||
* Top-level blocked-task error response envelope.
|
||||
*/
|
||||
export interface BlockedTaskError {
|
||||
detail: BlockedTaskDetail;
|
||||
}
|
||||
|
||||
@@ -6,10 +6,13 @@
|
||||
*/
|
||||
import type { BoardCreateSuccessMetrics } from "./boardCreateSuccessMetrics";
|
||||
|
||||
/**
|
||||
* Payload for creating a board.
|
||||
*/
|
||||
export interface BoardCreate {
|
||||
name: string;
|
||||
slug: string;
|
||||
gateway_id: string;
|
||||
gateway_id?: string | null;
|
||||
board_group_id?: string | null;
|
||||
board_type?: string;
|
||||
objective?: string | null;
|
||||
|
||||
@@ -8,6 +8,9 @@ import type { BoardGroupBoardSnapshotTaskCounts } from "./boardGroupBoardSnapsho
|
||||
import type { BoardGroupTaskSummary } from "./boardGroupTaskSummary";
|
||||
import type { BoardRead } from "./boardRead";
|
||||
|
||||
/**
|
||||
* Board-level rollup embedded within a board-group snapshot.
|
||||
*/
|
||||
export interface BoardGroupBoardSnapshot {
|
||||
board: BoardRead;
|
||||
task_counts?: BoardGroupBoardSnapshotTaskCounts;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for creating a board group.
|
||||
*/
|
||||
export interface BoardGroupCreate {
|
||||
name: string;
|
||||
slug: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Request payload for heartbeat policy updates.
|
||||
*/
|
||||
export interface BoardGroupHeartbeatApply {
|
||||
every: string;
|
||||
target?: string | null;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { BoardGroupHeartbeatApplyResultRequested } from "./boardGroupHeartbeatApplyResultRequested";
|
||||
|
||||
/**
|
||||
* Result payload describing agents updated by a heartbeat request.
|
||||
*/
|
||||
export interface BoardGroupHeartbeatApplyResult {
|
||||
board_group_id: string;
|
||||
requested: BoardGroupHeartbeatApplyResultRequested;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for creating a board-group memory entry.
|
||||
*/
|
||||
export interface BoardGroupMemoryCreate {
|
||||
/** @minLength 1 */
|
||||
content: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Serialized board-group memory entry returned from read endpoints.
|
||||
*/
|
||||
export interface BoardGroupMemoryRead {
|
||||
id: string;
|
||||
board_group_id: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Board-group payload returned from read endpoints.
|
||||
*/
|
||||
export interface BoardGroupRead {
|
||||
name: string;
|
||||
slug: string;
|
||||
|
||||
@@ -7,6 +7,9 @@
|
||||
import type { BoardGroupBoardSnapshot } from "./boardGroupBoardSnapshot";
|
||||
import type { BoardGroupRead } from "./boardGroupRead";
|
||||
|
||||
/**
|
||||
* Top-level board-group snapshot response payload.
|
||||
*/
|
||||
export interface BoardGroupSnapshot {
|
||||
group?: BoardGroupRead | null;
|
||||
boards?: BoardGroupBoardSnapshot[];
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Task summary row used inside board-group snapshot responses.
|
||||
*/
|
||||
export interface BoardGroupTaskSummary {
|
||||
id: string;
|
||||
board_id: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for partial board-group updates.
|
||||
*/
|
||||
export interface BoardGroupUpdate {
|
||||
name?: string | null;
|
||||
slug?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for creating a board memory entry.
|
||||
*/
|
||||
export interface BoardMemoryCreate {
|
||||
/** @minLength 1 */
|
||||
content: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Serialized board memory entry returned from read endpoints.
|
||||
*/
|
||||
export interface BoardMemoryRead {
|
||||
id: string;
|
||||
board_id: string;
|
||||
|
||||
@@ -7,13 +7,17 @@
|
||||
import type { BoardOnboardingAgentCompleteSuccessMetrics } from "./boardOnboardingAgentCompleteSuccessMetrics";
|
||||
import type { BoardOnboardingLeadAgentDraft } from "./boardOnboardingLeadAgentDraft";
|
||||
import type { BoardOnboardingUserProfile } from "./boardOnboardingUserProfile";
|
||||
import { BoardOnboardingAgentCompleteStatus } from "./boardOnboardingAgentCompleteStatus";
|
||||
|
||||
/**
|
||||
* Complete onboarding draft produced by the onboarding assistant.
|
||||
*/
|
||||
export interface BoardOnboardingAgentComplete {
|
||||
board_type: string;
|
||||
objective?: string | null;
|
||||
success_metrics?: BoardOnboardingAgentCompleteSuccessMetrics;
|
||||
target_date?: string | null;
|
||||
status: "complete";
|
||||
status: BoardOnboardingAgentCompleteStatus;
|
||||
user_profile?: BoardOnboardingUserProfile | null;
|
||||
lead_agent?: BoardOnboardingLeadAgentDraft | null;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* Generated by orval v8.2.0 🍺
|
||||
* Do not edit manually.
|
||||
* Mission Control API
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
export type BoardOnboardingAgentCompleteStatus =
|
||||
(typeof BoardOnboardingAgentCompleteStatus)[keyof typeof BoardOnboardingAgentCompleteStatus];
|
||||
|
||||
export const BoardOnboardingAgentCompleteStatus = {
|
||||
complete: "complete",
|
||||
} as const;
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { BoardOnboardingQuestionOption } from "./boardOnboardingQuestionOption";
|
||||
|
||||
/**
|
||||
* Question payload emitted by the onboarding assistant.
|
||||
*/
|
||||
export interface BoardOnboardingAgentQuestion {
|
||||
/** @minLength 1 */
|
||||
question: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* User answer payload for a single onboarding question.
|
||||
*/
|
||||
export interface BoardOnboardingAnswer {
|
||||
/** @minLength 1 */
|
||||
answer: string;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { BoardOnboardingConfirmSuccessMetrics } from "./boardOnboardingConfirmSuccessMetrics";
|
||||
|
||||
/**
|
||||
* Payload used to confirm generated onboarding draft fields.
|
||||
*/
|
||||
export interface BoardOnboardingConfirm {
|
||||
board_type: string;
|
||||
objective?: string | null;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { BoardOnboardingLeadAgentDraftIdentityProfile } from "./boardOnboardingLeadAgentDraftIdentityProfile";
|
||||
|
||||
/**
|
||||
* Editable lead-agent draft configuration.
|
||||
*/
|
||||
export interface BoardOnboardingLeadAgentDraft {
|
||||
name?: string | null;
|
||||
identity_profile?: BoardOnboardingLeadAgentDraftIdentityProfile;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Selectable option for an onboarding question.
|
||||
*/
|
||||
export interface BoardOnboardingQuestionOption {
|
||||
/** @minLength 1 */
|
||||
id: string;
|
||||
|
||||
@@ -7,6 +7,9 @@
|
||||
import type { BoardOnboardingAgentComplete } from "./boardOnboardingAgentComplete";
|
||||
import type { BoardOnboardingReadMessages } from "./boardOnboardingReadMessages";
|
||||
|
||||
/**
|
||||
* Stored onboarding session state returned by API endpoints.
|
||||
*/
|
||||
export interface BoardOnboardingRead {
|
||||
id: string;
|
||||
board_id: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Start signal for initializing onboarding conversation.
|
||||
*/
|
||||
export interface BoardOnboardingStart {
|
||||
[key: string]: unknown;
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* User-profile preferences gathered during onboarding.
|
||||
*/
|
||||
export interface BoardOnboardingUserProfile {
|
||||
preferred_name?: string | null;
|
||||
pronouns?: string | null;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { BoardReadSuccessMetrics } from "./boardReadSuccessMetrics";
|
||||
|
||||
/**
|
||||
* Board payload returned from read endpoints.
|
||||
*/
|
||||
export interface BoardRead {
|
||||
name: string;
|
||||
slug: string;
|
||||
|
||||
@@ -10,6 +10,9 @@ import type { BoardMemoryRead } from "./boardMemoryRead";
|
||||
import type { BoardRead } from "./boardRead";
|
||||
import type { TaskCardRead } from "./taskCardRead";
|
||||
|
||||
/**
|
||||
* Aggregated board payload used by board snapshot endpoints.
|
||||
*/
|
||||
export interface BoardSnapshot {
|
||||
board: BoardRead;
|
||||
tasks: TaskCardRead[];
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { BoardUpdateSuccessMetrics } from "./boardUpdateSuccessMetrics";
|
||||
|
||||
/**
|
||||
* Payload for partial board updates.
|
||||
*/
|
||||
export interface BoardUpdate {
|
||||
name?: string | null;
|
||||
slug?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Topline dashboard KPI summary values.
|
||||
*/
|
||||
export interface DashboardKpis {
|
||||
active_agents: number;
|
||||
tasks_in_progress: number;
|
||||
|
||||
@@ -9,6 +9,9 @@ import type { DashboardMetricsRange } from "./dashboardMetricsRange";
|
||||
import type { DashboardSeriesSet } from "./dashboardSeriesSet";
|
||||
import type { DashboardWipSeriesSet } from "./dashboardWipSeriesSet";
|
||||
|
||||
/**
|
||||
* Complete dashboard metrics response payload.
|
||||
*/
|
||||
export interface DashboardMetrics {
|
||||
range: DashboardMetricsRange;
|
||||
generated_at: string;
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
* Mission Control API
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
import type { DashboardMetricsApiV1MetricsDashboardGetRange } from "./dashboardMetricsApiV1MetricsDashboardGetRange";
|
||||
import type { DashboardMetricsApiV1MetricsDashboardGetRangeKey } from "./dashboardMetricsApiV1MetricsDashboardGetRangeKey";
|
||||
|
||||
export type DashboardMetricsApiV1MetricsDashboardGetParams = {
|
||||
range?: DashboardMetricsApiV1MetricsDashboardGetRange;
|
||||
range_key?: DashboardMetricsApiV1MetricsDashboardGetRangeKey;
|
||||
};
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
/**
|
||||
* Generated by orval v8.2.0 🍺
|
||||
* Do not edit manually.
|
||||
* Mission Control API
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
export type DashboardMetricsApiV1MetricsDashboardGetRangeKey =
|
||||
(typeof DashboardMetricsApiV1MetricsDashboardGetRangeKey)[keyof typeof DashboardMetricsApiV1MetricsDashboardGetRangeKey];
|
||||
|
||||
export const DashboardMetricsApiV1MetricsDashboardGetRangeKey = {
|
||||
"24h": "24h",
|
||||
"7d": "7d",
|
||||
} as const;
|
||||
@@ -8,6 +8,9 @@ import type { DashboardRangeSeriesBucket } from "./dashboardRangeSeriesBucket";
|
||||
import type { DashboardRangeSeriesRange } from "./dashboardRangeSeriesRange";
|
||||
import type { DashboardSeriesPoint } from "./dashboardSeriesPoint";
|
||||
|
||||
/**
|
||||
* Series payload for a single range/bucket combination.
|
||||
*/
|
||||
export interface DashboardRangeSeries {
|
||||
range: DashboardRangeSeriesRange;
|
||||
bucket: DashboardRangeSeriesBucket;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Single numeric time-series point.
|
||||
*/
|
||||
export interface DashboardSeriesPoint {
|
||||
period: string;
|
||||
value: number;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { DashboardRangeSeries } from "./dashboardRangeSeries";
|
||||
|
||||
/**
|
||||
* Primary vs comparison pair for generic series metrics.
|
||||
*/
|
||||
export interface DashboardSeriesSet {
|
||||
primary: DashboardRangeSeries;
|
||||
comparison: DashboardRangeSeries;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Work-in-progress point split by task status buckets.
|
||||
*/
|
||||
export interface DashboardWipPoint {
|
||||
period: string;
|
||||
inbox: number;
|
||||
|
||||
@@ -8,6 +8,9 @@ import type { DashboardWipPoint } from "./dashboardWipPoint";
|
||||
import type { DashboardWipRangeSeriesBucket } from "./dashboardWipRangeSeriesBucket";
|
||||
import type { DashboardWipRangeSeriesRange } from "./dashboardWipRangeSeriesRange";
|
||||
|
||||
/**
|
||||
* WIP series payload for a single range/bucket combination.
|
||||
*/
|
||||
export interface DashboardWipRangeSeries {
|
||||
range: DashboardWipRangeSeriesRange;
|
||||
bucket: DashboardWipRangeSeriesBucket;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { DashboardWipRangeSeries } from "./dashboardWipRangeSeries";
|
||||
|
||||
/**
|
||||
* Primary vs comparison pair for WIP status series metrics.
|
||||
*/
|
||||
export interface DashboardWipSeriesSet {
|
||||
primary: DashboardWipRangeSeries;
|
||||
comparison: DashboardWipRangeSeries;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Gateway command catalog and protocol metadata.
|
||||
*/
|
||||
export interface GatewayCommandsResponse {
|
||||
protocol_version: number;
|
||||
methods: string[];
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for creating a gateway configuration.
|
||||
*/
|
||||
export interface GatewayCreate {
|
||||
name: string;
|
||||
url: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Per-board result entry for a lead broadcast operation.
|
||||
*/
|
||||
export interface GatewayLeadBroadcastBoardResult {
|
||||
board_id: string;
|
||||
lead_agent_id?: string | null;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { GatewayLeadBroadcastRequestKind } from "./gatewayLeadBroadcastRequestKind";
|
||||
|
||||
/**
|
||||
* Request payload for broadcasting a message to multiple board leads.
|
||||
*/
|
||||
export interface GatewayLeadBroadcastRequest {
|
||||
kind?: GatewayLeadBroadcastRequestKind;
|
||||
correlation_id?: string | null;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { GatewayLeadBroadcastBoardResult } from "./gatewayLeadBroadcastBoardResult";
|
||||
|
||||
/**
|
||||
* Aggregate response for a lead broadcast operation.
|
||||
*/
|
||||
export interface GatewayLeadBroadcastResponse {
|
||||
ok?: boolean;
|
||||
sent?: number;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { GatewayLeadMessageRequestKind } from "./gatewayLeadMessageRequestKind";
|
||||
|
||||
/**
|
||||
* Request payload for sending a message to a board lead agent.
|
||||
*/
|
||||
export interface GatewayLeadMessageRequest {
|
||||
kind?: GatewayLeadMessageRequestKind;
|
||||
correlation_id?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Response payload for a lead-message dispatch attempt.
|
||||
*/
|
||||
export interface GatewayLeadMessageResponse {
|
||||
ok?: boolean;
|
||||
board_id: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Request payload for asking the end user via a main gateway agent.
|
||||
*/
|
||||
export interface GatewayMainAskUserRequest {
|
||||
correlation_id?: string | null;
|
||||
/** @minLength 1 */
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Response payload for user-question dispatch via gateway main agent.
|
||||
*/
|
||||
export interface GatewayMainAskUserResponse {
|
||||
ok?: boolean;
|
||||
board_id: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Gateway payload returned from read endpoints.
|
||||
*/
|
||||
export interface GatewayRead {
|
||||
name: string;
|
||||
url: string;
|
||||
|
||||
16
frontend/src/api/generated/model/gatewayResolveQuery.ts
Normal file
16
frontend/src/api/generated/model/gatewayResolveQuery.ts
Normal file
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* Generated by orval v8.2.0 🍺
|
||||
* Do not edit manually.
|
||||
* Mission Control API
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Query parameters used to resolve which gateway to target.
|
||||
*/
|
||||
export interface GatewayResolveQuery {
|
||||
board_id?: string | null;
|
||||
gateway_url?: string | null;
|
||||
gateway_token?: string | null;
|
||||
gateway_main_session_key?: string | null;
|
||||
}
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Gateway session history response payload.
|
||||
*/
|
||||
export interface GatewaySessionHistoryResponse {
|
||||
history: unknown[];
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Request payload for sending a message into a gateway session.
|
||||
*/
|
||||
export interface GatewaySessionMessageRequest {
|
||||
/** @minLength 1 */
|
||||
content: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Single gateway session response payload.
|
||||
*/
|
||||
export interface GatewaySessionResponse {
|
||||
session: unknown;
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Gateway sessions list response payload.
|
||||
*/
|
||||
export interface GatewaySessionsResponse {
|
||||
sessions: unknown[];
|
||||
main_session_key?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Per-agent error entry from a gateway template sync operation.
|
||||
*/
|
||||
export interface GatewayTemplatesSyncError {
|
||||
agent_id?: string | null;
|
||||
agent_name?: string | null;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { GatewayTemplatesSyncError } from "./gatewayTemplatesSyncError";
|
||||
|
||||
/**
|
||||
* Summary payload returned by gateway template sync endpoints.
|
||||
*/
|
||||
export interface GatewayTemplatesSyncResult {
|
||||
gateway_id: string;
|
||||
include_main: boolean;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for partial gateway updates.
|
||||
*/
|
||||
export interface GatewayUpdate {
|
||||
name?: string | null;
|
||||
url?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Aggregated gateway status response including session metadata.
|
||||
*/
|
||||
export interface GatewaysStatusResponse {
|
||||
connected: boolean;
|
||||
gateway_url: string;
|
||||
|
||||
@@ -49,6 +49,7 @@ export * from "./boardGroupUpdate";
|
||||
export * from "./boardMemoryCreate";
|
||||
export * from "./boardMemoryRead";
|
||||
export * from "./boardOnboardingAgentComplete";
|
||||
export * from "./boardOnboardingAgentCompleteStatus";
|
||||
export * from "./boardOnboardingAgentCompleteSuccessMetrics";
|
||||
export * from "./boardOnboardingAgentQuestion";
|
||||
export * from "./boardOnboardingAnswer";
|
||||
@@ -73,6 +74,7 @@ export * from "./dashboardKpis";
|
||||
export * from "./dashboardMetrics";
|
||||
export * from "./dashboardMetricsApiV1MetricsDashboardGetParams";
|
||||
export * from "./dashboardMetricsApiV1MetricsDashboardGetRange";
|
||||
export * from "./dashboardMetricsApiV1MetricsDashboardGetRangeKey";
|
||||
export * from "./dashboardMetricsRange";
|
||||
export * from "./dashboardRangeSeries";
|
||||
export * from "./dashboardRangeSeriesBucket";
|
||||
@@ -100,6 +102,7 @@ export * from "./gatewayLeadMessageResponse";
|
||||
export * from "./gatewayMainAskUserRequest";
|
||||
export * from "./gatewayMainAskUserResponse";
|
||||
export * from "./gatewayRead";
|
||||
export * from "./gatewayResolveQuery";
|
||||
export * from "./gatewaySessionHistoryResponse";
|
||||
export * from "./gatewaySessionMessageRequest";
|
||||
export * from "./gatewaySessionResponse";
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Standard success response payload.
|
||||
*/
|
||||
export interface OkResponse {
|
||||
ok?: boolean;
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for switching the active organization context.
|
||||
*/
|
||||
export interface OrganizationActiveUpdate {
|
||||
organization_id: string;
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Board access payload returned from read endpoints.
|
||||
*/
|
||||
export interface OrganizationBoardAccessRead {
|
||||
id: string;
|
||||
board_id: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Board access specification used in member/invite mutation payloads.
|
||||
*/
|
||||
export interface OrganizationBoardAccessSpec {
|
||||
board_id: string;
|
||||
can_read?: boolean;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for creating a new organization.
|
||||
*/
|
||||
export interface OrganizationCreate {
|
||||
name: string;
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for accepting an organization invite token.
|
||||
*/
|
||||
export interface OrganizationInviteAccept {
|
||||
token: string;
|
||||
}
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { OrganizationBoardAccessSpec } from "./organizationBoardAccessSpec";
|
||||
|
||||
/**
|
||||
* Payload for creating an organization invite.
|
||||
*/
|
||||
export interface OrganizationInviteCreate {
|
||||
invited_email: string;
|
||||
role?: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Organization invite payload returned from read endpoints.
|
||||
*/
|
||||
export interface OrganizationInviteRead {
|
||||
id: string;
|
||||
organization_id: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Organization list row for current user memberships.
|
||||
*/
|
||||
export interface OrganizationListItem {
|
||||
id: string;
|
||||
name: string;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { OrganizationBoardAccessSpec } from "./organizationBoardAccessSpec";
|
||||
|
||||
/**
|
||||
* Payload for replacing organization member access permissions.
|
||||
*/
|
||||
export interface OrganizationMemberAccessUpdate {
|
||||
all_boards_read?: boolean;
|
||||
all_boards_write?: boolean;
|
||||
|
||||
@@ -7,6 +7,9 @@
|
||||
import type { OrganizationBoardAccessRead } from "./organizationBoardAccessRead";
|
||||
import type { OrganizationUserRead } from "./organizationUserRead";
|
||||
|
||||
/**
|
||||
* Organization member payload including board-level access overrides.
|
||||
*/
|
||||
export interface OrganizationMemberRead {
|
||||
id: string;
|
||||
organization_id: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for partial updates to organization member role.
|
||||
*/
|
||||
export interface OrganizationMemberUpdate {
|
||||
role?: string | null;
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Organization payload returned by read endpoints.
|
||||
*/
|
||||
export interface OrganizationRead {
|
||||
id: string;
|
||||
name: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Embedded user fields included in organization member payloads.
|
||||
*/
|
||||
export interface OrganizationUserRead {
|
||||
id: string;
|
||||
email?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for updating an agent SOUL document.
|
||||
*/
|
||||
export interface SoulUpdateRequest {
|
||||
content: string;
|
||||
source_url?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Response payload containing rendered markdown for a soul.
|
||||
*/
|
||||
export interface SoulsDirectoryMarkdownResponse {
|
||||
handle: string;
|
||||
slug: string;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { SoulsDirectorySoulRef } from "./soulsDirectorySoulRef";
|
||||
|
||||
/**
|
||||
* Response wrapper for directory search results.
|
||||
*/
|
||||
export interface SoulsDirectorySearchResponse {
|
||||
items: SoulsDirectorySoulRef[];
|
||||
}
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Reference metadata for a soul entry in the directory index.
|
||||
*/
|
||||
export interface SoulsDirectorySoulRef {
|
||||
handle: string;
|
||||
slug: string;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { TaskCardReadStatus } from "./taskCardReadStatus";
|
||||
|
||||
/**
|
||||
* Task read model enriched with assignee and approval counters.
|
||||
*/
|
||||
export interface TaskCardRead {
|
||||
title: string;
|
||||
description?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for creating a task comment.
|
||||
*/
|
||||
export interface TaskCommentCreate {
|
||||
/** @minLength 1 */
|
||||
message: string;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Task comment payload returned from read endpoints.
|
||||
*/
|
||||
export interface TaskCommentRead {
|
||||
id: string;
|
||||
message: string | null;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { TaskCreateStatus } from "./taskCreateStatus";
|
||||
|
||||
/**
|
||||
* Payload for creating a task.
|
||||
*/
|
||||
export interface TaskCreate {
|
||||
title: string;
|
||||
description?: string | null;
|
||||
|
||||
@@ -6,6 +6,9 @@
|
||||
*/
|
||||
import type { TaskReadStatus } from "./taskReadStatus";
|
||||
|
||||
/**
|
||||
* Task payload returned from read endpoints.
|
||||
*/
|
||||
export interface TaskRead {
|
||||
title: string;
|
||||
description?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for partial task updates.
|
||||
*/
|
||||
export interface TaskUpdate {
|
||||
title?: string | null;
|
||||
description?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Full user payload returned by API responses.
|
||||
*/
|
||||
export interface UserRead {
|
||||
clerk_user_id: string;
|
||||
email?: string | null;
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
* OpenAPI spec version: 0.1.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* Payload for partial user profile updates.
|
||||
*/
|
||||
export interface UserUpdate {
|
||||
name?: string | null;
|
||||
preferred_name?: string | null;
|
||||
|
||||
Reference in New Issue
Block a user