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

Write API documentation for the Bundler #729

Open
TheDivic opened this issue Oct 22, 2024 · 2 comments
Open

Write API documentation for the Bundler #729

TheDivic opened this issue Oct 22, 2024 · 2 comments
Assignees
Labels
📖 Documentation Improvements or additions to documentation

Comments

@TheDivic
Copy link
Collaborator

TheDivic commented Oct 22, 2024

What?

Document our Bundler APIs, with focus on EPv0.7.0 endpoints.

Related conversation:
https://biconomyworkspace.slack.com/archives/C049MMHM7FD/p1729163067457519

Why?

  • The bundler has multiple API versions (v1, v2, v3) and none of them have proper API documentation.
  • Now with EPv0.7.0 it's particularly important, so we are all on the same page both internally (SDK <> Backend) and externally (for our clients).

How?

@TheDivic TheDivic self-assigned this Oct 22, 2024
@TheDivic TheDivic added the 📖 Documentation Improvements or additions to documentation label Oct 22, 2024
@joepegler
Copy link
Collaborator

Can we add swagger documentation for this instead of handwritten docs? They're a lot more useful

@TheDivic
Copy link
Collaborator Author

Yeah I used this: https://open-rpc.org/ it's like Swagger for JSON-RPCs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants