-
Notifications
You must be signed in to change notification settings - Fork 57
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.
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
chore: Reorganize RestApi specs for live documentation #2120
Comments
Weekly Update
|
Effort on this - Rest API specification reorg is stopped. @chair28980: Moved this to icebox from review due we decided to down-prio rest api efforts on nwaku till gen0 ready. |
This is obsolate. We have it working from separate repository: https://github.com/waku-org/waku-rest-api |
Background
Currently waku rest-api specification files (openapi.yaml's) are living next to the code separated by endpoints.
Also nwaku and go-waku maintains separately these open-api descriptors, rest endpoint types are not shared but sometimes duplicated.
This does not allow us to generate a comprehensive one source of truth documentation on the fly.
Such documentation can help waku users to build their solution on top of it vie utilizing rest api services. Just like bounty hackers can implement their UI with help if it.
Details
While obvious solution would be to merge all the descriptors under one big openapi.yaml file it would be hard to maintain and overview.
Target would be to route all these api descriptions from one root file yet separated by endpoints and schemas as OpenApi spec allows.
Another target is to find solution for a living documentation generated right from the nwaku master branch, possible embeddable into other waku documentation.
Acceptance criteria
No code change is made under this issue, only api spec files.
[ ] A working demo of api documentation right from nwaku repository.
The text was updated successfully, but these errors were encountered: