@proofline/sdk 5.9.0 → 5.11.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 +53 -2
- package/dist/transport.js +1 -1
- package/openapi.public.json +83 -2
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -479,6 +479,8 @@ export interface components {
|
|
|
479
479
|
github_user_id: number;
|
|
480
480
|
/** @description The login they were known by when they acted. Display metadata. */
|
|
481
481
|
login: string;
|
|
482
|
+
/** @description Profile name resolved for this organization. Display metadata only. */
|
|
483
|
+
name?: string | null;
|
|
482
484
|
/** @description Their profile on the deployment's GitHub host. */
|
|
483
485
|
profile_url?: string | null;
|
|
484
486
|
};
|
|
@@ -1098,8 +1100,9 @@ export interface components {
|
|
|
1098
1100
|
incompleteness_kind?: string | null;
|
|
1099
1101
|
/**
|
|
1100
1102
|
* @description Public causes of an `INCOMPLETE` code assessment: `OUT_OF_CREDITS`
|
|
1101
|
-
* when credits refused its model
|
|
1102
|
-
*
|
|
1103
|
+
* when credits refused its model, and `MODEL_ANSWER_WITHHELD` when the
|
|
1104
|
+
* credential mask withheld its model's answer after the source was read.
|
|
1105
|
+
* Absent otherwise; other recorded details stay private.
|
|
1103
1106
|
*/
|
|
1104
1107
|
reason_codes?: string[] | null;
|
|
1105
1108
|
/**
|
|
@@ -1482,6 +1485,12 @@ export interface components {
|
|
|
1482
1485
|
* than the reviews list and a single review.
|
|
1483
1486
|
*/
|
|
1484
1487
|
incomplete_causes?: components["schemas"]["IncompleteCause"][];
|
|
1488
|
+
/**
|
|
1489
|
+
* @description The supported findings of each environment investigation this review
|
|
1490
|
+
* published, by assessment in recorded order, including those the
|
|
1491
|
+
* pull-request Check left off its list. Absent when there are none.
|
|
1492
|
+
*/
|
|
1493
|
+
investigation_findings?: components["schemas"]["ReviewInvestigationFinding"][];
|
|
1485
1494
|
/** @description Present and true when this run is a Deep Review. */
|
|
1486
1495
|
is_deep_review?: boolean;
|
|
1487
1496
|
/**
|
|
@@ -2774,6 +2783,48 @@ export interface components {
|
|
|
2774
2783
|
*/
|
|
2775
2784
|
repositories: components["schemas"]["FilterChoice"][];
|
|
2776
2785
|
};
|
|
2786
|
+
/**
|
|
2787
|
+
* @description One environment evidence record a finding cites, as Proofline verified
|
|
2788
|
+
* it.
|
|
2789
|
+
*/
|
|
2790
|
+
ReviewInvestigationCitation: {
|
|
2791
|
+
/**
|
|
2792
|
+
* Format: uuid
|
|
2793
|
+
* @description The evidence collection that holds the record.
|
|
2794
|
+
*/
|
|
2795
|
+
collection_id: string;
|
|
2796
|
+
/** @description The record's stored digest. */
|
|
2797
|
+
digest: string;
|
|
2798
|
+
/**
|
|
2799
|
+
* Format: uuid
|
|
2800
|
+
* @description The record's ID.
|
|
2801
|
+
*/
|
|
2802
|
+
record_id: string;
|
|
2803
|
+
/** @description The table that holds the record. */
|
|
2804
|
+
table: string;
|
|
2805
|
+
};
|
|
2806
|
+
/** @description One supported finding of an environment investigation. */
|
|
2807
|
+
ReviewInvestigationFinding: {
|
|
2808
|
+
/**
|
|
2809
|
+
* @description What the finding is about: `secrets`, `configuration`, `iam`,
|
|
2810
|
+
* `network`, `capacity` or `other`.
|
|
2811
|
+
*/
|
|
2812
|
+
area: string;
|
|
2813
|
+
/**
|
|
2814
|
+
* Format: uuid
|
|
2815
|
+
* @description The environment assessment whose investigation recorded the finding.
|
|
2816
|
+
*/
|
|
2817
|
+
assessment_id: string;
|
|
2818
|
+
/**
|
|
2819
|
+
* @description The evidence records the finding cites, each verified, in the order
|
|
2820
|
+
* the finding cites them.
|
|
2821
|
+
*/
|
|
2822
|
+
citations: components["schemas"]["ReviewInvestigationCitation"][];
|
|
2823
|
+
/** @description Model text with protected values withheld. Render it as plain text. */
|
|
2824
|
+
detail: string;
|
|
2825
|
+
/** @description Model text with protected values withheld. Render it as plain text. */
|
|
2826
|
+
title: string;
|
|
2827
|
+
};
|
|
2777
2828
|
ReviewOpenItems: {
|
|
2778
2829
|
/**
|
|
2779
2830
|
* Format: uint64
|
package/dist/transport.js
CHANGED
package/openapi.public.json
CHANGED
|
@@ -22,6 +22,13 @@
|
|
|
22
22
|
"description": "The login they were known by when they acted. Display metadata.",
|
|
23
23
|
"type": "string"
|
|
24
24
|
},
|
|
25
|
+
"name": {
|
|
26
|
+
"description": "Profile name resolved for this organization. Display metadata only.",
|
|
27
|
+
"type": [
|
|
28
|
+
"string",
|
|
29
|
+
"null"
|
|
30
|
+
]
|
|
31
|
+
},
|
|
25
32
|
"profile_url": {
|
|
26
33
|
"description": "Their profile on the deployment's GitHub host.",
|
|
27
34
|
"type": [
|
|
@@ -1245,7 +1252,7 @@
|
|
|
1245
1252
|
]
|
|
1246
1253
|
},
|
|
1247
1254
|
"reason_codes": {
|
|
1248
|
-
"description": "Public causes of an `INCOMPLETE` code assessment: `OUT_OF_CREDITS`\n when credits refused its model
|
|
1255
|
+
"description": "Public causes of an `INCOMPLETE` code assessment: `OUT_OF_CREDITS`\n when credits refused its model, and `MODEL_ANSWER_WITHHELD` when the\n credential mask withheld its model's answer after the source was read.\n Absent otherwise; other recorded details stay private.",
|
|
1249
1256
|
"items": {
|
|
1250
1257
|
"type": "string"
|
|
1251
1258
|
},
|
|
@@ -1844,6 +1851,13 @@
|
|
|
1844
1851
|
},
|
|
1845
1852
|
"type": "array"
|
|
1846
1853
|
},
|
|
1854
|
+
"investigation_findings": {
|
|
1855
|
+
"description": "The supported findings of each environment investigation this review\n published, by assessment in recorded order, including those the\n pull-request Check left off its list. Absent when there are none.",
|
|
1856
|
+
"items": {
|
|
1857
|
+
"$ref": "#/components/schemas/ReviewInvestigationFinding"
|
|
1858
|
+
},
|
|
1859
|
+
"type": "array"
|
|
1860
|
+
},
|
|
1847
1861
|
"is_deep_review": {
|
|
1848
1862
|
"description": "Present and true when this run is a Deep Review.",
|
|
1849
1863
|
"type": "boolean"
|
|
@@ -4522,6 +4536,73 @@
|
|
|
4522
4536
|
],
|
|
4523
4537
|
"type": "object"
|
|
4524
4538
|
},
|
|
4539
|
+
"ReviewInvestigationCitation": {
|
|
4540
|
+
"description": "One environment evidence record a finding cites, as Proofline verified\n it.",
|
|
4541
|
+
"properties": {
|
|
4542
|
+
"collection_id": {
|
|
4543
|
+
"description": "The evidence collection that holds the record.",
|
|
4544
|
+
"format": "uuid",
|
|
4545
|
+
"type": "string"
|
|
4546
|
+
},
|
|
4547
|
+
"digest": {
|
|
4548
|
+
"description": "The record's stored digest.",
|
|
4549
|
+
"type": "string"
|
|
4550
|
+
},
|
|
4551
|
+
"record_id": {
|
|
4552
|
+
"description": "The record's ID.",
|
|
4553
|
+
"format": "uuid",
|
|
4554
|
+
"type": "string"
|
|
4555
|
+
},
|
|
4556
|
+
"table": {
|
|
4557
|
+
"description": "The table that holds the record.",
|
|
4558
|
+
"type": "string"
|
|
4559
|
+
}
|
|
4560
|
+
},
|
|
4561
|
+
"required": [
|
|
4562
|
+
"collection_id",
|
|
4563
|
+
"table",
|
|
4564
|
+
"record_id",
|
|
4565
|
+
"digest"
|
|
4566
|
+
],
|
|
4567
|
+
"type": "object"
|
|
4568
|
+
},
|
|
4569
|
+
"ReviewInvestigationFinding": {
|
|
4570
|
+
"description": "One supported finding of an environment investigation.",
|
|
4571
|
+
"properties": {
|
|
4572
|
+
"area": {
|
|
4573
|
+
"description": "What the finding is about: `secrets`, `configuration`, `iam`,\n `network`, `capacity` or `other`.",
|
|
4574
|
+
"type": "string"
|
|
4575
|
+
},
|
|
4576
|
+
"assessment_id": {
|
|
4577
|
+
"description": "The environment assessment whose investigation recorded the finding.",
|
|
4578
|
+
"format": "uuid",
|
|
4579
|
+
"type": "string"
|
|
4580
|
+
},
|
|
4581
|
+
"citations": {
|
|
4582
|
+
"description": "The evidence records the finding cites, each verified, in the order\n the finding cites them.",
|
|
4583
|
+
"items": {
|
|
4584
|
+
"$ref": "#/components/schemas/ReviewInvestigationCitation"
|
|
4585
|
+
},
|
|
4586
|
+
"type": "array"
|
|
4587
|
+
},
|
|
4588
|
+
"detail": {
|
|
4589
|
+
"description": "Model text with protected values withheld. Render it as plain text.",
|
|
4590
|
+
"type": "string"
|
|
4591
|
+
},
|
|
4592
|
+
"title": {
|
|
4593
|
+
"description": "Model text with protected values withheld. Render it as plain text.",
|
|
4594
|
+
"type": "string"
|
|
4595
|
+
}
|
|
4596
|
+
},
|
|
4597
|
+
"required": [
|
|
4598
|
+
"assessment_id",
|
|
4599
|
+
"area",
|
|
4600
|
+
"title",
|
|
4601
|
+
"detail",
|
|
4602
|
+
"citations"
|
|
4603
|
+
],
|
|
4604
|
+
"type": "object"
|
|
4605
|
+
},
|
|
4525
4606
|
"ReviewOpenItems": {
|
|
4526
4607
|
"properties": {
|
|
4527
4608
|
"accepted_risk_count": {
|
|
@@ -6150,7 +6231,7 @@
|
|
|
6150
6231
|
},
|
|
6151
6232
|
"info": {
|
|
6152
6233
|
"title": "Proofline Review API",
|
|
6153
|
-
"version": "5.
|
|
6234
|
+
"version": "5.11.0"
|
|
6154
6235
|
},
|
|
6155
6236
|
"openapi": "3.1.0",
|
|
6156
6237
|
"paths": {
|