Types

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

AcceptDecisionRequest

Field	Type	Required	Notes
contentHash	string or null	yes
revisionId	string (uuid) or null	no
branchId	string (uuid) or null	no

AcceptFlowProposalRequest

Field	Type	Required	Notes
name	string or null	yes
acceptWithIssues	boolean	no	default false

AcceptFlowProposalResponse

Field	Type	Required	Notes
scenarioId	string (uuid)	yes

AddBindingRequest

Field	Type	Required	Notes
id	string (uuid)	yes
sourceChannelId	string (uuid)	yes
targetChannelId	string (uuid)	yes
routingKey	string or null	yes

AddChannelRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
kind	string	yes

AddElementRequest

Field	Type	Required	Notes
id	string (uuid)	yes
kind	string	yes
name	string	yes
description	string or null	yes
technology	string or null	yes
ownerId	string (uuid) or null	yes
status	string or null	yes
parentId	string (uuid) or null	yes
tags	array of string or null	yes

AddMessageRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
description	string or null	yes
producerId	string (uuid)	yes
consumerIds	array of string (uuid)	yes
schemaId	string (uuid) or null	yes
tags	array of string or null	yes

AddOperationRequest

Field	Type	Required	Notes
id	string (uuid)	yes
ownerId	string (uuid)	yes
name	string	yes
transport	string	yes
requestSchemaId	string (uuid) or null	yes
responseSchemaId	string (uuid) or null	yes
timeoutMs	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
retry	null or RetryDto	yes

AddRelationshipRequest

Field	Type	Required	Notes
id	string (uuid)	yes
fromId	string (uuid)	yes
toId	string (uuid)	yes
label	string or null	yes
technology	string or null	yes
kind	string or null	no

AddSubscriptionRequest

Field	Type	Required	Notes
id	string (uuid)	yes
channelId	string (uuid)	yes
consumerId	string (uuid)	yes
retry	null or RetryDto	yes
deadLetterChannelId	string (uuid) or null	yes

AgentCapabilities

Field	Type	Required	Notes
caller	string	yes
tokenId	string (uuid) or null	yes
workspaceId	string (uuid) or null	yes
projectId	string (uuid) or null	yes
scopes	array of string	yes
expiresAt	string (date-time) or null	yes
mcpEndpoint	string	yes
reference	string	yes
skill	string	yes
tools	array of CapableTool	yes
endpoints	array of CapableEndpoint	yes

AgentTokenCreated

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
token	string	yes
scopes	array of string	yes
projectId	string (uuid) or null	yes
expiresAt	string (date-time)	yes

AgentTokenDto

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
scopes	array of string	yes
projectId	string (uuid) or null	yes
createdBy	string	yes
createdAt	string (date-time)	yes
expiresAt	string (date-time)	yes
lastUsedAt	string (date-time) or null	yes
revokedAt	string (date-time) or null	yes

AiConnectionTest

Field	Type	Required	Notes
ok	boolean	yes
latencyMs	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
model	string	yes
reportedModel	string or null	yes
supportsStructuredOutput	boolean or null	yes
error	null or ConnectionTestError	yes
structuredOutputNote	string or null	no

AiProviderSettings

Field	Type	Required	Notes
id	string (uuid)	yes
kind	string	yes
name	string	yes
model	string	yes
baseUrl	string	no	default ""
enabled	boolean	no	default true
supportsStructuredOutput	boolean	no	default true
supportsStreaming	boolean	no	default true
temperature	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
timeoutSeconds	integer (int32) or string (int32)	no	pattern "^-?(?:0|[1-9]\\d*)$", default 60
monthlyBudgetUsd	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
requestsPerMinute	integer (int32) or string (int32) or null	no	pattern "^-?(?:0|[1-9]\\d*)$"

AiSettings

Field	Type	Required	Notes
providers	array of AiProviderSettings	yes
taskRouting	TaskRouting	yes

AiUnavailable

Field	Type	Required	Notes
status	string	yes
reason	AiUnavailableReason	yes

AiUnavailableReason

Field	Type	Required	Notes
code	string	yes
message	string	yes
setting	string or null	yes
retryAfterSeconds	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"

AiUsageResponse

Field	Type	Required	Notes
from	string (date-time)	yes
to	string (date-time)	yes
totals	array of AiUsageTotal	yes

AiUsageTotal

Field	Type	Required	Notes
providerId	string (uuid)	yes
providerKind	string	yes
model	string	yes
task	string	yes
calls	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
inputTokens	integer (int64) or string (int64) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
outputTokens	integer (int64) or string (int64) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
costUsd	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
costKnown	boolean	yes
costEstimated	boolean	yes

AliasOmitted

Field	Type	Required	Notes
elements	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
operations	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
channels	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
subscriptions	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
messages	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
relationships	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
bindings	integer (int32) or string (int32)	no	pattern "^-?(?:0|[1-9]\\d*)$", default 0

AliasTarget

Field	Type	Required	Notes
alias	string	yes
id	string (uuid) or null	yes
name	string or null	yes

Alternative

Field	Type	Required	Notes
title	string	yes
whyNot	string or null	yes

AmountDelta

Field	Type	Required	Notes
currency	string	yes
left	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
right	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
delta	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

AnswerQuestionRequest

Field	Type	Required	Notes
answer	string	yes

ApproveRequest

Field	Type	Required	Notes
revision	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
contentHash	string	yes

ArchitectureItemDto

Field	Type	Required	Notes
id	string (uuid)	yes
alias	string	yes
action	string	yes
entityKind	string	yes
name	string	yes
proposed	ProposedEntity	yes
dependsOn	array of string (uuid)	yes
confidence	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
rationale	string	yes
status	string	yes

ArchitectureItemOutput

Field	Type	Required	Notes
alias	string	yes
action	string	yes
target	string or null	yes
entityKind	string	yes
name	string	yes
description	string or null	yes
technology	string or null	yes
elementKind	string or null	yes
parent	string or null	yes
from	string or null	yes
to	string or null	yes
label	string or null	yes
relationshipKind	string or null	yes
owner	string or null	yes
transport	string or null	yes
channelKind	string or null	yes
channel	string or null	yes
consumer	string or null	yes
producer	string or null	yes
consumers	array of string or null	yes
confidence	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
rationale	string	yes

ArchitectureOutput

Field	Type	Required	Notes
summary	string	yes
items	array of ArchitectureItemOutput	yes
openQuestions	array of string	yes
reasoningSummary	string	yes

ArchitectureProposalDto

Field	Type	Required	Notes
id	string (uuid)	yes
projectId	string (uuid)	yes
branchId	string (uuid) or null	yes
request	string	yes
status	string	yes
scope	string	yes
summary	string	yes
reasoningSummary	string	yes
openQuestions	array of string	yes
items	array of ArchitectureItemDto	yes
resolvedToExisting	array of ResolvedToExisting	yes
rejectedReferences	array of RejectedReference	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
stale	boolean	yes
itemIssues	array of ProposalItemFailure	yes
omitted	AliasOmitted	yes
omittedPrivate	null or OmittedPrivate	yes
provider	ProposalProvider	yes
promptTemplateVersion	string	yes
usage	ProposalUsage	yes
createdBy	string	yes
createdAt	string (date-time)	yes
decidedBy	string or null	yes
decidedAt	string (date-time) or null	yes
origin	string	yes

ArrivalKind

Type: "constant" or "poisson" or "ramp" or "burst"

Arrivals

Field	Type	Required	Notes
kind	ArrivalKind	yes
ratePerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
toRatePerSecond	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
bursts	array of BurstWindow or null	yes
durationSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
warmUpSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
label	AssumptionLabel	no
measurementRef	string or null	no

Assertion

Type: AssertionOutcomeAssertion or AssertionEventCountAssertion

AssertionEventCountAssertion

Field	Type	Required	Notes
type	"event-count"	no
kind	TraceEventKind	yes
target	string (uuid) or null	yes
expected	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
id	string	yes

AssertionOutcome

Field	Type	Required	Notes
id	string	yes
passed	boolean	yes
detail	string	yes
vacuous	boolean	yes
vacuousReason	string or null	yes

AssertionOutcomeAssertion

Field	Type	Required	Notes
type	"outcome"	no
step	string	yes
expected	StepOutcome	yes
id	string	yes

AssertionResult

Field	Type	Required	Notes
id	string	yes
passed	boolean	yes
detail	string	yes

AssumptionLabel

Type: "declared" or "measured"

AssumptionRequest

Field	Type	Required	Notes
id	string (uuid) or null	yes
name	string	yes
kind	string	yes
subjectId	string (uuid) or null	yes
value	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit	string	yes
label	string	yes
source	string or null	yes
effectiveDate	string (date)	yes

AssumptionRow

Field	Type	Required	Notes
group	string	yes
target	string (uuid) or null	yes
name	string	yes
field	string	yes
value	string	yes
unit	string	yes
label	AssumptionLabel	yes
measurementRef	string or null	yes
measurementStale	boolean or null	no

AuditEntryDto

Field	Type	Required	Notes
at	string (date-time)	yes
actorId	string	yes
action	string	yes
target	string	yes

AuthoriseTargetRequest

Field	Type	Required	Notes
baseUrl	string or null	yes
environment	string or null	yes
version	integer (int64) or string (int64) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"

AzureImportRequest

Field	Type	Required	Notes
meterId	string	yes
skuId	string or null	yes
armRegionName	string or null	yes
currency	string	yes

AzureMeter

Field	Type	Required	Notes
meterId	string	yes
meterName	string	yes
productId	string	yes
productName	string	yes
skuId	string	yes
skuName	string	yes
armSkuName	string	yes
serviceName	string	yes
serviceFamily	string	yes
armRegionName	string	yes
location	string	yes
unitOfMeasure	string	yes
retailPrice	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
currencyCode	string	yes
effectiveStartDate	string (date) or null	yes
type	string	yes
tierMinimumUnits	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
reservationTerm	string or null	yes
isPrimaryMeterRegion	boolean or null	yes
notImportable	string or null	yes

AzureMeterPage

Field	Type	Required	Notes
items	array of AzureMeter	yes
more	boolean	yes
sourceUrl	string	yes

BacklogWindow

Field	Type	Required	Notes
fromMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
toMs	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
peakDepth	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
peakAtMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

BindingDto

Field	Type	Required	Notes
id	string (uuid)	yes
sourceChannelId	string (uuid)	yes
targetChannelId	string (uuid)	yes
routingKey	string or null	yes
factStatus	string	yes
provenance	null or ProvenanceDto	yes
stale	null or StaleDto	no

BlockedStep

Field	Type	Required	Notes
stepId	string	yes
needs	array of string	yes

Blocker

Field	Type	Required	Notes
code	string	yes
subject	string	yes
message	string	yes

Bottleneck

Field	Type	Required	Notes
label	string	yes
found	boolean	yes
id	string (uuid) or null	yes
name	string or null	yes
kind	string or null	yes
utilisation	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
saturated	array of string (uuid) or null	yes
rule	string	yes
growthRule	string or null	yes
meanDepthByQuarter	array of number (double) or string (double) or null	no
depthAtEndOfArrivals	integer (int32) or string (int32) or null	no	pattern "^-?(?:0|[1-9]\\d*)$"
growthPerSecond	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

BranchAssumption

Field	Type	Required	Notes
stepId	string	yes
probability	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
label	AssumptionLabel	no
measurementRef	string or null	no

BriefIncluded

Field	Type	Required	Notes
elementIds	array of string (uuid)	yes
operationIds	array of string (uuid)	yes
channelIds	array of string (uuid)	yes
subscriptionIds	array of string (uuid)	yes
messageIds	array of string (uuid)	yes
schemaIds	array of string (uuid)	yes
scenarioIds	array of string (uuid)	yes
requirementIds	array of string	yes

BriefManifest

Field	Type	Required	Notes
format	string	yes
generator	GeneratorInfo	yes
pinned	PinnedState	yes
selection	BriefSelection	yes
included	BriefIncluded	yes
notApproved	array of string	yes
retired	array of string	yes
unconfirmedFacts	array of string (uuid)	yes
sha256	string	yes
bytes	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
buildReady	boolean	yes
blockers	array of Blocker	yes
changeScanId	string (uuid) or null	no

BriefRequest

Field	Type	Required	Notes
promiseIds	array of string (uuid) or null	no
scenarioIds	array of string (uuid) or null	no
elementIds	array of string (uuid) or null	no
revisionId	string (uuid) or null	no
branchId	string (uuid) or null	no
changeScanId	string (uuid) or null	no

BriefResult

Field	Type	Required	Notes
brief	string	yes
manifest	BriefManifest	yes

BriefSelection

Field	Type	Required	Notes
promiseIds	array of string (uuid)	yes
scenarioIds	array of string (uuid)	yes
elementIds	array of string (uuid)	yes

BuildManifest

Field	Type	Required	Notes
format	string	yes
generator	GeneratorInfo	yes
pinned	PinnedState	yes
files	array of BundleFile	yes
bundleHash	string	yes
buildReady	boolean	yes
blockers	array of Blocker	yes
selfCheck	SelfCheck	yes

BundleFile

Field	Type	Required	Notes
path	string	yes
sha256	string	yes
bytes	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

BurstWindow

Field	Type	Required	Notes
fromSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
toSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
ratePerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

CapableEndpoint

Field	Type	Required	Notes
method	string	yes
path	string	yes
scopes	array of string	yes

CapableTool

Field	Type	Required	Notes
name	string	yes
scope	string	yes
description	string	yes

CategoryDelta

Field	Type	Required	Notes
category	string	yes
amounts	array of AmountDelta	yes
leftUnknownLines	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
rightUnknownLines	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

CategorySubtotal

Field	Type	Required	Notes
category	string	yes
known	array of Money	yes
knownLines	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
unknownLines	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ChangeImpactDto

Field	Type	Required	Notes
scanId	string (uuid)	yes
repository	string	yes
kind	string	yes
base	ImpactSideDto	yes
head	ImpactSideDto	yes
limits	array of string	yes
changes	array of ImpactChangeDto	yes
flows	array of ImpactFlowDto	yes
promises	array of ImpactPromiseDto	yes
promisesNotAffected	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ChangeMemberRoleRequest

Field	Type	Required	Notes
role	string	yes

ChannelDto

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
kind	string	yes
factStatus	string	yes
provenance	null or ProvenanceDto	yes
stale	null or StaleDto	no

ChannelId

Type: string (uuid)

ChannelStats

Field	Type	Required	Notes
label	string	yes
id	string (uuid)	yes
name	string	yes
published	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
publishFailed	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

Cited

Field	Type	Required	Notes
kind	string	yes
id	string (uuid)	yes
name	string	yes

ComparedModel

Field	Type	Required	Notes
streamId	string (uuid)	yes
version	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
revisionId	string (uuid) or null	yes
revisionName	string or null	yes

Comparison

Field	Type	Required	Notes
comparable	boolean	yes
reason	string or null	yes
cheaper	string or null	yes
difference	null or Money	yes
totals	array of AmountDelta	yes
categories	array of CategoryDelta	yes
resources	array of ResourceDelta	yes
leftUnknown	array of UnknownLine	yes
rightUnknown	array of UnknownLine	yes

ComparisonDto

Field	Type	Required	Notes
left	EstimateDto	yes
right	EstimateDto	yes
comparison	Comparison	yes

Confidence

Field	Type	Required	Notes
level	string	yes
rule	string	yes
reasons	array of string	yes

ConnectionTestError

Field	Type	Required	Notes
code	string	yes
message	string	yes

CopySheetRequest

Field	Type	Required	Notes
from	string	yes

CostAssumption

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
kind	string	yes
subjectId	string (uuid) or null	yes
value	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit	string	yes
label	string	yes
source	string or null	yes
effectiveDate	string (date)	yes

CostSettings

Field	Type	Required	Notes
provider	string	yes
region	string	yes
currency	string	yes
azureRetailPricesBaseUrl	string	no	default "https://prices.azure.com"
stalePriceAfterDays	integer (int32) or string (int32)	no	pattern "^-?(?:0|[1-9]\\d*)$", default 90

CostSheetDto

Field	Type	Required	Notes
branchId	string (uuid)	yes
version	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
resources	array of ResourceDto	yes
assumptions	array of CostAssumption	yes

Counts

Field	Type	Required	Notes
completed	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
failed	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
rejected	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
timedOut	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
dropped	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
deadLettered	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

CreateAgentTokenRequest

Field	Type	Required	Notes
name	string or null	yes
scopes	array of string or null	yes
projectId	string (uuid) or null	yes
expiresAt	string (date-time) or null	yes

CreateArchitectureProposalRequest

Field	Type	Required	Notes
request	string or null	yes
branchId	string (uuid) or null	yes
selection	array of string (uuid) or null	no

CreateCommentRequest

Field	Type	Required	Notes
id	string (uuid)	yes
body	string	yes
entityId	string (uuid) or null	no
entityType	string or null	no

CreateDocRequest

Field	Type	Required	Notes
id	string (uuid)	yes
title	string	yes
spaceId	string (uuid) or null	no
elementId	string (uuid) or null	no
draftId	string (uuid) or null	no
type	string or null	no

CreateDraftRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes

CreateFlowProposalRequest

Field	Type	Required	Notes
request	string or null	yes
branchId	string (uuid) or null	yes
reviseScenarioId	string (uuid) or null	yes
selection	array of string (uuid) or null	no

CreateProjectRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
description	string or null	yes

CreateRevisionRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
note	string or null	yes

CreateSchemaRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
description	string or null	yes
content	string	yes

CreateSpaceRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes

CreateVariantRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
baseRevisionId	string (uuid) or null	yes
costSheetFrom	string or null	no

CreateViewRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
rootElementId	string (uuid) or null	yes

CreateWorkspaceRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes

CritiqueDto

Field	Type	Required	Notes
id	string (uuid)	yes
projectId	string (uuid)	yes
branchId	string (uuid) or null	yes
question	string	yes
focus	array of string (uuid)	yes
questions	array of CritiqueQuestion	yes
risks	array of CritiqueRisk	yes
proposedDecisions	array of CritiqueProposedDecision	yes
leftOut	array of CritiqueLeftOut	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
findingsHash	string	yes
stale	boolean	yes
findingsSent	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
findingsLeftOut	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
omitted	AliasOmitted	yes
omittedPrivate	null or OmittedPrivate	yes
provider	ProposalProvider	yes
promptTemplateVersion	string	yes
usage	ProposalUsage	yes
disclaimer	string	yes
createdBy	string	yes
createdAt	string (date-time)	yes

CritiqueLeftOut

Field	Type	Required	Notes
where	string	yes
reason	string	yes

CritiqueProposedDecision

Field	Type	Required	Notes
title	string	yes
context	string	yes
decision	string	yes
alternatives	array of Alternative	yes
settles	array of Settles	yes
about	array of Cited	yes
keptAs	string (uuid) or null	no

CritiqueQuestion

Field	Type	Required	Notes
about	array of Cited	yes
text	string	yes
why	string or null	yes
source	string	yes
note	string or null	yes
keptAs	string (uuid) or null	no

CritiqueRequest

Field	Type	Required	Notes
question	string or null	no
focus	array of string (uuid) or null	no
branchId	string (uuid) or null	no

CritiqueRisk

Field	Type	Required	Notes
about	array of Cited	yes
claim	string	yes
ruleId	string	yes
subjectId	string (uuid)	yes
findingResult	string or null	no
findingReason	string or null	no
claimSource	string	no	default "assistant"

CritiqueSummary

Field	Type	Required	Notes
id	string (uuid)	yes
branchId	string (uuid) or null	yes
question	string	yes
createdBy	string	yes
createdAt	string (date-time)	yes

CustomPriceRequest

Field	Type	Required	Notes
provider	string	yes
region	string or null	yes
sku	string	yes
description	string or null	yes
unit	string	yes
unitPrice	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
currency	string	yes
effectiveDate	string (date)	yes

DatabaseDiagnostics

Field	Type	Required	Notes
reachable	boolean	yes

DecideArchitectureProposalRequest

Field	Type	Required	Notes
accept	array of string (uuid) or null	yes
reject	array of string (uuid) or null	yes

DecideProposalsRequest

Field	Type	Required	Notes
accept	array of string (uuid) or null	yes
reject	array of string (uuid) or null	yes
relink	array of RelinkChoice or null	no
acknowledgeImpact	boolean	no	default false

DecideProposalsResponse

Field	Type	Required	Notes
accepted	array of string (uuid)	yes
rejected	array of string (uuid)	yes
failed	array of DecisionFailure	yes
relinked	array of string (uuid)	yes

DecisionChangedResponse

Field	Type	Required	Notes
type	string	yes
title	string	yes
detail	string	yes
contentHash	string	yes

DecisionDto

Field	Type	Required	Notes
id	string (uuid)	yes
projectId	string (uuid)	yes
number	string	yes
title	string	yes
status	string	yes
origin	string	yes
context	string	yes
decision	string	yes
alternatives	array of Alternative	yes
consequences	string or null	yes
affectedIds	array of string (uuid)	yes
settles	array of Settles	yes
stamps	array of SettlementStamp	yes
supersedes	string (uuid) or null	yes
supersededBy	string (uuid) or null	yes
createdBy	string	yes
createdAt	string (date-time)	yes
updatedAt	string (date-time)	yes
acceptedBy	string or null	yes
acceptedAt	string (date-time) or null	yes
history	array of DecisionHistoryEntry	yes
contentHash	string	yes

DecisionFailure

Field	Type	Required	Notes
id	string (uuid)	yes
reason	string	yes

DecisionHistoryEntry

Field	Type	Required	Notes
at	string (date-time)	yes
by	string	yes
action	string	yes
note	string or null	yes

DecisionRequest

Field	Type	Required	Notes
title	string	yes
context	string or null	yes
decision	string	yes
alternatives	array of Alternative or null	yes
consequences	string or null	yes
affectedIds	array of string (uuid) or null	yes
settles	array of Settles or null	yes
supersedes	string (uuid) or null	yes
origin	string or null	no

DiagnosticsResponse

Field	Type	Required	Notes
profile	string	yes
version	string	yes
database	DatabaseDiagnostics	yes
migrations	array of ModuleMigrations	yes
eventStore	EventStoreDiagnostics	yes
masterKeyId	string	yes
previousMasterKeyLoaded	boolean	yes
masterKeysInUse	array of MasterKeyInUse	yes
telemetry	TelemetryDiagnostics	yes

Distribution

Field	Type	Required	Notes
kind	DistributionKind	yes
ms	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
meanMs	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
medianMs	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p95Ms	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
minMs	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
maxMs	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

DistributionKind

Type: "fixed" or "exponential" or "lognormal" or "uniform"

DrainStats

Field	Type	Required	Notes
label	string	yes
drained	boolean	yes
timeToDrainMs	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
leftInSystem	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

EffectiveLimits

Field	Type	Required	Notes
maxDurationSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
maxDrainSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
maxArrivals	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxEvents	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxQueued	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxPendingEvents	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxSamples	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxSeriesPoints	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxTargets	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ElementDto

Field	Type	Required	Notes
id	string (uuid)	yes
kind	string	yes
name	string	yes
description	string or null	yes
technology	string or null	yes
ownerId	string (uuid) or null	yes
status	string	yes
parentId	string (uuid) or null	yes
tags	array of string	yes
icon	string or null	yes
factStatus	string	yes
provenance	null or ProvenanceDto	yes
stale	null or StaleDto	no

ElementId

Type: string (uuid)

ErrorResponse

Field	Type	Required	Notes
type	string	yes
title	string	yes
detail	string or null	no
errors	array of FieldError or null	no

Estimate

Field	Type	Required	Notes
engine	string	yes
asOf	string (date)	yes
currency	string	yes
staleAfterDays	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
lines	array of EstimateLine	yes
categories	array of CategorySubtotal	yes
totals	array of Money	yes
unknown	array of UnknownLine	yes

EstimateComparisonDto

Field	Type	Required	Notes
estimate	StressRunSummaryDto	yes
measured	MeasuredResultSummaryDto	yes
rows	array of EstimateRow	yes
differences	array of string	yes
note	string	yes

EstimateDto

Field	Type	Required	Notes
branchId	string (uuid)	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
sheetVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
inputsFingerprint	string	yes
hash	string	yes
estimate	Estimate	yes

EstimateLine

Field	Type	Required	Notes
id	string	yes
resourceId	string (uuid)	yes
usageLineId	string (uuid) or null	yes
elementId	string (uuid)	yes
resourceName	string	yes
name	string	yes
kind	string	yes
category	string	yes
provider	string	yes
region	string	yes
status	string	yes
reason	string or null	yes
detail	string or null	yes
flags	array of string	yes
quantity	null or QuantitySource	yes
price	null or PriceSource	yes
conversion	string or null	yes
units	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
amount	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
currency	string or null	yes

EstimateRow

Field	Type	Required	Notes
scope	string	yes
target	string (uuid) or null	yes
name	string	yes
metric	string	yes
unit	string	yes
estimated	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
estimatedLabel	string	yes
measured	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
measuredLabel	string	yes
difference	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
reason	string or null	yes

EventStoreConsumer

Field	Type	Required	Notes
name	string	yes
mode	string	yes
status	string	yes
lag	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

EventStoreDiagnostics

Field	Type	Required	Notes
reachable	boolean	yes
head	integer (int64) or string (int64) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
consumers	array of EventStoreConsumer	yes

EvidenceCountsDto

Field	Type	Required	Notes
passed	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
failed	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
notRun	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
unsupported	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
stale	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

EvidenceDto

Field	Type	Required	Notes
path	string	yes
startLine	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
endLine	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
rule	string	yes
pointer	string	yes
url	string	yes

EvidenceItem

Field	Type	Required	Notes
kind	string	yes
hash	string or null	no
scenarioId	string (uuid) or null	no
pointer	string or null	no
url	string or null	no
source	null or ExternalSource	no
artifactDigest	string or null	no
identity	string or null	no
identityReason	string or null	no
claimedResult	string or null	no

EvidenceItemDto

Field	Type	Required	Notes
factKey	string	yes
kind	string	yes
name	string	yes
attributes	map of string to string	yes
evidence	array of EvidenceDto	yes
reason	string	yes

EvidenceSource

Field	Type	Required	Notes
system	string	yes
repository	string	yes
workflow	string	yes
job	string or null	yes

EvidenceStatusDto

Field	Type	Required	Notes
counts	EvidenceCountsDto	yes
obligations	array of ObligationStatusDto	yes
modelRevisions	array of string	yes
commits	array of string	yes
environments	array of string	yes
gaps	array of string	yes

ExecuteMergeRequest

Field	Type	Required	Notes
resolutions	array of MergeResolution	yes
expectedMainVersion	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ExplainDelta

Field	Type	Required	Notes
delta	string	yes

ExplainRequest

Field	Type	Required	Notes
target	null or ExplainTarget	yes
question	string or null	yes
branchId	string (uuid) or null	yes

ExplainTarget

Field	Type	Required	Notes
kind	string or null	yes
id	string (uuid) or null	yes
scenarioId	string (uuid) or null	yes
sequence	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ExportRequest

Field	Type	Required	Notes
revisionId	string (uuid) or null	no
branchId	string (uuid) or null	no
format	string	no	default "bundle"
pinned	null or PinnedState	no

ExternalSource

Field	Type	Required	Notes
system	string	yes
runUrl	string	yes
commitSha	string	yes
jobName	string or null	yes
conclusion	string	yes
repository	string or null	no
workflow	string or null	no
runId	integer (int64) or string (int64) or null	no	pattern "^-?(?:0|[1-9]\\d*)$"

ExternalSourceRequest

Field	Type	Required	Notes
system	string	yes
runUrl	string	yes
commitSha	string or null	no
conclusion	string or null	no

Fault

Field	Type	Required	Notes
target	string (uuid)	yes
kind	FaultKind	yes
failFirst	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"

FaultKind

Type: "Error" or "Timeout" or "Outage"

FetchedFrom

Field	Type	Required	Notes
url	string	yes
fetchedAt	string (date-time)	yes
meterId	string	yes
providerEffectiveDate	string (date) or null	yes

FieldError

Field	Type	Required	Notes
field	string	yes
message	string	yes

Finding

Field	Type	Required	Notes
ruleId	string	yes
ruleVersion	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
category	string	yes
severity	string	yes
result	string	yes
subject	Cited	yes
cites	array of Cited	yes
reason	string	yes
wouldChange	string	yes
question	string or null	yes
fingerprint	string	yes
fired	boolean	no

FindingsResponse

Field	Type	Required	Notes
projectId	string (uuid)	yes
branch	string (uuid)	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
revisionId	string (uuid) or null	yes
inputsFingerprint	string	yes
ruleSetVersion	string	yes
hash	string	yes
counts	ReviewCounts	yes
findings	array of FindingView	yes

FindingView

Field	Type	Required	Notes
finding	Finding	yes
status	string	yes
decisionId	string (uuid) or null	yes
decision	string or null	yes
reason	string or null	yes
needsReReview	boolean	yes
settled	boolean	no
blocks	boolean	no

FlowAssertionOutput

Field	Type	Required	Notes
id	string	yes
type	string	yes
step	string or null	yes
expected	string or null	yes
eventKind	string or null	yes
target	string or null	yes
expectedCount	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"

FlowDiff

Field	Type	Required	Notes
addedSteps	array of string	yes
removedSteps	array of string	yes
changedSteps	array of string	yes

FlowEvidenceDto

Field	Type	Required	Notes
alias	string	yes
id	string (uuid)	yes
name	string	yes
why	string	yes

FlowEvidenceOutput

Field	Type	Required	Notes
alias	string	yes
why	string	yes

FlowFaultOutput

Field	Type	Required	Notes
target	string	yes
kind	string	yes
failFirst	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"

FlowMissingDto

Field	Type	Required	Notes
alias	string	yes
kind	string	yes
name	string	yes
elementKind	string or null	yes
transport	string or null	yes
channelKind	string or null	yes
parent	null or AliasTarget	yes
owner	null or AliasTarget	yes
channel	null or AliasTarget	yes
consumer	null or AliasTarget	yes
reason	string	yes
confidence	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
createdId	string (uuid) or null	yes
createAfter	array of string	yes

FlowMissingOutput

Field	Type	Required	Notes
alias	string	yes
kind	string	yes
name	string	yes
elementKind	string or null	yes
parentAlias	string or null	yes
ownerAlias	string or null	yes
transport	string or null	yes
channelKind	string or null	yes
channelAlias	string or null	yes
consumerAlias	string or null	yes
reason	string	yes
confidence	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

FlowOutput

Field	Type	Required	Notes
name	string	yes
summary	string	yes
steps	array of FlowStepOutput	yes
faults	array of FlowFaultOutput	yes
assertions	array of FlowAssertionOutput	yes
missing	array of FlowMissingOutput	yes
openQuestions	array of string	yes
reasoningSummary	string	yes
evidence	array of FlowEvidenceOutput	yes

FlowPreview

Field	Type	Required	Notes
hash	string	yes
eventCount	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
outcomes	map of string to StepOutcome	yes

FlowProposalDto

Field	Type	Required	Notes
id	string (uuid)	yes
projectId	string (uuid)	yes
branchId	string (uuid) or null	yes
request	string	yes
status	string	yes
name	string	yes
summary	string	yes
reasoningSummary	string	yes
openQuestions	array of string	yes
scenario	Scenario	yes
blockedSteps	array of BlockedStep	yes
missing	array of FlowMissingDto	yes
resolvedToExisting	array of ResolvedToExisting	yes
rejectedReferences	array of RejectedReference	yes
issues	array of ScenarioIssue	yes
preview	null or FlowPreview	yes
diff	null or FlowDiff	yes
evidence	array of FlowEvidenceDto	yes
reviseScenarioId	string (uuid) or null	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
stale	boolean	yes
omitted	AliasOmitted	yes
omittedPrivate	null or OmittedPrivate	yes
provider	ProposalProvider	yes
promptTemplateVersion	string	yes
usage	ProposalUsage	yes
createdBy	string	yes
createdAt	string (date-time)	yes
decidedBy	string or null	yes
decidedAt	string (date-time) or null	yes
origin	string	yes

FlowStats

Field	Type	Required	Notes
label	string	yes
arrivals	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
counts	Counts	yes
throughputPerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
latency	LatencySummary	yes

FlowStepOutput

Field	Type	Required	Notes
id	string	yes
parentStepId	string or null	yes
slot	string	yes
slotKey	string or null	yes
order	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
type	string	yes
from	string or null	yes
operation	string or null	yes
channel	string or null	yes
message	string or null	yes
by	string or null	yes
store	string or null	yes
dataset	string or null	yes
whenStep	string or null	yes
is	string or null	yes
requestJson	string or null	yes
responseJson	string or null	yes
payloadJson	string or null	yes
changeJson	string or null	yes
routingKey	string or null	no

ForbiddenEvent

Field	Type	Required	Notes
kind	TraceEventKind	yes
target	string (uuid) or null	yes

GenerateObligationsResponse

Field	Type	Required	Notes
promise	PromiseDto	yes
added	array of string	yes
skipped	array of Skipped	yes

GenerateScriptRequest

Field	Type	Required	Notes
targetId	string (uuid)	yes
profileId	string (uuid)	yes

GeneratorInfo

Field	Type	Required	Notes
name	string	yes
version	string	yes

GithubSettings

Field	Type	Required	Notes
apiBaseUrl	string	yes
defaultRef	string	yes

GitHubTestResponse

Field	Type	Required	Notes
ok	boolean	yes
authenticatedAs	string or null	yes
rateLimitRemaining	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
error	null or ConnectionTestError	yes

ImpactChangeDto

Field	Type	Required	Notes
id	string	yes
kind	string	yes
action	string	yes
entityKind	string	yes
entityId	string (uuid) or null	yes
name	string	yes
certainty	string	yes
basis	string	yes
diff	array of ProposalChangeDto	yes
evidence	array of EvidenceDto	yes
elementId	string (uuid) or null	yes
pattern	string or null	yes

ImpactCheckDto

Field	Type	Required	Notes
obligationId	string	yes
key	string	yes
title	string	yes
result	string	yes
detail	string or null	yes

ImpactEntityDto

Field	Type	Required	Notes
entityKind	string	yes
id	string (uuid)	yes
name	string	yes

ImpactFlowDto

Field	Type	Required	Notes
scenarioId	string (uuid)	yes
name	string	yes
stepIds	array of string	yes
certainty	string	yes
reasons	array of ImpactReasonDto	yes

ImpactPromiseDto

Field	Type	Required	Notes
id	string (uuid)	yes
requirementId	string	yes
title	string	yes
state	string	yes
revision	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
standing	string	yes
certainty	string	yes
reasons	array of ImpactReasonDto	yes
checks	array of ImpactCheckDto	yes

ImpactReasonDto

Field	Type	Required	Notes
certainty	string	yes
changeId	string	yes
text	string	yes

ImpactScenarioDto

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
stepIds	array of string	yes

ImpactSideDto

Field	Type	Required	Notes
scanId	string (uuid) or null	yes
ref	string or null	yes
commitSha	string or null	yes

ImportItem

Field	Type	Required	Notes
kind	string	yes
id	string (uuid)	yes
name	string or null	yes
change	string	yes
error	string or null	no
importedAs	string (uuid) or null	no

ImportResult

Field	Type	Required	Notes
applied	boolean	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
added	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
changed	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
unchanged	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
refused	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
items	array of ImportItem	yes

ImportSettings

Field	Type	Required	Notes
maxFiles	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxFileBytes	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxTotalBytes	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
excludeGlobs	array of string	yes

InputChange

Field	Type	Required	Notes
kind	string	yes
id	string (uuid) or null	yes
name	string	yes
change	string	yes

InputDifference

Field	Type	Required	Notes
input	string	yes
target	string (uuid) or null	yes
name	string	yes
left	string or null	yes
right	string or null	yes

InstanceInfoResponse

Field	Type	Required	Notes
profile	string	yes
version	string	yes
isInstanceAdmin	boolean	yes
allowSelfRegistration	boolean	yes

InstancePolicy

Field	Type	Required	Notes
allowSelfRegistration	boolean	yes
allowPrivateNetworkUrls	boolean	yes
allowedAiProviderKinds	array of string	yes
allowSendingPrivateCodeToAi	boolean	yes
maxConcurrentStressRuns	integer (int32) or string (int32)	no	pattern "^-?(?:0|[1-9]\\d*)$", default 4

InstanceSettingsResponse

Field	Type	Required	Notes
policy	InstancePolicy	yes
defaults	SettingsDocument	yes
version	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
workspacesWithPolicyViolations	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

InviteMemberRequest

Field	Type	Required	Notes
userId	string or null	yes
role	string	yes
email	string or null	no

JsonDocument

Type: any

JsonElement

Type: any

JsonObject

Type: object

K6NotCovered

Field	Type	Required	Notes
stepId	string	yes
kind	string	yes
reason	string	yes

K6Operation

Field	Type	Required	Notes
index	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
operationId	string (uuid)	yes
name	string	yes
ownerId	string (uuid)	yes
ownerName	string	yes

K6Plan

Field	Type	Required	Notes
generator	string	yes
executor	string	yes
operations	array of K6Operation	yes
steps	array of K6Step	yes
notCovered	array of K6NotCovered	yes
notes	array of string	yes
warmUpMs	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
durationMs	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
faults	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
load	string or null	no
plannedIterations	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
minElapsedMs	integer (int64) or string (int64) or null	no	pattern "^-?(?:0|[1-9]\\d*)$"
loadNotes	array of string or null	no

K6Step

Field	Type	Required	Notes
stepId	string	yes
operation	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
method	string	yes
path	string	yes
hasBody	boolean	yes
expect	string	yes
timeoutMs	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

KeepQuestionRequest

Field	Type	Required	Notes
proposalId	string (uuid)	yes
index	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

LatencySummary

Field	Type	Required	Notes
label	string	yes
count	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
kept	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
reservoir	boolean	yes
minMs	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
meanMs	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p50Ms	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p90Ms	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p95Ms	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p99Ms	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
maxMs	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

LinkedFactCoverageDto

Field	Type	Required	Notes
covered	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
notCovered	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
scope	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
limit	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
withheld	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
failed	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

LoginRequest

Field	Type	Required	Notes
email	string	yes
password	string	yes

MasterKeyInUse

Field	Type	Required	Notes
masterKeyId	string	yes
secrets	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
dataProtectionKeys	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
isCurrent	boolean	yes
isLoaded	boolean	yes

MeasuredFlowDto

Field	Type	Required	Notes
label	string	yes
iterations	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
unexpectedStatus	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
droppedIterations	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
unexpectedStatusRate	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
throughputPerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
latency	null or MeasuredLatencyDto	yes

MeasuredLatencyDto

Field	Type	Required	Notes
label	string	yes
count	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
minMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
meanMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p50Ms	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p90Ms	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p95Ms	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p99Ms	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
maxMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

MeasuredOperationDto

Field	Type	Required	Notes
label	string	yes
operationId	string (uuid)	yes
name	string	yes
requests	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
unexpectedStatus	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
unexpectedStatusRate	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
throughputPerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
latency	null or MeasuredLatencyDto	yes
expectedFailures	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
expectedFailureLatency	null or MeasuredLatencyDto	yes

MeasuredProvenance

Field	Type	Required	Notes
kind	string	yes
format	string	yes
scriptId	string (uuid)	yes
scriptHash	string	yes
contentHash	string	yes
targetId	string (uuid)	yes
targetName	string	yes
baseUrl	string	yes
environment	string	yes
importedBy	string	yes
importedVia	string or null	yes
importedAt	string (date-time)	yes

MeasuredResultDto

Field	Type	Required	Notes
result	MeasuredResultSummaryDto	yes
operations	array of MeasuredOperationDto	yes
notCovered	array of K6NotCovered	yes
faults	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
expectsFailure	boolean	yes

MeasuredResultSummaryDto

Field	Type	Required	Notes
id	string (uuid)	yes
label	string	yes
scenarioId	string (uuid)	yes
scenarioVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
modelStreamId	string (uuid)	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
profileId	string (uuid)	yes
profileVersion	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
startedAt	string (date-time)	yes
endedAt	string (date-time)	yes
measuredSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
provenance	MeasuredProvenance	yes
flow	MeasuredFlowDto	yes
stale	boolean	yes
staleBecause	array of string	yes

MemberDto

Field	Type	Required	Notes
userId	string	yes
email	string or null	yes
displayName	string or null	yes
role	string	yes
createdAt	string (date-time) or null	yes

MembershipDto

Field	Type	Required	Notes
id	string (uuid)	yes
workspaceId	string (uuid)	yes
userId	string	yes
role	string	yes
createdAt	string (date-time)	yes

MembersResponse

Field	Type	Required	Notes
yourRole	string	yes
members	array of MemberDto	yes

MergeResolution

Field	Type	Required	Notes
entityId	string (uuid)	yes
resolution	string	yes

MessageDto

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
description	string or null	yes
producerId	string (uuid)	yes
consumerIds	array of string (uuid)	yes
schemaId	string (uuid) or null	yes
tags	array of string	yes
factStatus	string	yes
provenance	null or ProvenanceDto	yes
stale	null or StaleDto	no

MessageId

Type: string (uuid)

MetricDelta

Field	Type	Required	Notes
scope	string	yes
target	string (uuid) or null	yes
name	string	yes
metric	string	yes
unit	string	yes
left	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
right	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
delta	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

MissingLinkDto

Field	Type	Required	Notes
kind	string	yes
id	string (uuid)	yes

ModelComparisonDto

Field	Type	Required	Notes
left	ComparedModel	yes
right	ComparedModel	yes
changes	array of ModelDifference	yes

ModelDifference

Field	Type	Required	Notes
entityType	string	yes
entityId	string (uuid)	yes
changeKind	string	yes
left	any	yes
right	any	yes

ModelPin

Field	Type	Required	Notes
streamId	string (uuid)	yes
version	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
revisionId	string (uuid) or null	yes
revisionName	string or null	yes

ModelPriceDto

Field	Type	Required	Notes
providerKind	string	yes
model	string	yes
inputUsdPerMillionTokens	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
outputUsdPerMillionTokens	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
effectiveFrom	string (date-time)	yes

ModuleMigrations

Field	Type	Required	Notes
module	string	yes
applied	array of string	yes
pending	array of string	yes

Money

Field	Type	Required	Notes
currency	string	yes
amount	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

MovedInput

Field	Type	Required	Notes
kind	string	yes
id	string	yes
pinned	string or null	yes
current	string or null	yes

NotificationSettings

Field	Type	Required	Notes
webhookUrl	string or null	yes

ObligationDto

Field	Type	Required	Notes
id	string	yes
key	string	yes
number	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
kind	string	yes
supported	boolean	yes
execution	string	yes
title	string	yes
recipe	ObligationRecipe	yes
source	string	yes
addedBy	string or null	no
lastChangedBy	string or null	no

ObligationRecipe

Field	Type	Required	Notes
text	string	yes
scenarioCheck	null or ScenarioCheckRecipe	no
sourcePattern	null or SourcePatternRecipe	no
plan	null or TestPlanRecipe	no

ObligationRequest

Field	Type	Required	Notes
kind	string	yes
title	string	yes
recipe	ObligationRecipe	yes

ObligationStatusDto

Field	Type	Required	Notes
obligationId	string	yes
result	string	yes
current	boolean or null	yes
runId	string (uuid) or null	yes
at	string (date-time) or null	yes
environment	string or null	yes
modelRevision	null or ModelPin	yes
commitSha	string or null	yes
scanId	string (uuid) or null	yes
scope	string or null	yes
evidence	array of EvidenceItem	yes
limitations	array of string	yes
detail	string or null	yes
inputs	null or RunInputs	yes
changed	array of string	yes
assertions	array of AssertionOutcome or null	yes
effectiveFaults	array of Fault or null	yes

OmittedPrivate

Field	Type	Required	Notes
count	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
reason	string	yes

OperationDto

Field	Type	Required	Notes
id	string (uuid)	yes
ownerId	string (uuid)	yes
name	string	yes
transport	string	yes
requestSchemaId	string (uuid) or null	yes
responseSchemaId	string (uuid) or null	yes
timeoutMs	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
retry	RetryDto	yes
factStatus	string	yes
provenance	null or ProvenanceDto	yes
stale	null or StaleDto	no

OperationId

Type: string (uuid)

OperationStats

Field	Type	Required	Notes
label	string	yes
id	string (uuid)	yes
name	string	yes
ownerId	string (uuid)	yes
timeoutMs	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxAttempts	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
backoffMs	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
attempts	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
counts	Counts	yes
retries	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
exhausted	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
wasted	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
throughputPerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
latency	LatencySummary	yes

Outage

Field	Type	Required	Notes
target	string (uuid)	yes
fromSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
toSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

OutageTarget

Field	Type	Required	Notes
id	string (uuid)	yes
kind	string	yes
name	string	yes

OverrideRow

Field	Type	Required	Notes
target	string (uuid)	yes
name	string	yes
field	string	yes
modelValue	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
profileValue	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
label	AssumptionLabel	yes
measurementRef	string or null	yes

PageOfBindingDto

Field	Type	Required	Notes
items	array of BindingDto	yes
cursor	string or null	yes

PageOfChannelDto

Field	Type	Required	Notes
items	array of ChannelDto	yes
cursor	string or null	yes

PageOfCritiqueSummary

Field	Type	Required	Notes
items	array of CritiqueSummary	yes
cursor	string or null	yes

PageOfDecisionDto

Field	Type	Required	Notes
items	array of DecisionDto	yes
cursor	string or null	yes

PageOfEvidenceItemDto

Field	Type	Required	Notes
items	array of EvidenceItemDto	yes
cursor	string or null	yes

PageOfOperationDto

Field	Type	Required	Notes
items	array of OperationDto	yes
cursor	string or null	yes

PageOfPriceEntryDto

Field	Type	Required	Notes
items	array of PriceEntryDto	yes
cursor	string or null	yes

PageOfPromiseSummaryDto

Field	Type	Required	Notes
items	array of PromiseSummaryDto	yes
cursor	string or null	yes

PageOfProposalSummary

Field	Type	Required	Notes
items	array of ProposalSummary	yes
cursor	string or null	yes

PageOfQuestionDto

Field	Type	Required	Notes
items	array of QuestionDto	yes
cursor	string or null	yes

PageOfScanDto

Field	Type	Required	Notes
items	array of ScanDto	yes
cursor	string or null	yes

PageOfScenarioSummaryDto

Field	Type	Required	Notes
items	array of ScenarioSummaryDto	yes
cursor	string or null	yes

PageOfSnapshotSummary

Field	Type	Required	Notes
items	array of SnapshotSummary	yes
cursor	string or null	yes

PageOfSubscriptionDto

Field	Type	Required	Notes
items	array of SubscriptionDto	yes
cursor	string or null	yes

PageOfVerificationRun

Field	Type	Required	Notes
items	array of VerificationRun	yes
cursor	string or null	yes

PinnedRun

Field	Type	Required	Notes
promiseId	string (uuid)	yes
promiseRevision	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
obligationId	string	yes
runId	string (uuid)	yes

PinnedSource

Field	Type	Required	Notes
repository	string	yes
trackedRef	string or null	yes
trackedCommit	string or null	yes
trackedScan	string (uuid) or null	yes
latestCommit	string or null	yes
latestScan	string (uuid) or null	yes

PinnedState

Field	Type	Required	Notes
projectId	string (uuid)	yes
projectName	string	yes
branch	string (uuid)	yes
streamVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
revisionId	string (uuid) or null	yes
scenarios	array of PinnedStream	yes
schemas	array of PinnedStream	yes
promises	array of PinnedStream	yes
runs	array of PinnedRun	yes
sources	array of PinnedSource	yes
decisions	array of PinnedStream or null	no
seal	string or null	no

PinnedStream

Field	Type	Required	Notes
id	string (uuid)	yes
version	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

PolicyOverride

Field	Type	Required	Notes
target	string (uuid)	yes
timeoutMs	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxAttempts	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
backoffMs	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
label	AssumptionLabel	no
measurementRef	string or null	no

PolicyViolation

Field	Type	Required	Notes
field	string	yes
message	string	yes

PrefixDto

Field	Type	Required	Notes
prefix	string or null	yes
nextNumber	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"

PriceEntryDto

Field	Type	Required	Notes
id	string (uuid)	yes
provider	string	yes
region	string	yes
sku	string	yes
description	string or null	yes
unit	string	yes
unitPrice	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
currency	string	yes
effectiveDate	string (date)	yes
source	string	yes
acceptedBy	string	yes
acceptedAt	string (date-time)	yes
fetched	null or FetchedFrom	yes
unitReadable	boolean	yes

PriceSource

Field	Type	Required	Notes
priceId	string (uuid)	yes
provider	string or null	yes
region	string or null	yes
sku	string or null	yes
meterId	string or null	yes
unitPrice	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit	string	yes
currency	string	yes
source	string	yes
effectiveDate	string (date)	yes
observedOn	string (date)	yes

PrivacySettings

Field	Type	Required	Notes
sendPrivateCodeToAi	boolean	yes

ProfileMeasurement

Field	Type	Required	Notes
target	string (uuid)	yes
measurementRef	string	yes
measurementStale	boolean	yes
staleBecause	array of string	yes

ProjectDetailDto

Field	Type	Required	Notes
id	string (uuid)	yes
workspaceId	string (uuid)	yes
name	string	yes
description	string or null	yes
streamId	string (uuid)	yes
createdAt	string (date-time)	yes
yourRole	string	yes

ProjectPricesDto

Field	Type	Required	Notes
workspaceId	string (uuid)	yes
entries	array of PriceEntryDto	yes
pinned	array of string (uuid)	yes

PromiseDto

Field	Type	Required	Notes
id	string (uuid)	yes
projectId	string (uuid)	yes
requirementId	string	yes
origin	string	yes
state	string	yes
latestRevision	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
inForceRevision	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
needsReview	boolean	yes
missingLinks	array of MissingLinkDto	yes
current	PromiseRevisionDto	yes
draft	null or PromiseRevisionDto	yes
revisions	array of PromiseRevisionDto	yes
createdBy	string	yes
createdAt	string (date-time)	yes
updatedAt	string (date-time)	yes

PromiseLinks

Field	Type	Required	Notes
scenarioIds	array of string (uuid)	yes
operationIds	array of string (uuid)	yes
channelIds	array of string (uuid)	yes
subscriptionIds	array of string (uuid)	yes
messageIds	array of string (uuid)	yes
elementIds	array of string (uuid)	yes

PromiseRequest

Field	Type	Required	Notes
title	string	yes
claim	string	yes
scope	string or null	yes
preconditions	string or null	yes
expectedOutcome	string or null	yes
forbiddenOutcome	string or null	yes
evidenceCriteria	string or null	yes
forbiddenEvents	array of ForbiddenEvent or null	yes
requiresPattern	null or RequiredPattern	yes
links	null or PromiseLinks	yes
origin	string or null	no

PromiseRevisionDto

Field	Type	Required	Notes
revision	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
status	string	yes
retires	boolean	yes
retiresRevision	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
inForce	boolean	yes
title	string	yes
claim	string	yes
scope	string or null	yes
preconditions	string or null	yes
expectedOutcome	string or null	yes
forbiddenOutcome	string or null	yes
evidenceCriteria	string or null	yes
forbiddenEvents	array of ForbiddenEvent	yes
requiresPattern	null or RequiredPattern	yes
links	PromiseLinks	yes
obligations	array of ObligationDto	yes
createdBy	string	yes
createdAt	string (date-time)	yes
approvedBy	string or null	yes
approvedAt	string (date-time) or null	yes
approvedModelVersion	integer (int64) or string (int64) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
contentHash	string	yes
approvedContentHash	string or null	yes
evidenceStatus	EvidenceStatusDto	yes
lastChangedBy	string or null	no
lastChangedAt	string (date-time) or null	no

PromiseSummaryDto

Field	Type	Required	Notes
id	string (uuid)	yes
requirementId	string	yes
title	string	yes
state	string	yes
origin	string	yes
latestRevision	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
inForceRevision	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
hasDraft	boolean	yes
needsReview	boolean	yes
counts	EvidenceCountsDto	yes
hasGaps	boolean	yes
updatedAt	string (date-time)	yes
draftLastChangedBy	string or null	no

ProposalChangeDto

Field	Type	Required	Notes
field	string	yes
from	string or null	yes
to	string or null	yes

ProposalCountsDto

Field	Type	Required	Notes
pending	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
accepted	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
rejected	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ProposalDto

Field	Type	Required	Notes
id	string (uuid)	yes
action	string	yes
entityKind	string	yes
entityId	string (uuid)	yes
subject	string	yes
factKey	string	yes
name	string	yes
proposed	null or JsonObject	yes
current	null or JsonObject	yes
changes	array of ProposalChangeDto	yes
evidence	array of EvidenceDto	yes
dependsOn	array of string (uuid)	yes
status	string	yes
partial	boolean	yes
canDecide	boolean	yes
canDecideReason	string or null	yes
impact	null or ProposalImpactDto	yes
truncated	boolean	yes

ProposalImpactDto

Field	Type	Required	Notes
scenarios	array of ImpactScenarioDto	yes
entities	array of ImpactEntityDto	yes
isEmpty	boolean	no

ProposalItemFailure

Field	Type	Required	Notes
itemId	string (uuid)	yes
reason	string	yes

ProposalItemsRefused

Field	Type	Required	Notes
type	string	yes
title	string	yes
failures	array of ProposalItemFailure	yes

ProposalPage

Field	Type	Required	Notes
items	array of ProposalDto	yes
cursor	string or null	yes
notCovered	null or LinkedFactCoverageDto	yes

ProposalProvider

Field	Type	Required	Notes
kind	string	yes
model	string	yes
reportedModel	string or null	yes

ProposalStale

Field	Type	Required	Notes
type	string	yes
title	string	yes
issues	array of ScenarioIssue	yes
preview	null or FlowPreview	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ProposalSummary

Field	Type	Required	Notes
id	string (uuid)	yes
status	string	yes
name	string	yes
request	string	yes
branchId	string (uuid) or null	yes
createdBy	string	yes
createdAt	string (date-time)	yes
decidedBy	string or null	yes
decidedAt	string (date-time) or null	yes
origin	string	yes

ProposalUsage

Field	Type	Required	Notes
inputTokens	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
outputTokens	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
costUsd	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

ProposedEntity

Field	Type	Required	Notes
kind	string or null	yes
name	string or null	yes
description	string or null	yes
technology	string or null	yes
parentId	string (uuid) or null	yes
fromId	string (uuid) or null	yes
toId	string (uuid) or null	yes
label	string or null	yes
ownerId	string (uuid) or null	yes
transport	string or null	yes
channelId	string (uuid) or null	yes
consumerId	string (uuid) or null	yes
producerId	string (uuid) or null	yes
consumerIds	array of string (uuid) or null	yes

ProvenanceDto

Field	Type	Required	Notes
source	string or null	yes
revision	string or null	yes
confidence	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
acceptedBy	string (uuid) or null	yes
acceptedAt	string (date-time) or null	yes

ProvenanceInput

Field	Type	Required	Notes
source	string or null	yes
revision	string or null	yes
confidence	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

QuantitySource

Field	Type	Required	Notes
value	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit	string	yes
label	string	yes
assumptionId	string (uuid) or null	yes

QuestionDto

Field	Type	Required	Notes
id	string (uuid)	yes
projectId	string (uuid)	yes
text	string	yes
about	array of string (uuid)	yes
origin	string	yes
status	string	yes
answer	string or null	yes
answeredBy	string or null	yes
answeredAt	string (date-time) or null	yes
createdBy	string	yes
createdAt	string (date-time)	yes

QuestionRequest

Field	Type	Required	Notes
text	string	yes
about	array of string (uuid) or null	no
origin	string or null	no

QueueStats

Field	Type	Required	Notes
meanDepth	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
meanDepthByQuarter	array of number (double) or string (double)	yes
maxDepth	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
depthAtEndOfArrivals	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

RecordEvidenceRequest

Field	Type	Required	Notes
result	string	yes
source	ExternalSourceRequest	yes
artifactDigest	string or null	yes
revision	integer (int32) or string (int32) or null	no	pattern "^-?(?:0|[1-9]\\d*)$"

RegisterRequest

Field	Type	Required	Notes
email	string	yes
password	string	yes
displayName	string or null	yes

RegressionDto

Field	Type	Required	Notes
label	string	yes
baseline	MeasuredResultSummaryDto	yes
candidate	MeasuredResultSummaryDto	yes
rows	array of RegressionRow	yes
subjects	array of RegressionSubject	yes
regressions	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
differences	array of string	yes
rule	string	yes

RegressionRow

Field	Type	Required	Notes
scope	string	yes
target	string (uuid) or null	yes
name	string	yes
metric	string	yes
unit	string	yes
baseline	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
candidate	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
change	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
relative	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
verdict	string	yes

RegressionSubject

Field	Type	Required	Notes
scope	string	yes
target	string (uuid) or null	yes
name	string	yes
regressed	boolean	yes
regressedMetrics	array of string	yes

RejectDecisionRequest

Field	Type	Required	Notes
reason	string or null	yes
contentHash	string or null	no

RejectedReference

Field	Type	Required	Notes
where	string	yes
alias	string	yes
reason	string	yes

RelationshipDto

Field	Type	Required	Notes
id	string (uuid)	yes
fromId	string (uuid)	yes
toId	string (uuid)	yes
label	string or null	yes
technology	string or null	yes
messageId	string (uuid) or null	yes
lineShape	string or null	yes
kind	string	yes
factStatus	string	yes
provenance	null or ProvenanceDto	yes
stale	null or StaleDto	no

RelinkChoice

Field	Type	Required	Notes
id	string (uuid)	yes
factKey	string or null	yes

RequiredPattern

Field	Type	Required	Notes
repository	string	yes
pattern	string	yes
service	string (uuid) or null	yes

RequiredResource

Field	Type	Required	Notes
elementId	string (uuid)	yes
name	string	yes

RequiredServiceTime

Field	Type	Required	Notes
target	string (uuid)	yes
kind	string	yes
name	string	yes
timeoutMs	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
maxAttempts	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
backoffMs	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"

RequiredSubscription

Field	Type	Required	Notes
subscriptionId	string (uuid)	yes
name	string	yes
maxAttempts	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
backoffMs	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
deadLetters	boolean	yes

ResolvedToExisting

Field	Type	Required	Notes
alias	string	yes
id	string (uuid)	yes
name	string	yes

ResourceAssumption

Field	Type	Required	Notes
elementId	string (uuid)	yes
concurrency	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
queueCapacity	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
label	AssumptionLabel	no
measurementRef	string or null	no

ResourceDelta

Field	Type	Required	Notes
elementId	string (uuid)	yes
name	string	yes
change	string	yes
leftResourceId	string (uuid) or null	yes
rightResourceId	string (uuid) or null	yes
amounts	array of AmountDelta	yes
leftUnknownLines	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
rightUnknownLines	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ResourceDto

Field	Type	Required	Notes
id	string (uuid)	yes
elementId	string (uuid)	yes
elementName	string or null	yes
name	string	yes
category	string	yes
provider	string	yes
region	string	yes
sku	string	yes
quantity	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit	string or null	yes
priceRef	string (uuid) or null	yes
usage	array of UsageLine	yes
factStatus	string	yes
provenance	null or ProvenanceDto	yes

ResourceRequest

Field	Type	Required	Notes
id	string (uuid) or null	yes
elementId	string (uuid)	yes
name	string	yes
category	string	yes
provider	string	yes
region	string or null	yes
sku	string or null	yes
quantity	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit	string or null	yes
priceRef	string (uuid) or null	yes
usage	array of UsageLineRequest or null	yes
factStatus	string or null	yes
provenance	null or ProvenanceInput	yes

ResourceSeries

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
kind	string	yes
queueDepth	array of integer (int32) or string (int32)	yes
inService	array of integer (int32) or string (int32)	yes

ResourceStats

Field	Type	Required	Notes
label	string	yes
id	string (uuid)	yes
name	string	yes
kind	string	yes
workers	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
queueCapacity	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
arrived	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
waited	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
counts	Counts	yes
retries	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
overflowed	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
wastedCount	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
wastedMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
utilisation	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
throughputPerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
queue	QueueStats	yes
wait	LatencySummary	yes
latency	LatencySummary	yes
failedInside	integer (int64) or string (int64) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
saturation	null or Saturation	yes

ResultRefusedResponse

Field	Type	Required	Notes
type	string	yes
title	string	yes
detail	string	yes
errors	array of FieldError	yes

RetryDto

Field	Type	Required	Notes
maxAttempts	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
backoffMs	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ReviewCounts

Field	Type	Required	Notes
blocking	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
concerns	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
unknown	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
verified	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
notApplicable	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
settled	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
needsReReview	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ReviseRequest

Field	Type	Required	Notes
retire	boolean	no	default false

RevisionChangedResponse

Field	Type	Required	Notes
type	string	yes
title	string	yes
detail	string	yes
revision	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
contentHash	string	yes

RevisionDto

Field	Type	Required	Notes
id	string (uuid)	yes
projectId	string (uuid)	yes
name	string	yes
note	string or null	yes
streamId	string (uuid)	yes
version	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
createdBy	string	yes
createdAt	string (date-time)	yes

RevisionModelDto

Field	Type	Required	Notes
revision	RevisionDto	yes
elements	array of ElementDto	yes
relationships	array of RelationshipDto	yes
messages	array of MessageDto	yes
operations	array of OperationDto	yes
channels	array of ChannelDto	yes
subscriptions	array of SubscriptionDto	yes
bindings	array of BindingDto	yes

RotateKeysResponse

Field	Type	Required	Notes
rewrapped	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
remaining	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
message	string	yes

RuleDto

Field	Type	Required	Notes
id	string	yes
version	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
category	string	yes
title	string	yes
reads	string	yes
settle	string	yes

RuleVersion

Field	Type	Required	Notes
rule	string	yes
version	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

RunInputs

Field	Type	Required	Notes
obligationHash	string	yes
modelStreamId	string (uuid) or null	no
modelVersion	integer (int64) or string (int64) or null	no	pattern "^-?(?:0|[1-9]\\d*)$"
scenarioId	string (uuid) or null	no
scenarioVersion	integer (int64) or string (int64) or null	no	pattern "^-?(?:0|[1-9]\\d*)$"
scenarioHash	string or null	no
schemas	array of SchemaInput or null	no
repository	string or null	no
scanId	string (uuid) or null	no
commitSha	string or null	no
ref	string or null	no
scanKind	string or null	no
coverage	string or null	no

RunObligationRequest

Field	Type	Required	Notes
modelRevisionId	string (uuid) or null	no
branchId	string (uuid) or null	no
scanId	string (uuid) or null	no
revision	integer (int32) or string (int32) or null	no	pattern "^-?(?:0|[1-9]\\d*)$"

RunScenarioResponse

Field	Type	Required	Notes
engineVersion	string	yes
hash	string	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
issues	array of ScenarioIssue	yes
events	array of TraceEvent	yes
outcomes	map of string to StepOutcome	yes
assertions	array of AssertionResult	yes
labels	map of string to string	yes

Saturation

Field	Type	Required	Notes
saturated	boolean	yes
turnedAway	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
firstTurnedAwayMs	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
lastTurnedAwayMs	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
arrivals	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
arrivalVariation	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
serviceVariation	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
noiseBound	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
windows	array of BacklogWindow	yes
moreWindows	boolean	yes
depthAtMidWindow	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
queueGrows	boolean	yes
growthPerSecond	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

SavedEstimateDto

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
branchId	string (uuid)	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
asOf	string (date)	yes
inputsFingerprint	string	yes
hash	string	yes
savedBy	string	yes
savedAt	string (date-time)	yes
outdated	boolean	yes
changes	array of InputChange	yes
result	null or Estimate	yes

SaveEstimateRequest

Field	Type	Required	Notes
name	string or null	yes
asOf	string (date) or null	yes

SaveLayoutEdge

Field	Type	Required	Notes
relationshipId	string (uuid)	yes
routePoints	null or JsonDocument	yes

SaveLayoutPosition

Field	Type	Required	Notes
elementId	string (uuid)	yes
x	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
y	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
width	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
height	number (double) or string (double) or null	no	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

SaveLayoutRequest

Field	Type	Required	Notes
positions	array of SaveLayoutPosition	yes
edges	array of SaveLayoutEdge or null	yes

SaveSnapshotRequest

Field	Type	Required	Notes
revisionId	string (uuid) or null	no
branchId	string (uuid) or null	no
note	string or null	no

ScanCoverageDto

Field	Type	Required	Notes
filesListed	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
filesExtracted	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
linkedFacts	null or LinkedFactCoverageDto	yes

ScanDetailDto

Field	Type	Required	Notes
id	string (uuid)	yes
repository	string	yes
repositoryName	string or null	yes
ref	string or null	yes
resolvedRef	string or null	yes
commitSha	string or null	yes
status	string	yes
isComplete	boolean	yes
kind	string	yes
trackedRef	string or null	yes
canDecide	boolean	yes
canDecideReason	string or null	yes
coverage	ScanCoverageDto	yes
relinked	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
needsReview	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
progress	ScanProgressDto	yes
proposalCounts	ProposalCountsDto	yes
error	null or ScanError	yes
retryAt	string (date-time) or null	yes
requestedBy	string	yes
createdAt	string (date-time)	yes
completedAt	string (date-time) or null	yes
notes	array of ScanNote	yes
ruleVersions	array of RuleVersion	yes
trackedBy	string or null	yes
trackedAt	string (date-time) or null	yes

ScanDto

Field	Type	Required	Notes
id	string (uuid)	yes
repository	string	yes
repositoryName	string or null	yes
ref	string or null	yes
resolvedRef	string or null	yes
commitSha	string or null	yes
status	string	yes
isComplete	boolean	yes
kind	string	yes
trackedRef	string or null	yes
canDecide	boolean	yes
canDecideReason	string or null	yes
coverage	ScanCoverageDto	yes
relinked	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
needsReview	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
progress	ScanProgressDto	yes
proposalCounts	ProposalCountsDto	yes
error	null or ScanError	yes
retryAt	string (date-time) or null	yes
requestedBy	string	yes
createdAt	string (date-time)	yes
completedAt	string (date-time) or null	yes

ScanError

Field	Type	Required	Notes
code	string	yes
message	string	yes

ScanNote

Field	Type	Required	Notes
code	string	yes
path	string	yes
line	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
message	string	yes

ScanProgressDto

Field	Type	Required	Notes
filesListed	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
filesRead	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
filesSkipped	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
bytesRead	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

Scenario

Field	Type	Required	Notes
id	ScenarioId	yes
name	string	yes
steps	array of Step	yes
faults	array of Fault	yes
assertions	array of Assertion	yes

ScenarioCheckRecipe

Field	Type	Required	Notes
scenarioId	string (uuid)	yes
faults	array of Fault	yes
expect	array of Assertion	yes

ScenarioDto

Field	Type	Required	Notes
id	ScenarioId	yes
name	string	yes
steps	array of Step	yes
faults	array of Fault	yes
assertions	array of Assertion	yes
origin	null or ScenarioOrigin	yes

ScenarioId

Type: string (uuid)

ScenarioIssue

Field	Type	Required	Notes
stepId	string	yes
code	string	yes
message	string	yes

ScenarioOrigin

Field	Type	Required	Notes
kind	string	yes
proposalId	string (uuid)	yes
provider	string	yes
model	string	yes

ScenarioSummaryDto

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes

SchemaInput

Field	Type	Required	Notes
id	string (uuid)	yes
version	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

ScriptDto

Field	Type	Required	Notes
id	string (uuid)	yes
hash	string	yes
fileName	string	yes
generator	string	yes
scenarioId	string (uuid)	yes
scenarioVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
modelStreamId	string (uuid)	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
profileId	string (uuid)	yes
profileVersion	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
targetId	string (uuid)	yes
targetName	string	yes
baseUrl	string	yes
environment	string	yes
authorisedBy	string	yes
authorisedAt	string (date-time)	yes
createdAt	string (date-time)	yes
plan	K6Plan	yes
command	string	yes
ciWorkflow	string	yes
content	string or null	yes

ScriptRefusedResponse

Field	Type	Required	Notes
type	string	yes
title	string	yes
reasons	array of string	yes

SecretStatusDto

Field	Type	Required	Notes
name	string	yes
isSet	boolean	yes
updatedAt	string (date-time) or null	yes
updatedBy	string or null	yes
fingerprint	string or null	yes
boundOrigin	string or null	yes
matchesCurrentUrl	boolean	yes

SelfCheck

Field	Type	Required	Notes
passed	boolean	yes
openApiOperations	SelfCheckCount	yes
asyncApiChannels	SelfCheckCount	yes
asyncApiMessages	SelfCheckCount	yes
asyncApiSubscriptions	SelfCheckCount	yes
asyncApiPublications	SelfCheckCount	yes
notes	array of string	yes

SelfCheckCount

Field	Type	Required	Notes
expected	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
parsed	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
missing	array of string	yes
unexpected	array of string	yes

ServiceTimeAssumption

Field	Type	Required	Notes
target	string (uuid)	yes
time	Distribution	yes
label	AssumptionLabel	no
measurementRef	string or null	no

SetDispositionRequest

Field	Type	Required	Notes
ruleId	string	yes
subjectId	string (uuid)	yes
status	string	yes
decisionId	string (uuid) or null	no
reason	string or null	no
revisionId	string (uuid) or null	no
branchId	string (uuid) or null	no

SetModelPriceRequest

Field	Type	Required	Notes
providerKind	string or null	yes
model	string or null	yes
inputUsdPerMillionTokens	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
outputUsdPerMillionTokens	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
effectiveFrom	string (date-time) or null	yes

SetPrefixRequest

Field	Type	Required	Notes
prefix	string	yes
startAt	integer (int32) or string (int32) or null	no	pattern "^-?(?:0|[1-9]\\d*)$"

SetSecretRequest

Field	Type	Required	Notes
value	string or null	yes

SettingsDocument

Field	Type	Required	Notes
ai	AiSettings	yes
github	GithubSettings	yes
import	ImportSettings	yes
cost	CostSettings	yes
simulation	SimulationSettings	yes
privacy	PrivacySettings	yes
usage	UsageSettings	yes
notifications	NotificationSettings	yes

SettlementStamp

Field	Type	Required	Notes
ruleId	string	yes
subjectId	string (uuid)	yes
ruleVersion	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
fingerprint	string or null	yes

Settles

Field	Type	Required	Notes
ruleId	string	yes
subjectId	string (uuid)	yes

SetupRequest

Field	Type	Required	Notes
email	string or null	yes
password	string or null	yes
displayName	string or null	yes
workspaceName	string or null	yes
setupToken	string or null	yes

SetupResponse

Field	Type	Required	Notes
userId	string	yes
workspaceId	string (uuid)	yes

SetupStatusResponse

Field	Type	Required	Notes
needsSetup	boolean	yes
profile	string	yes
requiresSetupToken	boolean	yes
setupTokenHint	string or null	yes

SignInMethodsResponse

Field	Type	Required	Notes
password	boolean	yes
providers	array of string	yes
registrationOpen	boolean	yes

SimulationSettings

Field	Type	Required	Notes
seed	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
durationSeconds	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
arrivalRatePerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
warmUpSeconds	integer (int32) or string (int32)	no	pattern "^-?(?:0|[1-9]\\d*)$", default 5

Skipped

Field	Type	Required	Notes
key	string	yes
reason	string	yes

SnapshotDto

Field	Type	Required	Notes
id	string (uuid)	yes
projectId	string (uuid)	yes
branch	string (uuid)	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
revisionId	string (uuid) or null	yes
inputsFingerprint	string	yes
ruleSetVersion	string	yes
hash	string	yes
note	string or null	yes
findings	array of FindingView	yes
createdBy	string	yes
createdAt	string (date-time)	yes

SnapshotSummary

Field	Type	Required	Notes
id	string (uuid)	yes
branch	string (uuid)	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
revisionId	string (uuid) or null	yes
inputsFingerprint	string	yes
ruleSetVersion	string	yes
hash	string	yes
note	string or null	yes
createdBy	string	yes
createdAt	string (date-time)	yes

SourcePatternRecipe

Field	Type	Required	Notes
repository	string	yes
pattern	string	yes
service	string (uuid) or null	yes
requireUnconditional	boolean or null	no

SourceWindowDto

Field	Type	Required	Notes
path	string	yes
commitSha	string	yes
startLine	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
endLine	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
lines	array of string	yes

StaleDto

Field	Type	Required	Notes
sinceRevision	string	yes
reason	string	yes

StartScanRequest

Field	Type	Required	Notes
repository	string or null	yes
ref	string or null	yes
includePaths	array of string or null	yes
excludePaths	array of string or null	yes

StartScanResponse

Field	Type	Required	Notes
id	string (uuid)	yes

Step

Type: StepCallStep or StepPublishStep or StepWriteStep or StepParallelStep or StepBranchStep

StepBranchStep

Field	Type	Required	Notes
type	"branch"	no
whenStep	string	yes
is	StepOutcome	yes
then	array of Step	yes
else	array of Step	yes
id	string	yes

StepCallStep

Field	Type	Required	Notes
type	"call"	no
from	ElementId	yes
operation	OperationId	yes
request	null or JsonElement	yes
response	null or JsonElement	yes
then	array of Step	yes
onError	array of Step	yes
id	string	yes

StepOutcome

Type: "Succeeded" or "Failed" or "Skipped"

StepParallelStep

Field	Type	Required	Notes
type	"parallel"	no
branches	array of any	yes
id	string	yes

StepPublishStep

Field	Type	Required	Notes
type	"publish"	no
from	ElementId	yes
channel	ChannelId	yes
message	MessageId	yes
payload	null or JsonElement	yes
headers	map of string to string	yes
handlers	map of string to array of Step	yes
routingKey	string or null	no
id	string	yes

StepWriteStep

Field	Type	Required	Notes
type	"write"	no
by	ElementId	yes
store	ElementId	yes
dataset	string	yes
change	null or JsonElement	yes
id	string	yes

StressComparisonDto

Field	Type	Required	Notes
label	string	yes
left	StressRunSummaryDto	yes
right	StressRunSummaryDto	yes
metrics	array of MetricDelta	yes
inputs	array of InputDifference	yes
note	string	yes
sameResult	boolean	yes

StressIssue

Field	Type	Required	Notes
code	string	yes
target	string	yes
message	string	yes
limit	string or null	no

StressMethods

Field	Type	Required	Notes
percentiles	string	yes
counting	string	yes
sampling	string	yes
time	string	yes

StressProfile

Field	Type	Required	Notes
name	string	yes
scenarioId	string (uuid)	yes
seed	string	yes
arrivals	Arrivals	yes
resources	array of ResourceAssumption	yes
serviceTimes	array of ServiceTimeAssumption	yes
subscriptions	array of SubscriptionAssumption	yes
branches	array of BranchAssumption	yes
overrides	array of PolicyOverride	yes
outages	array of Outage	yes

StressProfileDefaults

Field	Type	Required	Notes
seed	string	yes
durationSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
warmUpSeconds	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
arrivalRatePerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

StressProfileDto

Field	Type	Required	Notes
id	string (uuid)	yes
version	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
updatedAt	string (date-time)	yes
profile	StressProfile	yes
measurements	array of ProfileMeasurement	yes

StressProfileSummaryDto

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
scenarioId	string (uuid)	yes
version	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
updatedAt	string (date-time)	yes
runs	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

StressRefusedResponse

Field	Type	Required	Notes
type	string	yes
title	string	yes
issues	array of StressIssue	yes

StressRequirements

Field	Type	Required	Notes
scenarioIssues	array of ScenarioIssue	yes
resources	array of RequiredResource	yes
serviceTimes	array of RequiredServiceTime	yes
subscriptions	array of RequiredSubscription	yes
branches	array of string	yes
outageTargets	array of OutageTarget	yes
scenarioFaults	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

StressResult

Field	Type	Required	Notes
engineVersion	string	yes
label	string	yes
seed	string	yes
window	StressWindow	yes
flow	FlowStats	yes
elements	array of ResourceStats	yes
operations	array of OperationStats	yes
subscriptions	array of ResourceStats	yes
channels	array of ChannelStats	yes
series	StressSeries	yes
drain	DrainStats	yes
bottleneck	Bottleneck	yes
assumptions	array of AssumptionRow	yes
overrides	array of OverrideRow	yes
unmodelled	array of UnmodelledEffect	yes
confidence	Confidence	yes
methods	StressMethods	yes
limits	null or EffectiveLimits	yes
hash	string	yes

StressRunDto

Field	Type	Required	Notes
run	StressRunSummaryDto	yes
profile	StressProfile	yes
result	StressResult	yes

StressRunSummary

Field	Type	Required	Notes
label	string	yes
arrivals	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
completed	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
failed	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
throughputPerSecond	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p50Ms	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p95Ms	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
p99Ms	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
bottleneck	string or null	yes
confidence	string	yes
drained	boolean	yes

StressRunSummaryDto

Field	Type	Required	Notes
id	string (uuid)	yes
profileId	string (uuid)	yes
profileVersion	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
currentProfileVersion	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
modelStreamId	string (uuid)	yes
modelVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
scenarioId	string (uuid)	yes
scenarioVersion	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
seed	string	yes
engineVersion	string	yes
hash	string	yes
at	string (date-time)	yes
summary	StressRunSummary	yes
outdated	boolean	yes
outdatedBecause	array of string	yes

StressSeries

Field	Type	Required	Notes
label	string	yes
intervalMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
points	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
truncated	boolean	yes
arrivalsPerSecond	array of number (double) or string (double)	yes
throughputPerSecond	array of number (double) or string (double)	yes
failuresPerSecond	array of number (double) or string (double)	yes
inFlight	array of integer (int32) or string (int32)	yes
resources	array of ResourceSeries	yes

StressWindow

Field	Type	Required	Notes
warmUpMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
durationMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
endedAtMs	number (double) or string (double)	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"

SubmitArchitectureProposalRequest

Field	Type	Required	Notes
request	string or null	yes
proposal	null or ArchitectureOutput	yes

SubmitFlowProposalRequest

Field	Type	Required	Notes
request	string or null	yes
reviseScenarioId	string (uuid) or null	yes
flow	null or FlowOutput	yes

SubscriptionAssumption

Field	Type	Required	Notes
subscriptionId	string (uuid)	yes
consumers	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
queueCapacity	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
label	AssumptionLabel	no
measurementRef	string or null	no

SubscriptionDto

Field	Type	Required	Notes
id	string (uuid)	yes
channelId	string (uuid)	yes
consumerId	string (uuid)	yes
retry	RetryDto	yes
deadLetterChannelId	string (uuid) or null	yes
factStatus	string	yes
provenance	null or ProvenanceDto	yes
stale	null or StaleDto	no

TargetAuthorisation

Field	Type	Required	Notes
baseUrl	string	yes
environment	string	yes
by	string	yes
at	string (date-time)	yes

TargetDto

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
baseUrl	string	yes
environment	string	yes
version	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
authorisation	null or TargetAuthorisation	yes
override	null or TargetOverride	yes
updatedAt	string (date-time)	yes

TargetOverride

Field	Type	Required	Notes
allowNonIdempotent	boolean	yes
allowFailureInjection	boolean	yes
reason	string	yes
by	string	yes
at	string (date-time)	yes

TargetOverrideRequest

Field	Type	Required	Notes
allowNonIdempotent	boolean	yes
allowFailureInjection	boolean	yes
reason	string or null	yes
confirmName	string or null	yes

TargetRequest

Field	Type	Required	Notes
name	string or null	yes
baseUrl	string or null	yes
environment	string or null	yes

TaskRouting

Field	Type	Required	Notes
inferArchitecture	string (uuid) or null	yes
proposeFlow	string (uuid) or null	yes
critique	string (uuid) or null	yes
explain	string (uuid) or null	yes

TelemetryDiagnostics

Field	Type	Required	Notes
enabled	boolean	yes
endpointHost	string or null	yes

TestPlanRecipe

Field	Type	Required	Notes
steps	array of string	yes
inputs	array of string	yes
expectedObservations	array of string	yes
forbiddenObservations	array of string	yes
contractIds	array of string (uuid)	yes
evidenceSource	null or EvidenceSource	no

TraceEvent

Field	Type	Required	Notes
sequence	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
atMs	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
kind	TraceEventKind	yes
stepId	string	yes
attempt	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
from	string (uuid) or null	yes
to	string (uuid) or null	yes
target	string (uuid) or null	yes
payload	null or JsonElement	yes
detail	string or null	yes
message	string (uuid) or null	no
headers	map of string to string or null	no

TraceEventKind

Type: "RequestSent" or "ResponseReceived" or "RequestFailed" or "RequestTimedOut" or "RetryScheduled" or "Published" or "PublishFailed" or "Delivered" or "DeliveryFailed" or "DeadLettered" or "Dropped" or "DataWritten" or "DataWriteFailed" or "BranchTaken" or "StepSkipped" or "Routed" or "NotRouted"

UnknownLine

Field	Type	Required	Notes
lineId	string	yes
resourceId	string (uuid)	yes
elementId	string (uuid)	yes
resourceName	string	yes
name	string	yes
category	string	yes
reason	string	yes
detail	string	yes

UnmodelledEffect

Field	Type	Required	Notes
code	string	yes
kind	string	yes
text	string	yes

UpdateBindingRequest

Field	Type	Required	Notes
sourceChannelId	string (uuid) or null	yes
targetChannelId	string (uuid) or null	yes
routingKey	string or null	yes
setRoutingKey	boolean	no	default false
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

UpdateChannelRequest

Field	Type	Required	Notes
name	string or null	yes
kind	string or null	yes
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

UpdateCommentRequest

Field	Type	Required	Notes
body	string	yes

UpdateDocRequest

Field	Type	Required	Notes
title	string or null	yes
content	string or null	yes
spaceId	string (uuid) or null	yes
elementId	string (uuid) or null	yes
setSpaceId	boolean	no	default false
setElementId	boolean	no	default false
draftId	string (uuid) or null	no
type	string or null	no
setDraftId	boolean	no	default false
setType	boolean	no	default false

UpdateElementRequest

Field	Type	Required	Notes
name	string or null	yes
description	string or null	yes
technology	string or null	yes
ownerId	string (uuid) or null	yes
parentId	string (uuid) or null	yes
status	string or null	yes
tags	array of string or null	yes
icon	string or null	yes
setDescription	boolean	no	default false
setTechnology	boolean	no	default false
setOwnerId	boolean	no	default false
setParentId	boolean	no	default false
setIcon	boolean	no	default false
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

UpdateMessageRequest

Field	Type	Required	Notes
name	string or null	yes
description	string or null	yes
producerId	string (uuid) or null	yes
consumerIds	array of string (uuid) or null	yes
schemaId	string (uuid) or null	yes
setSchemaId	boolean	no	default false
setDescription	boolean	no	default false
setProducerId	boolean	no	default false
setConsumerIds	boolean	no	default false
tags	array of string or null	no
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

UpdateOperationRequest

Field	Type	Required	Notes
name	string or null	yes
ownerId	string (uuid) or null	yes
transport	string or null	yes
requestSchemaId	string (uuid) or null	yes
responseSchemaId	string (uuid) or null	yes
timeoutMs	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
retry	null or RetryDto	yes
setRequestSchemaId	boolean	no	default false
setResponseSchemaId	boolean	no	default false
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

UpdateProjectRequest

Field	Type	Required	Notes
name	string or null	yes
description	string or null	yes

UpdateRelationshipRequest

Field	Type	Required	Notes
label	string or null	yes
technology	string or null	yes
lineShape	string or null	yes
setLabel	boolean	no	default false
setTechnology	boolean	no	default false
setLineShape	boolean	no	default false
kind	string or null	no
setKind	boolean	no	default false
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

UpdateSchemaRequest

Field	Type	Required	Notes
name	string or null	yes
description	string or null	yes
content	string or null	yes
setDescription	boolean	no	default false
setContent	boolean	no	default false

UpdateSpaceRequest

Field	Type	Required	Notes
name	string or null	yes

UpdateSubscriptionRequest

Field	Type	Required	Notes
channelId	string (uuid) or null	yes
consumerId	string (uuid) or null	yes
retry	null or RetryDto	yes
deadLetterChannelId	string (uuid) or null	yes
setDeadLetterChannelId	boolean	no	default false
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

UpdateViewRequest

Field	Type	Required	Notes
name	string or null	yes
rootElementId	string (uuid) or null	yes
visibleElementIds	array of string (uuid) or null	yes
activeLens	string or null	yes
updatedAt	string (date-time) or null	yes
setRootElementId	boolean	no	default false
setActiveLens	boolean	no	default false

UpdateWorkspaceRequest

Field	Type	Required	Notes
name	string or null	yes

UsageLine

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
assumptionId	string (uuid)	yes
priceRef	string (uuid) or null	yes

UsageLineRequest

Field	Type	Required	Notes
id	string (uuid) or null	yes
name	string	yes
assumptionId	string (uuid)	yes
priceRef	string (uuid) or null	yes

UsageSettings

Field	Type	Required	Notes
monthlyAiBudgetUsd	number (double) or string (double) or null	yes	pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
maxScansPerDay	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"

VerificationRun

Field	Type	Required	Notes
id	string (uuid)	yes
obligationId	string	yes
promiseRevision	integer (int32) or string (int32)	yes	pattern "^-?(?:0|[1-9]\\d*)$"
obligationHash	string	yes
startedBy	string	yes
at	string (date-time)	yes
modelRevision	null or ModelPin	yes
commitSha	string or null	yes
scanId	string (uuid) or null	yes
environment	string	yes
result	string	yes
scope	string	yes
evidence	array of EvidenceItem	yes
limitations	array of string	yes
detail	string	yes
inputs	null or RunInputs	no
assertions	array of AssertionOutcome or null	no
effectiveFaults	array of Fault or null	no
draft	boolean or null	no

VerifiedFile

Field	Type	Required	Notes
path	string	yes
status	string	yes
expectedSha256	string or null	yes
actualSha256	string or null	yes

VerifyRequest

Field	Type	Required	Notes
manifest	BuildManifest	yes

VerifyResponse

Field	Type	Required	Notes
pinned	PinnedState	yes
identical	boolean	yes
matchesPinned	boolean	yes
manifest	string	yes
manifestDifferences	array of string	yes
archive	string or null	yes
current	boolean	yes
moved	array of MovedInput	yes
expectedBundleHash	string	yes
actualBundleHash	string	yes
files	array of VerifiedFile	yes
selfCheck	SelfCheck	yes
issued	boolean	yes

WorkspaceSettingsResponse

Field	Type	Required	Notes
effective	SettingsDocument	yes
overrides	JsonObject	yes
defaults	SettingsDocument	yes
policyViolations	array of PolicyViolation	yes
version	integer (int64) or string (int64)	yes	pattern "^-?(?:0|[1-9]\\d*)$"