@oore/client 0.23.0 → 0.25.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": [
@@ -15396,6 +15443,16 @@
           "name": {
             "type": "string"
           },
+          "size_budget": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/SizeBudget"
+              }
+            ]
+          },
           "timeout_minutes": {
             "type": [
               "integer",
@@ -16609,6 +16666,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": [
@@ -17971,6 +18193,7 @@
           "concurrency",
           "timeout_minutes",
           "approval",
+          "size_budget",
           "enabled",
           "created_at",
           "updated_at"
@@ -18007,6 +18230,10 @@
           "project_id": {
             "type": "string"
           },
+          "size_budget": {
+            "$ref": "#/components/schemas/SizeBudget",
+            "description": "Artifact size limits the commit checks enforce."
+          },
           "timeout_minutes": {
             "type": "integer",
             "format": "int32",
@@ -21126,6 +21353,72 @@
           }
         }
       },
+      "SizeBudget": {
+        "type": "object",
+        "description": "Artifact size limits a pipeline's commit checks enforce. Increase limits\ncompare with the same baseline as the build's size report; without a\nbaseline only `max_bytes` applies. Empty `rules` turns the budget off.",
+        "required": [
+          "mode",
+          "rules"
+        ],
+        "properties": {
+          "mode": {
+            "$ref": "#/components/schemas/SizeBudgetMode"
+          },
+          "rules": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SizeBudgetRule"
+            }
+          }
+        },
+        "additionalProperties": false
+      },
+      "SizeBudgetMode": {
+        "type": "string",
+        "description": "What a pipeline's commit check does when an artifact is over its size\nbudget. The build itself never fails.",
+        "enum": [
+          "warn",
+          "fail"
+        ]
+      },
+      "SizeBudgetRule": {
+        "type": "object",
+        "description": "Size limits for one kind of artifact. A rule needs at least one limit.",
+        "required": [
+          "kind"
+        ],
+        "properties": {
+          "kind": {
+            "type": "string",
+            "description": "The artifact kind: its lowercase file extension, such as `aab`,\n`apk` or `ipa`."
+          },
+          "max_bytes": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "format": "int64",
+            "description": "Largest size allowed, in bytes."
+          },
+          "max_increase_bytes": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "format": "int64",
+            "description": "Largest growth allowed compared with the baseline build, in bytes."
+          },
+          "max_increase_percent": {
+            "type": [
+              "number",
+              "null"
+            ],
+            "format": "double",
+            "description": "Largest growth allowed compared with the baseline build, in percent."
+          }
+        },
+        "additionalProperties": false
+      },
       "SlackMention": {
         "type": "object",
         "description": "Maps a person to the Slack member mentioned in their notifications.",
@@ -22158,6 +22451,16 @@
               "null"
             ]
           },
+          "size_budget": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/SizeBudget"
+              }
+            ]
+          },
           "timeout_minutes": {
             "type": [
               "integer",
@@ -22666,6 +22969,16 @@
               "null"
             ]
           },
+          "size_budget": {
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/SizeBudget"
+              }
+            ]
+          },
           "timeout_minutes": {
             "type": [
               "integer",

package/package.json

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