endpoints / Interface

EndpointInvokeConfig

Contextual information used for endpoint invoking.

See Also

Properties

NameTypeDescription
method
string

The method to be used for invoking the endpoint. The definition of "method" may vary depending on the concrete EndpointInvoker implementation. This property is forward from the source EndpointSchema.

path
string

Path of the target API endpoint. The definition and format of "path" may vary depending on the concrete EndpointInvoker implementation. This property is forward from the source EndpointSchema.

payload
unknown

The payload to be sent to the endpoint, if any.

query
Record<string, string | number | boolean | (string | number | boolean)[]> | undefined

The query to be sent to the endpoint, if any. Only primitive types are allowed as values.