v3

README

Temporal API V3

This directory contains an experimental and WIP Version 3 of the Temporal API.

Proto definitions are currently kept here as well, though eventually they will be migrated to RTradeLtd/grpc.

Updating generated code:

cd api/v3/proto # from project root
make deps
make gen
make swagger

Documentation

Overview

Package v3 is the main package for Temporal's experimental V3 API.

Index

• func REST(serviceAddress string) error
• type API
  • func New() *API
  • func (a *API) Run(ctx context.Context, address string) error
  • func (a *API) Status(context.Context, *temporalv3.Message) (*temporalv3.Message, error)

Functions

func REST

func REST(serviceAddress string) error

REST runs the RESTful reverse proxy for the Temporal V3 gRPC API

Types

type API

type API struct{}

API is the core Temporal V3 API

func New

func New() *API

New initializes a new Daemon

func (*API) Run

func (a *API) Run(ctx context.Context, address string) error

Run spins up daemon server

func (*API) Status

func (a *API) Status(context.Context, *temporalv3.Message) (*temporalv3.Message, error)

Status returns the Temporal API status