verodocs

Start

Example plans

Each plan below comes from a file in examples/. Begin with Getting started, then use Running the examplesfor each plan's prerequisites and command. Most plans need the sample API; the exec plan does not. Postgres and browser examples need optional database and browser dependencies, so they are not covered by an ordinary build without those prerequisites. Each description comes from its source file's leading comments.

exec.yamlexec
An exec migration step uses an argv list, no shell, its own process group, and capped output.
fixture.yamlsqlexecfixture
Seed reference data no API creates, then read it back.
graphql.yamlgraphql
A graphql step posts a query with variables and reads the data back; a second task expects an error and says so by reading body.errors, which is what turns the step's own errors check off.
grpc.yamlgrpc
One unary gRPC call and one server stream against the Orders service that examples/grpc/*.proto describe.
orders.yamlhttp
Log in, create an order, check it, and delete it in teardown.
playwright.yamlhttpscript
Log in, drive Chromium through Playwright on vero-testserver's /checkout page, then check the placed order with an http step.
postgres.yamlhttpsql
Check the persisted order with a read-only Postgres role and READ ONLY transactions.
rate-limit.yamlhttp
Four requests spend a budget of three; the fourth must be refused.
scripts.yamlhttpscript
Node (global fetch) and Python 3 script steps run against vero-testserver on its default address.
sqlite.yamlhttpsql
An HTTP 201 is followed by a read-only SQL check that the order was persisted for the right tenant.
wait-for-api.yamlhttpwaitFor
Wait for a service to come up, then use it.
ws.yamlws
A ws step sends two messages and collects the echoes; a second task collects what a server pushes on its own and reads when each message arrived.

Walkthroughs

verodocs