Version 1

WickConfig

Root configuration that can be any one of the possible Wick configuration formats.

Any one of the following types:

AppConfiguration
ComponentConfiguration
TypesConfiguration
TestConfiguration
LockdownConfiguration

LocationReference

A reference to a location on disk, URL, or registry.

Type: string

LiquidJsonValue

A liquid JSON value. Liquid-JSON is a way of using Liquid templates in structured JSON-like data.

See liquid-json and liquid’s website for more information.

Type: string

LiquidTemplate

A liquid template. Liquid-JSON is a way of using Liquid templates in structured JSON-like data. See liquid's [homepage](https://shopify.github.io/liquid/) for more information.

Type: string

Glob

A glob pattern, e.g. **/*.html

Type: string

AppConfiguration

Configuration for a standalone Wick application.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/app@v1"`	Yes
`metadata`	`Metadata`	Associated metadata for this application.
`package`	`PackageDefinition`	Details about the package for this application.
`resources`	`ResourceBinding[]`	Resources and configuration that the application and its components can access.
`import`	`ImportBinding[]`	Components that to import and make available to the application.
`triggers`	`TriggerDefinition[]`	Triggers to load and instantiate to drive the application’s behavior.

Metadata

Metadata to associate with an artifact.

Field name	Type	Description
`version`	`string`	The version of the artifact.
`authors`	`string[]`	A list of the authors.
`vendors`	`string[]`	A list of any vendors associated with the artifact.
`description`	`string`	A short description.
`documentation`	`string`	Where to find documentation.
`licenses`	`string[]`	The license(s) for the artifact.
`icon`	`LocationReference`	An icon to associate with the artifact.

PackageDefinition

Configuration for packaging and publishing Wick configurations.

Field name	Type	Description	Required?	Shortform?
`files`	`Glob[]`	The list of files and folders to be included with the package.
`registry`	`RegistryDefinition`	Configuration for publishing the package to a registry.

RegistryDefinition

Field name	Type	Description	Required?	Shortform?
`host`	`string`	The registry to publish to, e.g. registry.candle.dev
`namespace`	`string`	The namespace on the registry. e.g.: [your username]

ResourceBinding

An identifier bound to a resource.

Field name	Type	Description	Required?	Shortform?
`name`	`string`	The name of the binding.	Yes
`resource`	`ResourceDefinition`	The resource to bind to.	Yes

ImportBinding

An identifier bound to an imported component or type manifest.

Field name	Type	Description	Required?	Shortform?
`name`	`string`	The name of the binding.	Yes
`component`	`ImportDefinition`	The import to bind to.	Yes

ResourceDefinition

The possible types of resources. Resources are system-level resources and sensitive configuration.

Any one of the following types:

TcpPort
UdpPort
Url
Volume

TcpPort

A TCP port to bind to.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/resource/tcpport@v1"`	Yes
`address`	`LiquidTemplate`	The address to bind to.

UdpPort

A UDP port to bind to.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/resource/udpport@v1"`	Yes
`address`	`LiquidTemplate`	The address to bind to.

Volume

A filesystem or network volume resource.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/resource/volume@v1"`	Yes

Url

A URL configured as a resource.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/resource/url@v1"`	Yes

TriggerDefinition

Triggers that operate off events and translate environment data to components. Triggers are the way that Wick handles standard use cases and translates them into the component world.

Any one of the following types:

CliTrigger
HttpTrigger
TimeTrigger

CliTrigger

A trigger that runs when an application is called via the command line.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/trigger/cli@v1"`	Yes

TimeTrigger

A trigger that runs on a schedule similar to cron.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/trigger/time@v1"`	Yes
`operation`	`ComponentOperationExpression`	The operation to execute on the schedule.	Yes	Yes
`payload`	`OperationInput[]`	Values passed to the operation as inputs

OperationInput

Input to use when calling an operation

Field name	Type	Description	Required?	Shortform?
`name`	`string`	The name of the input.	Yes
`value`	`any`	The value to pass.	Yes

Schedule

The schedule to run the Time trigger with.

Field name	Type	Description	Required?	Shortform?
`cron`	`string`	Schedule in cron format with second precision. See cron.help for more information.	Yes
`repeat`	`u16`	repeat `n` times. Use `0` to repeat indefinitely

ComponentOperationExpression

A reference to an operation. This type can be shortened to component_id::operation_name with the short-form syntax.

This type can be abbreviated with shortform syntax

Field name	Type	Description	Required?	Shortform?
`component`	`ComponentDefinition`	The component that exports the operation.	Yes	Yes
`name`	`string`	The operation name.	Yes
`with`	`{ string : LiquidJsonValue }`	Configuration to pass to this operation on invocation.
`timeout`	`u64`	Timeout (in milliseconds) to wait for the operation to complete. Use 0 to wait indefinitely.

HttpTrigger

An HTTP server that delegates to HTTP routers on every request.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/trigger/http@v1"`	Yes
`routers`	`HttpRouter[]`	The router to handle incoming requests

HttpRouter

The types of routers that can be configured on the HttpTrigger.

Any one of the following types:

RawRouter
RestRouter
StaticRouter
ProxyRouter

ProxyRouter

A router that proxies to the configured URL when the path matches.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/router/proxy@v1"`	Yes
`middleware`	`Middleware`	Middleware operations for this router.
`url`	`string`	The URL resource to proxy to.	Yes
`strip_path`	`bool`	Whether or not to strip the router’s path from the proxied request.

RestRouter

A router that can be configured to delegate to specific operations on a per-route, per-method basis.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/router/rest@v1"`	Yes
`tools`	`Tools`	Additional tools and services to enable.
`middleware`	`Middleware`	Middleware operations for this router.
`routes`	`Route[]`	The routes to serve and operations that handle them.
`info`	`Info`	Information about the router to use when generating documentation and other tools.

Route

A route to serve and the operation that handles it.

Field name	Type	Description	Required?	Shortform?
`sub_path`	`string`	The path to serve this route from. See URI documentation for more information on specifying query and path parameters.	Yes
`operation`	`ComponentOperationExpression`	The operation that will act as the main entrypoint for this route.	Yes	Yes
`methods`	`HttpMethod[]`	The HTTP methods to serve this route for.
`id`	`string`	The unique ID of the route, used for documentation and tooling.
`description`	`string`	A short description of the route.
`summary`	`string`	A longer description of the route.

Tools

Additional tools and services to enable.

Field name	Type	Description	Required?	Shortform?
`openapi`	`bool`	Set to true to generate an OpenAPI specification and serve it at router_path/openapi.json

Info

Information about the router to use when generating documentation and other tools.

Field name	Type	Description
`title`	`string`	The title of the API.
`description`	`string`	A short description of the API.
`tos`	`string`	The terms of service for the API.
`contact`	`Contact`	The contact information for the API.
`license`	`License`	The license information for the API.
`version`	`string`	The version of the API.
`documentation`	`Documentation`	The URL to the API’s terms of service.

Documentation

Information about where and how the API is documented.

Field name	Type	Description	Required?	Shortform?
`url`	`string`	The URL to the API’s documentation.
`description`	`string`	A short description of the documentation.

License

Any licensing information for the API.

Field name	Type	Description	Required?	Shortform?
`name`	`string`	The name of the license.	Yes
`url`	`string`	The URL to the license.

Contact

Contact information to expose for the API.

Field name	Type	Description
`name`	`string`	The name of the contact.
`url`	`string`	The URL to the contact.
`email`	`string`	The email address of the contact.

StaticRouter

A router that serves static files.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/router/static@v1"`	Yes
`middleware`	`Middleware`	Middleware operations for this router.
`volume`	`string`	The volume to serve static files from.	Yes
`fallback`	`string`	Fallback path (relative to volume `resource`) for files to serve in case of a 404. Useful for SPA’s. if volume resource is: /www and fallback: index.html, then a 404 will serve /www/index.html
`indexes`	`bool`	Whether or not to serve directory listings when a directory is requested.

RawRouter

A router that delegates all requests to the configured operation, optionally encoding/decoding based on the specified codec.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/router/raw@v1"`	Yes
`middleware`	`Middleware`	Middleware operations for this router.
`codec`	`Codec`	The codec to use when encoding/decoding data.
`operation`	`ComponentOperationExpression`	The operation that handles HTTP requests.	Yes	Yes

Middleware

Request and response operations that run before and after the main operation.

Field name	Type	Description	Required?	Shortform?
`request`	`ComponentOperationExpression[]`	The middleware to apply to requests.
`response`	`ComponentOperationExpression[]`	The middleware to apply to responses.

TypesConfiguration

A type definition for a Wick Components and Operations

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/types@v1"`	Yes
`metadata`	`Metadata`	Associated metadata for this type.
`types`	`TypeDefinition[]`	Additional types to export and make available to the type.
`operations`	`OperationDefinition[]`	A list of operation signatures.
`package`	`PackageDefinition`	Details about the package for this types.

TestConfiguration

A configuration for a Wick Component

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/tests@v1"`	Yes
`with`	`{ string : LiquidJsonValue }`	Configuration used to instantiate this component.
`cases`	`TestDefinition[]`	Unit tests to run against components and operations.

LockdownConfiguration

A lockdown configuration used to secure Wick components and applications

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/lockdown@v1"`	Yes
`resources`	`ResourceRestriction[]`	Restrictions to apply to resources before an application or component can be run.

ResourceRestriction

Restrictions to assert against an application or component.

Any one of the following types:

VolumeRestriction
UrlRestriction
TcpPortRestriction
UdpPortRestriction

VolumeRestriction

Restrictions to apply against Volume resources

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/resource/volume@v1"`	Yes
`allow`	`LiquidTemplate`	The volumes to allow	Yes

UrlRestriction

Restrictions to apply against URL resources

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/resource/url@v1"`	Yes
`allow`	`LiquidTemplate`	The URLs to allow	Yes

TcpPortRestriction

Restrictions to apply against TCP Port resources

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/resource/tcpport@v1"`	Yes
`address`	`LiquidTemplate`	The address to allow	Yes
`port`	`LiquidTemplate`	The port to allow	Yes

UdpPortRestriction

Restrictions to apply against UDP Port resources

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/resource/udpport@v1"`	Yes
`address`	`LiquidTemplate`	The address to allow	Yes
`port`	`LiquidTemplate`	The port to allow	Yes

ComponentConfiguration

A configuration for a Wick Component

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/component@v1"`	Yes
`metadata`	`Metadata`	Associated metadata for this component.
`package`	`PackageDefinition`	Details about the package for this component.
`host`	`HostConfig`	Configuration for when wick hosts this component as a service.
`resources`	`ResourceBinding[]`	Resources that the component can access.
`import`	`ImportBinding[]`	Components or types to import into this component’s scope.
`types`	`TypeDefinition[]`	Additional types to export and make available to the component.
`requires`	`InterfaceBinding[]`	Interfaces the component requires to operate.
`component`	`ComponentKind`	Configuration specific to different kinds of components.	Yes
`tests`	`TestConfiguration[]`	Assertions that can be run against the component to validate its behavior.

InterfaceBinding

An interface bound to an ID. Used in the require/provide relationship between components.

Field name	Type	Description	Required?	Shortform?
`name`	`string`	The name of the interface.	Yes
`interface`	`InterfaceDefinition`	The interface to bind to.	Yes

InterfaceDefinition

A interface definition. Used as a signature that components can require or provide.

Field name	Type	Description	Required?	Shortform?
`types`	`TypeDefinition[]`	Types used by the interface’s operations
`operations`	`OperationDefinition[]`	A list of operations defined by this interface.

CompositeComponentConfiguration

A component made from connectiong other components.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/component/composite@v1"`	Yes
`with`	`Field[]`	Configuration necessary to provide when instantiating the component.
`extends`	`string[]`	A component or components whose operations you want to inherit from.

WasmComponentConfiguration

A component whose implementation is a WasmRS WebAssembly module.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/component/wasmrs@v1"`	Yes
`volumes`	`ExposedVolume[]`	Volumes to expose to the component.
`max_packet_size`	`u32`	The default size to allocate to the component’s send/receive buffer.
`with`	`Field[]`	Configuration necessary to provide when instantiating the component.
`operations`	`OperationDefinition[]`	A list of operations implemented by the WebAssembly module.

ExposedVolume

Volumes to expose to a component and the internal paths they map to.

Field name	Type	Description	Required?	Shortform?
`resource`	`string`	The resource ID of the volume.	Yes
`path`	`string`	The path to map it to in the component.	Yes

ComponentKind

Root component types. These are the components that can be instantiated and run.

Any one of the following types:

WasmComponentConfiguration
CompositeComponentConfiguration
SqlComponent
HttpClientComponent

ImportDefinition

Types of possible imports.

Any one of the following types:

TypesComponent
ManifestComponent
SqlComponent
HttpClientComponent

ComponentDefinition

Component types used when referencing operations or linking components.

Any one of the following types:

GrpcUrlComponent
ManifestComponent
ComponentReference
SqlComponent
HttpClientComponent

TypesComponent

A types configuration to import into this component's scope.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/component/types@v1"`	Yes
`types`	`string[]`	The types to import from the manifest.

ComponentReference

A reference to a component in the application's scope.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/component/reference@v1"`	Yes

HostConfig

Host configuration options.

Field name	Type	Description
`allow_latest`	`bool`	Whether or not to allow the `:latest` tag on remote artifacts.
`insecure_registries`	`string[]`	A list of registries to connect to insecurely (over HTTP vs HTTPS).
`rpc`	`HttpConfig`	Configuration for the GRPC server.

HttpConfig

Configuration for the GRPC service.

Field name	Type	Description
`enabled`	`bool`	Enable/disable the server.
`port`	`u16`	The port to bind to.
`address`	`string`	The address to bind to.
`pem`	`LocationReference`	Path to pem file for TLS.
`key`	`LocationReference`	Path to key file for TLS.
`ca`	`LocationReference`	Path to CA file.

GrpcUrlComponent

A component hosted as an independent microservice.

Field name	Type	Description	Required?	Shortform?
`kind`	`string`	must be `"wick/component/grpc@v1"`	Yes
`with`	`{ string : LiquidJsonValue }`	Any configuration necessary for the component.

ManifestComponent

A configuration defined in a Wick component manifest.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/component/manifest@v1"`	Yes
`with`	`{ string : LiquidJsonValue }`	Any configuration necessary for the component.
`provide`	`{ string : string }`	External components to provide to the referenced component.
`max_packet_size`	`u32`	If applicable, the default size to allocate to the component’s send/receive buffer.

CompositeOperationDefinition

Composite operations are operations whose implementations come from connecting other operations into a flow or series of pipelines.

Field name	Type	Description
`name`	`string`	The name of the operation.
`with`	`Field[]`	Any configuration required by the operation.
`inputs`	`Field[]`	Types of the inputs to the operation.
`outputs`	`Field[]`	Types of the outputs to the operation.
`uses`	`OperationInstance[]`	A map of IDs to specific operations.
`flow`	`FlowExpression[]`	A list of connections from operation to operation.
`operations`	`CompositeOperationDefinition[]`	Additional `CompositeOperationDefinition`s to define as children.

FlowExpression

A flow operation, i.e. a connection from one operation's outputs to another's inputs.

This type can be abbreviated with shortform syntax

Any one of the following types:

ConnectionDefinition
BlockExpression

BlockExpression

A list of FlowExpressions. Typically used only when expanding a shortform `FlowExpression` into multiple `FlowExpression`s.

Field name	Type	Description	Required?	Shortform?
`expressions`	`FlowExpression[]`

ConnectionDefinition

A connection between Operations and their ports. This can be specified in short-form syntax.

Field name	Type	Description	Required?	Shortform?
`from`	`ConnectionTargetDefinition`	An upstream operation’s output.	Yes
`to`	`ConnectionTargetDefinition`	A downstream operation’s input.	Yes

ConnectionTargetDefinition

A connection target e.g. a specific input or output on an operation instance. This can be specified in shortform syntax.

Field name	Type	Description	Required?
`instance`	`string`	The instance ID of the component operation.	Yes
`port`	`string`	The operation’s input or output (depending on to/from).
`data`	`{ string : LiquidJsonValue }`	The default value to provide on this connection in the event of an error.

OperationDefinition

An operation name and its input and output signatures

Field name	Type	Description
`name`	`string`	The name of the operation.
`with`	`Field[]`	Any configuration required by the operation.
`inputs`	`Field[]`	Types of the inputs to the operation.
`outputs`	`Field[]`	Types of the outputs to the operation.

Field

Field definition with a name and type signature

Field name	Type	Description	Required?
`name`	`string`	The name of the field.	Yes
`type`	`TypeSignature`	The type signature of the field.	Yes
`description`	`string`	The description of the field.

TypeSignature

This type can be abbreviated with shortform syntax

Any one of the following types:

I8
I16
I32
I64
U8
U16
U32
U64
F32
F64
Bool
StringType
Optional
Datetime
Bytes
Custom
List
Map
Object

I8

Field name	Type	Description	Required?	Shortform?

I16

Field name	Type	Description	Required?	Shortform?

I32

Field name	Type	Description	Required?	Shortform?

I64

Field name	Type	Description	Required?	Shortform?

U8

Field name	Type	Description	Required?	Shortform?

U16

Field name	Type	Description	Required?	Shortform?

U32

Field name	Type	Description	Required?	Shortform?

U64

Field name	Type	Description	Required?	Shortform?

F32

Field name	Type	Description	Required?	Shortform?

F64

Field name	Type	Description	Required?	Shortform?

Bool

Field name	Type	Description	Required?	Shortform?

StringType

Field name	Type	Description	Required?	Shortform?

Datetime

Field name	Type	Description	Required?	Shortform?

Bytes

Field name	Type	Description	Required?	Shortform?

Custom

Field name	Type	Description	Required?	Shortform?
`name`	`string`	The name of the custom type.

Optional

Field name	Type	Description	Required?	Shortform?
`type`	`TypeSignature`		Yes

List

Field name	Type	Description	Required?	Shortform?
`type`	`TypeSignature`		Yes

Map

Field name	Type	Description	Required?	Shortform?
`key`	`TypeSignature`		Yes
`value`	`TypeSignature`		Yes

Object

Field name	Type	Description	Required?	Shortform?

TypeDefinition

A Struct or Enum type definition.

Any one of the following types:

StructSignature
EnumSignature
UnionSignature

StructSignature

A struct definition of named fields and types.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/type/struct@v1"`	Yes
`fields`	`Field[]`	The fields in this struct.
`description`	`string`	The description of the struct.

UnionSignature

An enum definition of named variants.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/type/union@v1"`	Yes
`types`	`TypeSignature[]`	The types in the union.
`description`	`string`	The description of the union.

EnumSignature

An enum definition of named variants.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/type/enum@v1"`	Yes
`variants`	`EnumVariant[]`	The variants in the enum.
`description`	`string`	The description of the enum.

EnumVariant

An enum variant.

Field name	Type	Description
`name`	`string`	The name of the variant.
`index`	`u32`	The index of the variant.
`value`	`string`	The optional value of the variant.
`description`	`string`	A description of the variant.

OperationInstance

An identifier bound to a component's operation.

Field name	Type	Description	Required?	Shortform?
`name`	`string`	The name of the binding.	Yes
`operation`	`ComponentOperationExpression`	The operation to bind to.	Yes	Yes
`with`	`{ string : LiquidJsonValue }`	Data to associate with the reference, if any.
`timeout`	`u64`	Timeout (in milliseconds) to wait for the operation to complete. Use 0 to wait indefinitely.

TestDefinition

A test case for a component's operation.

Field name	Type	Description	Required?
`name`	`string`	The name of the test.
`operation`	`string`	The operaton to test.	Yes
`inherent`	`InherentData`	Inherent data to use for the test.
`with`	`{ string : LiquidJsonValue }`	The configuration for the operation, if any.
`inputs`	`PacketData[]`	The inputs to the test.
`outputs`	`TestPacketData[]`	The expected outputs of the operation.

InherentData

Data inherent to all invocations.

Field name	Type	Description	Required?	Shortform?
`seed`	`u64`	A random seed, i.e. to initialize a random number generator.
`timestamp`	`u64`	A timestamp.

PacketData

Either a success packet or an error packet.

Any one of the following types:

SuccessPacket
ErrorPacket

TestPacketData

Packet assertions.

Any one of the following types:

SuccessPacket
PacketAssertionDef
ErrorPacket

SuccessPacket

A simplified representation of a Wick data packet & payload, used when writing tests.

Field name	Type	Description	Required?
`name`	`string`	The name of the input or output this packet is going to or coming from.	Yes
`flags`	`PacketFlags`	Any flags set on the packet. Deprecated, use ‘flag:’ instead
`flag`	`PacketFlag`	The flag set on the packet.
`value`	`LiquidJsonValue`	The packet payload.

PacketAssertionDef

A test case for a component's operation that uses loose equality for comparing data.

Field name	Type	Description	Required?	Shortform?
`name`	`string`	The name of the input or output this packet is going to or coming from.	Yes
`assertions`	`PacketAssertion[]`	An assertion to test against the packet.

PacketAssertion

A packet assertion.

Field name	Type	Description	Required?
`path`	`string`	The optional path to a value in the packet to assert against.
`operator`	`AssertionOperator`	The operation to use when asserting against a packet.	Yes
`value`	`LiquidJsonValue`	A value or object combine with the operator to assert against a packet value.	Yes

AssertionOperator

An operation that drives the logic in a packet assertion.

Field name	Type	Description
Equals	unknown type
LessThan	unknown type
GreaterThan	unknown type
Regex	unknown type
Contains	unknown type

ErrorPacket

Field name	Type	Description	Required?
`name`	`string`	The name of the input or output this packet is going to or coming from.	Yes
`flags`	`PacketFlags`	Any flags set on the packet. Deprecated, use ‘flag:’ instead
`flag`	`PacketFlag`	The flag set on the packet.
`error`	`LiquidTemplate`	The error message.	Yes

PacketFlags

Flags set on a packet.

Field name	Type	Description
`done`	`bool`	Indicates the port should be considered closed.
`open`	`bool`	Indicates the opening of a new substream context within the parent stream.
`close`	`bool`	Indicates the closing of a substream context within the parent stream.

PacketFlag

Possible flags that can be set on a packet.

Field name	Type	Description
Done	unknown type	Indicates the port should be considered closed.
Open	unknown type	Indicates the opening of a new substream context within the parent stream.
Close	unknown type	Indicates the closing of a substream context within the parent stream.

SqlComponent

A dynamic component whose operations are SQL queries to a database.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/component/sql@v1"`	Yes
`tls`	`bool`	Whether or not to use TLS.
`with`	`Field[]`	Configuration necessary to provide when instantiating the component.
`operations`	`SqlQueryKind[]`	A list of operations to expose on this component.

SqlQueryKind

Any one of the following types:

SqlQueryOperationDefinition
SqlExecOperationDefinition

SqlQueryOperationDefinition

A dynamic operation whose implementation is a SQL query.

Field name	Type	Description	Required?
`name`	`string`	The name of the operation.
`with`	`Field[]`	Any configuration required by the operation.
`inputs`	`Field[]`	Types of the inputs to the operation.
`outputs`	`Field[]`	Types of the outputs to the operation.
`query`	`string`	The query to execute.	Yes
`arguments`	`string[]`	The positional arguments to the query, defined as a list of input names.
`on_error`	`ErrorBehavior`	What to do when an error occurs.

SqlExecOperationDefinition

A dynamic operation whose implementation is a SQL query that returns the number of rows affected or failure.

Field name	Type	Description	Required?
`name`	`string`	The name of the operation.
`with`	`Field[]`	Any configuration required by the operation.
`inputs`	`Field[]`	Types of the inputs to the operation.
`outputs`	`Field[]`	Types of the outputs to the operation.
`exec`	`string`	The query to execute.	Yes
`arguments`	`string[]`	The positional arguments to the query, defined as a list of input names.
`on_error`	`ErrorBehavior`	What to do when an error occurs.

ErrorBehavior

What to do when an error occurs.

Field name	Type	Description
Ignore	unknown type	Errors will be ignored.
Commit	unknown type	The operation will commit what has succeeded.
Rollback	unknown type	The operation will rollback changes.

HttpClientComponent

A component whose operations are HTTP requests.

Field name	Type	Description	Required?
`kind`	`string`	must be `"wick/component/http@v1"`	Yes
`codec`	`Codec`	The codec to use when encoding/decoding data. Can be overridden by individual operations.
`proxy`	`Proxy`	The proxy HTTP / HTTPS to use.
`timeout`	`u16`	The timeout in seconds
`with`	`Field[]`	Configuration necessary to provide when instantiating the component.
`operations`	`HttpClientOperationDefinition[]`	A list of operations to expose on this component.

Proxy

Field name	Type	Description
`resource`	`string`	The URL base to use. http, https are supported.
`username`	`string`	The username to use when authenticating with the proxy.
`password`	`string`	The password to use when authenticating with the proxy.

HttpClientOperationDefinition

A dynamic operation whose implementation is an HTTP request. The outputs of HttpClientOperationDefinition are always `response` & `body`

Field name	Type	Description
`name`	`string`	The name of the operation.
`with`	`Field[]`	Any configuration required by the operation.
`inputs`	`Field[]`	Types of the inputs to the operation.
`method`	`HttpMethod`	The HTTP method to use.
`codec`	`Codec`	The codec to use when encoding/decoding data.
`headers`	`{ string : string[] }`	Any headers to add to the request.
`body`	`LiquidJsonValue`	The body to send, processed as a structured JSON liquid template.
`path`	`string`	The path to append to our base URL, processed as a liquid template with each input as part of the template data.

Codec

Codec to use when encoding/decoding data.

Field name	Type	Description
Json	unknown type	JSON data
Raw	unknown type	Raw bytes
FormData	unknown type	Form Data
Text	unknown type	Raw text

HttpMethod

Supported HTTP methods

Field name	Type	Description
Get	unknown type	GET method
Post	unknown type	POST method
Put	unknown type	PUT method
Delete	unknown type	DELETE method