Skip to content
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

Closed
Tracked by #1076
NagyZoltanPeter opened this issue Oct 10, 2023 · 3 comments
Closed
Tracked by #1076

chore: Reorganize RestApi specs for live documentation #2120

NagyZoltanPeter opened this issue Oct 10, 2023 · 3 comments
Assignees
Labels
E:REST API service node See https://github.com/waku-org/pm/issues/82 for details

Comments

@NagyZoltanPeter
Copy link
Contributor

NagyZoltanPeter commented Oct 10, 2023

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.

@NagyZoltanPeter NagyZoltanPeter self-assigned this Oct 10, 2023
@NagyZoltanPeter NagyZoltanPeter added the E:REST API service node See https://github.com/waku-org/pm/issues/82 for details label Oct 10, 2023
@NagyZoltanPeter NagyZoltanPeter linked a pull request Oct 13, 2023 that will close this issue
7 tasks
@NagyZoltanPeter
Copy link
Contributor Author

Weekly Update

  • achieved: Http RestAPI interface is in parity with json-rpc with even more features supported on it.
  • next: Openapi specification is reorganized and online doc generated out of it. Currently under PR review.
    Follow up spec reorganization with rest api type reorganization. RFC changes to enhance lighpust failure response.

@NagyZoltanPeter
Copy link
Contributor Author

Effort on this - Rest API specification reorg is stopped.
As a last step the specification in its new form is moved to new repository: https://github.com/waku-org/waku-rest-api
Pull requests #2124 findings and remarks are to be followed up later here in align with go-waku.

@chair28980: Moved this to icebox from review due we decided to down-prio rest api efforts on nwaku till gen0 ready.
Please consider future task separation and priority of this effort.

@NagyZoltanPeter
Copy link
Contributor Author

This is obsolate. We have it working from separate repository: https://github.com/waku-org/waku-rest-api
page is accessible: https://waku-org.github.io/waku-rest-api

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E:REST API service node See https://github.com/waku-org/pm/issues/82 for details
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant