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 rest-api types #2121

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

chore: reorganize rest-api types #2121

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

Comments

@NagyZoltanPeter
Copy link
Contributor

Background

While rest api nwaku implementation is segregated by endpoints they implements their own types one-by-one.
This can be misleading adds complexity by code duplication and does not reflects one rest-api for Waku node as common.

Details

Ongoing task #2120 track normalize of openapi specifications and documentation.
This task tries to address and follow up that changes.

[ ] Reorganize types into common place
[ ] Remove type duplications
[ ] Enforce common naming scheme
[ ] Easy marshalling/de-marshalling code for api types, remove duplications of code/copy-pastes

Acceptance criteria

[ ] No change in functionality
[ ] All tests are passed
[ ] Alignment with go-waku and js-waku done in case of naming changes on api level.

@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 moved this to In Progress in Waku Oct 17, 2023
@chair28980
Copy link
Contributor

@NagyZoltanPeter I assigned this issue to you please update if thats incorrect, thank you!

@NagyZoltanPeter
Copy link
Contributor Author

Weekly Update

  • achieved: Enhancements on Rest request error handling.
  • next: Finalize api spec and doc after PR review. Work in progress: rest api type reorganization. RFC changes to enhance light-push failure response.
  • blocking: Fixing found issues during release.

@NagyZoltanPeter NagyZoltanPeter moved this from In Progress to Blocked in Waku Oct 24, 2023
@NagyZoltanPeter
Copy link
Contributor Author

Block while come to decision on rest api spec changes.
Also it is low prio compared to gen0 tasks.

@NagyZoltanPeter NagyZoltanPeter moved this from Blocked to Icebox in Waku Oct 31, 2023
@NagyZoltanPeter
Copy link
Contributor Author

Downprio!
Rest api specification is moved to https://github.com/waku-org/waku-rest-api
Original PR of spec effort: #2124 had several comments that effects rest-api types and interfaces. Until those are not agreed and applied to the specification this issue can be postponed.

@NagyZoltanPeter
Copy link
Contributor Author

  • Time gone by:
  • rest api spec is moved and has its own reference UI.
  • API types had been evolved and necessary reorg had been done meanwhile.

This is not applicable for current code base.

@github-project-automation github-project-automation bot moved this from Icebox to Done in Waku Jun 28, 2024
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

No branches or pull requests

2 participants