Skip to content

Schemas

Every table below is generated at build time from {schemas.api.repository}@{schemas.api.commit.slice(0, 8)} openapi.json (API v0.2.0). Field text is never hand-duplicated. Full endpoint shapes live in the API Reference.

AutonomyEvaluateRequest

FieldTypeRequiredDescription
request_idstringyesRequest Id
tenant_idstringyesTenant Id
repositorystringyesRepository
refstringyesRef
head_shastringyesHead Sha
event_keystringyesEvent Key
capabilitystringyesCapability
objectivestringyesObjective
impact_summarystringyesImpact Summary
evidencearrayyesEvidence
tests_passedboolean—Tests Passed
patch_releaseboolean—Patch Release
exported_signatures_changedboolean—Exported Signatures Changed
critical_file_touchedboolean—Critical File Touched
auth_or_secret_touchedboolean—Auth Or Secret Touched
proxy_or_ssl_touchedboolean—Proxy Or Ssl Touched
transient_ci_errorboolean—Transient Ci Error
canary_error_ratenumber | null—Canary Error Rate
superseded_headboolean—Superseded Head
stale_reviewboolean—Stale Review
retry_countinteger—Retry Count
test_coverage_deltainteger—Test Coverage Delta
author_permission_tierinteger—Author Permission Tier
critical_path_penaltyinteger—Critical Path Penalty
line_churn_penaltyinteger—Line Churn Penalty
changed_filesarray—Changed Files

Body_create_api_key_v1_api_keys_post

FieldTypeRequiredDescription
namestringyesName
permissionsarray—Permissions

Body_register_webhook_v1_webhooks_post

FieldTypeRequiredDescription
urlstringyesUrl
eventsarrayyesEvents
secretstring | null—Secret

Body_set_rate_limit_v1_rate_limit_post

FieldTypeRequiredDescription
keystringyesKey
limitintegeryesLimit

Body_submit_task_v1_tasks_submit_post

FieldTypeRequiredDescription
namestringyesName
argsarray—Args
kwargsobject—Kwargs

BulkStatusRequest

FieldTypeRequiredDescription
work_item_idsarrayyesWork Item Ids
tenant_idstringyesTenant Id

HTTPValidationError

FieldTypeRequiredDescription
detailarray—Detail

MergeRequest

FieldTypeRequiredDescription
actorstringyesActor
reasonstring—Reason
target_work_item_idstringyesTarget Work Item Id
idempotency_keystring | null—Idempotency Key

ObservationRequest

FieldTypeRequiredDescription
tenant_idstringyesTenant Id
sourcestringyesSource
textstringyesText
external_idstring | null—External Id
actorstring | null—Actor
occurred_atstring | null—Occurred At
metadataobject—Metadata
title_hintstring | null—Title Hint
owner_hintstring | null—Owner Hint
due_hintstring | null—Due Hint
priority_hintstring | null—Priority Hint

PromoteRequest

FieldTypeRequiredDescription
actorstringyesActor
reasonstring—Reason

PublishRequest

FieldTypeRequiredDescription
destinationstringyesDestination

ReviewRequest

FieldTypeRequiredDescription
actionstringyesAction
actorstringyesActor
reasonstring—Reason
resume_atstring | null—Resume At

ValidationError

FieldTypeRequiredDescription
locarrayyesLocation
msgstringyesMessage
typestringyesError Type
inputobject—Input
ctxobject—Context
Was this page helpful?