Feature Request: Implementation of Arazzo Specification v1.0.0
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
The Arazzo Specification v1.0.0 is a mechanism that provides a way to define sequences of API calls and their dependencies, which can be woven together to achieve a particular outcome or set of outcomes when dealing with API descriptions, such as OpenAPI descriptions.
Describe the solution you'd like
The Arazzo Specification is designed to improve the capability of API specifications to tell the story of the API in a manner that can improve the consuming developer experience. It allows for the articulation of workflows in a human-readable and machine-readable manner.
Additional context
Consider adding additional features to redoc that take advantage of the Arazzo Specification, such as the ability to visualize workflows, test them, or generate code from them.
Doc:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked Arazzo Specification v1.0.0 examples and the Redoc repository's existing OpenAPI support. Define the scope of Arazzo support—workflow visualization, testing, or code generation—and establish acceptance criteria for one selected capability.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100