Schema index

Schemas describe the JSON bodies that endpoints accept and return. Each schema page lists its fields with their types, the endpoints that use it and the schemas that contain it.

772 schemas

The list below names every schema in the API specification, with a short description where the specification has one.

Search

Use your browser’s find command (Ctrl+F, or Cmd+F on a Mac) to jump to a schema by name.

Names and descriptions

• _BudgetPatch · used by 1 schema
• _RetryPatch · used by 1 schema
• _ReviewPatch · used by 1 schema
• _ThresholdsPatch · used by 1 schema
• _TierPatch · used by 1 schema
• _ToolsPatch · used by 1 schema
• AcceptCaseRequest · uses 1 schema
• AcceptInvitationRequest
• AcceptReviewRequest
• ActionTransitionRequest
• ActiveSessionsResponse · uses 1 schema
• AddProjectMemberRequest · uses 1 schema
• AdminCreateUserRequest · uses 1 schema
• AdminCreateUserResponse · uses 1 schema
• AgentActionListResponse · uses 1 schema
• AgentActionRead · uses 2 schemas · used by 1 schema
• AgentActionResultLink · used by 1 schema
• AgentActionTarget · used by 1 schema
• AgentCatalogDetail
• AgentCatalogEntry
• AgentConfigExtensions — Typed homes for pre-registry contracts migrated from agent_policies. · uses 2 schemas · used by 1 schema
• AgentConfigPatch — What one request may override. · uses 6 schemas · used by 1 schema
• AgentConfigV1 — A project’s configuration of one agent. · uses 9 schemas
• AgentEvidenceV1 · used by 1 schema
• AgentFindingV1 · used by 1 schema
• AgenticRunV1 · uses 5 schemas
• AgentInvocationResponse · uses 1 schema
• AgentInvokeRequest · uses 1 schema
• AgentMemoryEntryResponse — Single memory entry returned to the client. · used by 2 schemas
• AgentMemoryListResponse — Paginated memory entry list. · uses 1 schema
• AgentPipelineResponse · uses 1 schema
• AgentPipelineReviewSummary — Minimal review projection for a pipeline card. · used by 1 schema
• AgentRunSummaryResponse · uses 1 schema
• AgentStackReleaseGateRequest
• AgentTaskV1 · uses 2 schemas · used by 1 schema
• AIActor · used by 1 schema
• AIAnalysisDiffBrief — RunCompareResponse.ai_analysis_diff. · used by 1 schema
• AICompareNarrative · used by 1 schema
• AICompareResponse · uses 4 schemas
• AIConfigRead — AI / LLM configuration returned to the client (no API keys). · uses 1 schema
• AIConfigUpdate — Payload for updating AI configuration.
• AICoverageAnalysisRequest
• AICoverageAnalysisResponse
• AIDigestDiffResponse — from / to are emitted under those JSON keys (aliases). · uses 2 schemas
• AIEvalDatasetCreate
• AIEvalDatasetResponse
• AIEvalGateRunListResponse — Agent-stack history (gate_type IS NULL) and the G2 history. · uses 1 schema
• AIEvalGateRunResponse · used by 1 schema
• AIEvalItemListResponse · uses 1 schema
• AIEvalItemOutputRead · used by 1 schema
• AIEvalManifestResponse
• AIEvalRunListResponse — GET /ai-eval/runs (was a bare list; no client read it). · uses 1 schema
• AIEvalRunResponse · uses 2 schemas · used by 2 schemas
• AIGenerateStrategyRequest
• AIGenerateTestCasesRequest
• AIGenerateTestCasesResponse
• AIHistoryListResponse · uses 2 schemas
• AIHistoryReviewBlock — Review status of an AI artefact (state is a plain string here). · used by 5 schemas
• AIModelStatusRead — Live model presence + fallback-chain state. · uses 2 schemas
• AIModeRead — What every role’s screens branch on: the analysis mode, and whether AI stays on this deployment.
• AIOptimizePlanRequest
• AIPreviousRunResponse · uses 1 schema
• AIQualityDashboardResponse — Combined dashboard data for AI quality metrics. · uses 2 schemas
• AIReviewTestCaseResponse
• AITaskEnqueueResponse
• AITaskStatusResponse
• AITestHistoryResponse · uses 1 schema
• AITestVersion · uses 1 schema · used by 1 schema
• AIVersionRef — One side of a diff or a compare. · used by 2 schemas
• AIVersionResponse · uses 2 schemas
• AIVersionSummary — One row of a run’s AI history list, and the head of a single version. · uses 2 schemas · used by 1 schema
• AllowedTransitionResponse
• AnalysisLookupResponse — Latest AI analysis for a (project, fingerprint) pair.
• AnalysisProvenance — Which engine actually produced this conclusion, and why. · uses 1 schema · used by 1 schema
• AnalysisResponse · uses 6 schemas
• AnalyzeRequest
• ApiKeyCreate
• ApiKeyCreatedResponse — Returned ONCE at creation — includes the plaintext key.
• ApiKeyResponse
• app__models__schemas__FeatureFlagUpdate — Partial update.
• app__routers__app_settings__FeatureFlagUpdate
• AttributionPreviewResponse · uses 1 schema
• AttributionPreviewSample · used by 1 schema
• AttributionRuleField · used by 1 schema
• AttributionRuleFieldsResponse · uses 1 schema
• AttributionRuleIn
• AttributionRuleUpdate
• AuditLogListResponse · uses 1 schema
• AuditLogResponse · used by 1 schema
• BaselineDiff · used by 1 schema
• BatchAcceptRequest · uses 1 schema
• BillingOverviewProject · used by 1 schema
• BillingOverviewResponse · uses 1 schema
• BisectCommit · used by 1 schema
• BisectCompare · uses 1 schema · used by 1 schema
• BisectResponse · uses 2 schemas
• BisectRunRef · used by 1 schema
• Body_draft_release_phases_api_v1_releases__release_id__phases_generate_post
• Body_import_test_cases_api_v1_test_management_cases_import_post
• Body_ingest_file_api_v1_ingest_file_post
• Body_login_api_v1_auth_login_post
• Body_reassign_assigned_failure_api_v1_me_assigned_failures__test_case_id__reassign_put
• Body_start_project_import_api_v1_projects_import_post
• Body_trigger_finetune_api_v1_training_finetune_post
• BudgetConfig — Budget names are the existing DEFAULT_BUDGETS keys. · used by 1 schema
• BulkJobProgress · used by 1 schema
• BulkJobRead · uses 1 schema
• BulkRunFilter · used by 1 schema
• BulkTriggerRequest · uses 1 schema
• BulkTriggerResponse
• CadenceWindowStatus · used by 1 schema
• CandidateEvaluationAccepted
• CandidateEvaluationRequest · uses 1 schema
• CandidateOptionsResponse · uses 1 schema
• CandidateTierOption · used by 1 schema
• CanonicalManagedUnlinkRequest
• CanonicalPromotionResponse · uses 2 schemas
• CanonicalRetirementConfirmRequest
• CanonicalTestCaseBulkLinkRequest — Move multiple canonical test cases to a different suite within the same project.
• CanonicalTestCaseBulkLinkResponse — Outcome of a bulk-link request.
• CanonicalTestCaseLinkRequest — Move a canonical test case to a different suite within the same project.
• CanonicalTestCaseListResponse · uses 1 schema
• CanonicalTestCaseResponse · used by 2 schemas
• ChangePasswordRequest
• ChatMessageResponse
• ChatSessionCreate
• ChatSessionResponse
• CitationSchema · used by 1 schema
• ClassificationHintCreate
• ClassificationHintList · uses 1 schema
• ClassificationHintPreview
• ClassificationHintResponse · used by 1 schema
• ClassificationHintUpdate
• ClassifyUncategorizedRequest — POST body for /api/v1/analytics/classify-uncategorized — bulk-assign a failure category to every test case currently labelled UNKNOWN (or NULL) in the requested project + window. · uses 1 schema
• ClassifyUncategorizedResponse
• ClusterEpicCreateRequest — POST /projects/{id}/systemic-clusters/{membership_key}/epic.
• ClusterEpicCreateResponse — 201 with created: true (filed now), 200 with created: false (an epic was already stored).
• ClusterEpicLink — One epic filed for a current cluster (systemic_cluster_epics). · used by 1 schema
• ClusterEpicPreviewResponse — GET /projects/{id}/systemic-clusters/{membership_key}/epic/preview (read-only).
• ClusterEpicStatusResponse — GET /projects/{id}/systemic-clusters/epics — the cluster list’s one status read. · uses 1 schema
• ClusterInsightResponse · uses 1 schema · used by 1 schema
• ClusterResponse
• CodeownersCoverage — Coverage of recent failing-test paths by path ownership rules. · used by 1 schema
• CodeownersImportRequest — Import a CODEOWNERS file into path ownership rules.
• CodeownersImportResponse — Summary of a CODEOWNERS import. · uses 1 schema
• CommentMention — A project member an @username in a test-case comment resolved to. · used by 1 schema
• CompliancePackFileCheck · used by 1 schema
• CompliancePackGenerateRequest — Body for POST /api/v1/releases/{id}/compliance-pack.
• CompliancePackKeyRotateRequest
• CompliancePackLifecycleResponse
• CompliancePackListRead · uses 1 schema
• CompliancePackRead · uses 1 schema
• CompliancePackSigningKeyRead · used by 1 schema
• CompliancePackSigningKeysResponse · uses 1 schema
• CompliancePackSummaryRead — One pack in the project-wide list. · used by 1 schema
• CompliancePackVerification · uses 1 schema
• ConfidenceWhy — Explains the basis of the confidence score for transparency. · used by 1 schema
• ConnectorConfigTestRequest
• ConnectorTestResult
• CreateShareLinkRequest
• DecisionLogEntry — A single structured decision made by an agent — mirror of BaseAgent.log_decision output stored on AgentStageResult.decision_log. · used by 1 schema
• DecisionReportFeedbackRequest — Utility rating or claim correction for one immutable report version.
• DecisionReportRef · used by 2 schemas
• DecisionTrailResponse — Full decision trail for a pipeline run — the user-facing audit surface. · uses 3 schemas
• DeepCostRead · used by 1 schema
• DeepEstimateResponse · uses 4 schemas
• DeepEstimateStage · used by 1 schema
• DeepFindingResponse
• DeepGateRead · used by 1 schema
• DeepHistoryResponse · uses 1 schema
• DeepHistoryRow · used by 1 schema
• DeepPreScanResponse · uses 1 schema
• DeepRunConfigurationRead · used by 2 schemas
• DefectApprovalRequest
• DefectApprovalResponse
• DefectCandidateResponse — Pre-assembled defect candidate for a cluster (editable before submission).
• DefectIntakeRequest — POST body for /api/v1/analytics/defects — manual defect intake. · uses 1 schema
• DefectIntakeResponse
• DefectJiraLinkResult — What linking a Jira key did. · used by 1 schema
• DefectPatchRequest — PATCH /api/v1/projects/{project_id}/defects/{defect_id}.
• DefectPatchResponse — The PATCH answer: the defect’s list row as the server now reads it (the GET /analytics/defects row shape), so the page replaces its row. · uses 2 schemas
• DefectPromotionRequest — User-editable fields submitted from the promotion modal.
• DefectPromotionResponse
• DefectWriteBackResult — The Jira status write-back after a status change. · used by 1 schema
• DeletedProjectsStorageResponse · uses 1 schema
• DeletedProjectStorageEntry · uses 1 schema · used by 1 schema
• DeleteRunAcceptedResponse — 202, not 204. · uses 1 schema
• DeleteRunRequest — Payload for DELETE /api/v1/runs/{run_id}.
• DeletionAcknowledgeRequest — Confirms a collected archive was saved; the route answers DeletionJobResponse.
• DeletionExecuteAcceptedResponse
• DeletionExecuteRequest — Execute takes a JOB ID, never a criteria body. · uses 1 schema
• DeletionJobListResponse · uses 1 schema
• DeletionJobResponse — One deletion that ran (or is running). · used by 1 schema
• DeletionPreviewResponse — A frozen candidate set an ADMIN authorises from. · uses 2 schemas
• DigestContentResponse — Actionable digest content for a project or saved view scope. · uses 2 schemas
• DigestReleaseVerdict · used by 1 schema
• DigestScopeInfo — What a digest was filtered by; digest_scope_service.scope_info. · used by 1 schema
• DigestSide — Compact per-side summary for the Run Compare columns (core.digest_side). · used by 1 schema
• DigestSubscriptionCreate
• DigestSubscriptionResponse
• DigestSubscriptionUpdate
• DimensionScore · used by 2 schemas
• DuplicateActionResponse — Result of a dismiss / merge action on a candidate pair.
• DuplicateCandidateListResponse — Paginated list of duplicate candidates for a project’s review queue. · uses 1 schema
• DuplicateCandidateResponse — One detected near-duplicate pair with its explainable score breakdown. · uses 1 schema · used by 1 schema
• DuplicateCaseRef — Minimal reference to one ManagedTestCase in a duplicate pair. · used by 1 schema
• DuplicateDetectionRunResponse — Summary of a triggered detection sweep over a project’s authored cases.
• DuplicateMergeRequest — Non-destructive merge: flip the candidate to merged and optionally soft-deprecate the losing case.
• DurationRegressionsResponse — A run’s duration regressions. · uses 2 schemas · used by 1 schema
• DurationSpikeResponse — A PASSED test slower than its Welford baseline (>= 3 sigma, >= 10 samples). · used by 1 schema
• EmailAvailability
• EmailTrendsRequest
• EmailTrendsResponse
• EmbeddingFamilyProgress · used by 1 schema
• EmbeddingGenerationRead · used by 1 schema
• EmbeddingIndexRead · uses 2 schemas · used by 1 schema
• EnrichedTestCaseDetailResponse — Versioned additive contract for an executed test case. · uses 7 schemas
• ErasureBlocker · used by 1 schema
• ErasureLocationCount · used by 1 schema
• ErasurePreview · uses 3 schemas
• ErasureRequest
• EscalationConfig · used by 1 schema
• EvalCandidateIn · used by 2 schemas
• EvalCandidateResolved — What the run ACTUALLY replays (stored in ai_eval_runs.candidate). · uses 1 schema · used by 1 schema
• EvalMetric · used by 1 schema
• EvalProvenanceHealthResponse · used by 1 schema
• EvidenceGapItem · used by 1 schema
• EvidenceGapListResponse · uses 1 schema
• EvidenceReference · used by 1 schema
• ExecuteTestPlanItemRequest
• ExecutionDayPoint · used by 1 schema
• ExecutionDurationHistogram — The window’s test executions by duration, over fixed log-spaced bucket edges (every bucket present, zero-filled). · uses 1 schema · used by 1 schema
• ExecutionHistogramBucket — One duration bucket: lower_ms <= duration < upper_ms. · used by 1 schema
• ExecutionMetricsResponse — GET /api/v1/analytics/execution-metrics. · uses 6 schemas
• ExecutionPercentiles — P50 / p95 of one figure over a set of executions. · used by 2 schemas
• ExecutionPerDay · uses 1 schema · used by 1 schema
• ExecutionRegressionRule · used by 1 schema
• ExecutionRegressions · uses 3 schemas · used by 1 schema
• ExecutionSlowTest · used by 1 schema
• ExecutionSlowTests · uses 1 schema · used by 1 schema
• ExecutionSuiteRegression · used by 1 schema
• ExecutionSuiteRegressions · uses 1 schema · used by 1 schema
• ExecutionSuiteRow · uses 1 schema · used by 1 schema
• ExecutionSuites · uses 1 schema · used by 1 schema
• ExecutionSuiteWindow · uses 1 schema · used by 1 schema
• ExecutionTestRegression · used by 1 schema
• ExecutionTestRegressions · uses 1 schema · used by 1 schema
• ExecutionTotals · used by 1 schema
• ExportChoice — DeletionExecuteRequest.export. · used by 1 schema
• ExportEstimate — What archiving the DELETABLE runs of a criteria preview would cost and reclaim. · uses 1 schema · used by 1 schema
• ExportTierEstimate — One tier’s archive size estimate. · used by 1 schema
• FailureCategory · used by 4 schemas
• FallbackChainEntry — One analysis tier and whether it can actually run right now. · used by 1 schema
• FeatureFlagCreate
• FeatureFlagHistoryEntry — One audit row of a flag: what changed, who, when and why.
• FeatureFlagResponse
• FeedbackRating · used by 1 schema
• FeedbackRequest · uses 2 schemas
• FirstTimeResetRequest — Used for forced password reset on first login — no current password required.
• FixerConfigExtension · uses 2 schemas · used by 1 schema
• FixerPolicyBudgets · used by 1 schema
• FixerRunnerExtension · used by 1 schema
• FixOutcomeRequest — Outcome of a fix informed by TestLookup’s diagnosis.
• FlakyCoachEntry — Single flaky test with coaching recommendation. · uses 1 schema · used by 1 schema
• FlakyCoachResponse — Project-level flaky coach leaderboard. · uses 2 schemas
• FlakyCoachScope — What each number in the leaderboard is scoped to. · used by 1 schema
• FlakyCountCriteria — What a flaky-test count actually measured. · used by 1 schema
• FlakyQuarantineRead
• FlakyScoreBrief — The four-signal score of a Detected row; plain str vocabularies. · uses 1 schema · used by 1 schema
• FlakyScoreComponent — One of the four signals of the nightly flakiness score. · used by 1 schema
• FrontendError · used by 1 schema
• FrontendTelemetryBatch · uses 2 schemas
• GatedChannel · used by 1 schema
• GenerationBatchResponse
• GitHubAppInstallUrl
• GitHubAppSettingsRead — The deployment’s GitHub App.
• GitHubAppSettingsWrite
• GitHubAppSetupCallback
• GitHubAppSetupResult
• GitHubConnectionTestResponse
• GitHubIntegrationRead
• GitHubIntegrationWrite
• GitLabConfigRead — GET/PUT response for /projects/{id}/integrations/gitlab.
• GitLabConfigWrite — PUT body for /projects/{id}/integrations/gitlab.
• GitLabConnectionTestResponse
• GroupMappingIn · used by 1 schema
• GroupMappingsIn · uses 1 schema
• HoldRefRead — A live retention hold as it appears inside another answer. · used by 1 schema
• HttpExchangeIn — One HTTP request/response a test made. · uses 1 schema · used by 2 schemas
• HttpExchangeListResponse — GET /api/v1/runs/{run_id}/tests/{test_id}/http-exchanges. · uses 1 schema
• HttpExchangeRead · uses 1 schema · used by 1 schema
• HttpMessageIn — One side of an exchange, as the SDK sends it (cut + redacted by HttpExchangeIn). · used by 1 schema
• HttpMessageRead · used by 1 schema
• HTTPValidationError · uses 1 schema
• IdentityEventListResponse · uses 1 schema
• IdentityEventResponse · uses 1 schema · used by 2 schemas
• IdentityEventType · used by 1 schema
• IdentitySyncStatus — Aggregated sync health for the admin dashboard. · uses 1 schema
• ImportDuplicateOf · used by 1 schema
• ImportHeaderReport · used by 1 schema
• ImportRowResult · uses 1 schema · used by 1 schema
• ImportSummary · used by 1 schema
• IngestPayload — JSON batch ingest request body for POST /api/v1/ingest. · uses 4 schemas
• IngestResponse — Response for accepted ingest request.
• IngestTestResult — A single test result in a JSON batch ingest. · uses 1 schema · used by 1 schema
• InsightDetectorStatus · used by 1 schema
• InsightItem · uses 1 schema · used by 1 schema
• InsightLink · used by 1 schema
• InsightListResponse · uses 2 schemas
• InstanceEnablePreviewItem · used by 1 schema
• InstanceEnablePreviewResponse · uses 1 schema
• InstanceEnableRequest
• InstanceRetentionPolicyRead — GET/PUT /api/v1/settings/retention-defaults.
• InstanceRetentionPolicyWrite — PUT body.
• IntegrationHealthRow
• IntegrationsConfigRead — External integrations configuration (no tokens). · uses 1 schema
• IntegrationsConfigUpdate — Payload for updating integrations. · uses 1 schema
• InvestigatorActConfig — (D16): the action types Act may run in this project, each opt-in. · used by 1 schema
• InvestigatorConfigExtension · uses 2 schemas · used by 1 schema
• InvestigatorPolicyBudgets — The complete legacy Investigator budget contract preserved by E4.4. · used by 1 schema
• InvitationMembershipView · used by 1 schema
• InvitationPreviewResponse · uses 1 schema
• InvitationSummary — One row of the Pending invitations tab. · uses 2 schemas
• InvitationTokenRequest
• InviteProjectMembership — A project the invitee joins on accept, with its project role. · uses 1 schema · used by 1 schema
• InviteUserRequest · uses 2 schemas
• InviteUserResponse · uses 1 schema
• JiraDefectContext · used by 1 schema
• JiraDefectCreateRequest — Body for POST /projects/{project_id}/defects/jira.
• JiraDefectCreateResponse
• JiraDefectExistingLink · used by 1 schema
• JiraDefectMetadataResponse — Dialog-picker metadata. · uses 1 schema
• JiraDefectOccurrences · used by 1 schema
• JiraDefectPreviewResponse — Pre-filled payload shown (read-only) in the create dialog. · uses 3 schemas
• JiraIssueRequest
• JiraIssueResponse
• JiraProjectOption · used by 1 schema
• KnowledgeDomainAllowlistUpdate
• KnowledgeSourceCreate
• KnowledgeSourceFreshnessResponse
• KnowledgeSourceListResponse · uses 1 schema
• KnowledgeSourceResponse · used by 1 schema
• KnowledgeSourceSyncResponse
• KnowledgeSourceUpdate
• KnowledgeSyncEventResponse
• LibraryCaseList · uses 1 schema · used by 1 schema
• LibraryCaseRow · used by 3 schemas
• LibraryHealthComponent · used by 1 schema
• LibraryHealthResponse · uses 5 schemas
• LikelyAffectedTest · uses 1 schema · used by 1 schema
• LikelyAffectedTestReason · used by 1 schema
• LikelyAffectedTestsHistory · used by 1 schema
• LikelyAffectedTestsResponse · uses 2 schemas
• LinkRunRequest
• LiveEvent — A single test execution event from a client machine. · used by 2 schemas
• LiveEventBatch — A batch of events sent from a client machine. · uses 1 schema
• LiveEventBatchResponse
• LiveHttpExchangesIn — Body of POST /api/v1/stream/http-exchanges: one test’s exchanges of a live session, posted once by the reporter after the test’s result. · uses 1 schema
• LiveHttpExchangesResponse
• LiveSessionCreate — Request body to register a new live execution session. · uses 3 schemas
• LiveSessionResponse — Response returned when a session is created.
• LiveSessionState — Live state of an active or recently completed session. · used by 1 schema
• LiveStreamIngestRequest — API-key-authenticated streaming ingest. · uses 2 schemas
• LiveStreamIngestResponse
• LiveStreamMeta — Optional CI/run metadata that enriches the auto-created session. · uses 1 schema · used by 1 schema
• LlmQuotaRead
• LlmQuotaWrite — Admin-editable billing config for a project.
• LlmUsageHistoryEntry
• LlmUsageRead
• ManagedTestCaseCreate · uses 2 schemas
• ManagedTestCaseListResponse · uses 1 schema
• ManagedTestCaseResponse · uses 2 schemas · used by 2 schemas
• ManagedTestCaseUpdate · uses 2 schemas
• MemoryReference — Canonical pointer from generated output back to an auditable memory row. · used by 2 schemas
• MemoryTimelineResponse — Timeline of memory entries for a run, grouped by entity type.
• MfaChallengeResponse — Password accepted; a second factor is required to finish.
• MfaDisableRequest — Disabling requires the password and a live second factor.
• MfaEnrollConfirmRequest
• MfaEnrollConfirmResponse · uses 1 schema
• MfaEnrollmentRequiredResponse — Password accepted; workspace policy requires MFA and the user has none.
• MfaEnrollStartRequest
• MfaEnrollStartResponse
• MfaPolicyRead · uses 1 schema
• MfaPolicyUpdate · uses 1 schema
• MfaRecoveryCodesRequest
• MfaRecoveryCodesResponse
• MfaStatusResponse
• MfaVerifyRequest
• MLLastRun — The outcome of the most recent training attempt (ml:retrain:last). · used by 1 schema
• MLRetrainAccepted — 202 of POST /settings/ai/ml/retrain.
• MLStatusRead — What the Settings > AI ML card shows (QA lead and above). · uses 2 schemas
• MLTrainingState — Whether a training job holds the retrain lock right now. · used by 1 schema
• ModelConfig · uses 2 schemas · used by 1 schema
• ModelEndpointConfig — One tier’s model. · used by 1 schema
• MutationClass · used by 1 schema
• MyFailureItem — A single auto-assigned failure surfaced on the calling user’s inbox. · uses 1 schema · used by 1 schema
• MyFailureListResponse · uses 1 schema
• NotificationChannel · used by 2 schemas
• NotificationLogResponse
• NotificationPreferenceCreate — Create or replace a single channel preference. · uses 1 schema
• NotificationPreferenceResponse
• NotificationTransitionPolicyResponse
• NotificationTransitionPolicyUpdate — Per-project transition-notification policy.
• NotifyTestOwnerRequest — POST body for /api/v1/analytics/notify-owner — fires an email at the suite owner of the test that’s been failing repeatedly.
• NotifyTestOwnerResponse
• OutboxRequeueRequest — Which failed run-outbox intents to put back.
• OverrideAuditEntry — Single entry in the override audit trail. · used by 1 schema
• OverridePolicyConfig · used by 1 schema
• OwnershipBulkImportItem — Single item for bulk import. · used by 1 schema
• OwnershipBulkImportRequest — Bulk import of ownership rules. · uses 1 schema
• OwnershipResolution — Result of resolving ownership for a test/cluster.
• OwnershipRuleCreate — Create a new ownership rule.
• OwnershipRuleResponse — Ownership rule response.
• OwnershipRuleUpdate — Partial update for an ownership rule.
• PasswordResetLinkResponse — An admin-issued reset link.
• PendingDefectItem — One defect awaiting approval (GET /deep-investigate/defects/pending-review). · used by 1 schema
• PendingDefectList — A page of the approval queue. · uses 1 schema
• PerTestRouting · uses 1 schema · used by 1 schema
• PhaseDraft · used by 1 schema
• PhaseDraftResponse · uses 1 schema
• PhaseIn · used by 1 schema
• PhaseUpdate
• PipelineCompareResponse · uses 2 schemas
• PipelineCompareSide · used by 1 schema
• PipelineCompareStageCell · used by 1 schema
• PipelineCompareStageRow · uses 1 schema · used by 1 schema
• PipelineEventLogHealthResponse
• PipelineReplayAuditGaps · used by 2 schemas
• PipelineReplayEventResponse · used by 1 schema
• PipelineReplayIntegritySummary · uses 1 schema · used by 1 schema
• PipelineReplayResponse · uses 4 schemas
• PipelineReplayStageResponse · used by 1 schema
• PipelineTimelineEventResponse · used by 1 schema
• PipelineTimelineResponse · uses 3 schemas
• PipelineTimelineSummary · used by 1 schema
• PolicyDimensionWeights — Weights for 7-dimension risk scoring (should sum to 1.0). · used by 1 schema
• PolicyDocument — The full policy rule document stored as JSON in release_gate_policies.rules. · uses 6 schemas · used by 3 schemas
• PolicyHardCaps — Hard caps that downgrade the pass-rate band before the verdict map. · used by 1 schema
• PolicyKindBudget — Failure budget for one excludable failure kind. · used by 1 schema
• PolicyKindRules — Opt-in failure-kind weighting for the release gate. · uses 1 schema · used by 1 schema
• PolicyPassRateBands — Project-level 4-band classification for the build colour and verdict. · used by 1 schema
• PolicyRule — A single rule within a release gate policy. · used by 1 schema
• PolicySimulateRequest — Simulate a draft policy against a past run. · uses 1 schema
• PolicySimulateResponse — Side-by-side comparison: original vs simulated policy result. · uses 1 schema
• PolicyThresholds — Risk score thresholds for GO/NO_GO classification. · used by 1 schema
• PreReleaseGateRequest
• PreScanGroup · used by 1 schema
• ProjectCreate
• ProjectDataError — A W24 refusal: also the 4xx detail shape {code, message} (ERROR_SENTENCES). · used by 1 schema
• ProjectDataHistoryReport — Inside ProjectDataImportReport.history. · uses 1 schema · used by 1 schema
• ProjectDataImportReport · uses 2 schemas · used by 1 schema
• ProjectDataJobList · uses 1 schema
• ProjectDataJobRead — One export / import job. · uses 5 schemas · used by 1 schema
• ProjectDataOptions — Echoed on an export job: what was asked for. · used by 1 schema
• ProjectDataProgress · used by 1 schema
• ProjectDataSkip · used by 2 schemas
• ProjectDataUpload — A parted import upload’s state (import jobs in “uploading”). · used by 1 schema
• ProjectExportEstimate — GET /projects/{id}/export-estimate: counts only.
• ProjectExportRequest — The OPTIONAL JSON body of POST /projects/{id}/export.
• ProjectImportPartReceipt — The answer of PUT /project-imports/uploads/{data_job_id}/parts/{part_number}.
• ProjectImportUploadStart — Body of POST /project-imports/uploads: every part but the last is exactly IMPORT_PART_MAX_BYTES.
• ProjectMemberResponse · uses 1 schema
• ProjectResetRequest — Destructive reset payload.
• ProjectResetResponse
• ProjectResponse
• ProjectRestoreResponse — A restored project and what deliberately stayed revoked.
• ProjectStorageResponse · uses 1 schema · used by 1 schema
• ProjectUpdate — Partial update for project attributes.
• PrometheusMetricTemplate — One admin-defined metric template; the server substitutes {service} (escaped) — never model PromQL. · used by 1 schema
• PrometheusMetricTemplateIn — A template as an ADMIN saves it (IntegrationsConfigUpdate): the placeholder, control characters and the unit are checked per item, so a 422’s loc is prometheus_metric_templates.N.<field>. · used by 1 schema
• PromoteModelRequest
• QuarantineDecisionRequest — Body for approve / reject / release endpoints.
• QuarantineLifecyclePolicyResponse
• QuarantineLifecyclePolicyUpdate — Per-project quarantine lifecycle policy.
• QuarantineManifestEntry — One currently-quarantined test in the CI manifest. · used by 1 schema
• QuarantineManifestResponse — Versioned quarantine manifest consumed by CI (testlookup ci-verdict). · uses 1 schema
• QuarantineProposeRequest — Manual proposal — rarely used.
• QuarantineStatsResponse — Counts per status for the /quarantine page header tiles.
• RagCaseAcceptEdits — Content fields a reviewer may change while accepting generated work. · uses 2 schemas · used by 2 schemas
• RagGenerateRequest
• RagGenerateResponse · uses 1 schema
• RagRetrieveRequest
• RagRetrieveResponse · uses 1 schema
• RagStatusResponse
• RecentSearchesResponse · uses 1 schema
• RecentSearchRead · used by 1 schema
• RedeemResetLinkRequest
• ReferenceBrokenRead — A link a deletion breaks (a SET NULL foreign key to test_runs) — a warning, never a block. · used by 3 schemas
• RefreshRequest
• RejectCaseRequest
• RejectReviewRequest
• ReleaseCouncilOverrideRequest — Override request with enhanced audit fields.
• ReleaseCouncilResponse — Extended release decision with council context. · uses 6 schemas
• ReleaseGatePolicyCreate — Create a new draft policy. · uses 1 schema
• ReleaseGatePolicyResponse — Policy summary response.
• ReleaseGatePolicyUpdate — Update a draft policy (fails if already published). · uses 1 schema
• ReleaseIn · uses 1 schema
• ReleaseOutcomeIn — A production outcome reported by a release owner for G5 drift.
• ReleasePhaseBulkItem · used by 1 schema
• ReleasePhasesBulkRequest · uses 1 schema
• ReleasePhasesCloneRequest
• ReleasePhasesCreatedResponse
• ReleasePortfolioTotals · used by 1 schema
• ReleasePortfolioTrend · uses 1 schema
• ReleaseSyncIn
• ReleaseUpdate
• ReportEvalCycleRequest
• ReportExportOut — One background report export. · used by 1 schema
• ReportExportRequestOut — What POST /exports decided. · uses 1 schema
• RequiredModel — One model the effective configuration depends on. · used by 1 schema
• RequirementCoverageSchema
• RequirementCoverageSummary · uses 1 schema · used by 2 schemas
• RequirementGapRead · used by 2 schemas
• RequirementLinkCreate
• RequirementLinkListResponse · uses 1 schema
• RequirementLinkRead · used by 1 schema
• ResetLinkRequest
• RetentionCriteria — What to delete.
• RetentionHoldCreate — POST /projects/{id}/retention-holds body.
• RetentionHoldListResponse · uses 1 schema
• RetentionHoldRead — One hold; state (live / expired / released) is computed by the service for now. · used by 1 schema
• RetentionHoldRelease — POST /projects/{id}/retention-holds/{hold_id}/release body.
• RetentionLastPurge — Latest execute-mode purge, parsed from the settings_audit_log purge-audit rows (setting_key = "retention_purge:{project_id}"). · used by 1 schema
• RetentionPolicyRead — GET/PUT response — the EFFECTIVE policy plus its source (default = no row, custom = project row exists). · uses 1 schema
• RetentionPolicyWrite — PUT body for /projects/{id}/retention-policy.
• RetentionPreviewCandidates — Per-class candidate counts a purge WOULD delete right now. · used by 1 schema
• RetentionPreviewFloor · used by 1 schema
• RetentionPreviewHold · used by 1 schema
• RetentionPreviewHolds · uses 1 schema · used by 1 schema
• RetentionPreviewResponse — POST .../retention-policy/preview — dry-run, writes nothing. · uses 4 schemas
• RetentionPurgeQueued — 202 body — the execute-mode purge was enqueued to Celery.
• RetentionPurgeRequest — POST .../retention-policy/purge — typed-name confirmation (project_reset convention): must equal the project name exactly.
• RetireCompliancePackRequest — Bring a pack’s retention window forward to now.
• RetrievedChunkSchema · used by 1 schema
• RetryConfig · used by 1 schema
• ReviewActionRequest
• ReviewBlock — Human-review status of an AI report. · used by 3 schemas
• ReviewConfig · used by 1 schema
• ReviewerCleanObservation · used by 1 schema
• ReviewerHumanOutcome · used by 1 schema
• ReviewerMutationObservation · uses 1 schema · used by 1 schema
• ReviewerQualityRequest · uses 3 schemas
• ReviewerQualityRunListResponse · uses 1 schema
• ReviewerQualityRunRead — An AIEvalReviewerQuality row WITHOUT its observation arrays. · used by 1 schema
• ReviewGateRead — GET/PUT /api/v1/settings/review-gate. · uses 2 schemas
• ReviewGateWrite — PUT body.
• ReviewQueueSummary · uses 1 schema · used by 1 schema
• ReviewResponse — A review request as clients see it.
• RoleActions — Role-aware recommended actions generated by the ReAct agent. · used by 1 schema
• RuleEvaluationResponse — Result of evaluating a single policy rule. · used by 2 schemas
• RunBranchItem · used by 1 schema
• RunBranchListResponse · uses 1 schema
• RunBrief · used by 1 schema
• RunCadenceCreate
• RunCadenceList · uses 1 schema
• RunCadencePatch — Every field optional; an empty PATCH changes nothing.
• RunCadencePauseRequest
• RunCadenceRead · used by 2 schemas
• RunCadenceStatusItem · uses 2 schemas · used by 1 schema
• RunCadenceStatusResponse · uses 1 schema
• RunCompareAIReport · used by 1 schema
• RunCompareResponse · uses 6 schemas
• RunCompareSelection · used by 1 schema
• RunCompareSummary — One side of the compare view — the subset of TestRun fields used by the diff UI. · used by 1 schema
• RunCompareTestDelta — A single test whose status or duration differed between the two runs. · used by 1 schema
• RunCompareTransition — How many tests went from one status to another between the runs. · used by 1 schema
• RunContext — run_context on IngestPayload / LiveSessionCreate / LiveStreamMeta and the /ingest/file form. · used by 3 schemas
• RunSignatureBatchResponse · uses 1 schema
• RunSignatureEntry · used by 1 schema
• RunSignatureItem · uses 1 schema · used by 1 schema
• RunTimeline — Tests with a start and a finish, for the waterfall. · uses 1 schema · used by 1 schema
• RunTimelineItem · used by 1 schema
• RunTimingFigures — The run’s own figures. · used by 1 schema
• RunTimingLane — One worker lane: the timed tests one worker ran. · used by 1 schema
• RunTimingPhases — Setup / test body / teardown totals over the run’s tests. · used by 1 schema
• RunTimingResponse — GET /api/v1/runs/{run_id}/timing. · uses 7 schemas
• RunTimingSlowest · uses 1 schema · used by 1 schema
• RunTimingSuites · uses 1 schema · used by 1 schema
• RunTimingTestResponse — One test of the run, as the slowest list shows it. · uses 1 schema · used by 1 schema
• RunTimingWorkers · uses 1 schema · used by 1 schema
• RunVerdictBatchResponse · uses 1 schema
• RunVerdictItem — One run of GET /runs/ai-verdicts: what its AI-verdict pill is computed from. · used by 1 schema
• SavedViewCreate
• SavedViewRelease — Whether THIS reader may apply the release stored in a view (S5-3f-ii). · used by 1 schema
• SavedViewResponse · uses 1 schema
• SavedViewUpdate
• SCIMEmail · used by 1 schema
• SCIMGroup · used by 1 schema
• SCIMName · used by 1 schema
• SCIMPatchOp · used by 1 schema
• SCIMPatchRequestPayload — Inbound PATCH payload; the protocol schemas member is required. · uses 1 schema
• SCIMTokenCreate — Create a new SCIM bearer token.
• SCIMTokenCreatedResponse — Returned once at creation — includes the plaintext token.
• SCIMTokenResponse
• SCIMUserRequest — Inbound SCIM user payload; the protocol schemas member is required. · uses 3 schemas
• SearchSuggestion · used by 1 schema
• SearchSuggestionsResponse · uses 1 schema
• SearchUsageRead
• SelfUpdateProfileRequest — Fields a user can update about themselves (no role/status changes).
• SendMessageRequest
• SendMessageResponse
• SetBaselineRequest
• ShadowConfig · used by 1 schema
• ShadowPairLabelRequest
• ShadowPairListResponse · uses 1 schema
• ShadowPairRead · uses 1 schema · used by 1 schema
• ShadowPairSource · used by 1 schema
• ShareLinkResponse
• SimilarMemoryRecallRequest — Request body for semantic similarity recall.
• SimilarMemoryRecallResponse — Response with ranked similar memories. · uses 1 schema
• SimilarMemoryResponse — A memory entry with a similarity score from vector recall. · uses 2 schemas · used by 1 schema
• SmtpConfigRead — SMTP server configuration returned to the client (no password).
• SmtpConfigUpdate — Payload for updating SMTP server configuration.
• SmtpTestResult
• SourceRoot · used by 2 schemas
• SourceRootsPreview
• SourceRootsResponse · uses 1 schema
• SourceRootsUpdate · uses 1 schema
• SSOConfigCreate — Create a new SSO configuration. · uses 3 schemas
• SSOConfigResponse — SSO configuration response (certificate is masked). · uses 3 schemas
• SSOConfigUpdate — Partial update of SSO configuration. · uses 2 schemas
• SSOEnforcementMode · used by 3 schemas
• SSOExchangeRequest — The one-time code the ACS hands the browser after an SSO sign-in.
• SSOLoginResponse — Token response after successful SSO authentication. · uses 1 schema
• SSOProviderType · used by 2 schemas
• SSORolePreviewRequest — Preview the role a user in groups gets.
• SSORolePreviewResponse
• SSOTestConnectionResponse — Result of testing SSO configuration.
• StageDecisionSummary · uses 1 schema · used by 1 schema
• StepAction
• StorageConfigRead — Data & storage configuration returned to the client.
• StorageConfigUpdate — Payload for updating storage config.
• StoreFootprintResponse — One store’s contribution to a project’s storage footprint. · used by 1 schema
• StrategyGapRead · used by 1 schema
• StreamMessageRequest — One streamed chat turn: a new question, or retry to answer the session’s unanswered (or stopped) last question again.
• StreamTicketResponse
• SubjectJobList · uses 1 schema
• SubjectJobRead — One personal-data export / erasure job. · uses 1 schema · used by 2 schemas
• SubjectRightsError — Also the 4xx detail shape {code, message} (subject_rights_vocab.ERROR_SENTENCES). · used by 1 schema
• SuiteDurationRegressionResponse — A suite whose median over its last 5 runs is >= 1.5x the 20 before. · used by 1 schema
• SuiteExecutionHistoryResponse — GET /api/v1/analytics/execution/suite-history. · uses 2 schemas
• SuiteExecutionResponse — One suite_executions row: how long one suite of one run took. · used by 1 schema
• SuiteHistoryPoint — One run of the suite. · used by 1 schema
• SuiteHistoryStats — Window percentiles over EVERY execution in the window (not only the returned points). · uses 1 schema · used by 1 schema
• SuiteOwnerResponse
• SuiteOwnerUpdate — PUT body for setting/clearing a suite’s explicit owner.
• SuiteParityCutover · used by 1 schema
• SuiteParityCutoverResult — POST /api/v1/admin/maintenance/suite-membership-cutover → 200.
• SuiteParityHistory · uses 2 schemas
• SuiteParityProjectLine · used by 1 schema
• SuiteParityRunDetail · uses 2 schemas
• SuiteParityRunSummary — One comparison of the legacy suite memberships with the canonical model. · used by 1 schema
• SuiteParitySampleRow · used by 1 schema
• SuiteReviewResponse
• SuiteReviewUpdate
• SummaryReportResponse · uses 4 schemas
• SummaryStepBreakdownRow — One captured granular step for a failing test. · used by 1 schema
• SummarySuiteRow · used by 1 schema
• SummaryTopFailingTest · uses 1 schema · used by 1 schema
• SummaryTotals · used by 1 schema
• SuppliedCommit — One commit in a caller-supplied commit range. · used by 3 schemas
• SuppliedCommitRange — A caller-supplied commit range WITH its boundary refs. · uses 1 schema · used by 2 schemas
• TaskBudgetV1 · used by 2 schemas
• TaskUsageV1 · used by 1 schema
• TeamChannelResponse — Team → notification channel mapping.
• TeamChannelUpsert — Create/replace the notification channel for one ownership team.
• TerminalOutcomeV1 · used by 1 schema
• TestAttachmentResponse — Index-only attachment metadata. · used by 2 schemas
• TestCaseBulkItemResult · used by 1 schema
• TestCaseBulkRequest
• TestCaseBulkResponse · uses 1 schema
• TestCaseClassificationSection — Classification fields supplied by the report or existing catalog. · used by 1 schema
• TestCaseCommentCreate
• TestCaseCommentResponse · uses 1 schema
• TestCaseDeprecateRequest
• TestCaseDurationStatsResponse — Duration percentiles of the test over the history window (every execution in the window, not only the 50 points returned). · used by 1 schema
• TestCaseExecutionSection — Outcome and bounded execution metadata for the result snapshot. · uses 1 schema · used by 1 schema
• TestCaseFlakinessResponse — Computed flakiness for the in-window timeline. · used by 1 schema
• TestCaseHistoryPointResponse — One cross-run point in a logical test’s timeline (most-recent-first). · uses 1 schema · used by 1 schema
• TestCaseHistoryResponse — Wrapper for GET /runs/{run_id}/tests/{test_id}/history. · uses 6 schemas
• TestCaseIdentitySection — Stable and source-native identifiers for one executed test result. · used by 1 schema
• TestCaseImportResponse · uses 3 schemas
• TestCaseLifecycleState — Stored lifecycle vocabulary for authored ManagedTestCase rows.
• TestCaseListResponse · uses 1 schema
• TestCaseMetadataResponse — Identity metadata: owner, effective suite, first/last seen, timestamps. · used by 1 schema
• TestCaseParameterSchema — Optional authored input metadata; sensitive values are never required. · used by 5 schemas
• TestCaseProvenanceSection — Where the current normalized detail came from. · used by 1 schema
• TestCaseRestoreRequest
• TestCaseReviewResponse
• TestCaseStepSchema — Authored step shape; expected outcomes are optional by design. · used by 5 schemas
• TestCaseSummary · uses 1 schema · used by 1 schema
• TestCaseTimelineResponse · uses 1 schema
• TestCaseTransitionRequest
• TestCaseVersionExecution — A plan execution recorded against one case version. · used by 1 schema
• TestCaseVersionResponse · uses 3 schemas
• TestDurationBaselineResponse — A test’s running duration statistics (perf_baselines). · used by 2 schemas
• TestExecutionReviewRead — Current review state for an AI-flagged failure.
• TestExecutionReviewUpdate — Transition the review state.
• TestHealthFinding — Per-test health finding. · uses 1 schema · used by 1 schema
• TestHealthResponse — Test health findings for a run. · uses 1 schema
• TestHealthViolation · used by 1 schema
• TestHistoryAI · used by 1 schema
• TestHistoryAIChange · used by 1 schema
• TestNotificationRequest · uses 1 schema
• TestPlanCreate
• TestPlanItemCreate
• TestPlanItemResponse
• TestPlanListResponse · uses 1 schema
• TestPlanResponse · used by 1 schema
• TestPlanUpdate
• TestStatus · used by 5 schemas
• TestStepResponse — One granular step in a logical test’s latest-run snapshot. · uses 3 schemas · used by 2 schemas · recursive
• TestStrategyResponse
• TestStrategyUpdate
• TestSuiteCreate
• TestSuiteListResponse · uses 1 schema
• TestSuiteResponse · used by 1 schema
• TestSuiteUpdate — None = keep existing value.
• ThresholdCheck — The recorded confidence-gate evaluation for one AI output. · used by 3 schemas
• ThresholdsConfig · used by 1 schema
• TierComparisonRequest · uses 1 schema
• TierOutputPairRequest · used by 1 schema
• TimelineEntry · uses 1 schema · used by 1 schema
• TimelineLink · used by 1 schema
• TimelineNoteCreate
• TimelineNoteList · uses 1 schema
• TimelineNoteResponse · used by 1 schema
• TimelineNoteUpdate — Only the fields SENT are applied (model_fields_set).
• TokenResponse · used by 1 schema
• ToolsConfig · used by 1 schema
• TraceabilityGapsResponse · uses 3 schemas
• TrackEventRequest
• TriageStatusUpdate — Body of PUT /api/v1/me/assigned-failures/{id}/triage.
• TriggerDeepRequest
• TriggerDeepResponse · uses 1 schema
• TriggerPipelineRequest
• UIDismissalCreate — Dismiss a UI prompt for the authenticated user.
• UIDismissalListResponse
• UpdateProjectMemberRoleRequest · uses 1 schema
• UpdateUserProfileRequest — Editable user attributes. · uses 1 schema
• UpdateUserRoleRequest · uses 1 schema
• UpdateUserStatusRequest
• UploadStatusResponse — Async status of an uploaded report (GET /api/v1/ingest/uploads/{task_id}).
• UserCreate
• UserListResponse · uses 1 schema
• UserResponse · uses 1 schema · used by 1 schema
• UserRole · used by 19 schemas
• ValidationError · used by 1 schema
• ValueMetricAssumptionsRead — GET/PUT response — the EFFECTIVE assumptions plus their source (default = no row, custom = project row exists).
• ValueMetricAssumptionsWrite — PUT body for /projects/{id}/value-metrics/assumptions.
• WebhookDeliveryRead
• WebhookDeliveryReplayResponse — Result of POST /webhooks/{sub_id}/deliveries/{delivery_id}/replay.
• WebhookEventCatalogEntry · used by 1 schema
• WebhookEventCatalogResponse · uses 1 schema
• WebhookSubscriptionRead
• WebhookSubscriptionWrite
• WebhookTestResponse
• WebVitalReport · used by 1 schema
• WorkflowBodyV1 · uses 4 schemas
• WorkflowDecisionEvent · used by 1 schema
• WorkflowDefaultRead · used by 1 schema
• WorkflowDefaultsResponse · uses 1 schema
• WorkflowDefaultUpdate
• WorkflowEdgeV1 · used by 1 schema
• WorkflowEvaluateV1
• WorkflowForkV1
• WorkflowLoopV1 · used by 1 schema
• WorkflowPublishV1
• WorkflowRetryPolicyV1 · used by 1 schema
• WorkflowStepV1 · used by 1 schema
• WouldRefuseChannel · used by 1 schema
• WouldRefuseSummary — The ai_report.distribution_would_refuse audit rows of the last 30 days. · uses 1 schema · used by 1 schema

Links between schemas

On each schema page, field types link to the schemas they use, and Used by schemas lists the schemas that contain it.

Download the specification

Download the OpenAPI document (JSON).

Schemas that contain themselves

These schemas refer back to themselves, directly or through other schemas. Their pages link to the schema instead of nesting it forever.

• TestStepResponse