List Every Document an Arazzo Workflow Depends On
Write a script that parses an entry document, follows every source description, and draws the graph of documents the workflow reaches.
Start tutorialDocs
Tutorials that get one job done with one package, guides that unpack a problem and how the toolkit approaches it, and the reference for every published package.
What are you looking for?
Tutorials
One use case, one package, finished in a sitting. Every command runs against the published package today, and the sample files are yours to download.
Parse and Validate Arazzo Runtime Expressions
Parse a runtime expression into a syntax tree, find where an invalid one stops parsing, and see where parsing ends and Arazzo document validation begins.
Start tutorialMore tutorials on the way
The next ones are being written. Follow Discussions to hear when they land.
Guides
Longer reads on one problem each: what it is, how you would solve it by hand, and how the toolkit approaches it. Kept up to date as the packages change.
Parsing Arazzo Documents
Why reading an Arazzo document properly is harder than loading YAML, and what a tool should expect from a parser.
Read guide
Resolving Arazzo Documents
Why an Arazzo document is rarely the one file it looks like, and what resolving, bundling, and dereferencing each do about it.
Read guideMore guides on the way
The next ones are being written. Follow Discussions to hear when they land.
Package reference
Each package gets its reference here. Until it has one, its README in the arazzo-toolkit monorepo is the reference.
@usearazzo/parser
Parses Arazzo and OpenAPI documents into an ApiDOM data model, and parses runtime expressions and criterion conditions into syntax trees.
API reference@usearazzo/resolver
Dereferences, bundles, and resolves the references in Arazzo and OpenAPI documents: $ref, JSON Schema, and reusable components.
@usearazzo/validator
Validates and lints Arazzo documents, and reports every problem as a Language Server Protocol diagnostic with its location, severity, and rule code.
API reference@usearazzo/cli
Validates Arazzo documents from the terminal and CI, with stylish or JSON output and exit codes your pipeline can act on.
CLI reference@usearazzo/runner
Executes Arazzo workflows against live APIs, step by step. The Runner page introduces it.
README on GitHub