ws-spec-kit 0.1.0-beta.0

package/schemas/builtin-external-action-grant-v1.schema.json

@@ -0,0 +1,298 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "builtin.external-action-grant.v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "grantId",
+    "requestId",
+    "requestDigest",
+    "workItemId",
+    "stepId",
+    "attemptId",
+    "provider",
+    "action",
+    "securityClass",
+    "target",
+    "payloadDigest",
+    "expectedContentDigest",
+    "payloadArtifactDigest",
+    "bindingDigest",
+    "inputDigest",
+    "artifactDigests",
+    "idempotencyKey",
+    "actor",
+    "approvalDigest",
+    "profile",
+    "profileDigest",
+    "workspaceDigest",
+    "configDigest",
+    "decidedAt",
+    "expiresAt",
+    "grantDigest"
+  ],
+  "properties": {
+    "version": {
+      "const": 1
+    },
+    "grantId": {
+      "type": "string",
+      "pattern": "^external-grant-[a-f0-9]{64}$"
+    },
+    "requestId": {
+      "type": "string",
+      "pattern": "^external-request-[a-f0-9]{64}$"
+    },
+    "requestDigest": {
+      "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"
+      ]
+    },
+    "securityClass": {
+      "enum": [
+        "local-write",
+        "external-write"
+      ]
+    },
+    "target": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "stableId"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "repository",
+            "issue",
+            "knowledge"
+          ]
+        },
+        "stableId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4096
+        }
+      }
+    },
+    "externalEffectKind": {
+      "const": "issue.comment"
+    },
+    "payloadDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "expectedContentDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "payloadArtifactDigest": {
+      "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}$"
+    },
+    "profile": {
+      "enum": [
+        "quick",
+        "standard",
+        "governed"
+      ]
+    },
+    "profileDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "workspaceDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "configDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "actor": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    },
+    "approvalDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "decidedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "expiresAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "grantDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "externalEffectKind": {
+            "const": "issue.comment"
+          }
+        },
+        "required": [
+          "externalEffectKind"
+        ]
+      },
+      "then": {
+        "properties": {
+          "action": {
+            "const": "issue.update"
+          },
+          "securityClass": {
+            "const": "external-write"
+          },
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "issue"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "action": {
+            "const": "knowledge.publish"
+          }
+        },
+        "required": [
+          "action"
+        ]
+      },
+      "then": {
+        "properties": {
+          "securityClass": {
+            "const": "external-write"
+          },
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "knowledge"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "action": {
+            "enum": [
+              "issue.update",
+              "issue.close"
+            ]
+          }
+        },
+        "required": [
+          "action"
+        ]
+      },
+      "then": {
+        "properties": {
+          "securityClass": {
+            "const": "external-write"
+          },
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "issue"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "action": {
+            "const": "git.commit"
+          }
+        },
+        "required": [
+          "action"
+        ]
+      },
+      "then": {
+        "properties": {
+          "provider": {
+            "const": "git-native"
+          },
+          "securityClass": {
+            "const": "local-write"
+          },
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "repository"
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

package/schemas/builtin-external-action-request-v1.schema.json

@@ -0,0 +1,288 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "builtin.external-action-request.v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "requestId",
+    "workItemId",
+    "stepId",
+    "attemptId",
+    "provider",
+    "action",
+    "securityClass",
+    "target",
+    "payloadDigest",
+    "expectedContentDigest",
+    "payloadArtifactDigest",
+    "bindingDigest",
+    "inputDigest",
+    "artifactDigests",
+    "idempotencyKey",
+    "profile",
+    "profileDigest",
+    "workspaceDigest",
+    "configDigest",
+    "sideEffects",
+    "createdAt",
+    "expiresAt",
+    "requestDigest"
+  ],
+  "properties": {
+    "version": {
+      "const": 1
+    },
+    "requestId": {
+      "type": "string",
+      "pattern": "^external-request-[a-f0-9]{64}$"
+    },
+    "requestDigest": {
+      "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"
+      ]
+    },
+    "securityClass": {
+      "enum": [
+        "local-write",
+        "external-write"
+      ]
+    },
+    "target": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "stableId"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "repository",
+            "issue",
+            "knowledge"
+          ]
+        },
+        "stableId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4096
+        }
+      }
+    },
+    "externalEffectKind": {
+      "const": "issue.comment"
+    },
+    "payloadDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "expectedContentDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "payloadArtifactDigest": {
+      "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}$"
+    },
+    "profile": {
+      "enum": [
+        "quick",
+        "standard",
+        "governed"
+      ]
+    },
+    "profileDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "workspaceDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "configDigest": {
+      "type": "string",
+      "pattern": "^sha256:[a-f0-9]{64}$"
+    },
+    "sideEffects": {
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 256
+      }
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "expiresAt": {
+      "type": "string",
+      "format": "date-time"
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "externalEffectKind": {
+            "const": "issue.comment"
+          }
+        },
+        "required": [
+          "externalEffectKind"
+        ]
+      },
+      "then": {
+        "properties": {
+          "action": {
+            "const": "issue.update"
+          },
+          "securityClass": {
+            "const": "external-write"
+          },
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "issue"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "action": {
+            "const": "knowledge.publish"
+          }
+        },
+        "required": [
+          "action"
+        ]
+      },
+      "then": {
+        "properties": {
+          "securityClass": {
+            "const": "external-write"
+          },
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "knowledge"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "action": {
+            "enum": [
+              "issue.update",
+              "issue.close"
+            ]
+          }
+        },
+        "required": [
+          "action"
+        ]
+      },
+      "then": {
+        "properties": {
+          "securityClass": {
+            "const": "external-write"
+          },
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "issue"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "action": {
+            "const": "git.commit"
+          }
+        },
+        "required": [
+          "action"
+        ]
+      },
+      "then": {
+        "properties": {
+          "provider": {
+            "const": "git-native"
+          },
+          "securityClass": {
+            "const": "local-write"
+          },
+          "target": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "const": "repository"
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,59 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "builtin.external-binding.v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "kind",
+    "target",
+    "exists",
+    "stableId",
+    "externalWorkItemId",
+    "publishStepId",
+    "publishAttemptId",
+    "publishInputDigest",
+    "expectedPublishedContentDigest"
+  ],
+  "properties": {
+    "version": {
+      "const": 1
+    },
+    "kind": {
+      "const": "external-binding"
+    },
+    "target": {
+      "enum": [
+        "issue",
+        "knowledge"
+      ]
+    },
+    "exists": {
+      "const": true
+    },
+    "stableId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "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:.+$"
+    },
+    "expectedPublishedContentDigest": {
+      "type": "string",
+      "pattern": "^sha256:.+$"
+    }
+  }
+}