Skip to main content

Interface: components

Defined in: packages/api-client/src/generated/api.ts:1441

Properties​

headers​

headers: never

Defined in: packages/api-client/src/generated/api.ts:1891

parameters​

parameters: never

Defined in: packages/api-client/src/generated/api.ts:1889

pathItems​

pathItems: never

Defined in: packages/api-client/src/generated/api.ts:1892

requestBodies​

requestBodies: never

Defined in: packages/api-client/src/generated/api.ts:1890

responses​

responses: never

Defined in: packages/api-client/src/generated/api.ts:1888

schemas​

schemas: object

Defined in: packages/api-client/src/generated/api.ts:1442

_AdminGrantRequest​

_AdminGrantRequest: object

_AdminGrantRequest

Description​

Grant admin rights to a seeded test user, so the admin E2E suite can exercise the surface (M27-2). Role defaults to viewer - least privilege, like real grants.

_AdminGrantRequest.email​

email: string

Email

_AdminGrantRequest.role​

role: "viewer" | "operator" | "superadmin"

Default​
viewer

_EmitSpec​

_EmitSpec: object

_EmitSpec

_EmitSpec.data?​

optional data?: object

Data

Index Signature​

[key: string]: unknown

_EmitSpec.type​

type: string

Type

_ResetRequest​

_ResetRequest: object

_ResetRequest

Description​

Extra seeded chat ids to purge alongside the current user's own linked project.

_ResetRequest.chat_ids?​

optional chat_ids?: number[]

Chat Ids

_SeedProjectRequest​

_SeedProjectRequest: object

_SeedProjectRequest

Description​

Seed a project for the signed-in user and/or emit an event, mirroring the test fixtures.

``state`` is optional: when given, the project run is (re)written with it; when omitted, the
run is left untouched - so an emit-only call can fire an SSE event without wiping a project
seeded by an earlier call.
_SeedProjectRequest.chat_id​

chat_id: number

Chat Id

_SeedProjectRequest.emit?​

optional emit?: { data?: {[key: string]: unknown; }; type: string; } | null

Union Members​
Type Literal​

{ data?: {[key: string]: unknown; }; type: string; }

data?​

optional data?: object

Data

Index Signature​

[key: string]: unknown

type​

type: string

Type

null

_SeedProjectRequest.state?​

optional state?: {[key: string]: unknown; } | null

State

_TestLoginRequest​

_TestLoginRequest: object

_TestLoginRequest

Description​

Optional body for the test-login endpoint: seed an isolated user per run (E2E-1).

_TestLoginRequest.email?​

optional email?: string | null

Email

_TestLoginRequest.name?​

optional name?: string | null

Name

AdminRole​

AdminRole: "viewer" | "operator" | "superadmin"

AdminRole

Description​

Fixed admin roles, strictly ordered: each includes everything below it.

AuditOutcome​

AuditOutcome: "error" | "ok" | "denied"

AuditOutcome

Description​

How the audited action ended (design 4.3: ok | error | denied).

AuthConfig​

AuthConfig: object

AuthConfig

Description​

Which sign-in methods this deployment offers (booleans only - never secrets).

AuthConfig.adminUrl​

adminUrl: string | null

Adminurl

Description​

The admin dashboard origin, when this deployment has one (BLOOM_ADMIN_DASHBOARD_URL).

AuthConfig.google​

google: boolean

Google

AuthConfig.testLogin​

testLogin: boolean

Testlogin

AuthConfig.testLoginRequiresPassword​

testLoginRequiresPassword: boolean

Testloginrequirespassword

Description​

Test-login demands the per-PR shared password (hardened previews, #346 follow-up).

ChildFlow​

ChildFlow: object

ChildFlow

Description​

One currently-active child work item, projected from persisted run state (#467).

ChildFlow.attempt_or_round?​

optional attempt_or_round?: number | null

Attempt Or Round

ChildFlow.disagreement?​

optional disagreement?: string | null

Disagreement

ChildFlow.failure_kind?​

optional failure_kind?: string | null

Failure Kind

ChildFlow.kind​

kind: "ticket" | "pr" | "revision" | "decision" | "client_approval" | "lifecycle"

ChildFlow.ref​

ref: string

Ref

ChildFlow.retries?​

optional retries?: number | null

Retries

ChildFlow.status​

status: string

Status

ChildFlow.title​

title: string

Title

ChildFlow.url?​

optional url?: string | null

Url

ChildFlowKind​

ChildFlowKind: "ticket" | "pr" | "revision" | "decision" | "client_approval" | "lifecycle"

ChildFlowKind

Description​

The kinds of concurrent child work a project can be running at once.

ConversationTurn​

ConversationTurn: object

ConversationTurn

Description​

One turn of a project's conversation (M20-3): the shared Telegram/web chat history.

Both channels append to the same ``run.state['conversation']``, so the dashboard Chat tab
reads the exact turns Telegram produced (and vice versa).
ConversationTurn.content​

content: string

Content

ConversationTurn.role​

role: string

Role

CreateProject​

CreateProject: object

CreateProject

Description​

The create-project request (M26-2): empty by default, so the user's first chat message starts discovery. message keeps the M20-3 seed-message behavior working until M26-3 rewires the web button; blank counts as absent. repo optionally binds an existing repository as the project target (M44 #867).

CreateProject.message?​

optional message?: string | null

Message

CreateProject.repo?​

optional repo?: string | null

Repo

Description​

An optional owner/name slug naming the EXISTING repository to adopt as the project target (M44 #867, TS-forward). Absent, null, or blank means the greenfield default; a value that is not an owner/name pair, or that resolves to a repo Bloom cannot access, is a 422.

CredentialMetadata​

CredentialMetadata: object

CredentialMetadata

Description​

What a read returns: everything ABOUT a credential, never the credential.

CredentialMetadata.name​

name: string

Name

CredentialMetadata.provided_at?​

optional provided_at?: string | null

Provided At

CredentialsOverview​

CredentialsOverview: object

CredentialsOverview

Description​

Everything the credentials page shows - metadata only, never a value.

CredentialsOverview.configured​

configured: boolean

Configured

CredentialsOverview.credentials​

credentials: object[]

Credentials

CredentialsOverview.required​

required: string[]

Required

CredentialsOverview.suggested_names​

suggested_names: string[]

Suggested Names

CredentialValue​

CredentialValue: object

CredentialValue

CredentialValue.value​

value: string

Value

CurrentUser​

CurrentUser: object

CurrentUser

Description​

The signed-in user, as served by /me and /test-login (the SPA's me-cache shape).

CurrentUser.email​

email: string

Email

CurrentUser.id​

id: string

Id

CurrentUser.isAdmin​

isAdmin: boolean

Isadmin

Description​

Server-derived capability boolean (an admin grant exists); it grants nothing itself.

CurrentUser.name​

name: string | null

Name

GlobalCredentialsOverview​

GlobalCredentialsOverview: object

GlobalCredentialsOverview

Description​

Everything the Global Credentials page shows - metadata only, never a value.

GlobalCredentialsOverview.configured​

configured: boolean

Configured

GlobalCredentialsOverview.credentials​

credentials: object[]

Credentials

GraphEdge​

GraphEdge: object

GraphEdge

GraphEdge.label?​

optional label?: string | null

Label

GraphEdge.source​

source: string

Source

GraphEdge.target​

target: string

Target

GraphNode​

GraphNode: object

GraphNode

Description​

One SDLC node in the project graph, with its status in this project's context.

GraphNode.id​

id: string

Id

GraphNode.kind​

kind: string

Kind

GraphNode.label​

label: string

Label

GraphNode.phase​

phase: string

Phase

GraphNode.status​

status: string

Status

HTTPValidationError​

HTTPValidationError: object

HTTPValidationError

HTTPValidationError.detail?​

optional detail?: object[]

Detail

LinkCode​

LinkCode: object

LinkCode

LinkCode.code​

code: string

Code

optional deep_link?: string | null

Deep Link

LinkStatus​

LinkStatus: object

LinkStatus

LinkStatus.linked​

linked: boolean

Linked

LinkStatus.telegram_user_id?​

optional telegram_user_id?: number | null

Telegram User Id

LinkStatus.verified​

verified: boolean

Verified

MilestoneStatus​

MilestoneStatus: object

MilestoneStatus

MilestoneStatus.closed_issues​

closed_issues: number

Closed Issues

Default​
0
MilestoneStatus.open_issues​

open_issues: number

Open Issues

Default​
0
MilestoneStatus.state​

state: string

State

MilestoneStatus.title​

title: string

Title

ProjectDetail​

ProjectDetail: object

ProjectDetail

Description​

The project detail view (M3): the overview, the SDLC graph in context, and milestones.

ProjectDetail.children?​

optional children?: object[]

Children

ProjectDetail.graph​

graph: object

ProjectDetail.graph.edges?​

optional edges?: object[]

Edges

ProjectDetail.graph.nodes?​

optional nodes?: object[]

Nodes

ProjectDetail.milestones?​

optional milestones?: object[]

Milestones

ProjectDetail.overview​

overview: object

ProjectDetail.overview.blocked?​

optional blocked?: string[]

Blocked

ProjectDetail.overview.issues_closed​

issues_closed: number

Issues Closed

Default​
0
ProjectDetail.overview.issues_open​

issues_open: number

Issues Open

Default​
0
ProjectDetail.overview.last_checked_at?​

optional last_checked_at?: string | null

Last Checked At

ProjectDetail.overview.live_status_available​

live_status_available: boolean

Live Status Available

Default​
true
ProjectDetail.overview.live_url?​

optional live_url?: string | null

Live Url

ProjectDetail.overview.milestones_closed​

milestones_closed: number

Milestones Closed

Default​
0
ProjectDetail.overview.milestones_open​

milestones_open: number

Milestones Open

Default​
0
ProjectDetail.overview.needs_attention?​

optional needs_attention?: string[]

Needs Attention

ProjectDetail.overview.next_check_at?​

optional next_check_at?: string | null

Next Check At

ProjectDetail.overview.phase​

phase: string

Phase

ProjectDetail.overview.prd_revision​

prd_revision: number

Prd Revision

Default​
0
ProjectDetail.overview.prd_status​

prd_status: string

Prd Status

Default​
draft
ProjectDetail.overview.pull_requests_open​

pull_requests_open: number

Pull Requests Open

Default​
0
ProjectDetail.overview.repo_url?​

optional repo_url?: string | null

Repo Url

ProjectDetail.overview.thread_id​

thread_id: string

Thread Id

ProjectDetail.overview.title​

title: string

Title

ProjectDetail.specialist_reviews?​

optional specialist_reviews?: object[]

Specialist Reviews

ProjectGraph​

ProjectGraph: object

ProjectGraph

ProjectGraph.edges?​

optional edges?: object[]

Edges

ProjectGraph.nodes?​

optional nodes?: object[]

Nodes

ProjectOverview​

ProjectOverview: object

ProjectOverview

Description​

A dashboard read model of one project (M3 #7): plan state + live GitHub status.

ProjectOverview.blocked?​

optional blocked?: string[]

Blocked

ProjectOverview.issues_closed​

issues_closed: number

Issues Closed

Default​
0
ProjectOverview.issues_open​

issues_open: number

Issues Open

Default​
0
ProjectOverview.last_checked_at?​

optional last_checked_at?: string | null

Last Checked At

ProjectOverview.live_status_available​

live_status_available: boolean

Live Status Available

Default​
true
ProjectOverview.live_url?​

optional live_url?: string | null

Live Url

ProjectOverview.milestones_closed​

milestones_closed: number

Milestones Closed

Default​
0
ProjectOverview.milestones_open​

milestones_open: number

Milestones Open

Default​
0
ProjectOverview.needs_attention?​

optional needs_attention?: string[]

Needs Attention

ProjectOverview.next_check_at?​

optional next_check_at?: string | null

Next Check At

ProjectOverview.phase​

phase: string

Phase

ProjectOverview.prd_revision​

prd_revision: number

Prd Revision

Default​
0
ProjectOverview.prd_status​

prd_status: string

Prd Status

Default​
draft
ProjectOverview.pull_requests_open​

pull_requests_open: number

Pull Requests Open

Default​
0
ProjectOverview.repo_url?​

optional repo_url?: string | null

Repo Url

ProjectOverview.thread_id​

thread_id: string

Thread Id

ProjectOverview.title​

title: string

Title

ProjectRenameConflict​

ProjectRenameConflict: object

ProjectRenameConflict

Description​

The 409 body when a rename is refused (M56-1 #961): FastAPI's {"detail": ...} shape carrying a machine-readable token or the compare-and-swap sentence.

ProjectRenameConflict.detail​

detail: string

Detail

Description​

A machine-readable conflict token: project_archived or project_deleted when the project is retired (the web maps each to a sentence), or the compare-and-swap message "the project changed since it was read; reload and retry" when a concurrent orchestrator turn won the race.

RenameProject​

RenameProject: object

RenameProject

Description​

The PATCH /api/projects/{thread_id} rename body (M56-1 #961, TS-forward - no Python twin): name is the owner-chosen display name, trimmed to 1..80 code points on a single line. Extra fields are rejected (pydantic extra="forbid"); a multi-line name is a 422.

RenameProject.name​

name: string

Name

SendMessage​

SendMessage: object

SendMessage

Description​

A chat message posted from the dashboard into a project's conversation (M20-3).

SendMessage.message​

message: string

Message

SpecialistReviewSummary​

SpecialistReviewSummary: object

SpecialistReviewSummary

SpecialistReviewSummary.pull_request​

pull_request: number

Pull Request

SpecialistReviewSummary.pull_request_url?​

optional pull_request_url?: string | null

Pull Request Url

SpecialistReviewSummary.roles?​

optional roles?: object[]

Roles

SpecialistRoleSummary​

SpecialistRoleSummary: object

SpecialistRoleSummary

SpecialistRoleSummary.blocking_findings​

blocking_findings: number

Blocking Findings

Default​
0
SpecialistRoleSummary.display_name​

display_name: string

Display Name

SpecialistRoleSummary.findings​

findings: number

Findings

Default​
0
SpecialistRoleSummary.major_findings​

major_findings: number

Major Findings

Default​
0
SpecialistRoleSummary.role​

role: string

Role

SpecialistRoleSummary.summary​

summary: string

Summary

Default​
SpecialistRoleSummary.verdict​

verdict: string

Verdict

TimelineEvent​

TimelineEvent: object

TimelineEvent

Description​

One recorded project event, as the dashboard's Project timeline renders it (#265).

TimelineEvent.at​

at: string

At Format: date-time

TimelineEvent.data​

data: object

Data

Index Signature​

[key: string]: unknown

TimelineEvent.type​

type: string

Type

ValidationError​

ValidationError: object

ValidationError

ValidationError.ctx?​

optional ctx?: Record<string, never>

Context

ValidationError.input?​

optional input?: unknown

Input

ValidationError.loc​

loc: (string | number)[]

Location

ValidationError.msg​

msg: string

Message

ValidationError.type​

type: string

Error Type