@proofline/sdk 6.1.0 → 6.3.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 +45 -1
- package/dist/transport.js +1 -1
- package/openapi.public.json +70 -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.
|
|
@@ -1566,6 +1582,12 @@ export interface components {
|
|
|
1566
1582
|
pull_request_author_name?: string | null;
|
|
1567
1583
|
/** @description The author's profile on the deployment's GitHub host. Absent when no author login is known. */
|
|
1568
1584
|
pull_request_author_url?: string | null;
|
|
1585
|
+
/**
|
|
1586
|
+
* @description Whether the pull request is a draft, as provider state last reported
|
|
1587
|
+
* it. Display state only: an open draft keeps `pull_request_state` `OPEN`.
|
|
1588
|
+
* Absent when `pull_request_state` is.
|
|
1589
|
+
*/
|
|
1590
|
+
pull_request_draft?: boolean | null;
|
|
1569
1591
|
/**
|
|
1570
1592
|
* Format: int64
|
|
1571
1593
|
* @description The pull request number. Absent for a deployment or patch review.
|
|
@@ -1584,6 +1606,14 @@ export interface components {
|
|
|
1584
1606
|
pull_request_title?: string | null;
|
|
1585
1607
|
/** @description The pull request on GitHub. Absent for a deployment review or when the repository is unknown. */
|
|
1586
1608
|
pull_request_url?: string | null;
|
|
1609
|
+
/**
|
|
1610
|
+
* @description Why Proofline answers no question about this run: `FORK_PULL_REQUEST`
|
|
1611
|
+
* when the pull request is recorded as coming from a fork, whose
|
|
1612
|
+
* conversations the fork policy excludes whatever the run. Absent
|
|
1613
|
+
* otherwise, which does not mean a question will be answered: each one
|
|
1614
|
+
* is still checked for access and retained evidence.
|
|
1615
|
+
*/
|
|
1616
|
+
questions_unavailable_reason?: components["schemas"]["QuestionsUnavailableReason"] | null;
|
|
1587
1617
|
/**
|
|
1588
1618
|
* @description How this review decided what it reviews after a push or a full-review
|
|
1589
1619
|
* request. Absent for a review that refreshes nothing, and while a
|
|
@@ -1735,6 +1765,12 @@ export interface components {
|
|
|
1735
1765
|
run_number: number;
|
|
1736
1766
|
/** @description Severity used by the series count; the linked occurrence may be less severe. */
|
|
1737
1767
|
severity: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* @description The linked occurrence's title, which heads the series' GitHub thread.
|
|
1770
|
+
* Absent when the occurrence has none or its review withheld a value
|
|
1771
|
+
* from it, so no text that review kept off GitHub is shown here.
|
|
1772
|
+
*/
|
|
1773
|
+
title?: string | null;
|
|
1738
1774
|
};
|
|
1739
1775
|
/**
|
|
1740
1776
|
* @description One environment linked to the reviewed repository, and whether this
|
|
@@ -2620,6 +2656,8 @@ export interface components {
|
|
|
2620
2656
|
/** @description The current gate projection, including a recorded bypass or supersession by a newer head. */
|
|
2621
2657
|
status: components["schemas"]["GateStatus"];
|
|
2622
2658
|
};
|
|
2659
|
+
/** @enum {string} */
|
|
2660
|
+
QuestionsUnavailableReason: "FORK_PULL_REQUEST";
|
|
2623
2661
|
/** @description A recorded refresh decision, as the console shows it. */
|
|
2624
2662
|
RefreshView: {
|
|
2625
2663
|
/**
|
|
@@ -3076,6 +3114,12 @@ export interface components {
|
|
|
3076
3114
|
pull_request_author_name?: string | null;
|
|
3077
3115
|
/** @description The author's profile on the deployment's GitHub host. Absent when no author login is known. */
|
|
3078
3116
|
pull_request_author_url?: string | null;
|
|
3117
|
+
/**
|
|
3118
|
+
* @description Whether the pull request is a draft, as provider state last reported
|
|
3119
|
+
* it. Display state only: an open draft keeps `pull_request_state` `OPEN`.
|
|
3120
|
+
* Absent when `pull_request_state` is.
|
|
3121
|
+
*/
|
|
3122
|
+
pull_request_draft?: boolean | null;
|
|
3079
3123
|
/**
|
|
3080
3124
|
* Format: int64
|
|
3081
3125
|
* @description The pull request number. Absent for a deployment or patch review.
|
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"
|
|
@@ -1976,6 +2006,13 @@
|
|
|
1976
2006
|
"null"
|
|
1977
2007
|
]
|
|
1978
2008
|
},
|
|
2009
|
+
"pull_request_draft": {
|
|
2010
|
+
"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.",
|
|
2011
|
+
"type": [
|
|
2012
|
+
"boolean",
|
|
2013
|
+
"null"
|
|
2014
|
+
]
|
|
2015
|
+
},
|
|
1979
2016
|
"pull_request_number": {
|
|
1980
2017
|
"description": "The pull request number. Absent for a deployment or patch review.",
|
|
1981
2018
|
"format": "int64",
|
|
@@ -2005,6 +2042,17 @@
|
|
|
2005
2042
|
"null"
|
|
2006
2043
|
]
|
|
2007
2044
|
},
|
|
2045
|
+
"questions_unavailable_reason": {
|
|
2046
|
+
"anyOf": [
|
|
2047
|
+
{
|
|
2048
|
+
"$ref": "#/components/schemas/QuestionsUnavailableReason"
|
|
2049
|
+
},
|
|
2050
|
+
{
|
|
2051
|
+
"type": "null"
|
|
2052
|
+
}
|
|
2053
|
+
],
|
|
2054
|
+
"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."
|
|
2055
|
+
},
|
|
2008
2056
|
"refresh": {
|
|
2009
2057
|
"anyOf": [
|
|
2010
2058
|
{
|
|
@@ -2280,6 +2328,13 @@
|
|
|
2280
2328
|
"severity": {
|
|
2281
2329
|
"description": "Severity used by the series count; the linked occurrence may be less severe.",
|
|
2282
2330
|
"type": "string"
|
|
2331
|
+
},
|
|
2332
|
+
"title": {
|
|
2333
|
+
"description": "The linked occurrence's title, which heads the series' GitHub thread.\n Absent when the occurrence has none or its review withheld a value\n from it, so no text that review kept off GitHub is shown here.",
|
|
2334
|
+
"type": [
|
|
2335
|
+
"string",
|
|
2336
|
+
"null"
|
|
2337
|
+
]
|
|
2283
2338
|
}
|
|
2284
2339
|
},
|
|
2285
2340
|
"required": [
|
|
@@ -4271,6 +4326,12 @@
|
|
|
4271
4326
|
],
|
|
4272
4327
|
"type": "object"
|
|
4273
4328
|
},
|
|
4329
|
+
"QuestionsUnavailableReason": {
|
|
4330
|
+
"enum": [
|
|
4331
|
+
"FORK_PULL_REQUEST"
|
|
4332
|
+
],
|
|
4333
|
+
"type": "string"
|
|
4334
|
+
},
|
|
4274
4335
|
"RefreshView": {
|
|
4275
4336
|
"description": "A recorded refresh decision, as the console shows it.",
|
|
4276
4337
|
"properties": {
|
|
@@ -5038,6 +5099,13 @@
|
|
|
5038
5099
|
"null"
|
|
5039
5100
|
]
|
|
5040
5101
|
},
|
|
5102
|
+
"pull_request_draft": {
|
|
5103
|
+
"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.",
|
|
5104
|
+
"type": [
|
|
5105
|
+
"boolean",
|
|
5106
|
+
"null"
|
|
5107
|
+
]
|
|
5108
|
+
},
|
|
5041
5109
|
"pull_request_number": {
|
|
5042
5110
|
"description": "The pull request number. Absent for a deployment or patch review.",
|
|
5043
5111
|
"format": "int64",
|
|
@@ -6274,7 +6342,7 @@
|
|
|
6274
6342
|
},
|
|
6275
6343
|
"info": {
|
|
6276
6344
|
"title": "Proofline Review API",
|
|
6277
|
-
"version": "6.
|
|
6345
|
+
"version": "6.3.0"
|
|
6278
6346
|
},
|
|
6279
6347
|
"openapi": "3.1.0",
|
|
6280
6348
|
"paths": {
|
|
@@ -6557,7 +6625,7 @@
|
|
|
6557
6625
|
},
|
|
6558
6626
|
"/api/v1/organizations/{org_id}/findings/{finding_id}/agent-session-prompt": {
|
|
6559
6627
|
"get": {
|
|
6560
|
-
"description": "Returns the exact prompt and target a coding-agent session on this pull request finding would send, with every protected value withheld,
|
|
6628
|
+
"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.",
|
|
6561
6629
|
"operationId": "get_agent_session_prompt",
|
|
6562
6630
|
"parameters": [
|
|
6563
6631
|
{
|