Provide documentation for API endpoints

[grega]

Documentation is a must, potentially Swagger-style? (as per: https://staging-my.raspberrypi.org/api/v1/documentation)

[github-actions]

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[github-actions]

This issue was closed because it has been open for more than 90 days with no activity.

[grega]

Documentation of the API is definitely still something we need to do.

[github-actions]

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[makifyegin]

Hi Can I work on that issue? @grega

[adrian-rpf]

@makifyegin We welcome contributions but this might not be the best first issue to look at.
If you let me know your skillset or type of work you like I'm happy to try and find something.

[makifyegin]

@adrian-rpf Thanks so much — that's really kind, and I'll happily take you up on it.

A bit about me: I work as a robotic automation developer(RPA) at Stellantis, mainly using JavaScript and writing lambda functions and scraping websites and responsible AWS Infrastructure. Outside work I'm teaching myself Ruby on Rails because it's the stack I want to move towards, and I learn best by building real things. I'm also comfortable with Docker and run a small k3s (lightweight Kubernetes) cluster where I self-host open source tools.

My main Rails learning project is volunteer work for Servas International, a peace and hospitality organisation: an open source interview booking API in Rails 8 with RSpec and JWT auth

— https://github.com/makifyegin/fox-api. It's a work in progress; I started adding Swagger docs there but haven't got them working properly yet, which is partly why #421 caught my eye — I'd love to learn how to do it right.

To be upfront: I really admire what the Foundation does and I'd like to become a long-term contributor, not a drive-by one. I'm happy to start small and be guided — tests, docs, bug fixes, Ruby side, whatever is genuinely useful for the team.

Thanks