Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Overview

API reference styling lab

Inspect a synthetic API with complex schemas, filters, response formats, and webhooks.

Updated
Read as Markdown

Fictional API example. This page demonstrates documentation features; its operations do not describe a live service.

The Cedar Parcel API is fictional. Its .example hosts do not accept requests, and its OpenAPI examples have not been executed. We keep it in the Shoalrun docs to check API reference layouts alongside other pages. It uses the same navigation, search, themes, and Markdown output.

Use these pages to inspect the hardest layouts:

  • Create a parcel enrollment shows four named request shapes with overlapping nested objects and required fields. In Bulk dispatch, monthlyParcelEstimate demonstrates an exclusive lower bound and schema-level examples, while customMetadata accepts any JSON value.
  • List parcel records shows direct query filters, three response formats, and the new object, array, and number constraints: minProperties, maxProperties, uniqueItems, and multipleOf.
  • Get a parcel uses a path-specific server and no authentication.
  • Upload a manifest requires two binary upload fields.
  • Get a parcel through the old route shows OpenAPI deprecation overriding an extension value.
  • Parcel delivered event shows an inbound OpenAPI 3.1 webhook with a nested oneOf proof.

The source and standalone test project live at framework/example-configs/reference-stress/ in the repository. The source is not copied into the built site; each operation publishes only its focused contract.

How it works for agents

Every operation has a complete .md page and a focused OpenAPI contract. Schema fields remain in Markdown even when their HTML disclosure is closed. The site manifest and search index include these pages, and the reader's theme choice does not change what an agent can read.