wrangler 0.0.0-e6733a3 → 0.0.0-e6ada079
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of wrangler might be problematic. Click here for more details.
- package/README.md +47 -16
- package/bin/wrangler.js +94 -31
- package/config-schema.json +3100 -0
- package/kv-asset-handler.js +1 -0
- package/package.json +154 -82
- package/templates/__tests__/pages-dev-util.test.ts +128 -0
- package/templates/__tests__/tsconfig-sanity.ts +12 -0
- package/templates/__tests__/tsconfig.json +8 -0
- package/templates/checked-fetch.js +30 -0
- package/templates/facade.d.ts +19 -0
- package/templates/gitignore +170 -0
- package/templates/init-tests/test-jest-new-worker.js +23 -0
- package/templates/init-tests/test-vitest-new-worker.js +24 -0
- package/templates/init-tests/test-vitest-new-worker.ts +25 -0
- package/templates/middleware/common.ts +67 -0
- package/templates/middleware/loader-modules.ts +134 -0
- package/templates/middleware/loader-sw.ts +229 -0
- package/templates/middleware/middleware-ensure-req-body-drained.ts +18 -0
- package/templates/middleware/middleware-miniflare3-json-error.ts +32 -0
- package/templates/middleware/middleware-pretty-error.ts +40 -0
- package/templates/middleware/middleware-scheduled.ts +15 -0
- package/templates/middleware/middleware-serve-static-assets.d.ts +6 -0
- package/templates/middleware/middleware-serve-static-assets.ts +56 -0
- package/templates/modules-watch-stub.js +4 -0
- package/templates/new-worker-scheduled.js +17 -0
- package/templates/new-worker-scheduled.ts +32 -0
- package/templates/new-worker.js +15 -0
- package/templates/new-worker.ts +33 -0
- package/templates/no-op-worker.js +10 -0
- package/templates/pages-dev-pipeline.ts +32 -0
- package/templates/pages-dev-util.ts +55 -0
- package/templates/pages-shim.ts +9 -0
- package/templates/pages-template-plugin.ts +190 -0
- package/templates/pages-template-worker.ts +198 -0
- package/templates/startDevWorker/InspectorProxyWorker.ts +664 -0
- package/templates/startDevWorker/ProxyWorker.ts +334 -0
- package/templates/tsconfig-sanity.ts +11 -0
- package/templates/tsconfig.init.json +22 -0
- package/templates/tsconfig.json +8 -0
- package/wrangler-dist/InspectorProxyWorker.js +464 -0
- package/wrangler-dist/InspectorProxyWorker.js.map +6 -0
- package/wrangler-dist/ProxyWorker.js +240 -0
- package/wrangler-dist/ProxyWorker.js.map +6 -0
- package/wrangler-dist/cli.d.ts +26391 -0
- package/wrangler-dist/cli.js +204293 -116652
- package/wrangler-dist/wasm-sync.wasm +0 -0
- package/import_meta_url.js +0 -3
- package/miniflare-config-stubs/.env.empty +0 -0
- package/miniflare-config-stubs/package.empty.json +0 -1
- package/miniflare-config-stubs/wrangler.empty.toml +0 -0
- package/pages/functions/buildWorker.ts +0 -62
- package/pages/functions/filepath-routing.test.ts +0 -39
- package/pages/functions/filepath-routing.ts +0 -221
- package/pages/functions/identifiers.ts +0 -78
- package/pages/functions/routes.ts +0 -158
- package/pages/functions/template-worker.ts +0 -144
- package/src/__tests__/clipboardy-mock.js +0 -4
- package/src/__tests__/dev.test.tsx +0 -66
- package/src/__tests__/index.test.ts +0 -287
- package/src/__tests__/jest.setup.ts +0 -22
- package/src/__tests__/kv.test.ts +0 -1098
- package/src/__tests__/mock-cfetch.ts +0 -171
- package/src/__tests__/mock-dialogs.ts +0 -65
- package/src/__tests__/run-in-tmp.ts +0 -19
- package/src/__tests__/run-wrangler.ts +0 -32
- package/src/api/form_data.ts +0 -131
- package/src/api/preview.ts +0 -128
- package/src/api/worker.ts +0 -155
- package/src/cfetch/index.ts +0 -102
- package/src/cfetch/internal.ts +0 -69
- package/src/cli.ts +0 -9
- package/src/config.ts +0 -487
- package/src/dev.tsx +0 -771
- package/src/dialogs.tsx +0 -77
- package/src/index.tsx +0 -1974
- package/src/inspect.ts +0 -524
- package/src/kv.tsx +0 -267
- package/src/module-collection.ts +0 -64
- package/src/pages.tsx +0 -1031
- package/src/proxy.ts +0 -294
- package/src/publish.ts +0 -358
- package/src/sites.tsx +0 -114
- package/src/tail.tsx +0 -73
- package/src/user.tsx +0 -1025
- package/static-asset-facade.js +0 -47
- package/vendor/@cloudflare/kv-asset-handler/CHANGELOG.md +0 -332
- package/vendor/@cloudflare/kv-asset-handler/LICENSE_APACHE +0 -176
- package/vendor/@cloudflare/kv-asset-handler/LICENSE_MIT +0 -25
- package/vendor/@cloudflare/kv-asset-handler/README.md +0 -245
- package/vendor/@cloudflare/kv-asset-handler/dist/index.d.ts +0 -32
- package/vendor/@cloudflare/kv-asset-handler/dist/index.js +0 -354
- package/vendor/@cloudflare/kv-asset-handler/dist/mocks.d.ts +0 -13
- package/vendor/@cloudflare/kv-asset-handler/dist/mocks.js +0 -148
- package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.d.ts +0 -1
- package/vendor/@cloudflare/kv-asset-handler/dist/test/getAssetFromKV.js +0 -436
- package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.d.ts +0 -1
- package/vendor/@cloudflare/kv-asset-handler/dist/test/mapRequestToAsset.js +0 -40
- package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.d.ts +0 -1
- package/vendor/@cloudflare/kv-asset-handler/dist/test/serveSinglePageApp.js +0 -42
- package/vendor/@cloudflare/kv-asset-handler/dist/types.d.ts +0 -26
- package/vendor/@cloudflare/kv-asset-handler/dist/types.js +0 -31
- package/vendor/@cloudflare/kv-asset-handler/package.json +0 -52
- package/vendor/@cloudflare/kv-asset-handler/src/index.ts +0 -296
- package/vendor/@cloudflare/kv-asset-handler/src/mocks.ts +0 -136
- package/vendor/@cloudflare/kv-asset-handler/src/test/getAssetFromKV.ts +0 -464
- package/vendor/@cloudflare/kv-asset-handler/src/test/mapRequestToAsset.ts +0 -33
- package/vendor/@cloudflare/kv-asset-handler/src/test/serveSinglePageApp.ts +0 -42
- package/vendor/@cloudflare/kv-asset-handler/src/types.ts +0 -39
- package/vendor/wrangler-mime/CHANGELOG.md +0 -289
- package/vendor/wrangler-mime/LICENSE +0 -21
- package/vendor/wrangler-mime/Mime.js +0 -97
- package/vendor/wrangler-mime/README.md +0 -187
- package/vendor/wrangler-mime/cli.js +0 -46
- package/vendor/wrangler-mime/index.js +0 -4
- package/vendor/wrangler-mime/lite.js +0 -4
- package/vendor/wrangler-mime/package.json +0 -52
- package/vendor/wrangler-mime/types/other.js +0 -1
- package/vendor/wrangler-mime/types/standard.js +0 -1
- package/wrangler-dist/cli.js.map +0 -7
@@ -0,0 +1,3100 @@
|
|
1
|
+
{
|
2
|
+
"$ref": "#/definitions/RawConfig",
|
3
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
4
|
+
"definitions": {
|
5
|
+
"CloudchamberConfig": {
|
6
|
+
"additionalProperties": false,
|
7
|
+
"description": "Configuration in wrangler for Cloudchamber",
|
8
|
+
"properties": {
|
9
|
+
"memory": {
|
10
|
+
"type": "string"
|
11
|
+
},
|
12
|
+
"vcpu": {
|
13
|
+
"type": "number"
|
14
|
+
}
|
15
|
+
},
|
16
|
+
"type": "object"
|
17
|
+
},
|
18
|
+
"ConfigModuleRuleType": {
|
19
|
+
"description": "The possible types for a `Rule`.",
|
20
|
+
"enum": [
|
21
|
+
"ESModule",
|
22
|
+
"CommonJS",
|
23
|
+
"CompiledWasm",
|
24
|
+
"Text",
|
25
|
+
"Data",
|
26
|
+
"PythonModule",
|
27
|
+
"PythonRequirement",
|
28
|
+
"NodeJsCompatModule"
|
29
|
+
],
|
30
|
+
"type": "string"
|
31
|
+
},
|
32
|
+
"CustomDomainRoute": {
|
33
|
+
"additionalProperties": false,
|
34
|
+
"properties": {
|
35
|
+
"custom_domain": {
|
36
|
+
"type": "boolean"
|
37
|
+
},
|
38
|
+
"pattern": {
|
39
|
+
"type": "string"
|
40
|
+
}
|
41
|
+
},
|
42
|
+
"required": [
|
43
|
+
"pattern",
|
44
|
+
"custom_domain"
|
45
|
+
],
|
46
|
+
"type": "object"
|
47
|
+
},
|
48
|
+
"DeprecatedUpload": {
|
49
|
+
"additionalProperties": false,
|
50
|
+
"description": "Deprecated upload configuration.",
|
51
|
+
"properties": {
|
52
|
+
"dir": {
|
53
|
+
"deprecated": true,
|
54
|
+
"description": "The directory you wish to upload your Worker from, relative to the wrangler.toml file.\n\nDefaults to the directory containing the wrangler.toml file.",
|
55
|
+
"type": "string"
|
56
|
+
},
|
57
|
+
"format": {
|
58
|
+
"deprecated": "We infer the format automatically now.",
|
59
|
+
"description": "The format of the Worker script.",
|
60
|
+
"enum": [
|
61
|
+
"modules",
|
62
|
+
"service-worker"
|
63
|
+
],
|
64
|
+
"type": "string"
|
65
|
+
},
|
66
|
+
"main": {
|
67
|
+
"deprecated": "This will be replaced by a command line argument.",
|
68
|
+
"description": "The path to the Worker script, relative to `upload.dir`.",
|
69
|
+
"type": "string"
|
70
|
+
},
|
71
|
+
"rules": {
|
72
|
+
"$ref": "#/definitions/Environment",
|
73
|
+
"deprecated": "This is now defined at the top level `rules` field."
|
74
|
+
}
|
75
|
+
},
|
76
|
+
"type": "object"
|
77
|
+
},
|
78
|
+
"DispatchNamespaceOutbound": {
|
79
|
+
"additionalProperties": false,
|
80
|
+
"properties": {
|
81
|
+
"environment": {
|
82
|
+
"description": "(Optional) Name of the environment handling the outbound requests.",
|
83
|
+
"type": "string"
|
84
|
+
},
|
85
|
+
"parameters": {
|
86
|
+
"description": "(Optional) List of parameter names, for sending context from your dispatch Worker to the outbound handler",
|
87
|
+
"items": {
|
88
|
+
"type": "string"
|
89
|
+
},
|
90
|
+
"type": "array"
|
91
|
+
},
|
92
|
+
"service": {
|
93
|
+
"description": "Name of the service handling the outbound requests",
|
94
|
+
"type": "string"
|
95
|
+
}
|
96
|
+
},
|
97
|
+
"required": [
|
98
|
+
"service"
|
99
|
+
],
|
100
|
+
"type": "object"
|
101
|
+
},
|
102
|
+
"DurableObjectBindings": {
|
103
|
+
"items": {
|
104
|
+
"additionalProperties": false,
|
105
|
+
"properties": {
|
106
|
+
"class_name": {
|
107
|
+
"description": "The exported class name of the Durable Object",
|
108
|
+
"type": "string"
|
109
|
+
},
|
110
|
+
"environment": {
|
111
|
+
"description": "The service environment of the script_name to bind to",
|
112
|
+
"type": "string"
|
113
|
+
},
|
114
|
+
"name": {
|
115
|
+
"description": "The name of the binding used to refer to the Durable Object",
|
116
|
+
"type": "string"
|
117
|
+
},
|
118
|
+
"script_name": {
|
119
|
+
"description": "The script where the Durable Object is defined (if it's external to this Worker)",
|
120
|
+
"type": "string"
|
121
|
+
}
|
122
|
+
},
|
123
|
+
"required": [
|
124
|
+
"name",
|
125
|
+
"class_name"
|
126
|
+
],
|
127
|
+
"type": "object"
|
128
|
+
},
|
129
|
+
"type": "array"
|
130
|
+
},
|
131
|
+
"Environment": {
|
132
|
+
"additionalProperties": false,
|
133
|
+
"description": "The `Environment` interface declares all the configuration fields that can be specified for an environment.\n\nThis could be the top-level default environment, or a specific named environment.",
|
134
|
+
"properties": {
|
135
|
+
"account_id": {
|
136
|
+
"description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable.",
|
137
|
+
"type": "string"
|
138
|
+
},
|
139
|
+
"ai": {
|
140
|
+
"additionalProperties": false,
|
141
|
+
"default": "`{}`",
|
142
|
+
"description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
143
|
+
"properties": {
|
144
|
+
"binding": {
|
145
|
+
"type": "string"
|
146
|
+
},
|
147
|
+
"staging": {
|
148
|
+
"type": "boolean"
|
149
|
+
}
|
150
|
+
},
|
151
|
+
"required": [
|
152
|
+
"binding"
|
153
|
+
],
|
154
|
+
"type": "object"
|
155
|
+
},
|
156
|
+
"analytics_engine_datasets": {
|
157
|
+
"default": "`[]`",
|
158
|
+
"description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
159
|
+
"items": {
|
160
|
+
"additionalProperties": false,
|
161
|
+
"properties": {
|
162
|
+
"binding": {
|
163
|
+
"description": "The binding name used to refer to the dataset in the Worker.",
|
164
|
+
"type": "string"
|
165
|
+
},
|
166
|
+
"dataset": {
|
167
|
+
"description": "The name of this dataset to write to.",
|
168
|
+
"type": "string"
|
169
|
+
}
|
170
|
+
},
|
171
|
+
"required": [
|
172
|
+
"binding"
|
173
|
+
],
|
174
|
+
"type": "object"
|
175
|
+
},
|
176
|
+
"type": "array"
|
177
|
+
},
|
178
|
+
"base_dir": {
|
179
|
+
"description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified.",
|
180
|
+
"type": "string"
|
181
|
+
},
|
182
|
+
"browser": {
|
183
|
+
"additionalProperties": false,
|
184
|
+
"default": "`{}`",
|
185
|
+
"description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
186
|
+
"properties": {
|
187
|
+
"binding": {
|
188
|
+
"type": "string"
|
189
|
+
}
|
190
|
+
},
|
191
|
+
"required": [
|
192
|
+
"binding"
|
193
|
+
],
|
194
|
+
"type": "object"
|
195
|
+
},
|
196
|
+
"build": {
|
197
|
+
"additionalProperties": false,
|
198
|
+
"default": {
|
199
|
+
"watch_dir": "./src"
|
200
|
+
},
|
201
|
+
"description": "Configures a custom build step to be run by Wrangler when building your Worker.\n\nRefer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build) for more details.",
|
202
|
+
"properties": {
|
203
|
+
"command": {
|
204
|
+
"description": "The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used.",
|
205
|
+
"type": "string"
|
206
|
+
},
|
207
|
+
"cwd": {
|
208
|
+
"description": "The directory in which the command is executed.",
|
209
|
+
"type": "string"
|
210
|
+
},
|
211
|
+
"upload": {
|
212
|
+
"$ref": "#/definitions/DeprecatedUpload",
|
213
|
+
"deprecated": true,
|
214
|
+
"description": "Deprecated field previously used to configure the build and upload of the script."
|
215
|
+
},
|
216
|
+
"watch_dir": {
|
217
|
+
"anyOf": [
|
218
|
+
{
|
219
|
+
"type": "string"
|
220
|
+
},
|
221
|
+
{
|
222
|
+
"items": {
|
223
|
+
"type": "string"
|
224
|
+
},
|
225
|
+
"type": "array"
|
226
|
+
}
|
227
|
+
],
|
228
|
+
"description": "The directory to watch for changes while using wrangler dev, defaults to the current working directory"
|
229
|
+
}
|
230
|
+
},
|
231
|
+
"type": "object"
|
232
|
+
},
|
233
|
+
"cloudchamber": {
|
234
|
+
"$ref": "#/definitions/CloudchamberConfig",
|
235
|
+
"default": "`{}`",
|
236
|
+
"description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment."
|
237
|
+
},
|
238
|
+
"compatibility_date": {
|
239
|
+
"description": "A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
|
240
|
+
"type": "string"
|
241
|
+
},
|
242
|
+
"compatibility_flags": {
|
243
|
+
"default": "`[]`",
|
244
|
+
"description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_flags.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
|
245
|
+
"items": {
|
246
|
+
"type": "string"
|
247
|
+
},
|
248
|
+
"type": "array"
|
249
|
+
},
|
250
|
+
"constellation": {
|
251
|
+
"default": "`[]`",
|
252
|
+
"description": "Specifies Constellation projects that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
253
|
+
"items": {
|
254
|
+
"additionalProperties": false,
|
255
|
+
"properties": {
|
256
|
+
"binding": {
|
257
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
258
|
+
"type": "string"
|
259
|
+
},
|
260
|
+
"project_id": {
|
261
|
+
"description": "The id of the project.",
|
262
|
+
"type": "string"
|
263
|
+
}
|
264
|
+
},
|
265
|
+
"required": [
|
266
|
+
"binding",
|
267
|
+
"project_id"
|
268
|
+
],
|
269
|
+
"type": "object"
|
270
|
+
},
|
271
|
+
"type": "array"
|
272
|
+
},
|
273
|
+
"d1_databases": {
|
274
|
+
"default": "`[]`",
|
275
|
+
"description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
276
|
+
"items": {
|
277
|
+
"additionalProperties": false,
|
278
|
+
"properties": {
|
279
|
+
"binding": {
|
280
|
+
"description": "The binding name used to refer to the D1 database in the Worker.",
|
281
|
+
"type": "string"
|
282
|
+
},
|
283
|
+
"database_id": {
|
284
|
+
"description": "The UUID of this D1 database (not required).",
|
285
|
+
"type": "string"
|
286
|
+
},
|
287
|
+
"database_internal_env": {
|
288
|
+
"description": "Internal use only.",
|
289
|
+
"type": "string"
|
290
|
+
},
|
291
|
+
"database_name": {
|
292
|
+
"description": "The name of this D1 database.",
|
293
|
+
"type": "string"
|
294
|
+
},
|
295
|
+
"migrations_dir": {
|
296
|
+
"description": "The path to the directory of migrations for this D1 database (defaults to './migrations').",
|
297
|
+
"type": "string"
|
298
|
+
},
|
299
|
+
"migrations_table": {
|
300
|
+
"description": "The name of the migrations table for this D1 database (defaults to 'd1_migrations').",
|
301
|
+
"type": "string"
|
302
|
+
},
|
303
|
+
"preview_database_id": {
|
304
|
+
"description": "The UUID of this D1 database for Wrangler Dev (if specified).",
|
305
|
+
"type": "string"
|
306
|
+
}
|
307
|
+
},
|
308
|
+
"required": [
|
309
|
+
"binding",
|
310
|
+
"database_name",
|
311
|
+
"database_id"
|
312
|
+
],
|
313
|
+
"type": "object"
|
314
|
+
},
|
315
|
+
"type": "array"
|
316
|
+
},
|
317
|
+
"define": {
|
318
|
+
"additionalProperties": {
|
319
|
+
"type": "string"
|
320
|
+
},
|
321
|
+
"default": "`{}`",
|
322
|
+
"description": "A map of values to substitute when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
323
|
+
"type": "object"
|
324
|
+
},
|
325
|
+
"dispatch_namespaces": {
|
326
|
+
"default": "`[]`",
|
327
|
+
"description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
328
|
+
"items": {
|
329
|
+
"additionalProperties": false,
|
330
|
+
"properties": {
|
331
|
+
"binding": {
|
332
|
+
"description": "The binding name used to refer to the bound service.",
|
333
|
+
"type": "string"
|
334
|
+
},
|
335
|
+
"namespace": {
|
336
|
+
"description": "The namespace to bind to.",
|
337
|
+
"type": "string"
|
338
|
+
},
|
339
|
+
"outbound": {
|
340
|
+
"$ref": "#/definitions/DispatchNamespaceOutbound",
|
341
|
+
"description": "Details about the outbound Worker which will handle outbound requests from your namespace"
|
342
|
+
}
|
343
|
+
},
|
344
|
+
"required": [
|
345
|
+
"binding",
|
346
|
+
"namespace"
|
347
|
+
],
|
348
|
+
"type": "object"
|
349
|
+
},
|
350
|
+
"type": "array"
|
351
|
+
},
|
352
|
+
"durable_objects": {
|
353
|
+
"additionalProperties": false,
|
354
|
+
"default": "`{bindings:[]}`",
|
355
|
+
"description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
356
|
+
"properties": {
|
357
|
+
"bindings": {
|
358
|
+
"$ref": "#/definitions/DurableObjectBindings"
|
359
|
+
}
|
360
|
+
},
|
361
|
+
"required": [
|
362
|
+
"bindings"
|
363
|
+
],
|
364
|
+
"type": "object"
|
365
|
+
},
|
366
|
+
"find_additional_modules": {
|
367
|
+
"description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false.",
|
368
|
+
"type": "boolean"
|
369
|
+
},
|
370
|
+
"first_party_worker": {
|
371
|
+
"description": "Designates this Worker as an internal-only \"first-party\" Worker.",
|
372
|
+
"type": "boolean"
|
373
|
+
},
|
374
|
+
"hyperdrive": {
|
375
|
+
"default": "`[]`",
|
376
|
+
"description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
377
|
+
"items": {
|
378
|
+
"additionalProperties": false,
|
379
|
+
"properties": {
|
380
|
+
"binding": {
|
381
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
382
|
+
"type": "string"
|
383
|
+
},
|
384
|
+
"id": {
|
385
|
+
"description": "The id of the database.",
|
386
|
+
"type": "string"
|
387
|
+
},
|
388
|
+
"localConnectionString": {
|
389
|
+
"description": "The local database connection string for `wrangler dev`",
|
390
|
+
"type": "string"
|
391
|
+
}
|
392
|
+
},
|
393
|
+
"required": [
|
394
|
+
"binding",
|
395
|
+
"id"
|
396
|
+
],
|
397
|
+
"type": "object"
|
398
|
+
},
|
399
|
+
"type": "array"
|
400
|
+
},
|
401
|
+
"jsx_factory": {
|
402
|
+
"default": "`\"React.createElement\"`",
|
403
|
+
"description": "The function to use to replace jsx syntax.",
|
404
|
+
"type": "string"
|
405
|
+
},
|
406
|
+
"jsx_fragment": {
|
407
|
+
"default": "`\"React.Fragment\"`",
|
408
|
+
"description": "The function to use to replace jsx fragment syntax.",
|
409
|
+
"type": "string"
|
410
|
+
},
|
411
|
+
"kv_namespaces": {
|
412
|
+
"default": "`[]`",
|
413
|
+
"description": "These specify any Workers KV Namespaces you want to access from inside your Worker.\n\nTo learn more about KV Namespaces, see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
414
|
+
"items": {
|
415
|
+
"additionalProperties": false,
|
416
|
+
"properties": {
|
417
|
+
"binding": {
|
418
|
+
"description": "The binding name used to refer to the KV Namespace",
|
419
|
+
"type": "string"
|
420
|
+
},
|
421
|
+
"id": {
|
422
|
+
"description": "The ID of the KV namespace",
|
423
|
+
"type": "string"
|
424
|
+
},
|
425
|
+
"preview_id": {
|
426
|
+
"description": "The ID of the KV namespace used during `wrangler dev`",
|
427
|
+
"type": "string"
|
428
|
+
}
|
429
|
+
},
|
430
|
+
"required": [
|
431
|
+
"binding",
|
432
|
+
"id"
|
433
|
+
],
|
434
|
+
"type": "object"
|
435
|
+
},
|
436
|
+
"type": "array"
|
437
|
+
},
|
438
|
+
"limits": {
|
439
|
+
"$ref": "#/definitions/UserLimits",
|
440
|
+
"description": "Specify limits for runtime behavior. Only supported for the \"standard\" Usage Model"
|
441
|
+
},
|
442
|
+
"logfwdr": {
|
443
|
+
"additionalProperties": false,
|
444
|
+
"default": "`{bindings:[]}`",
|
445
|
+
"description": "List of bindings that you will send to logfwdr",
|
446
|
+
"properties": {
|
447
|
+
"bindings": {
|
448
|
+
"items": {
|
449
|
+
"additionalProperties": false,
|
450
|
+
"properties": {
|
451
|
+
"destination": {
|
452
|
+
"description": "The destination for this logged message",
|
453
|
+
"type": "string"
|
454
|
+
},
|
455
|
+
"name": {
|
456
|
+
"description": "The binding name used to refer to logfwdr",
|
457
|
+
"type": "string"
|
458
|
+
}
|
459
|
+
},
|
460
|
+
"required": [
|
461
|
+
"name",
|
462
|
+
"destination"
|
463
|
+
],
|
464
|
+
"type": "object"
|
465
|
+
},
|
466
|
+
"type": "array"
|
467
|
+
}
|
468
|
+
},
|
469
|
+
"required": [
|
470
|
+
"bindings"
|
471
|
+
],
|
472
|
+
"type": "object"
|
473
|
+
},
|
474
|
+
"logpush": {
|
475
|
+
"description": "Send Trace Events from this Worker to Workers Logpush.\n\nThis will not configure a corresponding Logpush job automatically.\n\nFor more information about Workers Logpush, see: https://blog.cloudflare.com/logpush-for-workers/",
|
476
|
+
"type": "boolean"
|
477
|
+
},
|
478
|
+
"main": {
|
479
|
+
"description": "The entrypoint/path to the JavaScript file that will be executed.",
|
480
|
+
"type": "string"
|
481
|
+
},
|
482
|
+
"migrations": {
|
483
|
+
"default": [],
|
484
|
+
"description": "A list of migrations that should be uploaded with your Worker.\n\nThese define changes in your Durable Object declarations.\n\nMore details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations",
|
485
|
+
"items": {
|
486
|
+
"additionalProperties": false,
|
487
|
+
"properties": {
|
488
|
+
"deleted_classes": {
|
489
|
+
"description": "The Durable Objects being removed.",
|
490
|
+
"items": {
|
491
|
+
"type": "string"
|
492
|
+
},
|
493
|
+
"type": "array"
|
494
|
+
},
|
495
|
+
"new_classes": {
|
496
|
+
"description": "The new Durable Objects being defined.",
|
497
|
+
"items": {
|
498
|
+
"type": "string"
|
499
|
+
},
|
500
|
+
"type": "array"
|
501
|
+
},
|
502
|
+
"renamed_classes": {
|
503
|
+
"description": "The Durable Objects being renamed.",
|
504
|
+
"items": {
|
505
|
+
"additionalProperties": false,
|
506
|
+
"properties": {
|
507
|
+
"from": {
|
508
|
+
"type": "string"
|
509
|
+
},
|
510
|
+
"to": {
|
511
|
+
"type": "string"
|
512
|
+
}
|
513
|
+
},
|
514
|
+
"required": [
|
515
|
+
"from",
|
516
|
+
"to"
|
517
|
+
],
|
518
|
+
"type": "object"
|
519
|
+
},
|
520
|
+
"type": "array"
|
521
|
+
},
|
522
|
+
"tag": {
|
523
|
+
"description": "A unique identifier for this migration.",
|
524
|
+
"type": "string"
|
525
|
+
}
|
526
|
+
},
|
527
|
+
"required": [
|
528
|
+
"tag"
|
529
|
+
],
|
530
|
+
"type": "object"
|
531
|
+
},
|
532
|
+
"type": "array"
|
533
|
+
},
|
534
|
+
"minify": {
|
535
|
+
"description": "Minify the script before uploading.",
|
536
|
+
"type": "boolean"
|
537
|
+
},
|
538
|
+
"mtls_certificates": {
|
539
|
+
"default": "`[]`",
|
540
|
+
"description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
541
|
+
"items": {
|
542
|
+
"additionalProperties": false,
|
543
|
+
"properties": {
|
544
|
+
"binding": {
|
545
|
+
"description": "The binding name used to refer to the certificate in the Worker",
|
546
|
+
"type": "string"
|
547
|
+
},
|
548
|
+
"certificate_id": {
|
549
|
+
"description": "The uuid of the uploaded mTLS certificate",
|
550
|
+
"type": "string"
|
551
|
+
}
|
552
|
+
},
|
553
|
+
"required": [
|
554
|
+
"binding",
|
555
|
+
"certificate_id"
|
556
|
+
],
|
557
|
+
"type": "object"
|
558
|
+
},
|
559
|
+
"type": "array"
|
560
|
+
},
|
561
|
+
"name": {
|
562
|
+
"description": "The name of your Worker. Alphanumeric + dashes only.",
|
563
|
+
"type": "string"
|
564
|
+
},
|
565
|
+
"no_bundle": {
|
566
|
+
"description": "Skip internal build steps and directly deploy script",
|
567
|
+
"type": "boolean"
|
568
|
+
},
|
569
|
+
"node_compat": {
|
570
|
+
"description": "Add polyfills for node builtin modules and globals",
|
571
|
+
"type": "boolean"
|
572
|
+
},
|
573
|
+
"placement": {
|
574
|
+
"additionalProperties": false,
|
575
|
+
"description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
|
576
|
+
"properties": {
|
577
|
+
"mode": {
|
578
|
+
"enum": [
|
579
|
+
"off",
|
580
|
+
"smart"
|
581
|
+
],
|
582
|
+
"type": "string"
|
583
|
+
}
|
584
|
+
},
|
585
|
+
"required": [
|
586
|
+
"mode"
|
587
|
+
],
|
588
|
+
"type": "object"
|
589
|
+
},
|
590
|
+
"preserve_file_names": {
|
591
|
+
"description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.",
|
592
|
+
"type": "boolean"
|
593
|
+
},
|
594
|
+
"queues": {
|
595
|
+
"additionalProperties": false,
|
596
|
+
"default": "`{consumers:[],producers:[]}`",
|
597
|
+
"description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
598
|
+
"properties": {
|
599
|
+
"consumers": {
|
600
|
+
"description": "Consumer configuration",
|
601
|
+
"items": {
|
602
|
+
"additionalProperties": false,
|
603
|
+
"properties": {
|
604
|
+
"dead_letter_queue": {
|
605
|
+
"description": "The queue to send messages that failed to be consumed.",
|
606
|
+
"type": "string"
|
607
|
+
},
|
608
|
+
"max_batch_size": {
|
609
|
+
"description": "The maximum number of messages per batch",
|
610
|
+
"type": "number"
|
611
|
+
},
|
612
|
+
"max_batch_timeout": {
|
613
|
+
"description": "The maximum number of seconds to wait to fill a batch with messages.",
|
614
|
+
"type": "number"
|
615
|
+
},
|
616
|
+
"max_concurrency": {
|
617
|
+
"description": "The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog.",
|
618
|
+
"type": [
|
619
|
+
"number",
|
620
|
+
"null"
|
621
|
+
]
|
622
|
+
},
|
623
|
+
"max_retries": {
|
624
|
+
"description": "The maximum number of retries for each message.",
|
625
|
+
"type": "number"
|
626
|
+
},
|
627
|
+
"queue": {
|
628
|
+
"description": "The name of the queue from which this consumer should consume.",
|
629
|
+
"type": "string"
|
630
|
+
},
|
631
|
+
"retry_delay": {
|
632
|
+
"description": "The number of seconds to wait before retrying a message",
|
633
|
+
"type": "number"
|
634
|
+
},
|
635
|
+
"type": {
|
636
|
+
"description": "The consumer type, e.g., worker, http-pull, r2-bucket, etc. Default is worker.",
|
637
|
+
"type": "string"
|
638
|
+
},
|
639
|
+
"visibility_timeout_ms": {
|
640
|
+
"description": "The number of milliseconds to wait for pulled messages to become visible again",
|
641
|
+
"type": "number"
|
642
|
+
}
|
643
|
+
},
|
644
|
+
"required": [
|
645
|
+
"queue"
|
646
|
+
],
|
647
|
+
"type": "object"
|
648
|
+
},
|
649
|
+
"type": "array"
|
650
|
+
},
|
651
|
+
"producers": {
|
652
|
+
"description": "Producer bindings",
|
653
|
+
"items": {
|
654
|
+
"additionalProperties": false,
|
655
|
+
"properties": {
|
656
|
+
"binding": {
|
657
|
+
"description": "The binding name used to refer to the Queue in the Worker.",
|
658
|
+
"type": "string"
|
659
|
+
},
|
660
|
+
"delivery_delay": {
|
661
|
+
"description": "The number of seconds to wait before delivering a message",
|
662
|
+
"type": "number"
|
663
|
+
},
|
664
|
+
"queue": {
|
665
|
+
"description": "The name of this Queue.",
|
666
|
+
"type": "string"
|
667
|
+
}
|
668
|
+
},
|
669
|
+
"required": [
|
670
|
+
"binding",
|
671
|
+
"queue"
|
672
|
+
],
|
673
|
+
"type": "object"
|
674
|
+
},
|
675
|
+
"type": "array"
|
676
|
+
}
|
677
|
+
},
|
678
|
+
"type": "object"
|
679
|
+
},
|
680
|
+
"r2_buckets": {
|
681
|
+
"default": "`[]`",
|
682
|
+
"description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
683
|
+
"items": {
|
684
|
+
"additionalProperties": false,
|
685
|
+
"properties": {
|
686
|
+
"binding": {
|
687
|
+
"description": "The binding name used to refer to the R2 bucket in the Worker.",
|
688
|
+
"type": "string"
|
689
|
+
},
|
690
|
+
"bucket_name": {
|
691
|
+
"description": "The name of this R2 bucket at the edge.",
|
692
|
+
"type": "string"
|
693
|
+
},
|
694
|
+
"jurisdiction": {
|
695
|
+
"description": "The jurisdiction that the bucket exists in. Default if not present.",
|
696
|
+
"type": "string"
|
697
|
+
},
|
698
|
+
"preview_bucket_name": {
|
699
|
+
"description": "The preview name of this R2 bucket at the edge.",
|
700
|
+
"type": "string"
|
701
|
+
}
|
702
|
+
},
|
703
|
+
"required": [
|
704
|
+
"binding",
|
705
|
+
"bucket_name"
|
706
|
+
],
|
707
|
+
"type": "object"
|
708
|
+
},
|
709
|
+
"type": "array"
|
710
|
+
},
|
711
|
+
"route": {
|
712
|
+
"$ref": "#/definitions/Route",
|
713
|
+
"description": "A route that your Worker should be published to. Literally the same as routes, but only one. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker"
|
714
|
+
},
|
715
|
+
"routes": {
|
716
|
+
"description": "A list of routes that your Worker should be published to. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker (see `triggers`)",
|
717
|
+
"items": {
|
718
|
+
"$ref": "#/definitions/Route"
|
719
|
+
},
|
720
|
+
"type": "array"
|
721
|
+
},
|
722
|
+
"rules": {
|
723
|
+
"description": "An ordered list of rules that define which modules to import, and what type to import them as. You will need to specify rules to use Text, Data, and CompiledWasm modules, or when you wish to have a .js file be treated as an ESModule instead of CommonJS.",
|
724
|
+
"items": {
|
725
|
+
"$ref": "#/definitions/Rule"
|
726
|
+
},
|
727
|
+
"type": "array"
|
728
|
+
},
|
729
|
+
"send_email": {
|
730
|
+
"default": "`[]`",
|
731
|
+
"description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
732
|
+
"items": {
|
733
|
+
"additionalProperties": false,
|
734
|
+
"properties": {
|
735
|
+
"allowed_destination_addresses": {
|
736
|
+
"description": "If this binding should be restricted to a set of verified addresses",
|
737
|
+
"items": {
|
738
|
+
"type": "string"
|
739
|
+
},
|
740
|
+
"type": "array"
|
741
|
+
},
|
742
|
+
"destination_address": {
|
743
|
+
"description": "If this binding should be restricted to a specific verified address",
|
744
|
+
"type": "string"
|
745
|
+
},
|
746
|
+
"name": {
|
747
|
+
"description": "The binding name used to refer to the this binding",
|
748
|
+
"type": "string"
|
749
|
+
}
|
750
|
+
},
|
751
|
+
"required": [
|
752
|
+
"name"
|
753
|
+
],
|
754
|
+
"type": "object"
|
755
|
+
},
|
756
|
+
"type": "array"
|
757
|
+
},
|
758
|
+
"services": {
|
759
|
+
"default": "`[]`",
|
760
|
+
"description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
761
|
+
"items": {
|
762
|
+
"additionalProperties": false,
|
763
|
+
"properties": {
|
764
|
+
"binding": {
|
765
|
+
"description": "The binding name used to refer to the bound service.",
|
766
|
+
"type": "string"
|
767
|
+
},
|
768
|
+
"entrypoint": {
|
769
|
+
"description": "Optionally, the entrypoint (named export) of the service to bind to.",
|
770
|
+
"type": "string"
|
771
|
+
},
|
772
|
+
"environment": {
|
773
|
+
"description": "The environment of the service (e.g. production, staging, etc).",
|
774
|
+
"type": "string"
|
775
|
+
},
|
776
|
+
"service": {
|
777
|
+
"description": "The name of the service.",
|
778
|
+
"type": "string"
|
779
|
+
}
|
780
|
+
},
|
781
|
+
"required": [
|
782
|
+
"binding",
|
783
|
+
"service"
|
784
|
+
],
|
785
|
+
"type": "object"
|
786
|
+
},
|
787
|
+
"type": "array"
|
788
|
+
},
|
789
|
+
"tail_consumers": {
|
790
|
+
"default": "`[]`",
|
791
|
+
"description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
792
|
+
"items": {
|
793
|
+
"$ref": "#/definitions/TailConsumer"
|
794
|
+
},
|
795
|
+
"type": "array"
|
796
|
+
},
|
797
|
+
"triggers": {
|
798
|
+
"additionalProperties": false,
|
799
|
+
"default": "`{crons:[]}`",
|
800
|
+
"description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
|
801
|
+
"properties": {
|
802
|
+
"crons": {
|
803
|
+
"items": {
|
804
|
+
"type": "string"
|
805
|
+
},
|
806
|
+
"type": "array"
|
807
|
+
}
|
808
|
+
},
|
809
|
+
"required": [
|
810
|
+
"crons"
|
811
|
+
],
|
812
|
+
"type": "object"
|
813
|
+
},
|
814
|
+
"tsconfig": {
|
815
|
+
"description": "Path to a custom tsconfig",
|
816
|
+
"type": "string"
|
817
|
+
},
|
818
|
+
"unsafe": {
|
819
|
+
"additionalProperties": false,
|
820
|
+
"default": "`{}`",
|
821
|
+
"description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
822
|
+
"properties": {
|
823
|
+
"bindings": {
|
824
|
+
"description": "A set of bindings that should be put into a Worker's upload metadata without changes. These can be used to implement bindings for features that haven't released and aren't supported directly by wrangler or miniflare.",
|
825
|
+
"items": {
|
826
|
+
"additionalProperties": {},
|
827
|
+
"properties": {
|
828
|
+
"name": {
|
829
|
+
"type": "string"
|
830
|
+
},
|
831
|
+
"type": {
|
832
|
+
"type": "string"
|
833
|
+
}
|
834
|
+
},
|
835
|
+
"required": [
|
836
|
+
"name",
|
837
|
+
"type"
|
838
|
+
],
|
839
|
+
"type": "object"
|
840
|
+
},
|
841
|
+
"type": "array"
|
842
|
+
},
|
843
|
+
"capnp": {
|
844
|
+
"anyOf": [
|
845
|
+
{
|
846
|
+
"additionalProperties": false,
|
847
|
+
"properties": {
|
848
|
+
"base_path": {
|
849
|
+
"type": "string"
|
850
|
+
},
|
851
|
+
"source_schemas": {
|
852
|
+
"items": {
|
853
|
+
"type": "string"
|
854
|
+
},
|
855
|
+
"type": "array"
|
856
|
+
}
|
857
|
+
},
|
858
|
+
"required": [
|
859
|
+
"base_path",
|
860
|
+
"source_schemas"
|
861
|
+
],
|
862
|
+
"type": "object"
|
863
|
+
},
|
864
|
+
{
|
865
|
+
"additionalProperties": false,
|
866
|
+
"properties": {
|
867
|
+
"compiled_schema": {
|
868
|
+
"type": "string"
|
869
|
+
}
|
870
|
+
},
|
871
|
+
"required": [
|
872
|
+
"compiled_schema"
|
873
|
+
],
|
874
|
+
"type": "object"
|
875
|
+
}
|
876
|
+
],
|
877
|
+
"description": "Used for internal capnp uploads for the Workers runtime"
|
878
|
+
},
|
879
|
+
"metadata": {
|
880
|
+
"additionalProperties": {},
|
881
|
+
"description": "Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified here will always be applied to metadata last, so can add new or override existing fields.",
|
882
|
+
"type": "object"
|
883
|
+
}
|
884
|
+
},
|
885
|
+
"type": "object"
|
886
|
+
},
|
887
|
+
"upload_source_maps": {
|
888
|
+
"description": "Include source maps when uploading this worker.",
|
889
|
+
"type": "boolean"
|
890
|
+
},
|
891
|
+
"usage_model": {
|
892
|
+
"description": "Specifies the Usage Model for your Worker. There are two options - [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model). For newly created Workers, if the Usage Model is omitted it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model). For existing Workers, if the Usage Model is omitted, it will be set to the Usage Model configured in the dashboard for that Worker.",
|
893
|
+
"enum": [
|
894
|
+
"bundled",
|
895
|
+
"unbound"
|
896
|
+
],
|
897
|
+
"type": "string"
|
898
|
+
},
|
899
|
+
"vars": {
|
900
|
+
"additionalProperties": {
|
901
|
+
"anyOf": [
|
902
|
+
{
|
903
|
+
"type": "string"
|
904
|
+
},
|
905
|
+
{
|
906
|
+
"$ref": "#/definitions/Json"
|
907
|
+
}
|
908
|
+
]
|
909
|
+
},
|
910
|
+
"default": "`{}`",
|
911
|
+
"description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
912
|
+
"type": "object"
|
913
|
+
},
|
914
|
+
"vectorize": {
|
915
|
+
"default": "`[]`",
|
916
|
+
"description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
917
|
+
"items": {
|
918
|
+
"additionalProperties": false,
|
919
|
+
"properties": {
|
920
|
+
"binding": {
|
921
|
+
"description": "The binding name used to refer to the Vectorize index in the Worker.",
|
922
|
+
"type": "string"
|
923
|
+
},
|
924
|
+
"index_name": {
|
925
|
+
"description": "The name of the index.",
|
926
|
+
"type": "string"
|
927
|
+
}
|
928
|
+
},
|
929
|
+
"required": [
|
930
|
+
"binding",
|
931
|
+
"index_name"
|
932
|
+
],
|
933
|
+
"type": "object"
|
934
|
+
},
|
935
|
+
"type": "array"
|
936
|
+
},
|
937
|
+
"version_metadata": {
|
938
|
+
"additionalProperties": false,
|
939
|
+
"description": "Binding to the Worker Version's metadata",
|
940
|
+
"properties": {
|
941
|
+
"binding": {
|
942
|
+
"type": "string"
|
943
|
+
}
|
944
|
+
},
|
945
|
+
"required": [
|
946
|
+
"binding"
|
947
|
+
],
|
948
|
+
"type": "object"
|
949
|
+
},
|
950
|
+
"workers_dev": {
|
951
|
+
"default": "`true` (This is a breaking change from Wrangler v1)",
|
952
|
+
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.\n\n// Carmen according to our tests the default is undefined",
|
953
|
+
"type": "boolean"
|
954
|
+
},
|
955
|
+
"zone_id": {
|
956
|
+
"description": "TODO: remove this as it has been deprecated.\n\nThis is just here for now because the `route` commands use it. So we need to include it in this type so it is available.",
|
957
|
+
"type": "string"
|
958
|
+
}
|
959
|
+
},
|
960
|
+
"required": [
|
961
|
+
"analytics_engine_datasets",
|
962
|
+
"build",
|
963
|
+
"cloudchamber",
|
964
|
+
"compatibility_flags",
|
965
|
+
"constellation",
|
966
|
+
"d1_databases",
|
967
|
+
"define",
|
968
|
+
"dispatch_namespaces",
|
969
|
+
"durable_objects",
|
970
|
+
"hyperdrive",
|
971
|
+
"jsx_factory",
|
972
|
+
"jsx_fragment",
|
973
|
+
"kv_namespaces",
|
974
|
+
"logfwdr",
|
975
|
+
"migrations",
|
976
|
+
"mtls_certificates",
|
977
|
+
"queues",
|
978
|
+
"r2_buckets",
|
979
|
+
"rules",
|
980
|
+
"send_email",
|
981
|
+
"triggers",
|
982
|
+
"unsafe",
|
983
|
+
"vars",
|
984
|
+
"vectorize"
|
985
|
+
],
|
986
|
+
"type": "object"
|
987
|
+
},
|
988
|
+
"Json": {
|
989
|
+
"anyOf": [
|
990
|
+
{
|
991
|
+
"$ref": "#/definitions/Literal"
|
992
|
+
},
|
993
|
+
{
|
994
|
+
"additionalProperties": {
|
995
|
+
"$ref": "#/definitions/Json"
|
996
|
+
},
|
997
|
+
"type": "object"
|
998
|
+
},
|
999
|
+
{
|
1000
|
+
"items": {
|
1001
|
+
"$ref": "#/definitions/Json"
|
1002
|
+
},
|
1003
|
+
"type": "array"
|
1004
|
+
}
|
1005
|
+
]
|
1006
|
+
},
|
1007
|
+
"Literal": {
|
1008
|
+
"$ref": "#/definitions/TypeOf%3CZodUnion%3C%5Bdef-class-1315922706-6501-8772-1315922706-0-54395%2Cdef-class-1315922706-9299-10989-1315922706-0-54395%2Cdef-class-1315922706-12937-13365-1315922706-0-54395%2Cdef-class-1315922706-15083-15273-1315922706-0-54395%5D%3E%3E"
|
1009
|
+
},
|
1010
|
+
"RawConfig": {
|
1011
|
+
"additionalProperties": false,
|
1012
|
+
"properties": {
|
1013
|
+
"$schema": {
|
1014
|
+
"type": "string"
|
1015
|
+
},
|
1016
|
+
"account_id": {
|
1017
|
+
"description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable.",
|
1018
|
+
"type": "string"
|
1019
|
+
},
|
1020
|
+
"ai": {
|
1021
|
+
"additionalProperties": false,
|
1022
|
+
"default": "`{}`",
|
1023
|
+
"description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1024
|
+
"properties": {
|
1025
|
+
"binding": {
|
1026
|
+
"type": "string"
|
1027
|
+
},
|
1028
|
+
"staging": {
|
1029
|
+
"type": "boolean"
|
1030
|
+
}
|
1031
|
+
},
|
1032
|
+
"required": [
|
1033
|
+
"binding"
|
1034
|
+
],
|
1035
|
+
"type": "object"
|
1036
|
+
},
|
1037
|
+
"alias": {
|
1038
|
+
"additionalProperties": {
|
1039
|
+
"type": "string"
|
1040
|
+
},
|
1041
|
+
"description": "A map of module aliases. Lets you swap out a module for any others. Corresponds with esbuild's `alias` config",
|
1042
|
+
"type": "object"
|
1043
|
+
},
|
1044
|
+
"analytics_engine_datasets": {
|
1045
|
+
"default": "`[]`",
|
1046
|
+
"description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1047
|
+
"items": {
|
1048
|
+
"additionalProperties": false,
|
1049
|
+
"properties": {
|
1050
|
+
"binding": {
|
1051
|
+
"description": "The binding name used to refer to the dataset in the Worker.",
|
1052
|
+
"type": "string"
|
1053
|
+
},
|
1054
|
+
"dataset": {
|
1055
|
+
"description": "The name of this dataset to write to.",
|
1056
|
+
"type": "string"
|
1057
|
+
}
|
1058
|
+
},
|
1059
|
+
"required": [
|
1060
|
+
"binding"
|
1061
|
+
],
|
1062
|
+
"type": "object"
|
1063
|
+
},
|
1064
|
+
"type": "array"
|
1065
|
+
},
|
1066
|
+
"assets": {
|
1067
|
+
"anyOf": [
|
1068
|
+
{
|
1069
|
+
"additionalProperties": false,
|
1070
|
+
"properties": {
|
1071
|
+
"browser_TTL": {
|
1072
|
+
"type": "number"
|
1073
|
+
},
|
1074
|
+
"bucket": {
|
1075
|
+
"type": "string"
|
1076
|
+
},
|
1077
|
+
"exclude": {
|
1078
|
+
"items": {
|
1079
|
+
"type": "string"
|
1080
|
+
},
|
1081
|
+
"type": "array"
|
1082
|
+
},
|
1083
|
+
"include": {
|
1084
|
+
"items": {
|
1085
|
+
"type": "string"
|
1086
|
+
},
|
1087
|
+
"type": "array"
|
1088
|
+
},
|
1089
|
+
"serve_single_page_app": {
|
1090
|
+
"type": "boolean"
|
1091
|
+
}
|
1092
|
+
},
|
1093
|
+
"required": [
|
1094
|
+
"bucket",
|
1095
|
+
"include",
|
1096
|
+
"exclude",
|
1097
|
+
"serve_single_page_app"
|
1098
|
+
],
|
1099
|
+
"type": "object"
|
1100
|
+
},
|
1101
|
+
{
|
1102
|
+
"type": "string"
|
1103
|
+
}
|
1104
|
+
],
|
1105
|
+
"description": "Serve a folder of static assets with your Worker, without any additional code. This can either be a string, or an object with additional config fields. Only one of assets and legacy_assets can be used."
|
1106
|
+
},
|
1107
|
+
"base_dir": {
|
1108
|
+
"description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified.",
|
1109
|
+
"type": "string"
|
1110
|
+
},
|
1111
|
+
"browser": {
|
1112
|
+
"additionalProperties": false,
|
1113
|
+
"default": "`{}`",
|
1114
|
+
"description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1115
|
+
"properties": {
|
1116
|
+
"binding": {
|
1117
|
+
"type": "string"
|
1118
|
+
}
|
1119
|
+
},
|
1120
|
+
"required": [
|
1121
|
+
"binding"
|
1122
|
+
],
|
1123
|
+
"type": "object"
|
1124
|
+
},
|
1125
|
+
"build": {
|
1126
|
+
"additionalProperties": false,
|
1127
|
+
"default": {
|
1128
|
+
"watch_dir": "./src"
|
1129
|
+
},
|
1130
|
+
"description": "Configures a custom build step to be run by Wrangler when building your Worker.\n\nRefer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build) for more details.",
|
1131
|
+
"properties": {
|
1132
|
+
"command": {
|
1133
|
+
"description": "The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used.",
|
1134
|
+
"type": "string"
|
1135
|
+
},
|
1136
|
+
"cwd": {
|
1137
|
+
"description": "The directory in which the command is executed.",
|
1138
|
+
"type": "string"
|
1139
|
+
},
|
1140
|
+
"upload": {
|
1141
|
+
"$ref": "#/definitions/DeprecatedUpload",
|
1142
|
+
"deprecated": true,
|
1143
|
+
"description": "Deprecated field previously used to configure the build and upload of the script."
|
1144
|
+
},
|
1145
|
+
"watch_dir": {
|
1146
|
+
"anyOf": [
|
1147
|
+
{
|
1148
|
+
"type": "string"
|
1149
|
+
},
|
1150
|
+
{
|
1151
|
+
"items": {
|
1152
|
+
"type": "string"
|
1153
|
+
},
|
1154
|
+
"type": "array"
|
1155
|
+
}
|
1156
|
+
],
|
1157
|
+
"description": "The directory to watch for changes while using wrangler dev, defaults to the current working directory"
|
1158
|
+
}
|
1159
|
+
},
|
1160
|
+
"type": "object"
|
1161
|
+
},
|
1162
|
+
"cloudchamber": {
|
1163
|
+
"$ref": "#/definitions/CloudchamberConfig",
|
1164
|
+
"default": "`{}`",
|
1165
|
+
"description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment."
|
1166
|
+
},
|
1167
|
+
"compatibility_date": {
|
1168
|
+
"description": "A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
|
1169
|
+
"type": "string"
|
1170
|
+
},
|
1171
|
+
"compatibility_flags": {
|
1172
|
+
"default": "`[]`",
|
1173
|
+
"description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_flags.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
|
1174
|
+
"items": {
|
1175
|
+
"type": "string"
|
1176
|
+
},
|
1177
|
+
"type": "array"
|
1178
|
+
},
|
1179
|
+
"configPath": {
|
1180
|
+
"type": "string"
|
1181
|
+
},
|
1182
|
+
"constellation": {
|
1183
|
+
"default": "`[]`",
|
1184
|
+
"description": "Specifies Constellation projects that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1185
|
+
"items": {
|
1186
|
+
"additionalProperties": false,
|
1187
|
+
"properties": {
|
1188
|
+
"binding": {
|
1189
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
1190
|
+
"type": "string"
|
1191
|
+
},
|
1192
|
+
"project_id": {
|
1193
|
+
"description": "The id of the project.",
|
1194
|
+
"type": "string"
|
1195
|
+
}
|
1196
|
+
},
|
1197
|
+
"required": [
|
1198
|
+
"binding",
|
1199
|
+
"project_id"
|
1200
|
+
],
|
1201
|
+
"type": "object"
|
1202
|
+
},
|
1203
|
+
"type": "array"
|
1204
|
+
},
|
1205
|
+
"d1_databases": {
|
1206
|
+
"default": "`[]`",
|
1207
|
+
"description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1208
|
+
"items": {
|
1209
|
+
"additionalProperties": false,
|
1210
|
+
"properties": {
|
1211
|
+
"binding": {
|
1212
|
+
"description": "The binding name used to refer to the D1 database in the Worker.",
|
1213
|
+
"type": "string"
|
1214
|
+
},
|
1215
|
+
"database_id": {
|
1216
|
+
"description": "The UUID of this D1 database (not required).",
|
1217
|
+
"type": "string"
|
1218
|
+
},
|
1219
|
+
"database_internal_env": {
|
1220
|
+
"description": "Internal use only.",
|
1221
|
+
"type": "string"
|
1222
|
+
},
|
1223
|
+
"database_name": {
|
1224
|
+
"description": "The name of this D1 database.",
|
1225
|
+
"type": "string"
|
1226
|
+
},
|
1227
|
+
"migrations_dir": {
|
1228
|
+
"description": "The path to the directory of migrations for this D1 database (defaults to './migrations').",
|
1229
|
+
"type": "string"
|
1230
|
+
},
|
1231
|
+
"migrations_table": {
|
1232
|
+
"description": "The name of the migrations table for this D1 database (defaults to 'd1_migrations').",
|
1233
|
+
"type": "string"
|
1234
|
+
},
|
1235
|
+
"preview_database_id": {
|
1236
|
+
"description": "The UUID of this D1 database for Wrangler Dev (if specified).",
|
1237
|
+
"type": "string"
|
1238
|
+
}
|
1239
|
+
},
|
1240
|
+
"required": [
|
1241
|
+
"binding",
|
1242
|
+
"database_name",
|
1243
|
+
"database_id"
|
1244
|
+
],
|
1245
|
+
"type": "object"
|
1246
|
+
},
|
1247
|
+
"type": "array"
|
1248
|
+
},
|
1249
|
+
"data_blobs": {
|
1250
|
+
"additionalProperties": {
|
1251
|
+
"type": "string"
|
1252
|
+
},
|
1253
|
+
"description": "A list of data files that your worker should be bound to. This is the \"legacy\" way of binding to a data file. ES module workers should do proper module imports.",
|
1254
|
+
"type": "object"
|
1255
|
+
},
|
1256
|
+
"define": {
|
1257
|
+
"additionalProperties": {
|
1258
|
+
"type": "string"
|
1259
|
+
},
|
1260
|
+
"default": "`{}`",
|
1261
|
+
"description": "A map of values to substitute when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1262
|
+
"type": "object"
|
1263
|
+
},
|
1264
|
+
"dev": {
|
1265
|
+
"$ref": "#/definitions/RawDevConfig",
|
1266
|
+
"description": "Options to configure the development server that your worker will use."
|
1267
|
+
},
|
1268
|
+
"dispatch_namespaces": {
|
1269
|
+
"default": "`[]`",
|
1270
|
+
"description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1271
|
+
"items": {
|
1272
|
+
"additionalProperties": false,
|
1273
|
+
"properties": {
|
1274
|
+
"binding": {
|
1275
|
+
"description": "The binding name used to refer to the bound service.",
|
1276
|
+
"type": "string"
|
1277
|
+
},
|
1278
|
+
"namespace": {
|
1279
|
+
"description": "The namespace to bind to.",
|
1280
|
+
"type": "string"
|
1281
|
+
},
|
1282
|
+
"outbound": {
|
1283
|
+
"$ref": "#/definitions/DispatchNamespaceOutbound",
|
1284
|
+
"description": "Details about the outbound Worker which will handle outbound requests from your namespace"
|
1285
|
+
}
|
1286
|
+
},
|
1287
|
+
"required": [
|
1288
|
+
"binding",
|
1289
|
+
"namespace"
|
1290
|
+
],
|
1291
|
+
"type": "object"
|
1292
|
+
},
|
1293
|
+
"type": "array"
|
1294
|
+
},
|
1295
|
+
"durable_objects": {
|
1296
|
+
"additionalProperties": false,
|
1297
|
+
"default": "`{bindings:[]}`",
|
1298
|
+
"description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1299
|
+
"properties": {
|
1300
|
+
"bindings": {
|
1301
|
+
"$ref": "#/definitions/DurableObjectBindings"
|
1302
|
+
}
|
1303
|
+
},
|
1304
|
+
"required": [
|
1305
|
+
"bindings"
|
1306
|
+
],
|
1307
|
+
"type": "object"
|
1308
|
+
},
|
1309
|
+
"env": {
|
1310
|
+
"additionalProperties": {
|
1311
|
+
"$ref": "#/definitions/RawEnvironment"
|
1312
|
+
},
|
1313
|
+
"default": {},
|
1314
|
+
"description": "The `env` section defines overrides for the configuration for different environments.\n\nAll environment fields can be specified at the top level of the config indicating the default environment settings.\n\n- Some fields are inherited and overridable in each environment.\n- But some are not inherited and must be explicitly specified in every environment, if they are specified at the top level.\n\nFor more information, see the documentation at https://developers.cloudflare.com/workers/cli-wrangler/configuration#environments",
|
1315
|
+
"type": "object"
|
1316
|
+
},
|
1317
|
+
"experimental_services": {
|
1318
|
+
"default": "`[]`",
|
1319
|
+
"deprecated": "DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.",
|
1320
|
+
"description": "A list of services that your Worker should be bound to.",
|
1321
|
+
"items": {
|
1322
|
+
"additionalProperties": false,
|
1323
|
+
"properties": {
|
1324
|
+
"environment": {
|
1325
|
+
"description": "The Service's environment",
|
1326
|
+
"type": "string"
|
1327
|
+
},
|
1328
|
+
"name": {
|
1329
|
+
"description": "The binding name used to refer to the Service",
|
1330
|
+
"type": "string"
|
1331
|
+
},
|
1332
|
+
"service": {
|
1333
|
+
"description": "The name of the Service being bound",
|
1334
|
+
"type": "string"
|
1335
|
+
}
|
1336
|
+
},
|
1337
|
+
"required": [
|
1338
|
+
"name",
|
1339
|
+
"service",
|
1340
|
+
"environment"
|
1341
|
+
],
|
1342
|
+
"type": "object"
|
1343
|
+
},
|
1344
|
+
"type": "array"
|
1345
|
+
},
|
1346
|
+
"find_additional_modules": {
|
1347
|
+
"description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false.",
|
1348
|
+
"type": "boolean"
|
1349
|
+
},
|
1350
|
+
"first_party_worker": {
|
1351
|
+
"description": "Designates this Worker as an internal-only \"first-party\" Worker.",
|
1352
|
+
"type": "boolean"
|
1353
|
+
},
|
1354
|
+
"hyperdrive": {
|
1355
|
+
"default": "`[]`",
|
1356
|
+
"description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1357
|
+
"items": {
|
1358
|
+
"additionalProperties": false,
|
1359
|
+
"properties": {
|
1360
|
+
"binding": {
|
1361
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
1362
|
+
"type": "string"
|
1363
|
+
},
|
1364
|
+
"id": {
|
1365
|
+
"description": "The id of the database.",
|
1366
|
+
"type": "string"
|
1367
|
+
},
|
1368
|
+
"localConnectionString": {
|
1369
|
+
"description": "The local database connection string for `wrangler dev`",
|
1370
|
+
"type": "string"
|
1371
|
+
}
|
1372
|
+
},
|
1373
|
+
"required": [
|
1374
|
+
"binding",
|
1375
|
+
"id"
|
1376
|
+
],
|
1377
|
+
"type": "object"
|
1378
|
+
},
|
1379
|
+
"type": "array"
|
1380
|
+
},
|
1381
|
+
"jsx_factory": {
|
1382
|
+
"default": "`\"React.createElement\"`",
|
1383
|
+
"description": "The function to use to replace jsx syntax.",
|
1384
|
+
"type": "string"
|
1385
|
+
},
|
1386
|
+
"jsx_fragment": {
|
1387
|
+
"default": "`\"React.Fragment\"`",
|
1388
|
+
"description": "The function to use to replace jsx fragment syntax.",
|
1389
|
+
"type": "string"
|
1390
|
+
},
|
1391
|
+
"keep_vars": {
|
1392
|
+
"default": false,
|
1393
|
+
"description": "By default, wrangler.toml is the source of truth for your environment configuration, like a terraform file.\n\nIf you change your vars in the dashboard, wrangler *will* override/delete them on its next deploy.\n\nIf you want to keep your dashboard vars when wrangler deploys, set this field to true.",
|
1394
|
+
"type": "boolean"
|
1395
|
+
},
|
1396
|
+
"kv-namespaces": {
|
1397
|
+
"deprecated": "DO NOT USE. This was a legacy bug from Wrangler v1, that we do not want to support.",
|
1398
|
+
"description": "Legacy way of defining KVNamespaces that is no longer supported.",
|
1399
|
+
"type": "string"
|
1400
|
+
},
|
1401
|
+
"kv_namespaces": {
|
1402
|
+
"default": "`[]`",
|
1403
|
+
"description": "These specify any Workers KV Namespaces you want to access from inside your Worker.\n\nTo learn more about KV Namespaces, see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1404
|
+
"items": {
|
1405
|
+
"additionalProperties": false,
|
1406
|
+
"properties": {
|
1407
|
+
"binding": {
|
1408
|
+
"description": "The binding name used to refer to the KV Namespace",
|
1409
|
+
"type": "string"
|
1410
|
+
},
|
1411
|
+
"id": {
|
1412
|
+
"description": "The ID of the KV namespace",
|
1413
|
+
"type": "string"
|
1414
|
+
},
|
1415
|
+
"preview_id": {
|
1416
|
+
"description": "The ID of the KV namespace used during `wrangler dev`",
|
1417
|
+
"type": "string"
|
1418
|
+
}
|
1419
|
+
},
|
1420
|
+
"required": [
|
1421
|
+
"binding",
|
1422
|
+
"id"
|
1423
|
+
],
|
1424
|
+
"type": "object"
|
1425
|
+
},
|
1426
|
+
"type": "array"
|
1427
|
+
},
|
1428
|
+
"legacy_assets": {
|
1429
|
+
"anyOf": [
|
1430
|
+
{
|
1431
|
+
"additionalProperties": false,
|
1432
|
+
"properties": {
|
1433
|
+
"browser_TTL": {
|
1434
|
+
"type": "number"
|
1435
|
+
},
|
1436
|
+
"bucket": {
|
1437
|
+
"type": "string"
|
1438
|
+
},
|
1439
|
+
"exclude": {
|
1440
|
+
"items": {
|
1441
|
+
"type": "string"
|
1442
|
+
},
|
1443
|
+
"type": "array"
|
1444
|
+
},
|
1445
|
+
"include": {
|
1446
|
+
"items": {
|
1447
|
+
"type": "string"
|
1448
|
+
},
|
1449
|
+
"type": "array"
|
1450
|
+
},
|
1451
|
+
"serve_single_page_app": {
|
1452
|
+
"type": "boolean"
|
1453
|
+
}
|
1454
|
+
},
|
1455
|
+
"required": [
|
1456
|
+
"bucket",
|
1457
|
+
"include",
|
1458
|
+
"exclude",
|
1459
|
+
"serve_single_page_app"
|
1460
|
+
],
|
1461
|
+
"type": "object"
|
1462
|
+
},
|
1463
|
+
{
|
1464
|
+
"type": "string"
|
1465
|
+
}
|
1466
|
+
],
|
1467
|
+
"description": "Serve a folder of static assets with your Worker, without any additional code. This can either be a string, or an object with additional config fields. Only one of assets and legacy_assets can be used."
|
1468
|
+
},
|
1469
|
+
"legacy_env": {
|
1470
|
+
"description": "A boolean to enable \"legacy\" style wrangler environments (from Wrangler v1). These have been superseded by Services, but there may be projects that won't (or can't) use them. If you're using a legacy environment, you can set this to `true` to enable it.",
|
1471
|
+
"type": "boolean"
|
1472
|
+
},
|
1473
|
+
"limits": {
|
1474
|
+
"$ref": "#/definitions/UserLimits",
|
1475
|
+
"description": "Specify limits for runtime behavior. Only supported for the \"standard\" Usage Model"
|
1476
|
+
},
|
1477
|
+
"logfwdr": {
|
1478
|
+
"additionalProperties": false,
|
1479
|
+
"default": "`{bindings:[]}`",
|
1480
|
+
"description": "List of bindings that you will send to logfwdr",
|
1481
|
+
"properties": {
|
1482
|
+
"bindings": {
|
1483
|
+
"items": {
|
1484
|
+
"additionalProperties": false,
|
1485
|
+
"properties": {
|
1486
|
+
"destination": {
|
1487
|
+
"description": "The destination for this logged message",
|
1488
|
+
"type": "string"
|
1489
|
+
},
|
1490
|
+
"name": {
|
1491
|
+
"description": "The binding name used to refer to logfwdr",
|
1492
|
+
"type": "string"
|
1493
|
+
}
|
1494
|
+
},
|
1495
|
+
"required": [
|
1496
|
+
"name",
|
1497
|
+
"destination"
|
1498
|
+
],
|
1499
|
+
"type": "object"
|
1500
|
+
},
|
1501
|
+
"type": "array"
|
1502
|
+
}
|
1503
|
+
},
|
1504
|
+
"required": [
|
1505
|
+
"bindings"
|
1506
|
+
],
|
1507
|
+
"type": "object"
|
1508
|
+
},
|
1509
|
+
"logpush": {
|
1510
|
+
"description": "Send Trace Events from this Worker to Workers Logpush.\n\nThis will not configure a corresponding Logpush job automatically.\n\nFor more information about Workers Logpush, see: https://blog.cloudflare.com/logpush-for-workers/",
|
1511
|
+
"type": "boolean"
|
1512
|
+
},
|
1513
|
+
"main": {
|
1514
|
+
"description": "The entrypoint/path to the JavaScript file that will be executed.",
|
1515
|
+
"type": "string"
|
1516
|
+
},
|
1517
|
+
"migrations": {
|
1518
|
+
"default": [],
|
1519
|
+
"description": "A list of migrations that should be uploaded with your Worker.\n\nThese define changes in your Durable Object declarations.\n\nMore details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations",
|
1520
|
+
"items": {
|
1521
|
+
"additionalProperties": false,
|
1522
|
+
"properties": {
|
1523
|
+
"deleted_classes": {
|
1524
|
+
"description": "The Durable Objects being removed.",
|
1525
|
+
"items": {
|
1526
|
+
"type": "string"
|
1527
|
+
},
|
1528
|
+
"type": "array"
|
1529
|
+
},
|
1530
|
+
"new_classes": {
|
1531
|
+
"description": "The new Durable Objects being defined.",
|
1532
|
+
"items": {
|
1533
|
+
"type": "string"
|
1534
|
+
},
|
1535
|
+
"type": "array"
|
1536
|
+
},
|
1537
|
+
"renamed_classes": {
|
1538
|
+
"description": "The Durable Objects being renamed.",
|
1539
|
+
"items": {
|
1540
|
+
"additionalProperties": false,
|
1541
|
+
"properties": {
|
1542
|
+
"from": {
|
1543
|
+
"type": "string"
|
1544
|
+
},
|
1545
|
+
"to": {
|
1546
|
+
"type": "string"
|
1547
|
+
}
|
1548
|
+
},
|
1549
|
+
"required": [
|
1550
|
+
"from",
|
1551
|
+
"to"
|
1552
|
+
],
|
1553
|
+
"type": "object"
|
1554
|
+
},
|
1555
|
+
"type": "array"
|
1556
|
+
},
|
1557
|
+
"tag": {
|
1558
|
+
"description": "A unique identifier for this migration.",
|
1559
|
+
"type": "string"
|
1560
|
+
}
|
1561
|
+
},
|
1562
|
+
"required": [
|
1563
|
+
"tag"
|
1564
|
+
],
|
1565
|
+
"type": "object"
|
1566
|
+
},
|
1567
|
+
"type": "array"
|
1568
|
+
},
|
1569
|
+
"miniflare": {
|
1570
|
+
"deprecated": true,
|
1571
|
+
"description": "Configuration only used by a standalone use of the miniflare binary."
|
1572
|
+
},
|
1573
|
+
"minify": {
|
1574
|
+
"description": "Minify the script before uploading.",
|
1575
|
+
"type": "boolean"
|
1576
|
+
},
|
1577
|
+
"mtls_certificates": {
|
1578
|
+
"default": "`[]`",
|
1579
|
+
"description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1580
|
+
"items": {
|
1581
|
+
"additionalProperties": false,
|
1582
|
+
"properties": {
|
1583
|
+
"binding": {
|
1584
|
+
"description": "The binding name used to refer to the certificate in the Worker",
|
1585
|
+
"type": "string"
|
1586
|
+
},
|
1587
|
+
"certificate_id": {
|
1588
|
+
"description": "The uuid of the uploaded mTLS certificate",
|
1589
|
+
"type": "string"
|
1590
|
+
}
|
1591
|
+
},
|
1592
|
+
"required": [
|
1593
|
+
"binding",
|
1594
|
+
"certificate_id"
|
1595
|
+
],
|
1596
|
+
"type": "object"
|
1597
|
+
},
|
1598
|
+
"type": "array"
|
1599
|
+
},
|
1600
|
+
"name": {
|
1601
|
+
"description": "The name of your Worker. Alphanumeric + dashes only.",
|
1602
|
+
"type": "string"
|
1603
|
+
},
|
1604
|
+
"no_bundle": {
|
1605
|
+
"description": "Skip internal build steps and directly deploy script",
|
1606
|
+
"type": "boolean"
|
1607
|
+
},
|
1608
|
+
"node_compat": {
|
1609
|
+
"description": "Add polyfills for node builtin modules and globals",
|
1610
|
+
"type": "boolean"
|
1611
|
+
},
|
1612
|
+
"pages_build_output_dir": {
|
1613
|
+
"description": "The directory of static assets to serve.\n\nThe presence of this field in `wrangler.toml` indicates a Pages project, and will prompt the handling of the configuration file according to the Pages-specific validation rules.",
|
1614
|
+
"type": "string"
|
1615
|
+
},
|
1616
|
+
"placement": {
|
1617
|
+
"additionalProperties": false,
|
1618
|
+
"description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
|
1619
|
+
"properties": {
|
1620
|
+
"mode": {
|
1621
|
+
"enum": [
|
1622
|
+
"off",
|
1623
|
+
"smart"
|
1624
|
+
],
|
1625
|
+
"type": "string"
|
1626
|
+
}
|
1627
|
+
},
|
1628
|
+
"required": [
|
1629
|
+
"mode"
|
1630
|
+
],
|
1631
|
+
"type": "object"
|
1632
|
+
},
|
1633
|
+
"preserve_file_names": {
|
1634
|
+
"description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.",
|
1635
|
+
"type": "boolean"
|
1636
|
+
},
|
1637
|
+
"queues": {
|
1638
|
+
"additionalProperties": false,
|
1639
|
+
"default": "`{consumers:[],producers:[]}`",
|
1640
|
+
"description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1641
|
+
"properties": {
|
1642
|
+
"consumers": {
|
1643
|
+
"description": "Consumer configuration",
|
1644
|
+
"items": {
|
1645
|
+
"additionalProperties": false,
|
1646
|
+
"properties": {
|
1647
|
+
"dead_letter_queue": {
|
1648
|
+
"description": "The queue to send messages that failed to be consumed.",
|
1649
|
+
"type": "string"
|
1650
|
+
},
|
1651
|
+
"max_batch_size": {
|
1652
|
+
"description": "The maximum number of messages per batch",
|
1653
|
+
"type": "number"
|
1654
|
+
},
|
1655
|
+
"max_batch_timeout": {
|
1656
|
+
"description": "The maximum number of seconds to wait to fill a batch with messages.",
|
1657
|
+
"type": "number"
|
1658
|
+
},
|
1659
|
+
"max_concurrency": {
|
1660
|
+
"description": "The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog.",
|
1661
|
+
"type": [
|
1662
|
+
"number",
|
1663
|
+
"null"
|
1664
|
+
]
|
1665
|
+
},
|
1666
|
+
"max_retries": {
|
1667
|
+
"description": "The maximum number of retries for each message.",
|
1668
|
+
"type": "number"
|
1669
|
+
},
|
1670
|
+
"queue": {
|
1671
|
+
"description": "The name of the queue from which this consumer should consume.",
|
1672
|
+
"type": "string"
|
1673
|
+
},
|
1674
|
+
"retry_delay": {
|
1675
|
+
"description": "The number of seconds to wait before retrying a message",
|
1676
|
+
"type": "number"
|
1677
|
+
},
|
1678
|
+
"type": {
|
1679
|
+
"description": "The consumer type, e.g., worker, http-pull, r2-bucket, etc. Default is worker.",
|
1680
|
+
"type": "string"
|
1681
|
+
},
|
1682
|
+
"visibility_timeout_ms": {
|
1683
|
+
"description": "The number of milliseconds to wait for pulled messages to become visible again",
|
1684
|
+
"type": "number"
|
1685
|
+
}
|
1686
|
+
},
|
1687
|
+
"required": [
|
1688
|
+
"queue"
|
1689
|
+
],
|
1690
|
+
"type": "object"
|
1691
|
+
},
|
1692
|
+
"type": "array"
|
1693
|
+
},
|
1694
|
+
"producers": {
|
1695
|
+
"description": "Producer bindings",
|
1696
|
+
"items": {
|
1697
|
+
"additionalProperties": false,
|
1698
|
+
"properties": {
|
1699
|
+
"binding": {
|
1700
|
+
"description": "The binding name used to refer to the Queue in the Worker.",
|
1701
|
+
"type": "string"
|
1702
|
+
},
|
1703
|
+
"delivery_delay": {
|
1704
|
+
"description": "The number of seconds to wait before delivering a message",
|
1705
|
+
"type": "number"
|
1706
|
+
},
|
1707
|
+
"queue": {
|
1708
|
+
"description": "The name of this Queue.",
|
1709
|
+
"type": "string"
|
1710
|
+
}
|
1711
|
+
},
|
1712
|
+
"required": [
|
1713
|
+
"binding",
|
1714
|
+
"queue"
|
1715
|
+
],
|
1716
|
+
"type": "object"
|
1717
|
+
},
|
1718
|
+
"type": "array"
|
1719
|
+
}
|
1720
|
+
},
|
1721
|
+
"type": "object"
|
1722
|
+
},
|
1723
|
+
"r2_buckets": {
|
1724
|
+
"default": "`[]`",
|
1725
|
+
"description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1726
|
+
"items": {
|
1727
|
+
"additionalProperties": false,
|
1728
|
+
"properties": {
|
1729
|
+
"binding": {
|
1730
|
+
"description": "The binding name used to refer to the R2 bucket in the Worker.",
|
1731
|
+
"type": "string"
|
1732
|
+
},
|
1733
|
+
"bucket_name": {
|
1734
|
+
"description": "The name of this R2 bucket at the edge.",
|
1735
|
+
"type": "string"
|
1736
|
+
},
|
1737
|
+
"jurisdiction": {
|
1738
|
+
"description": "The jurisdiction that the bucket exists in. Default if not present.",
|
1739
|
+
"type": "string"
|
1740
|
+
},
|
1741
|
+
"preview_bucket_name": {
|
1742
|
+
"description": "The preview name of this R2 bucket at the edge.",
|
1743
|
+
"type": "string"
|
1744
|
+
}
|
1745
|
+
},
|
1746
|
+
"required": [
|
1747
|
+
"binding",
|
1748
|
+
"bucket_name"
|
1749
|
+
],
|
1750
|
+
"type": "object"
|
1751
|
+
},
|
1752
|
+
"type": "array"
|
1753
|
+
},
|
1754
|
+
"route": {
|
1755
|
+
"$ref": "#/definitions/Route",
|
1756
|
+
"description": "A route that your Worker should be published to. Literally the same as routes, but only one. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker"
|
1757
|
+
},
|
1758
|
+
"routes": {
|
1759
|
+
"description": "A list of routes that your Worker should be published to. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker (see `triggers`)",
|
1760
|
+
"items": {
|
1761
|
+
"$ref": "#/definitions/Route"
|
1762
|
+
},
|
1763
|
+
"type": "array"
|
1764
|
+
},
|
1765
|
+
"rules": {
|
1766
|
+
"description": "An ordered list of rules that define which modules to import, and what type to import them as. You will need to specify rules to use Text, Data, and CompiledWasm modules, or when you wish to have a .js file be treated as an ESModule instead of CommonJS.",
|
1767
|
+
"items": {
|
1768
|
+
"$ref": "#/definitions/Rule"
|
1769
|
+
},
|
1770
|
+
"type": "array"
|
1771
|
+
},
|
1772
|
+
"send_email": {
|
1773
|
+
"default": "`[]`",
|
1774
|
+
"description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1775
|
+
"items": {
|
1776
|
+
"additionalProperties": false,
|
1777
|
+
"properties": {
|
1778
|
+
"allowed_destination_addresses": {
|
1779
|
+
"description": "If this binding should be restricted to a set of verified addresses",
|
1780
|
+
"items": {
|
1781
|
+
"type": "string"
|
1782
|
+
},
|
1783
|
+
"type": "array"
|
1784
|
+
},
|
1785
|
+
"destination_address": {
|
1786
|
+
"description": "If this binding should be restricted to a specific verified address",
|
1787
|
+
"type": "string"
|
1788
|
+
},
|
1789
|
+
"name": {
|
1790
|
+
"description": "The binding name used to refer to the this binding",
|
1791
|
+
"type": "string"
|
1792
|
+
}
|
1793
|
+
},
|
1794
|
+
"required": [
|
1795
|
+
"name"
|
1796
|
+
],
|
1797
|
+
"type": "object"
|
1798
|
+
},
|
1799
|
+
"type": "array"
|
1800
|
+
},
|
1801
|
+
"send_metrics": {
|
1802
|
+
"description": "Whether Wrangler should send usage metrics to Cloudflare for this project.\n\nWhen defined this will override any user settings. Otherwise, Wrangler will use the user's preference.",
|
1803
|
+
"type": "boolean"
|
1804
|
+
},
|
1805
|
+
"services": {
|
1806
|
+
"default": "`[]`",
|
1807
|
+
"description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1808
|
+
"items": {
|
1809
|
+
"additionalProperties": false,
|
1810
|
+
"properties": {
|
1811
|
+
"binding": {
|
1812
|
+
"description": "The binding name used to refer to the bound service.",
|
1813
|
+
"type": "string"
|
1814
|
+
},
|
1815
|
+
"entrypoint": {
|
1816
|
+
"description": "Optionally, the entrypoint (named export) of the service to bind to.",
|
1817
|
+
"type": "string"
|
1818
|
+
},
|
1819
|
+
"environment": {
|
1820
|
+
"description": "The environment of the service (e.g. production, staging, etc).",
|
1821
|
+
"type": "string"
|
1822
|
+
},
|
1823
|
+
"service": {
|
1824
|
+
"description": "The name of the service.",
|
1825
|
+
"type": "string"
|
1826
|
+
}
|
1827
|
+
},
|
1828
|
+
"required": [
|
1829
|
+
"binding",
|
1830
|
+
"service"
|
1831
|
+
],
|
1832
|
+
"type": "object"
|
1833
|
+
},
|
1834
|
+
"type": "array"
|
1835
|
+
},
|
1836
|
+
"site": {
|
1837
|
+
"additionalProperties": false,
|
1838
|
+
"description": "The definition of a Worker Site, a feature that lets you upload static assets with your Worker.\n\nMore details at https://developers.cloudflare.com/workers/platform/sites",
|
1839
|
+
"properties": {
|
1840
|
+
"bucket": {
|
1841
|
+
"description": "The directory containing your static assets.\n\nIt must be a path relative to your wrangler.toml file. Example: bucket = \"./public\"\n\nIf there is a `site` field then it must contain this `bucket` field.",
|
1842
|
+
"type": "string"
|
1843
|
+
},
|
1844
|
+
"entry-point": {
|
1845
|
+
"deprecated": "DO NOT use this (it's a holdover from Wrangler v1.x). Either use the top level `main` field, or pass the path to your entry file as a command line argument.",
|
1846
|
+
"description": "The location of your Worker script.",
|
1847
|
+
"type": "string"
|
1848
|
+
},
|
1849
|
+
"exclude": {
|
1850
|
+
"default": [],
|
1851
|
+
"description": "A list of .gitignore-style patterns that match files or directories in your bucket that should be excluded from uploads. Example: exclude = [\"ignore_dir\"]",
|
1852
|
+
"items": {
|
1853
|
+
"type": "string"
|
1854
|
+
},
|
1855
|
+
"type": "array"
|
1856
|
+
},
|
1857
|
+
"include": {
|
1858
|
+
"default": [],
|
1859
|
+
"description": "An exclusive list of .gitignore-style patterns that match file or directory names from your bucket location. Only matched items will be uploaded. Example: include = [\"upload_dir\"]",
|
1860
|
+
"items": {
|
1861
|
+
"type": "string"
|
1862
|
+
},
|
1863
|
+
"type": "array"
|
1864
|
+
}
|
1865
|
+
},
|
1866
|
+
"required": [
|
1867
|
+
"bucket"
|
1868
|
+
],
|
1869
|
+
"type": "object"
|
1870
|
+
},
|
1871
|
+
"tail_consumers": {
|
1872
|
+
"default": "`[]`",
|
1873
|
+
"description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1874
|
+
"items": {
|
1875
|
+
"$ref": "#/definitions/TailConsumer"
|
1876
|
+
},
|
1877
|
+
"type": "array"
|
1878
|
+
},
|
1879
|
+
"text_blobs": {
|
1880
|
+
"additionalProperties": {
|
1881
|
+
"type": "string"
|
1882
|
+
},
|
1883
|
+
"description": "A list of text files that your worker should be bound to. This is the \"legacy\" way of binding to a text file. ES module workers should do proper module imports.",
|
1884
|
+
"type": "object"
|
1885
|
+
},
|
1886
|
+
"triggers": {
|
1887
|
+
"additionalProperties": false,
|
1888
|
+
"default": "`{crons:[]}`",
|
1889
|
+
"description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
|
1890
|
+
"properties": {
|
1891
|
+
"crons": {
|
1892
|
+
"items": {
|
1893
|
+
"type": "string"
|
1894
|
+
},
|
1895
|
+
"type": "array"
|
1896
|
+
}
|
1897
|
+
},
|
1898
|
+
"required": [
|
1899
|
+
"crons"
|
1900
|
+
],
|
1901
|
+
"type": "object"
|
1902
|
+
},
|
1903
|
+
"tsconfig": {
|
1904
|
+
"description": "Path to a custom tsconfig",
|
1905
|
+
"type": "string"
|
1906
|
+
},
|
1907
|
+
"type": {
|
1908
|
+
"deprecated": "DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
|
1909
|
+
"description": "The project \"type\". A holdover from Wrangler v1.x. Valid values were \"webpack\", \"javascript\", and \"rust\".",
|
1910
|
+
"enum": [
|
1911
|
+
"webpack",
|
1912
|
+
"javascript",
|
1913
|
+
"rust"
|
1914
|
+
],
|
1915
|
+
"type": "string"
|
1916
|
+
},
|
1917
|
+
"unsafe": {
|
1918
|
+
"additionalProperties": false,
|
1919
|
+
"default": "`{}`",
|
1920
|
+
"description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
1921
|
+
"properties": {
|
1922
|
+
"bindings": {
|
1923
|
+
"description": "A set of bindings that should be put into a Worker's upload metadata without changes. These can be used to implement bindings for features that haven't released and aren't supported directly by wrangler or miniflare.",
|
1924
|
+
"items": {
|
1925
|
+
"additionalProperties": {},
|
1926
|
+
"properties": {
|
1927
|
+
"name": {
|
1928
|
+
"type": "string"
|
1929
|
+
},
|
1930
|
+
"type": {
|
1931
|
+
"type": "string"
|
1932
|
+
}
|
1933
|
+
},
|
1934
|
+
"required": [
|
1935
|
+
"name",
|
1936
|
+
"type"
|
1937
|
+
],
|
1938
|
+
"type": "object"
|
1939
|
+
},
|
1940
|
+
"type": "array"
|
1941
|
+
},
|
1942
|
+
"capnp": {
|
1943
|
+
"anyOf": [
|
1944
|
+
{
|
1945
|
+
"additionalProperties": false,
|
1946
|
+
"properties": {
|
1947
|
+
"base_path": {
|
1948
|
+
"type": "string"
|
1949
|
+
},
|
1950
|
+
"source_schemas": {
|
1951
|
+
"items": {
|
1952
|
+
"type": "string"
|
1953
|
+
},
|
1954
|
+
"type": "array"
|
1955
|
+
}
|
1956
|
+
},
|
1957
|
+
"required": [
|
1958
|
+
"base_path",
|
1959
|
+
"source_schemas"
|
1960
|
+
],
|
1961
|
+
"type": "object"
|
1962
|
+
},
|
1963
|
+
{
|
1964
|
+
"additionalProperties": false,
|
1965
|
+
"properties": {
|
1966
|
+
"compiled_schema": {
|
1967
|
+
"type": "string"
|
1968
|
+
}
|
1969
|
+
},
|
1970
|
+
"required": [
|
1971
|
+
"compiled_schema"
|
1972
|
+
],
|
1973
|
+
"type": "object"
|
1974
|
+
}
|
1975
|
+
],
|
1976
|
+
"description": "Used for internal capnp uploads for the Workers runtime"
|
1977
|
+
},
|
1978
|
+
"metadata": {
|
1979
|
+
"additionalProperties": {},
|
1980
|
+
"description": "Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified here will always be applied to metadata last, so can add new or override existing fields.",
|
1981
|
+
"type": "object"
|
1982
|
+
}
|
1983
|
+
},
|
1984
|
+
"type": "object"
|
1985
|
+
},
|
1986
|
+
"upload_source_maps": {
|
1987
|
+
"description": "Include source maps when uploading this worker.",
|
1988
|
+
"type": "boolean"
|
1989
|
+
},
|
1990
|
+
"usage_model": {
|
1991
|
+
"description": "Specifies the Usage Model for your Worker. There are two options - [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model). For newly created Workers, if the Usage Model is omitted it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model). For existing Workers, if the Usage Model is omitted, it will be set to the Usage Model configured in the dashboard for that Worker.",
|
1992
|
+
"enum": [
|
1993
|
+
"bundled",
|
1994
|
+
"unbound"
|
1995
|
+
],
|
1996
|
+
"type": "string"
|
1997
|
+
},
|
1998
|
+
"vars": {
|
1999
|
+
"additionalProperties": {
|
2000
|
+
"anyOf": [
|
2001
|
+
{
|
2002
|
+
"type": "string"
|
2003
|
+
},
|
2004
|
+
{
|
2005
|
+
"$ref": "#/definitions/Json"
|
2006
|
+
}
|
2007
|
+
]
|
2008
|
+
},
|
2009
|
+
"default": "`{}`",
|
2010
|
+
"description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2011
|
+
"type": "object"
|
2012
|
+
},
|
2013
|
+
"vectorize": {
|
2014
|
+
"default": "`[]`",
|
2015
|
+
"description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2016
|
+
"items": {
|
2017
|
+
"additionalProperties": false,
|
2018
|
+
"properties": {
|
2019
|
+
"binding": {
|
2020
|
+
"description": "The binding name used to refer to the Vectorize index in the Worker.",
|
2021
|
+
"type": "string"
|
2022
|
+
},
|
2023
|
+
"index_name": {
|
2024
|
+
"description": "The name of the index.",
|
2025
|
+
"type": "string"
|
2026
|
+
}
|
2027
|
+
},
|
2028
|
+
"required": [
|
2029
|
+
"binding",
|
2030
|
+
"index_name"
|
2031
|
+
],
|
2032
|
+
"type": "object"
|
2033
|
+
},
|
2034
|
+
"type": "array"
|
2035
|
+
},
|
2036
|
+
"version_metadata": {
|
2037
|
+
"additionalProperties": false,
|
2038
|
+
"description": "Binding to the Worker Version's metadata",
|
2039
|
+
"properties": {
|
2040
|
+
"binding": {
|
2041
|
+
"type": "string"
|
2042
|
+
}
|
2043
|
+
},
|
2044
|
+
"required": [
|
2045
|
+
"binding"
|
2046
|
+
],
|
2047
|
+
"type": "object"
|
2048
|
+
},
|
2049
|
+
"wasm_modules": {
|
2050
|
+
"additionalProperties": {
|
2051
|
+
"type": "string"
|
2052
|
+
},
|
2053
|
+
"description": "A list of wasm modules that your worker should be bound to. This is the \"legacy\" way of binding to a wasm module. ES module workers should do proper module imports.",
|
2054
|
+
"type": "object"
|
2055
|
+
},
|
2056
|
+
"webpack_config": {
|
2057
|
+
"deprecated": "DO NOT USE THIS. Most common features now work out of the box with wrangler, including modules, jsx, typescript, etc. If you need anything more, use a custom build.",
|
2058
|
+
"description": "Path to the webpack config to use when building your worker. A holdover from Wrangler v1.x, used with `type: \"webpack\"`.",
|
2059
|
+
"type": "string"
|
2060
|
+
},
|
2061
|
+
"workers_dev": {
|
2062
|
+
"default": "`true` (This is a breaking change from Wrangler v1)",
|
2063
|
+
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.\n\n// Carmen according to our tests the default is undefined",
|
2064
|
+
"type": "boolean"
|
2065
|
+
},
|
2066
|
+
"zone_id": {
|
2067
|
+
"description": "TODO: remove this as it has been deprecated.\n\nThis is just here for now because the `route` commands use it. So we need to include it in this type so it is available.",
|
2068
|
+
"type": "string"
|
2069
|
+
}
|
2070
|
+
},
|
2071
|
+
"type": "object"
|
2072
|
+
},
|
2073
|
+
"RawDevConfig": {
|
2074
|
+
"additionalProperties": false,
|
2075
|
+
"properties": {
|
2076
|
+
"host": {
|
2077
|
+
"description": "Host to forward requests to, defaults to the host of the first route of project",
|
2078
|
+
"type": "string"
|
2079
|
+
},
|
2080
|
+
"inspector_port": {
|
2081
|
+
"default": 9229,
|
2082
|
+
"description": "Port for the local dev server's inspector to listen on",
|
2083
|
+
"type": "number"
|
2084
|
+
},
|
2085
|
+
"ip": {
|
2086
|
+
"default": "localhost",
|
2087
|
+
"description": "IP address for the local dev server to listen on,",
|
2088
|
+
"type": "string"
|
2089
|
+
},
|
2090
|
+
"local_protocol": {
|
2091
|
+
"default": "http",
|
2092
|
+
"description": "Protocol that local wrangler dev server listens to requests on.",
|
2093
|
+
"enum": [
|
2094
|
+
"http",
|
2095
|
+
"https"
|
2096
|
+
],
|
2097
|
+
"type": "string"
|
2098
|
+
},
|
2099
|
+
"port": {
|
2100
|
+
"default": 8787,
|
2101
|
+
"description": "Port for the local dev server to listen on",
|
2102
|
+
"type": "number"
|
2103
|
+
},
|
2104
|
+
"upstream_protocol": {
|
2105
|
+
"default": "https",
|
2106
|
+
"description": "Protocol that wrangler dev forwards requests on\n\nSetting this to `http` is not currently implemented for remote mode. See https://github.com/cloudflare/workers-sdk/issues/583",
|
2107
|
+
"enum": [
|
2108
|
+
"https",
|
2109
|
+
"http"
|
2110
|
+
],
|
2111
|
+
"type": "string"
|
2112
|
+
}
|
2113
|
+
},
|
2114
|
+
"type": "object"
|
2115
|
+
},
|
2116
|
+
"RawEnvironment": {
|
2117
|
+
"additionalProperties": false,
|
2118
|
+
"description": "The raw environment configuration that we read from the config file.\n\nAll the properties are optional, and will be replaced with defaults in the configuration that is used in the rest of the codebase.",
|
2119
|
+
"properties": {
|
2120
|
+
"account_id": {
|
2121
|
+
"description": "This is the ID of the account associated with your zone. You might have more than one account, so make sure to use the ID of the account associated with the zone/route you provide, if you provide one. It can also be specified through the CLOUDFLARE_ACCOUNT_ID environment variable.",
|
2122
|
+
"type": "string"
|
2123
|
+
},
|
2124
|
+
"ai": {
|
2125
|
+
"additionalProperties": false,
|
2126
|
+
"default": "`{}`",
|
2127
|
+
"description": "Binding to the AI project.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2128
|
+
"properties": {
|
2129
|
+
"binding": {
|
2130
|
+
"type": "string"
|
2131
|
+
},
|
2132
|
+
"staging": {
|
2133
|
+
"type": "boolean"
|
2134
|
+
}
|
2135
|
+
},
|
2136
|
+
"required": [
|
2137
|
+
"binding"
|
2138
|
+
],
|
2139
|
+
"type": "object"
|
2140
|
+
},
|
2141
|
+
"analytics_engine_datasets": {
|
2142
|
+
"default": "`[]`",
|
2143
|
+
"description": "Specifies analytics engine datasets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2144
|
+
"items": {
|
2145
|
+
"additionalProperties": false,
|
2146
|
+
"properties": {
|
2147
|
+
"binding": {
|
2148
|
+
"description": "The binding name used to refer to the dataset in the Worker.",
|
2149
|
+
"type": "string"
|
2150
|
+
},
|
2151
|
+
"dataset": {
|
2152
|
+
"description": "The name of this dataset to write to.",
|
2153
|
+
"type": "string"
|
2154
|
+
}
|
2155
|
+
},
|
2156
|
+
"required": [
|
2157
|
+
"binding"
|
2158
|
+
],
|
2159
|
+
"type": "object"
|
2160
|
+
},
|
2161
|
+
"type": "array"
|
2162
|
+
},
|
2163
|
+
"base_dir": {
|
2164
|
+
"description": "The directory in which module rules should be evaluated when including additional files into a Worker deployment. This defaults to the directory containing the `main` entry point of the Worker if not specified.",
|
2165
|
+
"type": "string"
|
2166
|
+
},
|
2167
|
+
"browser": {
|
2168
|
+
"additionalProperties": false,
|
2169
|
+
"default": "`{}`",
|
2170
|
+
"description": "A browser that will be usable from the Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2171
|
+
"properties": {
|
2172
|
+
"binding": {
|
2173
|
+
"type": "string"
|
2174
|
+
}
|
2175
|
+
},
|
2176
|
+
"required": [
|
2177
|
+
"binding"
|
2178
|
+
],
|
2179
|
+
"type": "object"
|
2180
|
+
},
|
2181
|
+
"build": {
|
2182
|
+
"additionalProperties": false,
|
2183
|
+
"default": {
|
2184
|
+
"watch_dir": "./src"
|
2185
|
+
},
|
2186
|
+
"description": "Configures a custom build step to be run by Wrangler when building your Worker.\n\nRefer to the [custom builds documentation](https://developers.cloudflare.com/workers/cli-wrangler/configuration#build) for more details.",
|
2187
|
+
"properties": {
|
2188
|
+
"command": {
|
2189
|
+
"description": "The command used to build your Worker. On Linux and macOS, the command is executed in the `sh` shell and the `cmd` shell for Windows. The `&&` and `||` shell operators may be used.",
|
2190
|
+
"type": "string"
|
2191
|
+
},
|
2192
|
+
"cwd": {
|
2193
|
+
"description": "The directory in which the command is executed.",
|
2194
|
+
"type": "string"
|
2195
|
+
},
|
2196
|
+
"upload": {
|
2197
|
+
"$ref": "#/definitions/DeprecatedUpload",
|
2198
|
+
"deprecated": true,
|
2199
|
+
"description": "Deprecated field previously used to configure the build and upload of the script."
|
2200
|
+
},
|
2201
|
+
"watch_dir": {
|
2202
|
+
"anyOf": [
|
2203
|
+
{
|
2204
|
+
"type": "string"
|
2205
|
+
},
|
2206
|
+
{
|
2207
|
+
"items": {
|
2208
|
+
"type": "string"
|
2209
|
+
},
|
2210
|
+
"type": "array"
|
2211
|
+
}
|
2212
|
+
],
|
2213
|
+
"description": "The directory to watch for changes while using wrangler dev, defaults to the current working directory"
|
2214
|
+
}
|
2215
|
+
},
|
2216
|
+
"type": "object"
|
2217
|
+
},
|
2218
|
+
"cloudchamber": {
|
2219
|
+
"$ref": "#/definitions/CloudchamberConfig",
|
2220
|
+
"default": "`{}`",
|
2221
|
+
"description": "Cloudchamber configuration\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment."
|
2222
|
+
},
|
2223
|
+
"compatibility_date": {
|
2224
|
+
"description": "A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
|
2225
|
+
"type": "string"
|
2226
|
+
},
|
2227
|
+
"compatibility_flags": {
|
2228
|
+
"default": "`[]`",
|
2229
|
+
"description": "A list of flags that enable features from upcoming features of the Workers runtime, usually used together with compatibility_flags.\n\nMore details at https://developers.cloudflare.com/workers/platform/compatibility-dates",
|
2230
|
+
"items": {
|
2231
|
+
"type": "string"
|
2232
|
+
},
|
2233
|
+
"type": "array"
|
2234
|
+
},
|
2235
|
+
"constellation": {
|
2236
|
+
"default": "`[]`",
|
2237
|
+
"description": "Specifies Constellation projects that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2238
|
+
"items": {
|
2239
|
+
"additionalProperties": false,
|
2240
|
+
"properties": {
|
2241
|
+
"binding": {
|
2242
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
2243
|
+
"type": "string"
|
2244
|
+
},
|
2245
|
+
"project_id": {
|
2246
|
+
"description": "The id of the project.",
|
2247
|
+
"type": "string"
|
2248
|
+
}
|
2249
|
+
},
|
2250
|
+
"required": [
|
2251
|
+
"binding",
|
2252
|
+
"project_id"
|
2253
|
+
],
|
2254
|
+
"type": "object"
|
2255
|
+
},
|
2256
|
+
"type": "array"
|
2257
|
+
},
|
2258
|
+
"d1_databases": {
|
2259
|
+
"default": "`[]`",
|
2260
|
+
"description": "Specifies D1 databases that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2261
|
+
"items": {
|
2262
|
+
"additionalProperties": false,
|
2263
|
+
"properties": {
|
2264
|
+
"binding": {
|
2265
|
+
"description": "The binding name used to refer to the D1 database in the Worker.",
|
2266
|
+
"type": "string"
|
2267
|
+
},
|
2268
|
+
"database_id": {
|
2269
|
+
"description": "The UUID of this D1 database (not required).",
|
2270
|
+
"type": "string"
|
2271
|
+
},
|
2272
|
+
"database_internal_env": {
|
2273
|
+
"description": "Internal use only.",
|
2274
|
+
"type": "string"
|
2275
|
+
},
|
2276
|
+
"database_name": {
|
2277
|
+
"description": "The name of this D1 database.",
|
2278
|
+
"type": "string"
|
2279
|
+
},
|
2280
|
+
"migrations_dir": {
|
2281
|
+
"description": "The path to the directory of migrations for this D1 database (defaults to './migrations').",
|
2282
|
+
"type": "string"
|
2283
|
+
},
|
2284
|
+
"migrations_table": {
|
2285
|
+
"description": "The name of the migrations table for this D1 database (defaults to 'd1_migrations').",
|
2286
|
+
"type": "string"
|
2287
|
+
},
|
2288
|
+
"preview_database_id": {
|
2289
|
+
"description": "The UUID of this D1 database for Wrangler Dev (if specified).",
|
2290
|
+
"type": "string"
|
2291
|
+
}
|
2292
|
+
},
|
2293
|
+
"required": [
|
2294
|
+
"binding",
|
2295
|
+
"database_name",
|
2296
|
+
"database_id"
|
2297
|
+
],
|
2298
|
+
"type": "object"
|
2299
|
+
},
|
2300
|
+
"type": "array"
|
2301
|
+
},
|
2302
|
+
"define": {
|
2303
|
+
"additionalProperties": {
|
2304
|
+
"type": "string"
|
2305
|
+
},
|
2306
|
+
"default": "`{}`",
|
2307
|
+
"description": "A map of values to substitute when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2308
|
+
"type": "object"
|
2309
|
+
},
|
2310
|
+
"dispatch_namespaces": {
|
2311
|
+
"default": "`[]`",
|
2312
|
+
"description": "Specifies namespace bindings that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2313
|
+
"items": {
|
2314
|
+
"additionalProperties": false,
|
2315
|
+
"properties": {
|
2316
|
+
"binding": {
|
2317
|
+
"description": "The binding name used to refer to the bound service.",
|
2318
|
+
"type": "string"
|
2319
|
+
},
|
2320
|
+
"namespace": {
|
2321
|
+
"description": "The namespace to bind to.",
|
2322
|
+
"type": "string"
|
2323
|
+
},
|
2324
|
+
"outbound": {
|
2325
|
+
"$ref": "#/definitions/DispatchNamespaceOutbound",
|
2326
|
+
"description": "Details about the outbound Worker which will handle outbound requests from your namespace"
|
2327
|
+
}
|
2328
|
+
},
|
2329
|
+
"required": [
|
2330
|
+
"binding",
|
2331
|
+
"namespace"
|
2332
|
+
],
|
2333
|
+
"type": "object"
|
2334
|
+
},
|
2335
|
+
"type": "array"
|
2336
|
+
},
|
2337
|
+
"durable_objects": {
|
2338
|
+
"additionalProperties": false,
|
2339
|
+
"default": "`{bindings:[]}`",
|
2340
|
+
"description": "A list of durable objects that your Worker should be bound to.\n\nFor more information about Durable Objects, see the documentation at https://developers.cloudflare.com/workers/learning/using-durable-objects\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2341
|
+
"properties": {
|
2342
|
+
"bindings": {
|
2343
|
+
"$ref": "#/definitions/DurableObjectBindings"
|
2344
|
+
}
|
2345
|
+
},
|
2346
|
+
"required": [
|
2347
|
+
"bindings"
|
2348
|
+
],
|
2349
|
+
"type": "object"
|
2350
|
+
},
|
2351
|
+
"experimental_services": {
|
2352
|
+
"default": "`[]`",
|
2353
|
+
"deprecated": "DO NOT USE. We'd added this to test the new service binding system, but the proper way to test experimental features is to use `unsafe.bindings` configuration.",
|
2354
|
+
"description": "A list of services that your Worker should be bound to.",
|
2355
|
+
"items": {
|
2356
|
+
"additionalProperties": false,
|
2357
|
+
"properties": {
|
2358
|
+
"environment": {
|
2359
|
+
"description": "The Service's environment",
|
2360
|
+
"type": "string"
|
2361
|
+
},
|
2362
|
+
"name": {
|
2363
|
+
"description": "The binding name used to refer to the Service",
|
2364
|
+
"type": "string"
|
2365
|
+
},
|
2366
|
+
"service": {
|
2367
|
+
"description": "The name of the Service being bound",
|
2368
|
+
"type": "string"
|
2369
|
+
}
|
2370
|
+
},
|
2371
|
+
"required": [
|
2372
|
+
"name",
|
2373
|
+
"service",
|
2374
|
+
"environment"
|
2375
|
+
],
|
2376
|
+
"type": "object"
|
2377
|
+
},
|
2378
|
+
"type": "array"
|
2379
|
+
},
|
2380
|
+
"find_additional_modules": {
|
2381
|
+
"description": "If true then Wrangler will traverse the file tree below `base_dir`; Any files that match `rules` will be included in the deployed Worker. Defaults to true if `no_bundle` is true, otherwise false.",
|
2382
|
+
"type": "boolean"
|
2383
|
+
},
|
2384
|
+
"first_party_worker": {
|
2385
|
+
"description": "Designates this Worker as an internal-only \"first-party\" Worker.",
|
2386
|
+
"type": "boolean"
|
2387
|
+
},
|
2388
|
+
"hyperdrive": {
|
2389
|
+
"default": "`[]`",
|
2390
|
+
"description": "Specifies Hyperdrive configs that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2391
|
+
"items": {
|
2392
|
+
"additionalProperties": false,
|
2393
|
+
"properties": {
|
2394
|
+
"binding": {
|
2395
|
+
"description": "The binding name used to refer to the project in the Worker.",
|
2396
|
+
"type": "string"
|
2397
|
+
},
|
2398
|
+
"id": {
|
2399
|
+
"description": "The id of the database.",
|
2400
|
+
"type": "string"
|
2401
|
+
},
|
2402
|
+
"localConnectionString": {
|
2403
|
+
"description": "The local database connection string for `wrangler dev`",
|
2404
|
+
"type": "string"
|
2405
|
+
}
|
2406
|
+
},
|
2407
|
+
"required": [
|
2408
|
+
"binding",
|
2409
|
+
"id"
|
2410
|
+
],
|
2411
|
+
"type": "object"
|
2412
|
+
},
|
2413
|
+
"type": "array"
|
2414
|
+
},
|
2415
|
+
"jsx_factory": {
|
2416
|
+
"default": "`\"React.createElement\"`",
|
2417
|
+
"description": "The function to use to replace jsx syntax.",
|
2418
|
+
"type": "string"
|
2419
|
+
},
|
2420
|
+
"jsx_fragment": {
|
2421
|
+
"default": "`\"React.Fragment\"`",
|
2422
|
+
"description": "The function to use to replace jsx fragment syntax.",
|
2423
|
+
"type": "string"
|
2424
|
+
},
|
2425
|
+
"kv-namespaces": {
|
2426
|
+
"deprecated": "DO NOT USE. This was a legacy bug from Wrangler v1, that we do not want to support.",
|
2427
|
+
"description": "Legacy way of defining KVNamespaces that is no longer supported.",
|
2428
|
+
"type": "string"
|
2429
|
+
},
|
2430
|
+
"kv_namespaces": {
|
2431
|
+
"default": "`[]`",
|
2432
|
+
"description": "These specify any Workers KV Namespaces you want to access from inside your Worker.\n\nTo learn more about KV Namespaces, see the documentation at https://developers.cloudflare.com/workers/learning/how-kv-works\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2433
|
+
"items": {
|
2434
|
+
"additionalProperties": false,
|
2435
|
+
"properties": {
|
2436
|
+
"binding": {
|
2437
|
+
"description": "The binding name used to refer to the KV Namespace",
|
2438
|
+
"type": "string"
|
2439
|
+
},
|
2440
|
+
"id": {
|
2441
|
+
"description": "The ID of the KV namespace",
|
2442
|
+
"type": "string"
|
2443
|
+
},
|
2444
|
+
"preview_id": {
|
2445
|
+
"description": "The ID of the KV namespace used during `wrangler dev`",
|
2446
|
+
"type": "string"
|
2447
|
+
}
|
2448
|
+
},
|
2449
|
+
"required": [
|
2450
|
+
"binding",
|
2451
|
+
"id"
|
2452
|
+
],
|
2453
|
+
"type": "object"
|
2454
|
+
},
|
2455
|
+
"type": "array"
|
2456
|
+
},
|
2457
|
+
"limits": {
|
2458
|
+
"$ref": "#/definitions/UserLimits",
|
2459
|
+
"description": "Specify limits for runtime behavior. Only supported for the \"standard\" Usage Model"
|
2460
|
+
},
|
2461
|
+
"logfwdr": {
|
2462
|
+
"additionalProperties": false,
|
2463
|
+
"default": "`{bindings:[]}`",
|
2464
|
+
"description": "List of bindings that you will send to logfwdr",
|
2465
|
+
"properties": {
|
2466
|
+
"bindings": {
|
2467
|
+
"items": {
|
2468
|
+
"additionalProperties": false,
|
2469
|
+
"properties": {
|
2470
|
+
"destination": {
|
2471
|
+
"description": "The destination for this logged message",
|
2472
|
+
"type": "string"
|
2473
|
+
},
|
2474
|
+
"name": {
|
2475
|
+
"description": "The binding name used to refer to logfwdr",
|
2476
|
+
"type": "string"
|
2477
|
+
}
|
2478
|
+
},
|
2479
|
+
"required": [
|
2480
|
+
"name",
|
2481
|
+
"destination"
|
2482
|
+
],
|
2483
|
+
"type": "object"
|
2484
|
+
},
|
2485
|
+
"type": "array"
|
2486
|
+
}
|
2487
|
+
},
|
2488
|
+
"required": [
|
2489
|
+
"bindings"
|
2490
|
+
],
|
2491
|
+
"type": "object"
|
2492
|
+
},
|
2493
|
+
"logpush": {
|
2494
|
+
"description": "Send Trace Events from this Worker to Workers Logpush.\n\nThis will not configure a corresponding Logpush job automatically.\n\nFor more information about Workers Logpush, see: https://blog.cloudflare.com/logpush-for-workers/",
|
2495
|
+
"type": "boolean"
|
2496
|
+
},
|
2497
|
+
"main": {
|
2498
|
+
"description": "The entrypoint/path to the JavaScript file that will be executed.",
|
2499
|
+
"type": "string"
|
2500
|
+
},
|
2501
|
+
"migrations": {
|
2502
|
+
"default": [],
|
2503
|
+
"description": "A list of migrations that should be uploaded with your Worker.\n\nThese define changes in your Durable Object declarations.\n\nMore details at https://developers.cloudflare.com/workers/learning/using-durable-objects#configuring-durable-object-classes-with-migrations",
|
2504
|
+
"items": {
|
2505
|
+
"additionalProperties": false,
|
2506
|
+
"properties": {
|
2507
|
+
"deleted_classes": {
|
2508
|
+
"description": "The Durable Objects being removed.",
|
2509
|
+
"items": {
|
2510
|
+
"type": "string"
|
2511
|
+
},
|
2512
|
+
"type": "array"
|
2513
|
+
},
|
2514
|
+
"new_classes": {
|
2515
|
+
"description": "The new Durable Objects being defined.",
|
2516
|
+
"items": {
|
2517
|
+
"type": "string"
|
2518
|
+
},
|
2519
|
+
"type": "array"
|
2520
|
+
},
|
2521
|
+
"renamed_classes": {
|
2522
|
+
"description": "The Durable Objects being renamed.",
|
2523
|
+
"items": {
|
2524
|
+
"additionalProperties": false,
|
2525
|
+
"properties": {
|
2526
|
+
"from": {
|
2527
|
+
"type": "string"
|
2528
|
+
},
|
2529
|
+
"to": {
|
2530
|
+
"type": "string"
|
2531
|
+
}
|
2532
|
+
},
|
2533
|
+
"required": [
|
2534
|
+
"from",
|
2535
|
+
"to"
|
2536
|
+
],
|
2537
|
+
"type": "object"
|
2538
|
+
},
|
2539
|
+
"type": "array"
|
2540
|
+
},
|
2541
|
+
"tag": {
|
2542
|
+
"description": "A unique identifier for this migration.",
|
2543
|
+
"type": "string"
|
2544
|
+
}
|
2545
|
+
},
|
2546
|
+
"required": [
|
2547
|
+
"tag"
|
2548
|
+
],
|
2549
|
+
"type": "object"
|
2550
|
+
},
|
2551
|
+
"type": "array"
|
2552
|
+
},
|
2553
|
+
"minify": {
|
2554
|
+
"description": "Minify the script before uploading.",
|
2555
|
+
"type": "boolean"
|
2556
|
+
},
|
2557
|
+
"mtls_certificates": {
|
2558
|
+
"default": "`[]`",
|
2559
|
+
"description": "Specifies a list of mTLS certificates that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2560
|
+
"items": {
|
2561
|
+
"additionalProperties": false,
|
2562
|
+
"properties": {
|
2563
|
+
"binding": {
|
2564
|
+
"description": "The binding name used to refer to the certificate in the Worker",
|
2565
|
+
"type": "string"
|
2566
|
+
},
|
2567
|
+
"certificate_id": {
|
2568
|
+
"description": "The uuid of the uploaded mTLS certificate",
|
2569
|
+
"type": "string"
|
2570
|
+
}
|
2571
|
+
},
|
2572
|
+
"required": [
|
2573
|
+
"binding",
|
2574
|
+
"certificate_id"
|
2575
|
+
],
|
2576
|
+
"type": "object"
|
2577
|
+
},
|
2578
|
+
"type": "array"
|
2579
|
+
},
|
2580
|
+
"name": {
|
2581
|
+
"description": "The name of your Worker. Alphanumeric + dashes only.",
|
2582
|
+
"type": "string"
|
2583
|
+
},
|
2584
|
+
"no_bundle": {
|
2585
|
+
"description": "Skip internal build steps and directly deploy script",
|
2586
|
+
"type": "boolean"
|
2587
|
+
},
|
2588
|
+
"node_compat": {
|
2589
|
+
"description": "Add polyfills for node builtin modules and globals",
|
2590
|
+
"type": "boolean"
|
2591
|
+
},
|
2592
|
+
"placement": {
|
2593
|
+
"additionalProperties": false,
|
2594
|
+
"description": "Specify how the Worker should be located to minimize round-trip time.\n\nMore details: https://developers.cloudflare.com/workers/platform/smart-placement/",
|
2595
|
+
"properties": {
|
2596
|
+
"mode": {
|
2597
|
+
"enum": [
|
2598
|
+
"off",
|
2599
|
+
"smart"
|
2600
|
+
],
|
2601
|
+
"type": "string"
|
2602
|
+
}
|
2603
|
+
},
|
2604
|
+
"required": [
|
2605
|
+
"mode"
|
2606
|
+
],
|
2607
|
+
"type": "object"
|
2608
|
+
},
|
2609
|
+
"preserve_file_names": {
|
2610
|
+
"description": "Determines whether Wrangler will preserve bundled file names. Defaults to false. If left unset, files will be named using the pattern ${fileHash}-${basename}, for example, `34de60b44167af5c5a709e62a4e20c4f18c9e3b6-favicon.ico`.",
|
2611
|
+
"type": "boolean"
|
2612
|
+
},
|
2613
|
+
"queues": {
|
2614
|
+
"additionalProperties": false,
|
2615
|
+
"default": "`{consumers:[],producers:[]}`",
|
2616
|
+
"description": "Specifies Queues that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2617
|
+
"properties": {
|
2618
|
+
"consumers": {
|
2619
|
+
"description": "Consumer configuration",
|
2620
|
+
"items": {
|
2621
|
+
"additionalProperties": false,
|
2622
|
+
"properties": {
|
2623
|
+
"dead_letter_queue": {
|
2624
|
+
"description": "The queue to send messages that failed to be consumed.",
|
2625
|
+
"type": "string"
|
2626
|
+
},
|
2627
|
+
"max_batch_size": {
|
2628
|
+
"description": "The maximum number of messages per batch",
|
2629
|
+
"type": "number"
|
2630
|
+
},
|
2631
|
+
"max_batch_timeout": {
|
2632
|
+
"description": "The maximum number of seconds to wait to fill a batch with messages.",
|
2633
|
+
"type": "number"
|
2634
|
+
},
|
2635
|
+
"max_concurrency": {
|
2636
|
+
"description": "The maximum number of concurrent consumer Worker invocations. Leaving this unset will allow your consumer to scale to the maximum concurrency needed to keep up with the message backlog.",
|
2637
|
+
"type": [
|
2638
|
+
"number",
|
2639
|
+
"null"
|
2640
|
+
]
|
2641
|
+
},
|
2642
|
+
"max_retries": {
|
2643
|
+
"description": "The maximum number of retries for each message.",
|
2644
|
+
"type": "number"
|
2645
|
+
},
|
2646
|
+
"queue": {
|
2647
|
+
"description": "The name of the queue from which this consumer should consume.",
|
2648
|
+
"type": "string"
|
2649
|
+
},
|
2650
|
+
"retry_delay": {
|
2651
|
+
"description": "The number of seconds to wait before retrying a message",
|
2652
|
+
"type": "number"
|
2653
|
+
},
|
2654
|
+
"type": {
|
2655
|
+
"description": "The consumer type, e.g., worker, http-pull, r2-bucket, etc. Default is worker.",
|
2656
|
+
"type": "string"
|
2657
|
+
},
|
2658
|
+
"visibility_timeout_ms": {
|
2659
|
+
"description": "The number of milliseconds to wait for pulled messages to become visible again",
|
2660
|
+
"type": "number"
|
2661
|
+
}
|
2662
|
+
},
|
2663
|
+
"required": [
|
2664
|
+
"queue"
|
2665
|
+
],
|
2666
|
+
"type": "object"
|
2667
|
+
},
|
2668
|
+
"type": "array"
|
2669
|
+
},
|
2670
|
+
"producers": {
|
2671
|
+
"description": "Producer bindings",
|
2672
|
+
"items": {
|
2673
|
+
"additionalProperties": false,
|
2674
|
+
"properties": {
|
2675
|
+
"binding": {
|
2676
|
+
"description": "The binding name used to refer to the Queue in the Worker.",
|
2677
|
+
"type": "string"
|
2678
|
+
},
|
2679
|
+
"delivery_delay": {
|
2680
|
+
"description": "The number of seconds to wait before delivering a message",
|
2681
|
+
"type": "number"
|
2682
|
+
},
|
2683
|
+
"queue": {
|
2684
|
+
"description": "The name of this Queue.",
|
2685
|
+
"type": "string"
|
2686
|
+
}
|
2687
|
+
},
|
2688
|
+
"required": [
|
2689
|
+
"binding",
|
2690
|
+
"queue"
|
2691
|
+
],
|
2692
|
+
"type": "object"
|
2693
|
+
},
|
2694
|
+
"type": "array"
|
2695
|
+
}
|
2696
|
+
},
|
2697
|
+
"type": "object"
|
2698
|
+
},
|
2699
|
+
"r2_buckets": {
|
2700
|
+
"default": "`[]`",
|
2701
|
+
"description": "Specifies R2 buckets that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2702
|
+
"items": {
|
2703
|
+
"additionalProperties": false,
|
2704
|
+
"properties": {
|
2705
|
+
"binding": {
|
2706
|
+
"description": "The binding name used to refer to the R2 bucket in the Worker.",
|
2707
|
+
"type": "string"
|
2708
|
+
},
|
2709
|
+
"bucket_name": {
|
2710
|
+
"description": "The name of this R2 bucket at the edge.",
|
2711
|
+
"type": "string"
|
2712
|
+
},
|
2713
|
+
"jurisdiction": {
|
2714
|
+
"description": "The jurisdiction that the bucket exists in. Default if not present.",
|
2715
|
+
"type": "string"
|
2716
|
+
},
|
2717
|
+
"preview_bucket_name": {
|
2718
|
+
"description": "The preview name of this R2 bucket at the edge.",
|
2719
|
+
"type": "string"
|
2720
|
+
}
|
2721
|
+
},
|
2722
|
+
"required": [
|
2723
|
+
"binding",
|
2724
|
+
"bucket_name"
|
2725
|
+
],
|
2726
|
+
"type": "object"
|
2727
|
+
},
|
2728
|
+
"type": "array"
|
2729
|
+
},
|
2730
|
+
"route": {
|
2731
|
+
"$ref": "#/definitions/Route",
|
2732
|
+
"description": "A route that your Worker should be published to. Literally the same as routes, but only one. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker"
|
2733
|
+
},
|
2734
|
+
"routes": {
|
2735
|
+
"description": "A list of routes that your Worker should be published to. Only one of `routes` or `route` is required.\n\nOnly required when workers_dev is false, and there's no scheduled Worker (see `triggers`)",
|
2736
|
+
"items": {
|
2737
|
+
"$ref": "#/definitions/Route"
|
2738
|
+
},
|
2739
|
+
"type": "array"
|
2740
|
+
},
|
2741
|
+
"rules": {
|
2742
|
+
"description": "An ordered list of rules that define which modules to import, and what type to import them as. You will need to specify rules to use Text, Data, and CompiledWasm modules, or when you wish to have a .js file be treated as an ESModule instead of CommonJS.",
|
2743
|
+
"items": {
|
2744
|
+
"$ref": "#/definitions/Rule"
|
2745
|
+
},
|
2746
|
+
"type": "array"
|
2747
|
+
},
|
2748
|
+
"send_email": {
|
2749
|
+
"default": "`[]`",
|
2750
|
+
"description": "These specify bindings to send email from inside your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2751
|
+
"items": {
|
2752
|
+
"additionalProperties": false,
|
2753
|
+
"properties": {
|
2754
|
+
"allowed_destination_addresses": {
|
2755
|
+
"description": "If this binding should be restricted to a set of verified addresses",
|
2756
|
+
"items": {
|
2757
|
+
"type": "string"
|
2758
|
+
},
|
2759
|
+
"type": "array"
|
2760
|
+
},
|
2761
|
+
"destination_address": {
|
2762
|
+
"description": "If this binding should be restricted to a specific verified address",
|
2763
|
+
"type": "string"
|
2764
|
+
},
|
2765
|
+
"name": {
|
2766
|
+
"description": "The binding name used to refer to the this binding",
|
2767
|
+
"type": "string"
|
2768
|
+
}
|
2769
|
+
},
|
2770
|
+
"required": [
|
2771
|
+
"name"
|
2772
|
+
],
|
2773
|
+
"type": "object"
|
2774
|
+
},
|
2775
|
+
"type": "array"
|
2776
|
+
},
|
2777
|
+
"services": {
|
2778
|
+
"default": "`[]`",
|
2779
|
+
"description": "Specifies service bindings (Worker-to-Worker) that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2780
|
+
"items": {
|
2781
|
+
"additionalProperties": false,
|
2782
|
+
"properties": {
|
2783
|
+
"binding": {
|
2784
|
+
"description": "The binding name used to refer to the bound service.",
|
2785
|
+
"type": "string"
|
2786
|
+
},
|
2787
|
+
"entrypoint": {
|
2788
|
+
"description": "Optionally, the entrypoint (named export) of the service to bind to.",
|
2789
|
+
"type": "string"
|
2790
|
+
},
|
2791
|
+
"environment": {
|
2792
|
+
"description": "The environment of the service (e.g. production, staging, etc).",
|
2793
|
+
"type": "string"
|
2794
|
+
},
|
2795
|
+
"service": {
|
2796
|
+
"description": "The name of the service.",
|
2797
|
+
"type": "string"
|
2798
|
+
}
|
2799
|
+
},
|
2800
|
+
"required": [
|
2801
|
+
"binding",
|
2802
|
+
"service"
|
2803
|
+
],
|
2804
|
+
"type": "object"
|
2805
|
+
},
|
2806
|
+
"type": "array"
|
2807
|
+
},
|
2808
|
+
"tail_consumers": {
|
2809
|
+
"default": "`[]`",
|
2810
|
+
"description": "Specifies a list of Tail Workers that are bound to this Worker environment\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2811
|
+
"items": {
|
2812
|
+
"$ref": "#/definitions/TailConsumer"
|
2813
|
+
},
|
2814
|
+
"type": "array"
|
2815
|
+
},
|
2816
|
+
"triggers": {
|
2817
|
+
"additionalProperties": false,
|
2818
|
+
"default": "`{crons:[]}`",
|
2819
|
+
"description": "\"Cron\" definitions to trigger a Worker's \"scheduled\" function.\n\nLets you call Workers periodically, much like a cron job.\n\nMore details here https://developers.cloudflare.com/workers/platform/cron-triggers",
|
2820
|
+
"properties": {
|
2821
|
+
"crons": {
|
2822
|
+
"items": {
|
2823
|
+
"type": "string"
|
2824
|
+
},
|
2825
|
+
"type": "array"
|
2826
|
+
}
|
2827
|
+
},
|
2828
|
+
"required": [
|
2829
|
+
"crons"
|
2830
|
+
],
|
2831
|
+
"type": "object"
|
2832
|
+
},
|
2833
|
+
"tsconfig": {
|
2834
|
+
"description": "Path to a custom tsconfig",
|
2835
|
+
"type": "string"
|
2836
|
+
},
|
2837
|
+
"unsafe": {
|
2838
|
+
"additionalProperties": false,
|
2839
|
+
"default": "`{}`",
|
2840
|
+
"description": "\"Unsafe\" tables for features that aren't directly supported by wrangler.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2841
|
+
"properties": {
|
2842
|
+
"bindings": {
|
2843
|
+
"description": "A set of bindings that should be put into a Worker's upload metadata without changes. These can be used to implement bindings for features that haven't released and aren't supported directly by wrangler or miniflare.",
|
2844
|
+
"items": {
|
2845
|
+
"additionalProperties": {},
|
2846
|
+
"properties": {
|
2847
|
+
"name": {
|
2848
|
+
"type": "string"
|
2849
|
+
},
|
2850
|
+
"type": {
|
2851
|
+
"type": "string"
|
2852
|
+
}
|
2853
|
+
},
|
2854
|
+
"required": [
|
2855
|
+
"name",
|
2856
|
+
"type"
|
2857
|
+
],
|
2858
|
+
"type": "object"
|
2859
|
+
},
|
2860
|
+
"type": "array"
|
2861
|
+
},
|
2862
|
+
"capnp": {
|
2863
|
+
"anyOf": [
|
2864
|
+
{
|
2865
|
+
"additionalProperties": false,
|
2866
|
+
"properties": {
|
2867
|
+
"base_path": {
|
2868
|
+
"type": "string"
|
2869
|
+
},
|
2870
|
+
"source_schemas": {
|
2871
|
+
"items": {
|
2872
|
+
"type": "string"
|
2873
|
+
},
|
2874
|
+
"type": "array"
|
2875
|
+
}
|
2876
|
+
},
|
2877
|
+
"required": [
|
2878
|
+
"base_path",
|
2879
|
+
"source_schemas"
|
2880
|
+
],
|
2881
|
+
"type": "object"
|
2882
|
+
},
|
2883
|
+
{
|
2884
|
+
"additionalProperties": false,
|
2885
|
+
"properties": {
|
2886
|
+
"compiled_schema": {
|
2887
|
+
"type": "string"
|
2888
|
+
}
|
2889
|
+
},
|
2890
|
+
"required": [
|
2891
|
+
"compiled_schema"
|
2892
|
+
],
|
2893
|
+
"type": "object"
|
2894
|
+
}
|
2895
|
+
],
|
2896
|
+
"description": "Used for internal capnp uploads for the Workers runtime"
|
2897
|
+
},
|
2898
|
+
"metadata": {
|
2899
|
+
"additionalProperties": {},
|
2900
|
+
"description": "Arbitrary key/value pairs that will be included in the uploaded metadata. Values specified here will always be applied to metadata last, so can add new or override existing fields.",
|
2901
|
+
"type": "object"
|
2902
|
+
}
|
2903
|
+
},
|
2904
|
+
"type": "object"
|
2905
|
+
},
|
2906
|
+
"upload_source_maps": {
|
2907
|
+
"description": "Include source maps when uploading this worker.",
|
2908
|
+
"type": "boolean"
|
2909
|
+
},
|
2910
|
+
"usage_model": {
|
2911
|
+
"description": "Specifies the Usage Model for your Worker. There are two options - [bundled](https://developers.cloudflare.com/workers/platform/limits#bundled-usage-model) and [unbound](https://developers.cloudflare.com/workers/platform/limits#unbound-usage-model). For newly created Workers, if the Usage Model is omitted it will be set to the [default Usage Model set on the account](https://dash.cloudflare.com/?account=workers/default-usage-model). For existing Workers, if the Usage Model is omitted, it will be set to the Usage Model configured in the dashboard for that Worker.",
|
2912
|
+
"enum": [
|
2913
|
+
"bundled",
|
2914
|
+
"unbound"
|
2915
|
+
],
|
2916
|
+
"type": "string"
|
2917
|
+
},
|
2918
|
+
"vars": {
|
2919
|
+
"additionalProperties": {
|
2920
|
+
"anyOf": [
|
2921
|
+
{
|
2922
|
+
"type": "string"
|
2923
|
+
},
|
2924
|
+
{
|
2925
|
+
"$ref": "#/definitions/Json"
|
2926
|
+
}
|
2927
|
+
]
|
2928
|
+
},
|
2929
|
+
"default": "`{}`",
|
2930
|
+
"description": "A map of environment variables to set when deploying your Worker.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2931
|
+
"type": "object"
|
2932
|
+
},
|
2933
|
+
"vectorize": {
|
2934
|
+
"default": "`[]`",
|
2935
|
+
"description": "Specifies Vectorize indexes that are bound to this Worker environment.\n\nNOTE: This field is not automatically inherited from the top level environment, and so must be specified in every named environment.",
|
2936
|
+
"items": {
|
2937
|
+
"additionalProperties": false,
|
2938
|
+
"properties": {
|
2939
|
+
"binding": {
|
2940
|
+
"description": "The binding name used to refer to the Vectorize index in the Worker.",
|
2941
|
+
"type": "string"
|
2942
|
+
},
|
2943
|
+
"index_name": {
|
2944
|
+
"description": "The name of the index.",
|
2945
|
+
"type": "string"
|
2946
|
+
}
|
2947
|
+
},
|
2948
|
+
"required": [
|
2949
|
+
"binding",
|
2950
|
+
"index_name"
|
2951
|
+
],
|
2952
|
+
"type": "object"
|
2953
|
+
},
|
2954
|
+
"type": "array"
|
2955
|
+
},
|
2956
|
+
"version_metadata": {
|
2957
|
+
"additionalProperties": false,
|
2958
|
+
"description": "Binding to the Worker Version's metadata",
|
2959
|
+
"properties": {
|
2960
|
+
"binding": {
|
2961
|
+
"type": "string"
|
2962
|
+
}
|
2963
|
+
},
|
2964
|
+
"required": [
|
2965
|
+
"binding"
|
2966
|
+
],
|
2967
|
+
"type": "object"
|
2968
|
+
},
|
2969
|
+
"workers_dev": {
|
2970
|
+
"default": "`true` (This is a breaking change from Wrangler v1)",
|
2971
|
+
"description": "Whether we use <name>.<subdomain>.workers.dev to test and deploy your Worker.\n\n// Carmen according to our tests the default is undefined",
|
2972
|
+
"type": "boolean"
|
2973
|
+
},
|
2974
|
+
"zone_id": {
|
2975
|
+
"description": "TODO: remove this as it has been deprecated.\n\nThis is just here for now because the `route` commands use it. So we need to include it in this type so it is available.",
|
2976
|
+
"type": "string"
|
2977
|
+
}
|
2978
|
+
},
|
2979
|
+
"type": "object"
|
2980
|
+
},
|
2981
|
+
"Route": {
|
2982
|
+
"anyOf": [
|
2983
|
+
{
|
2984
|
+
"$ref": "#/definitions/SimpleRoute"
|
2985
|
+
},
|
2986
|
+
{
|
2987
|
+
"$ref": "#/definitions/ZoneIdRoute"
|
2988
|
+
},
|
2989
|
+
{
|
2990
|
+
"$ref": "#/definitions/ZoneNameRoute"
|
2991
|
+
},
|
2992
|
+
{
|
2993
|
+
"$ref": "#/definitions/CustomDomainRoute"
|
2994
|
+
}
|
2995
|
+
]
|
2996
|
+
},
|
2997
|
+
"Rule": {
|
2998
|
+
"additionalProperties": false,
|
2999
|
+
"description": "A bundling resolver rule, defining the modules type for paths that match the specified globs.",
|
3000
|
+
"properties": {
|
3001
|
+
"fallthrough": {
|
3002
|
+
"type": "boolean"
|
3003
|
+
},
|
3004
|
+
"globs": {
|
3005
|
+
"items": {
|
3006
|
+
"type": "string"
|
3007
|
+
},
|
3008
|
+
"type": "array"
|
3009
|
+
},
|
3010
|
+
"type": {
|
3011
|
+
"$ref": "#/definitions/ConfigModuleRuleType"
|
3012
|
+
}
|
3013
|
+
},
|
3014
|
+
"required": [
|
3015
|
+
"type",
|
3016
|
+
"globs"
|
3017
|
+
],
|
3018
|
+
"type": "object"
|
3019
|
+
},
|
3020
|
+
"SimpleRoute": {
|
3021
|
+
"type": "string"
|
3022
|
+
},
|
3023
|
+
"TailConsumer": {
|
3024
|
+
"additionalProperties": false,
|
3025
|
+
"properties": {
|
3026
|
+
"environment": {
|
3027
|
+
"description": "(Optional) The environment of the service.",
|
3028
|
+
"type": "string"
|
3029
|
+
},
|
3030
|
+
"service": {
|
3031
|
+
"description": "The name of the service tail events will be forwarded to.",
|
3032
|
+
"type": "string"
|
3033
|
+
}
|
3034
|
+
},
|
3035
|
+
"required": [
|
3036
|
+
"service"
|
3037
|
+
],
|
3038
|
+
"type": "object"
|
3039
|
+
},
|
3040
|
+
"TypeOf<ZodUnion<[def-class-1315922706-6501-8772-1315922706-0-54395,def-class-1315922706-9299-10989-1315922706-0-54395,def-class-1315922706-12937-13365-1315922706-0-54395,def-class-1315922706-15083-15273-1315922706-0-54395]>>": {
|
3041
|
+
"type": [
|
3042
|
+
"string",
|
3043
|
+
"number",
|
3044
|
+
"boolean",
|
3045
|
+
"null"
|
3046
|
+
]
|
3047
|
+
},
|
3048
|
+
"UserLimits": {
|
3049
|
+
"additionalProperties": false,
|
3050
|
+
"properties": {
|
3051
|
+
"cpu_ms": {
|
3052
|
+
"description": "Maximum allowed CPU time for a Worker's invocation in milliseconds",
|
3053
|
+
"type": "number"
|
3054
|
+
}
|
3055
|
+
},
|
3056
|
+
"required": [
|
3057
|
+
"cpu_ms"
|
3058
|
+
],
|
3059
|
+
"type": "object"
|
3060
|
+
},
|
3061
|
+
"ZoneIdRoute": {
|
3062
|
+
"additionalProperties": false,
|
3063
|
+
"properties": {
|
3064
|
+
"custom_domain": {
|
3065
|
+
"type": "boolean"
|
3066
|
+
},
|
3067
|
+
"pattern": {
|
3068
|
+
"type": "string"
|
3069
|
+
},
|
3070
|
+
"zone_id": {
|
3071
|
+
"type": "string"
|
3072
|
+
}
|
3073
|
+
},
|
3074
|
+
"required": [
|
3075
|
+
"pattern",
|
3076
|
+
"zone_id"
|
3077
|
+
],
|
3078
|
+
"type": "object"
|
3079
|
+
},
|
3080
|
+
"ZoneNameRoute": {
|
3081
|
+
"additionalProperties": false,
|
3082
|
+
"properties": {
|
3083
|
+
"custom_domain": {
|
3084
|
+
"type": "boolean"
|
3085
|
+
},
|
3086
|
+
"pattern": {
|
3087
|
+
"type": "string"
|
3088
|
+
},
|
3089
|
+
"zone_name": {
|
3090
|
+
"type": "string"
|
3091
|
+
}
|
3092
|
+
},
|
3093
|
+
"required": [
|
3094
|
+
"pattern",
|
3095
|
+
"zone_name"
|
3096
|
+
],
|
3097
|
+
"type": "object"
|
3098
|
+
}
|
3099
|
+
}
|
3100
|
+
}
|