@proofline/sdk 5.2.0 → 5.4.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 +61 -2
- package/dist/transport.js +1 -1
- package/openapi.public.json +148 -2
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -1365,6 +1365,13 @@ export interface components {
|
|
|
1365
1365
|
* @description When the review reached a terminal status. Absent while it is still pending or running.
|
|
1366
1366
|
*/
|
|
1367
1367
|
completed_at?: string | null;
|
|
1368
|
+
/**
|
|
1369
|
+
* Format: int64
|
|
1370
|
+
* @description The credits this run was charged so far, in microcredits, whoever
|
|
1371
|
+
* paid: the plan, the free review month or the organization's credits.
|
|
1372
|
+
* Null for a caller who is not a member of the organization.
|
|
1373
|
+
*/
|
|
1374
|
+
cost_microcredits?: number | null;
|
|
1368
1375
|
/**
|
|
1369
1376
|
* Format: date-time
|
|
1370
1377
|
* @description When the review was created.
|
|
@@ -1384,6 +1391,13 @@ export interface components {
|
|
|
1384
1391
|
diff_stats?: components["schemas"]["ReviewDiffStats"] | null;
|
|
1385
1392
|
/** @description Display names of this review's assessed environments, not current repository links. */
|
|
1386
1393
|
environment_display_names: string[];
|
|
1394
|
+
/**
|
|
1395
|
+
* @description For a pull-request review, each environment its repository linked
|
|
1396
|
+
* when the review was created and each environment it assessed, with
|
|
1397
|
+
* whether the review checked it and why not. Absent for any other
|
|
1398
|
+
* review, and when the repository links no environment.
|
|
1399
|
+
*/
|
|
1400
|
+
environments?: components["schemas"]["EnvironmentCheck"][];
|
|
1387
1401
|
/**
|
|
1388
1402
|
* Format: int64
|
|
1389
1403
|
* @description How many findings this review's assessments recorded, across all of them.
|
|
@@ -1415,6 +1429,13 @@ export interface components {
|
|
|
1415
1429
|
* @description The review's identifier.
|
|
1416
1430
|
*/
|
|
1417
1431
|
id: string;
|
|
1432
|
+
/**
|
|
1433
|
+
* @description Why an `INCOMPLETE` review ended incomplete, as its incomplete
|
|
1434
|
+
* assessments recorded it, in name order. `UNKNOWN` alone when none
|
|
1435
|
+
* recorded a cause. Absent for every other status, and on reads other
|
|
1436
|
+
* than the reviews list and a single review.
|
|
1437
|
+
*/
|
|
1438
|
+
incomplete_causes?: components["schemas"]["IncompleteCause"][];
|
|
1418
1439
|
/** @description Present and true when this run is a Deep Review. */
|
|
1419
1440
|
is_deep_review?: boolean;
|
|
1420
1441
|
/**
|
|
@@ -1534,8 +1555,10 @@ export interface components {
|
|
|
1534
1555
|
*/
|
|
1535
1556
|
repository_url?: string | null;
|
|
1536
1557
|
/**
|
|
1537
|
-
* @description Who asked for this review, for
|
|
1538
|
-
*
|
|
1558
|
+
* @description Who asked for this review, for the reviews a person asked for: the
|
|
1559
|
+
* run-now button, a rerun, a pull request `review` command, or local
|
|
1560
|
+
* changes and pushed commits sent from the CLI or an editor. Absent on
|
|
1561
|
+
* automatic reviews, and on reviews recorded before requesters were.
|
|
1539
1562
|
*/
|
|
1540
1563
|
requested_by?: components["schemas"]["ActorView"] | null;
|
|
1541
1564
|
/**
|
|
@@ -1652,6 +1675,23 @@ export interface components {
|
|
|
1652
1675
|
/** @description Severity used by the series count; the linked occurrence may be less severe. */
|
|
1653
1676
|
severity: string;
|
|
1654
1677
|
};
|
|
1678
|
+
/**
|
|
1679
|
+
* @description One environment linked to the reviewed repository, and whether this
|
|
1680
|
+
* review checked it.
|
|
1681
|
+
*/
|
|
1682
|
+
EnvironmentCheck: {
|
|
1683
|
+
/** @description The environment's display name. */
|
|
1684
|
+
environment_display_name: string;
|
|
1685
|
+
/**
|
|
1686
|
+
* @description Why the environment was not checked or does not apply. Null when it
|
|
1687
|
+
* was checked or its check is still running.
|
|
1688
|
+
*/
|
|
1689
|
+
reason?: components["schemas"]["EnvironmentCheckReason"] | null;
|
|
1690
|
+
/** @description Whether this review checked the environment. */
|
|
1691
|
+
state: components["schemas"]["EnvironmentCheckState"];
|
|
1692
|
+
};
|
|
1693
|
+
EnvironmentCheckReason: "NOT_COVERED" | "FORK_PULL_REQUEST" | "UNFINISHED" | "ENDED" | "PULL_REQUEST_REVIEWS_OFF";
|
|
1694
|
+
EnvironmentCheckState: "CHECKED" | "CHECKING" | "NOT_CHECKED" | "NOT_APPLICABLE";
|
|
1655
1695
|
/** @enum {string} */
|
|
1656
1696
|
ExportEvidenceKind: "repository_file" | "repository_file_at_commit" | "companion_repository_file" | "commit" | "workflow_run" | "world_entity" | "deterministic_test" | "recorded_read" | "text";
|
|
1657
1697
|
ExportEvidenceRef: {
|
|
@@ -2129,6 +2169,11 @@ export interface components {
|
|
|
2129
2169
|
};
|
|
2130
2170
|
/** @enum {string} */
|
|
2131
2171
|
GateStatus: "REQUESTED" | "EVALUATING" | "ALLOWED" | "BLOCKED" | "BYPASSED" | "SUPERSEDED";
|
|
2172
|
+
/**
|
|
2173
|
+
* @description Why an assessment of the review ended incomplete, as the assessment
|
|
2174
|
+
* recorded it (`incompleteness_kind`), or `UNKNOWN` when none did.
|
|
2175
|
+
*/
|
|
2176
|
+
IncompleteCause: ("NOT_CONFIGURED" | "POLICY_EXCLUDED" | "EVIDENCE_UNAVAILABLE" | "HYPOTHESES_UNRESOLVED" | "MODEL_BUDGET_EXHAUSTED") | "UNKNOWN";
|
|
2132
2177
|
/**
|
|
2133
2178
|
* @description One finding a patch review re-verified against the patch. The outcome is
|
|
2134
2179
|
* local: the pull request's finding is unchanged whatever it is.
|
|
@@ -2855,6 +2900,13 @@ export interface components {
|
|
|
2855
2900
|
* @description The review's identifier.
|
|
2856
2901
|
*/
|
|
2857
2902
|
id: string;
|
|
2903
|
+
/**
|
|
2904
|
+
* @description Why an `INCOMPLETE` review ended incomplete, as its incomplete
|
|
2905
|
+
* assessments recorded it, in name order. `UNKNOWN` alone when none
|
|
2906
|
+
* recorded a cause. Absent for every other status, and on reads other
|
|
2907
|
+
* than the reviews list and a single review.
|
|
2908
|
+
*/
|
|
2909
|
+
incomplete_causes?: components["schemas"]["IncompleteCause"][];
|
|
2858
2910
|
/**
|
|
2859
2911
|
* @description `PULL_REQUEST`, `DEPLOYMENT`, `PATCH`, a review of local changes
|
|
2860
2912
|
* sent as a patch, `COMMIT`, a review of pushed commits, `FILES`,
|
|
@@ -2937,6 +2989,13 @@ export interface components {
|
|
|
2937
2989
|
* cannot be joined with the stored name.
|
|
2938
2990
|
*/
|
|
2939
2991
|
repository_url?: string | null;
|
|
2992
|
+
/**
|
|
2993
|
+
* @description Who asked for this review, for the reviews a person asked for: the
|
|
2994
|
+
* run-now button, a rerun, a pull request `review` command, or local
|
|
2995
|
+
* changes and pushed commits sent from the CLI or an editor. Absent on
|
|
2996
|
+
* automatic reviews, and on reviews recorded before requesters were.
|
|
2997
|
+
*/
|
|
2998
|
+
requested_by?: components["schemas"]["ActorView"] | null;
|
|
2940
2999
|
/**
|
|
2941
3000
|
* Format: int64
|
|
2942
3001
|
* @description One-based, append-only ordinal within one repository pull request.
|
package/dist/transport.js
CHANGED
package/openapi.public.json
CHANGED
|
@@ -1674,6 +1674,14 @@
|
|
|
1674
1674
|
"null"
|
|
1675
1675
|
]
|
|
1676
1676
|
},
|
|
1677
|
+
"cost_microcredits": {
|
|
1678
|
+
"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.",
|
|
1679
|
+
"format": "int64",
|
|
1680
|
+
"type": [
|
|
1681
|
+
"integer",
|
|
1682
|
+
"null"
|
|
1683
|
+
]
|
|
1684
|
+
},
|
|
1677
1685
|
"created_at": {
|
|
1678
1686
|
"description": "When the review was created.",
|
|
1679
1687
|
"format": "date-time",
|
|
@@ -1715,6 +1723,13 @@
|
|
|
1715
1723
|
},
|
|
1716
1724
|
"type": "array"
|
|
1717
1725
|
},
|
|
1726
|
+
"environments": {
|
|
1727
|
+
"description": "For a pull-request review, each environment its repository linked\n when the review was created and each environment it assessed, with\n whether the review checked it and why not. Absent for any other\n review, and when the repository links no environment.",
|
|
1728
|
+
"items": {
|
|
1729
|
+
"$ref": "#/components/schemas/EnvironmentCheck"
|
|
1730
|
+
},
|
|
1731
|
+
"type": "array"
|
|
1732
|
+
},
|
|
1718
1733
|
"finding_count": {
|
|
1719
1734
|
"description": "How many findings this review's assessments recorded, across all of them.",
|
|
1720
1735
|
"format": "int64",
|
|
@@ -1750,6 +1765,13 @@
|
|
|
1750
1765
|
"format": "uuid",
|
|
1751
1766
|
"type": "string"
|
|
1752
1767
|
},
|
|
1768
|
+
"incomplete_causes": {
|
|
1769
|
+
"description": "Why an `INCOMPLETE` review ended incomplete, as its incomplete\n assessments recorded it, in name order. `UNKNOWN` alone when none\n recorded a cause. Absent for every other status, and on reads other\n than the reviews list and a single review.",
|
|
1770
|
+
"items": {
|
|
1771
|
+
"$ref": "#/components/schemas/IncompleteCause"
|
|
1772
|
+
},
|
|
1773
|
+
"type": "array"
|
|
1774
|
+
},
|
|
1753
1775
|
"is_deep_review": {
|
|
1754
1776
|
"description": "Present and true when this run is a Deep Review.",
|
|
1755
1777
|
"type": "boolean"
|
|
@@ -1953,7 +1975,7 @@
|
|
|
1953
1975
|
"type": "null"
|
|
1954
1976
|
}
|
|
1955
1977
|
],
|
|
1956
|
-
"description": "Who asked for this review, for
|
|
1978
|
+
"description": "Who asked for this review, for the reviews a person asked for: the\n run-now button, a rerun, a pull request `review` command, or local\n changes and pushed commits sent from the CLI or an editor. Absent on\n automatic reviews, and on reviews recorded before requesters were."
|
|
1957
1979
|
},
|
|
1958
1980
|
"review_comment_url": {
|
|
1959
1981
|
"description": "The pull request review Proofline submitted for this review. Null when\n it submitted none.",
|
|
@@ -2172,6 +2194,92 @@
|
|
|
2172
2194
|
],
|
|
2173
2195
|
"type": "object"
|
|
2174
2196
|
},
|
|
2197
|
+
"EnvironmentCheck": {
|
|
2198
|
+
"description": "One environment linked to the reviewed repository, and whether this\n review checked it.",
|
|
2199
|
+
"properties": {
|
|
2200
|
+
"environment_display_name": {
|
|
2201
|
+
"description": "The environment's display name.",
|
|
2202
|
+
"type": "string"
|
|
2203
|
+
},
|
|
2204
|
+
"reason": {
|
|
2205
|
+
"anyOf": [
|
|
2206
|
+
{
|
|
2207
|
+
"$ref": "#/components/schemas/EnvironmentCheckReason"
|
|
2208
|
+
},
|
|
2209
|
+
{
|
|
2210
|
+
"type": "null"
|
|
2211
|
+
}
|
|
2212
|
+
],
|
|
2213
|
+
"description": "Why the environment was not checked or does not apply. Null when it\n was checked or its check is still running."
|
|
2214
|
+
},
|
|
2215
|
+
"state": {
|
|
2216
|
+
"allOf": [
|
|
2217
|
+
{
|
|
2218
|
+
"$ref": "#/components/schemas/EnvironmentCheckState"
|
|
2219
|
+
}
|
|
2220
|
+
],
|
|
2221
|
+
"description": "Whether this review checked the environment."
|
|
2222
|
+
}
|
|
2223
|
+
},
|
|
2224
|
+
"required": [
|
|
2225
|
+
"environment_display_name",
|
|
2226
|
+
"state"
|
|
2227
|
+
],
|
|
2228
|
+
"type": "object"
|
|
2229
|
+
},
|
|
2230
|
+
"EnvironmentCheckReason": {
|
|
2231
|
+
"oneOf": [
|
|
2232
|
+
{
|
|
2233
|
+
"const": "NOT_COVERED",
|
|
2234
|
+
"description": "`NOT_CHECKED`: Proofline does not check this environment for pull\n requests, so the review assessed its code only.",
|
|
2235
|
+
"type": "string"
|
|
2236
|
+
},
|
|
2237
|
+
{
|
|
2238
|
+
"const": "FORK_PULL_REQUEST",
|
|
2239
|
+
"description": "`NOT_CHECKED`: the pull request comes from a fork, which Proofline\n does not check against an environment.",
|
|
2240
|
+
"type": "string"
|
|
2241
|
+
},
|
|
2242
|
+
{
|
|
2243
|
+
"const": "UNFINISHED",
|
|
2244
|
+
"description": "`NOT_CHECKED`: the environment's assessment did not finish.",
|
|
2245
|
+
"type": "string"
|
|
2246
|
+
},
|
|
2247
|
+
{
|
|
2248
|
+
"const": "ENDED",
|
|
2249
|
+
"description": "`NOT_CHECKED`: the review or the assessment stopped before the\n environment was checked.",
|
|
2250
|
+
"type": "string"
|
|
2251
|
+
},
|
|
2252
|
+
{
|
|
2253
|
+
"const": "PULL_REQUEST_REVIEWS_OFF",
|
|
2254
|
+
"description": "`NOT_APPLICABLE`: pull request reviews are off on this repository's\n link to the environment.",
|
|
2255
|
+
"type": "string"
|
|
2256
|
+
}
|
|
2257
|
+
]
|
|
2258
|
+
},
|
|
2259
|
+
"EnvironmentCheckState": {
|
|
2260
|
+
"oneOf": [
|
|
2261
|
+
{
|
|
2262
|
+
"const": "CHECKED",
|
|
2263
|
+
"description": "The environment's assessment finished.",
|
|
2264
|
+
"type": "string"
|
|
2265
|
+
},
|
|
2266
|
+
{
|
|
2267
|
+
"const": "CHECKING",
|
|
2268
|
+
"description": "The environment's assessment is still running.",
|
|
2269
|
+
"type": "string"
|
|
2270
|
+
},
|
|
2271
|
+
{
|
|
2272
|
+
"const": "NOT_CHECKED",
|
|
2273
|
+
"description": "The review did not check the environment; `reason` says why.",
|
|
2274
|
+
"type": "string"
|
|
2275
|
+
},
|
|
2276
|
+
{
|
|
2277
|
+
"const": "NOT_APPLICABLE",
|
|
2278
|
+
"description": "The repository's link to the environment does not ask for pull\n request reviews; `reason` says so.",
|
|
2279
|
+
"type": "string"
|
|
2280
|
+
}
|
|
2281
|
+
]
|
|
2282
|
+
},
|
|
2175
2283
|
"ExportEvidenceKind": {
|
|
2176
2284
|
"enum": [
|
|
2177
2285
|
"repository_file",
|
|
@@ -3267,6 +3375,26 @@
|
|
|
3267
3375
|
],
|
|
3268
3376
|
"type": "string"
|
|
3269
3377
|
},
|
|
3378
|
+
"IncompleteCause": {
|
|
3379
|
+
"description": "Why an assessment of the review ended incomplete, as the assessment\n recorded it (`incompleteness_kind`), or `UNKNOWN` when none did.",
|
|
3380
|
+
"oneOf": [
|
|
3381
|
+
{
|
|
3382
|
+
"enum": [
|
|
3383
|
+
"NOT_CONFIGURED",
|
|
3384
|
+
"POLICY_EXCLUDED",
|
|
3385
|
+
"EVIDENCE_UNAVAILABLE",
|
|
3386
|
+
"HYPOTHESES_UNRESOLVED",
|
|
3387
|
+
"MODEL_BUDGET_EXHAUSTED"
|
|
3388
|
+
],
|
|
3389
|
+
"type": "string"
|
|
3390
|
+
},
|
|
3391
|
+
{
|
|
3392
|
+
"const": "UNKNOWN",
|
|
3393
|
+
"description": "The review ended incomplete and no assessment recorded why.",
|
|
3394
|
+
"type": "string"
|
|
3395
|
+
}
|
|
3396
|
+
]
|
|
3397
|
+
},
|
|
3270
3398
|
"LocalReverification": {
|
|
3271
3399
|
"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.",
|
|
3272
3400
|
"properties": {
|
|
@@ -4626,6 +4754,13 @@
|
|
|
4626
4754
|
"format": "uuid",
|
|
4627
4755
|
"type": "string"
|
|
4628
4756
|
},
|
|
4757
|
+
"incomplete_causes": {
|
|
4758
|
+
"description": "Why an `INCOMPLETE` review ended incomplete, as its incomplete\n assessments recorded it, in name order. `UNKNOWN` alone when none\n recorded a cause. Absent for every other status, and on reads other\n than the reviews list and a single review.",
|
|
4759
|
+
"items": {
|
|
4760
|
+
"$ref": "#/components/schemas/IncompleteCause"
|
|
4761
|
+
},
|
|
4762
|
+
"type": "array"
|
|
4763
|
+
},
|
|
4629
4764
|
"kind": {
|
|
4630
4765
|
"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.",
|
|
4631
4766
|
"type": "string"
|
|
@@ -4758,6 +4893,17 @@
|
|
|
4758
4893
|
"null"
|
|
4759
4894
|
]
|
|
4760
4895
|
},
|
|
4896
|
+
"requested_by": {
|
|
4897
|
+
"anyOf": [
|
|
4898
|
+
{
|
|
4899
|
+
"$ref": "#/components/schemas/ActorView"
|
|
4900
|
+
},
|
|
4901
|
+
{
|
|
4902
|
+
"type": "null"
|
|
4903
|
+
}
|
|
4904
|
+
],
|
|
4905
|
+
"description": "Who asked for this review, for the reviews a person asked for: the\n run-now button, a rerun, a pull request `review` command, or local\n changes and pushed commits sent from the CLI or an editor. Absent on\n automatic reviews, and on reviews recorded before requesters were."
|
|
4906
|
+
},
|
|
4761
4907
|
"run_number": {
|
|
4762
4908
|
"description": "One-based, append-only ordinal within one repository pull request.",
|
|
4763
4909
|
"format": "int64",
|
|
@@ -5850,7 +5996,7 @@
|
|
|
5850
5996
|
},
|
|
5851
5997
|
"info": {
|
|
5852
5998
|
"title": "Proofline Review API",
|
|
5853
|
-
"version": "5.
|
|
5999
|
+
"version": "5.4.0"
|
|
5854
6000
|
},
|
|
5855
6001
|
"openapi": "3.1.0",
|
|
5856
6002
|
"paths": {
|