@proofline/sdk 7.1.0 → 7.2.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/operations.d.ts +2 -0
- package/dist/operations.js +3 -0
- package/dist/schema.d.ts +270 -2
- package/dist/transport.js +1 -1
- package/openapi.public.json +654 -3
- package/package.json +1 -1
package/dist/operations.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ export type StartAgentSessionBody = NonNullable<paths["/api/v1/organizations/{or
|
|
|
8
8
|
export type GetFindingFixPromptParameters = paths["/api/v1/organizations/{org_id}/findings/{finding_id}/fix-prompt"]["get"]["parameters"];
|
|
9
9
|
export type RequestCommitReviewParameters = paths["/api/v1/organizations/{org_id}/repositories/{repo_id}/commit-reviews"]["post"]["parameters"];
|
|
10
10
|
export type RequestCommitReviewBody = NonNullable<paths["/api/v1/organizations/{org_id}/repositories/{repo_id}/commit-reviews"]["post"]["requestBody"]>["content"]["application/json"];
|
|
11
|
+
export type GetCommitDeployVerificationsParameters = paths["/api/v1/organizations/{org_id}/repositories/{repo_id}/commits/{commit_sha}/deploy-verifications"]["get"]["parameters"];
|
|
11
12
|
export type UploadCoverageReportsParameters = paths["/api/v1/organizations/{org_id}/repositories/{repo_id}/coverage-reports"]["post"]["parameters"];
|
|
12
13
|
export type UploadCoverageReportsBody = NonNullable<paths["/api/v1/organizations/{org_id}/repositories/{repo_id}/coverage-reports"]["post"]["requestBody"]>["content"]["application/json"];
|
|
13
14
|
export type RequestFileReviewParameters = paths["/api/v1/organizations/{org_id}/repositories/{repo_id}/file-reviews"]["post"]["parameters"];
|
|
@@ -38,6 +39,7 @@ export declare class Operations {
|
|
|
38
39
|
startAgentSession(parameters: StartAgentSessionParameters, body: StartAgentSessionBody): Promise<components["schemas"]["AgentSession"]>;
|
|
39
40
|
getFindingFixPrompt(parameters: GetFindingFixPromptParameters): Promise<components["schemas"]["FindingFixPrompt"]>;
|
|
40
41
|
requestCommitReview(parameters: RequestCommitReviewParameters, body: RequestCommitReviewBody): Promise<components["schemas"]["CommitReviewResponse"]>;
|
|
42
|
+
getCommitDeployVerifications(parameters: GetCommitDeployVerificationsParameters): Promise<components["schemas"]["CommitDeployVerifications"]>;
|
|
41
43
|
uploadCoverageReports(parameters: UploadCoverageReportsParameters, body: UploadCoverageReportsBody): Promise<components["schemas"]["CoverageUploadResponse"]>;
|
|
42
44
|
requestFileReview(parameters: RequestFileReviewParameters, body: RequestFileReviewBody): Promise<components["schemas"]["FileReviewResponse"]>;
|
|
43
45
|
requestPatchReview(parameters: RequestPatchReviewParameters, body: RequestPatchReviewBody): Promise<components["schemas"]["PatchReviewResponse"]>;
|
package/dist/operations.js
CHANGED
|
@@ -21,6 +21,9 @@ export class Operations {
|
|
|
21
21
|
requestCommitReview(parameters, body) {
|
|
22
22
|
return this.invoke("POST", "/api/v1/organizations/{org_id}/repositories/{repo_id}/commit-reviews", parameters, body);
|
|
23
23
|
}
|
|
24
|
+
getCommitDeployVerifications(parameters) {
|
|
25
|
+
return this.invoke("GET", "/api/v1/organizations/{org_id}/repositories/{repo_id}/commits/{commit_sha}/deploy-verifications", parameters);
|
|
26
|
+
}
|
|
24
27
|
uploadCoverageReports(parameters, body) {
|
|
25
28
|
return this.invoke("POST", "/api/v1/organizations/{org_id}/repositories/{repo_id}/coverage-reports", parameters, body);
|
|
26
29
|
}
|
package/dist/schema.d.ts
CHANGED
|
@@ -144,6 +144,26 @@ export interface paths {
|
|
|
144
144
|
patch?: never;
|
|
145
145
|
trace?: never;
|
|
146
146
|
};
|
|
147
|
+
"/api/v1/organizations/{org_id}/repositories/{repo_id}/commits/{commit_sha}/deploy-verifications": {
|
|
148
|
+
parameters: {
|
|
149
|
+
query?: never;
|
|
150
|
+
header?: never;
|
|
151
|
+
path?: never;
|
|
152
|
+
cookie?: never;
|
|
153
|
+
};
|
|
154
|
+
/**
|
|
155
|
+
* Get a commit's deploy verifications
|
|
156
|
+
* @description Returns each deploy of one exact commit in the repository that Proofline recorded, across the organization's environments: its environment ID, GitHub Environment, task, workflow run and attempt, where its verification stands, whether a check regressed, each check's result and due time, the gaps that leave it unproven and its console page. `commit_sha` must be a full 40-character lowercase commit SHA; a branch, tag or abbreviated SHA gets 400. A commit with no recorded deploy returns `recorded: false` and no deploys, which is never a result about a deploy. A repository outside the token's repository restriction or organization returns 404.
|
|
157
|
+
*/
|
|
158
|
+
get: operations["get_commit_deploy_verifications"];
|
|
159
|
+
put?: never;
|
|
160
|
+
post?: never;
|
|
161
|
+
delete?: never;
|
|
162
|
+
options?: never;
|
|
163
|
+
head?: never;
|
|
164
|
+
patch?: never;
|
|
165
|
+
trace?: never;
|
|
166
|
+
};
|
|
147
167
|
"/api/v1/organizations/{org_id}/repositories/{repo_id}/coverage-reports": {
|
|
148
168
|
parameters: {
|
|
149
169
|
query?: never;
|
|
@@ -814,6 +834,65 @@ export interface components {
|
|
|
814
834
|
/** @description The reaction as GitHub names it. */
|
|
815
835
|
reaction: components["schemas"]["CommentReaction"];
|
|
816
836
|
};
|
|
837
|
+
/** @description One deploy of the commit and where its verification stands. */
|
|
838
|
+
CommitDeploy: {
|
|
839
|
+
/**
|
|
840
|
+
* @description The four checks in order, each with its recorded result, if any, and
|
|
841
|
+
* when a missing one becomes overdue. Empty when no verification of
|
|
842
|
+
* the deploy exists.
|
|
843
|
+
*/
|
|
844
|
+
checkpoints: components["schemas"]["DeployCoverageCheckpoint"][];
|
|
845
|
+
/** @description The deploy's console page. */
|
|
846
|
+
deploy_url?: string | null;
|
|
847
|
+
/** @description The GitHub deployment's task, such as `deploy` or `deploy:web`. */
|
|
848
|
+
deployment_task?: string | null;
|
|
849
|
+
/**
|
|
850
|
+
* Format: uuid
|
|
851
|
+
* @description The Proofline environment that holds the deploy.
|
|
852
|
+
*/
|
|
853
|
+
environment_id: string;
|
|
854
|
+
/** @description What the checks that leave the deploy unproven name. */
|
|
855
|
+
gaps: components["schemas"]["DeployVerificationGap"][];
|
|
856
|
+
/** @description The GitHub Environment the deployment named. */
|
|
857
|
+
github_environment?: string | null;
|
|
858
|
+
/** @description Whether any check recorded `REGRESSED`, whatever its gaps. */
|
|
859
|
+
regressed: boolean;
|
|
860
|
+
/** @description Where the deploy's verification stands. */
|
|
861
|
+
state: components["schemas"]["DeployCoverageState"];
|
|
862
|
+
/**
|
|
863
|
+
* Format: int64
|
|
864
|
+
* @description The attempt of that run that created the deployment addressing the
|
|
865
|
+
* deploy; above 1 for a rerun.
|
|
866
|
+
*/
|
|
867
|
+
workflow_run_attempt?: number | null;
|
|
868
|
+
/**
|
|
869
|
+
* @description Each distinct attempt of that run that created one of the deploy's
|
|
870
|
+
* deployments, ascending. A retry of a job that failed belongs to the
|
|
871
|
+
* deploy it retried, and a re-run of a job that had already landed is a
|
|
872
|
+
* deploy of its own. Absent outside Actions and when no recorded
|
|
873
|
+
* deployment of the deploy names its attempt.
|
|
874
|
+
*/
|
|
875
|
+
workflow_run_attempts?: number[];
|
|
876
|
+
/**
|
|
877
|
+
* Format: int64
|
|
878
|
+
* @description The Actions run that created the deploy's deployments; absent outside
|
|
879
|
+
* Actions.
|
|
880
|
+
*/
|
|
881
|
+
workflow_run_id?: number | null;
|
|
882
|
+
};
|
|
883
|
+
/**
|
|
884
|
+
* @description The deploys of one commit that Proofline recorded, across the
|
|
885
|
+
* organization's environments.
|
|
886
|
+
*/
|
|
887
|
+
CommitDeployVerifications: {
|
|
888
|
+
/** @description Each recorded deploy, earliest landing first. */
|
|
889
|
+
deploys: components["schemas"]["CommitDeploy"][];
|
|
890
|
+
/**
|
|
891
|
+
* @description Whether the ledger holds any deploy of the commit. `false` says only
|
|
892
|
+
* that none was recorded, never anything about a deploy.
|
|
893
|
+
*/
|
|
894
|
+
recorded: boolean;
|
|
895
|
+
};
|
|
817
896
|
/**
|
|
818
897
|
* @description Pushed commits to review: the exact base the change is compared with and
|
|
819
898
|
* the exact head it ends at.
|
|
@@ -1559,7 +1638,8 @@ export interface components {
|
|
|
1559
1638
|
/**
|
|
1560
1639
|
* @description What Proofline still has open for the reviewed head, counted from the
|
|
1561
1640
|
* current finding decisions. Absent while the review is `PENDING` or
|
|
1562
|
-
* `RUNNING
|
|
1641
|
+
* `RUNNING`, and for a repository audit, whose findings are in its
|
|
1642
|
+
* report.
|
|
1563
1643
|
*/
|
|
1564
1644
|
open_items?: components["schemas"]["OpenItemsView"] | null;
|
|
1565
1645
|
/**
|
|
@@ -1672,6 +1752,12 @@ export interface components {
|
|
|
1672
1752
|
* it submitted none.
|
|
1673
1753
|
*/
|
|
1674
1754
|
review_comment_url?: string | null;
|
|
1755
|
+
/**
|
|
1756
|
+
* Format: int64
|
|
1757
|
+
* @description The review work within the total, excluding the separately billed PR
|
|
1758
|
+
* walkthrough. Visible to the same callers as the total.
|
|
1759
|
+
*/
|
|
1760
|
+
review_cost_microcredits?: number | null;
|
|
1675
1761
|
/**
|
|
1676
1762
|
* Format: date-time
|
|
1677
1763
|
* @description When a submitted pull request review was marked retracted, a marker
|
|
@@ -1754,6 +1840,31 @@ export interface components {
|
|
|
1754
1840
|
};
|
|
1755
1841
|
/** @enum {string} */
|
|
1756
1842
|
DeepReviewEscalationStatus: "UNEVALUATED" | "REFUSED" | "ADMITTED" | "NOT_SELECTED";
|
|
1843
|
+
DeployCheckResult: "HEALTHY" | "REGRESSED" | "SUPERSEDED" | "INCOMPLETE";
|
|
1844
|
+
/**
|
|
1845
|
+
* @description One of the four checks of a deploy.
|
|
1846
|
+
* @enum {string}
|
|
1847
|
+
*/
|
|
1848
|
+
DeployCheckpoint: "LANDING" | "MINUTES_20" | "HOUR_1" | "DAY_1";
|
|
1849
|
+
/** @description One checkpoint of a verified deploy. */
|
|
1850
|
+
DeployCoverageCheckpoint: {
|
|
1851
|
+
checkpoint: components["schemas"]["DeployCheckpoint"];
|
|
1852
|
+
/**
|
|
1853
|
+
* Format: date-time
|
|
1854
|
+
* @description When a missing check becomes overdue, allowing the workflow's read
|
|
1855
|
+
* delay, landing inventory reread, successor wait and transient-read retries.
|
|
1856
|
+
*/
|
|
1857
|
+
due_at: string;
|
|
1858
|
+
/** @description The recorded result; absent while no check of this window is recorded. */
|
|
1859
|
+
result?: components["schemas"]["DeployCheckResult"] | null;
|
|
1860
|
+
};
|
|
1861
|
+
/**
|
|
1862
|
+
* @description Where one deploy's verification stands. Each deploy has exactly one, so
|
|
1863
|
+
* the counts add up to the population.
|
|
1864
|
+
*/
|
|
1865
|
+
DeployCoverageState: "VERIFIED" | "VERIFIED_UNTIL_SUPERSEDED" | "SUPERSEDED" | "INCOMPLETE" | "UNRECORDED" | "NOT_YET_DUE" | "UNVERIFIED" | "FAILED" | "INACTIVE";
|
|
1866
|
+
/** @description A named reason a check could not establish part of what it compares. */
|
|
1867
|
+
DeployVerificationGap: "CHANGE_CHECK_MISSING" | "CHANGE_CHECK_INCOMPLETE" | "ENVIRONMENT_NOT_CHECKED" | "RUNNING_REVISION_UNKNOWN" | "RUNTIME_TARGET_UNAVAILABLE" | "RUNTIME_CAPABILITY_UNQUALIFIED" | "AWS_TELEMETRY_CONNECTION_UNAVAILABLE" | "RUNTIME_INVENTORY_UNAVAILABLE" | "RUNTIME_INVENTORY_STALE" | "RUNTIME_INVENTORY_INCOMPLETE" | "RUNTIME_SERVICE_UNKNOWN" | "RUNTIME_TRAFFIC_UNKNOWN" | "RUNTIME_REVISION_UNKNOWN" | "RUNTIME_ROLLOUT_UNSETTLED" | "RUNTIME_COMMIT_BINDING_MISSING" | "RUNTIME_ATTESTATIONS_PERMISSION_PENDING" | "RUNTIME_IMAGE_BUILT_EARLIER" | "RUNTIME_TASK_UNMAPPED" | "TELEMETRY_CONNECTION_UNAVAILABLE" | "TELEMETRY_CREDENTIAL_UNAVAILABLE" | "NO_SIGNALS_CONFIGURED" | "NO_SIGNALS_FOR_TASK_SERVICES" | "SIGNAL_PROJECT_NOT_CONNECTED" | "SIGNAL_CONFIGURATION_INVALID" | "SIGNAL_RESPONSE_INVALID" | "SIGNAL_READ_PARTIAL" | "SIGNAL_READ_UNAVAILABLE" | "SIGNAL_NO_DATA" | "SIGNAL_NOT_SINGLE_SERIES" | "SIGNAL_BUCKET_UNEXPECTED" | "BASELINE_UNAVAILABLE" | "BELOW_TRAFFIC_FLOOR" | "BASELINE_HELD_REGRESSION";
|
|
1757
1868
|
DomainView: {
|
|
1758
1869
|
/** @description The risk domain this evaluation covers. */
|
|
1759
1870
|
domain: string;
|
|
@@ -2303,6 +2414,8 @@ export interface components {
|
|
|
2303
2414
|
* recorded it (`incompleteness_kind`), or `UNKNOWN` when none did.
|
|
2304
2415
|
*/
|
|
2305
2416
|
IncompleteCause: ("NOT_CONFIGURED" | "POLICY_EXCLUDED" | "EVIDENCE_UNAVAILABLE" | "HYPOTHESES_UNRESOLVED" | "MODEL_BUDGET_EXHAUSTED") | "UNKNOWN";
|
|
2417
|
+
/** @description What published a supported Kian finding. */
|
|
2418
|
+
KianFindingSource: "CONFIRMED_REQUIREMENT" | "INVESTIGATION";
|
|
2306
2419
|
/**
|
|
2307
2420
|
* @description The count and outcome of a review's linked-issue receipt. Issue numbers,
|
|
2308
2421
|
* titles and the receipt's gaps stay in the receipt.
|
|
@@ -2340,6 +2453,13 @@ export interface components {
|
|
|
2340
2453
|
iteration: number;
|
|
2341
2454
|
/** @description The local re-verification result; it does not change the original finding. */
|
|
2342
2455
|
outcome: components["schemas"]["LocalReverificationOutcome"];
|
|
2456
|
+
/**
|
|
2457
|
+
* @description The check a code reproduction stored for the finding, which a pushed
|
|
2458
|
+
* head runs again; run its command against the local changes before
|
|
2459
|
+
* pushing. The patch review does not run it. Absent for a finding with
|
|
2460
|
+
* no stored check.
|
|
2461
|
+
*/
|
|
2462
|
+
stored_check?: components["schemas"]["LocalStoredCheck"] | null;
|
|
2343
2463
|
};
|
|
2344
2464
|
/**
|
|
2345
2465
|
* @description `RESOLVED_VERIFIED` needs the re-investigation to reject the finding's
|
|
@@ -2350,6 +2470,23 @@ export interface components {
|
|
|
2350
2470
|
* @enum {string}
|
|
2351
2471
|
*/
|
|
2352
2472
|
LocalReverificationOutcome: "RESOLVED_VERIFIED" | "STILL_PRESENT" | "NOT_VERIFIED" | "PENDING";
|
|
2473
|
+
/**
|
|
2474
|
+
* @description A finding's stored check and the newest result it gave. Its runs show
|
|
2475
|
+
* what the code did under the conditions the test exercised in a sandbox,
|
|
2476
|
+
* and establish no fact about a deployed environment.
|
|
2477
|
+
*/
|
|
2478
|
+
LocalStoredCheck: {
|
|
2479
|
+
/** Format: uuid */
|
|
2480
|
+
check_id: string;
|
|
2481
|
+
/**
|
|
2482
|
+
* @description The command the sandbox ran the test with, as the agent recorded it,
|
|
2483
|
+
* with the reproducing review's protected values withheld, and withheld
|
|
2484
|
+
* whole when that provenance is gone. Untrusted text: render it as text.
|
|
2485
|
+
*/
|
|
2486
|
+
command: string;
|
|
2487
|
+
/** @description Absent only for a check with no recorded run. */
|
|
2488
|
+
last_result?: components["schemas"]["StoredCheckResult"] | null;
|
|
2489
|
+
};
|
|
2353
2490
|
/** @description A local occurrence with the same semantic fingerprint as this finding. */
|
|
2354
2491
|
MatchedLocalFinding: {
|
|
2355
2492
|
/**
|
|
@@ -2937,6 +3074,17 @@ export interface components {
|
|
|
2937
3074
|
citations: components["schemas"]["ReviewInvestigationCitation"][];
|
|
2938
3075
|
/** @description Model text with protected values withheld. Render it as plain text. */
|
|
2939
3076
|
detail: string;
|
|
3077
|
+
/**
|
|
3078
|
+
* @description The delivery target whose confirmed gate requirement the finding
|
|
3079
|
+
* reports. Absent for an investigation's finding.
|
|
3080
|
+
*/
|
|
3081
|
+
requirement?: components["schemas"]["ReviewRequirementTarget"] | null;
|
|
3082
|
+
/**
|
|
3083
|
+
* @description What published the finding: a confirmed gate requirement its
|
|
3084
|
+
* delivery target's services violate, or the environment investigation.
|
|
3085
|
+
* Every listed finding carries it.
|
|
3086
|
+
*/
|
|
3087
|
+
source?: components["schemas"]["KianFindingSource"] | null;
|
|
2940
3088
|
/** @description Model text with protected values withheld. Render it as plain text. */
|
|
2941
3089
|
title: string;
|
|
2942
3090
|
};
|
|
@@ -3059,6 +3207,26 @@ export interface components {
|
|
|
3059
3207
|
/** @description Whether more reviews match the query beyond this page. */
|
|
3060
3208
|
truncated: boolean;
|
|
3061
3209
|
};
|
|
3210
|
+
/**
|
|
3211
|
+
* @description The delivery target whose confirmed entry a finding reports, as its Gate
|
|
3212
|
+
* requirements page addresses it.
|
|
3213
|
+
*/
|
|
3214
|
+
ReviewRequirementTarget: {
|
|
3215
|
+
/**
|
|
3216
|
+
* Format: uuid
|
|
3217
|
+
* @description The delivery target.
|
|
3218
|
+
*/
|
|
3219
|
+
delivery_target_id: string;
|
|
3220
|
+
/**
|
|
3221
|
+
* Format: uuid
|
|
3222
|
+
* @description The environment of the assessment that asked the requirement.
|
|
3223
|
+
*/
|
|
3224
|
+
environment_id: string;
|
|
3225
|
+
/** @description The repository's `owner/name`, which names the target to a reader. */
|
|
3226
|
+
repository_full_name: string;
|
|
3227
|
+
/** @description The repository's name, as the page's address names it. */
|
|
3228
|
+
repository_name: string;
|
|
3229
|
+
};
|
|
3062
3230
|
ReviewRoutingView: {
|
|
3063
3231
|
/** @constant */
|
|
3064
3232
|
status: "NOT_RECORDED";
|
|
@@ -3532,7 +3700,10 @@ export interface components {
|
|
|
3532
3700
|
};
|
|
3533
3701
|
/** @enum {string} */
|
|
3534
3702
|
SpendAccountKind: "DEPLOYMENT" | "TENANT_CREDENTIAL" | "UNATTRIBUTED";
|
|
3535
|
-
/**
|
|
3703
|
+
/**
|
|
3704
|
+
* @description UTC daily debit totals using only the account and transport recorded at
|
|
3705
|
+
* charge time, each split by what paid for it as Billing's Usage splits it.
|
|
3706
|
+
*/
|
|
3536
3707
|
SpendExportRow: {
|
|
3537
3708
|
/** @description Recorded attribution, not a current credential label or inferred account. */
|
|
3538
3709
|
account?: string | null;
|
|
@@ -3553,6 +3724,13 @@ export interface components {
|
|
|
3553
3724
|
* @description The number of debits summed into this row.
|
|
3554
3725
|
*/
|
|
3555
3726
|
debits: number;
|
|
3727
|
+
/**
|
|
3728
|
+
* Format: int64
|
|
3729
|
+
* @description The part the free review month paid: this organization's
|
|
3730
|
+
* `free-review:{debit}` grants for the row's debits.
|
|
3731
|
+
* @default 0
|
|
3732
|
+
*/
|
|
3733
|
+
free_review_microcredits?: number;
|
|
3556
3734
|
/**
|
|
3557
3735
|
* Format: int64
|
|
3558
3736
|
* @description Exact integer charge units; one credit contains one million microcredits.
|
|
@@ -3563,6 +3741,26 @@ export interface components {
|
|
|
3563
3741
|
* @description The organization charged.
|
|
3564
3742
|
*/
|
|
3565
3743
|
organization_id: string;
|
|
3744
|
+
/**
|
|
3745
|
+
* Format: int64
|
|
3746
|
+
* @description The part the organization's shared credit balance paid.
|
|
3747
|
+
* @default 0
|
|
3748
|
+
*/
|
|
3749
|
+
organization_microcredits?: number;
|
|
3750
|
+
/**
|
|
3751
|
+
* Format: int64
|
|
3752
|
+
* @description The part run on this organization's own provider key: a tariff
|
|
3753
|
+
* equivalent its provider bills, not credit spend. The four funding
|
|
3754
|
+
* columns add up to `microcredits`.
|
|
3755
|
+
* @default 0
|
|
3756
|
+
*/
|
|
3757
|
+
own_key_microcredits?: number;
|
|
3758
|
+
/**
|
|
3759
|
+
* Format: int64
|
|
3760
|
+
* @description The part of `microcredits` the workspace allowance or the author's seat paid.
|
|
3761
|
+
* @default 0
|
|
3762
|
+
*/
|
|
3763
|
+
plan_microcredits?: number;
|
|
3566
3764
|
/** @description The model transport recorded at charge time, null when the debit records none. */
|
|
3567
3765
|
transport?: string | null;
|
|
3568
3766
|
};
|
|
@@ -3592,6 +3790,36 @@ export interface components {
|
|
|
3592
3790
|
/** @description Person who stopped the review. */
|
|
3593
3791
|
stopped_by: components["schemas"]["ActorView"];
|
|
3594
3792
|
};
|
|
3793
|
+
/**
|
|
3794
|
+
* @description What the test did: `FAILED` as at the reproduction or otherwise,
|
|
3795
|
+
* `DID_NOT_FAIL` when it exited cleanly, which shows only that this test
|
|
3796
|
+
* did not fail under the conditions it exercised, or `UNAVAILABLE` when it
|
|
3797
|
+
* could not answer.
|
|
3798
|
+
* @enum {string}
|
|
3799
|
+
*/
|
|
3800
|
+
StoredCheckOutcome: "FAILED" | "DID_NOT_FAIL" | "UNAVAILABLE";
|
|
3801
|
+
/**
|
|
3802
|
+
* @description The newest result of a stored check: its newest settled rerun at a later
|
|
3803
|
+
* pull request head, or the reproduction's own head run when it has not
|
|
3804
|
+
* run again.
|
|
3805
|
+
*/
|
|
3806
|
+
StoredCheckResult: {
|
|
3807
|
+
/**
|
|
3808
|
+
* @description The commit the check ran at, or would have run at when a rerun could
|
|
3809
|
+
* not start.
|
|
3810
|
+
*/
|
|
3811
|
+
commit_sha?: string | null;
|
|
3812
|
+
/**
|
|
3813
|
+
* @description Why a rerun did not pass, such as `STILL_FAILS` or
|
|
3814
|
+
* `SERVICE_NOT_STARTED`. Absent for a pass and for the reproduction.
|
|
3815
|
+
*/
|
|
3816
|
+
reason?: string | null;
|
|
3817
|
+
result: components["schemas"]["StoredCheckOutcome"];
|
|
3818
|
+
/** @description `RERUN` or `REPRODUCTION`. */
|
|
3819
|
+
source: components["schemas"]["StoredCheckResultSource"];
|
|
3820
|
+
};
|
|
3821
|
+
/** @enum {string} */
|
|
3822
|
+
StoredCheckResultSource: "REPRODUCTION" | "RERUN";
|
|
3595
3823
|
/**
|
|
3596
3824
|
* @description One assessment's authorization of one subject, by identity.
|
|
3597
3825
|
*
|
|
@@ -4084,6 +4312,46 @@ export interface operations {
|
|
|
4084
4312
|
};
|
|
4085
4313
|
};
|
|
4086
4314
|
};
|
|
4315
|
+
get_commit_deploy_verifications: {
|
|
4316
|
+
parameters: {
|
|
4317
|
+
query?: never;
|
|
4318
|
+
header?: never;
|
|
4319
|
+
path: {
|
|
4320
|
+
/**
|
|
4321
|
+
* @description The full 40-character lowercase commit SHA the job deployed. A branch,
|
|
4322
|
+
* tag or abbreviated SHA is refused.
|
|
4323
|
+
*/
|
|
4324
|
+
commit_sha: string;
|
|
4325
|
+
org_id: string;
|
|
4326
|
+
repo_id: string;
|
|
4327
|
+
};
|
|
4328
|
+
cookie?: never;
|
|
4329
|
+
};
|
|
4330
|
+
requestBody?: never;
|
|
4331
|
+
responses: {
|
|
4332
|
+
/**
|
|
4333
|
+
* @description The deploys of one commit that Proofline recorded, across the
|
|
4334
|
+
* organization's environments.
|
|
4335
|
+
*/
|
|
4336
|
+
200: {
|
|
4337
|
+
headers: {
|
|
4338
|
+
[name: string]: unknown;
|
|
4339
|
+
};
|
|
4340
|
+
content: {
|
|
4341
|
+
"application/json": components["schemas"]["CommitDeployVerifications"];
|
|
4342
|
+
};
|
|
4343
|
+
};
|
|
4344
|
+
/** @description An RFC 9457 problem; the HTTP status remains authoritative. */
|
|
4345
|
+
default: {
|
|
4346
|
+
headers: {
|
|
4347
|
+
[name: string]: unknown;
|
|
4348
|
+
};
|
|
4349
|
+
content: {
|
|
4350
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
4351
|
+
};
|
|
4352
|
+
};
|
|
4353
|
+
};
|
|
4354
|
+
};
|
|
4087
4355
|
upload_coverage_reports: {
|
|
4088
4356
|
parameters: {
|
|
4089
4357
|
query?: never;
|
package/dist/transport.js
CHANGED
package/openapi.public.json
CHANGED
|
@@ -798,6 +798,116 @@
|
|
|
798
798
|
],
|
|
799
799
|
"type": "object"
|
|
800
800
|
},
|
|
801
|
+
"CommitDeploy": {
|
|
802
|
+
"description": "One deploy of the commit and where its verification stands.",
|
|
803
|
+
"properties": {
|
|
804
|
+
"checkpoints": {
|
|
805
|
+
"description": "The four checks in order, each with its recorded result, if any, and\n when a missing one becomes overdue. Empty when no verification of\n the deploy exists.",
|
|
806
|
+
"items": {
|
|
807
|
+
"$ref": "#/components/schemas/DeployCoverageCheckpoint"
|
|
808
|
+
},
|
|
809
|
+
"type": "array"
|
|
810
|
+
},
|
|
811
|
+
"deploy_url": {
|
|
812
|
+
"description": "The deploy's console page.",
|
|
813
|
+
"type": [
|
|
814
|
+
"string",
|
|
815
|
+
"null"
|
|
816
|
+
]
|
|
817
|
+
},
|
|
818
|
+
"deployment_task": {
|
|
819
|
+
"description": "The GitHub deployment's task, such as `deploy` or `deploy:web`.",
|
|
820
|
+
"type": [
|
|
821
|
+
"string",
|
|
822
|
+
"null"
|
|
823
|
+
]
|
|
824
|
+
},
|
|
825
|
+
"environment_id": {
|
|
826
|
+
"description": "The Proofline environment that holds the deploy.",
|
|
827
|
+
"format": "uuid",
|
|
828
|
+
"type": "string"
|
|
829
|
+
},
|
|
830
|
+
"gaps": {
|
|
831
|
+
"description": "What the checks that leave the deploy unproven name.",
|
|
832
|
+
"items": {
|
|
833
|
+
"$ref": "#/components/schemas/DeployVerificationGap"
|
|
834
|
+
},
|
|
835
|
+
"type": "array"
|
|
836
|
+
},
|
|
837
|
+
"github_environment": {
|
|
838
|
+
"description": "The GitHub Environment the deployment named.",
|
|
839
|
+
"type": [
|
|
840
|
+
"string",
|
|
841
|
+
"null"
|
|
842
|
+
]
|
|
843
|
+
},
|
|
844
|
+
"regressed": {
|
|
845
|
+
"description": "Whether any check recorded `REGRESSED`, whatever its gaps.",
|
|
846
|
+
"type": "boolean"
|
|
847
|
+
},
|
|
848
|
+
"state": {
|
|
849
|
+
"allOf": [
|
|
850
|
+
{
|
|
851
|
+
"$ref": "#/components/schemas/DeployCoverageState"
|
|
852
|
+
}
|
|
853
|
+
],
|
|
854
|
+
"description": "Where the deploy's verification stands."
|
|
855
|
+
},
|
|
856
|
+
"workflow_run_attempt": {
|
|
857
|
+
"description": "The attempt of that run that created the deployment addressing the\n deploy; above 1 for a rerun.",
|
|
858
|
+
"format": "int64",
|
|
859
|
+
"type": [
|
|
860
|
+
"integer",
|
|
861
|
+
"null"
|
|
862
|
+
]
|
|
863
|
+
},
|
|
864
|
+
"workflow_run_attempts": {
|
|
865
|
+
"description": "Each distinct attempt of that run that created one of the deploy's\n deployments, ascending. A retry of a job that failed belongs to the\n deploy it retried, and a re-run of a job that had already landed is a\n deploy of its own. Absent outside Actions and when no recorded\n deployment of the deploy names its attempt.",
|
|
866
|
+
"items": {
|
|
867
|
+
"format": "int64",
|
|
868
|
+
"type": "integer"
|
|
869
|
+
},
|
|
870
|
+
"type": "array"
|
|
871
|
+
},
|
|
872
|
+
"workflow_run_id": {
|
|
873
|
+
"description": "The Actions run that created the deploy's deployments; absent outside\n Actions.",
|
|
874
|
+
"format": "int64",
|
|
875
|
+
"type": [
|
|
876
|
+
"integer",
|
|
877
|
+
"null"
|
|
878
|
+
]
|
|
879
|
+
}
|
|
880
|
+
},
|
|
881
|
+
"required": [
|
|
882
|
+
"environment_id",
|
|
883
|
+
"state",
|
|
884
|
+
"regressed",
|
|
885
|
+
"checkpoints",
|
|
886
|
+
"gaps"
|
|
887
|
+
],
|
|
888
|
+
"type": "object"
|
|
889
|
+
},
|
|
890
|
+
"CommitDeployVerifications": {
|
|
891
|
+
"description": "The deploys of one commit that Proofline recorded, across the\n organization's environments.",
|
|
892
|
+
"properties": {
|
|
893
|
+
"deploys": {
|
|
894
|
+
"description": "Each recorded deploy, earliest landing first.",
|
|
895
|
+
"items": {
|
|
896
|
+
"$ref": "#/components/schemas/CommitDeploy"
|
|
897
|
+
},
|
|
898
|
+
"type": "array"
|
|
899
|
+
},
|
|
900
|
+
"recorded": {
|
|
901
|
+
"description": "Whether the ledger holds any deploy of the commit. `false` says only\n that none was recorded, never anything about a deploy.",
|
|
902
|
+
"type": "boolean"
|
|
903
|
+
}
|
|
904
|
+
},
|
|
905
|
+
"required": [
|
|
906
|
+
"recorded",
|
|
907
|
+
"deploys"
|
|
908
|
+
],
|
|
909
|
+
"type": "object"
|
|
910
|
+
},
|
|
801
911
|
"CommitReviewRequest": {
|
|
802
912
|
"additionalProperties": false,
|
|
803
913
|
"description": "Pushed commits to review: the exact base the change is compared with and\n the exact head it ends at.",
|
|
@@ -1960,7 +2070,7 @@
|
|
|
1960
2070
|
"type": "null"
|
|
1961
2071
|
}
|
|
1962
2072
|
],
|
|
1963
|
-
"description": "What Proofline still has open for the reviewed head, counted from the\n current finding decisions. Absent while the review is `PENDING` or\n `RUNNING
|
|
2073
|
+
"description": "What Proofline still has open for the reviewed head, counted from the\n current finding decisions. Absent while the review is `PENDING` or\n `RUNNING`, and for a repository audit, whose findings are in its\n report."
|
|
1964
2074
|
},
|
|
1965
2075
|
"open_items_observation": {
|
|
1966
2076
|
"anyOf": [
|
|
@@ -2147,6 +2257,14 @@
|
|
|
2147
2257
|
"null"
|
|
2148
2258
|
]
|
|
2149
2259
|
},
|
|
2260
|
+
"review_cost_microcredits": {
|
|
2261
|
+
"description": "The review work within the total, excluding the separately billed PR\n walkthrough. Visible to the same callers as the total.",
|
|
2262
|
+
"format": "int64",
|
|
2263
|
+
"type": [
|
|
2264
|
+
"integer",
|
|
2265
|
+
"null"
|
|
2266
|
+
]
|
|
2267
|
+
},
|
|
2150
2268
|
"review_retracted_at": {
|
|
2151
2269
|
"description": "When a submitted pull request review was marked retracted, a marker\n only older versions set. Null otherwise.",
|
|
2152
2270
|
"format": "date-time",
|
|
@@ -2309,6 +2427,289 @@
|
|
|
2309
2427
|
],
|
|
2310
2428
|
"type": "string"
|
|
2311
2429
|
},
|
|
2430
|
+
"DeployCheckResult": {
|
|
2431
|
+
"oneOf": [
|
|
2432
|
+
{
|
|
2433
|
+
"const": "HEALTHY",
|
|
2434
|
+
"description": "The deployed revision runs, a completed change check covered it, and\n every signal the deploy compares was read in full and stayed within\n tolerance. A deploy whose task the delivery target maps to services\n compares only the signals that name no service and those that name\n one of its services in the signal's Cloud Run project, and in its\n location when it names one, or in the signal's ECS account and region,\n and in its cluster when it names one. Every other deploy compares\n every watched signal. With none watched, every ECS service's rollout\n completed instead.",
|
|
2435
|
+
"type": "string"
|
|
2436
|
+
},
|
|
2437
|
+
{
|
|
2438
|
+
"const": "REGRESSED",
|
|
2439
|
+
"description": "The deploy stopped running after it landed, its own ECS rollout\n failed, or a signal moved past its tolerance in the worse direction.",
|
|
2440
|
+
"type": "string"
|
|
2441
|
+
},
|
|
2442
|
+
{
|
|
2443
|
+
"const": "SUPERSEDED",
|
|
2444
|
+
"description": "A later deploy of another revision replaced this one.",
|
|
2445
|
+
"type": "string"
|
|
2446
|
+
},
|
|
2447
|
+
{
|
|
2448
|
+
"const": "INCOMPLETE",
|
|
2449
|
+
"description": "Nothing regressed, and at least one gap leaves the check unproven.",
|
|
2450
|
+
"type": "string"
|
|
2451
|
+
}
|
|
2452
|
+
]
|
|
2453
|
+
},
|
|
2454
|
+
"DeployCheckpoint": {
|
|
2455
|
+
"description": "One of the four checks of a deploy.",
|
|
2456
|
+
"enum": [
|
|
2457
|
+
"LANDING",
|
|
2458
|
+
"MINUTES_20",
|
|
2459
|
+
"HOUR_1",
|
|
2460
|
+
"DAY_1"
|
|
2461
|
+
],
|
|
2462
|
+
"type": "string"
|
|
2463
|
+
},
|
|
2464
|
+
"DeployCoverageCheckpoint": {
|
|
2465
|
+
"description": "One checkpoint of a verified deploy.",
|
|
2466
|
+
"properties": {
|
|
2467
|
+
"checkpoint": {
|
|
2468
|
+
"$ref": "#/components/schemas/DeployCheckpoint"
|
|
2469
|
+
},
|
|
2470
|
+
"due_at": {
|
|
2471
|
+
"description": "When a missing check becomes overdue, allowing the workflow's read\n delay, landing inventory reread, successor wait and transient-read retries.",
|
|
2472
|
+
"format": "date-time",
|
|
2473
|
+
"type": "string"
|
|
2474
|
+
},
|
|
2475
|
+
"result": {
|
|
2476
|
+
"anyOf": [
|
|
2477
|
+
{
|
|
2478
|
+
"$ref": "#/components/schemas/DeployCheckResult"
|
|
2479
|
+
},
|
|
2480
|
+
{
|
|
2481
|
+
"type": "null"
|
|
2482
|
+
}
|
|
2483
|
+
],
|
|
2484
|
+
"description": "The recorded result; absent while no check of this window is recorded."
|
|
2485
|
+
}
|
|
2486
|
+
},
|
|
2487
|
+
"required": [
|
|
2488
|
+
"checkpoint",
|
|
2489
|
+
"due_at"
|
|
2490
|
+
],
|
|
2491
|
+
"type": "object"
|
|
2492
|
+
},
|
|
2493
|
+
"DeployCoverageState": {
|
|
2494
|
+
"description": "Where one deploy's verification stands. Each deploy has exactly one, so\n the counts add up to the population.",
|
|
2495
|
+
"oneOf": [
|
|
2496
|
+
{
|
|
2497
|
+
"const": "VERIFIED",
|
|
2498
|
+
"description": "All four checks recorded `HEALTHY` or `REGRESSED` and none names a\n gap, a change-check gap included.",
|
|
2499
|
+
"type": "string"
|
|
2500
|
+
},
|
|
2501
|
+
{
|
|
2502
|
+
"const": "VERIFIED_UNTIL_SUPERSEDED",
|
|
2503
|
+
"description": "A later deploy of the same task replaced this one after its landing\n check, and every check before then recorded `HEALTHY` or `REGRESSED`\n and names no gap, a change-check gap included.\n The verification observed the deploy for as long as it\n ran; the next deploy's own verification covers the time after.",
|
|
2504
|
+
"type": "string"
|
|
2505
|
+
},
|
|
2506
|
+
{
|
|
2507
|
+
"const": "SUPERSEDED",
|
|
2508
|
+
"description": "A later deploy replaced this one at its landing check, or a check\n before the replacement has no recorded result.",
|
|
2509
|
+
"type": "string"
|
|
2510
|
+
},
|
|
2511
|
+
{
|
|
2512
|
+
"const": "INCOMPLETE",
|
|
2513
|
+
"description": "A check recorded `INCOMPLETE`, or a check other than `SUPERSEDED`\n names a gap, a change-check gap included, whatever it recorded.",
|
|
2514
|
+
"type": "string"
|
|
2515
|
+
},
|
|
2516
|
+
{
|
|
2517
|
+
"const": "UNRECORDED",
|
|
2518
|
+
"description": "A check came due, or the verification run ended, with no result\n recorded for it.",
|
|
2519
|
+
"type": "string"
|
|
2520
|
+
},
|
|
2521
|
+
{
|
|
2522
|
+
"const": "NOT_YET_DUE",
|
|
2523
|
+
"description": "The checks recorded so far established the revision and signals, and\n the next one is not due yet.",
|
|
2524
|
+
"type": "string"
|
|
2525
|
+
},
|
|
2526
|
+
{
|
|
2527
|
+
"const": "UNVERIFIED",
|
|
2528
|
+
"description": "The deploy landed and no verification of it exists in this\n environment, as when it landed while deploy checks were off. A GitHub\n deploy with no verification whose deployments were all first received\n before the environment's link to its repository existed is not in the\n population at all.",
|
|
2529
|
+
"type": "string"
|
|
2530
|
+
},
|
|
2531
|
+
{
|
|
2532
|
+
"const": "FAILED",
|
|
2533
|
+
"description": "The latest status of one of the deploy's GitHub deployments is\n `failure` or `error`, even after it landed; in an Actions run, the\n deployment of the latest attempt of one of its jobs.",
|
|
2534
|
+
"type": "string"
|
|
2535
|
+
},
|
|
2536
|
+
{
|
|
2537
|
+
"const": "INACTIVE",
|
|
2538
|
+
"description": "The ledger holds only `inactive` statuses of the deploy's GitHub\n deployments: it never saw them land or fail.",
|
|
2539
|
+
"type": "string"
|
|
2540
|
+
}
|
|
2541
|
+
]
|
|
2542
|
+
},
|
|
2543
|
+
"DeployVerificationGap": {
|
|
2544
|
+
"description": "A named reason a check could not establish part of what it compares.",
|
|
2545
|
+
"oneOf": [
|
|
2546
|
+
{
|
|
2547
|
+
"const": "CHANGE_CHECK_MISSING",
|
|
2548
|
+
"description": "No review covered the deployed revision.",
|
|
2549
|
+
"type": "string"
|
|
2550
|
+
},
|
|
2551
|
+
{
|
|
2552
|
+
"const": "CHANGE_CHECK_INCOMPLETE",
|
|
2553
|
+
"description": "The change check that covered it did not complete.",
|
|
2554
|
+
"type": "string"
|
|
2555
|
+
},
|
|
2556
|
+
{
|
|
2557
|
+
"const": "ENVIRONMENT_NOT_CHECKED",
|
|
2558
|
+
"description": "A completed review covered the deployed revision but did not assess\n this environment, as a pull request review does while environment\n checks are off. The review is cited; the environment stays unchecked.",
|
|
2559
|
+
"type": "string"
|
|
2560
|
+
},
|
|
2561
|
+
{
|
|
2562
|
+
"const": "RUNNING_REVISION_UNKNOWN",
|
|
2563
|
+
"description": "The ledger shows no running revision for the deploy, or a late check's\n runtime read shows a later deployment of the same task that landed\n after the check came due, so it shows the present and not the window.",
|
|
2564
|
+
"type": "string"
|
|
2565
|
+
},
|
|
2566
|
+
{
|
|
2567
|
+
"const": "RUNTIME_TARGET_UNAVAILABLE",
|
|
2568
|
+
"description": "The check found no runtime to read: the environment names no Cloud\n Run service, the deploy's task is mapped to no approved service, or\n the delivery target's ECS runtime has no connected AWS account. An\n AWS run whose delivery target names no ECS runtime records it too.",
|
|
2569
|
+
"type": "string"
|
|
2570
|
+
},
|
|
2571
|
+
{
|
|
2572
|
+
"const": "RUNTIME_CAPABILITY_UNQUALIFIED",
|
|
2573
|
+
"description": "The AWS runtime was not read, because no serving artifact could yet\n be bound to a repository commit. Checks before AWS serving bindings\n recorded this for every AWS deploy; no check records it now.",
|
|
2574
|
+
"type": "string"
|
|
2575
|
+
},
|
|
2576
|
+
{
|
|
2577
|
+
"const": "AWS_TELEMETRY_CONNECTION_UNAVAILABLE",
|
|
2578
|
+
"description": "No active AWS connection of the environment can read the `CloudWatch`\n signal, or, when every watched signal is a `CloudWatch` signal, any of\n them.",
|
|
2579
|
+
"type": "string"
|
|
2580
|
+
},
|
|
2581
|
+
{
|
|
2582
|
+
"const": "RUNTIME_INVENTORY_UNAVAILABLE",
|
|
2583
|
+
"description": "The check could not read an inventory of the connection's Cloud Run\n services or ECS tasks: Kian retains none, or the read failed or timed\n out. Nothing shows what runs.",
|
|
2584
|
+
"type": "string"
|
|
2585
|
+
},
|
|
2586
|
+
{
|
|
2587
|
+
"const": "RUNTIME_INVENTORY_STALE",
|
|
2588
|
+
"description": "The newest inventory is older than the reader accepts, or was\n observed before the deploy landed, so nothing is read from it.",
|
|
2589
|
+
"type": "string"
|
|
2590
|
+
},
|
|
2591
|
+
{
|
|
2592
|
+
"const": "RUNTIME_INVENTORY_INCOMPLETE",
|
|
2593
|
+
"description": "The newest inventory's collection did not read every table the\n runtime read needs in full, so nothing is read from it.",
|
|
2594
|
+
"type": "string"
|
|
2595
|
+
},
|
|
2596
|
+
{
|
|
2597
|
+
"const": "RUNTIME_SERVICE_UNKNOWN",
|
|
2598
|
+
"description": "The inventory holds no single record of a service the check reads.",
|
|
2599
|
+
"type": "string"
|
|
2600
|
+
},
|
|
2601
|
+
{
|
|
2602
|
+
"const": "RUNTIME_TRAFFIC_UNKNOWN",
|
|
2603
|
+
"description": "A Cloud Run service's traffic shares do not add up to 100 percent,\n so what serves it is unknown.",
|
|
2604
|
+
"type": "string"
|
|
2605
|
+
},
|
|
2606
|
+
{
|
|
2607
|
+
"const": "RUNTIME_REVISION_UNKNOWN",
|
|
2608
|
+
"description": "A serving Cloud Run route names no revision the inventory holds, or\n an ECS service has no running task, more tasks than the reader\n reads, or a running container without an image digest.",
|
|
2609
|
+
"type": "string"
|
|
2610
|
+
},
|
|
2611
|
+
{
|
|
2612
|
+
"const": "RUNTIME_ROLLOUT_UNSETTLED",
|
|
2613
|
+
"description": "An ECS service's rollout has not settled: its primary deployment's\n rollout is not complete, it has more than one deployment, or it runs\n fewer tasks than it wants. When nothing else decides the runtime read,\n the check reads once more, after the next inventory collection, and\n records this only from that read. A failed rollout or a ledger\n successor decides the check at the first read, which records this\n beside it.",
|
|
2614
|
+
"type": "string"
|
|
2615
|
+
},
|
|
2616
|
+
{
|
|
2617
|
+
"const": "RUNTIME_COMMIT_BINDING_MISSING",
|
|
2618
|
+
"description": "A serving revision or container shows no commit: neither a qualified\n attestation of a Cloud Run revision's image digest nor its\n `commit-sha` label names a commit, an ECS image has no single\n qualified attestation of its commit, or every running container was\n built elsewhere.",
|
|
2619
|
+
"type": "string"
|
|
2620
|
+
},
|
|
2621
|
+
{
|
|
2622
|
+
"const": "RUNTIME_ATTESTATIONS_PERMISSION_PENDING",
|
|
2623
|
+
"description": "The running image's commit binding was not read because the\n repository's GitHub installation has not accepted the App's\n attestations permission. It replaces `RuntimeCommitBindingMissing`.",
|
|
2624
|
+
"type": "string"
|
|
2625
|
+
},
|
|
2626
|
+
{
|
|
2627
|
+
"const": "RUNTIME_IMAGE_BUILT_EARLIER",
|
|
2628
|
+
"description": "A running ECS container binds to a commit the deployed revision\n descends from, and the images its ECR repository received after it were\n not all read or bound, so whether a later build at or before the\n deployed revision replaced it is unknown. The newest such build runs the\n deploy, and a replaced one is a mismatch.",
|
|
2629
|
+
"type": "string"
|
|
2630
|
+
},
|
|
2631
|
+
{
|
|
2632
|
+
"const": "RUNTIME_TASK_UNMAPPED",
|
|
2633
|
+
"description": "The repository deploys several GitHub deployment tasks into the\n environment, and its delivery target's task map does not name this\n deploy's task. No other task's services stand for it.",
|
|
2634
|
+
"type": "string"
|
|
2635
|
+
},
|
|
2636
|
+
{
|
|
2637
|
+
"const": "TELEMETRY_CONNECTION_UNAVAILABLE",
|
|
2638
|
+
"description": "Proofline holds no Cloud Monitoring read access for the environment.",
|
|
2639
|
+
"type": "string"
|
|
2640
|
+
},
|
|
2641
|
+
{
|
|
2642
|
+
"const": "TELEMETRY_CREDENTIAL_UNAVAILABLE",
|
|
2643
|
+
"description": "The read credential could not be minted for this window.",
|
|
2644
|
+
"type": "string"
|
|
2645
|
+
},
|
|
2646
|
+
{
|
|
2647
|
+
"const": "NO_SIGNALS_CONFIGURED",
|
|
2648
|
+
"description": "The environment watches no signal. A check whose every ECS service's\n rollout completed records it under the report's `suggestions`\n instead.",
|
|
2649
|
+
"type": "string"
|
|
2650
|
+
},
|
|
2651
|
+
{
|
|
2652
|
+
"const": "NO_SIGNALS_FOR_TASK_SERVICES",
|
|
2653
|
+
"description": "The environment watches signals, but the deploy's task is mapped to\n services and every watched signal names a service the check does not\n compare, so it compared none. A mapped task's check compares a signal\n that names one of its services in the signal's Cloud Run project, and\n in its location when it names one, or in the signal's ECS account and\n region, and in its cluster when it names one.",
|
|
2654
|
+
"type": "string"
|
|
2655
|
+
},
|
|
2656
|
+
{
|
|
2657
|
+
"const": "SIGNAL_PROJECT_NOT_CONNECTED",
|
|
2658
|
+
"description": "No verified Cloud Build connection of the environment reads the\n signal's project. A Cloud Run, GKE or other connection to the same\n project does not read its metrics.",
|
|
2659
|
+
"type": "string"
|
|
2660
|
+
},
|
|
2661
|
+
{
|
|
2662
|
+
"const": "SIGNAL_CONFIGURATION_INVALID",
|
|
2663
|
+
"description": "The signal's descriptors or statistic do not form a valid query, the\n project has no such metric, or the statistic cannot apply to the\n metric's kind and value type.",
|
|
2664
|
+
"type": "string"
|
|
2665
|
+
},
|
|
2666
|
+
{
|
|
2667
|
+
"const": "SIGNAL_RESPONSE_INVALID",
|
|
2668
|
+
"description": "Cloud Monitoring answered with something the reader refused.",
|
|
2669
|
+
"type": "string"
|
|
2670
|
+
},
|
|
2671
|
+
{
|
|
2672
|
+
"const": "SIGNAL_READ_PARTIAL",
|
|
2673
|
+
"description": "The provider read covered only part of the window, for the reason\n the reading records.",
|
|
2674
|
+
"type": "string"
|
|
2675
|
+
},
|
|
2676
|
+
{
|
|
2677
|
+
"const": "SIGNAL_READ_UNAVAILABLE",
|
|
2678
|
+
"description": "The provider read returned nothing for the window, for the reason\n the reading records, such as a refused permission.",
|
|
2679
|
+
"type": "string"
|
|
2680
|
+
},
|
|
2681
|
+
{
|
|
2682
|
+
"const": "SIGNAL_NO_DATA",
|
|
2683
|
+
"description": "A complete read returned no point and the signal does not treat that\n as zero.",
|
|
2684
|
+
"type": "string"
|
|
2685
|
+
},
|
|
2686
|
+
{
|
|
2687
|
+
"const": "SIGNAL_NOT_SINGLE_SERIES",
|
|
2688
|
+
"description": "The provider reduced the read to more than one series.",
|
|
2689
|
+
"type": "string"
|
|
2690
|
+
},
|
|
2691
|
+
{
|
|
2692
|
+
"const": "SIGNAL_BUCKET_UNEXPECTED",
|
|
2693
|
+
"description": "The read returned more than one bucket for the window.",
|
|
2694
|
+
"type": "string"
|
|
2695
|
+
},
|
|
2696
|
+
{
|
|
2697
|
+
"const": "BASELINE_UNAVAILABLE",
|
|
2698
|
+
"description": "The window has a value and its baseline before landing has none.",
|
|
2699
|
+
"type": "string"
|
|
2700
|
+
},
|
|
2701
|
+
{
|
|
2702
|
+
"const": "BELOW_TRAFFIC_FLOOR",
|
|
2703
|
+
"description": "A compared service's traffic signal counted fewer requests than its\n floor in the check's window or in its baseline, so that service's\n other signals say too little to call the check healthy. Each of the\n service's signal reports names the floor, both windows and their\n counts under `traffic`.",
|
|
2704
|
+
"type": "string"
|
|
2705
|
+
},
|
|
2706
|
+
{
|
|
2707
|
+
"const": "BASELINE_HELD_REGRESSION",
|
|
2708
|
+
"description": "An earlier deploy of the same task found the signal regressed in a\n check whose window overlaps the hour before this deploy started, and\n the baseline that check compared with is not usable: its window ended\n more than a day before this deploy started, or the signal would no\n longer send the query it cites. The regressed hour is never compared\n in its place, so the signal is not compared.",
|
|
2709
|
+
"type": "string"
|
|
2710
|
+
}
|
|
2711
|
+
]
|
|
2712
|
+
},
|
|
2312
2713
|
"DomainView": {
|
|
2313
2714
|
"properties": {
|
|
2314
2715
|
"domain": {
|
|
@@ -3628,6 +4029,21 @@
|
|
|
3628
4029
|
}
|
|
3629
4030
|
]
|
|
3630
4031
|
},
|
|
4032
|
+
"KianFindingSource": {
|
|
4033
|
+
"description": "What published a supported Kian finding.",
|
|
4034
|
+
"oneOf": [
|
|
4035
|
+
{
|
|
4036
|
+
"const": "CONFIRMED_REQUIREMENT",
|
|
4037
|
+
"description": "A service violates a confirmed gate requirement of its delivery\n target ([`requirements`]).",
|
|
4038
|
+
"type": "string"
|
|
4039
|
+
},
|
|
4040
|
+
{
|
|
4041
|
+
"const": "INVESTIGATION",
|
|
4042
|
+
"description": "The environment investigation found it ([`kian_investigation`]).",
|
|
4043
|
+
"type": "string"
|
|
4044
|
+
}
|
|
4045
|
+
]
|
|
4046
|
+
},
|
|
3631
4047
|
"LinkedIssueCapture": {
|
|
3632
4048
|
"description": "The count and outcome of a review's linked-issue receipt. Issue numbers,\n titles and the receipt's gaps stay in the receipt.",
|
|
3633
4049
|
"properties": {
|
|
@@ -3694,6 +4110,17 @@
|
|
|
3694
4110
|
}
|
|
3695
4111
|
],
|
|
3696
4112
|
"description": "The local re-verification result; it does not change the original finding."
|
|
4113
|
+
},
|
|
4114
|
+
"stored_check": {
|
|
4115
|
+
"anyOf": [
|
|
4116
|
+
{
|
|
4117
|
+
"$ref": "#/components/schemas/LocalStoredCheck"
|
|
4118
|
+
},
|
|
4119
|
+
{
|
|
4120
|
+
"type": "null"
|
|
4121
|
+
}
|
|
4122
|
+
],
|
|
4123
|
+
"description": "The check a code reproduction stored for the finding, which a pushed\n head runs again; run its command against the local changes before\n pushing. The patch review does not run it. Absent for a finding with\n no stored check."
|
|
3697
4124
|
}
|
|
3698
4125
|
},
|
|
3699
4126
|
"required": [
|
|
@@ -3714,6 +4141,35 @@
|
|
|
3714
4141
|
],
|
|
3715
4142
|
"type": "string"
|
|
3716
4143
|
},
|
|
4144
|
+
"LocalStoredCheck": {
|
|
4145
|
+
"description": "A finding's stored check and the newest result it gave. Its runs show\n what the code did under the conditions the test exercised in a sandbox,\n and establish no fact about a deployed environment.",
|
|
4146
|
+
"properties": {
|
|
4147
|
+
"check_id": {
|
|
4148
|
+
"format": "uuid",
|
|
4149
|
+
"type": "string"
|
|
4150
|
+
},
|
|
4151
|
+
"command": {
|
|
4152
|
+
"description": "The command the sandbox ran the test with, as the agent recorded it,\n with the reproducing review's protected values withheld, and withheld\n whole when that provenance is gone. Untrusted text: render it as text.",
|
|
4153
|
+
"type": "string"
|
|
4154
|
+
},
|
|
4155
|
+
"last_result": {
|
|
4156
|
+
"anyOf": [
|
|
4157
|
+
{
|
|
4158
|
+
"$ref": "#/components/schemas/StoredCheckResult"
|
|
4159
|
+
},
|
|
4160
|
+
{
|
|
4161
|
+
"type": "null"
|
|
4162
|
+
}
|
|
4163
|
+
],
|
|
4164
|
+
"description": "Absent only for a check with no recorded run."
|
|
4165
|
+
}
|
|
4166
|
+
},
|
|
4167
|
+
"required": [
|
|
4168
|
+
"check_id",
|
|
4169
|
+
"command"
|
|
4170
|
+
],
|
|
4171
|
+
"type": "object"
|
|
4172
|
+
},
|
|
3717
4173
|
"MatchedLocalFinding": {
|
|
3718
4174
|
"description": "A local occurrence with the same semantic fingerprint as this finding.",
|
|
3719
4175
|
"properties": {
|
|
@@ -4806,6 +5262,28 @@
|
|
|
4806
5262
|
"description": "Model text with protected values withheld. Render it as plain text.",
|
|
4807
5263
|
"type": "string"
|
|
4808
5264
|
},
|
|
5265
|
+
"requirement": {
|
|
5266
|
+
"anyOf": [
|
|
5267
|
+
{
|
|
5268
|
+
"$ref": "#/components/schemas/ReviewRequirementTarget"
|
|
5269
|
+
},
|
|
5270
|
+
{
|
|
5271
|
+
"type": "null"
|
|
5272
|
+
}
|
|
5273
|
+
],
|
|
5274
|
+
"description": "The delivery target whose confirmed gate requirement the finding\n reports. Absent for an investigation's finding."
|
|
5275
|
+
},
|
|
5276
|
+
"source": {
|
|
5277
|
+
"anyOf": [
|
|
5278
|
+
{
|
|
5279
|
+
"$ref": "#/components/schemas/KianFindingSource"
|
|
5280
|
+
},
|
|
5281
|
+
{
|
|
5282
|
+
"type": "null"
|
|
5283
|
+
}
|
|
5284
|
+
],
|
|
5285
|
+
"description": "What published the finding: a confirmed gate requirement its\n delivery target's services violate, or the environment investigation.\n Every listed finding carries it."
|
|
5286
|
+
},
|
|
4809
5287
|
"title": {
|
|
4810
5288
|
"description": "Model text with protected values withheld. Render it as plain text.",
|
|
4811
5289
|
"type": "string"
|
|
@@ -5007,6 +5485,36 @@
|
|
|
5007
5485
|
],
|
|
5008
5486
|
"type": "object"
|
|
5009
5487
|
},
|
|
5488
|
+
"ReviewRequirementTarget": {
|
|
5489
|
+
"description": "The delivery target whose confirmed entry a finding reports, as its Gate\n requirements page addresses it.",
|
|
5490
|
+
"properties": {
|
|
5491
|
+
"delivery_target_id": {
|
|
5492
|
+
"description": "The delivery target.",
|
|
5493
|
+
"format": "uuid",
|
|
5494
|
+
"type": "string"
|
|
5495
|
+
},
|
|
5496
|
+
"environment_id": {
|
|
5497
|
+
"description": "The environment of the assessment that asked the requirement.",
|
|
5498
|
+
"format": "uuid",
|
|
5499
|
+
"type": "string"
|
|
5500
|
+
},
|
|
5501
|
+
"repository_full_name": {
|
|
5502
|
+
"description": "The repository's `owner/name`, which names the target to a reader.",
|
|
5503
|
+
"type": "string"
|
|
5504
|
+
},
|
|
5505
|
+
"repository_name": {
|
|
5506
|
+
"description": "The repository's name, as the page's address names it.",
|
|
5507
|
+
"type": "string"
|
|
5508
|
+
}
|
|
5509
|
+
},
|
|
5510
|
+
"required": [
|
|
5511
|
+
"environment_id",
|
|
5512
|
+
"repository_name",
|
|
5513
|
+
"repository_full_name",
|
|
5514
|
+
"delivery_target_id"
|
|
5515
|
+
],
|
|
5516
|
+
"type": "object"
|
|
5517
|
+
},
|
|
5010
5518
|
"ReviewRoutingView": {
|
|
5011
5519
|
"oneOf": [
|
|
5012
5520
|
{
|
|
@@ -5938,7 +6446,7 @@
|
|
|
5938
6446
|
"type": "string"
|
|
5939
6447
|
},
|
|
5940
6448
|
"SpendExportRow": {
|
|
5941
|
-
"description": "UTC daily debit totals using only the account and transport recorded at charge time.",
|
|
6449
|
+
"description": "UTC daily debit totals using only the account and transport recorded at\n charge time, each split by what paid for it as Billing's Usage splits it.",
|
|
5942
6450
|
"properties": {
|
|
5943
6451
|
"account": {
|
|
5944
6452
|
"description": "Recorded attribution, not a current credential label or inferred account.",
|
|
@@ -5972,6 +6480,12 @@
|
|
|
5972
6480
|
"format": "int64",
|
|
5973
6481
|
"type": "integer"
|
|
5974
6482
|
},
|
|
6483
|
+
"free_review_microcredits": {
|
|
6484
|
+
"default": 0,
|
|
6485
|
+
"description": "The part the free review month paid: this organization's\n `free-review:{debit}` grants for the row's debits.",
|
|
6486
|
+
"format": "int64",
|
|
6487
|
+
"type": "integer"
|
|
6488
|
+
},
|
|
5975
6489
|
"microcredits": {
|
|
5976
6490
|
"description": "Exact integer charge units; one credit contains one million microcredits.",
|
|
5977
6491
|
"format": "int64",
|
|
@@ -5982,6 +6496,24 @@
|
|
|
5982
6496
|
"format": "uuid",
|
|
5983
6497
|
"type": "string"
|
|
5984
6498
|
},
|
|
6499
|
+
"organization_microcredits": {
|
|
6500
|
+
"default": 0,
|
|
6501
|
+
"description": "The part the organization's shared credit balance paid.",
|
|
6502
|
+
"format": "int64",
|
|
6503
|
+
"type": "integer"
|
|
6504
|
+
},
|
|
6505
|
+
"own_key_microcredits": {
|
|
6506
|
+
"default": 0,
|
|
6507
|
+
"description": "The part run on this organization's own provider key: a tariff\n equivalent its provider bills, not credit spend. The four funding\n columns add up to `microcredits`.",
|
|
6508
|
+
"format": "int64",
|
|
6509
|
+
"type": "integer"
|
|
6510
|
+
},
|
|
6511
|
+
"plan_microcredits": {
|
|
6512
|
+
"default": 0,
|
|
6513
|
+
"description": "The part of `microcredits` the workspace allowance or the author's seat paid.",
|
|
6514
|
+
"format": "int64",
|
|
6515
|
+
"type": "integer"
|
|
6516
|
+
},
|
|
5985
6517
|
"transport": {
|
|
5986
6518
|
"description": "The model transport recorded at charge time, null when the debit records none.",
|
|
5987
6519
|
"type": [
|
|
@@ -6053,6 +6585,57 @@
|
|
|
6053
6585
|
],
|
|
6054
6586
|
"type": "object"
|
|
6055
6587
|
},
|
|
6588
|
+
"StoredCheckOutcome": {
|
|
6589
|
+
"description": "What the test did: `FAILED` as at the reproduction or otherwise,\n `DID_NOT_FAIL` when it exited cleanly, which shows only that this test\n did not fail under the conditions it exercised, or `UNAVAILABLE` when it\n could not answer.",
|
|
6590
|
+
"enum": [
|
|
6591
|
+
"FAILED",
|
|
6592
|
+
"DID_NOT_FAIL",
|
|
6593
|
+
"UNAVAILABLE"
|
|
6594
|
+
],
|
|
6595
|
+
"type": "string"
|
|
6596
|
+
},
|
|
6597
|
+
"StoredCheckResult": {
|
|
6598
|
+
"description": "The newest result of a stored check: its newest settled rerun at a later\n pull request head, or the reproduction's own head run when it has not\n run again.",
|
|
6599
|
+
"properties": {
|
|
6600
|
+
"commit_sha": {
|
|
6601
|
+
"description": "The commit the check ran at, or would have run at when a rerun could\n not start.",
|
|
6602
|
+
"type": [
|
|
6603
|
+
"string",
|
|
6604
|
+
"null"
|
|
6605
|
+
]
|
|
6606
|
+
},
|
|
6607
|
+
"reason": {
|
|
6608
|
+
"description": "Why a rerun did not pass, such as `STILL_FAILS` or\n `SERVICE_NOT_STARTED`. Absent for a pass and for the reproduction.",
|
|
6609
|
+
"type": [
|
|
6610
|
+
"string",
|
|
6611
|
+
"null"
|
|
6612
|
+
]
|
|
6613
|
+
},
|
|
6614
|
+
"result": {
|
|
6615
|
+
"$ref": "#/components/schemas/StoredCheckOutcome"
|
|
6616
|
+
},
|
|
6617
|
+
"source": {
|
|
6618
|
+
"allOf": [
|
|
6619
|
+
{
|
|
6620
|
+
"$ref": "#/components/schemas/StoredCheckResultSource"
|
|
6621
|
+
}
|
|
6622
|
+
],
|
|
6623
|
+
"description": "`RERUN` or `REPRODUCTION`."
|
|
6624
|
+
}
|
|
6625
|
+
},
|
|
6626
|
+
"required": [
|
|
6627
|
+
"source",
|
|
6628
|
+
"result"
|
|
6629
|
+
],
|
|
6630
|
+
"type": "object"
|
|
6631
|
+
},
|
|
6632
|
+
"StoredCheckResultSource": {
|
|
6633
|
+
"enum": [
|
|
6634
|
+
"REPRODUCTION",
|
|
6635
|
+
"RERUN"
|
|
6636
|
+
],
|
|
6637
|
+
"type": "string"
|
|
6638
|
+
},
|
|
6056
6639
|
"SubjectAuthorization": {
|
|
6057
6640
|
"description": "One assessment's authorization of one subject, by identity.\n\n The display name is not the answer on its own: an environment's external key\n is unique within its organization and a display name is mutable metadata,\n so two environments of one review can carry the same one.\n Collapsing to it would leave a reader unable to tell which assessment\n authorized the subject and which one gapped, which is the confusion this\n field exists to remove.",
|
|
6058
6641
|
"properties": {
|
|
@@ -6462,7 +7045,7 @@
|
|
|
6462
7045
|
},
|
|
6463
7046
|
"info": {
|
|
6464
7047
|
"title": "Proofline Review API",
|
|
6465
|
-
"version": "7.
|
|
7048
|
+
"version": "7.2.0"
|
|
6466
7049
|
},
|
|
6467
7050
|
"openapi": "3.1.0",
|
|
6468
7051
|
"paths": {
|
|
@@ -7002,6 +7585,74 @@
|
|
|
7002
7585
|
"x-proofline-token-scope": "reviews:request"
|
|
7003
7586
|
}
|
|
7004
7587
|
},
|
|
7588
|
+
"/api/v1/organizations/{org_id}/repositories/{repo_id}/commits/{commit_sha}/deploy-verifications": {
|
|
7589
|
+
"get": {
|
|
7590
|
+
"description": "Returns each deploy of one exact commit in the repository that Proofline recorded, across the organization's environments: its environment ID, GitHub Environment, task, workflow run and attempt, where its verification stands, whether a check regressed, each check's result and due time, the gaps that leave it unproven and its console page. `commit_sha` must be a full 40-character lowercase commit SHA; a branch, tag or abbreviated SHA gets 400. A commit with no recorded deploy returns `recorded: false` and no deploys, which is never a result about a deploy. A repository outside the token's repository restriction or organization returns 404.",
|
|
7591
|
+
"operationId": "get_commit_deploy_verifications",
|
|
7592
|
+
"parameters": [
|
|
7593
|
+
{
|
|
7594
|
+
"description": "The full 40-character lowercase commit SHA the job deployed. A branch,\n tag or abbreviated SHA is refused.",
|
|
7595
|
+
"in": "path",
|
|
7596
|
+
"name": "commit_sha",
|
|
7597
|
+
"required": true,
|
|
7598
|
+
"schema": {
|
|
7599
|
+
"description": "The full 40-character lowercase commit SHA the job deployed. A branch,\n tag or abbreviated SHA is refused.",
|
|
7600
|
+
"type": "string"
|
|
7601
|
+
},
|
|
7602
|
+
"style": "simple"
|
|
7603
|
+
},
|
|
7604
|
+
{
|
|
7605
|
+
"in": "path",
|
|
7606
|
+
"name": "org_id",
|
|
7607
|
+
"required": true,
|
|
7608
|
+
"schema": {
|
|
7609
|
+
"format": "uuid",
|
|
7610
|
+
"type": "string"
|
|
7611
|
+
},
|
|
7612
|
+
"style": "simple"
|
|
7613
|
+
},
|
|
7614
|
+
{
|
|
7615
|
+
"in": "path",
|
|
7616
|
+
"name": "repo_id",
|
|
7617
|
+
"required": true,
|
|
7618
|
+
"schema": {
|
|
7619
|
+
"format": "uuid",
|
|
7620
|
+
"type": "string"
|
|
7621
|
+
},
|
|
7622
|
+
"style": "simple"
|
|
7623
|
+
}
|
|
7624
|
+
],
|
|
7625
|
+
"responses": {
|
|
7626
|
+
"200": {
|
|
7627
|
+
"content": {
|
|
7628
|
+
"application/json": {
|
|
7629
|
+
"schema": {
|
|
7630
|
+
"$ref": "#/components/schemas/CommitDeployVerifications"
|
|
7631
|
+
}
|
|
7632
|
+
}
|
|
7633
|
+
},
|
|
7634
|
+
"description": "The deploys of one commit that Proofline recorded, across the\n organization's environments."
|
|
7635
|
+
},
|
|
7636
|
+
"default": {
|
|
7637
|
+
"content": {
|
|
7638
|
+
"application/problem+json": {
|
|
7639
|
+
"schema": {
|
|
7640
|
+
"$ref": "#/components/schemas/Problem"
|
|
7641
|
+
}
|
|
7642
|
+
}
|
|
7643
|
+
},
|
|
7644
|
+
"description": "An RFC 9457 problem; the HTTP status remains authoritative."
|
|
7645
|
+
}
|
|
7646
|
+
},
|
|
7647
|
+
"security": [
|
|
7648
|
+
{
|
|
7649
|
+
"bearerAuth": []
|
|
7650
|
+
}
|
|
7651
|
+
],
|
|
7652
|
+
"summary": "Get a commit's deploy verifications",
|
|
7653
|
+
"x-proofline-token-scope": "reviews:read"
|
|
7654
|
+
}
|
|
7655
|
+
},
|
|
7005
7656
|
"/api/v1/organizations/{org_id}/repositories/{repo_id}/coverage-reports": {
|
|
7006
7657
|
"post": {
|
|
7007
7658
|
"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.",
|