API documentation very needed

[Ozzadar]

Hey there,

we've been spamming you on twitter for the last couple of days. We managed to get your software (loomio AND cobudget) running yet we can't do anything with it because there is no description of what any of your API does or takes as parameters.

Would you have any internal documentation that would facilitate our process of improving upon your app? We would gladly share our progress with you!

Thanks,
-Paul

[ahdinosaur]

@Ozzadar good on you for setting up your own instances of Loomio and Cobudget. 😄 agreed that better docs would be sweet, but it's heaps of work and we're quite limited by resources already so any help would be greatly appreciated.

the only hidden internal documentation i can think of is an alpha group help document @derekrazo wrote, maybe he could post a link?

i think there is self-generated Cobudget api documentation at http://localhost:3000/docs once you have the api running. can you confirm @euglazer?

[derekrazo]

Hi @Ozzadar - Thanks so much for reaching out here and raising the issues you're brining up :)

Here's the alpha documentation @ahdinosaur was talking about : https://docs.google.com/document/d/1h52G6C5WY3G3hCLp-4NiNdc2WgRVCtQ7_wGpY7x6VcI/edit?usp=sharing

However, it's a bit out of date, as we've now added the launch round feature and email notifications. I'll try to make some time today or tomorrow to update these user docs.

If you'd like to chat about any cobudget stuff - feel free to reach me at derek@enspiral.com

[Ozzadar]

Is there any documentation on how to utilize cobudget-api fully? I can't seem to find where I can get my access tokens and stuff. (I want to add a button or three but can't make API calls atm)

[Ozzadar]

(Im also terrible at ruby/rails so I could just be missing some basic rails knowledge here)

OH, and thanks for the quick reply!

[ahdinosaur]

if you want to understand how to utilize it fully, i recommend reading the source of both cobudget-api and cobudget-ui. not much else we can offer at the moment, feel free to contribute your own docs.

regarding access tokens, in 'master' there's api auth [0] [1] and ui auth; in 'beta' we're using devise-token-auth and ng-token-auth, respectively.

i don't know rails either, it's cool.