Skip to main content

fleetforge.runtime.v1 API

  • Source: api/proto/public/fleetforge/runtime/v1/runtime.proto
  • Package: fleetforge.runtime.v1
  • TypeScript declarations: sdk/typescript/src/gen/fleetforge/runtime/v1/runtime_pb.ts
  • TypeScript Connect client: sdk/typescript/src/gen/fleetforge/runtime/v1/runtime_connect.ts
  • Python module: sdk/python/fleetforge_proto/fleetforge/runtime/v1/runtime_pb2.py

Services

RuntimeService

Messages

SubmitRunRequest

FieldTypeLabelDescription
specRunSpecoptional
idempotency_keystringoptional

SubmitRunResponse

FieldTypeLabelDescription
run_idstringoptional

GetRunRequest

FieldTypeLabelDescription
run_idstringoptional

GetRunResponse

FieldTypeLabelDescription
runRunDetailoptional

TapRunRequest

FieldTypeLabelDescription
run_idstringoptional

ReplayRunRequest

FieldTypeLabelDescription
run_idstringoptional
modeReplayModeoptional

ReplayRunResponse

FieldTypeLabelDescription
run_idstringoptional
all_within_tolerancebooloptional
strategyReplayStrategyoptional
stepsReplaySteprepeated

RunSpec

FieldTypeLabelDescription
dag_jsonstringoptional
inputsgoogle.protobuf.Structoptional
seedint64optional
labelsmap<string, string>map
breakpointsstringrepeated

RunDetail

FieldTypeLabelDescription
run_idstringoptional
statusRunStatusoptional
specRunSpecoptional
created_atgoogle.protobuf.Timestampoptional
updated_atgoogle.protobuf.Timestampoptional
stepsStepSummaryrepeated

StepSummary

FieldTypeLabelDescription
step_idstringoptional
idxint32optional
typestringoptional
statusstringoptional
attemptint32optional
leased_atgoogle.protobuf.Timestampoptional
completed_atgoogle.protobuf.Timestampoptional
outputgoogle.protobuf.Valueoptional
errorgoogle.protobuf.Valueoptional

RunEvent

FieldTypeLabelDescription
run_idstringoptional
step_idstringoptional
kindstringoptional
payloadgoogle.protobuf.Valueoptional
occurred_atgoogle.protobuf.Timestampoptional

ReplayStep

FieldTypeLabelDescription
step_idstringoptional
snapshotgoogle.protobuf.Valueoptional
driftReplayStepDriftoptional

ReplayStepDrift

FieldTypeLabelDescription
recordedgoogle.protobuf.Valueoptional
currentgoogle.protobuf.Valueoptional
token_deltagoogle.protobuf.DoubleValueoptional
cost_deltagoogle.protobuf.DoubleValueoptional
within_tolerancebooloptional

UpdateBreakpointsRequest

FieldTypeLabelDescription
run_idstringoptional
addstringrepeated
removestringrepeated
clear_allbooloptional

UpdateBreakpointsResponse

FieldTypeLabelDescription
breakpointsstringrepeated

ResumeRunRequest

FieldTypeLabelDescription
run_idstringoptional

ResumeRunResponse

FieldTypeLabelDescription
statusRunStatusoptional
resumed_step_idstringoptional

PatchStepRequest

FieldTypeLabelDescription
run_idstringoptional
step_idstringoptional
inputs_patchgoogle.protobuf.Structoptional
envgoogle.protobuf.Structoptional
modelgoogle.protobuf.StringValueoptional
notestringoptional

PatchStepResponse

FieldTypeLabelDescription
step_idstringoptional

CreateBranchRunRequest

FieldTypeLabelDescription
run_idstringoptional
from_stepstringoptional
seed_modeBranchSeedModeoptional
seedgoogle.protobuf.Int64Valueoptional
inputs_patchgoogle.protobuf.Structoptional
labels_patchgoogle.protobuf.Structoptional
notestringoptional

CreateBranchRunResponse

FieldTypeLabelDescription
run_idstringoptional

GetAttestationsRequest

FieldTypeLabelDescription
attestation_idsstringrepeated

GetAttestationsResponse

FieldTypeLabelDescription
attestationsAttestationrepeated

Attestation

FieldTypeLabelDescription
attestation_idstringoptional
issued_atgoogle.protobuf.Timestampoptional
subjectAttestationSubjectoptional
artifact_hashgoogle.protobuf.StringValueoptional
claimsgoogle.protobuf.Structoptional
signaturegoogle.protobuf.StringValueoptional

AttestationSubject

FieldTypeLabelDescription
runAttestationRunSubjectoneof (kind)
stepAttestationStepSubjectoneof (kind)
toolAttestationToolSubjectoneof (kind)
artifactAttestationArtifactSubjectoneof (kind)
capability_tokenAttestationCapabilitySubjectoneof (kind)
customAttestationCustomSubjectoneof (kind)

Oneof groups

  • kind: run, step, tool, artifact, capability_token, custom

AttestationRunSubject

FieldTypeLabelDescription
run_idstringoptional

AttestationStepSubject

FieldTypeLabelDescription
run_idstringoptional
step_idstringoptional

AttestationToolSubject

FieldTypeLabelDescription
namestringoptional

AttestationArtifactSubject

FieldTypeLabelDescription
uristringoptional

AttestationCapabilitySubject

FieldTypeLabelDescription
token_idstringoptional

AttestationCustomSubject

FieldTypeLabelDescription
labelstringoptional

EvalScenarioDefinition

FieldTypeLabelDescription
slugstringoptional
titlestringoptional
descriptionstringoptional
run_specgoogle.protobuf.Structoptional
expectedgoogle.protobuf.Structoptional

SyncEvalPackRequest

FieldTypeLabelDescription
packstringoptional
scenariosEvalScenarioDefinitionrepeated

SyncEvalPackResponse

FieldTypeLabelDescription
scenario_idsstringrepeated

ListEvalScenariosRequest

No fields defined.

EvalResult

FieldTypeLabelDescription
result_idstringoptional
run_idstringoptional
scenario_idstringoptional
outcomestringoptional
commitstringoptional
executed_atgoogle.protobuf.Timestampoptional
metricsgoogle.protobuf.Structoptional

EvalScenario

FieldTypeLabelDescription
scenario_idstringoptional
packstringoptional
slugstringoptional
titlestringoptional
descriptionstringoptional
created_atgoogle.protobuf.Timestampoptional
historyEvalResultrepeated

ListEvalScenariosResponse

FieldTypeLabelDescription
scenariosEvalScenariorepeated

RecordEvalResultRequest

FieldTypeLabelDescription
packstringoptional
slugstringoptional
run_idstringoptional
commitstringoptional

RecordEvalResultResponse

FieldTypeLabelDescription
resultEvalResultoptional

ChangeDiff

FieldTypeLabelDescription
pathstringoptional
lines_addeduint32optional
lines_deleteduint32optional
novelty_scoregoogle.protobuf.DoubleValueoptional
risk_tagsstringrepeated
componentstringoptional

CoverageComponent

FieldTypeLabelDescription
namestringoptional
coverage_ratiogoogle.protobuf.DoubleValueoptional
required_ratiogoogle.protobuf.DoubleValueoptional

CoverageReport

FieldTypeLabelDescription
overall_ratiogoogle.protobuf.DoubleValueoptional
minimum_ratiogoogle.protobuf.DoubleValueoptional
componentsCoverageComponentrepeated

EvalMetric

FieldTypeLabelDescription
namestringoptional
slugstringoptional
scoredoubleoptional
thresholdgoogle.protobuf.DoubleValueoptional
directionMetricDirectionoptional
weightgoogle.protobuf.DoubleValueoptional

BudgetSignal

FieldTypeLabelDescription
namestringoptional
actualdoubleoptional
limitgoogle.protobuf.DoubleValueoptional

FollowupAction

FieldTypeLabelDescription
slugstringoptional
descriptionstringoptional
recommendedbooloptional

NoveltySummary

FieldTypeLabelDescription
max_noveltydoubleoptional
avg_noveltydoubleoptional
high_risk_pathsstringrepeated

CoverageSummary

FieldTypeLabelDescription
overall_ratiogoogle.protobuf.DoubleValueoptional
components_below_thresholdstringrepeated

EvalSummary

FieldTypeLabelDescription
failing_metricsstringrepeated
attention_metricsstringrepeated
score_per_tokengoogle.protobuf.DoubleValueoptional

BudgetSummary

FieldTypeLabelDescription
breachesstringrepeated
near_limitsstringrepeated

DecisionScorecard

FieldTypeLabelDescription
noveltyNoveltySummaryoptional
coverageCoverageSummaryoptional
evalsEvalSummaryoptional
budgetsBudgetSummaryoptional
telemetrygoogle.protobuf.Structoptional

ChangeGateDecision

FieldTypeLabelDescription
gate_idstringoptional
change_idstringoptional
revisionstringoptional
effectChangeDecisionEffectoptional
reasonsstringrepeated
followupsFollowupActionrepeated
scorecardDecisionScorecardoptional
decided_atgoogle.protobuf.Timestampoptional
metadatagoogle.protobuf.Structoptional
telemetrygoogle.protobuf.Structoptional
acknowledgementsChangeGateFollowuprepeated

CheckChangeGateRequest

FieldTypeLabelDescription
change_idstringoptional
revisionstringoptional
diffsChangeDiffrepeated
coverageCoverageReportoptional
evalsEvalMetricrepeated
budgetsBudgetSignalrepeated
telemetrygoogle.protobuf.Structoptional
metadatagoogle.protobuf.Structoptional
actorstringoptional

CheckChangeGateResponse

FieldTypeLabelDescription
decisionChangeGateDecisionoptional

ChangeGateFollowup

FieldTypeLabelDescription
followup_idstringoptional
gate_idstringoptional
actorstringoptional
outcomeFollowupOutcomeoptional
notegoogle.protobuf.StringValueoptional
detailsgoogle.protobuf.Structoptional
recorded_atgoogle.protobuf.Timestampoptional

RecordGateFollowupRequest

FieldTypeLabelDescription
gate_idstringoptional
actorstringoptional
outcomeFollowupOutcomeoptional
notegoogle.protobuf.StringValueoptional
detailsgoogle.protobuf.Structoptional

RecordGateFollowupResponse

FieldTypeLabelDescription
followupChangeGateFollowupoptional

ListChangeGatesRequest

FieldTypeLabelDescription
change_idstringoptional
limituint32optional

ListChangeGatesResponse

FieldTypeLabelDescription
decisionsChangeGateDecisionrepeated

Enums

BranchSeedMode

NameNumber
BRANCH_SEED_MODE_UNSPECIFIED0
BRANCH_SEED_MODE_SAME1
BRANCH_SEED_MODE_NEW2
BRANCH_SEED_MODE_CUSTOM3

RunStatus

NameNumber
RUN_STATUS_UNSPECIFIED0
RUN_STATUS_PENDING1
RUN_STATUS_RUNNING2
RUN_STATUS_SUCCEEDED3
RUN_STATUS_FAILED4
RUN_STATUS_CANCELED5
RUN_STATUS_PAUSED_AT_STEP6

ReplayMode

NameNumber
REPLAY_MODE_UNSPECIFIED0
REPLAY_MODE_FULL1
REPLAY_MODE_STEP_ONLY2
REPLAY_MODE_DIFF3

ReplayStrategy

NameNumber
REPLAY_STRATEGY_UNSPECIFIED0
REPLAY_STRATEGY_MOCKED1
REPLAY_STRATEGY_LIVE2

MetricDirection

NameNumber
METRIC_DIRECTION_UNSPECIFIED0
METRIC_DIRECTION_HIGHER_IS_BETTER1
METRIC_DIRECTION_LOWER_IS_BETTER2

ChangeDecisionEffect

NameNumber
CHANGE_DECISION_EFFECT_UNSPECIFIED0
CHANGE_DECISION_EFFECT_ALLOW1
CHANGE_DECISION_EFFECT_FOLLOW_UP2
CHANGE_DECISION_EFFECT_DENY3

FollowupOutcome

NameNumber
FOLLOWUP_OUTCOME_UNSPECIFIED0
FOLLOWUP_OUTCOME_APPROVED1
FOLLOWUP_OUTCOME_NEEDS_CHANGES2
FOLLOWUP_OUTCOME_DEFERRED3