@apexops/contracts 0.10.0-next.5 → 0.11.0-next.0

package/schemas/repository-publish-plan-v1.schema.json

@@ -0,0 +1,265 @@
+{
+  "$id": "https://schemas.apexops.dev/repository-publish-plan-v1.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "actions": {
+      "items": {
+        "anyOf": [
+          {
+            "const": "create-repository",
+            "type": "string"
+          },
+          {
+            "const": "add-remote",
+            "type": "string"
+          },
+          {
+            "const": "push-branch",
+            "type": "string"
+          }
+        ]
+      },
+      "maxItems": 3,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "blockers": {
+      "items": {
+        "maxLength": 512,
+        "minLength": 1,
+        "type": "string"
+      },
+      "maxItems": 16,
+      "type": "array"
+    },
+    "config": {
+      "$id": "https://schemas.apexops.dev/repository-publish-config-v1.json",
+      "additionalProperties": false,
+      "properties": {
+        "branch": {
+          "pattern": "^[A-Za-z0-9][A-Za-z0-9._/-]{0,254}$(?![\\s\\S])",
+          "type": "string"
+        },
+        "name": {
+          "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,99}$(?![\\s\\S])",
+          "type": "string"
+        },
+        "owner": {
+          "pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,38}$(?![\\s\\S])",
+          "type": "string"
+        },
+        "remote": {
+          "const": "origin",
+          "type": "string"
+        },
+        "schemaVersion": {
+          "const": "1.0.0",
+          "type": "string"
+        },
+        "visibility": {
+          "anyOf": [
+            {
+              "const": "private",
+              "type": "string"
+            },
+            {
+              "const": "internal",
+              "type": "string"
+            },
+            {
+              "const": "public",
+              "type": "string"
+            }
+          ]
+        }
+      },
+      "required": [
+        "schemaVersion",
+        "owner",
+        "name",
+        "visibility",
+        "branch",
+        "remote"
+      ],
+      "type": "object"
+    },
+    "deploymentAuthorized": {
+      "const": false,
+      "type": "boolean"
+    },
+    "evidenceHash": {
+      "pattern": "^[0-9a-f]{64}$",
+      "type": "string"
+    },
+    "executionAuthorized": {
+      "const": false,
+      "type": "boolean"
+    },
+    "filesModified": {
+      "const": false,
+      "type": "boolean"
+    },
+    "pendingActions": {
+      "items": {
+        "maxLength": 256,
+        "minLength": 1,
+        "type": "string"
+      },
+      "maxItems": 16,
+      "type": "array"
+    },
+    "planHash": {
+      "pattern": "^[0-9a-f]{64}$",
+      "type": "string"
+    },
+    "push": {
+      "additionalProperties": false,
+      "properties": {
+        "branch": {
+          "maxLength": 255,
+          "minLength": 1,
+          "type": "string"
+        },
+        "commit": {
+          "pattern": "^[0-9a-f]{40}$(?![\\s\\S])",
+          "type": "string"
+        },
+        "commitCount": {
+          "maximum": 1000000,
+          "minimum": 0,
+          "type": "integer"
+        },
+        "files": {
+          "items": {
+            "maxLength": 1024,
+            "minLength": 1,
+            "type": "string"
+          },
+          "maxItems": 512,
+          "type": "array"
+        },
+        "filesTruncated": {
+          "type": "boolean"
+        },
+        "forcePush": {
+          "const": false,
+          "type": "boolean"
+        },
+        "uncommittedChanges": {
+          "items": {
+            "maxLength": 1024,
+            "minLength": 1,
+            "type": "string"
+          },
+          "maxItems": 512,
+          "type": "array"
+        }
+      },
+      "required": [
+        "branch",
+        "commit",
+        "commitCount",
+        "files",
+        "filesTruncated",
+        "uncommittedChanges",
+        "forcePush"
+      ],
+      "type": "object"
+    },
+    "repository": {
+      "additionalProperties": false,
+      "properties": {
+        "exists": {
+          "type": "boolean"
+        },
+        "fullName": {
+          "maxLength": 140,
+          "minLength": 3,
+          "type": "string"
+        },
+        "owner": {
+          "maxLength": 39,
+          "minLength": 1,
+          "type": "string"
+        },
+        "ownerType": {
+          "anyOf": [
+            {
+              "const": "user",
+              "type": "string"
+            },
+            {
+              "const": "organization",
+              "type": "string"
+            },
+            {
+              "const": "unknown",
+              "type": "string"
+            }
+          ]
+        },
+        "visibility": {
+          "anyOf": [
+            {
+              "const": "private",
+              "type": "string"
+            },
+            {
+              "const": "internal",
+              "type": "string"
+            },
+            {
+              "const": "public",
+              "type": "string"
+            }
+          ]
+        }
+      },
+      "required": [
+        "fullName",
+        "owner",
+        "ownerType",
+        "visibility",
+        "exists"
+      ],
+      "type": "object"
+    },
+    "schemaVersion": {
+      "const": "1.0.0",
+      "type": "string"
+    },
+    "status": {
+      "anyOf": [
+        {
+          "const": "ready",
+          "type": "string"
+        },
+        {
+          "const": "pending",
+          "type": "string"
+        },
+        {
+          "const": "blocked",
+          "type": "string"
+        }
+      ]
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "config",
+    "evidenceHash",
+    "planHash",
+    "status",
+    "repository",
+    "actions",
+    "push",
+    "blockers",
+    "pendingActions",
+    "filesModified",
+    "executionAuthorized",
+    "deploymentAuthorized"
+  ],
+  "type": "object"
+}

package/schemas/requirements-amendment-v1.schema.json

@@ -0,0 +1,213 @@
+{
+  "$id": "https://schemas.apexops.dev/requirements-amendment-v1.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "additions": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "id": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "priority": {
+            "anyOf": [
+              {
+                "const": "must",
+                "type": "string"
+              },
+              {
+                "const": "should",
+                "type": "string"
+              },
+              {
+                "const": "could",
+                "type": "string"
+              }
+            ]
+          },
+          "source": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "statement": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "status": {
+            "anyOf": [
+              {
+                "const": "confirmed",
+                "type": "string"
+              },
+              {
+                "const": "unknown",
+                "type": "string"
+              },
+              {
+                "const": "deferred",
+                "type": "string"
+              }
+            ]
+          }
+        },
+        "required": [
+          "id",
+          "statement",
+          "priority",
+          "status",
+          "source"
+        ],
+        "type": "object"
+      },
+      "maxItems": 128,
+      "type": "array"
+    },
+    "baseRequirementsHash": {
+      "pattern": "^[0-9a-f]{64}$",
+      "type": "string"
+    },
+    "fields": {
+      "additionalProperties": false,
+      "properties": {
+        "architectureHandoff": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "assumptions": {
+          "items": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "budgetAndOperations": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "businessContext": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "nonFunctionalRequirements": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "regionalConstraints": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "securityAndCompliance": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "successCriteria": {
+          "minLength": 1,
+          "type": "string"
+        },
+        "unknowns": {
+          "items": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "workload": {
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "removals": {
+      "items": {
+        "maxLength": 512,
+        "minLength": 1,
+        "type": "string"
+      },
+      "maxItems": 128,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "schemaVersion": {
+      "const": "1.0.0",
+      "type": "string"
+    },
+    "updates": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "changes": {
+            "additionalProperties": false,
+            "minProperties": 1,
+            "properties": {
+              "priority": {
+                "anyOf": [
+                  {
+                    "const": "must",
+                    "type": "string"
+                  },
+                  {
+                    "const": "should",
+                    "type": "string"
+                  },
+                  {
+                    "const": "could",
+                    "type": "string"
+                  }
+                ]
+              },
+              "source": {
+                "minLength": 1,
+                "type": "string"
+              },
+              "statement": {
+                "minLength": 1,
+                "type": "string"
+              },
+              "status": {
+                "anyOf": [
+                  {
+                    "const": "confirmed",
+                    "type": "string"
+                  },
+                  {
+                    "const": "unknown",
+                    "type": "string"
+                  },
+                  {
+                    "const": "deferred",
+                    "type": "string"
+                  }
+                ]
+              }
+            },
+            "type": "object"
+          },
+          "id": {
+            "maxLength": 512,
+            "minLength": 1,
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "changes"
+        ],
+        "type": "object"
+      },
+      "maxItems": 128,
+      "type": "array"
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "baseRequirementsHash",
+    "updates",
+    "additions",
+    "removals",
+    "fields"
+  ],
+  "type": "object"
+}

package/schemas/requirements-change-proposal-v1.schema.json

@@ -0,0 +1,196 @@
+{
+  "$id": "https://schemas.apexops.dev/requirements-change-proposal-v1.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "addedRequirementIds": {
+      "items": {
+        "maxLength": 512,
+        "minLength": 1,
+        "type": "string"
+      },
+      "maxItems": 4096,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "candidateHash": {
+      "pattern": "^[0-9a-f]{64}$",
+      "type": "string"
+    },
+    "changedFields": {
+      "items": {
+        "maxLength": 512,
+        "minLength": 1,
+        "type": "string"
+      },
+      "maxItems": 4096,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "changedRequirementIds": {
+      "items": {
+        "maxLength": 512,
+        "minLength": 1,
+        "type": "string"
+      },
+      "maxItems": 4096,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "deploymentAuthorized": {
+      "const": false,
+      "type": "boolean"
+    },
+    "expectedHead": {
+      "pattern": "^[0-9a-f]{64}$",
+      "type": "string"
+    },
+    "filesModified": {
+      "const": false,
+      "type": "boolean"
+    },
+    "invalidatedGates": {
+      "items": {
+        "maximum": 4,
+        "minimum": 1,
+        "type": "integer"
+      },
+      "maxItems": 4,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "invalidatedNodes": {
+      "items": {
+        "maxLength": 512,
+        "minLength": 1,
+        "type": "string"
+      },
+      "maxItems": 4096,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "mode": {
+      "anyOf": [
+        {
+          "const": "adopt",
+          "type": "string"
+        },
+        {
+          "const": "revise",
+          "type": "string"
+        }
+      ]
+    },
+    "ownerEpoch": {
+      "minimum": 0,
+      "type": "integer"
+    },
+    "projectId": {
+      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
+      "type": "string"
+    },
+    "proposalHash": {
+      "pattern": "^[0-9a-f]{64}$",
+      "type": "string"
+    },
+    "reason": {
+      "maxLength": 2048,
+      "minLength": 1,
+      "type": "string"
+    },
+    "removedRequirementIds": {
+      "items": {
+        "maxLength": 512,
+        "minLength": 1,
+        "type": "string"
+      },
+      "maxItems": 4096,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "requiresReassessment": {
+      "additionalItems": false,
+      "items": [
+        {
+          "const": "cost",
+          "type": "string"
+        },
+        {
+          "const": "policy",
+          "type": "string"
+        },
+        {
+          "const": "security",
+          "type": "string"
+        },
+        {
+          "const": "dependencies",
+          "type": "string"
+        },
+        {
+          "const": "code",
+          "type": "string"
+        },
+        {
+          "const": "documents",
+          "type": "string"
+        }
+      ],
+      "maxItems": 6,
+      "minItems": 6,
+      "type": "array"
+    },
+    "retainedRequirementIds": {
+      "items": {
+        "maxLength": 512,
+        "minLength": 1,
+        "type": "string"
+      },
+      "maxItems": 4096,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "runId": {
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$",
+      "type": "string"
+    },
+    "schemaVersion": {
+      "const": "1.0.0",
+      "type": "string"
+    },
+    "sourceRequirementsHash": {
+      "anyOf": [
+        {
+          "pattern": "^[0-9a-f]{64}$",
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "projectId",
+    "runId",
+    "expectedHead",
+    "ownerEpoch",
+    "sourceRequirementsHash",
+    "mode",
+    "candidateHash",
+    "reason",
+    "addedRequirementIds",
+    "removedRequirementIds",
+    "changedRequirementIds",
+    "retainedRequirementIds",
+    "changedFields",
+    "invalidatedNodes",
+    "invalidatedGates",
+    "requiresReassessment",
+    "filesModified",
+    "deploymentAuthorized",
+    "proposalHash"
+  ],
+  "type": "object"
+}