Payload schema
requestobject
The creation request this certificate settles.
type: "empty"object
Seed a fresh repo with iterate's starter files.
type"empty"
type: "github-private"object
Seed an empty Artifact, link the GitHub repository, then pull its default branch through the Worker at depth one.
type"github-private"
connectionstring
The named GitHub connection (App installation) minting tokens.
ownerstring
GitHub owner (org or user).
repostring
GitHub repository name.
type: "github-public"object
Have Cloudflare Artifacts clone the public GitHub repository directly (no transfer through the Worker), then link it.
type"github-public"
connectionstring
The named GitHub connection (App installation) minting tokens.
depthintegeroptional
Shallow-import depth; omit to let Cloudflare Artifacts import the full history.
ownerstring
GitHub owner (org or user).
repostring
GitHub repository name.
artifactNamestring
The Cloudflare Artifacts repository name.
defaultBranchstring
The branch commit and task facts derive from.
remotestring
The artifact's Git remote URL.
Raw JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"request": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "empty"
}
},
"required": [
"type"
],
"additionalProperties": false,
"description": "Seed a fresh repo with iterate's starter files."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "github-private"
},
"connection": {
"type": "string",
"minLength": 1,
"description": "The named GitHub connection (App installation) minting tokens."
},
"owner": {
"type": "string",
"minLength": 1,
"description": "GitHub owner (org or user)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "GitHub repository name."
}
},
"required": [
"type",
"connection",
"owner",
"repo"
],
"additionalProperties": false,
"description": "Seed an empty Artifact, link the GitHub repository, then pull its default branch through the Worker at depth one."
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "github-public"
},
"connection": {
"type": "string",
"minLength": 1,
"description": "The named GitHub connection (App installation) minting tokens."
},
"depth": {
"description": "Shallow-import depth; omit to let Cloudflare Artifacts import the full history.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"owner": {
"type": "string",
"minLength": 1,
"description": "GitHub owner (org or user)."
},
"repo": {
"type": "string",
"minLength": 1,
"description": "GitHub repository name."
}
},
"required": [
"type",
"connection",
"owner",
"repo"
],
"additionalProperties": false,
"description": "Have Cloudflare Artifacts clone the public GitHub repository directly (no transfer through the Worker), then link it."
}
],
"description": "The creation request this certificate settles."
},
"artifactName": {
"type": "string",
"minLength": 1,
"description": "The Cloudflare Artifacts repository name."
},
"defaultBranch": {
"type": "string",
"minLength": 1,
"description": "The branch commit and task facts derive from."
},
"remote": {
"type": "string",
"format": "uri",
"description": "The artifact's Git remote URL."
}
},
"required": [
"request",
"artifactName",
"defaultBranch",
"remote"
],
"additionalProperties": false
}