@proofline/sdk 6.3.0 → 7.0.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 +50 -1
- package/dist/transport.js +1 -1
- package/openapi.public.json +110 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -1365,6 +1365,13 @@ export interface components {
|
|
|
1365
1365
|
assessment_count: number;
|
|
1366
1366
|
/** @description The environment assessments this review recorded. */
|
|
1367
1367
|
assessments: components["schemas"]["CustomerAssessment"][];
|
|
1368
|
+
/**
|
|
1369
|
+
* @description The repository audit's mode, `CODE_ONLY` or `INFRASTRUCTURE_AWARE`,
|
|
1370
|
+
* when this `REVISION_SCAN` is an audit. An audit's findings are in its
|
|
1371
|
+
* audit report, not in `finding_count` or the review's assessments.
|
|
1372
|
+
* Null for every other review.
|
|
1373
|
+
*/
|
|
1374
|
+
audit_mode?: string | null;
|
|
1368
1375
|
/**
|
|
1369
1376
|
* @description The base branch tip GitHub reported when the review was triggered,
|
|
1370
1377
|
* display metadata that differs from `base_commit_sha` when the base
|
|
@@ -1517,6 +1524,15 @@ export interface components {
|
|
|
1517
1524
|
* `REVISION_SCAN`, a scan of one captured commit.
|
|
1518
1525
|
*/
|
|
1519
1526
|
kind: string;
|
|
1527
|
+
/**
|
|
1528
|
+
* @description What this review's linked-issue receipt recorded, read from the
|
|
1529
|
+
* receipt and never from current settings, so a later allowlist change
|
|
1530
|
+
* does not alter it. Null when the review kept no receipt: a kind that
|
|
1531
|
+
* reads no linked issues, a run that has not prepared its context yet,
|
|
1532
|
+
* a run that predates receipts, or a receipt that does not decode. Null
|
|
1533
|
+
* never means that no issue was captured.
|
|
1534
|
+
*/
|
|
1535
|
+
linked_issues?: components["schemas"]["LinkedIssueCapture"] | null;
|
|
1520
1536
|
/**
|
|
1521
1537
|
* @description For a patch review requested with `verify_finding_ids`, each finding
|
|
1522
1538
|
* it re-verifies against the patch and the outcome. The outcome is
|
|
@@ -1779,6 +1795,8 @@ export interface components {
|
|
|
1779
1795
|
EnvironmentCheck: {
|
|
1780
1796
|
/** @description The environment's display name. */
|
|
1781
1797
|
environment_display_name: string;
|
|
1798
|
+
/** @description The environment's key, which names its console pages. */
|
|
1799
|
+
environment_external_key: string;
|
|
1782
1800
|
/**
|
|
1783
1801
|
* @description Why the environment was not checked or does not apply. Null when it
|
|
1784
1802
|
* was checked or its check is still running.
|
|
@@ -1787,7 +1805,7 @@ export interface components {
|
|
|
1787
1805
|
/** @description Whether this review checked the environment. */
|
|
1788
1806
|
state: components["schemas"]["EnvironmentCheckState"];
|
|
1789
1807
|
};
|
|
1790
|
-
EnvironmentCheckReason: "NOT_COVERED" | "FORK_PULL_REQUEST" | "UNFINISHED" | "ENDED" | "PULL_REQUEST_REVIEWS_OFF";
|
|
1808
|
+
EnvironmentCheckReason: "NOT_COVERED" | "NO_CLOUD_ACCOUNT" | "READS_REFUSED" | "FORK_PULL_REQUEST" | "UNFINISHED" | "ENDED" | "PULL_REQUEST_REVIEWS_OFF";
|
|
1791
1809
|
EnvironmentCheckState: "CHECKED" | "CHECKING" | "NOT_CHECKED" | "NOT_APPLICABLE";
|
|
1792
1810
|
/** @enum {string} */
|
|
1793
1811
|
ExportEvidenceKind: "repository_file" | "repository_file_at_commit" | "companion_repository_file" | "commit" | "workflow_run" | "world_entity" | "deterministic_test" | "recorded_read" | "text";
|
|
@@ -2280,6 +2298,20 @@ export interface components {
|
|
|
2280
2298
|
* recorded it (`incompleteness_kind`), or `UNKNOWN` when none did.
|
|
2281
2299
|
*/
|
|
2282
2300
|
IncompleteCause: ("NOT_CONFIGURED" | "POLICY_EXCLUDED" | "EVIDENCE_UNAVAILABLE" | "HYPOTHESES_UNRESOLVED" | "MODEL_BUDGET_EXHAUSTED") | "UNKNOWN";
|
|
2301
|
+
/**
|
|
2302
|
+
* @description The count and outcome of a review's linked-issue receipt. Issue numbers,
|
|
2303
|
+
* titles and the receipt's gaps stay in the receipt.
|
|
2304
|
+
*/
|
|
2305
|
+
LinkedIssueCapture: {
|
|
2306
|
+
/**
|
|
2307
|
+
* Format: int64
|
|
2308
|
+
* @description How many issues the review captured as context.
|
|
2309
|
+
*/
|
|
2310
|
+
captured_count: number;
|
|
2311
|
+
outcome: components["schemas"]["LinkedIssueOutcome"];
|
|
2312
|
+
};
|
|
2313
|
+
/** @description What the review's linked-issue preparation found. */
|
|
2314
|
+
LinkedIssueOutcome: "NOT_CONFIGURED" | "NO_REFERENCES" | "PREPARED" | "SOURCE_UNAVAILABLE";
|
|
2283
2315
|
/**
|
|
2284
2316
|
* @description One finding a patch review re-verified against the patch. The outcome is
|
|
2285
2317
|
* local: the pull request's finding is unchanged whatever it is.
|
|
@@ -3021,6 +3053,13 @@ export interface components {
|
|
|
3021
3053
|
* @description How many environment assessments this review has.
|
|
3022
3054
|
*/
|
|
3023
3055
|
assessment_count: number;
|
|
3056
|
+
/**
|
|
3057
|
+
* @description The repository audit's mode, `CODE_ONLY` or `INFRASTRUCTURE_AWARE`,
|
|
3058
|
+
* when this `REVISION_SCAN` is an audit. An audit's findings are in its
|
|
3059
|
+
* audit report, not in `finding_count` or the review's assessments.
|
|
3060
|
+
* Null for every other review.
|
|
3061
|
+
*/
|
|
3062
|
+
audit_mode?: string | null;
|
|
3024
3063
|
/**
|
|
3025
3064
|
* Format: date-time
|
|
3026
3065
|
* @description When the review reached a terminal status. Absent while it is still pending or running.
|
|
@@ -4366,6 +4405,11 @@ export interface operations {
|
|
|
4366
4405
|
* findings, FAILED/INCOMPLETE/STOPPED execution, or an earlier reviewed commit.
|
|
4367
4406
|
*/
|
|
4368
4407
|
attention?: string | null;
|
|
4408
|
+
/**
|
|
4409
|
+
* @description `only` lists repository audits; `none` leaves them out, so
|
|
4410
|
+
* `kind=REVISION_SCAN&audits=none` lists plain revision scans.
|
|
4411
|
+
*/
|
|
4412
|
+
audits?: string | null;
|
|
4369
4413
|
/**
|
|
4370
4414
|
* @description `mine` for the caller's own pull requests, or a GitHub user ID. `mine`
|
|
4371
4415
|
* needs a person's sign-in or token.
|
|
@@ -4460,6 +4504,11 @@ export interface operations {
|
|
|
4460
4504
|
* findings, FAILED/INCOMPLETE/STOPPED execution, or an earlier reviewed commit.
|
|
4461
4505
|
*/
|
|
4462
4506
|
attention?: string | null;
|
|
4507
|
+
/**
|
|
4508
|
+
* @description `only` lists repository audits; `none` leaves them out, so
|
|
4509
|
+
* `kind=REVISION_SCAN&audits=none` lists plain revision scans.
|
|
4510
|
+
*/
|
|
4511
|
+
audits?: string | null;
|
|
4463
4512
|
/**
|
|
4464
4513
|
* @description `mine` for the caller's own pull requests, or a GitHub user ID. `mine`
|
|
4465
4514
|
* needs a person's sign-in or token.
|
package/dist/transport.js
CHANGED
package/openapi.public.json
CHANGED
|
@@ -1693,6 +1693,13 @@
|
|
|
1693
1693
|
},
|
|
1694
1694
|
"type": "array"
|
|
1695
1695
|
},
|
|
1696
|
+
"audit_mode": {
|
|
1697
|
+
"description": "The repository audit's mode, `CODE_ONLY` or `INFRASTRUCTURE_AWARE`,\n when this `REVISION_SCAN` is an audit. An audit's findings are in its\n audit report, not in `finding_count` or the review's assessments.\n Null for every other review.",
|
|
1698
|
+
"type": [
|
|
1699
|
+
"string",
|
|
1700
|
+
"null"
|
|
1701
|
+
]
|
|
1702
|
+
},
|
|
1696
1703
|
"base_branch_commit_sha": {
|
|
1697
1704
|
"description": "The base branch tip GitHub reported when the review was triggered,\n display metadata that differs from `base_commit_sha` when the base\n branch moved after the branch point.",
|
|
1698
1705
|
"type": [
|
|
@@ -1896,6 +1903,17 @@
|
|
|
1896
1903
|
"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.",
|
|
1897
1904
|
"type": "string"
|
|
1898
1905
|
},
|
|
1906
|
+
"linked_issues": {
|
|
1907
|
+
"anyOf": [
|
|
1908
|
+
{
|
|
1909
|
+
"$ref": "#/components/schemas/LinkedIssueCapture"
|
|
1910
|
+
},
|
|
1911
|
+
{
|
|
1912
|
+
"type": "null"
|
|
1913
|
+
}
|
|
1914
|
+
],
|
|
1915
|
+
"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."
|
|
1916
|
+
},
|
|
1899
1917
|
"local_reverifications": {
|
|
1900
1918
|
"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.",
|
|
1901
1919
|
"items": {
|
|
@@ -2353,6 +2371,10 @@
|
|
|
2353
2371
|
"description": "The environment's display name.",
|
|
2354
2372
|
"type": "string"
|
|
2355
2373
|
},
|
|
2374
|
+
"environment_external_key": {
|
|
2375
|
+
"description": "The environment's key, which names its console pages.",
|
|
2376
|
+
"type": "string"
|
|
2377
|
+
},
|
|
2356
2378
|
"reason": {
|
|
2357
2379
|
"anyOf": [
|
|
2358
2380
|
{
|
|
@@ -2375,6 +2397,7 @@
|
|
|
2375
2397
|
},
|
|
2376
2398
|
"required": [
|
|
2377
2399
|
"environment_display_name",
|
|
2400
|
+
"environment_external_key",
|
|
2378
2401
|
"state"
|
|
2379
2402
|
],
|
|
2380
2403
|
"type": "object"
|
|
@@ -2386,6 +2409,16 @@
|
|
|
2386
2409
|
"description": "`NOT_CHECKED`: Proofline does not check this environment for pull\n requests, so the review assessed its code only.",
|
|
2387
2410
|
"type": "string"
|
|
2388
2411
|
},
|
|
2412
|
+
{
|
|
2413
|
+
"const": "NO_CLOUD_ACCOUNT",
|
|
2414
|
+
"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.",
|
|
2415
|
+
"type": "string"
|
|
2416
|
+
},
|
|
2417
|
+
{
|
|
2418
|
+
"const": "READS_REFUSED",
|
|
2419
|
+
"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.",
|
|
2420
|
+
"type": "string"
|
|
2421
|
+
},
|
|
2389
2422
|
{
|
|
2390
2423
|
"const": "FORK_PULL_REQUEST",
|
|
2391
2424
|
"description": "`NOT_CHECKED`: the pull request comes from a fork, which Proofline\n does not check against an environment.",
|
|
@@ -3584,6 +3617,49 @@
|
|
|
3584
3617
|
}
|
|
3585
3618
|
]
|
|
3586
3619
|
},
|
|
3620
|
+
"LinkedIssueCapture": {
|
|
3621
|
+
"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.",
|
|
3622
|
+
"properties": {
|
|
3623
|
+
"captured_count": {
|
|
3624
|
+
"description": "How many issues the review captured as context.",
|
|
3625
|
+
"format": "int64",
|
|
3626
|
+
"type": "integer"
|
|
3627
|
+
},
|
|
3628
|
+
"outcome": {
|
|
3629
|
+
"$ref": "#/components/schemas/LinkedIssueOutcome"
|
|
3630
|
+
}
|
|
3631
|
+
},
|
|
3632
|
+
"required": [
|
|
3633
|
+
"outcome",
|
|
3634
|
+
"captured_count"
|
|
3635
|
+
],
|
|
3636
|
+
"type": "object"
|
|
3637
|
+
},
|
|
3638
|
+
"LinkedIssueOutcome": {
|
|
3639
|
+
"description": "What the review's linked-issue preparation found.",
|
|
3640
|
+
"oneOf": [
|
|
3641
|
+
{
|
|
3642
|
+
"const": "NOT_CONFIGURED",
|
|
3643
|
+
"description": "No issue source was connected for the review.",
|
|
3644
|
+
"type": "string"
|
|
3645
|
+
},
|
|
3646
|
+
{
|
|
3647
|
+
"const": "NO_REFERENCES",
|
|
3648
|
+
"description": "The pull request referenced no issue.",
|
|
3649
|
+
"type": "string"
|
|
3650
|
+
},
|
|
3651
|
+
{
|
|
3652
|
+
"const": "PREPARED",
|
|
3653
|
+
"description": "The pull request referenced issues and the source was read.",
|
|
3654
|
+
"type": "string"
|
|
3655
|
+
},
|
|
3656
|
+
{
|
|
3657
|
+
"const": "SOURCE_UNAVAILABLE",
|
|
3658
|
+
"description": "The source could not be read, or the review's evaluation withheld\n linked issues.",
|
|
3659
|
+
"type": "string"
|
|
3660
|
+
}
|
|
3661
|
+
]
|
|
3662
|
+
},
|
|
3587
3663
|
"LocalReverification": {
|
|
3588
3664
|
"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.",
|
|
3589
3665
|
"properties": {
|
|
@@ -4971,6 +5047,13 @@
|
|
|
4971
5047
|
"format": "int64",
|
|
4972
5048
|
"type": "integer"
|
|
4973
5049
|
},
|
|
5050
|
+
"audit_mode": {
|
|
5051
|
+
"description": "The repository audit's mode, `CODE_ONLY` or `INFRASTRUCTURE_AWARE`,\n when this `REVISION_SCAN` is an audit. An audit's findings are in its\n audit report, not in `finding_count` or the review's assessments.\n Null for every other review.",
|
|
5052
|
+
"type": [
|
|
5053
|
+
"string",
|
|
5054
|
+
"null"
|
|
5055
|
+
]
|
|
5056
|
+
},
|
|
4974
5057
|
"completed_at": {
|
|
4975
5058
|
"description": "When the review reached a terminal status. Absent while it is still pending or running.",
|
|
4976
5059
|
"format": "date-time",
|
|
@@ -6342,7 +6425,7 @@
|
|
|
6342
6425
|
},
|
|
6343
6426
|
"info": {
|
|
6344
6427
|
"title": "Proofline Review API",
|
|
6345
|
-
"version": "
|
|
6428
|
+
"version": "7.0.0"
|
|
6346
6429
|
},
|
|
6347
6430
|
"openapi": "3.1.0",
|
|
6348
6431
|
"paths": {
|
|
@@ -7415,6 +7498,19 @@
|
|
|
7415
7498
|
},
|
|
7416
7499
|
"style": "form"
|
|
7417
7500
|
},
|
|
7501
|
+
{
|
|
7502
|
+
"description": "`only` lists repository audits; `none` leaves them out, so\n `kind=REVISION_SCAN&audits=none` lists plain revision scans.",
|
|
7503
|
+
"in": "query",
|
|
7504
|
+
"name": "audits",
|
|
7505
|
+
"schema": {
|
|
7506
|
+
"description": "`only` lists repository audits; `none` leaves them out, so\n `kind=REVISION_SCAN&audits=none` lists plain revision scans.",
|
|
7507
|
+
"type": [
|
|
7508
|
+
"string",
|
|
7509
|
+
"null"
|
|
7510
|
+
]
|
|
7511
|
+
},
|
|
7512
|
+
"style": "form"
|
|
7513
|
+
},
|
|
7418
7514
|
{
|
|
7419
7515
|
"description": "`mine` for the caller's own pull requests, or a GitHub user ID. `mine`\n needs a person's sign-in or token.",
|
|
7420
7516
|
"in": "query",
|
|
@@ -7687,6 +7783,19 @@
|
|
|
7687
7783
|
},
|
|
7688
7784
|
"style": "form"
|
|
7689
7785
|
},
|
|
7786
|
+
{
|
|
7787
|
+
"description": "`only` lists repository audits; `none` leaves them out, so\n `kind=REVISION_SCAN&audits=none` lists plain revision scans.",
|
|
7788
|
+
"in": "query",
|
|
7789
|
+
"name": "audits",
|
|
7790
|
+
"schema": {
|
|
7791
|
+
"description": "`only` lists repository audits; `none` leaves them out, so\n `kind=REVISION_SCAN&audits=none` lists plain revision scans.",
|
|
7792
|
+
"type": [
|
|
7793
|
+
"string",
|
|
7794
|
+
"null"
|
|
7795
|
+
]
|
|
7796
|
+
},
|
|
7797
|
+
"style": "form"
|
|
7798
|
+
},
|
|
7690
7799
|
{
|
|
7691
7800
|
"description": "`mine` for the caller's own pull requests, or a GitHub user ID. `mine`\n needs a person's sign-in or token.",
|
|
7692
7801
|
"in": "query",
|