@proofline/sdk 1.0.3 → 2.0.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/README.md +62 -47
- package/dist/fixes.d.ts +14 -0
- package/dist/fixes.js +19 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +3 -0
- package/dist/knowledge.d.ts +5 -19
- package/dist/knowledge.js +3 -61
- package/dist/mcp.d.ts +20 -0
- package/dist/mcp.js +62 -0
- package/dist/operations.d.ts +3 -0
- package/dist/operations.js +3 -0
- package/dist/schema.d.ts +286 -0
- package/dist/transport.js +1 -1
- package/openapi.public.json +472 -2
- package/package.json +1 -1
package/openapi.public.json
CHANGED
|
@@ -763,6 +763,47 @@
|
|
|
763
763
|
],
|
|
764
764
|
"type": "object"
|
|
765
765
|
},
|
|
766
|
+
"CheckFile": {
|
|
767
|
+
"description": "One file World cited for a check's result.",
|
|
768
|
+
"properties": {
|
|
769
|
+
"path": {
|
|
770
|
+
"allOf": [
|
|
771
|
+
{
|
|
772
|
+
"$ref": "#/components/schemas/UntrustedText"
|
|
773
|
+
}
|
|
774
|
+
],
|
|
775
|
+
"description": "The repository-relative path. It is repository text."
|
|
776
|
+
},
|
|
777
|
+
"revision": {
|
|
778
|
+
"allOf": [
|
|
779
|
+
{
|
|
780
|
+
"$ref": "#/components/schemas/CheckFileRevision"
|
|
781
|
+
}
|
|
782
|
+
],
|
|
783
|
+
"description": "The revision World read the file at."
|
|
784
|
+
}
|
|
785
|
+
},
|
|
786
|
+
"required": [
|
|
787
|
+
"revision",
|
|
788
|
+
"path"
|
|
789
|
+
],
|
|
790
|
+
"type": "object"
|
|
791
|
+
},
|
|
792
|
+
"CheckFileRevision": {
|
|
793
|
+
"description": "The revision a cited file was read at.",
|
|
794
|
+
"oneOf": [
|
|
795
|
+
{
|
|
796
|
+
"const": "PROPOSED_CODE_REVISION",
|
|
797
|
+
"description": "The reviewed commit.",
|
|
798
|
+
"type": "string"
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
"const": "BASE_CODE_REVISION",
|
|
802
|
+
"description": "Its merge base.",
|
|
803
|
+
"type": "string"
|
|
804
|
+
}
|
|
805
|
+
]
|
|
806
|
+
},
|
|
766
807
|
"CheckLifecycle": {
|
|
767
808
|
"description": "World's lifecycle disclosure for the evaluator version that answered, as\n the receipt recorded it. A deployment gate counts only `GATING` results\n (`DeterministicCoverage::gate_effective_status`), and only when it\n evaluates a deployment; the lifecycle alone permits or blocks nothing.",
|
|
768
809
|
"oneOf": [
|
|
@@ -793,6 +834,103 @@
|
|
|
793
834
|
}
|
|
794
835
|
]
|
|
795
836
|
},
|
|
837
|
+
"CiFailureAttribution": {
|
|
838
|
+
"description": "What the control plane records as a failure's cause.",
|
|
839
|
+
"enum": [
|
|
840
|
+
"CAUSED_BY_CHANGE",
|
|
841
|
+
"PRE_EXISTING_ON_BASE",
|
|
842
|
+
"FLAKY_OR_INFRASTRUCTURE",
|
|
843
|
+
"ENVIRONMENT_STATE",
|
|
844
|
+
"UNKNOWN"
|
|
845
|
+
],
|
|
846
|
+
"type": "string"
|
|
847
|
+
},
|
|
848
|
+
"CiFailureLine": {
|
|
849
|
+
"description": "One failed CI job as the Check states it.",
|
|
850
|
+
"properties": {
|
|
851
|
+
"attribution": {
|
|
852
|
+
"allOf": [
|
|
853
|
+
{
|
|
854
|
+
"$ref": "#/components/schemas/CiFailureAttribution"
|
|
855
|
+
}
|
|
856
|
+
],
|
|
857
|
+
"description": "The recorded cause: `CAUSED_BY_CHANGE`, `PRE_EXISTING_ON_BASE`,\n `FLAKY_OR_INFRASTRUCTURE`, `ENVIRONMENT_STATE` or `UNKNOWN`. `UNKNOWN`\n means the failure was not diagnosed, and `undiagnosed` says why."
|
|
858
|
+
},
|
|
859
|
+
"failed_step": {
|
|
860
|
+
"description": "The first failed step's name, admitted the same way. Null when no\n step concluded as failed.",
|
|
861
|
+
"type": [
|
|
862
|
+
"string",
|
|
863
|
+
"null"
|
|
864
|
+
]
|
|
865
|
+
},
|
|
866
|
+
"job_name": {
|
|
867
|
+
"description": "The job's name as the diagnosis admitted it: masked, or `<withheld>`.\n A protected value of the observing review reads as the withheld\n marker.",
|
|
868
|
+
"type": "string"
|
|
869
|
+
},
|
|
870
|
+
"run_attempt": {
|
|
871
|
+
"description": "The GitHub Actions run attempt the job failed in, from 1. The line\n is the newest diagnosed attempt of its run.",
|
|
872
|
+
"format": "int64",
|
|
873
|
+
"type": "integer"
|
|
874
|
+
},
|
|
875
|
+
"timed_out": {
|
|
876
|
+
"description": "Whether the job timed out rather than failed.",
|
|
877
|
+
"type": "boolean"
|
|
878
|
+
},
|
|
879
|
+
"undiagnosed": {
|
|
880
|
+
"anyOf": [
|
|
881
|
+
{
|
|
882
|
+
"$ref": "#/components/schemas/CiFailureUndiagnosed"
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"type": "null"
|
|
886
|
+
}
|
|
887
|
+
],
|
|
888
|
+
"description": "Why the failure was not diagnosed. Set exactly when `attribution` is\n `UNKNOWN`."
|
|
889
|
+
}
|
|
890
|
+
},
|
|
891
|
+
"required": [
|
|
892
|
+
"job_name",
|
|
893
|
+
"timed_out",
|
|
894
|
+
"run_attempt",
|
|
895
|
+
"attribution"
|
|
896
|
+
],
|
|
897
|
+
"type": "object"
|
|
898
|
+
},
|
|
899
|
+
"CiFailureUndiagnosed": {
|
|
900
|
+
"description": "Why a failed job's attribution is `UNKNOWN`.",
|
|
901
|
+
"oneOf": [
|
|
902
|
+
{
|
|
903
|
+
"const": "LOG_UNAVAILABLE",
|
|
904
|
+
"description": "GitHub returned no log for the job.",
|
|
905
|
+
"type": "string"
|
|
906
|
+
},
|
|
907
|
+
{
|
|
908
|
+
"const": "LOG_TOO_LARGE",
|
|
909
|
+
"description": "The complete log exceeds the read bound.",
|
|
910
|
+
"type": "string"
|
|
911
|
+
},
|
|
912
|
+
{
|
|
913
|
+
"const": "LOG_NOT_ADMITTED",
|
|
914
|
+
"description": "The log could not cross the credential mask or protected-value\n admission. The console names which.",
|
|
915
|
+
"type": "string"
|
|
916
|
+
},
|
|
917
|
+
{
|
|
918
|
+
"const": "DECISION_UNAVAILABLE",
|
|
919
|
+
"description": "The attribution decision fell back: Jev was unavailable or refused.",
|
|
920
|
+
"type": "string"
|
|
921
|
+
},
|
|
922
|
+
{
|
|
923
|
+
"const": "SHADOW",
|
|
924
|
+
"description": "The attribution decision runs in shadow mode, so its answer is not\n applied.",
|
|
925
|
+
"type": "string"
|
|
926
|
+
},
|
|
927
|
+
{
|
|
928
|
+
"const": "UNDETERMINED",
|
|
929
|
+
"description": "The decision applied no cause.",
|
|
930
|
+
"type": "string"
|
|
931
|
+
}
|
|
932
|
+
]
|
|
933
|
+
},
|
|
796
934
|
"CodeAssessmentStatus": {
|
|
797
935
|
"description": "A code assessment's recorded execution status. It is never a verdict on\n the change: only `COMPLETED` says the assessment covered what it read.",
|
|
798
936
|
"oneOf": [
|
|
@@ -953,6 +1091,100 @@
|
|
|
953
1091
|
],
|
|
954
1092
|
"type": "object"
|
|
955
1093
|
},
|
|
1094
|
+
"CoverageRefused": {
|
|
1095
|
+
"description": "An upload refused for its content: a symbolic or unknown commit, or a\n report that cannot be read. Nothing is stored.",
|
|
1096
|
+
"properties": {
|
|
1097
|
+
"detail": {
|
|
1098
|
+
"description": "One sentence naming what was refused and why.",
|
|
1099
|
+
"type": "string"
|
|
1100
|
+
},
|
|
1101
|
+
"status": {
|
|
1102
|
+
"description": "Always 422.",
|
|
1103
|
+
"format": "uint16",
|
|
1104
|
+
"maximum": 65535,
|
|
1105
|
+
"minimum": 0,
|
|
1106
|
+
"type": "integer"
|
|
1107
|
+
},
|
|
1108
|
+
"title": {
|
|
1109
|
+
"description": "Always `unprocessable coverage upload`.",
|
|
1110
|
+
"type": "string"
|
|
1111
|
+
}
|
|
1112
|
+
},
|
|
1113
|
+
"required": [
|
|
1114
|
+
"title",
|
|
1115
|
+
"status",
|
|
1116
|
+
"detail"
|
|
1117
|
+
],
|
|
1118
|
+
"type": "object"
|
|
1119
|
+
},
|
|
1120
|
+
"CoverageUploadRequest": {
|
|
1121
|
+
"additionalProperties": false,
|
|
1122
|
+
"description": "The coverage reports a CI run produced for one commit.",
|
|
1123
|
+
"properties": {
|
|
1124
|
+
"reports": {
|
|
1125
|
+
"description": "One to 50 reports, each LCOV, Cobertura XML, `JaCoCo` XML or a Go\n cover profile, in a JSON body of at most 64 MiB.",
|
|
1126
|
+
"items": {
|
|
1127
|
+
"$ref": "#/components/schemas/UploadedReport"
|
|
1128
|
+
},
|
|
1129
|
+
"type": "array"
|
|
1130
|
+
},
|
|
1131
|
+
"tested_sha": {
|
|
1132
|
+
"description": "The full 40-character commit the tests ran on. GitHub must have it in\n this repository. A merge commit counts for a pull request head that is\n one of its two parents.",
|
|
1133
|
+
"type": "string"
|
|
1134
|
+
}
|
|
1135
|
+
},
|
|
1136
|
+
"required": [
|
|
1137
|
+
"tested_sha",
|
|
1138
|
+
"reports"
|
|
1139
|
+
],
|
|
1140
|
+
"type": "object"
|
|
1141
|
+
},
|
|
1142
|
+
"CoverageUploadResponse": {
|
|
1143
|
+
"description": "The report the upload recorded, or the one an identical upload recorded.",
|
|
1144
|
+
"properties": {
|
|
1145
|
+
"covered_lines": {
|
|
1146
|
+
"description": "Covered lines among those instrumented lines.",
|
|
1147
|
+
"format": "uint64",
|
|
1148
|
+
"minimum": 0,
|
|
1149
|
+
"type": "integer"
|
|
1150
|
+
},
|
|
1151
|
+
"created": {
|
|
1152
|
+
"description": "False when the same reports for this commit were already recorded.",
|
|
1153
|
+
"type": "boolean"
|
|
1154
|
+
},
|
|
1155
|
+
"formats": {
|
|
1156
|
+
"description": "The format of each report, in upload order.",
|
|
1157
|
+
"items": {
|
|
1158
|
+
"type": "string"
|
|
1159
|
+
},
|
|
1160
|
+
"type": "array"
|
|
1161
|
+
},
|
|
1162
|
+
"instrumented_lines": {
|
|
1163
|
+
"description": "Instrumented lines across the reports, a file two reports name under\n one path counted once.",
|
|
1164
|
+
"format": "uint64",
|
|
1165
|
+
"minimum": 0,
|
|
1166
|
+
"type": "integer"
|
|
1167
|
+
},
|
|
1168
|
+
"report_id": {
|
|
1169
|
+
"description": "The recorded report.",
|
|
1170
|
+
"format": "uuid",
|
|
1171
|
+
"type": "string"
|
|
1172
|
+
},
|
|
1173
|
+
"tested_sha": {
|
|
1174
|
+
"description": "The commit the reports tested, as the upload named it.",
|
|
1175
|
+
"type": "string"
|
|
1176
|
+
}
|
|
1177
|
+
},
|
|
1178
|
+
"required": [
|
|
1179
|
+
"report_id",
|
|
1180
|
+
"tested_sha",
|
|
1181
|
+
"created",
|
|
1182
|
+
"formats",
|
|
1183
|
+
"instrumented_lines",
|
|
1184
|
+
"covered_lines"
|
|
1185
|
+
],
|
|
1186
|
+
"type": "object"
|
|
1187
|
+
},
|
|
956
1188
|
"CustomerAssessment": {
|
|
957
1189
|
"properties": {
|
|
958
1190
|
"checks": {
|
|
@@ -1214,6 +1446,13 @@
|
|
|
1214
1446
|
"null"
|
|
1215
1447
|
]
|
|
1216
1448
|
},
|
|
1449
|
+
"files": {
|
|
1450
|
+
"description": "The files World cited as evidence for this result, once each in\n World's order, with the revision World read each at. Empty when World\n cited no file, and on results recorded before World cited files.",
|
|
1451
|
+
"items": {
|
|
1452
|
+
"$ref": "#/components/schemas/CheckFile"
|
|
1453
|
+
},
|
|
1454
|
+
"type": "array"
|
|
1455
|
+
},
|
|
1217
1456
|
"lifecycle": {
|
|
1218
1457
|
"allOf": [
|
|
1219
1458
|
{
|
|
@@ -1245,7 +1484,8 @@
|
|
|
1245
1484
|
"required": [
|
|
1246
1485
|
"name",
|
|
1247
1486
|
"outcome",
|
|
1248
|
-
"lifecycle"
|
|
1487
|
+
"lifecycle",
|
|
1488
|
+
"files"
|
|
1249
1489
|
],
|
|
1250
1490
|
"type": "object"
|
|
1251
1491
|
},
|
|
@@ -1289,6 +1529,13 @@
|
|
|
1289
1529
|
"null"
|
|
1290
1530
|
]
|
|
1291
1531
|
},
|
|
1532
|
+
"coverage_details": {
|
|
1533
|
+
"description": "Recorded check coverage counts and fixed cancellation causes, without source text.\n Absent coverage does not establish that every check ran.",
|
|
1534
|
+
"items": {
|
|
1535
|
+
"type": "string"
|
|
1536
|
+
},
|
|
1537
|
+
"type": "array"
|
|
1538
|
+
},
|
|
1292
1539
|
"findings": {
|
|
1293
1540
|
"description": "The code-only findings the code assessment recorded, `SERIOUS` first.\n An empty list does not establish deployment safety.",
|
|
1294
1541
|
"items": {
|
|
@@ -1604,6 +1851,13 @@
|
|
|
1604
1851
|
"description": "The finding's recorded lifecycle state: `NEW`, `UNCHANGED`, `RESOLVED`\n or `REINTRODUCED`.",
|
|
1605
1852
|
"type": "string"
|
|
1606
1853
|
},
|
|
1854
|
+
"local_findings": {
|
|
1855
|
+
"description": "Earlier occurrences in the author's local reviews linked by exact patch\n identity. These links carry no verdict or finding decision.",
|
|
1856
|
+
"items": {
|
|
1857
|
+
"$ref": "#/components/schemas/MatchedLocalFinding"
|
|
1858
|
+
},
|
|
1859
|
+
"type": "array"
|
|
1860
|
+
},
|
|
1607
1861
|
"placement": {
|
|
1608
1862
|
"anyOf": [
|
|
1609
1863
|
{
|
|
@@ -2368,6 +2622,43 @@
|
|
|
2368
2622
|
],
|
|
2369
2623
|
"type": "object"
|
|
2370
2624
|
},
|
|
2625
|
+
"EarlierOpenFinding": {
|
|
2626
|
+
"description": "A published occurrence of an unresolved series absent from the current run.",
|
|
2627
|
+
"properties": {
|
|
2628
|
+
"finding_id": {
|
|
2629
|
+
"description": "The occurrence in the series' first published review.",
|
|
2630
|
+
"format": "uuid",
|
|
2631
|
+
"type": "string"
|
|
2632
|
+
},
|
|
2633
|
+
"finding_series_id": {
|
|
2634
|
+
"description": "The unresolved environment finding series counted for this run.",
|
|
2635
|
+
"format": "uuid",
|
|
2636
|
+
"type": "string"
|
|
2637
|
+
},
|
|
2638
|
+
"review_id": {
|
|
2639
|
+
"description": "The first published review containing this occurrence.",
|
|
2640
|
+
"format": "uuid",
|
|
2641
|
+
"type": "string"
|
|
2642
|
+
},
|
|
2643
|
+
"run_number": {
|
|
2644
|
+
"description": "The earlier pull-request run that contains this occurrence.",
|
|
2645
|
+
"format": "int64",
|
|
2646
|
+
"type": "integer"
|
|
2647
|
+
},
|
|
2648
|
+
"severity": {
|
|
2649
|
+
"description": "Severity used by the series count; the linked occurrence may be less severe.",
|
|
2650
|
+
"type": "string"
|
|
2651
|
+
}
|
|
2652
|
+
},
|
|
2653
|
+
"required": [
|
|
2654
|
+
"finding_series_id",
|
|
2655
|
+
"finding_id",
|
|
2656
|
+
"review_id",
|
|
2657
|
+
"run_number",
|
|
2658
|
+
"severity"
|
|
2659
|
+
],
|
|
2660
|
+
"type": "object"
|
|
2661
|
+
},
|
|
2371
2662
|
"EvidenceView": {
|
|
2372
2663
|
"enum": [
|
|
2373
2664
|
"REQUIRED_PROPERTIES_ESTABLISHED",
|
|
@@ -3543,6 +3834,32 @@
|
|
|
3543
3834
|
],
|
|
3544
3835
|
"type": "string"
|
|
3545
3836
|
},
|
|
3837
|
+
"MatchedLocalFinding": {
|
|
3838
|
+
"description": "A local occurrence with the same semantic fingerprint as this finding.",
|
|
3839
|
+
"properties": {
|
|
3840
|
+
"created_at": {
|
|
3841
|
+
"description": "When the local review was requested.",
|
|
3842
|
+
"format": "date-time",
|
|
3843
|
+
"type": "string"
|
|
3844
|
+
},
|
|
3845
|
+
"finding_id": {
|
|
3846
|
+
"description": "The occurrence in that local review.",
|
|
3847
|
+
"format": "uuid",
|
|
3848
|
+
"type": "string"
|
|
3849
|
+
},
|
|
3850
|
+
"review_id": {
|
|
3851
|
+
"description": "The author's local review, linked by exact patch identity.",
|
|
3852
|
+
"format": "uuid",
|
|
3853
|
+
"type": "string"
|
|
3854
|
+
}
|
|
3855
|
+
},
|
|
3856
|
+
"required": [
|
|
3857
|
+
"review_id",
|
|
3858
|
+
"finding_id",
|
|
3859
|
+
"created_at"
|
|
3860
|
+
],
|
|
3861
|
+
"type": "object"
|
|
3862
|
+
},
|
|
3546
3863
|
"NotAssessedView": {
|
|
3547
3864
|
"properties": {
|
|
3548
3865
|
"environment_display_name": {
|
|
@@ -3827,6 +4144,13 @@
|
|
|
3827
4144
|
"minimum": 0,
|
|
3828
4145
|
"type": "integer"
|
|
3829
4146
|
},
|
|
4147
|
+
"earlier_findings": {
|
|
4148
|
+
"description": "Exact published occurrences of earlier unresolved environment findings.",
|
|
4149
|
+
"items": {
|
|
4150
|
+
"$ref": "#/components/schemas/EarlierOpenFinding"
|
|
4151
|
+
},
|
|
4152
|
+
"type": "array"
|
|
4153
|
+
},
|
|
3830
4154
|
"not_assessed": {
|
|
3831
4155
|
"description": "Recorded assessment gaps, including explicit policy exclusions.",
|
|
3832
4156
|
"items": {
|
|
@@ -4714,6 +5038,31 @@
|
|
|
4714
5038
|
"minimum": 0,
|
|
4715
5039
|
"type": "integer"
|
|
4716
5040
|
},
|
|
5041
|
+
"ci_failures": {
|
|
5042
|
+
"description": "Failed CI jobs diagnosed on the reviewed head, the newest diagnosed\n attempt of each run, in diagnosis order. The Check states each one;\n none is a Proofline open item. Absent when no job was diagnosed.",
|
|
5043
|
+
"items": {
|
|
5044
|
+
"$ref": "#/components/schemas/CiFailureLine"
|
|
5045
|
+
},
|
|
5046
|
+
"type": "array"
|
|
5047
|
+
},
|
|
5048
|
+
"ci_failures_omitted": {
|
|
5049
|
+
"description": "Diagnosed failed CI jobs on the reviewed head beyond `ci_failures`.",
|
|
5050
|
+
"format": "uint64",
|
|
5051
|
+
"minimum": 0,
|
|
5052
|
+
"type": "integer"
|
|
5053
|
+
},
|
|
5054
|
+
"ci_runs_pending": {
|
|
5055
|
+
"description": "Failed CI run attempts on the reviewed head whose diagnosis is queued\n or running, so none of their jobs has a line yet.",
|
|
5056
|
+
"format": "uint64",
|
|
5057
|
+
"minimum": 0,
|
|
5058
|
+
"type": "integer"
|
|
5059
|
+
},
|
|
5060
|
+
"ci_runs_unfinished": {
|
|
5061
|
+
"description": "Failed CI run attempts on the reviewed head whose diagnosis failed or\n was cancelled, so none of their jobs has a line.",
|
|
5062
|
+
"format": "uint64",
|
|
5063
|
+
"minimum": 0,
|
|
5064
|
+
"type": "integer"
|
|
5065
|
+
},
|
|
4717
5066
|
"current_head_provider_updated_at": {
|
|
4718
5067
|
"description": "GitHub's update time for the recorded pull request state that\n `current_head_sha` comes from. Null when none is recorded.",
|
|
4719
5068
|
"format": "date-time",
|
|
@@ -4729,6 +5078,13 @@
|
|
|
4729
5078
|
"null"
|
|
4730
5079
|
]
|
|
4731
5080
|
},
|
|
5081
|
+
"earlier_findings": {
|
|
5082
|
+
"description": "Exact published occurrences of earlier unresolved environment findings.\n Absent from observations recorded before destinations were captured.",
|
|
5083
|
+
"items": {
|
|
5084
|
+
"$ref": "#/components/schemas/EarlierOpenFinding"
|
|
5085
|
+
},
|
|
5086
|
+
"type": "array"
|
|
5087
|
+
},
|
|
4732
5088
|
"environments": {
|
|
4733
5089
|
"description": "This review's environment assessments that are not `COMPLETED`, ordered\n by environment key.",
|
|
4734
5090
|
"items": {
|
|
@@ -5356,6 +5712,14 @@
|
|
|
5356
5712
|
],
|
|
5357
5713
|
"description": "Human override beside the original decision, when one was requested."
|
|
5358
5714
|
},
|
|
5715
|
+
"publication_group": {
|
|
5716
|
+
"description": "The finding that represents this finding's publication group, when an\n applied group publishes it in one comment with other findings. Every\n member names the same finding, the representative included.",
|
|
5717
|
+
"format": "uuid",
|
|
5718
|
+
"type": [
|
|
5719
|
+
"string",
|
|
5720
|
+
"null"
|
|
5721
|
+
]
|
|
5722
|
+
},
|
|
5359
5723
|
"reason_codes": {
|
|
5360
5724
|
"description": "Recognized safe reason codes; unknown values are represented as `UNRECOGNIZED`.",
|
|
5361
5725
|
"items": {
|
|
@@ -6217,6 +6581,24 @@
|
|
|
6217
6581
|
],
|
|
6218
6582
|
"type": "object"
|
|
6219
6583
|
},
|
|
6584
|
+
"UploadedReport": {
|
|
6585
|
+
"additionalProperties": false,
|
|
6586
|
+
"properties": {
|
|
6587
|
+
"content": {
|
|
6588
|
+
"description": "The report text, exactly as the coverage tool wrote it.",
|
|
6589
|
+
"type": "string"
|
|
6590
|
+
},
|
|
6591
|
+
"name": {
|
|
6592
|
+
"description": "A relative name for the report, such as `web/lcov.info`, unique in\n the upload.",
|
|
6593
|
+
"type": "string"
|
|
6594
|
+
}
|
|
6595
|
+
},
|
|
6596
|
+
"required": [
|
|
6597
|
+
"name",
|
|
6598
|
+
"content"
|
|
6599
|
+
],
|
|
6600
|
+
"type": "object"
|
|
6601
|
+
},
|
|
6220
6602
|
"WalkthroughFileView": {
|
|
6221
6603
|
"properties": {
|
|
6222
6604
|
"additions": {
|
|
@@ -6342,7 +6724,7 @@
|
|
|
6342
6724
|
},
|
|
6343
6725
|
"info": {
|
|
6344
6726
|
"title": "Proofline Review API",
|
|
6345
|
-
"version": "
|
|
6727
|
+
"version": "2.0.0"
|
|
6346
6728
|
},
|
|
6347
6729
|
"openapi": "3.1.0",
|
|
6348
6730
|
"paths": {
|
|
@@ -6882,6 +7264,94 @@
|
|
|
6882
7264
|
"x-proofline-token-scope": "reviews:request"
|
|
6883
7265
|
}
|
|
6884
7266
|
},
|
|
7267
|
+
"/api/v1/organizations/{org_id}/repositories/{repo_id}/coverage-reports": {
|
|
7268
|
+
"post": {
|
|
7269
|
+
"description": "Records the LCOV, Cobertura, JaCoCo or Go coverage reports a CI run produced for one exact commit GitHub has in the repository, for COVERAGE checks that accept uploads. A branch, tag or abbreviated SHA, or a report that cannot be read, gets 422 and stores nothing. Requires a repository-restricted token and live GitHub write access; the same reports for the same commit return the report already recorded.",
|
|
7270
|
+
"operationId": "upload_coverage_reports",
|
|
7271
|
+
"parameters": [
|
|
7272
|
+
{
|
|
7273
|
+
"in": "path",
|
|
7274
|
+
"name": "org_id",
|
|
7275
|
+
"required": true,
|
|
7276
|
+
"schema": {
|
|
7277
|
+
"format": "uuid",
|
|
7278
|
+
"type": "string"
|
|
7279
|
+
},
|
|
7280
|
+
"style": "simple"
|
|
7281
|
+
},
|
|
7282
|
+
{
|
|
7283
|
+
"in": "path",
|
|
7284
|
+
"name": "repo_id",
|
|
7285
|
+
"required": true,
|
|
7286
|
+
"schema": {
|
|
7287
|
+
"format": "uuid",
|
|
7288
|
+
"type": "string"
|
|
7289
|
+
},
|
|
7290
|
+
"style": "simple"
|
|
7291
|
+
}
|
|
7292
|
+
],
|
|
7293
|
+
"requestBody": {
|
|
7294
|
+
"content": {
|
|
7295
|
+
"application/json": {
|
|
7296
|
+
"schema": {
|
|
7297
|
+
"$ref": "#/components/schemas/CoverageUploadRequest"
|
|
7298
|
+
}
|
|
7299
|
+
}
|
|
7300
|
+
},
|
|
7301
|
+
"description": "The coverage reports a CI run produced for one commit.",
|
|
7302
|
+
"required": true
|
|
7303
|
+
},
|
|
7304
|
+
"responses": {
|
|
7305
|
+
"200": {
|
|
7306
|
+
"content": {
|
|
7307
|
+
"application/json": {
|
|
7308
|
+
"schema": {
|
|
7309
|
+
"$ref": "#/components/schemas/CoverageUploadResponse"
|
|
7310
|
+
}
|
|
7311
|
+
}
|
|
7312
|
+
},
|
|
7313
|
+
"description": "The report the upload recorded, or the one an identical upload recorded."
|
|
7314
|
+
},
|
|
7315
|
+
"201": {
|
|
7316
|
+
"content": {
|
|
7317
|
+
"application/json": {
|
|
7318
|
+
"schema": {
|
|
7319
|
+
"$ref": "#/components/schemas/CoverageUploadResponse"
|
|
7320
|
+
}
|
|
7321
|
+
}
|
|
7322
|
+
},
|
|
7323
|
+
"description": "The report the upload recorded, or the one an identical upload recorded."
|
|
7324
|
+
},
|
|
7325
|
+
"422": {
|
|
7326
|
+
"content": {
|
|
7327
|
+
"application/json": {
|
|
7328
|
+
"schema": {
|
|
7329
|
+
"$ref": "#/components/schemas/CoverageRefused"
|
|
7330
|
+
}
|
|
7331
|
+
}
|
|
7332
|
+
},
|
|
7333
|
+
"description": "An upload refused for its content: a symbolic or unknown commit, or a\n report that cannot be read. Nothing is stored."
|
|
7334
|
+
},
|
|
7335
|
+
"default": {
|
|
7336
|
+
"content": {
|
|
7337
|
+
"application/problem+json": {
|
|
7338
|
+
"schema": {
|
|
7339
|
+
"$ref": "#/components/schemas/Problem"
|
|
7340
|
+
}
|
|
7341
|
+
}
|
|
7342
|
+
},
|
|
7343
|
+
"description": "An RFC 9457 problem; the HTTP status remains authoritative."
|
|
7344
|
+
}
|
|
7345
|
+
},
|
|
7346
|
+
"security": [
|
|
7347
|
+
{
|
|
7348
|
+
"bearerAuth": []
|
|
7349
|
+
}
|
|
7350
|
+
],
|
|
7351
|
+
"summary": "Upload coverage reports",
|
|
7352
|
+
"x-proofline-token-scope": "coverage:write"
|
|
7353
|
+
}
|
|
7354
|
+
},
|
|
6885
7355
|
"/api/v1/organizations/{org_id}/repositories/{repo_id}/file-reviews": {
|
|
6886
7356
|
"post": {
|
|
6887
7357
|
"description": "Reviews up to twenty exact file paths at one pushed commit. Requires live GitHub read access and verifies every path at that commit. The retained selection is immutable; a repeat by the same person returns its review. Results remain in Proofline and are never posted to GitHub.",
|