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.

Sign up for GitHub

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

Jump to bottom

Add P2P API Docs #786

Open
ohager opened this issue Jan 27, 2024 · 1 comment
Open

Add P2P API Docs #786

ohager opened this issue Jan 27, 2024 · 1 comment
Labels
API DOC Problems/Improveements related to the API Documentiation

Comments

@ohager
Copy link
Member

ohager commented Jan 27, 2024

At the moment, just the extensive HTTP Web API is documented using OAS.

For completeness it's nice having the P2P API documented in the same style (OAS).
I recommend to add a new path to serve (similar to api-doc) a p2p-doc.
@ohager ohager added the API DOC Problems/Improveements related to the API Documentiation label Jan 27, 2024
@damccull
Copy link
Collaborator

I've done quite a bit of documentation on them at https://signumoasis.xyz/docs/api/p2p/. You should be able to get quite a bit of info to create this new interactive api doc from here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
API DOC Problems/Improveements related to the API Documentiation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@damccull @ohager