@oore/client 0.25.0 → 0.27.0

package/openapi/openapi.json

@@ -2180,6 +2180,54 @@
         ]
       }
     },
+    "/v1/builds/{build_id}/analysis": {
+      "get": {
+        "tags": [
+          "Builds"
+        ],
+        "summary": "Get the build's analyzer summary",
+        "description": "Returns the `dart analyze` counts and most severe diagnostics of a\nbuild, with the baseline build on the base branch it compares with.\n`analysis` is `null` when the build reported none.",
+        "operationId": "get_build_analysis",
+        "parameters": [
+          {
+            "name": "build_id",
+            "in": "path",
+            "description": "Build ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Analyzer summary",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BuildAnalysisResponse"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Build not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "bearer_auth": []
+          }
+        ]
+      }
+    },
     "/v1/builds/{build_id}/approve": {
       "post": {
         "tags": [
@@ -7152,7 +7200,7 @@
           "Environments"
         ],
         "summary": "Approve promotion",
-        "description": "Approves a pending promotion and makes the store change as the approver. Requires the maintainer role. Writes an audit log entry.",
+        "description": "Approves a pending promotion and makes the store change as the approver. Requires one of the environment's approvers (by default any maintainer). API tokens cannot decide promotions. Writes an audit log entry.",
         "operationId": "approve_promotion",
         "parameters": [
           {
@@ -7203,7 +7251,7 @@
             }
           },
           "403": {
-            "description": "Permission denied",
+            "description": "Not one of the environment's approvers, or an API token",
             "content": {
               "application/json": {
                 "schema": {
@@ -7256,7 +7304,7 @@
           "Environments"
         ],
         "summary": "Reject promotion",
-        "description": "Rejects a pending promotion; nothing changes at the store. Requires the maintainer role. Writes an audit log entry.",
+        "description": "Rejects a pending promotion; nothing changes at the store. Requires one of the environment's approvers (by default any maintainer). API tokens cannot decide promotions. Writes an audit log entry.",
         "operationId": "reject_promotion",
         "parameters": [
           {
@@ -7307,7 +7355,7 @@
             }
           },
           "403": {
-            "description": "Permission denied",
+            "description": "Not one of the environment's approvers, or an API token",
             "content": {
               "application/json": {
                 "schema": {
@@ -9235,6 +9283,93 @@
         ]
       }
     },
+    "/v1/runners/{runner_id}/jobs/{job_id}/analysis": {
+      "post": {
+        "tags": [
+          "Builds"
+        ],
+        "summary": "Report the analyzer summary",
+        "description": "Runner reports the `dart analyze --format=json` summary of a build. A\nlater report replaces an earlier one. Only accepted while the build\nruns.",
+        "operationId": "report_job_analysis",
+        "parameters": [
+          {
+            "name": "runner_id",
+            "in": "path",
+            "description": "Runner ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "job_id",
+            "in": "path",
+            "description": "Build/Job ID",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RunnerAnalyzerReport"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Recorded",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Runner does not match the assignment",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Build not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Build is not running",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "bearer_auth": []
+          }
+        ]
+      }
+    },
     "/v1/runners/{runner_id}/jobs/{job_id}/android-signing": {
       "get": {
         "tags": [
@@ -13150,6 +13285,74 @@
           }
         }
       },
+      "AnalyzerCounts": {
+        "type": "object",
+        "description": "Diagnostics counted by severity.",
+        "required": [
+          "errors",
+          "warnings",
+          "infos"
+        ],
+        "properties": {
+          "errors": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "infos": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "warnings": {
+            "type": "integer",
+            "format": "int64"
+          }
+        }
+      },
+      "AnalyzerDiagnostic": {
+        "type": "object",
+        "description": "One `dart analyze` diagnostic.",
+        "required": [
+          "severity",
+          "code",
+          "message",
+          "file",
+          "line",
+          "column"
+        ],
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "The diagnostic code, such as `unused_import`."
+          },
+          "column": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "file": {
+            "type": "string",
+            "description": "Path relative to the build workspace, such as `lib/main.dart`."
+          },
+          "line": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "message": {
+            "type": "string"
+          },
+          "severity": {
+            "$ref": "#/components/schemas/AnalyzerSeverity"
+          }
+        }
+      },
+      "AnalyzerSeverity": {
+        "type": "string",
+        "description": "Severity of a `dart analyze` diagnostic.",
+        "enum": [
+          "error",
+          "warning",
+          "info"
+        ]
+      },
       "AndroidSigningBuildType": {
         "type": "string",
         "enum": [
@@ -13499,6 +13702,14 @@
         },
         "additionalProperties": false
       },
+      "ApproverRole": {
+        "type": "string",
+        "description": "The lowest project role that may approve promotions into an environment.",
+        "enum": [
+          "maintainer",
+          "developer"
+        ]
+      },
       "Artifact": {
         "type": "object",
         "required": [
@@ -14140,6 +14351,89 @@
           }
         }
       },
+      "BuildAnalysis": {
+        "type": "object",
+        "description": "A build's analyzer summary.",
+        "required": [
+          "counts",
+          "diagnostics",
+          "recorded_at"
+        ],
+        "properties": {
+          "counts": {
+            "$ref": "#/components/schemas/AnalyzerCounts"
+          },
+          "diagnostics": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/AnalyzerDiagnostic"
+            },
+            "description": "The most severe diagnostics, errors first, at most 50."
+          },
+          "recorded_at": {
+            "type": "integer",
+            "format": "int64"
+          }
+        }
+      },
+      "BuildAnalysisBaseline": {
+        "type": "object",
+        "description": "The earlier build an analysis compares with: the latest successful build\nof the same pipeline on the base branch that reported one, as for sizes.",
+        "required": [
+          "build_id",
+          "build_number",
+          "branch",
+          "counts"
+        ],
+        "properties": {
+          "branch": {
+            "type": "string"
+          },
+          "build_id": {
+            "type": "string"
+          },
+          "build_number": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "counts": {
+            "$ref": "#/components/schemas/AnalyzerCounts"
+          }
+        }
+      },
+      "BuildAnalysisResponse": {
+        "type": "object",
+        "properties": {
+          "analysis": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/BuildAnalysis",
+                "description": "`null` when the build reported no analysis."
+              }
+            ]
+          },
+          "base_branch": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The branch the build compares with: a pull request's target branch,\notherwise the default branch."
+          },
+          "baseline": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/BuildAnalysisBaseline"
+              }
+            ]
+          }
+        }
+      },
       "BuildApproval": {
         "type": "object",
         "required": [
@@ -15503,6 +15797,17 @@
           "approval_required": {
             "type": "boolean"
           },
+          "approvers": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/EnvironmentApproversInput",
+                "description": "Who may approve promotions. Defaults to any project maintainer."
+              }
+            ]
+          },
           "key": {
             "type": "string"
           },
@@ -15840,6 +16145,72 @@
           }
         }
       },
+      "EnvironmentApprover": {
+        "type": "object",
+        "description": "A project member named as an approver.",
+        "required": [
+          "user_id",
+          "email"
+        ],
+        "properties": {
+          "email": {
+            "type": "string"
+          },
+          "user_id": {
+            "type": "string"
+          }
+        }
+      },
+      "EnvironmentApprovers": {
+        "type": "object",
+        "description": "Who may approve or reject promotions into an environment.\n\nA member may decide when their project role is at least `role`, or when\nthey are one of `users` (developers and maintainers only). With no role\nand no users, any project maintainer may decide, as before approvers\nexisted. Instance owners and admins may always decide. API tokens never\ndecide: approvals are interactive.",
+        "required": [
+          "users"
+        ],
+        "properties": {
+          "role": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/ApproverRole",
+                "description": "A developer role lets developers and maintainers approve."
+              }
+            ]
+          },
+          "users": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/EnvironmentApprover"
+            },
+            "description": "Project members named as approvers. A user who leaves the project,\nor becomes a viewer, stops counting."
+          }
+        }
+      },
+      "EnvironmentApproversInput": {
+        "type": "object",
+        "description": "Approvers to set on an environment. Replaces the whole set; send an empty\nobject to go back to \"any maintainer\".",
+        "properties": {
+          "role": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/ApproverRole"
+              }
+            ]
+          },
+          "user_ids": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "User ids of project members who are developers or maintainers. At\nmost 20."
+          }
+        }
+      },
       "EnvironmentPromotion": {
         "type": "object",
         "description": "A request to put an existing build into an environment.",
@@ -18999,6 +19370,7 @@
           "store",
           "track",
           "approval_required",
+          "approvers",
           "rollout_policy",
           "promotable",
           "created_at",
@@ -19007,7 +19379,11 @@
         "properties": {
           "approval_required": {
             "type": "boolean",
-            "description": "A promotion into this environment waits for a maintainer's approval\nbefore anything changes at the store."
+            "description": "A promotion into this environment waits for an approval before\nanything changes at the store. `approvers` says who may give it."
+          },
+          "approvers": {
+            "$ref": "#/components/schemas/EnvironmentApprovers",
+            "description": "Who may approve or reject promotions into this environment. With no\nrole and no users, any project maintainer may."
           },
           "created_at": {
             "type": "integer",
@@ -20265,6 +20641,26 @@
           }
         }
       },
+      "RunnerAnalyzerReport": {
+        "type": "object",
+        "description": "The summary of `dart analyze --format=json` a runner reports after the\nbuild's steps.",
+        "required": [
+          "counts",
+          "diagnostics"
+        ],
+        "properties": {
+          "counts": {
+            "$ref": "#/components/schemas/AnalyzerCounts"
+          },
+          "diagnostics": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/AnalyzerDiagnostic"
+            },
+            "description": "The most severe diagnostics, errors first. The daemon keeps at most\n50."
+          }
+        }
+      },
       "RunnerAndroidSigningProfile": {
         "type": "object",
         "required": [
@@ -21857,6 +22253,27 @@
           }
         }
       },
+      "TargetSizeBudget": {
+        "type": "object",
+        "description": "A size budget a repository's `.oore.yaml` version 2 file sets on one\ntarget, after workflow overrides. That platform's commit check enforces it\non top of the pipeline's `size_budget`, which stays a floor.",
+        "required": [
+          "platform",
+          "source",
+          "budget"
+        ],
+        "properties": {
+          "budget": {
+            "$ref": "#/components/schemas/SizeBudget"
+          },
+          "platform": {
+            "$ref": "#/components/schemas/BuildPlatform"
+          },
+          "source": {
+            "type": "string",
+            "description": "Where the budget came from, such as `targets.android.budgets`."
+          }
+        }
+      },
       "TestNotificationChannelResponse": {
         "type": "object",
         "required": [
@@ -22220,6 +22637,16 @@
             ],
             "format": "int32"
           },
+          "size_budgets": {
+            "type": [
+              "array",
+              "null"
+            ],
+            "items": {
+              "$ref": "#/components/schemas/TargetSizeBudget"
+            },
+            "description": "The size budgets the build's `.oore.yaml` version 2 file sets, sent\nonce the runner planned the build. An empty list means the file sets\nnone; leaving it out keeps what the build has."
+          },
           "status": {
             "type": "string"
           },
@@ -22498,6 +22925,17 @@
               "null"
             ]
           },
+          "approvers": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/EnvironmentApproversInput",
+                "description": "Replaces who may approve promotions; leave out (or send null) to keep\nthem."
+              }
+            ]
+          },
           "name": {
             "type": [
               "string",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oore/client",
-  "version": "0.25.0",
+  "version": "0.27.0",
   "description": "Typed, tree-shakeable client for the Oore API",
   "type": "module",
   "sideEffects": false,