Note by @pancakes

if you're on the latest dev version you can go to /scalar or /swagger on your instance and see it for yourself
i'm hoping that other contributors that make api changes/additions will follow the rough style of documentation i've started