@proofline/sdk 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/schema.d.ts CHANGED
@@ -144,6 +144,26 @@ export interface paths {
144
144
  patch?: never;
145
145
  trace?: never;
146
146
  };
147
+ "/api/v1/organizations/{org_id}/repositories/{repo_id}/file-reviews": {
148
+ parameters: {
149
+ query?: never;
150
+ header?: never;
151
+ path?: never;
152
+ cookie?: never;
153
+ };
154
+ get?: never;
155
+ put?: never;
156
+ /**
157
+ * Review selected whole files
158
+ * @description Reviews up to twenty exact file paths at one pushed commit. Requires live GitHub read access and verifies every path at that commit. The retained selection is immutable; a repeat by the same person returns its review. Results remain in Proofline and are never posted to GitHub.
159
+ */
160
+ post: operations["request_file_review"];
161
+ delete?: never;
162
+ options?: never;
163
+ head?: never;
164
+ patch?: never;
165
+ trace?: never;
166
+ };
147
167
  "/api/v1/organizations/{org_id}/repositories/{repo_id}/patch-reviews": {
148
168
  parameters: {
149
169
  query?: never;
@@ -155,7 +175,7 @@ export interface paths {
155
175
  put?: never;
156
176
  /**
157
177
  * Review local changes
158
- * @description Reviews a unified diff against a commit GitHub has in the repository, and returns that patch's review when one exists. The review reads only that commit and the patch, and is never posted to a pull request. Requires live GitHub read access; the same patch on the same base always returns the same review.
178
+ * @description Reviews a unified diff against a commit GitHub has in the repository, and returns that patch's review when one exists. The review reads only that commit and the patch, and is never posted to a pull request. With `verify_finding_ids`, the review also re-verifies those open findings of one pull request against the patch and reports each outcome on the review, without changing the pull request's findings. Requires live GitHub read access; the same patch on the same base, re-verifying the same findings, always returns the same review.
159
179
  */
160
180
  post: operations["request_patch_review"];
161
181
  delete?: never;
@@ -384,6 +404,26 @@ export interface paths {
384
404
  patch?: never;
385
405
  trace?: never;
386
406
  };
407
+ "/api/v1/organizations/{org_id}/reviews/{review_id}/stop": {
408
+ parameters: {
409
+ query?: never;
410
+ header?: never;
411
+ path?: never;
412
+ cookie?: never;
413
+ };
414
+ get?: never;
415
+ put?: never;
416
+ /**
417
+ * Stop your local review
418
+ * @description Stops the holder's own pending or running withheld patch, commit or named-file review. Requires a personal or CLI device token with live GitHub read access to the review's repository. Organization, CI job and MCP OAuth tokens cannot stop reviews. The stopped review retains its findings and exact code identity; requesting the same input returns that stopped review.
419
+ */
420
+ post: operations["stop_review"];
421
+ delete?: never;
422
+ options?: never;
423
+ head?: never;
424
+ patch?: never;
425
+ trace?: never;
426
+ };
387
427
  }
388
428
  export type webhooks = Record<string, never>;
389
429
  export interface components {
@@ -525,6 +565,15 @@ export interface components {
525
565
  };
526
566
  /** @enum {string} */
527
567
  AgentVendor: "CURSOR_CLOUD_AGENTS" | "DEVIN";
568
+ ApprovalGap: {
569
+ /**
570
+ * Format: uuid
571
+ * @description Assessment whose approval could not supply deferred occurrence questions.
572
+ */
573
+ assessment_id: string;
574
+ /** @description Reason the assessment's approval could not supply deferred occurrence questions. */
575
+ code: string;
576
+ };
528
577
  AssessmentProjection: {
529
578
  /**
530
579
  * Format: uuid
@@ -583,6 +632,8 @@ export interface components {
583
632
  /** @enum {string} */
584
633
  Authority: "ADVISORY" | "DEPLOYMENT_POLICY";
585
634
  Availability: ("RECORDED" | "NOT_RECORDED" | "LEGACY" | "OPERATIONAL_FAILURE") | "LIMITED";
635
+ /** @description How the capture ended. */
636
+ CaptureState: "PENDING" | "RECORDED" | "UNBOUND" | "NOT_EXECUTED" | "INCOMPLETE";
586
637
  /**
587
638
  * @description Which conditions behind a check's result the change brought, and which
588
639
  * World found at the review's base revision. It sits beside the result and
@@ -656,6 +707,52 @@ export interface components {
656
707
  /** @description The revision that holds the counted conditions. */
657
708
  revision: components["schemas"]["AttributedRevision"];
658
709
  };
710
+ /** @enum {string} */
711
+ ChangeDiagramKindView: "FLOWCHART" | "SEQUENCE";
712
+ ChangeDiagramOutcome: "DRAWN" | "NO_INTERACTION" | "INDEX_INCOMPLETE" | "OVER_CAPS" | "DECISION_UNAVAILABLE";
713
+ /** @description The change-level diagram recorded for a review, or why there is none. */
714
+ ChangeDiagramView: {
715
+ /** @description Diagram format when a diagram was drawn; otherwise null. */
716
+ kind?: components["schemas"]["ChangeDiagramKindView"] | null;
717
+ /**
718
+ * @description Markdown lines under the diagram: which environment and snapshot its
719
+ * dashed relations come from, or which environment was not read.
720
+ */
721
+ legend: string[];
722
+ /**
723
+ * @description Mermaid source the server generated from the stored graph. Every
724
+ * label is escaped, and no model wrote any of it. Absent unless
725
+ * `outcome` is `DRAWN`.
726
+ */
727
+ mermaid?: string | null;
728
+ /** @description Whether the diagram was drawn, or why no diagram is available. */
729
+ outcome: components["schemas"]["ChangeDiagramOutcome"];
730
+ };
731
+ /** @description What a review recorded about its change. */
732
+ ChangeSummary: {
733
+ /** @description The compared base commit. Null when the review pinned none. */
734
+ base_sha?: string | null;
735
+ /**
736
+ * @description The changed files the review read, by path, with the depth it read
737
+ * them at. Empty when the review recorded no change digest. Files the
738
+ * review's filters kept from review are listed apart, with their reason.
739
+ */
740
+ files: components["schemas"]["FileFact"][];
741
+ /** @description The reviewed head commit. */
742
+ head_sha: string;
743
+ /**
744
+ * @description Model-written prose. Present only when `prose_outcome` is `PUBLISHED`.
745
+ * It is untrusted text: render it inert.
746
+ */
747
+ prose?: components["schemas"]["Prose"] | null;
748
+ /** @description The recorded prose-generation outcome, before response-time withholding. */
749
+ prose_outcome: components["schemas"]["ProseOutcome"];
750
+ /**
751
+ * @description The route the summary applied. Null when the review recorded no change
752
+ * digest, so no route was asked.
753
+ */
754
+ route?: components["schemas"]["SummaryRoute"] | null;
755
+ };
659
756
  /**
660
757
  * @description World's lifecycle disclosure for the evaluator version that answered, as
661
758
  * the receipt recorded it. A deployment gate counts only `GATING` results
@@ -755,6 +852,12 @@ export interface components {
755
852
  * records no decision basis.
756
853
  */
757
854
  decision_presentation?: components["schemas"]["CustomerDecision"] | null;
855
+ /**
856
+ * @description What World declares depends on what this change deploys in this
857
+ * environment, at the assessment's pinned snapshot. Absent when the
858
+ * assessment's kind records no declared reach.
859
+ */
860
+ declared_reach?: components["schemas"]["DeclaredReachView"] | null;
758
861
  /**
759
862
  * @description The risk domains the assessment evaluated, each with its status and
760
863
  * reason, ordered by domain.
@@ -812,6 +915,12 @@ export interface components {
812
915
  * records no decision basis.
813
916
  */
814
917
  decision_presentation?: components["schemas"]["CustomerDecision"] | null;
918
+ /**
919
+ * @description What World declares depends on what this change deploys in this
920
+ * environment, at the assessment's pinned snapshot. Absent when the
921
+ * assessment's kind records no declared reach.
922
+ */
923
+ declared_reach?: components["schemas"]["DeclaredReachView"] | null;
815
924
  /**
816
925
  * @description The risk domains the assessment evaluated, each with its status and
817
926
  * reason, ordered by domain.
@@ -1233,6 +1342,20 @@ export interface components {
1233
1342
  * orientation only. Null when no pull request state is recorded.
1234
1343
  */
1235
1344
  base_ref?: string | null;
1345
+ /**
1346
+ * @description The change-level diagram: the changed call path from the pinned code
1347
+ * index and the relations World declares. Absent when the review
1348
+ * recorded none.
1349
+ */
1350
+ change_diagram?: components["schemas"]["ChangeDiagramView"] | null;
1351
+ /**
1352
+ * @description What the change does and which files the review read at which depth
1353
+ * (§55). Null until the review's publication records it, and for a
1354
+ * review that is not of a pull request. Generated text has current
1355
+ * credentials and recorded protected values withheld; missing or expired
1356
+ * provenance withholds the generated text whole.
1357
+ */
1358
+ change_summary?: components["schemas"]["ChangeSummary"] | null;
1236
1359
  /**
1237
1360
  * @description The GitHub check run Proofline published for this review. Null when
1238
1361
  * none was published.
@@ -1279,6 +1402,11 @@ export interface components {
1279
1402
  * @description How many findings this review's assessments recorded, across all of them.
1280
1403
  */
1281
1404
  finding_count: number;
1405
+ /**
1406
+ * @description Whether fix generation is configured for this deployment and organization.
1407
+ * Write authorization is checked again when a fix is requested.
1408
+ */
1409
+ fix_generation_enabled?: boolean;
1282
1410
  /**
1283
1411
  * @description The head commit this review is pinned to. For a patch review, the
1284
1412
  * revision ID Proofline derives from its base commit and patch digest,
@@ -1300,11 +1428,21 @@ export interface components {
1300
1428
  * @description The review's identifier.
1301
1429
  */
1302
1430
  id: string;
1431
+ /** @description Present and true when this run is a Deep Review. */
1432
+ is_deep_review?: boolean;
1303
1433
  /**
1304
1434
  * @description `PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes
1305
- * sent as a patch, or `COMMIT`, a review of pushed commits.
1435
+ * sent as a patch, `COMMIT`, a review of pushed commits, or `FILES`,
1436
+ * complete selected files at one pushed commit.
1306
1437
  */
1307
1438
  kind: string;
1439
+ /**
1440
+ * @description For a patch review requested with `verify_finding_ids`, each finding
1441
+ * it re-verifies against the patch and the outcome. The outcome is
1442
+ * local: the pull request's finding is unchanged whatever it is. Absent
1443
+ * otherwise.
1444
+ */
1445
+ local_reverifications?: components["schemas"]["LocalReverification"][];
1308
1446
  /**
1309
1447
  * @description The deterministic policy for this exact repository/head, when opted in.
1310
1448
  * Its captured review owner and GitHub bypass remain separate history.
@@ -1364,6 +1502,12 @@ export interface components {
1364
1502
  pull_request_title?: string | null;
1365
1503
  /** @description The pull request on GitHub. Absent for a deployment review or when the repository is unknown. */
1366
1504
  pull_request_url?: string | null;
1505
+ /**
1506
+ * @description How this review decided what it reviews after a push or a full-review
1507
+ * request. Absent for a review that refreshes nothing, and while a
1508
+ * refresh has not decided yet.
1509
+ */
1510
+ refresh?: components["schemas"]["RefreshView"] | null;
1367
1511
  /**
1368
1512
  * @description Every other run for this pull request the caller can see, plus reviews
1369
1513
  * joined to this one by supersession or rerun.
@@ -1449,9 +1593,53 @@ export interface components {
1449
1593
  * requested without naming a hook.
1450
1594
  */
1451
1595
  trigger_source?: components["schemas"]["PatchTriggerSource"] | null;
1596
+ /**
1597
+ * @description The reviewed head's changed files in reading groups, with a line per
1598
+ * file. Absent until the walkthrough is stored, and for a review that
1599
+ * has none.
1600
+ */
1601
+ walkthrough?: components["schemas"]["WalkthroughView"] | null;
1452
1602
  };
1453
1603
  /** @enum {string} */
1454
1604
  Dataset: "reviews" | "finding_outcomes" | "finding_validations" | "spend" | "findings";
1605
+ /** @enum {string} */
1606
+ DeclaredReachOutcome: "READ" | "NO_ROOTS" | "ROOTS_UNKNOWN" | "UNAVAILABLE";
1607
+ /**
1608
+ * @description One assessment's declared reach receipt. A reached entity declares a
1609
+ * dependency on what the change deploys; it is never a claim that the change
1610
+ * breaks it.
1611
+ */
1612
+ DeclaredReachView: {
1613
+ /**
1614
+ * @description Whether World's walk ended with no gap. An empty, incomplete reach
1615
+ * says nothing about what depends on the change.
1616
+ */
1617
+ complete: boolean;
1618
+ /** @description Every reached entity, shorter paths first, then by kind. */
1619
+ entities: components["schemas"]["ReachedEntityView"][];
1620
+ /** @description Where World's walk or its evidence stopped. */
1621
+ gaps: components["schemas"]["ReachGapView"][];
1622
+ /**
1623
+ * @description `READ` when World answered, `NO_ROOTS` when no evidence bound a
1624
+ * deployed artifact or workload to the repository, `ROOTS_UNKNOWN` when
1625
+ * World's evidence does not establish which revision runs, and
1626
+ * `UNAVAILABLE` when World gave no answer. Only `READ` carries entities or gaps.
1627
+ */
1628
+ outcome: components["schemas"]["DeclaredReachOutcome"];
1629
+ /** @description World's digest of its full answer. Null unless `READ`. */
1630
+ receipt_digest?: string | null;
1631
+ /**
1632
+ * Format: uuid
1633
+ * @description The World snapshot the reach was read at. Null unless `READ`.
1634
+ */
1635
+ snapshot_id?: string | null;
1636
+ /**
1637
+ * @description The Terraform addresses the reach also started from, or why it took
1638
+ * none. Absent when the assessment read reach only from the deployed
1639
+ * revision.
1640
+ */
1641
+ terraform?: components["schemas"]["TerraformRootsView"] | null;
1642
+ };
1455
1643
  DeepReviewEscalation: {
1456
1644
  /** @description A fixed customer explanation; internal admission errors are withheld. */
1457
1645
  reason: string;
@@ -1486,7 +1674,7 @@ export interface components {
1486
1674
  /** @enum {string} */
1487
1675
  ExportFindingSeverity: "WARNING" | "SERIOUS";
1488
1676
  /** @enum {string} */
1489
- ExportReviewKind: "PULL_REQUEST" | "DEPLOYMENT" | "PATCH" | "COMMIT";
1677
+ ExportReviewKind: "PULL_REQUEST" | "DEPLOYMENT" | "PATCH" | "COMMIT" | "FILES";
1490
1678
  /** @enum {string} */
1491
1679
  ExportReviewStatus: "PENDING" | "RUNNING" | "COMPLETED" | "INCOMPLETE" | "FAILED" | "SUPERSEDED" | "STOPPED" | "EXCLUDED";
1492
1680
  /** @description The closed row vocabulary of the existing raw-stream export operation. */
@@ -1495,6 +1683,26 @@ export interface components {
1495
1683
  ExportValidation: "UNKNOWN" | "CONFIRMED" | "DISMISSED" | "FIXED" | "ACCEPTED_RISK" | "ALREADY_COVERED";
1496
1684
  /** @enum {string} */
1497
1685
  ExportValidationSource: "ui" | "github_comment" | "proofline";
1686
+ FileFact: {
1687
+ /**
1688
+ * Format: int64
1689
+ * @description Lines added in this file's recorded diff.
1690
+ */
1691
+ additions: number;
1692
+ /**
1693
+ * Format: int64
1694
+ * @description Lines deleted in this file's recorded diff.
1695
+ */
1696
+ deletions: number;
1697
+ /** @description The review depth recorded for this file. */
1698
+ depth: components["schemas"]["ReviewDepth"];
1699
+ /** @description The repository-relative path of the changed file. */
1700
+ path: string;
1701
+ /** @description The path before a rename. */
1702
+ previous_path?: string | null;
1703
+ /** @description GitHub's file status: `added`, `modified`, `removed`, `renamed` and so on. */
1704
+ status: string;
1705
+ };
1498
1706
  FileProjection: {
1499
1707
  /** @description The code-inspection depth retained by the plan. */
1500
1708
  depth: string;
@@ -1503,6 +1711,37 @@ export interface components {
1503
1711
  /** @description Repository-relative path retained by the routing plan. */
1504
1712
  path: string;
1505
1713
  };
1714
+ /** @description Whole files selected at one exact pushed commit. */
1715
+ FileReviewRequest: {
1716
+ /** @description The exact pushed commit whose whole files are reviewed. */
1717
+ commit_sha: string;
1718
+ /** @description Between one and twenty exact repository-relative file paths. */
1719
+ paths: string[];
1720
+ };
1721
+ /** @description What a named-file review request produced. */
1722
+ FileReviewResponse: {
1723
+ /**
1724
+ * @description True when this exact selection already had a review and that one is
1725
+ * returned. Sending the same selection twice by the same person reviews it once.
1726
+ */
1727
+ existing: boolean;
1728
+ /**
1729
+ * Format: uuid
1730
+ * @description The review of this selection, readable through the review and findings
1731
+ * routes.
1732
+ */
1733
+ review_id: string;
1734
+ };
1735
+ /**
1736
+ * @description The retained selection, not a digest of file contents. Its identity uses
1737
+ * a version prefix and length-framed UTF-8 paths in their sorted order.
1738
+ */
1739
+ FileScope: {
1740
+ /** @description Sorted, unique repository-relative paths selected for whole-file review. */
1741
+ paths: string[];
1742
+ /** @description Digest of the selected paths, not the file contents. */
1743
+ paths_digest: string;
1744
+ };
1506
1745
  FilterChoice: {
1507
1746
  /**
1508
1747
  * Format: uuid
@@ -1898,6 +2137,12 @@ export interface components {
1898
2137
  severity: components["schemas"]["ExportFindingSeverity"];
1899
2138
  };
1900
2139
  GateState: {
2140
+ /**
2141
+ * @description The occurrence questions the gate's approval deferred, as each
2142
+ * observed execution of its deployment answered them. Outcome-only
2143
+ * records: none of them changes the gate or grades a prediction.
2144
+ */
2145
+ occurrence_captures: components["schemas"]["OccurrenceCapture"][];
1901
2146
  /** @description Recorded override authorization, not confirmation of provider delivery. */
1902
2147
  override_record?: components["schemas"]["Override"] | null;
1903
2148
  /**
@@ -1908,6 +2153,39 @@ export interface components {
1908
2153
  };
1909
2154
  /** @enum {string} */
1910
2155
  GateStatus: "REQUESTED" | "EVALUATING" | "ALLOWED" | "BLOCKED" | "BYPASSED" | "SUPERSEDED";
2156
+ /**
2157
+ * @description One finding a patch review re-verified against the patch. The outcome is
2158
+ * local: the pull request's finding is unchanged whatever it is.
2159
+ */
2160
+ LocalReverification: {
2161
+ /**
2162
+ * @description Each deterministic check the finding cited and its result on the
2163
+ * patched head. Empty until an outcome is recorded.
2164
+ */
2165
+ checks: unknown;
2166
+ /**
2167
+ * Format: uuid
2168
+ * @description The finding being re-verified against this patch.
2169
+ */
2170
+ finding_id: string;
2171
+ /**
2172
+ * Format: int32
2173
+ * @description The request's number among the requests to re-verify the finding's
2174
+ * series on this patch, at most 3.
2175
+ */
2176
+ iteration: number;
2177
+ /** @description The local re-verification result; it does not change the original finding. */
2178
+ outcome: components["schemas"]["LocalReverificationOutcome"];
2179
+ };
2180
+ /**
2181
+ * @description `RESOLVED_VERIFIED` needs the re-investigation to reject the finding's
2182
+ * hypothesis and every cited check to pass. `STILL_PRESENT`: the hypothesis
2183
+ * is supported, or a check still finds the mechanism. `NOT_VERIFIED`:
2184
+ * anything else, including a review that ended without an answer.
2185
+ * `PENDING`: the review is still running.
2186
+ * @enum {string}
2187
+ */
2188
+ LocalReverificationOutcome: "RESOLVED_VERIFIED" | "STILL_PRESENT" | "NOT_VERIFIED" | "PENDING";
1911
2189
  NotAssessedView: {
1912
2190
  /**
1913
2191
  * @description The display name of the environment whose assessment is not
@@ -1920,6 +2198,42 @@ export interface components {
1920
2198
  */
1921
2199
  incompleteness_kind?: string | null;
1922
2200
  };
2201
+ /** @description The capture of one observed execution of a gate's deployment. */
2202
+ OccurrenceCapture: {
2203
+ /** @description Assessments whose approval could defer nothing, with the reason. */
2204
+ approval_gaps: components["schemas"]["ApprovalGap"][];
2205
+ /** @description Explanation of the capture's outcome, when available. */
2206
+ detail?: string | null;
2207
+ /** @description Retained identity of the deployment occurrence, when available. */
2208
+ occurrence_key?: string | null;
2209
+ /** @description Deferred questions and their binding or observed results for this occurrence. */
2210
+ questions: components["schemas"]["OccurrenceQuestion"][];
2211
+ /** @description Whether the capture is pending, recorded, unbound, not executed, or incomplete. */
2212
+ state: components["schemas"]["CaptureState"];
2213
+ };
2214
+ /** @description One deferred question as the gate presents it. */
2215
+ OccurrenceQuestion: {
2216
+ /**
2217
+ * Format: uuid
2218
+ * @description Assessment whose approval deferred this question.
2219
+ */
2220
+ assessment_id: string;
2221
+ /** @description World's binding or refusal code, or the control plane's own gap. */
2222
+ code?: string | null;
2223
+ /** @description Hypothesis family key for the deferred question. */
2224
+ family_key: string;
2225
+ /**
2226
+ * Format: int32
2227
+ * @description Hypothesis family version for the deferred question.
2228
+ */
2229
+ family_version: number;
2230
+ /** @description World's observed result once it recorded the question. */
2231
+ observed_result?: string | null;
2232
+ /** @description World outcome record identifier, when an observed result was recorded. */
2233
+ outcome_id?: string | null;
2234
+ /** @description Whether the question is pending, recorded, unbound, or not executed. */
2235
+ state: components["schemas"]["QuestionState"];
2236
+ };
1923
2237
  OpenFindingCounts: {
1924
2238
  /**
1925
2239
  * Format: uint64
@@ -2049,6 +2363,17 @@ export interface components {
2049
2363
  * @default null
2050
2364
  */
2051
2365
  trigger_source: components["schemas"]["PatchTriggerSource"] | null;
2366
+ /**
2367
+ * @description Open findings of one pull request in this repository to re-verify
2368
+ * against the patch, at most 20. The review re-investigates each one
2369
+ * and reports its outcome in `local_reverifications`; the pull
2370
+ * request's findings are unchanged whatever it is. Requires an API
2371
+ * token. Each finding's series takes at most 3 requests per patch, and
2372
+ * the pull request at most 10 re-verification requests per hour,
2373
+ * counted with those a coding agent makes through MCP.
2374
+ * @default []
2375
+ */
2376
+ verify_finding_ids: string[];
2052
2377
  };
2053
2378
  /** @description What a patch review request produced. */
2054
2379
  PatchReviewResponse: {
@@ -2068,6 +2393,11 @@ export interface components {
2068
2393
  * and findings routes.
2069
2394
  */
2070
2395
  review_id: string;
2396
+ /**
2397
+ * @description Each finding of `verify_finding_ids` the review re-verifies, one per
2398
+ * finding series. Empty without `verify_finding_ids`.
2399
+ */
2400
+ verify: components["schemas"]["PatchVerification"][];
2071
2401
  };
2072
2402
  /**
2073
2403
  * @description The git hook that asked for a patch review. The client declares it; it is
@@ -2075,6 +2405,20 @@ export interface components {
2075
2405
  * @enum {string}
2076
2406
  */
2077
2407
  PatchTriggerSource: "HOOK_PRE_COMMIT" | "HOOK_PRE_PUSH";
2408
+ /** @description One finding a patch review re-verifies against the patch. */
2409
+ PatchVerification: {
2410
+ /**
2411
+ * Format: uuid
2412
+ * @description The finding being re-verified against this patch.
2413
+ */
2414
+ finding_id: string;
2415
+ /**
2416
+ * Format: int32
2417
+ * @description This request's number among the requests to re-verify the finding's
2418
+ * series on this patch, at most 3.
2419
+ */
2420
+ iteration: number;
2421
+ };
2078
2422
  /** @enum {string} */
2079
2423
  PermissionView: "PERMIT" | "BLOCK";
2080
2424
  PlanProjection: {
@@ -2115,13 +2459,26 @@ export interface components {
2115
2459
  /** @description A short, stable summary of the problem class, such as `not found` or `conflict`. */
2116
2460
  title: string;
2117
2461
  };
2462
+ Prose: {
2463
+ /** @description At most 120 characters. */
2464
+ headline: string;
2465
+ /** @description Paths in the pinned diff the prose calls out. */
2466
+ notable_paths: string[];
2467
+ /** @description At most three of at most 400 characters; one on the `SHORT` route. */
2468
+ paragraphs: string[];
2469
+ };
2470
+ /** @description Why the summary carries prose or does not. */
2471
+ ProseOutcome: "PUBLISHED" | "NO_CHANGE_DIGEST" | "NOT_REQUESTED" | "MODEL_UNAVAILABLE" | "MALFORMED" | "REJECTED" | "UNGROUNDED";
2118
2472
  PullRequestMergeGate: {
2119
2473
  /**
2120
2474
  * Format: int32
2121
2475
  * @description The number of environment assessments counted by the recorded decision. Null before a decision.
2122
2476
  */
2123
2477
  assessment_count?: number | null;
2124
- /** @description The frozen blocking threshold, either SERIOUS or WARNING; later settings do not restamp it. */
2478
+ /**
2479
+ * @description The frozen blocking threshold, either SERIOUS (serious and critical findings) or WARNING (every
2480
+ * supported finding); later settings do not restamp it.
2481
+ */
2125
2482
  blocking_severity: string;
2126
2483
  /**
2127
2484
  * Format: date-time
@@ -2178,6 +2535,67 @@ export interface components {
2178
2535
  /** @description The current gate projection, including a recorded bypass or supersession by a newer head. */
2179
2536
  status: components["schemas"]["GateStatus"];
2180
2537
  };
2538
+ /** @description Where one deferred question stands. */
2539
+ QuestionState: "PENDING" | "RECORDED" | "UNBOUND" | "NOT_EXECUTED";
2540
+ ReachGapView: {
2541
+ /** @description `COVERAGE_INCOMPLETE`, `SOURCE_CAPABILITY_MISSING` or `BOUND_REACHED`. */
2542
+ code: string;
2543
+ };
2544
+ ReachStepView: {
2545
+ /**
2546
+ * Format: uuid
2547
+ * @description The World relation assertion behind this step.
2548
+ */
2549
+ assertion_id: string;
2550
+ /**
2551
+ * @description `OUT` when the step follows the relation from its subject, `IN` when
2552
+ * it follows it back to the subject.
2553
+ */
2554
+ direction: string;
2555
+ /** @description The relation key, such as `proofline.relation.consumes_api`. */
2556
+ relation: string;
2557
+ };
2558
+ ReachedEntityView: {
2559
+ /**
2560
+ * Format: uuid
2561
+ * @description World's entity ID.
2562
+ */
2563
+ entity_id: string;
2564
+ /** @description The entity's kind, such as `service` or `queue`. */
2565
+ kind: string;
2566
+ /**
2567
+ * @description World's display label for the entity: environment evidence for
2568
+ * readers of this organization, never published to GitHub.
2569
+ */
2570
+ label: string;
2571
+ /** @description The recorded relation assertions from the deployed root to the entity. */
2572
+ path: components["schemas"]["ReachStepView"][];
2573
+ /** @description World's registry type keys for the entity. */
2574
+ type_keys: string[];
2575
+ };
2576
+ /** @description A recorded refresh decision, as the console shows it. */
2577
+ RefreshView: {
2578
+ /**
2579
+ * @description What decided: `FLOOR`, a refresh rule that always reviews the whole
2580
+ * change; `JEV`, Proofline's decision model within those rules; or
2581
+ * `FALLBACK`, the refresh rules because the model did not decide.
2582
+ * Absent for a full review a person requested, and for reviews decided
2583
+ * before it was recorded.
2584
+ */
2585
+ decided_by?: string | null;
2586
+ /**
2587
+ * @description `INCREMENTAL` reviews only the files the push touched and carries the
2588
+ * earlier review's untouched findings forward; `FULL` reviews the whole change.
2589
+ */
2590
+ mode: string;
2591
+ /** @description Why, in words. Server text that may name repository paths. */
2592
+ reason?: string | null;
2593
+ /**
2594
+ * Format: uuid
2595
+ * @description The review this one refreshes. Absent for a full review a person requested.
2596
+ */
2597
+ refreshes_review_id?: string | null;
2598
+ };
2181
2599
  /**
2182
2600
  * @description An environment a refusal names. `external_key` is how its pages are
2183
2601
  * addressed.
@@ -2302,6 +2720,11 @@ export interface components {
2302
2720
  */
2303
2721
  validate_findings: boolean;
2304
2722
  };
2723
+ /**
2724
+ * @description The depth the applied route plan read a file at.
2725
+ * @enum {string}
2726
+ */
2727
+ ReviewDepth: "STANDARD";
2305
2728
  ReviewDiffStats: {
2306
2729
  /**
2307
2730
  * Format: int64
@@ -2482,7 +2905,8 @@ export interface components {
2482
2905
  id: string;
2483
2906
  /**
2484
2907
  * @description `PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes
2485
- * sent as a patch, or `COMMIT`, a review of pushed commits.
2908
+ * sent as a patch, `COMMIT`, a review of pushed commits, or `FILES`,
2909
+ * complete selected files at one pushed commit.
2486
2910
  */
2487
2911
  kind: string;
2488
2912
  /** @description The review's stable public address: `rev_` followed by its identifier without hyphens. */
@@ -2528,6 +2952,12 @@ export interface components {
2528
2952
  pull_request_title?: string | null;
2529
2953
  /** @description The pull request on GitHub. Absent for a deployment review or when the repository is unknown. */
2530
2954
  pull_request_url?: string | null;
2955
+ /**
2956
+ * @description How this review decided what it reviews after a push or a full-review
2957
+ * request. Absent for a review that refreshes nothing, and while a
2958
+ * refresh has not decided yet.
2959
+ */
2960
+ refresh?: components["schemas"]["RefreshView"] | null;
2531
2961
  /** @description The repository's `owner/name`. Absent when the review names no repository. */
2532
2962
  repository_full_name?: string | null;
2533
2963
  /**
@@ -2612,8 +3042,8 @@ export interface components {
2612
3042
  /** @description The pinned head commit SHA, null when the review records none. */
2613
3043
  head_commit_sha?: string | null;
2614
3044
  /**
2615
- * @description Whether the review analyzes a pull request, a deployment, a local patch or pushed
2616
- * commits.
3045
+ * @description Whether the review analyzes a pull request, a deployment, a local patch, pushed
3046
+ * commits or selected whole files.
2617
3047
  */
2618
3048
  kind: components["schemas"]["ExportReviewKind"];
2619
3049
  /**
@@ -2883,6 +3313,23 @@ export interface components {
2883
3313
  /** @description The `prompt_digest` of the prompt the person confirmed. */
2884
3314
  prompt_digest: string;
2885
3315
  };
3316
+ /** @description What stopping a review recorded. */
3317
+ StopResponse: {
3318
+ /**
3319
+ * Format: uuid
3320
+ * @description Identifier of the stopped review.
3321
+ */
3322
+ review_id: string;
3323
+ /** @description Always `STOPPED`: the review's status once the stop is committed. */
3324
+ status: string;
3325
+ /**
3326
+ * Format: date-time
3327
+ * @description Time when the review was stopped.
3328
+ */
3329
+ stopped_at: string;
3330
+ /** @description Person who stopped the review. */
3331
+ stopped_by: components["schemas"]["ActorView"];
3332
+ };
2886
3333
  /**
2887
3334
  * @description One assessment's authorization of one subject, by identity.
2888
3335
  *
@@ -2923,6 +3370,8 @@ export interface components {
2923
3370
  commit_sha?: string | null;
2924
3371
  /** @description The GitHub deployment identifier a `GITHUB_WORKFLOW_RUN` subject ran for. Absent when the run was not for a deployment. */
2925
3372
  deployment_external_id?: string | null;
3373
+ /** @description Whole-file selection at the pinned revision; absent for comparisons. */
3374
+ file_scope?: components["schemas"]["FileScope"] | null;
2926
3375
  /**
2927
3376
  * Format: uuid
2928
3377
  * @description The subject's stable identifier. It holds across a poll refresh even
@@ -2985,6 +3434,29 @@ export interface components {
2985
3434
  workflow_run_id?: number | null;
2986
3435
  };
2987
3436
  /** @enum {string} */
3437
+ SummaryRoute: "DETERMINISTIC_ONLY" | "SHORT" | "FULL";
3438
+ /** @enum {string} */
3439
+ TerraformPlanView: "TAKEN" | "NOT_DECLARED" | "NOT_PINNED" | "HEAD_DIFFERS" | "ADDRESSES_UNREPORTED";
3440
+ /** @description The Terraform roots of one declared reach read. */
3441
+ TerraformRootsView: {
3442
+ /** @description The changed resource instance addresses taken as roots. */
3443
+ addresses: string[];
3444
+ /**
3445
+ * Format: uint
3446
+ * @description Changed addresses left out at World's limit of 100 roots per read.
3447
+ */
3448
+ omitted: number;
3449
+ /**
3450
+ * @description `TAKEN` when the plan pinned for the reviewed commit named the roots,
3451
+ * `NOT_DECLARED` when the environment captures no Terraform plan for this
3452
+ * review, `NOT_PINNED` when it declares one and none was pinned,
3453
+ * `HEAD_DIFFERS` when the pinned plan is for another commit, and
3454
+ * `ADDRESSES_UNREPORTED` when the pinned plan records no changed
3455
+ * addresses because it was pinned before World reported them.
3456
+ */
3457
+ plan: components["schemas"]["TerraformPlanView"];
3458
+ };
3459
+ /** @enum {string} */
2988
3460
  ThreadObservationFreshness: "FRESH" | "STALE";
2989
3461
  /** @description A read of GitHub's thread state. `observed_at` is when Proofline read it. */
2990
3462
  ThreadObservationView: {
@@ -3031,6 +3503,61 @@ export interface components {
3031
3503
  /** @description The text itself. Render it as plain text only. */
3032
3504
  untrusted_text: string;
3033
3505
  };
3506
+ WalkthroughFileView: {
3507
+ /**
3508
+ * Format: int64
3509
+ * @description Lines added.
3510
+ */
3511
+ additions: number;
3512
+ /** @description GitHub's change status, upper case, such as `ADDED` or `RENAMED`. */
3513
+ change: string;
3514
+ /**
3515
+ * Format: int64
3516
+ * @description Lines deleted.
3517
+ */
3518
+ deletions: number;
3519
+ /**
3520
+ * @description The route plan's depth tier. Absent for a file the review did not
3521
+ * evaluate.
3522
+ */
3523
+ depth?: string | null;
3524
+ /** @description Whether `line` is model-authored. */
3525
+ generated: boolean;
3526
+ /** @description A model sentence, or the deterministic line when there is none. */
3527
+ line: string;
3528
+ /** @description The file's path at the head commit. */
3529
+ path: string;
3530
+ /** @description The file's path before a rename. Absent otherwise. */
3531
+ previous_path?: string | null;
3532
+ /**
3533
+ * @description Why the review did not evaluate the file, such as `LOCKFILE` or
3534
+ * `REPOSITORY_FILTER`.
3535
+ */
3536
+ skip_class?: string | null;
3537
+ };
3538
+ WalkthroughGroupView: {
3539
+ /** @description What the group changes. Absent when the group has no description. */
3540
+ description?: string | null;
3541
+ /** @description The group's files. */
3542
+ files: components["schemas"]["WalkthroughFileView"][];
3543
+ /**
3544
+ * @description `FEATURE`, `FIX`, `REFACTOR`, `CONFIGURATION`, `INFRASTRUCTURE`,
3545
+ * `DATA`, `DEPENDENCIES`, `TESTS` or `DOCS`.
3546
+ */
3547
+ kind: string;
3548
+ /** @description The group's title. */
3549
+ title: string;
3550
+ };
3551
+ /**
3552
+ * @description One review's walkthrough of its pinned head. Titles and lines are model
3553
+ * text over untrusted repository content: render them as text.
3554
+ */
3555
+ WalkthroughView: {
3556
+ /** @description Groups in reading order. */
3557
+ groups: components["schemas"]["WalkthroughGroupView"][];
3558
+ /** @description The head commit SHA the walkthrough describes. */
3559
+ head_sha: string;
3560
+ };
3034
3561
  };
3035
3562
  responses: never;
3036
3563
  parameters: never;
@@ -3307,6 +3834,61 @@ export interface operations {
3307
3834
  };
3308
3835
  };
3309
3836
  };
3837
+ request_file_review: {
3838
+ parameters: {
3839
+ query?: never;
3840
+ header?: never;
3841
+ path: {
3842
+ org_id: string;
3843
+ repo_id: string;
3844
+ };
3845
+ cookie?: never;
3846
+ };
3847
+ /** @description Whole files selected at one exact pushed commit. */
3848
+ requestBody: {
3849
+ content: {
3850
+ "application/json": components["schemas"]["FileReviewRequest"];
3851
+ };
3852
+ };
3853
+ responses: {
3854
+ /** @description What a named-file review request produced. */
3855
+ 200: {
3856
+ headers: {
3857
+ [name: string]: unknown;
3858
+ };
3859
+ content: {
3860
+ "application/json": components["schemas"]["FileReviewResponse"];
3861
+ };
3862
+ };
3863
+ /**
3864
+ * @description A run-now request that created nothing, as the 400 it is answered with.
3865
+ *
3866
+ * The refusal is a configuration fact, not a failure, and it is still sent
3867
+ * as an RFC 9457 problem: `title`, `status` and `detail` are what a client
3868
+ * that knows only problems shows, and `repository_name` and `refusal` are
3869
+ * the extension members a client that knows refusals links from. During a
3870
+ * rollout a page loaded from the previous bundle keeps working against
3871
+ * this server, because a refusal was a 400 with a `detail` before too.
3872
+ */
3873
+ 400: {
3874
+ headers: {
3875
+ [name: string]: unknown;
3876
+ };
3877
+ content: {
3878
+ "application/json": components["schemas"]["RunNowRefused"];
3879
+ };
3880
+ };
3881
+ /** @description An RFC 9457 problem; the HTTP status remains authoritative. */
3882
+ default: {
3883
+ headers: {
3884
+ [name: string]: unknown;
3885
+ };
3886
+ content: {
3887
+ "application/problem+json": components["schemas"]["Problem"];
3888
+ };
3889
+ };
3890
+ };
3891
+ };
3310
3892
  request_patch_review: {
3311
3893
  parameters: {
3312
3894
  query?: never;
@@ -3771,4 +4353,36 @@ export interface operations {
3771
4353
  };
3772
4354
  };
3773
4355
  };
4356
+ stop_review: {
4357
+ parameters: {
4358
+ query?: never;
4359
+ header?: never;
4360
+ path: {
4361
+ org_id: string;
4362
+ review_id: string;
4363
+ };
4364
+ cookie?: never;
4365
+ };
4366
+ requestBody?: never;
4367
+ responses: {
4368
+ /** @description What stopping a review recorded. */
4369
+ 200: {
4370
+ headers: {
4371
+ [name: string]: unknown;
4372
+ };
4373
+ content: {
4374
+ "application/json": components["schemas"]["StopResponse"];
4375
+ };
4376
+ };
4377
+ /** @description An RFC 9457 problem; the HTTP status remains authoritative. */
4378
+ default: {
4379
+ headers: {
4380
+ [name: string]: unknown;
4381
+ };
4382
+ content: {
4383
+ "application/problem+json": components["schemas"]["Problem"];
4384
+ };
4385
+ };
4386
+ };
4387
+ };
3774
4388
  }