@proofline/sdk 6.4.0 → 7.1.0
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 +58 -3
- package/dist/transport.js +1 -1
- package/openapi.public.json +109 -3
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -455,7 +455,7 @@ export interface paths {
|
|
|
455
455
|
put?: never;
|
|
456
456
|
/**
|
|
457
457
|
* Stop your local review
|
|
458
|
-
* @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.
|
|
458
|
+
* @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. A repository audit is refused on this route: only a person with live GitHub write access stops it, through the audit stop, and no token or platform authority does. The stopped review retains its findings and exact code identity; requesting the same input returns that stopped review.
|
|
459
459
|
*/
|
|
460
460
|
post: operations["stop_review"];
|
|
461
461
|
delete?: never;
|
|
@@ -1430,6 +1430,11 @@ export interface components {
|
|
|
1430
1430
|
* @description When the review reached a terminal status. Absent while it is still pending or running.
|
|
1431
1431
|
*/
|
|
1432
1432
|
completed_at?: string | null;
|
|
1433
|
+
/**
|
|
1434
|
+
* @description What paid for `cost_microcredits`, read from each debit's own funding
|
|
1435
|
+
* records. Present exactly when `cost_microcredits` is.
|
|
1436
|
+
*/
|
|
1437
|
+
cost_funding?: components["schemas"]["ReviewCostFunding"] | null;
|
|
1433
1438
|
/**
|
|
1434
1439
|
* Format: int64
|
|
1435
1440
|
* @description The credits this run was charged so far, in microcredits, whoever
|
|
@@ -1524,6 +1529,15 @@ export interface components {
|
|
|
1524
1529
|
* `REVISION_SCAN`, a scan of one captured commit.
|
|
1525
1530
|
*/
|
|
1526
1531
|
kind: string;
|
|
1532
|
+
/**
|
|
1533
|
+
* @description What this review's linked-issue receipt recorded, read from the
|
|
1534
|
+
* receipt and never from current settings, so a later allowlist change
|
|
1535
|
+
* does not alter it. Null when the review kept no receipt: a kind that
|
|
1536
|
+
* reads no linked issues, a run that has not prepared its context yet,
|
|
1537
|
+
* a run that predates receipts, or a receipt that does not decode. Null
|
|
1538
|
+
* never means that no issue was captured.
|
|
1539
|
+
*/
|
|
1540
|
+
linked_issues?: components["schemas"]["LinkedIssueCapture"] | null;
|
|
1527
1541
|
/**
|
|
1528
1542
|
* @description For a patch review requested with `verify_finding_ids`, each finding
|
|
1529
1543
|
* it re-verifies against the patch and the outcome. The outcome is
|
|
@@ -1786,6 +1800,8 @@ export interface components {
|
|
|
1786
1800
|
EnvironmentCheck: {
|
|
1787
1801
|
/** @description The environment's display name. */
|
|
1788
1802
|
environment_display_name: string;
|
|
1803
|
+
/** @description The environment's key, which names its console pages. */
|
|
1804
|
+
environment_external_key: string;
|
|
1789
1805
|
/**
|
|
1790
1806
|
* @description Why the environment was not checked or does not apply. Null when it
|
|
1791
1807
|
* was checked or its check is still running.
|
|
@@ -1794,7 +1810,7 @@ export interface components {
|
|
|
1794
1810
|
/** @description Whether this review checked the environment. */
|
|
1795
1811
|
state: components["schemas"]["EnvironmentCheckState"];
|
|
1796
1812
|
};
|
|
1797
|
-
EnvironmentCheckReason: "NOT_COVERED" | "FORK_PULL_REQUEST" | "UNFINISHED" | "ENDED" | "PULL_REQUEST_REVIEWS_OFF";
|
|
1813
|
+
EnvironmentCheckReason: "NOT_COVERED" | "NO_CLOUD_ACCOUNT" | "READS_REFUSED" | "FORK_PULL_REQUEST" | "UNFINISHED" | "ENDED" | "PULL_REQUEST_REVIEWS_OFF";
|
|
1798
1814
|
EnvironmentCheckState: "CHECKED" | "CHECKING" | "NOT_CHECKED" | "NOT_APPLICABLE";
|
|
1799
1815
|
/** @enum {string} */
|
|
1800
1816
|
ExportEvidenceKind: "repository_file" | "repository_file_at_commit" | "companion_repository_file" | "commit" | "workflow_run" | "world_entity" | "deterministic_test" | "recorded_read" | "text";
|
|
@@ -2287,6 +2303,20 @@ export interface components {
|
|
|
2287
2303
|
* recorded it (`incompleteness_kind`), or `UNKNOWN` when none did.
|
|
2288
2304
|
*/
|
|
2289
2305
|
IncompleteCause: ("NOT_CONFIGURED" | "POLICY_EXCLUDED" | "EVIDENCE_UNAVAILABLE" | "HYPOTHESES_UNRESOLVED" | "MODEL_BUDGET_EXHAUSTED") | "UNKNOWN";
|
|
2306
|
+
/**
|
|
2307
|
+
* @description The count and outcome of a review's linked-issue receipt. Issue numbers,
|
|
2308
|
+
* titles and the receipt's gaps stay in the receipt.
|
|
2309
|
+
*/
|
|
2310
|
+
LinkedIssueCapture: {
|
|
2311
|
+
/**
|
|
2312
|
+
* Format: int64
|
|
2313
|
+
* @description How many issues the review captured as context.
|
|
2314
|
+
*/
|
|
2315
|
+
captured_count: number;
|
|
2316
|
+
outcome: components["schemas"]["LinkedIssueOutcome"];
|
|
2317
|
+
};
|
|
2318
|
+
/** @description What the review's linked-issue preparation found. */
|
|
2319
|
+
LinkedIssueOutcome: "NOT_CONFIGURED" | "NO_REFERENCES" | "PREPARED" | "SOURCE_UNAVAILABLE";
|
|
2290
2320
|
/**
|
|
2291
2321
|
* @description One finding a patch review re-verified against the patch. The outcome is
|
|
2292
2322
|
* local: the pull request's finding is unchanged whatever it is.
|
|
@@ -2428,7 +2458,10 @@ export interface components {
|
|
|
2428
2458
|
* @description Unresolved recorded finding series, including notification-suppressed
|
|
2429
2459
|
* findings, decisions whose dismissal or risk acceptance expired, and
|
|
2430
2460
|
* earlier published series of the pull request that this review did not
|
|
2431
|
-
* find again
|
|
2461
|
+
* find again, and the supported findings its `KIAN` environment
|
|
2462
|
+
* assessments published: each violated confirmed gate requirement the
|
|
2463
|
+
* change does not set and each investigation finding, which have no
|
|
2464
|
+
* severity.
|
|
2432
2465
|
*/
|
|
2433
2466
|
open_findings: number;
|
|
2434
2467
|
/**
|
|
@@ -2812,6 +2845,28 @@ export interface components {
|
|
|
2812
2845
|
*/
|
|
2813
2846
|
validate_findings: boolean;
|
|
2814
2847
|
};
|
|
2848
|
+
/**
|
|
2849
|
+
* @description What paid for a run's credit cost, as Usage splits a day. The three parts
|
|
2850
|
+
* add up to the cost.
|
|
2851
|
+
*/
|
|
2852
|
+
ReviewCostFunding: {
|
|
2853
|
+
/**
|
|
2854
|
+
* Format: int64
|
|
2855
|
+
* @description Paid by the free review month: the same organization's
|
|
2856
|
+
* `free-review:{debit_id}` grants for the run's debits.
|
|
2857
|
+
*/
|
|
2858
|
+
free_review_microcredits: number;
|
|
2859
|
+
/**
|
|
2860
|
+
* Format: int64
|
|
2861
|
+
* @description Taken from the organization's shared credit balance.
|
|
2862
|
+
*/
|
|
2863
|
+
organization_microcredits: number;
|
|
2864
|
+
/**
|
|
2865
|
+
* Format: int64
|
|
2866
|
+
* @description Paid by the workspace allowance or the author's seat.
|
|
2867
|
+
*/
|
|
2868
|
+
plan_microcredits: number;
|
|
2869
|
+
};
|
|
2815
2870
|
/**
|
|
2816
2871
|
* @description The depth the applied route plan read a file at.
|
|
2817
2872
|
* @enum {string}
|
package/dist/transport.js
CHANGED
package/openapi.public.json
CHANGED
|
@@ -1783,6 +1783,17 @@
|
|
|
1783
1783
|
"null"
|
|
1784
1784
|
]
|
|
1785
1785
|
},
|
|
1786
|
+
"cost_funding": {
|
|
1787
|
+
"anyOf": [
|
|
1788
|
+
{
|
|
1789
|
+
"$ref": "#/components/schemas/ReviewCostFunding"
|
|
1790
|
+
},
|
|
1791
|
+
{
|
|
1792
|
+
"type": "null"
|
|
1793
|
+
}
|
|
1794
|
+
],
|
|
1795
|
+
"description": "What paid for `cost_microcredits`, read from each debit's own funding\n records. Present exactly when `cost_microcredits` is."
|
|
1796
|
+
},
|
|
1786
1797
|
"cost_microcredits": {
|
|
1787
1798
|
"description": "The credits this run was charged so far, in microcredits, whoever\n paid: the plan, the free review month or the organization's credits.\n Null for a caller who is not a member of the organization.",
|
|
1788
1799
|
"format": "int64",
|
|
@@ -1903,6 +1914,17 @@
|
|
|
1903
1914
|
"description": "`PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes\n sent as a patch, `COMMIT`, a review of pushed commits, `FILES`,\n complete selected files at one pushed commit, `MERGE_GROUP`, the\n commit GitHub's merge queue built for a group of pull requests, or\n `REVISION_SCAN`, a scan of one captured commit.",
|
|
1904
1915
|
"type": "string"
|
|
1905
1916
|
},
|
|
1917
|
+
"linked_issues": {
|
|
1918
|
+
"anyOf": [
|
|
1919
|
+
{
|
|
1920
|
+
"$ref": "#/components/schemas/LinkedIssueCapture"
|
|
1921
|
+
},
|
|
1922
|
+
{
|
|
1923
|
+
"type": "null"
|
|
1924
|
+
}
|
|
1925
|
+
],
|
|
1926
|
+
"description": "What this review's linked-issue receipt recorded, read from the\n receipt and never from current settings, so a later allowlist change\n does not alter it. Null when the review kept no receipt: a kind that\n reads no linked issues, a run that has not prepared its context yet,\n a run that predates receipts, or a receipt that does not decode. Null\n never means that no issue was captured."
|
|
1927
|
+
},
|
|
1906
1928
|
"local_reverifications": {
|
|
1907
1929
|
"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.",
|
|
1908
1930
|
"items": {
|
|
@@ -2360,6 +2382,10 @@
|
|
|
2360
2382
|
"description": "The environment's display name.",
|
|
2361
2383
|
"type": "string"
|
|
2362
2384
|
},
|
|
2385
|
+
"environment_external_key": {
|
|
2386
|
+
"description": "The environment's key, which names its console pages.",
|
|
2387
|
+
"type": "string"
|
|
2388
|
+
},
|
|
2363
2389
|
"reason": {
|
|
2364
2390
|
"anyOf": [
|
|
2365
2391
|
{
|
|
@@ -2382,6 +2408,7 @@
|
|
|
2382
2408
|
},
|
|
2383
2409
|
"required": [
|
|
2384
2410
|
"environment_display_name",
|
|
2411
|
+
"environment_external_key",
|
|
2385
2412
|
"state"
|
|
2386
2413
|
],
|
|
2387
2414
|
"type": "object"
|
|
@@ -2393,6 +2420,16 @@
|
|
|
2393
2420
|
"description": "`NOT_CHECKED`: Proofline does not check this environment for pull\n requests, so the review assessed its code only.",
|
|
2394
2421
|
"type": "string"
|
|
2395
2422
|
},
|
|
2423
|
+
{
|
|
2424
|
+
"const": "NO_CLOUD_ACCOUNT",
|
|
2425
|
+
"description": "`NOT_CHECKED`: no AWS account, Google Cloud project or Azure\n subscription is connected to the environment, so the review assessed\n its code only. The environment's Setup page connects one.",
|
|
2426
|
+
"type": "string"
|
|
2427
|
+
},
|
|
2428
|
+
{
|
|
2429
|
+
"const": "READS_REFUSED",
|
|
2430
|
+
"description": "`NOT_CHECKED`: the environment's assessment is incomplete because the\n inventory it pinned lacks reads a connected account's role refused.\n The environment's Setup page names them.",
|
|
2431
|
+
"type": "string"
|
|
2432
|
+
},
|
|
2396
2433
|
{
|
|
2397
2434
|
"const": "FORK_PULL_REQUEST",
|
|
2398
2435
|
"description": "`NOT_CHECKED`: the pull request comes from a fork, which Proofline\n does not check against an environment.",
|
|
@@ -3591,6 +3628,49 @@
|
|
|
3591
3628
|
}
|
|
3592
3629
|
]
|
|
3593
3630
|
},
|
|
3631
|
+
"LinkedIssueCapture": {
|
|
3632
|
+
"description": "The count and outcome of a review's linked-issue receipt. Issue numbers,\n titles and the receipt's gaps stay in the receipt.",
|
|
3633
|
+
"properties": {
|
|
3634
|
+
"captured_count": {
|
|
3635
|
+
"description": "How many issues the review captured as context.",
|
|
3636
|
+
"format": "int64",
|
|
3637
|
+
"type": "integer"
|
|
3638
|
+
},
|
|
3639
|
+
"outcome": {
|
|
3640
|
+
"$ref": "#/components/schemas/LinkedIssueOutcome"
|
|
3641
|
+
}
|
|
3642
|
+
},
|
|
3643
|
+
"required": [
|
|
3644
|
+
"outcome",
|
|
3645
|
+
"captured_count"
|
|
3646
|
+
],
|
|
3647
|
+
"type": "object"
|
|
3648
|
+
},
|
|
3649
|
+
"LinkedIssueOutcome": {
|
|
3650
|
+
"description": "What the review's linked-issue preparation found.",
|
|
3651
|
+
"oneOf": [
|
|
3652
|
+
{
|
|
3653
|
+
"const": "NOT_CONFIGURED",
|
|
3654
|
+
"description": "No issue source was connected for the review.",
|
|
3655
|
+
"type": "string"
|
|
3656
|
+
},
|
|
3657
|
+
{
|
|
3658
|
+
"const": "NO_REFERENCES",
|
|
3659
|
+
"description": "The pull request referenced no issue.",
|
|
3660
|
+
"type": "string"
|
|
3661
|
+
},
|
|
3662
|
+
{
|
|
3663
|
+
"const": "PREPARED",
|
|
3664
|
+
"description": "The pull request referenced issues and the source was read.",
|
|
3665
|
+
"type": "string"
|
|
3666
|
+
},
|
|
3667
|
+
{
|
|
3668
|
+
"const": "SOURCE_UNAVAILABLE",
|
|
3669
|
+
"description": "The source could not be read, or the review's evaluation withheld\n linked issues.",
|
|
3670
|
+
"type": "string"
|
|
3671
|
+
}
|
|
3672
|
+
]
|
|
3673
|
+
},
|
|
3594
3674
|
"LocalReverification": {
|
|
3595
3675
|
"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.",
|
|
3596
3676
|
"properties": {
|
|
@@ -3863,7 +3943,7 @@
|
|
|
3863
3943
|
"type": "array"
|
|
3864
3944
|
},
|
|
3865
3945
|
"open_findings": {
|
|
3866
|
-
"description": "Unresolved recorded finding series, including notification-suppressed\n findings, decisions whose dismissal or risk acceptance expired, and\n earlier published series of the pull request that this review did not\n find again.",
|
|
3946
|
+
"description": "Unresolved recorded finding series, including notification-suppressed\n findings, decisions whose dismissal or risk acceptance expired, and\n earlier published series of the pull request that this review did not\n find again, and the supported findings its `KIAN` environment\n assessments published: each violated confirmed gate requirement the\n change does not set and each investigation finding, which have no\n severity.",
|
|
3867
3947
|
"format": "uint",
|
|
3868
3948
|
"minimum": 0,
|
|
3869
3949
|
"type": "integer"
|
|
@@ -4590,6 +4670,32 @@
|
|
|
4590
4670
|
],
|
|
4591
4671
|
"type": "object"
|
|
4592
4672
|
},
|
|
4673
|
+
"ReviewCostFunding": {
|
|
4674
|
+
"description": "What paid for a run's credit cost, as Usage splits a day. The three parts\n add up to the cost.",
|
|
4675
|
+
"properties": {
|
|
4676
|
+
"free_review_microcredits": {
|
|
4677
|
+
"description": "Paid by the free review month: the same organization's\n `free-review:{debit_id}` grants for the run's debits.",
|
|
4678
|
+
"format": "int64",
|
|
4679
|
+
"type": "integer"
|
|
4680
|
+
},
|
|
4681
|
+
"organization_microcredits": {
|
|
4682
|
+
"description": "Taken from the organization's shared credit balance.",
|
|
4683
|
+
"format": "int64",
|
|
4684
|
+
"type": "integer"
|
|
4685
|
+
},
|
|
4686
|
+
"plan_microcredits": {
|
|
4687
|
+
"description": "Paid by the workspace allowance or the author's seat.",
|
|
4688
|
+
"format": "int64",
|
|
4689
|
+
"type": "integer"
|
|
4690
|
+
}
|
|
4691
|
+
},
|
|
4692
|
+
"required": [
|
|
4693
|
+
"plan_microcredits",
|
|
4694
|
+
"free_review_microcredits",
|
|
4695
|
+
"organization_microcredits"
|
|
4696
|
+
],
|
|
4697
|
+
"type": "object"
|
|
4698
|
+
},
|
|
4593
4699
|
"ReviewDepth": {
|
|
4594
4700
|
"description": "The depth the applied route plan read a file at.",
|
|
4595
4701
|
"enum": [
|
|
@@ -6356,7 +6462,7 @@
|
|
|
6356
6462
|
},
|
|
6357
6463
|
"info": {
|
|
6358
6464
|
"title": "Proofline Review API",
|
|
6359
|
-
"version": "
|
|
6465
|
+
"version": "7.1.0"
|
|
6360
6466
|
},
|
|
6361
6467
|
"openapi": "3.1.0",
|
|
6362
6468
|
"paths": {
|
|
@@ -8200,7 +8306,7 @@
|
|
|
8200
8306
|
},
|
|
8201
8307
|
"/api/v1/organizations/{org_id}/reviews/{review_id}/stop": {
|
|
8202
8308
|
"post": {
|
|
8203
|
-
"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.",
|
|
8309
|
+
"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. A repository audit is refused on this route: only a person with live GitHub write access stops it, through the audit stop, and no token or platform authority does. The stopped review retains its findings and exact code identity; requesting the same input returns that stopped review.",
|
|
8204
8310
|
"operationId": "stop_review",
|
|
8205
8311
|
"parameters": [
|
|
8206
8312
|
{
|