@oore/client 0.24.0 → 0.26.0

package/openapi/openapi.json

@@ -4604,6 +4604,53 @@
         ]
       }
     },
+    "/v1/pipelines/import-yaml": {
+      "post": {
+        "tags": [
+          "Pipelines"
+        ],
+        "summary": "Import `.oore.yaml` into pipeline settings",
+        "description": "Reads a `version: 2` `.oore.yaml` back into the pipeline's form\nsettings: the inverse of the export. The file is validated as\n`oore pipeline validate` does. Settings are returned only when the\nform can hold the whole file; exported again, they plan the same as\nthe file. Everything else is listed in `unsupported`. Nothing is\nsaved, and secret references stay as written.",
+        "operationId": "import_pipeline_yaml",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ImportPipelineYamlRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "The form settings, or why the file cannot become them",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ImportPipelineYamlResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "The file is too large",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "bearer_auth": []
+          }
+        ]
+      }
+    },
     "/v1/pipelines/plan": {
       "post": {
         "tags": [
@@ -7105,7 +7152,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": [
           {
@@ -7156,7 +7203,7 @@
             }
           },
           "403": {
-            "description": "Permission denied",
+            "description": "Not one of the environment's approvers, or an API token",
             "content": {
               "application/json": {
                 "schema": {
@@ -7209,7 +7256,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": [
           {
@@ -7260,7 +7307,7 @@
             }
           },
           "403": {
-            "description": "Permission denied",
+            "description": "Not one of the environment's approvers, or an API token",
             "content": {
               "application/json": {
                 "schema": {
@@ -13452,6 +13499,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": [
@@ -15456,6 +15511,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"
           },
@@ -15793,6 +15859,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.",
@@ -16619,6 +16751,171 @@
           }
         }
       },
+      "ImportPipelineYamlRequest": {
+        "type": "object",
+        "description": "A `version: 2` `.oore.yaml` to read back into the pipeline editor's form,\nwith the settings the editor holds now.",
+        "required": [
+          "yaml"
+        ],
+        "properties": {
+          "app_store": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/AppStorePublishConfig",
+                "description": "The pipeline's App Store Connect settings. The file's\n`publish.testflight` must match them."
+              }
+            ]
+          },
+          "execution_config": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/PipelineExecutionConfig",
+                "description": "The form settings the editor holds now. They decide between\nequivalent ways of holding the file: the pipeline's Build commands\n(which the file runs as steps after the targets), build arguments or\na build command override."
+              }
+            ]
+          },
+          "google_play": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/GooglePlayPublishConfig",
+                "description": "The pipeline's Google Play settings. The form does not edit them, so\nthe file's `publish.play` must match them."
+              }
+            ]
+          },
+          "trigger_config": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/TriggerConfig",
+                "description": "The pipeline's trigger settings, whose schedules are kept. Left out\nfor repositories that only build manually, where the file's `on`\ncannot be held."
+              }
+            ]
+          },
+          "yaml": {
+            "type": "string",
+            "description": "The file's text."
+          }
+        }
+      },
+      "ImportPipelineYamlResponse": {
+        "type": "object",
+        "required": [
+          "valid",
+          "representable",
+          "errors",
+          "unsupported",
+          "notes"
+        ],
+        "properties": {
+          "errors": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "The file's validation errors, one per entry."
+          },
+          "execution_config": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/PipelineExecutionConfig",
+                "description": "The form settings. Exported again, they plan the same as the file."
+              }
+            ]
+          },
+          "google_play": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/ImportedPlayPublish",
+                "description": "The file's `publish.play`."
+              }
+            ]
+          },
+          "notes": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "What the form drops without changing what runs, such as step names."
+          },
+          "representable": {
+            "type": "boolean",
+            "description": "Valid, and the form can hold all of it: `execution_config` is set."
+          },
+          "testflight_group": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The file's `publish.testflight.group`."
+          },
+          "trigger_config": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/TriggerConfig",
+                "description": "The trigger settings the file's `on` maps to, with the pipeline's\nschedules kept. Left out when the file has no `on`, so the pipeline's\ntrigger settings stay as they are."
+              }
+            ]
+          },
+          "unsupported": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "What the form cannot hold, one per entry, such as workflows, vars,\nflavors or an `on` the trigger settings cannot express."
+          },
+          "valid": {
+            "type": "boolean",
+            "description": "The file parses and validates as `oore pipeline validate` checks it."
+          }
+        }
+      },
+      "ImportedPlayPublish": {
+        "type": "object",
+        "description": "A file's `publish.play`, as written.",
+        "required": [
+          "track"
+        ],
+        "properties": {
+          "draft": {
+            "type": [
+              "boolean",
+              "null"
+            ],
+            "description": "Left out, the Publish settings decide."
+          },
+          "rollout_percent": {
+            "type": [
+              "number",
+              "null"
+            ],
+            "format": "double",
+            "description": "The staged rollout as a percentage. Left out, the Publish settings\ndecide."
+          },
+          "track": {
+            "type": "string"
+          }
+        }
+      },
       "InstancePreferences": {
         "type": "object",
         "required": [
@@ -18787,6 +19084,7 @@
           "store",
           "track",
           "approval_required",
+          "approvers",
           "rollout_policy",
           "promotable",
           "created_at",
@@ -18795,7 +19093,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",
@@ -22286,6 +22588,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.24.0",
+  "version": "0.26.0",
   "description": "Typed, tree-shakeable client for the Oore API",
   "type": "module",
   "sideEffects": false,