cloudflare

type D1Query ¶ added in v1.801.350

type D1Query struct {
	// SQL is the statement to run. Required.
	SQL string `json:"sql"`
	// Params are the statement's bound values, in the order its placeholders appear.
	Params []any `json:"params,omitempty"`
}

D1Query is the shape this plane's query route takes, DECLARED for the document (openapi.Register, cloudflare.go) rather than bound by the handler. The handler forwards the caller's body to D1 verbatim, so there is no Go struct it could bind that would also state the shape — binding one is exactly the field loss the route refuses. It reads `sql` off the body to require it, and nothing else; this states the two fields D1 itself takes, and the schema is an OPEN object, so a field D1 accepts that is not named here still reaches D1 unchanged.

type PagesBuildConfig ¶

type PagesBuildConfig struct {
	BuildCommand   string `json:"build_command,omitempty"`
	DestinationDir string `json:"destination_dir,omitempty"`
	RootDir        string `json:"root_dir,omitempty"`
}

PagesBuildConfig is the project build config.

type PagesD1Binding ¶

type PagesD1Binding struct {
	ID string `json:"id"`
}

type PagesDeploy ¶ added in v1.801.350

type PagesDeploy struct {
	// Branch is the branch to build. Omit it to build the project's production branch.
	Branch string `json:"branch"`
}

PagesDeploy is the deploy request body: the branch to build. It is the whole shape this route reads, so it is also what the document declares for it (openapi.Register, cloudflare.go) — one struct, bound by the handler and reflected by the spec, so the published contract cannot drift from the code.

type PagesDeploymentConfig ¶

type PagesDeploymentConfig struct {
	CompatibilityDate  string                    `json:"compatibility_date,omitempty"`
	CompatibilityFlags []string                  `json:"compatibility_flags,omitempty"`
	EnvVars            map[string]PagesEnvVar    `json:"env_vars,omitempty"`
	KVNamespaces       map[string]PagesKVBinding `json:"kv_namespaces,omitempty"`
	D1Databases        map[string]PagesD1Binding `json:"d1_databases,omitempty"`
	R2Buckets          map[string]PagesR2Binding `json:"r2_buckets,omitempty"`
}

PagesDeploymentConfig is a preview/production deployment config.

type PagesDeploymentConfigs ¶

type PagesDeploymentConfigs struct {
	Preview    *PagesDeploymentConfig `json:"preview,omitempty"`
	Production *PagesDeploymentConfig `json:"production,omitempty"`
}

PagesDeploymentConfigs pairs the preview + production deployment configs.

type PagesEnvVar ¶

type PagesEnvVar struct {
	Value string `json:"value"`
	Type  string `json:"type,omitempty"`
}

PagesEnvVar is one deployment env var (plain_text | secret_text).

type PagesKVBinding ¶

type PagesKVBinding struct {
	NamespaceID string `json:"namespace_id"`
}

PagesKVBinding / PagesD1Binding / PagesR2Binding are the deployment-config resource bindings (ported from PagesDeploymentConfig).

type PagesProjectCreate ¶

type PagesProjectCreate struct {
	Name              string                  `json:"name"`
	ProductionBranch  string                  `json:"production_branch,omitempty"`
	BuildConfig       *PagesBuildConfig       `json:"build_config,omitempty"`
	DeploymentConfigs *PagesDeploymentConfigs `json:"deployment_configs,omitempty"`
}

PagesProjectCreate is the create-project request body (ported from PagesProjectCreateParams). The platform sends {name, production_branch}; the full shape is modeled so a richer caller is forwarded faithfully.

type PagesR2Binding ¶

type PagesR2Binding struct {
	Name string `json:"name"`
}

type PurgeCache ¶

type PurgeCache struct {
	Everything bool     `json:"purge_everything,omitempty"`
	Files      []string `json:"files,omitempty"`
}

PurgeCache is the body of a zone cache purge. Exactly one selector may be set: Everything drops the zone's entire edge cache; Files purges the listed URLs. Cloudflare also accepts tags/hosts/prefixes, which are Enterprise-only and are deliberately not modeled — an unmodeled field would silently no-op on our plan.

type WorkerScriptPut ¶

type WorkerScriptPut struct {
	Script             string          `json:"script"`
	MainModule         string          `json:"mainModule,omitempty"`
	CompatibilityDate  string          `json:"compatibilityDate,omitempty"`
	CompatibilityFlags []string        `json:"compatibilityFlags,omitempty"`
	Bindings           json.RawMessage `json:"bindings,omitempty"`
}

WorkerScriptPut is the upload request for a Workers module script. Script is the ES-module source; MainModule names the entry file (default "worker.js"). CompatibilityDate/Flags and Bindings ride the multipart metadata part. It is the struct the handler binds AND what the document declares for the route (openapi.Register, cloudflare.go), so the published contract follows the code.