@mgiles/perk 1.0.1 → 2.0.0

package/shared/schemas/outputs/pr-land.schema.json

@@ -0,0 +1,187 @@
+{
+  "$defs": {
+    "LandPrOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of the picked :class:`github.PullRequest` subset\n(field order load-bearing).",
+      "properties": {
+        "number": {
+          "title": "Number",
+          "type": "integer"
+        },
+        "state": {
+          "title": "State",
+          "type": "string"
+        }
+      },
+      "required": [
+        "number",
+        "state"
+      ],
+      "title": "LandPrOut",
+      "type": "object"
+    },
+    "LearnConsumeOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of :class:`LearnConsumeUpdate` (field order load-bearing).",
+      "properties": {
+        "closed": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Closed",
+          "type": "array"
+        },
+        "skipped_reason": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Skipped Reason"
+        }
+      },
+      "required": [
+        "closed",
+        "skipped_reason"
+      ],
+      "title": "LearnConsumeOut",
+      "type": "object"
+    },
+    "ObjectiveLandOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of :class:`ObjectiveLandUpdate` (field order load-bearing).\n\n``id`` maps from the domain ``objective`` field (the linked objective id).",
+      "properties": {
+        "id": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Id"
+        },
+        "nodes_marked": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Nodes Marked",
+          "type": "array"
+        },
+        "skipped_reason": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Skipped Reason"
+        },
+        "closed": {
+          "title": "Closed",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "id",
+        "nodes_marked",
+        "skipped_reason",
+        "closed"
+      ],
+      "title": "ObjectiveLandOut",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "description": "The ``--json`` serialization boundary of :class:`PrLandResult` (field order load-bearing).",
+  "properties": {
+    "success": {
+      "title": "Success",
+      "type": "boolean"
+    },
+    "error_type": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Error Type"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Message"
+    },
+    "pr": {
+      "$ref": "#/$defs/LandPrOut"
+    },
+    "branch": {
+      "title": "Branch",
+      "type": "string"
+    },
+    "issue": {
+      "title": "Issue",
+      "type": "string"
+    },
+    "pending_learn": {
+      "title": "Pending Learn",
+      "type": "boolean"
+    },
+    "plan_issue_closed": {
+      "title": "Plan Issue Closed",
+      "type": "boolean"
+    },
+    "dry_run": {
+      "title": "Dry Run",
+      "type": "boolean"
+    },
+    "objective": {
+      "$ref": "#/$defs/ObjectiveLandOut"
+    },
+    "learn": {
+      "$ref": "#/$defs/LearnConsumeOut"
+    },
+    "learn_state": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "title": "Learn State"
+    }
+  },
+  "required": [
+    "success",
+    "error_type",
+    "message",
+    "pr",
+    "branch",
+    "issue",
+    "pending_learn",
+    "plan_issue_closed",
+    "dry_run",
+    "objective",
+    "learn"
+  ],
+  "title": "PrLandOut",
+  "type": "object"
+}

package/shared/schemas/outputs/pr-ready.schema.json

@@ -0,0 +1,75 @@
+{
+  "$defs": {
+    "ReadyPrOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of the picked :class:`github.PullRequest` subset\n(field order load-bearing).",
+      "properties": {
+        "number": {
+          "title": "Number",
+          "type": "integer"
+        },
+        "url": {
+          "title": "Url",
+          "type": "string"
+        }
+      },
+      "required": [
+        "number",
+        "url"
+      ],
+      "title": "ReadyPrOut",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "description": "The ``--json`` serialization boundary of :class:`PrReadyResult` (order load-bearing).",
+  "properties": {
+    "success": {
+      "title": "Success",
+      "type": "boolean"
+    },
+    "error_type": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Error Type"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Message"
+    },
+    "pr": {
+      "$ref": "#/$defs/ReadyPrOut"
+    },
+    "was_draft": {
+      "title": "Was Draft",
+      "type": "boolean"
+    },
+    "dry_run": {
+      "title": "Dry Run",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "success",
+    "error_type",
+    "message",
+    "pr",
+    "was_draft",
+    "dry_run"
+  ],
+  "title": "PrReadyOut",
+  "type": "object"
+}

package/shared/schemas/outputs/pr-review-checkout.schema.json

@@ -0,0 +1,69 @@
+{
+  "additionalProperties": false,
+  "description": "The ``--json`` serialization boundary of :class:`ReviewCheckoutResult` (flat; envelope\nkeys first). ``path`` is absolute; the SHAs are full 40-char.",
+  "properties": {
+    "success": {
+      "title": "Success",
+      "type": "boolean"
+    },
+    "error_type": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Error Type"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Message"
+    },
+    "path": {
+      "title": "Path",
+      "type": "string"
+    },
+    "pr": {
+      "title": "Pr",
+      "type": "integer"
+    },
+    "url": {
+      "title": "Url",
+      "type": "string"
+    },
+    "head_sha": {
+      "title": "Head Sha",
+      "type": "string"
+    },
+    "base_sha": {
+      "title": "Base Sha",
+      "type": "string"
+    },
+    "base_ref": {
+      "title": "Base Ref",
+      "type": "string"
+    }
+  },
+  "required": [
+    "success",
+    "error_type",
+    "message",
+    "path",
+    "pr",
+    "url",
+    "head_sha",
+    "base_sha",
+    "base_ref"
+  ],
+  "title": "PrReviewCheckoutOut",
+  "type": "object"
+}

package/shared/schemas/outputs/pr-review-cleanup.schema.json

@@ -0,0 +1,54 @@
+{
+  "additionalProperties": false,
+  "description": "The ``--json`` serialization boundary of :class:`ReviewCleanupResult` (flat; envelope\nkeys first). ``path`` is absolute.",
+  "properties": {
+    "success": {
+      "title": "Success",
+      "type": "boolean"
+    },
+    "error_type": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Error Type"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Message"
+    },
+    "pr": {
+      "title": "Pr",
+      "type": "integer"
+    },
+    "path": {
+      "title": "Path",
+      "type": "string"
+    },
+    "removed": {
+      "title": "Removed",
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "success",
+    "error_type",
+    "message",
+    "pr",
+    "path",
+    "removed"
+  ],
+  "title": "PrReviewCleanupOut",
+  "type": "object"
+}

package/shared/schemas/outputs/pr-review-context.schema.json

@@ -0,0 +1,86 @@
+{
+  "additionalProperties": false,
+  "description": "The ``--json`` serialization boundary of :class:`PrReviewContextResult`\n(flat; field order load-bearing). ``pr`` maps from the domain ``pr_number``.",
+  "properties": {
+    "success": {
+      "title": "Success",
+      "type": "boolean"
+    },
+    "error_type": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Error Type"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Message"
+    },
+    "branch": {
+      "title": "Branch",
+      "type": "string"
+    },
+    "pr": {
+      "title": "Pr",
+      "type": "integer"
+    },
+    "base_ref": {
+      "title": "Base Ref",
+      "type": "string"
+    },
+    "head_ref": {
+      "title": "Head Ref",
+      "type": "string"
+    },
+    "title": {
+      "title": "Title",
+      "type": "string"
+    },
+    "body": {
+      "title": "Body",
+      "type": "string"
+    },
+    "diff": {
+      "title": "Diff",
+      "type": "string"
+    },
+    "plan_body": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Plan Body"
+    }
+  },
+  "required": [
+    "success",
+    "error_type",
+    "message",
+    "branch",
+    "pr",
+    "base_ref",
+    "head_ref",
+    "title",
+    "body",
+    "diff",
+    "plan_body"
+  ],
+  "title": "PrReviewContextOut",
+  "type": "object"
+}

package/shared/schemas/outputs/pr-review-submit.schema.json

@@ -0,0 +1,64 @@
+{
+  "additionalProperties": false,
+  "description": "The ``--json`` serialization boundary of the submission result (flat; envelope keys\nfirst). ``event`` is the flag spelling; ``mode`` \u2208\n``validated | review | review_folded | comment_fallback``.",
+  "properties": {
+    "success": {
+      "title": "Success",
+      "type": "boolean"
+    },
+    "error_type": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Error Type"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Message"
+    },
+    "dry_run": {
+      "title": "Dry Run",
+      "type": "boolean"
+    },
+    "pr": {
+      "title": "Pr",
+      "type": "integer"
+    },
+    "event": {
+      "title": "Event",
+      "type": "string"
+    },
+    "mode": {
+      "title": "Mode",
+      "type": "string"
+    },
+    "comment_count": {
+      "title": "Comment Count",
+      "type": "integer"
+    }
+  },
+  "required": [
+    "success",
+    "error_type",
+    "message",
+    "dry_run",
+    "pr",
+    "event",
+    "mode",
+    "comment_count"
+  ],
+  "title": "PrReviewSubmitOut",
+  "type": "object"
+}

package/shared/schemas/outputs/pr-submit.schema.json

@@ -0,0 +1,147 @@
+{
+  "$defs": {
+    "PlanHeaderUpdateOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of the picked :class:`issue_backend.PlanHeaderUpdate` subset\n(field order load-bearing).",
+      "properties": {
+        "fields_updated": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Fields Updated",
+          "type": "array"
+        }
+      },
+      "required": [
+        "fields_updated"
+      ],
+      "title": "PlanHeaderUpdateOut",
+      "type": "object"
+    },
+    "SubmitPrOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of the picked :class:`github.PullRequest` subset\n(field order load-bearing).",
+      "properties": {
+        "number": {
+          "title": "Number",
+          "type": "integer"
+        },
+        "url": {
+          "title": "Url",
+          "type": "string"
+        },
+        "is_draft": {
+          "title": "Is Draft",
+          "type": "boolean"
+        },
+        "existed": {
+          "title": "Existed",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "number",
+        "url",
+        "is_draft",
+        "existed"
+      ],
+      "title": "SubmitPrOut",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "description": "The ``--json`` serialization boundary of :class:`PrSubmitResult` (order load-bearing).",
+  "properties": {
+    "success": {
+      "title": "Success",
+      "type": "boolean"
+    },
+    "error_type": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Error Type"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Message"
+    },
+    "pr": {
+      "$ref": "#/$defs/SubmitPrOut"
+    },
+    "branch": {
+      "title": "Branch",
+      "type": "string"
+    },
+    "issue": {
+      "title": "Issue",
+      "type": "string"
+    },
+    "plan_header": {
+      "$ref": "#/$defs/PlanHeaderUpdateOut"
+    },
+    "plan_embedded": {
+      "title": "Plan Embedded",
+      "type": "boolean"
+    },
+    "pr_checked": {
+      "title": "Pr Checked",
+      "type": "boolean"
+    },
+    "dry_run": {
+      "title": "Dry Run",
+      "type": "boolean"
+    },
+    "base": {
+      "title": "Base",
+      "type": "string"
+    },
+    "mergeable": {
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Mergeable"
+    },
+    "conflicts": {
+      "items": {
+        "type": "string"
+      },
+      "title": "Conflicts",
+      "type": "array"
+    }
+  },
+  "required": [
+    "success",
+    "error_type",
+    "message",
+    "pr",
+    "branch",
+    "issue",
+    "plan_header",
+    "plan_embedded",
+    "pr_checked",
+    "dry_run",
+    "base",
+    "mergeable",
+    "conflicts"
+  ],
+  "title": "PrSubmitOut",
+  "type": "object"
+}