handshake-org / handshake-org/hsd

Auto generate Open API documentation

Open
#699 2 comments 2 reactions 0 assignees View on GitHub
docs help
Dominant language
JavaScript
Stars
2.1k
Forks
306
PR merge metrics
No merged PRs in 30d

Description

It would be great if we could extract an [OpenAPI](https://www.openapis.org/) compatible documentation of endpoints available in hsd.

Such documentation make it easy to automatically generate:
* Clients implementation (no need for `hs-client` syncs/updates)
* Documentation websites
* Typescript types

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.