avodado
avodado docs
Blocks reference

API

Field contracts and worked examples for the 2 api blocks.

Field contracts and worked examples for the api blocks — converted at build time from the repo's authoring-skill reference. Every example body is YAML; in a real doc the fence language is the block type (for example sequence … ). Schemas are strict — unknown fields are rejected. See the field contract for the at-a-glance shape of all 87 blocks, or the block catalog for live previews.

API reference

endpoint — a Swagger-style API endpoint card

```endpointeditable · live
renderedavo renders this
SECTION 01 · API endpoint

Create an order

POST/orders/{cartId}Bearer <token>

Convert a cart into an order.

Parameters
NameInTypeDescription
cartId requiredpathuuidCart to convert
dry-runquerybooleanValidate without persisting
Request body
FieldTypeDescription
items requiredItem[]Line items
Responses
StatusDescription
201Order created
400Invalid cart
Example request
{ "items": [{ "sku": "A1", "qty": 2 }] }
Example response
{ "id": "ord_123", "status": "pending" }
Valid — passes avo check

Only method and path are required. params[].in is path | query | header | cookie. For a whole spec, generate docs with avo sync openapi.

packet — a wire format, bit by bit

The diagram an RFC draws in ASCII, as arithmetic instead: a bit ruler across the top, then fields whose cell width IS their bit count.

```packeteditable · live
renderedavo renders this
SECTION 01 · Wire format

Request header

PACKET
Packet layout081624Version14Version — 4 bits at offset 0Flags4Flags — 4 bits at offset 4Total length24Total length — 24 bits at offset 8Request id32Request id — 32 bits at offset 32032

64 bits · 8 bytes

Valid — passes avo check

width is the bits per row (32 by default). A field that doesn't fit the rest of its row wraps and continues on the next one, marked and (cont.) — which is what the bytes do. The footer totals bits and bytes and says when the last row is partial.