Auto-generate API documentation from contracts
Open
feature request
- Dominant language
- TypeScript
- Stars
- 11
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Right now, Rivet doesn't promote the use of defining `endpoints` in your contracts. However, with the use of the JSON Schema [`base`](http://json-schema.org/latest/json-schema-hypermedia.html#rfc.section.5.1) property, it would be relatively simple to generate documentation for your consumer requirements to a service.
Contributor guide
No contributing guide indexed for this repository
Research direction
No files, tests, or entry points are named in the issue. Start by locating how Rivet represents contracts and JSON Schema endpoints, then define the documentation output and tests needed to show that consumer requirements are generated from those contracts.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100