ws-spec-kit 0.1.0-beta.0

package/schemas/builtin-external-receipt-v1.schema.json

@@ -0,0 +1,109 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "builtin.external-receipt.v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "kind",
+    "target",
+    "stableId",
+    "externalWorkItemId",
+    "publishStepId",
+    "publishAttemptId",
+    "publishInputDigest",
+    "publishedContentDigest",
+    "readBackContentDigest",
+    "status",
+    "readBackStatus"
+  ],
+  "properties": {
+    "version": {
+      "const": 1
+    },
+    "kind": {
+      "const": "external-receipt"
+    },
+    "target": {
+      "enum": [
+        "issue",
+        "knowledge"
+      ]
+    },
+    "stableId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "externalEffectKind": {
+      "const": "issue.comment"
+    },
+    "externalEffectId": {
+      "type": "string",
+      "pattern": "^(?:github-comment|gitlab-note):[1-9][0-9]{0,15}$"
+    },
+    "externalWorkItemId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "publishStepId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]{0,62}(?::[1-9][0-9]*:[a-z][a-z0-9-]{0,62})?$"
+    },
+    "publishAttemptId": {
+      "type": "string",
+      "pattern": "^attempt-.+$"
+    },
+    "publishInputDigest": {
+      "type": "string",
+      "pattern": "^sha256:.+$"
+    },
+    "publishedContentDigest": {
+      "type": "string",
+      "pattern": "^sha256:.+$"
+    },
+    "readBackContentDigest": {
+      "type": "string",
+      "pattern": "^sha256:.+$"
+    },
+    "status": {
+      "const": "confirmed"
+    },
+    "readBackStatus": {
+      "enum": [
+        "confirmed",
+        "stale",
+        "failed"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "externalEffectKind": {
+            "const": "issue.comment"
+          }
+        },
+        "required": [
+          "externalEffectKind"
+        ]
+      },
+      "then": {
+        "properties": {
+          "externalEffectId": {
+            "type": "string",
+            "pattern": "^(?:github-comment|gitlab-note):[1-9][0-9]{0,15}$"
+          }
+        },
+        "required": [
+          "externalEffectId"
+        ]
+      },
+      "else": {
+        "properties": {
+          "externalEffectId": false
+        }
+      }
+    }
+  ]
+}

package/schemas/builtin-external-write-receipt-v1.schema.json

@@ -0,0 +1,253 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "builtin.external-write-receipt.v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "kind",
+    "requestId",
+    "requestDigest",
+    "grantDigest",
+    "workItemId",
+    "stepId",
+    "attemptId",
+    "provider",
+    "action",
+    "target",
+    "payloadDigest",
+    "expectedContentDigest",
+    "bindingDigest",
+    "inputDigest",
+    "artifactDigests",
+    "idempotencyKey",
+    "publishedContentDigest",
+    "readBackContentDigest",
+    "status",
+    "verifiedAt"
+  ],
+  "properties": {
+    "version": {
+      "const": 1
+    },
+    "kind": {
+      "const": "external-write-receipt"
+    },
+    "requestId": {
+      "type": "string",
+      "pattern": "^external-request-[a-f0-9]{64}$"
+    },
+    "requestDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "grantDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "workItemId": {
+      "type": "string",
+      "pattern": "^WSS-[A-Za-z0-9-]+$"
+    },
+    "stepId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]{0,62}(?::[1-9][0-9]*:[a-z][a-z0-9-]{0,62})?$"
+    },
+    "attemptId": {
+      "type": "string",
+      "pattern": "^attempt-.+$"
+    },
+    "provider": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]{0,62}$"
+    },
+    "action": {
+      "enum": [
+        "git.commit",
+        "issue.update",
+        "knowledge.publish",
+        "issue.close"
+      ]
+    },
+    "target": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "stableId"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "repository",
+            "issue",
+            "knowledge"
+          ]
+        },
+        "stableId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4096
+        }
+      }
+    },
+    "payloadDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "externalEffectKind": {
+      "const": "issue.comment"
+    },
+    "externalEffectId": {
+      "type": "string",
+      "pattern": "^(?:github-comment|gitlab-note):[1-9][0-9]{0,15}$"
+    },
+    "expectedContentDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "bindingDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "inputDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "artifactDigests": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "pattern": "^sha256:[a-f0-9]{64}$"
+      }
+    },
+    "idempotencyKey": {
+      "type": "string",
+      "pattern": "^external:[a-f0-9]{64}$"
+    },
+    "publishedContentDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "readBackContentDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "status": {
+      "const": "verified"
+    },
+    "verifiedAt": {
+      "type": "string",
+      "format": "date-time"
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "externalEffectKind": {
+            "const": "issue.comment"
+          }
+        },
+        "required": [
+          "externalEffectKind"
+        ]
+      },
+      "then": {
+        "properties": {
+          "externalEffectId": {
+            "type": "string",
+            "pattern": "^(?:github-comment|gitlab-note):[1-9][0-9]{0,15}$"
+          }
+        },
+        "required": [
+          "externalEffectId"
+        ]
+      },
+      "else": {
+        "properties": {
+          "externalEffectId": false
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "action": {
+            "const": "knowledge.publish"
+          }
+        },
+        "required": [
+          "action"
+        ]
+      },
+      "then": {
+        "properties": {
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "knowledge"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "action": {
+            "enum": [
+              "issue.update",
+              "issue.close"
+            ]
+          }
+        },
+        "required": [
+          "action"
+        ]
+      },
+      "then": {
+        "properties": {
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "issue"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "action": {
+            "const": "git.commit"
+          }
+        },
+        "required": [
+          "action"
+        ]
+      },
+      "then": {
+        "properties": {
+          "provider": {
+            "const": "git-native"
+          },
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "repository"
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

package/schemas/builtin-source-artifact-v1.schema.json

@@ -0,0 +1,293 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "builtin.source-artifact.v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "artifactType",
+    "schemaVersion",
+    "artifactId",
+    "type",
+    "stableId",
+    "title",
+    "body",
+    "metadata",
+    "contentDigest"
+  ],
+  "properties": {
+    "version": {
+      "const": 1
+    },
+    "artifactType": {
+      "const": "requirement-source"
+    },
+    "schemaVersion": {
+      "const": 1
+    },
+    "artifactId": {
+      "type": "string",
+      "pattern": "^source-[a-f0-9]{64}$"
+    },
+    "type": {
+      "enum": [
+        "user.prompt",
+        "local.file",
+        "github.issue",
+        "gitlab.issue",
+        "feishu.document"
+      ]
+    },
+    "stableId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512
+    },
+    "canonicalUrl": {
+      "type": "string",
+      "format": "uri",
+      "maxLength": 2048
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512
+    },
+    "body": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 524288
+    },
+    "updatedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "metadata": {
+      "type": "object"
+    },
+    "contentDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "enum": [
+              "user.prompt",
+              "local.file"
+            ]
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "properties": {
+          "metadata": {
+            "type": "object",
+            "additionalProperties": false,
+            "maxProperties": 16,
+            "properties": {}
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "enum": [
+              "github.issue",
+              "gitlab.issue"
+            ]
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "properties": {
+          "metadata": {
+            "type": "object",
+            "additionalProperties": false,
+            "maxProperties": 16,
+            "properties": {
+              "assignees": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256
+                  },
+                  {
+                    "type": "array",
+                    "maxItems": 32,
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 256
+                    }
+                  }
+                ]
+              },
+              "author": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256
+                  },
+                  {
+                    "type": "array",
+                    "maxItems": 32,
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 256
+                    }
+                  }
+                ]
+              },
+              "labels": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256
+                  },
+                  {
+                    "type": "array",
+                    "maxItems": 32,
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 256
+                    }
+                  }
+                ]
+              },
+              "repository": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256
+                  },
+                  {
+                    "type": "array",
+                    "maxItems": 32,
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 256
+                    }
+                  }
+                ]
+              },
+              "state": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256
+                  },
+                  {
+                    "type": "array",
+                    "maxItems": 32,
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 256
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "feishu.document"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "properties": {
+          "metadata": {
+            "type": "object",
+            "additionalProperties": false,
+            "maxProperties": 16,
+            "properties": {
+              "owner": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256
+                  },
+                  {
+                    "type": "array",
+                    "maxItems": 32,
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 256
+                    }
+                  }
+                ]
+              },
+              "revision": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256
+                  },
+                  {
+                    "type": "array",
+                    "maxItems": 32,
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 256
+                    }
+                  }
+                ]
+              },
+              "space": {
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256
+                  },
+                  {
+                    "type": "array",
+                    "maxItems": 32,
+                    "items": {
+                      "type": "string",
+                      "minLength": 1,
+                      "maxLength": 256
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}