@proofline/sdk 1.0.1 → 1.0.2
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/README.md +18 -0
- package/dist/exports.d.ts +11 -0
- package/dist/exports.js +94 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +7 -0
- package/dist/operations.d.ts +5 -0
- package/dist/operations.js +6 -0
- package/dist/schema.d.ts +621 -7
- package/dist/transport.d.ts +1 -1
- package/dist/transport.js +9 -6
- package/openapi.public.json +1228 -24
- package/package.json +1 -1
package/openapi.public.json
CHANGED
|
@@ -263,6 +263,24 @@
|
|
|
263
263
|
],
|
|
264
264
|
"type": "string"
|
|
265
265
|
},
|
|
266
|
+
"ApprovalGap": {
|
|
267
|
+
"properties": {
|
|
268
|
+
"assessment_id": {
|
|
269
|
+
"description": "Assessment whose approval could not supply deferred occurrence questions.",
|
|
270
|
+
"format": "uuid",
|
|
271
|
+
"type": "string"
|
|
272
|
+
},
|
|
273
|
+
"code": {
|
|
274
|
+
"description": "Reason the assessment's approval could not supply deferred occurrence questions.",
|
|
275
|
+
"type": "string"
|
|
276
|
+
}
|
|
277
|
+
},
|
|
278
|
+
"required": [
|
|
279
|
+
"assessment_id",
|
|
280
|
+
"code"
|
|
281
|
+
],
|
|
282
|
+
"type": "object"
|
|
283
|
+
},
|
|
266
284
|
"AssessmentProjection": {
|
|
267
285
|
"properties": {
|
|
268
286
|
"assessment_id": {
|
|
@@ -457,6 +475,36 @@
|
|
|
457
475
|
}
|
|
458
476
|
]
|
|
459
477
|
},
|
|
478
|
+
"CaptureState": {
|
|
479
|
+
"description": "How the capture ended.",
|
|
480
|
+
"oneOf": [
|
|
481
|
+
{
|
|
482
|
+
"const": "PENDING",
|
|
483
|
+
"description": "Still waiting for an authorized execution or a decidable look.",
|
|
484
|
+
"type": "string"
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
"const": "RECORDED",
|
|
488
|
+
"description": "World recorded every deferred question.",
|
|
489
|
+
"type": "string"
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
"const": "UNBOUND",
|
|
493
|
+
"description": "At least one deferred question is not bound to the execution.",
|
|
494
|
+
"type": "string"
|
|
495
|
+
},
|
|
496
|
+
{
|
|
497
|
+
"const": "NOT_EXECUTED",
|
|
498
|
+
"description": "The gate never authorized the execution.",
|
|
499
|
+
"type": "string"
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"const": "INCOMPLETE",
|
|
503
|
+
"description": "The capture failed before it wrote its receipt. The gate is\n unchanged; nothing is inferred about the deferred questions.",
|
|
504
|
+
"type": "string"
|
|
505
|
+
}
|
|
506
|
+
]
|
|
507
|
+
},
|
|
460
508
|
"ChangeAttributionView": {
|
|
461
509
|
"description": "Which conditions behind a check's result the change brought, and which\n World found at the review's base revision. It sits beside the result and\n never changes it: a condition already at the base is still a condition.",
|
|
462
510
|
"properties": {
|
|
@@ -576,6 +624,145 @@
|
|
|
576
624
|
],
|
|
577
625
|
"type": "object"
|
|
578
626
|
},
|
|
627
|
+
"ChangeDiagramKindView": {
|
|
628
|
+
"enum": [
|
|
629
|
+
"FLOWCHART",
|
|
630
|
+
"SEQUENCE"
|
|
631
|
+
],
|
|
632
|
+
"type": "string"
|
|
633
|
+
},
|
|
634
|
+
"ChangeDiagramOutcome": {
|
|
635
|
+
"oneOf": [
|
|
636
|
+
{
|
|
637
|
+
"enum": [
|
|
638
|
+
"DRAWN"
|
|
639
|
+
],
|
|
640
|
+
"type": "string"
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
"const": "NO_INTERACTION",
|
|
644
|
+
"description": "No interaction between three or more components survived selection.",
|
|
645
|
+
"type": "string"
|
|
646
|
+
},
|
|
647
|
+
{
|
|
648
|
+
"const": "INDEX_INCOMPLETE",
|
|
649
|
+
"description": "The head's code index could not vouch for every edge.",
|
|
650
|
+
"type": "string"
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
"const": "OVER_CAPS",
|
|
654
|
+
"description": "The changed call path is larger than a diagram shows.",
|
|
655
|
+
"type": "string"
|
|
656
|
+
},
|
|
657
|
+
{
|
|
658
|
+
"const": "DECISION_UNAVAILABLE",
|
|
659
|
+
"description": "A decision the diagram depends on gave no answer.",
|
|
660
|
+
"type": "string"
|
|
661
|
+
}
|
|
662
|
+
]
|
|
663
|
+
},
|
|
664
|
+
"ChangeDiagramView": {
|
|
665
|
+
"description": "The change-level diagram recorded for a review, or why there is none.",
|
|
666
|
+
"properties": {
|
|
667
|
+
"kind": {
|
|
668
|
+
"anyOf": [
|
|
669
|
+
{
|
|
670
|
+
"$ref": "#/components/schemas/ChangeDiagramKindView"
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
"type": "null"
|
|
674
|
+
}
|
|
675
|
+
],
|
|
676
|
+
"description": "Diagram format when a diagram was drawn; otherwise null."
|
|
677
|
+
},
|
|
678
|
+
"legend": {
|
|
679
|
+
"description": "Markdown lines under the diagram: which environment and snapshot its\n dashed relations come from, or which environment was not read.",
|
|
680
|
+
"items": {
|
|
681
|
+
"type": "string"
|
|
682
|
+
},
|
|
683
|
+
"type": "array"
|
|
684
|
+
},
|
|
685
|
+
"mermaid": {
|
|
686
|
+
"description": "Mermaid source the server generated from the stored graph. Every\n label is escaped, and no model wrote any of it. Absent unless\n `outcome` is `DRAWN`.",
|
|
687
|
+
"type": [
|
|
688
|
+
"string",
|
|
689
|
+
"null"
|
|
690
|
+
]
|
|
691
|
+
},
|
|
692
|
+
"outcome": {
|
|
693
|
+
"allOf": [
|
|
694
|
+
{
|
|
695
|
+
"$ref": "#/components/schemas/ChangeDiagramOutcome"
|
|
696
|
+
}
|
|
697
|
+
],
|
|
698
|
+
"description": "Whether the diagram was drawn, or why no diagram is available."
|
|
699
|
+
}
|
|
700
|
+
},
|
|
701
|
+
"required": [
|
|
702
|
+
"outcome",
|
|
703
|
+
"legend"
|
|
704
|
+
],
|
|
705
|
+
"type": "object"
|
|
706
|
+
},
|
|
707
|
+
"ChangeSummary": {
|
|
708
|
+
"description": "What a review recorded about its change.",
|
|
709
|
+
"properties": {
|
|
710
|
+
"base_sha": {
|
|
711
|
+
"description": "The compared base commit. Null when the review pinned none.",
|
|
712
|
+
"type": [
|
|
713
|
+
"string",
|
|
714
|
+
"null"
|
|
715
|
+
]
|
|
716
|
+
},
|
|
717
|
+
"files": {
|
|
718
|
+
"description": "The changed files the review read, by path, with the depth it read\n them at. Empty when the review recorded no change digest. Files the\n review's filters kept from review are listed apart, with their reason.",
|
|
719
|
+
"items": {
|
|
720
|
+
"$ref": "#/components/schemas/FileFact"
|
|
721
|
+
},
|
|
722
|
+
"type": "array"
|
|
723
|
+
},
|
|
724
|
+
"head_sha": {
|
|
725
|
+
"description": "The reviewed head commit.",
|
|
726
|
+
"type": "string"
|
|
727
|
+
},
|
|
728
|
+
"prose": {
|
|
729
|
+
"anyOf": [
|
|
730
|
+
{
|
|
731
|
+
"$ref": "#/components/schemas/Prose"
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"type": "null"
|
|
735
|
+
}
|
|
736
|
+
],
|
|
737
|
+
"description": "Model-written prose. Present only when `prose_outcome` is `PUBLISHED`.\n It is untrusted text: render it inert."
|
|
738
|
+
},
|
|
739
|
+
"prose_outcome": {
|
|
740
|
+
"allOf": [
|
|
741
|
+
{
|
|
742
|
+
"$ref": "#/components/schemas/ProseOutcome"
|
|
743
|
+
}
|
|
744
|
+
],
|
|
745
|
+
"description": "The recorded prose-generation outcome, before response-time withholding."
|
|
746
|
+
},
|
|
747
|
+
"route": {
|
|
748
|
+
"anyOf": [
|
|
749
|
+
{
|
|
750
|
+
"$ref": "#/components/schemas/SummaryRoute"
|
|
751
|
+
},
|
|
752
|
+
{
|
|
753
|
+
"type": "null"
|
|
754
|
+
}
|
|
755
|
+
],
|
|
756
|
+
"description": "The route the summary applied. Null when the review recorded no change\n digest, so no route was asked."
|
|
757
|
+
}
|
|
758
|
+
},
|
|
759
|
+
"required": [
|
|
760
|
+
"head_sha",
|
|
761
|
+
"files",
|
|
762
|
+
"prose_outcome"
|
|
763
|
+
],
|
|
764
|
+
"type": "object"
|
|
765
|
+
},
|
|
579
766
|
"CheckLifecycle": {
|
|
580
767
|
"description": "World's lifecycle disclosure for the evaluator version that answered, as\n the receipt recorded it. A deployment gate counts only `GATING` results\n (`DeterministicCoverage::gate_effective_status`), and only when it\n evaluates a deployment; the lifecycle alone permits or blocks nothing.",
|
|
581
768
|
"oneOf": [
|
|
@@ -795,6 +982,17 @@
|
|
|
795
982
|
],
|
|
796
983
|
"description": "The retained decision disclosure, which grants no deployment\n authorization. Absent when none is recorded and the review kind\n records no decision basis."
|
|
797
984
|
},
|
|
985
|
+
"declared_reach": {
|
|
986
|
+
"anyOf": [
|
|
987
|
+
{
|
|
988
|
+
"$ref": "#/components/schemas/DeclaredReachView"
|
|
989
|
+
},
|
|
990
|
+
{
|
|
991
|
+
"type": "null"
|
|
992
|
+
}
|
|
993
|
+
],
|
|
994
|
+
"description": "What World declares depends on what this change deploys in this\n environment, at the assessment's pinned snapshot. Absent when the\n assessment's kind records no declared reach."
|
|
995
|
+
},
|
|
798
996
|
"domains": {
|
|
799
997
|
"description": "The risk domains the assessment evaluated, each with its status and\n reason, ordered by domain.",
|
|
800
998
|
"items": {
|
|
@@ -894,6 +1092,17 @@
|
|
|
894
1092
|
],
|
|
895
1093
|
"description": "The retained decision disclosure, which grants no deployment\n authorization. Absent when none is recorded and the review kind\n records no decision basis."
|
|
896
1094
|
},
|
|
1095
|
+
"declared_reach": {
|
|
1096
|
+
"anyOf": [
|
|
1097
|
+
{
|
|
1098
|
+
"$ref": "#/components/schemas/DeclaredReachView"
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"type": "null"
|
|
1102
|
+
}
|
|
1103
|
+
],
|
|
1104
|
+
"description": "What World declares depends on what this change deploys in this\n environment, at the assessment's pinned snapshot. Absent when the\n assessment's kind records no declared reach."
|
|
1105
|
+
},
|
|
897
1106
|
"domains": {
|
|
898
1107
|
"description": "The risk domains the assessment evaluated, each with its status and\n reason, ordered by domain.",
|
|
899
1108
|
"items": {
|
|
@@ -1596,6 +1805,28 @@
|
|
|
1596
1805
|
"null"
|
|
1597
1806
|
]
|
|
1598
1807
|
},
|
|
1808
|
+
"change_diagram": {
|
|
1809
|
+
"anyOf": [
|
|
1810
|
+
{
|
|
1811
|
+
"$ref": "#/components/schemas/ChangeDiagramView"
|
|
1812
|
+
},
|
|
1813
|
+
{
|
|
1814
|
+
"type": "null"
|
|
1815
|
+
}
|
|
1816
|
+
],
|
|
1817
|
+
"description": "The change-level diagram: the changed call path from the pinned code\n index and the relations World declares. Absent when the review\n recorded none."
|
|
1818
|
+
},
|
|
1819
|
+
"change_summary": {
|
|
1820
|
+
"anyOf": [
|
|
1821
|
+
{
|
|
1822
|
+
"$ref": "#/components/schemas/ChangeSummary"
|
|
1823
|
+
},
|
|
1824
|
+
{
|
|
1825
|
+
"type": "null"
|
|
1826
|
+
}
|
|
1827
|
+
],
|
|
1828
|
+
"description": "What the change does and which files the review read at which depth\n (§55). Null until the review's publication records it, and for a\n review that is not of a pull request. Generated text has current\n credentials and recorded protected values withheld; missing or expired\n provenance withholds the generated text whole."
|
|
1829
|
+
},
|
|
1599
1830
|
"check_run_url": {
|
|
1600
1831
|
"description": "The GitHub check run Proofline published for this review. Null when\n none was published.",
|
|
1601
1832
|
"type": [
|
|
@@ -1675,6 +1906,10 @@
|
|
|
1675
1906
|
"format": "int64",
|
|
1676
1907
|
"type": "integer"
|
|
1677
1908
|
},
|
|
1909
|
+
"fix_generation_enabled": {
|
|
1910
|
+
"description": "Whether fix generation is configured for this deployment and organization.\n Write authorization is checked again when a fix is requested.",
|
|
1911
|
+
"type": "boolean"
|
|
1912
|
+
},
|
|
1678
1913
|
"head_commit_sha": {
|
|
1679
1914
|
"description": "The head commit this review is pinned to. For a patch review, the\n revision ID Proofline derives from its base commit and patch digest,\n which is not a commit. Absent when the review recorded none.",
|
|
1680
1915
|
"type": [
|
|
@@ -1701,10 +1936,21 @@
|
|
|
1701
1936
|
"format": "uuid",
|
|
1702
1937
|
"type": "string"
|
|
1703
1938
|
},
|
|
1939
|
+
"is_deep_review": {
|
|
1940
|
+
"description": "Present and true when this run is a Deep Review.",
|
|
1941
|
+
"type": "boolean"
|
|
1942
|
+
},
|
|
1704
1943
|
"kind": {
|
|
1705
|
-
"description": "`PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes\n sent as a patch,
|
|
1944
|
+
"description": "`PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes\n sent as a patch, `COMMIT`, a review of pushed commits, or `FILES`,\n complete selected files at one pushed commit.",
|
|
1706
1945
|
"type": "string"
|
|
1707
1946
|
},
|
|
1947
|
+
"local_reverifications": {
|
|
1948
|
+
"description": "For a patch review requested with `verify_finding_ids`, each finding\n it re-verifies against the patch and the outcome. The outcome is\n local: the pull request's finding is unchanged whatever it is. Absent\n otherwise.",
|
|
1949
|
+
"items": {
|
|
1950
|
+
"$ref": "#/components/schemas/LocalReverification"
|
|
1951
|
+
},
|
|
1952
|
+
"type": "array"
|
|
1953
|
+
},
|
|
1708
1954
|
"merge_gate": {
|
|
1709
1955
|
"anyOf": [
|
|
1710
1956
|
{
|
|
@@ -1811,6 +2057,17 @@
|
|
|
1811
2057
|
"null"
|
|
1812
2058
|
]
|
|
1813
2059
|
},
|
|
2060
|
+
"refresh": {
|
|
2061
|
+
"anyOf": [
|
|
2062
|
+
{
|
|
2063
|
+
"$ref": "#/components/schemas/RefreshView"
|
|
2064
|
+
},
|
|
2065
|
+
{
|
|
2066
|
+
"type": "null"
|
|
2067
|
+
}
|
|
2068
|
+
],
|
|
2069
|
+
"description": "How this review decided what it reviews after a push or a full-review\n request. Absent for a review that refreshes nothing, and while a\n refresh has not decided yet."
|
|
2070
|
+
},
|
|
1814
2071
|
"related_reviews": {
|
|
1815
2072
|
"description": "Every other run for this pull request the caller can see, plus reviews\n joined to this one by supersession or rerun.",
|
|
1816
2073
|
"items": {
|
|
@@ -1944,6 +2201,17 @@
|
|
|
1944
2201
|
}
|
|
1945
2202
|
],
|
|
1946
2203
|
"description": "The git hook that asked for this patch review: `HOOK_PRE_COMMIT` or\n `HOOK_PRE_PUSH`. Null for any other review, and for a patch review\n requested without naming a hook."
|
|
2204
|
+
},
|
|
2205
|
+
"walkthrough": {
|
|
2206
|
+
"anyOf": [
|
|
2207
|
+
{
|
|
2208
|
+
"$ref": "#/components/schemas/WalkthroughView"
|
|
2209
|
+
},
|
|
2210
|
+
{
|
|
2211
|
+
"type": "null"
|
|
2212
|
+
}
|
|
2213
|
+
],
|
|
2214
|
+
"description": "The reviewed head's changed files in reading groups, with a line per\n file. Absent until the walkthrough is stored, and for a review that\n has none."
|
|
1947
2215
|
}
|
|
1948
2216
|
},
|
|
1949
2217
|
"required": [
|
|
@@ -1975,6 +2243,79 @@
|
|
|
1975
2243
|
],
|
|
1976
2244
|
"type": "string"
|
|
1977
2245
|
},
|
|
2246
|
+
"DeclaredReachOutcome": {
|
|
2247
|
+
"enum": [
|
|
2248
|
+
"READ",
|
|
2249
|
+
"NO_ROOTS",
|
|
2250
|
+
"ROOTS_UNKNOWN",
|
|
2251
|
+
"UNAVAILABLE"
|
|
2252
|
+
],
|
|
2253
|
+
"type": "string"
|
|
2254
|
+
},
|
|
2255
|
+
"DeclaredReachView": {
|
|
2256
|
+
"description": "One assessment's declared reach receipt. A reached entity declares a\n dependency on what the change deploys; it is never a claim that the change\n breaks it.",
|
|
2257
|
+
"properties": {
|
|
2258
|
+
"complete": {
|
|
2259
|
+
"description": "Whether World's walk ended with no gap. An empty, incomplete reach\n says nothing about what depends on the change.",
|
|
2260
|
+
"type": "boolean"
|
|
2261
|
+
},
|
|
2262
|
+
"entities": {
|
|
2263
|
+
"description": "Every reached entity, shorter paths first, then by kind.",
|
|
2264
|
+
"items": {
|
|
2265
|
+
"$ref": "#/components/schemas/ReachedEntityView"
|
|
2266
|
+
},
|
|
2267
|
+
"type": "array"
|
|
2268
|
+
},
|
|
2269
|
+
"gaps": {
|
|
2270
|
+
"description": "Where World's walk or its evidence stopped.",
|
|
2271
|
+
"items": {
|
|
2272
|
+
"$ref": "#/components/schemas/ReachGapView"
|
|
2273
|
+
},
|
|
2274
|
+
"type": "array"
|
|
2275
|
+
},
|
|
2276
|
+
"outcome": {
|
|
2277
|
+
"allOf": [
|
|
2278
|
+
{
|
|
2279
|
+
"$ref": "#/components/schemas/DeclaredReachOutcome"
|
|
2280
|
+
}
|
|
2281
|
+
],
|
|
2282
|
+
"description": "`READ` when World answered, `NO_ROOTS` when no evidence bound a\n deployed artifact or workload to the repository, `ROOTS_UNKNOWN` when\n World's evidence does not establish which revision runs, and\n `UNAVAILABLE` when World gave no answer. Only `READ` carries entities or gaps."
|
|
2283
|
+
},
|
|
2284
|
+
"receipt_digest": {
|
|
2285
|
+
"description": "World's digest of its full answer. Null unless `READ`.",
|
|
2286
|
+
"type": [
|
|
2287
|
+
"string",
|
|
2288
|
+
"null"
|
|
2289
|
+
]
|
|
2290
|
+
},
|
|
2291
|
+
"snapshot_id": {
|
|
2292
|
+
"description": "The World snapshot the reach was read at. Null unless `READ`.",
|
|
2293
|
+
"format": "uuid",
|
|
2294
|
+
"type": [
|
|
2295
|
+
"string",
|
|
2296
|
+
"null"
|
|
2297
|
+
]
|
|
2298
|
+
},
|
|
2299
|
+
"terraform": {
|
|
2300
|
+
"anyOf": [
|
|
2301
|
+
{
|
|
2302
|
+
"$ref": "#/components/schemas/TerraformRootsView"
|
|
2303
|
+
},
|
|
2304
|
+
{
|
|
2305
|
+
"type": "null"
|
|
2306
|
+
}
|
|
2307
|
+
],
|
|
2308
|
+
"description": "The Terraform addresses the reach also started from, or why it took\n none. Absent when the assessment read reach only from the deployed\n revision."
|
|
2309
|
+
}
|
|
2310
|
+
},
|
|
2311
|
+
"required": [
|
|
2312
|
+
"outcome",
|
|
2313
|
+
"complete",
|
|
2314
|
+
"entities",
|
|
2315
|
+
"gaps"
|
|
2316
|
+
],
|
|
2317
|
+
"type": "object"
|
|
2318
|
+
},
|
|
1978
2319
|
"DeepReviewEscalation": {
|
|
1979
2320
|
"properties": {
|
|
1980
2321
|
"reason": {
|
|
@@ -2091,7 +2432,8 @@
|
|
|
2091
2432
|
"PULL_REQUEST",
|
|
2092
2433
|
"DEPLOYMENT",
|
|
2093
2434
|
"PATCH",
|
|
2094
|
-
"COMMIT"
|
|
2435
|
+
"COMMIT",
|
|
2436
|
+
"FILES"
|
|
2095
2437
|
],
|
|
2096
2438
|
"type": "string"
|
|
2097
2439
|
},
|
|
@@ -2147,23 +2489,68 @@
|
|
|
2147
2489
|
],
|
|
2148
2490
|
"type": "string"
|
|
2149
2491
|
},
|
|
2150
|
-
"
|
|
2492
|
+
"FileFact": {
|
|
2151
2493
|
"properties": {
|
|
2152
|
-
"
|
|
2153
|
-
"description": "
|
|
2154
|
-
"
|
|
2494
|
+
"additions": {
|
|
2495
|
+
"description": "Lines added in this file's recorded diff.",
|
|
2496
|
+
"format": "int64",
|
|
2497
|
+
"type": "integer"
|
|
2155
2498
|
},
|
|
2156
|
-
"
|
|
2157
|
-
"description": "
|
|
2158
|
-
"
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2499
|
+
"deletions": {
|
|
2500
|
+
"description": "Lines deleted in this file's recorded diff.",
|
|
2501
|
+
"format": "int64",
|
|
2502
|
+
"type": "integer"
|
|
2503
|
+
},
|
|
2504
|
+
"depth": {
|
|
2505
|
+
"allOf": [
|
|
2506
|
+
{
|
|
2507
|
+
"$ref": "#/components/schemas/ReviewDepth"
|
|
2508
|
+
}
|
|
2509
|
+
],
|
|
2510
|
+
"description": "The review depth recorded for this file."
|
|
2162
2511
|
},
|
|
2163
2512
|
"path": {
|
|
2164
|
-
"description": "
|
|
2513
|
+
"description": "The repository-relative path of the changed file.",
|
|
2165
2514
|
"type": "string"
|
|
2166
|
-
}
|
|
2515
|
+
},
|
|
2516
|
+
"previous_path": {
|
|
2517
|
+
"description": "The path before a rename.",
|
|
2518
|
+
"type": [
|
|
2519
|
+
"string",
|
|
2520
|
+
"null"
|
|
2521
|
+
]
|
|
2522
|
+
},
|
|
2523
|
+
"status": {
|
|
2524
|
+
"description": "GitHub's file status: `added`, `modified`, `removed`, `renamed` and so on.",
|
|
2525
|
+
"type": "string"
|
|
2526
|
+
}
|
|
2527
|
+
},
|
|
2528
|
+
"required": [
|
|
2529
|
+
"path",
|
|
2530
|
+
"status",
|
|
2531
|
+
"additions",
|
|
2532
|
+
"deletions",
|
|
2533
|
+
"depth"
|
|
2534
|
+
],
|
|
2535
|
+
"type": "object"
|
|
2536
|
+
},
|
|
2537
|
+
"FileProjection": {
|
|
2538
|
+
"properties": {
|
|
2539
|
+
"depth": {
|
|
2540
|
+
"description": "The code-inspection depth retained by the plan.",
|
|
2541
|
+
"type": "string"
|
|
2542
|
+
},
|
|
2543
|
+
"passes": {
|
|
2544
|
+
"description": "The review passes bound to this file.",
|
|
2545
|
+
"items": {
|
|
2546
|
+
"type": "string"
|
|
2547
|
+
},
|
|
2548
|
+
"type": "array"
|
|
2549
|
+
},
|
|
2550
|
+
"path": {
|
|
2551
|
+
"description": "Repository-relative path retained by the routing plan.",
|
|
2552
|
+
"type": "string"
|
|
2553
|
+
}
|
|
2167
2554
|
},
|
|
2168
2555
|
"required": [
|
|
2169
2556
|
"path",
|
|
@@ -2172,6 +2559,69 @@
|
|
|
2172
2559
|
],
|
|
2173
2560
|
"type": "object"
|
|
2174
2561
|
},
|
|
2562
|
+
"FileReviewRequest": {
|
|
2563
|
+
"additionalProperties": false,
|
|
2564
|
+
"description": "Whole files selected at one exact pushed commit.",
|
|
2565
|
+
"properties": {
|
|
2566
|
+
"commit_sha": {
|
|
2567
|
+
"description": "The exact pushed commit whose whole files are reviewed.",
|
|
2568
|
+
"type": "string"
|
|
2569
|
+
},
|
|
2570
|
+
"paths": {
|
|
2571
|
+
"description": "Between one and twenty exact repository-relative file paths.",
|
|
2572
|
+
"items": {
|
|
2573
|
+
"type": "string"
|
|
2574
|
+
},
|
|
2575
|
+
"type": "array"
|
|
2576
|
+
}
|
|
2577
|
+
},
|
|
2578
|
+
"required": [
|
|
2579
|
+
"commit_sha",
|
|
2580
|
+
"paths"
|
|
2581
|
+
],
|
|
2582
|
+
"type": "object"
|
|
2583
|
+
},
|
|
2584
|
+
"FileReviewResponse": {
|
|
2585
|
+
"description": "What a named-file review request produced.",
|
|
2586
|
+
"properties": {
|
|
2587
|
+
"existing": {
|
|
2588
|
+
"description": "True when this exact selection already had a review and that one is\n returned. Sending the same selection twice by the same person reviews it once.",
|
|
2589
|
+
"type": "boolean"
|
|
2590
|
+
},
|
|
2591
|
+
"review_id": {
|
|
2592
|
+
"description": "The review of this selection, readable through the review and findings\n routes.",
|
|
2593
|
+
"format": "uuid",
|
|
2594
|
+
"type": "string"
|
|
2595
|
+
}
|
|
2596
|
+
},
|
|
2597
|
+
"required": [
|
|
2598
|
+
"review_id",
|
|
2599
|
+
"existing"
|
|
2600
|
+
],
|
|
2601
|
+
"type": "object"
|
|
2602
|
+
},
|
|
2603
|
+
"FileScope": {
|
|
2604
|
+
"additionalProperties": false,
|
|
2605
|
+
"description": "The retained selection, not a digest of file contents. Its identity uses\n a version prefix and length-framed UTF-8 paths in their sorted order.",
|
|
2606
|
+
"properties": {
|
|
2607
|
+
"paths": {
|
|
2608
|
+
"description": "Sorted, unique repository-relative paths selected for whole-file review.",
|
|
2609
|
+
"items": {
|
|
2610
|
+
"type": "string"
|
|
2611
|
+
},
|
|
2612
|
+
"type": "array"
|
|
2613
|
+
},
|
|
2614
|
+
"paths_digest": {
|
|
2615
|
+
"description": "Digest of the selected paths, not the file contents.",
|
|
2616
|
+
"type": "string"
|
|
2617
|
+
}
|
|
2618
|
+
},
|
|
2619
|
+
"required": [
|
|
2620
|
+
"paths",
|
|
2621
|
+
"paths_digest"
|
|
2622
|
+
],
|
|
2623
|
+
"type": "object"
|
|
2624
|
+
},
|
|
2175
2625
|
"FilterChoice": {
|
|
2176
2626
|
"properties": {
|
|
2177
2627
|
"id": {
|
|
@@ -3010,6 +3460,13 @@
|
|
|
3010
3460
|
},
|
|
3011
3461
|
"GateState": {
|
|
3012
3462
|
"properties": {
|
|
3463
|
+
"occurrence_captures": {
|
|
3464
|
+
"description": "The occurrence questions the gate's approval deferred, as each\n observed execution of its deployment answered them. Outcome-only\n records: none of them changes the gate or grades a prediction.",
|
|
3465
|
+
"items": {
|
|
3466
|
+
"$ref": "#/components/schemas/OccurrenceCapture"
|
|
3467
|
+
},
|
|
3468
|
+
"type": "array"
|
|
3469
|
+
},
|
|
3013
3470
|
"override_record": {
|
|
3014
3471
|
"anyOf": [
|
|
3015
3472
|
{
|
|
@@ -3027,7 +3484,8 @@
|
|
|
3027
3484
|
}
|
|
3028
3485
|
},
|
|
3029
3486
|
"required": [
|
|
3030
|
-
"status"
|
|
3487
|
+
"status",
|
|
3488
|
+
"occurrence_captures"
|
|
3031
3489
|
],
|
|
3032
3490
|
"type": "object"
|
|
3033
3491
|
},
|
|
@@ -3042,6 +3500,49 @@
|
|
|
3042
3500
|
],
|
|
3043
3501
|
"type": "string"
|
|
3044
3502
|
},
|
|
3503
|
+
"LocalReverification": {
|
|
3504
|
+
"description": "One finding a patch review re-verified against the patch. The outcome is\n local: the pull request's finding is unchanged whatever it is.",
|
|
3505
|
+
"properties": {
|
|
3506
|
+
"checks": {
|
|
3507
|
+
"description": "Each deterministic check the finding cited and its result on the\n patched head. Empty until an outcome is recorded."
|
|
3508
|
+
},
|
|
3509
|
+
"finding_id": {
|
|
3510
|
+
"description": "The finding being re-verified against this patch.",
|
|
3511
|
+
"format": "uuid",
|
|
3512
|
+
"type": "string"
|
|
3513
|
+
},
|
|
3514
|
+
"iteration": {
|
|
3515
|
+
"description": "The request's number among the requests to re-verify the finding's\n series on this patch, at most 3.",
|
|
3516
|
+
"format": "int32",
|
|
3517
|
+
"type": "integer"
|
|
3518
|
+
},
|
|
3519
|
+
"outcome": {
|
|
3520
|
+
"allOf": [
|
|
3521
|
+
{
|
|
3522
|
+
"$ref": "#/components/schemas/LocalReverificationOutcome"
|
|
3523
|
+
}
|
|
3524
|
+
],
|
|
3525
|
+
"description": "The local re-verification result; it does not change the original finding."
|
|
3526
|
+
}
|
|
3527
|
+
},
|
|
3528
|
+
"required": [
|
|
3529
|
+
"finding_id",
|
|
3530
|
+
"iteration",
|
|
3531
|
+
"outcome",
|
|
3532
|
+
"checks"
|
|
3533
|
+
],
|
|
3534
|
+
"type": "object"
|
|
3535
|
+
},
|
|
3536
|
+
"LocalReverificationOutcome": {
|
|
3537
|
+
"description": "`RESOLVED_VERIFIED` needs the re-investigation to reject the finding's\n hypothesis and every cited check to pass. `STILL_PRESENT`: the hypothesis\n is supported, or a check still finds the mechanism. `NOT_VERIFIED`:\n anything else, including a review that ended without an answer.\n `PENDING`: the review is still running.",
|
|
3538
|
+
"enum": [
|
|
3539
|
+
"RESOLVED_VERIFIED",
|
|
3540
|
+
"STILL_PRESENT",
|
|
3541
|
+
"NOT_VERIFIED",
|
|
3542
|
+
"PENDING"
|
|
3543
|
+
],
|
|
3544
|
+
"type": "string"
|
|
3545
|
+
},
|
|
3045
3546
|
"NotAssessedView": {
|
|
3046
3547
|
"properties": {
|
|
3047
3548
|
"environment_display_name": {
|
|
@@ -3061,6 +3562,108 @@
|
|
|
3061
3562
|
],
|
|
3062
3563
|
"type": "object"
|
|
3063
3564
|
},
|
|
3565
|
+
"OccurrenceCapture": {
|
|
3566
|
+
"description": "The capture of one observed execution of a gate's deployment.",
|
|
3567
|
+
"properties": {
|
|
3568
|
+
"approval_gaps": {
|
|
3569
|
+
"description": "Assessments whose approval could defer nothing, with the reason.",
|
|
3570
|
+
"items": {
|
|
3571
|
+
"$ref": "#/components/schemas/ApprovalGap"
|
|
3572
|
+
},
|
|
3573
|
+
"type": "array"
|
|
3574
|
+
},
|
|
3575
|
+
"detail": {
|
|
3576
|
+
"description": "Explanation of the capture's outcome, when available.",
|
|
3577
|
+
"type": [
|
|
3578
|
+
"string",
|
|
3579
|
+
"null"
|
|
3580
|
+
]
|
|
3581
|
+
},
|
|
3582
|
+
"occurrence_key": {
|
|
3583
|
+
"description": "Retained identity of the deployment occurrence, when available.",
|
|
3584
|
+
"type": [
|
|
3585
|
+
"string",
|
|
3586
|
+
"null"
|
|
3587
|
+
]
|
|
3588
|
+
},
|
|
3589
|
+
"questions": {
|
|
3590
|
+
"description": "Deferred questions and their binding or observed results for this occurrence.",
|
|
3591
|
+
"items": {
|
|
3592
|
+
"$ref": "#/components/schemas/OccurrenceQuestion"
|
|
3593
|
+
},
|
|
3594
|
+
"type": "array"
|
|
3595
|
+
},
|
|
3596
|
+
"state": {
|
|
3597
|
+
"allOf": [
|
|
3598
|
+
{
|
|
3599
|
+
"$ref": "#/components/schemas/CaptureState"
|
|
3600
|
+
}
|
|
3601
|
+
],
|
|
3602
|
+
"description": "Whether the capture is pending, recorded, unbound, not executed, or incomplete."
|
|
3603
|
+
}
|
|
3604
|
+
},
|
|
3605
|
+
"required": [
|
|
3606
|
+
"state",
|
|
3607
|
+
"approval_gaps",
|
|
3608
|
+
"questions"
|
|
3609
|
+
],
|
|
3610
|
+
"type": "object"
|
|
3611
|
+
},
|
|
3612
|
+
"OccurrenceQuestion": {
|
|
3613
|
+
"description": "One deferred question as the gate presents it.",
|
|
3614
|
+
"properties": {
|
|
3615
|
+
"assessment_id": {
|
|
3616
|
+
"description": "Assessment whose approval deferred this question.",
|
|
3617
|
+
"format": "uuid",
|
|
3618
|
+
"type": "string"
|
|
3619
|
+
},
|
|
3620
|
+
"code": {
|
|
3621
|
+
"description": "World's binding or refusal code, or the control plane's own gap.",
|
|
3622
|
+
"type": [
|
|
3623
|
+
"string",
|
|
3624
|
+
"null"
|
|
3625
|
+
]
|
|
3626
|
+
},
|
|
3627
|
+
"family_key": {
|
|
3628
|
+
"description": "Hypothesis family key for the deferred question.",
|
|
3629
|
+
"type": "string"
|
|
3630
|
+
},
|
|
3631
|
+
"family_version": {
|
|
3632
|
+
"description": "Hypothesis family version for the deferred question.",
|
|
3633
|
+
"format": "int32",
|
|
3634
|
+
"type": "integer"
|
|
3635
|
+
},
|
|
3636
|
+
"observed_result": {
|
|
3637
|
+
"description": "World's observed result once it recorded the question.",
|
|
3638
|
+
"type": [
|
|
3639
|
+
"string",
|
|
3640
|
+
"null"
|
|
3641
|
+
]
|
|
3642
|
+
},
|
|
3643
|
+
"outcome_id": {
|
|
3644
|
+
"description": "World outcome record identifier, when an observed result was recorded.",
|
|
3645
|
+
"type": [
|
|
3646
|
+
"string",
|
|
3647
|
+
"null"
|
|
3648
|
+
]
|
|
3649
|
+
},
|
|
3650
|
+
"state": {
|
|
3651
|
+
"allOf": [
|
|
3652
|
+
{
|
|
3653
|
+
"$ref": "#/components/schemas/QuestionState"
|
|
3654
|
+
}
|
|
3655
|
+
],
|
|
3656
|
+
"description": "Whether the question is pending, recorded, unbound, or not executed."
|
|
3657
|
+
}
|
|
3658
|
+
},
|
|
3659
|
+
"required": [
|
|
3660
|
+
"assessment_id",
|
|
3661
|
+
"family_key",
|
|
3662
|
+
"family_version",
|
|
3663
|
+
"state"
|
|
3664
|
+
],
|
|
3665
|
+
"type": "object"
|
|
3666
|
+
},
|
|
3064
3667
|
"OpenFindingCounts": {
|
|
3065
3668
|
"properties": {
|
|
3066
3669
|
"serious": {
|
|
@@ -3330,6 +3933,15 @@
|
|
|
3330
3933
|
],
|
|
3331
3934
|
"default": null,
|
|
3332
3935
|
"description": "The git hook that sent this request, when one did. A review recorded\n by an earlier identical request keeps the source it recorded."
|
|
3936
|
+
},
|
|
3937
|
+
"verify_finding_ids": {
|
|
3938
|
+
"default": [],
|
|
3939
|
+
"description": "Open findings of one pull request in this repository to re-verify\n against the patch, at most 20. The review re-investigates each one\n and reports its outcome in `local_reverifications`; the pull\n request's findings are unchanged whatever it is. Requires an API\n token. Each finding's series takes at most 3 requests per patch, and\n the pull request at most 10 re-verification requests per hour,\n counted with those a coding agent makes through MCP.",
|
|
3940
|
+
"items": {
|
|
3941
|
+
"format": "uuid",
|
|
3942
|
+
"type": "string"
|
|
3943
|
+
},
|
|
3944
|
+
"type": "array"
|
|
3333
3945
|
}
|
|
3334
3946
|
},
|
|
3335
3947
|
"required": [
|
|
@@ -3353,12 +3965,20 @@
|
|
|
3353
3965
|
"description": "The review of this patch on this base, readable through the review\n and findings routes.",
|
|
3354
3966
|
"format": "uuid",
|
|
3355
3967
|
"type": "string"
|
|
3968
|
+
},
|
|
3969
|
+
"verify": {
|
|
3970
|
+
"description": "Each finding of `verify_finding_ids` the review re-verifies, one per\n finding series. Empty without `verify_finding_ids`.",
|
|
3971
|
+
"items": {
|
|
3972
|
+
"$ref": "#/components/schemas/PatchVerification"
|
|
3973
|
+
},
|
|
3974
|
+
"type": "array"
|
|
3356
3975
|
}
|
|
3357
3976
|
},
|
|
3358
3977
|
"required": [
|
|
3359
3978
|
"review_id",
|
|
3360
3979
|
"existing",
|
|
3361
|
-
"patch_digest"
|
|
3980
|
+
"patch_digest",
|
|
3981
|
+
"verify"
|
|
3362
3982
|
],
|
|
3363
3983
|
"type": "object"
|
|
3364
3984
|
},
|
|
@@ -3370,6 +3990,26 @@
|
|
|
3370
3990
|
],
|
|
3371
3991
|
"type": "string"
|
|
3372
3992
|
},
|
|
3993
|
+
"PatchVerification": {
|
|
3994
|
+
"description": "One finding a patch review re-verifies against the patch.",
|
|
3995
|
+
"properties": {
|
|
3996
|
+
"finding_id": {
|
|
3997
|
+
"description": "The finding being re-verified against this patch.",
|
|
3998
|
+
"format": "uuid",
|
|
3999
|
+
"type": "string"
|
|
4000
|
+
},
|
|
4001
|
+
"iteration": {
|
|
4002
|
+
"description": "This request's number among the requests to re-verify the finding's\n series on this patch, at most 3.",
|
|
4003
|
+
"format": "int32",
|
|
4004
|
+
"type": "integer"
|
|
4005
|
+
}
|
|
4006
|
+
},
|
|
4007
|
+
"required": [
|
|
4008
|
+
"finding_id",
|
|
4009
|
+
"iteration"
|
|
4010
|
+
],
|
|
4011
|
+
"type": "object"
|
|
4012
|
+
},
|
|
3373
4013
|
"PermissionView": {
|
|
3374
4014
|
"enum": [
|
|
3375
4015
|
"PERMIT",
|
|
@@ -3459,6 +4099,75 @@
|
|
|
3459
4099
|
"title": "Problem",
|
|
3460
4100
|
"type": "object"
|
|
3461
4101
|
},
|
|
4102
|
+
"Prose": {
|
|
4103
|
+
"properties": {
|
|
4104
|
+
"headline": {
|
|
4105
|
+
"description": "At most 120 characters.",
|
|
4106
|
+
"type": "string"
|
|
4107
|
+
},
|
|
4108
|
+
"notable_paths": {
|
|
4109
|
+
"description": "Paths in the pinned diff the prose calls out.",
|
|
4110
|
+
"items": {
|
|
4111
|
+
"type": "string"
|
|
4112
|
+
},
|
|
4113
|
+
"type": "array"
|
|
4114
|
+
},
|
|
4115
|
+
"paragraphs": {
|
|
4116
|
+
"description": "At most three of at most 400 characters; one on the `SHORT` route.",
|
|
4117
|
+
"items": {
|
|
4118
|
+
"type": "string"
|
|
4119
|
+
},
|
|
4120
|
+
"type": "array"
|
|
4121
|
+
}
|
|
4122
|
+
},
|
|
4123
|
+
"required": [
|
|
4124
|
+
"headline",
|
|
4125
|
+
"paragraphs",
|
|
4126
|
+
"notable_paths"
|
|
4127
|
+
],
|
|
4128
|
+
"type": "object"
|
|
4129
|
+
},
|
|
4130
|
+
"ProseOutcome": {
|
|
4131
|
+
"description": "Why the summary carries prose or does not.",
|
|
4132
|
+
"oneOf": [
|
|
4133
|
+
{
|
|
4134
|
+
"enum": [
|
|
4135
|
+
"PUBLISHED"
|
|
4136
|
+
],
|
|
4137
|
+
"type": "string"
|
|
4138
|
+
},
|
|
4139
|
+
{
|
|
4140
|
+
"const": "NO_CHANGE_DIGEST",
|
|
4141
|
+
"description": "The review recorded no change digest to summarize.",
|
|
4142
|
+
"type": "string"
|
|
4143
|
+
},
|
|
4144
|
+
{
|
|
4145
|
+
"const": "NOT_REQUESTED",
|
|
4146
|
+
"description": "The applied route was `DETERMINISTIC_ONLY`.",
|
|
4147
|
+
"type": "string"
|
|
4148
|
+
},
|
|
4149
|
+
{
|
|
4150
|
+
"const": "MODEL_UNAVAILABLE",
|
|
4151
|
+
"description": "No fast-tier model was bound, priced or funded, or it did not answer.",
|
|
4152
|
+
"type": "string"
|
|
4153
|
+
},
|
|
4154
|
+
{
|
|
4155
|
+
"const": "MALFORMED",
|
|
4156
|
+
"description": "The answer did not fit the tool's schema or its limits.",
|
|
4157
|
+
"type": "string"
|
|
4158
|
+
},
|
|
4159
|
+
{
|
|
4160
|
+
"const": "REJECTED",
|
|
4161
|
+
"description": "The prose used a word a summary never uses (\"safe\", \"no risk\",\n \"approved\") or named a path outside the diff.",
|
|
4162
|
+
"type": "string"
|
|
4163
|
+
},
|
|
4164
|
+
{
|
|
4165
|
+
"const": "UNGROUNDED",
|
|
4166
|
+
"description": "Jev answered that a statement does not follow from the diff slices.",
|
|
4167
|
+
"type": "string"
|
|
4168
|
+
}
|
|
4169
|
+
]
|
|
4170
|
+
},
|
|
3462
4171
|
"PullRequestMergeGate": {
|
|
3463
4172
|
"properties": {
|
|
3464
4173
|
"assessment_count": {
|
|
@@ -3470,7 +4179,7 @@
|
|
|
3470
4179
|
]
|
|
3471
4180
|
},
|
|
3472
4181
|
"blocking_severity": {
|
|
3473
|
-
"description": "The frozen blocking threshold, either SERIOUS or WARNING; later settings do not restamp it.",
|
|
4182
|
+
"description": "The frozen blocking threshold, either SERIOUS (serious and critical findings) or WARNING (every\n supported finding); later settings do not restamp it.",
|
|
3474
4183
|
"type": "string"
|
|
3475
4184
|
},
|
|
3476
4185
|
"bypassed_at": {
|
|
@@ -3590,6 +4299,140 @@
|
|
|
3590
4299
|
],
|
|
3591
4300
|
"type": "object"
|
|
3592
4301
|
},
|
|
4302
|
+
"QuestionState": {
|
|
4303
|
+
"description": "Where one deferred question stands.",
|
|
4304
|
+
"oneOf": [
|
|
4305
|
+
{
|
|
4306
|
+
"const": "PENDING",
|
|
4307
|
+
"description": "World has stored no record yet: the execution is not yet decidable\n inside the question's window.",
|
|
4308
|
+
"type": "string"
|
|
4309
|
+
},
|
|
4310
|
+
{
|
|
4311
|
+
"const": "RECORDED",
|
|
4312
|
+
"description": "World recorded what the execution was observed to do.",
|
|
4313
|
+
"type": "string"
|
|
4314
|
+
},
|
|
4315
|
+
{
|
|
4316
|
+
"const": "UNBOUND",
|
|
4317
|
+
"description": "The question is not bound to the execution: World's binding code, its\n refusal of the replay, or the control plane's own gap says why.",
|
|
4318
|
+
"type": "string"
|
|
4319
|
+
},
|
|
4320
|
+
{
|
|
4321
|
+
"const": "NOT_EXECUTED",
|
|
4322
|
+
"description": "The gate never authorized the execution, so nothing ran to observe.",
|
|
4323
|
+
"type": "string"
|
|
4324
|
+
}
|
|
4325
|
+
]
|
|
4326
|
+
},
|
|
4327
|
+
"ReachGapView": {
|
|
4328
|
+
"properties": {
|
|
4329
|
+
"code": {
|
|
4330
|
+
"description": "`COVERAGE_INCOMPLETE`, `SOURCE_CAPABILITY_MISSING` or `BOUND_REACHED`.",
|
|
4331
|
+
"type": "string"
|
|
4332
|
+
}
|
|
4333
|
+
},
|
|
4334
|
+
"required": [
|
|
4335
|
+
"code"
|
|
4336
|
+
],
|
|
4337
|
+
"type": "object"
|
|
4338
|
+
},
|
|
4339
|
+
"ReachStepView": {
|
|
4340
|
+
"properties": {
|
|
4341
|
+
"assertion_id": {
|
|
4342
|
+
"description": "The World relation assertion behind this step.",
|
|
4343
|
+
"format": "uuid",
|
|
4344
|
+
"type": "string"
|
|
4345
|
+
},
|
|
4346
|
+
"direction": {
|
|
4347
|
+
"description": "`OUT` when the step follows the relation from its subject, `IN` when\n it follows it back to the subject.",
|
|
4348
|
+
"type": "string"
|
|
4349
|
+
},
|
|
4350
|
+
"relation": {
|
|
4351
|
+
"description": "The relation key, such as `proofline.relation.consumes_api`.",
|
|
4352
|
+
"type": "string"
|
|
4353
|
+
}
|
|
4354
|
+
},
|
|
4355
|
+
"required": [
|
|
4356
|
+
"assertion_id",
|
|
4357
|
+
"relation",
|
|
4358
|
+
"direction"
|
|
4359
|
+
],
|
|
4360
|
+
"type": "object"
|
|
4361
|
+
},
|
|
4362
|
+
"ReachedEntityView": {
|
|
4363
|
+
"properties": {
|
|
4364
|
+
"entity_id": {
|
|
4365
|
+
"description": "World's entity ID.",
|
|
4366
|
+
"format": "uuid",
|
|
4367
|
+
"type": "string"
|
|
4368
|
+
},
|
|
4369
|
+
"kind": {
|
|
4370
|
+
"description": "The entity's kind, such as `service` or `queue`.",
|
|
4371
|
+
"type": "string"
|
|
4372
|
+
},
|
|
4373
|
+
"label": {
|
|
4374
|
+
"description": "World's display label for the entity: environment evidence for\n readers of this organization, never published to GitHub.",
|
|
4375
|
+
"type": "string"
|
|
4376
|
+
},
|
|
4377
|
+
"path": {
|
|
4378
|
+
"description": "The recorded relation assertions from the deployed root to the entity.",
|
|
4379
|
+
"items": {
|
|
4380
|
+
"$ref": "#/components/schemas/ReachStepView"
|
|
4381
|
+
},
|
|
4382
|
+
"type": "array"
|
|
4383
|
+
},
|
|
4384
|
+
"type_keys": {
|
|
4385
|
+
"description": "World's registry type keys for the entity.",
|
|
4386
|
+
"items": {
|
|
4387
|
+
"type": "string"
|
|
4388
|
+
},
|
|
4389
|
+
"type": "array"
|
|
4390
|
+
}
|
|
4391
|
+
},
|
|
4392
|
+
"required": [
|
|
4393
|
+
"entity_id",
|
|
4394
|
+
"kind",
|
|
4395
|
+
"type_keys",
|
|
4396
|
+
"label",
|
|
4397
|
+
"path"
|
|
4398
|
+
],
|
|
4399
|
+
"type": "object"
|
|
4400
|
+
},
|
|
4401
|
+
"RefreshView": {
|
|
4402
|
+
"description": "A recorded refresh decision, as the console shows it.",
|
|
4403
|
+
"properties": {
|
|
4404
|
+
"decided_by": {
|
|
4405
|
+
"description": "What decided: `FLOOR`, a refresh rule that always reviews the whole\n change; `JEV`, Proofline's decision model within those rules; or\n `FALLBACK`, the refresh rules because the model did not decide.\n Absent for a full review a person requested, and for reviews decided\n before it was recorded.",
|
|
4406
|
+
"type": [
|
|
4407
|
+
"string",
|
|
4408
|
+
"null"
|
|
4409
|
+
]
|
|
4410
|
+
},
|
|
4411
|
+
"mode": {
|
|
4412
|
+
"description": "`INCREMENTAL` reviews only the files the push touched and carries the\n earlier review's untouched findings forward; `FULL` reviews the whole change.",
|
|
4413
|
+
"type": "string"
|
|
4414
|
+
},
|
|
4415
|
+
"reason": {
|
|
4416
|
+
"description": "Why, in words. Server text that may name repository paths.",
|
|
4417
|
+
"type": [
|
|
4418
|
+
"string",
|
|
4419
|
+
"null"
|
|
4420
|
+
]
|
|
4421
|
+
},
|
|
4422
|
+
"refreshes_review_id": {
|
|
4423
|
+
"description": "The review this one refreshes. Absent for a full review a person requested.",
|
|
4424
|
+
"format": "uuid",
|
|
4425
|
+
"type": [
|
|
4426
|
+
"string",
|
|
4427
|
+
"null"
|
|
4428
|
+
]
|
|
4429
|
+
}
|
|
4430
|
+
},
|
|
4431
|
+
"required": [
|
|
4432
|
+
"mode"
|
|
4433
|
+
],
|
|
4434
|
+
"type": "object"
|
|
4435
|
+
},
|
|
3593
4436
|
"RefusedEnvironment": {
|
|
3594
4437
|
"description": "An environment a refusal names. `external_key` is how its pages are\n addressed.",
|
|
3595
4438
|
"properties": {
|
|
@@ -3806,6 +4649,13 @@
|
|
|
3806
4649
|
],
|
|
3807
4650
|
"type": "object"
|
|
3808
4651
|
},
|
|
4652
|
+
"ReviewDepth": {
|
|
4653
|
+
"description": "The depth the applied route plan read a file at.",
|
|
4654
|
+
"enum": [
|
|
4655
|
+
"STANDARD"
|
|
4656
|
+
],
|
|
4657
|
+
"type": "string"
|
|
4658
|
+
},
|
|
3809
4659
|
"ReviewDiffStats": {
|
|
3810
4660
|
"properties": {
|
|
3811
4661
|
"additions": {
|
|
@@ -4151,7 +5001,7 @@
|
|
|
4151
5001
|
"type": "string"
|
|
4152
5002
|
},
|
|
4153
5003
|
"kind": {
|
|
4154
|
-
"description": "`PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes\n sent as a patch,
|
|
5004
|
+
"description": "`PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes\n sent as a patch, `COMMIT`, a review of pushed commits, or `FILES`,\n complete selected files at one pushed commit.",
|
|
4155
5005
|
"type": "string"
|
|
4156
5006
|
},
|
|
4157
5007
|
"public_key": {
|
|
@@ -4227,6 +5077,17 @@
|
|
|
4227
5077
|
"null"
|
|
4228
5078
|
]
|
|
4229
5079
|
},
|
|
5080
|
+
"refresh": {
|
|
5081
|
+
"anyOf": [
|
|
5082
|
+
{
|
|
5083
|
+
"$ref": "#/components/schemas/RefreshView"
|
|
5084
|
+
},
|
|
5085
|
+
{
|
|
5086
|
+
"type": "null"
|
|
5087
|
+
}
|
|
5088
|
+
],
|
|
5089
|
+
"description": "How this review decided what it reviews after a push or a full-review\n request. Absent for a review that refreshes nothing, and while a\n refresh has not decided yet."
|
|
5090
|
+
},
|
|
4230
5091
|
"repository_full_name": {
|
|
4231
5092
|
"description": "The repository's `owner/name`. Absent when the review names no repository.",
|
|
4232
5093
|
"type": [
|
|
@@ -4377,7 +5238,7 @@
|
|
|
4377
5238
|
"$ref": "#/components/schemas/ExportReviewKind"
|
|
4378
5239
|
}
|
|
4379
5240
|
],
|
|
4380
|
-
"description": "Whether the review analyzes a pull request, a deployment, a local patch
|
|
5241
|
+
"description": "Whether the review analyzes a pull request, a deployment, a local patch, pushed\n commits or selected whole files."
|
|
4381
5242
|
},
|
|
4382
5243
|
"organization_id": {
|
|
4383
5244
|
"description": "The organization that owns the review.",
|
|
@@ -5003,14 +5864,48 @@
|
|
|
5003
5864
|
"format": "uuid",
|
|
5004
5865
|
"type": "string"
|
|
5005
5866
|
},
|
|
5006
|
-
"prompt_digest": {
|
|
5007
|
-
"description": "The `prompt_digest` of the prompt the person confirmed.",
|
|
5867
|
+
"prompt_digest": {
|
|
5868
|
+
"description": "The `prompt_digest` of the prompt the person confirmed.",
|
|
5869
|
+
"type": "string"
|
|
5870
|
+
}
|
|
5871
|
+
},
|
|
5872
|
+
"required": [
|
|
5873
|
+
"connection_id",
|
|
5874
|
+
"prompt_digest"
|
|
5875
|
+
],
|
|
5876
|
+
"type": "object"
|
|
5877
|
+
},
|
|
5878
|
+
"StopResponse": {
|
|
5879
|
+
"description": "What stopping a review recorded.",
|
|
5880
|
+
"properties": {
|
|
5881
|
+
"review_id": {
|
|
5882
|
+
"description": "Identifier of the stopped review.",
|
|
5883
|
+
"format": "uuid",
|
|
5884
|
+
"type": "string"
|
|
5885
|
+
},
|
|
5886
|
+
"status": {
|
|
5887
|
+
"description": "Always `STOPPED`: the review's status once the stop is committed.",
|
|
5888
|
+
"type": "string"
|
|
5889
|
+
},
|
|
5890
|
+
"stopped_at": {
|
|
5891
|
+
"description": "Time when the review was stopped.",
|
|
5892
|
+
"format": "date-time",
|
|
5008
5893
|
"type": "string"
|
|
5894
|
+
},
|
|
5895
|
+
"stopped_by": {
|
|
5896
|
+
"allOf": [
|
|
5897
|
+
{
|
|
5898
|
+
"$ref": "#/components/schemas/ActorView"
|
|
5899
|
+
}
|
|
5900
|
+
],
|
|
5901
|
+
"description": "Person who stopped the review."
|
|
5009
5902
|
}
|
|
5010
5903
|
},
|
|
5011
5904
|
"required": [
|
|
5012
|
-
"
|
|
5013
|
-
"
|
|
5905
|
+
"review_id",
|
|
5906
|
+
"status",
|
|
5907
|
+
"stopped_by",
|
|
5908
|
+
"stopped_at"
|
|
5014
5909
|
],
|
|
5015
5910
|
"type": "object"
|
|
5016
5911
|
},
|
|
@@ -5067,6 +5962,17 @@
|
|
|
5067
5962
|
"null"
|
|
5068
5963
|
]
|
|
5069
5964
|
},
|
|
5965
|
+
"file_scope": {
|
|
5966
|
+
"anyOf": [
|
|
5967
|
+
{
|
|
5968
|
+
"$ref": "#/components/schemas/FileScope"
|
|
5969
|
+
},
|
|
5970
|
+
{
|
|
5971
|
+
"type": "null"
|
|
5972
|
+
}
|
|
5973
|
+
],
|
|
5974
|
+
"description": "Whole-file selection at the pinned revision; absent for comparisons."
|
|
5975
|
+
},
|
|
5070
5976
|
"id": {
|
|
5071
5977
|
"description": "The subject's stable identifier. It holds across a poll refresh even\n when a concurrently populated subject shifts this response's\n `(kind, id)` order: a client keying its own local UI state (an open\n disclosure, a focused control) by array index would otherwise lose\n that state to a reorder that changed nothing it owns.",
|
|
5072
5978
|
"format": "uuid",
|
|
@@ -5141,6 +6047,56 @@
|
|
|
5141
6047
|
],
|
|
5142
6048
|
"type": "object"
|
|
5143
6049
|
},
|
|
6050
|
+
"SummaryRoute": {
|
|
6051
|
+
"enum": [
|
|
6052
|
+
"DETERMINISTIC_ONLY",
|
|
6053
|
+
"SHORT",
|
|
6054
|
+
"FULL"
|
|
6055
|
+
],
|
|
6056
|
+
"type": "string"
|
|
6057
|
+
},
|
|
6058
|
+
"TerraformPlanView": {
|
|
6059
|
+
"enum": [
|
|
6060
|
+
"TAKEN",
|
|
6061
|
+
"NOT_DECLARED",
|
|
6062
|
+
"NOT_PINNED",
|
|
6063
|
+
"HEAD_DIFFERS",
|
|
6064
|
+
"ADDRESSES_UNREPORTED"
|
|
6065
|
+
],
|
|
6066
|
+
"type": "string"
|
|
6067
|
+
},
|
|
6068
|
+
"TerraformRootsView": {
|
|
6069
|
+
"description": "The Terraform roots of one declared reach read.",
|
|
6070
|
+
"properties": {
|
|
6071
|
+
"addresses": {
|
|
6072
|
+
"description": "The changed resource instance addresses taken as roots.",
|
|
6073
|
+
"items": {
|
|
6074
|
+
"type": "string"
|
|
6075
|
+
},
|
|
6076
|
+
"type": "array"
|
|
6077
|
+
},
|
|
6078
|
+
"omitted": {
|
|
6079
|
+
"description": "Changed addresses left out at World's limit of 100 roots per read.",
|
|
6080
|
+
"format": "uint",
|
|
6081
|
+
"minimum": 0,
|
|
6082
|
+
"type": "integer"
|
|
6083
|
+
},
|
|
6084
|
+
"plan": {
|
|
6085
|
+
"allOf": [
|
|
6086
|
+
{
|
|
6087
|
+
"$ref": "#/components/schemas/TerraformPlanView"
|
|
6088
|
+
}
|
|
6089
|
+
],
|
|
6090
|
+
"description": "`TAKEN` when the plan pinned for the reviewed commit named the roots,\n `NOT_DECLARED` when the environment captures no Terraform plan for this\n review, `NOT_PINNED` when it declares one and none was pinned,\n `HEAD_DIFFERS` when the pinned plan is for another commit, and\n `ADDRESSES_UNREPORTED` when the pinned plan records no changed\n addresses because it was pinned before World reported them."
|
|
6091
|
+
}
|
|
6092
|
+
},
|
|
6093
|
+
"required": [
|
|
6094
|
+
"plan",
|
|
6095
|
+
"addresses",
|
|
6096
|
+
"omitted"
|
|
6097
|
+
],
|
|
6098
|
+
"type": "object"
|
|
6099
|
+
},
|
|
5144
6100
|
"ThreadObservationFreshness": {
|
|
5145
6101
|
"enum": [
|
|
5146
6102
|
"FRESH",
|
|
@@ -5260,6 +6216,119 @@
|
|
|
5260
6216
|
"untrusted_text"
|
|
5261
6217
|
],
|
|
5262
6218
|
"type": "object"
|
|
6219
|
+
},
|
|
6220
|
+
"WalkthroughFileView": {
|
|
6221
|
+
"properties": {
|
|
6222
|
+
"additions": {
|
|
6223
|
+
"description": "Lines added.",
|
|
6224
|
+
"format": "int64",
|
|
6225
|
+
"type": "integer"
|
|
6226
|
+
},
|
|
6227
|
+
"change": {
|
|
6228
|
+
"description": "GitHub's change status, upper case, such as `ADDED` or `RENAMED`.",
|
|
6229
|
+
"type": "string"
|
|
6230
|
+
},
|
|
6231
|
+
"deletions": {
|
|
6232
|
+
"description": "Lines deleted.",
|
|
6233
|
+
"format": "int64",
|
|
6234
|
+
"type": "integer"
|
|
6235
|
+
},
|
|
6236
|
+
"depth": {
|
|
6237
|
+
"description": "The route plan's depth tier. Absent for a file the review did not\n evaluate.",
|
|
6238
|
+
"type": [
|
|
6239
|
+
"string",
|
|
6240
|
+
"null"
|
|
6241
|
+
]
|
|
6242
|
+
},
|
|
6243
|
+
"generated": {
|
|
6244
|
+
"description": "Whether `line` is model-authored.",
|
|
6245
|
+
"type": "boolean"
|
|
6246
|
+
},
|
|
6247
|
+
"line": {
|
|
6248
|
+
"description": "A model sentence, or the deterministic line when there is none.",
|
|
6249
|
+
"type": "string"
|
|
6250
|
+
},
|
|
6251
|
+
"path": {
|
|
6252
|
+
"description": "The file's path at the head commit.",
|
|
6253
|
+
"type": "string"
|
|
6254
|
+
},
|
|
6255
|
+
"previous_path": {
|
|
6256
|
+
"description": "The file's path before a rename. Absent otherwise.",
|
|
6257
|
+
"type": [
|
|
6258
|
+
"string",
|
|
6259
|
+
"null"
|
|
6260
|
+
]
|
|
6261
|
+
},
|
|
6262
|
+
"skip_class": {
|
|
6263
|
+
"description": "Why the review did not evaluate the file, such as `LOCKFILE` or\n `REPOSITORY_FILTER`.",
|
|
6264
|
+
"type": [
|
|
6265
|
+
"string",
|
|
6266
|
+
"null"
|
|
6267
|
+
]
|
|
6268
|
+
}
|
|
6269
|
+
},
|
|
6270
|
+
"required": [
|
|
6271
|
+
"path",
|
|
6272
|
+
"change",
|
|
6273
|
+
"additions",
|
|
6274
|
+
"deletions",
|
|
6275
|
+
"line",
|
|
6276
|
+
"generated"
|
|
6277
|
+
],
|
|
6278
|
+
"type": "object"
|
|
6279
|
+
},
|
|
6280
|
+
"WalkthroughGroupView": {
|
|
6281
|
+
"properties": {
|
|
6282
|
+
"description": {
|
|
6283
|
+
"description": "What the group changes. Absent when the group has no description.",
|
|
6284
|
+
"type": [
|
|
6285
|
+
"string",
|
|
6286
|
+
"null"
|
|
6287
|
+
]
|
|
6288
|
+
},
|
|
6289
|
+
"files": {
|
|
6290
|
+
"description": "The group's files.",
|
|
6291
|
+
"items": {
|
|
6292
|
+
"$ref": "#/components/schemas/WalkthroughFileView"
|
|
6293
|
+
},
|
|
6294
|
+
"type": "array"
|
|
6295
|
+
},
|
|
6296
|
+
"kind": {
|
|
6297
|
+
"description": "`FEATURE`, `FIX`, `REFACTOR`, `CONFIGURATION`, `INFRASTRUCTURE`,\n `DATA`, `DEPENDENCIES`, `TESTS` or `DOCS`.",
|
|
6298
|
+
"type": "string"
|
|
6299
|
+
},
|
|
6300
|
+
"title": {
|
|
6301
|
+
"description": "The group's title.",
|
|
6302
|
+
"type": "string"
|
|
6303
|
+
}
|
|
6304
|
+
},
|
|
6305
|
+
"required": [
|
|
6306
|
+
"title",
|
|
6307
|
+
"kind",
|
|
6308
|
+
"files"
|
|
6309
|
+
],
|
|
6310
|
+
"type": "object"
|
|
6311
|
+
},
|
|
6312
|
+
"WalkthroughView": {
|
|
6313
|
+
"description": "One review's walkthrough of its pinned head. Titles and lines are model\n text over untrusted repository content: render them as text.",
|
|
6314
|
+
"properties": {
|
|
6315
|
+
"groups": {
|
|
6316
|
+
"description": "Groups in reading order.",
|
|
6317
|
+
"items": {
|
|
6318
|
+
"$ref": "#/components/schemas/WalkthroughGroupView"
|
|
6319
|
+
},
|
|
6320
|
+
"type": "array"
|
|
6321
|
+
},
|
|
6322
|
+
"head_sha": {
|
|
6323
|
+
"description": "The head commit SHA the walkthrough describes.",
|
|
6324
|
+
"type": "string"
|
|
6325
|
+
}
|
|
6326
|
+
},
|
|
6327
|
+
"required": [
|
|
6328
|
+
"head_sha",
|
|
6329
|
+
"groups"
|
|
6330
|
+
],
|
|
6331
|
+
"type": "object"
|
|
5263
6332
|
}
|
|
5264
6333
|
},
|
|
5265
6334
|
"securitySchemes": {
|
|
@@ -5813,9 +6882,87 @@
|
|
|
5813
6882
|
"x-proofline-token-scope": "reviews:request"
|
|
5814
6883
|
}
|
|
5815
6884
|
},
|
|
6885
|
+
"/api/v1/organizations/{org_id}/repositories/{repo_id}/file-reviews": {
|
|
6886
|
+
"post": {
|
|
6887
|
+
"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.",
|
|
6888
|
+
"operationId": "request_file_review",
|
|
6889
|
+
"parameters": [
|
|
6890
|
+
{
|
|
6891
|
+
"in": "path",
|
|
6892
|
+
"name": "org_id",
|
|
6893
|
+
"required": true,
|
|
6894
|
+
"schema": {
|
|
6895
|
+
"format": "uuid",
|
|
6896
|
+
"type": "string"
|
|
6897
|
+
},
|
|
6898
|
+
"style": "simple"
|
|
6899
|
+
},
|
|
6900
|
+
{
|
|
6901
|
+
"in": "path",
|
|
6902
|
+
"name": "repo_id",
|
|
6903
|
+
"required": true,
|
|
6904
|
+
"schema": {
|
|
6905
|
+
"format": "uuid",
|
|
6906
|
+
"type": "string"
|
|
6907
|
+
},
|
|
6908
|
+
"style": "simple"
|
|
6909
|
+
}
|
|
6910
|
+
],
|
|
6911
|
+
"requestBody": {
|
|
6912
|
+
"content": {
|
|
6913
|
+
"application/json": {
|
|
6914
|
+
"schema": {
|
|
6915
|
+
"$ref": "#/components/schemas/FileReviewRequest"
|
|
6916
|
+
}
|
|
6917
|
+
}
|
|
6918
|
+
},
|
|
6919
|
+
"description": "Whole files selected at one exact pushed commit.",
|
|
6920
|
+
"required": true
|
|
6921
|
+
},
|
|
6922
|
+
"responses": {
|
|
6923
|
+
"200": {
|
|
6924
|
+
"content": {
|
|
6925
|
+
"application/json": {
|
|
6926
|
+
"schema": {
|
|
6927
|
+
"$ref": "#/components/schemas/FileReviewResponse"
|
|
6928
|
+
}
|
|
6929
|
+
}
|
|
6930
|
+
},
|
|
6931
|
+
"description": "What a named-file review request produced."
|
|
6932
|
+
},
|
|
6933
|
+
"400": {
|
|
6934
|
+
"content": {
|
|
6935
|
+
"application/json": {
|
|
6936
|
+
"schema": {
|
|
6937
|
+
"$ref": "#/components/schemas/RunNowRefused"
|
|
6938
|
+
}
|
|
6939
|
+
}
|
|
6940
|
+
},
|
|
6941
|
+
"description": "A run-now request that created nothing, as the 400 it is answered with.\n\n The refusal is a configuration fact, not a failure, and it is still sent\n as an RFC 9457 problem: `title`, `status` and `detail` are what a client\n that knows only problems shows, and `repository_name` and `refusal` are\n the extension members a client that knows refusals links from. During a\n rollout a page loaded from the previous bundle keeps working against\n this server, because a refusal was a 400 with a `detail` before too."
|
|
6942
|
+
},
|
|
6943
|
+
"default": {
|
|
6944
|
+
"content": {
|
|
6945
|
+
"application/problem+json": {
|
|
6946
|
+
"schema": {
|
|
6947
|
+
"$ref": "#/components/schemas/Problem"
|
|
6948
|
+
}
|
|
6949
|
+
}
|
|
6950
|
+
},
|
|
6951
|
+
"description": "An RFC 9457 problem; the HTTP status remains authoritative."
|
|
6952
|
+
}
|
|
6953
|
+
},
|
|
6954
|
+
"security": [
|
|
6955
|
+
{
|
|
6956
|
+
"bearerAuth": []
|
|
6957
|
+
}
|
|
6958
|
+
],
|
|
6959
|
+
"summary": "Review selected whole files",
|
|
6960
|
+
"x-proofline-token-scope": "reviews:request"
|
|
6961
|
+
}
|
|
6962
|
+
},
|
|
5816
6963
|
"/api/v1/organizations/{org_id}/repositories/{repo_id}/patch-reviews": {
|
|
5817
6964
|
"post": {
|
|
5818
|
-
"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.",
|
|
6965
|
+
"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.",
|
|
5819
6966
|
"operationId": "request_patch_review",
|
|
5820
6967
|
"parameters": [
|
|
5821
6968
|
{
|
|
@@ -6824,6 +7971,63 @@
|
|
|
6824
7971
|
"summary": "Get review routing",
|
|
6825
7972
|
"x-proofline-token-scope": "reviews:read"
|
|
6826
7973
|
}
|
|
7974
|
+
},
|
|
7975
|
+
"/api/v1/organizations/{org_id}/reviews/{review_id}/stop": {
|
|
7976
|
+
"post": {
|
|
7977
|
+
"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.",
|
|
7978
|
+
"operationId": "stop_review",
|
|
7979
|
+
"parameters": [
|
|
7980
|
+
{
|
|
7981
|
+
"in": "path",
|
|
7982
|
+
"name": "org_id",
|
|
7983
|
+
"required": true,
|
|
7984
|
+
"schema": {
|
|
7985
|
+
"format": "uuid",
|
|
7986
|
+
"type": "string"
|
|
7987
|
+
},
|
|
7988
|
+
"style": "simple"
|
|
7989
|
+
},
|
|
7990
|
+
{
|
|
7991
|
+
"in": "path",
|
|
7992
|
+
"name": "review_id",
|
|
7993
|
+
"required": true,
|
|
7994
|
+
"schema": {
|
|
7995
|
+
"format": "uuid",
|
|
7996
|
+
"type": "string"
|
|
7997
|
+
},
|
|
7998
|
+
"style": "simple"
|
|
7999
|
+
}
|
|
8000
|
+
],
|
|
8001
|
+
"responses": {
|
|
8002
|
+
"200": {
|
|
8003
|
+
"content": {
|
|
8004
|
+
"application/json": {
|
|
8005
|
+
"schema": {
|
|
8006
|
+
"$ref": "#/components/schemas/StopResponse"
|
|
8007
|
+
}
|
|
8008
|
+
}
|
|
8009
|
+
},
|
|
8010
|
+
"description": "What stopping a review recorded."
|
|
8011
|
+
},
|
|
8012
|
+
"default": {
|
|
8013
|
+
"content": {
|
|
8014
|
+
"application/problem+json": {
|
|
8015
|
+
"schema": {
|
|
8016
|
+
"$ref": "#/components/schemas/Problem"
|
|
8017
|
+
}
|
|
8018
|
+
}
|
|
8019
|
+
},
|
|
8020
|
+
"description": "An RFC 9457 problem; the HTTP status remains authoritative."
|
|
8021
|
+
}
|
|
8022
|
+
},
|
|
8023
|
+
"security": [
|
|
8024
|
+
{
|
|
8025
|
+
"bearerAuth": []
|
|
8026
|
+
}
|
|
8027
|
+
],
|
|
8028
|
+
"summary": "Stop your local review",
|
|
8029
|
+
"x-proofline-token-scope": "reviews:request"
|
|
8030
|
+
}
|
|
6827
8031
|
}
|
|
6828
8032
|
}
|
|
6829
8033
|
}
|