@proofline/sdk 5.8.0 → 5.9.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 +34 -0
- package/dist/transport.js +1 -1
- package/openapi.public.json +76 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -1623,6 +1623,12 @@ export interface components {
|
|
|
1623
1623
|
* @description One-based, append-only ordinal within one repository pull request.
|
|
1624
1624
|
*/
|
|
1625
1625
|
run_number?: number | null;
|
|
1626
|
+
/**
|
|
1627
|
+
* @description Where an unfinished review's runs stand: running, queued for a worker,
|
|
1628
|
+
* waiting for a scheduled step, or due again after an attempt that did
|
|
1629
|
+
* not finish. Null once the review has ended.
|
|
1630
|
+
*/
|
|
1631
|
+
run_progress?: components["schemas"]["RunProgress"] | null;
|
|
1626
1632
|
/** @description The review's lifecycle status: `PENDING`, `RUNNING`, `COMPLETED`, `INCOMPLETE`, `FAILED`, `SUPERSEDED`, `STOPPED` or `EXCLUDED`. */
|
|
1627
1633
|
status: string;
|
|
1628
1634
|
/**
|
|
@@ -3279,6 +3285,34 @@ export interface components {
|
|
|
3279
3285
|
*/
|
|
3280
3286
|
run_number: number;
|
|
3281
3287
|
};
|
|
3288
|
+
/** @description Where an unfinished review's runs stand. */
|
|
3289
|
+
RunProgress: {
|
|
3290
|
+
/**
|
|
3291
|
+
* Format: int32
|
|
3292
|
+
* @description Attempts begun by the run in `state`, counting worker claims.
|
|
3293
|
+
*/
|
|
3294
|
+
attempts: number;
|
|
3295
|
+
/**
|
|
3296
|
+
* Format: date-time
|
|
3297
|
+
* @description When the run in `state` is due: in the past for `QUEUED`, the next
|
|
3298
|
+
* attempt for `RETRY_SCHEDULED` and the next check for `WAITING`. Null
|
|
3299
|
+
* for `RUNNING`.
|
|
3300
|
+
*/
|
|
3301
|
+
due_at?: string | null;
|
|
3302
|
+
/**
|
|
3303
|
+
* Format: date-time
|
|
3304
|
+
* @description When any of the review's runs last recorded a completed step. Null
|
|
3305
|
+
* before the first.
|
|
3306
|
+
*/
|
|
3307
|
+
last_progress_at?: string | null;
|
|
3308
|
+
/**
|
|
3309
|
+
* @description The most telling state among the review's unfinished runs: a scheduled
|
|
3310
|
+
* retry, then a running worker, then a queued run, then a wait.
|
|
3311
|
+
*/
|
|
3312
|
+
state: components["schemas"]["RunProgressState"];
|
|
3313
|
+
};
|
|
3314
|
+
/** @description What an unfinished review's runs are doing now. */
|
|
3315
|
+
RunProgressState: "WAITING" | "QUEUED" | "RUNNING" | "RETRY_SCHEDULED";
|
|
3282
3316
|
/** @description One request to scan a ref or an exact commit of the repository. */
|
|
3283
3317
|
ScanRequestBody: {
|
|
3284
3318
|
/**
|
package/dist/transport.js
CHANGED
package/openapi.public.json
CHANGED
|
@@ -2072,6 +2072,17 @@
|
|
|
2072
2072
|
"null"
|
|
2073
2073
|
]
|
|
2074
2074
|
},
|
|
2075
|
+
"run_progress": {
|
|
2076
|
+
"anyOf": [
|
|
2077
|
+
{
|
|
2078
|
+
"$ref": "#/components/schemas/RunProgress"
|
|
2079
|
+
},
|
|
2080
|
+
{
|
|
2081
|
+
"type": "null"
|
|
2082
|
+
}
|
|
2083
|
+
],
|
|
2084
|
+
"description": "Where an unfinished review's runs stand: running, queued for a worker,\n waiting for a scheduled step, or due again after an attempt that did\n not finish. Null once the review has ended."
|
|
2085
|
+
},
|
|
2075
2086
|
"status": {
|
|
2076
2087
|
"description": "The review's lifecycle status: `PENDING`, `RUNNING`, `COMPLETED`, `INCOMPLETE`, `FAILED`, `SUPERSEDED`, `STOPPED` or `EXCLUDED`.",
|
|
2077
2088
|
"type": "string"
|
|
@@ -5480,6 +5491,70 @@
|
|
|
5480
5491
|
],
|
|
5481
5492
|
"type": "object"
|
|
5482
5493
|
},
|
|
5494
|
+
"RunProgress": {
|
|
5495
|
+
"description": "Where an unfinished review's runs stand.",
|
|
5496
|
+
"properties": {
|
|
5497
|
+
"attempts": {
|
|
5498
|
+
"description": "Attempts begun by the run in `state`, counting worker claims.",
|
|
5499
|
+
"format": "int32",
|
|
5500
|
+
"type": "integer"
|
|
5501
|
+
},
|
|
5502
|
+
"due_at": {
|
|
5503
|
+
"description": "When the run in `state` is due: in the past for `QUEUED`, the next\n attempt for `RETRY_SCHEDULED` and the next check for `WAITING`. Null\n for `RUNNING`.",
|
|
5504
|
+
"format": "date-time",
|
|
5505
|
+
"type": [
|
|
5506
|
+
"string",
|
|
5507
|
+
"null"
|
|
5508
|
+
]
|
|
5509
|
+
},
|
|
5510
|
+
"last_progress_at": {
|
|
5511
|
+
"description": "When any of the review's runs last recorded a completed step. Null\n before the first.",
|
|
5512
|
+
"format": "date-time",
|
|
5513
|
+
"type": [
|
|
5514
|
+
"string",
|
|
5515
|
+
"null"
|
|
5516
|
+
]
|
|
5517
|
+
},
|
|
5518
|
+
"state": {
|
|
5519
|
+
"allOf": [
|
|
5520
|
+
{
|
|
5521
|
+
"$ref": "#/components/schemas/RunProgressState"
|
|
5522
|
+
}
|
|
5523
|
+
],
|
|
5524
|
+
"description": "The most telling state among the review's unfinished runs: a scheduled\n retry, then a running worker, then a queued run, then a wait."
|
|
5525
|
+
}
|
|
5526
|
+
},
|
|
5527
|
+
"required": [
|
|
5528
|
+
"state",
|
|
5529
|
+
"attempts"
|
|
5530
|
+
],
|
|
5531
|
+
"type": "object"
|
|
5532
|
+
},
|
|
5533
|
+
"RunProgressState": {
|
|
5534
|
+
"description": "What an unfinished review's runs are doing now.",
|
|
5535
|
+
"oneOf": [
|
|
5536
|
+
{
|
|
5537
|
+
"const": "WAITING",
|
|
5538
|
+
"description": "A run waits for a scheduled step, such as a push's quiet period, a\n resource another run holds, or its assessments, and is checked again\n at `due_at`.",
|
|
5539
|
+
"type": "string"
|
|
5540
|
+
},
|
|
5541
|
+
{
|
|
5542
|
+
"const": "QUEUED",
|
|
5543
|
+
"description": "A run is due and no worker has claimed it yet. It has been due since\n `due_at`.",
|
|
5544
|
+
"type": "string"
|
|
5545
|
+
},
|
|
5546
|
+
{
|
|
5547
|
+
"const": "RUNNING",
|
|
5548
|
+
"description": "A worker is running one of the review's runs.",
|
|
5549
|
+
"type": "string"
|
|
5550
|
+
},
|
|
5551
|
+
{
|
|
5552
|
+
"const": "RETRY_SCHEDULED",
|
|
5553
|
+
"description": "An attempt of a run ended without finishing, and the run starts again\n at `due_at`.",
|
|
5554
|
+
"type": "string"
|
|
5555
|
+
}
|
|
5556
|
+
]
|
|
5557
|
+
},
|
|
5483
5558
|
"ScanRequestBody": {
|
|
5484
5559
|
"additionalProperties": false,
|
|
5485
5560
|
"description": "One request to scan a ref or an exact commit of the repository.",
|
|
@@ -6075,7 +6150,7 @@
|
|
|
6075
6150
|
},
|
|
6076
6151
|
"info": {
|
|
6077
6152
|
"title": "Proofline Review API",
|
|
6078
|
-
"version": "5.
|
|
6153
|
+
"version": "5.9.0"
|
|
6079
6154
|
},
|
|
6080
6155
|
"openapi": "3.1.0",
|
|
6081
6156
|
"paths": {
|