search

pikvm / pikvm

Open and inexpensive DIY IP-KVM based on Raspberry Pi
https://pikvm.org
GNU General Public License v3.0
7.89k stars 446 forks source link

API documentation? #44

Closed codinghipster closed 2 years ago

codinghipster commented 4 years ago

I'm looking for documentation, or even just the source code, for the API for pikvm. I looked through this repo, the website, and subreddit and I couldn't find anything.

If documentation doesn't exist I'm absolutely willing to help with that too..

tryallthethings commented 4 years ago

Documentation doesn't exist (yet) as far as I know but you can find the source code here: https://github.com/pikvm/kvmd

mdevaev commented 4 years ago

I would be very grateful if you could help with the description. You can find all the APIs here: https://github.com/pikvm/kvmd/tree/master/kvmd/apps/kvmd/api

mdevaev commented 4 years ago

@codinghipster if you have any questions, I am ready to help you

codinghipster commented 4 years ago

Thanks, I'm going to look into swagger or some other form of self-documenting library. I've never set that up with aiohttp so it should be interesting.

mdevaev commented 3 years ago

Just started this: https://github.com/pikvm/pikvm/blob/master/pages/api.md

mdevaev commented 2 years ago

The main functions are already documented. The API will be updated as needed: https://docs.pikvm.org/api