@proofline/sdk 6.2.0 → 6.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 +63 -1
- package/dist/transport.js +1 -1
- package/openapi.public.json +103 -2
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -73,7 +73,7 @@ export interface paths {
|
|
|
73
73
|
};
|
|
74
74
|
/**
|
|
75
75
|
* Preview a coding-agent session
|
|
76
|
-
* @description Returns the exact prompt and target a coding-agent session on this pull request finding would send, with every protected value withheld,
|
|
76
|
+
* @description Returns the exact prompt and target a coding-agent session on this pull request finding would send, with every protected value withheld, the prompt digest a start names, and the ID and vendor of each active connection that allowlists the target repository. Requires access to every repository in the review.
|
|
77
77
|
*/
|
|
78
78
|
get: operations["get_agent_session_prompt"];
|
|
79
79
|
put?: never;
|
|
@@ -557,7 +557,23 @@ export interface components {
|
|
|
557
557
|
/** @description The session in the vendor's console. */
|
|
558
558
|
vendor_url?: string | null;
|
|
559
559
|
};
|
|
560
|
+
/** @description A vendor connection a session on the previewed target may use. */
|
|
561
|
+
AgentSessionConnection: {
|
|
562
|
+
/**
|
|
563
|
+
* Format: uuid
|
|
564
|
+
* @description The connection's ID, which a start names as `connection_id`.
|
|
565
|
+
*/
|
|
566
|
+
id: string;
|
|
567
|
+
/** @description The coding-agent vendor. */
|
|
568
|
+
vendor: components["schemas"]["AgentVendor"];
|
|
569
|
+
};
|
|
560
570
|
AgentSessionPrompt: {
|
|
571
|
+
/**
|
|
572
|
+
* @description The organization's active vendor connections that allowlist the
|
|
573
|
+
* target repository; absent when none does. A start names one of
|
|
574
|
+
* them as `connection_id`.
|
|
575
|
+
*/
|
|
576
|
+
connections?: components["schemas"]["AgentSessionConnection"][];
|
|
561
577
|
/**
|
|
562
578
|
* @description SHA-256 of `untrusted_text`. A start names it, so the session
|
|
563
579
|
* sends what the person confirmed.
|
|
@@ -1349,6 +1365,13 @@ export interface components {
|
|
|
1349
1365
|
assessment_count: number;
|
|
1350
1366
|
/** @description The environment assessments this review recorded. */
|
|
1351
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;
|
|
1352
1375
|
/**
|
|
1353
1376
|
* @description The base branch tip GitHub reported when the review was triggered,
|
|
1354
1377
|
* display metadata that differs from `base_commit_sha` when the base
|
|
@@ -1566,6 +1589,12 @@ export interface components {
|
|
|
1566
1589
|
pull_request_author_name?: string | null;
|
|
1567
1590
|
/** @description The author's profile on the deployment's GitHub host. Absent when no author login is known. */
|
|
1568
1591
|
pull_request_author_url?: string | null;
|
|
1592
|
+
/**
|
|
1593
|
+
* @description Whether the pull request is a draft, as provider state last reported
|
|
1594
|
+
* it. Display state only: an open draft keeps `pull_request_state` `OPEN`.
|
|
1595
|
+
* Absent when `pull_request_state` is.
|
|
1596
|
+
*/
|
|
1597
|
+
pull_request_draft?: boolean | null;
|
|
1569
1598
|
/**
|
|
1570
1599
|
* Format: int64
|
|
1571
1600
|
* @description The pull request number. Absent for a deployment or patch review.
|
|
@@ -1584,6 +1613,14 @@ export interface components {
|
|
|
1584
1613
|
pull_request_title?: string | null;
|
|
1585
1614
|
/** @description The pull request on GitHub. Absent for a deployment review or when the repository is unknown. */
|
|
1586
1615
|
pull_request_url?: string | null;
|
|
1616
|
+
/**
|
|
1617
|
+
* @description Why Proofline answers no question about this run: `FORK_PULL_REQUEST`
|
|
1618
|
+
* when the pull request is recorded as coming from a fork, whose
|
|
1619
|
+
* conversations the fork policy excludes whatever the run. Absent
|
|
1620
|
+
* otherwise, which does not mean a question will be answered: each one
|
|
1621
|
+
* is still checked for access and retained evidence.
|
|
1622
|
+
*/
|
|
1623
|
+
questions_unavailable_reason?: components["schemas"]["QuestionsUnavailableReason"] | null;
|
|
1587
1624
|
/**
|
|
1588
1625
|
* @description How this review decided what it reviews after a push or a full-review
|
|
1589
1626
|
* request. Absent for a review that refreshes nothing, and while a
|
|
@@ -2626,6 +2663,8 @@ export interface components {
|
|
|
2626
2663
|
/** @description The current gate projection, including a recorded bypass or supersession by a newer head. */
|
|
2627
2664
|
status: components["schemas"]["GateStatus"];
|
|
2628
2665
|
};
|
|
2666
|
+
/** @enum {string} */
|
|
2667
|
+
QuestionsUnavailableReason: "FORK_PULL_REQUEST";
|
|
2629
2668
|
/** @description A recorded refresh decision, as the console shows it. */
|
|
2630
2669
|
RefreshView: {
|
|
2631
2670
|
/**
|
|
@@ -2989,6 +3028,13 @@ export interface components {
|
|
|
2989
3028
|
* @description How many environment assessments this review has.
|
|
2990
3029
|
*/
|
|
2991
3030
|
assessment_count: number;
|
|
3031
|
+
/**
|
|
3032
|
+
* @description The repository audit's mode, `CODE_ONLY` or `INFRASTRUCTURE_AWARE`,
|
|
3033
|
+
* when this `REVISION_SCAN` is an audit. An audit's findings are in its
|
|
3034
|
+
* audit report, not in `finding_count` or the review's assessments.
|
|
3035
|
+
* Null for every other review.
|
|
3036
|
+
*/
|
|
3037
|
+
audit_mode?: string | null;
|
|
2992
3038
|
/**
|
|
2993
3039
|
* Format: date-time
|
|
2994
3040
|
* @description When the review reached a terminal status. Absent while it is still pending or running.
|
|
@@ -3082,6 +3128,12 @@ export interface components {
|
|
|
3082
3128
|
pull_request_author_name?: string | null;
|
|
3083
3129
|
/** @description The author's profile on the deployment's GitHub host. Absent when no author login is known. */
|
|
3084
3130
|
pull_request_author_url?: string | null;
|
|
3131
|
+
/**
|
|
3132
|
+
* @description Whether the pull request is a draft, as provider state last reported
|
|
3133
|
+
* it. Display state only: an open draft keeps `pull_request_state` `OPEN`.
|
|
3134
|
+
* Absent when `pull_request_state` is.
|
|
3135
|
+
*/
|
|
3136
|
+
pull_request_draft?: boolean | null;
|
|
3085
3137
|
/**
|
|
3086
3138
|
* Format: int64
|
|
3087
3139
|
* @description The pull request number. Absent for a deployment or patch review.
|
|
@@ -4328,6 +4380,11 @@ export interface operations {
|
|
|
4328
4380
|
* findings, FAILED/INCOMPLETE/STOPPED execution, or an earlier reviewed commit.
|
|
4329
4381
|
*/
|
|
4330
4382
|
attention?: string | null;
|
|
4383
|
+
/**
|
|
4384
|
+
* @description `only` lists repository audits; `none` leaves them out, so
|
|
4385
|
+
* `kind=REVISION_SCAN&audits=none` lists plain revision scans.
|
|
4386
|
+
*/
|
|
4387
|
+
audits?: string | null;
|
|
4331
4388
|
/**
|
|
4332
4389
|
* @description `mine` for the caller's own pull requests, or a GitHub user ID. `mine`
|
|
4333
4390
|
* needs a person's sign-in or token.
|
|
@@ -4422,6 +4479,11 @@ export interface operations {
|
|
|
4422
4479
|
* findings, FAILED/INCOMPLETE/STOPPED execution, or an earlier reviewed commit.
|
|
4423
4480
|
*/
|
|
4424
4481
|
attention?: string | null;
|
|
4482
|
+
/**
|
|
4483
|
+
* @description `only` lists repository audits; `none` leaves them out, so
|
|
4484
|
+
* `kind=REVISION_SCAN&audits=none` lists plain revision scans.
|
|
4485
|
+
*/
|
|
4486
|
+
audits?: string | null;
|
|
4425
4487
|
/**
|
|
4426
4488
|
* @description `mine` for the caller's own pull requests, or a GitHub user ID. `mine`
|
|
4427
4489
|
* needs a person's sign-in or token.
|
package/dist/transport.js
CHANGED
package/openapi.public.json
CHANGED
|
@@ -168,10 +168,40 @@
|
|
|
168
168
|
],
|
|
169
169
|
"type": "object"
|
|
170
170
|
},
|
|
171
|
+
"AgentSessionConnection": {
|
|
172
|
+
"description": "A vendor connection a session on the previewed target may use.",
|
|
173
|
+
"properties": {
|
|
174
|
+
"id": {
|
|
175
|
+
"description": "The connection's ID, which a start names as `connection_id`.",
|
|
176
|
+
"format": "uuid",
|
|
177
|
+
"type": "string"
|
|
178
|
+
},
|
|
179
|
+
"vendor": {
|
|
180
|
+
"allOf": [
|
|
181
|
+
{
|
|
182
|
+
"$ref": "#/components/schemas/AgentVendor"
|
|
183
|
+
}
|
|
184
|
+
],
|
|
185
|
+
"description": "The coding-agent vendor."
|
|
186
|
+
}
|
|
187
|
+
},
|
|
188
|
+
"required": [
|
|
189
|
+
"id",
|
|
190
|
+
"vendor"
|
|
191
|
+
],
|
|
192
|
+
"type": "object"
|
|
193
|
+
},
|
|
171
194
|
"AgentSessionPrompt": {
|
|
172
195
|
"oneOf": [
|
|
173
196
|
{
|
|
174
197
|
"properties": {
|
|
198
|
+
"connections": {
|
|
199
|
+
"description": "The organization's active vendor connections that allowlist the\n target repository; absent when none does. A start names one of\n them as `connection_id`.",
|
|
200
|
+
"items": {
|
|
201
|
+
"$ref": "#/components/schemas/AgentSessionConnection"
|
|
202
|
+
},
|
|
203
|
+
"type": "array"
|
|
204
|
+
},
|
|
175
205
|
"prompt_digest": {
|
|
176
206
|
"description": "SHA-256 of `untrusted_text`. A start names it, so the session\n sends what the person confirmed.",
|
|
177
207
|
"type": "string"
|
|
@@ -1663,6 +1693,13 @@
|
|
|
1663
1693
|
},
|
|
1664
1694
|
"type": "array"
|
|
1665
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
|
+
},
|
|
1666
1703
|
"base_branch_commit_sha": {
|
|
1667
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.",
|
|
1668
1705
|
"type": [
|
|
@@ -1976,6 +2013,13 @@
|
|
|
1976
2013
|
"null"
|
|
1977
2014
|
]
|
|
1978
2015
|
},
|
|
2016
|
+
"pull_request_draft": {
|
|
2017
|
+
"description": "Whether the pull request is a draft, as provider state last reported\n it. Display state only: an open draft keeps `pull_request_state` `OPEN`.\n Absent when `pull_request_state` is.",
|
|
2018
|
+
"type": [
|
|
2019
|
+
"boolean",
|
|
2020
|
+
"null"
|
|
2021
|
+
]
|
|
2022
|
+
},
|
|
1979
2023
|
"pull_request_number": {
|
|
1980
2024
|
"description": "The pull request number. Absent for a deployment or patch review.",
|
|
1981
2025
|
"format": "int64",
|
|
@@ -2005,6 +2049,17 @@
|
|
|
2005
2049
|
"null"
|
|
2006
2050
|
]
|
|
2007
2051
|
},
|
|
2052
|
+
"questions_unavailable_reason": {
|
|
2053
|
+
"anyOf": [
|
|
2054
|
+
{
|
|
2055
|
+
"$ref": "#/components/schemas/QuestionsUnavailableReason"
|
|
2056
|
+
},
|
|
2057
|
+
{
|
|
2058
|
+
"type": "null"
|
|
2059
|
+
}
|
|
2060
|
+
],
|
|
2061
|
+
"description": "Why Proofline answers no question about this run: `FORK_PULL_REQUEST`\n when the pull request is recorded as coming from a fork, whose\n conversations the fork policy excludes whatever the run. Absent\n otherwise, which does not mean a question will be answered: each one\n is still checked for access and retained evidence."
|
|
2062
|
+
},
|
|
2008
2063
|
"refresh": {
|
|
2009
2064
|
"anyOf": [
|
|
2010
2065
|
{
|
|
@@ -4278,6 +4333,12 @@
|
|
|
4278
4333
|
],
|
|
4279
4334
|
"type": "object"
|
|
4280
4335
|
},
|
|
4336
|
+
"QuestionsUnavailableReason": {
|
|
4337
|
+
"enum": [
|
|
4338
|
+
"FORK_PULL_REQUEST"
|
|
4339
|
+
],
|
|
4340
|
+
"type": "string"
|
|
4341
|
+
},
|
|
4281
4342
|
"RefreshView": {
|
|
4282
4343
|
"description": "A recorded refresh decision, as the console shows it.",
|
|
4283
4344
|
"properties": {
|
|
@@ -4917,6 +4978,13 @@
|
|
|
4917
4978
|
"format": "int64",
|
|
4918
4979
|
"type": "integer"
|
|
4919
4980
|
},
|
|
4981
|
+
"audit_mode": {
|
|
4982
|
+
"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.",
|
|
4983
|
+
"type": [
|
|
4984
|
+
"string",
|
|
4985
|
+
"null"
|
|
4986
|
+
]
|
|
4987
|
+
},
|
|
4920
4988
|
"completed_at": {
|
|
4921
4989
|
"description": "When the review reached a terminal status. Absent while it is still pending or running.",
|
|
4922
4990
|
"format": "date-time",
|
|
@@ -5045,6 +5113,13 @@
|
|
|
5045
5113
|
"null"
|
|
5046
5114
|
]
|
|
5047
5115
|
},
|
|
5116
|
+
"pull_request_draft": {
|
|
5117
|
+
"description": "Whether the pull request is a draft, as provider state last reported\n it. Display state only: an open draft keeps `pull_request_state` `OPEN`.\n Absent when `pull_request_state` is.",
|
|
5118
|
+
"type": [
|
|
5119
|
+
"boolean",
|
|
5120
|
+
"null"
|
|
5121
|
+
]
|
|
5122
|
+
},
|
|
5048
5123
|
"pull_request_number": {
|
|
5049
5124
|
"description": "The pull request number. Absent for a deployment or patch review.",
|
|
5050
5125
|
"format": "int64",
|
|
@@ -6281,7 +6356,7 @@
|
|
|
6281
6356
|
},
|
|
6282
6357
|
"info": {
|
|
6283
6358
|
"title": "Proofline Review API",
|
|
6284
|
-
"version": "6.
|
|
6359
|
+
"version": "6.4.0"
|
|
6285
6360
|
},
|
|
6286
6361
|
"openapi": "3.1.0",
|
|
6287
6362
|
"paths": {
|
|
@@ -6564,7 +6639,7 @@
|
|
|
6564
6639
|
},
|
|
6565
6640
|
"/api/v1/organizations/{org_id}/findings/{finding_id}/agent-session-prompt": {
|
|
6566
6641
|
"get": {
|
|
6567
|
-
"description": "Returns the exact prompt and target a coding-agent session on this pull request finding would send, with every protected value withheld,
|
|
6642
|
+
"description": "Returns the exact prompt and target a coding-agent session on this pull request finding would send, with every protected value withheld, the prompt digest a start names, and the ID and vendor of each active connection that allowlists the target repository. Requires access to every repository in the review.",
|
|
6568
6643
|
"operationId": "get_agent_session_prompt",
|
|
6569
6644
|
"parameters": [
|
|
6570
6645
|
{
|
|
@@ -7354,6 +7429,19 @@
|
|
|
7354
7429
|
},
|
|
7355
7430
|
"style": "form"
|
|
7356
7431
|
},
|
|
7432
|
+
{
|
|
7433
|
+
"description": "`only` lists repository audits; `none` leaves them out, so\n `kind=REVISION_SCAN&audits=none` lists plain revision scans.",
|
|
7434
|
+
"in": "query",
|
|
7435
|
+
"name": "audits",
|
|
7436
|
+
"schema": {
|
|
7437
|
+
"description": "`only` lists repository audits; `none` leaves them out, so\n `kind=REVISION_SCAN&audits=none` lists plain revision scans.",
|
|
7438
|
+
"type": [
|
|
7439
|
+
"string",
|
|
7440
|
+
"null"
|
|
7441
|
+
]
|
|
7442
|
+
},
|
|
7443
|
+
"style": "form"
|
|
7444
|
+
},
|
|
7357
7445
|
{
|
|
7358
7446
|
"description": "`mine` for the caller's own pull requests, or a GitHub user ID. `mine`\n needs a person's sign-in or token.",
|
|
7359
7447
|
"in": "query",
|
|
@@ -7626,6 +7714,19 @@
|
|
|
7626
7714
|
},
|
|
7627
7715
|
"style": "form"
|
|
7628
7716
|
},
|
|
7717
|
+
{
|
|
7718
|
+
"description": "`only` lists repository audits; `none` leaves them out, so\n `kind=REVISION_SCAN&audits=none` lists plain revision scans.",
|
|
7719
|
+
"in": "query",
|
|
7720
|
+
"name": "audits",
|
|
7721
|
+
"schema": {
|
|
7722
|
+
"description": "`only` lists repository audits; `none` leaves them out, so\n `kind=REVISION_SCAN&audits=none` lists plain revision scans.",
|
|
7723
|
+
"type": [
|
|
7724
|
+
"string",
|
|
7725
|
+
"null"
|
|
7726
|
+
]
|
|
7727
|
+
},
|
|
7728
|
+
"style": "form"
|
|
7729
|
+
},
|
|
7629
7730
|
{
|
|
7630
7731
|
"description": "`mine` for the caller's own pull requests, or a GitHub user ID. `mine`\n needs a person's sign-in or token.",
|
|
7631
7732
|
"in": "query",
|