Shortcuts

flash.core.serve.core.Endpoint

class flash.core.serve.core.Endpoint(route, inputs, outputs)[source]

An endpoint maps a route and request/response payload to components.

Parameters
  • route (str) – The API route name to construct as the servicing POST endpoint.

  • inputs (Dict[str, str]) – The full name of a component input. Typically, specified by just passing in the component parameter attribute (i.e.``component.inputs.foo``).

  • outputs (Dict[str, str]) – The full name of a component output. Typically, specified by just passing in the component parameter attribute (i.e.``component.outputs.bar``).