Skip to content

arazzo: align diagram with arazzo example #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulRbr merged 1 commit into from
Mar 9, 2026
Merged

arazzo: align diagram with arazzo example #441

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/_guides/arazzo/specification/v1.0/introduction/benefits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ workflows:
type: jsonpath
outputs:
tripId: $response.body#/trips/0/id

- stepId: book
operationId: create-booking
requestBody:
Expand All @@ -69,6 +69,23 @@ workflows:
successCriteria:
- condition: $statusCode == 201
- condition: $response.body#/status == 'confirmed'
outputs:
bookingId: $response.body#/id

- stepId: pay
operationId: pay-booking
requestBody:
payload:
bookingId: $steps.book.outputs.bookingId
payment:
mean: credit_card
details: NDExMTExMTExMTExOjAxMzE6MTExCg==
successCriteria:
- condition: $statusCode == 201
- condition: $response.body#/status == 'payment_succeeded'
outputs:
ticketNumber: $response.body#/ticket/number
ticketAztecCode: $response.body#/ticket/aztecCode
```

If you've ever maintained getting started documentation, you'll know the pain: they're the first thing users read and the first thing that goes stale. Arazzo helps because you can treat workflows as the canonical version of those journeys, then generate docs and examples from the same source.
Expand Down