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

Docs: API docs with or w/o swagger #177

Closed
samip5 opened this issue Jun 5, 2023 · 3 comments
Closed

Docs: API docs with or w/o swagger #177

samip5 opened this issue Jun 5, 2023 · 3 comments

Comments

@samip5
Copy link
Contributor

samip5 commented Jun 5, 2023

It would help a lot if there was a swagger API docs that would have examples of how to actually call the JSONRPC API and/or events API.

Postman collection would also help.

@samip5 samip5 changed the title API docs with or w/o swagger Docs: API docs with or w/o swagger Jun 5, 2023
@vktr
Copy link
Contributor

vktr commented Jun 5, 2023

All the JSONRPC methods are documented at porla.org - for example, torrents.list. Since it's JSONRPC I've just documented the payloads and responses and not the JSONRPC stuffs, but I should probably do some example request/responses in the top level docs for the JSONRPC API.

The events API is documented here - https://porla.org/api/events#monitoring-using-curl but should probably be expanded with an example that uses the auth token as well.

@samip5
Copy link
Contributor Author

samip5 commented Jun 5, 2023

Yes, the issue that I encountered when looking at the docs was simply that there was no curl examples of calling any of them, which made it very hard to understand how to call them.

@vktr
Copy link
Contributor

vktr commented Jun 5, 2023

I've added an issue in the docs repo - porla/docs#6. I'm closing this in favor of that 😃

@vktr vktr closed this as completed Jun 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants