docs: add Arazzo workflow documentation for Open Payments API flows#773
Open
flarcos wants to merge 1 commit intointerledger:mainfrom
Open
docs: add Arazzo workflow documentation for Open Payments API flows#773flarcos wants to merge 1 commit intointerledger:mainfrom
flarcos wants to merge 1 commit intointerledger:mainfrom
Conversation
Add machine-readable API workflow definitions using the Arazzo Specification v1.0.1 for the core Open Payments flows: - one-time-payment-fixed-receive: e-commerce checkout (9 steps) - one-time-payment-fixed-send: remittance pattern (9 steps) - recurring-payment: subscription with interval grants (9 steps) - transaction-history: listing/retrieving payments (3 workflows) - token-management: token rotation, revocation, grant cancel (3 workflows) All workflows reference the existing OpenAPI specs in open-payments-specifications and use Arazzo runtime expressions to define data flow between steps.
✅ Deploy Preview for openpayments-preview canceled.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds machine-readable API workflow documentation using the Arazzo Specification v1.0.1 for the core Open Payments flows.
What is Arazzo?
Arazzo is an OpenAPI Initiative specification for describing sequences of API calls and their dependencies. It sits alongside OpenAPI but focuses on workflows — how multiple API operations chain together to achieve a business outcome.
Workflows Documented
one-time-payment-fixed-receive.arazzo.yamlone-time-payment-fixed-send.arazzo.yamlrecurring-payment.arazzo.yamltransaction-history.arazzo.yamltoken-management.arazzo.yamlKey Features
operationIdreferences resolve against the OpenAPI specs inopen-payments-specifications/openapi/$inputs.*,$steps.*.outputs.*, and$response.body.*to define data flow between API callssuccessCriteriaassertionsHow It Helps
References